fs/btrfs/disk-io.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Copyright (C) 2007 Oracle.  All rights reserved.
   4  */
   5
   6 #ifndef BTRFS_DISK_IO_H
   7 #define BTRFS_DISK_IO_H
   8
   9 #define BTRFS_SUPER_MIRROR_MAX   3
  10 #define BTRFS_SUPER_MIRROR_SHIFT 12
  11
  12 /*
  13  * Fixed blocksize for all devices, applies to specific ways of reading
  14  * metadata like superblock. Must meet the set_blocksize requirements.
  15  *
  16  * Do not change.
  17  */
  18 #define BTRFS_BDEV_BLOCKSIZE    (4096)
  19
  20 enum btrfs_wq_endio_type {
  21         BTRFS_WQ_ENDIO_DATA,
  22         BTRFS_WQ_ENDIO_METADATA,
  23         BTRFS_WQ_ENDIO_FREE_SPACE,
  24 };
  25
  26 static inline u64 btrfs_sb_offset(int mirror)
  27 {
  28         u64 start = SZ_16K;
  29         if (mirror)
  30                 return start << (BTRFS_SUPER_MIRROR_SHIFT * mirror);
  31         return BTRFS_SUPER_INFO_OFFSET;
  32 }
  33
  34 struct btrfs_device;
  35 struct btrfs_fs_devices;
  36
  37 void btrfs_check_leaked_roots(struct btrfs_fs_info *fs_info);
  38 void btrfs_init_fs_info(struct btrfs_fs_info *fs_info);
  39 int btrfs_verify_level_key(struct extent_buffer *eb, int level,
  40                            struct btrfs_key *first_key, u64 parent_transid);
  41 struct extent_buffer *read_tree_block(struct btrfs_fs_info *fs_info, u64 bytenr,
  42                                       u64 owner_root, u64 parent_transid,
  43                                       int level, struct btrfs_key *first_key);
  44 struct extent_buffer *btrfs_find_create_tree_block(
  45                                                 struct btrfs_fs_info *fs_info,
  46                                                 u64 bytenr, u64 owner_root,
  47                                                 int level);
  48 void btrfs_clean_tree_block(struct extent_buffer *buf);
  49 void btrfs_clear_oneshot_options(struct btrfs_fs_info *fs_info);
  50 int btrfs_start_pre_rw_mount(struct btrfs_fs_info *fs_info);
  51 int __cold open_ctree(struct super_block *sb,
  52                struct btrfs_fs_devices *fs_devices,
  53                char *options);
  54 void __cold close_ctree(struct btrfs_fs_info *fs_info);
  55 int write_all_supers(struct btrfs_fs_info *fs_info, int max_mirrors);
  56 struct btrfs_super_block *btrfs_read_dev_super(struct block_device *bdev);
  57 struct btrfs_super_block *btrfs_read_dev_one_super(struct block_device *bdev,
  58                                                    int copy_num);
  59 int btrfs_commit_super(struct btrfs_fs_info *fs_info);
  60 struct btrfs_root *btrfs_read_tree_root(struct btrfs_root *tree_root,
  61                                         struct btrfs_key *key);
  62 int btrfs_insert_fs_root(struct btrfs_fs_info *fs_info,
  63                          struct btrfs_root *root);
  64 void btrfs_free_fs_roots(struct btrfs_fs_info *fs_info);
  65
  66 struct btrfs_root *btrfs_get_fs_root(struct btrfs_fs_info *fs_info,
  67                                      u64 objectid, bool check_ref);
  68 struct btrfs_root *btrfs_get_new_fs_root(struct btrfs_fs_info *fs_info,
  69                                          u64 objectid, dev_t anon_dev);
  70 struct btrfs_root *btrfs_get_fs_root_commit_root(struct btrfs_fs_info *fs_info,
  71                                                  struct btrfs_path *path,
  72                                                  u64 objectid);
  73 int btrfs_global_root_insert(struct btrfs_root *root);
  74 void btrfs_global_root_delete(struct btrfs_root *root);
  75 struct btrfs_root *btrfs_global_root(struct btrfs_fs_info *fs_info,
  76                                      struct btrfs_key *key);
  77 struct btrfs_root *btrfs_csum_root(struct btrfs_fs_info *fs_info, u64 bytenr);
  78 struct btrfs_root *btrfs_extent_root(struct btrfs_fs_info *fs_info, u64 bytenr);
  79
  80 void btrfs_free_fs_info(struct btrfs_fs_info *fs_info);
  81 int btrfs_cleanup_fs_roots(struct btrfs_fs_info *fs_info);
  82 void btrfs_btree_balance_dirty(struct btrfs_fs_info *fs_info);
  83 void btrfs_btree_balance_dirty_nodelay(struct btrfs_fs_info *fs_info);
  84 void btrfs_drop_and_free_fs_root(struct btrfs_fs_info *fs_info,
  85                                  struct btrfs_root *root);
  86 int btrfs_validate_metadata_buffer(struct btrfs_bio *bbio,
  87                                    struct page *page, u64 start, u64 end,
  88                                    int mirror);
  89 void btrfs_submit_metadata_bio(struct inode *inode, struct bio *bio, int mirror_num);
  90 #ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
  91 struct btrfs_root *btrfs_alloc_dummy_root(struct btrfs_fs_info *fs_info);
  92 #endif
  93
  94 /*
  95  * This function is used to grab the root, and avoid it is freed when we
  96  * access it. But it doesn't ensure that the tree is not dropped.
  97  *
  98  * If you want to ensure the whole tree is safe, you should use
  99  *      fs_info->subvol_srcu
 100  */
 101 static inline struct btrfs_root *btrfs_grab_root(struct btrfs_root *root)
 102 {
 103         if (!root)
 104                 return NULL;
 105         if (refcount_inc_not_zero(&root->refs))
 106                 return root;
 107         return NULL;
 108 }
 109
 110 static inline struct btrfs_root *btrfs_block_group_root(struct btrfs_fs_info *fs_info)
 111 {
 112         if (btrfs_fs_incompat(fs_info, EXTENT_TREE_V2))
 113                 return fs_info->block_group_root;
 114         return btrfs_extent_root(fs_info, 0);
 115 }
 116
 117 void btrfs_put_root(struct btrfs_root *root);
 118 void btrfs_mark_buffer_dirty(struct extent_buffer *buf);
 119 int btrfs_buffer_uptodate(struct extent_buffer *buf, u64 parent_transid,
 120                           int atomic);
 121 int btrfs_read_extent_buffer(struct extent_buffer *buf, u64 parent_transid,
 122                              int level, struct btrfs_key *first_key);
 123 blk_status_t btrfs_bio_wq_end_io(struct btrfs_fs_info *info, struct bio *bio,
 124                         enum btrfs_wq_endio_type metadata);
 125 blk_status_t btrfs_wq_submit_bio(struct inode *inode, struct bio *bio,
 126                                  int mirror_num, u64 dio_file_offset,
 127                                  extent_submit_bio_start_t *submit_bio_start);
 128 blk_status_t btrfs_submit_bio_done(void *private_data, struct bio *bio,
 129                           int mirror_num);
 130 int btrfs_alloc_log_tree_node(struct btrfs_trans_handle *trans,
 131                               struct btrfs_root *root);
 132 int btrfs_init_log_root_tree(struct btrfs_trans_handle *trans,
 133                              struct btrfs_fs_info *fs_info);
 134 int btrfs_add_log_tree(struct btrfs_trans_handle *trans,
 135                        struct btrfs_root *root);
 136 void btrfs_cleanup_dirty_bgs(struct btrfs_transaction *trans,
 137                              struct btrfs_fs_info *fs_info);
 138 void btrfs_cleanup_one_transaction(struct btrfs_transaction *trans,
 139                                   struct btrfs_fs_info *fs_info);
 140 struct btrfs_root *btrfs_create_tree(struct btrfs_trans_handle *trans,
 141                                      u64 objectid);
 142 int btree_lock_page_hook(struct page *page, void *data,
 143                                 void (*flush_fn)(void *));
 144 int btrfs_get_num_tolerated_disk_barrier_failures(u64 flags);
 145 int btrfs_get_free_objectid(struct btrfs_root *root, u64 *objectid);
 146 int btrfs_init_root_free_objectid(struct btrfs_root *root);
 147 int __init btrfs_end_io_wq_init(void);
 148 void __cold btrfs_end_io_wq_exit(void);
 149
 150 #ifdef CONFIG_DEBUG_LOCK_ALLOC
 151 void btrfs_set_buffer_lockdep_class(u64 objectid,
 152                                     struct extent_buffer *eb, int level);
 153 #else
 154 static inline void btrfs_set_buffer_lockdep_class(u64 objectid,
 155                                         struct extent_buffer *eb, int level)
 156 {
 157 }
 158 #endif
 159
 160 #endif