Skip to content

RFC btrfs: qgroup: Use backref cache based backref walk for commit roots

Qu Wenruo linux-btrfs 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 RFC Latest39 patches 17 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/39btrfs: backref: Introduce the skeleton of btrfs_backref_iterfs/btrfs/backref.c fs/btrfs/backref.h+150 -01 reply
2/39btrfs: backref: Implement btrfs_backref_iter_next()fs/btrfs/backref.c fs/btrfs/backref.h+92 -01 reply
3/39btrfs: relocation: Use btrfs_backref_iter infrastructurefs/btrfs/relocation.c+63 -1311 reply
4/39btrfs: relocation: Rename mark_block_processed() and __mark_block_processed()fs/btrfs/relocation.c+21 -341 reply
5/39btrfs: relocation: Add backref_cache::pending_edge and backref_cache::useless_node membersfs/btrfs/relocation.c+46 -281 reply
6/39btrfs: relocation: Add backref_cache::fs_info memberfs/btrfs/relocation.c+6 -21 reply
7/39btrfs: relocation: Make reloc root search specific for relocation backref cachefs/btrfs/ctree.h fs/btrfs/relocation.c+41 -113 replies
8/39btrfs: relocation: Refactor direct tree backref processing into its own functionfs/btrfs/relocation.c+79 -521 reply
9/39btrfs: relocation: Refactor indirect tree backref processing into its own functionfs/btrfs/relocation.c+160 -1351 reply
10/39btrfs: relocation: Use wrapper to replace open-coded edge linkingfs/btrfs/relocation.c+37 -160 replies
11/39btrfs: relocation: Specify essential members for alloc_backref_node()fs/btrfs/relocation.c+19 -200 replies
12/39btrfs: relocation: Remove the open-coded goto loop for breadth-first searchfs/btrfs/relocation.c+89 -841 reply
13/39btrfs: relocation: Refactor the finishing part of upper linkage into finish_upper_links()fs/btrfs/relocation.c+117 -691 reply
14/39btrfs: relocation: Refactor the useless nodes handling into its own functionfs/btrfs/relocation.c+75 -371 reply
15/39btrfs: Move backref node/edge/cache structure to backref.hfs/btrfs/backref.h fs/btrfs/relocation.c+122 -1131 reply
16/39btrfs: Rename tree_entry to simple_node and export itfs/btrfs/backref.h fs/btrfs/misc.h fs/btrfs/relocation.c+94 -750 replies
17/39btrfs: Move backref_cache_init() to backref.cfs/btrfs/backref.c fs/btrfs/backref.h fs/btrfs/relocation.c+18 -160 replies
18/39btrfs: Move alloc_backref_node() to backref.cfs/btrfs/backref.c fs/btrfs/backref.h fs/btrfs/relocation.c+22 -200 replies
19/39btrfs: Move alloc_backref_edge() to backref.cfs/btrfs/backref.c fs/btrfs/backref.h fs/btrfs/relocation.c+11 -100 replies
20/39btrfs: Move link_backref_edge() to backref.cfs/btrfs/backref.h fs/btrfs/relocation.c+16 -160 replies
21/39btrfs: Move free_backref_node() and free_backref_edge() to backref.hfs/btrfs/backref.h fs/btrfs/relocation.c+20 -190 replies
22/39btrfs: Move drop_backref_node() and needed facilities to backref.hfs/btrfs/backref.h fs/btrfs/relocation.c+37 -310 replies
23/39btrfs: Rename remove_backref_node() to cleanup_backref_node() and move it to backref.cfs/btrfs/backref.c fs/btrfs/backref.h fs/btrfs/relocation.c+51 -470 replies
24/39btrfs: Rename backref_cache_cleanup() to backref_cache_release() and move it to backref.cfs/btrfs/backref.c fs/btrfs/backref.h fs/btrfs/relocation.c+32 -310 replies
25/39btrfs: Rename backref_tree_panic() to backref_cache_panic(), and move it to backref.cfs/btrfs/backref.h fs/btrfs/relocation.c+19 -220 replies
26/39btrfs: Rename should_ignore_root() to should_ignore_reloc_root() and export itfs/btrfs/ctree.h fs/btrfs/relocation.c+6 -40 replies
27/39btrfs: relocation: Open-code read_fs_root() for handle_indirect_tree_backref()fs/btrfs/relocation.c+5 -10 replies
28/39btrfs: Rename handle_one_tree_block() to backref_cache_add_one_tree_block() and move it to backref.cfs/btrfs/backref.c fs/btrfs/backref.h fs/btrfs/relocation.c+366 -3580 replies
29/39btrfs: Rename finish_upper_links() to backref_cache_finish_upper_links() and move it to backref.cfs/btrfs/backref.c fs/btrfs/backref.h fs/btrfs/relocation.c+117 -1140 replies
30/39btrfs: relocation: Move error handling of build_backref_tree() to backref.cfs/btrfs/backref.c fs/btrfs/backref.h fs/btrfs/relocation.c+57 -470 replies
31/39btrfs: relocation: Use btrfs_find_all_leaves() to locate parent tree leaves of a data extentfs/btrfs/backref.c fs/btrfs/backref.h fs/btrfs/relocation.c+61 -2630 replies
32/39btrfs: backref: Only ignore reloc roots for indrect backref resolve if the backref cache is for reloction purposefs/btrfs/backref.c+13 -20 replies
33/39btrfs: qgroup: Introduce qgroup backref cachefs/btrfs/ctree.h fs/btrfs/disk-io.c fs/btrfs/qgroup.c+54 -00 replies
34/39btrfs: qgroup: Introduce qgroup_backref_cache_build() functionfs/btrfs/qgroup.c+151 -00 replies
35/39btrfs: qgroup: Introduce a function to iterate through backref_cache to find all parents for specified nodefs/btrfs/qgroup.c+39 -00 replies
36/39btrfs: qgroup: Introduce helpers to get needed tree block infofs/btrfs/qgroup.c+66 -00 replies
37/39btrfs: qgroup: Introduce verification for function to ensure old roots ulist matches btrfs_find_all_roots() resultfs/btrfs/qgroup.c+72 -00 replies
38/39btrfs: qgroup: Introduce a new function to get old_roots ulist using backref cachefs/btrfs/qgroup.c+110 -00 replies
39/39btrfs: qgroup: Use backref cache to speed up old_roots searchfs/btrfs/qgroup.c+12 -100 replies

