( )⚙ D11704 dirstate-v2: reorder flag to group related one together

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D11704

dirstate-v2: reorder flag to group related one together
ClosedPublic

Authored by marmoute on Oct 19 2021, 7:01 PM.

Details

Reviewers
Alphare
Group Reviewers
hg-reviewers
Commits
rHG749946b6a641: dirstate-v2: reorder flag to group related one together
Summary

Since the format is not frozen yet, it seems like the right moment to do it.

Diff Detail

Repository
rHG Mercurial
Branch
default
Lint
No Linters Available
Unit
No Unit Test Coverage

Event Timeline

marmoute created this revision.Oct 19 2021, 7:01 PM
Alphare requested changes to this revision.Oct 20 2021, 4:56 AM
Alphare added a subscriber: Alphare.
Alphare added inline comments.
mercurial/cext/util.h
45

Note that this is "has mode and size" in the documentation, the Rust as well as the Python implementation. It's probably worth renaming here

This revision now requires changes to proceed.Oct 20 2021, 4:56 AM
marmoute updated this revision to Diff 30936.Oct 20 2021, 5:13 AM
marmoute added inline comments.Oct 20 2021, 5:13 AM
mercurial/cext/util.h
45

I would rather do a follow up than mixing a rename in the reorder.

Alphare accepted this revision.Oct 20 2021, 5:26 AM
Alphare added inline comments.
mercurial/cext/util.h
45

Sure

This revision is now accepted and ready to land.Oct 20 2021, 5:26 AM
marmoute added a commit: rHG749946b6a641: dirstate-v2: reorder flag to group related one together.Oct 20 2021, 5:32 AM
Closed by commit rHG749946b6a641: dirstate-v2: reorder flag to group related one together (authored by marmoute). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 30936

mercurial/cext/util.h

int flags; int flags;
int mode; int mode;
int size; int size;
int mtime_s; int mtime_s;
int mtime_ns; int mtime_ns;
} dirstateItemObject; } dirstateItemObject;
/* clang-format on */ /* clang-format on */
static const int dirstate_flag_wc_tracked = 1; static const int dirstate_flag_wc_tracked = 1 << 0;
static const int dirstate_flag_p1_tracked = 1 << 1; static const int dirstate_flag_p1_tracked = 1 << 1;
static const int dirstate_flag_p2_info = 1 << 2; static const int dirstate_flag_p2_info = 1 << 2;
static const int dirstate_flag_has_meaningful_data = 1 << 3; static const int dirstate_flag_mode_exec_perm = 1 << 3;
static const int dirstate_flag_has_mtime = 1 << 4; static const int dirstate_flag_mode_is_symlink = 1 << 4;
static const int dirstate_flag_directory = 1 << 5; static const int dirstate_flag_has_fallback_exec = 1 << 5;
static const int dirstate_flag_mode_exec_perm = 1 << 6; static const int dirstate_flag_fallback_exec = 1 << 6;
static const int dirstate_flag_mode_is_symlink = 1 << 7; static const int dirstate_flag_has_fallback_symlink = 1 << 7;
static const int dirstate_flag_expected_state_is_modified = 1 << 8; static const int dirstate_flag_fallback_symlink = 1 << 8;
static const int dirstate_flag_all_unknown_recorded = 1 << 9; static const int dirstate_flag_expected_state_is_modified = 1 << 9;
static const int dirstate_flag_all_ignored_recorded = 1 << 10; static const int dirstate_flag_has_meaningful_data = 1 << 10;
AlphareUnsubmitted
Not Done

Note that this is "has mode and size" in the documentation, the Rust as well as the Python implementation. It's probably worth renaming here

Alphare: Note that this is "has mode and size" in the documentation, the Rust as well as the Python…
marmouteAuthorUnsubmitted
Done

I would rather do a follow up than mixing a rename in the reorder.

marmoute: I would rather do a follow up than mixing a rename in the reorder.
AlphareUnsubmitted
Not Done

Sure

