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