LXR linux/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
  20enum btrfs_wq_endio_type {
  21        BTRFS_WQ_ENDIO_DATA,
  22        BTRFS_WQ_ENDIO_METADATA,
  23        BTRFS_WQ_ENDIO_FREE_SPACE,
  24        BTRFS_WQ_ENDIO_RAID56,
  25};
  26
  27static inline u64 btrfs_sb_offset(int mirror)
  28{
  29        u64 start = SZ_16K;
  30        if (mirror)
  31                return start << (BTRFS_SUPER_MIRROR_SHIFT * mirror);
  32        return BTRFS_SUPER_INFO_OFFSET;
  33}
  34
  35struct btrfs_device;
  36struct btrfs_fs_devices;
  37
  38void btrfs_check_leaked_roots(struct btrfs_fs_info *fs_info);
  39void btrfs_init_fs_info(struct btrfs_fs_info *fs_info);
  40int btrfs_verify_level_key(struct extent_buffer *eb, int level,
  41                           struct btrfs_key *first_key, u64 parent_transid);
  42struct extent_buffer *read_tree_block(struct btrfs_fs_info *fs_info, u64 bytenr,
  43                                      u64 owner_root, u64 parent_transid,
  44                                      int level, struct btrfs_key *first_key);
  45struct extent_buffer *btrfs_find_create_tree_block(
  46                                                struct btrfs_fs_info *fs_info,
  47                                                u64 bytenr, u64 owner_root,
  48                                                int level);
  49void btrfs_clean_tree_block(struct extent_buffer *buf);
  50void btrfs_clear_oneshot_options(struct btrfs_fs_info *fs_info);
  51int btrfs_start_pre_rw_mount(struct btrfs_fs_info *fs_info);
  52int __cold open_ctree(struct super_block *sb,
  53               struct btrfs_fs_devices *fs_devices,
  54               char *options);
  55void __cold close_ctree(struct btrfs_fs_info *fs_info);
  56int write_all_supers(struct btrfs_fs_info *fs_info, int max_mirrors);
  57struct btrfs_super_block *btrfs_read_dev_super(struct block_device *bdev);
  58struct btrfs_super_block *btrfs_read_dev_one_super(struct block_device *bdev,
  59                                                   int copy_num);
  60int btrfs_commit_super(struct btrfs_fs_info *fs_info);
  61struct btrfs_root *btrfs_read_tree_root(struct btrfs_root *tree_root,
  62                                        struct btrfs_key *key);
  63int btrfs_insert_fs_root(struct btrfs_fs_info *fs_info,
  64                         struct btrfs_root *root);
  65void btrfs_free_fs_roots(struct btrfs_fs_info *fs_info);
  66
  67struct btrfs_root *btrfs_get_fs_root(struct btrfs_fs_info *fs_info,
  68                                     u64 objectid, bool check_ref);
  69struct btrfs_root *btrfs_get_new_fs_root(struct btrfs_fs_info *fs_info,
  70                                         u64 objectid, dev_t anon_dev);
  71struct btrfs_root *btrfs_get_fs_root_commit_root(struct btrfs_fs_info *fs_info,
  72                                                 struct btrfs_path *path,
  73                                                 u64 objectid);
  74
  75void btrfs_free_fs_info(struct btrfs_fs_info *fs_info);
  76int btrfs_cleanup_fs_roots(struct btrfs_fs_info *fs_info);
  77void btrfs_btree_balance_dirty(struct btrfs_fs_info *fs_info);
  78void btrfs_btree_balance_dirty_nodelay(struct btrfs_fs_info *fs_info);
  79void btrfs_drop_and_free_fs_root(struct btrfs_fs_info *fs_info,
  80                                 struct btrfs_root *root);
  81int btrfs_validate_metadata_buffer(struct btrfs_bio *bbio,
  82                                   struct page *page, u64 start, u64 end,
  83                                   int mirror);
  84blk_status_t btrfs_submit_metadata_bio(struct inode *inode, struct bio *bio,
  85                                       int mirror_num, unsigned long bio_flags);
  86#ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
  87struct btrfs_root *btrfs_alloc_dummy_root(struct btrfs_fs_info *fs_info);
  88#endif
  89
  90/*
  91 * This function is used to grab the root, and avoid it is freed when we
  92 * access it. But it doesn't ensure that the tree is not dropped.
  93 *
  94 * If you want to ensure the whole tree is safe, you should use
  95 *      fs_info->subvol_srcu
  96 */
  97static inline struct btrfs_root *btrfs_grab_root(struct btrfs_root *root)
  98{
  99        if (!root)
 100                return NULL;
 101        if (refcount_inc_not_zero(&root->refs))
 102                return root;
 103        return NULL;
 104}
 105
 106void btrfs_put_root(struct btrfs_root *root);
 107void btrfs_mark_buffer_dirty(struct extent_buffer *buf);
 108int btrfs_buffer_uptodate(struct extent_buffer *buf, u64 parent_transid,
 109                          int atomic);
 110int btrfs_read_buffer(struct extent_buffer *buf, u64 parent_transid, int level,
 111                      struct btrfs_key *first_key);
 112blk_status_t btrfs_bio_wq_end_io(struct btrfs_fs_info *info, struct bio *bio,
 113                        enum btrfs_wq_endio_type metadata);
 114blk_status_t btrfs_wq_submit_bio(struct inode *inode, struct bio *bio,
 115                                 int mirror_num, unsigned long bio_flags,
 116                                 u64 dio_file_offset,
 117                                 extent_submit_bio_start_t *submit_bio_start);
 118blk_status_t btrfs_submit_bio_done(void *private_data, struct bio *bio,
 119                          int mirror_num);
 120int btrfs_alloc_log_tree_node(struct btrfs_trans_handle *trans,
 121                              struct btrfs_root *root);
 122int btrfs_init_log_root_tree(struct btrfs_trans_handle *trans,
 123                             struct btrfs_fs_info *fs_info);
 124int btrfs_add_log_tree(struct btrfs_trans_handle *trans,
 125                       struct btrfs_root *root);
 126void btrfs_cleanup_dirty_bgs(struct btrfs_transaction *trans,
 127                             struct btrfs_fs_info *fs_info);
 128void btrfs_cleanup_one_transaction(struct btrfs_transaction *trans,
 129                                  struct btrfs_fs_info *fs_info);
 130struct btrfs_root *btrfs_create_tree(struct btrfs_trans_handle *trans,
 131                                     u64 objectid);
 132int btree_lock_page_hook(struct page *page, void *data,
 133                                void (*flush_fn)(void *));
 134int btrfs_get_num_tolerated_disk_barrier_failures(u64 flags);
 135int btrfs_get_free_objectid(struct btrfs_root *root, u64 *objectid);
 136int btrfs_init_root_free_objectid(struct btrfs_root *root);
 137int __init btrfs_end_io_wq_init(void);
 138void __cold btrfs_end_io_wq_exit(void);
 139
 140#ifdef CONFIG_DEBUG_LOCK_ALLOC
 141void btrfs_set_buffer_lockdep_class(u64 objectid,
 142                                    struct extent_buffer *eb, int level);
 143#else
 144static inline void btrfs_set_buffer_lockdep_class(u64 objectid,
 145                                        struct extent_buffer *eb, int level)
 146{
 147}
 148#endif
 149
 150#endif
 151