1 /* SPDX-License-Identifier: GPL-2.0 */
3 #ifndef BTRFS_EXTENT_IO_H
4 #define BTRFS_EXTENT_IO_H
6 #include <linux/rbtree.h>
7 #include <linux/refcount.h>
10 /* bits for the extent state */
11 #define EXTENT_DIRTY (1U << 0)
12 #define EXTENT_WRITEBACK (1U << 1)
13 #define EXTENT_UPTODATE (1U << 2)
14 #define EXTENT_LOCKED (1U << 3)
15 #define EXTENT_NEW (1U << 4)
16 #define EXTENT_DELALLOC (1U << 5)
17 #define EXTENT_DEFRAG (1U << 6)
18 #define EXTENT_BOUNDARY (1U << 9)
19 #define EXTENT_NODATASUM (1U << 10)
20 #define EXTENT_CLEAR_META_RESV (1U << 11)
21 #define EXTENT_FIRST_DELALLOC (1U << 12)
22 #define EXTENT_NEED_WAIT (1U << 13)
23 #define EXTENT_DAMAGED (1U << 14)
24 #define EXTENT_NORESERVE (1U << 15)
25 #define EXTENT_QGROUP_RESERVED (1U << 16)
26 #define EXTENT_CLEAR_DATA_RESV (1U << 17)
27 #define EXTENT_DELALLOC_NEW (1U << 18)
28 #define EXTENT_IOBITS (EXTENT_LOCKED | EXTENT_WRITEBACK)
29 #define EXTENT_DO_ACCOUNTING (EXTENT_CLEAR_META_RESV | \
30 EXTENT_CLEAR_DATA_RESV)
31 #define EXTENT_CTLBITS (EXTENT_DO_ACCOUNTING | EXTENT_FIRST_DELALLOC)
34 * flags for bio submission. The high bits indicate the compression
37 #define EXTENT_BIO_COMPRESSED 1
38 #define EXTENT_BIO_FLAG_SHIFT 16
40 /* these are bit numbers for test/set bit */
41 #define EXTENT_BUFFER_UPTODATE 0
42 #define EXTENT_BUFFER_DIRTY 2
43 #define EXTENT_BUFFER_CORRUPT 3
44 #define EXTENT_BUFFER_READAHEAD 4 /* this got triggered by readahead */
45 #define EXTENT_BUFFER_TREE_REF 5
46 #define EXTENT_BUFFER_STALE 6
47 #define EXTENT_BUFFER_WRITEBACK 7
48 #define EXTENT_BUFFER_READ_ERR 8 /* read IO error */
49 #define EXTENT_BUFFER_UNMAPPED 9
50 #define EXTENT_BUFFER_IN_TREE 10
51 #define EXTENT_BUFFER_WRITE_ERR 11 /* write IO error */
53 /* these are flags for __process_pages_contig */
54 #define PAGE_UNLOCK (1 << 0)
55 #define PAGE_CLEAR_DIRTY (1 << 1)
56 #define PAGE_SET_WRITEBACK (1 << 2)
57 #define PAGE_END_WRITEBACK (1 << 3)
58 #define PAGE_SET_PRIVATE2 (1 << 4)
59 #define PAGE_SET_ERROR (1 << 5)
60 #define PAGE_LOCK (1 << 6)
63 * page->private values. Every page that is controlled by the extent
64 * map has page->private set to one.
66 #define EXTENT_PAGE_PRIVATE 1
69 * The extent buffer bitmap operations are done with byte granularity instead of
70 * word granularity for two reasons:
71 * 1. The bitmaps must be little-endian on disk.
72 * 2. Bitmap items are not guaranteed to be aligned to a word and therefore a
73 * single word in a bitmap may straddle two pages in the extent buffer.
75 #define BIT_BYTE(nr) ((nr) / BITS_PER_BYTE)
76 #define BYTE_MASK ((1 << BITS_PER_BYTE) - 1)
77 #define BITMAP_FIRST_BYTE_MASK(start) \
78 ((BYTE_MASK << ((start) & (BITS_PER_BYTE - 1))) & BYTE_MASK)
79 #define BITMAP_LAST_BYTE_MASK(nbits) \
80 (BYTE_MASK >> (-(nbits) & (BITS_PER_BYTE - 1)))
86 struct io_failure_record;
88 typedef blk_status_t (extent_submit_bio_hook_t)(void *private_data, struct bio *bio,
89 int mirror_num, unsigned long bio_flags,
92 typedef blk_status_t (extent_submit_bio_start_t)(void *private_data,
93 struct bio *bio, u64 bio_offset);
95 struct extent_io_ops {
97 * The following callbacks must be allways defined, the function
98 * pointer will be called unconditionally.
100 extent_submit_bio_hook_t *submit_bio_hook;
101 int (*readpage_end_io_hook)(struct btrfs_io_bio *io_bio, u64 phy_offset,
102 struct page *page, u64 start, u64 end,
104 int (*readpage_io_failed_hook)(struct page *page, int failed_mirror);
107 * Optional hooks, called if the pointer is not NULL
109 void (*set_bit_hook)(void *private_data, struct extent_state *state,
111 void (*clear_bit_hook)(void *private_data,
112 struct extent_state *state,
114 void (*merge_extent_hook)(void *private_data,
115 struct extent_state *new,
116 struct extent_state *other);
117 void (*split_extent_hook)(void *private_data,
118 struct extent_state *orig, u64 split);
119 void (*check_extent_io_range)(void *private_data, const char *caller,
123 struct extent_io_tree {
124 struct rb_root state;
129 const struct extent_io_ops *ops;
132 struct extent_state {
134 u64 end; /* inclusive */
135 struct rb_node rb_node;
137 /* ADD NEW ELEMENTS AFTER THIS */
138 wait_queue_head_t wq;
142 struct io_failure_record *failrec;
144 #ifdef CONFIG_BTRFS_DEBUG
145 struct list_head leak_list;
149 #define INLINE_EXTENT_BUFFER_PAGES 16
150 #define MAX_INLINE_EXTENT_BUFFER_SIZE (INLINE_EXTENT_BUFFER_PAGES * PAGE_SIZE)
151 struct extent_buffer {
154 unsigned long bflags;
155 struct btrfs_fs_info *fs_info;
156 spinlock_t refs_lock;
160 struct rcu_head rcu_head;
163 /* count of read lock holders on the extent buffer */
164 atomic_t write_locks;
166 atomic_t blocking_writers;
167 atomic_t blocking_readers;
168 atomic_t spinning_readers;
169 atomic_t spinning_writers;
171 /* >= 0 if eb belongs to a log tree, -1 otherwise */
174 /* protects write locks */
177 /* readers use lock_wq while they wait for the write
178 * lock holders to unlock
180 wait_queue_head_t write_lock_wq;
182 /* writers use read_lock_wq while they wait for readers
185 wait_queue_head_t read_lock_wq;
186 struct page *pages[INLINE_EXTENT_BUFFER_PAGES];
187 #ifdef CONFIG_BTRFS_DEBUG
188 struct list_head leak_list;
193 * Structure to record how many bytes and which ranges are set/cleared
195 struct extent_changeset {
196 /* How many bytes are set/cleared in this operation */
197 unsigned int bytes_changed;
200 struct ulist range_changed;
203 static inline void extent_changeset_init(struct extent_changeset *changeset)
205 changeset->bytes_changed = 0;
206 ulist_init(&changeset->range_changed);
209 static inline struct extent_changeset *extent_changeset_alloc(void)
211 struct extent_changeset *ret;
213 ret = kmalloc(sizeof(*ret), GFP_KERNEL);
217 extent_changeset_init(ret);
221 static inline void extent_changeset_release(struct extent_changeset *changeset)
225 changeset->bytes_changed = 0;
226 ulist_release(&changeset->range_changed);
229 static inline void extent_changeset_free(struct extent_changeset *changeset)
233 extent_changeset_release(changeset);
237 static inline void extent_set_compress_type(unsigned long *bio_flags,
240 *bio_flags |= compress_type << EXTENT_BIO_FLAG_SHIFT;
243 static inline int extent_compress_type(unsigned long bio_flags)
245 return bio_flags >> EXTENT_BIO_FLAG_SHIFT;
248 struct extent_map_tree;
250 typedef struct extent_map *(get_extent_t)(struct btrfs_inode *inode,
256 void extent_io_tree_init(struct extent_io_tree *tree, void *private_data);
257 int try_release_extent_mapping(struct page *page, gfp_t mask);
258 int try_release_extent_buffer(struct page *page);
259 int lock_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
260 struct extent_state **cached);
262 static inline int lock_extent(struct extent_io_tree *tree, u64 start, u64 end)
264 return lock_extent_bits(tree, start, end, NULL);
267 int try_lock_extent(struct extent_io_tree *tree, u64 start, u64 end);
268 int extent_read_full_page(struct extent_io_tree *tree, struct page *page,
269 get_extent_t *get_extent, int mirror_num);
270 int __init extent_io_init(void);
271 void __cold extent_io_exit(void);
273 u64 count_range_bits(struct extent_io_tree *tree,
274 u64 *start, u64 search_end,
275 u64 max_bytes, unsigned bits, int contig);
277 void free_extent_state(struct extent_state *state);
278 int test_range_bit(struct extent_io_tree *tree, u64 start, u64 end,
279 unsigned bits, int filled,
280 struct extent_state *cached_state);
281 int clear_record_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
282 unsigned bits, struct extent_changeset *changeset);
283 int clear_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
284 unsigned bits, int wake, int delete,
285 struct extent_state **cached);
286 int __clear_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
287 unsigned bits, int wake, int delete,
288 struct extent_state **cached, gfp_t mask,
289 struct extent_changeset *changeset);
291 static inline int unlock_extent(struct extent_io_tree *tree, u64 start, u64 end)
293 return clear_extent_bit(tree, start, end, EXTENT_LOCKED, 1, 0, NULL);
296 static inline int unlock_extent_cached(struct extent_io_tree *tree, u64 start,
297 u64 end, struct extent_state **cached)
299 return __clear_extent_bit(tree, start, end, EXTENT_LOCKED, 1, 0, cached,
303 static inline int unlock_extent_cached_atomic(struct extent_io_tree *tree,
304 u64 start, u64 end, struct extent_state **cached)
306 return __clear_extent_bit(tree, start, end, EXTENT_LOCKED, 1, 0, cached,
310 static inline int clear_extent_bits(struct extent_io_tree *tree, u64 start,
311 u64 end, unsigned bits)
315 if (bits & EXTENT_LOCKED)
318 return clear_extent_bit(tree, start, end, bits, wake, 0, NULL);
321 int set_record_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
322 unsigned bits, struct extent_changeset *changeset);
323 int set_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
324 unsigned bits, u64 *failed_start,
325 struct extent_state **cached_state, gfp_t mask);
327 static inline int set_extent_bits(struct extent_io_tree *tree, u64 start,
328 u64 end, unsigned bits)
330 return set_extent_bit(tree, start, end, bits, NULL, NULL, GFP_NOFS);
333 static inline int clear_extent_uptodate(struct extent_io_tree *tree, u64 start,
334 u64 end, struct extent_state **cached_state)
336 return __clear_extent_bit(tree, start, end, EXTENT_UPTODATE, 0, 0,
337 cached_state, GFP_NOFS, NULL);
340 static inline int set_extent_dirty(struct extent_io_tree *tree, u64 start,
343 return set_extent_bit(tree, start, end, EXTENT_DIRTY, NULL,
347 static inline int clear_extent_dirty(struct extent_io_tree *tree, u64 start,
350 return clear_extent_bit(tree, start, end,
351 EXTENT_DIRTY | EXTENT_DELALLOC |
352 EXTENT_DO_ACCOUNTING, 0, 0, NULL);
355 int convert_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
356 unsigned bits, unsigned clear_bits,
357 struct extent_state **cached_state);
359 static inline int set_extent_delalloc(struct extent_io_tree *tree, u64 start,
360 u64 end, unsigned int extra_bits,
361 struct extent_state **cached_state)
363 return set_extent_bit(tree, start, end,
364 EXTENT_DELALLOC | EXTENT_UPTODATE | extra_bits,
365 NULL, cached_state, GFP_NOFS);
368 static inline int set_extent_defrag(struct extent_io_tree *tree, u64 start,
369 u64 end, struct extent_state **cached_state)
371 return set_extent_bit(tree, start, end,
372 EXTENT_DELALLOC | EXTENT_UPTODATE | EXTENT_DEFRAG,
373 NULL, cached_state, GFP_NOFS);
376 static inline int set_extent_new(struct extent_io_tree *tree, u64 start,
379 return set_extent_bit(tree, start, end, EXTENT_NEW, NULL, NULL,
383 static inline int set_extent_uptodate(struct extent_io_tree *tree, u64 start,
384 u64 end, struct extent_state **cached_state, gfp_t mask)
386 return set_extent_bit(tree, start, end, EXTENT_UPTODATE, NULL,
390 int find_first_extent_bit(struct extent_io_tree *tree, u64 start,
391 u64 *start_ret, u64 *end_ret, unsigned bits,
392 struct extent_state **cached_state);
393 int extent_invalidatepage(struct extent_io_tree *tree,
394 struct page *page, unsigned long offset);
395 int extent_write_full_page(struct page *page, struct writeback_control *wbc);
396 int extent_write_locked_range(struct inode *inode, u64 start, u64 end,
398 int extent_writepages(struct address_space *mapping,
399 struct writeback_control *wbc);
400 int btree_write_cache_pages(struct address_space *mapping,
401 struct writeback_control *wbc);
402 int extent_readpages(struct address_space *mapping, struct list_head *pages,
404 int extent_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
405 __u64 start, __u64 len);
406 void set_page_extent_mapped(struct page *page);
408 struct extent_buffer *alloc_extent_buffer(struct btrfs_fs_info *fs_info,
410 struct extent_buffer *__alloc_dummy_extent_buffer(struct btrfs_fs_info *fs_info,
411 u64 start, unsigned long len);
412 struct extent_buffer *alloc_dummy_extent_buffer(struct btrfs_fs_info *fs_info,
414 struct extent_buffer *btrfs_clone_extent_buffer(struct extent_buffer *src);
415 struct extent_buffer *find_extent_buffer(struct btrfs_fs_info *fs_info,
417 void free_extent_buffer(struct extent_buffer *eb);
418 void free_extent_buffer_stale(struct extent_buffer *eb);
420 #define WAIT_COMPLETE 1
421 #define WAIT_PAGE_LOCK 2
422 int read_extent_buffer_pages(struct extent_io_tree *tree,
423 struct extent_buffer *eb, int wait,
425 void wait_on_extent_buffer_writeback(struct extent_buffer *eb);
427 static inline int num_extent_pages(const struct extent_buffer *eb)
429 return (round_up(eb->start + eb->len, PAGE_SIZE) >> PAGE_SHIFT) -
430 (eb->start >> PAGE_SHIFT);
433 static inline void extent_buffer_get(struct extent_buffer *eb)
435 atomic_inc(&eb->refs);
438 static inline int extent_buffer_uptodate(struct extent_buffer *eb)
440 return test_bit(EXTENT_BUFFER_UPTODATE, &eb->bflags);
443 int memcmp_extent_buffer(const struct extent_buffer *eb, const void *ptrv,
444 unsigned long start, unsigned long len);
445 void read_extent_buffer(const struct extent_buffer *eb, void *dst,
448 int read_extent_buffer_to_user(const struct extent_buffer *eb,
449 void __user *dst, unsigned long start,
451 void write_extent_buffer_fsid(struct extent_buffer *eb, const void *src);
452 void write_extent_buffer_chunk_tree_uuid(struct extent_buffer *eb,
454 void write_extent_buffer(struct extent_buffer *eb, const void *src,
455 unsigned long start, unsigned long len);
456 void copy_extent_buffer_full(struct extent_buffer *dst,
457 struct extent_buffer *src);
458 void copy_extent_buffer(struct extent_buffer *dst, struct extent_buffer *src,
459 unsigned long dst_offset, unsigned long src_offset,
461 void memcpy_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
462 unsigned long src_offset, unsigned long len);
463 void memmove_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
464 unsigned long src_offset, unsigned long len);
465 void memzero_extent_buffer(struct extent_buffer *eb, unsigned long start,
467 int extent_buffer_test_bit(struct extent_buffer *eb, unsigned long start,
469 void extent_buffer_bitmap_set(struct extent_buffer *eb, unsigned long start,
470 unsigned long pos, unsigned long len);
471 void extent_buffer_bitmap_clear(struct extent_buffer *eb, unsigned long start,
472 unsigned long pos, unsigned long len);
473 void clear_extent_buffer_dirty(struct extent_buffer *eb);
474 bool set_extent_buffer_dirty(struct extent_buffer *eb);
475 void set_extent_buffer_uptodate(struct extent_buffer *eb);
476 void clear_extent_buffer_uptodate(struct extent_buffer *eb);
477 int extent_buffer_under_io(struct extent_buffer *eb);
478 int map_private_extent_buffer(const struct extent_buffer *eb,
479 unsigned long offset, unsigned long min_len,
480 char **map, unsigned long *map_start,
481 unsigned long *map_len);
482 void extent_range_clear_dirty_for_io(struct inode *inode, u64 start, u64 end);
483 void extent_range_redirty_for_io(struct inode *inode, u64 start, u64 end);
484 void extent_clear_unlock_delalloc(struct inode *inode, u64 start, u64 end,
485 u64 delalloc_end, struct page *locked_page,
486 unsigned bits_to_clear,
487 unsigned long page_ops);
488 struct bio *btrfs_bio_alloc(struct block_device *bdev, u64 first_byte);
489 struct bio *btrfs_io_bio_alloc(unsigned int nr_iovecs);
490 struct bio *btrfs_bio_clone(struct bio *bio);
491 struct bio *btrfs_bio_clone_partial(struct bio *orig, int offset, int size);
493 struct btrfs_fs_info;
496 int repair_io_failure(struct btrfs_fs_info *fs_info, u64 ino, u64 start,
497 u64 length, u64 logical, struct page *page,
498 unsigned int pg_offset, int mirror_num);
499 int clean_io_failure(struct btrfs_fs_info *fs_info,
500 struct extent_io_tree *failure_tree,
501 struct extent_io_tree *io_tree, u64 start,
502 struct page *page, u64 ino, unsigned int pg_offset);
503 void end_extent_writepage(struct page *page, int err, u64 start, u64 end);
504 int repair_eb_io_failure(struct btrfs_fs_info *fs_info,
505 struct extent_buffer *eb, int mirror_num);
508 * When IO fails, either with EIO or csum verification fails, we
509 * try other mirrors that might have a good copy of the data. This
510 * io_failure_record is used to record state as we go through all the
511 * mirrors. If another mirror has good data, the page is set up to date
512 * and things continue. If a good mirror can't be found, the original
513 * bio end_io callback is called to indicate things have failed.
515 struct io_failure_record {
520 unsigned long bio_flags;
527 void btrfs_free_io_failure_record(struct btrfs_inode *inode, u64 start,
529 int btrfs_get_io_failure_record(struct inode *inode, u64 start, u64 end,
530 struct io_failure_record **failrec_ret);
531 bool btrfs_check_repairable(struct inode *inode, unsigned failed_bio_pages,
532 struct io_failure_record *failrec, int fail_mirror);
533 struct bio *btrfs_create_repair_bio(struct inode *inode, struct bio *failed_bio,
534 struct io_failure_record *failrec,
535 struct page *page, int pg_offset, int icsum,
536 bio_end_io_t *endio_func, void *data);
537 int free_io_failure(struct extent_io_tree *failure_tree,
538 struct extent_io_tree *io_tree,
539 struct io_failure_record *rec);
540 #ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
541 u64 btrfs_find_lock_delalloc_range(struct inode *inode,
542 struct extent_io_tree *tree,
543 struct page *locked_page, u64 *start,
544 u64 *end, u64 max_bytes);
546 struct extent_buffer *alloc_test_extent_buffer(struct btrfs_fs_info *fs_info,