view tests/test-nointerrupt.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

#require no-windows no-rhg

XXX-RHG this test hangs if `hg` is really `rhg`. This was hidden by the use of
`alias hg=rhg` by run-tests.py. With such alias removed, this test is revealed
buggy. This need to be resolved sooner than later.

Dummy extension simulating unsafe long running command
  $ SYNC_FILE="$TESTTMP/sync-file"
  $ export SYNC_FILE
  $ DONE_FILE="$TESTTMP/done-file"
  $ export DONE_FILE
  $ 
  $ cat > wait_ext.py <<EOF
  > import os
  > import time
  > 
  > from mercurial.i18n import _
  > from mercurial import registrar
  > from mercurial import testing
  > 
  > cmdtable = {}
  > command = registrar.command(cmdtable)
  > 
  > @command(b'wait-signal', [], _(b'SYNC_FILE DONE_FILE'), norepo=True)
  > def sleep(ui, sync_file=b"$SYNC_FILE", done_file=b"$DONE_FILE", **opts):
  >     start = time.time()
  >     with ui.uninterruptible():
  >         testing.write_file(sync_file, b'%d' % os.getpid())
  >         testing.wait_file(done_file)
  >         # make sure we get rescheduled and the signal get a chance to be handled
  >         time.sleep(0.1)
  >         ui.warn(b"end of unsafe operation\n")
  >     ui.warn(b"%d second(s) passed\n" % int(time.time() - start))
  > EOF

  $ cat > send-signal.sh << EOF
  > #!/bin/sh
  > SIG=\$1
  > if [ -z "\$SIG" ]; then
  >    echo "send-signal.sh requires one argument" >&2
  >    exit 1
  > fi
  > "$RUNTESTDIR/testlib/wait-on-file" 10 "$SYNC_FILE" || exit 2
  > kill -s \$SIG \`cat "$SYNC_FILE"\`
  > sleep 1
  > touch "$DONE_FILE"
  > EOF

#if no-windows
  $ chmod +x send-signal.sh
#endif

Kludge to emulate timeout(1) which is not generally available.

Set up repository
  $ hg init repo
  $ cd repo
  $ cat >> $HGRCPATH << EOF
  > [extensions]
  > wait_ext = $TESTTMP/wait_ext.py
  > EOF


Test ctrl-c
  $ rm -f $SYNC_FILE $DONE_FILE
  $ sh -c "../send-signal.sh INT" &
  $ hg wait-signal
  interrupted!
  [255]

  $ cat >> $HGRCPATH << EOF
  > [experimental]
  > nointerrupt = yes
  > EOF

  $ rm -f $SYNC_FILE $DONE_FILE
  $ sh -c "../send-signal.sh INT" &
  $ hg wait-signal
  interrupted!
  [255]

  $ cat >> $HGRCPATH << EOF
  > [experimental]
  > nointerrupt-interactiveonly = False
  > EOF

  $ rm -f $SYNC_FILE $DONE_FILE
  $ sh -c "../send-signal.sh INT" &
  $ hg wait-signal
  shutting down cleanly
  press ^C again to terminate immediately (dangerous)
  end of unsafe operation
  interrupted!
  [255]