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