dirstate: Remove the flat Rust DirstateMap implementation Before this changeset we had two Rust implementations of `DirstateMap`. This removes the "flat" DirstateMap so that the "tree" DirstateMap is always used when Rust enabled. This simplifies the code a lot, and will enable (in the next changeset) further removal of a trait abstraction. This is a performance regression when: * Rust is enabled, and * The repository uses the legacy dirstate-v1 file format, and * For `hg status`, unknown files are not listed (such as with `-mard`) The regression is about 100 milliseconds for `hg status -mard` on a semi-large repository (mozilla-central), from ~320ms to ~420ms. We deem this to be small enough to be worth it. The new dirstate-v2 is still experimental at this point, but we aim to stabilize it (though not yet enable it by default for new repositories) in Mercurial 6.0. Eventually, upgrating repositories to dirsate-v2 will eliminate this regression (and enable other performance improvements). # Background The flat DirstateMap was introduced with the first Rust implementation of the status algorithm. It works similarly to the previous Python + C one, with a single `HashMap` that associates file paths to a `DirstateEntry` (where Python has a dict). We later added the tree DirstateMap where the root of the tree contains nodes for files and directories that are directly at the root of the repository, and nodes for directories can contain child nodes representing the files and directly that *they* contain directly. The shape of this tree mirrors that of the working directory in the filesystem. This enables the status algorithm to traverse this tree in tandem with traversing the filesystem tree, which in turns enables a more efficient algorithm. Furthermore, the new dirstate-v2 file format is also based on a tree of the same shape. The tree DirstateMap can access a dirstate-v2 file without parsing it: binary data in a single large (possibly memory-mapped) bytes buffer is traversed on demand. This allows `DirstateMap` creation to take `O(1)` time. (Mutation works by creating new in-memory nodes with copy-on-write semantics, and serialization is append-mostly.) The tradeoff is that for "legacy" repositories that use the dirstate-v1 file format, parsing that file into a tree DirstateMap takes more time. Profiling shows that this time is dominated by `HashMap`. For a dirstate containing `F` files with an average `D` directory depth, the flat DirstateMap does parsing in `O(F)` number of HashMap operations but the tree DirstateMap in `O(F × D)` operations, since each node has its own HashMap containing its child nodes. This slower costs ~140ms on an old snapshot of mozilla-central, and ~80ms on an old snapshot of the Netbeans repository. The status algorithm is faster, but with `-mard` (when not listing unknown files) it is typically not faster *enough* to compensate the slower parsing. Both Rust implementations are always faster than the Python + C implementation # Benchmark results All benchmarks are run on changeset 98c0408324e6, with repositories that use the dirstate-v1 file format, on a server with 4 CPU cores and 4 CPU threads (no HyperThreading). `hg status` benchmarks show wall clock times of the entire command as the average and standard deviation of serveral runs, collected by https://github.com/sharkdp/hyperfine and reformated. Parsing benchmarks are wall clock time of the Rust function that converts a bytes buffer of the dirstate file into the `DirstateMap` data structure as used by the status algorithm. A single run each, collected by running `hg status` this environment variable: RUST_LOG=hg::dirstate::dirstate_map=trace,hg::dirstate_tree::dirstate_map=trace Benchmark 1: Rust flat DirstateMap → Rust tree DirstateMap hg status mozilla-clean 562.3 ms ± 2.0 ms → 462.5 ms ± 0.6 ms 1.22 ± 0.00 times faster mozilla-dirty 859.6 ms ± 2.2 ms → 719.5 ms ± 3.2 ms 1.19 ± 0.01 times faster mozilla-ignored 558.2 ms ± 3.0 ms → 457.9 ms ± 2.9 ms 1.22 ± 0.01 times faster mozilla-unknowns 859.4 ms ± 5.7 ms → 716.0 ms ± 4.7 ms 1.20 ± 0.01 times faster netbeans-clean 336.5 ms ± 0.9 ms → 339.5 ms ± 0.4 ms 0.99 ± 0.00 times faster netbeans-dirty 491.4 ms ± 1.6 ms → 475.1 ms ± 1.2 ms 1.03 ± 0.00 times faster netbeans-ignored 343.7 ms ± 1.0 ms → 347.8 ms ± 0.4 ms 0.99 ± 0.00 times faster netbeans-unknowns 484.3 ms ± 1.0 ms → 466.0 ms ± 1.2 ms 1.04 ± 0.00 times faster hg status -mard mozilla-clean 317.3 ms ± 0.6 ms → 422.5 ms ± 1.2 ms 0.75 ± 0.00 times faster mozilla-dirty 315.4 ms ± 0.6 ms → 417.7 ms ± 1.1 ms 0.76 ± 0.00 times faster mozilla-ignored 314.6 ms ± 0.6 ms → 417.4 ms ± 1.0 ms 0.75 ± 0.00 times faster mozilla-unknowns 312.9 ms ± 0.9 ms → 417.3 ms ± 1.6 ms 0.75 ± 0.00 times faster netbeans-clean 212.0 ms ± 0.6 ms → 283.6 ms ± 0.8 ms 0.75 ± 0.00 times faster netbeans-dirty 211.4 ms ± 1.0 ms → 283.4 ms ± 1.6 ms 0.75 ± 0.01 times faster netbeans-ignored 211.4 ms ± 0.9 ms → 283.9 ms ± 0.8 ms 0.74 ± 0.01 times faster netbeans-unknowns 211.1 ms ± 0.6 ms → 283.4 ms ± 1.0 ms 0.74 ± 0.00 times faster Parsing mozilla-clean 38.4ms → 177.6ms mozilla-dirty 38.8ms → 177.0ms mozilla-ignored 38.8ms → 178.0ms mozilla-unknowns 38.7ms → 176.9ms netbeans-clean 16.5ms → 97.3ms netbeans-dirty 16.5ms → 98.4ms netbeans-ignored 16.9ms → 97.4ms netbeans-unknowns 16.9ms → 96.3ms Benchmark 2: Python + C dirstatemap → Rust tree DirstateMap hg status mozilla-clean 1261.0 ms ± 3.6 ms → 461.1 ms ± 0.5 ms 2.73 ± 0.00 times faster mozilla-dirty 2293.4 ms ± 9.1 ms → 719.6 ms ± 3.6 ms 3.19 ± 0.01 times faster mozilla-ignored 1240.4 ms ± 2.3 ms → 457.7 ms ± 1.9 ms 2.71 ± 0.00 times faster mozilla-unknowns 2283.3 ms ± 9.0 ms → 719.7 ms ± 3.8 ms 3.17 ± 0.01 times faster netbeans-clean 879.7 ms ± 3.5 ms → 339.9 ms ± 0.5 ms 2.59 ± 0.00 times faster netbeans-dirty 1257.3 ms ± 4.7 ms → 474.6 ms ± 1.6 ms 2.65 ± 0.01 times faster netbeans-ignored 943.9 ms ± 1.9 ms → 347.3 ms ± 1.1 ms 2.72 ± 0.00 times faster netbeans-unknowns 1188.1 ms ± 5.0 ms → 465.2 ms ± 2.3 ms 2.55 ± 0.01 times faster hg status -mard mozilla-clean 903.2 ms ± 3.6 ms → 423.4 ms ± 2.2 ms 2.13 ± 0.01 times faster mozilla-dirty 884.6 ms ± 4.5 ms → 417.3 ms ± 1.4 ms 2.12 ± 0.01 times faster mozilla-ignored 881.9 ms ± 1.3 ms → 417.3 ms ± 0.8 ms 2.11 ± 0.00 times faster mozilla-unknowns 878.5 ms ± 1.9 ms → 416.4 ms ± 0.9 ms 2.11 ± 0.00 times faster netbeans-clean 434.9 ms ± 1.8 ms → 284.0 ms ± 0.8 ms 1.53 ± 0.01 times faster netbeans-dirty 434.1 ms ± 0.8 ms → 283.1 ms ± 0.8 ms 1.53 ± 0.00 times faster netbeans-ignored 431.7 ms ± 1.1 ms → 283.6 ms ± 1.8 ms 1.52 ± 0.01 times faster netbeans-unknowns 433.0 ms ± 1.3 ms → 283.5 ms ± 0.7 ms 1.53 ± 0.00 times faster Differential Revision: https://phab.mercurial-scm.org/D11516

     1

