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/*
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_fs_info *fs_info,
48 u64 bytenr, u64 parent_transid);
49void readahead_tree_block(struct btrfs_fs_info *fs_info, u64 bytenr);
50int reada_tree_block_flagged(struct btrfs_fs_info *fs_info, u64 bytenr,
51 int mirror_num, struct extent_buffer **eb);
52struct extent_buffer *btrfs_find_create_tree_block(
53 struct btrfs_fs_info *fs_info,
54 u64 bytenr);
55void clean_tree_block(struct btrfs_trans_handle *trans,
56 struct btrfs_fs_info *fs_info, struct extent_buffer *buf);
57int open_ctree(struct super_block *sb,
58 struct btrfs_fs_devices *fs_devices,
59 char *options);
60void close_ctree(struct btrfs_fs_info *fs_info);
61int write_ctree_super(struct btrfs_trans_handle *trans,
62 struct btrfs_fs_info *fs_info, int max_mirrors);
63struct buffer_head *btrfs_read_dev_super(struct block_device *bdev);
64int btrfs_read_dev_one_super(struct block_device *bdev, int copy_num,
65 struct buffer_head **bh_ret);
66int btrfs_commit_super(struct btrfs_fs_info *fs_info);
67struct btrfs_root *btrfs_read_fs_root(struct btrfs_root *tree_root,
68 struct btrfs_key *location);
69int btrfs_init_fs_root(struct btrfs_root *root);
70struct btrfs_root *btrfs_lookup_fs_root(struct btrfs_fs_info *fs_info,
71 u64 root_id);
72int btrfs_insert_fs_root(struct btrfs_fs_info *fs_info,
73 struct btrfs_root *root);
74void btrfs_free_fs_roots(struct btrfs_fs_info *fs_info);
75
76struct btrfs_root *btrfs_get_fs_root(struct btrfs_fs_info *fs_info,
77 struct btrfs_key *key,
78 bool check_ref);
79static inline struct btrfs_root *
80btrfs_read_fs_root_no_name(struct btrfs_fs_info *fs_info,
81 struct btrfs_key *location)
82{
83 return btrfs_get_fs_root(fs_info, location, true);
84}
85
86int btrfs_cleanup_fs_roots(struct btrfs_fs_info *fs_info);
87void btrfs_btree_balance_dirty(struct btrfs_fs_info *fs_info);
88void btrfs_btree_balance_dirty_nodelay(struct btrfs_fs_info *fs_info);
89void btrfs_drop_and_free_fs_root(struct btrfs_fs_info *fs_info,
90 struct btrfs_root *root);
91void btrfs_free_fs_root(struct btrfs_root *root);
92
93#ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
94struct btrfs_root *btrfs_alloc_dummy_root(struct btrfs_fs_info *fs_info);
95#endif
96
97/*
98 * This function is used to grab the root, and avoid it is freed when we
99 * access it. But it doesn't ensure that the tree is not dropped.
100 *
101 * If you want to ensure the whole tree is safe, you should use
102 * fs_info->subvol_srcu
103 */
104static inline struct btrfs_root *btrfs_grab_fs_root(struct btrfs_root *root)
105{
106 if (atomic_inc_not_zero(&root->refs))
107 return root;
108 return NULL;
109}
110
111static inline void btrfs_put_fs_root(struct btrfs_root *root)
112{
113 if (atomic_dec_and_test(&root->refs))
114 kfree(root);
115}
116
117void btrfs_mark_buffer_dirty(struct extent_buffer *buf);
118int btrfs_buffer_uptodate(struct extent_buffer *buf, u64 parent_transid,
119 int atomic);
120int btrfs_read_buffer(struct extent_buffer *buf, u64 parent_transid);
121u32 btrfs_csum_data(char *data, u32 seed, size_t len);
122void btrfs_csum_final(u32 crc, u8 *result);
123int btrfs_bio_wq_end_io(struct btrfs_fs_info *info, struct bio *bio,
124 enum btrfs_wq_endio_type metadata);
125int btrfs_wq_submit_bio(struct btrfs_fs_info *fs_info, struct inode *inode,
126 struct bio *bio, int mirror_num,
127 unsigned long bio_flags, u64 bio_offset,
128 extent_submit_bio_hook_t *submit_bio_start,
129 extent_submit_bio_hook_t *submit_bio_done);
130unsigned long btrfs_async_submit_limit(struct btrfs_fs_info *info);
131int btrfs_write_tree_block(struct extent_buffer *buf);
132int btrfs_wait_tree_block_writeback(struct extent_buffer *buf);
133int btrfs_init_log_root_tree(struct btrfs_trans_handle *trans,
134 struct btrfs_fs_info *fs_info);
135int btrfs_add_log_tree(struct btrfs_trans_handle *trans,
136 struct btrfs_root *root);
137void btrfs_cleanup_dirty_bgs(struct btrfs_transaction *trans,
138 struct btrfs_fs_info *fs_info);
139void btrfs_cleanup_one_transaction(struct btrfs_transaction *trans,
140 struct btrfs_fs_info *fs_info);
141struct btrfs_root *btrfs_create_tree(struct btrfs_trans_handle *trans,
142 struct btrfs_fs_info *fs_info,
143 u64 objectid);
144int btree_lock_page_hook(struct page *page, void *data,
145 void (*flush_fn)(void *));
146int btrfs_get_num_tolerated_disk_barrier_failures(u64 flags);
147int btrfs_calc_num_tolerated_disk_barrier_failures(
148 struct btrfs_fs_info *fs_info);
149int __init btrfs_end_io_wq_init(void);
150void btrfs_end_io_wq_exit(void);
151
152#ifdef CONFIG_DEBUG_LOCK_ALLOC
153void btrfs_init_lockdep(void);
154void btrfs_set_buffer_lockdep_class(u64 objectid,
155 struct extent_buffer *eb, int level);
156#else
157static inline void btrfs_init_lockdep(void)
158{ }
159static inline void btrfs_set_buffer_lockdep_class(u64 objectid,
160 struct extent_buffer *eb, int level)
161{
162}
163#endif
164#endif