Skip to content

BUILD.md

Latest commit

 

History

History
137 lines (89 loc) · 4.38 KB

BUILD.md

File metadata and controls

137 lines (89 loc) · 4.38 KB

Building

These are generic building and installation instructions.

Requirements

To compile, you need a C and C++ compiler that is GNUC-compatible, such as GCC, LLVM/Clang, or ICC. It is recommended to use GCC 7.1+ or Clang 6.0+. You can find GCC at http://gcc.gnu.org.

Testing

lzbench undergoes automated testing using Azure Pipelines with the following compilers:

  • Ubuntu: gcc (versions 7.5 to 14.2) and clang (versions 6.0 to 19), gcc 14.2 (32-bit)
  • MacOS: Apple LLVM version 15.0.0
  • Windows: mingw32-gcc 14.2.0 (32-bit) and mingw64-gcc 14.2.0 (64-bit)
  • Cross-compilation: gcc for ARM (32-bit and 64-bit) and PowerPC (64-bit Little-endian)

Get the source code

From git repository

Clone git repository with:

git clone https://github.com/inikep/lzbench.git
cd lzbench

Download an archive

Another option is to download zip or tar ball from repository or release page at https://github.com/inikep/lzbench/releases/.

Unpack the archive:

unzip lzbench-master.zip

or

tar -xzf lzbench-[version].tar.gz

This creates the directory ./lzbench-[version] containing the source from the main archive.

Compilation

Change to lzbench directory and run make.

make -j$(nproc)

To order static or dynamic linking set BUILD_STATIC to 1, or 0 respectively:

make BUILD_STATIC=1

To include debugging information:

make BUILD_TYPE=debug

For 32-bit compilation:

make BUILD_ARCH=32-bit

For non-default compiler:

make CC=gcc-14 CXX=g++-14

For an optimized but non-portable build, use:

make MOREFLAGS="-march=native"

or

make USER_CFLAGS="-march=native" USER_CXXFLAGS="-march=native"

USER_CFLAGS, USER_CXXFLAGS and USER_LDFLAGS variables allow user to add or replace existing values of corresponding variables without completely replacing them.

With certain compilers, systems or combination some compressors may cause issues. Most of them should be resolved automatically but in case of problems, particular compressor can be excluded from build by setting DONT_BUILD_XXX to 1, where XXX is target compressor, for example:

make DONT_BUILD_GLZA=1

CUDA support

To enable CUDA use:

make ENABLE_CUDA=1

The directory where the CUDA compiler and libraries are available can be passed to make via the CUDA_BASE variable (which is /usr/local/cuda by default), e.g.:

make ENABLE_CUDA=1 CUDA_BASE=/home/lzbench/cuda

If CUDA is available, lzbench supports additional compressors:

  • cudaMemcpy - similar to the reference memcpy benchmark, using GPU memory
  • nvcomp_lz4 - LZ4 GPU-only compressor
  • [bsc_cuda] - GPU modes for libbsc

Compilation for various CPU architectures

  • x86_64 (amd64) is our main configuration as is well tested
  • x86 (32-bit) works fine with all default codecs except LZSSE in our tests
  • arm/aarch64 works fine with all default codecs except LZSSE for arm (32-bit) in our tests
  • ppc64le (PowerPC 64-bit Little-endian) works fine with all default codecs
  • ppc/ppc64 (PowerPC 32-bit and 64-bit Big-endian) - a lot compressors fail because of Big-endian architecture
  • riscv32/riscv64 - we have reports it works fine with DONT_BUILD_TORNADO=1. For riscv64, if the environment includes the B extension (which comprises the Zba, Zbb, and Zbs extensions), you can improve performance by adding MOREFLAGS="-march=rv64gc_zba_zbb_zbs" during compilation
  • mipsel/mips64el - waiting for reports
  • mips/mips64 - a lot compressors will fail because of Big-endian architecture
  • loongarch64 - we have reports it works fine

Known issues

With all issues refer to Makefile, as they may already be suppressed.

All operating systems

  • LZSSE requires 64-bit Intel CPU with SSE4.1 for compilation and execution (a support for __SSE4_1__ is auto-detected)

Windows

  • mingw64-gcc works correctly with DONT_BUILD_LZHAM=1
  • mingw32-gcc functions properly with DONT_BUILD_GLZA=1 DONT_BUILD_LZHAM=1

MacOS

  • Apple clang works fine with DONT_BUILD_LZHAM=1 DONT_BUILD_CSC=1, which should be added automatically

Copyright (C) 2025 tansy

This file is free documentation: you have unlimited permission to copy, distribute, and modify it.