Main Page

From btrfs Wiki
(Difference between revisions)
Jump to: navigation, search
(Using the built-in tools: add links to new man pages)
(Using the built-in tools: add new manpages, remove links to the obsolete)
Line 136: Line 136:
 
=== Using the built-in tools ===
 
=== Using the built-in tools ===
  
* Manual pages generated from git (incomplete)
+
* Manual pages generated from git ([[:Category:Manpage|complete list]]):
 
** [[Manpage/btrfs|btrfs]] — main administration tool
 
** [[Manpage/btrfs|btrfs]] — main administration tool
** [[Manpage/mkfs.btrfs|mkfs.btrfs]]
+
** [[Manpage/mkfs.btrfs|mkfs.btrfs]] — creating the filesystem
** [[Manpage/fsck.btrfs|fsck.btrfs]]
+
** [[Manpage/btrfs-check|btrfs check]] — repairing file systems
** [[Manpage/btrfs-check|btrfs check]]
+
** [[Manpage/btrfs-convert|btrfs-convert]] — tool to convert in-place from ext2/3/4 filesystems to btrfs. For a greater detail of how the algorithm works, please see the [[Conversion from Ext3]] page.
  
 
* Original wiki documenation (obsolete, will be removed)
 
* Original wiki documenation (obsolete, will be removed)
** [[Btrfs(command)|btrfs]] — main administration tool
 
** [[Mkfs.btrfs|mkfs.btrfs]] — creating the filesystem
 
** [[Btrfsck|btrfsck]] — repairing file systems
 
 
** [[Restore|restore and find-root]] — utilities to find and restore data from an unmountable filesystem
 
** [[Restore|restore and find-root]] — utilities to find and restore data from an unmountable filesystem
** [[Btrfs-convert|btrfs-convert]] — tool to convert in-place from ext2/3/4 filesystems to btrfs
 
  
 
=== Developer documentation ===
 
=== Developer documentation ===

Revision as of 23:08, 3 July 2014

Btrfs is a new copy on write (CoW) filesystem for Linux aimed at implementing advanced features while 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. 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 page.

Contents

Stability status

The filesystem disk format is no longer unstable, and it's not expected to change unless there are strong reasons to do so. If there is a format change, file systems with a unchanged format will continue to be mountable and usable by newer kernels.

The Btrfs code base is under heavy development. Every effort is being made to keep it stable and fast. Due to the fast development speed, the state of development of the filesystem improves noticeably with every new Linux version, so it's recommended to run the most modern kernel possible.

For benchmarks, it's recommended to test the latest stable Linux version, and not any older. If possible, it's also recommendable to test the latest Linux development version. Also, it's recommended to test the different options, f.e. different compression options.

If you have any bug, problems, performance issues or questions while using Btrfs, please email the Btrfs mailing list (no subscription required). Please report bugs also on Bugzilla.

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.

The main Btrfs features available at the moment include:

  • Extent based file storage
  • 2^64 byte == 16 EiB maximum file size
  • 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)
  • Compression (zlib and LZO)
  • Integrated multiple device support
    • File Striping, File Mirroring, File Striping+Mirroring, Striping with Single and Dual Parity implementations
  • 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 fixing errors on files with redundant copies
  • Online filesystem defragmentation
  • Offline filesystem check
  • Conversion of existing ext3/4 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)

Additional features in development, or planned, include:

  • Very fast offline filesystem check
  • Object-level mirroring and striping
  • Alternative checksum algorithms
  • Online filesystem check
  • Other compression methods (snappy, LZ4)
  • Hot data tracking and moving to faster devices (currently being pushed as a generic feature available through VFS)
  • In-band deduplication (happens during writes)

Roadmap

See also the Roadmap for a list of what features the main developers are currently working on.

News

Linux v3.16 (highlights or user visible changes)

  • O_TMPFILE support [1]
  • reworked qgroup accounting, to fix negative numbers after subvol deletion
  • SEARCH_TREE ioctl v2, extended for retrieving more data [2]
  • new balance filter limit for more finegrained balancing [3]
  • ioctl FS_INFO and it's sysfs counterpart export information about nodesize, sectorsize and clone_alignment
  • snapshots are protected during send

Linux v3.15 (Jun 2014)

  • pile of send fixes (stability, speed)
  • worker threads now use kernel workqueues

btrfs-progs 3.14.2 (May 2014)

  • documentation is now written in asciidoc and there are manpages for each subcommand
  • misc bugfixes

Read about past releases in the Changelog

Articles, presentations, podcasts

Documentation

Guides and usage information

External Btrfs Documentation / Guides

Links to Btrfs documentation of various Linux distributions:

Project information/Contact

Using the built-in tools

  • Original wiki documenation (obsolete, will be removed)

Developer documentation

  • Code documentation — trees, source files, sample code for manipulating trees
  • Data Structures — detailed on-disk data structures
  • Trees — detailed in-tree representation of files and directories

Source code download

Benchmarking

Historical resources

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

Articles, presentations, podcasts

Benchmarks

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.
Personal tools