Alphare: Sure
static const int dirstate_flag_fallback_exec = 1 << 11; static const int dirstate_flag_has_mtime = 1 << 11;
static const int dirstate_flag_has_fallback_exec = 1 << 12; static const int dirstate_flag_mtime_second_ambiguous = 1 << 12;
static const int dirstate_flag_fallback_symlink = 1 << 13; static const int dirstate_flag_directory = 1 << 13;
static const int dirstate_flag_has_fallback_symlink = 1 << 14; static const int dirstate_flag_all_unknown_recorded = 1 << 14;
static const int dirstate_flag_mtime_second_ambiguous = 1 << 15; static const int dirstate_flag_all_ignored_recorded = 1 << 15;
extern PyTypeObject dirstateItemType; extern PyTypeObject dirstateItemType;
#define dirstate_tuple_check(op) (Py_TYPE(op) == &dirstateItemType) #define dirstate_tuple_check(op) (Py_TYPE(op) == &dirstateItemType)
#ifndef MIN #ifndef MIN
#define MIN(a, b) (((a) < (b)) ? (a) : (b)) #define MIN(a, b) (((a) < (b)) ? (a) : (b))
#endif #endif
/* VC9 doesn't include bool and lacks stdbool.h based on my searching */ /* VC9 doesn't include bool and lacks stdbool.h based on my searching */

mercurial/helptext/internals/dirstate-v2.txt

