view tests/test-merge-symlinks.t @ 38732:be4984261611

merge: mark file gets as not thread safe (issue5933)

In default installs, this has the effect of disabling the thread-based
worker on Windows when manifesting files in the working directory. My
measurements have shown that with revlog-based repositories, Mercurial
spends a lot of CPU time in revlog code resolving file data. This ends
up incurring a lot of context switching across threads and slows down
`hg update` operations when going from an empty working directory to
the tip of the repo.

On mozilla-unified (246,351 files) on an i7-6700K (4+4 CPUs):

before: 487s wall
after:  360s wall (equivalent to worker.enabled=false)
cpus=2: 379s wall

Even with only 2 threads, the thread pool is still slower.

The introduction of the thread-based worker (02b36e860e0b) states that
it resulted in a "~50%" speedup for `hg sparse --enable-profile` and
`hg sparse --disable-profile`. This disagrees with my measurement
above. I theorize a few reasons for this:

1) Removal of files from the working directory is I/O - not CPU - bound
   and should benefit from a thread pool (unless I/O is insanely fast
   and the GIL release is near instantaneous). So tests like `hg sparse
   --enable-profile` may exercise deletion throughput and aren't good
   benchmarks for worker tasks that are CPU heavy.
2) The patch was authored by someone at Facebook. The results were
   likely measured against a repository using remotefilelog. And I
   believe that revision retrieval during working directory updates with
   remotefilelog will often use a remote store, thus being I/O and not
   CPU bound. This probably resulted in an overstated performance gain.

Since there appears to be a need to enable the thread-based worker with
some stores, I've made the flagging of file gets as thread safe
configurable. I've made it experimental because I don't want to formalize
a boolean flag for this option and because this attribute is best
captured against the store implementation. But we don't have a proper
store API for this yet. I'd rather cross this bridge later.

It is possible there are revlog-based repositories that do benefit from
a thread-based worker. I didn't do very comprehensive testing. If there
are, we may want to devise a more proper algorithm for whether to use
the thread-based worker, including possibly config options to limit the
number of threads to use. But until I see evidence that justifies
complexity, simplicity wins.

Differential Revision: https://phab.mercurial-scm.org/D3963

  $ cat > echo.py <<EOF
  > #!$PYTHON
  > from __future__ import absolute_import, print_function
  > import os
  > import sys
  > try:
  >     import msvcrt
  >     msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
  >     msvcrt.setmode(sys.stderr.fileno(), os.O_BINARY)
  > except ImportError:
  >     pass
  > 
  > for k in ('HG_FILE', 'HG_MY_ISLINK', 'HG_OTHER_ISLINK', 'HG_BASE_ISLINK'):
  >     print(k, os.environ[k])
  > EOF

Create 2 heads containing the same file, once as
a file, once as a link. Bundle was generated with:

# hg init t
# cd t
# echo a > a
# hg ci -qAm t0 -d '0 0'
# echo l > l
# hg ci -qAm t1 -d '1 0'
# hg up -C 0
# ln -s a l
# hg ci -qAm t2 -d '2 0'
# echo l2 > l2
# hg ci -qAm t3 -d '3 0'

  $ hg init t
  $ cd t
  $ hg -q unbundle "$TESTDIR/bundles/test-merge-symlinks.hg"
  $ hg up -C 3
  3 files updated, 0 files merged, 0 files removed, 0 files unresolved

Merge them and display *_ISLINK vars
merge heads

  $ hg merge --tool="$PYTHON ../echo.py"
  merging l
  HG_FILE l
  HG_MY_ISLINK 1
  HG_OTHER_ISLINK 0
  HG_BASE_ISLINK 0
  0 files updated, 1 files merged, 0 files removed, 0 files unresolved
  (branch merge, don't forget to commit)

Test working directory symlink bit calculation wrt copies,
especially on non-supporting systems.
merge working directory

  $ hg up -C 2
  1 files updated, 0 files merged, 1 files removed, 0 files unresolved
  $ hg copy l l2
  $ HGMERGE="$PYTHON ../echo.py" hg up 3
  merging l2
  HG_FILE l2
  HG_MY_ISLINK 1
  HG_OTHER_ISLINK 0
  HG_BASE_ISLINK 0
  0 files updated, 1 files merged, 0 files removed, 0 files unresolved

  $ cd ..