OpenZL: A Novel Data Compression Framework

OpenZL delivers high compression ratios while preserving high speed, a level of performance that is out of reach for generic compressors. Check out the blog post and whitepaper for a breakdown of how it works.

OpenZL takes a description of your data and builds from it a specialized compressor optimized for your specific format. Learn how it works →

OpenZL consists of a core library and tools to generate specialized compressors — all compatible with a single universal decompressor. It is designed for engineers that deal with large quantities of specialized datasets (like AI workloads for example) and require high speed for their processing pipelines.

See our docs for more information and our quickstart guide to get started with a guided tutorial.

This project is under active development. The API, the compressed format, and the set of codecs and graphs included in OpenZL are all subject to (and will!) change as the project matures.

However, we intend to maintain some stability guarantees in the face of that evolution. In particular, payloads compressed with any release-tagged version of the library will remain decompressible by new releases of the library for at least the next several years. And new releases of the library will be able to generate frames compatible with at least the previous release.

(Commits on the dev branch offer no guarantees whatsoever. Use only release-tagged commits for any non-experimental deployments.)

Despite the big scary warnings above, we consider the core to have reached production-readiness, and OpenZL is used extensively in production at Meta.

The OpenZL library and essential tools can be built using make:

The Makefile supports all standard build variables, such as CC, CFLAGS, CPPFLAGS, LDFLAGS, LDLIBS, etc.

It builds with multi-threading by default, auto-detecting the local number of cores, and can be overridden using standard -j# flag (ex: make -j8).

Binary generation can be altered by explicitly requesting a build type:

Example:

Build types are documented in make help, and their exact flags are detailed with make show-config.

Usual ones are:

• BUILD_TYPE=DEV: debug build with asserts enabled and ASAN / UBSAN enabled
• BUILD_TYPE=OPT: optimized build with asserts disabled (default)

OpenZL can be built using cmake. Basic usage is as follows:

Details on setting CMake variables is below.

By default, we ship several different predefined build modes which can be set with the OPENZL_BUILD_MODE variable:

• none (default): CMake default build mode controlled by CMAKE_BUILD_TYPE
• dev: debug build with asserts enabled and ASAN / UBSAN enabled
• dev-nosan: debug build with asserts enabled
• opt: optimized build with asserts disabled
• opt-asan: optimized build with asserts disabled and ASAN / UBSAN enabled
• dbgo: optimized build with asserts enabled
• dbgo-asan: optimized build with asserts enabled and ASAN / UBSAN enabled

For ASAN / UBSAN, ensure that libasan and libubsan are installed on the machine.

OpenZL ships with settings to configure VSCode to work with the CMake build system. To enable it install two extensions:

1. cmake-tools
2. clangd (or any other C++ language server that works with compile_commands.json)

Important: For proper C++ language server support, you need to generate compile_commands.json:

The preferred method is to use the CMake Tools extension command "CMake: Configure".

If it doesn't work, or is too difficult to setup, you can use the manual setup:

When to regenerate:

• After cloning the repository (first-time setup)
• When adding/removing source files
• When modifying CMakeLists.txt

• CMAKE_C_COMPILER = Set the C compiler for OpenZL & dependency builds
• CMAKE_CXX_COMPILER = Set the C++ compiler for OpenZL & dependency builds
• CMAKE_C_FLAGS = C flags for OpenZL & dependency builds
• CMAKE_CXX_FLAGS = C++ flags for OpenZL & dependency builds
• OPENZL_BUILD_TESTS=ON = pull in testing deps and build the unit/integration tests
• OPENZL_BUILD_BENCHMARKS=ON = pull in benchmarking deps and build the benchmark executable
• OPENZL_BUILD_MODE = Sets the build mode for OpenZL and dependencies
• OPENZL_SANITIZE_ADDRESS=ON = Enable ASAN & UBSAN for OpenZL (but not dependencies)
• OPENZL_COMMON_COMPILE_OPTIONS = Shared C/C++ compiler options for OpenZL only
• OPENZL_C_COMPILE_OPTIONS = C compiler options for OpenZL only
• OPENZL_CXX_COMPILE_OPTIONS = C++ compiler options for OpenZL only
• OPENZL_COMMON_COMPILE_DEFINITIONS = Shared C/C++ compiler definitions (-D) for OpenZL only
• OPENZL_C_COMPILE_DEFINITIONS = C compiler definitions (-D) for OpenZL only
• OPENZL_CXX_COMPILE_DEFINITIONS = C++ compiler definitions (-D) for OpenZL only
• OPENZL_COMMON_FLAGS = extra compiler flags used in all targets

OpenZL uses modern C11 features that may not be fully supported by MSVC. For Windows builds, we recommend using clang-cl for the best compatibility.

1. Recommended: Use clang-cl for full C11 support

2. Alternative: Use MinGW-w64 for GNU toolchain compatibility.

3. Limited Support: MSVC may produce C2099 errors due to limited C11 support.

Run our detection script to check available compilers and get recommendations:

For detailed Windows build instructions, troubleshooting, and installation guides, see build/cmake/WINDOWS_BUILD.md.

OpenZL is BSD licensed, as found in the LICENSE file.