Skip to contentSkip to conversation

btrfs: Add intrudoction to dev-replace.

PATCH In review Qu Wenruo 3 participants 3 messages Jan 23, 2020 – Jan 30, 2020 Btrfs file system

lore
Share & tools
lore

Qu Wenruo

author
#0 lore raw

PATCH 1/1 btrfs: Add intrudoction to dev-replace.

The overview of btrfs dev-replace is not that complex. But digging into the code directly can waste some extra time, so add such introduction to help later guys.

Also, it mentions some corner cases caused by the write duplication and scrub based data copy, to inform new comers not to get trapped by that pitfall.

---
 fs/btrfs/dev-replace.c | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
fs/btrfs/dev-replace.c +38 -0
index f639dde2a679..5889c10ed8d2 100644
@@ -22,6 +22,44 @@
 #include "dev-replace.h"
 #include "sysfs.h"
 
+/*
+ * Introduction for dev-replace.
+ *
+ * [Objective]
+ * To copy all extents (both runtime and on-disk) from source device
+ * to target device, while still keeps the fs RW.
+ *
+ * [Method]
+ * There are two main methods involved:
+ * - Write duplication
+ *   All newer write will to written to both target and source devices.
+ *   So that even replace get canceled, old device is still valid.
+ *
+ *   Location:		handle_ops_on_dev_replace() from __btrfs_map_block()
+ *   Start timing:	btrfs_dev_replace_start()
+ *   End timing:	btrfs_dev_replace_finishing()
+ *   Content:		Latest data/meta
+ *
+ * - Existing extents copy
+ *   This happens by re-using scrub facility, as scrub also iterates through
+ *   exiting extents from commit root.
+ *
+ *   Location:		scrub_write_block_to_dev_replace() from
+ *   			scrub_block_complete()
+ *   Content:		Data/meta from commit root.
+ *
+ * Due to the content difference, we need to avoid nocow write when dev-replace
+ * is happening.
+ * This is done by marking the block group RO and wait for nocow writes.
+ *
+ * After replace is done, the finishing part is done by:
+ * - Swap target and source device
+ *   When the scrub finishes, swap the source device with target device.
+ *
+ *   Location:		btrfs_dev_replace_update_device_in_mapping_tree() from
+ *   			btrfs_dev_replace_finishing()
+ */
+
 static int btrfs_dev_replace_finishing(struct btrfs_fs_info *fs_info,
 				       int scrub_ret);
 static void btrfs_dev_replace_update_device_in_mapping_tree(
Signature · 1 line
2.25.0
Reviewed-by on v1 1/1
#1 lore raw
Quoted 8 lines · Qu Wenruo

The overview of btrfs dev-replace is not that complex. But digging into the code directly can waste some extra time, so add such introduction to help later guys.

Also, it mentions some corner cases caused by the write duplication and scrub based data copy, to inform new comers not to get trapped by that pitfall.

looks good.

nits below.

Quoted 14 lines
---
  fs/btrfs/dev-replace.c | 38 ++++++++++++++++++++++++++++++++++++++
  1 file changed, 38 insertions(+)
fs/btrfs/dev-replace.c +1 -0
index f639dde2a679..5889c10ed8d2 100644
@@ -22,6 +22,44 @@
  #include "dev-replace.h"
  #include "sysfs.h"
 
+/*

fs/btrfs/dev-replace.c line 35

Quoted 10 lines
fs/btrfs/dev-replace.c +10 -0
+ * Introduction for dev-replace.
+ *
+ * [Objective]
+ * To copy all extents (both runtime and on-disk) from source device
+ * to target device, while still keeps the fs RW.
+ *
+ * [Method]
+ * There are two main methods involved:
+ * - Write duplication
+ *   All newer write will to written to both target and source devices.
                          ^^^^^^^^^

fs/btrfs/dev-replace.c line 38

Quoted 3 lines
fs/btrfs/dev-replace.c +3 -0
+ *   So that even replace get canceled, old device is still valid.
+ *
+ *   Location:		handle_ops_on_dev_replace() from __btrfs_map_block()

Term Location is bit confusing, instead Functions will do?

Thanks, Anand

Quoted 28 lines
fs/btrfs/dev-replace.c +24 -0
+ *   Start timing:	btrfs_dev_replace_start()
+ *   End timing:	btrfs_dev_replace_finishing()
+ *   Content:		Latest data/meta
+ *
+ * - Existing extents copy
+ *   This happens by re-using scrub facility, as scrub also iterates through
+ *   exiting extents from commit root.
+ *
+ *   Location:		scrub_write_block_to_dev_replace() from
+ *   			scrub_block_complete()
+ *   Content:		Data/meta from commit root.
+ *
+ * Due to the content difference, we need to avoid nocow write when dev-replace
+ * is happening.
+ * This is done by marking the block group RO and wait for nocow writes.
+ *
+ * After replace is done, the finishing part is done by:
+ * - Swap target and source device
+ *   When the scrub finishes, swap the source device with target device.
+ *
+ *   Location:		btrfs_dev_replace_update_device_in_mapping_tree() from
+ *   			btrfs_dev_replace_finishing()
+ */
+
  static int btrfs_dev_replace_finishing(struct btrfs_fs_info *fs_info,
  				       int scrub_ret);
  static void btrfs_dev_replace_update_device_in_mapping_tree(
#2 lore raw
In reply to Qu Wenruo
Quoted 9 lines · Qu Wenruo

The overview of btrfs dev-replace is not that complex. But digging into the code directly can waste some extra time, so add such introduction to help later guys.

Also, it mentions some corner cases caused by the write duplication and scrub based data copy, to inform new comers not to get trapped by that pitfall.

Thanks for the docs, I've adjusted some wording and fixed a few typos. Please try to proofread it before sending, also reviews should catch and point that out.