4 #include <linux/rbtree.h>
5 #include <linux/refcount.h>
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_CLEAR_META_RESV (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_DELALLOC_NEW (1U << 18)
26 #define EXTENT_IOBITS (EXTENT_LOCKED | EXTENT_WRITEBACK)
27 #define EXTENT_DO_ACCOUNTING (EXTENT_CLEAR_META_RESV | \
28 EXTENT_CLEAR_DATA_RESV)
29 #define EXTENT_CTLBITS (EXTENT_DO_ACCOUNTING | EXTENT_FIRST_DELALLOC)
32 * flags for bio submission. The high bits indicate the compression
35 #define EXTENT_BIO_COMPRESSED 1
36 #define EXTENT_BIO_TREE_LOG 2
37 #define EXTENT_BIO_FLAG_SHIFT 16
39 /* these are bit numbers for test/set bit */
40 #define EXTENT_BUFFER_UPTODATE 0
41 #define EXTENT_BUFFER_DIRTY 2
42 #define EXTENT_BUFFER_CORRUPT 3
43 #define EXTENT_BUFFER_READAHEAD 4 /* this got triggered by readahead */
44 #define EXTENT_BUFFER_TREE_REF 5
45 #define EXTENT_BUFFER_STALE 6
46 #define EXTENT_BUFFER_WRITEBACK 7
47 #define EXTENT_BUFFER_READ_ERR 8 /* read IO error */
48 #define EXTENT_BUFFER_DUMMY 9
49 #define EXTENT_BUFFER_IN_TREE 10
50 #define EXTENT_BUFFER_WRITE_ERR 11 /* write IO error */
52 /* these are flags for __process_pages_contig */
53 #define PAGE_UNLOCK (1 << 0)
54 #define PAGE_CLEAR_DIRTY (1 << 1)
55 #define PAGE_SET_WRITEBACK (1 << 2)
56 #define PAGE_END_WRITEBACK (1 << 3)
57 #define PAGE_SET_PRIVATE2 (1 << 4)
58 #define PAGE_SET_ERROR (1 << 5)
59 #define PAGE_LOCK (1 << 6)
62 * page->private values. Every page that is controlled by the extent
63 * map has page->private set to one.
65 #define EXTENT_PAGE_PRIVATE 1
68 * The extent buffer bitmap operations are done with byte granularity instead of
69 * word granularity for two reasons:
70 * 1. The bitmaps must be little-endian on disk.
71 * 2. Bitmap items are not guaranteed to be aligned to a word and therefore a
72 * single word in a bitmap may straddle two pages in the extent buffer.
74 #define BIT_BYTE(nr) ((nr) / BITS_PER_BYTE)
75 #define BYTE_MASK ((1 << BITS_PER_BYTE) - 1)
76 #define BITMAP_FIRST_BYTE_MASK(start) \
77 ((BYTE_MASK << ((start) & (BITS_PER_BYTE - 1))) & BYTE_MASK)
78 #define BITMAP_LAST_BYTE_MASK(nbits) \
79 (BYTE_MASK >> (-(nbits) & (BITS_PER_BYTE - 1)))
81 static inline int le_test_bit(int nr, const u8 *addr)
83 return 1U & (addr[BIT_BYTE(nr)] >> (nr & (BITS_PER_BYTE-1)));
86 extern void le_bitmap_set(u8 *map, unsigned int start, int len);
87 extern void le_bitmap_clear(u8 *map, unsigned int start, int len);
93 struct io_failure_record;
95 typedef int (extent_submit_bio_hook_t)(void *private_data, struct bio *bio,
96 int mirror_num, unsigned long bio_flags,
98 struct extent_io_ops {
100 * The following callbacks must be allways defined, the function
101 * pointer will be called unconditionally.
103 extent_submit_bio_hook_t *submit_bio_hook;
104 int (*readpage_end_io_hook)(struct btrfs_io_bio *io_bio, u64 phy_offset,
105 struct page *page, u64 start, u64 end,
107 int (*merge_bio_hook)(struct page *page, unsigned long offset,
108 size_t size, struct bio *bio,
109 unsigned long bio_flags);
110 int (*readpage_io_failed_hook)(struct page *page, int failed_mirror);
111 struct btrfs_fs_info *(*tree_fs_info)(void *private_data);
112 void (*set_range_writeback)(void *private_data, u64 start, u64 end);
115 * Optional hooks, called if the pointer is not NULL
117 int (*fill_delalloc)(void *private_data, struct page *locked_page,
118 u64 start, u64 end, int *page_started,
119 unsigned long *nr_written);
121 int (*writepage_start_hook)(struct page *page, u64 start, u64 end);
122 void (*writepage_end_io_hook)(struct page *page, u64 start, u64 end,
123 struct extent_state *state, int uptodate);
124 void (*set_bit_hook)(void *private_data, struct extent_state *state,
126 void (*clear_bit_hook)(void *private_data,
127 struct extent_state *state,
129 void (*merge_extent_hook)(void *private_data,
130 struct extent_state *new,
131 struct extent_state *other);
132 void (*split_extent_hook)(void *private_data,
133 struct extent_state *orig, u64 split);
134 void (*check_extent_io_range)(void *private_data, const char *caller,
138 struct extent_io_tree {
139 struct rb_root state;
144 const struct extent_io_ops *ops;
147 struct extent_state {
149 u64 end; /* inclusive */
150 struct rb_node rb_node;
152 /* ADD NEW ELEMENTS AFTER THIS */
153 wait_queue_head_t wq;
157 struct io_failure_record *failrec;
159 #ifdef CONFIG_BTRFS_DEBUG
160 struct list_head leak_list;
164 #define INLINE_EXTENT_BUFFER_PAGES 16
165 #define MAX_INLINE_EXTENT_BUFFER_SIZE (INLINE_EXTENT_BUFFER_PAGES * PAGE_SIZE)
166 struct extent_buffer {
169 unsigned long bflags;
170 struct btrfs_fs_info *fs_info;
171 spinlock_t refs_lock;
175 struct rcu_head rcu_head;
178 /* count of read lock holders on the extent buffer */
179 atomic_t write_locks;
181 atomic_t blocking_writers;
182 atomic_t blocking_readers;
183 atomic_t spinning_readers;
184 atomic_t spinning_writers;
186 /* >= 0 if eb belongs to a log tree, -1 otherwise */
189 /* protects write locks */
192 /* readers use lock_wq while they wait for the write
193 * lock holders to unlock
195 wait_queue_head_t write_lock_wq;
197 /* writers use read_lock_wq while they wait for readers
200 wait_queue_head_t read_lock_wq;
201 struct page *pages[INLINE_EXTENT_BUFFER_PAGES];
202 #ifdef CONFIG_BTRFS_DEBUG
203 struct list_head leak_list;
208 * Structure to record how many bytes and which ranges are set/cleared
210 struct extent_changeset {
211 /* How many bytes are set/cleared in this operation */
215 struct ulist range_changed;
218 static inline void extent_set_compress_type(unsigned long *bio_flags,
221 *bio_flags |= compress_type << EXTENT_BIO_FLAG_SHIFT;
224 static inline int extent_compress_type(unsigned long bio_flags)
226 return bio_flags >> EXTENT_BIO_FLAG_SHIFT;
229 struct extent_map_tree;
231 typedef struct extent_map *(get_extent_t)(struct btrfs_inode *inode,
237 void extent_io_tree_init(struct extent_io_tree *tree, void *private_data);
238 int try_release_extent_mapping(struct extent_map_tree *map,
239 struct extent_io_tree *tree, struct page *page,
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);
245 static inline int lock_extent(struct extent_io_tree *tree, u64 start, u64 end)
247 return lock_extent_bits(tree, start, end, NULL);
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 extent_io_exit(void);
256 u64 count_range_bits(struct extent_io_tree *tree,
257 u64 *start, u64 search_end,
258 u64 max_bytes, unsigned bits, int contig);
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, gfp_t mask);
270 static inline int unlock_extent(struct extent_io_tree *tree, u64 start, u64 end)
272 return clear_extent_bit(tree, start, end, EXTENT_LOCKED, 1, 0, NULL,
276 static inline int unlock_extent_cached(struct extent_io_tree *tree, u64 start,
277 u64 end, struct extent_state **cached, gfp_t mask)
279 return clear_extent_bit(tree, start, end, EXTENT_LOCKED, 1, 0, cached,
283 static inline int clear_extent_bits(struct extent_io_tree *tree, u64 start,
284 u64 end, unsigned bits)
288 if (bits & EXTENT_LOCKED)
291 return clear_extent_bit(tree, start, end, bits, wake, 0, NULL,
295 int set_record_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
296 unsigned bits, struct extent_changeset *changeset);
297 int set_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
298 unsigned bits, u64 *failed_start,
299 struct extent_state **cached_state, gfp_t mask);
301 static inline int set_extent_bits(struct extent_io_tree *tree, u64 start,
302 u64 end, unsigned bits)
304 return set_extent_bit(tree, start, end, bits, NULL, NULL, GFP_NOFS);
307 static inline int clear_extent_uptodate(struct extent_io_tree *tree, u64 start,
308 u64 end, struct extent_state **cached_state, gfp_t mask)
310 return clear_extent_bit(tree, start, end, EXTENT_UPTODATE, 0, 0,
314 static inline int set_extent_dirty(struct extent_io_tree *tree, u64 start,
317 return set_extent_bit(tree, start, end, EXTENT_DIRTY, NULL,
321 static inline int clear_extent_dirty(struct extent_io_tree *tree, u64 start,
324 return clear_extent_bit(tree, start, end,
325 EXTENT_DIRTY | EXTENT_DELALLOC |
326 EXTENT_DO_ACCOUNTING, 0, 0, NULL, GFP_NOFS);
329 int convert_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
330 unsigned bits, unsigned clear_bits,
331 struct extent_state **cached_state);
333 static inline int set_extent_delalloc(struct extent_io_tree *tree, u64 start,
334 u64 end, struct extent_state **cached_state)
336 return set_extent_bit(tree, start, end,
337 EXTENT_DELALLOC | EXTENT_UPTODATE,
338 NULL, cached_state, GFP_NOFS);
341 static inline int set_extent_defrag(struct extent_io_tree *tree, u64 start,
342 u64 end, struct extent_state **cached_state)
344 return set_extent_bit(tree, start, end,
345 EXTENT_DELALLOC | EXTENT_UPTODATE | EXTENT_DEFRAG,
346 NULL, cached_state, GFP_NOFS);
349 static inline int set_extent_new(struct extent_io_tree *tree, u64 start,
352 return set_extent_bit(tree, start, end, EXTENT_NEW, NULL, NULL,
356 static inline int set_extent_uptodate(struct extent_io_tree *tree, u64 start,
357 u64 end, struct extent_state **cached_state, gfp_t mask)
359 return set_extent_bit(tree, start, end, EXTENT_UPTODATE, NULL,
363 int find_first_extent_bit(struct extent_io_tree *tree, u64 start,
364 u64 *start_ret, u64 *end_ret, unsigned bits,
365 struct extent_state **cached_state);
366 int extent_invalidatepage(struct extent_io_tree *tree,
367 struct page *page, unsigned long offset);
368 int extent_write_full_page(struct extent_io_tree *tree, struct page *page,
369 get_extent_t *get_extent,
370 struct writeback_control *wbc);
371 int extent_write_locked_range(struct extent_io_tree *tree, struct inode *inode,
372 u64 start, u64 end, get_extent_t *get_extent,
374 int extent_writepages(struct extent_io_tree *tree,
375 struct address_space *mapping,
376 get_extent_t *get_extent,
377 struct writeback_control *wbc);
378 int btree_write_cache_pages(struct address_space *mapping,
379 struct writeback_control *wbc);
380 int extent_readpages(struct extent_io_tree *tree,
381 struct address_space *mapping,
382 struct list_head *pages, unsigned nr_pages,
383 get_extent_t get_extent);
384 int extent_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
385 __u64 start, __u64 len, get_extent_t *get_extent);
386 void set_page_extent_mapped(struct page *page);
388 struct extent_buffer *alloc_extent_buffer(struct btrfs_fs_info *fs_info,
390 struct extent_buffer *__alloc_dummy_extent_buffer(struct btrfs_fs_info *fs_info,
391 u64 start, unsigned long len);
392 struct extent_buffer *alloc_dummy_extent_buffer(struct btrfs_fs_info *fs_info,
394 struct extent_buffer *btrfs_clone_extent_buffer(struct extent_buffer *src);
395 struct extent_buffer *find_extent_buffer(struct btrfs_fs_info *fs_info,
397 void free_extent_buffer(struct extent_buffer *eb);
398 void free_extent_buffer_stale(struct extent_buffer *eb);
400 #define WAIT_COMPLETE 1
401 #define WAIT_PAGE_LOCK 2
402 int read_extent_buffer_pages(struct extent_io_tree *tree,
403 struct extent_buffer *eb, int wait,
404 get_extent_t *get_extent, int mirror_num);
405 void wait_on_extent_buffer_writeback(struct extent_buffer *eb);
407 static inline unsigned long num_extent_pages(u64 start, u64 len)
409 return ((start + len + PAGE_SIZE - 1) >> PAGE_SHIFT) -
410 (start >> PAGE_SHIFT);
413 static inline void extent_buffer_get(struct extent_buffer *eb)
415 atomic_inc(&eb->refs);
418 int memcmp_extent_buffer(struct extent_buffer *eb, const void *ptrv,
421 void read_extent_buffer(struct extent_buffer *eb, void *dst,
424 int read_extent_buffer_to_user(struct extent_buffer *eb, void __user *dst,
427 void write_extent_buffer_fsid(struct extent_buffer *eb, const void *src);
428 void write_extent_buffer_chunk_tree_uuid(struct extent_buffer *eb,
430 void write_extent_buffer(struct extent_buffer *eb, const void *src,
431 unsigned long start, unsigned long len);
432 void copy_extent_buffer_full(struct extent_buffer *dst,
433 struct extent_buffer *src);
434 void copy_extent_buffer(struct extent_buffer *dst, struct extent_buffer *src,
435 unsigned long dst_offset, unsigned long src_offset,
437 void memcpy_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
438 unsigned long src_offset, unsigned long len);
439 void memmove_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
440 unsigned long src_offset, unsigned long len);
441 void memzero_extent_buffer(struct extent_buffer *eb, unsigned long start,
443 int extent_buffer_test_bit(struct extent_buffer *eb, unsigned long start,
445 void extent_buffer_bitmap_set(struct extent_buffer *eb, unsigned long start,
446 unsigned long pos, unsigned long len);
447 void extent_buffer_bitmap_clear(struct extent_buffer *eb, unsigned long start,
448 unsigned long pos, unsigned long len);
449 void clear_extent_buffer_dirty(struct extent_buffer *eb);
450 int set_extent_buffer_dirty(struct extent_buffer *eb);
451 void set_extent_buffer_uptodate(struct extent_buffer *eb);
452 void clear_extent_buffer_uptodate(struct extent_buffer *eb);
453 int extent_buffer_uptodate(struct extent_buffer *eb);
454 int extent_buffer_under_io(struct extent_buffer *eb);
455 int map_private_extent_buffer(struct extent_buffer *eb, unsigned long offset,
456 unsigned long min_len, char **map,
457 unsigned long *map_start,
458 unsigned long *map_len);
459 void extent_range_clear_dirty_for_io(struct inode *inode, u64 start, u64 end);
460 void extent_range_redirty_for_io(struct inode *inode, u64 start, u64 end);
461 void extent_clear_unlock_delalloc(struct inode *inode, u64 start, u64 end,
462 u64 delalloc_end, struct page *locked_page,
463 unsigned bits_to_clear,
464 unsigned long page_ops);
466 btrfs_bio_alloc(struct block_device *bdev, u64 first_sector, int nr_vecs,
468 struct bio *btrfs_io_bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs);
469 struct bio *btrfs_bio_clone(struct bio *bio);
470 struct bio *btrfs_bio_clone_partial(struct bio *orig, int offset, int size);
472 struct btrfs_fs_info;
475 int repair_io_failure(struct btrfs_fs_info *fs_info, u64 ino, u64 start,
476 u64 length, u64 logical, struct page *page,
477 unsigned int pg_offset, int mirror_num);
478 int clean_io_failure(struct btrfs_fs_info *fs_info,
479 struct extent_io_tree *failure_tree,
480 struct extent_io_tree *io_tree, u64 start,
481 struct page *page, u64 ino, unsigned int pg_offset);
482 void end_extent_writepage(struct page *page, int err, u64 start, u64 end);
483 int repair_eb_io_failure(struct btrfs_fs_info *fs_info,
484 struct extent_buffer *eb, int mirror_num);
487 * When IO fails, either with EIO or csum verification fails, we
488 * try other mirrors that might have a good copy of the data. This
489 * io_failure_record is used to record state as we go through all the
490 * mirrors. If another mirror has good data, the page is set up to date
491 * and things continue. If a good mirror can't be found, the original
492 * bio end_io callback is called to indicate things have failed.
494 struct io_failure_record {
499 unsigned long bio_flags;
506 void btrfs_free_io_failure_record(struct btrfs_inode *inode, u64 start,
508 int btrfs_get_io_failure_record(struct inode *inode, u64 start, u64 end,
509 struct io_failure_record **failrec_ret);
510 int btrfs_check_repairable(struct inode *inode, struct bio *failed_bio,
511 struct io_failure_record *failrec, int fail_mirror);
512 struct bio *btrfs_create_repair_bio(struct inode *inode, struct bio *failed_bio,
513 struct io_failure_record *failrec,
514 struct page *page, int pg_offset, int icsum,
515 bio_end_io_t *endio_func, void *data);
516 int free_io_failure(struct extent_io_tree *failure_tree,
517 struct extent_io_tree *io_tree,
518 struct io_failure_record *rec);
519 #ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
520 noinline u64 find_lock_delalloc_range(struct inode *inode,
521 struct extent_io_tree *tree,
522 struct page *locked_page, u64 *start,
523 u64 *end, u64 max_bytes);
525 struct extent_buffer *alloc_test_extent_buffer(struct btrfs_fs_info *fs_info,