Documentation/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 *chunk-recover* [options] <device>::
  19 Recover the chunk tree by scanning the devices
  20 +
  21 `Options`
  22 +
  23 -y::::
  24 assume an answer of 'yes' to all questions.
  25 -v::::
  26 verbose mode.
  27 -h::::
  28 help.
  29
  30 NOTE: Since *chunk-recover* will scan the whole device, it will be *VERY* slow
  31 especially executed on a large device.
  32
  33 *super-recover* [options] <device>::
  34 Recover bad superblocks from good copies.
  35 +
  36 `Options`
  37 +
  38 -y::::
  39 assume an answer of 'yes' to all questions.
  40 -v::::
  41 verbose mode.
  42
  43 *zero-log* <device>::
  44 clear the filesystem log tree
  45 +
  46 This command will clear the filesystem log tree. This may fix a specific
  47 set of problem when the filesystem mount fails due to the log replay. See below
  48 for sample stacktraces that may show up in system log.
  49 +
  50 The common case where this happens has been fixed a long time ago,
  51 so it is unlikely that you will see this particular problem, but the utility is
  52 kept around.
  53 +
  54 NOTE: clearing the log may lead to loss of changes that were made since the
  55 last transaction commit. This may be up to 30 seconds (default commit period)
  56 or less if the commit was implied by other filesystem activity.
  57 +
  58 One can determine whether *zero-log* is needed according to the kernel
  59 backtrace:
  60 +
  61 ----
  62 ? replay_one_dir_item+0xb5/0xb5 [btrfs]
  63 ? walk_log_tree+0x9c/0x19d [btrfs]
  64 ? btrfs_read_fs_root_no_radix+0x169/0x1a1 [btrfs]
  65 ? btrfs_recover_log_trees+0x195/0x29c [btrfs]
  66 ? replay_one_dir_item+0xb5/0xb5 [btrfs]
  67 ? btree_read_extent_buffer_pages+0x76/0xbc [btrfs]
  68 ? open_ctree+0xff6/0x132c [btrfs]
  69 ----
  70 +
  71 If the errors are like above, then *zero-log* should be used to clear
  72 the log and the filesystem may be mounted normally again. The keywords to look
  73 for are 'open_ctree' which says that it's during mount and function names
  74 that contain 'replay', 'recover' or 'log_tree'.
  75
  76 *fix-device-size* <device>::
  77 fix device size and super block total bytes
  78 +
  79 This command will fix the following problems, by re-aligning all devices' total
  80 bytes and re-calculating super block total bytes.
  81 +
  82 1. Newer kernel refuse to mount btrfs caused by mismatch super block total bytes
  83 +
  84 ----
  85 BTRFS error (device sdb): super_total_bytes 92017859088384 mismatch with fs_devices total_rw_bytes 92017859094528
  86 ----
  87 +
  88 2. Noisy kernel warning for newer kernels
  89 +
  90 ----
  91 WARNING: CPU: 3 PID: 439 at fs/btrfs/ctree.h:1559 btrfs_update_device+0x1c5/0x1d0 [btrfs]
  92 ----
  93 +
  94 And the corresponding line is the `WARN_ON()` line below:
  95 +
  96 ----
  97 {
  98         BUILD_BUG_ON(sizeof(u64) !=
  99                      sizeof(((struct btrfs_dev_item *)0))->total_bytes);
 100         WARN_ON(!IS_ALIGNED(val, eb->fs_info->sectorsize));
 101         btrfs_set_64(eb, s, offsetof(struct btrfs_dev_item, total_bytes), val);
 102 }
 103 ----
 104
 105 EXIT STATUS
 106 -----------
 107 *btrfs rescue* returns a zero exit status if it succeeds. Non zero is
 108 returned in case of failure.
 109
 110 AVAILABILITY
 111 ------------
 112 *btrfs* is part of btrfs-progs.
 113 Please refer to the btrfs wiki http://btrfs.wiki.kernel.org for
 114 further details.
 115
 116 SEE ALSO
 117 --------
 118 `mkfs.btrfs`(8),
 119 `btrfs-scrub`(8),
 120 `btrfs-check`(8)