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