xref: /freebsd/sys/contrib/openzfs/man/man7/zpool-features.7 (revision 1db64f89363c97858961c4df0b7d02f3223723cf)
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 disabled
368encryption and equal
369.Nm recordsize ) .
370.Pp
371This feature becomes
372.Sy active
373when first block is cloned.
374When the last cloned block is freed, it goes back to the enabled state.
375.feature com.delphix bookmarks yes extensible_dataset
376This feature enables use of the
377.Nm zfs Cm bookmark
378command.
379.Pp
380This feature is
381.Sy active
382while any bookmarks exist in the pool.
383All bookmarks in the pool can be listed by running
384.Nm zfs Cm list Fl t Sy bookmark Fl r Ar poolname .
385.
386.feature com.datto bookmark_v2 no bookmark extensible_dataset
387This feature enables the creation and management of larger bookmarks which are
388needed for other features in ZFS.
389.Pp
390This feature becomes
391.Sy active
392when a v2 bookmark is created and will be returned to the
393.Sy enabled
394state when all v2 bookmarks are destroyed.
395.
396.feature com.delphix bookmark_written no bookmark extensible_dataset bookmark_v2
397This feature enables additional bookmark accounting fields, enabling the
398.Sy written Ns # Ns Ar bookmark
399property
400.Pq space written since a bookmark
401and estimates of send stream sizes for incrementals from bookmarks.
402.Pp
403This feature becomes
404.Sy active
405when a bookmark is created and will be
406returned to the
407.Sy enabled
408state when all bookmarks with these fields are destroyed.
409.
410.feature org.openzfs device_rebuild yes
411This feature enables the ability for the
412.Nm zpool Cm attach
413and
414.Nm zpool Cm replace
415commands to perform sequential reconstruction
416.Pq instead of healing reconstruction
417when resilvering.
418.Pp
419Sequential reconstruction resilvers a device in LBA order without immediately
420verifying the checksums.
421Once complete, a scrub is started, which then verifies the checksums.
422This approach allows full redundancy to be restored to the pool
423in the minimum amount of time.
424This two-phase approach will take longer than a healing resilver
425when the time to verify the checksums is included.
426However, unless there is additional pool damage,
427no checksum errors should be reported by the scrub.
428This feature is incompatible with raidz configurations.
429.
430This feature becomes
431.Sy active
432while a sequential resilver is in progress, and returns to
433.Sy enabled
434when the resilver completes.
435.
436.feature com.delphix device_removal no
437This feature enables the
438.Nm zpool Cm remove
439command to remove top-level vdevs,
440evacuating them to reduce the total size of the pool.
441.Pp
442This feature becomes
443.Sy active
444when the
445.Nm zpool Cm remove
446command is used
447on a top-level vdev, and will never return to being
448.Sy enabled .
449.
450.feature org.openzfs draid no
451This feature enables use of the
452.Sy draid
453vdev type.
454dRAID is a variant of RAID-Z which provides integrated distributed
455hot spares that allow faster resilvering while retaining the benefits of RAID-Z.
456Data, parity, and spare space are organized in redundancy groups
457and distributed evenly over all of the devices.
458.Pp
459This feature becomes
460.Sy active
461when creating a pool which uses the
462.Sy draid
463vdev type, or when adding a new
464.Sy draid
465vdev to an existing pool.
466.
467.feature org.illumos edonr no extensible_dataset
468This feature enables the use of the Edon-R hash algorithm for checksum,
469including for nopwrite
470.Po if compression is also enabled, an overwrite of
471a block whose checksum matches the data being written will be ignored
472.Pc .
473In an abundance of caution, Edon-R requires verification when used with
474dedup:
475.Nm zfs Cm set Sy dedup Ns = Ns Sy edonr , Ns Sy verify
476.Po see Xr zfs-set 8 Pc .
477.Pp
478Edon-R is a very high-performance hash algorithm that was part
479of the NIST SHA-3 competition.
480It provides extremely high hash performance
481.Pq over 350% faster than SHA-256 ,
482but was not selected because of its unsuitability
483as a general purpose secure hash algorithm.
484This implementation utilizes the new salted checksumming functionality
485in ZFS, which means that the checksum is pre-seeded with a secret
486256-bit random key
487.Pq stored on the pool
488before being fed the data block to be checksummed.
489Thus the produced checksums are unique to a given pool,
490preventing hash collision attacks on systems with dedup.
491.Pp
492.checksum-spiel edonr
493.
494.feature com.delphix embedded_data no
495This feature improves the performance and compression ratio of
496highly-compressible blocks.
497Blocks whose contents can compress to 112 bytes
498or smaller can take advantage of this feature.
499.Pp
500When this feature is enabled, the contents of highly-compressible blocks are
501stored in the block
502.Dq pointer
503itself
504.Po a misnomer in this case, as it contains
505the compressed data, rather than a pointer to its location on disk
506.Pc .
507Thus the space of the block
508.Pq one sector, typically 512 B or 4 KiB
509is saved, and no additional I/O is needed to read and write the data block.
510.
511\*[instant-never]
512.
513.feature com.delphix empty_bpobj yes
514This feature increases the performance of creating and using a large
515number of snapshots of a single filesystem or volume, and also reduces
516the disk space required.
517.Pp
518When there are many snapshots, each snapshot uses many Block Pointer
519Objects
520.Pq bpobjs
521to track blocks associated with that snapshot.
522However, in common use cases, most of these bpobjs are empty.
523This feature allows us to create each bpobj on-demand,
524thus eliminating the empty bpobjs.
525.Pp
526This feature is
527.Sy active
528while there are any filesystems, volumes,
529or snapshots which were created after enabling this feature.
530.
531.feature com.delphix enabled_txg yes
532Once this feature is enabled, ZFS records the transaction group number
533in which new features are enabled.
534This has no user-visible impact, but other features may depend on this feature.
535.Pp
536This feature becomes
537.Sy active
538as soon as it is enabled and will never return to being
539.Sy enabled .
540.
541.feature com.datto encryption no bookmark_v2 extensible_dataset
542This feature enables the creation and management of natively encrypted datasets.
543.Pp
544This feature becomes
545.Sy active
546when an encrypted dataset is created and will be returned to the
547.Sy enabled
548state when all datasets that use this feature are destroyed.
549.
550.feature com.delphix extensible_dataset no
551This feature allows more flexible use of internal ZFS data structures,
552and exists for other features to depend on.
553.Pp
554This feature will be
555.Sy active
556when the first dependent feature uses it, and will be returned to the
557.Sy enabled
558state when all datasets that use this feature are destroyed.
559.
560.feature com.joyent filesystem_limits yes extensible_dataset
561This feature enables filesystem and snapshot limits.
562These limits can be used to control how many filesystems and/or snapshots
563can be created at the point in the tree on which the limits are set.
564.Pp
565This feature is
566.Sy active
567once either of the limit properties has been set on a dataset
568and will never return to being
569.Sy enabled .
570.
571.feature com.delphix head_errlog no
572This feature enables the upgraded version of errlog, which required an on-disk
573error log format change.
574Now the error log of each head dataset is stored separately in the zap object
575and keyed by the head id.
576With this feature enabled, every dataset affected by an error block is listed
577in the output of
578.Nm zpool Cm status .
579In case of encrypted filesystems with unloaded keys we are unable to check
580their snapshots or clones for errors and these will not be reported.
581An "access denied" error will be reported.
582.Pp
583\*[instant-never]
584.
585.feature com.delphix hole_birth no enabled_txg
586This feature has/had bugs, the result of which is that, if you do a
587.Nm zfs Cm send Fl i
588.Pq or Fl R , No since it uses Fl i
589from an affected dataset, the receiving party will not see any checksum
590or other errors, but the resulting destination snapshot
591will not match the source.
592Its use by
593.Nm zfs Cm send Fl i
594has been disabled by default
595.Po
596see
597.Sy send_holes_without_birth_time
598in
599.Xr zfs 4
600.Pc .
601.Pp
602This feature improves performance of incremental sends
603.Pq Nm zfs Cm send Fl i
604and receives for objects with many holes.
605The most common case of hole-filled objects is zvols.
606.Pp
607An incremental send stream from snapshot
608.Sy A No to snapshot Sy B
609contains information about every block that changed between
610.Sy A No and Sy B .
611Blocks which did not change between those snapshots can be
612identified and omitted from the stream using a piece of metadata called
613the
614.Dq block birth time ,
615but birth times are not recorded for holes
616.Pq blocks filled only with zeroes .
617Since holes created after
618.Sy A No cannot be distinguished from holes created before Sy A ,
619information about every hole in the entire filesystem or zvol
620is included in the send stream.
621.Pp
622For workloads where holes are rare this is not a problem.
623However, when incrementally replicating filesystems or zvols with many holes
624.Pq for example a zvol formatted with another filesystem
625a lot of time will be spent sending and receiving unnecessary information
626about holes that already exist on the receiving side.
627.Pp
628Once the
629.Sy hole_birth
630feature has been enabled the block birth times
631of all new holes will be recorded.
632Incremental sends between snapshots created after this feature is enabled
633will use this new metadata to avoid sending information about holes that
634already exist on the receiving side.
635.Pp
636\*[instant-never]
637.
638.feature org.open-zfs large_blocks no extensible_dataset
639This feature allows the record size on a dataset to be set larger than 128 KiB.
640.Pp
641This feature becomes
642.Sy active
643once a dataset contains a file with a block size larger than 128 KiB,
644and will return to being
645.Sy enabled
646once all filesystems that have ever had their recordsize larger than 128 KiB
647are destroyed.
648.
649.feature org.zfsonlinux large_dnode no extensible_dataset
650This feature allows the size of dnodes in a dataset to be set larger than 512 B.
651.
652This feature becomes
653.Sy active
654once a dataset contains an object with a dnode larger than 512 B,
655which occurs as a result of setting the
656.Sy dnodesize
657dataset property to a value other than
658.Sy legacy .
659The feature will return to being
660.Sy enabled
661once all filesystems that have ever contained a dnode larger than 512 B
662are destroyed.
663Large dnodes allow more data to be stored in the bonus buffer,
664thus potentially improving performance by avoiding the use of spill blocks.
665.
666.feature com.delphix livelist yes
667This feature allows clones to be deleted faster than the traditional method
668when a large number of random/sparse writes have been made to the clone.
669All blocks allocated and freed after a clone is created are tracked by the
670the clone's livelist which is referenced during the deletion of the clone.
671The feature is activated when a clone is created and remains
672.Sy active
673until all clones have been destroyed.
674.
675.feature com.delphix log_spacemap yes com.delphix:spacemap_v2
676This feature improves performance for heavily-fragmented pools,
677especially when workloads are heavy in random-writes.
678It does so by logging all the metaslab changes on a single spacemap every TXG
679instead of scattering multiple writes to all the metaslab spacemaps.
680.Pp
681\*[instant-never]
682.
683.feature org.illumos lz4_compress no
684.Sy lz4
685is a high-performance real-time compression algorithm that
686features significantly faster compression and decompression as well as a
687higher compression ratio than the older
688.Sy lzjb
689compression.
690Typically,
691.Sy lz4
692compression is approximately 50% faster on compressible data and 200% faster
693on incompressible data than
694.Sy lzjb .
695It is also approximately 80% faster on decompression,
696while giving approximately a 10% better compression ratio.
697.Pp
698When the
699.Sy lz4_compress
700feature is set to
701.Sy enabled ,
702the administrator can turn on
703.Sy lz4
704compression on any dataset on the pool using the
705.Xr zfs-set 8
706command.
707All newly written metadata will be compressed with the
708.Sy lz4
709algorithm.
710.Pp
711\*[instant-never]
712.
713.feature com.joyent multi_vdev_crash_dump no
714This feature allows a dump device to be configured with a pool comprised
715of multiple vdevs.
716Those vdevs may be arranged in any mirrored or raidz configuration.
717.Pp
718When the
719.Sy multi_vdev_crash_dump
720feature is set to
721.Sy enabled ,
722the administrator can use
723.Xr dumpadm 8
724to configure a dump device on a pool comprised of multiple vdevs.
725.Pp
726Under
727.Fx
728and Linux this feature is unused, but registered for compatibility.
729New pools created on these systems will have the feature
730.Sy enabled
731but will never transition to
732.Sy active ,
733as this functionality is not required for crash dump support.
734Existing pools where this feature is
735.Sy active
736can be imported.
737.
738.feature com.delphix obsolete_counts yes device_removal
739This feature is an enhancement of
740.Sy device_removal ,
741which will over time reduce the memory used to track removed devices.
742When indirect blocks are freed or remapped,
743we note that their part of the indirect mapping is
744.Dq obsolete
745– no longer needed.
746.Pp
747This feature becomes
748.Sy active
749when the
750.Nm zpool Cm remove
751command is used on a top-level vdev, and will never return to being
752.Sy enabled .
753.
754.feature org.zfsonlinux project_quota yes extensible_dataset
755This feature allows administrators to account the spaces and objects usage
756information against the project identifier
757.Pq ID .
758.Pp
759The project ID is an object-based attribute.
760When upgrading an existing filesystem,
761objects without a project ID will be assigned a zero project ID.
762When this feature is enabled, newly created objects inherit
763their parent directories' project ID if the parent's inherit flag is set
764.Pq via Nm chattr Sy [+-]P No or Nm zfs Cm project Fl s Ns | Ns Fl C .
765Otherwise, the new object's project ID will be zero.
766An object's project ID can be changed at any time by the owner
767.Pq or privileged user
768via
769.Nm chattr Fl p Ar prjid
770or
771.Nm zfs Cm project Fl p Ar prjid .
772.Pp
773This feature will become
774.Sy active
775as soon as it is enabled and will never return to being
776.Sy disabled .
777\*[remount-upgrade]
778.
779.feature org.openzfs raidz_expansion no none
780This feature enables the
781.Nm zpool Cm attach
782subcommand to attach a new device to a RAID-Z group, expanding the total
783amount usable space in the pool.
784See
785.Xr zpool-attach 8 .
786.
787.feature com.delphix redaction_bookmarks no bookmarks extensible_dataset
788This feature enables the use of redacted
789.Nm zfs Cm send Ns s ,
790which create redaction bookmarks storing the list of blocks
791redacted by the send that created them.
792For more information about redacted sends, see
793.Xr zfs-send 8 .
794.
795.feature com.delphix redacted_datasets no extensible_dataset
796This feature enables the receiving of redacted
797.Nm zfs Cm send
798streams, which create redacted datasets when received.
799These datasets are missing some of their blocks,
800and so cannot be safely mounted, and their contents cannot be safely read.
801For more information about redacted receives, see
802.Xr zfs-send 8 .
803.
804.feature com.delphix redaction_list_spill no redaction_bookmarks
805This feature enables the redaction list created by zfs redact to store
806many more entries.
807It becomes
808.Sy active
809when a redaction list is created with more than 36 entries,
810and returns to being
811.Sy enabled
812when no long redaction lists remain in the pool.
813For more information about redacted sends, see
814.Xr zfs-send 8 .
815.
816.feature com.datto resilver_defer yes
817This feature allows ZFS to postpone new resilvers if an existing one is already
818in progress.
819Without this feature, any new resilvers will cause the currently
820running one to be immediately restarted from the beginning.
821.Pp
822This feature becomes
823.Sy active
824once a resilver has been deferred, and returns to being
825.Sy enabled
826when the deferred resilver begins.
827.
828.feature org.illumos sha512 no extensible_dataset
829This feature enables the use of the SHA-512/256 truncated hash algorithm
830.Pq FIPS 180-4
831for checksum and dedup.
832The native 64-bit arithmetic of SHA-512 provides an approximate 50%
833performance boost over SHA-256 on 64-bit hardware
834and is thus a good minimum-change replacement candidate
835for systems where hash performance is important,
836but these systems cannot for whatever reason utilize the faster
837.Sy skein No and Sy edonr
838algorithms.
839.Pp
840.checksum-spiel sha512
841.
842.feature org.illumos skein no extensible_dataset
843This feature enables the use of the Skein hash algorithm for checksum and dedup.
844Skein is a high-performance secure hash algorithm that was a
845finalist in the NIST SHA-3 competition.
846It provides a very high security margin and high performance on 64-bit hardware
847.Pq 80% faster than SHA-256 .
848This implementation also utilizes the new salted checksumming
849functionality in ZFS, which means that the checksum is pre-seeded with a
850secret 256-bit random key
851.Pq stored on the pool
852before being fed the data block to be checksummed.
853Thus the produced checksums are unique to a given pool,
854preventing hash collision attacks on systems with dedup.
855.Pp
856.checksum-spiel skein
857.
858.feature com.delphix spacemap_histogram yes
859This features allows ZFS to maintain more information about how free space
860is organized within the pool.
861If this feature is
862.Sy enabled ,
863it will be activated when a new space map object is created, or
864an existing space map is upgraded to the new format,
865and never returns back to being
866.Sy enabled .
867.
868.feature com.delphix spacemap_v2 yes
869This feature enables the use of the new space map encoding which
870consists of two words
871.Pq instead of one
872whenever it is advantageous.
873The new encoding allows space maps to represent large regions of
874space more efficiently on-disk while also increasing their maximum
875addressable offset.
876.Pp
877This feature becomes
878.Sy active
879once it is
880.Sy enabled ,
881and never returns back to being
882.Sy enabled .
883.
884.feature org.zfsonlinux userobj_accounting yes extensible_dataset
885This feature allows administrators to account the object usage information
886by user and group.
887.Pp
888\*[instant-never]
889\*[remount-upgrade]
890.
891.feature com.klarasystems vdev_zaps_v2 no
892This feature creates a ZAP object for the root vdev.
893.Pp
894This feature becomes active after the next
895.Nm zpool Cm import
896or
897.Nm zpool reguid .
898.
899Properties can be retrieved or set on the root vdev using
900.Nm zpool Cm get
901and
902.Nm zpool Cm set
903with
904.Sy root
905as the vdev name which is an alias for
906.Sy root-0 .
907.feature org.openzfs zilsaxattr yes extensible_dataset
908This feature enables
909.Sy xattr Ns = Ns Sy sa
910extended attribute logging in the ZIL.
911If enabled, extended attribute changes
912.Pq both Sy xattrdir Ns = Ns Sy dir No and Sy xattr Ns = Ns Sy sa
913are guaranteed to be durable if either the dataset had
914.Sy sync Ns = Ns Sy always
915set at the time the changes were made, or
916.Xr sync 2
917is called on the dataset after the changes were made.
918.Pp
919This feature becomes
920.Sy active
921when a ZIL is created for at least one dataset and will be returned to the
922.Sy enabled
923state when it is destroyed for all datasets that use this feature.
924.
925.feature com.delphix zpool_checkpoint yes
926This feature enables the
927.Nm zpool Cm checkpoint
928command that can checkpoint the state of the pool
929at the time it was issued and later rewind back to it or discard it.
930.Pp
931This feature becomes
932.Sy active
933when the
934.Nm zpool Cm checkpoint
935command is used to checkpoint the pool.
936The feature will only return back to being
937.Sy enabled
938when the pool is rewound or the checkpoint has been discarded.
939.
940.feature org.freebsd zstd_compress no extensible_dataset
941.Sy zstd
942is a high-performance compression algorithm that features a
943combination of high compression ratios and high speed.
944Compared to
945.Sy gzip ,
946.Sy zstd
947offers slightly better compression at much higher speeds.
948Compared to
949.Sy lz4 ,
950.Sy zstd
951offers much better compression while being only modestly slower.
952Typically,
953.Sy zstd
954compression speed ranges from 250 to 500 MB/s per thread
955and decompression speed is over 1 GB/s per thread.
956.Pp
957When the
958.Sy zstd
959feature is set to
960.Sy enabled ,
961the administrator can turn on
962.Sy zstd
963compression of any dataset using
964.Nm zfs Cm set Sy compress Ns = Ns Sy zstd Ar dset
965.Po see Xr zfs-set 8 Pc .
966This feature becomes
967.Sy active
968once a
969.Sy compress
970property has been set to
971.Sy zstd ,
972and will return to being
973.Sy enabled
974once all filesystems that have ever had their
975.Sy compress
976property set to
977.Sy zstd
978are destroyed.
979.El
980.
981.Sh SEE ALSO
982.Xr zfs 8 ,
983.Xr zpool 8
984