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, 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) 2014, Nexenta Systems, Inc. All rights reserved.
27 * Copyright (c) 2017, Intel Corporation.
28 * Copyright (c) 2019, Klara Inc.
29 * Copyright (c) 2019, Allan Jude
37 #include <sys/debug.h>
38 #include <sys/fs/zfs.h>
39 #include <sys/inttypes.h>
40 #include <sys/types.h>
41 #include <sys/param.h>
42 #include <sys/zfs_sysfs.h>
43 #include "zfeature_common.h"
46 * Set to disable all feature checks while opening pools, allowing pools with
47 * unsupported features to be opened. Set for testing only.
49 boolean_t zfeature_checks_disable
= B_FALSE
;
51 zfeature_info_t spa_feature_table
[SPA_FEATURES
];
54 * Valid characters for feature guids. This list is mainly for aesthetic
55 * purposes and could be expanded in the future. There are different allowed
56 * characters in the guids reverse dns portion (before the colon) and its
57 * short name (after the colon).
60 valid_char(char c
, boolean_t after_colon
)
62 return ((c
>= 'a' && c
<= 'z') ||
63 (c
>= '0' && c
<= '9') ||
64 (after_colon
&& c
== '_') ||
65 (!after_colon
&& (c
== '.' || c
== '-')));
69 * Every feature guid must contain exactly one colon which separates a reverse
70 * dns organization name from the feature's "short" name (e.g.
71 * "com.company:feature_name").
74 zfeature_is_valid_guid(const char *name
)
77 boolean_t has_colon
= B_FALSE
;
80 while (name
[i
] != '\0') {
88 if (!valid_char(c
, has_colon
))
96 zfeature_is_supported(const char *guid
)
98 if (zfeature_checks_disable
)
101 for (spa_feature_t i
= 0; i
< SPA_FEATURES
; i
++) {
102 zfeature_info_t
*feature
= &spa_feature_table
[i
];
103 if (!feature
->fi_zfs_mod_supported
)
105 if (strcmp(guid
, feature
->fi_guid
) == 0)
112 zfeature_lookup_guid(const char *guid
, spa_feature_t
*res
)
114 for (spa_feature_t i
= 0; i
< SPA_FEATURES
; i
++) {
115 zfeature_info_t
*feature
= &spa_feature_table
[i
];
116 if (!feature
->fi_zfs_mod_supported
)
118 if (strcmp(guid
, feature
->fi_guid
) == 0) {
129 zfeature_lookup_name(const char *name
, spa_feature_t
*res
)
131 for (spa_feature_t i
= 0; i
< SPA_FEATURES
; i
++) {
132 zfeature_info_t
*feature
= &spa_feature_table
[i
];
133 if (!feature
->fi_zfs_mod_supported
)
135 if (strcmp(name
, feature
->fi_uname
) == 0) {
146 zfeature_depends_on(spa_feature_t fid
, spa_feature_t check
)
148 zfeature_info_t
*feature
= &spa_feature_table
[fid
];
150 for (int i
= 0; feature
->fi_depends
[i
] != SPA_FEATURE_NONE
; i
++) {
151 if (feature
->fi_depends
[i
] == check
)
158 deps_contains_feature(const spa_feature_t
*deps
, const spa_feature_t feature
)
160 for (int i
= 0; deps
[i
] != SPA_FEATURE_NONE
; i
++)
161 if (deps
[i
] == feature
)
167 #if !defined(_KERNEL) && !defined(LIB_ZPOOL_BUILD)
169 zfs_mod_supported_impl(const char *scope
, const char *name
, const char *sysfs
)
171 boolean_t supported
= B_FALSE
;
174 int len
= asprintf(&path
, "%s%s%s%s%s", sysfs
,
175 scope
== NULL
? "" : "/", scope
== NULL
? "" : scope
,
176 name
== NULL
? "" : "/", name
== NULL
? "" : name
);
178 struct stat64 statbuf
;
179 supported
= !!(stat64(path
, &statbuf
) == 0);
187 zfs_mod_supported(const char *scope
, const char *name
)
192 * Check both the primary and alternate sysfs locations to determine
193 * if the required functionality is supported.
195 supported
= (zfs_mod_supported_impl(scope
, name
, ZFS_SYSFS_DIR
) ||
196 zfs_mod_supported_impl(scope
, name
, ZFS_SYSFS_ALT_DIR
));
199 * For backwards compatibility with kernel modules that predate
200 * supported feature/property checking. Report the feature/property
201 * as supported if the kernel module is loaded but the requested
202 * scope directory does not exist.
204 if (supported
== B_FALSE
) {
205 struct stat64 statbuf
;
206 if ((stat64(ZFS_SYSFS_DIR
, &statbuf
) == 0) &&
207 !zfs_mod_supported_impl(scope
, NULL
, ZFS_SYSFS_DIR
) &&
208 !zfs_mod_supported_impl(scope
, NULL
, ZFS_SYSFS_ALT_DIR
)) {
218 zfs_mod_supported_feature(const char *name
)
221 * The zfs module spa_feature_table[], whether in-kernel or in
222 * libzpool, always supports all the features. libzfs needs to
223 * query the running module, via sysfs, to determine which
224 * features are supported.
226 * The equivalent _can_ be done on FreeBSD by way of the sysctl
227 * tree, but this has not been done yet. Therefore, we return
228 * that all features are supported.
231 #if defined(_KERNEL) || defined(LIB_ZPOOL_BUILD) || defined(__FreeBSD__)
235 return (zfs_mod_supported(ZFS_SYSFS_POOL_FEATURES
, name
));
240 zfeature_register(spa_feature_t fid
, const char *guid
, const char *name
,
241 const char *desc
, zfeature_flags_t flags
, zfeature_type_t type
,
242 const spa_feature_t
*deps
)
244 zfeature_info_t
*feature
= &spa_feature_table
[fid
];
245 static spa_feature_t nodeps
[] = { SPA_FEATURE_NONE
};
247 ASSERT(name
!= NULL
);
248 ASSERT(desc
!= NULL
);
249 ASSERT((flags
& ZFEATURE_FLAG_READONLY_COMPAT
) == 0 ||
250 (flags
& ZFEATURE_FLAG_MOS
) == 0);
251 ASSERT3U(fid
, <, SPA_FEATURES
);
252 ASSERT(zfeature_is_valid_guid(guid
));
257 VERIFY(((flags
& ZFEATURE_FLAG_PER_DATASET
) == 0) ||
258 (deps_contains_feature(deps
, SPA_FEATURE_EXTENSIBLE_DATASET
)));
260 feature
->fi_feature
= fid
;
261 feature
->fi_guid
= guid
;
262 feature
->fi_uname
= name
;
263 feature
->fi_desc
= desc
;
264 feature
->fi_flags
= flags
;
265 feature
->fi_type
= type
;
266 feature
->fi_depends
= deps
;
267 feature
->fi_zfs_mod_supported
= zfs_mod_supported_feature(guid
);
271 * Every feature has a GUID of the form com.example:feature_name. The
272 * reversed DNS name ensures that the feature's GUID is unique across all ZFS
273 * implementations. This allows companies to independently develop and
274 * release features. Examples include org.delphix and org.datto. Previously,
275 * features developed on one implementation have used that implementation's
276 * domain name (e.g. org.illumos and org.zfsonlinux). Use of the org.openzfs
277 * domain name is recommended for new features which are developed by the
278 * OpenZFS community and its platforms. This domain may optionally be used by
279 * companies developing features for initial release through an OpenZFS
280 * implementation. Use of the org.openzfs domain requires reserving the
281 * feature name in advance with the OpenZFS project.
284 zpool_feature_init(void)
286 zfeature_register(SPA_FEATURE_ASYNC_DESTROY
,
287 "com.delphix:async_destroy", "async_destroy",
288 "Destroy filesystems asynchronously.",
289 ZFEATURE_FLAG_READONLY_COMPAT
, ZFEATURE_TYPE_BOOLEAN
, NULL
);
291 zfeature_register(SPA_FEATURE_EMPTY_BPOBJ
,
292 "com.delphix:empty_bpobj", "empty_bpobj",
293 "Snapshots use less space.",
294 ZFEATURE_FLAG_READONLY_COMPAT
, ZFEATURE_TYPE_BOOLEAN
, NULL
);
296 zfeature_register(SPA_FEATURE_LZ4_COMPRESS
,
297 "org.illumos:lz4_compress", "lz4_compress",
298 "LZ4 compression algorithm support.",
299 ZFEATURE_FLAG_ACTIVATE_ON_ENABLE
, ZFEATURE_TYPE_BOOLEAN
, NULL
);
301 zfeature_register(SPA_FEATURE_MULTI_VDEV_CRASH_DUMP
,
302 "com.joyent:multi_vdev_crash_dump", "multi_vdev_crash_dump",
303 "Crash dumps to multiple vdev pools.",
304 0, ZFEATURE_TYPE_BOOLEAN
, NULL
);
306 zfeature_register(SPA_FEATURE_SPACEMAP_HISTOGRAM
,
307 "com.delphix:spacemap_histogram", "spacemap_histogram",
308 "Spacemaps maintain space histograms.",
309 ZFEATURE_FLAG_READONLY_COMPAT
, ZFEATURE_TYPE_BOOLEAN
, NULL
);
311 zfeature_register(SPA_FEATURE_ENABLED_TXG
,
312 "com.delphix:enabled_txg", "enabled_txg",
313 "Record txg at which a feature is enabled",
314 ZFEATURE_FLAG_READONLY_COMPAT
, ZFEATURE_TYPE_BOOLEAN
, NULL
);
317 static const spa_feature_t hole_birth_deps
[] = {
318 SPA_FEATURE_ENABLED_TXG
,
321 zfeature_register(SPA_FEATURE_HOLE_BIRTH
,
322 "com.delphix:hole_birth", "hole_birth",
323 "Retain hole birth txg for more precise zfs send",
324 ZFEATURE_FLAG_MOS
| ZFEATURE_FLAG_ACTIVATE_ON_ENABLE
,
325 ZFEATURE_TYPE_BOOLEAN
, hole_birth_deps
);
328 zfeature_register(SPA_FEATURE_POOL_CHECKPOINT
,
329 "com.delphix:zpool_checkpoint", "zpool_checkpoint",
330 "Pool state can be checkpointed, allowing rewind later.",
331 ZFEATURE_FLAG_READONLY_COMPAT
, ZFEATURE_TYPE_BOOLEAN
, NULL
);
333 zfeature_register(SPA_FEATURE_SPACEMAP_V2
,
334 "com.delphix:spacemap_v2", "spacemap_v2",
335 "Space maps representing large segments are more efficient.",
336 ZFEATURE_FLAG_READONLY_COMPAT
| ZFEATURE_FLAG_ACTIVATE_ON_ENABLE
,
337 ZFEATURE_TYPE_BOOLEAN
, NULL
);
339 zfeature_register(SPA_FEATURE_EXTENSIBLE_DATASET
,
340 "com.delphix:extensible_dataset", "extensible_dataset",
341 "Enhanced dataset functionality, used by other features.",
342 0, ZFEATURE_TYPE_BOOLEAN
, NULL
);
345 static const spa_feature_t bookmarks_deps
[] = {
346 SPA_FEATURE_EXTENSIBLE_DATASET
,
350 zfeature_register(SPA_FEATURE_BOOKMARKS
,
351 "com.delphix:bookmarks", "bookmarks",
352 "\"zfs bookmark\" command",
353 ZFEATURE_FLAG_READONLY_COMPAT
, ZFEATURE_TYPE_BOOLEAN
,
358 static const spa_feature_t filesystem_limits_deps
[] = {
359 SPA_FEATURE_EXTENSIBLE_DATASET
,
362 zfeature_register(SPA_FEATURE_FS_SS_LIMIT
,
363 "com.joyent:filesystem_limits", "filesystem_limits",
364 "Filesystem and snapshot limits.",
365 ZFEATURE_FLAG_READONLY_COMPAT
, ZFEATURE_TYPE_BOOLEAN
,
366 filesystem_limits_deps
);
369 zfeature_register(SPA_FEATURE_EMBEDDED_DATA
,
370 "com.delphix:embedded_data", "embedded_data",
371 "Blocks which compress very well use even less space.",
372 ZFEATURE_FLAG_MOS
| ZFEATURE_FLAG_ACTIVATE_ON_ENABLE
,
373 ZFEATURE_TYPE_BOOLEAN
, NULL
);
376 static const spa_feature_t livelist_deps
[] = {
377 SPA_FEATURE_EXTENSIBLE_DATASET
,
380 zfeature_register(SPA_FEATURE_LIVELIST
,
381 "com.delphix:livelist", "livelist",
382 "Improved clone deletion performance.",
383 ZFEATURE_FLAG_READONLY_COMPAT
, ZFEATURE_TYPE_BOOLEAN
,
388 static const spa_feature_t log_spacemap_deps
[] = {
389 SPA_FEATURE_SPACEMAP_V2
,
392 zfeature_register(SPA_FEATURE_LOG_SPACEMAP
,
393 "com.delphix:log_spacemap", "log_spacemap",
394 "Log metaslab changes on a single spacemap and "
395 "flush them periodically.",
396 ZFEATURE_FLAG_READONLY_COMPAT
, ZFEATURE_TYPE_BOOLEAN
,
401 static const spa_feature_t large_blocks_deps
[] = {
402 SPA_FEATURE_EXTENSIBLE_DATASET
,
405 zfeature_register(SPA_FEATURE_LARGE_BLOCKS
,
406 "org.open-zfs:large_blocks", "large_blocks",
407 "Support for blocks larger than 128KB.",
408 ZFEATURE_FLAG_PER_DATASET
, ZFEATURE_TYPE_BOOLEAN
,
413 static const spa_feature_t large_dnode_deps
[] = {
414 SPA_FEATURE_EXTENSIBLE_DATASET
,
417 zfeature_register(SPA_FEATURE_LARGE_DNODE
,
418 "org.zfsonlinux:large_dnode", "large_dnode",
419 "Variable on-disk size of dnodes.",
420 ZFEATURE_FLAG_PER_DATASET
, ZFEATURE_TYPE_BOOLEAN
,
425 static const spa_feature_t sha512_deps
[] = {
426 SPA_FEATURE_EXTENSIBLE_DATASET
,
429 zfeature_register(SPA_FEATURE_SHA512
,
430 "org.illumos:sha512", "sha512",
431 "SHA-512/256 hash algorithm.",
432 ZFEATURE_FLAG_PER_DATASET
, ZFEATURE_TYPE_BOOLEAN
,
437 static const spa_feature_t skein_deps
[] = {
438 SPA_FEATURE_EXTENSIBLE_DATASET
,
441 zfeature_register(SPA_FEATURE_SKEIN
,
442 "org.illumos:skein", "skein",
443 "Skein hash algorithm.",
444 ZFEATURE_FLAG_PER_DATASET
, ZFEATURE_TYPE_BOOLEAN
,
449 static const spa_feature_t edonr_deps
[] = {
450 SPA_FEATURE_EXTENSIBLE_DATASET
,
453 zfeature_register(SPA_FEATURE_EDONR
,
454 "org.illumos:edonr", "edonr",
455 "Edon-R hash algorithm.",
456 ZFEATURE_FLAG_PER_DATASET
, ZFEATURE_TYPE_BOOLEAN
,
461 static const spa_feature_t redact_books_deps
[] = {
462 SPA_FEATURE_BOOKMARK_V2
,
463 SPA_FEATURE_EXTENSIBLE_DATASET
,
464 SPA_FEATURE_BOOKMARKS
,
467 zfeature_register(SPA_FEATURE_REDACTION_BOOKMARKS
,
468 "com.delphix:redaction_bookmarks", "redaction_bookmarks",
469 "Support for bookmarks which store redaction lists for zfs "
470 "redacted send/recv.", 0, ZFEATURE_TYPE_BOOLEAN
,
475 static const spa_feature_t redact_datasets_deps
[] = {
476 SPA_FEATURE_EXTENSIBLE_DATASET
,
479 zfeature_register(SPA_FEATURE_REDACTED_DATASETS
,
480 "com.delphix:redacted_datasets", "redacted_datasets", "Support for "
481 "redacted datasets, produced by receiving a redacted zfs send "
482 "stream.", ZFEATURE_FLAG_PER_DATASET
, ZFEATURE_TYPE_UINT64_ARRAY
,
483 redact_datasets_deps
);
487 static const spa_feature_t bookmark_written_deps
[] = {
488 SPA_FEATURE_BOOKMARK_V2
,
489 SPA_FEATURE_EXTENSIBLE_DATASET
,
490 SPA_FEATURE_BOOKMARKS
,
493 zfeature_register(SPA_FEATURE_BOOKMARK_WRITTEN
,
494 "com.delphix:bookmark_written", "bookmark_written",
495 "Additional accounting, enabling the written#<bookmark> property"
496 "(space written since a bookmark), and estimates of send stream "
497 "sizes for incrementals from bookmarks.",
498 0, ZFEATURE_TYPE_BOOLEAN
, bookmark_written_deps
);
501 zfeature_register(SPA_FEATURE_DEVICE_REMOVAL
,
502 "com.delphix:device_removal", "device_removal",
503 "Top-level vdevs can be removed, reducing logical pool size.",
504 ZFEATURE_FLAG_MOS
, ZFEATURE_TYPE_BOOLEAN
, NULL
);
507 static const spa_feature_t obsolete_counts_deps
[] = {
508 SPA_FEATURE_EXTENSIBLE_DATASET
,
509 SPA_FEATURE_DEVICE_REMOVAL
,
512 zfeature_register(SPA_FEATURE_OBSOLETE_COUNTS
,
513 "com.delphix:obsolete_counts", "obsolete_counts",
514 "Reduce memory used by removed devices when their blocks are "
515 "freed or remapped.",
516 ZFEATURE_FLAG_READONLY_COMPAT
, ZFEATURE_TYPE_BOOLEAN
,
517 obsolete_counts_deps
);
521 static const spa_feature_t userobj_accounting_deps
[] = {
522 SPA_FEATURE_EXTENSIBLE_DATASET
,
525 zfeature_register(SPA_FEATURE_USEROBJ_ACCOUNTING
,
526 "org.zfsonlinux:userobj_accounting", "userobj_accounting",
527 "User/Group object accounting.",
528 ZFEATURE_FLAG_READONLY_COMPAT
| ZFEATURE_FLAG_PER_DATASET
,
529 ZFEATURE_TYPE_BOOLEAN
, userobj_accounting_deps
);
533 static const spa_feature_t bookmark_v2_deps
[] = {
534 SPA_FEATURE_EXTENSIBLE_DATASET
,
535 SPA_FEATURE_BOOKMARKS
,
538 zfeature_register(SPA_FEATURE_BOOKMARK_V2
,
539 "com.datto:bookmark_v2", "bookmark_v2",
540 "Support for larger bookmarks",
541 0, ZFEATURE_TYPE_BOOLEAN
, bookmark_v2_deps
);
545 static const spa_feature_t encryption_deps
[] = {
546 SPA_FEATURE_EXTENSIBLE_DATASET
,
547 SPA_FEATURE_BOOKMARK_V2
,
550 zfeature_register(SPA_FEATURE_ENCRYPTION
,
551 "com.datto:encryption", "encryption",
552 "Support for dataset level encryption",
553 ZFEATURE_FLAG_PER_DATASET
, ZFEATURE_TYPE_BOOLEAN
,
558 static const spa_feature_t project_quota_deps
[] = {
559 SPA_FEATURE_EXTENSIBLE_DATASET
,
562 zfeature_register(SPA_FEATURE_PROJECT_QUOTA
,
563 "org.zfsonlinux:project_quota", "project_quota",
564 "space/object accounting based on project ID.",
565 ZFEATURE_FLAG_READONLY_COMPAT
| ZFEATURE_FLAG_PER_DATASET
,
566 ZFEATURE_TYPE_BOOLEAN
, project_quota_deps
);
569 zfeature_register(SPA_FEATURE_ALLOCATION_CLASSES
,
570 "org.zfsonlinux:allocation_classes", "allocation_classes",
571 "Support for separate allocation classes.",
572 ZFEATURE_FLAG_READONLY_COMPAT
, ZFEATURE_TYPE_BOOLEAN
, NULL
);
574 zfeature_register(SPA_FEATURE_RESILVER_DEFER
,
575 "com.datto:resilver_defer", "resilver_defer",
576 "Support for deferring new resilvers when one is already running.",
577 ZFEATURE_FLAG_READONLY_COMPAT
, ZFEATURE_TYPE_BOOLEAN
, NULL
);
579 zfeature_register(SPA_FEATURE_DEVICE_REBUILD
,
580 "org.openzfs:device_rebuild", "device_rebuild",
581 "Support for sequential mirror/dRAID device rebuilds",
582 ZFEATURE_FLAG_READONLY_COMPAT
, ZFEATURE_TYPE_BOOLEAN
, NULL
);
585 static const spa_feature_t zstd_deps
[] = {
586 SPA_FEATURE_EXTENSIBLE_DATASET
,
589 zfeature_register(SPA_FEATURE_ZSTD_COMPRESS
,
590 "org.freebsd:zstd_compress", "zstd_compress",
591 "zstd compression algorithm support.",
592 ZFEATURE_FLAG_PER_DATASET
, ZFEATURE_TYPE_BOOLEAN
, zstd_deps
);
595 zfeature_register(SPA_FEATURE_DRAID
,
596 "org.openzfs:draid", "draid", "Support for distributed spare RAID",
597 ZFEATURE_FLAG_MOS
, ZFEATURE_TYPE_BOOLEAN
, NULL
);
601 EXPORT_SYMBOL(zfeature_lookup_guid
);
602 EXPORT_SYMBOL(zfeature_lookup_name
);
603 EXPORT_SYMBOL(zfeature_is_supported
);
604 EXPORT_SYMBOL(zfeature_is_valid_guid
);
605 EXPORT_SYMBOL(zfeature_depends_on
);
606 EXPORT_SYMBOL(zpool_feature_init
);
607 EXPORT_SYMBOL(spa_feature_table
);