btrfs-progs/Documentation/btrfstune.rst
Qu Wenruo 68a04bc710 btrfs-progs: tune: add new option to convert back to extent tree
With previous btrfstune support to convert to block-group-tree, it has
implemented most of the infrastructure for bi-directional conversion.

This patch will implement the remaining conversion support to go back to
extent tree.

The modification includes:

- New convert_to_extent_tree() function in btrfstune.c
  It's almost the same as convert_to_bg_tree(), but with small changes:
  * No need to set extra features like NO_HOLES/FST.
  * Need to delete the block group tree when everything finished.

- Update btrfs_delete_and_free_root() to handle non-global roots
  Currently the function can only accepts global roots (extent/csum/free
  space trees)

  If we pass a non-global root into the function, we will screw up
  global_roots_tree and crash.

  Since we're going to use btrfs_delete_and_free_root() to free block
  group tree which is not a global tree, this is needed.

- New handling for half converted fs in get_last_converted_bg()
  There are two cases need to be handled:

  * The bg tree is already empty
    We need to grab the first bg in extent tree.
    Or at conversion function we will fail at grabbing the first bg.

  * The bg tree is not empty
    Then we need to grab the last bg in extent tree.

- Extra root switching in involved functions. This involves:

  * read_converting_block_groups()
  * insert_block_group_item()
  * update_block_group_item()

  We just need to update our target root according to the current
  compat_ro and super flags.

Signed-off-by: Qu Wenruo <wqu@suse.com>
Signed-off-by: David Sterba <dsterba@suse.com>
2023-04-19 01:10:24 +02:00

140 lines
4.7 KiB
ReStructuredText

btrfstune(8)
============
SYNOPSIS
--------
**btrfstune** [options] <device> [<device>...]
DESCRIPTION
-----------
**btrfstune** can be used to enable, disable, or set various filesystem
parameters. The filesystem must be unmounted.
The common use case is to enable features that were not enabled at mkfs time.
Please make sure that you have kernel support for the features. You can find a
complete list of features and kernel version of their introduction at
https://btrfs.wiki.kernel.org/index.php/Changelog#By_feature . Also, the
manual page :doc:`mkfs.btrfs(8)<mkfs.btrfs>` contains more details about the features.
Some of the features could be also enabled on a mounted filesystem by other
means. Please refer to the *FILESYSTEM FEATURES* in :doc:`btrfs(5)<btrfs-man5>`.
OPTIONS
-------
--enable-block-group-tree
(since kernel 6.1)
Enable block group tree feature (greatly reduce mount time),
enabled by mkfs feature *block-group-tree*.
--disable-block-group-tree
(since kernel 6.1)
Disable block group tree feature and convert the filesystem to extent
tree.
-f
Allow dangerous changes, e.g. clear the seeding flag or change fsid.
Make sure that you are aware of the dangers.
-m
(since kernel: 5.0)
change fsid stored as 'metadata_uuid' to a randomly generated UUID,
see also '-U'
-M <UUID>
(since kernel: 5.0)
change fsid stored as *metadata_uuid* to a given UUID, see also *-U*
The metadata_uuid is stored only in the superblock and is a backward
incompatible change. The fsid in metadata blocks remains unchanged and
is not overwritten, thus the whole operation is significantly faster
than *-U*.
The new metadata_uuid can be used for mount by UUID and is also used to
identify devices of a multi-device filesystem.
-n
(since kernel: 3.14)
Enable no-holes feature (more efficient representation of file holes),
enabled by mkfs feature *no-holes*.
-r
(since kernel: 3.7)
Enable extended inode refs (hardlink limit per file in a directory is
65536), enabled by mkfs feature *extref*.
-S <0|1>
Enable seeding on a given device. Value 1 will enable seeding, 0 will
disable it. A seeding filesystem is forced to be mounted read-only. A
new device can be added to the filesystem and will capture all writes
keeping the seeding device intact. See also section *SEEDING DEVICE*
in :doc:`btrfs(5)<btrfs-man5>`.
.. warning::
Clearing the seeding flag on a device may be dangerous. If a
previously-seeding device is changed, all filesystems that used
that device will become unmountable. Setting the seeding flag
back will not fix that.
A valid usecase is 'seeding device as a base image'. Clear the
seeding flag, update the filesystem and make it seeding again,
provided that it's OK to throw away all filesystems built on
top of the previous base.
-u
Change fsid to a randomly generated UUID or continue previous fsid
change operation in case it was interrupted.
-U <UUID>
Change fsid to 'UUID' in all metadata blocks.
The *UUID* should be a 36 bytes string in ``printf(3)`` format
*"%08x-%04x-%04x-%04x-%012x"*.
If there is a previous unfinished fsid change, it will continue only if the
*UUID* matches the unfinished one or if you use the option *-u*.
All metadata blocks are rewritten, this may take some time, but the final
filesystem compatibility is unaffected, unlike *-M*.
.. warning::
Cancelling or interrupting a UUID change operation will make
the filesystem temporarily unmountable. To fix it, rerun
*btrfstune -u* and let it complete.
-x
(since kernel: 3.10)
Enable skinny metadata extent refs (more efficient representation of
extents), enabled by mkfs feature *skinny-metadata*.
All newly created extents will use the new representation. To
completely switch the entire filesystem, run a full balance of the
metadata. Please refer to :doc:`btrfs-balance(8)<btrfs-balance>`.
EXIT STATUS
-----------
**btrfstune** returns 0 if no error happened, 1 otherwise.
COMPATIBILITY NOTE
------------------
This deprecated tool exists for historical reasons but is still in use today.
Its functionality will be merged to the main tool, at which time **btrfstune**
will be declared obsolete and scheduled for removal.
SEE ALSO
--------
:doc:`btrfs(5)<btrfs-man5>`,
:doc:`btrfs-balance(8)<btrfs-balance>`,
:doc:`mkfs.btrfs(8)<mkfs.btrfs>`