Documentation/mkfs.btrfs.asciidoc

   1 mkfs.btrfs(8)
   2 =============
   3
   4 NAME
   5 ----
   6 mkfs.btrfs - create a btrfs filesystem
   7
   8 SYNOPSIS
   9 --------
  10 *mkfs.btrfs* [options] <device> [<device>...]
  11
  12 DESCRIPTION
  13 -----------
  14 *mkfs.btrfs* is used to create the btrfs filesystem on a single or multiple
  15 devices.  <device> is typically a block device but can be a file-backed image
  16 as well. Multiple devices are grouped by UUID of the filesystem.
  17
  18 Before mounting such filesystem, the kernel module must know all the devices
  19 either via preceding execution of *btrfs device scan* or using the *device*
  20 mount option. See section *MULTIPLE DEVICES* for more details.
  21
  22 OPTIONS
  23 -------
  24 *-A|--alloc-start <offset>*::
  25 (An option to help debugging chunk allocator.)
  26 Specify the (physical) offset from the start of the device at which allocations
  27 start.  The default value is zero.
  28
  29 *-b|--byte-count <size>*::
  30 Specify the size of the filesystem. If this option is not used,
  31 mkfs.btrfs uses the entire device space for the filesystem.
  32
  33 *-d|--data <profile>*::
  34 Specify the profile for the data block groups.  Valid values are 'raid0',
  35 'raid1', 'raid5', 'raid6', 'raid10' or 'single' or dup (case does not matter).
  36 +
  37 See 'DUP PROFILES ON A SINGLE DEVICE' for more.
  38
  39 *-m|--metadata <profile>*::
  40 Specify the profile for the metadata block groups.
  41 Valid values are 'raid0', 'raid1', 'raid5', 'raid6', 'raid10', 'single' or
  42 'dup', (case does not matter).
  43 +
  44 A single device filesystem will default to 'DUP', unless a SSD is detected. Then
  45 it will default to 'single'. The detection is based on the value of
  46 `/sys/block/DEV/queue/rotational`, where 'DEV' is the short name of the device.
  47 +
  48 Note that the rotational status can be arbitrarily set by the underlying block
  49 device driver and may not reflect the true status (network block device, memory-backed
  50 SCSI devices etc). Use the options '--data/--metadata' to avoid confusion.
  51 +
  52 See 'DUP PROFILES ON A SINGLE DEVICE' for more details.
  53
  54 *-M|--mixed*::
  55 Normally the data and metadata block groups are isolated. The 'mixed' mode
  56 will remove the isolation and store both types in the same block group type.
  57 This helps to utilize the free space regardless of the purpose and is suitable
  58 for small devices. The separate allocation of block groups leads to a situation
  59 where the space is reserved for the other block group type, is not available for
  60 allocation and can lead to ENOSPC state.
  61 +
  62 The recommended size for the mixed mode is for filesystems less than 1GiB. The
  63 soft recommendation is to use it for filesystems smaller than 5GiB. The mixed
  64 mode may lead to degraded performance on larger filesystems, but is otherwise
  65 usable, even on multiple devices.
  66 +
  67 The 'nodesize' and 'sectorsize' must be equal, and the block group types must
  68 match.
  69 +
  70 NOTE: versions up to 4.2.x forced the mixed mode for devices smaller than 1GiB.
  71 This has been removed in 4.3+ as it caused some usability issues.
  72
  73 *-l|--leafsize <size>*::
  74 Alias for --nodesize. Deprecated.
  75
  76 *-n|--nodesize <size>*::
  77 Specify the nodesize, the tree block size in which btrfs stores metadata. The
  78 default value is 16KiB (16384) or the page size, whichever is bigger. Must be a
  79 multiple of the sectorsize, but not larger than 64KiB (65536).  Leafsize always
  80 equals nodesize and the options are aliases.
  81 +
  82 Smaller node size increases fragmentation but lead to higher b-trees which in
  83 turn leads to lower locking contention. Higher node sizes give better packing
  84 and less fragmentation at the cost of more expensive memory operations while
  85 updating the metadata blocks.
  86 +
  87 NOTE: versions up to 3.11 set the nodesize to 4k.
  88
  89 *-s|--sectorsize <size>*::
  90 Specify the sectorsize, the minimum data block allocation unit.
  91 +
  92 The default value is the page size and is autodetected. If the sectorsize
  93 differs from the page size, the created filesystem may not be mountable by the
  94 kernel. Therefore it is not recommended to use this option unless you are going
  95 to mount it on a system with the appropriate page size.
  96
  97 *-L|--label <string>*::
  98 Specify a label for the filesystem. The 'string' should be less than 256
  99 bytes and must not contain newline characters.
 100
 101 *-K|--nodiscard*::
 102 Do not perform whole device TRIM operation on devices that are capable of that.
 103
 104 *-r|--rootdir <rootdir>*::
 105 Populate the toplevel subvolume with files from 'rootdir'.  This does not
 106 require root permissions and does not mount the filesystem.
 107
 108 *-O|--features <feature1>[,<feature2>...]*::
 109 A list of filesystem features turned on at mkfs time. Not all features are
 110 supported by old kernels. To disable a feature, prefix it with '^'.
 111 +
 112 See section *FILESYSTEM FEATURES* for more details.  To see all available
 113 features that mkfs.btrfs supports run:
 114 +
 115 +mkfs.btrfs -O list-all+
 116
 117 *-f|--force*::
 118 Forcibly overwrite the block devices when an existing filesystem is detected.
 119 By default, mkfs.btrfs will utilize 'libblkid' to check for any known
 120 filesystem on the devices. Alternatively you can use the `wipefs` utility
 121 to clear the devices.
 122
 123 *-q|--quiet*::
 124 Print only error or warning messages. Options --features or --help are unaffected.
 125
 126 *-U|--uuid <UUID>*::
 127 Create the filesystem with the given 'UUID'. The UUID must not exist on any
 128 filesystem currently present.
 129
 130 *-V|--version*::
 131 Print the *mkfs.btrfs* version and exit.
 132
 133 *--help*::
 134 Print help.
 135
 136 SIZE UNITS
 137 ----------
 138 The default unit is 'byte'. All size parameters accept suffixes in the 1024
 139 base. The recognized suffixes are: 'k', 'm', 'g', 't', 'p', 'e', both uppercase
 140 and lowercase.
 141
 142 MULTIPLE DEVICES
 143 ----------------
 144
 145 Before mounting a multiple device filesystem, the kernel module must know the
 146 association of the block devices that are attached to the filesystem UUID.
 147
 148 There is typically no action needed from the user.  On a system that utilizes a
 149 udev-like daemon, any new block device is automatically registered. The rules
 150 call *btrfs device scan*.
 151
 152 The same command can be used to trigger the device scanning if the btrfs kernel
 153 module is reloaded (naturally all previous information about the device
 154 registration is lost).
 155
 156 Another possibility is to use the mount options *device* to specify the list of
 157 devices to scan at the time of mount.
 158
 159  # mount -o device=/dev/sdb,device=/dev/sdc /dev/sda /mnt
 160
 161 NOTE: that this means only scanning, if the devices do not exist in the system,
 162 mount will fail anyway. This can happen on systems without initramfs/initrd and
 163 root partition created with RAID1/10/5/6 profiles. The mount action can happen
 164 before all block devices are discovered. The waiting is usually done on the
 165 initramfs/initrd systems.
 166
 167 FILESYSTEM FEATURES
 168 -------------------
 169
 170 Features that can be enabled during creation time. See also `btrfs`(5) section
 171 'FILESYSTEM FEATURES'.
 172
 173 *mixed-bg*::
 174 (kernel support since 2.6.37)
 175 +
 176 mixed data and metadata block groups, also set by option '--mixed'
 177
 178 *extref*::
 179 (default since btrfs-progs 3.12, kernel support since 3.7)
 180 +
 181 increased hardlink limit per file in a directory to 65536, older kernels
 182 supported a varying number of hardlinks depending on the sum of all file name
 183 sizes that can be stored into one metadata block
 184
 185 *raid56*::
 186 (kernel support since 3.9)
 187 +
 188 extended format for RAID5/6, also enabled if raid5 or raid6 block groups
 189 are selected
 190
 191 *skinny-metadata*::
 192 (default since btrfs-progs 3.18, kernel support since 3.10)
 193 +
 194 reduced-size metadata for extent references, saves a few percent of metadata
 195
 196 *no-holes*::
 197 (kernel support since 3.14)
 198 +
 199 improved representation of file extents where holes are not explicitly
 200 stored as an extent, saves a few percent of metadata if sparse files are used
 201
 202 BLOCK GROUPS, CHUNKS, RAID
 203 --------------------------
 204
 205 The highlevel organizational units of a filesystem are block groups of three types:
 206 data, metadata and system.
 207
 208 *DATA*::
 209 store data blocks and nothing else
 210
 211 *METADATA*::
 212 store internal metadata in b-trees, can store file data if they fit into the
 213 inline limit
 214
 215 *SYSTEM*::
 216 store structures that describe the mapping between the physical devices and the
 217 linear logical space representing the filesystem
 218
 219 Other terms commonly used:
 220
 221 *block group*::
 222 *chunk*::
 223 a logical range of space of a given profile, stores data, metadata or both;
 224 sometimes the terms are used interchangeably
 225 +
 226 A typical size of metadata block group is 256MiB (filesystem smaller than
 227 50GiB) and 1GiB (larger than 50GiB), for data it's 1GiB. The system block group
 228 size is a few megabytes.
 229
 230 *RAID*::
 231 a block group profile type that utilizes RAID-like features on multiple
 232 devices: striping, mirroring, parity
 233
 234 *profile*::
 235 when used in connection with block groups refers to the allocation strategy
 236 and constraints, see the section 'PROFILES' for more details
 237
 238 PROFILES
 239 --------
 240
 241 There are the following block group types available:
 242
 243 [ cols="^,^,^,^,^",width="60%" ]
 244 |=============================================================
 245 .2+^.<h| Profile   3+^.^h| Redundancy           .2+^.<h| Min/max devices
 246       ^.^h| Copies   ^.^h| Parity     ^.<h| Striping
 247 | single  | 1            |                |            | 1/any
 248 | DUP     | 2 / 1 device |                |            | 1/any ^(see note 1)^
 249 | RAID0   |              |                | 1 to N     | 2/any
 250 | RAID1   | 2            |                |            | 2/any
 251 | RAID10  | 2            |                | 1 to N     | 4/any
 252 | RAID5   | 1            | 1              | 2 to N - 1 | 2/any ^(see note 2)^
 253 | RAID6   | 1            | 2              | 3 to N - 2 | 3/any ^(see note 3)^
 254 |=============================================================
 255
 256 WARNING: It's not recommended to build btrfs with RAID0/1/10/5/6 prfiles on
 257 partitions from the same device.  Neither redundancy nor performance will be
 258 improved.
 259
 260 'Note 1:' DUP may exist on more than 1 device if it starts on a single device and
 261 another one is added. Since version 4.5.1, *mkfs.btrfs* will let you create DUP
 262 on multiple devices.
 263
 264 'Note 2:' It's not recommended to use 2 devices with RAID5. In that case,
 265 parity stripe will contain the same data as the data stripe, making RAID5
 266 degraded to RAID1 with more overhead.
 267
 268 'Note 3:' It's also not recommended to use 3 devices with RAID6, unless you
 269 want to get effectively 3 copies in a RAID1-like manner (but not exactly that).
 270 N-copies RAID1 is not implemented.
 271
 272 DUP PROFILES ON A SINGLE DEVICE
 273 -------------------------------
 274
 275 The mkfs utility will let the user create a filesystem with profiles that write
 276 the logical blocks to 2 physical locations. Whether there are really 2
 277 physical copies highly depends on the underlying device type.
 278
 279 For example, a SSD drive can remap the blocks internally to a single copy thus
 280 deduplicating them. This negates the purpose of increased redundancy and just
 281 wastes filesystem space without the expected level of redundancy.
 282
 283 The duplicated data/metadata may still be useful to statistically improve the
 284 chances on a device that might perform some internal optimizations. The actual
 285 details are not usually disclosed by vendors. For example we could expect that
 286 not all blocks get deduplicated. This will provide a non-zero probability of
 287 recovery compared to a zero chance if the single profile is used. The user
 288 should make the tradeoff decision. The deduplication in SSDs is thought to be
 289 widely available so the reason behind the mkfs default is to not give a false
 290 sense of redundancy.
 291
 292 As another example, the widely used USB flash or SD cards use a translation
 293 layer between the logical and physical view of the device. The data lifetime
 294 may be affected by frequent plugging. The memory cells could get damaged,
 295 hopefully not destroying both copies of particular data in case of DUP.
 296
 297 The wear levelling techniques can also lead to reduced redundancy, even if the
 298 device does not do any deduplication. The controllers may put data written in
 299 a short timespan into the same physical storage unit (cell, block etc). In case
 300 this unit dies, both copies are lost. BTRFS does not add any artificial delay
 301 between metadata writes.
 302
 303 The traditional rotational hard drives usually fail at the sector level.
 304
 305 In any case, a device that starts to misbehave and repairs from the DUP copy
 306 should be replaced! *DUP is not backup*.
 307
 308 KNOWN ISSUES
 309 ------------
 310
 311 **SMALL FILESYSTEMS AND LARGE NODESIZE**
 312
 313 The combination of small filesystem size and large nodesize is not recommended
 314 in general and can lead to various ENOSPC-related issues during mount time or runtime.
 315
 316 Since mixed block group creation is optional, we allow small
 317 filesystem instances with differing values for 'sectorsize' and 'nodesize'
 318 to be created and could end up in the following situation:
 319
 320   # mkfs.btrfs -f -n 65536 /dev/loop0
 321   btrfs-progs v3.19-rc2-405-g976307c
 322   See http://btrfs.wiki.kernel.org for more information.
 323
 324   Performing full device TRIM (512.00MiB) ...
 325   Label:              (null)
 326   UUID:               49fab72e-0c8b-466b-a3ca-d1bfe56475f0
 327   Node size:          65536
 328   Sector size:        4096
 329   Filesystem size:    512.00MiB
 330   Block group profiles:
 331     Data:             single            8.00MiB
 332     Metadata:         DUP              40.00MiB
 333     System:           DUP              12.00MiB
 334   SSD detected:       no
 335   Incompat features:  extref, skinny-metadata
 336   Number of devices:  1
 337   Devices:
 338     ID        SIZE  PATH
 339      1   512.00MiB  /dev/loop0
 340
 341   # mount /dev/loop0 /mnt/
 342   mount: mount /dev/loop0 on /mnt failed: No space left on device
 343
 344 The ENOSPC occurs during the creation of the UUID tree. This is caused
 345 by large metadata blocks and space reservation strategy that allocates more
 346 than can fit into the filesystem.
 347
 348
 349 AVAILABILITY
 350 ------------
 351 *mkfs.btrfs* is part of btrfs-progs.
 352 Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
 353 further details.
 354
 355 SEE ALSO
 356 --------
 357 `btrfs`(5),
 358 `btrfs`(8),
 359 `wipefs`(8)