Userspace utilities to manage btrfs filesystems
Go to file
Stéphane Lesimple 078e9a1cc9 btrfs-progs: check: enhanced progress indicator
We reuse the task_position enum and task_ctx struct of the original progress
indicator, adding more values and fields for our needs.

Then add hooks in all steps of the check to properly record progress.

Here's how the output looks like on a 22 Tb 5-disk RAID1 FS:

Opening filesystem to check...
Checking filesystem on /dev/mapper/luks-ST10000VN0004-XXXXXXXX
UUID: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
[1/7] checking extents           (0:20:21 elapsed, 950958 items checked)
[2/7] checking root items        (0:01:29 elapsed, 15121 items checked)
[3/7] checking free space cache  (0:00:11 elapsed, 4928 items checked)
[4/7] checking fs roots          (0:51:31 elapsed, 600892 items checked)
[5/7] checking csums             (0:14:35 elapsed, 754522 items checked)
[6/7] checking root refs         (0:00:00 elapsed, 232 items checked)
[7/7] checking quota groups skipped (not enabled on this FS)
found 5286458060800 bytes used, no error found

Signed-off-by: Stéphane Lesimple <stephane_btrfs@lesimple.fr>
Signed-off-by: David Sterba <dsterba@suse.com>
2018-08-06 15:03:23 +02:00
Documentation btrfs-progs: doc: Update man 5 btrfs for 4.18 2018-08-06 15:01:26 +02:00
check btrfs-progs: check: enhanced progress indicator 2018-08-06 15:03:23 +02:00
convert btrfs-progs: check: enhanced progress indicator 2018-08-06 15:03:23 +02:00
image btrfs-progs: convert: Fix offset-by-one error in read_data_extent() 2018-03-30 22:15:55 +02:00
kernel-lib btrfs-progs: kernel-lib: add generated tables.c 2017-08-24 19:06:31 +02:00
kernel-shared btrfs-progs: shared: cleanup includes in ulist.c 2017-03-08 13:00:47 +01:00
libbtrfsutil libbtrfsutil: fix test assumptions about top-level subvolume 2018-03-30 22:57:57 +02:00
m4 btrfs-progs: build: detect whether -std=gnu90 is supported 2018-06-07 16:37:35 +02:00
mkfs btrfs-progs: mkfs: Fix typos in strings and comments 2018-06-07 16:37:40 +02:00
tests btrfs-progs: fsck-tests: add test case with keyed data backref with reloc tree blocks 2018-08-06 15:03:16 +02:00
travis btrfs-progs: ci: update test image packages - add clang and python 2018-03-06 11:28:38 +01:00
.gitignore btrfs-progs: Remove deprecated btrfs-calc-size tool 2018-04-24 13:00:10 +02:00
.travis.yml btrfs-progs: ci: enable clang and python for musl build test 2018-03-06 11:28:38 +01:00
64-btrfs-dm.rules
Android.mk btrfs-progs: build: Remove unused variable TESTS 2018-01-08 19:25:05 +01:00
CHANGES btrfs-progs: update CHANGES for v4.17 2018-06-07 16:55:08 +02:00
COPYING
INSTALL libbtrfsutil: add Python bindings 2018-02-24 01:37:17 +01:00
Makefile btrfs-progs: remove stale dir-test 2018-08-06 15:01:38 +02:00
Makefile.extrawarn
Makefile.inc.in btrfs-progs: build: detect whether -std=gnu90 is supported 2018-06-07 16:37:35 +02:00
README.md btrfs-progs: README: update links, enhance contribution section 2017-09-25 15:17:04 +02:00
VERSION Btrfs progs v4.17 2018-06-15 16:21:17 +02:00
androidcompat.h
autogen.sh btrfs-progs: build: simplify version tracking 2018-01-31 15:14:01 +01:00
backref.c btrfs-progs: do not merge tree block refs have different root_id 2018-06-07 16:37:36 +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: cleanup whitespaces of btrfs-completion 2017-09-25 15:17:19 +02:00
btrfs-corrupt-block.c btrfs-progs: Remove root argument from btrfs_del_csums 2018-08-06 15:01:46 +02:00
btrfs-crc.c
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 help defines to own header 2017-03-08 13:00:45 +01:00
btrfs-fragments.c
btrfs-list.c btrfs-progs: btrfs-list: add rb_entry helpers for root_info 2018-08-06 14:58:57 +02:00
btrfs-list.h
btrfs-map-logical.c btrfs-progs: map-logical: fix spelling of a variable 2018-06-07 16:37:40 +02:00
btrfs-sb-mod.c btrfs-progs: sb-mod: add compat bit to the recognized fields 2018-04-11 15:37:36 +02:00
btrfs-select-super.c btrfs-progs: Refactor write_all_supers and its callers to use btrfs_fs_info 2017-07-12 17:53:28 +02:00
btrfs.c btrfs-progs: rework option parser to use getopt for global options 2017-03-31 19:40:57 +02:00
btrfsck.h
btrfstune.c btrfs-progs: btrfstune: prepare for enhanced mount check 2018-08-06 14:59:25 +02:00
chunk-recover.c btrfs-progs: constify pathnames passed as arguments 2018-08-06 14:58:50 +02:00
cmds-balance.c btrfs-progs: Fix wrong optind re-initialization to allow mixed option and non-option 2018-08-06 14:59:45 +02:00
cmds-device.c btrfs-progs: Fix wrong optind re-initialization to allow mixed option and non-option 2018-08-06 14:59:45 +02:00
cmds-fi-du.c btrfs-progs: Fix wrong optind re-initialization to allow mixed option and non-option 2018-08-06 14:59:45 +02:00
cmds-fi-usage.c btrfs-progs: Fix wrong optind re-initialization to allow mixed option and non-option 2018-08-06 14:59:45 +02:00
cmds-fi-usage.h btrfs-progs: don't use __u8 for fsid buffers 2017-11-14 15:59:00 +01:00
cmds-filesystem.c btrfs-progs: Fix wrong optind re-initialization to allow mixed option and non-option 2018-08-06 14:59:45 +02:00
cmds-inspect-dump-super.c btrfs-progs: remove BTRFS_CRC32_SIZE definition 2018-03-30 22:15:55 +02:00
cmds-inspect-dump-tree.c btrfs-progs: Fix wrong optind re-initialization to allow mixed option and non-option 2018-08-06 14:59:45 +02:00
cmds-inspect-tree-stats.c btrfs-progs: Fix wrong optind re-initialization to allow mixed option and non-option 2018-08-06 14:59:45 +02:00
cmds-inspect.c btrfs-progs: Fix wrong optind re-initialization to allow mixed option and non-option 2018-08-06 14:59:45 +02:00
cmds-property.c btrfs-progs: move get_fsid() to utils.c 2017-10-06 13:23:27 +02:00
cmds-qgroup.c btrfs-progs: Fix wrong optind re-initialization to allow mixed option and non-option 2018-08-06 14:59:45 +02:00
cmds-quota.c btrfs-progs: Fix wrong optind re-initialization to allow mixed option and non-option 2018-08-06 14:59:45 +02:00
cmds-receive.c btrfs-progs: Fix wrong optind re-initialization to allow mixed option and non-option 2018-08-06 14:59:45 +02:00
cmds-replace.c btrfs-progs: Fix wrong optind re-initialization to allow mixed option and non-option 2018-08-06 14:59:45 +02:00
cmds-rescue.c btrfs-progs: Fix wrong optind re-initialization to allow mixed option and non-option 2018-08-06 14:59:45 +02:00
cmds-restore.c btrfs-progs: Get rid of the confusing btrfs_file_extent_inline_len() 2018-08-06 15:00:34 +02:00
cmds-scrub.c btrfs-progs: Remove duplicate value-get for data_extents_scrubbed 2018-04-24 13:00:10 +02:00
cmds-send.c btrfs-progs: Fix wrong optind re-initialization to allow mixed option and non-option 2018-08-06 14:59:45 +02:00
cmds-subvolume.c btrfs-progs: Fix wrong optind re-initialization to allow mixed option and non-option 2018-08-06 14:59:45 +02:00
commands.h btrfs-progs: move command definitions to commands.h 2017-08-24 19:08:24 +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: build: detect whether -std=gnu90 is supported 2018-06-07 16:37:35 +02:00
ctree.c btrfs-progs: Always pass 0 for offset when calling btrfs_free_extent for btree blocks. 2018-08-06 15:02:04 +02:00
ctree.h btrfs-progs: check: Drop trans/root arguments from free_extent_hook 2018-08-06 15:01:57 +02:00
dir-item.c btrfs-progs: dir-item: Make btrfs_delete_one_dir_name more robust to handle corrupted name len 2018-06-07 16:32:03 +02:00
disk-io.c btrfs-progs: print bytenr of tree block in print_tree_block_error 2018-08-06 15:01:29 +02:00
disk-io.h btrfs-progs: add new flag to read superblock with mismatched fsids 2018-08-06 14:59:19 +02:00
extent-cache.c btrfs-progs: Remove objectid argument from alloc_cache_extent 2018-06-07 16:37:32 +02:00
extent-cache.h btrfs-progs: Remove add_cache_extent2 2018-06-07 16:37:32 +02:00
extent-tree.c btrfs-progs: Always pass 0 for offset when calling btrfs_free_extent for btree blocks. 2018-08-06 15:02:04 +02:00
extent_io.c btrfs-progs: extent_io: Refactor alloc_extent_buffer() to follow kernel parameters 2018-04-24 13:00:11 +02:00
extent_io.h btrfs-progs: reorder extent buffer members for better packing 2018-04-24 13:00:12 +02:00
file-item.c btrfs-progs: Remove root argument from btrfs_del_csums 2018-08-06 15:01:46 +02:00
file.c btrfs-progs: Get rid of the confusing btrfs_file_extent_inline_len() 2018-08-06 15:00:34 +02:00
find-root.c btrfs-progs: drop blocksize from read_tree_block 2017-09-08 16:15:05 +02:00
find-root.h
free-space-cache.c btrfs-progs: free-space-cache: Don't panic when free space cache is corrupted 2018-08-06 15:00:24 +02:00
free-space-cache.h
free-space-tree.c btrfs-progs: check: Fix wrong error message in case of corrupted extent 2018-08-06 15:01:32 +02:00
free-space-tree.h
fsck.btrfs
fsfeatures.c btrfs-progs: move fs features implementation to own file 2017-03-08 13:00:45 +01:00
fsfeatures.h btrfs-progs: Add zstd support 2017-09-25 15:17:13 +02:00
hash.h
hasher.c
help.c btrfs-progs: Remove unused parameter 2018-03-30 22:15:55 +02:00
help.h btrfs-progs: Remove unused parameter 2018-03-30 22:15:55 +02:00
inode-item.c btrfs-progs: remove unused argument from btrfs_lookup_inode_ref 2017-03-08 13:00:47 +01:00
inode-map.c
inode.c btrfs-progs: check: adjustments for further repair 2017-10-16 20:33:00 +02:00
internal.h
ioctl-test.c
ioctl.h
kerncompat.h btrfs-progs: kerncompat: Fix re-definition of __bitwise 2017-03-16 17:40:35 +01:00
library-test.c btrfs-progs: library-test: add all exported headers 2017-03-31 14:17:48 +02:00
messages.c btrfs-progs: add prefix to message helpers 2017-03-31 14:17:48 +02:00
messages.h btrfs-progs: use libbtrfsutil for read-only property 2018-03-06 11:28:37 +01:00
print-tree.c btrfs-progs: Get rid of the confusing btrfs_file_extent_inline_len() 2018-08-06 15:00:34 +02:00
print-tree.h btrfs-progs: print-tree: Remove btrfs_root parameter 2018-04-24 13:00:11 +02:00
props.c btrfs-progs: use libbtrfsutil for read-only property 2018-03-06 11:28:37 +01:00
props.h
qgroup-verify.c btrfs-progs: check: enhanced progress indicator 2018-08-06 15:03:23 +02:00
qgroup-verify.h btrfs-progs: check: enhanced progress indicator 2018-08-06 15:03:23 +02:00
qgroup.c btrfs-progs: qgroups: fix misleading index check 2018-08-06 14:58:31 +02:00
qgroup.h
quick-test.c btrfs-progs: fix build of quick-test 2018-08-06 15:01:36 +02:00
random-test.c btrfs-progs: add crude error handling when transaction start fails 2017-09-08 16:15:05 +02:00
rbtree-utils.c
rbtree-utils.h
repair.c
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: send: always print a space after path in dump 2017-04-19 19:33:43 +02:00
send-dump.h
send-stream.c btrfs-progs: fix btrfs send & receive with -e flag 2017-04-07 18:51:19 +02:00
send-stream.h
send-utils.c btrfs-progs: send-utils: remove unused functions path_cat and path_cat3 2018-04-24 13:00:03 +02:00
send-utils.h btrfs-progs: send-utils: remove unused functions path_cat and path_cat3 2018-04-24 13:00:03 +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
string-table.c
string-table.h
super-recover.c btrfs-progs: super-recover: fix the broken sb detection 2018-01-31 15:14:01 +01:00
task-utils.c btrfs-progs: check: enhanced progress indicator 2018-08-06 15:03:23 +02:00
task-utils.h btrfs-progs: check: enhanced progress indicator 2018-08-06 15:03:23 +02:00
transaction.c btrfs-progs: Add boolean to signal whether we are re-initing extent tree 2018-08-06 15:02:06 +02:00
transaction.h btrfs-progs: Add boolean to signal whether we are re-initing extent tree 2018-08-06 15:02:06 +02:00
utils-lib.c
utils.c btrfs-progs: pass superblock flags to mount check helpers 2018-08-06 14:59:04 +02:00
utils.h btrfs-progs: pass superblock flags to mount check helpers 2018-08-06 14:59:04 +02:00
uuid-tree.c btrfs-progs: treewide: Replace strerror(errno) with %m. 2018-01-31 15:14:03 +01:00
version.h.in
volumes.c btrfs-progs: Exit gracefully when overlapping chunks are detected 2018-08-06 15:02:59 +02:00
volumes.h btrfs-progs: Remove devid parameter from btrfs_rmap_block 2018-06-07 16:37:32 +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)

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