2 .\" Copyright (c) 2012, Martin Matuska <mm@FreeBSD.org>.
3 .\" All Rights Reserved.
5 .\" The contents of this file are subject to the terms of the
6 .\" Common Development and Distribution License (the "License").
7 .\" You may not use this file except in compliance with the License.
9 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10 .\" or http://www.opensolaris.org/os/licensing.
11 .\" See the License for the specific language governing permissions
12 .\" and limitations under the License.
14 .\" When distributing Covered Code, include this CDDL HEADER in each
15 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16 .\" If applicable, add the following below this CDDL HEADER, with the
17 .\" fields enclosed by brackets "[]" replaced with your own identifying
18 .\" information: Portions Copyright [yyyy] [name of copyright owner]
20 .\" Copyright (c) 2012 by Delphix. All rights reserved.
21 .\" Copyright (c) 2013 by Saso Kiselkov. All rights reserved.
22 .\" Copyright (c) 2013, Joyent, Inc. All rights reserved.
31 .Nd ZFS pool feature descriptions
33 ZFS pool on\-disk format versions are specified via "features" which replace
34 the old on\-disk format numbers (the last supported on\-disk format number is
36 To enable a feature on a pool use the
41 .Sy feature@feature_name
45 The pool format does not affect file system version compatibility or the ability
46 to send file systems between pools.
48 Since most features can be enabled independently of each other the on\-disk
49 format of the pool is specified by the set of all features marked as
51 on the pool. If the pool was created by another software version this set may
52 include unsupported features.
53 .Ss Identifying features
54 Every feature has a guid of the form
55 .Sy com.example:feature_name .
56 The reverse DNS name ensures that the feature's guid is unique across all ZFS
57 implementations. When unsupported features are encountered on a pool they will
58 be identified by their guids.
59 Refer to the documentation for the ZFS implementation that created the pool
60 for information about those features.
62 Each supported feature also has a short name.
63 By convention a feature's short name is the portion of its guid which follows
65 .Sy com.example:feature_name
66 would have the short name
68 however a feature's short name may differ across ZFS implementations if
69 following the convention would result in name conflicts.
71 Features can be in one of three states:
72 .Bl -tag -width "XXXXXXXX"
74 This feature's on\-disk format changes are in effect on the pool.
75 Support for this feature is required to import the pool in read\-write mode.
76 If this feature is not read-only compatible, support is also required to
77 import the pool in read\-only mode (see "Read\-only compatibility").
79 An administrator has marked this feature as enabled on the pool, but the
80 feature's on\-disk format changes have not been made yet.
81 The pool can still be imported by software that does not support this feature,
82 but changes may be made to the on\-disk format at any time which will move
86 Some features may support returning to the
90 See feature\-specific documentation for details.
92 This feature's on\-disk format changes have not been made and will not be made
93 unless an administrator moves the feature to the
96 Features cannot be disabled once they have been enabled.
99 The state of supported features is exposed through pool properties of the form
100 .Sy feature@short_name .
101 .Ss Read\-only compatibility
102 Some features may make on\-disk format changes that do not interfere with other
103 software's ability to read from the pool.
104 These features are referred to as "read\-only compatible".
105 If all unsupported features on a pool are read\-only compatible, the pool can
106 be imported in read\-only mode by setting the
108 property during import (see
110 for details on importing pools).
111 .Ss Unsupported features
112 For each unsupported feature enabled on an imported pool a pool property
114 .Sy unsupported@feature_guid
115 will indicate why the import was allowed despite the unsupported feature.
116 Possible values for this property are:
117 .Bl -tag -width "XXXXXXXX"
119 The feature is in the
121 state and therefore the pool's on\-disk format is still compatible with
122 software that does not support this feature.
124 The feature is read\-only compatible and the pool has been imported in
127 .Ss Feature dependencies
128 Some features depend on other features being enabled in order to function
130 Enabling a feature will automatically enable any features it depends on.
132 The following features are supported on this system:
133 .Bl -tag -width "XXXXXXXX"
135 .Bl -column "READ\-ONLY COMPATIBLE" "com.delphix:async_destroy"
136 .It GUID Ta com.delphix:async_destroy
137 .It READ\-ONLY COMPATIBLE Ta yes
138 .It DEPENDENCIES Ta none
141 Destroying a file system requires traversing all of its data in order to
142 return its used space to the pool.
145 the file system is not fully removed until all space has been reclaimed.
146 If the destroy operation is interrupted by a reboot or power outage the next
147 attempt to open the pool will need to complete the destroy operation
152 is enabled the file system's data will be reclaimed by a background process,
153 allowing the destroy operation to complete without traversing the entire file
155 The background process is able to resume interrupted destroys after the pool
156 has been opened, eliminating the need to finish interrupted destroys as part
157 of the open operation.
158 The amount of space remaining to be reclaimed by the background process is
159 available through the
169 .Bl -column "READ\-ONLY COMPATIBLE" "com.delphix:empty_bpobj"
170 .It GUID Ta com.delphix:empty_bpobj
171 .It READ\-ONLY COMPATIBLE Ta yes
172 .It DEPENDENCIES Ta none
175 This feature increases the performance of creating and using a large number
176 of snapshots of a single filesystem or volume, and also reduces the disk
179 When there are many snapshots, each snapshot uses many Block Pointer Objects
181 to track blocks associated with that snapshot.
182 However, in common use cases, most of these bpobj's are empty.
183 This feature allows us to create each bpobj on-demand, thus eliminating the
188 while there are any filesystems, volumes, or snapshots which were created
189 after enabling this feature.
190 .It Sy filesystem_limits
191 .Bl -column "READ\-ONLY COMPATIBLE" "com.joyent:filesystem_limits"
192 .It GUID Ta com.joyent:filesystem_limits
193 .It READ\-ONLY COMPATIBLE Ta yes
194 .It DEPENDENCIES Ta extensible_dataset
197 This feature enables filesystem and snapshot limits.
198 These limits can be used
199 to control how many filesystems and/or snapshots can be created at the point in
200 the tree on which the limits are set.
204 once either of the limit properties has been
206 Once activated the feature is never deactivated.
208 .Bl -column "READ\-ONLY COMPATIBLE" "org.illumos:lz4_compress"
209 .It GUID Ta org.illumos:lz4_compress
210 .It READ\-ONLY COMPATIBLE Ta no
211 .It DEPENDENCIES Ta none
215 is a high-performance real-time compression algorithm that
216 features significantly faster compression and decompression as well as a
217 higher compression ratio than the older
222 compression is approximately 50% faster on
223 compressible data and 200% faster on incompressible data than
225 It is also approximately 80% faster on decompression, while
226 giving approximately 10% better compression ratio.
233 administrator can turn on
235 compression on any dataset on the
238 command. Please note that doing so will
239 immediately activate the
241 feature on the underlying
243 .Pq even before any data is written ,
244 and the feature will not be
246 Since this feature is not read-only compatible, this
247 operation will render the pool unimportable on systems without support
253 -compressed root pools is supported.
254 .It Sy multi_vdev_crash_dump
255 .Bl -column "READ\-ONLY COMPATIBLE" "com.joyent:multi_vdev_crash_dump"
256 .It GUID Ta com.joyent:multi_vdev_crash_dump
257 .It READ\-ONLY COMPATIBLE Ta no
258 .It DEPENDENCIES Ta none
261 This feature allows a dump device to be configured with a pool comprised
263 Those vdevs may be arranged in any mirrored or raidz
265 .\" TODO: this is not yet supported on FreeBSD.
268 .\" .Sy multi_vdev_crash_dump
269 .\" feature is set to
271 .\" the administrator can use the
273 .\" command to configure a
274 .\" dump device on a pool comprised of multiple vdevs.
275 .It Sy spacemap_histogram
276 .Bl -column "READ\-ONLY COMPATIBLE" "com.delphix:spacemap_histogram"
277 .It GUID Ta com.delphix:spacemap_histogram
278 .It READ\-ONLY COMPATIBLE Ta yes
279 .It DEPENDENCIES Ta none
282 This features allows ZFS to maintain more information about how free space
283 is organized within the pool. If this feature is
288 when a new space map object is created or
289 an existing space map is upgraded to the new format.
292 it will remain in that state until the pool is destroyed.
293 .It Sy extensible_dataset
294 .Bl -column "READ\-ONLY COMPATIBLE" "com.delphix:extensible_dataset"
295 .It GUID Ta com.delphix:extensible_dataset
296 .It READ\-ONLY COMPATIBLE Ta no
297 .It DEPENDENCIES Ta none
300 This feature allows more flexible use of internal ZFS data structures,
301 and exists for other features to depend on.
305 when the first dependent feature uses it,
306 and will be returned to the
308 state when all datasets that use
309 this feature are destroyed.
311 .Bl -column "READ\-ONLY COMPATIBLE" "com.delphix:bookmarks"
312 .It GUID Ta com.delphix:bookmarks
313 .It READ\-ONLY COMPATIBLE Ta yes
314 .It DEPENDENCIES Ta extensible_dataset
317 This feature enables use of the
324 while any bookmarks exist in the pool.
325 All bookmarks in the pool can be listed by running
328 .Fl t No bookmark Fl r Ar poolname .
330 .Bl -column "READ\-ONLY COMPATIBLE" "com.delphix:enabled_txg"
331 .It GUID Ta com.delphix:enabled_txg
332 .It READ\-ONLY COMPATIBLE Ta yes
333 .It DEPENDENCIES Ta none
336 Once this feature is enabled ZFS records the transaction group number
337 in which new features are enabled. This has no user-visible impact,
338 but other features may depend on this feature.
342 as soon as it is enabled and will
343 never return to being
346 .Bl -column "READ\-ONLY COMPATIBLE" "com.delphix:hole_birth"
347 .It GUID Ta com.delphix:hole_birth
348 .It READ\-ONLY COMPATIBLE Ta no
349 .It DEPENDENCIES Ta enabled_txg
352 This feature improves performance of incremental sends
354 and receives for objects with many holes.
355 The most common case of
356 hole-filled objects is zvols.
358 An incremental send stream from snapshot
362 contains information about every block that changed between
366 Blocks which did not change between those snapshots can be
367 identified and omitted from the stream using a piece of metadata called
368 the 'block birth time', but birth times are not recorded for holes
369 .Pq blocks filled only with zeroes .
370 Since holes created after
373 distinguished from holes created before
375 information about every
376 hole in the entire filesystem or zvol is included in the send stream.
378 For workloads where holes are rare this is not a problem.
380 incrementally replicating filesystems or zvols with many holes
381 .Pq for example a zvol formatted with another filesystem
383 be spent sending and receiving unnecessary information about holes that
384 already exist on the receiving side.
388 feature has been enabled the block birth times
389 of all new holes will be recorded.
390 Incremental sends between snapshots
391 created after this feature is enabled will use this new metadata to avoid
392 sending information about holes that already exist on the receiving side.
396 as soon as it is enabled and will
397 never return to being
403 This manual page is a
405 reimplementation of the
408 .Em zpool-features(5) ,
409 modified and customized for
411 and licensed under the Common Development and Distribution License
416 implementation of this manual page was initially written by
417 .An Martin Matuska Aq mm@FreeBSD.org .