fs/btrfs/tests/extent-map-tests.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Copyright (C) 2017 Oracle.  All rights reserved.
   4  */
   5
   6 #include <linux/types.h>
   7 #include "btrfs-tests.h"
   8 #include "../ctree.h"
   9
  10 static void free_extent_map_tree(struct extent_map_tree *em_tree)
  11 {
  12         struct extent_map *em;
  13         struct rb_node *node;
  14
  15         while (!RB_EMPTY_ROOT(&em_tree->map.rb_root)) {
  16                 node = rb_first_cached(&em_tree->map);
  17                 em = rb_entry(node, struct extent_map, rb_node);
  18                 remove_extent_mapping(em_tree, em);
  19
  20 #ifdef CONFIG_BTRFS_DEBUG
  21                 if (refcount_read(&em->refs) != 1) {
  22                         test_err(
  23 "em leak: em (start 0x%llx len 0x%llx block_start 0x%llx block_len 0x%llx) refs %d",
  24                                  em->start, em->len, em->block_start,
  25                                  em->block_len, refcount_read(&em->refs));
  26
  27                         refcount_set(&em->refs, 1);
  28                 }
  29 #endif
  30                 free_extent_map(em);
  31         }
  32 }
  33
  34 /*
  35  * Test scenario:
  36  *
  37  * Suppose that no extent map has been loaded into memory yet, there is a file
  38  * extent [0, 16K), followed by another file extent [16K, 20K), two dio reads
  39  * are entering btrfs_get_extent() concurrently, t1 is reading [8K, 16K), t2 is
  40  * reading [0, 8K)
  41  *
  42  *     t1                            t2
  43  *  btrfs_get_extent()              btrfs_get_extent()
  44  *    -> lookup_extent_mapping()      ->lookup_extent_mapping()
  45  *    -> add_extent_mapping(0, 16K)
  46  *    -> return em
  47  *                                    ->add_extent_mapping(0, 16K)
  48  *                                    -> #handle -EEXIST
  49  */
  50 static int test_case_1(struct btrfs_fs_info *fs_info,
  51                 struct extent_map_tree *em_tree)
  52 {
  53         struct extent_map *em;
  54         u64 start = 0;
  55         u64 len = SZ_8K;
  56         int ret;
  57
  58         em = alloc_extent_map();
  59         if (!em)
  60                 return -ENOMEM;
  61
  62         /* Add [0, 16K) */
  63         em->start = 0;
  64         em->len = SZ_16K;
  65         em->block_start = 0;
  66         em->block_len = SZ_16K;
  67         ret = add_extent_mapping(em_tree, em, 0);
  68         if (ret < 0) {
  69                 test_err("cannot add extent range [0, 16K)");
  70                 goto out;
  71         }
  72         free_extent_map(em);
  73
  74         /* Add [16K, 20K) following [0, 16K)  */
  75         em = alloc_extent_map();
  76         if (!em) {
  77                 ret = -ENOMEM;
  78                 goto out;
  79         }
  80
  81         em->start = SZ_16K;
  82         em->len = SZ_4K;
  83         em->block_start = SZ_32K; /* avoid merging */
  84         em->block_len = SZ_4K;
  85         ret = add_extent_mapping(em_tree, em, 0);
  86         if (ret < 0) {
  87                 test_err("cannot add extent range [16K, 20K)");
  88                 goto out;
  89         }
  90         free_extent_map(em);
  91
  92         em = alloc_extent_map();
  93         if (!em) {
  94                 ret = -ENOMEM;
  95                 goto out;
  96         }
  97
  98         /* Add [0, 8K), should return [0, 16K) instead. */
  99         em->start = start;
 100         em->len = len;
 101         em->block_start = start;
 102         em->block_len = len;
 103         ret = btrfs_add_extent_mapping(fs_info, em_tree, &em, em->start, em->len);
 104         if (ret) {
 105                 test_err("case1 [%llu %llu]: ret %d", start, start + len, ret);
 106                 goto out;
 107         }
 108         if (em &&
 109             (em->start != 0 || extent_map_end(em) != SZ_16K ||
 110              em->block_start != 0 || em->block_len != SZ_16K)) {
 111                 test_err(
 112 "case1 [%llu %llu]: ret %d return a wrong em (start %llu len %llu block_start %llu block_len %llu",
 113                          start, start + len, ret, em->start, em->len,
 114                          em->block_start, em->block_len);
 115                 ret = -EINVAL;
 116         }
 117         free_extent_map(em);
 118 out:
 119         free_extent_map_tree(em_tree);
 120
 121         return ret;
 122 }
 123
 124 /*
 125  * Test scenario:
 126  *
 127  * Reading the inline ending up with EEXIST, ie. read an inline
 128  * extent and discard page cache and read it again.
 129  */
 130 static int test_case_2(struct btrfs_fs_info *fs_info,
 131                 struct extent_map_tree *em_tree)
 132 {
 133         struct extent_map *em;
 134         int ret;
 135
 136         em = alloc_extent_map();
 137         if (!em)
 138                 return -ENOMEM;
 139
 140         /* Add [0, 1K) */
 141         em->start = 0;
 142         em->len = SZ_1K;
 143         em->block_start = EXTENT_MAP_INLINE;
 144         em->block_len = (u64)-1;
 145         ret = add_extent_mapping(em_tree, em, 0);
 146         if (ret < 0) {
 147                 test_err("cannot add extent range [0, 1K)");
 148                 goto out;
 149         }
 150         free_extent_map(em);
 151
 152         /* Add [4K, 4K) following [0, 1K)  */
 153         em = alloc_extent_map();
 154         if (!em) {
 155                 ret = -ENOMEM;
 156                 goto out;
 157         }
 158
 159         em->start = SZ_4K;
 160         em->len = SZ_4K;
 161         em->block_start = SZ_4K;
 162         em->block_len = SZ_4K;
 163         ret = add_extent_mapping(em_tree, em, 0);
 164         if (ret < 0) {
 165                 test_err("cannot add extent range [4K, 8K)");
 166                 goto out;
 167         }
 168         free_extent_map(em);
 169
 170         em = alloc_extent_map();
 171         if (!em) {
 172                 ret = -ENOMEM;
 173                 goto out;
 174         }
 175
 176         /* Add [0, 1K) */
 177         em->start = 0;
 178         em->len = SZ_1K;
 179         em->block_start = EXTENT_MAP_INLINE;
 180         em->block_len = (u64)-1;
 181         ret = btrfs_add_extent_mapping(fs_info, em_tree, &em, em->start, em->len);
 182         if (ret) {
 183                 test_err("case2 [0 1K]: ret %d", ret);
 184                 goto out;
 185         }
 186         if (em &&
 187             (em->start != 0 || extent_map_end(em) != SZ_1K ||
 188              em->block_start != EXTENT_MAP_INLINE || em->block_len != (u64)-1)) {
 189                 test_err(
 190 "case2 [0 1K]: ret %d return a wrong em (start %llu len %llu block_start %llu block_len %llu",
 191                          ret, em->start, em->len, em->block_start,
 192                          em->block_len);
 193                 ret = -EINVAL;
 194         }
 195         free_extent_map(em);
 196 out:
 197         free_extent_map_tree(em_tree);
 198
 199         return ret;
 200 }
 201
 202 static int __test_case_3(struct btrfs_fs_info *fs_info,
 203                 struct extent_map_tree *em_tree, u64 start)
 204 {
 205         struct extent_map *em;
 206         u64 len = SZ_4K;
 207         int ret;
 208
 209         em = alloc_extent_map();
 210         if (!em)
 211                 return -ENOMEM;
 212
 213         /* Add [4K, 8K) */
 214         em->start = SZ_4K;
 215         em->len = SZ_4K;
 216         em->block_start = SZ_4K;
 217         em->block_len = SZ_4K;
 218         ret = add_extent_mapping(em_tree, em, 0);
 219         if (ret < 0) {
 220                 test_err("cannot add extent range [4K, 8K)");
 221                 goto out;
 222         }
 223         free_extent_map(em);
 224
 225         em = alloc_extent_map();
 226         if (!em) {
 227                 ret = -ENOMEM;
 228                 goto out;
 229         }
 230
 231         /* Add [0, 16K) */
 232         em->start = 0;
 233         em->len = SZ_16K;
 234         em->block_start = 0;
 235         em->block_len = SZ_16K;
 236         ret = btrfs_add_extent_mapping(fs_info, em_tree, &em, start, len);
 237         if (ret) {
 238                 test_err("case3 [0x%llx 0x%llx): ret %d",
 239                          start, start + len, ret);
 240                 goto out;
 241         }
 242         /*
 243          * Since bytes within em are contiguous, em->block_start is identical to
 244          * em->start.
 245          */
 246         if (em &&
 247             (start < em->start || start + len > extent_map_end(em) ||
 248              em->start != em->block_start || em->len != em->block_len)) {
 249                 test_err(
 250 "case3 [0x%llx 0x%llx): ret %d em (start 0x%llx len 0x%llx block_start 0x%llx block_len 0x%llx)",
 251                          start, start + len, ret, em->start, em->len,
 252                          em->block_start, em->block_len);
 253                 ret = -EINVAL;
 254         }
 255         free_extent_map(em);
 256 out:
 257         free_extent_map_tree(em_tree);
 258
 259         return ret;
 260 }
 261
 262 /*
 263  * Test scenario:
 264  *
 265  * Suppose that no extent map has been loaded into memory yet.
 266  * There is a file extent [0, 16K), two jobs are running concurrently
 267  * against it, t1 is buffered writing to [4K, 8K) and t2 is doing dio
 268  * read from [0, 4K) or [8K, 12K) or [12K, 16K).
 269  *
 270  * t1 goes ahead of t2 and adds em [4K, 8K) into tree.
 271  *
 272  *         t1                       t2
 273  *  cow_file_range()         btrfs_get_extent()
 274  *                            -> lookup_extent_mapping()
 275  *   -> add_extent_mapping()
 276  *                            -> add_extent_mapping()
 277  */
 278 static int test_case_3(struct btrfs_fs_info *fs_info,
 279                 struct extent_map_tree *em_tree)
 280 {
 281         int ret;
 282
 283         ret = __test_case_3(fs_info, em_tree, 0);
 284         if (ret)
 285                 return ret;
 286         ret = __test_case_3(fs_info, em_tree, SZ_8K);
 287         if (ret)
 288                 return ret;
 289         ret = __test_case_3(fs_info, em_tree, (12 * 1024ULL));
 290
 291         return ret;
 292 }
 293
 294 static int __test_case_4(struct btrfs_fs_info *fs_info,
 295                 struct extent_map_tree *em_tree, u64 start)
 296 {
 297         struct extent_map *em;
 298         u64 len = SZ_4K;
 299         int ret;
 300
 301         em = alloc_extent_map();
 302         if (!em)
 303                 return -ENOMEM;
 304
 305         /* Add [0K, 8K) */
 306         em->start = 0;
 307         em->len = SZ_8K;
 308         em->block_start = 0;
 309         em->block_len = SZ_8K;
 310         ret = add_extent_mapping(em_tree, em, 0);
 311         if (ret < 0) {
 312                 test_err("cannot add extent range [0, 8K)");
 313                 goto out;
 314         }
 315         free_extent_map(em);
 316
 317         em = alloc_extent_map();
 318         if (!em) {
 319                 ret = -ENOMEM;
 320                 goto out;
 321         }
 322
 323         /* Add [8K, 24K) */
 324         em->start = SZ_8K;
 325         em->len = 24 * 1024ULL;
 326         em->block_start = SZ_16K; /* avoid merging */
 327         em->block_len = 24 * 1024ULL;
 328         ret = add_extent_mapping(em_tree, em, 0);
 329         if (ret < 0) {
 330                 test_err("cannot add extent range [8K, 32K)");
 331                 goto out;
 332         }
 333         free_extent_map(em);
 334
 335         em = alloc_extent_map();
 336         if (!em) {
 337                 ret = -ENOMEM;
 338                 goto out;
 339         }
 340         /* Add [0K, 32K) */
 341         em->start = 0;
 342         em->len = SZ_32K;
 343         em->block_start = 0;
 344         em->block_len = SZ_32K;
 345         ret = btrfs_add_extent_mapping(fs_info, em_tree, &em, start, len);
 346         if (ret) {
 347                 test_err("case4 [0x%llx 0x%llx): ret %d",
 348                          start, len, ret);
 349                 goto out;
 350         }
 351         if (em && (start < em->start || start + len > extent_map_end(em))) {
 352                 test_err(
 353 "case4 [0x%llx 0x%llx): ret %d, added wrong em (start 0x%llx len 0x%llx block_start 0x%llx block_len 0x%llx)",
 354                          start, len, ret, em->start, em->len, em->block_start,
 355                          em->block_len);
 356                 ret = -EINVAL;
 357         }
 358         free_extent_map(em);
 359 out:
 360         free_extent_map_tree(em_tree);
 361
 362         return ret;
 363 }
 364
 365 /*
 366  * Test scenario:
 367  *
 368  * Suppose that no extent map has been loaded into memory yet.
 369  * There is a file extent [0, 32K), two jobs are running concurrently
 370  * against it, t1 is doing dio write to [8K, 32K) and t2 is doing dio
 371  * read from [0, 4K) or [4K, 8K).
 372  *
 373  * t1 goes ahead of t2 and splits em [0, 32K) to em [0K, 8K) and [8K 32K).
 374  *
 375  *         t1                                t2
 376  *  btrfs_get_blocks_direct()          btrfs_get_blocks_direct()
 377  *   -> btrfs_get_extent()              -> btrfs_get_extent()
 378  *       -> lookup_extent_mapping()
 379  *       -> add_extent_mapping()            -> lookup_extent_mapping()
 380  *          # load [0, 32K)
 381  *   -> btrfs_new_extent_direct()
 382  *       -> btrfs_drop_extent_cache()
 383  *          # split [0, 32K)
 384  *       -> add_extent_mapping()
 385  *          # add [8K, 32K)
 386  *                                          -> add_extent_mapping()
 387  *                                             # handle -EEXIST when adding
 388  *                                             # [0, 32K)
 389  */
 390 static int test_case_4(struct btrfs_fs_info *fs_info,
 391                 struct extent_map_tree *em_tree)
 392 {
 393         int ret;
 394
 395         ret = __test_case_4(fs_info, em_tree, 0);
 396         if (ret)
 397                 return ret;
 398         ret = __test_case_4(fs_info, em_tree, SZ_4K);
 399
 400         return ret;
 401 }
 402
 403 int btrfs_test_extent_map(void)
 404 {
 405         struct btrfs_fs_info *fs_info = NULL;
 406         struct extent_map_tree *em_tree;
 407         int ret = 0;
 408
 409         test_msg("running extent_map tests");
 410
 411         /*
 412          * Note: the fs_info is not set up completely, we only need
 413          * fs_info::fsid for the tracepoint.
 414          */
 415         fs_info = btrfs_alloc_dummy_fs_info(PAGE_SIZE, PAGE_SIZE);
 416         if (!fs_info) {
 417                 test_std_err(TEST_ALLOC_FS_INFO);
 418                 return -ENOMEM;
 419         }
 420
 421         em_tree = kzalloc(sizeof(*em_tree), GFP_KERNEL);
 422         if (!em_tree) {
 423                 ret = -ENOMEM;
 424                 goto out;
 425         }
 426
 427         extent_map_tree_init(em_tree);
 428
 429         ret = test_case_1(fs_info, em_tree);
 430         if (ret)
 431                 goto out;
 432         ret = test_case_2(fs_info, em_tree);
 433         if (ret)
 434                 goto out;
 435         ret = test_case_3(fs_info, em_tree);
 436         if (ret)
 437                 goto out;
 438         ret = test_case_4(fs_info, em_tree);
 439
 440 out:
 441         kfree(em_tree);
 442         btrfs_free_dummy_fs_info(fs_info);
 443
 444         return ret;
 445 }