btrfs: balance: fix potential bg lookup failure in chunk_usage_range_filter()

[BUG]
Running btrfs balance with a usage range filter (-dusage=min..max) can
trigger a null-ptr-deref when metadata corruption causes a chunk to have
no corresponding block group in the in-memory cache:

  KASAN: null-ptr-deref in range [0x0000000000000070-0x0000000000000077]
  RIP: 0010:chunk_usage_range_filter fs/btrfs/volumes.c:3845 [inline]
  RIP: 0010:should_balance_chunk fs/btrfs/volumes.c:4031 [inline]
  RIP: 0010:__btrfs_balance fs/btrfs/volumes.c:4182 [inline]
  RIP: 0010:btrfs_balance+0x249e/0x4320 fs/btrfs/volumes.c:4618
  ...
  Call Trace:
    btrfs_ioctl_balance fs/btrfs/ioctl.c:3577 [inline]
    btrfs_ioctl+0x25cf/0x5b90 fs/btrfs/ioctl.c:5313
    vfs_ioctl fs/ioctl.c:51 [inline]
    ...

The bug is reproducible on recent development branch.

[CAUSE]
Two separate data structures are involved:

1. The on-disk chunk tree, which records every chunk (logical address
   space region) and is iterated by __btrfs_balance().

2. The in-memory block group cache (fs_info->block_group_cache_tree),
   which is built at mount time by btrfs_read_block_groups() and holds
   a struct btrfs_block_group for each chunk. This cache is what the
   usage range filter queries.

On a well-formed filesystem, these two are kept in 1:1 correspondence.
However, btrfs_read_block_groups() builds the cache from block group
items in the extent tree, not directly from the chunk tree. A corrupted
image can therefore contain a chunk item in the chunk tree whose
corresponding block group item is absent from the extent tree; that
chunk's block group is then never inserted into the in-memory cache.

When balance iterates the chunk tree and reaches such an orphaned chunk,
should_balance_chunk() calls chunk_usage_range_filter(), which queries
the block group cache:

  cache = btrfs_lookup_block_group(fs_info, chunk_offset);
  chunk_used = cache->used;   /* cache may be NULL */

btrfs_lookup_block_group() returns NULL silently when no cached entry
covers chunk_offset. chunk_usage_range_filter() does not check the return
value, so the immediately following dereference of cache->used triggers
the crash.

[FIX]
Add a NULL check after btrfs_lookup_block_group() in
chunk_usage_range_filter(). When the lookup fails, emit a btrfs_err()
message identifying the affected bytenr and return -EUCLEAN to indicate
filesystem corruption.

Since chunk_usage_range_filter() now has an error path, change its
return type from bool to error pointer, return 0 if the chunk matches
the usage range, and 1 if it should be filtered out.

Signed-off-by: ZhengYuan Huang <gality369@gmail.com>
Reviewed-by: David Sterba <dsterba@suse.com>
Signed-off-by: David Sterba <dsterba@suse.com>

diff --git a/fs/btrfs/volumes.c b/fs/btrfs/volumes.c
index cb29bf616e183ebebbd9ae91d3772f48f1c5e051..be30d54bb95c14df7b5c1ecc3632e647d2482eb8 100644 (file)
--- a/fs/btrfs/volumes.c
+++ b/fs/btrfs/volumes.c
@@ -3957,16 +3957,21 @@ static bool chunk_profiles_filter(u64 chunk_type, struct btrfs_balance_args *bar
        return true;
 }
 
-static bool chunk_usage_range_filter(struct btrfs_fs_info *fs_info, u64 chunk_offset,
-                                    struct btrfs_balance_args *bargs)
+static int chunk_usage_range_filter(struct btrfs_fs_info *fs_info, u64 chunk_offset,
+                                   struct btrfs_balance_args *bargs)
 {
        struct btrfs_block_group *cache;
        u64 chunk_used;
        u64 user_thresh_min;
        u64 user_thresh_max;
-       bool ret = true;
+       int ret = 1;
 
        cache = btrfs_lookup_block_group(fs_info, chunk_offset);
+       if (unlikely(!cache)) {
+               btrfs_err(fs_info, "balance: chunk at bytenr %llu has no corresponding block group",
+                         chunk_offset);
+               return -EUCLEAN;
+       }
        chunk_used = cache->used;
 
        if (bargs->usage_min == 0)
@@ -3982,7 +3987,7 @@ static bool chunk_usage_range_filter(struct btrfs_fs_info *fs_info, u64 chunk_of
                user_thresh_max = mult_perc(cache->length, bargs->usage_max);
 
        if (user_thresh_min <= chunk_used && chunk_used < user_thresh_max)
-               ret = false;
+               ret = 0;
 
        btrfs_put_block_group(cache);
        return ret;
@@ -4158,9 +4163,14 @@ static int should_balance_chunk(struct extent_buffer *leaf, struct btrfs_chunk *
                        return ret2;
                if (ret2)
                        return false;
-       } else if ((bargs->flags & BTRFS_BALANCE_ARGS_USAGE_RANGE) &&
-           chunk_usage_range_filter(fs_info, chunk_offset, bargs)) {
-               return false;
+       } else if (bargs->flags & BTRFS_BALANCE_ARGS_USAGE_RANGE) {
+               int ret2;
+
+               ret2 = chunk_usage_range_filter(fs_info, chunk_offset, bargs);
+               if (ret2 < 0)
+                       return ret2;
+               if (ret2)
+                       return false;
        }
 
        /* devid filter */