Loading...
1/* SPDX-License-Identifier: GPL-2.0 */
2
3#ifndef BTRFS_EXTENT_IO_TREE_H
4#define BTRFS_EXTENT_IO_TREE_H
5
6#include <linux/rbtree.h>
7#include <linux/spinlock.h>
8#include <linux/refcount.h>
9#include <linux/list.h>
10#include <linux/wait.h>
11#include "misc.h"
12
13struct extent_changeset;
14struct btrfs_fs_info;
15struct btrfs_inode;
16
17/* Bits for the extent state */
18enum {
19 ENUM_BIT(EXTENT_DIRTY),
20 ENUM_BIT(EXTENT_UPTODATE),
21 ENUM_BIT(EXTENT_LOCKED),
22 ENUM_BIT(EXTENT_DIO_LOCKED),
23 ENUM_BIT(EXTENT_NEW),
24 ENUM_BIT(EXTENT_DELALLOC),
25 ENUM_BIT(EXTENT_DEFRAG),
26 ENUM_BIT(EXTENT_BOUNDARY),
27 ENUM_BIT(EXTENT_NODATASUM),
28 ENUM_BIT(EXTENT_CLEAR_META_RESV),
29 ENUM_BIT(EXTENT_NEED_WAIT),
30 ENUM_BIT(EXTENT_NORESERVE),
31 ENUM_BIT(EXTENT_QGROUP_RESERVED),
32 ENUM_BIT(EXTENT_CLEAR_DATA_RESV),
33 /*
34 * Must be cleared only during ordered extent completion or on error
35 * paths if we did not manage to submit bios and create the ordered
36 * extents for the range. Should not be cleared during page release
37 * and page invalidation (if there is an ordered extent in flight),
38 * that is left for the ordered extent completion.
39 */
40 ENUM_BIT(EXTENT_DELALLOC_NEW),
41 /*
42 * When an ordered extent successfully completes for a region marked as
43 * a new delalloc range, use this flag when clearing a new delalloc
44 * range to indicate that the VFS' inode number of bytes should be
45 * incremented and the inode's new delalloc bytes decremented, in an
46 * atomic way to prevent races with stat(2).
47 */
48 ENUM_BIT(EXTENT_ADD_INODE_BYTES),
49 /*
50 * Set during truncate when we're clearing an entire range and we just
51 * want the extent states to go away.
52 */
53 ENUM_BIT(EXTENT_CLEAR_ALL_BITS),
54
55 /*
56 * This must be last.
57 *
58 * Bit not representing a state but a request for NOWAIT semantics,
59 * e.g. when allocating memory, and must be masked out from the other
60 * bits.
61 */
62 ENUM_BIT(EXTENT_NOWAIT)
63};
64
65#define EXTENT_DO_ACCOUNTING (EXTENT_CLEAR_META_RESV | \
66 EXTENT_CLEAR_DATA_RESV)
67#define EXTENT_CTLBITS (EXTENT_DO_ACCOUNTING | \
68 EXTENT_ADD_INODE_BYTES | \
69 EXTENT_CLEAR_ALL_BITS)
70
71#define EXTENT_LOCK_BITS (EXTENT_LOCKED | EXTENT_DIO_LOCKED)
72
73/*
74 * Redefined bits above which are used only in the device allocation tree,
75 * shouldn't be using EXTENT_LOCKED / EXTENT_BOUNDARY / EXTENT_CLEAR_META_RESV
76 * / EXTENT_CLEAR_DATA_RESV because they have special meaning to the bit
77 * manipulation functions
78 */
79#define CHUNK_ALLOCATED EXTENT_DIRTY
80#define CHUNK_TRIMMED EXTENT_DEFRAG
81#define CHUNK_STATE_MASK (CHUNK_ALLOCATED | \
82 CHUNK_TRIMMED)
83
84enum {
85 IO_TREE_FS_PINNED_EXTENTS,
86 IO_TREE_FS_EXCLUDED_EXTENTS,
87 IO_TREE_BTREE_INODE_IO,
88 IO_TREE_INODE_IO,
89 IO_TREE_RELOC_BLOCKS,
90 IO_TREE_TRANS_DIRTY_PAGES,
91 IO_TREE_ROOT_DIRTY_LOG_PAGES,
92 IO_TREE_INODE_FILE_EXTENT,
93 IO_TREE_LOG_CSUM_RANGE,
94 IO_TREE_SELFTEST,
95 IO_TREE_DEVICE_ALLOC_STATE,
96};
97
98struct extent_io_tree {
99 struct rb_root state;
100 /*
101 * The fs_info is needed for trace points, a tree attached to an inode
102 * needs the inode.
103 *
104 * owner == IO_TREE_INODE_IO - then inode is valid and fs_info can be
105 * accessed as inode->root->fs_info
106 */
107 union {
108 struct btrfs_fs_info *fs_info;
109 struct btrfs_inode *inode;
110 };
111
112 /* Who owns this io tree, should be one of IO_TREE_* */
113 u8 owner;
114
115 spinlock_t lock;
116};
117
118struct extent_state {
119 u64 start;
120 u64 end; /* inclusive */
121 struct rb_node rb_node;
122
123 /* ADD NEW ELEMENTS AFTER THIS */
124 wait_queue_head_t wq;
125 refcount_t refs;
126 u32 state;
127
128#ifdef CONFIG_BTRFS_DEBUG
129 struct list_head leak_list;
130#endif
131};
132
133struct btrfs_inode *extent_io_tree_to_inode(struct extent_io_tree *tree);
134const struct btrfs_inode *extent_io_tree_to_inode_const(const struct extent_io_tree *tree);
135const struct btrfs_fs_info *extent_io_tree_to_fs_info(const struct extent_io_tree *tree);
136
137void extent_io_tree_init(struct btrfs_fs_info *fs_info,
138 struct extent_io_tree *tree, unsigned int owner);
139void extent_io_tree_release(struct extent_io_tree *tree);
140int __lock_extent(struct extent_io_tree *tree, u64 start, u64 end, u32 bits,
141 struct extent_state **cached);
142bool __try_lock_extent(struct extent_io_tree *tree, u64 start, u64 end, u32 bits,
143 struct extent_state **cached);
144
145static inline int lock_extent(struct extent_io_tree *tree, u64 start, u64 end,
146 struct extent_state **cached)
147{
148 return __lock_extent(tree, start, end, EXTENT_LOCKED, cached);
149}
150
151static inline bool try_lock_extent(struct extent_io_tree *tree, u64 start,
152 u64 end, struct extent_state **cached)
153{
154 return __try_lock_extent(tree, start, end, EXTENT_LOCKED, cached);
155}
156
157int __init extent_state_init_cachep(void);
158void __cold extent_state_free_cachep(void);
159
160u64 count_range_bits(struct extent_io_tree *tree,
161 u64 *start, u64 search_end,
162 u64 max_bytes, u32 bits, int contig,
163 struct extent_state **cached_state);
164
165void free_extent_state(struct extent_state *state);
166bool test_range_bit(struct extent_io_tree *tree, u64 start, u64 end, u32 bit,
167 struct extent_state *cached_state);
168bool test_range_bit_exists(struct extent_io_tree *tree, u64 start, u64 end, u32 bit);
169int clear_record_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
170 u32 bits, struct extent_changeset *changeset);
171int __clear_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
172 u32 bits, struct extent_state **cached,
173 struct extent_changeset *changeset);
174
175static inline int clear_extent_bit(struct extent_io_tree *tree, u64 start,
176 u64 end, u32 bits,
177 struct extent_state **cached)
178{
179 return __clear_extent_bit(tree, start, end, bits, cached, NULL);
180}
181
182static inline int unlock_extent(struct extent_io_tree *tree, u64 start, u64 end,
183 struct extent_state **cached)
184{
185 return __clear_extent_bit(tree, start, end, EXTENT_LOCKED, cached, NULL);
186}
187
188static inline int clear_extent_bits(struct extent_io_tree *tree, u64 start,
189 u64 end, u32 bits)
190{
191 return clear_extent_bit(tree, start, end, bits, NULL);
192}
193
194int set_record_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
195 u32 bits, struct extent_changeset *changeset);
196int set_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
197 u32 bits, struct extent_state **cached_state);
198
199static inline int clear_extent_uptodate(struct extent_io_tree *tree, u64 start,
200 u64 end, struct extent_state **cached_state)
201{
202 return __clear_extent_bit(tree, start, end, EXTENT_UPTODATE,
203 cached_state, NULL);
204}
205
206static inline int clear_extent_dirty(struct extent_io_tree *tree, u64 start,
207 u64 end, struct extent_state **cached)
208{
209 return clear_extent_bit(tree, start, end,
210 EXTENT_DIRTY | EXTENT_DELALLOC |
211 EXTENT_DO_ACCOUNTING, cached);
212}
213
214int convert_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
215 u32 bits, u32 clear_bits,
216 struct extent_state **cached_state);
217
218bool find_first_extent_bit(struct extent_io_tree *tree, u64 start,
219 u64 *start_ret, u64 *end_ret, u32 bits,
220 struct extent_state **cached_state);
221void find_first_clear_extent_bit(struct extent_io_tree *tree, u64 start,
222 u64 *start_ret, u64 *end_ret, u32 bits);
223int find_contiguous_extent_bit(struct extent_io_tree *tree, u64 start,
224 u64 *start_ret, u64 *end_ret, u32 bits);
225bool btrfs_find_delalloc_range(struct extent_io_tree *tree, u64 *start,
226 u64 *end, u64 max_bytes,
227 struct extent_state **cached_state);
228static inline int lock_dio_extent(struct extent_io_tree *tree, u64 start,
229 u64 end, struct extent_state **cached)
230{
231 return __lock_extent(tree, start, end, EXTENT_DIO_LOCKED, cached);
232}
233
234static inline bool try_lock_dio_extent(struct extent_io_tree *tree, u64 start,
235 u64 end, struct extent_state **cached)
236{
237 return __try_lock_extent(tree, start, end, EXTENT_DIO_LOCKED, cached);
238}
239
240static inline int unlock_dio_extent(struct extent_io_tree *tree, u64 start,
241 u64 end, struct extent_state **cached)
242{
243 return __clear_extent_bit(tree, start, end, EXTENT_DIO_LOCKED, cached, NULL);
244}
245
246#endif /* BTRFS_EXTENT_IO_TREE_H */
1/* SPDX-License-Identifier: GPL-2.0 */
2
3#ifndef BTRFS_EXTENT_IO_TREE_H
4#define BTRFS_EXTENT_IO_TREE_H
5
6#include <linux/rbtree.h>
7#include <linux/spinlock.h>
8#include <linux/refcount.h>
9#include <linux/list.h>
10#include <linux/wait.h>
11#include "misc.h"
12
13struct extent_changeset;
14struct btrfs_fs_info;
15struct btrfs_inode;
16
17/* Bits for the extent state */
18enum {
19 ENUM_BIT(EXTENT_DIRTY),
20 ENUM_BIT(EXTENT_UPTODATE),
21 ENUM_BIT(EXTENT_LOCKED),
22 ENUM_BIT(EXTENT_NEW),
23 ENUM_BIT(EXTENT_DELALLOC),
24 ENUM_BIT(EXTENT_DEFRAG),
25 ENUM_BIT(EXTENT_BOUNDARY),
26 ENUM_BIT(EXTENT_NODATASUM),
27 ENUM_BIT(EXTENT_CLEAR_META_RESV),
28 ENUM_BIT(EXTENT_NEED_WAIT),
29 ENUM_BIT(EXTENT_NORESERVE),
30 ENUM_BIT(EXTENT_QGROUP_RESERVED),
31 ENUM_BIT(EXTENT_CLEAR_DATA_RESV),
32 /*
33 * Must be cleared only during ordered extent completion or on error
34 * paths if we did not manage to submit bios and create the ordered
35 * extents for the range. Should not be cleared during page release
36 * and page invalidation (if there is an ordered extent in flight),
37 * that is left for the ordered extent completion.
38 */
39 ENUM_BIT(EXTENT_DELALLOC_NEW),
40 /*
41 * When an ordered extent successfully completes for a region marked as
42 * a new delalloc range, use this flag when clearing a new delalloc
43 * range to indicate that the VFS' inode number of bytes should be
44 * incremented and the inode's new delalloc bytes decremented, in an
45 * atomic way to prevent races with stat(2).
46 */
47 ENUM_BIT(EXTENT_ADD_INODE_BYTES),
48 /*
49 * Set during truncate when we're clearing an entire range and we just
50 * want the extent states to go away.
51 */
52 ENUM_BIT(EXTENT_CLEAR_ALL_BITS),
53
54 /*
55 * This must be last.
56 *
57 * Bit not representing a state but a request for NOWAIT semantics,
58 * e.g. when allocating memory, and must be masked out from the other
59 * bits.
60 */
61 ENUM_BIT(EXTENT_NOWAIT)
62};
63
64#define EXTENT_DO_ACCOUNTING (EXTENT_CLEAR_META_RESV | \
65 EXTENT_CLEAR_DATA_RESV)
66#define EXTENT_CTLBITS (EXTENT_DO_ACCOUNTING | \
67 EXTENT_ADD_INODE_BYTES | \
68 EXTENT_CLEAR_ALL_BITS)
69
70/*
71 * Redefined bits above which are used only in the device allocation tree,
72 * shouldn't be using EXTENT_LOCKED / EXTENT_BOUNDARY / EXTENT_CLEAR_META_RESV
73 * / EXTENT_CLEAR_DATA_RESV because they have special meaning to the bit
74 * manipulation functions
75 */
76#define CHUNK_ALLOCATED EXTENT_DIRTY
77#define CHUNK_TRIMMED EXTENT_DEFRAG
78#define CHUNK_STATE_MASK (CHUNK_ALLOCATED | \
79 CHUNK_TRIMMED)
80
81enum {
82 IO_TREE_FS_PINNED_EXTENTS,
83 IO_TREE_FS_EXCLUDED_EXTENTS,
84 IO_TREE_BTREE_INODE_IO,
85 IO_TREE_INODE_IO,
86 IO_TREE_RELOC_BLOCKS,
87 IO_TREE_TRANS_DIRTY_PAGES,
88 IO_TREE_ROOT_DIRTY_LOG_PAGES,
89 IO_TREE_INODE_FILE_EXTENT,
90 IO_TREE_LOG_CSUM_RANGE,
91 IO_TREE_SELFTEST,
92 IO_TREE_DEVICE_ALLOC_STATE,
93};
94
95struct extent_io_tree {
96 struct rb_root state;
97 /*
98 * The fs_info is needed for trace points, a tree attached to an inode
99 * needs the inode.
100 *
101 * owner == IO_TREE_INODE_IO - then inode is valid and fs_info can be
102 * accessed as inode->root->fs_info
103 */
104 union {
105 struct btrfs_fs_info *fs_info;
106 struct btrfs_inode *inode;
107 };
108
109 /* Who owns this io tree, should be one of IO_TREE_* */
110 u8 owner;
111
112 spinlock_t lock;
113};
114
115struct extent_state {
116 u64 start;
117 u64 end; /* inclusive */
118 struct rb_node rb_node;
119
120 /* ADD NEW ELEMENTS AFTER THIS */
121 wait_queue_head_t wq;
122 refcount_t refs;
123 u32 state;
124
125#ifdef CONFIG_BTRFS_DEBUG
126 struct list_head leak_list;
127#endif
128};
129
130struct btrfs_inode *extent_io_tree_to_inode(struct extent_io_tree *tree);
131const struct btrfs_inode *extent_io_tree_to_inode_const(const struct extent_io_tree *tree);
132const struct btrfs_fs_info *extent_io_tree_to_fs_info(const struct extent_io_tree *tree);
133
134void extent_io_tree_init(struct btrfs_fs_info *fs_info,
135 struct extent_io_tree *tree, unsigned int owner);
136void extent_io_tree_release(struct extent_io_tree *tree);
137
138int lock_extent(struct extent_io_tree *tree, u64 start, u64 end,
139 struct extent_state **cached);
140
141int try_lock_extent(struct extent_io_tree *tree, u64 start, u64 end,
142 struct extent_state **cached);
143
144int __init extent_state_init_cachep(void);
145void __cold extent_state_free_cachep(void);
146
147u64 count_range_bits(struct extent_io_tree *tree,
148 u64 *start, u64 search_end,
149 u64 max_bytes, u32 bits, int contig,
150 struct extent_state **cached_state);
151
152void free_extent_state(struct extent_state *state);
153bool test_range_bit(struct extent_io_tree *tree, u64 start, u64 end, u32 bit,
154 struct extent_state *cached_state);
155bool test_range_bit_exists(struct extent_io_tree *tree, u64 start, u64 end, u32 bit);
156int clear_record_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
157 u32 bits, struct extent_changeset *changeset);
158int __clear_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
159 u32 bits, struct extent_state **cached,
160 struct extent_changeset *changeset);
161
162static inline int clear_extent_bit(struct extent_io_tree *tree, u64 start,
163 u64 end, u32 bits,
164 struct extent_state **cached)
165{
166 return __clear_extent_bit(tree, start, end, bits, cached, NULL);
167}
168
169static inline int unlock_extent(struct extent_io_tree *tree, u64 start, u64 end,
170 struct extent_state **cached)
171{
172 return __clear_extent_bit(tree, start, end, EXTENT_LOCKED, cached, NULL);
173}
174
175static inline int clear_extent_bits(struct extent_io_tree *tree, u64 start,
176 u64 end, u32 bits)
177{
178 return clear_extent_bit(tree, start, end, bits, NULL);
179}
180
181int set_record_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
182 u32 bits, struct extent_changeset *changeset);
183int set_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
184 u32 bits, struct extent_state **cached_state);
185
186static inline int clear_extent_uptodate(struct extent_io_tree *tree, u64 start,
187 u64 end, struct extent_state **cached_state)
188{
189 return __clear_extent_bit(tree, start, end, EXTENT_UPTODATE,
190 cached_state, NULL);
191}
192
193static inline int clear_extent_dirty(struct extent_io_tree *tree, u64 start,
194 u64 end, struct extent_state **cached)
195{
196 return clear_extent_bit(tree, start, end,
197 EXTENT_DIRTY | EXTENT_DELALLOC |
198 EXTENT_DO_ACCOUNTING, cached);
199}
200
201int convert_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
202 u32 bits, u32 clear_bits,
203 struct extent_state **cached_state);
204
205bool find_first_extent_bit(struct extent_io_tree *tree, u64 start,
206 u64 *start_ret, u64 *end_ret, u32 bits,
207 struct extent_state **cached_state);
208void find_first_clear_extent_bit(struct extent_io_tree *tree, u64 start,
209 u64 *start_ret, u64 *end_ret, u32 bits);
210int find_contiguous_extent_bit(struct extent_io_tree *tree, u64 start,
211 u64 *start_ret, u64 *end_ret, u32 bits);
212bool btrfs_find_delalloc_range(struct extent_io_tree *tree, u64 *start,
213 u64 *end, u64 max_bytes,
214 struct extent_state **cached_state);
215
216#endif /* BTRFS_EXTENT_IO_TREE_H */