Userspace utilities to manage btrfs filesystems
Go to file
Naohiro Aota bfd34b7876 btrfs-progs: zoned: redirty clean extent buffers
Tree manipulating operations like merging nodes often release
once-allocated tree nodes. Btrfs cleans such nodes so that pages in the
node are not uselessly written out. On ZONED drives, however, such
optimization blocks the following IOs as the cancellation of the write
out of the freed blocks breaks the sequential write sequence expected by
the device.

Check if next dirty extent buffer is continuous to a previously written
one. If not, it redirty extent buffers between the previous one and the
next one, so that all dirty buffers are written sequentially.

Signed-off-by: Naohiro Aota <naohiro.aota@wdc.com>
Signed-off-by: David Sterba <dsterba@suse.com>
2021-05-06 16:41:45 +02:00
Documentation btrfs-progs: docs: how to use swapfile from fstab 2021-05-06 16:41:44 +02:00
check btrfs-progs: pass in fs_info to btrfs_csum_data 2021-03-24 22:20:19 +01:00
ci btrfs-progs: ci: fix symlink paths of helper scripts 2021-03-15 14:59:42 +01:00
cmds btrfs-progs: zoned: implement log-structured superblock 2021-05-06 16:41:45 +02:00
common btrfs-progs: zoned: implement log-structured superblock 2021-05-06 16:41:45 +02:00
convert btrfs-progs: pass in fs_info to btrfs_csum_data 2021-03-24 22:20:19 +01:00
crypto btrfs-progs: crypto: remove unused sha256 definitions 2021-03-24 22:20:19 +01:00
image btrfs-progs: factor open_ctree parameters to a structure 2021-03-24 22:20:19 +01:00
kernel-lib btrfs-progs: a bunch of typo fixes 2021-01-13 22:33:10 +01:00
kernel-shared btrfs-progs: zoned: redirty clean extent buffers 2021-05-06 16:41:45 +02:00
libbtrfsutil libbtrfsutil: relicense to LGPLv2.1+ 2021-04-19 18:58:26 +02:00
m4 btrfs-progs: a bunch of typo fixes 2021-01-13 22:33:10 +01:00
mkfs btrfs-progs: utils: introduce queue_param helper function 2021-05-06 16:41:45 +02:00
tests btrfs-progs: tests: add missing variable setup to test-console 2021-03-24 22:20:19 +01:00
.editorconfig
.gitignore btrfs-progs: ci: add docker build and test scripts 2021-03-01 15:46:34 +01:00
.travis.yml Revert "btrfs-progs: build: add libmount dependency" 2021-02-19 15:24:42 +01:00
64-btrfs-dm.rules
Android.mk Revert "btrfs-progs: build: add libmount dependency" 2021-02-19 15:24:42 +01:00
CHANGES btrfs-progs: update CHANGES for 5.11.1 2021-03-24 19:34:03 +01:00
COPYING
INSTALL btrfs-progs: build: note about 32bit build on 64bit host 2021-03-24 22:20:19 +01:00
Makefile btrfs-progs: zoned: get zone information of zoned block devices 2021-05-06 16:41:45 +02:00
Makefile.extrawarn
Makefile.inc.in Revert "btrfs-progs: build: add libmount dependency" 2021-02-19 15:24:42 +01:00
README.md btrfs-progs: link nested README.md from the main one 2021-03-04 21:14:41 +01:00
VERSION Btrfs progs v5.11.1 2021-03-24 19:35:32 +01:00
androidcompat.h
autogen.sh
btrfs-completion btrfs-progs: rescue: add create-control-device subcommand 2021-02-19 16:19:37 +01:00
btrfs-corrupt-block.c
btrfs-crc.c
btrfs-debugfs
btrfs-find-root.c btrfs-progs: factor open_ctree parameters to a structure 2021-03-24 22:20:19 +01:00
btrfs-fragments.c
btrfs-list.c
btrfs-list.h
btrfs-map-logical.c
btrfs-sb-mod.c btrfs-progs: pass in fs_info to btrfs_csum_data 2021-03-24 22:20:19 +01:00
btrfs-select-super.c
btrfs.c btrfs-progs: sort main help menu entries 2020-12-10 17:10:30 +01:00
btrfsck.h
btrfstune.c
configure.ac btrfs-progs: build: check zoned block device support 2021-05-06 16:41:45 +02:00
fsck.btrfs
ioctl.h
kerncompat.h btrfs-progs: zoned: implement zoned chunk allocator 2021-05-06 16:41:45 +02:00
libbtrfs.sym
libbtrfsutil.sym
props.c
props.h
qgroup.c
qgroup.h
quick-test.c
random-test.c
repair.c
repair.h
send.h
show-blocks
version.h.in

