Mercurial > hg
view tests/test-racy-mutations.t @ 49000:dd6b67d5c256 stable
rust: fix unsound `OwningDirstateMap`
As per the previous patch, `OwningDirstateMap` is unsound. Self-referential
structs are difficult to implement correctly in Rust since the compiler is
free to move structs around as much as it wants to. They are also very rarely
needed in practice, so the state-of-the-art on how they should be done within
the Rust rules is still a bit new.
The crate `ouroboros` is an attempt at providing a safe way (in the Rust sense)
of declaring self-referential structs. It is getting a lot attention and was
improved very quickly when soundness issues were found in the past: rather than
relying on our own (limited) review circle, we might as well use the de-facto
common crate to fix this problem. This will give us a much better chance of
finding issues should any new ones be discovered as well as the benefit of
fewer `unsafe` APIs of our own.
I was starting to think about how I would present a safe API to the old struct
but soon realized that the callback-based approach was already done in
`ouroboros`, along with a lot more care towards refusing incorrect structs.
In short: we don't return a mutable reference to the `DirstateMap` anymore, we
expect users of its API to pass a `FnOnce` that takes the map as an argument.
This allows our `OwningDirstateMap` to control the input and output lifetimes
of the code that modifies it to prevent such issues.
Changing to `ouroboros` meant changing every API with it, but it is relatively
low churn in the end. It correctly identified the example buggy modification of
`copy_map_insert` outlined in the previous patch as violating the borrow rules.
Differential Revision: https://phab.mercurial-scm.org/D12429
author | Raphaël Gomès <rgomes@octobus.net> |
---|---|
date | Tue, 05 Apr 2022 10:55:28 +0200 |
parents | bd752712ccaf |
children | dd384ad01d88 |
line wrap: on
line source
#testcases skip-detection fail-if-detected Test situations that "should" only be reproducible: - on networked filesystems, or - user using `hg debuglocks` to eliminate the lock file, or - something (that doesn't respect the lock file) writing to the .hg directory while we're running $ hg init a $ cd a $ cat > "$TESTTMP/waitlock_editor.sh" <<EOF > [ -n "\${WAITLOCK_ANNOUNCE:-}" ] && touch "\${WAITLOCK_ANNOUNCE}" > f="\${WAITLOCK_FILE}" > start=\`date +%s\` > timeout=5 > $RUNTESTDIR/testlib/wait-on-file "\$timeout" "\$f" > if [ \$# -gt 1 ]; then > cat "\$@" > fi > EOF Things behave differently if we don't already have a 00changelog.i file when this all starts, so let's make one. $ echo r0 > r0 $ hg commit -qAm 'r0' Start an hg commit that will take a while $ EDITOR_STARTED="$(pwd)/.editor_started" $ MISCHIEF_MANAGED="$(pwd)/.mischief_managed" $ JOBS_FINISHED="$(pwd)/.jobs_finished" #if fail-if-detected $ cat >> .hg/hgrc << EOF > [debug] > revlog.verifyposition.changelog = fail > EOF #endif $ echo foo > foo $ (WAITLOCK_ANNOUNCE="${EDITOR_STARTED}" \ > WAITLOCK_FILE="${MISCHIEF_MANAGED}" \ > HGEDITOR="sh $TESTTMP/waitlock_editor.sh" \ > hg commit -qAm 'r1 (foo)' --edit foo > .foo_commit_out 2>&1 ; touch "${JOBS_FINISHED}") & Wait for the "editor" to actually start $ WAITLOCK_FILE="${EDITOR_STARTED}" sh "$TESTTMP/waitlock_editor.sh" Break the locks, and make another commit. $ hg debuglocks -LW $ echo bar > bar $ hg commit -qAm 'r2 (bar)' bar $ hg debugrevlogindex -c rev linkrev nodeid p1 p2 0 0 222799e2f90b 000000000000 000000000000 1 1 6f124f6007a0 222799e2f90b 000000000000 Awaken the editor from that first commit $ touch "${MISCHIEF_MANAGED}" And wait for it to finish $ WAITLOCK_FILE="${JOBS_FINISHED}" sh "$TESTTMP/waitlock_editor.sh" #if skip-detection (Ensure there was no output) $ cat .foo_commit_out And observe a corrupted repository -- rev 2's linkrev is 1, which should never happen for the changelog (the linkrev should always refer to itself). $ hg debugrevlogindex -c rev linkrev nodeid p1 p2 0 0 222799e2f90b 000000000000 000000000000 1 1 6f124f6007a0 222799e2f90b 000000000000 2 1 ac80e6205bb2 222799e2f90b 000000000000 #endif #if fail-if-detected $ cat .foo_commit_out transaction abort! rollback completed note: commit message saved in .hg/last-message.txt note: use 'hg commit --logfile .hg/last-message.txt --edit' to reuse it abort: 00changelog.i: file cursor at position 249, expected 121 And no corruption in the changelog. $ hg debugrevlogindex -c rev linkrev nodeid p1 p2 0 0 222799e2f90b 000000000000 000000000000 1 1 6f124f6007a0 222799e2f90b 000000000000 (missing-correct-output !) And, because of transactions, there's none in the manifestlog either. $ hg debugrevlogindex -m rev linkrev nodeid p1 p2 0 0 7b7020262a56 000000000000 000000000000 1 1 ad3fe36d86d9 7b7020262a56 000000000000 #endif