view tests/test-win32text.t @ 44363:f7459da77f23

nodemap: introduce an option to use mmap to read the nodemap mapping

The performance and memory benefit is much greater if we don't have to copy all
the data in memory for each information. So we introduce an option (on by
default) to read the data using mmap.

This changeset is the last one definition the API for index support nodemap
data. (they have to be able to use the mmaping).

Below are some benchmark comparing the best we currently have in 5.3 with the
final step of this series (using the persistent nodemap implementation in
Rust). The benchmark run `hg perfindex` with various revset and the following
variants:

Before:

 * do not use the persistent nodemap
 * use the CPython implementation of the index for nodemap
 * use mmapping of the changelog index

After:

 * use the MixedIndex Rust code, with the NodeTree object for nodemap access
   (still in review)
 * use the persistent nodemap data from disk
 * access the persistent nodemap data through mmap
 * use mmapping of the changelog index

The persistent nodemap greatly speed up  most operation on very large
repositories. Some of the previously very fast lookup end up a bit slower because
the persistent nodemap has to be setup. However the absolute slowdown is very
small and won't matters in the big picture.

Here are some numbers (in seconds) for the reference copy of mozilla-try:

Revset            Before   After     abs-change speedup

-10000:           0.004622 0.005532   0.000910  ×   0.83
-10:              0.000050 0.000132   0.000082  ×   0.37
tip               0.000052 0.000085   0.000033  ×   0.61
0 + (-10000:)     0.028222 0.005337  -0.022885  ×   5.29
0                 0.023521 0.000084  -0.023437  × 280.01
(-10000:) + 0     0.235539 0.005308  -0.230231  ×  44.37
(-10:) + :9       0.232883 0.000180  -0.232703  ×1293.79
(-10000:) + (:99) 0.238735 0.005358  -0.233377  ×  44.55
:99 + (-10000:)   0.317942 0.005593  -0.312349  ×  56.84
:9 + (-10:)       0.313372 0.000179  -0.313193  ×1750.68
:9                0.316450 0.000143  -0.316307  ×2212.93


On smaller repositories, the cost of nodemap related operation is not as big, so
the win is much more modest. Yet it helps shaving a handful of millisecond here
and there.

Here are some numbers (in seconds) for the reference copy of mercurial:

Revset            Before   After     abs-change speedup
-10:              0.000065 0.000097   0.000032  × 0.67
tip               0.000063 0.000078   0.000015  × 0.80
0                 0.000561 0.000079  -0.000482  × 7.10
-10000:           0.004609 0.003648  -0.000961  × 1.26
0 + (-10000:)     0.005023 0.003715  -0.001307  × 1.35
(-10:) + :9       0.002187 0.000108  -0.002079  ×20.25
(-10000:) + 0     0.006252 0.003716  -0.002536  × 1.68
(-10000:) + (:99) 0.006367 0.003707  -0.002660  × 1.71
:9 + (-10:)       0.003846 0.000110  -0.003736  ×34.96
:9                0.003854 0.000099  -0.003755  ×38.92
:99 + (-10000:)   0.007644 0.003778  -0.003866  × 2.02

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

  $ hg init t
  $ cd t
  $ cat > unix2dos.py <<EOF
  > import sys
  > 
  > for path in sys.argv[1:]:
  >     data = open(path, 'rb').read()
  >     data = data.replace(b'\n', b'\r\n')
  >     open(path, 'wb').write(data)
  > EOF
  $ echo '[hooks]' >> .hg/hgrc
  $ echo 'pretxncommit.crlf = python:hgext.win32text.forbidcrlf' >> .hg/hgrc
  $ echo 'pretxnchangegroup.crlf = python:hgext.win32text.forbidcrlf' >> .hg/hgrc
  $ cat .hg/hgrc
  [hooks]
  pretxncommit.crlf = python:hgext.win32text.forbidcrlf
  pretxnchangegroup.crlf = python:hgext.win32text.forbidcrlf

  $ echo hello > f
  $ hg add f

commit should succeed

  $ hg ci -m 1

  $ hg clone . ../zoz
  updating to branch default
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ cp .hg/hgrc ../zoz/.hg
  $ "$PYTHON" unix2dos.py f

commit should fail

  $ hg ci -m 2.1
  attempt to commit or push text file(s) using CRLF line endings
  in f583ea08d42a: f
  transaction abort!
  rollback completed
  abort: pretxncommit.crlf hook failed
  [255]

  $ mv .hg/hgrc .hg/hgrc.bak

commits should succeed

  $ hg ci -m 2
  $ hg cp f g
  $ hg ci -m 2.2

