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

// status.rs

     2

//

     3

// Copyright 2019 Raphaël Gomès <rgomes@octobus.net>

     4

//

     5

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

     6

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

     7

     8

//! Rust implementation of dirstate.status (dirstate.py).

     9

//! It is currently missing a lot of functionality compared to the Python one

    10

//! and will only be triggered in narrow cases.

    11

    12

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

    13

    14

use crate::{

    15

    utils::hg_path::{HgPath, HgPathError},

    16

    PatternError,

    17

};

    18

    19

use std::{borrow::Cow, fmt};

    20

    21

/// Wrong type of file from a `BadMatch`

    22

/// Note: a lot of those don't exist on all platforms.

    23

#[derive(Debug, Copy, Clone)]

    24

pub enum BadType {

    25

    CharacterDevice,

    26

    BlockDevice,

    27

    FIFO,

    28

    Socket,

    29

    Directory,

    30

    Unknown,

    31

}

    32

    33

impl fmt::Display for BadType {

    34

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

    35

        f.write_str(match self {

    36

            BadType::CharacterDevice => "character device",

    37

            BadType::BlockDevice => "block device",

    38

            BadType::FIFO => "fifo",

    39

            BadType::Socket => "socket",

    40

            BadType::Directory => "directory",

    41

            BadType::Unknown => "unknown",

    42

        })

    43

    }

    44

}

    45

    46

/// Was explicitly matched but cannot be found/accessed

    47

#[derive(Debug, Copy, Clone)]

    48

pub enum BadMatch {

    49

    OsError(i32),

    50

    BadType(BadType),

    51

}

    52

    53

/// `Box<dyn Trait>` is syntactic sugar for `Box<dyn Trait + 'static>`, so add

    54

/// an explicit lifetime here to not fight `'static` bounds "out of nowhere".

    55

pub type IgnoreFnType<'a> =

    56

    Box<dyn for<'r> Fn(&'r HgPath) -> bool + Sync + 'a>;

    57

    58

/// We have a good mix of owned (from directory traversal) and borrowed (from

    59

/// the dirstate/explicit) paths, this comes up a lot.

    60

pub type HgPathCow<'a> = Cow<'a, HgPath>;

    61

    62

#[derive(Debug, Copy, Clone)]

    63

pub struct StatusOptions {

    64

    /// Remember the most recent modification timeslot for status, to make

    65

    /// sure we won't miss future size-preserving file content modifications

    66

    /// that happen within the same timeslot.

    67

    pub last_normal_time: i64,

    68

    /// Whether we are on a filesystem with UNIX-like exec flags

    69

    pub check_exec: bool,

    70

    pub list_clean: bool,

    71

    pub list_unknown: bool,

    72

    pub list_ignored: bool,

    73

    /// Whether to collect traversed dirs for applying a callback later.

    74

    /// Used by `hg purge` for example.

    75

    pub collect_traversed_dirs: bool,

    76

}

    77

    78

#[derive(Debug, Default)]

    79

pub struct DirstateStatus<'a> {

    80

    /// Tracked files whose contents have changed since the parent revision

    81

    pub modified: Vec<HgPathCow<'a>>,

    82

    83

    /// Newly-tracked files that were not present in the parent

    84

    pub added: Vec<HgPathCow<'a>>,

    85

    86

    /// Previously-tracked files that have been (re)moved with an hg command

    87

    pub removed: Vec<HgPathCow<'a>>,

    88

    89

    /// (Still) tracked files that are missing, (re)moved with an non-hg

    90

    /// command

    91

    pub deleted: Vec<HgPathCow<'a>>,

    92

    93

    /// Tracked files that are up to date with the parent.

    94

    /// Only pupulated if `StatusOptions::list_clean` is true.

    95

    pub clean: Vec<HgPathCow<'a>>,

    96

    97

    /// Files in the working directory that are ignored with `.hgignore`.

    98

    /// Only pupulated if `StatusOptions::list_ignored` is true.

    99

    pub ignored: Vec<HgPathCow<'a>>,

   100

   101

    /// Files in the working directory that are neither tracked nor ignored.

   102

    /// Only pupulated if `StatusOptions::list_unknown` is true.

   103

    pub unknown: Vec<HgPathCow<'a>>,

   104

   105

    /// Was explicitly matched but cannot be found/accessed

   106

    pub bad: Vec<(HgPathCow<'a>, BadMatch)>,

   107

   108

    /// Either clean or modified, but we can’t tell from filesystem metadata

   109

    /// alone. The file contents need to be read and compared with that in

   110

    /// the parent.

   111

    pub unsure: Vec<HgPathCow<'a>>,

   112

   113

    /// Only filled if `collect_traversed_dirs` is `true`

   114

    pub traversed: Vec<HgPathCow<'a>>,

   115

   116

    /// Whether `status()` made changed to the `DirstateMap` that should be

   117

    /// written back to disk

   118

    pub dirty: bool,

   119

}

   120

   121

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

   122

pub enum StatusError {

   123

    /// Generic IO error

   124

    IO(std::io::Error),

   125

    /// An invalid path that cannot be represented in Mercurial was found

   126

    Path(HgPathError),

   127

    /// An invalid "ignore" pattern was found

   128

    Pattern(PatternError),

   129

    /// Corrupted dirstate

   130

    DirstateV2ParseError(DirstateV2ParseError),

   131

}

   132

   133

pub type StatusResult<T> = Result<T, StatusError>;

   134

   135

impl fmt::Display for StatusError {

   136

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

   137

        match self {

   138

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

   139

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

   140

            StatusError::Pattern(error) => error.fmt(f),

   141

            StatusError::DirstateV2ParseError(_) => {

   142

                f.write_str("dirstate-v2 parse error")

   143

            }

   144

        }

   145

    }

   146

}