cddl/contrib/opensolaris/cmd/zpool/zpool-features.7

   1 '\" te
   2 .\" Copyright (c) 2012, Martin Matuska <mm@FreeBSD.org>.
   3 .\" All Rights Reserved.
   4 .\"
   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.
   8 .\"
   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.
  13 .\"
  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]
  19 .\"
  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.
  23 .\"
  24 .\" $FreeBSD$
  25 .\"
  26 .Dd January 2, 2014
  27 .Dt ZPOOL-FEATURES 7
  28 .Os
  29 .Sh NAME
  30 .Nm zpool-features
  31 .Nd ZFS pool feature descriptions
  32 .Sh DESCRIPTION
  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
  35 28).
  36 To enable a feature on a pool use the
  37 .Cm upgrade
  38 subcommand of the
  39 .Xr zpool 8
  40 command, or set the
  41 .Sy feature@feature_name
  42 property to
  43 .Ar enabled .
  44 .Pp
  45 The pool format does not affect file system version compatibility or the ability
  46 to send file systems between pools.
  47 .Pp
  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
  50 .Sy active
  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.
  61 .Pp
  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
  64 the ':' (e.g.
  65 .Sy com.example:feature_name
  66 would have the short name
  67 .Sy feature_name ),
  68 however a feature's short name may differ across ZFS implementations if
  69 following the convention would result in name conflicts.
  70 .Ss Feature states
  71 Features can be in one of three states:
  72 .Bl -tag -width "XXXXXXXX"
  73 .It Sy active
  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").
  78 .It Sy enabled
  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
  83 the feature to the
  84 .Sy active
  85 state.
  86 Some features may support returning to the
  87 .Sy enabled
  88 state after becoming
  89 .Sy active .
  90 See feature\-specific documentation for details.
  91 .It Sy disabled
  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
  94 .Sy enabled
  95 state.
  96 Features cannot be disabled once they have been enabled.
  97 .El
  98 .Pp
  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
 107 .Sy readonly
 108 property during import (see
 109 .Xr zpool 8
 110 for details on importing pools).
 111 .Ss Unsupported features
 112 For each unsupported feature enabled on an imported pool a pool property
 113 named
 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"
 118 .It Sy inactive
 119 The feature is in the
 120 .Sy enabled
 121 state and therefore the pool's on\-disk format is still compatible with
 122 software that does not support this feature.
 123 .It Sy readonly
 124 The feature is read\-only compatible and the pool has been imported in
 125 read\-only mode.
 126 .El
 127 .Ss Feature dependencies
 128 Some features depend on other features being enabled in order to function
 129 properly.
 130 Enabling a feature will automatically enable any features it depends on.
 131 .Sh FEATURES
 132 The following features are supported on this system:
 133 .Bl -tag -width "XXXXXXXX"
 134 .It Sy async_destroy
 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
 139 .El
 140 .Pp
 141 Destroying a file system requires traversing all of its data in order to
 142 return its used space to the pool.
 143 Without
 144 .Sy async_destroy
 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
 148 synchronously.
 149 .Pp
 150 When
 151 .Sy async_destroy
 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
 154 system.
 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
 160 .Sy freeing
 161 property.
 162 .Pp
 163 This feature is only
 164 .Sy active
 165 while
 166 .Sy freeing
 167 is non\-zero.
 168 .It Sy empty_bpobj
 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
 173 .El
 174 .Pp
 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
 177 space required.
 178 .Pp
 179 When there are many snapshots, each snapshot uses many Block Pointer Objects
 180 .Pq bpobj's
 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
 184 empty bpobjs.
 185 .Pp
 186 This feature is
 187 .Sy active
 188 while there are any filesystems, volumes, or snapshots which were created
 189 after enabling this feature.
 190 .It Sy lz4_compress
 191 .Bl -column "READ\-ONLY COMPATIBLE" "org.illumos:lz4_compress"
 192 .It GUID Ta org.illumos:lz4_compress
 193 .It READ\-ONLY COMPATIBLE Ta no
 194 .It DEPENDENCIES Ta none
 195 .El
 196 .Pp
 197 .Sy lz4
 198 is a high-performance real-time compression algorithm that
 199 features significantly faster compression and decompression as well as a
 200 higher compression ratio than the older
 201 .Sy lzjb
 202 compression.
 203 Typically,
 204 .Sy lz4
 205 compression is approximately 50% faster on
 206 compressible data and 200% faster on incompressible data than
 207 .Sy lzjb .
 208 It is also approximately 80% faster on decompression, while
 209 giving approximately 10% better compression ratio.
 210 .Pp
 211 When the
 212 .Sy lz4_compress
 213 feature is set to
 214 .Sy enabled ,
 215 the
 216 administrator can turn on
 217 .Sy lz4
 218 compression on any dataset on the
 219 pool using the
 220 .Xr zfs 8
 221 command. Please note that doing so will
 222 immediately activate the
 223 .Sy lz4_compress
 224 feature on the underlying
 225 pool
 226 .Pq even before any data is written ,
 227 and the feature will not be
 228 deactivated.
 229 Since this feature is not read-only compatible, this
 230 operation will render the pool unimportable on systems without support
 231 for the
 232 .Sy lz4_compress
 233 feature.
 234 Booting off of
 235 .Sy lz4
 236 -compressed root pools is supported.
 237 .It Sy multi_vdev_crash_dump
 238 .Bl -column "READ\-ONLY COMPATIBLE" "com.joyent:multi_vdev_crash_dump"
 239 .It GUID Ta com.joyent:multi_vdev_crash_dump
 240 .It READ\-ONLY COMPATIBLE Ta no
 241 .It DEPENDENCIES Ta none
 242 .El
 243 .Pp
 244 This feature allows a dump device to be configured with a pool comprised
 245 of multiple vdevs.
 246 Those vdevs may be arranged in any mirrored or raidz
 247 configuration.
 248 .\" TODO: this is not yet supported on FreeBSD.
 249 .\" .Pp
 250 .\" When the
 251 .\" .Sy multi_vdev_crash_dump
 252 .\" feature is set to
 253 .\" .Sy enabled ,
 254 .\" the administrator can use the
 255 .\" .Xr dumpon 8
 256 .\" command to configure a
 257 .\" dump device on a pool comprised of multiple vdevs.
 258 .It Sy spacemap_histogram
 259 .Bl -column "READ\-ONLY COMPATIBLE" "com.delphix:spacemap_histogram"
 260 .It GUID Ta com.delphix:spacemap_histogram
 261 .It READ\-ONLY COMPATIBLE Ta yes
 262 .It DEPENDENCIES Ta none
 263 .El
 264 .Pp
 265 This features allows ZFS to maintain more information about how free space
 266 is organized within the pool. If this feature is
 267 .Sy enabled ,
 268 ZFS will
 269 set this feature to
 270 .Sy active
 271 when a new space map object is created or
 272 an existing space map is upgraded to the new format.
 273 Once the feature is
 274 .Sy active ,
 275 it will remain in that state until the pool is destroyed.
 276 .It Sy extensible_dataset
 277 .Bl -column "READ\-ONLY COMPATIBLE" "com.delphix:extensible_dataset"
 278 .It GUID Ta com.delphix:extensible_dataset
 279 .It READ\-ONLY COMPATIBLE Ta no
 280 .It DEPENDENCIES Ta none
 281 .El
 282 .Pp
 283 This feature allows more flexible use of internal ZFS data structures,
 284 and exists for other features to depend on.
 285 .Pp
 286 This feature will be
 287 .Sy active
 288 when the first dependent feature uses it,
 289 and will be returned to the
 290 .Sy enabled
 291 state when all datasets that use
 292 this feature are destroyed.
 293 .It Sy bookmarks
 294 .Bl -column "READ\-ONLY COMPATIBLE" "com.delphix:bookmarks"
 295 .It GUID Ta com.delphix:bookmarks
 296 .It READ\-ONLY COMPATIBLE Ta yes
 297 .It DEPENDENCIES Ta extensible_dataset
 298 .El
 299 .Pp
 300 This feature enables use of the
 301 .Nm zfs
 302 .Cm bookmark
 303 subcommand.
 304 .Pp
 305 This feature is
 306 .Sy active
 307 while any bookmarks exist in the pool.
 308 All bookmarks in the pool can be listed by running
 309 .Nm zfs
 310 .Cm list
 311 .Fl t No bookmark Fl r Ar poolname .
 312 .It Sy enabled_txg
 313 .Bl -column "READ\-ONLY COMPATIBLE" "com.delphix:enabled_txg"
 314 .It GUID Ta com.delphix:enabled_txg
 315 .It READ\-ONLY COMPATIBLE Ta yes
 316 .It DEPENDENCIES Ta none
 317 .El
 318 .Pp
 319 Once this feature is enabled ZFS records the transaction group number
 320 in which new features are enabled. This has no user-visible impact,
 321 but other features may depend on this feature.
 322 .Pp
 323 This feature becomes
 324 .Sy active
 325 as soon as it is enabled and will
 326 never return to being
 327 .Sy enabled .
 328 .It Sy hole_birth
 329 .Bl -column "READ\-ONLY COMPATIBLE" "com.delphix:hole_birth"
 330 .It GUID Ta com.delphix:hole_birth
 331 .It READ\-ONLY COMPATIBLE Ta no
 332 .It DEPENDENCIES Ta enabled_txg
 333 .El
 334 .Pp
 335 This feature improves performance of incremental sends
 336 .Pq Dq zfs send -i
 337 and receives for objects with many holes.
 338 The most common case of
 339 hole-filled objects is zvols.
 340 .Pp
 341 An incremental send stream from snapshot
 342 .Sy A
 343 to snapshot
 344 .Sy B
 345 contains information about every block that changed between
 346 .Sy A
 347 and
 348 .Sy B .
 349 Blocks which did not change between those snapshots can be
 350 identified and omitted from the stream using a piece of metadata called
 351 the 'block birth time', but birth times are not recorded for holes
 352 .Pq blocks filled only with zeroes .
 353 Since holes created after
 354 .Sy A
 355 cannot be
 356 distinguished from holes created before
 357 .Sy A ,
 358 information about every
 359 hole in the entire filesystem or zvol is included in the send stream.
 360 .Pp
 361 For workloads where holes are rare this is not a problem.
 362 However, when
 363 incrementally replicating filesystems or zvols with many holes
 364 .Pq for example a zvol formatted with another filesystem
 365 a lot of time will
 366 be spent sending and receiving unnecessary information about holes that
 367 already exist on the receiving side.
 368 .Pp
 369 Once the
 370 .Sy hole_birth
 371 feature has been enabled the block birth times
 372 of all new holes will be recorded.
 373 Incremental sends between snapshots
 374 created after this feature is enabled will use this new metadata to avoid
 375 sending information about holes that already exist on the receiving side.
 376 .Pp
 377 This feature becomes
 378 .Sy active
 379 as soon as it is enabled and will
 380 never return to being
 381 .Sy enabled .
 382 .El
 383 .Sh SEE ALSO
 384 .Xr zpool 8
 385 .Sh AUTHORS
 386 This manual page is a
 387 .Xr mdoc 7
 388 reimplementation of the
 389 .Tn illumos
 390 manual page
 391 .Em zpool-features(5) ,
 392 modified and customized for
 393 .Fx
 394 and licensed under the Common Development and Distribution License
 395 .Pq Tn CDDL .
 396 .Pp
 397 The
 398 .Xr mdoc 7
 399 implementation of this manual page was initially written by
 400 .An Martin Matuska Aq mm@FreeBSD.org .