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 September 20, 2013
  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 (even before any data is written). Since this feature is not
 226 read-only compatible, this operation will render the pool unimportable
 227 on systems without support for the
 228 .Sy lz4_compress
 229 feature. At the
 230 moment, this operation cannot be reversed. Booting off of
 231 .Sy lz4
 232 -compressed root pools is supported.
 233 .It Sy multi_vdev_crash_dump
 234 .Bl -column "READ\-ONLY COMPATIBLE" "com.joyent:multi_vdev_crash_dump"
 235 .It GUID Ta com.joyent:multi_vdev_crash_dump
 236 .It READ\-ONLY COMPATIBLE Ta no
 237 .It DEPENDENCIES Ta none
 238 .El
 239 .Pp
 240 This feature allows a dump device to be configured with a pool comprised
 241 of multiple vdevs.
 242 Those vdevs may be arranged in any mirrored or raidz
 243 configuration.
 244 .\" TODO: this is not yet supported on FreeBSD.
 245 .\" .Pp
 246 .\" When the
 247 .\" .Sy multi_vdev_crash_dump
 248 .\" feature is set to
 249 .\" .Sy enabled ,
 250 .\" the administrator can use the
 251 .\" .Xr dumpon 8
 252 .\" command to configure a
 253 .\" dump device on a pool comprised of multiple vdevs.
 254 .El
 255 .Sh SEE ALSO
 256 .Xr zpool 8
 257 .Sh AUTHORS
 258 This manual page is a
 259 .Xr mdoc 7
 260 reimplementation of the
 261 .Tn illumos
 262 manual page
 263 .Em zpool-features(5) ,
 264 modified and customized for
 265 .Fx
 266 and licensed under the Common Development and Distribution License
 267 .Pq Tn CDDL .
 268 .Pp
 269 The
 270 .Xr mdoc 7
 271 implementation of this manual page was initially written by
 272 .An Martin Matuska Aq mm@FreeBSD.org .