erebion/coreboot
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
coreboot/util/cbfstool/lz4/lib
History
Patrick Rudolph 0302b2ee07 lib/xxhash: Move to commonlib/bsd 
Move the xxhash lib to commonlib/bsd folder so that it can be
easily included by tools. Update use of standard headers to
allow compilation on POSIX compatible systems as well.

Use the new xxhash lib in cbfstool over the existing duplicated
xxhash lib residing in lz4/lib.

Change-Id: I21041409d5b734cecf43294dcaf3bf17531dbc15
Signed-off-by: Patrick Rudolph <patrick.rudolph@9elements.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/89682
Reviewed-by: Matt DeVillier <matt.devillier@gmail.com>
Reviewed-by: Julius Werner <jwerner@chromium.org>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
2025-12-20 17:35:33 +00:00
..
liblz4.pc.in
LICENSE
lz4.c lz4: Fix out-of-bounds reads 2020-03-02 15:03:03 +00:00
lz4.h
lz4_xxhash.h lib/xxhash: Move to commonlib/bsd 2025-12-20 17:35:33 +00:00
lz4frame.c lib/xxhash: Move to commonlib/bsd 2025-12-20 17:35:33 +00:00
lz4frame.h
lz4frame_static.h
lz4hc.c
lz4hc.h
Makefile util: Add SPDX license headers to Makefiles 2022-11-22 12:47:09 +00:00
README.md

README.md

LZ4 - Library Files

The lib directory contains several files, but you don't necessarily need them all.

To integrate fast LZ4 compression/decompression into your program, you basically just need "lz4.c" and "lz4.h".

For more compression at the cost of compression speed (while preserving decompression speed), use lz4hc on top of regular lz4. lz4hc only provides compression functions. It also needs lz4 to compile properly.

If you want to produce files or data streams compatible with lz4 command line utility, use lz4frame. This library encapsulates lz4-compressed blocks into the official interoperable frame format. In order to work properly, lz4frame needs lz4 and lz4hc, and also xxhash, which provides error detection algorithm. (Advanced stuff : It's possible to hide xxhash symbols into a local namespace. This is what liblz4 does, to avoid symbol duplication in case a user program would link to several libraries containing xxhash symbols.)

A more complex "lz4frame_static.h" is also provided, although its usage is not recommended. It contains definitions which are not guaranteed to remain stable within future versions. Use for static linking only.

The other files are not source code. There are :

  • LICENSE : contains the BSD license text
  • Makefile : script to compile or install lz4 library (static or dynamic)
  • liblz4.pc.in : for pkg-config (make install)