]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - fs/btrfs/extent_io.h
Btrfs: fix missing hole after hole punching and fsync when using NO_HOLES
[mirror_ubuntu-bionic-kernel.git] / fs / btrfs / extent_io.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __EXTENTIO__
3 #define __EXTENTIO__
4
5 #include <linux/rbtree.h>
6 #include <linux/refcount.h>
7 #include "ulist.h"
8
9 /* bits for the extent state */
10 #define EXTENT_DIRTY (1U << 0)
11 #define EXTENT_WRITEBACK (1U << 1)
12 #define EXTENT_UPTODATE (1U << 2)
13 #define EXTENT_LOCKED (1U << 3)
14 #define EXTENT_NEW (1U << 4)
15 #define EXTENT_DELALLOC (1U << 5)
16 #define EXTENT_DEFRAG (1U << 6)
17 #define EXTENT_BOUNDARY (1U << 9)
18 #define EXTENT_NODATASUM (1U << 10)
19 #define EXTENT_CLEAR_META_RESV (1U << 11)
20 #define EXTENT_FIRST_DELALLOC (1U << 12)
21 #define EXTENT_NEED_WAIT (1U << 13)
22 #define EXTENT_DAMAGED (1U << 14)
23 #define EXTENT_NORESERVE (1U << 15)
24 #define EXTENT_QGROUP_RESERVED (1U << 16)
25 #define EXTENT_CLEAR_DATA_RESV (1U << 17)
26 #define EXTENT_DELALLOC_NEW (1U << 18)
27 #define EXTENT_IOBITS (EXTENT_LOCKED | EXTENT_WRITEBACK)
28 #define EXTENT_DO_ACCOUNTING (EXTENT_CLEAR_META_RESV | \
29 EXTENT_CLEAR_DATA_RESV)
30 #define EXTENT_CTLBITS (EXTENT_DO_ACCOUNTING | EXTENT_FIRST_DELALLOC)
31
32 /*
33 * flags for bio submission. The high bits indicate the compression
34 * type for this bio
35 */
36 #define EXTENT_BIO_COMPRESSED 1
37 #define EXTENT_BIO_FLAG_SHIFT 16
38
39 /* these are bit numbers for test/set bit */
40 #define EXTENT_BUFFER_UPTODATE 0
41 #define EXTENT_BUFFER_DIRTY 2
42 #define EXTENT_BUFFER_CORRUPT 3
43 #define EXTENT_BUFFER_READAHEAD 4 /* this got triggered by readahead */
44 #define EXTENT_BUFFER_TREE_REF 5
45 #define EXTENT_BUFFER_STALE 6
46 #define EXTENT_BUFFER_WRITEBACK 7
47 #define EXTENT_BUFFER_READ_ERR 8 /* read IO error */
48 #define EXTENT_BUFFER_DUMMY 9
49 #define EXTENT_BUFFER_IN_TREE 10
50 #define EXTENT_BUFFER_WRITE_ERR 11 /* write IO error */
51
52 /* these are flags for __process_pages_contig */
53 #define PAGE_UNLOCK (1 << 0)
54 #define PAGE_CLEAR_DIRTY (1 << 1)
55 #define PAGE_SET_WRITEBACK (1 << 2)
56 #define PAGE_END_WRITEBACK (1 << 3)
57 #define PAGE_SET_PRIVATE2 (1 << 4)
58 #define PAGE_SET_ERROR (1 << 5)
59 #define PAGE_LOCK (1 << 6)
60
61 /*
62 * page->private values. Every page that is controlled by the extent
63 * map has page->private set to one.
64 */
65 #define EXTENT_PAGE_PRIVATE 1
66
67 /*
68 * The extent buffer bitmap operations are done with byte granularity instead of
69 * word granularity for two reasons:
70 * 1. The bitmaps must be little-endian on disk.
71 * 2. Bitmap items are not guaranteed to be aligned to a word and therefore a
72 * single word in a bitmap may straddle two pages in the extent buffer.
73 */
74 #define BIT_BYTE(nr) ((nr) / BITS_PER_BYTE)
75 #define BYTE_MASK ((1 << BITS_PER_BYTE) - 1)
76 #define BITMAP_FIRST_BYTE_MASK(start) \
77 ((BYTE_MASK << ((start) & (BITS_PER_BYTE - 1))) & BYTE_MASK)
78 #define BITMAP_LAST_BYTE_MASK(nbits) \
79 (BYTE_MASK >> (-(nbits) & (BITS_PER_BYTE - 1)))
80
81 static inline int le_test_bit(int nr, const u8 *addr)
82 {
83 return 1U & (addr[BIT_BYTE(nr)] >> (nr & (BITS_PER_BYTE-1)));
84 }
85
86 extern void le_bitmap_set(u8 *map, unsigned int start, int len);
87 extern void le_bitmap_clear(u8 *map, unsigned int start, int len);
88
89 struct extent_state;
90 struct btrfs_root;
91 struct btrfs_inode;
92 struct btrfs_io_bio;
93 struct io_failure_record;
94
95 typedef blk_status_t (extent_submit_bio_hook_t)(void *private_data, struct bio *bio,
96 int mirror_num, unsigned long bio_flags,
97 u64 bio_offset);
98 struct extent_io_ops {
99 /*
100 * The following callbacks must be allways defined, the function
101 * pointer will be called unconditionally.
102 */
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,
106 int mirror);
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);
113
114 /*
115 * Optional hooks, called if the pointer is not NULL
116 */
117 int (*writepage_start_hook)(struct page *page, u64 start, u64 end);
118 void (*writepage_end_io_hook)(struct page *page, u64 start, u64 end,
119 struct extent_state *state, int uptodate);
120 void (*set_bit_hook)(void *private_data, struct extent_state *state,
121 unsigned *bits);
122 void (*clear_bit_hook)(void *private_data,
123 struct extent_state *state,
124 unsigned *bits);
125 void (*merge_extent_hook)(void *private_data,
126 struct extent_state *new,
127 struct extent_state *other);
128 void (*split_extent_hook)(void *private_data,
129 struct extent_state *orig, u64 split);
130 void (*check_extent_io_range)(void *private_data, const char *caller,
131 u64 start, u64 end);
132 };
133
134 struct extent_io_tree {
135 struct rb_root state;
136 void *private_data;
137 u64 dirty_bytes;
138 int track_uptodate;
139 spinlock_t lock;
140 const struct extent_io_ops *ops;
141 };
142
143 struct extent_state {
144 u64 start;
145 u64 end; /* inclusive */
146 struct rb_node rb_node;
147
148 /* ADD NEW ELEMENTS AFTER THIS */
149 wait_queue_head_t wq;
150 refcount_t refs;
151 unsigned state;
152
153 struct io_failure_record *failrec;
154
155 #ifdef CONFIG_BTRFS_DEBUG
156 struct list_head leak_list;
157 #endif
158 };
159
160 #define INLINE_EXTENT_BUFFER_PAGES 16
161 #define MAX_INLINE_EXTENT_BUFFER_SIZE (INLINE_EXTENT_BUFFER_PAGES * PAGE_SIZE)
162 struct extent_buffer {
163 u64 start;
164 unsigned long len;
165 unsigned long bflags;
166 struct btrfs_fs_info *fs_info;
167 spinlock_t refs_lock;
168 atomic_t refs;
169 atomic_t io_pages;
170 int read_mirror;
171 struct rcu_head rcu_head;
172 pid_t lock_owner;
173
174 /* count of read lock holders on the extent buffer */
175 atomic_t write_locks;
176 atomic_t read_locks;
177 atomic_t blocking_writers;
178 atomic_t blocking_readers;
179 atomic_t spinning_readers;
180 atomic_t spinning_writers;
181 short lock_nested;
182 /* >= 0 if eb belongs to a log tree, -1 otherwise */
183 short log_index;
184
185 /* protects write locks */
186 rwlock_t lock;
187
188 /* readers use lock_wq while they wait for the write
189 * lock holders to unlock
190 */
191 wait_queue_head_t write_lock_wq;
192
193 /* writers use read_lock_wq while they wait for readers
194 * to unlock
195 */
196 wait_queue_head_t read_lock_wq;
197 struct page *pages[INLINE_EXTENT_BUFFER_PAGES];
198 #ifdef CONFIG_BTRFS_DEBUG
199 struct list_head leak_list;
200 #endif
201 };
202
203 /*
204 * Structure to record how many bytes and which ranges are set/cleared
205 */
206 struct extent_changeset {
207 /* How many bytes are set/cleared in this operation */
208 unsigned int bytes_changed;
209
210 /* Changed ranges */
211 struct ulist range_changed;
212 };
213
214 static inline void extent_changeset_init(struct extent_changeset *changeset)
215 {
216 changeset->bytes_changed = 0;
217 ulist_init(&changeset->range_changed);
218 }
219
220 static inline struct extent_changeset *extent_changeset_alloc(void)
221 {
222 struct extent_changeset *ret;
223
224 ret = kmalloc(sizeof(*ret), GFP_KERNEL);
225 if (!ret)
226 return NULL;
227
228 extent_changeset_init(ret);
229 return ret;
230 }
231
232 static inline void extent_changeset_release(struct extent_changeset *changeset)
233 {
234 if (!changeset)
235 return;
236 changeset->bytes_changed = 0;
237 ulist_release(&changeset->range_changed);
238 }
239
240 static inline void extent_changeset_free(struct extent_changeset *changeset)
241 {
242 if (!changeset)
243 return;
244 extent_changeset_release(changeset);
245 kfree(changeset);
246 }
247
248 static inline void extent_set_compress_type(unsigned long *bio_flags,
249 int compress_type)
250 {
251 *bio_flags |= compress_type << EXTENT_BIO_FLAG_SHIFT;
252 }
253
254 static inline int extent_compress_type(unsigned long bio_flags)
255 {
256 return bio_flags >> EXTENT_BIO_FLAG_SHIFT;
257 }
258
259 struct extent_map_tree;
260
261 typedef struct extent_map *(get_extent_t)(struct btrfs_inode *inode,
262 struct page *page,
263 size_t pg_offset,
264 u64 start, u64 len,
265 int create);
266
267 void extent_io_tree_init(struct extent_io_tree *tree, void *private_data);
268 int try_release_extent_mapping(struct extent_map_tree *map,
269 struct extent_io_tree *tree, struct page *page,
270 gfp_t mask);
271 int try_release_extent_buffer(struct page *page);
272 int lock_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
273 struct extent_state **cached);
274
275 static inline int lock_extent(struct extent_io_tree *tree, u64 start, u64 end)
276 {
277 return lock_extent_bits(tree, start, end, NULL);
278 }
279
280 int try_lock_extent(struct extent_io_tree *tree, u64 start, u64 end);
281 int extent_read_full_page(struct extent_io_tree *tree, struct page *page,
282 get_extent_t *get_extent, int mirror_num);
283 int __init extent_io_init(void);
284 void extent_io_exit(void);
285
286 u64 count_range_bits(struct extent_io_tree *tree,
287 u64 *start, u64 search_end,
288 u64 max_bytes, unsigned bits, int contig);
289
290 void free_extent_state(struct extent_state *state);
291 int test_range_bit(struct extent_io_tree *tree, u64 start, u64 end,
292 unsigned bits, int filled,
293 struct extent_state *cached_state);
294 int clear_record_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
295 unsigned bits, struct extent_changeset *changeset);
296 int clear_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
297 unsigned bits, int wake, int delete,
298 struct extent_state **cached, gfp_t mask);
299
300 static inline int unlock_extent(struct extent_io_tree *tree, u64 start, u64 end)
301 {
302 return clear_extent_bit(tree, start, end, EXTENT_LOCKED, 1, 0, NULL,
303 GFP_NOFS);
304 }
305
306 static inline int unlock_extent_cached(struct extent_io_tree *tree, u64 start,
307 u64 end, struct extent_state **cached, gfp_t mask)
308 {
309 return clear_extent_bit(tree, start, end, EXTENT_LOCKED, 1, 0, cached,
310 mask);
311 }
312
313 static inline int clear_extent_bits(struct extent_io_tree *tree, u64 start,
314 u64 end, unsigned bits)
315 {
316 int wake = 0;
317
318 if (bits & EXTENT_LOCKED)
319 wake = 1;
320
321 return clear_extent_bit(tree, start, end, bits, wake, 0, NULL,
322 GFP_NOFS);
323 }
324
325 int set_record_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
326 unsigned bits, struct extent_changeset *changeset);
327 int set_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
328 unsigned bits, u64 *failed_start,
329 struct extent_state **cached_state, gfp_t mask);
330
331 static inline int set_extent_bits(struct extent_io_tree *tree, u64 start,
332 u64 end, unsigned bits)
333 {
334 return set_extent_bit(tree, start, end, bits, NULL, NULL, GFP_NOFS);
335 }
336
337 static inline int clear_extent_uptodate(struct extent_io_tree *tree, u64 start,
338 u64 end, struct extent_state **cached_state, gfp_t mask)
339 {
340 return clear_extent_bit(tree, start, end, EXTENT_UPTODATE, 0, 0,
341 cached_state, mask);
342 }
343
344 static inline int set_extent_dirty(struct extent_io_tree *tree, u64 start,
345 u64 end, gfp_t mask)
346 {
347 return set_extent_bit(tree, start, end, EXTENT_DIRTY, NULL,
348 NULL, mask);
349 }
350
351 static inline int clear_extent_dirty(struct extent_io_tree *tree, u64 start,
352 u64 end, struct extent_state **cached)
353 {
354 return clear_extent_bit(tree, start, end,
355 EXTENT_DIRTY | EXTENT_DELALLOC |
356 EXTENT_DO_ACCOUNTING, 0, 0, cached, GFP_NOFS);
357 }
358
359 int convert_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
360 unsigned bits, unsigned clear_bits,
361 struct extent_state **cached_state);
362
363 static inline int set_extent_delalloc(struct extent_io_tree *tree, u64 start,
364 u64 end, unsigned int extra_bits,
365 struct extent_state **cached_state)
366 {
367 return set_extent_bit(tree, start, end,
368 EXTENT_DELALLOC | EXTENT_UPTODATE | extra_bits,
369 NULL, cached_state, GFP_NOFS);
370 }
371
372 static inline int set_extent_defrag(struct extent_io_tree *tree, u64 start,
373 u64 end, struct extent_state **cached_state)
374 {
375 return set_extent_bit(tree, start, end,
376 EXTENT_DELALLOC | EXTENT_UPTODATE | EXTENT_DEFRAG,
377 NULL, cached_state, GFP_NOFS);
378 }
379
380 static inline int set_extent_new(struct extent_io_tree *tree, u64 start,
381 u64 end)
382 {
383 return set_extent_bit(tree, start, end, EXTENT_NEW, NULL, NULL,
384 GFP_NOFS);
385 }
386
387 static inline int set_extent_uptodate(struct extent_io_tree *tree, u64 start,
388 u64 end, struct extent_state **cached_state, gfp_t mask)
389 {
390 return set_extent_bit(tree, start, end, EXTENT_UPTODATE, NULL,
391 cached_state, mask);
392 }
393
394 int find_first_extent_bit(struct extent_io_tree *tree, u64 start,
395 u64 *start_ret, u64 *end_ret, unsigned bits,
396 struct extent_state **cached_state);
397 int extent_invalidatepage(struct extent_io_tree *tree,
398 struct page *page, unsigned long offset);
399 int extent_write_full_page(struct extent_io_tree *tree, struct page *page,
400 get_extent_t *get_extent,
401 struct writeback_control *wbc);
402 int extent_write_locked_range(struct extent_io_tree *tree, struct inode *inode,
403 u64 start, u64 end, get_extent_t *get_extent,
404 int mode);
405 int extent_writepages(struct extent_io_tree *tree,
406 struct address_space *mapping,
407 get_extent_t *get_extent,
408 struct writeback_control *wbc);
409 int btree_write_cache_pages(struct address_space *mapping,
410 struct writeback_control *wbc);
411 int extent_readpages(struct extent_io_tree *tree,
412 struct address_space *mapping,
413 struct list_head *pages, unsigned nr_pages,
414 get_extent_t get_extent);
415 int extent_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
416 __u64 start, __u64 len, get_extent_t *get_extent);
417 void set_page_extent_mapped(struct page *page);
418
419 struct extent_buffer *alloc_extent_buffer(struct btrfs_fs_info *fs_info,
420 u64 start);
421 struct extent_buffer *__alloc_dummy_extent_buffer(struct btrfs_fs_info *fs_info,
422 u64 start, unsigned long len);
423 struct extent_buffer *alloc_dummy_extent_buffer(struct btrfs_fs_info *fs_info,
424 u64 start);
425 struct extent_buffer *btrfs_clone_extent_buffer(struct extent_buffer *src);
426 struct extent_buffer *find_extent_buffer(struct btrfs_fs_info *fs_info,
427 u64 start);
428 void free_extent_buffer(struct extent_buffer *eb);
429 void free_extent_buffer_stale(struct extent_buffer *eb);
430 #define WAIT_NONE 0
431 #define WAIT_COMPLETE 1
432 #define WAIT_PAGE_LOCK 2
433 int read_extent_buffer_pages(struct extent_io_tree *tree,
434 struct extent_buffer *eb, int wait,
435 get_extent_t *get_extent, int mirror_num);
436 void wait_on_extent_buffer_writeback(struct extent_buffer *eb);
437
438 static inline unsigned long num_extent_pages(u64 start, u64 len)
439 {
440 return ((start + len + PAGE_SIZE - 1) >> PAGE_SHIFT) -
441 (start >> PAGE_SHIFT);
442 }
443
444 static inline void extent_buffer_get(struct extent_buffer *eb)
445 {
446 atomic_inc(&eb->refs);
447 }
448
449 int memcmp_extent_buffer(const struct extent_buffer *eb, const void *ptrv,
450 unsigned long start, unsigned long len);
451 void read_extent_buffer(const struct extent_buffer *eb, void *dst,
452 unsigned long start,
453 unsigned long len);
454 int read_extent_buffer_to_user(const struct extent_buffer *eb,
455 void __user *dst, unsigned long start,
456 unsigned long len);
457 void write_extent_buffer_fsid(struct extent_buffer *eb, const void *src);
458 void write_extent_buffer_chunk_tree_uuid(struct extent_buffer *eb,
459 const void *src);
460 void write_extent_buffer(struct extent_buffer *eb, const void *src,
461 unsigned long start, unsigned long len);
462 void copy_extent_buffer_full(struct extent_buffer *dst,
463 struct extent_buffer *src);
464 void copy_extent_buffer(struct extent_buffer *dst, struct extent_buffer *src,
465 unsigned long dst_offset, unsigned long src_offset,
466 unsigned long len);
467 void memcpy_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
468 unsigned long src_offset, unsigned long len);
469 void memmove_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
470 unsigned long src_offset, unsigned long len);
471 void memzero_extent_buffer(struct extent_buffer *eb, unsigned long start,
472 unsigned long len);
473 int extent_buffer_test_bit(struct extent_buffer *eb, unsigned long start,
474 unsigned long pos);
475 void extent_buffer_bitmap_set(struct extent_buffer *eb, unsigned long start,
476 unsigned long pos, unsigned long len);
477 void extent_buffer_bitmap_clear(struct extent_buffer *eb, unsigned long start,
478 unsigned long pos, unsigned long len);
479 void clear_extent_buffer_dirty(struct extent_buffer *eb);
480 int set_extent_buffer_dirty(struct extent_buffer *eb);
481 void set_extent_buffer_uptodate(struct extent_buffer *eb);
482 void clear_extent_buffer_uptodate(struct extent_buffer *eb);
483 int extent_buffer_uptodate(struct extent_buffer *eb);
484 int extent_buffer_under_io(struct extent_buffer *eb);
485 int map_private_extent_buffer(const struct extent_buffer *eb,
486 unsigned long offset, unsigned long min_len,
487 char **map, unsigned long *map_start,
488 unsigned long *map_len);
489 void extent_range_clear_dirty_for_io(struct inode *inode, u64 start, u64 end);
490 void extent_range_redirty_for_io(struct inode *inode, u64 start, u64 end);
491 void extent_clear_unlock_delalloc(struct inode *inode, u64 start, u64 end,
492 u64 delalloc_end, struct page *locked_page,
493 unsigned bits_to_clear,
494 unsigned long page_ops);
495 struct bio *btrfs_bio_alloc(struct block_device *bdev, u64 first_byte);
496 struct bio *btrfs_io_bio_alloc(unsigned int nr_iovecs);
497 struct bio *btrfs_bio_clone(struct bio *bio);
498 struct bio *btrfs_bio_clone_partial(struct bio *orig, int offset, int size);
499
500 struct btrfs_fs_info;
501 struct btrfs_inode;
502
503 int repair_io_failure(struct btrfs_fs_info *fs_info, u64 ino, u64 start,
504 u64 length, u64 logical, struct page *page,
505 unsigned int pg_offset, int mirror_num);
506 int clean_io_failure(struct btrfs_fs_info *fs_info,
507 struct extent_io_tree *failure_tree,
508 struct extent_io_tree *io_tree, u64 start,
509 struct page *page, u64 ino, unsigned int pg_offset);
510 void end_extent_writepage(struct page *page, int err, u64 start, u64 end);
511 int repair_eb_io_failure(struct btrfs_fs_info *fs_info,
512 struct extent_buffer *eb, int mirror_num);
513
514 /*
515 * When IO fails, either with EIO or csum verification fails, we
516 * try other mirrors that might have a good copy of the data. This
517 * io_failure_record is used to record state as we go through all the
518 * mirrors. If another mirror has good data, the page is set up to date
519 * and things continue. If a good mirror can't be found, the original
520 * bio end_io callback is called to indicate things have failed.
521 */
522 struct io_failure_record {
523 struct page *page;
524 u64 start;
525 u64 len;
526 u64 logical;
527 unsigned long bio_flags;
528 int this_mirror;
529 int failed_mirror;
530 int in_validation;
531 };
532
533
534 void btrfs_free_io_failure_record(struct btrfs_inode *inode, u64 start,
535 u64 end);
536 int btrfs_get_io_failure_record(struct inode *inode, u64 start, u64 end,
537 struct io_failure_record **failrec_ret);
538 bool btrfs_check_repairable(struct inode *inode, struct bio *failed_bio,
539 struct io_failure_record *failrec, int fail_mirror);
540 struct bio *btrfs_create_repair_bio(struct inode *inode, struct bio *failed_bio,
541 struct io_failure_record *failrec,
542 struct page *page, int pg_offset, int icsum,
543 bio_end_io_t *endio_func, void *data);
544 int free_io_failure(struct extent_io_tree *failure_tree,
545 struct extent_io_tree *io_tree,
546 struct io_failure_record *rec);
547 #ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
548 noinline u64 find_lock_delalloc_range(struct inode *inode,
549 struct extent_io_tree *tree,
550 struct page *locked_page, u64 *start,
551 u64 *end, u64 max_bytes);
552 #endif
553 struct extent_buffer *alloc_test_extent_buffer(struct btrfs_fs_info *fs_info,
554 u64 start);
555 #endif