Btrfs is a modern copy on write (CoW) filesystem for Linux aimed at implementing advanced features while also focusing on fault tolerance, repair and easy administration. Jointly developed at multiple companies, Btrfs is licensed under the GPL and open for contribution from anyone.
For user space utilities install the btrfs-progs package, which is required for basic operations.
If you need to boot from a Btrfs file system (i.e., your kernel and initramfs reside on a Btrfs partition), check if your boot loader supports Btrfs.
File system creation
The following shows how to create a new Btrfs file system. To convert an ext3/4 partition to Btrfs, see #Ext3/4 to Btrfs conversion. To use a partitionless setup, see #Partitionless Btrfs disk.
See mkfs.btrfs(8) for more information.
File system on a single device
To create a Btrfs filesystem on partition /dev/partition :
The Btrfs default nodesize for metadata is 16KB, while the default sectorsize for data is equal to page size and autodetected. To use a larger nodesize for metadata (must be a multiple of sectorsize, up to 64KB is allowed), specify a value for the nodesize via the -n switch as shown in this example using 32KB blocks:
Multi-device file system
Multiple devices can be used to create a RAID. Supported RAID levels include RAID 0, RAID 1, RAID 10, RAID 5 and RAID 6. Starting from kernel 5.5 RAID1c3 and RAID1c4 for 3- and 4- copies of RAID 1 level. The RAID levels can be configured separately for data and metadata using the -d and -m options respectively. By default the data is striped ( raid0 ) and the metadata is mirrored ( raid1 ). See Using Btrfs with Multiple Devices for more information about how to create a Btrfs RAID volume.
You can create a JBOD configuration, where disks are seen as one filesystem, but files are not duplicated, using -d single -m raid1 .
You must include either the udev hook or the btrfs hook in /etc/mkinitcpio.conf in order to use multiple Btrfs devices in a pool. See the Mkinitcpio#Common hooks article for more information.
See #RAID for advice on maintenance specific to multi-device Btrfs file systems.
Configuring the file system
By default, Btrfs uses copy-on-write for all files all the time. See the Btrfs Sysadmin Guide section for implementation details, as well as advantages and disadvantages.
To disable copy-on-write for newly created files in a mounted subvolume, use the nodatacow mount option. This will only affect newly created files. Copy-on-write will still happen for existing files. The nodatacow option also disables compression. See btrfs(5) for details.
To disable copy-on-write for single files/directories do:
This will disable copy-on-write for those operation in which there is only one reference to the file. If there is more than one reference (e.g. through cp –reflink=always or because of a filesystem snapshot), copy-on-write still occurs.
Make sure that the data are not used during this process. Also note that mv or cp –reflink as described below will not work.
Creating lightweight copies
By default, when copying files on a Btrfs filesystem with cp , actual copies are created. To create a lightweight copy referencing to the original data, use the reflink option:
See the man page on cp(1) for more details on the –reflink flag.
Btrfs supports transparent and automatic compression. This not only reduces the size of files, but can also improve performance, in some specific use cases (e.g. single thread with heavy file I/O), while obviously harming performance in other cases (e.g. multithreaded and/or cpu intensive tasks with large file I/O). Better performance is generally achieved with the fastest compress algorithms, zstd and lzo, and some benchmarks provide detailed comparisons.
The compress=alg mount option enables automatically considering every file for compression, where alg is either zlib , lzo , zstd , or no (for no compression). Using this option, btrfs will check if compressing the first portion of the data shrinks it. If it does, the entire write to that file will be compressed. If it does not, none of it is compressed. With this option, if the first portion of the write does not shrink, no compression will be applied to the write even if the rest of the data would shrink tremendously.  This is done to prevent making the disk wait to start writing until all of the data to be written is fully given to btrfs and compressed.
The compress-force=alg mount option can be used instead, which makes btrfs skip checking if compression shrinks the first portion, and enables automatic compression for every file. In a worst-case scenario, this can cause (slightly) more space to be used, and CPU usage for no purpose. However, empirical testing on multiple mixed-use systems showed a significant improvement of about 10% disk compression from using compress-force=zstd over just compress=zstd (which also had 10% disk compression), resulting in a total effective disk space saving of 20%.
Only files created or modified after the mount option is added will be compressed.
To apply compression to existing files, use the btrfs filesystem defragment -calg command, where alg is either zlib , lzo or zstd . For example, in order to re-compress the whole file system with zstd , run the following command:
To enable compression when installing Arch to an empty Btrfs partition, use the compress option when mounting the file system: mount -o compress=zstd /dev/sdxY /mnt/ . During configuration, add compress=zstd to the mount options of the root file system in fstab.
View compression types and ratios
compsize takes a list of files (or an entire btrfs filesystem) and measures compression types used and effective compression ratios. Uncompressed size may not match the number given by other programs such as du , because every extent is counted once, even if it is reflinked several times, and even if part of it is no longer used anywhere but has not been garbage collected. The -x option keeps it on a single filesystem, which is useful in situations like compsize -x / to avoid it from attempting to look in non-btrfs subdirectories and fail the entire run.
“A btrfs subvolume is not a block device (and cannot be treated as one) instead, a btrfs subvolume can be thought of as a POSIX file namespace. This namespace can be accessed via the top-level subvolume of the filesystem, or it can be mounted in its own right.” 
Each Btrfs file system has a top-level subvolume with ID 5. It can be mounted as / (by default), or another subvolume can be mounted instead. Subvolumes can be moved around in the filesystem and are rather identified by their id than their path.
See the following links for more details:
Creating a subvolume
To create a subvolume:
To see a list of current subvolumes and their ids under path :
Deleting a subvolume
To delete a subvolume:
Since Linux 4.18, one can also delete a subvolume like a regular directory ( rm -r , rmdir ).
Subvolumes can be mounted like file system partitions using the subvol=/path/to/subvolume or subvolid=objectid mount flags. For example, you could have a subvolume named subvol_root and mount it as / . One can mimic traditional file system partitions by creating various subvolumes under the top level of the file system and then mounting them at the appropriate mount points. Thus one can easily restore a file system (or part of it) to a previous state using #Snapshots.
See btrfs(5) for a full list of btrfs-specific mount options.
Mounting subvolume as root
To use a subvolume as the root mountpoint specify the subvolume via a kernel parameter using rootflags=subvol=/path/to/subvolume . Edit the root mountpoint in /etc/fstab and specify the mount option subvol= . Alternatively the subvolume can be specified with its id, rootflags=subvolid=objectid as kernel parameter and subvolid=objectid as mount option in /etc/fstab .
Changing the default sub-volume
The default sub-volume is mounted if no subvol= mount option is provided. To change the default subvolume, do:
where subvolume-id can be found by listing.
Changing the default subvolume with btrfs subvolume set-default will make the top level of the filesystem inaccessible, except by use of the subvol=/ or subvolid=5 mount options .
Quota support in Btrfs is implemented at a subvolume level by the use of quota groups or qgroup: Each subvolume is assigned a quota groups in the form of 0/subvolume_id by default. However it is possible to create a quota group using any number if desired.
To use qgroups you need to enable quota first using
From this point onwards newly created subvolumes will be controlled by those groups. In order to retrospectively enable them for already existing subvolumes, enable quota normally, then create a qgroup (quota group) for each of those subvolume using their subvolume_id and rescan them:
Quota groups in Btrfs form a tree hierarchy, whereby qgroups are attached to subvolumes. The size limits are set per qgroup and apply when any limit is reached in tree that contains a given subvolume.
Limits on quota groups can be applied either to the total data usage, un-shared data usage, compressed data usage or both. File copy and file deletion may both affect limits since the unshared limit of another qgroup can change if the original volume’s files are deleted and only one copy is remaining. For example a fresh snapshot shares almost all the blocks with the original subvolume, new writes to either subvolume will raise towards the exclusive limit, deletions of common data in one volume raises towards the exclusive limit in the other one.
To apply a limit to a qgroup, use the command btrfs qgroup limit . Depending on your usage either use a total limit, unshared limit ( -e ) or compressed limit ( -c ). To show usage and limits for a given path within a filesystem use
The resolution at which data are written to the filesystem is dictated by Btrfs itself and by system-wide settings. Btrfs defaults to a 30 seconds checkpoint interval in which new data are committed to the filesystem. This can be changed by appending the commit mount option in /etc/fstab for the btrfs partition.
System-wide settings also affect commit intervals. They include the files under /proc/sys/vm/* and are out-of-scope of this wiki article. The kernel documentation for them resides in Documentation/sysctl/vm.txt .
A Btrfs filesystem is able to free unused blocks from an SSD drive supporting the TRIM command. Starting with kernel version 5.6 there is asynchronous discard support, enabled with mount option discard=async . Freed extents are not discarded immediately, but grouped together and trimmed later by a separate worker thread, improving commit latency.
More information about enabling and using TRIM can be found in Solid State Drives#TRIM.
Swap files in Btrfs are supported since Linux kernel 5.0. The proper way to initialize a swap file is described in Swap file#Swap file creation. Configuring hibernation to a swap file is described in Power management/Suspend and hibernate#Hibernation into swap file on Btrfs.
Displaying used/free space
General linux userspace tools such as df will inaccurately report free space on a Btrfs partition. It is recommended to use btrfs filesystem usage to query Btrfs partitions. For example:
See  for more information.
Btrfs supports online defragmentation through the mount option autodefrag , see btrfs(5) § MOUNT OPTIONS . To manually defragment your root, use:
Using the above command without the -r switch will result in only the metadata held by the subvolume containing the directory being defragmented. This allows for single file defragmentation by simply specifying the path.
Defragmenting a file which has a COW copy (either a snapshot copy or one made with cp –reflink or bcp) plus using the -c switch with a compression algorithm may result in two unrelated files effectively increasing the disk usage.
Btrfs offers native “RAID” for #Multi-device file systems. Notable features which set btrfs RAID apart from mdadm are self-healing redundant arrays and online balancing. See the Btrfs wiki page for more information. The Btrfs sysadmin page also has a section with some more technical background.
The Btrfs Wiki Glossary says that Btrfs scrub is “[a]n online filesystem checking tool. Reads all the data and metadata on the filesystem, and uses checksums and the duplicate copies from RAID storage to identify and repair any corrupt data.”
To start a (background) scrub on the filesystem which contains / :
To check the status of a running scrub:
Start with a service or timer
The btrfs-progs package brings the btrfs-scrub@.timer unit for monthly scrubbing the specified mountpoint. Enable the timer with an escaped path, e.g. btrfs-scrub@-.timer for / and email@example.com for /home . You can use systemd-escape -p /path/to/mountpoint to escape the path, see systemd-escape(1) for details.
You can also run the scrub by starting btrfs-scrub@.service (with the same encoded path). The advantage of this over btrfs scrub (as the root user) is that the results of the scrub will be logged in the systemd journal.
“A balance passes all data in the filesystem through the allocator again. It is primarily intended to rebalance the data in the filesystem across the devices when a device is added or removed. A balance will regenerate missing copies for the redundant RAID levels, if a device has failed.”  See Upstream FAQ page.
On a single-device filesystem a balance may be also useful for (temporarily) reducing the amount of allocated but unused (meta)data chunks. Sometimes this is needed for fixing “filesystem full” issues.
“A snapshot is simply a subvolume that shares its data (and metadata) with some other subvolume, using btrfs’s COW capabilities.” See Btrfs Wiki SysadminGuide#Snapshots for details.
To create a snapshot:
To create a readonly snapshot add the -r flag. To create writable version of a readonly snapshot, simply create a snapshot of it.
A subvolume can be sent to stdout or a file using the send command. This is usually most useful when piped to a Btrfs receive command. For example, to send a snapshot named /root_backup (perhaps of a snapshot you made of / earlier) to /backup you would do the following:
The snapshot that is sent must be readonly. The above command is useful for copying a subvolume to an external device (e.g. a USB disk mounted at /backup above).
You can also send only the difference between two snapshots. For example, if you have already sent a copy of root_backup above and have made a new readonly snapshot on your system named root_backup_new , then to send only the incremental difference to /backup do:
Now a new subvolume named root_backup_new will be present in /backup .
See Btrfs Wiki’s Incremental Backup page on how to use this for incremental backups and for tools that automate the process.
Using copy-on-write, Btrfs is able to copy files or whole subvolumes without actually copying the data. However whenever a file is altered a new proper copy is created. Deduplication takes this a step further, by actively identifying blocks of data which share common sequences and combining them into an extent with the same copy-on-write semantics.
Tools dedicated to deduplicate a Btrfs formatted partition include duperemove , bedup AUR and btrfs-dedup. One may also want to merely deduplicate data on a file based level instead using e.g. rmlint , jdupes AUR or dduper-git AUR . For an overview of available features of those programs and additional information have a look at the upstream Wiki entry.
Furthermore Btrfs developers are working on inband (also known as synchronous or inline) deduplication, meaning deduplication done when writing new data to the filesystem. Currently it is still an experiment which is developed out-of-tree. Users willing to test the new feature should read the appropriate kernel wiki page.
A few limitations should be known before trying.
Btrfs has no built-in encryption support, but this may come in the future. Users can encrypt the partition before running mkfs.btrfs . See dm-crypt/Encrypting an entire system#Btrfs subvolumes with swap.
Existing Btrfs file systems can use something like EncFS or TrueCrypt, though perhaps without some of Btrfs’ features.
Using TLP requires special precautions in order to avoid filesystem corruption. Refer to the according TLP section for more information.
btrfs check issues
The tool btrfs check has known issues and should not be run without further reading, see section #btrfs check.
Tips and tricks
Partitionless Btrfs disk
Btrfs can occupy an entire data storage device, replacing the MBR or GPT partitioning schemes, using subvolumes to simulate partitions. However, using a partitionless setup is not required to simply create a Btrfs filesystem on an existing partition that was created using another method. There are some limitations to partitionless single disk setups:
- Cannot place other file systems on another partition on the same disk.
- If using a Linux kernel version before 5.0, you cannot use swap area as Btrfs did not support swap files pre-5.0 and there is no place to create swap partition
- Cannot use UEFI to boot.
To overwrite the existing partition table with Btrfs, run the following command:
For example, use /dev/sda rather than /dev/sda1 . The latter would format an existing partition instead of replacing the entire partitioning scheme. Because the root partition is Btrfs, make sure btrfs is compiled into the kernel, or put btrfs into mkinitcpio.conf#MODULES and regenerate the initramfs.
Install the boot loader like you would for a data storage device with a Master Boot Record. See Syslinux#Manual install or GRUB/Tips and tricks#Install to partition or partitionless disk. If your kernel does not boot due to Failed to mount /sysroot. , please add GRUB_PRELOAD_MODULES=”btrfs” in /etc/default/grub and generate the grub configuration (GRUB#Generate the main configuration file).
Ext3/4 to Btrfs conversion
Boot from an install CD, then convert by doing:
Mount the partion and test the conversion by checking the files. Be sure to change the /etc/fstab to reflect the change (type to btrfs and fs_passno [the last field] to 0 as Btrfs does not do a file system check on boot). Also note that the UUID of the partition will have changed, so update fstab accordingly when using UUIDs. chroot into the system and rebuild the GRUB menu list (see Install from existing Linux and GRUB articles). If converting a root filesystem, while still chrooted run mkinitcpio -p linux to regenerate the initramfs or the system will not successfully boot. If you get stuck in grub with ‘unknown filesystem’ try reinstalling grub with grub-install /dev/partition and regenerate the config as well grub-mkconfig -o /boot/grub/grub.cfg .
After confirming that there are no problems, complete the conversion by deleting the backup ext2_saved sub-volume. Note that you cannot revert back to ext3/4 without it.
Finally balance the file system to reclaim the space.
Remember that some applications which were installed prior have to be adapted to Btrfs. Notably TLP#Btrfs needs special care to avoid filesystem corruption but other applications may profit from certain features as well.
Checksum hardware acceleration
CRC32 is a new instruction in Intel SSE4.2. To verify if Btrfs checksum is hardware accelerated:
If you see crc32c=crc32c-generic , it is probably because your root partition is Btrfs, and you will have to compile crc32c-intel into the kernel to make it work. Putting crc32c-intel into mkinitcpio.conf does not work.
btrfs-check cannot be used on a mounted file system. To be able to use btrfs-check without booting from a live USB, add it to the initial ramdisk:
Then if there is a problem booting, the utility is available for repair.
See the Btrfs Wiki page for more information.
Booting into snapshots
In order to boot into a snapshot, the same procedure applies as for mounting a subvolume as your root parition, as given in section mounting a subvolume as your root partition, because snapshots can be mounted like subvolumes. If using GRUB you can automatically populate your boot menu with btrfs snapshots when regenerating the configuration file with the help of grub-btrfs or grub-btrfs-git AUR .
Use Btrfs subvolumes with systemd-nspawn
See the Btrfs Problem FAQ for general troubleshooting.
The offset problem may happen when you try to embed core.img into a partitioned disk. It means that it is OK to embed grub’s core.img into a Btrfs pool on a partitionless disk (e.g. /dev/sdX ) directly.
GRUB can boot Btrfs partitions, however the module may be larger than other file systems. And the core.img file made by grub-install may not fit in the first 63 sectors (31.5KiB) of the drive between the MBR and the first partition. Up-to-date partitioning tools such as fdisk and gdisk avoid this issue by offsetting the first partition by roughly 1MiB or 2MiB.
The factual accuracy of this article or section is disputed.
Users experiencing the following: error no such device: root when booting from a RAID style setup then edit /usr/share/grub/grub-mkconfig_lib and remove both quotes from the line echo ” search –no-floppy –fs-uuid –set=root $
BTRFS: open_ctree failed
As of November 2014 there seems to be a bug in systemd or mkinitcpio causing the following error on systems with multi-device Btrfs filesystem using the btrfs hook in mkinitcpio.conf :
A workaround is to remove btrfs from the HOOKS array in /etc/mkinitcpio.conf and instead add btrfs to the MODULES array. Then regenerate the initramfs and reboot.
You will get the same error if you try to mount a raid array without one of the devices. In that case you must add the degraded mount option to /etc/fstab . If your root resides on the array, you must also add rootflags=degraded to your kernel parameters.
As of August 2016, a potential workaround for this bug is to mount the array by a single drive only in /etc/fstab , and allow btrfs to discover and append the other drives automatically. Group-based identifiers such as UUID and LABEL appear to contribute to the failure. For example, a two-device RAID1 array consisting of ‘disk1′ and disk2’ will have a UUID allocated to it, but instead of using the UUID, use only /dev/mapper/disk1 in /etc/fstab . For a more detailed explanation, see the following blog post [dead link 2020-05-24 ⓘ] .
Another possible workaround is to remove the udev hook in mkinitcpio.conf and replace it with the systemd hook. In this case, btrfs should not be in the HOOKS or MODULES arrays.
See the original forums thread and FS#42884 for further information and discussion.
The btrfs check command can be used to check or repair an unmounted Btrfs filesystem. However, this repair tool is still immature and not able to repair certain filesystem errors even those that do not render the filesystem unmountable.