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