use crate::dirstate::parsers::Timestamp;

     2

use crate::dirstate::CopyMapIter;

     3

use crate::dirstate::StateMapIter;

     4

use crate::dirstate_tree::dispatch::DirstateMapMethods;

     5

use crate::dirstate_tree::on_disk::DirstateV2ParseError;

     6

use crate::dirstate_tree::owning::OwningDirstateMap;

     7

use crate::matchers::Matcher;

     8

use crate::utils::hg_path::{HgPath, HgPathBuf};

     9

use crate::DirstateEntry;

    10

use crate::DirstateError;

    11

use crate::DirstateParents;

    12

use crate::DirstateStatus;

    13

use crate::PatternFileWarning;

    14

use crate::StatusError;

    15

use crate::StatusOptions;

    16

use std::path::PathBuf;

    17

    18

impl DirstateMapMethods for OwningDirstateMap {

    19

    fn clear(&mut self) {

    20

        self.get_mut().clear()

    21

    }

    22

    23

    fn set_entry(

    24

        &mut self,

    25

        filename: &HgPath,

    26

        entry: DirstateEntry,

    27

    ) -> Result<(), DirstateV2ParseError> {

    28

        self.get_mut().set_entry(filename, entry)

    29

    }

    30

    31

    fn add_file(

    32

        &mut self,

    33

        filename: &HgPath,

    34

        entry: DirstateEntry,

    35

    ) -> Result<(), DirstateError> {

    36

        self.get_mut().add_file(filename, entry)

    37

    }

