Clone this repo:

Branches

  1. 267c3ea Project import generated by Copybara. by Unknown Author · 4 weeks ago main
  2. 30df9f9 Initial commit by Vinny · 4 weeks ago

zlib-ng

zlib data compression library for the next generation systems

Maintained by Hans Kristian Rosbach aka Dead2 (zlib-ng àt circlestorm dót org)

CIStatus
GitHub ActionsMaster Branch Status Master Branch Status Master Branch Status
BuildkiteBuild status
CodeFactorCodeFactor
OSS-FuzzFuzzing Status
Codecovcodecov.io

Features

  • Zlib compatible API with support for dual-linking
  • Modernized native API based on zlib API for ease of porting
  • Modern C11 syntax and a clean code layout
  • Deflate medium and quick algorithms based on Intel’s zlib fork
  • Support for CPU intrinsics when available
    • Adler32 implementation using SSSE3, AVX2, AVX512, AVX512-VNNI, Neon, VMX & VSX
    • CRC32-B implementation using PCLMULQDQ, VPCLMULQDQ, ACLE, & IBM Z
    • Hash table implementation using CRC32-C intrinsics on x86 and ARM
    • Slide hash implementations using SSE2, AVX2, Neon, VMX & VSX
    • Compare256 implementations using SSE2, AVX2, Neon, & POWER9
    • Inflate chunk copying using SSE2, AVX, Neon & VSX
    • Support for hardware-accelerated deflate using IBM Z DFLTCC
  • Unaligned memory read/writes and large bit buffer improvements
  • Includes improvements from Cloudflare and Intel forks
  • Configure, CMake, and NMake build system support
  • Comprehensive set of CMake unit tests
  • Code sanitizers, fuzzing, and coverage
  • GitHub Actions continuous integration on Windows, macOS, and Linux
    • Emulated CI for ARM, AARCH64, PPC, PPC64, SPARC64, S390x using qemu

History

The motivation for this fork came after seeing several 3rd party contributions containing new optimizations not getting implemented into the official zlib repository.

Mark Adler has been maintaining zlib for a very long time, and he has done a great job and hopefully he will continue for a long time yet. The idea of zlib-ng is not to replace zlib, but to co-exist as a drop-in replacement with a lower threshold for code change.

zlib has a long history and is incredibly portable, even supporting lots of systems that predate the Internet. This is great, but it does complicate further development and maintainability. The zlib code has numerous workarounds for old compilers that do not understand ANSI-C or to accommodate systems with limitations such as operating in a 16-bit environment.

Many of these workarounds are only maintenance burdens, some of them are pretty huge code-wise. For example, the [v]s[n]printf workaround code has a whopping 8 different implementations just to cater to various old compilers. With this many workarounds cluttered throughout the code, new programmers with an idea/interest for zlib will need to take some time to figure out why all of these seemingly strange things are used, and how to work within those confines.

So I decided to make a fork, merge all the Intel optimizations, merge the Cloudflare optimizations that did not conflict, plus a couple of other smaller patches. Then I started cleaning out workarounds, various dead code, all contrib and example code as there is little point in having those in this fork for various reasons.

A lot of improvements have gone into zlib-ng since its start, and numerous people and companies have contributed both small and big improvements, or valuable testing.

Please read LICENSE.md, it is very simple and very liberal.

Build

There are two ways to build zlib-ng:

Cmake

To build zlib-ng using the cross-platform makefile generator cmake.

cmake .
cmake --build . --config Release
ctest --verbose -C Release

Alternatively, you can use the cmake configuration GUI tool ccmake:

ccmake .

Configure

To build zlib-ng using the bash configure script:

./configure
make
make test

Build Options

CMakeconfigureDescriptionDefault
ZLIB_COMPAT--zlib-compatCompile with zlib compatible APIOFF
ZLIB_ENABLE_TESTSBuild test binariesON
WITH_GZFILEOP--without-gzfileopsCompile with support for gzFile related functionsON
WITH_OPTIM--without-optimizationsBuild with optimisationsON
WITH_NEW_STRATEGIES--without-new-strategiesUse new strategiesON
WITH_NATIVE_INSTRUCTIONS--nativeCompiles with full instruction set supported on this host (gcc/clang -march=native)OFF
WITH_SANITIZERBuild with sanitizer (memory, address, undefined)OFF
WITH_FUZZERSBuild test/fuzzOFF
WITH_BENCHMARKSBuild test/benchmarksOFF
WITH_MAINTAINER_WARNINGSBuild with project maintainer warningsOFF
WITH_CODE_COVERAGEEnable code coverage reportingOFF

