Documentation/btrfs-balance.asciidoc

   1 btrfs-balance(8)
   2 ================
   3
   4 NAME
   5 ----
   6 btrfs-balance - balance block groups on a btrfs filesystem
   7
   8 SYNOPSIS
   9 --------
  10 *btrfs balance* <subcommand> <args>
  11
  12 DESCRIPTION
  13 -----------
  14 The primary purpose of the balance feature is to spread block groups across
  15 all devices so they match constraints defined by the respective profiles. See
  16 `mkfs.btrfs`(8) section 'PROFILES' for more details.
  17 The scope of the balancing process can be further tuned by use of filters that
  18 can select the block groups to process. Balance works only on a mounted
  19 filesystem.
  20
  21 The balance operation is cancellable by the user. The on-disk state of the
  22 filesystem is always consistent so an unexpected interruption (eg. system crash,
  23 reboot) does not corrupt the filesystem. The progress of the balance operation
  24 is temporarily stored and will be resumed upon mount, unless the mount option
  25 'skip_balance' is specified.
  26
  27 WARNING: running balance without filters will take a lot of time as it basically
  28 rewrites the entire filesystem and needs to update all block pointers.
  29
  30 The filters can be used to perform following actions:
  31
  32 - convert block group profiles (filter 'convert')
  33 - make block group usage more compact  (filter 'usage')
  34 - perform actions only on a given device (filters 'devid', 'drange')
  35
  36 The filters can be applied to a combination of block group types (data,
  37 metadata, system). Note that changing 'system' needs the force option.
  38
  39 NOTE: the balance operation needs enough work space, ie. space that is
  40 completely unused in the filesystem, otherwise this may lead to ENOSPC reports.
  41 See the section 'ENOSPC' for more details.
  42
  43 COMPATIBILITY
  44 -------------
  45
  46 NOTE: The balance subcommand also exists under the *btrfs filesystem*
  47 namespace. This still works for backward compatibility but is deprecated and
  48 should not be used anymore.
  49
  50 NOTE: A short syntax *btrfs balance <path>* works due to backward compatibility
  51 but is deprecated and should not be used anymore. Use *btrfs balance start*
  52 command instead.
  53
  54 SUBCOMMAND
  55 ----------
  56 *cancel* <path>::
  57 cancel running or paused balance
  58
  59 *pause* <path>::
  60 pause running balance operation, this will store the state of the balance
  61 progress and used filters to the filesystem
  62
  63 *resume* <path>::
  64 resume interrupted balance
  65
  66 *start* [options] <path>::
  67 start the balance operation according to the specified filters, no filters
  68 will rewrite the entire filesystem. The process runs in the foreground.
  69 +
  70 NOTE: the balance command without filters will basically rewrite everything
  71 in the filesystem. The run time is potentially very long, depending on the
  72 filesystem size. To prevent starting a full balance by accident, the user is
  73 warned and has a few seconds to cancel the operation before it starts. The
  74 warning and delay can be skipped with '--full-balance' option.
  75 +
  76 `Options`
  77 +
  78 -d[<filters>]::::
  79 act on data block groups, see `FILTERS` section for details about 'filters'
  80 -m[<filters>]::::
  81 act on metadata chunks, see `FILTERS` section for details about 'filters'
  82 -s[<filters>]::::
  83 act on system chunks (requires '-f'), see `FILTERS` section for details about 'filters'.
  84 -v::::
  85 be verbose and print balance filter arguments
  86 -f::::
  87 force reducing of metadata integrity, eg. when going from 'raid1' to 'single'
  88
  89 *status* [-v] <path>::
  90 Show status of running or paused balance.
  91 +
  92 If '-v' option is given, output will be verbose.
  93
  94 FILTERS
  95 -------
  96 From kernel 3.3 onwards, btrfs balance can limit its action to a subset of the
  97 full filesystem, and can be used to change the replication configuration (e.g.
  98 moving data from single to RAID1). This functionality is accessed through the
  99 '-d', '-m' or '-s' options to btrfs balance start, which filter on data,
 100 metadata and system blocks respectively.
 101
 102 A filter has the following structure: 'type'[='params'][,'type'=...]
 103
 104 The available types are:
 105
 106 *profiles=<profiles>*::
 107 Balances only block groups with the given profiles. Parameters
 108 are a list of profile names separated by "'|'" (pipe).
 109
 110 *usage=<percent>*::
 111 *usage=<range>*::
 112 Balances only block groups with usage under the given percentage. The
 113 value of 0 is allowed and will clean up completely unused block groups, this
 114 should not require any new work space allocated. You may want to use 'usage=0'
 115 in case balance is returning ENOSPC and your filesystem is not too full.
 116 +
 117 The argument may be a single value or a range. The single value 'N' means 'at
 118 most N percent used', equivalent to '..N' range syntax. Kernels prior to 4.4
 119 accept only the single value format.
 120 The minimum range boundary is inclusive, maximum is exclusive.
 121
 122 *devid=<id>*::
 123 Balances only block groups which have at least one chunk on the given
 124 device. To list devices with ids use *btrfs fi show*.
 125
 126 *drange=<range>*::
 127 Balance only block groups which overlap with the given byte range on any
 128 device. Use in conjunction with 'devid' to filter on a specific device. The
 129 parameter is a range specified as 'start..end'.
 130
 131 *vrange=<range>*::
 132 Balance only block groups which overlap with the given byte range in the
 133 filesystem's internal virtual address space. This is the address space that
 134 most reports from btrfs in the kernel log use. The parameter is a range
 135 specified as 'start..end'.
 136
 137 *convert=<profile>*::
 138 Convert each selected block group to the given profile name identified by
 139 parameters.
 140 +
 141 NOTE: starting with kernel 4.5, the 'data' chunks can be converted to/from the
 142 'DUP' profile on a single device.
 143
 144 *limit=<number>*::
 145 *limit=<range>*::
 146 Process only given number of chunks, after all filters are applied. This can be
 147 used to specifically target a chunk in connection with other filters ('drange',
 148 'vrange') or just simply limit the amount of work done by a single balance run.
 149 +
 150 The argument may be a single value or a range. The single value 'N' means 'at
 151 most N chunks', equivalent to '..N' range syntax. Kernels prior to 4.4 accept
 152 only the single value format.  The range minimum and maximum are inclusive.
 153
 154 *stripes=<range>*::
 155 Balance only block groups which have the given number of stripes. The parameter
 156 is a range specified as 'start..end'. Makes sense for block group profiles that
 157 utilize striping, ie. RAID0/10/5/6.  The range minimum and maximum are
 158 inclusive.
 159
 160 *soft*::
 161 Takes no parameters. Only has meaning when converting between profiles.
 162 When doing convert from one profile to another and soft mode is on,
 163 chunks that already have the target profile are left untouched.
 164 This is useful e.g. when half of the filesystem was converted earlier but got
 165 cancelled.
 166 +
 167 The soft mode switch is (like every other filter) per-type.
 168 For example, this means that we can convert metadata chunks the "hard" way
 169 while converting data chunks selectively with soft switch.
 170
 171 Profile names, used in 'profiles' and 'convert' are one of: 'raid0', 'raid1',
 172 'raid10', 'raid5', 'raid6', 'dup', 'single'. The mixed data/metadata profiles
 173 can be converted in the same way, but it's conversion between mixed and non-mixed
 174 is not implemented. For the constraints of the profiles please refer to `mkfs.btrfs`(8),
 175 section 'PROFILES'.
 176
 177 ENOSPC
 178 ------
 179
 180 The way balance operates, it usually needs to temporarily create a new block
 181 group and move the old data there. For that it needs work space, otherwise
 182 it fails for ENOSPC reasons.
 183 This is not the same ENOSPC as if the free space is exhausted. This refers to
 184 the space on the level of block groups.
 185
 186 The free work space can be calculated from the output of the *btrfs filesystem show*
 187 command:
 188
 189 ------------------------------
 190    Label: 'BTRFS'  uuid: 8a9d72cd-ead3-469d-b371-9c7203276265
 191            Total devices 2 FS bytes used 77.03GiB
 192            devid    1 size 53.90GiB used 51.90GiB path /dev/sdc2
 193            devid    2 size 53.90GiB used 51.90GiB path /dev/sde1
 194 ------------------------------
 195
 196 'size' - 'used' = 'free work space' +
 197 '53.90GiB' - '51.90GiB' = '2.00GiB'
 198
 199 An example of a filter that does not require workspace is 'usage=0'. This will
 200 scan through all unused block groups of a given type and will reclaim the
 201 space. After that it might be possible to run other filters.
 202
 203 **CONVERSIONS ON MULTIPLE DEVICES**
 204
 205 Conversion to profiles based on striping (RAID0, RAID5/6) require the work
 206 space on each device. An interrupted balance may leave partially filled block
 207 groups that might consume the work space.
 208
 209 EXIT STATUS
 210 -----------
 211 *btrfs balance* returns a zero exit status if it succeeds. Non zero is
 212 returned in case of failure.
 213
 214 AVAILABILITY
 215 ------------
 216 *btrfs* is part of btrfs-progs.
 217 Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
 218 further details.
 219
 220 SEE ALSO
 221 --------
 222 `mkfs.btrfs`(8),
 223 `btrfs-device`(8)