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