upstream/opnsense-src
1
0
Fork 0
mirror of https://github.com/opnsense/src.git synced 2026-05-28 04:12:45 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
opnsense-src/sys/contrib/openzfs/module/zstd
History
Warner Losh 4f0c9b76cf stand: Only compile decompression routines 
We don't need the compress rotuines, nor zstd_opt.c. Remove them.
Expand the number of places we omit code for IN_LIBSA (which are FreeBSD
specific). Due to the agressive optimization, though, this doesn't
reduce the size of the loader. It does reduce the number of 'false
positives' for places to omit to reduce the size as well as reducing the
build time slightly.

Sponsored by:		Netflix
Reviewed by:		tsoome, delphij
Differential Revision:	https://reviews.freebsd.org/D36145
2022-08-12 21:48:18 -06:00
..
include zfs: merge openzfs/zfs@c0cf6ed67 2022-05-19 00:55:59 +02:00
lib zfs: merge openzfs/zfs@c0cf6ed67 2022-05-19 00:55:59 +02:00
README.md zfs: merge openzfs/zfs@c0cf6ed67 2022-05-19 00:55:59 +02:00
zfs_zstd.c stand: Only compile decompression routines 2022-08-12 21:48:18 -06:00
zstd-in.c
zstd_sparc.c zfs: merge openzfs/zfs@3b89d9518 (master) into main 2021-08-31 09:02:21 +02:00

README.md

ZSTD-On-ZFS Library Manual

Introduction

This subtree contains the ZSTD library used in ZFS. It is heavily cut-down by dropping any unneeded files, and combined into a single file, but otherwise is intentionally unmodified. Please do not alter the file containing the zstd library, besides upgrading to a newer ZSTD release.

Tree structure:

  • zfs_zstd.c are the actual zfs kernel module hooks.
  • lib/ contains the unmodified version of the Zstandard library
  • zstd-in.c is our template file for generating the single-file library
  • include/: This directory contains supplemental includes for platform compatibility, which are not expected to be used by ZFS elsewhere in the future. Thus we keep them private to ZSTD.

Updating ZSTD

To update ZSTD the following steps need to be taken:

  1. Grab the latest release of ZSTD.
  2. Copy the files output by the following script to module/zstd/lib/: grep include [path to zstd]/contrib/single_file_libs/zstd-in.c | awk '{ print $2 }'
  3. Remove debug.c, threading.c, and zstdmt_compress.c.
  4. Update Makefiles with resulting file lists.
  5. Follow symbol renaming notes in include/zstd_compat_wrapper.h

Altering ZSTD and breaking changes

If ZSTD made changes that break compatibility or you need to make breaking changes to the way we handle ZSTD, it is required to maintain backwards compatibility.

We already save the ZSTD version number within the block header to be used to add future compatibility checks and/or fixes. However, currently it is not actually used in such a way.