xref: /freebsd/sys/contrib/openzfs/include/zfeature_common.h (revision 9e5787d2284e187abb5b654d924394a65772e004)
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 http://www.opensolaris.org/os/licensing.
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
31 
32 #include <sys/fs/zfs.h>
33 #include <sys/inttypes.h>
34 #include <sys/types.h>
35 
36 #ifdef	__cplusplus
37 extern "C" {
38 #endif
39 
40 struct zfeature_info;
41 
42 typedef 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 #if !defined(__FreeBSD__)
60 	SPA_FEATURE_EDONR,
61 #endif
62 	SPA_FEATURE_USEROBJ_ACCOUNTING,
63 	SPA_FEATURE_ENCRYPTION,
64 	SPA_FEATURE_PROJECT_QUOTA,
65 	SPA_FEATURE_DEVICE_REMOVAL,
66 	SPA_FEATURE_OBSOLETE_COUNTS,
67 	SPA_FEATURE_POOL_CHECKPOINT,
68 	SPA_FEATURE_SPACEMAP_V2,
69 	SPA_FEATURE_ALLOCATION_CLASSES,
70 	SPA_FEATURE_RESILVER_DEFER,
71 	SPA_FEATURE_BOOKMARK_V2,
72 	SPA_FEATURE_REDACTION_BOOKMARKS,
73 	SPA_FEATURE_REDACTED_DATASETS,
74 	SPA_FEATURE_BOOKMARK_WRITTEN,
75 	SPA_FEATURE_LOG_SPACEMAP,
76 	SPA_FEATURE_LIVELIST,
77 	SPA_FEATURE_DEVICE_REBUILD,
78 	SPA_FEATURE_ZSTD_COMPRESS,
79 	SPA_FEATURES
80 } spa_feature_t;
81 
82 #define	SPA_FEATURE_DISABLED	(-1ULL)
83 
84 typedef enum zfeature_flags {
85 	/* Can open pool readonly even if this feature is not supported. */
86 	ZFEATURE_FLAG_READONLY_COMPAT =		(1 << 0),
87 	/*
88 	 * Is this feature necessary to load the pool? i.e. do we need this
89 	 * feature to read the full feature list out of the MOS?
90 	 */
91 	ZFEATURE_FLAG_MOS =			(1 << 1),
92 	/* Activate this feature at the same time it is enabled. */
93 	ZFEATURE_FLAG_ACTIVATE_ON_ENABLE =	(1 << 2),
94 	/* Each dataset has a field set if it has ever used this feature. */
95 	ZFEATURE_FLAG_PER_DATASET =		(1 << 3)
96 } zfeature_flags_t;
97 
98 typedef enum zfeature_type {
99 	ZFEATURE_TYPE_BOOLEAN,
100 	ZFEATURE_TYPE_UINT64_ARRAY,
101 	ZFEATURE_NUM_TYPES
102 } zfeature_type_t;
103 
104 typedef struct zfeature_info {
105 	spa_feature_t fi_feature;
106 	const char *fi_uname;	/* User-facing feature name */
107 	const char *fi_guid;	/* On-disk feature identifier */
108 	const char *fi_desc;	/* Feature description */
109 	zfeature_flags_t fi_flags;
110 	boolean_t fi_zfs_mod_supported;	/* supported by running zfs module */
111 	zfeature_type_t fi_type; /* Only relevant for PER_DATASET features */
112 	/* array of dependencies, terminated by SPA_FEATURE_NONE */
113 	const spa_feature_t *fi_depends;
114 } zfeature_info_t;
115 
116 typedef int (zfeature_func_t)(zfeature_info_t *, void *);
117 
118 #define	ZFS_FEATURE_DEBUG
119 
120 extern zfeature_info_t spa_feature_table[SPA_FEATURES];
121 
122 extern boolean_t zfeature_is_valid_guid(const char *);
123 
124 extern boolean_t zfeature_is_supported(const char *);
125 extern int zfeature_lookup_guid(const char *, spa_feature_t *);
126 extern int zfeature_lookup_name(const char *, spa_feature_t *);
127 extern boolean_t zfeature_depends_on(spa_feature_t, spa_feature_t);
128 
129 extern void zpool_feature_init(void);
130 
131 #ifdef	__cplusplus
132 }
133 #endif
134 
135 #endif	/* _ZFEATURE_COMMON_H */
136