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_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 BTRFS_WQ_ENDIO_DIO_REPAIR,
29};
30
31static inline u64 btrfs_sb_offset(int mirror)
32{
33 u64 start = SZ_16K;
34 if (mirror)
35 return start << (BTRFS_SUPER_MIRROR_SHIFT * mirror);
36 return BTRFS_SUPER_INFO_OFFSET;
37}
38
39struct btrfs_device;
40struct btrfs_fs_devices;
41
42int btrfs_verify_level_key(struct extent_buffer *eb, int level,
43 struct btrfs_key *first_key, u64 parent_transid);
44struct extent_buffer *read_tree_block(struct btrfs_fs_info *fs_info, u64 bytenr,
45 u64 parent_transid, int level,
46 struct btrfs_key *first_key);
47void readahead_tree_block(struct btrfs_fs_info *fs_info, u64 bytenr);
48struct extent_buffer *btrfs_find_create_tree_block(
49 struct btrfs_fs_info *fs_info,
50 u64 bytenr);
51void btrfs_clean_tree_block(struct extent_buffer *buf);
52int open_ctree(struct super_block *sb,
53 struct btrfs_fs_devices *fs_devices,
54 char *options);
55void close_ctree(struct btrfs_fs_info *fs_info);
56int write_all_supers(struct btrfs_fs_info *fs_info, int max_mirrors);
57struct buffer_head *btrfs_read_dev_super(struct block_device *bdev);
58int btrfs_read_dev_one_super(struct block_device *bdev, int copy_num,
59 struct buffer_head **bh_ret);
60int btrfs_commit_super(struct btrfs_fs_info *fs_info);
61struct btrfs_root *btrfs_read_fs_root(struct btrfs_root *tree_root,
62 struct btrfs_key *location);
63int btrfs_init_fs_root(struct btrfs_root *root);
64struct btrfs_root *btrfs_lookup_fs_root(struct btrfs_fs_info *fs_info,
65 u64 root_id);
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 struct btrfs_key *key,
72 bool check_ref);
73static inline struct btrfs_root *
74btrfs_read_fs_root_no_name(struct btrfs_fs_info *fs_info,
75 struct btrfs_key *location)
76{
77 return btrfs_get_fs_root(fs_info, location, true);
78}
79
80int btrfs_cleanup_fs_roots(struct btrfs_fs_info *fs_info);
81void btrfs_btree_balance_dirty(struct btrfs_fs_info *fs_info);
82void btrfs_btree_balance_dirty_nodelay(struct btrfs_fs_info *fs_info);
83void btrfs_drop_and_free_fs_root(struct btrfs_fs_info *fs_info,
84 struct btrfs_root *root);
85void btrfs_free_fs_root(struct btrfs_root *root);
86
87#ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
88struct btrfs_root *btrfs_alloc_dummy_root(struct btrfs_fs_info *fs_info);
89#endif
90
91/*
92 * This function is used to grab the root, and avoid it is freed when we
93 * access it. But it doesn't ensure that the tree is not dropped.
94 *
95 * If you want to ensure the whole tree is safe, you should use
96 * fs_info->subvol_srcu
97 */
98static inline struct btrfs_root *btrfs_grab_fs_root(struct btrfs_root *root)
99{
100 if (refcount_inc_not_zero(&root->refs))
101 return root;
102 return NULL;
103}
104
105static inline void btrfs_put_fs_root(struct btrfs_root *root)
106{
107 if (refcount_dec_and_test(&root->refs))
108 kfree(root);
109}
110
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_buffer(struct extent_buffer *buf, u64 parent_transid, int level,
115 struct btrfs_key *first_key);
116blk_status_t btrfs_bio_wq_end_io(struct btrfs_fs_info *info, struct bio *bio,
117 enum btrfs_wq_endio_type metadata);
118blk_status_t btrfs_wq_submit_bio(struct btrfs_fs_info *fs_info, struct bio *bio,
119 int mirror_num, unsigned long bio_flags,
120 u64 bio_offset, void *private_data,
121 extent_submit_bio_start_t *submit_bio_start);
122blk_status_t btrfs_submit_bio_done(void *private_data, struct bio *bio,
123 int mirror_num);
124int btrfs_init_log_root_tree(struct btrfs_trans_handle *trans,
125 struct btrfs_fs_info *fs_info);
126int btrfs_add_log_tree(struct btrfs_trans_handle *trans,
127 struct btrfs_root *root);
128void btrfs_cleanup_dirty_bgs(struct btrfs_transaction *trans,
129 struct btrfs_fs_info *fs_info);
130void btrfs_cleanup_one_transaction(struct btrfs_transaction *trans,
131 struct btrfs_fs_info *fs_info);
132struct btrfs_root *btrfs_create_tree(struct btrfs_trans_handle *trans,
133 u64 objectid);
134int btree_lock_page_hook(struct page *page, void *data,
135 void (*flush_fn)(void *));
136struct extent_map *btree_get_extent(struct btrfs_inode *inode,
137 struct page *page, size_t pg_offset, u64 start, u64 len,
138 int create);
139int btrfs_get_num_tolerated_disk_barrier_failures(u64 flags);
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_init_lockdep(void);
145void btrfs_set_buffer_lockdep_class(u64 objectid,
146 struct extent_buffer *eb, int level);
147#else
148static inline void btrfs_init_lockdep(void)
149{ }
150static inline void btrfs_set_buffer_lockdep_class(u64 objectid,
151 struct extent_buffer *eb, int level)
152{
153}
154#endif
155
156#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 (64 * 1024)
23#define BTRFS_SUPER_INFO_SIZE 4096
24
25#define BTRFS_SUPER_MIRROR_MAX 3
26#define BTRFS_SUPER_MIRROR_SHIFT 12
27
28enum {
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};
34
35static inline u64 btrfs_sb_offset(int mirror)
36{
37 u64 start = 16 * 1024;
38 if (mirror)
39 return start << (BTRFS_SUPER_MIRROR_SHIFT * mirror);
40 return BTRFS_SUPER_INFO_OFFSET;
41}
42
43struct btrfs_device;
44struct btrfs_fs_devices;
45
46struct extent_buffer *read_tree_block(struct btrfs_root *root, u64 bytenr,
47 u32 blocksize, u64 parent_transid);
48int readahead_tree_block(struct btrfs_root *root, u64 bytenr, u32 blocksize,
49 u64 parent_transid);
50int reada_tree_block_flagged(struct btrfs_root *root, u64 bytenr, u32 blocksize,
51 int mirror_num, struct extent_buffer **eb);
52struct extent_buffer *btrfs_find_create_tree_block(struct btrfs_root *root,
53 u64 bytenr, u32 blocksize);
54void clean_tree_block(struct btrfs_trans_handle *trans,
55 struct btrfs_root *root, struct extent_buffer *buf);
56int open_ctree(struct super_block *sb,
57 struct btrfs_fs_devices *fs_devices,
58 char *options);
59int 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_commit_super(struct btrfs_root *root);
64struct extent_buffer *btrfs_find_tree_block(struct btrfs_root *root,
65 u64 bytenr, u32 blocksize);
66struct btrfs_root *btrfs_read_fs_root(struct btrfs_root *tree_root,
67 struct btrfs_key *location);
68int btrfs_init_fs_root(struct btrfs_root *root);
69int btrfs_insert_fs_root(struct btrfs_fs_info *fs_info,
70 struct btrfs_root *root);
71
72struct btrfs_root *btrfs_get_fs_root(struct btrfs_fs_info *fs_info,
73 struct btrfs_key *key,
74 bool check_ref);
75static inline struct btrfs_root *
76btrfs_read_fs_root_no_name(struct btrfs_fs_info *fs_info,
77 struct btrfs_key *location)
78{
79 return btrfs_get_fs_root(fs_info, location, true);
80}
81
82int btrfs_cleanup_fs_roots(struct btrfs_fs_info *fs_info);
83void btrfs_btree_balance_dirty(struct btrfs_root *root);
84void btrfs_btree_balance_dirty_nodelay(struct btrfs_root *root);
85void btrfs_drop_and_free_fs_root(struct btrfs_fs_info *fs_info,
86 struct btrfs_root *root);
87void btrfs_free_fs_root(struct btrfs_root *root);
88
89#ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
90struct btrfs_root *btrfs_alloc_dummy_root(void);
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_fs_root(struct btrfs_root *root)
101{
102 if (atomic_inc_not_zero(&root->refs))
103 return root;
104 return NULL;
105}
106
107static inline void btrfs_put_fs_root(struct btrfs_root *root)
108{
109 if (atomic_dec_and_test(&root->refs))
110 kfree(root);
111}
112
113void btrfs_mark_buffer_dirty(struct extent_buffer *buf);
114int btrfs_buffer_uptodate(struct extent_buffer *buf, u64 parent_transid,
115 int atomic);
116int btrfs_set_buffer_uptodate(struct extent_buffer *buf);
117int btrfs_read_buffer(struct extent_buffer *buf, u64 parent_transid);
118u32 btrfs_csum_data(char *data, u32 seed, size_t len);
119void btrfs_csum_final(u32 crc, char *result);
120int btrfs_bio_wq_end_io(struct btrfs_fs_info *info, struct bio *bio,
121 int metadata);
122int btrfs_wq_submit_bio(struct btrfs_fs_info *fs_info, struct inode *inode,
123 int rw, struct bio *bio, int mirror_num,
124 unsigned long bio_flags, u64 bio_offset,
125 extent_submit_bio_hook_t *submit_bio_start,
126 extent_submit_bio_hook_t *submit_bio_done);
127unsigned long btrfs_async_submit_limit(struct btrfs_fs_info *info);
128int btrfs_write_tree_block(struct extent_buffer *buf);
129int btrfs_wait_tree_block_writeback(struct extent_buffer *buf);
130int btrfs_init_log_root_tree(struct btrfs_trans_handle *trans,
131 struct btrfs_fs_info *fs_info);
132int btrfs_add_log_tree(struct btrfs_trans_handle *trans,
133 struct btrfs_root *root);
134void btrfs_cleanup_one_transaction(struct btrfs_transaction *trans,
135 struct btrfs_root *root);
136struct btrfs_root *btrfs_create_tree(struct btrfs_trans_handle *trans,
137 struct btrfs_fs_info *fs_info,
138 u64 objectid);
139int btree_lock_page_hook(struct page *page, void *data,
140 void (*flush_fn)(void *));
141int btrfs_calc_num_tolerated_disk_barrier_failures(
142 struct btrfs_fs_info *fs_info);
143
144#ifdef CONFIG_DEBUG_LOCK_ALLOC
145void btrfs_init_lockdep(void);
146void btrfs_set_buffer_lockdep_class(u64 objectid,
147 struct extent_buffer *eb, int level);
148#else
149static inline void btrfs_init_lockdep(void)
150{ }
151static inline void btrfs_set_buffer_lockdep_class(u64 objectid,
152 struct extent_buffer *eb, int level)
153{
154}
155#endif
156#endif