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