zfeature_common.h revision 54811da5ac6b517992fdc173df5d605e4e61fdc0
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 */
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
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_DEVICE_REMOVAL,
61	SPA_FEATURE_OBSOLETE_COUNTS,
62	SPA_FEATURE_POOL_CHECKPOINT,
63	SPA_FEATURE_SPACEMAP_V2,
64	SPA_FEATURES
65} spa_feature_t;
66
67#define	SPA_FEATURE_DISABLED	(-1ULL)
68
69typedef enum zfeature_flags {
70	/* Can open pool readonly even if this feature is not supported. */
71	ZFEATURE_FLAG_READONLY_COMPAT =		(1 << 0),
72	/* Is this feature necessary to read the MOS? */
73	ZFEATURE_FLAG_MOS =			(1 << 1),
74	/* Activate this feature at the same time it is enabled. */
75	ZFEATURE_FLAG_ACTIVATE_ON_ENABLE =	(1 << 2),
76	/* Each dataset has a field set if it has ever used this feature. */
77	ZFEATURE_FLAG_PER_DATASET =		(1 << 3)
78} zfeature_flags_t;
79
80typedef struct zfeature_info {
81	spa_feature_t fi_feature;
82	const char *fi_uname;	/* User-facing feature name */
83	const char *fi_guid;	/* On-disk feature identifier */
84	const char *fi_desc;	/* Feature description */
85	zfeature_flags_t fi_flags;
86	/* array of dependencies, terminated by SPA_FEATURE_NONE */
87	const spa_feature_t *fi_depends;
88} zfeature_info_t;
89
90typedef int (zfeature_func_t)(zfeature_info_t *, void *);
91
92#define	ZFS_FEATURE_DEBUG
93
94extern zfeature_info_t spa_feature_table[SPA_FEATURES];
95
96extern boolean_t zfeature_is_valid_guid(const char *);
97
98extern boolean_t zfeature_is_supported(const char *);
99extern int zfeature_lookup_name(const char *, spa_feature_t *);
100extern boolean_t zfeature_depends_on(spa_feature_t, spa_feature_t);
101
102extern void zpool_feature_init(void);
103
104#ifdef	__cplusplus
105}
106#endif
107
108#endif	/* _ZFEATURE_COMMON_H */
109