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_DUMMY 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 typedef blk_status_t (extent_submit_bio_done_t)(void *private_data,
96 struct bio *bio, int mirror_num);
98 struct extent_io_ops {
100 * The following callbacks must be allways defined, the function
101 * pointer will be called unconditionally.
103 extent_submit_bio_hook_t *submit_bio_hook;
104 int (*readpage_end_io_hook)(struct btrfs_io_bio *io_bio, u64 phy_offset,
105 struct page *page, u64 start, u64 end,
107 int (*merge_bio_hook)(struct page *page, unsigned long offset,
108 size_t size, struct bio *bio,
109 unsigned long bio_flags);
110 int (*readpage_io_failed_hook)(struct page *page, int failed_mirror);
111 struct btrfs_fs_info *(*tree_fs_info)(void *private_data);
112 void (*set_range_writeback)(void *private_data, u64 start, u64 end);
115 * Optional hooks, called if the pointer is not NULL
117 int (*fill_delalloc)(void *private_data, struct page *locked_page,
118 u64 start, u64 end, int *page_started,
119 unsigned long *nr_written,
120 struct writeback_control *wbc);
122 int (*writepage_start_hook)(struct page *page, u64 start, u64 end);
123 void (*writepage_end_io_hook)(struct page *page, u64 start, u64 end,
124 struct extent_state *state, int uptodate);
125 void (*set_bit_hook)(void *private_data, struct extent_state *state,
127 void (*clear_bit_hook)(void *private_data,
128 struct extent_state *state,
130 void (*merge_extent_hook)(void *private_data,
131 struct extent_state *new,
132 struct extent_state *other);
133 void (*split_extent_hook)(void *private_data,
134 struct extent_state *orig, u64 split);
135 void (*check_extent_io_range)(void *private_data, const char *caller,
139 struct extent_io_tree {
140 struct rb_root state;
145 const struct extent_io_ops *ops;
148 struct extent_state {
150 u64 end; /* inclusive */
151 struct rb_node rb_node;
153 /* ADD NEW ELEMENTS AFTER THIS */
154 wait_queue_head_t wq;
158 struct io_failure_record *failrec;
160 #ifdef CONFIG_BTRFS_DEBUG
161 struct list_head leak_list;
165 #define INLINE_EXTENT_BUFFER_PAGES 16
166 #define MAX_INLINE_EXTENT_BUFFER_SIZE (INLINE_EXTENT_BUFFER_PAGES * PAGE_SIZE)
167 struct extent_buffer {
170 unsigned long bflags;
171 struct btrfs_fs_info *fs_info;
172 spinlock_t refs_lock;
176 struct rcu_head rcu_head;
179 /* count of read lock holders on the extent buffer */
180 atomic_t write_locks;
182 atomic_t blocking_writers;
183 atomic_t blocking_readers;
184 atomic_t spinning_readers;
185 atomic_t spinning_writers;
187 /* >= 0 if eb belongs to a log tree, -1 otherwise */
190 /* protects write locks */
193 /* readers use lock_wq while they wait for the write
194 * lock holders to unlock
196 wait_queue_head_t write_lock_wq;
198 /* writers use read_lock_wq while they wait for readers
201 wait_queue_head_t read_lock_wq;
202 struct page *pages[INLINE_EXTENT_BUFFER_PAGES];
203 #ifdef CONFIG_BTRFS_DEBUG
204 struct list_head leak_list;
209 * Structure to record how many bytes and which ranges are set/cleared
211 struct extent_changeset {
212 /* How many bytes are set/cleared in this operation */
213 unsigned int bytes_changed;
216 struct ulist range_changed;
219 static inline void extent_changeset_init(struct extent_changeset *changeset)
221 changeset->bytes_changed = 0;
222 ulist_init(&changeset->range_changed);
225 static inline struct extent_changeset *extent_changeset_alloc(void)
227 struct extent_changeset *ret;
229 ret = kmalloc(sizeof(*ret), GFP_KERNEL);
233 extent_changeset_init(ret);
237 static inline void extent_changeset_release(struct extent_changeset *changeset)
241 changeset->bytes_changed = 0;
242 ulist_release(&changeset->range_changed);
245 static inline void extent_changeset_free(struct extent_changeset *changeset)
249 extent_changeset_release(changeset);
253 static inline void extent_set_compress_type(unsigned long *bio_flags,
256 *bio_flags |= compress_type << EXTENT_BIO_FLAG_SHIFT;
259 static inline int extent_compress_type(unsigned long bio_flags)
261 return bio_flags >> EXTENT_BIO_FLAG_SHIFT;
264 struct extent_map_tree;
266 typedef struct extent_map *(get_extent_t)(struct btrfs_inode *inode,
272 void extent_io_tree_init(struct extent_io_tree *tree, void *private_data);
273 int try_release_extent_mapping(struct extent_map_tree *map,
274 struct extent_io_tree *tree, struct page *page,
276 int try_release_extent_buffer(struct page *page);
277 int lock_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
278 struct extent_state **cached);
280 static inline int lock_extent(struct extent_io_tree *tree, u64 start, u64 end)
282 return lock_extent_bits(tree, start, end, NULL);
285 int try_lock_extent(struct extent_io_tree *tree, u64 start, u64 end);
286 int extent_read_full_page(struct extent_io_tree *tree, struct page *page,
287 get_extent_t *get_extent, int mirror_num);
288 int __init extent_io_init(void);
289 void __cold extent_io_exit(void);
291 u64 count_range_bits(struct extent_io_tree *tree,
292 u64 *start, u64 search_end,
293 u64 max_bytes, unsigned bits, int contig);
295 void free_extent_state(struct extent_state *state);
296 int test_range_bit(struct extent_io_tree *tree, u64 start, u64 end,
297 unsigned bits, int filled,
298 struct extent_state *cached_state);
299 int clear_record_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
300 unsigned bits, struct extent_changeset *changeset);
301 int clear_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
302 unsigned bits, int wake, int delete,
303 struct extent_state **cached);
304 int __clear_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
305 unsigned bits, int wake, int delete,
306 struct extent_state **cached, gfp_t mask,
307 struct extent_changeset *changeset);
309 static inline int unlock_extent(struct extent_io_tree *tree, u64 start, u64 end)
311 return clear_extent_bit(tree, start, end, EXTENT_LOCKED, 1, 0, NULL);
314 static inline int unlock_extent_cached(struct extent_io_tree *tree, u64 start,
315 u64 end, struct extent_state **cached)
317 return __clear_extent_bit(tree, start, end, EXTENT_LOCKED, 1, 0, cached,
321 static inline int unlock_extent_cached_atomic(struct extent_io_tree *tree,
322 u64 start, u64 end, struct extent_state **cached)
324 return __clear_extent_bit(tree, start, end, EXTENT_LOCKED, 1, 0, cached,
328 static inline int clear_extent_bits(struct extent_io_tree *tree, u64 start,
329 u64 end, unsigned bits)
333 if (bits & EXTENT_LOCKED)
336 return clear_extent_bit(tree, start, end, bits, wake, 0, NULL);
339 int set_record_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
340 unsigned bits, struct extent_changeset *changeset);
341 int set_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
342 unsigned bits, u64 *failed_start,
343 struct extent_state **cached_state, gfp_t mask);
345 static inline int set_extent_bits(struct extent_io_tree *tree, u64 start,
346 u64 end, unsigned bits)
348 return set_extent_bit(tree, start, end, bits, NULL, NULL, GFP_NOFS);
351 static inline int clear_extent_uptodate(struct extent_io_tree *tree, u64 start,
352 u64 end, struct extent_state **cached_state)
354 return __clear_extent_bit(tree, start, end, EXTENT_UPTODATE, 0, 0,
355 cached_state, GFP_NOFS, NULL);
358 static inline int set_extent_dirty(struct extent_io_tree *tree, u64 start,
361 return set_extent_bit(tree, start, end, EXTENT_DIRTY, NULL,
365 static inline int clear_extent_dirty(struct extent_io_tree *tree, u64 start,
368 return clear_extent_bit(tree, start, end,
369 EXTENT_DIRTY | EXTENT_DELALLOC |
370 EXTENT_DO_ACCOUNTING, 0, 0, NULL);
373 int convert_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
374 unsigned bits, unsigned clear_bits,
375 struct extent_state **cached_state);
377 static inline int set_extent_delalloc(struct extent_io_tree *tree, u64 start,
378 u64 end, unsigned int extra_bits,
379 struct extent_state **cached_state)
381 return set_extent_bit(tree, start, end,
382 EXTENT_DELALLOC | EXTENT_UPTODATE | extra_bits,
383 NULL, cached_state, GFP_NOFS);
386 static inline int set_extent_defrag(struct extent_io_tree *tree, u64 start,
387 u64 end, struct extent_state **cached_state)
389 return set_extent_bit(tree, start, end,
390 EXTENT_DELALLOC | EXTENT_UPTODATE | EXTENT_DEFRAG,
391 NULL, cached_state, GFP_NOFS);
394 static inline int set_extent_new(struct extent_io_tree *tree, u64 start,
397 return set_extent_bit(tree, start, end, EXTENT_NEW, NULL, NULL,
401 static inline int set_extent_uptodate(struct extent_io_tree *tree, u64 start,
402 u64 end, struct extent_state **cached_state, gfp_t mask)
404 return set_extent_bit(tree, start, end, EXTENT_UPTODATE, NULL,
408 int find_first_extent_bit(struct extent_io_tree *tree, u64 start,
409 u64 *start_ret, u64 *end_ret, unsigned bits,
410 struct extent_state **cached_state);
411 int extent_invalidatepage(struct extent_io_tree *tree,
412 struct page *page, unsigned long offset);
413 int extent_write_full_page(struct page *page, struct writeback_control *wbc);
414 int extent_write_locked_range(struct inode *inode, u64 start, u64 end,
416 int extent_writepages(struct extent_io_tree *tree,
417 struct address_space *mapping,
418 struct writeback_control *wbc);
419 int btree_write_cache_pages(struct address_space *mapping,
420 struct writeback_control *wbc);
421 int extent_readpages(struct extent_io_tree *tree,
422 struct address_space *mapping,
423 struct list_head *pages, unsigned nr_pages);
424 int extent_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
425 __u64 start, __u64 len);
426 void set_page_extent_mapped(struct page *page);
428 struct extent_buffer *alloc_extent_buffer(struct btrfs_fs_info *fs_info,
430 struct extent_buffer *__alloc_dummy_extent_buffer(struct btrfs_fs_info *fs_info,
431 u64 start, unsigned long len);
432 struct extent_buffer *alloc_dummy_extent_buffer(struct btrfs_fs_info *fs_info,
434 struct extent_buffer *btrfs_clone_extent_buffer(struct extent_buffer *src);
435 struct extent_buffer *find_extent_buffer(struct btrfs_fs_info *fs_info,
437 void free_extent_buffer(struct extent_buffer *eb);
438 void free_extent_buffer_stale(struct extent_buffer *eb);
440 #define WAIT_COMPLETE 1
441 #define WAIT_PAGE_LOCK 2
442 int read_extent_buffer_pages(struct extent_io_tree *tree,
443 struct extent_buffer *eb, int wait,
445 void wait_on_extent_buffer_writeback(struct extent_buffer *eb);
447 static inline unsigned long num_extent_pages(u64 start, u64 len)
449 return ((start + len + PAGE_SIZE - 1) >> PAGE_SHIFT) -
450 (start >> PAGE_SHIFT);
453 static inline void extent_buffer_get(struct extent_buffer *eb)
455 atomic_inc(&eb->refs);
458 static inline int extent_buffer_uptodate(struct extent_buffer *eb)
460 return test_bit(EXTENT_BUFFER_UPTODATE, &eb->bflags);
463 int memcmp_extent_buffer(const struct extent_buffer *eb, const void *ptrv,
464 unsigned long start, unsigned long len);
465 void read_extent_buffer(const struct extent_buffer *eb, void *dst,
468 int read_extent_buffer_to_user(const struct extent_buffer *eb,
469 void __user *dst, unsigned long start,
471 void write_extent_buffer_fsid(struct extent_buffer *eb, const void *src);
472 void write_extent_buffer_chunk_tree_uuid(struct extent_buffer *eb,
474 void write_extent_buffer(struct extent_buffer *eb, const void *src,
475 unsigned long start, unsigned long len);
476 void copy_extent_buffer_full(struct extent_buffer *dst,
477 struct extent_buffer *src);
478 void copy_extent_buffer(struct extent_buffer *dst, struct extent_buffer *src,
479 unsigned long dst_offset, unsigned long src_offset,
481 void memcpy_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
482 unsigned long src_offset, unsigned long len);
483 void memmove_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
484 unsigned long src_offset, unsigned long len);
485 void memzero_extent_buffer(struct extent_buffer *eb, unsigned long start,
487 int extent_buffer_test_bit(struct extent_buffer *eb, unsigned long start,
489 void extent_buffer_bitmap_set(struct extent_buffer *eb, unsigned long start,
490 unsigned long pos, unsigned long len);
491 void extent_buffer_bitmap_clear(struct extent_buffer *eb, unsigned long start,
492 unsigned long pos, unsigned long len);
493 void clear_extent_buffer_dirty(struct extent_buffer *eb);
494 int set_extent_buffer_dirty(struct extent_buffer *eb);
495 void set_extent_buffer_uptodate(struct extent_buffer *eb);
496 void clear_extent_buffer_uptodate(struct extent_buffer *eb);
497 int extent_buffer_under_io(struct extent_buffer *eb);
498 int map_private_extent_buffer(const struct extent_buffer *eb,
499 unsigned long offset, unsigned long min_len,
500 char **map, unsigned long *map_start,
501 unsigned long *map_len);
502 void extent_range_clear_dirty_for_io(struct inode *inode, u64 start, u64 end);
503 void extent_range_redirty_for_io(struct inode *inode, u64 start, u64 end);
504 void extent_clear_unlock_delalloc(struct inode *inode, u64 start, u64 end,
505 u64 delalloc_end, struct page *locked_page,
506 unsigned bits_to_clear,
507 unsigned long page_ops);
508 struct bio *btrfs_bio_alloc(struct block_device *bdev, u64 first_byte);
509 struct bio *btrfs_io_bio_alloc(unsigned int nr_iovecs);
510 struct bio *btrfs_bio_clone(struct bio *bio);
511 struct bio *btrfs_bio_clone_partial(struct bio *orig, int offset, int size);
513 struct btrfs_fs_info;
516 int repair_io_failure(struct btrfs_fs_info *fs_info, u64 ino, u64 start,
517 u64 length, u64 logical, struct page *page,
518 unsigned int pg_offset, int mirror_num);
519 int clean_io_failure(struct btrfs_fs_info *fs_info,
520 struct extent_io_tree *failure_tree,
521 struct extent_io_tree *io_tree, u64 start,
522 struct page *page, u64 ino, unsigned int pg_offset);
523 void end_extent_writepage(struct page *page, int err, u64 start, u64 end);
524 int repair_eb_io_failure(struct btrfs_fs_info *fs_info,
525 struct extent_buffer *eb, int mirror_num);
528 * When IO fails, either with EIO or csum verification fails, we
529 * try other mirrors that might have a good copy of the data. This
530 * io_failure_record is used to record state as we go through all the
531 * mirrors. If another mirror has good data, the page is set up to date
532 * and things continue. If a good mirror can't be found, the original
533 * bio end_io callback is called to indicate things have failed.
535 struct io_failure_record {
540 unsigned long bio_flags;
547 void btrfs_free_io_failure_record(struct btrfs_inode *inode, u64 start,
549 int btrfs_get_io_failure_record(struct inode *inode, u64 start, u64 end,
550 struct io_failure_record **failrec_ret);
551 bool btrfs_check_repairable(struct inode *inode, unsigned failed_bio_pages,
552 struct io_failure_record *failrec, int fail_mirror);
553 struct bio *btrfs_create_repair_bio(struct inode *inode, struct bio *failed_bio,
554 struct io_failure_record *failrec,
555 struct page *page, int pg_offset, int icsum,
556 bio_end_io_t *endio_func, void *data);
557 int free_io_failure(struct extent_io_tree *failure_tree,
558 struct extent_io_tree *io_tree,
559 struct io_failure_record *rec);
560 #ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
561 noinline u64 find_lock_delalloc_range(struct inode *inode,
562 struct extent_io_tree *tree,
563 struct page *locked_page, u64 *start,
564 u64 *end, u64 max_bytes);
566 struct extent_buffer *alloc_test_extent_buffer(struct btrfs_fs_info *fs_info,