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#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
20static inline u64 btrfs_sb_offset(int mirror)
21{
22 u64 start = SZ_16K;
23 if (mirror)
24 return start << (BTRFS_SUPER_MIRROR_SHIFT * mirror);
25 return BTRFS_SUPER_INFO_OFFSET;
26}
27
28struct btrfs_device;
29struct btrfs_fs_devices;
30struct btrfs_tree_parent_check;
31
32void btrfs_check_leaked_roots(struct btrfs_fs_info *fs_info);
33void btrfs_init_fs_info(struct btrfs_fs_info *fs_info);
34int btrfs_verify_level_key(struct extent_buffer *eb, int level,
35 struct btrfs_key *first_key, u64 parent_transid);
36struct extent_buffer *read_tree_block(struct btrfs_fs_info *fs_info, u64 bytenr,
37 struct btrfs_tree_parent_check *check);
38struct extent_buffer *btrfs_find_create_tree_block(
39 struct btrfs_fs_info *fs_info,
40 u64 bytenr, u64 owner_root,
41 int level);
42void btrfs_clean_tree_block(struct extent_buffer *buf);
43void btrfs_clear_oneshot_options(struct btrfs_fs_info *fs_info);
44int btrfs_start_pre_rw_mount(struct btrfs_fs_info *fs_info);
45int btrfs_check_super_csum(struct btrfs_fs_info *fs_info,
46 const struct btrfs_super_block *disk_sb);
47int __cold open_ctree(struct super_block *sb,
48 struct btrfs_fs_devices *fs_devices,
49 char *options);
50void __cold close_ctree(struct btrfs_fs_info *fs_info);
51int btrfs_validate_super(struct btrfs_fs_info *fs_info,
52 struct btrfs_super_block *sb, int mirror_num);
53int btrfs_check_features(struct btrfs_fs_info *fs_info, bool is_rw_mount);
54int write_all_supers(struct btrfs_fs_info *fs_info, int max_mirrors);
55struct btrfs_super_block *btrfs_read_dev_super(struct block_device *bdev);
56struct btrfs_super_block *btrfs_read_dev_one_super(struct block_device *bdev,
57 int copy_num, bool drop_cache);
58int btrfs_commit_super(struct btrfs_fs_info *fs_info);
59struct btrfs_root *btrfs_read_tree_root(struct btrfs_root *tree_root,
60 struct btrfs_key *key);
61int btrfs_insert_fs_root(struct btrfs_fs_info *fs_info,
62 struct btrfs_root *root);
63void btrfs_free_fs_roots(struct btrfs_fs_info *fs_info);
64
65struct btrfs_root *btrfs_get_fs_root(struct btrfs_fs_info *fs_info,
66 u64 objectid, bool check_ref);
67struct btrfs_root *btrfs_get_new_fs_root(struct btrfs_fs_info *fs_info,
68 u64 objectid, dev_t anon_dev);
69struct btrfs_root *btrfs_get_fs_root_commit_root(struct btrfs_fs_info *fs_info,
70 struct btrfs_path *path,
71 u64 objectid);
72int btrfs_global_root_insert(struct btrfs_root *root);
73void btrfs_global_root_delete(struct btrfs_root *root);
74struct btrfs_root *btrfs_global_root(struct btrfs_fs_info *fs_info,
75 struct btrfs_key *key);
76struct btrfs_root *btrfs_csum_root(struct btrfs_fs_info *fs_info, u64 bytenr);
77struct btrfs_root *btrfs_extent_root(struct btrfs_fs_info *fs_info, u64 bytenr);
78struct btrfs_root *btrfs_block_group_root(struct btrfs_fs_info *fs_info);
79
80void btrfs_free_fs_info(struct btrfs_fs_info *fs_info);
81int btrfs_cleanup_fs_roots(struct btrfs_fs_info *fs_info);
82void btrfs_btree_balance_dirty(struct btrfs_fs_info *fs_info);
83void btrfs_btree_balance_dirty_nodelay(struct btrfs_fs_info *fs_info);
84void btrfs_drop_and_free_fs_root(struct btrfs_fs_info *fs_info,
85 struct btrfs_root *root);
86int btrfs_validate_metadata_buffer(struct btrfs_bio *bbio,
87 struct page *page, u64 start, u64 end,
88 int mirror);
89void btrfs_submit_metadata_bio(struct btrfs_inode *inode, struct bio *bio, int mirror_num);
90#ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
91struct 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 */
101static 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
110void btrfs_put_root(struct btrfs_root *root);
111void btrfs_mark_buffer_dirty(struct extent_buffer *buf);
112int btrfs_buffer_uptodate(struct extent_buffer *buf, u64 parent_transid,
113 int atomic);
114int btrfs_read_extent_buffer(struct extent_buffer *buf,
115 struct btrfs_tree_parent_check *check);
116
117enum btrfs_wq_submit_cmd {
118 WQ_SUBMIT_METADATA,
119 WQ_SUBMIT_DATA,
120 WQ_SUBMIT_DATA_DIO,
121};
122
123bool btrfs_wq_submit_bio(struct btrfs_inode *inode, struct bio *bio, int mirror_num,
124 u64 dio_file_offset, enum btrfs_wq_submit_cmd cmd);
125blk_status_t btree_submit_bio_start(struct bio *bio);
126int btrfs_alloc_log_tree_node(struct btrfs_trans_handle *trans,
127 struct btrfs_root *root);
128int btrfs_init_log_root_tree(struct btrfs_trans_handle *trans,
129 struct btrfs_fs_info *fs_info);
130int btrfs_add_log_tree(struct btrfs_trans_handle *trans,
131 struct btrfs_root *root);
132void btrfs_cleanup_dirty_bgs(struct btrfs_transaction *trans,
133 struct btrfs_fs_info *fs_info);
134void btrfs_cleanup_one_transaction(struct btrfs_transaction *trans,
135 struct btrfs_fs_info *fs_info);
136struct btrfs_root *btrfs_create_tree(struct btrfs_trans_handle *trans,
137 u64 objectid);
138int btrfs_get_num_tolerated_disk_barrier_failures(u64 flags);
139int btrfs_get_free_objectid(struct btrfs_root *root, u64 *objectid);
140int btrfs_init_root_free_objectid(struct btrfs_root *root);
141
142#endif
1/*
2 * Copyright (C) 2007 Oracle. All rights reserved.
3 *
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public
6 * License v2 as published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 * General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public
14 * License along with this program; if not, write to the
15 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
16 * Boston, MA 021110-1307, USA.
17 */
18
19#ifndef __DISKIO__
20#define __DISKIO__
21
22#define BTRFS_SUPER_INFO_OFFSET SZ_64K
23#define BTRFS_SUPER_INFO_SIZE 4096
24
25#define BTRFS_SUPER_MIRROR_MAX 3
26#define BTRFS_SUPER_MIRROR_SHIFT 12
27
28enum btrfs_wq_endio_type {
29 BTRFS_WQ_ENDIO_DATA = 0,
30 BTRFS_WQ_ENDIO_METADATA = 1,
31 BTRFS_WQ_ENDIO_FREE_SPACE = 2,
32 BTRFS_WQ_ENDIO_RAID56 = 3,
33 BTRFS_WQ_ENDIO_DIO_REPAIR = 4,
34};
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
44struct btrfs_device;
45struct btrfs_fs_devices;
46
47struct extent_buffer *read_tree_block(struct btrfs_root *root, u64 bytenr,
48 u64 parent_transid);
49void readahead_tree_block(struct btrfs_root *root, u64 bytenr);
50int reada_tree_block_flagged(struct btrfs_root *root, u64 bytenr,
51 int mirror_num, struct extent_buffer **eb);
52struct extent_buffer *btrfs_find_create_tree_block(struct btrfs_root *root,
53 u64 bytenr);
54void clean_tree_block(struct btrfs_trans_handle *trans,
55 struct btrfs_fs_info *fs_info, struct extent_buffer *buf);
56int open_ctree(struct super_block *sb,
57 struct btrfs_fs_devices *fs_devices,
58 char *options);
59void close_ctree(struct btrfs_root *root);
60int write_ctree_super(struct btrfs_trans_handle *trans,
61 struct btrfs_root *root, int max_mirrors);
62struct buffer_head *btrfs_read_dev_super(struct block_device *bdev);
63int btrfs_read_dev_one_super(struct block_device *bdev, int copy_num,
64 struct buffer_head **bh_ret);
65int btrfs_commit_super(struct btrfs_root *root);
66struct extent_buffer *btrfs_find_tree_block(struct btrfs_fs_info *fs_info,
67 u64 bytenr);
68struct btrfs_root *btrfs_read_fs_root(struct btrfs_root *tree_root,
69 struct btrfs_key *location);
70int btrfs_init_fs_root(struct btrfs_root *root);
71int btrfs_insert_fs_root(struct btrfs_fs_info *fs_info,
72 struct btrfs_root *root);
73void btrfs_free_fs_roots(struct btrfs_fs_info *fs_info);
74
75struct btrfs_root *btrfs_get_fs_root(struct btrfs_fs_info *fs_info,
76 struct btrfs_key *key,
77 bool check_ref);
78static inline struct btrfs_root *
79btrfs_read_fs_root_no_name(struct btrfs_fs_info *fs_info,
80 struct btrfs_key *location)
81{
82 return btrfs_get_fs_root(fs_info, location, true);
83}
84
85int btrfs_cleanup_fs_roots(struct btrfs_fs_info *fs_info);
86void btrfs_btree_balance_dirty(struct btrfs_root *root);
87void btrfs_btree_balance_dirty_nodelay(struct btrfs_root *root);
88void btrfs_drop_and_free_fs_root(struct btrfs_fs_info *fs_info,
89 struct btrfs_root *root);
90void btrfs_free_fs_root(struct btrfs_root *root);
91
92#ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
93struct btrfs_root *btrfs_alloc_dummy_root(void);
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_fs_root(struct btrfs_root *root)
104{
105 if (atomic_inc_not_zero(&root->refs))
106 return root;
107 return NULL;
108}
109
110static inline void btrfs_put_fs_root(struct btrfs_root *root)
111{
112 if (atomic_dec_and_test(&root->refs))
113 kfree(root);
114}
115
116void btrfs_mark_buffer_dirty(struct extent_buffer *buf);
117int btrfs_buffer_uptodate(struct extent_buffer *buf, u64 parent_transid,
118 int atomic);
119int btrfs_read_buffer(struct extent_buffer *buf, u64 parent_transid);
120u32 btrfs_csum_data(char *data, u32 seed, size_t len);
121void btrfs_csum_final(u32 crc, char *result);
122int btrfs_bio_wq_end_io(struct btrfs_fs_info *info, struct bio *bio,
123 enum btrfs_wq_endio_type metadata);
124int btrfs_wq_submit_bio(struct btrfs_fs_info *fs_info, struct inode *inode,
125 int rw, struct bio *bio, int mirror_num,
126 unsigned long bio_flags, u64 bio_offset,
127 extent_submit_bio_hook_t *submit_bio_start,
128 extent_submit_bio_hook_t *submit_bio_done);
129unsigned long btrfs_async_submit_limit(struct btrfs_fs_info *info);
130int btrfs_write_tree_block(struct extent_buffer *buf);
131int btrfs_wait_tree_block_writeback(struct extent_buffer *buf);
132int btrfs_init_log_root_tree(struct btrfs_trans_handle *trans,
133 struct btrfs_fs_info *fs_info);
134int btrfs_add_log_tree(struct btrfs_trans_handle *trans,
135 struct btrfs_root *root);
136void btrfs_cleanup_one_transaction(struct btrfs_transaction *trans,
137 struct btrfs_root *root);
138struct btrfs_root *btrfs_create_tree(struct btrfs_trans_handle *trans,
139 struct btrfs_fs_info *fs_info,
140 u64 objectid);
141int btree_lock_page_hook(struct page *page, void *data,
142 void (*flush_fn)(void *));
143int btrfs_get_num_tolerated_disk_barrier_failures(u64 flags);
144int btrfs_calc_num_tolerated_disk_barrier_failures(
145 struct btrfs_fs_info *fs_info);
146int __init btrfs_end_io_wq_init(void);
147void btrfs_end_io_wq_exit(void);
148
149#ifdef CONFIG_DEBUG_LOCK_ALLOC
150void btrfs_init_lockdep(void);
151void btrfs_set_buffer_lockdep_class(u64 objectid,
152 struct extent_buffer *eb, int level);
153#else
154static inline void btrfs_init_lockdep(void)
155{ }
156static inline void btrfs_set_buffer_lockdep_class(u64 objectid,
157 struct extent_buffer *eb, int level)
158{
159}
160#endif
161#endif