Manpage/btrfs-scrub

From btrfs Wiki
(Difference between revisions)
Jump to: navigation, search
m (Protected "Manpage/btrfs-scrub": Counter-productive edit warring (‎[edit=sysop] (indefinite) ‎[move=sysop] (indefinite)))
(git 5.4)
 
Line 16: Line 16:
 
<blockquote><b>Note:</b>
 
<blockquote><b>Note:</b>
 
Scrub is not a filesystem checker (fsck) and does not verify nor repair
 
Scrub is not a filesystem checker (fsck) and does not verify nor repair
structural damage in the filesystem.</blockquote>
+
structural damage in the filesystem. It really only checks checksums of data
 +
and tree blocks, it doesn&#8217;t ensure the content of tree blocks is valid and
 +
consistent. There&#8217;s some validation performed when metadata blocks are read
 +
from disk but it&#8217;s not extensive and cannot substitute full <em>btrfs check</em> run.</blockquote>
 
<p>The user is supposed to run it manually or via a periodic system service. The
 
<p>The user is supposed to run it manually or via a periodic system service. The
 
recommended period is a month but could be less. The estimated device bandwidth
 
recommended period is a month but could be less. The estimated device bandwidth
 
utilization is about 80% on an idle filesystem. The IO priority class is by
 
utilization is about 80% on an idle filesystem. The IO priority class is by
default <em>idle</em> so background scrub should not interfere with normal filesystem
+
default <em>idle</em> so background scrub should not significantly interfere with
operation significantly.</p>
+
normal filesystem operation. The IO scheduler set for the device(s) might not
 +
support the priority classes though.</p>
 
<p>The scrubbing status is recorded in <em>/var/lib/btrfs/</em> in textual files named
 
<p>The scrubbing status is recorded in <em>/var/lib/btrfs/</em> in textual files named
 
