b4d460f32cc42d237a44172f3f9975fd39637c5f - platform/external/zstd

commit	b4d460f32cc42d237a44172f3f9975fd39637c5f	[log] [tgz]
author	Yann Collet <cyan@fb.com>	Thu Jul 20 01:13:14 2017 -0700
committer	Yann Collet <cyan@fb.com>	Thu Jul 20 01:13:14 2017 -0700
tree	fb7ac0d21eb2ad095ed9b4dd1e35afb17bb4f817
parent	1ca128868912a978d815663bce9583520e47ace5 [diff]

tree: fb7ac0d21eb2ad095ed9b4dd1e35afb17bb4f817

README.md

Zstandard, or zstd as short version, is a fast lossless compression algorithm, targeting real-time compression scenarios at zlib-level and better compression ratios.

It is provided as an open-source BSD-licensed C library, and a command line utility producing and decoding .zst and .gz files. For other programming languages, you can consult a list of known ports on Zstandard homepage.

dev branch status

As a reference, several fast compression algorithms were tested and compared on a server running Linux Debian (Linux version 4.8.0-1-amd64), with a Core i7-6700K CPU @ 4.0GHz, using lzbench, an open-source in-memory benchmark by @inikep compiled with GCC 6.3.0, on the Silesia compression corpus.

Compressor name	Ratio	Compression	Decompress.
zstd 1.1.3 -1	2.877	430 MB/s	1110 MB/s
zlib 1.2.8 -1	2.743	110 MB/s	400 MB/s
brotli 0.5.2 -0	2.708	400 MB/s	430 MB/s
quicklz 1.5.0 -1	2.238	550 MB/s	710 MB/s
lzo1x 2.09 -1	2.108	650 MB/s	830 MB/s
lz4 1.7.5	2.101	720 MB/s	3600 MB/s
snappy 1.1.3	2.091	500 MB/s	1650 MB/s
lzf 3.6 -1	2.077	400 MB/s	860 MB/s

Zstd can also offer stronger compression ratios at the cost of compression speed. Speed vs Compression trade-off is configurable by small increments. Decompression speed is preserved and remains roughly the same at all settings, a property shared by most LZ compression algorithms, such as zlib or lzma.

The following tests were run on a server running Linux Debian (Linux version 4.8.0-1-amd64) with a Core i7-6700K CPU @ 4.0GHz, using lzbench, an open-source in-memory benchmark by @inikep compiled with GCC 6.3.0, on the Silesia compression corpus.

Compression Speed vs Ratio	Decompression Speed

Several algorithms can produce higher compression ratios, but at slower speeds, falling outside of the graph. For a larger picture including very slow modes, click on this link .

The case for Small Data compression

Previous charts provide results applicable to typical file and stream scenarios (several MB). Small data comes with different perspectives.

The smaller the amount of data to compress, the more difficult it is to compress. This problem is common to all compression algorithms, and reason is, compression algorithms learn from past data how to compress future data. But at the beginning of a new data set, there is no "past" to build upon.

To solve this situation, Zstd offers a training mode, which can be used to tune the algorithm for a selected type of data. Training Zstandard is achieved by providing it with a few samples (one file per sample). The result of this training is stored in a file called "dictionary", which must be loaded before compression and decompression. Using this dictionary, the compression ratio achievable on small data improves dramatically.

The following example uses the github-users sample set, created from github public API. It consists of roughly 10K records weighing about 1KB each.

Compression Ratio	Compression Speed	Decompression Speed

These compression gains are achieved while simultaneously providing faster compression and decompression speeds.

Training works if there is some correlation in a family of small data samples. The more data-specific a dictionary is, the more efficient it is (there is no universal dictionary). Hence, deploying one dictionary per type of data will provide the greatest benefits. Dictionary gains are mostly effective in the first few KB. Then, the compression algorithm will gradually use previously decoded content to better compress the rest of the file.

Dictionary compression How To :

Create the dictionary

zstd --train FullPathToTrainingSet/* -o dictionaryName

Compress with dictionary

zstd -D dictionaryName FILE

Decompress with dictionary

zstd -D dictionaryName --decompress FILE.zst

Build

Once you have the repository cloned, there are multiple ways provided to build Zstandard.

Makefile

If your system is compatible with a standard make (or gmake) binary generator, you can simply run it at the root directory. It will generate zstd within root directory.

Other available options include :

make install : create and install zstd binary, library and man page
make test : create and run zstd and test tools on local platform

cmake

A cmake project generator is provided within build/cmake. It can generate Makefiles or other build scripts to create zstd binary, and libzstd dynamic and static libraries.

Meson

A Meson project is provided within contrib/meson.

Visual Studio (Windows)

Going into build directory, you will find additional possibilities :

Projects for Visual Studio 2005, 2008 and 2010
- VS2010 project is compatible with VS2012, VS2013 and VS2015
Automated build scripts for Visual compiler by @KrzysFR , in build/VS_scripts, which will build zstd cli and libzstd library without any need to open Visual Studio solution.

Status

Zstandard is currently deployed within Facebook. It is used daily to compress and decompress very large amounts of data in multiple formats and use cases. Zstandard is considered safe for production environments.

License

Zstandard is BSD-licensed. We also provide an additional patent grant.

Contributing

The "dev" branch is the one where all contributions will be merged before reaching "master". If you plan to propose a patch, please commit into the "dev" branch or its own feature branch. Direct commit to "master" are not permitted. For more information, please read CONTRIBUTING.

Miscellaneous

Zstd entropy stage is provided by Huff0 and FSE, from Finite State Entropy library.