Reviews trailers per patch

14 of 39 patches have a Reviewed-by or Acked-by.

PatchJohannes ThumshirnNikolay BorisovJosef Bacik
1/39R-b
2/39R-b R-b
3/39R-b R-b
4/39R-b R-b
5/39R-b
6/39R-b
7/39R-b R-b
8/39R-b
9/39R-b
10/39R-b R-b
11/39R-b R-b
12/39R-b
13/39R-b
14/39R-b
15/39
16/39
17/39
18/39
19/39
20/39
21/39
22/39
23/39
24/39
25/39
26/39
27/39
28/39
29/39
30/39
31/39
32/39
33/39
34/39
35/39
36/39
37/39
38/39
39/39

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes. Scroll the table sideways for all 3 reviewers.

Read the v1 thread

Cover letter [PATCH RFC 00/39] btrfs: qgroup: Use backref cache based backref walk for commit roots

This patchset is based on an OLD misc-next branch, please inform me before trying to merge, so I can rebase it to latest misc-next. (There will be tons of conflicts)

The branch can be fetched from github for review/testing.
https://github.com/adam900710/linux/tree/backref_cache_all

The patchset survives all the existing qgroup tests.

=== BACKGROUND ===
One of the biggest problem for qgroup is its performance impact. Although we have improved it in since v5.0 kernel, there is still something slowing down qgroup, the backref walk.

Before this patchset, we use btrfs_find_all_roots() to iterate all roots referring to one extent.
That function is doing a pretty good job, but it doesn't has any cache, which means even we're looking up the same extent, we still need to do the full backref walk.

On the other hand, relocation is doing its own backref cache, and provides a much faster backref walk.

So the patchset is mostly trying to make qgroup backref walk (at least commit root backref walk) to use the same mechanism provided by relocation.

=== BENCHMARK ===
For the performance improvement, the last patch has a benchmark. The following content is completely copied from that patch:
------
Here is a small script to test it:

mkfs.btrfs -f $dev
mount $dev -o space_cache=v2 $mnt

btrfs subvolume create $mnt/src

  for ((i = 0; i < 64; i++)); do
          for (( j = 0; j < 16; j++)); do
                  xfs_io -f -c "pwrite 0 2k" $mnt/src/file_inline_$(($i * 16 + $j)) > /dev/null
          done
          xfs_io -f -c "pwrite 0 1M" $mnt/src/file_reg_$i > /dev/null
          sync
          btrfs subvol snapshot $mnt/src $mnt/snapshot_$i
  done
  sync

btrfs quota enable $mnt
btrfs quota rescan -w $mnt

Here is the benchmark for above small tests.
The performance material is the total execution time of get_old_roots() for patched kernel (*), and find_all_roots() for original kernel.

*: With CONFIG_BTRFS_FS_CHECK_INTEGRITY disabled, as get_old_roots()
will call find_all_roots() to verify the result if that config is enabled.

| Number of calls | Total exec time |
------------------------------------------------------

