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