AuroraMiddleware/zstd
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
2,063 Commits 1 Branch 0 Tags 27 MiB
C 83.9%
C++ 6.8%
Shell 2.8%
Python 2.2%
Makefile 2.1%
Other 2%
10bfd0c0d5
Go to file
Nick Terrell 10bfd0c0d5 Fix ZSTD_execSequence() performance regression 
Commit ae1cb3b3d0 caused the regression.
It is an instruction alignment issue, because if it is `U64 i` instead
of `U32 i`, the regression returns.  This patch fixes the regression
in gcc, but only gets some of the clang performance back.

Benchmarks:
Run on `silesia.tar`.  I only show levels 1-5 because the performance
regression was uniform across all levels.  I did one run on levels
1-19 and it looked good.

| Build | Level | Before | While | After |
|-------|-------|-------:|------:|------:|
| gcc   |     1 |  931.4 | 904.4 | 932.8 |
| gcc   |     2 |  849.1 | 822.6 | 851.2 |
| gcc   |     3 |  815.6 | 790.6 | 818.9 |
| gcc   |     4 |  794.1 | 770.7 | 798.0 |
| gcc   |     5 |  785.7 | 760.7 | 788.8 |
| clang |     1 |  705.5 | 683.2 | 693.8 |
| clang |     2 |  670.0 | 649.2 | 660.7 |
| clang |     3 |  659.6 | 639.8 | 651.4 |
| clang |     4 |  652.5 | 634.7 | 645.9 |
| clang |     5 |  646.9 | 625.5 | 637.7 |
2016-10-27 16:19:57 -07:00
build Windows resources moved to programs/windres/ 2016-10-25 10:34:41 +02:00
contrib added doc\zstd_manual.html 2016-10-24 16:07:53 +02:00
doc images/ moved to doc/images/ 2016-10-25 10:05:20 +02:00
examples minor const added 2016-10-26 18:44:59 -07:00
lib Fix ZSTD_execSequence() performance regression 2016-10-27 16:19:57 -07:00
programs Windows resources moved to programs/windres/ 2016-10-25 10:34:41 +02:00
tests added ZSTD_initDStream_usingDDict() . 2016-10-25 17:47:02 -07:00
zlibWrapper zstd_compression_format.md moved to doc/ 2016-10-24 15:58:07 +02:00
.coverity.yml fixed issue with small dictionary 2016-07-14 23:27:31 +02:00
.gitattributes zstd.exe has FileVersion and ProductVersion 2016-09-13 13:53:43 +02:00
.gitignore updated .gitignore 2016-09-28 13:23:11 +02:00
.travis.yml zstd.h: updated comments 2016-10-06 13:23:52 +02:00
appveyor.yml [pzstd] Add tests to appveyor MinGW64 2016-09-22 19:00:54 -07:00
CONTRIBUTING.md added boilerplate 2016-08-30 11:06:28 -07:00
LICENSE added boilerplate 2016-08-30 11:06:28 -07:00
LICENSE-examples added boilerplate 2016-08-30 11:06:28 -07:00
Makefile updated visual projects 2016-10-12 15:29:22 -07:00
NEWS print one global summary (instead of one per file) 2016-10-26 18:37:29 -07:00
PATENTS added boilerplate 2016-08-30 11:06:28 -07:00
README.md images/ moved to doc/images/ 2016-10-25 10:05:20 +02:00

README.md

Zstd, short for Zstandard, 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. For other programming languages, you can consult a list of known ports on Zstandard homepage.

Branch Status
master Build Status
dev Build Status

As a reference, several fast compression algorithms were tested and compared on a Core i7-3930K CPU @ 4.5GHz, using lzbench, an open-source in-memory benchmark by @inikep compiled with GCC 5.4.0, with the Silesia compression corpus.

Name Ratio C.speed D.speed
MB/s MB/s
zstd 0.8.2 -1 2.877 330 940
zlib 1.2.8 -1 2.730 95 360
brotli 0.4 -0 2.708 320 375
QuickLZ 1.5 2.237 510 605
LZO 2.09 2.106 610 870
LZ4 r131 2.101 620 3100
Snappy 1.1.3 2.091 480 1600
LZF 3.6 2.077 375 790

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 Core i7-3930K CPU @ 4.5GHz, using lzbench, an open-source in-memory benchmark by @inikep compiled with GCC 5.2.1, on the Silesia compression corpus.

Compression Speed vs Ratio Decompression Speed
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 achieve any significant compression.

This problem is common to many compression algorithms. The reason is, compression algorithms learn from past data how to compress future data. But at the beginning of a new file, 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, by providing it with a few samples. The result of the training is stored in a file called "dictionary", which can be loaded before compression and decompression. Using this dictionary, the compression ratio achievable on small data improves dramatically:

Compressing Small Data

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

Dictionary works if there is some correlation in a family of small data (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 rely more and more on previously decoded content to compress the rest of the file.

Dictionary compression How To :

  1. Create the dictionary

zstd --train FullPathToTrainingSet/* -o dictionaryName

  1. Compress with dictionary

zstd FILE -D dictionaryName

  1. Decompress with dictionary

zstd --decompress FILE.zst -D dictionaryName

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.

Visual (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.