xref: /openbmc/linux/fs/btrfs/disk-io.h (revision 0646c28b)
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 static 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 
28 struct btrfs_device;
29 struct btrfs_fs_devices;
30 
31 void btrfs_check_leaked_roots(struct btrfs_fs_info *fs_info);
32 void btrfs_init_fs_info(struct btrfs_fs_info *fs_info);
33 int btrfs_verify_level_key(struct extent_buffer *eb, int level,
34 			   struct btrfs_key *first_key, u64 parent_transid);
35 struct extent_buffer *read_tree_block(struct btrfs_fs_info *fs_info, u64 bytenr,
36 				      u64 owner_root, u64 parent_transid,
37 				      int level, struct btrfs_key *first_key);
38 struct extent_buffer *btrfs_find_create_tree_block(
39 						struct btrfs_fs_info *fs_info,
40 						u64 bytenr, u64 owner_root,
41 						int level);
42 void btrfs_clean_tree_block(struct extent_buffer *buf);
43 void btrfs_clear_oneshot_options(struct btrfs_fs_info *fs_info);
44 int btrfs_start_pre_rw_mount(struct btrfs_fs_info *fs_info);
45 int __cold open_ctree(struct super_block *sb,
46 	       struct btrfs_fs_devices *fs_devices,
47 	       char *options);
48 void __cold close_ctree(struct btrfs_fs_info *fs_info);
49 int btrfs_validate_super(struct btrfs_fs_info *fs_info,
50 			 struct btrfs_super_block *sb, int mirror_num);
51 int btrfs_check_features(struct btrfs_fs_info *fs_info, struct super_block *sb);
52 int write_all_supers(struct btrfs_fs_info *fs_info, int max_mirrors);
53 struct btrfs_super_block *btrfs_read_dev_super(struct block_device *bdev);
54 struct btrfs_super_block *btrfs_read_dev_one_super(struct block_device *bdev,
55 						   int copy_num, bool drop_cache);
56 int btrfs_commit_super(struct btrfs_fs_info *fs_info);
57 struct btrfs_root *btrfs_read_tree_root(struct btrfs_root *tree_root,
58 					struct btrfs_key *key);
59 int btrfs_insert_fs_root(struct btrfs_fs_info *fs_info,
60 			 struct btrfs_root *root);
61 void btrfs_free_fs_roots(struct btrfs_fs_info *fs_info);
62 
63 struct btrfs_root *btrfs_get_fs_root(struct btrfs_fs_info *fs_info,
64 				     u64 objectid, bool check_ref);
65 struct btrfs_root *btrfs_get_new_fs_root(struct btrfs_fs_info *fs_info,
66 					 u64 objectid, dev_t anon_dev);
67 struct btrfs_root *btrfs_get_fs_root_commit_root(struct btrfs_fs_info *fs_info,
68 						 struct btrfs_path *path,
69 						 u64 objectid);
70 int btrfs_global_root_insert(struct btrfs_root *root);
71 void btrfs_global_root_delete(struct btrfs_root *root);
72 struct btrfs_root *btrfs_global_root(struct btrfs_fs_info *fs_info,
73 				     struct btrfs_key *key);
74 struct btrfs_root *btrfs_csum_root(struct btrfs_fs_info *fs_info, u64 bytenr);
75 struct btrfs_root *btrfs_extent_root(struct btrfs_fs_info *fs_info, u64 bytenr);
76 
77 void btrfs_free_fs_info(struct btrfs_fs_info *fs_info);
78 int btrfs_cleanup_fs_roots(struct btrfs_fs_info *fs_info);
79 void btrfs_btree_balance_dirty(struct btrfs_fs_info *fs_info);
80 void btrfs_btree_balance_dirty_nodelay(struct btrfs_fs_info *fs_info);
81 void btrfs_drop_and_free_fs_root(struct btrfs_fs_info *fs_info,
82 				 struct btrfs_root *root);
83 int btrfs_validate_metadata_buffer(struct btrfs_bio *bbio,
84 				   struct page *page, u64 start, u64 end,
85 				   int mirror);
86 void btrfs_submit_metadata_bio(struct inode *inode, struct bio *bio, int mirror_num);
87 #ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
88 struct 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  */
98 static inline struct btrfs_root *btrfs_grab_root(struct btrfs_root *root)
99 {
100 	if (!root)
101 		return NULL;
102 	if (refcount_inc_not_zero(&root->refs))
103 		return root;
104 	return NULL;
105 }
106 
107 static inline struct btrfs_root *btrfs_block_group_root(struct btrfs_fs_info *fs_info)
108 {
109 	if (btrfs_fs_compat_ro(fs_info, BLOCK_GROUP_TREE))
110 		return fs_info->block_group_root;
111 	return btrfs_extent_root(fs_info, 0);
112 }
113 
114 void btrfs_put_root(struct btrfs_root *root);
115 void btrfs_mark_buffer_dirty(struct extent_buffer *buf);
116 int btrfs_buffer_uptodate(struct extent_buffer *buf, u64 parent_transid,
117 			  int atomic);
118 int btrfs_read_extent_buffer(struct extent_buffer *buf, u64 parent_transid,
119 			     int level, struct btrfs_key *first_key);
120 bool btrfs_wq_submit_bio(struct inode *inode, struct bio *bio, int mirror_num,
121 			 u64 dio_file_offset,
122 			 extent_submit_bio_start_t *submit_bio_start);
123 blk_status_t btrfs_submit_bio_done(void *private_data, struct bio *bio,
124 			  int mirror_num);
125 int btrfs_alloc_log_tree_node(struct btrfs_trans_handle *trans,
126 			      struct btrfs_root *root);
127 int btrfs_init_log_root_tree(struct btrfs_trans_handle *trans,
128 			     struct btrfs_fs_info *fs_info);
129 int btrfs_add_log_tree(struct btrfs_trans_handle *trans,
130 		       struct btrfs_root *root);
131 void btrfs_cleanup_dirty_bgs(struct btrfs_transaction *trans,
132 			     struct btrfs_fs_info *fs_info);
133 void btrfs_cleanup_one_transaction(struct btrfs_transaction *trans,
134 				  struct btrfs_fs_info *fs_info);
135 struct btrfs_root *btrfs_create_tree(struct btrfs_trans_handle *trans,
136 				     u64 objectid);
137 int btree_lock_page_hook(struct page *page, void *data,
138 				void (*flush_fn)(void *));
139 int btrfs_get_num_tolerated_disk_barrier_failures(u64 flags);
140 int btrfs_get_free_objectid(struct btrfs_root *root, u64 *objectid);
141 int btrfs_init_root_free_objectid(struct btrfs_root *root);
142 
143 #endif
144