find_all_roots()|  732		   | 529991034ns
get_old_roots() |  732		   | 127998312ns

------------------------------------------------------
diff | 0.00 % | -75.8 %
------

Patch 01~30 are mostly refactors and code movement, which exposes no behavior change.

Patch 31~32 are small behavior change only for qgroup backref cache. Patch 33~39 are the implementation of qgroup backref cache.

=== REASON FOR RFC ===
The naming is currently my biggest concern.

Since the code movement involves exporting quite a lot of functions, in theory they should have btrfs_ prefix.
(For all newly exported functions in backref.h)

But some functions like alloc_backref_node(), adding "btrfs_" prefix doesn't make it more clear, but just making it unnecessary long.

My current plan is to rename them using "btrfs_brc_" prefix (BackRef Cache), and remove the "cache" in the original name.

E.g:
alloc_backref_node => btrfs_brc_alloc_node()
backref_cache_release => btrfs_brc_release()
link_backref_edge => btrfs_brc_link_edge()

But the abbr "brc" is pretty confusing and makes no sense by itself, so I'm not sure what's the best practice here.

Qu Wenruo (39):
btrfs: backref: Introduce the skeleton of btrfs_backref_iter
btrfs: backref: Implement btrfs_backref_iter_next()
btrfs: relocation: Use btrfs_backref_iter infrastructure
btrfs: relocation: Rename mark_block_processed() and
__mark_block_processed()
btrfs: relocation: Add backref_cache::pending_edge and
backref_cache::useless_node members
btrfs: relocation: Add backref_cache::fs_info member
btrfs: relocation: Make reloc root search specific for relocation
backref cache
btrfs: relocation: Refactor direct tree backref processing into its
own function
btrfs: relocation: Refactor indirect tree backref processing into its
own function
btrfs: relocation: Use wrapper to replace open-coded edge linking
btrfs: relocation: Specify essential members for alloc_backref_node()
btrfs: relocation: Remove the open-coded goto loop for breadth-first
search
btrfs: relocation: Refactor the finishing part of upper linkage into
finish_upper_links()
btrfs: relocation: Refactor the useless nodes handling into its own
function
btrfs: Move backref node/edge/cache structure to backref.h
btrfs: Rename tree_entry to simple_node and export it
btrfs: Move backref_cache_init() to backref.c
btrfs: Move alloc_backref_node() to backref.c
btrfs: Move alloc_backref_edge() to backref.c
btrfs: Move link_backref_edge() to backref.c
btrfs: Move free_backref_node() and free_backref_edge() to backref.h
btrfs: Move drop_backref_node() and needed facilities to backref.h
btrfs: Rename remove_backref_node() to cleanup_backref_node() and move
it to backref.c
btrfs: Rename backref_cache_cleanup() to backref_cache_release() and
move it to backref.c
btrfs: Rename backref_tree_panic() to backref_cache_panic(), and move
it to backref.c
btrfs: Rename should_ignore_root() to should_ignore_reloc_root() and
export it
btrfs: relocation: Open-code read_fs_root() for
handle_indirect_tree_backref()
btrfs: Rename handle_one_tree_block() to
backref_cache_add_one_tree_block() and move it to backref.c
btrfs: Rename finish_upper_links() to
backref_cache_finish_upper_links() and move it to backref.c
btrfs: relocation: Move error handling of build_backref_tree() to
backref.c
btrfs: relocation: Use btrfs_find_all_leaves() to locate parent tree
leaves of a data extent
btrfs: backref: Only ignore reloc roots for indrect backref resolve if
the backref cache is for reloction purpose
btrfs: qgroup: Introduce qgroup backref cache
btrfs: qgroup: Introduce qgroup_backref_cache_build() function
btrfs: qgroup: Introduce a function to iterate through backref_cache
to find all parents for specified node
btrfs: qgroup: Introduce helpers to get needed tree block info
btrfs: qgroup: Introduce verification for function to ensure old roots
ulist matches btrfs_find_all_roots() result
btrfs: qgroup: Introduce a new function to get old_roots ulist using
backref cache
btrfs: qgroup: Use backref cache to speed up old_roots search

 fs/btrfs/backref.c    |  826 ++++++++++++++++++++++++-
 fs/btrfs/backref.h    |  305 +++++++++
 fs/btrfs/ctree.h      |    5 +
 fs/btrfs/disk-io.c    |    1 +
 fs/btrfs/misc.h       |   54 ++
 fs/btrfs/qgroup.c     |  511 +++++++++++++++-
 fs/btrfs/relocation.c | 1356 +++++++----------------------------------
 7 files changed, 1903 insertions(+), 1155 deletions(-)
Signature · 1 line
2.25.1