view tests/test-bheads.t @ 30442:41a8106789ca

util: implement zstd compression engine

Now that zstd is vendored and being built (in some configurations), we
can implement a compression engine for zstd!

The zstd engine is a little different from existing engines. Because
it may not always be present, we have to defer load the module in case
importing it fails. We facilitate this via a cached property that holds
a reference to the module or None. The "available" method is
implemented to reflect reality.

The zstd engine declares its ability to handle bundles using the
"zstd" human name and the "ZS" internal name. The latter was chosen
because internal names are 2 characters (by only convention I think)
and "ZS" seems reasonable.

The engine, like others, supports specifying the compression level.
However, there are no consumers of this API that yet pass in that
argument. I have plans to change that, so stay tuned.

Since all we need to do to support bundle generation with a new
compression engine is implement and register the compression engine,
bundle generation with zstd "just works!" Tests demonstrating this
have been added.

How does performance of zstd for bundle generation compare? On the
mozilla-unified repo, `hg bundle --all -t <engine>-v2` yields the
following on my i7-6700K on Linux:

engine        CPU time     bundle size   vs orig size   throughput
none            97.0s     4,054,405,584     100.0%       41.8 MB/s
bzip2 (l=9)    393.6s       975,343,098      24.0%       10.3 MB/s
gzip (l=6)     184.0s     1,140,533,074      28.1%       22.0 MB/s
zstd (l=1)     108.2s     1,119,434,718      27.6%       37.5 MB/s
zstd (l=2)     111.3s     1,078,328,002      26.6%       36.4 MB/s
zstd (l=3)     113.7s     1,011,823,727      25.0%       35.7 MB/s
zstd (l=4)     116.0s     1,008,965,888      24.9%       35.0 MB/s
zstd (l=5)     121.0s       977,203,148      24.1%       33.5 MB/s
zstd (l=6)     131.7s       927,360,198      22.9%       30.8 MB/s
zstd (l=7)     139.0s       912,808,505      22.5%       29.2 MB/s
zstd (l=12)    198.1s       854,527,714      21.1%       20.5 MB/s
zstd (l=18)    681.6s       789,750,690      19.5%        5.9 MB/s

On compression, zstd for bundle generation delivers:

* better compression than gzip with significantly less CPU utilization
* better than bzip2 compression ratios while still being significantly
  faster than gzip
* ability to aggressively tune compression level to achieve
  significantly smaller bundles

That last point is important. With clone bundles, a server can
pre-generate a bundle file, upload it to a static file server, and
redirect clients to transparently download it during clone. The server
could choose to produce a zstd bundle with the highest compression
settings possible. This would take a very long time - a magnitude
longer than a typical zstd bundle generation - but the result would
be hundreds of megabytes smaller! For the clone volume we do at
Mozilla, this could translate to petabytes of bandwidth savings
per year and faster clones (due to smaller transfer size).

I don't have detailed numbers to report on decompression. However,
zstd decompression is fast: >1 GB/s output throughput on this machine,
even through the Python bindings. And it can do that regardless of the
compression level of the input. By the time you have enough data to
worry about overhead of decompression, you have plenty of other things
to worry about performance wise.

zstd is wins all around. I can't wait to implement support for it
on the wire protocol and in revlogs.

  $ heads()
  > {
  >    hg heads --template '{rev}: {desc|firstline|strip} ({branches})\n' "$@"
  > }

  $ hg init a
  $ cd a
  $ echo 'root' >root
  $ hg add root
  $ hg commit -m "Adding root node"
  $ heads
  0: Adding root node ()
-------
  $ heads .
  0: Adding root node ()

=======

  $ echo 'a' >a
  $ hg add a
  $ hg branch a
  marked working directory as branch a
  (branches are permanent and global, did you want a bookmark?)
  $ hg commit -m "Adding a branch"
  $ heads
  1: Adding a branch (a)
  0: Adding root node ()
-------
  $ heads .
  1: Adding a branch (a)

=======

  $ hg update -C 0
  0 files updated, 0 files merged, 1 files removed, 0 files unresolved
  $ echo 'b' >b
  $ hg add b
  $ hg branch b
  marked working directory as branch b
  $ hg commit -m "Adding b branch"
  $ heads
  2: Adding b branch (b)
  1: Adding a branch (a)
  0: Adding root node ()
-------
  $ heads .
  2: Adding b branch (b)

