btrfs: extent_io: Introduce needed structure for recoding set/clear bits
[deliverable/linux.git] / fs / btrfs / extent_io.h
CommitLineData
d1310b2e
CM
1#ifndef __EXTENTIO__
2#define __EXTENTIO__
3
4#include <linux/rbtree.h>
ac467772 5#include "ulist.h"
d1310b2e
CM
6
7/* bits for the extent state */
9ee49a04
DS
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_IOBITS (EXTENT_LOCKED | EXTENT_WRITEBACK)
23#define EXTENT_CTLBITS (EXTENT_DO_ACCOUNTING | EXTENT_FIRST_DELALLOC)
d1310b2e 24
261507a0
LZ
25/*
26 * flags for bio submission. The high bits indicate the compression
27 * type for this bio
28 */
c8b97818 29#define EXTENT_BIO_COMPRESSED 1
de0022b9 30#define EXTENT_BIO_TREE_LOG 2
4b384318 31#define EXTENT_BIO_PARENT_LOCKED 4
261507a0 32#define EXTENT_BIO_FLAG_SHIFT 16
c8b97818 33
b4ce94de
CM
34/* these are bit numbers for test/set bit */
35#define EXTENT_BUFFER_UPTODATE 0
b9473439 36#define EXTENT_BUFFER_DIRTY 2
a826d6dc 37#define EXTENT_BUFFER_CORRUPT 3
ab0fff03 38#define EXTENT_BUFFER_READAHEAD 4 /* this got triggered by readahead */
3083ee2e
JB
39#define EXTENT_BUFFER_TREE_REF 5
40#define EXTENT_BUFFER_STALE 6
0b32f4bb 41#define EXTENT_BUFFER_WRITEBACK 7
656f30db 42#define EXTENT_BUFFER_READ_ERR 8 /* read IO error */
815a51c7 43#define EXTENT_BUFFER_DUMMY 9
34b41ace 44#define EXTENT_BUFFER_IN_TREE 10
656f30db 45#define EXTENT_BUFFER_WRITE_ERR 11 /* write IO error */
b4ce94de 46
a791e35e 47/* these are flags for extent_clear_unlock_delalloc */
c2790a2e
JB
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)
704de49d 53#define PAGE_SET_ERROR (1 << 5)
a791e35e 54
d1310b2e
CM
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
d1310b2e 60
70dec807 61struct extent_state;
ea466794 62struct btrfs_root;
facc8a22 63struct btrfs_io_bio;
70dec807 64
44b8bd7e 65typedef int (extent_submit_bio_hook_t)(struct inode *inode, int rw,
c8b97818 66 struct bio *bio, int mirror_num,
eaf25d93 67 unsigned long bio_flags, u64 bio_offset);
d1310b2e 68struct extent_io_ops {
c8b97818 69 int (*fill_delalloc)(struct inode *inode, struct page *locked_page,
771ed689
CM
70 u64 start, u64 end, int *page_started,
71 unsigned long *nr_written);
247e743c 72 int (*writepage_start_hook)(struct page *page, u64 start, u64 end);
d1310b2e 73 int (*writepage_io_hook)(struct page *page, u64 start, u64 end);
44b8bd7e 74 extent_submit_bio_hook_t *submit_bio_hook;
64a16701 75 int (*merge_bio_hook)(int rw, struct page *page, unsigned long offset,
c8b97818
CM
76 size_t size, struct bio *bio,
77 unsigned long bio_flags);
ea466794 78 int (*readpage_io_failed_hook)(struct page *page, int failed_mirror);
facc8a22
MX
79 int (*readpage_end_io_hook)(struct btrfs_io_bio *io_bio, u64 phy_offset,
80 struct page *page, u64 start, u64 end,
81 int mirror);
1259ab75 82 int (*writepage_end_io_hook)(struct page *page, u64 start, u64 end,
e6dcd2dc 83 struct extent_state *state, int uptodate);
1bf85046 84 void (*set_bit_hook)(struct inode *inode, struct extent_state *state,
9ee49a04 85 unsigned *bits);
1bf85046 86 void (*clear_bit_hook)(struct inode *inode, struct extent_state *state,
9ee49a04 87 unsigned *bits);
1bf85046
JM
88 void (*merge_extent_hook)(struct inode *inode,
89 struct extent_state *new,
90 struct extent_state *other);
91 void (*split_extent_hook)(struct inode *inode,
92 struct extent_state *orig, u64 split);
d1310b2e
CM
93};
94
95struct extent_io_tree {
96 struct rb_root state;
97 struct address_space *mapping;
98 u64 dirty_bytes;
0b32f4bb 99 int track_uptodate;
70dec807 100 spinlock_t lock;
e8c9f186 101 const struct extent_io_ops *ops;
d1310b2e
CM
102};
103
104struct extent_state {
105 u64 start;
106 u64 end; /* inclusive */
d1310b2e 107 struct rb_node rb_node;
9ed74f2d
JB
108
109 /* ADD NEW ELEMENTS AFTER THIS */
d1310b2e
CM
110 wait_queue_head_t wq;
111 atomic_t refs;
9ee49a04 112 unsigned state;
d1310b2e
CM
113
114 /* for use by the FS */
115 u64 private;
116
6d49ba1b 117#ifdef CONFIG_BTRFS_DEBUG
2d2ae547 118 struct list_head leak_list;
6d49ba1b 119#endif
d1310b2e
CM
120};
121
727011e0
CM
122#define INLINE_EXTENT_BUFFER_PAGES 16
123#define MAX_INLINE_EXTENT_BUFFER_SIZE (INLINE_EXTENT_BUFFER_PAGES * PAGE_CACHE_SIZE)
d1310b2e
CM
124struct extent_buffer {
125 u64 start;
126 unsigned long len;
b4ce94de 127 unsigned long bflags;
f28491e0 128 struct btrfs_fs_info *fs_info;
3083ee2e 129 spinlock_t refs_lock;
727011e0 130 atomic_t refs;
0b32f4bb 131 atomic_t io_pages;
5cf1ab56 132 int read_mirror;
19fe0a8b 133 struct rcu_head rcu_head;
5b25f70f 134 pid_t lock_owner;
b4ce94de 135
bd681513
CM
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;
656f30db
FM
143 short lock_nested;
144 /* >= 0 if eb belongs to a log tree, -1 otherwise */
145 short log_index;
bd681513
CM
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;
b4ce94de 154
bd681513
CM
155 /* writers use read_lock_wq while they wait for readers
156 * to unlock
b4ce94de 157 */
bd681513 158 wait_queue_head_t read_lock_wq;
b8dae313 159 struct page *pages[INLINE_EXTENT_BUFFER_PAGES];
6d49ba1b
ES
160#ifdef CONFIG_BTRFS_DEBUG
161 struct list_head leak_list;
162#endif
d1310b2e
CM
163};
164
ac467772
QW
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
261507a0
LZ
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
d1310b2e
CM
187struct extent_map_tree;
188
189typedef struct extent_map *(get_extent_t)(struct inode *inode,
190 struct page *page,
306e16ce 191 size_t pg_offset,
d1310b2e
CM
192 u64 start, u64 len,
193 int create);
194
195void extent_io_tree_init(struct extent_io_tree *tree,
f993c883 196 struct address_space *mapping);
d1310b2e 197int try_release_extent_mapping(struct extent_map_tree *map,
70dec807
CM
198 struct extent_io_tree *tree, struct page *page,
199 gfp_t mask);
f7a52a40 200int try_release_extent_buffer(struct page *page);
d0082371 201int lock_extent(struct extent_io_tree *tree, u64 start, u64 end);
1edbb734 202int lock_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
9ee49a04 203 unsigned bits, struct extent_state **cached);
d0082371 204int unlock_extent(struct extent_io_tree *tree, u64 start, u64 end);
2ac55d41
JB
205int unlock_extent_cached(struct extent_io_tree *tree, u64 start, u64 end,
206 struct extent_state **cached, gfp_t mask);
d0082371 207int try_lock_extent(struct extent_io_tree *tree, u64 start, u64 end);
d1310b2e 208int extent_read_full_page(struct extent_io_tree *tree, struct page *page,
8ddc7d9c 209 get_extent_t *get_extent, int mirror_num);
4b384318
MF
210int extent_read_full_page_nolock(struct extent_io_tree *tree, struct page *page,
211 get_extent_t *get_extent, int mirror_num);
d1310b2e
CM
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,
9ee49a04 217 u64 max_bytes, unsigned bits, int contig);
d1310b2e 218
4845e44f 219void free_extent_state(struct extent_state *state);
d1310b2e 220int test_range_bit(struct extent_io_tree *tree, u64 start, u64 end,
9ee49a04 221 unsigned bits, int filled,
41074888 222 struct extent_state *cached_state);
d1310b2e 223int clear_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
9ee49a04 224 unsigned bits, gfp_t mask);
e6dcd2dc 225int clear_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
9ee49a04 226 unsigned bits, int wake, int delete,
41074888 227 struct extent_state **cached, gfp_t mask);
d1310b2e 228int set_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
9ee49a04 229 unsigned bits, gfp_t mask);
4845e44f 230int set_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
9ee49a04 231 unsigned bits, u64 *failed_start,
4845e44f 232 struct extent_state **cached_state, gfp_t mask);
d1310b2e 233int set_extent_uptodate(struct extent_io_tree *tree, u64 start, u64 end,
507903b8 234 struct extent_state **cached_state, gfp_t mask);
5fd02043
JB
235int clear_extent_uptodate(struct extent_io_tree *tree, u64 start, u64 end,
236 struct extent_state **cached_state, gfp_t mask);
d1310b2e
CM
237int set_extent_new(struct extent_io_tree *tree, u64 start, u64 end,
238 gfp_t mask);
239int set_extent_dirty(struct extent_io_tree *tree, u64 start, u64 end,
240 gfp_t mask);
241int clear_extent_dirty(struct extent_io_tree *tree, u64 start, u64 end,
242 gfp_t mask);
462d6fac 243int convert_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
9ee49a04 244 unsigned bits, unsigned clear_bits,
e6138876 245 struct extent_state **cached_state, gfp_t mask);
d1310b2e 246int set_extent_delalloc(struct extent_io_tree *tree, u64 start, u64 end,
2ac55d41 247 struct extent_state **cached_state, gfp_t mask);
9e8a4a8b
LB
248int set_extent_defrag(struct extent_io_tree *tree, u64 start, u64 end,
249 struct extent_state **cached_state, gfp_t mask);
d1310b2e 250int find_first_extent_bit(struct extent_io_tree *tree, u64 start,
9ee49a04 251 u64 *start_ret, u64 *end_ret, unsigned bits,
e6138876 252 struct extent_state **cached_state);
d1310b2e
CM
253int extent_invalidatepage(struct extent_io_tree *tree,
254 struct page *page, unsigned long offset);
255int extent_write_full_page(struct extent_io_tree *tree, struct page *page,
256 get_extent_t *get_extent,
257 struct writeback_control *wbc);
771ed689
CM
258int extent_write_locked_range(struct extent_io_tree *tree, struct inode *inode,
259 u64 start, u64 end, get_extent_t *get_extent,
260 int mode);
d1310b2e
CM
261int extent_writepages(struct extent_io_tree *tree,
262 struct address_space *mapping,
263 get_extent_t *get_extent,
264 struct writeback_control *wbc);
0b32f4bb
JB
265int btree_write_cache_pages(struct address_space *mapping,
266 struct writeback_control *wbc);
d1310b2e
CM
267int extent_readpages(struct extent_io_tree *tree,
268 struct address_space *mapping,
269 struct list_head *pages, unsigned nr_pages,
270 get_extent_t get_extent);
1506fcc8
YS
271int extent_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
272 __u64 start, __u64 len, get_extent_t *get_extent);
d1310b2e
CM
273int get_state_private(struct extent_io_tree *tree, u64 start, u64 *private);
274void set_page_extent_mapped(struct page *page);
275
f28491e0 276struct extent_buffer *alloc_extent_buffer(struct btrfs_fs_info *fs_info,
ce3e6984 277 u64 start);
3f556f78
DS
278struct extent_buffer *alloc_dummy_extent_buffer(struct btrfs_fs_info *fs_info,
279 u64 start);
815a51c7 280struct extent_buffer *btrfs_clone_extent_buffer(struct extent_buffer *src);
f28491e0 281struct extent_buffer *find_extent_buffer(struct btrfs_fs_info *fs_info,
452c75c3 282 u64 start);
d1310b2e 283void free_extent_buffer(struct extent_buffer *eb);
3083ee2e 284void free_extent_buffer_stale(struct extent_buffer *eb);
bb82ab88
AJ
285#define WAIT_NONE 0
286#define WAIT_COMPLETE 1
287#define WAIT_PAGE_LOCK 2
d1310b2e 288int read_extent_buffer_pages(struct extent_io_tree *tree,
a86c12c7 289 struct extent_buffer *eb, u64 start, int wait,
f188591e 290 get_extent_t *get_extent, int mirror_num);
fd8b2b61 291void wait_on_extent_buffer_writeback(struct extent_buffer *eb);
479ed9ab
RD
292
293static inline unsigned long num_extent_pages(u64 start, u64 len)
294{
295 return ((start + len + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT) -
296 (start >> PAGE_CACHE_SHIFT);
297}
298
d1310b2e
CM
299static inline void extent_buffer_get(struct extent_buffer *eb)
300{
301 atomic_inc(&eb->refs);
302}
303
304int memcmp_extent_buffer(struct extent_buffer *eb, const void *ptrv,
305 unsigned long start,
306 unsigned long len);
307void read_extent_buffer(struct extent_buffer *eb, void *dst,
308 unsigned long start,
309 unsigned long len);
550ac1d8
GH
310int read_extent_buffer_to_user(struct extent_buffer *eb, void __user *dst,
311 unsigned long start,
312 unsigned long len);
d1310b2e
CM
313void write_extent_buffer(struct extent_buffer *eb, const void *src,
314 unsigned long start, unsigned long len);
315void copy_extent_buffer(struct extent_buffer *dst, struct extent_buffer *src,
316 unsigned long dst_offset, unsigned long src_offset,
317 unsigned long len);
318void memcpy_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
319 unsigned long src_offset, unsigned long len);
320void memmove_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
321 unsigned long src_offset, unsigned long len);
322void memset_extent_buffer(struct extent_buffer *eb, char c,
323 unsigned long start, unsigned long len);
1d4284bd 324void clear_extent_buffer_dirty(struct extent_buffer *eb);
0b32f4bb
JB
325int set_extent_buffer_dirty(struct extent_buffer *eb);
326int set_extent_buffer_uptodate(struct extent_buffer *eb);
327int clear_extent_buffer_uptodate(struct extent_buffer *eb);
328int extent_buffer_uptodate(struct extent_buffer *eb);
a26e8c9f 329int extent_buffer_under_io(struct extent_buffer *eb);
d1310b2e 330int map_private_extent_buffer(struct extent_buffer *eb, unsigned long offset,
a6591715 331 unsigned long min_len, char **map,
d1310b2e 332 unsigned long *map_start,
a6591715 333 unsigned long *map_len);
4adaa611
CM
334int extent_range_clear_dirty_for_io(struct inode *inode, u64 start, u64 end);
335int extent_range_redirty_for_io(struct inode *inode, u64 start, u64 end);
c2790a2e
JB
336int extent_clear_unlock_delalloc(struct inode *inode, u64 start, u64 end,
337 struct page *locked_page,
9ee49a04 338 unsigned bits_to_clear,
c2790a2e 339 unsigned long page_ops);
88f794ed
MX
340struct bio *
341btrfs_bio_alloc(struct block_device *bdev, u64 first_sector, int nr_vecs,
342 gfp_t gfp_flags);
9be3395b
CM
343struct bio *btrfs_io_bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs);
344struct bio *btrfs_bio_clone(struct bio *bio, gfp_t gfp_mask);
4a54c8c1 345
3ec706c8 346struct btrfs_fs_info;
4a54c8c1 347
1203b681
MX
348int repair_io_failure(struct inode *inode, u64 start, u64 length, u64 logical,
349 struct page *page, unsigned int pg_offset,
350 int mirror_num);
8b110e39
MX
351int clean_io_failure(struct inode *inode, u64 start, struct page *page,
352 unsigned int pg_offset);
87826df0 353int end_extent_writepage(struct page *page, int err, u64 start, u64 end);
ea466794
JB
354int repair_eb_io_failure(struct btrfs_root *root, struct extent_buffer *eb,
355 int mirror_num);
2fe6303e
MX
356
357/*
358 * When IO fails, either with EIO or csum verification fails, we
359 * try other mirrors that might have a good copy of the data. This
360 * io_failure_record is used to record state as we go through all the
361 * mirrors. If another mirror has good data, the page is set up to date
362 * and things continue. If a good mirror can't be found, the original
363 * bio end_io callback is called to indicate things have failed.
364 */
365struct io_failure_record {
366 struct page *page;
367 u64 start;
368 u64 len;
369 u64 logical;
370 unsigned long bio_flags;
371 int this_mirror;
372 int failed_mirror;
373 int in_validation;
374};
375
f612496b 376void btrfs_free_io_failure_record(struct inode *inode, u64 start, u64 end);
2fe6303e
MX
377int btrfs_get_io_failure_record(struct inode *inode, u64 start, u64 end,
378 struct io_failure_record **failrec_ret);
379int btrfs_check_repairable(struct inode *inode, struct bio *failed_bio,
380 struct io_failure_record *failrec, int fail_mirror);
381struct bio *btrfs_create_repair_bio(struct inode *inode, struct bio *failed_bio,
382 struct io_failure_record *failrec,
383 struct page *page, int pg_offset, int icsum,
8b110e39
MX
384 bio_end_io_t *endio_func, void *data);
385int free_io_failure(struct inode *inode, struct io_failure_record *rec);
294e30fe
JB
386#ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
387noinline u64 find_lock_delalloc_range(struct inode *inode,
388 struct extent_io_tree *tree,
389 struct page *locked_page, u64 *start,
390 u64 *end, u64 max_bytes);
0d4cf4e6 391#endif
faa2dbf0 392struct extent_buffer *alloc_test_extent_buffer(struct btrfs_fs_info *fs_info,
ce3e6984 393 u64 start);
294e30fe 394#endif
This page took 0.292222 seconds and 5 git commands to generate.