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