=======

  $ echo 'bh1' >bh1
  $ hg add bh1
  $ hg commit -m "Adding b branch head 1"
  $ heads
  3: Adding b branch head 1 (b)
  1: Adding a branch (a)
  0: Adding root node ()
-------
  $ heads .
  3: Adding b branch head 1 (b)

=======

  $ hg update -C 2
  0 files updated, 0 files merged, 1 files removed, 0 files unresolved
  $ echo 'bh2' >bh2
  $ hg add bh2
  $ hg commit -m "Adding b branch head 2"
  created new head
  $ heads
  4: Adding b branch head 2 (b)
  3: Adding b branch head 1 (b)
  1: Adding a branch (a)
  0: Adding root node ()
  $ heads .
  4: Adding b branch head 2 (b)
  3: Adding b branch head 1 (b)

=======

  $ hg update -C 2
  0 files updated, 0 files merged, 1 files removed, 0 files unresolved
  $ echo 'bh3' >bh3
  $ hg add bh3
  $ hg commit -m "Adding b branch head 3"
  created new head
  $ heads
  5: Adding b branch head 3 (b)
  4: Adding b branch head 2 (b)
  3: Adding b branch head 1 (b)
  1: Adding a branch (a)
  0: Adding root node ()
-------
  $ heads .
  5: Adding b branch head 3 (b)
  4: Adding b branch head 2 (b)
  3: Adding b branch head 1 (b)