push should fail

  $ hg push ../zoz
  pushing to ../zoz
  searching for changes
  adding changesets
  adding manifests
  adding file changes
  attempt to commit or push text file(s) using CRLF line endings
  in bc2d09796734: g
  in b1aa5cde7ff4: f
  
  To prevent this mistake in your local repository,
  add to Mercurial.ini or .hg/hgrc:
  
  [hooks]
  pretxncommit.crlf = python:hgext.win32text.forbidcrlf
  
  and also consider adding:
  
  [extensions]
  win32text =
  [encode]
  ** = cleverencode:
  [decode]
  ** = cleverdecode:
  transaction abort!
  rollback completed
  abort: pretxnchangegroup.crlf hook failed
  [255]

  $ mv .hg/hgrc.bak .hg/hgrc
  $ echo hello > f
  $ hg rm g

commit should succeed

  $ hg ci -m 2.3

push should succeed

  $ hg push ../zoz
  pushing to ../zoz
  searching for changes
  adding changesets
  adding manifests
  adding file changes
  added 3 changesets with 3 changes to 2 files

and now for something completely different

  $ mkdir d
  $ echo hello > d/f2
  $ "$PYTHON" unix2dos.py d/f2
  $ hg add d/f2
  $ hg ci -m 3
  attempt to commit or push text file(s) using CRLF line endings
  in 053ba1a3035a: d/f2
  transaction abort!
  rollback completed
  abort: pretxncommit.crlf hook failed
  [255]
  $ hg revert -a
  forgetting d/f2
  $ rm d/f2

  $ hg rem f
  $ hg ci -m 4

  $ "$PYTHON" -c 'open("bin", "wb").write(b"hello\x00\x0D\x0A")'
  $ hg add bin
  $ hg ci -m 5
  $ hg log -v
  changeset:   5:f0b1c8d75fce
  tag:         tip
  user:        test
  date:        Thu Jan 01 00:00:00 1970 +0000
  files:       bin
  description:
  5
  
  
  changeset:   4:77796dbcd4ad
  user:        test
  date:        Thu Jan 01 00:00:00 1970 +0000
  files:       f
  description:
  4
  
  
  changeset:   3:7c1b5430b350
  user:        test
  date:        Thu Jan 01 00:00:00 1970 +0000
  files:       f g
  description:
  2.3
  
  
  changeset:   2:bc2d09796734
  user:        test
  date:        Thu Jan 01 00:00:00 1970 +0000
  files:       g
  description:
  2.2
  
  
  changeset:   1:b1aa5cde7ff4
  user:        test
  date:        Thu Jan 01 00:00:00 1970 +0000
  files:       f
  description:
  2
  
  
  changeset:   0:fcf06d5c4e1d
  user:        test
  date:        Thu Jan 01 00:00:00 1970 +0000
  files:       f
  description:
  1
  
  
  $ hg clone . dupe
  updating to branch default
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved

  $ for x in a b c d; do echo content > dupe/$x; done
  $ hg -R dupe add
  adding dupe/a
  adding dupe/b
  adding dupe/c
  adding dupe/d
  $ "$PYTHON" unix2dos.py dupe/b dupe/c dupe/d
  $ hg -R dupe ci -m a dupe/a
  $ hg -R dupe ci -m b/c dupe/[bc]
  $ hg -R dupe ci -m d dupe/d
  $ hg -R dupe log -v
  changeset:   8:67ac5962ab43
  tag:         tip
  user:        test
  date:        Thu Jan 01 00:00:00 1970 +0000
  files:       d
  description:
  d
  
  
  changeset:   7:68c127d1834e
  user:        test
  date:        Thu Jan 01 00:00:00 1970 +0000
  files:       b c
  description:
  b/c
  
  
  changeset:   6:adbf8bf7f31d
  user:        test
  date:        Thu Jan 01 00:00:00 1970 +0000
  files:       a
  description:
  a
  
  
  changeset:   5:f0b1c8d75fce
  user:        test
  date:        Thu Jan 01 00:00:00 1970 +0000
  files:       bin
  description:
  5
  
  
  changeset:   4:77796dbcd4ad
  user:        test
  date:        Thu Jan 01 00:00:00 1970 +0000
  files:       f
  description:
  4
  
  
  changeset:   3:7c1b5430b350
  user:        test
  date:        Thu Jan 01 00:00:00 1970 +0000
  files:       f g
  description:
  2.3
  
  
  changeset:   2:bc2d09796734
  user:        test
  date:        Thu Jan 01 00:00:00 1970 +0000
  files:       g
  description:
  2.2
  
  
  changeset:   1:b1aa5cde7ff4
  user:        test
  date:        Thu Jan 01 00:00:00 1970 +0000
  files:       f
  description:
  2
  
  
  changeset:   0:fcf06d5c4e1d
  user:        test
  date:        Thu Jan 01 00:00:00 1970 +0000
  files:       f
  description:
  1
  
  
  $ hg pull dupe
  pulling from dupe
  searching for changes
  adding changesets
  adding manifests
  adding file changes
  attempt to commit or push text file(s) using CRLF line endings
  in 67ac5962ab43: d
  in 68c127d1834e: b
  in 68c127d1834e: c
  
  To prevent this mistake in your local repository,
  add to Mercurial.ini or .hg/hgrc:
  
  [hooks]
  pretxncommit.crlf = python:hgext.win32text.forbidcrlf
  
  and also consider adding:
  
  [extensions]
  win32text =
  [encode]
  ** = cleverencode:
  [decode]
  ** = cleverdecode:
  transaction abort!
  rollback completed
  abort: pretxnchangegroup.crlf hook failed
  [255]

  $ hg log -v
  changeset:   5:f0b1c8d75fce
  tag:         tip
  user:        test
  date:        Thu Jan 01 00:00:00 1970 +0000
  files:       bin
  description:
  5
  
  
  changeset:   4:77796dbcd4ad
  user:        test
  date:        Thu Jan 01 00:00:00 1970 +0000
  files:       f
  description:
  4
  
  
  changeset:   3:7c1b5430b350
  user:        test
  date:        Thu Jan 01 00:00:00 1970 +0000
  files:       f g
  description:
  2.3
  
  
  changeset:   2:bc2d09796734
  user:        test
  date:        Thu Jan 01 00:00:00 1970 +0000
  files:       g
  description:
  2.2
  
  
  changeset:   1:b1aa5cde7ff4
  user:        test
  date:        Thu Jan 01 00:00:00 1970 +0000
  files:       f
  description:
  2
  
  
  changeset:   0:fcf06d5c4e1d
  user:        test
  date:        Thu Jan 01 00:00:00 1970 +0000
  files:       f
  description:
  1
  
  
  $ rm .hg/hgrc
  $ (echo some; echo text) > f3
  $ "$PYTHON" -c 'open("f4.bat", "wb").write(b"rem empty\x0D\x0A")'
  $ hg add f3 f4.bat
  $ hg ci -m 6
  $ cat bin
  hello\x00\r (esc)
  $ cat f3
  some
  text
  $ cat f4.bat
  rem empty\r (esc)

  $ echo '[extensions]' >> .hg/hgrc
  $ echo 'win32text = ' >> .hg/hgrc
  $ echo '[decode]' >> .hg/hgrc
  $ echo '** = cleverdecode:' >> .hg/hgrc
  $ echo '[encode]' >> .hg/hgrc
  $ echo '** = cleverencode:' >> .hg/hgrc
  $ cat .hg/hgrc
  [extensions]
  win32text = 
  [decode]
  ** = cleverdecode:
  [encode]
  ** = cleverencode:

