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 .\"
  23 .\" $FreeBSD$
  24 .\"
  25 .Dd February 8, 2013
  26 .Dt ZPOOL-FEATURES 7
  27 .Os
  28 .Sh NAME
  29 .Nm zpool-features
  30 .Nd ZFS pool feature descriptions
  31 .Sh DESCRIPTION
  32 ZFS pool on\-disk format versions are specified via "features" which replace
  33 the old on\-disk format numbers (the last supported on\-disk format number is
  34 28).
  35 To enable a feature on a pool use the
  36 .Cm upgrade
  37 subcommand of the
  38 .Xr zpool 8
  39 command, or set the
  40 .Sy feature@feature_name
  41 property to
  42 .Ar enabled .
  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. If the pool was created by another software version this set may
  51 include unsupported features.
  52 .Ss Identifying features
  53 Every feature has a guid of the form
  54 .Sy com.example:feature_name .
  55 The reverse DNS name ensures that the feature's guid is unique across all ZFS
  56 implementations. When unsupported features are encountered on a pool they will
  57 be identified by their guids.
  58 Refer to the documentation for the ZFS implementation that created the pool
  59 for information about those features.
  60 .Pp
  61 Each supported feature also has a short name.
  62 By convention a feature's short name is the portion of its guid which follows
  63 the ':' (e.g.
  64 .Sy com.example:feature_name
  65 would have the short name
  66 .Sy feature_name ),
  67 however a feature's short name may differ across ZFS implementations if
  68 following the convention would result in name conflicts.
  69 .Ss Feature states
  70 Features can be in one of three states:
  71 .Bl -tag -width "XXXXXXXX"
  72 .It Sy active
  73 This feature's on\-disk format changes are in effect on the pool.
  74 Support for this feature is required to import the pool in read\-write mode.
  75 If this feature is not read-only compatible, support is also required to
  76 import the pool in read\-only mode (see "Read\-only compatibility").
  77 .It Sy enabled
  78 An administrator has marked this feature as enabled on the pool, but the
  79 feature's on\-disk format changes have not been made yet.
  80 The pool can still be imported by software that does not support this feature,
  81 but changes may be made to the on\-disk format at any time which will move
  82 the feature to the
  83 .Sy active
  84 state.
  85 Some features may support returning to the
  86 .Sy enabled
  87 state after becoming
  88 .Sy active .
  89 See feature\-specific documentation for details.
  90 .It Sy disabled
  91 This feature's on\-disk format changes have not been made and will not be made
  92 unless an administrator moves the feature to the
  93 .Sy enabled
  94 state.
  95 Features cannot be disabled once they have been enabled.
  96 .El
  97 .Pp
  98 The state of supported features is exposed through pool properties of the form
  99 .Sy feature@short_name .
 100 .Ss Read\-only compatibility
 101 Some features may make on\-disk format changes that do not interfere with other
 102 software's ability to read from the pool.
 103 These features are referred to as "read\-only compatible".
 104 If all unsupported features on a pool are read\-only compatible, the pool can
 105 be imported in read\-only mode by setting the
 106 .Sy readonly
 107 property during import (see
 108 .Xr zpool 8
 109 for details on importing pools).
 110 .Ss Unsupported features
 111 For each unsupported feature enabled on an imported pool a pool property
 112 named
 113 .Sy unsupported@feature_guid
 114 will indicate why the import was allowed despite the unsupported feature.
 115 Possible values for this property are:
 116 .Bl -tag -width "XXXXXXXX"
 117 .It Sy inactive
 118 The feature is in the
 119 .Sy enabled
 120 state and therefore the pool's on\-disk format is still compatible with
 121 software that does not support this feature.
 122 .It Sy readonly
 123 The feature is read\-only compatible and the pool has been imported in
 124 read\-only mode.
 125 .El
 126 .Ss Feature dependencies
 127 Some features depend on other features being enabled in order to function
 128 properly.
 129 Enabling a feature will automatically enable any features it depends on.
 130 .Sh FEATURES
 131 The following features are supported on this system:
 132 .Bl -tag -width "XXXXXXXX"
 133 .It Sy async_destroy
 134 .Bl -column "READ\-ONLY COMPATIBLE" "com.delphix:async_destroy"
 135 .It GUID Ta com.delphix:async_destroy
 136 .It READ\-ONLY COMPATIBLE Ta yes
 137 .It DEPENDENCIES Ta none
 138 .El
 139 .Pp
 140 Destroying a file system requires traversing all of its data in order to
 141 return its used space to the pool.
 142 Without
 143 .Sy async_destroy
 144 the file system is not fully removed until all space has been reclaimed.
 145 If the destroy operation is interrupted by a reboot or power outage the next
 146 attempt to open the pool will need to complete the destroy operation
 147 synchronously.
 148 .Pp
 149 When
 150 .Sy async_destroy
 151 is enabled the file system's data will be reclaimed by a background process,
 152 allowing the destroy operation to complete without traversing the entire file
 153 system.
 154 The background process is able to resume interrupted destroys after the pool
 155 has been opened, eliminating the need to finish interrupted destroys as part
 156 of the open operation.
 157 The amount of space remaining to be reclaimed by the background process is
 158 available through the
 159 .Sy freeing
 160 property.
 161 .Pp
 162 This feature is only
 163 .Sy active
 164 while
 165 .Sy freeing
 166 is non\-zero.
 167 .It Sy empty_bpobj
 168 .Bl -column "READ\-ONLY COMPATIBLE" "com.delphix:empty_bpobj"
 169 .It GUID Ta com.delphix:empty_bpobj
 170 .It READ\-ONLY COMPATIBLE Ta yes
 171 .It DEPENDENCIES Ta none
 172 .El
 173 .Pp
 174 This feature increases the performance of creating and using a large number
 175 of snapshots of a single filesystem or volume, and also reduces the disk
 176 space required.
 177 .Pp
 178 When there are many snapshots, each snapshot uses many Block Pointer Objects
 179 .Pq bpobj's
 180 to track blocks associated with that snapshot.
 181 However, in common use cases, most of these bpobj's are empty.
 182 This feature allows us to create each bpobj on-demand, thus eliminating the
 183 empty bpobjs.
 184 .Pp
 185 This feature is
 186 .Sy active
 187 while there are any filesystems, volumes, or snapshots which were created
 188 after enabling this feature.
 189 .It Sy lz4_compress
 190 .Bl -column "READ\-ONLY COMPATIBLE" "org.illumos:lz4_compress"
 191 .It GUID Ta org.illumos:lz4_compress
 192 .It READ\-ONLY COMPATIBLE Ta no
 193 .It DEPENDENCIES Ta none
 194 .El
 195 .Pp
 196 .Sy lz4
 197 is a high-performance real-time compression algorithm that
 198 features significantly faster compression and decompression as well as a
 199 higher compression ratio than the older
 200 .Sy lzjb
 201 compression.
 202 Typically,
 203 .Sy lz4
 204 compression is approximately 50% faster on
 205 compressible data and 200% faster on incompressible data than
 206 .Sy lzjb .
 207 It is also approximately 80% faster on decompression, while
 208 giving approximately 10% better compression ratio.
 209 .Pp
 210 When the
 211 .Sy lz4_compress
 212 feature is set to
 213 .Sy enabled ,
 214 the
 215 administrator can turn on
 216 .Sy lz4
 217 compression on any dataset on the
 218 pool using the
 219 .Xr zfs 8
 220 command. Please note that doing so will
 221 immediately activate the
 222 .Sy lz4_compress
 223 feature on the underlying
 224 pool (even before any data is written). Since this feature is not
 225 read-only compatible, this operation will render the pool unimportable
 226 on systems without support for the
 227 .Sy lz4_compress
 228 feature. At the
 229 moment, this operation cannot be reversed. Booting off of
 230 .Sy lz4
 231 -compressed root pools is supported.
 232 .El
 233 .Sh SEE ALSO
 234 .Xr zpool 8
 235 .Sh AUTHORS
 236 This manual page is a
 237 .Xr mdoc 7
 238 reimplementation of the
 239 .Tn illumos
 240 manual page
 241 .Em zpool-features(5) ,
 242 modified and customized for
 243 .Fx
 244 and licensed under the Common Development and Distribution License
 245 .Pq Tn CDDL .
 246 .Pp
 247 The
 248 .Xr mdoc 7
 249 implementation of this manual page was initially written by
 250 .An Martin Matuska Aq mm@FreeBSD.org .