* Offset 30: * Offset 30:
A `flags` fields that packs some boolean values as bits of a 16-bit integer. A `flags` fields that packs some boolean values as bits of a 16-bit integer.
Starting from least-significant, bit masks are:: Starting from least-significant, bit masks are::
WDIR_TRACKED = 1 << 0 WDIR_TRACKED = 1 << 0
P1_TRACKED = 1 << 1 P1_TRACKED = 1 << 1
P2_INFO = 1 << 2 P2_INFO = 1 << 2
HAS_MODE_AND_SIZE = 1 << 3 MODE_EXEC_PERM = 1 << 3
HAS_MTIME = 1 << 4 MODE_IS_SYMLINK = 1 << 4
DIRECTORY = 1 << 5 HAS_FALLBACK_EXEC = 1 << 5
MODE_EXEC_PERM = 1 << 6 FALLBACK_EXEC = 1 << 6
MODE_IS_SYMLINK = 1 << 7 HAS_FALLBACK_SYMLINK = 1 << 7
EXPECTED_STATE_IS_MODIFIED = 1 << 8 FALLBACK_SYMLINK = 1 << 8
ALL_UNKNOWN_RECORDED = 1 << 9 EXPECTED_STATE_IS_MODIFIED = 1 << 9
ALL_IGNORED_RECORDED = 1 << 10 HAS_MODE_AND_SIZE = 1 << 10
HAS_FALLBACK_EXEC = 1 << 11 HAS_MTIME = 1 << 11
FALLBACK_EXEC = 1 << 12 MTIME_SECOND_AMBIGUOUS = 1 << 12
HAS_FALLBACK_SYMLINK = 1 << 13 DIRECTORY = 1 << 13
FALLBACK_SYMLINK = 1 << 14 ALL_UNKNOWN_RECORDED = 1 << 14
MTIME_SECOND_AMBIGUOUS = 1 << 15 ALL_IGNORED_RECORDED = 1 << 15
The meaning of each bit is described below. The meaning of each bit is described below.
Other bits are unset. Other bits are unset.
They may be assigned meaning if the future, They may be assigned meaning if the future,
with the limitation that Mercurial versions that pre-date such meaning with the limitation that Mercurial versions that pre-date such meaning
will always reset those bits to unset when writing nodes. will always reset those bits to unset when writing nodes.
(A new node is written for any mutation in its subtree, (A new node is written for any mutation in its subtree,

mercurial/pure/parsers.py

# a special value used internally for `time` if the time is ambigeous # a special value used internally for `time` if the time is ambigeous
AMBIGUOUS_TIME = -1 AMBIGUOUS_TIME = -1
# Bits of the `flags` byte inside a node in the file format # Bits of the `flags` byte inside a node in the file format
DIRSTATE_V2_WDIR_TRACKED = 1 << 0 DIRSTATE_V2_WDIR_TRACKED = 1 << 0
DIRSTATE_V2_P1_TRACKED = 1 << 1 DIRSTATE_V2_P1_TRACKED = 1 << 1
DIRSTATE_V2_P2_INFO = 1 << 2 DIRSTATE_V2_P2_INFO = 1 << 2
DIRSTATE_V2_HAS_MODE_AND_SIZE = 1 << 3 DIRSTATE_V2_MODE_EXEC_PERM = 1 << 3
DIRSTATE_V2_HAS_MTIME = 1 << 4 DIRSTATE_V2_MODE_IS_SYMLINK = 1 << 4
DIRSTATE_V2_DIRECTORY = 1 << 5 DIRSTATE_V2_HAS_FALLBACK_EXEC = 1 << 5
DIRSTATE_V2_MODE_EXEC_PERM = 1 << 6 DIRSTATE_V2_FALLBACK_EXEC = 1 << 6
DIRSTATE_V2_MODE_IS_SYMLINK = 1 << 7 DIRSTATE_V2_HAS_FALLBACK_SYMLINK = 1 << 7
DIRSTATE_V2_EXPECTED_STATE_IS_MODIFIED = 1 << 8 DIRSTATE_V2_FALLBACK_SYMLINK = 1 << 8
DIRSTATE_V2_ALL_UNKNOWN_RECORDED = 1 << 9 DIRSTATE_V2_EXPECTED_STATE_IS_MODIFIED = 1 << 9
DIRSTATE_V2_ALL_IGNORED_RECORDED = 1 << 10 DIRSTATE_V2_HAS_MODE_AND_SIZE = 1 << 10
DIRSTATE_V2_HAS_FALLBACK_EXEC = 1 << 11 DIRSTATE_V2_HAS_MTIME = 1 << 11
DIRSTATE_V2_FALLBACK_EXEC = 1 << 12 DIRSTATE_V2_MTIME_SECOND_AMBIGUOUS = 1 << 12
DIRSTATE_V2_HAS_FALLBACK_SYMLINK = 1 << 13 DIRSTATE_V2_DIRECTORY = 1 << 13
DIRSTATE_V2_FALLBACK_SYMLINK = 1 << 14 DIRSTATE_V2_ALL_UNKNOWN_RECORDED = 1 << 14
DIRSTATE_V2_MTIME_SECOND_AMBIGUOUS = 1 << 15 DIRSTATE_V2_ALL_IGNORED_RECORDED = 1 << 15
@attr.s(slots=True, init=False) @attr.s(slots=True, init=False)
class DirstateItem(object): class DirstateItem(object):
"""represent a dirstate entry """represent a dirstate entry
It hold multiple attributes It hold multiple attributes

rust/hg-core/src/dirstate_tree/on_disk.rs

} }
bitflags! { bitflags! {
#[repr(C)] #[repr(C)]
struct Flags: u16 { struct Flags: u16 {
const WDIR_TRACKED = 1 << 0; const WDIR_TRACKED = 1 << 0;
const P1_TRACKED = 1 << 1; const P1_TRACKED = 1 << 1;
const P2_INFO = 1 << 2; const P2_INFO = 1 << 2;
const HAS_MODE_AND_SIZE = 1 << 3; const MODE_EXEC_PERM = 1 << 3;
const HAS_MTIME = 1 << 4; const MODE_IS_SYMLINK = 1 << 4;
const DIRECTORY = 1 << 5; const HAS_FALLBACK_EXEC = 1 << 5;
const MODE_EXEC_PERM = 1 << 6; const FALLBACK_EXEC = 1 << 6;
const MODE_IS_SYMLINK = 1 << 7; const HAS_FALLBACK_SYMLINK = 1 << 7;
const EXPECTED_STATE_IS_MODIFIED = 1 << 8; const FALLBACK_SYMLINK = 1 << 8;
const ALL_UNKNOWN_RECORDED = 1 << 9; const EXPECTED_STATE_IS_MODIFIED = 1 << 9;
const ALL_IGNORED_RECORDED = 1 << 10; const HAS_MODE_AND_SIZE = 1 <<10;
const HAS_FALLBACK_EXEC = 1 << 11; const HAS_MTIME = 1 <<11;
const FALLBACK_EXEC = 1 << 12; const MTIME_SECOND_AMBIGUOUS = 1 << 12;
const HAS_FALLBACK_SYMLINK = 1 << 13; const DIRECTORY = 1 <<13;
const FALLBACK_SYMLINK = 1 << 14; const ALL_UNKNOWN_RECORDED = 1 <<14;
const MTIME_SECOND_AMBIGUOUS = 1 << 15; const ALL_IGNORED_RECORDED = 1 <<15;
} }
} }
/// Duration since the Unix epoch /// Duration since the Unix epoch
#[derive(BytesCast, Copy, Clone)] #[derive(BytesCast, Copy, Clone)]
#[repr(C)] #[repr(C)]
struct PackedTruncatedTimestamp { struct PackedTruncatedTimestamp {
truncated_seconds: U32Be, truncated_seconds: U32Be,