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