view tests/svn/tags.svndump @ 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.

SVN-fs-dump-format-version: 2

UUID: a9c3b03d-cffa-4248-8023-ecf4b2bdf5d5

Revision-number: 0
Prop-content-length: 56
Content-length: 56

K 8
svn:date
V 27
2009-04-29T19:26:51.708679Z
PROPS-END

Revision-number: 1
Prop-content-length: 112
Content-length: 112

K 7
svn:log
V 10
init projA
K 10
svn:author
V 7
pmezard
K 8
svn:date
V 27
2009-04-29T19:26:52.115023Z
PROPS-END

Node-path: branches
Node-kind: dir
Node-action: add
Prop-content-length: 10
Content-length: 10

PROPS-END


Node-path: tags
Node-kind: dir
Node-action: add
Prop-content-length: 10
Content-length: 10

PROPS-END


Node-path: trunk
Node-kind: dir
Node-action: add
Prop-content-length: 10
Content-length: 10

PROPS-END


Node-path: unrelated
Node-kind: dir
Node-action: add
Prop-content-length: 10
Content-length: 10

PROPS-END


Revision-number: 2
Prop-content-length: 105
Content-length: 105

K 7
svn:log
V 4
adda
K 10
svn:author
V 7
pmezard
K 8
svn:date
V 27
2009-04-29T19:26:53.109819Z
PROPS-END

Node-path: trunk/a
Node-kind: file
Node-action: add
Prop-content-length: 10
Text-content-length: 2
Text-content-md5: 60b725f10c9c85c70d97880dfe8191b3
Text-content-sha1: 3f786850e387550fdab836ed7e6dc881de23001b
Content-length: 12

PROPS-END
a


Revision-number: 3
Prop-content-length: 108
Content-length: 108

K 7
svn:log
V 7
changea
K 10
svn:author
V 7
pmezard
K 8
svn:date
V 27
2009-04-29T19:26:54.073017Z
PROPS-END

Node-path: trunk/a
Node-kind: file
Node-action: change
Text-content-length: 4
Text-content-md5: 0d227f1abf8c2932d342e9b99cc957eb
Text-content-sha1: d7c8127a20a396cff08af086a1c695b0636f0c29
Content-length: 4

a
a


Revision-number: 4
Prop-content-length: 109
Content-length: 109

K 7
svn:log
V 8
changea2
K 10
svn:author
V 7
pmezard
K 8
svn:date
V 27
2009-04-29T19:26:55.076032Z
PROPS-END

Node-path: trunk/a
Node-kind: file
Node-action: change
Text-content-length: 6
Text-content-md5: 7d4ebf8f298d22fc349a91725b00af1c
Text-content-sha1: 92f31bc48f52339253fce6cad9f2f0c95b302f7e
Content-length: 6

a
a
a


Revision-number: 5
Prop-content-length: 117
Content-length: 117

K 7
svn:log
V 15
unrelatedchange
K 10
svn:author
V 7
pmezard
K 8
svn:date
V 27
2009-04-29T19:26:56.095784Z
PROPS-END

Node-path: unrelated/dummy
Node-kind: file
Node-action: add
Prop-content-length: 10
Text-content-length: 2
Text-content-md5: 60b725f10c9c85c70d97880dfe8191b3
Text-content-sha1: 3f786850e387550fdab836ed7e6dc881de23001b
Content-length: 12

PROPS-END
a


Revision-number: 6
Prop-content-length: 131
Content-length: 131

K 7
svn:log
V 29
tagging trunk.v1 trunk.badtag
K 10
svn:author
V 7
pmezard
K 8
svn:date
V 27
2009-04-29T19:27:00.074864Z
PROPS-END

Node-path: tags/trunk.badtag
Node-kind: dir
Node-action: add
Node-copyfrom-rev: 5
Node-copyfrom-path: trunk


Node-path: tags/trunk.v1
Node-kind: dir
Node-action: add
Node-copyfrom-rev: 5
Node-copyfrom-path: trunk


Revision-number: 7
Prop-content-length: 109
Content-length: 109

K 7
svn:log
V 8
changea3
K 10
svn:author
V 7
pmezard
K 8
svn:date
V 27
2009-04-29T19:27:01.073910Z
PROPS-END

Node-path: trunk/a
Node-kind: file
Node-action: change
Text-content-length: 8
Text-content-md5: d12178e74d8774e34361e0a08d1fd2b7
Text-content-sha1: cce0b2a263066e26610df9082b7b3c810f71262e
Content-length: 8

a
a
a
a


Revision-number: 8
Prop-content-length: 118
Content-length: 118

K 7
svn:log
V 16
fix trunk.badtag
K 10
svn:author
V 7
pmezard
K 8
svn:date
V 27
2009-04-29T19:27:04.073542Z
PROPS-END

Node-path: tags/trunk.goodtag
Node-kind: dir
Node-action: add
Node-copyfrom-rev: 7
Node-copyfrom-path: tags/trunk.badtag


Node-path: tags/trunk.badtag
Node-action: delete


Revision-number: 9
Prop-content-length: 108
Content-length: 108

K 7
svn:log
V 7
changea
K 10
svn:author
V 7
pmezard
K 8
svn:date
V 27
2009-04-29T19:27:05.095204Z
PROPS-END

Node-path: trunk/a
Node-kind: file
Node-action: change
Text-content-length: 10
Text-content-md5: 3f65cbdca1b64c2f8f574fccae24f3a4
Text-content-sha1: 5c077263421de2abff9dbe867921bc6810811aa2
Content-length: 10

a
a
a
a
a


Revision-number: 10
Prop-content-length: 115
Content-length: 115

K 7
svn:log
V 13
removegoodtag
K 10
svn:author
V 7
pmezard
K 8
svn:date
V 27
2009-04-29T19:27:06.089193Z
PROPS-END

Node-path: tags/trunk.goodtag
Node-action: delete


Revision-number: 11
Prop-content-length: 117
Content-length: 117

K 7
svn:log
V 15
recreategoodtag
K 10
svn:author
V 7
pmezard
K 8
svn:date
V 27
2009-04-29T19:27:09.070471Z
PROPS-END

Node-path: tags/trunk.goodtag
Node-kind: dir
Node-action: add
Node-copyfrom-rev: 10
Node-copyfrom-path: trunk