xref: /illumos-gate/usr/src/common/zfs/zfeature_common.h (revision 142d813a06c6f9a6142e2c276b62129a17a31a65)
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, 2017 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) 2014 Integros [integros.com]
27  * Copyright (c) 2017, Intel Corporation.
28  */
29 
30 #ifndef _ZFEATURE_COMMON_H
31 #define	_ZFEATURE_COMMON_H
32 
33 #include <sys/fs/zfs.h>
34 #include <sys/inttypes.h>
35 #include <sys/types.h>
36 
37 #ifdef	__cplusplus
38 extern "C" {
39 #endif
40 
41 struct zfeature_info;
42 
43 typedef enum spa_feature {
44 	SPA_FEATURE_NONE = -1,
45 	SPA_FEATURE_ASYNC_DESTROY,
46 	SPA_FEATURE_EMPTY_BPOBJ,
47 	SPA_FEATURE_LZ4_COMPRESS,
48 	SPA_FEATURE_MULTI_VDEV_CRASH_DUMP,
49 	SPA_FEATURE_SPACEMAP_HISTOGRAM,
50 	SPA_FEATURE_ENABLED_TXG,
51 	SPA_FEATURE_HOLE_BIRTH,
52 	SPA_FEATURE_EXTENSIBLE_DATASET,
53 	SPA_FEATURE_EMBEDDED_DATA,
54 	SPA_FEATURE_BOOKMARKS,
55 	SPA_FEATURE_FS_SS_LIMIT,
56 	SPA_FEATURE_LARGE_BLOCKS,
57 	SPA_FEATURE_LARGE_DNODE,
58 	SPA_FEATURE_SHA512,
59 	SPA_FEATURE_SKEIN,
60 	SPA_FEATURE_EDONR,
61 	SPA_FEATURE_DEVICE_REMOVAL,
62 	SPA_FEATURE_OBSOLETE_COUNTS,
63 	SPA_FEATURE_POOL_CHECKPOINT,
64 	SPA_FEATURE_SPACEMAP_V2,
65 	SPA_FEATURE_ALLOCATION_CLASSES,
66 	SPA_FEATURE_RESILVER_DEFER,
67 	SPA_FEATURE_ENCRYPTION,
68 	SPA_FEATURE_BOOKMARK_V2,
69 	SPA_FEATURES
70 } spa_feature_t;
71 
72 #define	SPA_FEATURE_DISABLED	(-1ULL)
73 
74 typedef enum zfeature_flags {
75 	/* Can open pool readonly even if this feature is not supported. */
76 	ZFEATURE_FLAG_READONLY_COMPAT =		(1 << 0),
77 	/* Is this feature necessary to read the MOS? */
78 	ZFEATURE_FLAG_MOS =			(1 << 1),
79 	/* Activate this feature at the same time it is enabled. */
80 	ZFEATURE_FLAG_ACTIVATE_ON_ENABLE =	(1 << 2),
81 	/* Each dataset has a field set if it has ever used this feature. */
82 	ZFEATURE_FLAG_PER_DATASET =		(1 << 3)
83 } zfeature_flags_t;
84 
85 typedef struct zfeature_info {
86 	spa_feature_t fi_feature;
87 	const char *fi_uname;	/* User-facing feature name */
88 	const char *fi_guid;	/* On-disk feature identifier */
89 	const char *fi_desc;	/* Feature description */
90 	zfeature_flags_t fi_flags;
91 	/* array of dependencies, terminated by SPA_FEATURE_NONE */
92 	const spa_feature_t *fi_depends;
93 } zfeature_info_t;
94 
95 typedef int (zfeature_func_t)(zfeature_info_t *, void *);
96 
97 #define	ZFS_FEATURE_DEBUG
98 
99 extern zfeature_info_t spa_feature_table[SPA_FEATURES];
100 
101 extern boolean_t zfeature_is_valid_guid(const char *);
102 
103 extern boolean_t zfeature_is_supported(const char *);
104 extern int zfeature_lookup_name(const char *, spa_feature_t *);
105 extern boolean_t zfeature_depends_on(spa_feature_t, spa_feature_t);
106 
107 extern void zpool_feature_init(void);
108 
109 #ifdef	__cplusplus
110 }
111 #endif
112 
113 #endif	/* _ZFEATURE_COMMON_H */
114