Beyond Linux® From Scratch (systemd Edition) - Version 11.3

Chapter 5. File Systems and Disk Management

btrfs-progs-6.1.3

Introduction to btrfs-progs

The btrfs-progs package contains administration and debugging tools for the B-tree file system (btrfs).

This package is known to build and work properly using an LFS 11.3 platform.

Package Information

Btrfs-progs Dependencies

Required

LZO-2.10

Recommended

asciidoc-10.2.0 (or asciidoctor-2.0.18) and xmlto-0.0.28 (both required to generate man pages)

Optional

LVM2-2.03.18 (dmsetup is used in tests), reiserfsprogs-3.6.27 (for tests), and sphinx-6.1.3 (required to build documentation),

User Notes: https://wiki.linuxfromscratch.org/blfs/wiki/btrfs-progs

Kernel Configuration

Enable the following option in the kernel configuration and recompile the kernel: 

File systems --->
  <*/M> Btrfs filesystem support [CONFIG_BTRFS_FS]

In addition to the above and to the options required for LVM2-2.03.18 and reiserfsprogs-3.6.27, the following options must be enabled for running tests: 

File systems  --->
  [*]   Btrfs POSIX Access Control Lists      [CONFIG_BTRFS_FS_POSIX_ACL]
  [*]   ReiserFS extended attributes          [CONFIG_REISERFS_FS_XATTR]
  [*]     ReiserFS POSIX Access Control Lists [CONFIG_REISERFS_FS_POSIX_ACL]

Installation of btrfs-progs

Install btrfs-progs by running the following commands: 

./configure --prefix=/usr --disable-documentation &&
make
[Note]

Note

Some tests require grep built with perl regular expressions. To obtain this, rebuild grep with the LFS Chapter 8 instructions after installing pcre2-10.42.

Before running tests, build a support program: 

make fssum

To test the results, issue (as the root user): 

pushd tests
   ./fsck-tests.sh
   ./mkfs-tests.sh
   ./cli-tests.sh
   ./convert-tests.sh
   ./misc-tests.sh
   ./fuzz-tests.sh
popd
[Note]

Note

If the above mentioned kernel options are not enabled, some tests fail, and prevent all the remaining tests to run because the test disk image is not cleanly unmounted.

The mkfs test 025-zoned-parallel is known to fail.

Install the package as the root user: 

make install

Command Explanations

--disable-documentation: This option is needed if the recommended dependencies are not installed.

Contents

Installed Programs: btrfs, btrfs-convert, btrfs-find-root, btrfs-image, btrfs-map-logical, btrfs-select-super, btrfsck (link to btrfs), btrfstune, fsck.btrfs, and mkfs.btrfs
Installed Libraries: libbtrfs.so and libbtrfsutil.so
Installed Directories: /usr/include/btrfs

Short Descriptions

btrfs

is the main interface into btrfs filesystem operations

btrfs-convert

converts from an ext2/3/4 or reiserfs filesystem to btrfs

btrfs-find-root

is a filter to find btrfs root

btrfs-map-logical

maps btrfs logical extent to physical extent

btrfs-select-super

overwrites the primary superblock with a backup copy

btrfstune

tunes various filesystem parameters

fsck.btrfs

does nothing, but is present for consistency with fstab

mkfs.btrfs

creates a btrfs file system