The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/contrib/openzfs/man/man7/zpool-features.7

Version: -  FREEBSD  -  FREEBSD-13-STABLE  -  FREEBSD-13-0  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  l41  -  OPENBSD  -  linux-2.6  -  MK84  -  PLAN9  -  xnu-8792 
SearchContext: -  none  -  3  -  10 

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

Cache object: 472ca22c9be8db1a78502aa7b726654b


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.