Install

WARNING: We do not recommend manually installing unless you really know what you are doing, because this can potentially override the system default zlib library, and any incompatibility or wrong configuration of zlib-ng can make the whole system unusable, requiring recovery or reinstall. If you still want a manual install, we recommend using the /opt/ path prefix.

For Linux distros, an alternative way to use zlib-ng (if compiled in zlib-compat mode) instead of zlib, is through the use of the LD_PRELOAD environment variable. If the program is dynamically linked with zlib, then zlib-ng will temporarily be used instead by the program, without risking system-wide instability.

LD_PRELOAD=/opt/zlib-ng/libz.so.1.2.12.zlib-ng /usr/bin/program

Cmake

To install zlib-ng system-wide using cmake:

cmake --build . --target install

Configure

To install zlib-ng system-wide using the configure script:

make install

Vcpkg

Alternatively, you can build and install zlib-ng using the vcpkg dependency manager:

git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
./bootstrap-vcpkg.sh # "./bootstrap-vcpkg.bat" for powershell
./vcpkg integrate install
./vcpkg install zlib-ng

The zlib-ng port in vcpkg is kept up to date by Microsoft team members and community contributors. If the version is out of date, please create an issue or pull request on the vcpkg repository.

Contributing

Zlib-ng is a aiming to be open to contributions, and we would be delighted to receive pull requests on github. Just remember that any code you submit must be your own and it must be zlib licensed. Help with testing and reviewing of pull requests etc is also very much appreciated.

If you are interested in contributing, please consider joining our IRC channel #zlib-ng on the Freenode IRC network.

Acknowledgments

Thanks to Servebolt.com for sponsoring my maintainership of zlib-ng.

Thanks go out to all the people and companies who have taken the time to contribute code reviews, testing and/or patches. Zlib-ng would not have been nearly as good without you.

The deflate format used by zlib was defined by Phil Katz. The deflate and zlib specifications were written by L. Peter Deutsch.

zlib was originally created by Jean-loup Gailly (compression) and Mark Adler (decompression).

Advanced Build Options

CMakeconfigureDescriptionDefault
FORCE_SSE2--force-sse2Skip runtime check for SSE2 instructions (Always on for x86_64)OFF (x86)
FORCE_TZCNT--force-tzcntSkip runtime check for TZCNT instructionsOFF
WITH_AVX2Build with AVX2 intrinsicsON
WITH_AVX512Build with AVX512 intrinsicsON
WITH_AVX512VNNIBuild with AVX512VNNI intrinsicsON
WITH_SSE2Build with SSE2 intrinsicsON
WITH_SSE41Build with SSE41 intrinsicsON
WITH_SSE42Build with SSE42 intrinsicsON
WITH_PCLMULQDQBuild with PCLMULQDQ intrinsicsON
WITH_VPCLMULQDQ--without-vpclmulqdqBuild with VPCLMULQDQ intrinsicsON
WITH_ACLE--without-acleBuild with ACLE intrinsicsON
WITH_NEON--without-neonBuild with NEON intrinsicsON
WITH_ALTIVEC--without-altivecBuild with AltiVec (VMX) intrinsicsON
WITH_POWER8--without-power8Build with POWER8 optimisationsON
WITH_CRC32_VX--without-crc32-vxBuild with vectorized CRC32 on IBM ZON
WITH_DFLTCC_DEFLATE--with-dfltcc-deflateBuild with DFLTCC intrinsics for compression on IBM ZOFF
WITH_DFLTCC_INFLATE--with-dfltcc-inflateBuild with DFLTCC intrinsics for decompression on IBM ZOFF
WITH_UNALIGNED--without-unalignedAllow optimizations that use unaligned reads if safe on current archON
WITH_INFLATE_STRICTBuild with strict inflate distance checkingOFF
WITH_INFLATE_ALLOW_INVALID_DISTBuild with zero fill for inflate invalid distancesOFF
INSTALL_UTILSCopy minigzip and minideflate during installOFF
ZLIBNG_ENABLE_TESTSTest zlib-ng specific APION

Related Projects