ZTS: Fix zpool_import_hostid_changed_cachefile_unclean_export
[zfs.git] / man / man7 / zpool-features.7
blobfe7715496eadaa31b6684e3f38aa2809711b77aa
1 .\"
2 .\" Copyright (c) 2012, 2018 by Delphix. All rights reserved.
3 .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
4 .\" Copyright (c) 2014, Joyent, Inc. All rights reserved.
5 .\" The contents of this file are subject to the terms of the Common Development
6 .\" and Distribution License (the "License").  You may not use this file except
7 .\" in compliance with the License. You can obtain a copy of the license at
8 .\" usr/src/OPENSOLARIS.LICENSE or https://opensource.org/licenses/CDDL-1.0.
9 .\"
10 .\" See the License for the specific language governing permissions and
11 .\" limitations under the License. When distributing Covered Code, include this
12 .\" CDDL HEADER in each file and include the License file at
13 .\" usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this
14 .\" CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your
15 .\" own identifying information:
16 .\" Portions Copyright [yyyy] [name of copyright owner]
17 .\" Copyright (c) 2019, Klara Inc.
18 .\" Copyright (c) 2019, Allan Jude
19 .\" Copyright (c) 2021, Colm Buckley <colm@tuatha.org>
20 .\" Copyright (c) 2023, Klara Inc.
21 .\"
22 .Dd February 14, 2024
23 .Dt ZPOOL-FEATURES 7
24 .Os
26 .Sh NAME
27 .Nm zpool-features
28 .Nd description of ZFS pool features
30 .Sh DESCRIPTION
31 ZFS pool on-disk format versions are specified via
32 .Dq features
33 which replace the old on-disk format numbers
34 .Pq the last supported on-disk format number is 28 .
35 To enable a feature on a pool use the
36 .Nm zpool Cm upgrade ,
37 or set the
38 .Sy feature Ns @ Ns Ar feature-name
39 property to
40 .Sy enabled .
41 Please also see the
42 .Sx Compatibility feature sets
43 section for information on how sets of features may be enabled together.
44 .Pp
45 The pool format does not affect file system version compatibility or the ability
46 to send file systems between pools.
47 .Pp
48 Since most features can be enabled independently of each other, the on-disk
49 format of the pool is specified by the set of all features marked as
50 .Sy active
51 on the pool.
52 If the pool was created by another software version
53 this set may include unsupported features.
55 .Ss Identifying features
56 Every feature has a GUID of the form
57 .Ar com.example : Ns Ar feature-name .
58 The reversed DNS name ensures that the feature's GUID is unique across all ZFS
59 implementations.
60 When unsupported features are encountered on a pool they will
61 be identified by their GUIDs.
62 Refer to the documentation for the ZFS
63 implementation that created the pool for information about those features.
64 .Pp
65 Each supported feature also has a short name.
66 By convention a feature's short name is the portion of its GUID which follows
67 the
68 .Sq \&:
69 .Po
70 i.e.
71 .Ar com.example : Ns Ar feature-name
72 would have the short name
73 .Ar feature-name
74 .Pc ,
75 however a feature's short name may differ across ZFS implementations if
76 following the convention would result in name conflicts.
78 .Ss Feature states
79 Features can be in one of three states:
80 .Bl -tag -width "disabled"
81 .It Sy active
82 This feature's on-disk format changes are in effect on the pool.
83 Support for this feature is required to import the pool in read-write mode.
84 If this feature is not read-only compatible,
85 support is also required to import the pool in read-only mode
86 .Pq see Sx Read-only compatibility .
87 .It Sy enabled
88 An administrator has marked this feature as enabled on the pool, but the
89 feature's on-disk format changes have not been made yet.
90 The pool can still be imported by software that does not support this feature,
91 but changes may be made to the on-disk format at any time
92 which will move the feature to the
93 .Sy active
94 state.
95 Some features may support returning to the
96 .Sy enabled
97 state after becoming
98 .Sy active .
99 See feature-specific documentation for details.
100 .It Sy disabled
101 This feature's on-disk format changes have not been made and will not be made
102 unless an administrator moves the feature to the
103 .Sy enabled
104 state.
105 Features cannot be disabled once they have been enabled.
108 The state of supported features is exposed through pool properties of the form
109 .Sy feature Ns @ Ns Ar short-name .
111 .Ss Read-only compatibility
112 Some features may make on-disk format changes that do not interfere with other
113 software's ability to read from the pool.
114 These features are referred to as
115 .Dq read-only compatible .
116 If all unsupported features on a pool are read-only compatible,
117 the pool can be imported in read-only mode by setting the
118 .Sy readonly
119 property during import
120 .Po see
121 .Xr zpool-import 8
122 for details on importing pools
123 .Pc .
125 .Ss Unsupported features
126 For each unsupported feature enabled on an imported pool, a pool property
127 named
128 .Sy unsupported Ns @ Ns Ar feature-name
129 will indicate why the import was allowed despite the unsupported feature.
130 Possible values for this property are:
131 .Bl -tag -width "readonly"
132 .It Sy inactive
133 The feature is in the
134 .Sy enabled
135 state and therefore the pool's on-disk
136 format is still compatible with software that does not support this feature.
137 .It Sy readonly
138 The feature is read-only compatible and the pool has been imported in
139 read-only mode.
142 .Ss Feature dependencies
143 Some features depend on other features being enabled in order to function.
144 Enabling a feature will automatically enable any features it depends on.
146 .Ss Compatibility feature sets
147 It is sometimes necessary for a pool to maintain compatibility with a
148 specific on-disk format, by enabling and disabling particular features.
150 .Sy compatibility
151 feature facilitates this by allowing feature sets to be read from text files.
152 When set to
153 .Sy off
154 .Pq the default ,
155 compatibility feature sets are disabled
156 .Pq i.e. all features are enabled ;
157 when set to
158 .Sy legacy ,
159 no features are enabled.
160 When set to a comma-separated list of filenames
162 each filename may either be an absolute path, or relative to
163 .Pa /etc/zfs/compatibility.d
165 .Pa /usr/share/zfs/compatibility.d
166 .Pc ,
167 the lists of requested features are read from those files,
168 separated by whitespace and/or commas.
169 Only features present in all files are enabled.
171 Simple sanity checks are applied to the files:
172 they must be between 1 B and 16 KiB in size, and must end with a newline
173 character.
175 The requested features are applied when a pool is created using
176 .Nm zpool Cm create Fl o Sy compatibility Ns = Ns Ar …
177 and controls which features are enabled when using
178 .Nm zpool Cm upgrade .
179 .Nm zpool Cm status
180 will not show a warning about disabled features which are not part
181 of the requested feature set.
183 The special value
184 .Sy legacy
185 prevents any features from being enabled, either via
186 .Nm zpool Cm upgrade
188 .Nm zpool Cm set Sy feature Ns @ Ns Ar feature-name Ns = Ns Sy enabled .
189 This setting also prevents pools from being upgraded to newer on-disk versions.
190 This is a safety measure to prevent new features from being
191 accidentally enabled, breaking compatibility.
193 By convention, compatibility files in
194 .Pa /usr/share/zfs/compatibility.d
195 are provided by the distribution, and include feature sets
196 supported by important versions of popular distributions, and feature
197 sets commonly supported at the start of each year.
198 Compatibility files in
199 .Pa /etc/zfs/compatibility.d ,
200 if present, will take precedence over files with the same name in
201 .Pa /usr/share/zfs/compatibility.d .
203 If an unrecognized feature is found in these files, an error message will
204 be shown.
205 If the unrecognized feature is in a file in
206 .Pa /etc/zfs/compatibility.d ,
207 this is treated as an error and processing will stop.
208 If the unrecognized feature is under
209 .Pa /usr/share/zfs/compatibility.d ,
210 this is treated as a warning and processing will continue.
211 This difference is to allow distributions to include features
212 which might not be recognized by the currently-installed binaries.
214 Compatibility files may include comments:
215 any text from
216 .Sq #
217 to the end of the line is ignored.
219 .Sy Example :
220 .Bd -literal -compact -offset 4n
221 .No example# Nm cat Pa /usr/share/zfs/compatibility.d/grub2
222 # Features which are supported by GRUB2 versions from v2.12 onwards.
223 allocation_classes
224 async_destroy
225 block_cloning
226 bookmarks
227 device_rebuild
228 embedded_data
229 empty_bpobj
230 enabled_txg
231 extensible_dataset
232 filesystem_limits
233 hole_birth
234 large_blocks
235 livelist
236 log_spacemap
237 lz4_compress
238 project_quota
239 resilver_defer
240 spacemap_histogram
241 spacemap_v2
242 userobj_accounting
243 zilsaxattr
244 zpool_checkpoint
246 .No example# Nm cat Pa /usr/share/zfs/compatibility.d/grub2-2.06
247 # Features which are supported by GRUB2 versions prior to v2.12.
249 # GRUB is not able to detect ZFS pool if snaphsot of top level boot pool
250 # is created. This issue is observed with GRUB versions before v2.12 if
251 # extensible_dataset feature is enabled on ZFS boot pool.
253 # This file lists all read-only comaptible features except
254 # extensible_dataset and any other feature that depends on it.
256 allocation_classes
257 async_destroy
258 block_cloning
259 device_rebuild
260 embedded_data
261 empty_bpobj
262 enabled_txg
263 hole_birth
264 log_spacemap
265 lz4_compress
266 resilver_defer
267 spacemap_histogram
268 spacemap_v2
269 zpool_checkpoint
271 .No example# Nm zpool Cm create Fl o Sy compatibility Ns = Ns Ar grub2 Ar bootpool Ar vdev
275 .Xr zpool-create 8
277 .Xr zpool-upgrade 8
278 for more information on how these commands are affected by feature sets.
280 .de feature
281 .It Sy \\$2
282 .Bl -tag -compact -width "READ-ONLY COMPATIBLE"
283 .It GUID
284 .Sy \\$1:\\$2
285 .if !"\\$4"" \{\
286 .It DEPENDENCIES
287 \fB\\$4\fP\c
288 .if !"\\$5"" , \fB\\$5\fP\c
289 .if !"\\$6"" , \fB\\$6\fP\c
290 .if !"\\$7"" , \fB\\$7\fP\c
291 .if !"\\$8"" , \fB\\$8\fP\c
292 .if !"\\$9"" , \fB\\$9\fP\c
294 .It READ-ONLY COMPATIBLE
295 \\$3
300 .ds instant-never \
301 .No This feature becomes Sy active No as soon as it is enabled \
302 and will never return to being Sy enabled .
304 .ds remount-upgrade \
305 .No Each filesystem will be upgraded automatically when remounted, \
306 or when a new file is created under that filesystem. \
307 The upgrade can also be triggered on filesystems via \
308 Nm zfs Cm set Sy version Ns = Ns Sy current Ar fs . \
309 No The upgrade process runs in the background and may take a while to complete \
310 for filesystems containing large amounts of files .
312 .de checksum-spiel
313 When the
314 .Sy \\$1
315 feature is set to
316 .Sy enabled ,
317 the administrator can turn on the
318 .Sy \\$1
319 checksum on any dataset using
320 .Nm zfs Cm set Sy checksum Ns = Ns Sy \\$1 Ar dset
321 .Po see Xr zfs-set 8 Pc .
322 This feature becomes
323 .Sy active
324 once a
325 .Sy checksum
326 property has been set to
327 .Sy \\$1 ,
328 and will return to being
329 .Sy enabled
330 once all filesystems that have ever had their checksum set to
331 .Sy \\$1
332 are destroyed.
335 .Sh FEATURES
336 The following features are supported on this system:
337 .Bl -tag -width Ds
338 .feature org.zfsonlinux allocation_classes yes
339 This feature enables support for separate allocation classes.
341 This feature becomes
342 .Sy active
343 when a dedicated allocation class vdev
344 .Pq dedup or special
345 is created with the
346 .Nm zpool Cm create No or Nm zpool Cm add No commands .
347 With device removal, it can be returned to the
348 .Sy enabled
349 state if all the dedicated allocation class vdevs are removed.
351 .feature com.delphix async_destroy yes
352 Destroying a file system requires traversing all of its data in order to
353 return its used space to the pool.
354 Without
355 .Sy async_destroy ,
356 the file system is not fully removed until all space has been reclaimed.
357 If the destroy operation is interrupted by a reboot or power outage,
358 the next attempt to open the pool will need to complete the destroy
359 operation synchronously.
361 When
362 .Sy async_destroy
363 is enabled, the file system's data will be reclaimed by a background process,
364 allowing the destroy operation to complete
365 without traversing the entire file system.
366 The background process is able to resume
367 interrupted destroys after the pool has been opened, eliminating the need
368 to finish interrupted destroys as part of the open operation.
369 The amount of space remaining to be reclaimed by the background process
370 is available through the
371 .Sy freeing
372 property.
374 This feature is only
375 .Sy active
376 while
377 .Sy freeing
378 is non-zero.
380 .feature org.openzfs blake3 no extensible_dataset
381 This feature enables the use of the BLAKE3 hash algorithm for checksum and
382 dedup.
383 BLAKE3 is a secure hash algorithm focused on high performance.
385 .checksum-spiel blake3
387 .feature com.fudosecurity block_cloning yes
388 When this feature is enabled ZFS will use block cloning for operations like
389 .Fn copy_file_range 2 .
390 Block cloning allows to create multiple references to a single block.
391 It is much faster than copying the data (as the actual data is neither read nor
392 written) and takes no additional space.
393 Blocks can be cloned across datasets under some conditions (like equal
394 .Nm recordsize ,
395 the same master encryption key, etc.).
396 ZFS tries its best to clone across datasets including encrypted ones.
397 This is limited for various (nontrivial) reasons depending on the OS
398 and/or ZFS internals.
400 This feature becomes
401 .Sy active
402 when first block is cloned.
403 When the last cloned block is freed, it goes back to the enabled state.
404 .feature com.delphix bookmarks yes extensible_dataset
405 This feature enables use of the
406 .Nm zfs Cm bookmark
407 command.
409 This feature is
410 .Sy active
411 while any bookmarks exist in the pool.
412 All bookmarks in the pool can be listed by running
413 .Nm zfs Cm list Fl t Sy bookmark Fl r Ar poolname .
415 .feature com.datto bookmark_v2 no bookmark extensible_dataset
416 This feature enables the creation and management of larger bookmarks which are
417 needed for other features in ZFS.
419 This feature becomes
420 .Sy active
421 when a v2 bookmark is created and will be returned to the
422 .Sy enabled
423 state when all v2 bookmarks are destroyed.
425 .feature com.delphix bookmark_written no bookmark extensible_dataset bookmark_v2
426 This feature enables additional bookmark accounting fields, enabling the
427 .Sy written Ns # Ns Ar bookmark
428 property
429 .Pq space written since a bookmark
430 and estimates of send stream sizes for incrementals from bookmarks.
432 This feature becomes
433 .Sy active
434 when a bookmark is created and will be
435 returned to the
436 .Sy enabled
437 state when all bookmarks with these fields are destroyed.
439 .feature org.openzfs device_rebuild yes
440 This feature enables the ability for the
441 .Nm zpool Cm attach
443 .Nm zpool Cm replace
444 commands to perform sequential reconstruction
445 .Pq instead of healing reconstruction
446 when resilvering.
448 Sequential reconstruction resilvers a device in LBA order without immediately
449 verifying the checksums.
450 Once complete, a scrub is started, which then verifies the checksums.
451 This approach allows full redundancy to be restored to the pool
452 in the minimum amount of time.
453 This two-phase approach will take longer than a healing resilver
454 when the time to verify the checksums is included.
455 However, unless there is additional pool damage,
456 no checksum errors should be reported by the scrub.
457 This feature is incompatible with raidz configurations.
459 This feature becomes
460 .Sy active
461 while a sequential resilver is in progress, and returns to
462 .Sy enabled
463 when the resilver completes.
465 .feature com.delphix device_removal no
466 This feature enables the
467 .Nm zpool Cm remove
468 command to remove top-level vdevs,
469 evacuating them to reduce the total size of the pool.
471 This feature becomes
472 .Sy active
473 when the
474 .Nm zpool Cm remove
475 command is used
476 on a top-level vdev, and will never return to being
477 .Sy enabled .
479 .feature org.openzfs draid no
480 This feature enables use of the
481 .Sy draid
482 vdev type.
483 dRAID is a variant of RAID-Z which provides integrated distributed
484 hot spares that allow faster resilvering while retaining the benefits of RAID-Z.
485 Data, parity, and spare space are organized in redundancy groups
486 and distributed evenly over all of the devices.
488 This feature becomes
489 .Sy active
490 when creating a pool which uses the
491 .Sy draid
492 vdev type, or when adding a new
493 .Sy draid
494 vdev to an existing pool.
496 .feature org.illumos edonr no extensible_dataset
497 This feature enables the use of the Edon-R hash algorithm for checksum,
498 including for nopwrite
499 .Po if compression is also enabled, an overwrite of
500 a block whose checksum matches the data being written will be ignored
501 .Pc .
502 In an abundance of caution, Edon-R requires verification when used with
503 dedup:
504 .Nm zfs Cm set Sy dedup Ns = Ns Sy edonr , Ns Sy verify
505 .Po see Xr zfs-set 8 Pc .
507 Edon-R is a very high-performance hash algorithm that was part
508 of the NIST SHA-3 competition.
509 It provides extremely high hash performance
510 .Pq over 350% faster than SHA-256 ,
511 but was not selected because of its unsuitability
512 as a general purpose secure hash algorithm.
513 This implementation utilizes the new salted checksumming functionality
514 in ZFS, which means that the checksum is pre-seeded with a secret
515 256-bit random key
516 .Pq stored on the pool
517 before being fed the data block to be checksummed.
518 Thus the produced checksums are unique to a given pool,
519 preventing hash collision attacks on systems with dedup.
521 .checksum-spiel edonr
523 .feature com.delphix embedded_data no
524 This feature improves the performance and compression ratio of
525 highly-compressible blocks.
526 Blocks whose contents can compress to 112 bytes
527 or smaller can take advantage of this feature.
529 When this feature is enabled, the contents of highly-compressible blocks are
530 stored in the block
531 .Dq pointer
532 itself
533 .Po a misnomer in this case, as it contains
534 the compressed data, rather than a pointer to its location on disk
535 .Pc .
536 Thus the space of the block
537 .Pq one sector, typically 512 B or 4 KiB
538 is saved, and no additional I/O is needed to read and write the data block.
540 \*[instant-never]
542 .feature com.delphix empty_bpobj yes
543 This feature increases the performance of creating and using a large
544 number of snapshots of a single filesystem or volume, and also reduces
545 the disk space required.
547 When there are many snapshots, each snapshot uses many Block Pointer
548 Objects
549 .Pq bpobjs
550 to track blocks associated with that snapshot.
551 However, in common use cases, most of these bpobjs are empty.
552 This feature allows us to create each bpobj on-demand,
553 thus eliminating the empty bpobjs.
555 This feature is
556 .Sy active
557 while there are any filesystems, volumes,
558 or snapshots which were created after enabling this feature.
560 .feature com.delphix enabled_txg yes
561 Once this feature is enabled, ZFS records the transaction group number
562 in which new features are enabled.
563 This has no user-visible impact, but other features may depend on this feature.
565 This feature becomes
566 .Sy active
567 as soon as it is enabled and will never return to being
568 .Sy enabled .
570 .feature com.datto encryption no bookmark_v2 extensible_dataset
571 This feature enables the creation and management of natively encrypted datasets.
573 This feature becomes
574 .Sy active
575 when an encrypted dataset is created and will be returned to the
576 .Sy enabled
577 state when all datasets that use this feature are destroyed.
579 .feature com.klarasystems fast_dedup yes
580 This feature allows more advanced deduplication features to be enabled on new
581 dedup tables.
583 This feature will be
584 .Sy active
585 when the first deduplicated block is written after a new dedup table is created
586 (ie after a new pool creation, or new checksum used on a dataset with
587 .Sy dedup
588 enabled).
589 It will be returned to the
590 .Sy enabled
591 state when all deduplicated blocks using it are freed.
593 .feature com.delphix extensible_dataset no
594 This feature allows more flexible use of internal ZFS data structures,
595 and exists for other features to depend on.
597 This feature will be
598 .Sy active
599 when the first dependent feature uses it, and will be returned to the
600 .Sy enabled
601 state when all datasets that use this feature are destroyed.
603 .feature com.joyent filesystem_limits yes extensible_dataset
604 This feature enables filesystem and snapshot limits.
605 These limits can be used to control how many filesystems and/or snapshots
606 can be created at the point in the tree on which the limits are set.
608 This feature is
609 .Sy active
610 once either of the limit properties has been set on a dataset
611 and will never return to being
612 .Sy enabled .
614 .feature com.delphix head_errlog no
615 This feature enables the upgraded version of errlog, which required an on-disk
616 error log format change.
617 Now the error log of each head dataset is stored separately in the zap object
618 and keyed by the head id.
619 With this feature enabled, every dataset affected by an error block is listed
620 in the output of
621 .Nm zpool Cm status .
622 In case of encrypted filesystems with unloaded keys we are unable to check
623 their snapshots or clones for errors and these will not be reported.
624 An "access denied" error will be reported.
626 \*[instant-never]
628 .feature com.delphix hole_birth no enabled_txg
629 This feature has/had bugs, the result of which is that, if you do a
630 .Nm zfs Cm send Fl i
631 .Pq or Fl R , No since it uses Fl i
632 from an affected dataset, the receiving party will not see any checksum
633 or other errors, but the resulting destination snapshot
634 will not match the source.
635 Its use by
636 .Nm zfs Cm send Fl i
637 has been disabled by default
640 .Sy send_holes_without_birth_time
642 .Xr zfs 4
643 .Pc .
645 This feature improves performance of incremental sends
646 .Pq Nm zfs Cm send Fl i
647 and receives for objects with many holes.
648 The most common case of hole-filled objects is zvols.
650 An incremental send stream from snapshot
651 .Sy A No to snapshot Sy B
652 contains information about every block that changed between
653 .Sy A No and Sy B .
654 Blocks which did not change between those snapshots can be
655 identified and omitted from the stream using a piece of metadata called
657 .Dq block birth time ,
658 but birth times are not recorded for holes
659 .Pq blocks filled only with zeroes .
660 Since holes created after
661 .Sy A No cannot be distinguished from holes created before Sy A ,
662 information about every hole in the entire filesystem or zvol
663 is included in the send stream.
665 For workloads where holes are rare this is not a problem.
666 However, when incrementally replicating filesystems or zvols with many holes
667 .Pq for example a zvol formatted with another filesystem
668 a lot of time will be spent sending and receiving unnecessary information
669 about holes that already exist on the receiving side.
671 Once the
672 .Sy hole_birth
673 feature has been enabled the block birth times
674 of all new holes will be recorded.
675 Incremental sends between snapshots created after this feature is enabled
676 will use this new metadata to avoid sending information about holes that
677 already exist on the receiving side.
679 \*[instant-never]
681 .feature org.open-zfs large_blocks no extensible_dataset
682 This feature allows the record size on a dataset to be set larger than 128 KiB.
684 This feature becomes
685 .Sy active
686 once a dataset contains a file with a block size larger than 128 KiB,
687 and will return to being
688 .Sy enabled
689 once all filesystems that have ever had their recordsize larger than 128 KiB
690 are destroyed.
692 .feature org.zfsonlinux large_dnode no extensible_dataset
693 This feature allows the size of dnodes in a dataset to be set larger than 512 B.
695 This feature becomes
696 .Sy active
697 once a dataset contains an object with a dnode larger than 512 B,
698 which occurs as a result of setting the
699 .Sy dnodesize
700 dataset property to a value other than
701 .Sy legacy .
702 The feature will return to being
703 .Sy enabled
704 once all filesystems that have ever contained a dnode larger than 512 B
705 are destroyed.
706 Large dnodes allow more data to be stored in the bonus buffer,
707 thus potentially improving performance by avoiding the use of spill blocks.
709 .feature com.delphix livelist yes extensible_dataset
710 This feature allows clones to be deleted faster than the traditional method
711 when a large number of random/sparse writes have been made to the clone.
712 All blocks allocated and freed after a clone is created are tracked by the
713 the clone's livelist which is referenced during the deletion of the clone.
714 The feature is activated when a clone is created and remains
715 .Sy active
716 until all clones have been destroyed.
718 .feature com.delphix log_spacemap yes com.delphix:spacemap_v2
719 This feature improves performance for heavily-fragmented pools,
720 especially when workloads are heavy in random-writes.
721 It does so by logging all the metaslab changes on a single spacemap every TXG
722 instead of scattering multiple writes to all the metaslab spacemaps.
724 \*[instant-never]
726 .feature org.illumos lz4_compress no
727 .Sy lz4
728 is a high-performance real-time compression algorithm that
729 features significantly faster compression and decompression as well as a
730 higher compression ratio than the older
731 .Sy lzjb
732 compression.
733 Typically,
734 .Sy lz4
735 compression is approximately 50% faster on compressible data and 200% faster
736 on incompressible data than
737 .Sy lzjb .
738 It is also approximately 80% faster on decompression,
739 while giving approximately a 10% better compression ratio.
741 When the
742 .Sy lz4_compress
743 feature is set to
744 .Sy enabled ,
745 the administrator can turn on
746 .Sy lz4
747 compression on any dataset on the pool using the
748 .Xr zfs-set 8
749 command.
750 All newly written metadata will be compressed with the
751 .Sy lz4
752 algorithm.
754 \*[instant-never]
756 .feature com.joyent multi_vdev_crash_dump no
757 This feature allows a dump device to be configured with a pool comprised
758 of multiple vdevs.
759 Those vdevs may be arranged in any mirrored or raidz configuration.
761 When the
762 .Sy multi_vdev_crash_dump
763 feature is set to
764 .Sy enabled ,
765 the administrator can use
766 .Xr dumpadm 8
767 to configure a dump device on a pool comprised of multiple vdevs.
769 Under
771 and Linux this feature is unused, but registered for compatibility.
772 New pools created on these systems will have the feature
773 .Sy enabled
774 but will never transition to
775 .Sy active ,
776 as this functionality is not required for crash dump support.
777 Existing pools where this feature is
778 .Sy active
779 can be imported.
781 .feature com.delphix obsolete_counts yes device_removal
782 This feature is an enhancement of
783 .Sy device_removal ,
784 which will over time reduce the memory used to track removed devices.
785 When indirect blocks are freed or remapped,
786 we note that their part of the indirect mapping is
787 .Dq obsolete
788 – no longer needed.
790 This feature becomes
791 .Sy active
792 when the
793 .Nm zpool Cm remove
794 command is used on a top-level vdev, and will never return to being
795 .Sy enabled .
797 .feature org.zfsonlinux project_quota yes extensible_dataset
798 This feature allows administrators to account the spaces and objects usage
799 information against the project identifier
800 .Pq ID .
802 The project ID is an object-based attribute.
803 When upgrading an existing filesystem,
804 objects without a project ID will be assigned a zero project ID.
805 When this feature is enabled, newly created objects inherit
806 their parent directories' project ID if the parent's inherit flag is set
807 .Pq via Nm chattr Sy [+-]P No or Nm zfs Cm project Fl s Ns | Ns Fl C .
808 Otherwise, the new object's project ID will be zero.
809 An object's project ID can be changed at any time by the owner
810 .Pq or privileged user
812 .Nm chattr Fl p Ar prjid
814 .Nm zfs Cm project Fl p Ar prjid .
816 This feature will become
817 .Sy active
818 as soon as it is enabled and will never return to being
819 .Sy disabled .
820 \*[remount-upgrade]
822 .feature org.openzfs raidz_expansion no none
823 This feature enables the
824 .Nm zpool Cm attach
825 subcommand to attach a new device to a RAID-Z group, expanding the total
826 amount usable space in the pool.
828 .Xr zpool-attach 8 .
830 .feature com.delphix redaction_bookmarks no bookmarks extensible_dataset
831 This feature enables the use of redacted
832 .Nm zfs Cm send Ns s ,
833 which create redaction bookmarks storing the list of blocks
834 redacted by the send that created them.
835 For more information about redacted sends, see
836 .Xr zfs-send 8 .
838 .feature com.delphix redacted_datasets no extensible_dataset
839 This feature enables the receiving of redacted
840 .Nm zfs Cm send
841 streams, which create redacted datasets when received.
842 These datasets are missing some of their blocks,
843 and so cannot be safely mounted, and their contents cannot be safely read.
844 For more information about redacted receives, see
845 .Xr zfs-send 8 .
847 .feature com.delphix redaction_list_spill no redaction_bookmarks
848 This feature enables the redaction list created by zfs redact to store
849 many more entries.
850 It becomes
851 .Sy active
852 when a redaction list is created with more than 36 entries,
853 and returns to being
854 .Sy enabled
855 when no long redaction lists remain in the pool.
856 For more information about redacted sends, see
857 .Xr zfs-send 8 .
859 .feature com.datto resilver_defer yes
860 This feature allows ZFS to postpone new resilvers if an existing one is already
861 in progress.
862 Without this feature, any new resilvers will cause the currently
863 running one to be immediately restarted from the beginning.
865 This feature becomes
866 .Sy active
867 once a resilver has been deferred, and returns to being
868 .Sy enabled
869 when the deferred resilver begins.
871 .feature org.illumos sha512 no extensible_dataset
872 This feature enables the use of the SHA-512/256 truncated hash algorithm
873 .Pq FIPS 180-4
874 for checksum and dedup.
875 The native 64-bit arithmetic of SHA-512 provides an approximate 50%
876 performance boost over SHA-256 on 64-bit hardware
877 and is thus a good minimum-change replacement candidate
878 for systems where hash performance is important,
879 but these systems cannot for whatever reason utilize the faster
880 .Sy skein No and Sy edonr
881 algorithms.
883 .checksum-spiel sha512
885 .feature org.illumos skein no extensible_dataset
886 This feature enables the use of the Skein hash algorithm for checksum and dedup.
887 Skein is a high-performance secure hash algorithm that was a
888 finalist in the NIST SHA-3 competition.
889 It provides a very high security margin and high performance on 64-bit hardware
890 .Pq 80% faster than SHA-256 .
891 This implementation also utilizes the new salted checksumming
892 functionality in ZFS, which means that the checksum is pre-seeded with a
893 secret 256-bit random key
894 .Pq stored on the pool
895 before being fed the data block to be checksummed.
896 Thus the produced checksums are unique to a given pool,
897 preventing hash collision attacks on systems with dedup.
899 .checksum-spiel skein
901 .feature com.delphix spacemap_histogram yes
902 This features allows ZFS to maintain more information about how free space
903 is organized within the pool.
904 If this feature is
905 .Sy enabled ,
906 it will be activated when a new space map object is created, or
907 an existing space map is upgraded to the new format,
908 and never returns back to being
909 .Sy enabled .
911 .feature com.delphix spacemap_v2 yes
912 This feature enables the use of the new space map encoding which
913 consists of two words
914 .Pq instead of one
915 whenever it is advantageous.
916 The new encoding allows space maps to represent large regions of
917 space more efficiently on-disk while also increasing their maximum
918 addressable offset.
920 This feature becomes
921 .Sy active
922 once it is
923 .Sy enabled ,
924 and never returns back to being
925 .Sy enabled .
927 .feature org.zfsonlinux userobj_accounting yes extensible_dataset
928 This feature allows administrators to account the object usage information
929 by user and group.
931 \*[instant-never]
932 \*[remount-upgrade]
934 .feature com.klarasystems vdev_zaps_v2 no
935 This feature creates a ZAP object for the root vdev.
937 This feature becomes active after the next
938 .Nm zpool Cm import
940 .Nm zpool reguid .
942 Properties can be retrieved or set on the root vdev using
943 .Nm zpool Cm get
945 .Nm zpool Cm set
946 with
947 .Sy root
948 as the vdev name which is an alias for
949 .Sy root-0 .
950 .feature org.openzfs zilsaxattr yes extensible_dataset
951 This feature enables
952 .Sy xattr Ns = Ns Sy sa
953 extended attribute logging in the ZIL.
954 If enabled, extended attribute changes
955 .Pq both Sy xattrdir Ns = Ns Sy dir No and Sy xattr Ns = Ns Sy sa
956 are guaranteed to be durable if either the dataset had
957 .Sy sync Ns = Ns Sy always
958 set at the time the changes were made, or
959 .Xr sync 2
960 is called on the dataset after the changes were made.
962 This feature becomes
963 .Sy active
964 when a ZIL is created for at least one dataset and will be returned to the
965 .Sy enabled
966 state when it is destroyed for all datasets that use this feature.
968 .feature com.delphix zpool_checkpoint yes
969 This feature enables the
970 .Nm zpool Cm checkpoint
971 command that can checkpoint the state of the pool
972 at the time it was issued and later rewind back to it or discard it.
974 This feature becomes
975 .Sy active
976 when the
977 .Nm zpool Cm checkpoint
978 command is used to checkpoint the pool.
979 The feature will only return back to being
980 .Sy enabled
981 when the pool is rewound or the checkpoint has been discarded.
983 .feature org.freebsd zstd_compress no extensible_dataset
984 .Sy zstd
985 is a high-performance compression algorithm that features a
986 combination of high compression ratios and high speed.
987 Compared to
988 .Sy gzip ,
989 .Sy zstd
990 offers slightly better compression at much higher speeds.
991 Compared to
992 .Sy lz4 ,
993 .Sy zstd
994 offers much better compression while being only modestly slower.
995 Typically,
996 .Sy zstd
997 compression speed ranges from 250 to 500 MB/s per thread
998 and decompression speed is over 1 GB/s per thread.
1000 When the
1001 .Sy zstd
1002 feature is set to
1003 .Sy enabled ,
1004 the administrator can turn on
1005 .Sy zstd
1006 compression of any dataset using
1007 .Nm zfs Cm set Sy compress Ns = Ns Sy zstd Ar dset
1008 .Po see Xr zfs-set 8 Pc .
1009 This feature becomes
1010 .Sy active
1011 once a
1012 .Sy compress
1013 property has been set to
1014 .Sy zstd ,
1015 and will return to being
1016 .Sy enabled
1017 once all filesystems that have ever had their
1018 .Sy compress
1019 property set to
1020 .Sy zstd
1021 are destroyed.
1024 .Sh SEE ALSO
1025 .Xr zfs 8 ,
1026 .Xr zpool 8