Documentation/btrfs-device.asciidoc

   1 btrfs-device(8)
   2 ===============
   3
   4 NAME
   5 ----
   6 btrfs-device - manage devices of btrfs filesystems
   7
   8 SYNOPSIS
   9 --------
  10 *btrfs device* <subcommand> <args>
  11
  12 DESCRIPTION
  13 -----------
  14 The *btrfs device* command group is used to manage devices of the btrfs filesystems.
  15
  16 DEVICE MANAGEMENT
  17 -----------------
  18 Btrfs filesystem can be created on top of single or multiple block devices.
  19 Data and metadata are organized in allocation profiles with various redundancy
  20 policies. There's some similarity with traditional RAID levels, but this could
  21 be confusing to users familiar with the traditional meaning. Due to the
  22 similarity, the RAID terminology is widely used in the documentation.  See
  23 `mkfs.btrfs`(8) for more details and the exact profile capabilities and
  24 constraints.
  25
  26 The device management works on a mounted filesystem. Devices can be added,
  27 removed or replaced, by commands provided by *btrfs device* and *btrfs replace*.
  28
  29 The profiles can be also changed, provided there's enough workspace to do the
  30 conversion, using the *btrfs balance* command and namely the filter 'convert'.
  31
  32 Profile::
  33 A profile describes an allocation policy based on the redundancy/replication
  34 constraints in connection with the number of devices. The profile applies to
  35 data and metadata block groups separately.
  36
  37 RAID level::
  38 Where applicable, the level refers to a profile that matches constraints of the
  39 standard RAID levels. At the moment the supported ones are: RAID0, RAID1,
  40 RAID10, RAID5 and RAID6.
  41
  42 See the section *TYPICAL USECASES* for some examples.
  43
  44 SUBCOMMAND
  45 ----------
  46 *add* [-Kf] <device> [<device>...] <path>::
  47 Add device(s) to the filesystem identified by <path>.
  48 +
  49 If applicable, a whole device discard (TRIM) operation is performed prior to
  50 adding the device. A device with existing filesystem detected by `blkid`(8)
  51 will prevent device addition and has to be forced. Alternatively the filesystem
  52 can be wiped from the device using eg. the `wipefs`(8) tool.
  53 +
  54 The operation is instant and does not affect existing data. The operation merely
  55 adds the device to the filesystem structures and creates some block groups
  56 headers.
  57 +
  58 `Options`
  59 +
  60 -K|--nodiscard::::
  61 do not perform discard (TRIM) by default
  62 -f|--force::::
  63 force overwrite of existing filesystem on the given disk(s)
  64
  65 *remove* <device>|<devid> [<device>|<devid>...] <path>::
  66 Remove device(s) from a filesystem identified by <path>
  67 +
  68 Device removal must satisfy the profile constraints, otherwise the command
  69 fails. The filesystem must be converted to profile(s) that would allow the
  70 removal. This can typically happen when going down from 2 devices to 1 and
  71 using the RAID1 profile. See the example section below.
  72 +
  73 The operation can take long as it needs to move all data from the device.
  74 +
  75 It is possible to delete the device that was used to mount the filesystem. The
  76 device entry in mount table will be replaced by another device name with the
  77 lowest device id.
  78
  79 *delete* <device>|<devid> [<device>|<devid>...] <path>::
  80 Alias of remove kept for backward compatibility
  81
  82 *ready* <device>::
  83 Wait until all devices of a multiple-device filesystem are scanned and
  84 registered within the kernel module. This is to provide a way for automatic
  85 filesystem mounting tools to wait before the mount can start. The device scan
  86 is only one of the preconditions and the mount can fail for other reasons.
  87 Normal users usually do not need this command and may safely ignore it.
  88
  89 *scan* [(--all-devices|-d)|<device> [<device>...]]::
  90 Scan devices for a btrfs filesystem and register them with the kernel module.
  91 This allows mounting multiple-device filesystem by specifying just one from the
  92 whole group.
  93 +
  94 If no devices are passed, all block devices that blkid reports to contain btrfs
  95 are scanned.
  96 +
  97 The options '--all-devices' or '-d' are deprecated and kept for backward compatibility.
  98 If used, behavior is the same as if no devices are passed.
  99 +
 100 The command can be run repeatedly. Devices that have been already registered
 101 remain as such. Reloading the kernel module will drop this information. There's
 102 an alternative way of mounting multiple-device filesystem without the need for
 103 prior scanning. See the mount option 'device'.
 104
 105 *stats* [options] <path>|<device>::
 106 Read and print the device IO error statistics for all devices of the given
 107 filesystem identified by <path> or for a single <device>. The filesystem must
 108 be mounted.  See section *DEVICE STATS* for more information about the reported
 109 statistics and the meaning.
 110 +
 111 `Options`
 112 +
 113 -z|--reset::::
 114 Print the stats and reset the values to zero afterwards.
 115
 116 -c|--check::::
 117 Check if the stats are all zeros and return 0 it it is so. Set bit 6 of the
 118 return code if any of the statistics is no-zero. The error values is 65 if
 119 reading stats from at least one device failed, otherwise it's 64.
 120
 121 *usage* [options] <path> [<path>...]::
 122 Show detailed information about internal allocations in devices.
 123 +
 124 `Options`
 125 +
 126 -b|--raw::::
 127 raw numbers in bytes, without the 'B' suffix
 128 -h|--human-readable::::
 129 print human friendly numbers, base 1024, this is the default
 130 -H::::
 131 print human friendly numbers, base 1000
 132 --iec::::
 133 select the 1024 base for the following options, according to the IEC standard
 134 --si::::
 135 select the 1000 base for the following options, according to the SI standard
 136 -k|--kbytes::::
 137 show sizes in KiB, or kB with --si
 138 -m|--mbytes::::
 139 show sizes in MiB, or MB with --si
 140 -g|--gbytes::::
 141 show sizes in GiB, or GB with --si
 142 -t|--tbytes::::
 143 show sizes in TiB, or TB with --si
 144
 145 If conflicting options are passed, the last one takes precedence.
 146
 147 TYPICAL USECASES
 148 ----------------
 149
 150 STARTING WITH A SINGLE-DEVICE FILESYSTEM
 151 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 152
 153 Assume we've created a filesystem on a block device '/dev/sda' with profile
 154 'single/single' (data/metadata), the device size is 50GiB and we've used the
 155 whole device for the filesystem. The mount point is '/mnt'.
 156
 157 The amount of data stored is 16GiB, metadata have allocated 2GiB.
 158
 159 ==== ADD NEW DEVICE ====
 160
 161 We want to increase the total size of the filesystem and keep the profiles. The
 162 size of the new device '/dev/sdb' is 100GiB.
 163
 164  $ btrfs device add /dev/sdb /mnt
 165
 166 The amount of free data space increases by less than 100GiB, some space is
 167 allocated for metadata.
 168
 169 ==== CONVERT TO RAID1 ====
 170
 171 Now we want to increase the redundancy level of both data and metadata, but
 172 we'll do that in steps. Note, that the device sizes are not equal and we'll use
 173 that to show the capabilities of split data/metadata and independent profiles.
 174
 175 The constraint for RAID1 gives us at most 50GiB of usable space and exactly 2
 176 copies will be stored on the devices.
 177
 178 First we'll convert the metadata. As the metadata occupy less than 50GiB and
 179 there's enough workspace for the conversion process, we can do:
 180
 181  $ btrfs balance start -mconvert=raid1 /mnt
 182
 183 This operation can take a while as the metadata have to be moved and all block
 184 pointers updated. Depending on the physical locations of the old and new
 185 blocks, the disk seeking is the key factor affecting performance.
 186
 187 You'll note that the system block group has been also converted to RAID1, this
 188 normally happens as the system block group also holds metadata (the physical to
 189 logical mappings).
 190
 191 What changed:
 192
 193 * available data space decreased by 3GiB, usable roughly (50 - 3) + (100 - 3) = 144 GiB
 194 * metadata redundancy increased
 195
 196 IOW, the unequal device sizes allow for combined space for data yet improved
 197 redundancy for metadata. If we decide to increase redundancy of data as well,
 198 we're going to lose 50GiB of the second device for obvious reasons.
 199
 200  $ btrfs balance start -dconvert=raid1 /mnt
 201
 202 The balance process needs some workspace (ie. a free device space without any
 203 data or metadata block groups) so the command could fail if there's too much
 204 data or the block groups occupy the whole first device.
 205
 206 The device size of '/dev/sdb' as seen by the filesystem remains unchanged, but
 207 the logical space from 50-100GiB will be unused.
 208
 209 DEVICE STATS
 210 ------------
 211
 212 The device stats keep persistent record of several error classes related to
 213 doing IO. The current values are printed at mount time and updated during
 214 filesystem lifetime or from a scrub run.
 215
 216  $ btrfs device stats /dev/sda3
 217  [/dev/sda3].write_io_errs   0
 218  [/dev/sda3].read_io_errs    0
 219  [/dev/sda3].flush_io_errs   0
 220  [/dev/sda3].corruption_errs 0
 221  [/dev/sda3].generation_errs 0
 222
 223 write_io_errs::
 224 Failed writes to the block devices, means that the layers beneath the
 225 filesystem were not able to satisfy the write request.
 226 read_io_errors::
 227 Read request analogy to write_io_errs.
 228 flush_io_errs::
 229 Number of failed writes with the 'FLUSH' flag set. The flushing is a method of
 230 forcing a particular order between write requests and is crucial for
 231 implementing crash consistency. In case of btrfs, all the metadata blocks must
 232 be permanently stored on the block device before the superblock is written.
 233 corruption_errs::
 234 A block checksum mismatched or a corrupted metadata header was found.
 235 generation_errs::
 236 The block generation does not match the expected value (eg. stored in the
 237 parent node).
 238
 239 EXIT STATUS
 240 -----------
 241 *btrfs device* returns a zero exit status if it succeeds. Non zero is
 242 returned in case of failure.
 243
 244 If the '-s' option is used, *btrfs device stats* will add 64 to the
 245 exit status if any of the error counters is non-zero.
 246
 247 AVAILABILITY
 248 ------------
 249 *btrfs* is part of btrfs-progs.
 250 Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
 251 further details.
 252
 253 SEE ALSO
 254 --------
 255 `mkfs.btrfs`(8),
 256 `btrfs-replace`(8),
 257 `btrfs-balance`(8)