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

// Copyright 2018-2020 Georges Racinet <georges.racinet@octobus.net>

     2

//           and Mercurial contributors

     3

//

     4

// This software may be used and distributed according to the terms of the

     5

// GNU General Public License version 2 or any later version.

     6

     7

mod ancestors;

     8

pub mod dagops;

     9

pub mod errors;

    10

pub use ancestors::{AncestorsIterator, LazyAncestors, MissingAncestors};

    11

pub mod dirstate;

    12

pub mod dirstate_tree;

    13

pub mod discovery;

    14

pub mod exit_codes;

    15

pub mod requirements;

    16

pub mod testing; // unconditionally built, for use from integration tests

    17

pub use dirstate::{

    18

    dirs_multiset::{DirsMultiset, DirsMultisetIter},

    19

    status::{

    20

        BadMatch, BadType, DirstateStatus, HgPathCow, StatusError,

    21

        StatusOptions,

    22

    },

    23

    DirstateEntry, DirstateParents, EntryState,

    24

};

    25

pub mod copy_tracing;

    26

mod filepatterns;

    27

pub mod matchers;

    28

pub mod repo;

    29

pub mod revlog;

    30

pub use revlog::*;

    31

pub mod config;

    32

pub mod logging;

    33

pub mod operations;

    34

pub mod revset;

    35

pub mod utils;

    36

pub mod vfs;

    37

    38

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

    39

pub use filepatterns::{

    40

    parse_pattern_syntax, read_pattern_file, IgnorePattern,

    41

    PatternFileWarning, PatternSyntax,

    42

};

    43

use std::collections::HashMap;

    44

use std::fmt;

    45

use twox_hash::RandomXxHashBuilder64;

    46

    47

/// This is a contract between the `micro-timer` crate and us, to expose

    48

/// the `log` crate as `crate::log`.

    49

use log;

    50

    51

pub type LineNumber = usize;

    52

    53

/// Rust's default hasher is too slow because it tries to prevent collision

    54

/// attacks. We are not concerned about those: if an ill-minded person has

    55

/// write access to your repository, you have other issues.

    56

pub type FastHashMap<K, V> = HashMap<K, V, RandomXxHashBuilder64>;

    57

    58

#[derive(Debug, PartialEq)]

    59

pub enum DirstateMapError {

    60

    PathNotFound(HgPathBuf),

    61

    EmptyPath,

    62

    InvalidPath(HgPathError),

    63

}

    64

    65

impl fmt::Display for DirstateMapError {

    66

    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {

    67

        match self {

    68

            DirstateMapError::PathNotFound(_) => {

    69

                f.write_str("expected a value, found none")

    70

            }

    71

            DirstateMapError::EmptyPath => {

    72

                f.write_str("Overflow in dirstate.")

    73

            }

    74

            DirstateMapError::InvalidPath(path_error) => path_error.fmt(f),

    75

        }

    76

    }

    77

}

    78

    79

#[derive(Debug, derive_more::From)]

    80

pub enum DirstateError {

    81

    Map(DirstateMapError),

    82

    Common(errors::HgError),

    83

}

    84

    85

impl fmt::Display for DirstateError {

    86

    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {

    87

        match self {

    88

            DirstateError::Map(error) => error.fmt(f),

    89

            DirstateError::Common(error) => error.fmt(f),

    90

        }

    91

    }

    92

}

    93

    94

#[derive(Debug, derive_more::From)]

    95

pub enum PatternError {

    96

    #[from]

    97

    Path(HgPathError),

    98

    UnsupportedSyntax(String),

    99

    UnsupportedSyntaxInFile(String, String, usize),

   100

    TooLong(usize),

   101

    #[from]

   102

    IO(std::io::Error),

   103

    /// Needed a pattern that can be turned into a regex but got one that

   104

    /// can't. This should only happen through programmer error.

   105

    NonRegexPattern(IgnorePattern),

   106

}

   107

   108

impl fmt::Display for PatternError {

   109

    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {

   110

        match self {

   111

            PatternError::UnsupportedSyntax(syntax) => {

   112

                write!(f, "Unsupported syntax {}", syntax)

   113

            }

   114

            PatternError::UnsupportedSyntaxInFile(syntax, file_path, line) => {

   115

                write!(

   116

                    f,

   117

                    "{}:{}: unsupported syntax {}",

   118

                    file_path, line, syntax

   119

                )

   120

            }

   121

            PatternError::TooLong(size) => {

   122

                write!(f, "matcher pattern is too long ({} bytes)", size)

   123

            }

   124

            PatternError::IO(error) => error.fmt(f),

   125

            PatternError::Path(error) => error.fmt(f),

   126

            PatternError::NonRegexPattern(pattern) => {

   127

                write!(f, "'{:?}' cannot be turned into a regex", pattern)

   128

            }

   129

        }

   130

    }

   131

}