1/*
2 * CDDL HEADER START
3 *
4 * The contents of this file are subject to the terms of the
5 * Common Development and Distribution License (the "License").
6 * You may not use this file except in compliance with the License.
7 *
8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 * or https://opensource.org/licenses/CDDL-1.0.
10 * See the License for the specific language governing permissions
11 * and limitations under the License.
12 *
13 * When distributing Covered Code, include this CDDL HEADER in each
14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 * If applicable, add the following below this CDDL HEADER, with the
16 * fields enclosed by brackets "[]" replaced with your own identifying
17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 *
19 * CDDL HEADER END
20 */
21
22/*
23 * Copyright (c) 2011, 2018 by Delphix. All rights reserved.
24 * Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
25 * Copyright (c) 2013, Joyent, Inc. All rights reserved.
26 * Copyright (c) 2017, Intel Corporation.
27 */
28
29#ifndef _ZFEATURE_COMMON_H
30#define	_ZFEATURE_COMMON_H extern __attribute__((visibility("default")))
31
32#include <sys/fs/zfs.h>
33#include <sys/inttypes.h>
34#include <sys/types.h>
35
36#ifdef	__cplusplus
37extern "C" {
38#endif
39
40struct zfeature_info;
41
42typedef enum spa_feature {
43	SPA_FEATURE_NONE = -1,
44	SPA_FEATURE_ASYNC_DESTROY,
45	SPA_FEATURE_EMPTY_BPOBJ,
46	SPA_FEATURE_LZ4_COMPRESS,
47	SPA_FEATURE_MULTI_VDEV_CRASH_DUMP,
48	SPA_FEATURE_SPACEMAP_HISTOGRAM,
49	SPA_FEATURE_ENABLED_TXG,
50	SPA_FEATURE_HOLE_BIRTH,
51	SPA_FEATURE_EXTENSIBLE_DATASET,
52	SPA_FEATURE_EMBEDDED_DATA,
53	SPA_FEATURE_BOOKMARKS,
54	SPA_FEATURE_FS_SS_LIMIT,
55	SPA_FEATURE_LARGE_BLOCKS,
56	SPA_FEATURE_LARGE_DNODE,
57	SPA_FEATURE_SHA512,
58	SPA_FEATURE_SKEIN,
59	SPA_FEATURE_EDONR,
60	SPA_FEATURE_USEROBJ_ACCOUNTING,
61	SPA_FEATURE_ENCRYPTION,
62	SPA_FEATURE_PROJECT_QUOTA,
63	SPA_FEATURE_DEVICE_REMOVAL,
64	SPA_FEATURE_OBSOLETE_COUNTS,
65	SPA_FEATURE_POOL_CHECKPOINT,
66	SPA_FEATURE_SPACEMAP_V2,
67	SPA_FEATURE_ALLOCATION_CLASSES,
68	SPA_FEATURE_RESILVER_DEFER,
69	SPA_FEATURE_BOOKMARK_V2,
70	SPA_FEATURE_REDACTION_BOOKMARKS,
71	SPA_FEATURE_REDACTED_DATASETS,
72	SPA_FEATURE_BOOKMARK_WRITTEN,
73	SPA_FEATURE_LOG_SPACEMAP,
74	SPA_FEATURE_LIVELIST,
75	SPA_FEATURE_DEVICE_REBUILD,
76	SPA_FEATURE_ZSTD_COMPRESS,
77	SPA_FEATURE_DRAID,
78	SPA_FEATURE_ZILSAXATTR,
79	SPA_FEATURE_HEAD_ERRLOG,
80	SPA_FEATURE_BLAKE3,
81	SPA_FEATURE_BLOCK_CLONING,
82	SPA_FEATURE_AVZ_V2,
83	SPA_FEATURE_REDACTION_LIST_SPILL,
84	SPA_FEATURE_RAIDZ_EXPANSION,
85	SPA_FEATURES
86} spa_feature_t;
87
88#define	SPA_FEATURE_DISABLED	(-1ULL)
89
90typedef enum zfeature_flags {
91	/* Can open pool readonly even if this feature is not supported. */
92	ZFEATURE_FLAG_READONLY_COMPAT =		(1 << 0),
93	/*
94	 * Is this feature necessary to load the pool? i.e. do we need this
95	 * feature to read the full feature list out of the MOS?
96	 */
97	ZFEATURE_FLAG_MOS =			(1 << 1),
98	/* Activate this feature at the same time it is enabled. */
99	ZFEATURE_FLAG_ACTIVATE_ON_ENABLE =	(1 << 2),
100	/* Each dataset has a field set if it has ever used this feature. */
101	ZFEATURE_FLAG_PER_DATASET =		(1 << 3)
102} zfeature_flags_t;
103
104typedef enum zfeature_type {
105	ZFEATURE_TYPE_BOOLEAN,
106	ZFEATURE_TYPE_UINT64_ARRAY,
107	ZFEATURE_NUM_TYPES
108} zfeature_type_t;
109
110typedef struct zfeature_info {
111	spa_feature_t fi_feature;
112	const char *fi_uname;	/* User-facing feature name */
113	const char *fi_guid;	/* On-disk feature identifier */
114	const char *fi_desc;	/* Feature description */
115	zfeature_flags_t fi_flags;
116	boolean_t fi_zfs_mod_supported;	/* supported by running zfs module */
117	zfeature_type_t fi_type; /* Only relevant for PER_DATASET features */
118	/* array of dependencies, terminated by SPA_FEATURE_NONE */
119	const spa_feature_t *fi_depends;
120} zfeature_info_t;
121
122typedef int (zfeature_func_t)(zfeature_info_t *, void *);
123
124#define	ZFS_FEATURE_DEBUG
125
126_ZFEATURE_COMMON_H zfeature_info_t spa_feature_table[SPA_FEATURES];
127_ZFEATURE_COMMON_H boolean_t zfeature_checks_disable;
128
129_ZFEATURE_COMMON_H boolean_t zfeature_is_valid_guid(const char *);
130
131_ZFEATURE_COMMON_H boolean_t zfeature_is_supported(const char *);
132_ZFEATURE_COMMON_H int zfeature_lookup_guid(const char *, spa_feature_t *);
133_ZFEATURE_COMMON_H int zfeature_lookup_name(const char *, spa_feature_t *);
134_ZFEATURE_COMMON_H boolean_t zfeature_depends_on(spa_feature_t, spa_feature_t);
135
136_ZFEATURE_COMMON_H void zpool_feature_init(void);
137
138#ifdef	__cplusplus
139}
140#endif
141
142#endif	/* _ZFEATURE_COMMON_H */
143