Userspace utilities to manage btrfs filesystems
Go to file
Anand Jain c501c9e3b8 btrfs-progs: mkfs: match devid order to the stripe index
At the time mkfs.btrfs the device id and stripe index gets reversed as
shown in [1]. This patch helps to keep them in order at the time of
mkfs.btrfs. And makes it easier to debug.

Before:
Stripe 0 is on devid 2; Stipe 1 is on devid 1;

./mkfs.btrfs -fq -draid1 -mraid1 /dev/sdb /dev/sdc && btrfs in dump-tree -d /dev/sdb | grep -A 10000 "chunk tree" | grep -B 10000 "device tree" | grep -A 13  "FIRST_CHUNK_TREE CHUNK_ITEM"
	item 2 key (FIRST_CHUNK_TREE CHUNK_ITEM 22020096) itemoff 15975 itemsize 112
		length 8388608 owner 2 stripe_len 65536 type SYSTEM|RAID1
		io_align 65536 io_width 65536 sector_size 4096
		num_stripes 2 sub_stripes 0
			stripe 0 devid 2 offset 1048576
			dev_uuid d9fe51c4-6e79-446d-87ee-5be3184798cd
			stripe 1 devid 1 offset 22020096
			dev_uuid 16f626ca-1a54-469b-ac7e-25623af884ab
	item 3 key (FIRST_CHUNK_TREE CHUNK_ITEM 30408704) itemoff 15863 itemsize 112
		length 268435456 owner 2 stripe_len 65536 type METADATA|RAID1
		io_align 65536 io_width 65536 sector_size 4096
		num_stripes 2 sub_stripes 0
			stripe 0 devid 2 offset 9437184
			dev_uuid d9fe51c4-6e79-446d-87ee-5be3184798cd
			stripe 1 devid 1 offset 30408704
			dev_uuid 16f626ca-1a54-469b-ac7e-25623af884ab
	item 4 key (FIRST_CHUNK_TREE CHUNK_ITEM 298844160) itemoff 15751 itemsize 112
		length 314572800 owner 2 stripe_len 65536 type DATA|RAID1
		io_align 65536 io_width 65536 sector_size 4096
		num_stripes 2 sub_stripes 0
			stripe 0 devid 2 offset 277872640
			dev_uuid d9fe51c4-6e79-446d-87ee-5be3184798cd
			stripe 1 devid 1 offset 298844160
			dev_uuid 16f626ca-1a54-469b-ac7e-25623af884ab

After:
Stripe 0 is on devid 1; Stripe 1 is on devid 2

./mkfs.btrfs -fq -draid1 -mraid1 /dev/sdb /dev/sdc && btrfs in dump-tree -d /dev/sdb | grep -A 10000 "chunk tree" | grep -B 10000 "device tree" | grep -A 13  "FIRST_CHUNK_TREE CHUNK_ITEM"
/dev/sdb: 8 bytes were erased at offset 0x00010040 (btrfs): 5f 42 48 52 66 53 5f 4d
/dev/sdc: 8 bytes were erased at offset 0x00010040 (btrfs): 5f 42 48 52 66 53 5f 4d
	item 2 key (FIRST_CHUNK_TREE CHUNK_ITEM 22020096) itemoff 15975 itemsize 112
		length 8388608 owner 2 stripe_len 65536 type SYSTEM|RAID1
		io_align 65536 io_width 65536 sector_size 4096
		num_stripes 2 sub_stripes 0
			stripe 0 devid 1 offset 22020096
			dev_uuid 6abc88fa-f42e-4f0c-9bc3-2225735e51d1
			stripe 1 devid 2 offset 1048576
			dev_uuid 73746d27-13a6-4d58-ac6b-48c90c31d94d
	item 3 key (FIRST_CHUNK_TREE CHUNK_ITEM 30408704) itemoff 15863 itemsize 112
		length 268435456 owner 2 stripe_len 65536 type METADATA|RAID1
		io_align 65536 io_width 65536 sector_size 4096
		num_stripes 2 sub_stripes 0
			stripe 0 devid 1 offset 30408704
			dev_uuid 6abc88fa-f42e-4f0c-9bc3-2225735e51d1
			stripe 1 devid 2 offset 9437184
			dev_uuid 73746d27-13a6-4d58-ac6b-48c90c31d94d
	item 4 key (FIRST_CHUNK_TREE CHUNK_ITEM 298844160) itemoff 15751 itemsize 112
		length 314572800 owner 2 stripe_len 65536 type DATA|RAID1
		io_align 65536 io_width 65536 sector_size 4096
		num_stripes 2 sub_stripes 0
			stripe 0 devid 1 offset 298844160
			dev_uuid 6abc88fa-f42e-4f0c-9bc3-2225735e51d1
			stripe 1 devid 2 offset 277872640
			dev_uuid 73746d27-13a6-4d58-ac6b-48c90c31d94d

