fs/btrfs/extent_io.h

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