Userspace utilities to manage btrfs filesystems
Go to file
David Sterba 785073f658 btrfs-progs: crypto: add hash speedtest utility
A simple tool to microbenchmark performance of the hashes. Uses rdtsc
for timing, so works only on x86_64.

 $ make hash-speedtest
 $ ./hash-speedtest [iterations]

   Block size: 4096
   Iterations: 100000

       NULL-NOP: cycles:     56061823, c/i      560
    NULL-MEMCPY: cycles:     61296469, c/i      612
	 CRC32C: cycles:    179961796, c/i     1799
	 XXHASH: cycles:    138434590, c/i     1384

Signed-off-by: David Sterba <dsterba@suse.com>
2019-11-18 19:20:03 +01:00
Documentation btrfs-progs: docs: add compression level support for mount options 2019-10-14 17:29:44 +02:00
check btrfs-progs: Fix printf formats 2019-10-14 17:31:05 +02:00
ci btrfs-progs: ci: setup GitLab-CI 2019-10-16 23:03:52 +02:00
cmds btrfs-progs: move crc32c implementation to crypto/ 2019-11-18 19:20:02 +01:00
common btrfs-progs: move crc32c implementation to crypto/ 2019-11-18 19:20:02 +01:00
convert btrfs-progs: move crc32c implementation to crypto/ 2019-11-18 19:20:02 +01:00
crypto btrfs-progs: crypto: add hash speedtest utility 2019-11-18 19:20:03 +01:00
image btrfs-progs: move crc32c implementation to crypto/ 2019-11-18 19:20:02 +01:00
kernel-lib btrfs-progs: move crc32c implementation to crypto/ 2019-11-18 19:20:02 +01:00
kernel-shared btrfs-progs: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02:00
libbtrfsutil libbtrfsutil: remove stale BTRFS_DEV_REPLACE_ITEM_STATE_x defines 2019-10-14 17:27:26 +02:00
m4 btrfs-progs: build: detect whether -std=gnu90 is supported 2018-06-07 16:37:35 +02:00
mkfs btrfs-progs: move crc32c implementation to crypto/ 2019-11-18 19:20:02 +01:00
tests btrfs-progs: move sha256 from tests to crypto/ 2019-11-18 19:20:02 +01:00
.gitignore btrfs-progs: gitignore: Ignore hidden files 2019-03-05 13:27:27 +01:00
.gitlab-ci.yml btrfs-progs: ci: setup GitLab-CI 2019-10-16 23:03:52 +02:00
.travis.yml btrfs-progs: ci: rename travis/ to ci/ 2019-07-04 02:06:34 +02:00
64-btrfs-dm.rules
Android.mk btrfs-progs: move crc32c implementation to crypto/ 2019-11-18 19:20:02 +01:00
CHANGES btrfs-progs: update CHANGES for 5.3.1 2019-10-25 14:03:21 +02:00
COPYING
INSTALL btrfs-progs: document the new all-in-one binary 2019-07-04 15:36:00 +02:00
Makefile btrfs-progs: crypto: add hash speedtest utility 2019-11-18 19:20:03 +01:00
Makefile.extrawarn btrfs-progs: build: disable -Waddress-of-packed-member by default 2019-06-14 15:09:53 +02:00
Makefile.inc.in btrfs-progs: build: add --disable-shared and --disable-static 2018-08-06 15:03:41 +02:00
README.md btrfs-progs: document the new all-in-one binary 2019-07-04 15:36:00 +02:00
VERSION Btrfs progs v5.3.1 2019-10-25 14:05:38 +02:00
androidcompat.h
autogen.sh btrfs-progs: build: simplify version tracking 2018-01-31 15:14:01 +01:00
backref.c btrfs-progs: move internal.h to common/ 2019-07-03 20:49:03 +02:00
backref.h btrfs-progs: move ulist.[ch] to kernel-shared 2017-03-08 13:00:47 +01:00
bcp
btrfs-completion btrfs-progs: completion: let dump-tree/dump-super/inode-resolve accept any file 2018-10-23 14:48:38 +02:00
btrfs-corrupt-block.c btrfs-progs: add checksum type to checksumming functions 2019-10-14 17:28:22 +02:00
btrfs-crc.c btrfs-progs: move crc32c implementation to crypto/ 2019-11-18 19:20:02 +01:00
btrfs-debugfs btrfs-progs: right-align number columns in btrfs-debugfs output 2017-10-06 13:41:31 +02:00
btrfs-find-root.c btrfs-progs: move crc32c implementation to crypto/ 2019-11-18 19:20:02 +01:00
btrfs-fragments.c btrfs-progs: Fix printf formats 2019-10-14 17:31:05 +02:00
btrfs-list.c btrfs-progs: move rbtree-utils.[ch] to common/ 2019-07-03 20:49:04 +02:00
btrfs-list.h btrfs-progs: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02:00
btrfs-map-logical.c btrfs-progs: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02:00
btrfs-sb-mod.c btrfs-progs: move crc32c implementation to crypto/ 2019-11-18 19:20:02 +01:00
btrfs-select-super.c btrfs-progs: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02:00
btrfs.c btrfs-progs: move crc32c implementation to crypto/ 2019-11-18 19:20:02 +01:00
btrfsck.h btrfs-progs: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02:00
btrfstune.c btrfs-progs: build most common tools into one binary (busybox style) 2019-07-04 15:30:40 +02:00
common-defs.h btrfs-progs: move some common definitions to own header 2017-03-08 13:00:45 +01:00
configure.ac btrfs-progs: fix typos in user-visible strings 2018-11-26 18:24:49 +01:00
ctree.c btrfs-progs: constify and reduce csum definition table 2019-11-18 19:20:02 +01:00
ctree.h btrfs-progs: add xxhash64 to mkfs 2019-11-18 19:20:00 +01:00
delayed-ref.c btrfs-progs: Handle error properly in btrfs_commit_transaction() 2019-05-13 15:54:47 +02:00
delayed-ref.h btrfs-progs: delayed-ref: Fix memory leak and use-after-free caused by wrong condition to free delayed ref/head. 2019-07-03 13:31:14 +02:00
dir-item.c btrfs-progs: check: lowmem: Add ability to repair dir item with mismatched hash 2019-01-15 18:42:13 +01:00
disk-io.c btrfs-progs: use hash wrapper for crc32c in btrfs_csum_data 2019-11-18 19:20:03 +01:00
disk-io.h btrfs-progs: update checksumming api 2019-10-14 17:28:34 +02:00
extent-cache.c btrfs-progs: move rbtree-utils.[ch] to common/ 2019-07-03 20:49:04 +02:00
extent-cache.h btrfs-progs: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02:00
extent-tree.c btrfs-progs: move crc32c implementation to crypto/ 2019-11-18 19:20:02 +01:00
extent_io.c btrfs-progs: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02:00
extent_io.h btrfs-progs: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02:00
file-item.c btrfs-progs: move crc32c implementation to crypto/ 2019-11-18 19:20:02 +01:00
file.c btrfs-progs: move utils.[ch] to common/ 2019-07-03 20:49:04 +02:00
find-root.c btrfs-progs: move utils.[ch] to common/ 2019-07-03 20:49:04 +02:00
find-root.h btrfs-progs: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02:00
free-space-cache.c btrfs-progs: move crc32c implementation to crypto/ 2019-11-18 19:20:02 +01:00
free-space-cache.h btrfs-progs: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02:00
free-space-tree.c btrfs-progs: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02:00
free-space-tree.h btrfs-progs: Pull free space tree related code from kernel 2018-10-25 16:11:39 +02:00
fsck.btrfs
hash.h btrfs-progs: move crc32c implementation to crypto/ 2019-11-18 19:20:02 +01:00
hasher.c
inode-item.c btrfs-progs: remove unused argument from btrfs_lookup_inode_ref 2017-03-08 13:00:47 +01:00
inode-map.c btrfs-progs: move internal.h to common/ 2019-07-03 20:49:03 +02:00
inode.c btrfs-progs: move messages.[ch] to common/ 2019-07-03 20:49:03 +02:00
ioctl-test.c btrfs-progs: tests: make the ioctl-test actually useful 2016-10-24 14:57:19 +02:00
ioctl.h btrfs-progs: device scan: add new option to forget one or all scanned devices 2019-03-01 13:40:21 +01:00
kerncompat.h btrfs-progs: Fix printf formats 2019-10-14 17:31:05 +02:00
libbtrfs.sym btrfs-progs: libbtrfs: add list of exported symbols 2019-10-24 16:31:25 +02:00
library-test.c btrfs-progs: move crc32c implementation to crypto/ 2019-11-18 19:20:02 +01:00
print-tree.c btrfs-progs: Fix printf formats 2019-10-14 17:31:05 +02:00
print-tree.h btrfs-progs: print-tree: Use BFS as default traversal method 2019-10-14 17:27:28 +02:00
props.c btrfs-progs: props: convert to C99 initializers 2019-07-26 17:46:42 +02:00
props.h
qgroup.c btrfs-progs: move utils.[ch] to common/ 2019-07-03 20:49:04 +02:00
qgroup.h btrfs-progs: qgroups: introduce btrfs_qgroup_query 2019-07-03 13:31:14 +02:00
quick-test.c btrfs-progs: Fix printf formats 2019-10-14 17:31:05 +02:00
random-test.c btrfs-progs: Fix printf formats 2019-10-14 17:31:05 +02:00
repair.c btrfs-progs: move utils.[ch] to common/ 2019-07-03 20:49:04 +02:00
repair.h
root-tree.c btrfs-progs: Use more strict check to read out tree root 2017-05-02 16:33:04 +02:00
send-dump.c btrfs-progs: move utils.[ch] to common/ 2019-07-03 20:49:04 +02:00
send-dump.h btrfs-progs: introduce new send-dump object 2016-12-14 15:06:34 +01:00
send-stream.c btrfs-progs: move crc32c implementation to crypto/ 2019-11-18 19:20:02 +01:00
send-stream.h
send-utils.c btrfs-progs: send: add gcc9 workaround for root item reset 2019-07-04 02:06:34 +02:00
send-utils.h btrfs-progs: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02:00
send.h btrfs-progs: Introduce kernel sizes to cleanup large intermediate number 2017-03-08 13:00:45 +01:00
show-blocks btrfs-progs: Remove btrfs-debug-tree command 2018-04-24 13:00:10 +02:00
transaction.c btrfs-progs: Exhaust delayed refs and dirty block groups to prevent delayed refs lost 2019-07-26 17:46:41 +02:00
transaction.h btrfs-progs: Avoid nested chunk allocation call 2019-06-05 20:27:31 +02:00
utils-lib.c btrfs-progs: move utils.[ch] to common/ 2019-07-03 20:49:04 +02:00
uuid-tree.c btrfs-progs: move utils.[ch] to common/ 2019-07-03 20:49:04 +02:00
version.h.in
volumes.c btrfs-progs: mkfs: match devid order to the stripe index 2019-10-14 17:28:05 +02:00
volumes.h btrfs-progs: sync btrfs_raid_attr from kernel 2019-07-03 13:31:16 +02:00

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

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.

References