<em>scrub.status.UUID</em> for a filesystem identified by the given UUID. (Progress
 
<em>scrub.status.UUID</em> for a filesystem identified by the given UUID. (Progress
Line 34: Line 38:
 
<dd>
 
<dd>
 
<p>
 
<p>
If a scrub is running on the filesystem identified by <em>path</em> cancel it.
+
If a scrub is running on the filesystem identified by <em>path</em> or <em>device</em>,
 +
cancel it.
 
</p>
 
</p>
 
<p>If a <em>device</em> is specified, the corresponding filesystem is found and
 
<p>If a <em>device</em> is specified, the corresponding filesystem is found and
<b>btrfs scrub cancel</b> behaves as if it was called on that filesystem.</p>
+
<b>btrfs scrub cancel</b> behaves as if it was called on that filesystem.
 +
The progress is saved in the status file so <b>btrfs scrub resume</b> can continue
 +
from the last position.</p>
  
 
<dt>
 
<dt>
Line 44: Line 51:
 
<p>
 
<p>
 
Resume a cancelled or interrupted scrub on the filesystem identified by
 
Resume a cancelled or interrupted scrub on the filesystem identified by
<em>path</em> or on a given <em>device</em>.
+
<em>path</em> or on a given <em>device</em>. The starting point is read from the status file
 +
if it exists.
 
</p>
 
</p>
<p>Does not start a new scrub if the last scrub finished successfully.</p>
+
<p>This does not start a new scrub if the last scrub finished successfully.</p>
 
<p><tt>Options</tt></p>
 
<p><tt>Options</tt></p>
 
<p>see <b>scrub start</b>.</p>
 
<p>see <b>scrub start</b>.</p>
Line 55: Line 63:
 
<p>
 
<p>
 
Start a scrub on all devices of the filesystem identified by <em>path</em> or on
 
Start a scrub on all devices of the filesystem identified by <em>path</em> or on
a single <em>device</em>. If a scrub is already running, the new one fails.
+
a single <em>device</em>. If a scrub is already running, the new one will not start.
 
</p>
 
</p>
<p>Without options, scrub is started as a background process.</p>
+
<p>Without options, scrub is started as a background process. The automatic
 +
repairs of damaged copies is performed by default for block group profiles with
 +
redundancy.</p>
 
<p>The default IO priority of scrub is the idle class. The priority can be
 
<p>The default IO priority of scrub is the idle class. The priority can be
configured similar to the [http://man7.org/linux/man-pages/man1/ionice.1.html ionice(1)] syntax using <em>-c</em> and <em>-n</em> options.</p>
+
configured similar to the [http://man7.org/linux/man-pages/man1/ionice.1.html ionice(1)] syntax using <em>-c</em> and <em>-n</em> options.
 +
Note that not all IO schedulers honor the ionice settings.</p>
 
<p><tt>Options</tt></p>
 
<p><tt>Options</tt></p>
 
<dl>
 
<dl>
Line 95: Line 106:
 
<dd>
 
<dd>
 
<p>
 
<p>
print raw statistics per-device instead of a summary
+
raw print mode, print full data instead of summary
 
</p>
 
</p>
  

Latest revision as of 17:48, 16 January 2020

Contents

[edit] btrfs-scrub(8) manual page

Warning: this page is automatically generated from git, all edits will be lost. Current git version.


[edit] NAME

btrfs-scrub - scrub btrfs filesystem, verify block checksums

[edit] SYNOPSIS

btrfs scrub <subcommand> <args>

[edit] DESCRIPTION

btrfs scrub is used to scrub a btrfs filesystem, which will read all data and metadata blocks from all devices and verify checksums. Automatically repair corrupted blocks if there’s a correct copy available.

Note: Scrub is not a filesystem checker (fsck) and does not verify nor repair structural damage in the filesystem. It really only checks checksums of data and tree blocks, it doesn’t ensure the content of tree blocks is valid and consistent. There’s some validation performed when metadata blocks are read from disk but it’s not extensive and cannot substitute full btrfs check run.

The user is supposed to run it manually or via a periodic system service. The recommended period is a month but could be less. The estimated device bandwidth utilization is about 80% on an idle filesystem. The IO priority class is by default idle so background scrub should not significantly interfere with normal filesystem operation. The IO scheduler set for the device(s) might not support the priority classes though.

The scrubbing status is recorded in /var/lib/btrfs/ in textual files named scrub.status.UUID for a filesystem identified by the given UUID. (Progress state is communicated through a named pipe in file scrub.progress.UUID in the same directory.) The status file is updated every 5 seconds. A resumed scrub will continue from the last saved position.

[edit] SUBCOMMAND

cancel <path>|<device>

If a scrub is running on the filesystem identified by path or device, cancel it.

If a device is specified, the corresponding filesystem is found and btrfs scrub cancel behaves as if it was called on that filesystem. The progress is saved in the status file so btrfs scrub resume can continue from the last position.

resume [-BdqrR] [-c <ioprio_class> -n <ioprio_classdata>] <path>|<device>

Resume a cancelled or interrupted scrub on the filesystem identified by path or on a given device. The starting point is read from the status file if it exists.

This does not start a new scrub if the last scrub finished successfully.

Options

see scrub start.

start [-BdqrRf] [-c <ioprio_class> -n <ioprio_classdata>] <path>|<device>

Start a scrub on all devices of the filesystem identified by path or on a single device. If a scrub is already running, the new one will not start.

Without options, scrub is started as a background process. The automatic repairs of damaged copies is performed by default for block group profiles with redundancy.

The default IO priority of scrub is the idle class. The priority can be configured similar to the ionice(1) syntax using -c and -n options. Note that not all IO schedulers honor the ionice settings.

Options

-B

do not background and print scrub statistics when finished

-d

print separate statistics for each device of the filesystem (-B only) at the end

-q

be quiet, omit error messages and statistics

-r

run in read-only mode, do not attempt to correct anything, can be run on a read-only filesystem

-R

raw print mode, print full data instead of summary

-c <ioprio_class>

set IO priority class (see ionice(1) manpage)

-n <ioprio_classdata>

set IO priority classdata (see ionice(1) manpage)

-f

force starting new scrub even if a scrub is already running, this can useful when scrub status file is damaged and reports a running scrub although it is not, but should not normally be necessary

status [-d] <path>|<device>

Show status of a running scrub for the filesystem identified by path or for the specified device.

If no scrub is running, show statistics of the last finished or cancelled scrub for that filesystem or device.

Options

-d

print separate statistics for each device of the filesystem

[edit] EXIT STATUS

btrfs scrub returns a zero exit status if it succeeds. Non zero is returned in case of failure:

1

scrub couldn’t be performed

2

there is nothing to resume

3

scrub found uncorrectable errors

[edit] AVAILABILITY

btrfs is part of btrfs-progs. Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for further details.

[edit] SEE ALSO

mkfs.btrfs(8), ionice(1)

Personal tools