Signed-off-by: Anand Jain <anand.jain@oracle.com>
Reviewed-by: Qu Wenruo <wqu@suse.com>
Signed-off-by: David Sterba <dsterba@suse.com>
2019-10-14 17:28:05 +02:00
Documentation btrfs-progs: docs: document btrfs-balance exit status in detail 2019-10-14 17:27:44 +02:00
check btrfs-progs: check: move device_record to main.c 2019-10-14 17:27:41 +02:00
ci btrfs-progs: ci: rename travis/ to ci/ 2019-07-04 02:06:34 +02:00
cmds btrfs-progs: qgroups: use parse_size instead of open coding it 2019-10-14 17:27:46 +02:00
common btrfs-progs: constify argument of parse_size 2019-10-14 17:27:50 +02:00
convert btrfs-progs: pass in a btrfs_mkfs_config to write_temp_extent_buffer 2019-10-14 17:27:23 +02:00
image btrfs-progs: build: add stub makefile to image and mkfs 2019-07-04 15:36:01 +02:00
kernel-lib btrfs-progs: kernel-lib: add overflow check helpers 2019-09-04 16:08:22 +02: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: mkfs: fix xattr enumeration 2019-10-14 17:27:56 +02:00
tests btrfs-progs: tests: fix misc/021 when restoring overlapping stale data 2019-10-14 17:28:02 +02:00
.gitignore btrfs-progs: gitignore: Ignore hidden files 2019-03-05 13:27:27 +01: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 string-table.[ch] to common/ 2019-07-03 20:49:03 +02:00
CHANGES btrfs-progs: update CHANGES for v5.2.2 2019-09-04 16:16:36 +02:00
COPYING
INSTALL btrfs-progs: document the new all-in-one binary 2019-07-04 15:36:00 +02:00
Makefile btrfs-progs: move qgroup-verify.[ch] to check/ 2019-10-14 17:27:35 +02: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.2.2 2019-09-05 15:34:37 +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
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: corrupt-block: Fix description of 'r' option 2019-10-14 17:27:59 +02:00
btrfs-crc.c btrfs-progs: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02:00
btrfs-debugfs
btrfs-find-root.c btrfs-progs: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02:00
btrfs-fragments.c btrfs-progs: move utils.[ch] to common/ 2019-07-03 20:49:04 +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: sb-mod: add remaining superblock integer items 2019-07-04 15:36:01 +02: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: build most common tools into one binary (busybox style) 2019-07-04 15:30:40 +02: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
configure.ac btrfs-progs: fix typos in user-visible strings 2018-11-26 18:24:49 +01:00
ctree.c btrfs-progs: deal with drop_progress properly in fsck 2019-07-26 17:46:42 +02:00
ctree.h btrfs-progs: extent-tree: Unify the parameters of btrfs_inc_extent_ref() 2019-07-26 17:46:42 +02: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 btrfs_csum_data() in __csum_tree_block_size() 2019-10-14 17:27:20 +02:00
disk-io.h btrfs-progs: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +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: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02: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: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02: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: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02: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: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02:00
hasher.c
inode-item.c
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
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: kerncompat: define __always_inline conditionally 2019-07-04 15:36:01 +02:00
library-test.c btrfs-progs: copy btrfsck.h to check/common.h 2019-10-14 17:27:37 +02:00
print-tree.c btrfs-progs: print-tree: add BTRFS_DEV_ITEMS_OBJECTID in comment 2019-10-14 17:27:52 +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: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02:00
random-test.c btrfs-progs: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02:00
repair.c btrfs-progs: move utils.[ch] to common/ 2019-07-03 20:49:04 +02:00
repair.h
root-tree.c
send-dump.c btrfs-progs: move utils.[ch] to common/ 2019-07-03 20:49:04 +02:00
send-dump.h
send-stream.c btrfs-progs: build: drop kernel-lib from -I and update paths 2019-07-03 20:49:04 +02: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
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