fs/btrfs/fs.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2
   3 #ifndef BTRFS_FS_H
   4 #define BTRFS_FS_H
   5
   6 #include <linux/blkdev.h>
   7 #include <linux/fs.h>
   8 #include <linux/btrfs_tree.h>
   9 #include <linux/sizes.h>
  10 #include "extent-io-tree.h"
  11 #include "extent_map.h"
  12 #include "async-thread.h"
  13 #include "block-rsv.h"
  14
  15 #define BTRFS_MAX_EXTENT_SIZE SZ_128M
  16
  17 #define BTRFS_OLDEST_GENERATION 0ULL
  18
  19 #define BTRFS_EMPTY_DIR_SIZE 0
  20
  21 #define BTRFS_DIRTY_METADATA_THRESH             SZ_32M
  22
  23 #define BTRFS_SUPER_INFO_OFFSET                 SZ_64K
  24 #define BTRFS_SUPER_INFO_SIZE                   4096
  25 static_assert(sizeof(struct btrfs_super_block) == BTRFS_SUPER_INFO_SIZE);
  26
  27 /*
  28  * Number of metadata items necessary for an unlink operation:
  29  *
  30  * 1 for the possible orphan item
  31  * 1 for the dir item
  32  * 1 for the dir index
  33  * 1 for the inode ref
  34  * 1 for the inode
  35  * 1 for the parent inode
  36  */
  37 #define BTRFS_UNLINK_METADATA_UNITS             6
  38
  39 /*
  40  * The reserved space at the beginning of each device.  It covers the primary
  41  * super block and leaves space for potential use by other tools like
  42  * bootloaders or to lower potential damage of accidental overwrite.
  43  */
  44 #define BTRFS_DEVICE_RANGE_RESERVED                     (SZ_1M)
  45 /*
  46  * Runtime (in-memory) states of filesystem
  47  */
  48 enum {
  49         /*
  50          * Filesystem is being remounted, allow to skip some operations, like
  51          * defrag
  52          */
  53         BTRFS_FS_STATE_REMOUNTING,
  54         /* Filesystem in RO mode */
  55         BTRFS_FS_STATE_RO,
  56         /* Track if a transaction abort has been reported on this filesystem */
  57         BTRFS_FS_STATE_TRANS_ABORTED,
  58         /*
  59          * Bio operations should be blocked on this filesystem because a source
  60          * or target device is being destroyed as part of a device replace
  61          */
  62         BTRFS_FS_STATE_DEV_REPLACING,
  63         /* The btrfs_fs_info created for self-tests */
  64         BTRFS_FS_STATE_DUMMY_FS_INFO,
  65
  66         BTRFS_FS_STATE_NO_CSUMS,
  67
  68         /* Indicates there was an error cleaning up a log tree. */
  69         BTRFS_FS_STATE_LOG_CLEANUP_ERROR,
  70
  71         BTRFS_FS_STATE_COUNT
  72 };
  73
  74 enum {
  75         BTRFS_FS_CLOSING_START,
  76         BTRFS_FS_CLOSING_DONE,
  77         BTRFS_FS_LOG_RECOVERING,
  78         BTRFS_FS_OPEN,
  79         BTRFS_FS_QUOTA_ENABLED,
  80         BTRFS_FS_UPDATE_UUID_TREE_GEN,
  81         BTRFS_FS_CREATING_FREE_SPACE_TREE,
  82         BTRFS_FS_BTREE_ERR,
  83         BTRFS_FS_LOG1_ERR,
  84         BTRFS_FS_LOG2_ERR,
  85         BTRFS_FS_QUOTA_OVERRIDE,
  86         /* Used to record internally whether fs has been frozen */
  87         BTRFS_FS_FROZEN,
  88         /*
  89          * Indicate that balance has been set up from the ioctl and is in the
  90          * main phase. The fs_info::balance_ctl is initialized.
  91          */
  92         BTRFS_FS_BALANCE_RUNNING,
  93
  94         /*
  95          * Indicate that relocation of a chunk has started, it's set per chunk
  96          * and is toggled between chunks.
  97          */
  98         BTRFS_FS_RELOC_RUNNING,
  99
 100         /* Indicate that the cleaner thread is awake and doing something. */
 101         BTRFS_FS_CLEANER_RUNNING,
 102
 103         /*
 104          * The checksumming has an optimized version and is considered fast,
 105          * so we don't need to offload checksums to workqueues.
 106          */
 107         BTRFS_FS_CSUM_IMPL_FAST,
 108
 109         /* Indicate that the discard workqueue can service discards. */
 110         BTRFS_FS_DISCARD_RUNNING,
 111
 112         /* Indicate that we need to cleanup space cache v1 */
 113         BTRFS_FS_CLEANUP_SPACE_CACHE_V1,
 114
 115         /* Indicate that we can't trust the free space tree for caching yet */
 116         BTRFS_FS_FREE_SPACE_TREE_UNTRUSTED,
 117
 118         /* Indicate whether there are any tree modification log users */
 119         BTRFS_FS_TREE_MOD_LOG_USERS,
 120
 121         /* Indicate that we want the transaction kthread to commit right now. */
 122         BTRFS_FS_COMMIT_TRANS,
 123
 124         /* Indicate we have half completed snapshot deletions pending. */
 125         BTRFS_FS_UNFINISHED_DROPS,
 126
 127         /* Indicate we have to finish a zone to do next allocation. */
 128         BTRFS_FS_NEED_ZONE_FINISH,
 129
 130         /* Indicate that we want to commit the transaction. */
 131         BTRFS_FS_NEED_TRANS_COMMIT,
 132
 133         /* This is set when active zone tracking is needed. */
 134         BTRFS_FS_ACTIVE_ZONE_TRACKING,
 135
 136         /*
 137          * Indicate if we have some features changed, this is mostly for
 138          * cleaner thread to update the sysfs interface.
 139          */
 140         BTRFS_FS_FEATURE_CHANGED,
 141
 142 #if BITS_PER_LONG == 32
 143         /* Indicate if we have error/warn message printed on 32bit systems */
 144         BTRFS_FS_32BIT_ERROR,
 145         BTRFS_FS_32BIT_WARN,
 146 #endif
 147 };
 148
 149 /*
 150  * Flags for mount options.
 151  *
 152  * Note: don't forget to add new options to btrfs_show_options()
 153  */
 154 enum {
 155         BTRFS_MOUNT_NODATASUM                   = (1UL << 0),
 156         BTRFS_MOUNT_NODATACOW                   = (1UL << 1),
 157         BTRFS_MOUNT_NOBARRIER                   = (1UL << 2),
 158         BTRFS_MOUNT_SSD                         = (1UL << 3),
 159         BTRFS_MOUNT_DEGRADED                    = (1UL << 4),
 160         BTRFS_MOUNT_COMPRESS                    = (1UL << 5),
 161         BTRFS_MOUNT_NOTREELOG                   = (1UL << 6),
 162         BTRFS_MOUNT_FLUSHONCOMMIT               = (1UL << 7),
 163         BTRFS_MOUNT_SSD_SPREAD                  = (1UL << 8),
 164         BTRFS_MOUNT_NOSSD                       = (1UL << 9),
 165         BTRFS_MOUNT_DISCARD_SYNC                = (1UL << 10),
 166         BTRFS_MOUNT_FORCE_COMPRESS              = (1UL << 11),
 167         BTRFS_MOUNT_SPACE_CACHE                 = (1UL << 12),
 168         BTRFS_MOUNT_CLEAR_CACHE                 = (1UL << 13),
 169         BTRFS_MOUNT_USER_SUBVOL_RM_ALLOWED      = (1UL << 14),
 170         BTRFS_MOUNT_ENOSPC_DEBUG                = (1UL << 15),
 171         BTRFS_MOUNT_AUTO_DEFRAG                 = (1UL << 16),
 172         BTRFS_MOUNT_USEBACKUPROOT               = (1UL << 17),
 173         BTRFS_MOUNT_SKIP_BALANCE                = (1UL << 18),
 174         BTRFS_MOUNT_PANIC_ON_FATAL_ERROR        = (1UL << 19),
 175         BTRFS_MOUNT_RESCAN_UUID_TREE            = (1UL << 20),
 176         BTRFS_MOUNT_FRAGMENT_DATA               = (1UL << 21),
 177         BTRFS_MOUNT_FRAGMENT_METADATA           = (1UL << 22),
 178         BTRFS_MOUNT_FREE_SPACE_TREE             = (1UL << 23),
 179         BTRFS_MOUNT_NOLOGREPLAY                 = (1UL << 24),
 180         BTRFS_MOUNT_REF_VERIFY                  = (1UL << 25),
 181         BTRFS_MOUNT_DISCARD_ASYNC               = (1UL << 26),
 182         BTRFS_MOUNT_IGNOREBADROOTS              = (1UL << 27),
 183         BTRFS_MOUNT_IGNOREDATACSUMS             = (1UL << 28),
 184         BTRFS_MOUNT_NODISCARD                   = (1UL << 29),
 185 };
 186
 187 /*
 188  * Compat flags that we support.  If any incompat flags are set other than the
 189  * ones specified below then we will fail to mount
 190  */
 191 #define BTRFS_FEATURE_COMPAT_SUPP               0ULL
 192 #define BTRFS_FEATURE_COMPAT_SAFE_SET           0ULL
 193 #define BTRFS_FEATURE_COMPAT_SAFE_CLEAR         0ULL
 194
 195 #define BTRFS_FEATURE_COMPAT_RO_SUPP                    \
 196         (BTRFS_FEATURE_COMPAT_RO_FREE_SPACE_TREE |      \
 197          BTRFS_FEATURE_COMPAT_RO_FREE_SPACE_TREE_VALID | \
 198          BTRFS_FEATURE_COMPAT_RO_VERITY |               \
 199          BTRFS_FEATURE_COMPAT_RO_BLOCK_GROUP_TREE)
 200
 201 #define BTRFS_FEATURE_COMPAT_RO_SAFE_SET        0ULL
 202 #define BTRFS_FEATURE_COMPAT_RO_SAFE_CLEAR      0ULL
 203
 204 #define BTRFS_FEATURE_INCOMPAT_SUPP_STABLE              \
 205         (BTRFS_FEATURE_INCOMPAT_MIXED_BACKREF |         \
 206          BTRFS_FEATURE_INCOMPAT_DEFAULT_SUBVOL |        \
 207          BTRFS_FEATURE_INCOMPAT_MIXED_GROUPS |          \
 208          BTRFS_FEATURE_INCOMPAT_BIG_METADATA |          \
 209          BTRFS_FEATURE_INCOMPAT_COMPRESS_LZO |          \
 210          BTRFS_FEATURE_INCOMPAT_COMPRESS_ZSTD |         \
 211          BTRFS_FEATURE_INCOMPAT_RAID56 |                \
 212          BTRFS_FEATURE_INCOMPAT_EXTENDED_IREF |         \
 213          BTRFS_FEATURE_INCOMPAT_SKINNY_METADATA |       \
 214          BTRFS_FEATURE_INCOMPAT_NO_HOLES        |       \
 215          BTRFS_FEATURE_INCOMPAT_METADATA_UUID   |       \
 216          BTRFS_FEATURE_INCOMPAT_RAID1C34        |       \
 217          BTRFS_FEATURE_INCOMPAT_ZONED)
 218
 219 #ifdef CONFIG_BTRFS_DEBUG
 220         /*
 221          * Features under developmen like Extent tree v2 support is enabled
 222          * only under CONFIG_BTRFS_DEBUG.
 223          */
 224 #define BTRFS_FEATURE_INCOMPAT_SUPP             \
 225         (BTRFS_FEATURE_INCOMPAT_SUPP_STABLE |   \
 226          BTRFS_FEATURE_INCOMPAT_EXTENT_TREE_V2)
 227
 228 #else
 229
 230 #define BTRFS_FEATURE_INCOMPAT_SUPP             \
 231         (BTRFS_FEATURE_INCOMPAT_SUPP_STABLE)
 232
 233 #endif
 234
 235 #define BTRFS_FEATURE_INCOMPAT_SAFE_SET                 \
 236         (BTRFS_FEATURE_INCOMPAT_EXTENDED_IREF)
 237 #define BTRFS_FEATURE_INCOMPAT_SAFE_CLEAR               0ULL
 238
 239 #define BTRFS_DEFAULT_COMMIT_INTERVAL   (30)
 240 #define BTRFS_DEFAULT_MAX_INLINE        (2048)
 241
 242 struct btrfs_dev_replace {
 243         /* See #define above */
 244         u64 replace_state;
 245         /* Seconds since 1-Jan-1970 */
 246         time64_t time_started;
 247         /* Seconds since 1-Jan-1970 */
 248         time64_t time_stopped;
 249         atomic64_t num_write_errors;
 250         atomic64_t num_uncorrectable_read_errors;
 251
 252         u64 cursor_left;
 253         u64 committed_cursor_left;
 254         u64 cursor_left_last_write_of_item;
 255         u64 cursor_right;
 256
 257         /* See #define above */
 258         u64 cont_reading_from_srcdev_mode;
 259
 260         int is_valid;
 261         int item_needs_writeback;
 262         struct btrfs_device *srcdev;
 263         struct btrfs_device *tgtdev;
 264
 265         struct mutex lock_finishing_cancel_unmount;
 266         struct rw_semaphore rwsem;
 267
 268         struct btrfs_scrub_progress scrub_progress;
 269
 270         struct percpu_counter bio_counter;
 271         wait_queue_head_t replace_wait;
 272 };
 273
 274 /*
 275  * Free clusters are used to claim free space in relatively large chunks,
 276  * allowing us to do less seeky writes. They are used for all metadata
 277  * allocations. In ssd_spread mode they are also used for data allocations.
 278  */
 279 struct btrfs_free_cluster {
 280         spinlock_t lock;
 281         spinlock_t refill_lock;
 282         struct rb_root root;
 283
 284         /* Largest extent in this cluster */
 285         u64 max_size;
 286
 287         /* First extent starting offset */
 288         u64 window_start;
 289
 290         /* We did a full search and couldn't create a cluster */
 291         bool fragmented;
 292
 293         struct btrfs_block_group *block_group;
 294         /*
 295          * When a cluster is allocated from a block group, we put the cluster
 296          * onto a list in the block group so that it can be freed before the
 297          * block group is freed.
 298          */
 299         struct list_head block_group_list;
 300 };
 301
 302 /* Discard control. */
 303 /*
 304  * Async discard uses multiple lists to differentiate the discard filter
 305  * parameters.  Index 0 is for completely free block groups where we need to
 306  * ensure the entire block group is trimmed without being lossy.  Indices
 307  * afterwards represent monotonically decreasing discard filter sizes to
 308  * prioritize what should be discarded next.
 309  */
 310 #define BTRFS_NR_DISCARD_LISTS          3
 311 #define BTRFS_DISCARD_INDEX_UNUSED      0
 312 #define BTRFS_DISCARD_INDEX_START       1
 313
 314 struct btrfs_discard_ctl {
 315         struct workqueue_struct *discard_workers;
 316         struct delayed_work work;
 317         spinlock_t lock;
 318         struct btrfs_block_group *block_group;
 319         struct list_head discard_list[BTRFS_NR_DISCARD_LISTS];
 320         u64 prev_discard;
 321         u64 prev_discard_time;
 322         atomic_t discardable_extents;
 323         atomic64_t discardable_bytes;
 324         u64 max_discard_size;
 325         u64 delay_ms;
 326         u32 iops_limit;
 327         u32 kbps_limit;
 328         u64 discard_extent_bytes;
 329         u64 discard_bitmap_bytes;
 330         atomic64_t discard_bytes_saved;
 331 };
 332
 333 /*
 334  * Exclusive operations (device replace, resize, device add/remove, balance)
 335  */
 336 enum btrfs_exclusive_operation {
 337         BTRFS_EXCLOP_NONE,
 338         BTRFS_EXCLOP_BALANCE_PAUSED,
 339         BTRFS_EXCLOP_BALANCE,
 340         BTRFS_EXCLOP_DEV_ADD,
 341         BTRFS_EXCLOP_DEV_REMOVE,
 342         BTRFS_EXCLOP_DEV_REPLACE,
 343         BTRFS_EXCLOP_RESIZE,
 344         BTRFS_EXCLOP_SWAP_ACTIVATE,
 345 };
 346
 347 /* Store data about transaction commits, exported via sysfs. */
 348 struct btrfs_commit_stats {
 349         /* Total number of commits */
 350         u64 commit_count;
 351         /* The maximum commit duration so far in ns */
 352         u64 max_commit_dur;
 353         /* The last commit duration in ns */
 354         u64 last_commit_dur;
 355         /* The total commit duration in ns */
 356         u64 total_commit_dur;
 357 };
 358
 359 struct btrfs_fs_info {
 360         u8 chunk_tree_uuid[BTRFS_UUID_SIZE];
 361         unsigned long flags;
 362         struct btrfs_root *tree_root;
 363         struct btrfs_root *chunk_root;
 364         struct btrfs_root *dev_root;
 365         struct btrfs_root *fs_root;
 366         struct btrfs_root *quota_root;
 367         struct btrfs_root *uuid_root;
 368         struct btrfs_root *data_reloc_root;
 369         struct btrfs_root *block_group_root;
 370
 371         /* The log root tree is a directory of all the other log roots */
 372         struct btrfs_root *log_root_tree;
 373
 374         /* The tree that holds the global roots (csum, extent, etc) */
 375         rwlock_t global_root_lock;
 376         struct rb_root global_root_tree;
 377
 378         spinlock_t fs_roots_radix_lock;
 379         struct radix_tree_root fs_roots_radix;
 380
 381         /* Block group cache stuff */
 382         rwlock_t block_group_cache_lock;
 383         struct rb_root_cached block_group_cache_tree;
 384
 385         /* Keep track of unallocated space */
 386         atomic64_t free_chunk_space;
 387
 388         /* Track ranges which are used by log trees blocks/logged data extents */
 389         struct extent_io_tree excluded_extents;
 390
 391         /* logical->physical extent mapping */
 392         struct extent_map_tree mapping_tree;
 393
 394         /*
 395          * Block reservation for extent, checksum, root tree and delayed dir
 396          * index item.
 397          */
 398         struct btrfs_block_rsv global_block_rsv;
 399         /* Block reservation for metadata operations */
 400         struct btrfs_block_rsv trans_block_rsv;
 401         /* Block reservation for chunk tree */
 402         struct btrfs_block_rsv chunk_block_rsv;
 403         /* Block reservation for delayed operations */
 404         struct btrfs_block_rsv delayed_block_rsv;
 405         /* Block reservation for delayed refs */
 406         struct btrfs_block_rsv delayed_refs_rsv;
 407
 408         struct btrfs_block_rsv empty_block_rsv;
 409
 410         u64 generation;
 411         u64 last_trans_committed;
 412         /*
 413          * Generation of the last transaction used for block group relocation
 414          * since the filesystem was last mounted (or 0 if none happened yet).
 415          * Must be written and read while holding btrfs_fs_info::commit_root_sem.
 416          */
 417         u64 last_reloc_trans;
 418
 419         /*
 420          * This is updated to the current trans every time a full commit is
 421          * required instead of the faster short fsync log commits
 422          */
 423         u64 last_trans_log_full_commit;
 424         unsigned long mount_opt;
 425
 426         unsigned long compress_type:4;
 427         unsigned int compress_level;
 428         u32 commit_interval;
 429         /*
 430          * It is a suggestive number, the read side is safe even it gets a
 431          * wrong number because we will write out the data into a regular
 432          * extent. The write side(mount/remount) is under ->s_umount lock,
 433          * so it is also safe.
 434          */
 435         u64 max_inline;
 436
 437         struct btrfs_transaction *running_transaction;
 438         wait_queue_head_t transaction_throttle;
 439         wait_queue_head_t transaction_wait;
 440         wait_queue_head_t transaction_blocked_wait;
 441         wait_queue_head_t async_submit_wait;
 442
 443         /*
 444          * Used to protect the incompat_flags, compat_flags, compat_ro_flags
 445          * when they are updated.
 446          *
 447          * Because we do not clear the flags for ever, so we needn't use
 448          * the lock on the read side.
 449          *
 450          * We also needn't use the lock when we mount the fs, because
 451          * there is no other task which will update the flag.
 452          */
 453         spinlock_t super_lock;
 454         struct btrfs_super_block *super_copy;
 455         struct btrfs_super_block *super_for_commit;
 456         struct super_block *sb;
 457         struct inode *btree_inode;
 458         struct mutex tree_log_mutex;
 459         struct mutex transaction_kthread_mutex;
 460         struct mutex cleaner_mutex;
 461         struct mutex chunk_mutex;
 462
 463         /*
 464          * This is taken to make sure we don't set block groups ro after the
 465          * free space cache has been allocated on them.
 466          */
 467         struct mutex ro_block_group_mutex;
 468
 469         /*
 470          * This is used during read/modify/write to make sure no two ios are
 471          * trying to mod the same stripe at the same time.
 472          */
 473         struct btrfs_stripe_hash_table *stripe_hash_table;
 474
 475         /*
 476          * This protects the ordered operations list only while we are
 477          * processing all of the entries on it.  This way we make sure the
 478          * commit code doesn't find the list temporarily empty because another
 479          * function happens to be doing non-waiting preflush before jumping
 480          * into the main commit.
 481          */
 482         struct mutex ordered_operations_mutex;
 483
 484         struct rw_semaphore commit_root_sem;
 485
 486         struct rw_semaphore cleanup_work_sem;
 487
 488         struct rw_semaphore subvol_sem;
 489
 490         spinlock_t trans_lock;
 491         /*
 492          * The reloc mutex goes with the trans lock, it is taken during commit
 493          * to protect us from the relocation code.
 494          */
 495         struct mutex reloc_mutex;
 496
 497         struct list_head trans_list;
 498         struct list_head dead_roots;
 499         struct list_head caching_block_groups;
 500
 501         spinlock_t delayed_iput_lock;
 502         struct list_head delayed_iputs;
 503         atomic_t nr_delayed_iputs;
 504         wait_queue_head_t delayed_iputs_wait;
 505
 506         atomic64_t tree_mod_seq;
 507
 508         /* This protects tree_mod_log and tree_mod_seq_list */
 509         rwlock_t tree_mod_log_lock;
 510         struct rb_root tree_mod_log;
 511         struct list_head tree_mod_seq_list;
 512
 513         atomic_t async_delalloc_pages;
 514
 515         /* This is used to protect the following list -- ordered_roots. */
 516         spinlock_t ordered_root_lock;
 517
 518         /*
 519          * All fs/file tree roots in which there are data=ordered extents
 520          * pending writeback are added into this list.
 521          *
 522          * These can span multiple transactions and basically include every
 523          * dirty data page that isn't from nodatacow.
 524          */
 525         struct list_head ordered_roots;
 526
 527         struct mutex delalloc_root_mutex;
 528         spinlock_t delalloc_root_lock;
 529         /* All fs/file tree roots that have delalloc inodes. */
 530         struct list_head delalloc_roots;
 531
 532         /*
 533          * There is a pool of worker threads for checksumming during writes and
 534          * a pool for checksumming after reads.  This is because readers can
 535          * run with FS locks held, and the writers may be waiting for those
 536          * locks.  We don't want ordering in the pending list to cause
 537          * deadlocks, and so the two are serviced separately.
 538          *
 539          * A third pool does submit_bio to avoid deadlocking with the other two.
 540          */
 541         struct btrfs_workqueue *workers;
 542         struct btrfs_workqueue *delalloc_workers;
 543         struct btrfs_workqueue *flush_workers;
 544         struct workqueue_struct *endio_workers;
 545         struct workqueue_struct *endio_meta_workers;
 546         struct workqueue_struct *rmw_workers;
 547         struct workqueue_struct *compressed_write_workers;
 548         struct btrfs_workqueue *endio_write_workers;
 549         struct btrfs_workqueue *endio_freespace_worker;
 550         struct btrfs_workqueue *caching_workers;
 551
 552         /*
 553          * Fixup workers take dirty pages that didn't properly go through the
 554          * cow mechanism and make them safe to write.  It happens for the
 555          * sys_munmap function call path.
 556          */
 557         struct btrfs_workqueue *fixup_workers;
 558         struct btrfs_workqueue *delayed_workers;
 559
 560         struct task_struct *transaction_kthread;
 561         struct task_struct *cleaner_kthread;
 562         u32 thread_pool_size;
 563
 564         struct kobject *space_info_kobj;
 565         struct kobject *qgroups_kobj;
 566         struct kobject *discard_kobj;
 567
 568         /* Used to keep from writing metadata until there is a nice batch */
 569         struct percpu_counter dirty_metadata_bytes;
 570         struct percpu_counter delalloc_bytes;
 571         struct percpu_counter ordered_bytes;
 572         s32 dirty_metadata_batch;
 573         s32 delalloc_batch;
 574
 575         /* Protected by 'trans_lock'. */
 576         struct list_head dirty_cowonly_roots;
 577
 578         struct btrfs_fs_devices *fs_devices;
 579
 580         /*
 581          * The space_info list is effectively read only after initial setup.
 582          * It is populated at mount time and cleaned up after all block groups
 583          * are removed.  RCU is used to protect it.
 584          */
 585         struct list_head space_info;
 586
 587         struct btrfs_space_info *data_sinfo;
 588
 589         struct reloc_control *reloc_ctl;
 590
 591         /* data_alloc_cluster is only used in ssd_spread mode */
 592         struct btrfs_free_cluster data_alloc_cluster;
 593
 594         /* All metadata allocations go through this cluster. */
 595         struct btrfs_free_cluster meta_alloc_cluster;
 596
 597         /* Auto defrag inodes go here. */
 598         spinlock_t defrag_inodes_lock;
 599         struct rb_root defrag_inodes;
 600         atomic_t defrag_running;
 601
 602         /* Used to protect avail_{data, metadata, system}_alloc_bits */
 603         seqlock_t profiles_lock;
 604         /*
 605          * These three are in extended format (availability of single chunks is
 606          * denoted by BTRFS_AVAIL_ALLOC_BIT_SINGLE bit, other types are denoted
 607          * by corresponding BTRFS_BLOCK_GROUP_* bits)
 608          */
 609         u64 avail_data_alloc_bits;
 610         u64 avail_metadata_alloc_bits;
 611         u64 avail_system_alloc_bits;
 612
 613         /* Balance state */
 614         spinlock_t balance_lock;
 615         struct mutex balance_mutex;
 616         atomic_t balance_pause_req;
 617         atomic_t balance_cancel_req;
 618         struct btrfs_balance_control *balance_ctl;
 619         wait_queue_head_t balance_wait_q;
 620
 621         /* Cancellation requests for chunk relocation */
 622         atomic_t reloc_cancel_req;
 623
 624         u32 data_chunk_allocations;
 625         u32 metadata_ratio;
 626
 627         void *bdev_holder;
 628
 629         /* Private scrub information */
 630         struct mutex scrub_lock;
 631         atomic_t scrubs_running;
 632         atomic_t scrub_pause_req;
 633         atomic_t scrubs_paused;
 634         atomic_t scrub_cancel_req;
 635         wait_queue_head_t scrub_pause_wait;
 636         /*
 637          * The worker pointers are NULL iff the refcount is 0, ie. scrub is not
 638          * running.
 639          */
 640         refcount_t scrub_workers_refcnt;
 641         struct workqueue_struct *scrub_workers;
 642         struct btrfs_subpage_info *subpage_info;
 643
 644         struct btrfs_discard_ctl discard_ctl;
 645
 646         /* Is qgroup tracking in a consistent state? */
 647         u64 qgroup_flags;
 648
 649         /* Holds configuration and tracking. Protected by qgroup_lock. */
 650         struct rb_root qgroup_tree;
 651         spinlock_t qgroup_lock;
 652
 653         /*
 654          * Used to avoid frequently calling ulist_alloc()/ulist_free()
 655          * when doing qgroup accounting, it must be protected by qgroup_lock.
 656          */
 657         struct ulist *qgroup_ulist;
 658
 659         /*
 660          * Protect user change for quota operations. If a transaction is needed,
 661          * it must be started before locking this lock.
 662          */
 663         struct mutex qgroup_ioctl_lock;
 664
 665         /* List of dirty qgroups to be written at next commit. */
 666         struct list_head dirty_qgroups;
 667
 668         /* Used by qgroup for an efficient tree traversal. */
 669         u64 qgroup_seq;
 670
 671         /* Qgroup rescan items. */
 672         /* Protects the progress item */
 673         struct mutex qgroup_rescan_lock;
 674         struct btrfs_key qgroup_rescan_progress;
 675         struct btrfs_workqueue *qgroup_rescan_workers;
 676         struct completion qgroup_rescan_completion;
 677         struct btrfs_work qgroup_rescan_work;
 678         /* Protected by qgroup_rescan_lock */
 679         bool qgroup_rescan_running;
 680         u8 qgroup_drop_subtree_thres;
 681
 682         /*
 683          * If this is not 0, then it indicates a serious filesystem error has
 684          * happened and it contains that error (negative errno value).
 685          */
 686         int fs_error;
 687
 688         /* Filesystem state */
 689         unsigned long fs_state;
 690
 691         struct btrfs_delayed_root *delayed_root;
 692
 693         /* Extent buffer radix tree */
 694         spinlock_t buffer_lock;
 695         /* Entries are eb->start / sectorsize */
 696         struct radix_tree_root buffer_radix;
 697
 698         /* Next backup root to be overwritten */
 699         int backup_root_index;
 700
 701         /* Device replace state */
 702         struct btrfs_dev_replace dev_replace;
 703
 704         struct semaphore uuid_tree_rescan_sem;
 705
 706         /* Used to reclaim the metadata space in the background. */
 707         struct work_struct async_reclaim_work;
 708         struct work_struct async_data_reclaim_work;
 709         struct work_struct preempt_reclaim_work;
 710
 711         /* Reclaim partially filled block groups in the background */
 712         struct work_struct reclaim_bgs_work;
 713         struct list_head reclaim_bgs;
 714         int bg_reclaim_threshold;
 715
 716         spinlock_t unused_bgs_lock;
 717         struct list_head unused_bgs;
 718         struct mutex unused_bg_unpin_mutex;
 719         /* Protect block groups that are going to be deleted */
 720         struct mutex reclaim_bgs_lock;
 721
 722         /* Cached block sizes */
 723         u32 nodesize;
 724         u32 sectorsize;
 725         /* ilog2 of sectorsize, use to avoid 64bit division */
 726         u32 sectorsize_bits;
 727         u32 csum_size;
 728         u32 csums_per_leaf;
 729         u32 stripesize;
 730
 731         /*
 732          * Maximum size of an extent. BTRFS_MAX_EXTENT_SIZE on regular
 733          * filesystem, on zoned it depends on the device constraints.
 734          */
 735         u64 max_extent_size;
 736
 737         /* Block groups and devices containing active swapfiles. */
 738         spinlock_t swapfile_pins_lock;
 739         struct rb_root swapfile_pins;
 740
 741         struct crypto_shash *csum_shash;
 742
 743         /* Type of exclusive operation running, protected by super_lock */
 744         enum btrfs_exclusive_operation exclusive_operation;
 745
 746         /*
 747          * Zone size > 0 when in ZONED mode, otherwise it's used for a check
 748          * if the mode is enabled
 749          */
 750         u64 zone_size;
 751
 752         /* Constraints for ZONE_APPEND commands: */
 753         struct queue_limits limits;
 754         u64 max_zone_append_size;
 755
 756         struct mutex zoned_meta_io_lock;
 757         spinlock_t treelog_bg_lock;
 758         u64 treelog_bg;
 759
 760         /*
 761          * Start of the dedicated data relocation block group, protected by
 762          * relocation_bg_lock.
 763          */
 764         spinlock_t relocation_bg_lock;
 765         u64 data_reloc_bg;
 766         struct mutex zoned_data_reloc_io_lock;
 767
 768         struct btrfs_block_group *active_meta_bg;
 769         struct btrfs_block_group *active_system_bg;
 770
 771         u64 nr_global_roots;
 772
 773         spinlock_t zone_active_bgs_lock;
 774         struct list_head zone_active_bgs;
 775
 776         /* Updates are not protected by any lock */
 777         struct btrfs_commit_stats commit_stats;
 778
 779         /*
 780          * Last generation where we dropped a non-relocation root.
 781          * Use btrfs_set_last_root_drop_gen() and btrfs_get_last_root_drop_gen()
 782          * to change it and to read it, respectively.
 783          */
 784         u64 last_root_drop_gen;
 785
 786         /*
 787          * Annotations for transaction events (structures are empty when
 788          * compiled without lockdep).
 789          */
 790         struct lockdep_map btrfs_trans_num_writers_map;
 791         struct lockdep_map btrfs_trans_num_extwriters_map;
 792         struct lockdep_map btrfs_state_change_map[4];
 793         struct lockdep_map btrfs_trans_pending_ordered_map;
 794         struct lockdep_map btrfs_ordered_extent_map;
 795
 796 #ifdef CONFIG_BTRFS_FS_REF_VERIFY
 797         spinlock_t ref_verify_lock;
 798         struct rb_root block_tree;
 799 #endif
 800
 801 #ifdef CONFIG_BTRFS_DEBUG
 802         struct kobject *debug_kobj;
 803         struct list_head allocated_roots;
 804
 805         spinlock_t eb_leak_lock;
 806         struct list_head allocated_ebs;
 807 #endif
 808 };
 809
 810 static inline void btrfs_set_last_root_drop_gen(struct btrfs_fs_info *fs_info,
 811                                                 u64 gen)
 812 {
 813         WRITE_ONCE(fs_info->last_root_drop_gen, gen);
 814 }
 815
 816 static inline u64 btrfs_get_last_root_drop_gen(const struct btrfs_fs_info *fs_info)
 817 {
 818         return READ_ONCE(fs_info->last_root_drop_gen);
 819 }
 820
 821 /*
 822  * Take the number of bytes to be checksummed and figure out how many leaves
 823  * it would require to store the csums for that many bytes.
 824  */
 825 static inline u64 btrfs_csum_bytes_to_leaves(
 826                         const struct btrfs_fs_info *fs_info, u64 csum_bytes)
 827 {
 828         const u64 num_csums = csum_bytes >> fs_info->sectorsize_bits;
 829
 830         return DIV_ROUND_UP_ULL(num_csums, fs_info->csums_per_leaf);
 831 }
 832
 833 /*
 834  * Use this if we would be adding new items, as we could split nodes as we cow
 835  * down the tree.
 836  */
 837 static inline u64 btrfs_calc_insert_metadata_size(const struct btrfs_fs_info *fs_info,
 838                                                   unsigned num_items)
 839 {
 840         return (u64)fs_info->nodesize * BTRFS_MAX_LEVEL * 2 * num_items;
 841 }
 842
 843 /*
 844  * Doing a truncate or a modification won't result in new nodes or leaves, just
 845  * what we need for COW.
 846  */
 847 static inline u64 btrfs_calc_metadata_size(const struct btrfs_fs_info *fs_info,
 848                                                  unsigned num_items)
 849 {
 850         return (u64)fs_info->nodesize * BTRFS_MAX_LEVEL * num_items;
 851 }
 852
 853 #define BTRFS_MAX_EXTENT_ITEM_SIZE(r) ((BTRFS_LEAF_DATA_SIZE(r->fs_info) >> 4) - \
 854                                         sizeof(struct btrfs_item))
 855
 856 static inline bool btrfs_is_zoned(const struct btrfs_fs_info *fs_info)
 857 {
 858         return IS_ENABLED(CONFIG_BLK_DEV_ZONED) && fs_info->zone_size > 0;
 859 }
 860
 861 /*
 862  * Count how many fs_info->max_extent_size cover the @size
 863  */
 864 static inline u32 count_max_extents(struct btrfs_fs_info *fs_info, u64 size)
 865 {
 866 #ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
 867         if (!fs_info)
 868                 return div_u64(size + BTRFS_MAX_EXTENT_SIZE - 1, BTRFS_MAX_EXTENT_SIZE);
 869 #endif
 870
 871         return div_u64(size + fs_info->max_extent_size - 1, fs_info->max_extent_size);
 872 }
 873
 874 bool btrfs_exclop_start(struct btrfs_fs_info *fs_info,
 875                         enum btrfs_exclusive_operation type);
 876 bool btrfs_exclop_start_try_lock(struct btrfs_fs_info *fs_info,
 877                                  enum btrfs_exclusive_operation type);
 878 void btrfs_exclop_start_unlock(struct btrfs_fs_info *fs_info);
 879 void btrfs_exclop_finish(struct btrfs_fs_info *fs_info);
 880 void btrfs_exclop_balance(struct btrfs_fs_info *fs_info,
 881                           enum btrfs_exclusive_operation op);
 882
 883 /* Compatibility and incompatibility defines */
 884 void __btrfs_set_fs_incompat(struct btrfs_fs_info *fs_info, u64 flag,
 885                              const char *name);
 886 void __btrfs_clear_fs_incompat(struct btrfs_fs_info *fs_info, u64 flag,
 887                                const char *name);
 888 void __btrfs_set_fs_compat_ro(struct btrfs_fs_info *fs_info, u64 flag,
 889                               const char *name);
 890 void __btrfs_clear_fs_compat_ro(struct btrfs_fs_info *fs_info, u64 flag,
 891                                 const char *name);
 892
 893 #define __btrfs_fs_incompat(fs_info, flags)                             \
 894         (!!(btrfs_super_incompat_flags((fs_info)->super_copy) & (flags)))
 895
 896 #define __btrfs_fs_compat_ro(fs_info, flags)                            \
 897         (!!(btrfs_super_compat_ro_flags((fs_info)->super_copy) & (flags)))
 898
 899 #define btrfs_set_fs_incompat(__fs_info, opt)                           \
 900         __btrfs_set_fs_incompat((__fs_info), BTRFS_FEATURE_INCOMPAT_##opt, #opt)
 901
 902 #define btrfs_clear_fs_incompat(__fs_info, opt)                         \
 903         __btrfs_clear_fs_incompat((__fs_info), BTRFS_FEATURE_INCOMPAT_##opt, #opt)
 904
 905 #define btrfs_fs_incompat(fs_info, opt)                                 \
 906         __btrfs_fs_incompat((fs_info), BTRFS_FEATURE_INCOMPAT_##opt)
 907
 908 #define btrfs_set_fs_compat_ro(__fs_info, opt)                          \
 909         __btrfs_set_fs_compat_ro((__fs_info), BTRFS_FEATURE_COMPAT_RO_##opt, #opt)
 910
 911 #define btrfs_clear_fs_compat_ro(__fs_info, opt)                        \
 912         __btrfs_clear_fs_compat_ro((__fs_info), BTRFS_FEATURE_COMPAT_RO_##opt, #opt)
 913
 914 #define btrfs_fs_compat_ro(fs_info, opt)                                \
 915         __btrfs_fs_compat_ro((fs_info), BTRFS_FEATURE_COMPAT_RO_##opt)
 916
 917 #define btrfs_clear_opt(o, opt)         ((o) &= ~BTRFS_MOUNT_##opt)
 918 #define btrfs_set_opt(o, opt)           ((o) |= BTRFS_MOUNT_##opt)
 919 #define btrfs_raw_test_opt(o, opt)      ((o) & BTRFS_MOUNT_##opt)
 920 #define btrfs_test_opt(fs_info, opt)    ((fs_info)->mount_opt & \
 921                                          BTRFS_MOUNT_##opt)
 922
 923 #define btrfs_set_and_info(fs_info, opt, fmt, args...)                  \
 924 do {                                                                    \
 925         if (!btrfs_test_opt(fs_info, opt))                              \
 926                 btrfs_info(fs_info, fmt, ##args);                       \
 927         btrfs_set_opt(fs_info->mount_opt, opt);                         \
 928 } while (0)
 929
 930 #define btrfs_clear_and_info(fs_info, opt, fmt, args...)                \
 931 do {                                                                    \
 932         if (btrfs_test_opt(fs_info, opt))                               \
 933                 btrfs_info(fs_info, fmt, ##args);                       \
 934         btrfs_clear_opt(fs_info->mount_opt, opt);                       \
 935 } while (0)
 936
 937 static inline int btrfs_fs_closing(struct btrfs_fs_info *fs_info)
 938 {
 939         /* Do it this way so we only ever do one test_bit in the normal case. */
 940         if (test_bit(BTRFS_FS_CLOSING_START, &fs_info->flags)) {
 941                 if (test_bit(BTRFS_FS_CLOSING_DONE, &fs_info->flags))
 942                         return 2;
 943                 return 1;
 944         }
 945         return 0;
 946 }
 947
 948 /*
 949  * If we remount the fs to be R/O or umount the fs, the cleaner needn't do
 950  * anything except sleeping. This function is used to check the status of
 951  * the fs.
 952  * We check for BTRFS_FS_STATE_RO to avoid races with a concurrent remount,
 953  * since setting and checking for SB_RDONLY in the superblock's flags is not
 954  * atomic.
 955  */
 956 static inline int btrfs_need_cleaner_sleep(struct btrfs_fs_info *fs_info)
 957 {
 958         return test_bit(BTRFS_FS_STATE_RO, &fs_info->fs_state) ||
 959                 btrfs_fs_closing(fs_info);
 960 }
 961
 962 static inline void btrfs_wake_unfinished_drop(struct btrfs_fs_info *fs_info)
 963 {
 964         clear_and_wake_up_bit(BTRFS_FS_UNFINISHED_DROPS, &fs_info->flags);
 965 }
 966
 967 #define BTRFS_FS_ERROR(fs_info) (READ_ONCE((fs_info)->fs_error))
 968
 969 #define BTRFS_FS_LOG_CLEANUP_ERROR(fs_info)                             \
 970         (unlikely(test_bit(BTRFS_FS_STATE_LOG_CLEANUP_ERROR,            \
 971                            &(fs_info)->fs_state)))
 972
 973 #ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
 974
 975 #define EXPORT_FOR_TESTS
 976
 977 static inline int btrfs_is_testing(struct btrfs_fs_info *fs_info)
 978 {
 979         return test_bit(BTRFS_FS_STATE_DUMMY_FS_INFO, &fs_info->fs_state);
 980 }
 981
 982 void btrfs_test_destroy_inode(struct inode *inode);
 983
 984 #else
 985
 986 #define EXPORT_FOR_TESTS static
 987
 988 static inline int btrfs_is_testing(struct btrfs_fs_info *fs_info)
 989 {
 990         return 0;
 991 }
 992 #endif
 993
 994 #endif