=======

  $ hg merge 4
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  (branch merge, don't forget to commit)
  $ hg commit -m "Merging b branch head 2 and b branch head 3"
  $ heads
  6: Merging b branch head 2 and b branch head 3 (b)
  3: Adding b branch head 1 (b)
  1: Adding a branch (a)
  0: Adding root node ()
-------
  $ heads .
  6: Merging b branch head 2 and b branch head 3 (b)
  3: Adding b branch head 1 (b)

=======

  $ echo 'c' >c
  $ hg add c
  $ hg branch c
  marked working directory as branch c
  $ hg commit -m "Adding c branch"
  $ heads
  7: Adding c branch (c)
  6: Merging b branch head 2 and b branch head 3 (b)
  3: Adding b branch head 1 (b)
  1: Adding a branch (a)
  0: Adding root node ()
-------
  $ heads .
  7: Adding c branch (c)

=======

  $ heads -r 3 .
  no open branch heads found on branches c (started at 3)
  [1]
  $ heads -r 2 .
  7: Adding c branch (c)
-------
  $ hg update -C 4
  0 files updated, 0 files merged, 2 files removed, 0 files unresolved
-------
  $ heads -r 3 .
  3: Adding b branch head 1 (b)
-------
  $ heads -r 2 .
  6: Merging b branch head 2 and b branch head 3 (b)
  3: Adding b branch head 1 (b)
-------
  $ heads -r 7 .
  no open branch heads found on branches b (started at 7)
  [1]

=======

  $ for i in 0 1 2 3 4 5 6 7; do
  >     hg update -C "$i"
  >     heads
  >     echo '-------'
  >     heads .
  >     echo '-------'
  > done
  0 files updated, 0 files merged, 2 files removed, 0 files unresolved
  7: Adding c branch (c)
  6: Merging b branch head 2 and b branch head 3 (b)
  3: Adding b branch head 1 (b)
  1: Adding a branch (a)
  0: Adding root node ()
  -------
  0: Adding root node ()
  -------
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  7: Adding c branch (c)
  6: Merging b branch head 2 and b branch head 3 (b)
  3: Adding b branch head 1 (b)
  1: Adding a branch (a)
  0: Adding root node ()
  -------
  1: Adding a branch (a)
  -------
  1 files updated, 0 files merged, 1 files removed, 0 files unresolved
  7: Adding c branch (c)
  6: Merging b branch head 2 and b branch head 3 (b)
  3: Adding b branch head 1 (b)
  1: Adding a branch (a)
  0: Adding root node ()
  -------
  6: Merging b branch head 2 and b branch head 3 (b)
  3: Adding b branch head 1 (b)
  -------
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  7: Adding c branch (c)
  6: Merging b branch head 2 and b branch head 3 (b)
  3: Adding b branch head 1 (b)
  1: Adding a branch (a)
  0: Adding root node ()
  -------
  6: Merging b branch head 2 and b branch head 3 (b)
  3: Adding b branch head 1 (b)
  -------
  1 files updated, 0 files merged, 1 files removed, 0 files unresolved
  7: Adding c branch (c)
  6: Merging b branch head 2 and b branch head 3 (b)
  3: Adding b branch head 1 (b)
  1: Adding a branch (a)
  0: Adding root node ()
  -------
  6: Merging b branch head 2 and b branch head 3 (b)
  3: Adding b branch head 1 (b)
  -------
  1 files updated, 0 files merged, 1 files removed, 0 files unresolved
  7: Adding c branch (c)
  6: Merging b branch head 2 and b branch head 3 (b)
  3: Adding b branch head 1 (b)
  1: Adding a branch (a)
  0: Adding root node ()
  -------
  6: Merging b branch head 2 and b branch head 3 (b)
  3: Adding b branch head 1 (b)
  -------
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  7: Adding c branch (c)
  6: Merging b branch head 2 and b branch head 3 (b)
  3: Adding b branch head 1 (b)
  1: Adding a branch (a)
  0: Adding root node ()
  -------
  6: Merging b branch head 2 and b branch head 3 (b)
  3: Adding b branch head 1 (b)
  -------
  1 files updated, 0 files merged, 0 files removed, 0 files unresolved
  7: Adding c branch (c)
  6: Merging b branch head 2 and b branch head 3 (b)
  3: Adding b branch head 1 (b)
  1: Adding a branch (a)
  0: Adding root node ()
  -------
  7: Adding c branch (c)
  -------

=======

  $ for i in a b c z; do
  >     heads "$i"
  >     echo '-------'
  > done
  1: Adding a branch (a)
  -------
  6: Merging b branch head 2 and b branch head 3 (b)
  3: Adding b branch head 1 (b)
  -------
  7: Adding c branch (c)
  -------
  abort: unknown revision 'z'!
  -------

=======

  $ heads 0 1 2 3 4 5 6 7
  7: Adding c branch (c)
  6: Merging b branch head 2 and b branch head 3 (b)
  3: Adding b branch head 1 (b)
  1: Adding a branch (a)
  0: Adding root node ()

Topological heads:

  $ heads -t
  7: Adding c branch (c)
  3: Adding b branch head 1 (b)
  1: Adding a branch (a)

  $ cd ..
______________

"created new head" message tests

  $ hg init newheadmsg
  $ cd newheadmsg

Init: no msg

  $ echo 1 > a
  $ hg ci -Am "a0: Initial root"
  adding a
  $ echo 2 >> a
  $ hg ci -m "a1 (HN)"

  $ hg branch b
  marked working directory as branch b
  (branches are permanent and global, did you want a bookmark?)
  $ echo 1 > b
  $ hg ci -Am "b2: Initial root for branch b"
  adding b
  $ echo 2 >> b
  $ hg ci -m "b3 (HN)"

Case NN: msg

  $ hg up -q null
  $ hg branch -f b
  marked working directory as branch b
  $ echo 1 > bb
  $ hg ci -Am "b4 (NN): new topo root for branch b"
  adding bb
  created new head

Case HN: no msg

  $ echo 2 >> bb
  $ hg ci -m "b5 (HN)"

Case BN: msg

  $ hg branch -f default
  marked working directory as branch default
  $ echo 1 > aa
  $ hg ci -Am "a6 (BN): new branch root"
  adding aa
  created new head

Case CN: msg

  $ hg up -q 4
  $ echo 3 >> bbb
  $ hg ci -Am "b7 (CN): regular new head"
  adding bbb
  created new head

Case BB: msg

  $ hg up -q 4
  $ hg merge -q 3
  $ hg branch -f default
  marked working directory as branch default
  $ hg ci -m "a8 (BB): weird new branch root"
  created new head

Case CB: msg

  $ hg up -q 4
  $ hg merge -q 1
  $ hg ci -m "b9 (CB): new head from branch merge"
  created new head

Case HB: no msg

  $ hg up -q 7
  $ hg merge -q 6
  $ hg ci -m "b10 (HB): continuing head from branch merge"

Case CC: msg

  $ hg up -q 4
  $ hg merge -q 2
  $ hg ci -m "b11 (CC): new head from merge"
  created new head

Case CH: no msg

  $ hg up -q 2
  $ hg merge -q 10
  $ hg ci -m "b12 (CH): continuing head from merge"

Case HH: no msg

  $ hg merge -q 3
  $ hg ci -m "b12 (HH): merging two heads"

  $ cd ..