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