Rivoreo Source Code Repositories
src.rivoreo.one / lz4 / b5bedefabe513c810e77a64c448b00377e0a8bf0
commitb5bedefabe513c810e77a64c448b00377e0a8bf0[log] [download]
authorYann Collet <cyan@fb.com>Wed Apr 03 16:28:42 2019 -0700
committerYann Collet <cyan@fb.com>Wed Apr 03 16:28:42 2019 -0700
tree8ab482045e0e50d89b08ffc5c4ecd9d2874ffd42
parent50f01d881d0bfe0accd8f7c70937be99c403b6ef [diff]
fixed an old bug in LZ4F_flush()

which remained undetected so far,
as it requires a fairly large number of conditions to be triggered,
starting with enabling Block checksum, which is disabled by default,
and which usage is known to be extremely rare.
2 files changed
tree: 8ab482045e0e50d89b08ffc5c4ecd9d2874ffd42
  1. .circleci/
  2. .gitattributes
  3. .gitignore
  4. .travis.yml
  5. INSTALL
  6. LICENSE
  7. Makefile
  8. NEWS
  9. README.md
  10. appveyor.yml
  11. contrib/
  12. doc/
  13. examples/
  14. lib/
  15. programs/
  16. tests/
  17. visual/
README.md

LZ4 - Extremely fast compression

LZ4 is lossless compression algorithm, providing compression speed > 500 MB/s per core, scalable with multi-cores CPU. It features an extremely fast decoder, with speed in multiple GB/s per core, typically reaching RAM speed limits on multi-core systems.

Speed can be tuned dynamically, selecting an “acceleration” factor which trades compression ratio for faster speed. On the other end, a high compression derivative, LZ4_HC, is also provided, trading CPU time for improved compression ratio. All versions feature the same decompression speed.

LZ4 is also compatible with dictionary compression, and can ingest any input file as dictionary, including those created by Zstandard Dictionary Builder. (note: only the final 64KB are used).

LZ4 library is provided as open-source software using BSD 2-Clause license.

BranchStatus
masterBuild Status Build status coverity
devBuild Status Build status

Branch Policy:

  • The “master” branch is considered stable, at all times.
  • The “dev” branch is the one where all contributions must be merged before being promoted to 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.

Benchmarks

The benchmark uses lzbench, from @inikep compiled with GCC v7.3.0 on Linux 64-bits (Debian 4.15.17-1). The reference system uses a Core i7-6700K CPU @ 4.0GHz. Benchmark evaluates the compression of reference Silesia Corpus in single-thread mode.

CompressorRatioCompressionDecompression
memcpy1.00013100 MB/s13100 MB/s
LZ4 default (v1.8.2)2.101730 MB/s3900 MB/s
LZO 2.092.108630 MB/s800 MB/s
QuickLZ 1.5.02.238530 MB/s720 MB/s
Snappy 1.1.42.091525 MB/s1750 MB/s
Zstandard 1.3.4 -12.877470 MB/s1380 MB/s
LZF v3.62.073380 MB/s840 MB/s
zlib deflate 1.2.11 -12.730100 MB/s380 MB/s
LZ4 HC -9 (v1.8.2)2.72140 MB/s3920 MB/s
zlib deflate 1.2.11 -63.09934 MB/s410 MB/s

LZ4 is also compatible and optimized for x32 mode, for which it provides additional speed performance.

Installation

make
make install     # this command may require root permissions

LZ4's Makefile supports standard Makefile conventions, including staged installs, redirection, or command redefinition. It is compatible with parallel builds (-j#).

Documentation

The raw LZ4 block compression format is detailed within lz4_Block_format.

Arbitrarily long files or data streams are compressed using multiple blocks, for streaming requirements. These blocks are organized into a frame, defined into lz4_Frame_format. Interoperable versions of LZ4 must also respect the frame format.

Other source versions

Beyond the C reference source, many contributors have created versions of lz4 in multiple languages (Java, C#, Python, Perl, Ruby, etc.). A list of known source ports is maintained on the LZ4 Homepage.