    38

    39

    fn remove_file(

    40

        &mut self,

    41

        filename: &HgPath,

    42

        in_merge: bool,

    43

    ) -> Result<(), DirstateError> {

    44

        self.get_mut().remove_file(filename, in_merge)

    45

    }

    46

    47

    fn drop_entry_and_copy_source(

    48

        &mut self,

    49

        filename: &HgPath,

    50

    ) -> Result<(), DirstateError> {

    51

        self.get_mut().drop_entry_and_copy_source(filename)

    52

    }

    53

    54

    fn has_tracked_dir(

    55

        &mut self,

    56

        directory: &HgPath,

    57

    ) -> Result<bool, DirstateError> {

    58

        self.get_mut().has_tracked_dir(directory)

    59

    }

    60

    61

    fn has_dir(&mut self, directory: &HgPath) -> Result<bool, DirstateError> {

    62

        self.get_mut().has_dir(directory)

    63

    }

    64

    65

    fn pack_v1(

    66

        &mut self,

    67

        parents: DirstateParents,

    68

        now: Timestamp,

    69

    ) -> Result<Vec<u8>, DirstateError> {

    70

        self.get_mut().pack_v1(parents, now)

    71

    }

    72

    73

    fn pack_v2(

    74

        &mut self,

    75

        now: Timestamp,

    76

        can_append: bool,

    77

    ) -> Result<(Vec<u8>, Vec<u8>, bool), DirstateError> {

    78

        self.get_mut().pack_v2(now, can_append)

    79

    }

    80

    81

    fn status<'a>(

    82

        &'a mut self,

    83

        matcher: &'a (dyn Matcher + Sync),

    84

        root_dir: PathBuf,

    85

        ignore_files: Vec<PathBuf>,

    86

        options: StatusOptions,

    87

    ) -> Result<(DirstateStatus<'a>, Vec<PatternFileWarning>), StatusError>

    88

    {

    89

        self.get_mut()

    90

            .status(matcher, root_dir, ignore_files, options)

    91

    }

    92

    93

    fn copy_map_len(&self) -> usize {

    94

        self.get().copy_map_len()

    95

    }

    96

    97

    fn copy_map_iter(&self) -> CopyMapIter<'_> {

    98

        self.get().copy_map_iter()

    99

    }

   100

   101

    fn copy_map_contains_key(

   102

        &self,

   103

        key: &HgPath,

   104

    ) -> Result<bool, DirstateV2ParseError> {

   105

        self.get().copy_map_contains_key(key)

   106

    }

   107

   108

    fn copy_map_get(

   109

        &self,

   110

        key: &HgPath,

   111

    ) -> Result<Option<&HgPath>, DirstateV2ParseError> {

   112

        self.get().copy_map_get(key)

   113

    }

   114

   115

    fn copy_map_remove(

   116

        &mut self,

   117

        key: &HgPath,

   118

    ) -> Result<Option<HgPathBuf>, DirstateV2ParseError> {

   119

        self.get_mut().copy_map_remove(key)

   120

    }

   121

   122

    fn copy_map_insert(

   123

        &mut self,

   124

        key: HgPathBuf,

   125

        value: HgPathBuf,

   126

    ) -> Result<Option<HgPathBuf>, DirstateV2ParseError> {

   127

        self.get_mut().copy_map_insert(key, value)

   128

    }

   129

   130

    fn len(&self) -> usize {

   131

        self.get().len()

   132

    }

   133

   134

    fn contains_key(

   135

        &self,

   136

        key: &HgPath,

   137

    ) -> Result<bool, DirstateV2ParseError> {

   138

        self.get().contains_key(key)

   139

    }

   140

   141

    fn get(

   142

        &self,

   143

        key: &HgPath,

   144

    ) -> Result<Option<DirstateEntry>, DirstateV2ParseError> {

   145

        self.get().get(key)

   146

    }

   147

   148

    fn iter(&self) -> StateMapIter<'_> {

   149

        self.get().iter()

   150

    }

   151

   152

    fn iter_tracked_dirs(

   153

        &mut self,

   154

    ) -> Result<

   155

        Box<

   156

            dyn Iterator<Item = Result<&HgPath, DirstateV2ParseError>>

   157

                + Send

   158

                + '_,

   159

        >,

   160

        DirstateError,

   161

    > {

   162

        self.get_mut().iter_tracked_dirs()

   163

    }

   164

   165

    fn debug_iter(

   166

        &self,

   167

        all: bool,

   168

    ) -> Box<

   169

        dyn Iterator<

   170

                Item = Result<

   171

                    (&HgPath, (u8, i32, i32, i32)),

   172

                    DirstateV2ParseError,

   173

                >,

   174

            > + Send

   175

            + '_,

   176

    > {

   177

        self.get().debug_iter(all)

   178

    }

   179

}