Trigger deprecation warning:

  $ hg id -t
  win32text is deprecated: https://mercurial-scm.org/wiki/Win32TextExtension
  tip

Disable warning:

  $ echo '[win32text]' >> .hg/hgrc
  $ echo 'warn = no' >> .hg/hgrc
  $ hg id -t
  tip

  $ rm f3 f4.bat bin
  $ hg co -C
  WARNING: f4.bat already has CRLF line endings
  and does not need EOL conversion by the win32text plugin.
  Before your next commit, please reconsider your encode/decode settings in 
  Mercurial.ini or $TESTTMP/t/.hg/hgrc.
  3 files updated, 0 files merged, 0 files removed, 0 files unresolved
  $ cat bin
  hello\x00\r (esc)
  $ cat f3
  some\r (esc)
  text\r (esc)
  $ cat f4.bat
  rem empty\r (esc)

  $ "$PYTHON" -c 'open("f5.sh", "wb").write(b"# empty\x0D\x0A")'
  $ hg add f5.sh
  $ hg ci -m 7
  $ cat f5.sh
  # empty\r (esc)
  $ hg cat f5.sh
  # empty
  $ echo '% just linefeed' > linefeed
  $ hg ci -qAm 8 linefeed
  $ cat linefeed
  % just linefeed
  $ hg cat linefeed
  % just linefeed
  $ hg st -q
  $ hg revert -a linefeed
  no changes needed to linefeed
  $ cat linefeed
  % just linefeed
  $ hg st -q
  $ echo modified >> linefeed
  $ hg st -q
  M linefeed
  $ hg revert -a
  reverting linefeed
  $ hg st -q
  $ cat linefeed
  % just linefeed\r (esc)

  $ cd ..