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