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