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

   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 .\"
  22 .\" $FreeBSD$
  23 .\"
  24 .Dd Aug 27, 2012
  25 .Dt ZPOOL-FEATURES 8
  26 .Os
  27 .Sh NAME
  28 .Nm zpool-features
  29 .Nd ZFS pool feature descriptions
  30 .Sh DESCRIPTION
  31 ZFS pool on\-disk format versions are specified via "features" which replace
  32 the old on\-disk format numbers (the last supported on\-disk format number is
  33 28).
  34 To enable a feature on a pool use the
  35 .Cm upgrade
  36 subcommand of the
  37 .Xr zpool 8
  38 command, or set the
  39 .Sy feature@feature_name
  40 property to
  41 .Ar enabled .
  42 .Pp
  43 The pool format does not affect file system version compatibility or the ability
  44 to send file systems between pools.
  45 .Pp
  46 Since most features can be enabled independently of each other the on\-disk
  47 format of the pool is specified by the set of all features marked as
  48 .Sy active
  49 on the pool. If the pool was created by another software version this set may
  50 include unsupported features.
  51 .Ss Identifying features
  52 Every feature has a guid of the form
  53 .Sy com.example:feature_name .
  54 The reverse DNS name ensures that the feature's guid is unique across all ZFS
  55 implementations. When unsupported features are encountered on a pool they will
  56 be identified by their guids.
  57 Refer to the documentation for the ZFS implementation that created the pool
  58 for information about those features.
  59 .Pp
  60 Each supported feature also has a short name.
  61 By convention a feature's short name is the portion of its guid which follows
  62 the ':' (e.g.
  63 .Sy com.example:feature_name
  64 would have the short name
  65 .Sy feature_name ),
  66 however a feature's short name may differ across ZFS implementations if
  67 following the convention would result in name conflicts.
  68 .Ss Feature states
  69 Features can be in one of three states:
  70 .Bl -tag
  71 .It Sy active
  72 This feature's on\-disk format changes are in effect on the pool.
  73 Support for this feature is required to import the pool in read\-write mode.
  74 If this feature is not read-only compatible, support is also required to
  75 import the pool in read\-only mode (see "Read\-only compatibility").
  76 .It Sy enabled
  77 An administrator has marked this feature as enabled on the pool, but the
  78 feature's on\-disk format changes have not been made yet.
  79 The pool can still be imported by software that does not support this feature,
  80 but changes may be made to the on\-disk format at any time which will move
  81 the feature to the
  82 .Sy active
  83 state.
  84 Some features may support returning to the
  85 .Sy enabled
  86 state after becoming
  87 .Sy active .
  88 See feature\-specific documentation for details.
  89 .It Sy disabled
  90 This feature's on\-disk format changes have not been made and will not be made
  91 unless an administrator moves the feature to the
  92 .Sy enabled
  93 state.
  94 Features cannot be disabled once they have been enabled.
  95 .El
  96 The state of supported features is exposed through pool properties of the form
  97 .Sy feature@short_name .
  98 .Ss Read\-only compatibility
  99 Some features may make on\-disk format changes that do not interfere with other
 100 software's ability to read from the pool.
 101 These features are referred to as "read\-only compatible".
 102 If all unsupported features on a pool are read\-only compatible, the pool can
 103 be imported in read\-only mode by setting the
 104 .Sy readonly
 105 property during import (see
 106 .Xr zpool 8
 107 for details on importing pools).
 108 .Ss Unsupported features
 109 For each unsupported feature enabled on an imported pool a pool property
 110 named
 111 .Sy unsupported@feature_guid
 112 will indicate why the import was allowed despite the unsupported feature.
 113 Possible values for this property are:
 114 .Bl -tag
 115 .It Sy inactive
 116 The feature is in the
 117 .Sy enabled
 118 state and therefore the pool's on\-disk format is still compatible with
 119 software that does not support this feature.
 120 .It Sy readonly
 121 The feature is read\-only compatible and the pool has been imported in
 122 read\-only mode.
 123 .El
 124 .Ss Feature dependencies
 125 Some features depend on other features being enabled in order to function
 126 properly.
 127 Enabling a feature will automatically enable any features it depends on.
 128 .Sh FEATURES
 129 The following features are supported on this system:
 130 .Bl -tag
 131 .It Sy async_destroy
 132 .Bl -column "READ\-ONLY COMPATIBLE" "com.delphix:async_destroy"
 133 .It GUID Ta com.delphix:async_destroy
 134 .It READ\-ONLY COMPATIBLE Ta yes
 135 .It DEPENDENCIES Ta none
 136 .El
 137 .Pp
 138 Destroying a file system requires traversing all of its data in order to
 139 return its used space to the pool.
 140 Without
 141 .Sy async_destroy
 142 the file system is not fully removed until all space has been reclaimed.
 143 If the destroy operation is interrupted by a reboot or power outage the next
 144 attempt to open the pool will need to complete the destroy operation
 145 synchronously.
 146 .Pp
 147 When
 148 .Sy async_destroy
 149 is enabled the file system's data will be reclaimed by a background process,
 150 allowing the destroy operation to complete without traversing the entire file
 151 system.
 152 The background process is able to resume interrupted destroys after the pool
 153 has been opened, eliminating the need to finish interrupted destroys as part
 154 of the open operation.
 155 The amount of space remaining to be reclaimed by the background process is
 156 available through the
 157 .Sy freeing
 158 property.
 159 .Pp
 160 This feature is only
 161 .Sy active
 162 while
 163 .Sy freeing
 164 is non\-zero.
 165 .Sh SEE ALSO
 166 .Xr zpool 8
 167 .Sh AUTHORS
 168 This manual page is a
 169 .Xr mdoc 7
 170 reimplementation of the
 171 .Tn illumos
 172 manual page
 173 .Em zpool-features(5) ,
 174 modified and customized for
 175 .Fx
 176 and licensed under the Common Development and Distribution License
 177 .Pq Tn CDDL .
 178 .Pp
 179 The
 180 .Xr mdoc 7
 181 implementation of this manual page was initially written by
 182 .An Martin Matuska Aq mm@FreeBSD.org .