Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
9888c340 DS |
2 | |
3 | #ifndef BTRFS_EXTENT_IO_H | |
4 | #define BTRFS_EXTENT_IO_H | |
d1310b2e CM |
5 | |
6 | #include <linux/rbtree.h> | |
b7ac31b7 | 7 | #include <linux/refcount.h> |
10c5db28 | 8 | #include <linux/fiemap.h> |
deb67895 | 9 | #include <linux/btrfs_tree.h> |
0ff40013 | 10 | #include "compression.h" |
ac467772 | 11 | #include "ulist.h" |
fd8d2951 | 12 | #include "misc.h" |
d1310b2e | 13 | |
98c8d683 JB |
14 | struct btrfs_trans_handle; |
15 | ||
80cb3836 DS |
16 | enum { |
17 | EXTENT_BUFFER_UPTODATE, | |
18 | EXTENT_BUFFER_DIRTY, | |
19 | EXTENT_BUFFER_CORRUPT, | |
20 | /* this got triggered by readahead */ | |
21 | EXTENT_BUFFER_READAHEAD, | |
22 | EXTENT_BUFFER_TREE_REF, | |
23 | EXTENT_BUFFER_STALE, | |
24 | EXTENT_BUFFER_WRITEBACK, | |
25 | /* read IO error */ | |
26 | EXTENT_BUFFER_READ_ERR, | |
27 | EXTENT_BUFFER_UNMAPPED, | |
28 | EXTENT_BUFFER_IN_TREE, | |
29 | /* write IO error */ | |
30 | EXTENT_BUFFER_WRITE_ERR, | |
d3575156 | 31 | EXTENT_BUFFER_NO_CHECK, |
d7172f52 CH |
32 | /* Indicate that extent buffer pages a being read */ |
33 | EXTENT_BUFFER_READING, | |
80cb3836 | 34 | }; |
b4ce94de | 35 | |
da2c7009 | 36 | /* these are flags for __process_pages_contig */ |
fd8d2951 DS |
37 | enum { |
38 | ENUM_BIT(PAGE_UNLOCK), | |
39 | /* Page starts writeback, clear dirty bit and set writeback bit */ | |
40 | ENUM_BIT(PAGE_START_WRITEBACK), | |
41 | ENUM_BIT(PAGE_END_WRITEBACK), | |
42 | ENUM_BIT(PAGE_SET_ORDERED), | |
fd8d2951 | 43 | }; |
a791e35e | 44 | |
d1310b2e CM |
45 | /* |
46 | * page->private values. Every page that is controlled by the extent | |
47 | * map has page->private set to one. | |
48 | */ | |
49 | #define EXTENT_PAGE_PRIVATE 1 | |
d1310b2e | 50 | |
2fe1d551 OS |
51 | /* |
52 | * The extent buffer bitmap operations are done with byte granularity instead of | |
53 | * word granularity for two reasons: | |
54 | * 1. The bitmaps must be little-endian on disk. | |
55 | * 2. Bitmap items are not guaranteed to be aligned to a word and therefore a | |
56 | * single word in a bitmap may straddle two pages in the extent buffer. | |
57 | */ | |
58 | #define BIT_BYTE(nr) ((nr) / BITS_PER_BYTE) | |
59 | #define BYTE_MASK ((1 << BITS_PER_BYTE) - 1) | |
60 | #define BITMAP_FIRST_BYTE_MASK(start) \ | |
61 | ((BYTE_MASK << ((start) & (BITS_PER_BYTE - 1))) & BYTE_MASK) | |
62 | #define BITMAP_LAST_BYTE_MASK(nbits) \ | |
63 | (BYTE_MASK >> (-(nbits) & (BITS_PER_BYTE - 1))) | |
64 | ||
ea466794 | 65 | struct btrfs_root; |
6fc0ef68 | 66 | struct btrfs_inode; |
183ebab7 | 67 | struct btrfs_fs_info; |
9c7d3a54 | 68 | struct extent_io_tree; |
947a6299 | 69 | struct btrfs_tree_parent_check; |
a758781d | 70 | |
a62a3bd9 JB |
71 | int __init extent_buffer_init_cachep(void); |
72 | void __cold extent_buffer_free_cachep(void); | |
73 | ||
deb67895 | 74 | #define INLINE_EXTENT_BUFFER_PAGES (BTRFS_MAX_METADATA_BLOCKSIZE / PAGE_SIZE) |
d1310b2e CM |
75 | struct extent_buffer { |
76 | u64 start; | |
77 | unsigned long len; | |
b4ce94de | 78 | unsigned long bflags; |
f28491e0 | 79 | struct btrfs_fs_info *fs_info; |
3083ee2e | 80 | spinlock_t refs_lock; |
727011e0 | 81 | atomic_t refs; |
5cf1ab56 | 82 | int read_mirror; |
19fe0a8b | 83 | struct rcu_head rcu_head; |
5b25f70f | 84 | pid_t lock_owner; |
656f30db | 85 | /* >= 0 if eb belongs to a log tree, -1 otherwise */ |
dc516164 DS |
86 | s8 log_index; |
87 | ||
88 | struct rw_semaphore lock; | |
bd681513 | 89 | |
b8dae313 | 90 | struct page *pages[INLINE_EXTENT_BUFFER_PAGES]; |
6d49ba1b ES |
91 | #ifdef CONFIG_BTRFS_DEBUG |
92 | struct list_head leak_list; | |
93 | #endif | |
d1310b2e CM |
94 | }; |
95 | ||
861093ef NA |
96 | struct btrfs_eb_write_context { |
97 | struct writeback_control *wbc; | |
98 | struct extent_buffer *eb; | |
99 | }; | |
100 | ||
9b48adda JB |
101 | /* |
102 | * Get the correct offset inside the page of extent buffer. | |
103 | * | |
104 | * @eb: target extent buffer | |
105 | * @start: offset inside the extent buffer | |
106 | * | |
107 | * Will handle both sectorsize == PAGE_SIZE and sectorsize < PAGE_SIZE cases. | |
108 | */ | |
109 | static inline size_t get_eb_offset_in_page(const struct extent_buffer *eb, | |
110 | unsigned long offset) | |
111 | { | |
112 | /* | |
113 | * For sectorsize == PAGE_SIZE case, eb->start will always be aligned | |
114 | * to PAGE_SIZE, thus adding it won't cause any difference. | |
115 | * | |
116 | * For sectorsize < PAGE_SIZE, we must only read the data that belongs | |
117 | * to the eb, thus we have to take the eb->start into consideration. | |
118 | */ | |
119 | return offset_in_page(offset + eb->start); | |
120 | } | |
121 | ||
122 | static inline unsigned long get_eb_page_index(unsigned long offset) | |
123 | { | |
124 | /* | |
125 | * For sectorsize == PAGE_SIZE case, plain >> PAGE_SHIFT is enough. | |
126 | * | |
127 | * For sectorsize < PAGE_SIZE case, we only support 64K PAGE_SIZE, | |
128 | * and have ensured that all tree blocks are contained in one page, | |
129 | * thus we always get index == 0. | |
130 | */ | |
131 | return offset >> PAGE_SHIFT; | |
132 | } | |
133 | ||
ac467772 QW |
134 | /* |
135 | * Structure to record how many bytes and which ranges are set/cleared | |
136 | */ | |
137 | struct extent_changeset { | |
138 | /* How many bytes are set/cleared in this operation */ | |
b642b52d | 139 | u64 bytes_changed; |
ac467772 QW |
140 | |
141 | /* Changed ranges */ | |
53d32359 | 142 | struct ulist range_changed; |
ac467772 QW |
143 | }; |
144 | ||
364ecf36 QW |
145 | static inline void extent_changeset_init(struct extent_changeset *changeset) |
146 | { | |
147 | changeset->bytes_changed = 0; | |
148 | ulist_init(&changeset->range_changed); | |
149 | } | |
150 | ||
151 | static inline struct extent_changeset *extent_changeset_alloc(void) | |
152 | { | |
153 | struct extent_changeset *ret; | |
154 | ||
155 | ret = kmalloc(sizeof(*ret), GFP_KERNEL); | |
156 | if (!ret) | |
157 | return NULL; | |
158 | ||
159 | extent_changeset_init(ret); | |
160 | return ret; | |
161 | } | |
162 | ||
163 | static inline void extent_changeset_release(struct extent_changeset *changeset) | |
164 | { | |
165 | if (!changeset) | |
166 | return; | |
167 | changeset->bytes_changed = 0; | |
168 | ulist_release(&changeset->range_changed); | |
169 | } | |
170 | ||
171 | static inline void extent_changeset_free(struct extent_changeset *changeset) | |
172 | { | |
173 | if (!changeset) | |
174 | return; | |
175 | extent_changeset_release(changeset); | |
176 | kfree(changeset); | |
177 | } | |
178 | ||
d1310b2e CM |
179 | struct extent_map_tree; |
180 | ||
477a30ba | 181 | int try_release_extent_mapping(struct page *page, gfp_t mask); |
f7a52a40 | 182 | int try_release_extent_buffer(struct page *page); |
cd716d8f | 183 | |
fdaf9a58 | 184 | int btrfs_read_folio(struct file *file, struct folio *folio); |
778b8785 CH |
185 | void extent_write_locked_range(struct inode *inode, struct page *locked_page, |
186 | u64 start, u64 end, struct writeback_control *wbc, | |
187 | bool pages_dirty); | |
8ae225a8 | 188 | int extent_writepages(struct address_space *mapping, |
d1310b2e | 189 | struct writeback_control *wbc); |
0b32f4bb JB |
190 | int btree_write_cache_pages(struct address_space *mapping, |
191 | struct writeback_control *wbc); | |
ba206a02 | 192 | void extent_readahead(struct readahead_control *rac); |
facee0a0 | 193 | int extent_fiemap(struct btrfs_inode *inode, struct fiemap_extent_info *fieinfo, |
bab16e21 | 194 | u64 start, u64 len); |
32443de3 QW |
195 | int set_page_extent_mapped(struct page *page); |
196 | void clear_page_extent_mapped(struct page *page); | |
d1310b2e | 197 | |
f28491e0 | 198 | struct extent_buffer *alloc_extent_buffer(struct btrfs_fs_info *fs_info, |
3fbaf258 | 199 | u64 start, u64 owner_root, int level); |
0f331229 OS |
200 | struct extent_buffer *__alloc_dummy_extent_buffer(struct btrfs_fs_info *fs_info, |
201 | u64 start, unsigned long len); | |
3f556f78 | 202 | struct extent_buffer *alloc_dummy_extent_buffer(struct btrfs_fs_info *fs_info, |
da17066c | 203 | u64 start); |
2b48966a | 204 | struct extent_buffer *btrfs_clone_extent_buffer(const struct extent_buffer *src); |
f28491e0 | 205 | struct extent_buffer *find_extent_buffer(struct btrfs_fs_info *fs_info, |
452c75c3 | 206 | u64 start); |
d1310b2e | 207 | void free_extent_buffer(struct extent_buffer *eb); |
3083ee2e | 208 | void free_extent_buffer_stale(struct extent_buffer *eb); |
bb82ab88 AJ |
209 | #define WAIT_NONE 0 |
210 | #define WAIT_COMPLETE 1 | |
211 | #define WAIT_PAGE_LOCK 2 | |
947a6299 QW |
212 | int read_extent_buffer_pages(struct extent_buffer *eb, int wait, int mirror_num, |
213 | struct btrfs_tree_parent_check *parent_check); | |
fd8b2b61 | 214 | void wait_on_extent_buffer_writeback(struct extent_buffer *eb); |
bfb484d9 | 215 | void btrfs_readahead_tree_block(struct btrfs_fs_info *fs_info, |
3fbaf258 | 216 | u64 bytenr, u64 owner_root, u64 gen, int level); |
bfb484d9 | 217 | void btrfs_readahead_node_child(struct extent_buffer *node, int slot); |
479ed9ab | 218 | |
cc5e31a4 | 219 | static inline int num_extent_pages(const struct extent_buffer *eb) |
479ed9ab | 220 | { |
4a3dc938 QW |
221 | /* |
222 | * For sectorsize == PAGE_SIZE case, since nodesize is always aligned to | |
223 | * sectorsize, it's just eb->len >> PAGE_SHIFT. | |
224 | * | |
225 | * For sectorsize < PAGE_SIZE case, we could have nodesize < PAGE_SIZE, | |
226 | * thus have to ensure we get at least one page. | |
227 | */ | |
228 | return (eb->len >> PAGE_SHIFT) ?: 1; | |
479ed9ab RD |
229 | } |
230 | ||
2b48966a | 231 | static inline int extent_buffer_uptodate(const struct extent_buffer *eb) |
ba020491 AJ |
232 | { |
233 | return test_bit(EXTENT_BUFFER_UPTODATE, &eb->bflags); | |
234 | } | |
235 | ||
1cbb1f45 JM |
236 | int memcmp_extent_buffer(const struct extent_buffer *eb, const void *ptrv, |
237 | unsigned long start, unsigned long len); | |
238 | void read_extent_buffer(const struct extent_buffer *eb, void *dst, | |
d1310b2e CM |
239 | unsigned long start, |
240 | unsigned long len); | |
a48b73ec JB |
241 | int read_extent_buffer_to_user_nofault(const struct extent_buffer *eb, |
242 | void __user *dst, unsigned long start, | |
243 | unsigned long len); | |
2b48966a | 244 | void write_extent_buffer(const struct extent_buffer *eb, const void *src, |
d1310b2e | 245 | unsigned long start, unsigned long len); |
730c374e QW |
246 | |
247 | static inline void write_extent_buffer_chunk_tree_uuid( | |
248 | const struct extent_buffer *eb, const void *chunk_tree_uuid) | |
249 | { | |
250 | write_extent_buffer(eb, chunk_tree_uuid, | |
251 | offsetof(struct btrfs_header, chunk_tree_uuid), | |
252 | BTRFS_FSID_SIZE); | |
253 | } | |
254 | ||
255 | static inline void write_extent_buffer_fsid(const struct extent_buffer *eb, | |
256 | const void *fsid) | |
257 | { | |
258 | write_extent_buffer(eb, fsid, offsetof(struct btrfs_header, fsid), | |
259 | BTRFS_FSID_SIZE); | |
260 | } | |
261 | ||
2b48966a DS |
262 | void copy_extent_buffer_full(const struct extent_buffer *dst, |
263 | const struct extent_buffer *src); | |
264 | void copy_extent_buffer(const struct extent_buffer *dst, | |
265 | const struct extent_buffer *src, | |
d1310b2e CM |
266 | unsigned long dst_offset, unsigned long src_offset, |
267 | unsigned long len); | |
2b48966a DS |
268 | void memcpy_extent_buffer(const struct extent_buffer *dst, |
269 | unsigned long dst_offset, unsigned long src_offset, | |
270 | unsigned long len); | |
271 | void memmove_extent_buffer(const struct extent_buffer *dst, | |
272 | unsigned long dst_offset, unsigned long src_offset, | |
b159fa28 | 273 | unsigned long len); |
2b48966a | 274 | void memzero_extent_buffer(const struct extent_buffer *eb, unsigned long start, |
b159fa28 | 275 | unsigned long len); |
2b48966a | 276 | int extent_buffer_test_bit(const struct extent_buffer *eb, unsigned long start, |
3e1e8bb7 | 277 | unsigned long pos); |
2b48966a | 278 | void extent_buffer_bitmap_set(const struct extent_buffer *eb, unsigned long start, |
3e1e8bb7 | 279 | unsigned long pos, unsigned long len); |
2b48966a DS |
280 | void extent_buffer_bitmap_clear(const struct extent_buffer *eb, |
281 | unsigned long start, unsigned long pos, | |
282 | unsigned long len); | |
f18cc978 | 283 | void set_extent_buffer_dirty(struct extent_buffer *eb); |
09c25a8c | 284 | void set_extent_buffer_uptodate(struct extent_buffer *eb); |
69ba3927 | 285 | void clear_extent_buffer_uptodate(struct extent_buffer *eb); |
bd1fa4f0 | 286 | void extent_range_clear_dirty_for_io(struct inode *inode, u64 start, u64 end); |
ad7ff17b | 287 | void extent_clear_unlock_delalloc(struct btrfs_inode *inode, u64 start, u64 end, |
74e9194a | 288 | struct page *locked_page, |
f97e27e9 | 289 | u32 bits_to_clear, unsigned long page_ops); |
d6f65c27 JB |
290 | int extent_invalidate_folio(struct extent_io_tree *tree, |
291 | struct folio *folio, size_t offset); | |
98c8d683 JB |
292 | void btrfs_clear_buffer_dirty(struct btrfs_trans_handle *trans, |
293 | struct extent_buffer *buf); | |
dd137dd1 STD |
294 | |
295 | int btrfs_alloc_page_array(unsigned int nr_pages, struct page **page_array); | |
4a54c8c1 | 296 | |
294e30fe | 297 | #ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS |
9978059b | 298 | bool find_lock_delalloc_range(struct inode *inode, |
ce9f967f JT |
299 | struct page *locked_page, u64 *start, |
300 | u64 *end); | |
0d4cf4e6 | 301 | #endif |
faa2dbf0 | 302 | struct extent_buffer *alloc_test_extent_buffer(struct btrfs_fs_info *fs_info, |
da17066c | 303 | u64 start); |
3fd63727 JB |
304 | |
305 | #ifdef CONFIG_BTRFS_DEBUG | |
306 | void btrfs_extent_buffer_leak_debug_check(struct btrfs_fs_info *fs_info); | |
307 | #else | |
308 | #define btrfs_extent_buffer_leak_debug_check(fs_info) do {} while (0) | |
309 | #endif | |
310 | ||
294e30fe | 311 | #endif |