btrfs-rescue.asciidoc

   1 btrfs-rescue(8)
   2 ===============
   3
   4 NAME
   5 ----
   6 btrfs-rescue - Recover a damaged btrfs filesystem
   7
   8 SYNOPSIS
   9 --------
  10 *btrfs rescue* <subcommand> <args>
  11
  12 DESCRIPTION
  13 -----------
  14 *btrfs rescue* is used to try to recover a damaged btrfs filesystem.
  15
  16 SUBCOMMAND
  17 ----------
  18
  19 *chunk-recover* [options] <device>::
  20 Recover the chunk tree by scanning the devices
  21 +
  22 `Options`
  23 +
  24 -y::::
  25 assume an answer of 'yes' to all questions.
  26 -v::::
  27 verbose mode.
  28 -h::::
  29 help.
  30
  31 NOTE: Since *chunk-recover* will scan the whole device, it will be *VERY* slow
  32 especially executed on a large device.
  33
  34 *fix-device-size* <device>::
  35 fix device size and super block total bytes values that are do not match
  36 +
  37 Kernel 4.11 starts to check the device size more strictly and this might
  38 mismatch the stored value of total bytes. See the exact error message below.
  39 Newer kernel will refuse to mount the filesystem where the values do not match.
  40 This error is not fatal and can be fixed.  This command will fix the device
  41 size values if possible.
  42 +
  43 ----
  44 BTRFS error (device sdb): super_total_bytes 92017859088384 mismatch with fs_devices total_rw_bytes 92017859094528
  45 ----
  46 +
  47 The mismatch may also exhibit as a kernel warning:
  48 +
  49 ----
  50 WARNING: CPU: 3 PID: 439 at fs/btrfs/ctree.h:1559 btrfs_update_device+0x1c5/0x1d0 [btrfs]
  51 ----
  52
  53 *super-recover* [options] <device>::
  54 Recover bad superblocks from good copies.
  55 +
  56 `Options`
  57 +
  58 -y::::
  59 assume an answer of 'yes' to all questions.
  60 -v::::
  61 verbose mode.
  62
  63 *zero-log* <device>::
  64 clear the filesystem log tree
  65 +
  66 This command will clear the filesystem log tree. This may fix a specific
  67 set of problem when the filesystem mount fails due to the log replay. See below
  68 for sample stacktraces that may show up in system log.
  69 +
  70 The common case where this happens was fixed a long time ago,
  71 so it is unlikely that you will see this particular problem, but the command is
  72 kept around.
  73 +
  74 NOTE: clearing the log may lead to loss of changes that were made since the
  75 last transaction commit. This may be up to 30 seconds (default commit period)
  76 or less if the commit was implied by other filesystem activity.
  77 +
  78 One can determine whether *zero-log* is needed according to the kernel
  79 backtrace:
  80 +
  81 ----
  82 ? replay_one_dir_item+0xb5/0xb5 [btrfs]
  83 ? walk_log_tree+0x9c/0x19d [btrfs]
  84 ? btrfs_read_fs_root_no_radix+0x169/0x1a1 [btrfs]
  85 ? btrfs_recover_log_trees+0x195/0x29c [btrfs]
  86 ? replay_one_dir_item+0xb5/0xb5 [btrfs]
  87 ? btree_read_extent_buffer_pages+0x76/0xbc [btrfs]
  88 ? open_ctree+0xff6/0x132c [btrfs]
  89 ----
  90 +
  91 If the errors are like above, then *zero-log* should be used to clear
  92 the log and the filesystem may be mounted normally again. The keywords to look
  93 for are 'open_ctree' which says that it's during mount and function names
  94 that contain 'replay', 'recover' or 'log_tree'.
  95
  96 EXIT STATUS
  97 -----------
  98 *btrfs rescue* returns a zero exit status if it succeeds. Non zero is
  99 returned in case of failure.
 100
 101 AVAILABILITY
 102 ------------
 103 *btrfs* is part of btrfs-progs.
 104 Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
 105 further details.
 106
 107 SEE ALSO
 108 --------
 109 `mkfs.btrfs`(8),
 110 `btrfs-scrub`(8),
 111 `btrfs-check`(8)