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.
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.
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]
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, Nexenta Systems, Inc. All rights reserved.
27 * Copyright (c) 2014 Integros [integros.com]
31 #include <sys/systm.h>
36 #include <sys/debug.h>
37 #include <sys/fs/zfs.h>
38 #include <sys/inttypes.h>
39 #include <sys/types.h>
40 #include "zfeature_common.h"
43 * Set to disable all feature checks while opening pools, allowing pools with
44 * unsupported features to be opened. Set for testing only.
46 boolean_t zfeature_checks_disable
= B_FALSE
;
48 zfeature_info_t spa_feature_table
[SPA_FEATURES
];
51 * Valid characters for feature guids. This list is mainly for aesthetic
52 * purposes and could be expanded in the future. There are different allowed
53 * characters in the guids reverse dns portion (before the colon) and its
54 * short name (after the colon).
57 valid_char(char c
, boolean_t after_colon
)
59 return ((c
>= 'a' && c
<= 'z') ||
60 (c
>= '0' && c
<= '9') ||
61 (after_colon
&& c
== '_') ||
62 (!after_colon
&& (c
== '.' || c
== '-')));
66 * Every feature guid must contain exactly one colon which separates a reverse
67 * dns organization name from the feature's "short" name (e.g.
68 * "com.company:feature_name").
71 zfeature_is_valid_guid(const char *name
)
74 boolean_t has_colon
= B_FALSE
;
77 while (name
[i
] != '\0') {
85 if (!valid_char(c
, has_colon
))
93 zfeature_is_supported(const char *guid
)
95 if (zfeature_checks_disable
)
98 for (spa_feature_t i
= 0; i
< SPA_FEATURES
; i
++) {
99 zfeature_info_t
*feature
= &spa_feature_table
[i
];
100 if (strcmp(guid
, feature
->fi_guid
) == 0)
107 zfeature_lookup_name(const char *name
, spa_feature_t
*res
)
109 for (spa_feature_t i
= 0; i
< SPA_FEATURES
; i
++) {
110 zfeature_info_t
*feature
= &spa_feature_table
[i
];
111 if (strcmp(name
, feature
->fi_uname
) == 0) {
122 zfeature_depends_on(spa_feature_t fid
, spa_feature_t check
)
124 zfeature_info_t
*feature
= &spa_feature_table
[fid
];
126 for (int i
= 0; feature
->fi_depends
[i
] != SPA_FEATURE_NONE
; i
++) {
127 if (feature
->fi_depends
[i
] == check
)
134 deps_contains_feature(const spa_feature_t
*deps
, const spa_feature_t feature
)
136 for (int i
= 0; deps
[i
] != SPA_FEATURE_NONE
; i
++)
137 if (deps
[i
] == feature
)
144 zfeature_register(spa_feature_t fid
, const char *guid
, const char *name
,
145 const char *desc
, zfeature_flags_t flags
, const spa_feature_t
*deps
)
147 zfeature_info_t
*feature
= &spa_feature_table
[fid
];
148 static spa_feature_t nodeps
[] = { SPA_FEATURE_NONE
};
150 ASSERT(name
!= NULL
);
151 ASSERT(desc
!= NULL
);
152 ASSERT((flags
& ZFEATURE_FLAG_READONLY_COMPAT
) == 0 ||
153 (flags
& ZFEATURE_FLAG_MOS
) == 0);
154 ASSERT3U(fid
, <, SPA_FEATURES
);
155 ASSERT(zfeature_is_valid_guid(guid
));
160 VERIFY(((flags
& ZFEATURE_FLAG_PER_DATASET
) == 0) ||
161 (deps_contains_feature(deps
, SPA_FEATURE_EXTENSIBLE_DATASET
)));
163 feature
->fi_feature
= fid
;
164 feature
->fi_guid
= guid
;
165 feature
->fi_uname
= name
;
166 feature
->fi_desc
= desc
;
167 feature
->fi_flags
= flags
;
168 feature
->fi_depends
= deps
;
172 zpool_feature_init(void)
174 zfeature_register(SPA_FEATURE_ASYNC_DESTROY
,
175 "com.delphix:async_destroy", "async_destroy",
176 "Destroy filesystems asynchronously.",
177 ZFEATURE_FLAG_READONLY_COMPAT
, NULL
);
179 zfeature_register(SPA_FEATURE_EMPTY_BPOBJ
,
180 "com.delphix:empty_bpobj", "empty_bpobj",
181 "Snapshots use less space.",
182 ZFEATURE_FLAG_READONLY_COMPAT
, NULL
);
184 zfeature_register(SPA_FEATURE_LZ4_COMPRESS
,
185 "org.illumos:lz4_compress", "lz4_compress",
186 "LZ4 compression algorithm support.",
187 ZFEATURE_FLAG_ACTIVATE_ON_ENABLE
, NULL
);
189 zfeature_register(SPA_FEATURE_MULTI_VDEV_CRASH_DUMP
,
190 "com.joyent:multi_vdev_crash_dump", "multi_vdev_crash_dump",
191 "Crash dumps to multiple vdev pools.",
194 zfeature_register(SPA_FEATURE_SPACEMAP_HISTOGRAM
,
195 "com.delphix:spacemap_histogram", "spacemap_histogram",
196 "Spacemaps maintain space histograms.",
197 ZFEATURE_FLAG_READONLY_COMPAT
, NULL
);
199 zfeature_register(SPA_FEATURE_ENABLED_TXG
,
200 "com.delphix:enabled_txg", "enabled_txg",
201 "Record txg at which a feature is enabled",
202 ZFEATURE_FLAG_READONLY_COMPAT
, NULL
);
204 static spa_feature_t hole_birth_deps
[] = {
205 SPA_FEATURE_ENABLED_TXG
,
208 zfeature_register(SPA_FEATURE_HOLE_BIRTH
,
209 "com.delphix:hole_birth", "hole_birth",
210 "Retain hole birth txg for more precise zfs send",
211 ZFEATURE_FLAG_MOS
| ZFEATURE_FLAG_ACTIVATE_ON_ENABLE
,
214 zfeature_register(SPA_FEATURE_EXTENSIBLE_DATASET
,
215 "com.delphix:extensible_dataset", "extensible_dataset",
216 "Enhanced dataset functionality, used by other features.",
219 static const spa_feature_t bookmarks_deps
[] = {
220 SPA_FEATURE_EXTENSIBLE_DATASET
,
223 zfeature_register(SPA_FEATURE_BOOKMARKS
,
224 "com.delphix:bookmarks", "bookmarks",
225 "\"zfs bookmark\" command",
226 ZFEATURE_FLAG_READONLY_COMPAT
, bookmarks_deps
);
228 static const spa_feature_t filesystem_limits_deps
[] = {
229 SPA_FEATURE_EXTENSIBLE_DATASET
,
232 zfeature_register(SPA_FEATURE_FS_SS_LIMIT
,
233 "com.joyent:filesystem_limits", "filesystem_limits",
234 "Filesystem and snapshot limits.",
235 ZFEATURE_FLAG_READONLY_COMPAT
, filesystem_limits_deps
);
237 zfeature_register(SPA_FEATURE_EMBEDDED_DATA
,
238 "com.delphix:embedded_data", "embedded_data",
239 "Blocks which compress very well use even less space.",
240 ZFEATURE_FLAG_MOS
| ZFEATURE_FLAG_ACTIVATE_ON_ENABLE
,
243 zfeature_register(SPA_FEATURE_POOL_CHECKPOINT
,
244 "com.delphix:zpool_checkpoint", "zpool_checkpoint",
245 "Pool state can be checkpointed, allowing rewind later.",
246 ZFEATURE_FLAG_READONLY_COMPAT
, NULL
);
248 static const spa_feature_t large_blocks_deps
[] = {
249 SPA_FEATURE_EXTENSIBLE_DATASET
,
252 zfeature_register(SPA_FEATURE_LARGE_BLOCKS
,
253 "org.open-zfs:large_blocks", "large_blocks",
254 "Support for blocks larger than 128KB.",
255 ZFEATURE_FLAG_PER_DATASET
, large_blocks_deps
);
257 static const spa_feature_t sha512_deps
[] = {
258 SPA_FEATURE_EXTENSIBLE_DATASET
,
261 zfeature_register(SPA_FEATURE_SHA512
,
262 "org.illumos:sha512", "sha512",
263 "SHA-512/256 hash algorithm.",
264 ZFEATURE_FLAG_PER_DATASET
, sha512_deps
);
266 static const spa_feature_t skein_deps
[] = {
267 SPA_FEATURE_EXTENSIBLE_DATASET
,
270 zfeature_register(SPA_FEATURE_SKEIN
,
271 "org.illumos:skein", "skein",
272 "Skein hash algorithm.",
273 ZFEATURE_FLAG_PER_DATASET
, skein_deps
);
275 static const spa_feature_t edonr_deps
[] = {
276 SPA_FEATURE_EXTENSIBLE_DATASET
,
279 zfeature_register(SPA_FEATURE_EDONR
,
280 "org.illumos:edonr", "edonr",
281 "Edon-R hash algorithm.",
282 ZFEATURE_FLAG_PER_DATASET
, edonr_deps
);
284 zfeature_register(SPA_FEATURE_DEVICE_REMOVAL
,
285 "com.delphix:device_removal", "device_removal",
286 "Top-level vdevs can be removed, reducing logical pool size.",
287 ZFEATURE_FLAG_MOS
, NULL
);
289 static const spa_feature_t obsolete_counts_deps
[] = {
290 SPA_FEATURE_EXTENSIBLE_DATASET
,
291 SPA_FEATURE_DEVICE_REMOVAL
,
294 zfeature_register(SPA_FEATURE_OBSOLETE_COUNTS
,
295 "com.delphix:obsolete_counts", "obsolete_counts",
296 "Reduce memory used by removed devices when their blocks are "
297 "freed or remapped.",
298 ZFEATURE_FLAG_READONLY_COMPAT
, obsolete_counts_deps
);