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