mirror of
https://git.proxmox.com/git/mirror_zfs.git
synced 2024-11-17 10:01:01 +03:00
10b3c7f5e4
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
136 lines
3.9 KiB
C
136 lines
3.9 KiB
C
/*
|
|
* CDDL HEADER START
|
|
*
|
|
* The contents of this file are subject to the terms of the
|
|
* Common Development and Distribution License (the "License").
|
|
* You may not use this file except in compliance with the License.
|
|
*
|
|
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
|
|
* or http://www.opensolaris.org/os/licensing.
|
|
* See the License for the specific language governing permissions
|
|
* and limitations under the License.
|
|
*
|
|
* When distributing Covered Code, include this CDDL HEADER in each
|
|
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
|
|
* If applicable, add the following below this CDDL HEADER, with the
|
|
* fields enclosed by brackets "[]" replaced with your own identifying
|
|
* information: Portions Copyright [yyyy] [name of copyright owner]
|
|
*
|
|
* CDDL HEADER END
|
|
*/
|
|
|
|
/*
|
|
* Copyright (c) 2011, 2018 by Delphix. All rights reserved.
|
|
* Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
|
|
* Copyright (c) 2013, Joyent, Inc. All rights reserved.
|
|
* Copyright (c) 2017, Intel Corporation.
|
|
*/
|
|
|
|
#ifndef _ZFEATURE_COMMON_H
|
|
#define _ZFEATURE_COMMON_H
|
|
|
|
#include <sys/fs/zfs.h>
|
|
#include <sys/inttypes.h>
|
|
#include <sys/types.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
struct zfeature_info;
|
|
|
|
typedef enum spa_feature {
|
|
SPA_FEATURE_NONE = -1,
|
|
SPA_FEATURE_ASYNC_DESTROY,
|
|
SPA_FEATURE_EMPTY_BPOBJ,
|
|
SPA_FEATURE_LZ4_COMPRESS,
|
|
SPA_FEATURE_MULTI_VDEV_CRASH_DUMP,
|
|
SPA_FEATURE_SPACEMAP_HISTOGRAM,
|
|
SPA_FEATURE_ENABLED_TXG,
|
|
SPA_FEATURE_HOLE_BIRTH,
|
|
SPA_FEATURE_EXTENSIBLE_DATASET,
|
|
SPA_FEATURE_EMBEDDED_DATA,
|
|
SPA_FEATURE_BOOKMARKS,
|
|
SPA_FEATURE_FS_SS_LIMIT,
|
|
SPA_FEATURE_LARGE_BLOCKS,
|
|
SPA_FEATURE_LARGE_DNODE,
|
|
SPA_FEATURE_SHA512,
|
|
SPA_FEATURE_SKEIN,
|
|
#if !defined(__FreeBSD__)
|
|
SPA_FEATURE_EDONR,
|
|
#endif
|
|
SPA_FEATURE_USEROBJ_ACCOUNTING,
|
|
SPA_FEATURE_ENCRYPTION,
|
|
SPA_FEATURE_PROJECT_QUOTA,
|
|
SPA_FEATURE_DEVICE_REMOVAL,
|
|
SPA_FEATURE_OBSOLETE_COUNTS,
|
|
SPA_FEATURE_POOL_CHECKPOINT,
|
|
SPA_FEATURE_SPACEMAP_V2,
|
|
SPA_FEATURE_ALLOCATION_CLASSES,
|
|
SPA_FEATURE_RESILVER_DEFER,
|
|
SPA_FEATURE_BOOKMARK_V2,
|
|
SPA_FEATURE_REDACTION_BOOKMARKS,
|
|
SPA_FEATURE_REDACTED_DATASETS,
|
|
SPA_FEATURE_BOOKMARK_WRITTEN,
|
|
SPA_FEATURE_LOG_SPACEMAP,
|
|
SPA_FEATURE_LIVELIST,
|
|
SPA_FEATURE_DEVICE_REBUILD,
|
|
SPA_FEATURE_ZSTD_COMPRESS,
|
|
SPA_FEATURES
|
|
} spa_feature_t;
|
|
|
|
#define SPA_FEATURE_DISABLED (-1ULL)
|
|
|
|
typedef enum zfeature_flags {
|
|
/* Can open pool readonly even if this feature is not supported. */
|
|
ZFEATURE_FLAG_READONLY_COMPAT = (1 << 0),
|
|
/*
|
|
* Is this feature necessary to load the pool? i.e. do we need this
|
|
* feature to read the full feature list out of the MOS?
|
|
*/
|
|
ZFEATURE_FLAG_MOS = (1 << 1),
|
|
/* Activate this feature at the same time it is enabled. */
|
|
ZFEATURE_FLAG_ACTIVATE_ON_ENABLE = (1 << 2),
|
|
/* Each dataset has a field set if it has ever used this feature. */
|
|
ZFEATURE_FLAG_PER_DATASET = (1 << 3)
|
|
} zfeature_flags_t;
|
|
|
|
typedef enum zfeature_type {
|
|
ZFEATURE_TYPE_BOOLEAN,
|
|
ZFEATURE_TYPE_UINT64_ARRAY,
|
|
ZFEATURE_NUM_TYPES
|
|
} zfeature_type_t;
|
|
|
|
typedef struct zfeature_info {
|
|
spa_feature_t fi_feature;
|
|
const char *fi_uname; /* User-facing feature name */
|
|
const char *fi_guid; /* On-disk feature identifier */
|
|
const char *fi_desc; /* Feature description */
|
|
zfeature_flags_t fi_flags;
|
|
boolean_t fi_zfs_mod_supported; /* supported by running zfs module */
|
|
zfeature_type_t fi_type; /* Only relevant for PER_DATASET features */
|
|
/* array of dependencies, terminated by SPA_FEATURE_NONE */
|
|
const spa_feature_t *fi_depends;
|
|
} zfeature_info_t;
|
|
|
|
typedef int (zfeature_func_t)(zfeature_info_t *, void *);
|
|
|
|
#define ZFS_FEATURE_DEBUG
|
|
|
|
extern zfeature_info_t spa_feature_table[SPA_FEATURES];
|
|
|
|
extern boolean_t zfeature_is_valid_guid(const char *);
|
|
|
|
extern boolean_t zfeature_is_supported(const char *);
|
|
extern int zfeature_lookup_guid(const char *, spa_feature_t *);
|
|
extern int zfeature_lookup_name(const char *, spa_feature_t *);
|
|
extern boolean_t zfeature_depends_on(spa_feature_t, spa_feature_t);
|
|
|
|
extern void zpool_feature_init(void);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* _ZFEATURE_COMMON_H */
|