Userspace utilities to manage btrfs filesystems
Go to file
Qu Wenruo f3353a5e85 btrfs-progs: convert: handle ext4 orphan file feature properly
[BUG]
Since e2fsprog 1.47, even with a newly created empty ext4 filesystem,
btrfs-convert would result an fs that btrfs-check would complain:

  # mkfs.ext4 -F test.img
  # btrfs-convert test.img
  # btrfs-check test.img
  Opening filesystem to check...
  Checking filesystem on test.img
  UUID: e45da158-8967-4e4d-9c9f-66b0d127dbce
  [1/7] checking root items
  [2/7] checking extents
  [3/7] checking free space cache
  [4/7] checking fs roots
  root 5 inode 266 errors 2000, link count wrong
  ERROR: errors found in fs roots
  found 26333184 bytes used, error(s) found <<<
  total csum bytes: 25540
  total tree bytes: 180224
  total fs tree bytes: 49152
  total extent tree bytes: 16384
  btree space waste bytes: 145423
  file data blocks allocated: 33947648
   referenced 26284032

[CAUSE]
Ext4 has a new compat feature, COMPAT_ORPHAN_FILE, as a better way to
track all the orphan inodes.

This new feature would create a new special inode for this purpose, and
such orphan file inode would not be reachable from any other inode, but
only from super block.

Unfortunately btrfs-convert only skip ext2 known special inodes, not the
newer one.

[FIX]
According to the kernel document, we can locate the orphan file inode
using ext2 super block s_orphan_file_inum, and skip it for
btrfs-convert.

And such skip would only happen if we have the definition of
EXT4_FEATURE_COMPAT_ORPHAN_FILE, to be compatible with older e2fsprogs.

Signed-off-by: Qu Wenruo <wqu@suse.com>
Signed-off-by: David Sterba <dsterba@suse.com>
2023-03-23 19:48:26 +01:00
.github/workflows btrfs-progs: ci: build workflow Github actions for devel 2023-03-22 15:21:37 +01:00
Documentation btrfs-progs: docs: convert btrfs-ioctl to more compact format 2023-03-22 20:07:50 +01:00
check btrfs-progs: check: convert help text to option formatter 2023-02-28 20:11:23 +01:00
ci btrfs-progs: ci: enable crypto backends on alpine/musl image 2023-03-01 16:58:29 +01:00
cmds btrfs-progs: handle case if fsid not in sysfs in device_is_seed 2023-03-17 18:15:39 +01:00
common btrfs-progs: qgroup show: fix formatting of qgroupid on json output 2023-03-16 15:48:41 +01:00
convert btrfs-progs: convert: handle ext4 orphan file feature properly 2023-03-23 19:48:26 +01:00
crypto btrfs-progs: crypto: remove unused declarations of blake2 variants 2023-03-17 01:16:02 +01:00
image btrfs-progs: open code print_usage where applicable 2023-02-28 20:11:23 +01:00
include btrfs-progs: sync DEV_INFO ioctl from kernel 2023-03-21 02:55:56 +01:00
kernel-lib btrfs-progs: properly handle degraded raid56 reads 2022-11-24 17:29:12 +01:00
kernel-shared btrfs-progs: use alloc_dummy_extent_buffer() for temporary super block 2023-03-21 03:10:42 +01:00
libbtrfs btrfs-progs: libbtrfs: own copy of crc32c 2023-02-28 20:11:22 +01:00
libbtrfsutil btrfs-progs: sync DEV_INFO ioctl from kernel 2023-03-21 02:55:56 +01:00
m4 btrfs-progs: build: fix detection of std=gnu11 build 2023-02-28 19:49:30 +01:00
mkfs btrfs-progs: open code print_usage where applicable 2023-02-28 20:11:23 +01:00
tests btrfs-progs: tests: fix mkfs/025 detection of zoned support 2023-03-22 14:34:21 +01:00
tune btrfs-progs: open code print_usage where applicable 2023-02-28 20:11:23 +01:00
.editorconfig btrfs-progs: add basic .editorconfig 2020-08-31 17:01:02 +02:00
.gitignore btrfs-progs: ci: build workflow Github actions for devel 2023-03-22 15:21:37 +01:00
64-btrfs-dm.rules
64-btrfs-zoned.rules btrfs-progs: add udev rule to use mq-deadline on zoned btrfs 2022-02-01 18:41:43 +01:00
CHANGES btrfs-progs: update CHANGES for 6.2.1 2023-03-03 16:54:17 +01:00
COPYING
INSTALL btrfs-progs: INSTALL: add minimal version of crypto libraries 2023-03-01 17:02:26 +01:00
Makefile btrfs-progs: fix detection of accelerated implementation. 2023-03-01 15:10:21 +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: fix detection of accelerated implementation. 2023-03-01 15:10:21 +01:00
README.md btrfs-progs: README: replace or remove wiki links 2023-02-28 20:11:23 +01:00
VERSION Btrfs progs v6.2.1 2023-03-03 17:10:44 +01:00
autogen.sh btrfs-progs: build: simplify version tracking 2018-01-31 15:14:01 +01:00
btrfs-completion btrfs-progs: inspect: new command map-swapfile 2022-12-06 21:03:31 +01:00
btrfs-corrupt-block.c btrfs-progs: corrupt-block: convert help text to option formatter 2023-02-28 20:11:24 +01:00
btrfs-crc.c btrfs-progs: move crc32c implementation to crypto/ 2019-11-18 19:20:02 +01:00
btrfs-debugfs btrfs-progs: port btrfs-debugfs to python3 2020-07-02 22:24:33 +02:00
btrfs-find-root.c btrfs-progs: find-root: convert help text to option formatter 2023-02-28 20:11:24 +01:00
btrfs-fragments.c btrfs-progs: reorder includes in standalone tools 2022-10-11 09:06:12 +02:00
btrfs-map-logical.c btrfs-progs: map-logical: convert help text to option formatter 2023-02-28 20:11:24 +01:00
btrfs-sb-mod.c btrfs-progs: build: use plain fcntl.h instead of sys/fcntl.h 2023-02-28 19:49:30 +01:00
btrfs-select-super.c btrfs-progs: select-super: convert help text to option formatter 2023-02-28 20:11:24 +01:00
btrfs.c btrfs-progs: help: convert help text to option formatter 2023-02-28 20:11:24 +01:00
configure.ac btrfs-progs: docs: don't use wiki links in manual pages and package 2023-03-16 22:38:21 +01:00
fsck.btrfs
quick-test.c btrfs-progs: kernel-lib: remove radix-tree 2022-10-11 09:08:07 +02:00
show-blocks btrfs-progs: Remove btrfs-debug-tree command 2018-04-24 13:00:10 +02:00

README.md

Btrfs-progs

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 and also documentation:

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 RTD.

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:

Development

The development takes place in the mailing list (linux-btrfs@vger.kernel.org) or at github (issues, pull requests). Changes should be split to logical parts if possible, documentation may be included in the same patch as to code or separately.

The development model of btrfs-progs shares a lot with the kernel model. The

  • 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 is not mandatory for less significant changes (typos, documentation) but is desired as 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.

Documentation sources are written in RST and built by sphinx.

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 rescue or limited environments harder. The implementations are portable and there are optimized versions for some architectures. Optionally it's possible to use libgcrypt, libsodium or libkcapi implementations.

Some other code is borrowed from kernel, eg. the raid5 tables or data structure implementation (list, rb-tree).

References