view tests/test-bookmarks-corner-case.t @ 48068:bf8837e3d7ce

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
author Simon Sapin <simon.sapin@octobus.net>
date Mon, 27 Sep 2021 12:09:15 +0200
parents e5efbb11e185
children
line wrap: on
line source

================================
Test corner case around bookmark
================================

This test file is meant to gather test around bookmark that are specific
 enough to not find a place elsewhere.

Test bookmark/changelog race condition
======================================

The data from the bookmark file are filtered to only contains bookmark with
node known to the changelog. If the cache invalidation between these two bits
goes wrong, bookmark can be dropped.

Setup
-----

initial repository setup

  $ hg init bookrace-server
  $ cd bookrace-server
  $ echo a > a
  $ hg add a
  $ hg commit -m root
  $ echo a >> a
  $ hg bookmark book-A
  $ hg commit -m A0
  $ hg up 'desc(root)'
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  (leaving bookmark book-A)
  $ echo b > b
  $ hg add b
  $ hg bookmark book-B
  $ hg commit -m B0
  created new head
  $ hg up null
  0 files updated, 0 files merged, 2 files removed, 0 files unresolved
  (leaving bookmark book-B)
  $ hg phase --public --rev 'all()'
  $ hg log -G
  o  changeset:   2:c79985706978
  |  bookmark:    book-B
  |  tag:         tip
  |  parent:      0:6569b5a81c7e
  |  user:        test
  |  date:        Thu Jan 01 00:00:00 1970 +0000
  |  summary:     B0
  |
  | o  changeset:   1:39c28d785860
  |/   bookmark:    book-A
  |    user:        test
  |    date:        Thu Jan 01 00:00:00 1970 +0000
  |    summary:     A0
  |
  o  changeset:   0:6569b5a81c7e
     user:        test
     date:        Thu Jan 01 00:00:00 1970 +0000
     summary:     root
  
  $ hg book
     book-A                    1:39c28d785860
     book-B                    2:c79985706978
  $ cd ..

Add new changeset on each bookmark in distinct clones

  $ hg clone ssh://user@dummy/bookrace-server client-A
  requesting all changes
  adding changesets
  adding manifests
  adding file changes
  added 3 changesets with 3 changes to 2 files (+1 heads)
  new changesets 6569b5a81c7e:c79985706978
  updating to branch default
  2 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ hg -R client-A update book-A
  1 files updated, 0 files merged, 1 files removed, 0 files unresolved
  (activating bookmark book-A)
  $ echo a >> client-A/a
  $ hg -R client-A commit -m A1
  $ hg clone ssh://user@dummy/bookrace-server client-B
  requesting all changes
  adding changesets
  adding manifests
  adding file changes
  added 3 changesets with 3 changes to 2 files (+1 heads)
  new changesets 6569b5a81c7e:c79985706978
  updating to branch default
  2 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ hg -R client-B update book-B
  0 files updated, 0 files merged, 0 files removed, 0 files unresolved
  (activating bookmark book-B)
  $ echo b >> client-B/b
  $ hg -R client-B commit -m B1

extension to reproduce the race
-------------------------------

If two process are pushing we want to make sure the following happens:

* process A read changelog
* process B to its full push
* process A read bookmarks
* process A proceed with rest of the push

We build a server side extension for this purpose

  $ cat > bookrace.py << EOF
  > import atexit
  > import os
  > import time
  > from mercurial import bookmarks, error, extensions
  > 
  > def wait(repo):
  >     if not os.path.exists('push-A-started'):
  >         assert repo._currentlock(repo._lockref) is None
  >         assert repo._currentlock(repo._wlockref) is None
  >         repo.ui.status(b'setting raced push up\n')
  >         with open('push-A-started', 'w'):
  >             pass
  >     clock = 300
  >     while not os.path.exists('push-B-done'):
  >         clock -= 1
  >         if clock <= 0:
  >             raise error.Abort("race scenario timed out")
  >         time.sleep(0.1)
  > 
  > def reposetup(ui, repo):
  >     class racedrepo(repo.__class__):
  >         @property
  >         def _bookmarks(self):
  >             wait(self)
  >             return super(racedrepo, self)._bookmarks
  >     repo.__class__ = racedrepo
  > 
  > def e():
  >     with open('push-A-done', 'w'):
  >         pass
  > atexit.register(e)
  > EOF

Actual test
-----------

Start the raced push.

  $ cat >> bookrace-server/.hg/hgrc << EOF
  > [extensions]
  > bookrace=$TESTTMP/bookrace.py
  > EOF
  $ hg push -R client-A -r book-A >push-output.txt 2>&1 &

Wait up to 30 seconds for that push to start.

  $ clock=30
  $ while [ ! -f push-A-started ] && [ $clock -gt 0 ] ; do
  >    clock=`expr $clock - 1`
  >    sleep 1
  > done

Do the other push.

  $ cat >> bookrace-server/.hg/hgrc << EOF
  > [extensions]
  > bookrace=!
  > EOF

  $ hg push -R client-B -r book-B
  pushing to ssh://user@dummy/bookrace-server
  searching for changes
  remote: adding changesets
  remote: adding manifests
  remote: adding file changes
  remote: added 1 changesets with 1 changes to 1 files
  updating bookmark book-B

Signal the raced put that we are done (it waits up to 30 seconds).

  $ touch push-B-done

Wait for the raced push to finish (with the remaning of the initial 30 seconds).

  $ while [ ! -f push-A-done ] && [ $clock -gt 0 ] ; do
  >    clock=`expr $clock - 1`
  >    sleep 1
  > done

Check raced push output.

  $ cat push-output.txt
  pushing to ssh://user@dummy/bookrace-server
  searching for changes
  remote: setting raced push up
  remote has heads on branch 'default' that are not known locally: f26c3b5167d1
  remote: adding changesets
  remote: adding manifests
  remote: adding file changes
  remote: added 1 changesets with 1 changes to 1 files
  updating bookmark book-A

Check result of the push.

  $ hg -R bookrace-server log -G
  o  changeset:   4:9ce3b28c16de
  |  bookmark:    book-A
  |  tag:         tip
  |  parent:      1:39c28d785860
  |  user:        test
  |  date:        Thu Jan 01 00:00:00 1970 +0000
  |  summary:     A1
  |
  | o  changeset:   3:f26c3b5167d1
  | |  bookmark:    book-B
  | |  user:        test
  | |  date:        Thu Jan 01 00:00:00 1970 +0000
  | |  summary:     B1
  | |
  | o  changeset:   2:c79985706978
  | |  parent:      0:6569b5a81c7e
  | |  user:        test
  | |  date:        Thu Jan 01 00:00:00 1970 +0000
  | |  summary:     B0
  | |
  o |  changeset:   1:39c28d785860
  |/   user:        test
  |    date:        Thu Jan 01 00:00:00 1970 +0000
  |    summary:     A0
  |
  o  changeset:   0:6569b5a81c7e
     user:        test
     date:        Thu Jan 01 00:00:00 1970 +0000
     summary:     root
  
  $ hg -R bookrace-server book
     book-A                    4:9ce3b28c16de
     book-B                    3:f26c3b5167d1