2021-10-07 17:31:26 +00:00
|
|
|
#
|
|
|
|
|
# Shown below is a simplified dependency graph of the OpenZFS provided
|
|
|
|
|
# libraries. Administrative commands (`zfs`, `zpool`, etc) interface with
|
|
|
|
|
# the kernel modules using the `libzfs.so` and `libzfs_core.so` libraries.
|
|
|
|
|
# These libraries provide a stable ABI across OpenZFS point releases.
|
|
|
|
|
#
|
|
|
|
|
# The `libzpool.so` library is a user space build of the DMU and SPA layers
|
|
|
|
|
# used to implement debugging tools (zdb) and code validation tools (ztest).
|
|
|
|
|
# These library interfaces are subject to change at any time.
|
|
|
|
|
#
|
|
|
|
|
#
|
2024-02-05 18:00:41 +00:00
|
|
|
# CMDS: zhack/ztest/ zfs/zpool/zed/
|
2021-10-07 17:31:26 +00:00
|
|
|
# raidz_{test,bench} zinject/zstream
|
|
|
|
|
# | |
|
|
|
|
|
# LIBS: | | libzfsbootenv*
|
2024-02-05 18:00:41 +00:00
|
|
|
# |--libzdb--zdb | |
|
2021-10-07 17:31:26 +00:00
|
|
|
# | | |
|
|
|
|
|
# libzpool libzfs* ----------------+
|
|
|
|
|
# | | | \ / | | |
|
|
|
|
|
# libicp --/ | | \ / | | \------- libshare
|
|
|
|
|
# | | \ / | |
|
|
|
|
|
# libzstd ---/ | \ / | \--------- libuutil
|
|
|
|
|
# | \ / \ | |
|
|
|
|
|
# libunicode --/ \ / \ | |
|
|
|
|
|
# \ / \ | |
|
|
|
|
|
# libzutil libzfs_core* | |
|
|
|
|
|
# | | | | \ | | | |
|
|
|
|
|
# | | | | | | | | |
|
|
|
|
|
# | | | | | | | | |
|
|
|
|
|
# libtpool -------------/ | | | \---- libnvpair* | | |
|
|
|
|
|
# | | | | | |
|
|
|
|
|
# libefi -----------------/ | \------ libavl* --------/ |
|
|
|
|
|
# | | |
|
|
|
|
|
# \-------- libspl ----+------/
|
|
|
|
|
#
|
|
|
|
|
#
|
2011-12-31 23:30:52 +00:00
|
|
|
# NB: GNU Automake Manual, Chapter 8.3.5: Libtool Convenience Libraries
|
Add zstd support to zfs
This PR adds two new compression types, based on ZStandard:
- zstd: A basic ZStandard compression algorithm Available compression.
Levels for zstd are zstd-1 through zstd-19, where the compression
increases with every level, but speed decreases.
- zstd-fast: A faster version of the ZStandard compression algorithm
zstd-fast is basically a "negative" level of zstd. The compression
decreases with every level, but speed increases.
Available compression levels for zstd-fast:
- zstd-fast-1 through zstd-fast-10
- zstd-fast-20 through zstd-fast-100 (in increments of 10)
- zstd-fast-500 and zstd-fast-1000
For more information check the man page.
Implementation details:
Rather than treat each level of zstd as a different algorithm (as was
done historically with gzip), the block pointer `enum zio_compress`
value is simply zstd for all levels, including zstd-fast, since they all
use the same decompression function.
The compress= property (a 64bit unsigned integer) uses the lower 7 bits
to store the compression algorithm (matching the number of bits used in
a block pointer, as the 8th bit was borrowed for embedded block
pointers). The upper bits are used to store the compression level.
It is necessary to be able to determine what compression level was used
when later reading a block back, so the concept used in LZ4, where the
first 32bits of the on-disk value are the size of the compressed data
(since the allocation is rounded up to the nearest ashift), was
extended, and we store the version of ZSTD and the level as well as the
compressed size. This value is returned when decompressing a block, so
that if the block needs to be recompressed (L2ARC, nop-write, etc), that
the same parameters will be used to result in the matching checksum.
All of the internal ZFS code ( `arc_buf_hdr_t`, `objset_t`,
`zio_prop_t`, etc.) uses the separated _compress and _complevel
variables. Only the properties ZAP contains the combined/bit-shifted
value. The combined value is split when the compression_changed_cb()
callback is called, and sets both objset members (os_compress and
os_complevel).
The userspace tools all use the combined/bit-shifted value.
Additional notes:
zdb can now also decode the ZSTD compression header (flag -Z) and
inspect the size, version and compression level saved in that header.
For each record, if it is ZSTD compressed, the parameters of the decoded
compression header get printed.
ZSTD is included with all current tests and new tests are added
as-needed.
Per-dataset feature flags now get activated when the property is set.
If a compression algorithm requires a feature flag, zfs activates the
feature when the property is set, rather than waiting for the first
block to be born. This is currently only used by zstd but can be
extended as needed.
Portions-Sponsored-By: The FreeBSD Foundation
Co-authored-by: Allan Jude <allanjude@freebsd.org>
Co-authored-by: Brian Behlendorf <behlendorf1@llnl.gov>
Co-authored-by: Sebastian Gottschall <s.gottschall@dd-wrt.com>
Co-authored-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl>
Co-authored-by: Michael Niewöhner <foss@mniewoehner.de>
Signed-off-by: Allan Jude <allan@klarasystems.com>
Signed-off-by: Allan Jude <allanjude@freebsd.org>
Signed-off-by: Brian Behlendorf <behlendorf1@llnl.gov>
Signed-off-by: Sebastian Gottschall <s.gottschall@dd-wrt.com>
Signed-off-by: Kjeld Schouten-Lebbing <kjeld@schouten-lebbing.nl>
Signed-off-by: Michael Niewöhner <foss@mniewoehner.de>
Closes #6247
Closes #9024
Closes #10277
Closes #10278
2020-08-18 17:10:17 +00:00
|
|
|
# These nine libraries are intermediary build components.
|
2021-10-07 17:31:26 +00:00
|
|
|
#
|
2022-04-07 23:07:08 +00:00
|
|
|
# * - A stable ABI is provided for these libraries;
|
|
|
|
|
# when performing an ABI check the following options are applied:
|
|
|
|
|
#
|
|
|
|
|
# --no-unreferenced-symbols: Exclude symbols which are not referenced by
|
|
|
|
|
# any debug information. Without this _init() and _fini() are incorrectly
|
|
|
|
|
# reported on CentOS7 for libuutil.so.
|
|
|
|
|
#
|
|
|
|
|
# --headers-dir1: Limit ABI checks to public OpenZFS headers, otherwise
|
|
|
|
|
# changes in public system headers are also reported.
|
|
|
|
|
#
|
|
|
|
|
# --suppressions: Honor a suppressions file for each library to provide
|
|
|
|
|
# a mechanism for suppressing harmless warnings.
|
|
|
|
|
#
|
2020-04-14 18:36:28 +00:00
|
|
|
|
2022-04-07 23:07:08 +00:00
|
|
|
noinst_LTLIBRARIES =
|
|
|
|
|
lib_LTLIBRARIES =
|
|
|
|
|
pkgconfig_DATA =
|
|
|
|
|
include $(srcdir)/%D%/libavl/Makefile.am
|
|
|
|
|
include $(srcdir)/%D%/libicp/Makefile.am
|
|
|
|
|
include $(srcdir)/%D%/libnvpair/Makefile.am
|
|
|
|
|
include $(srcdir)/%D%/libshare/Makefile.am
|
|
|
|
|
include $(srcdir)/%D%/libspl/Makefile.am
|
|
|
|
|
include $(srcdir)/%D%/libtpool/Makefile.am
|
|
|
|
|
include $(srcdir)/%D%/libunicode/Makefile.am
|
|
|
|
|
include $(srcdir)/%D%/libuutil/Makefile.am
|
2024-02-05 18:00:41 +00:00
|
|
|
include $(srcdir)/%D%/libzdb/Makefile.am
|
2022-04-07 23:07:08 +00:00
|
|
|
include $(srcdir)/%D%/libzfs_core/Makefile.am
|
|
|
|
|
include $(srcdir)/%D%/libzfs/Makefile.am
|
|
|
|
|
include $(srcdir)/%D%/libzfsbootenv/Makefile.am
|
|
|
|
|
include $(srcdir)/%D%/libzpool/Makefile.am
|
|
|
|
|
include $(srcdir)/%D%/libzstd/Makefile.am
|
|
|
|
|
include $(srcdir)/%D%/libzutil/Makefile.am
|
2020-04-14 18:36:28 +00:00
|
|
|
if BUILD_LINUX
|
2022-04-07 23:07:08 +00:00
|
|
|
include $(srcdir)/%D%/libefi/Makefile.am
|
2020-04-14 18:36:28 +00:00
|
|
|
endif
|
|
|
|
|
|
2020-09-12 15:19:48 +00:00
|
|
|
|
2022-04-07 23:07:08 +00:00
|
|
|
PHONY += lib
|
|
|
|
|
lib: $(noinst_LTLIBRARIES) $(lib_LTLIBRARIES)
|
2011-12-31 23:30:52 +00:00
|
|
|
|
2020-11-15 04:35:31 +00:00
|
|
|
|
2022-04-07 23:07:08 +00:00
|
|
|
PHONY += checkabi storeabi check_libabi_version allow_libabi_only_for_x86_64
|
2020-11-15 04:35:31 +00:00
|
|
|
|
2022-04-07 23:07:08 +00:00
|
|
|
check_libabi_version:
|
|
|
|
|
if [ $$(abidw -v | $(SED) 's/[^0-9]//g') -lt 200 ]; then \
|
|
|
|
|
printf '%s\n' "" \
|
|
|
|
|
"*** Please use libabigail 2.0.0 version or newer;" \
|
|
|
|
|
"*** otherwise results are not consistent!" \
|
|
|
|
|
"(or see https://github.com/openzfs/libabigail-docker)"; \
|
|
|
|
|
exit 1; \
|
|
|
|
|
fi
|
2020-11-15 04:35:31 +00:00
|
|
|
|
2022-04-07 23:07:08 +00:00
|
|
|
allow_libabi_only_for_x86_64:
|
|
|
|
|
echo '*** ABI definitions provided apply only to x86_64:'
|
|
|
|
|
echo '*** not checking or storing ABI and assuming success.'
|
2021-01-22 20:54:34 +00:00
|
|
|
|
2022-04-07 23:07:08 +00:00
|
|
|
if TARGET_CPU_X86_64
|
|
|
|
|
# These should depend on $(lib_LTLIBRARIES), but this breaks on CI when bound into Docker
|
|
|
|
|
checkabi: check_libabi_version
|
|
|
|
|
err=0; \
|
|
|
|
|
for lib in $(lib_LTLIBRARIES); do \
|
|
|
|
|
lib=$${lib%.la}; \
|
|
|
|
|
[ -f $(srcdir)/lib/$$lib/$$lib.suppr ] || continue; \
|
|
|
|
|
echo $$lib:; \
|
|
|
|
|
abidiff --no-unreferenced-symbols \
|
|
|
|
|
--headers-dir1 include \
|
|
|
|
|
--suppressions $(srcdir)/lib/$$lib/$$lib.suppr \
|
|
|
|
|
$(srcdir)/lib/$$lib/$$lib.abi .libs/$$lib.so || err=$$((err + 1)); \
|
|
|
|
|
done; \
|
|
|
|
|
exit $$err
|
|
|
|
|
|
|
|
|
|
storeabi: check_libabi_version
|
|
|
|
|
for lib in $(lib_LTLIBRARIES); do \
|
|
|
|
|
lib=$${lib%.la}; \
|
|
|
|
|
[ -f $(srcdir)/lib/$$lib/$$lib.suppr ] || continue; \
|
|
|
|
|
abidw --no-show-locs \
|
|
|
|
|
--no-corpus-path \
|
|
|
|
|
--no-comp-dir-path \
|
|
|
|
|
--type-id-style hash \
|
|
|
|
|
.libs/$$lib.so > $(srcdir)/lib/$$lib/$$lib.abi; \
|
2021-01-22 20:54:34 +00:00
|
|
|
done
|
2022-04-07 23:07:08 +00:00
|
|
|
else
|
|
|
|
|
checkabi: allow_libabi_only_for_x86_64
|
|
|
|
|
storeabi: allow_libabi_only_for_x86_64
|
|
|
|
|
endif
|
