xref: /linux/fs/btrfs/disk-io.h (revision 7696286034ac72cf9b46499be1715ac62fd302c3)
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 "bio.h"
13 #include "ordered-data.h"
14 
15 struct block_device;
16 struct super_block;
17 struct extent_buffer;
18 struct btrfs_device;
19 struct btrfs_fs_devices;
20 struct btrfs_fs_info;
21 struct btrfs_super_block;
22 struct btrfs_trans_handle;
23 struct btrfs_tree_parent_check;
24 struct btrfs_transaction;
25 
26 #define BTRFS_SUPER_MIRROR_MAX	 3
27 #define BTRFS_SUPER_MIRROR_SHIFT 12
28 
29 /*
30  * Fixed blocksize for all devices, applies to specific ways of reading
31  * metadata like superblock. Must meet the set_blocksize requirements.
32  *
33  * Do not change.
34  */
35 #define BTRFS_BDEV_BLOCKSIZE	(4096)
36 
37 static inline u64 btrfs_sb_offset(int mirror)
38 {
39 	u64 start = SZ_16K;
40 	if (mirror)
41 		return start << (BTRFS_SUPER_MIRROR_SHIFT * mirror);
42 	return BTRFS_SUPER_INFO_OFFSET;
43 }
44 
45 void btrfs_check_leaked_roots(const struct btrfs_fs_info *fs_info);
46 void btrfs_init_fs_info(struct btrfs_fs_info *fs_info);
47 struct extent_buffer *read_tree_block(struct btrfs_fs_info *fs_info, u64 bytenr,
48 				      struct btrfs_tree_parent_check *check);
49 struct extent_buffer *btrfs_find_create_tree_block(
50 						struct btrfs_fs_info *fs_info,
51 						u64 bytenr, u64 owner_root,
52 						int level);
53 int btrfs_start_pre_rw_mount(struct btrfs_fs_info *fs_info);
54 int btrfs_check_super_csum(struct btrfs_fs_info *fs_info,
55 			   const struct btrfs_super_block *disk_sb);
56 int __cold open_ctree(struct super_block *sb, struct btrfs_fs_devices *fs_devices);
57 void __cold close_ctree(struct btrfs_fs_info *fs_info);
58 int btrfs_validate_super(const struct btrfs_fs_info *fs_info,
59 			 const struct btrfs_super_block *sb, int mirror_num);
60 int btrfs_check_features(struct btrfs_fs_info *fs_info, bool is_rw_mount);
61 int write_all_supers(struct btrfs_fs_info *fs_info, int max_mirrors);
62 int btrfs_commit_super(struct btrfs_fs_info *fs_info);
63 struct btrfs_root *btrfs_read_tree_root(struct btrfs_root *tree_root,
64 					const struct btrfs_key *key);
65 int btrfs_insert_fs_root(struct btrfs_fs_info *fs_info,
66 			 struct btrfs_root *root);
67 void btrfs_free_fs_roots(struct btrfs_fs_info *fs_info);
68 
69 struct btrfs_root *btrfs_get_fs_root(struct btrfs_fs_info *fs_info,
70 				     u64 objectid, bool check_ref);
71 struct btrfs_root *btrfs_get_new_fs_root(struct btrfs_fs_info *fs_info,
72 					 u64 objectid, dev_t *anon_dev);
73 struct btrfs_root *btrfs_get_fs_root_commit_root(struct btrfs_fs_info *fs_info,
74 						 struct btrfs_path *path,
75 						 u64 objectid);
76 int btrfs_global_root_insert(struct btrfs_root *root);
77 void btrfs_global_root_delete(struct btrfs_root *root);
78 struct btrfs_root *btrfs_global_root(struct btrfs_fs_info *fs_info,
79 				     struct btrfs_key *key);
80 struct btrfs_root *btrfs_csum_root(struct btrfs_fs_info *fs_info, u64 bytenr);
81 struct btrfs_root *btrfs_extent_root(struct btrfs_fs_info *fs_info, u64 bytenr);
82 
83 void btrfs_free_fs_info(struct btrfs_fs_info *fs_info);
84 void btrfs_btree_balance_dirty(struct btrfs_fs_info *fs_info);
85 void btrfs_btree_balance_dirty_nodelay(struct btrfs_fs_info *fs_info);
86 void btrfs_drop_and_free_fs_root(struct btrfs_fs_info *fs_info,
87 				 struct btrfs_root *root);
88 int btrfs_validate_extent_buffer(struct extent_buffer *eb,
89 				 const struct btrfs_tree_parent_check *check);
90 #ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
91 struct 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 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 void btrfs_put_root(struct btrfs_root *root);
108 void btrfs_mark_buffer_dirty(struct btrfs_trans_handle *trans,
109 			     struct extent_buffer *buf);
110 int btrfs_buffer_uptodate(struct extent_buffer *buf, u64 parent_transid, bool atomic);
111 int btrfs_read_extent_buffer(struct extent_buffer *buf,
112 			     const struct btrfs_tree_parent_check *check);
113 
114 int btree_csum_one_bio(struct btrfs_bio *bbio);
115 int btrfs_alloc_log_tree_node(struct btrfs_trans_handle *trans,
116 			      struct btrfs_root *root);
117 int btrfs_init_log_root_tree(struct btrfs_trans_handle *trans,
118 			     struct btrfs_fs_info *fs_info);
119 int btrfs_add_log_tree(struct btrfs_trans_handle *trans,
120 		       struct btrfs_root *root);
121 void btrfs_cleanup_dirty_bgs(struct btrfs_transaction *trans,
122 			     struct btrfs_fs_info *fs_info);
123 void btrfs_cleanup_one_transaction(struct btrfs_transaction *trans);
124 struct btrfs_root *btrfs_create_tree(struct btrfs_trans_handle *trans,
125 				     u64 objectid);
126 int btrfs_get_num_tolerated_disk_barrier_failures(u64 flags);
127 int btrfs_get_free_objectid(struct btrfs_root *root, u64 *objectid);
128 int btrfs_init_root_free_objectid(struct btrfs_root *root);
129 
130 #endif
131