9d6ed9def3
* Minor fix * Run non-optimize FASTCOVER 5 times in benchmark * Merge fastCover into dictBuilder * Fix mixed declaration issue * Add fastcover to symbol.c * Add fastCover.c and cover.h to build * Change fastCover.c to fastcover.c * Update benchmark to run FASTCOVER in dictBuilder * Undo spliting fastcover_param into cover_param and f * Remove convert param functions * Assign f to parameter * Add zdict.h to Makefile in lib * Add cover.h to BUCK * Cast 1 to U64 before shifting * Remove trimming of zero freq head and tail in selectSegment and rebenchmark * Remove f as a separate parameter of tryParam * Read 8 bytes when d is 6 * Add trimming off zero frequency head and tail * Use best functions from COVER and remove trimming part(which leads to worse compression ratio after previous bugs were fixed) * Add finalize= argument to FASTCOVER to specify percentage of training samples passed to ZDICT_finalizeDictionary * Change nbDmer to always read 8 bytes even when d=6 * Add skip=# argument to allow skipping dmers in computeFrequency in FASTCOVER * Update comments and benchmarking result * Change default method of ZDICT_trainFromBuffer to ZDICT_optimizeTrainFromBuffer_fastCover * Add dictType enum and fix bug about passing zParam when converting to coverParam * Combine finalize and skip into a single parameter * Update acceleration parameters and benchmark on 3 sample sets * Change default splitPoint of FASTCOVER to 0.75 and benchmark first 3 sample sets * Initialize variables outside of for loop in benchmark.c * Update benchmark result for hg-manifest * Remove cover.h from install-includes * Add explanation of f * Set default compression level for trainFromBuffer to 3 * Add assertion of fastCoverParams in DiB_trainFromFiles * Add checkTotalCompressedSize function + some minor fixes * Add test for multithreading fastCovr * Initialize segmentFreqs in every FASTCOVER_selectSegment and move mutex_unnlock to end of COVER_best_finish * Free segmentFreqs * Initialize segmentFreqs before calling FASTCOVER_buildDictionary instead of in FASTCOVER_selectSegment * Add FASTCOVER_MEMMULT * Minor fix * Update benchmarking result |
||
---|---|---|
.circleci | ||
build | ||
contrib | ||
doc | ||
examples | ||
lib | ||
programs | ||
tests | ||
zlibWrapper | ||
.buckconfig | ||
.buckversion | ||
.gitattributes | ||
.gitignore | ||
.travis.yml | ||
appveyor.yml | ||
CONTRIBUTING.md | ||
COPYING | ||
LICENSE | ||
Makefile | ||
NEWS | ||
README.md | ||
TESTING.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's backed by a very fast entropy stage, provided by Huff0 and FSE library.
The project is provided as an open-source dual BSD and GPLv2 licensed C library,
and a command line utility producing and decoding .zst
, .gz
, .xz
and .lz4
files.
Should your project require another programming language,
a list of known ports and bindings is provided on Zstandard homepage.
Benchmarks
For reference, several fast compression algorithms were tested and compared
on a server running Linux Debian (Linux version 4.14.0-3-amd64
),
with a Core i7-6700K CPU @ 4.0GHz,
using lzbench, an open-source in-memory benchmark by @inikep
compiled with gcc 7.3.0,
on the Silesia compression corpus.
Compressor name | Ratio | Compression | Decompress. |
---|---|---|---|
zstd 1.3.4 -1 | 2.877 | 470 MB/s | 1380 MB/s |
zlib 1.2.11 -1 | 2.743 | 110 MB/s | 400 MB/s |
brotli 1.0.2 -0 | 2.701 | 410 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.8.1 | 2.101 | 750 MB/s | 3700 MB/s |
snappy 1.1.4 | 2.091 | 530 MB/s | 1800 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.14.0-3-amd64
)
with a Core i7-6700K CPU @ 4.0GHz,
using lzbench, an open-source in-memory benchmark by @inikep
compiled with gcc 7.3.0,
on the Silesia compression corpus.
Compression Speed vs Ratio | Decompression Speed |
---|---|
A few other algorithms can produce higher compression ratios at slower speeds, falling outside of the graph. For a larger picture including 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 instructions
Makefile
If your system is compatible with standard make
(or gmake
),
invoking make
in root directory will generate zstd
cli in root directory.
Other available options include:
make install
: create and install zstd cli, library and man pagesmake check
: create and runzstd
, tests its behavior 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.
By default, CMAKE_BUILD_TYPE
is set to Release
.
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, VS2015 and VS2017.
- Automated build scripts for Visual compiler by @KrzysFR, in
build/VS_scripts
, which will buildzstd
cli andlibzstd
library without any need to open Visual Studio solution.
Status
Zstandard is currently deployed within Facebook. It is used continuously to compress large amounts of data in multiple formats and use cases. Zstandard is considered safe for production environments.
License
Zstandard is dual-licensed under BSD and GPLv2.
Contributing
The "dev" branch is the one where all contributions are 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.