Main Page

From btrfs Wiki
(Difference between revisions)
Jump to: navigation, search
(Articles, presentations, podcasts: Add Josef Bacik's excellent talk)
(News: progs 5.11)
 
(19 intermediate revisions by 5 users not shown)
Line 1: Line 1:
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 [[Contributors|multiple companies]], Btrfs is licensed under the GPL and open for contribution from anyone.
+
__NOTOC__
Not too many companies have said that they are using Btrfs in production, but we welcome those who can say so on the [[Production_Users|production users]] page.
+
<!-- Welcome Block -->
 +
<div style="margin:0; margin-top:10px; margin-right:10px; border:1px solid #dfdfdf; padding:0 1em 1em 1em; align:right; ">
 +
[[File:Btrfs_logo_small.png|200px|left|btrfs]]
  
== Stability status ==
+
'''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. Its main features and benefits are:
  
'''For feature status and stability, please refer to the [[Status]] page.''' The filesystem [[On-disk_Format|disk format]] is stable; this means that it is not expected to change unless there are very strong reasons to do so. If there is a format change, filesystems which implement the previous disk format will continue to be mountable and usable by newer kernels.
+
* '''Snapshots''' which do not make the full copy of files
 +
* '''RAID''' - support for software-based RAID 0, RAID 1, RAID 10
 +
* '''Self-healing''' - checksums for data and metadata, automatic detection of silent data corruptions
  
The Btrfs code base is under heavy development. Not only is every effort being made to ensure that it remains stable and fast but to make it more so with each and every commit. This rapid pace of development means that the filesystem improves ''noticeably'' with every new Linux release so it's ''highly'' recommended that users run the most modern kernel possible.
+
Development of Btrfs started in 2007. Since that time, Btrfs is a part of the Linux kernel and is under active development.
  
For benchmarks, it's recommended to test the latest stable Linux version, and not any older, as well as the latest Linux development versions. Also, it's recommended to test the various [[Manpage/btrfs(5)#MOUNT_OPTIONS|mount options]] such as different compression options.
+
Jointly developed at [[Contributors|multiple companies]], Btrfs is licensed under the GPL and open for contribution from anyone.
  
As with all software, newly added features may need a few releases to stabilize.
+
[[Production_Users|List of companies using btrfs in production]].
 +
</div>
 +
 
 +
{| width="100%"
 +
|-
 +
|style="vertical-align:top" |
 +
 
 +
<!-- Development and Issue Reporting Block -->
 +
<div style="margin:0; margin-top:10px; margin-right:10px; border:1px solid #dfdfdf; padding:0 1em 1em 1em; background-color:#dcf5ff; align:right;">
 +
== Development and Issue Reporting ==
 +
 
 +
'''For feature status, please refer to the [[Status]] page.'''
 +
 
 +
The Btrfs code base is stable. However, new features are still under development. Every effort is made to ensure that it remains stable and fast at each and every commit. This rapid pace of development means that the filesystem improves ''noticeably'' with every new Linux release so it's ''highly'' recommended that users run the most modern kernel possible.
 +
 
 +
For benchmarks, it's recommended to test the latest stable Linux version, and not any older, as well as the latest Linux development versions. Also, it's recommended to test the various [[Manpage/btrfs(5)#MOUNT_OPTIONS|mount options]] such as different [[compression]] options.
  
 
If you find any behavior you suspect to be caused by a bug, performance issues, or have any questions about using Btrfs, please email the [[Btrfs mailing list]] (no subscription required). Please report bugs on [[Problem_FAQ#How_do_I_report_bugs_and_issues.3F|Bugzilla]].
 
If you find any behavior you suspect to be caused by a bug, performance issues, or have any questions about using Btrfs, please email the [[Btrfs mailing list]] (no subscription required). Please report bugs on [[Problem_FAQ#How_do_I_report_bugs_and_issues.3F|Bugzilla]].
 +
</div>
  
 +
<!-- Features Block -->
 +
<div style="margin:0; margin-top:10px; margin-right:10px; border:1px solid #dfdfdf; padding:0 1em 1em 1em; background-color:#F8F8FF; align:right;">
 
== Features ==
 
== Features ==
  
Line 57: Line 79:
 
* DAX/persistent memory support
 
* DAX/persistent memory support
 
* The file/directory -level encryption support (fscrypt)
 
* The file/directory -level encryption support (fscrypt)
 +
</div>
  
== News ==
+
<!-- Documentation Block -->
 
+
<div style="margin:0; margin-top:10px; margin-right:10px; border:1px solid #dfdfdf; padding:0 1em 1em 1em; background-color:#fffff0; align:right; ">
''' linux v5.8 (Aug 2020) '''
+
* Hilights:
+
** speedup dead root detection during orphan cleanup
+
** send will emit file capabilities after chown
+
* Core changes:
+
** improved global block reserve utilization
+
** direct io cleanups and fixes
+
** refactored block group reading code
+
** lots of other core changes see the [https://git.kernel.org/linus/f3cdc8ae116e27d84e1f33c7a2995960cebb73ac pull request]
+
 
+
''' btrfs-progs v5.7 (Jul 2020) '''
+
* mkfs:
+
** new option to enable features otherwise enabled at runtime, now implemented for quotas, 'mkfs.btrfs -R quota'
+
** fix space accounting for small image, DUP and --rootdir
+
** option -A removed
+
* check: detect ranges with overlapping csum items
+
* fi usage: report correct numbers when plain RAID56 profiles are used
+
* convert: ensure the data chunks size never exceed device size
+
* libbtrfsutil: update documentation regarding subvolume deletion
+
* build: support libkcapi as implementation backend for cryptographic primitives
+
* core: global options for verbosity (-v, -q), subcommands -v or -q are aliases and will continue to work but are considered deprecated, current command output is preserved to keep scripts working
+
* other:
+
** block group code cleanups
+
** build warning fixes
+
** more files moved to kernel-shared
+
** btrfs-debugfs ported to python 3
+
** documentation updates
+
** new tests
+
 
+
== Changelog ==
+
 
+
Read about past releases in the separate [[Changelog]] page
+
 
+
* [[Changelog#By_feature|features by kernel version]]
+
* [[Changelog#By_version_.28linux_kernel.29|kernel changes for each release]]
+
* [[Changelog#By_version_.28btrfs-progs.29|btrfs-progs changes for each release]]
+
 
+
 
== Documentation ==
 
== Documentation ==
  
Line 117: Line 103:
 
* "[https://docs.oracle.com/cd/E37670_01/E37355/html/ol_btrfs.html The Btrfs File System]" chapter in the [https://docs.oracle.com/cd/E37670_01/E37355/html/index.html Oracle Linux 6 Administrator's Solutions Guide]
 
* "[https://docs.oracle.com/cd/E37670_01/E37355/html/ol_btrfs.html The Btrfs File System]" chapter in the [https://docs.oracle.com/cd/E37670_01/E37355/html/index.html Oracle Linux 6 Administrator's Solutions Guide]
 
* Oracle Linux [https://wikis.oracle.com/display/oraclelinux/Hands-on+lab+-+Storage+Management+with+Btrfs Hands-on lab - Storage Management with Btrfs]
 
* Oracle Linux [https://wikis.oracle.com/display/oraclelinux/Hands-on+lab+-+Storage+Management+with+Btrfs Hands-on lab - Storage Management with Btrfs]
* [https://www.suse.com/documentation/sles11/stor_admin/data/sec_filesystems_major.html Major File Systems in Linux] chapter in the [https://www.suse.com/documentation/sles11/stor_admin/data/bookinfo.html SLES 11 Storage Administration Guide]
+
* [https://documentation.suse.com/sles/15-GA/single-html/SLES-storage/#sec-filesystems-major-btrfs Major File Systems in Linux] chapter in the [https://documentation.suse.com/en-us/sles/15-GA/single-html/SLES-storage/ SLES 15 Storage Administration Guide]
 
* [https://access.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Storage_Administration_Guide/ch-btrfs.html Btrfs] chapter in the [https://access.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Storage_Administration_Guide/ Red Hat Enterprise Linux 6 Storage Administration Guide]
 
* [https://access.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Storage_Administration_Guide/ch-btrfs.html Btrfs] chapter in the [https://access.redhat.com/site/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Storage_Administration_Guide/ Red Hat Enterprise Linux 6 Storage Administration Guide]
 
* [https://help.ubuntu.com/community/btrfs Btrfs Wiki page] on the [https://help.ubuntu.com/community Ubuntu Community Help Wiki]
 
* [https://help.ubuntu.com/community/btrfs Btrfs Wiki page] on the [https://help.ubuntu.com/community Ubuntu Community Help Wiki]
Line 123: Line 109:
 
* [http://www.funtoo.org/BTRFS_Fun BTRFS Fun Wiki page] on the [http://www.funtoo.org/ Funtoo Wiki]
 
* [http://www.funtoo.org/BTRFS_Fun BTRFS Fun Wiki page] on the [http://www.funtoo.org/ Funtoo Wiki]
 
* [http://marc.merlins.org/perso/btrfs/post_2014-05-21_My-Btrfs-Talk-at-Linuxcon-JP-2014.html Marc MERLIN's Btrfs talk at Linuxcon JP 2014] which gives an overview of Btrfs, best practices, and its more interesting features.
 
* [http://marc.merlins.org/perso/btrfs/post_2014-05-21_My-Btrfs-Talk-at-Linuxcon-JP-2014.html Marc MERLIN's Btrfs talk at Linuxcon JP 2014] which gives an overview of Btrfs, best practices, and its more interesting features.
 
=== Project information/Contact ===
 
 
* [[Changelog]] — history of changes in linux kernel wrt btrfs
 
** [[Changelog#By_feature | features added by release]]
 
* [[Contributors#Statistics_for_5.x_series|Development statistics]] — contributors, commits, lines
 
* [[Glossary]]
 
* Contact information:
 
** [[Btrfs mailing list]]
 
** [http://en.wikipedia.org/wiki/Internet_Relay_Chat IRC] on freenode.net in the channel [irc://irc.freenode.net:6667/btrfs #btrfs]
 
** Reporting bugs:
 
*** for kernel code see [[Problem_FAQ#How_do_I_report_bugs_and_issues.3F | the Bugzilla FAQ]], quick tip: use product ''File System'' and component ''btrfs''.
 
*** for btrfs-progs it's either bugzilla or [https://github.com/kdave/btrfs-progs/issues/ github issues]
 
*** for read-only documentation exported on wiki eg. manual pages as [https://github.com/kdave/btrfs-progs/issues/ github issues]
 
* [[Project ideas]]
 
* [[Project_ideas#Cleanup_projects|Cleanup ideas]]
 
* [[Project_ideas#Userspace_tools_projects|Userspace tools projects]]
 
  
 
=== Manual pages ===
 
=== Manual pages ===
Line 154: Line 123:
 
=== Developer documentation ===
 
=== Developer documentation ===
  
 +
* [[Development setup]] - how to build btrfs from sources and prepare a development environment
 +
 +
* [https://github.com/btrfs/btrfs-dev-docs Developer documentation on Github] - collection of documents describing internals of BTRFS
 
* [[Developer's FAQ]] — hints and answers for contributors and developers, general information about patch formatting
 
* [[Developer's FAQ]] — hints and answers for contributors and developers, general information about patch formatting
 
* [[Development notes]] — notes, hints, checklists for specific implementation tasks (eg. adding new ioctls)
 
* [[Development notes]] — notes, hints, checklists for specific implementation tasks (eg. adding new ioctls)
 
* [[Code documentation]] — trees, source files, sample code for manipulating trees
 
* [[Code documentation]] — trees, source files, sample code for manipulating trees
 
* [[Data Structures]] — detailed on-disk data structures
 
* [[Data Structures]] — detailed on-disk data structures
 +
* [[On-disk_Format | On-disk Format]] - Details of data structures written on disk
 
* [[Trees]] — detailed in-tree representation of files and directories
 
* [[Trees]] — detailed in-tree representation of files and directories
  
Line 176: Line 149:
 
** In-band (write) time deduplication
 
** In-band (write) time deduplication
 
*** [[User notes on dedupe]] — User/tester notes for using in-band deduplication feature
 
*** [[User notes on dedupe]] — User/tester notes for using in-band deduplication feature
 +
</div>
  
==== Source code download ====
+
| width="50%" style="vertical-align:top" |
 +
 
 +
<!-- News Block -->
 +
<div style="margin:0; margin-top:10px; border:1px solid #dfdfdf; padding: 0em 1em 1em 1em; background-color:#f0e0d0; align:left;">
 +
== News ==
 +
 
 +
''' btrfs-progs v5.11 (Mar 2021) '''
 +
 
 +
* fix device path canonicalization for device mapper devices
 +
* receive: remove workaround for setting capabilities, all stable kernels have been patched
 +
* receive: fix duplicate mount path detection
 +
* rescue: new subcommand create-control-device
 +
* device stats: minor fix for plain text format output
 +
* build: detect if e2fsprogs support 64bit timestamps
 +
* build: drop libmount, required functionality has been reimplemented
 +
* mkfs: warn when raid56 is used
 +
* balance convert: warn when raid56 is used
 +
* other
 +
** new and updated tests
 +
** documentation updates: seeding device, raid56 status
 +
** CI updates: docker images for various distros
 +
 
 +
''' linux v5.11 (Feb 2020) '''
 +
 
 +
* new mount option ''rescue'', various modes how to access a damaged filesystem
 +
* sysfs updates: filesystem generation, supported ''rescue'' modes, read mirror policy
 +
* removed feature: ''mount -o inode_cache''
 +
* free space tree fixes, v1 cache removed during conversion
 +
* core
 +
** locking switched to standard rw semaphores
 +
** direct IO ported to iomap infrastructure
 +
** zoned allocation mode preparation
 +
** subpage blocksize preparation
 +
** various performance improvements (skipping unnecessary work)
 +
 
 +
</div>
 +
 
 +
<!-- Changelog Block -->
 +
<div style="margin:0; margin-top:10px; border:1px solid #dfdfdf; padding: 0em 1em 1em 1em; background-color:#dfefdf; align:left; margin-top:10px">
 +
 
 +
== Changelog ==
 +
 
 +
Read about past releases in the separate [[Changelog]] page
 +
 
 +
* [[Changelog#By_feature|features by kernel version]]
 +
* [[Changelog#By_version_.28linux_kernel.29|kernel changes for each release]]
 +
* [[Changelog#By_version_.28btrfs-progs.29|btrfs-progs changes for each release]]
 +
</div>
 +
 
 +
<!-- Source code Block -->
 +
<div style="margin:0; margin-top:10px; border:1px solid #dfdfdf; padding: 0em 1em 1em 1em; background-color:#dfefdf; align:left; margin-top:10px">
 +
== Source code download ==
  
 
[[Btrfs source repositories]] describes purpose and contents, here are a few quick links:
 
[[Btrfs source repositories]] describes purpose and contents, here are a few quick links:
Line 183: Line 208:
 
* repository for kernel pull requests: git://git.kernel.org/pub/scm/linux/kernel/git/kdave/linux.git ([https://git.kernel.org/pub/scm/linux/kernel/git/kdave/linux.git gitweb])
 
* repository for kernel pull requests: git://git.kernel.org/pub/scm/linux/kernel/git/kdave/linux.git ([https://git.kernel.org/pub/scm/linux/kernel/git/kdave/linux.git gitweb])
 
* kernel development repository: git://github.com/kdave/btrfs-devel.git ([https://github.com/kdave/btrfs-devel.git web access])
 
* kernel development repository: git://github.com/kdave/btrfs-devel.git ([https://github.com/kdave/btrfs-devel.git web access])
* kernel development repository (mirror): git://gitlabs.com/kdave/btrfs-devel.git ([https://gitlab.com/kdave/btrfs-devel.git web access])
+
* kernel development repository (mirror): git://gitlab.com/kdave/btrfs-devel.git ([https://gitlab.com/kdave/btrfs-devel.git web access])
 
* btrfs-progs development and release repository: git://github.com/kdave/btrfs-progs.git ([https://github.com/kdave/btrfs-progs.git web access])
 
* btrfs-progs development and release repository: git://github.com/kdave/btrfs-progs.git ([https://github.com/kdave/btrfs-progs.git web access])
 
* released tarballs of btrfs-progs: https://mirrors.edge.kernel.org/pub/linux/kernel/people/kdave/btrfs-progs/
 
* released tarballs of btrfs-progs: https://mirrors.edge.kernel.org/pub/linux/kernel/people/kdave/btrfs-progs/
 +
</div>
  
=== Wiki accounts, editing ===
+
<!-- Articles Block -->
 
+
<div style="margin:0; margin-top:10px; border:1px solid #dfdfdf; padding: 0em 1em 1em 1em; background-color:#dfefdf; align:left; margin-top:10px">
The wiki contributions are welcome! Please create an account and wait for approval (this is a necessary spam protection and we cannot remove it). You can try to catch some of the wiki admins on [[#Project_information.2FContact|IRC]] (or ping user 'kdave' in a query) to expedite the account creation.
+
 
+
The registration requires full name for account but it's not mandatory from our perspective. The wiki User and User talk pages are created automatically but removed after account is approved. If you want to use the pages, create them manually, they won't be deleted.
+
 
+
 
== Articles, presentations, podcasts ==
 
== Articles, presentations, podcasts ==
 
* '''Video:''' [https://www.youtube.com/watch?v=U7gXR2L05IU Deploying Btrfs at Facebook Scale] by Josef Bacik at the Open Source Summit 2020 (2020-06-29)
 
* '''Video:''' [https://www.youtube.com/watch?v=U7gXR2L05IU Deploying Btrfs at Facebook Scale] by Josef Bacik at the Open Source Summit 2020 (2020-06-29)
Line 207: Line 229:
 
* '''Technical report:''' [http://domino.watson.ibm.com/library/cyberdig.nsf/1e4115aea78b6e7c85256b360066f0d4/9e29fdded06e5de785257c1d005e7e9e!OpenDocument Visualizating Block IO Workloads]. Section six shows a visual comparison of the IO patterns for BTRFS, XFS, and EXT4. Submitted to ACM Transactions on Storage, November 2013.
 
* '''Technical report:''' [http://domino.watson.ibm.com/library/cyberdig.nsf/1e4115aea78b6e7c85256b360066f0d4/9e29fdded06e5de785257c1d005e7e9e!OpenDocument Visualizating Block IO Workloads]. Section six shows a visual comparison of the IO patterns for BTRFS, XFS, and EXT4. Submitted to ACM Transactions on Storage, November 2013.
 
* '''Paper:''' [http://dl.acm.org/citation.cfm?id=2501623 BTRFS: The Linux B-Tree Filesystem] describing the overall concepts and architecture, appeared in ACM Transactions on Storage, August 2013. Includes a detailed comparison with ZFS. There is a free ACM authorized link, from O. Rodeh's [https://sites.google.com/site/ohadrodehshomepage/research] page. Otherwise, try [http://domino.research.ibm.com/library/cyberdig.nsf/papers/6E1C5B6A1B6EDD9885257A38006B6130/$File/rj10501.pdf IBM Research link]
 
* '''Paper:''' [http://dl.acm.org/citation.cfm?id=2501623 BTRFS: The Linux B-Tree Filesystem] describing the overall concepts and architecture, appeared in ACM Transactions on Storage, August 2013. Includes a detailed comparison with ZFS. There is a free ACM authorized link, from O. Rodeh's [https://sites.google.com/site/ohadrodehshomepage/research] page. Otherwise, try [http://domino.research.ibm.com/library/cyberdig.nsf/papers/6E1C5B6A1B6EDD9885257A38006B6130/$File/rj10501.pdf IBM Research link]
 +
</div>
  
<!--
+
<!-- Historical Block -->
== Benchmarking ==
+
<div style="margin:0; margin-top:10px; border:1px solid #dfdfdf; padding: 0em 1em 1em 1em; background-color:#dfefdf; align:left; margin-top:10px">
-->
+
 
+
 
== Historical resources ==
 
== Historical resources ==
  
Line 230: Line 251:
 
* '''Webcast:''' [https://event.on24.com/eventRegistration/EventLobbyServlet?target=registration.jsp&eventid=233161&sessionid=1&key=D0B1D3285FA444C5745C344A1C859CE0&partnerref=banner&sourcepage=register State of "Btrfs" File System for Linux by Chris Mason] (2010-08-26) [email registration and flash required]
 
* '''Webcast:''' [https://event.on24.com/eventRegistration/EventLobbyServlet?target=registration.jsp&eventid=233161&sessionid=1&key=D0B1D3285FA444C5745C344A1C859CE0&partnerref=banner&sourcepage=register State of "Btrfs" File System for Linux by Chris Mason] (2010-08-26) [email registration and flash required]
 
* '''Article:''' [http://lwn.net/Articles/342892/ Valerie Aurora: A short history of btrfs] (2009-07-22)
 
* '''Article:''' [http://lwn.net/Articles/342892/ Valerie Aurora: A short history of btrfs] (2009-07-22)
 +
</div>
 +
 +
<!-- Project Block -->
 +
<div style="margin:0; margin-top:10px; border:1px solid #dfdfdf; padding: 0em 1em 1em 1em; background-color:#dfefdf; align:left; margin-top:10px">
 +
== Project information/Contact ==
 +
 +
* [[Changelog]] — history of changes in linux kernel wrt btrfs
 +
** [[Changelog#By_feature | features added by release]]
 +
* [[Contributors#Statistics_for_5.x_series|Development statistics]] — contributors, commits, lines
 +
* [[Glossary]]
 +
* Contact information:
 +
** [[Btrfs mailing list]]
 +
** [http://en.wikipedia.org/wiki/Internet_Relay_Chat IRC] on freenode.net in the channel [irc://irc.freenode.net:6667/btrfs #btrfs]
 +
** Reporting bugs:
 +
*** for kernel code see [[Problem_FAQ#How_do_I_report_bugs_and_issues.3F | the Bugzilla FAQ]], quick tip: use product ''File System'' and component ''btrfs''.
 +
*** for btrfs-progs it's either bugzilla or [https://github.com/kdave/btrfs-progs/issues/ github issues]
 +
*** for read-only documentation exported on wiki eg. manual pages as [https://github.com/kdave/btrfs-progs/issues/ github issues]
 +
* [[Project ideas]]
 +
* [[Project_ideas#Cleanup_projects|Cleanup ideas]]
 +
* [[Project_ideas#Userspace_tools_projects|Userspace tools projects]]
 +
</div>
 +
 +
<!-- Wiki Block -->
 +
<div style="margin:0; margin-top:10px; border:1px solid #dfdfdf; padding: 0em 1em 1em 1em; background-color:#dfefdf; align:left; margin-top:10px">
 +
== Wiki accounts, editing ==
 +
 +
The wiki contributions are welcome! Please create an account and wait for approval (this is a necessary spam protection and we cannot remove it). You can try to catch some of the wiki admins on [[#Project_information.2FContact|IRC]] (or ping user 'kdave' in a query) to expedite the account creation.
 +
 +
The registration requires full name for account but it's not mandatory from our perspective. The wiki User and User talk pages are created automatically but removed after account is approved. If you want to use the pages, create them manually, they won't be deleted.
 +
</div>
 +
 +
|}

Latest revision as of 13:41, 5 March 2021

btrfs

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. Its main features and benefits are:

  • Snapshots which do not make the full copy of files
  • RAID - support for software-based RAID 0, RAID 1, RAID 10
  • Self-healing - checksums for data and metadata, automatic detection of silent data corruptions

Development of Btrfs started in 2007. Since that time, Btrfs is a part of the Linux kernel and is under active development.

Jointly developed at multiple companies, Btrfs is licensed under the GPL and open for contribution from anyone.

List of companies using btrfs in production.

[edit] Development and Issue Reporting

For feature status, please refer to the Status page.

The Btrfs code base is stable. However, new features are still under development. Every effort is made to ensure that it remains stable and fast at each and every commit. This rapid pace of development means that the filesystem improves noticeably with every new Linux release so it's highly recommended that users run the most modern kernel possible.

For benchmarks, it's recommended to test the latest stable Linux version, and not any older, as well as the latest Linux development versions. Also, it's recommended to test the various mount options such as different compression options.

If you find any behavior you suspect to be caused by a bug, performance issues, or have any questions about using Btrfs, please email the Btrfs mailing list (no subscription required). Please report bugs on Bugzilla.

[edit] Features

Linux has a wealth of filesystems from which to choose, but we are facing a number of challenges with scaling to the large storage subsystems that are becoming common in today's data centers. Filesystems need to scale in their ability to address and manage large storage, and also in their ability to detect, repair and tolerate errors in the data stored on disk.

[edit] Major Features Currently Implemented

  • Extent based file storage
  • 2^64 byte == 16 EiB maximum file size (practical limit is 8 EiB due to Linux VFS)
  • Space-efficient packing of small files
  • Space-efficient indexed directories
  • Dynamic inode allocation
  • Writable snapshots, read-only snapshots
  • Subvolumes (separate internal filesystem roots)
  • Checksums on data and metadata (crc32c, xxhash, sha256, blake2b)
  • Compression (ZLIB, LZO, ZSTD), heuristics
  • Integrated multiple device support
    • File Striping
    • File Mirroring
    • File Striping+Mirroring
    • Single and Dual Parity implementations (experimental, not production-ready)
  • SSD (flash storage) awareness (TRIM/Discard for reporting free blocks for reuse) and optimizations (e.g. avoiding unnecessary seek optimizations, sending writes in clusters, even if they are from unrelated files. This results in larger write operations and faster write throughput)
  • Efficient incremental backup
  • Background scrub process for finding and repairing errors of files with redundant copies
  • Online filesystem defragmentation
  • Offline filesystem check
  • In-place conversion of existing ext2/3/4 and reiserfs file systems
  • Seed devices. Create a (readonly) filesystem that acts as a template to seed other Btrfs filesystems. The original filesystem and devices are included as a readonly starting point for the new filesystem. Using copy on write, all modifications are stored on different devices; the original is unchanged.
  • Subvolume-aware quota support
  • Send/receive of subvolume changes
    • Efficient incremental filesystem mirroring
  • Batch, or out-of-band deduplication (happens after writes, not during)
  • Swapfile support
  • Tree-checker, post-read and pre-write metadata verification

[edit] Features by kernel version

As part of the changelog you can also review

[edit] Features Currently in Development or Planned for Future Implementation

  • SMR (zoned block device) support
  • DAX/persistent memory support
  • The file/directory -level encryption support (fscrypt)

[edit] Documentation

[edit] Guides and usage information

[edit] External Btrfs Documentation / Guides

Links to Btrfs documentation of various Linux distributions:

[edit] Manual pages

  • Original wiki documentation (obsolete, will be removed)

[edit] Developer documentation

  • Development setup - how to build btrfs from sources and prepare a development environment
  • Original COW B-tree: Source code in C that implements the COW B-tree algorithms repository. Written by Ohad Rodeh at IBM Research in 2006, and released under a BSD license. This is a reference implementation, that works in user space.
  • Unmerged features
    • In-band (write) time deduplication

[edit] News

btrfs-progs v5.11 (Mar 2021)

  • fix device path canonicalization for device mapper devices
  • receive: remove workaround for setting capabilities, all stable kernels have been patched
  • receive: fix duplicate mount path detection
  • rescue: new subcommand create-control-device
  • device stats: minor fix for plain text format output
  • build: detect if e2fsprogs support 64bit timestamps
  • build: drop libmount, required functionality has been reimplemented
  • mkfs: warn when raid56 is used
  • balance convert: warn when raid56 is used
  • other
    • new and updated tests
    • documentation updates: seeding device, raid56 status
    • CI updates: docker images for various distros

linux v5.11 (Feb 2020)

  • new mount option rescue, various modes how to access a damaged filesystem
  • sysfs updates: filesystem generation, supported rescue modes, read mirror policy
  • removed feature: mount -o inode_cache
  • free space tree fixes, v1 cache removed during conversion
  • core
    • locking switched to standard rw semaphores
    • direct IO ported to iomap infrastructure
    • zoned allocation mode preparation
    • subpage blocksize preparation
    • various performance improvements (skipping unnecessary work)

[edit] Source code download

Btrfs source repositories describes purpose and contents, here are a few quick links:

[edit] Articles, presentations, podcasts

[edit] Historical resources

Links to old or obsolete documentation, articles. Kept for historical reasons. Stuff that's more than 3 years old.

[edit] Articles, presentations, podcasts

[edit] Project information/Contact

[edit] Wiki accounts, editing

The wiki contributions are welcome! Please create an account and wait for approval (this is a necessary spam protection and we cannot remove it). You can try to catch some of the wiki admins on IRC (or ping user 'kdave' in a query) to expedite the account creation.

The registration requires full name for account but it's not mandatory from our perspective. The wiki User and User talk pages are created automatically but removed after account is approved. If you want to use the pages, create them manually, they won't be deleted.

Personal tools