README.md

Btrfs-progs build status coverity status

Userspace utilities to manage btrfs filesystems. License: GPLv2.

Btrfs is a copy on write (COW) filesystem for Linux aimed at implementing advanced features while focusing on fault tolerance, repair and easy administration.

This repository hosts following utilities:

  • btrfs — the main administration tool (manual page)
  • mkfs.btrfs — utility to create the filesystem (manual page)
  • all-in-one binary in the busybox style with mkfs.btrfs, btrfs-image and other tools built-in (standalone tools)

The C and python 3 bindings are provided by a LGPL library libbtrfsutil see libbtrfsutil/README.md for more.

See INSTALL for build instructions and tests/README.md for testing information.

Release cycle

The major version releases are time-based and follow the cycle of the linux kernel releases. The cycle usually takes 2 months. A minor version releases may happen in the meantime if there are bug fixes or minor useful improvements queued.

The release tags are signed with a GPG key ID F2B4 1200 C54E FB30 380C 1756 C565 D5F9 D76D 583B, release tarballs are hosted at kernel.org. See file CHANGES or changelogs on wiki.

Reporting bugs

There are several ways, each has its own specifics and audience that can give feedback or work on a fix. The following list is sorted in the order of preference:

  • github issue tracker
  • to the mailing list linux-btrfs@vger.kernel.org -- (not required to subscribe), beware that the mail might get overlooked in other traffic
  • IRC (irc.freenode.net #btrfs) -- good for discussions eg. if a bug is already known, but reports could miss developers' attention
  • bugzilla.kernel.org -- (requires registration), set the product to Filesystems and component Btrfs, please put 'btrfs-progs' into the subject so it's clear that it's not a kernel bug report

Development

The patch submissions, development or general discussions take place at linux-btrfs@vger.kernel.org mailinglist, subsciption is not required to post.

The GitHub pull requests will not be accepted directly, the preferred way is to send patches to the mailinglist instead. You can link to a branch in any git repository if the mails do not make it to the mailinglist or just for convenience (makes it easier to test).

The development model of btrfs-progs shares a lot with the kernel model. The github way is different in some ways. We, the upstream community, expect that the patches meet some criteria (often lacking in github contributions):

  • one logical change per patch: eg. not mixing bugfixes, cleanups, features etc., sometimes it's not clear and will be usually pointed out during reviews
  • proper subject line: eg. prefix with btrfs-progs: subpart, ... , descriptive yet not too long, see git log --oneline for some inspiration
  • proper changelog: the changelogs are often missing or lacking explanation why the change was made, or how is something broken, what are user-visible effects of the bug or the fix, how does an improvement help or the intended usecase
  • the Signed-off-by line: this documents who authored the change, you can read more about the The Developer's Certificate of Origin (chapter 11)
    • if you are not used to the signed-off style, your contributions won't be rejected just because of it's missing, the Author: tag will be added as a substitute in order to allow contributions without much bothering with formalities

Source code coding style and preferences follow the kernel coding style. You can find the editor settings in .editorconfig and use the EditorConfig plugin to let your editor use that, or update your editor settings manually.

Testing

The testing documentation can be found in tests/ and continuous integration/container images in ci/.

Documentation updates

Documentation fixes or updates do not need much explanation so sticking to the code rules in the previous section is not necessary. GitHub pull requests are OK, patches could be sent to me directly and not required to be also in the mailinglist. Pointing out typos via IRC also works, although might get accidentally lost in the noise.

Third-party sources

Build dependencies are listed in INSTALL. Implementation of checksum/hash functions is provided by copies of the respective sources to avoid adding dependencies that would make deployments in rescure or limited environments harder. The implementations are portable and not optimized for speed nor accelerated. Optionally it's possible to use libgcrypt, libsodium or libkcapi implementations.

References