NAME¶btrfs-check - check or repair a btrfs filesystem
SYNOPSIS¶btrfs check [options] <device>
DESCRIPTION¶The filesystem checker is used to verify structural integrity of a filesystem and attempt to repair it if requested. It is recommended to unmount the filesystem prior to running the check, but it is possible to start checking a mounted filesystem (see --force).
By default, btrfs check will not modify the device but you can reaffirm that by the option --readonly.
btrfsck is an alias of btrfs check command and is now deprecated.
Do not use --repair unless you are advised to do so by a developer or an experienced user, and then only after having accepted that no fsck successfully repair all types of filesystem corruption. Eg. some other software or hardware bugs can fatally damage a volume.
The structural integrity check verifies if internal filesystem objects or data structures satisfy the constraints, point to the right objects or are correctly connected together.
There are several cross checks that can detect wrong reference counts of shared extents, backreferences, missing extents of inodes, directory and inode connectivity etc.
The amount of memory required can be high, depending on the size of the filesystem, similarly the run time. Check the modes that can also affect that.
SAFE OR ADVISORY OPTIONS¶-b|--backup
This can be combined with --super if some of the superblocks are damaged.
This expects that the filesystem is otherwise OK, and is basically an offline scrub that does not repair data from spare copies.
This can be used to use a different starting point if some of the primary superblock is damaged.
For free space cache v1, the clear_cache kernel mount option only rebuilds the free space cache for block groups that are modified while the filesystem is mounted with that option. Thus, using this option with v1 makes it possible to actually clear the entire free space cache.
For free space cache v2, the clear_cache kernel mount option destroys the entire free space cache. This option, with v2 provides an alternative method of clearing the free space cache that doesn’t require mounting the filesystem.
there’s a warning and 10 second delay when this option is run without --force to give users a chance to think twice before running repair, the warnings in documentation have shown to be insufficient
Do not blindly use this option to fix checksum mismatch problems.
Do not use unless you know what you’re doing.
The MODE can be one of:
lowmem mode does not work with --repair yet, and is still considered experimental.
This option also skips the delay and warning in the repair mode (see --repair).
EXIT STATUS¶btrfs check returns a zero exit status if it succeeds. Non zero is returned in case of failure.
AVAILABILITY¶btrfs is part of btrfs-progs. Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for further details.
SEE ALSO¶mkfs.btrfs(8), btrfs-scrub(8), btrfs-rescue(8)