Btrfs: add branch prediction hints in the read page end IO function
[linux-2.6-block.git] / fs / btrfs / extent_io.h
CommitLineData
d1310b2e
CM
1#ifndef __EXTENTIO__
2#define __EXTENTIO__
3
4#include <linux/rbtree.h>
5
6/* bits for the extent state */
7#define EXTENT_DIRTY 1
8#define EXTENT_WRITEBACK (1 << 1)
9#define EXTENT_UPTODATE (1 << 2)
10#define EXTENT_LOCKED (1 << 3)
11#define EXTENT_NEW (1 << 4)
12#define EXTENT_DELALLOC (1 << 5)
13#define EXTENT_DEFRAG (1 << 6)
14#define EXTENT_DEFRAG_DONE (1 << 7)
15#define EXTENT_BUFFER_FILLED (1 << 8)
8b62b72b
CM
16#define EXTENT_BOUNDARY (1 << 9)
17#define EXTENT_NODATASUM (1 << 10)
32c00aff 18#define EXTENT_DO_ACCOUNTING (1 << 11)
0ca1f7ce 19#define EXTENT_FIRST_DELALLOC (1 << 12)
1728366e 20#define EXTENT_NEED_WAIT (1 << 13)
806468f8 21#define EXTENT_DAMAGED (1 << 14)
7ee9e440 22#define EXTENT_NORESERVE (1 << 15)
d1310b2e 23#define EXTENT_IOBITS (EXTENT_LOCKED | EXTENT_WRITEBACK)
0ca1f7ce 24#define EXTENT_CTLBITS (EXTENT_DO_ACCOUNTING | EXTENT_FIRST_DELALLOC)
d1310b2e 25
261507a0
LZ
26/*
27 * flags for bio submission. The high bits indicate the compression
28 * type for this bio
29 */
c8b97818 30#define EXTENT_BIO_COMPRESSED 1
de0022b9 31#define EXTENT_BIO_TREE_LOG 2
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
36#define EXTENT_BUFFER_BLOCKING 1
b9473439 37#define EXTENT_BUFFER_DIRTY 2
a826d6dc 38#define EXTENT_BUFFER_CORRUPT 3
ab0fff03 39#define EXTENT_BUFFER_READAHEAD 4 /* this got triggered by readahead */
3083ee2e
JB
40#define EXTENT_BUFFER_TREE_REF 5
41#define EXTENT_BUFFER_STALE 6
0b32f4bb
JB
42#define EXTENT_BUFFER_WRITEBACK 7
43#define EXTENT_BUFFER_IOERR 8
815a51c7 44#define EXTENT_BUFFER_DUMMY 9
b4ce94de 45
a791e35e
CM
46/* these are flags for extent_clear_unlock_delalloc */
47#define EXTENT_CLEAR_UNLOCK_PAGE 0x1
48#define EXTENT_CLEAR_UNLOCK 0x2
49#define EXTENT_CLEAR_DELALLOC 0x4
50#define EXTENT_CLEAR_DIRTY 0x8
51#define EXTENT_SET_WRITEBACK 0x10
52#define EXTENT_END_WRITEBACK 0x20
53#define EXTENT_SET_PRIVATE2 0x40
32c00aff 54#define EXTENT_CLEAR_ACCOUNTING 0x80
a791e35e 55
d1310b2e
CM
56/*
57 * page->private values. Every page that is controlled by the extent
58 * map has page->private set to one.
59 */
60#define EXTENT_PAGE_PRIVATE 1
61#define EXTENT_PAGE_PRIVATE_FIRST_PAGE 3
62
70dec807 63struct extent_state;
ea466794 64struct btrfs_root;
70dec807 65
44b8bd7e 66typedef int (extent_submit_bio_hook_t)(struct inode *inode, int rw,
c8b97818 67 struct bio *bio, int mirror_num,
eaf25d93 68 unsigned long bio_flags, u64 bio_offset);
d1310b2e 69struct extent_io_ops {
c8b97818 70 int (*fill_delalloc)(struct inode *inode, struct page *locked_page,
771ed689
CM
71 u64 start, u64 end, int *page_started,
72 unsigned long *nr_written);
247e743c 73 int (*writepage_start_hook)(struct page *page, u64 start, u64 end);
d1310b2e 74 int (*writepage_io_hook)(struct page *page, u64 start, u64 end);
44b8bd7e 75 extent_submit_bio_hook_t *submit_bio_hook;
64a16701 76 int (*merge_bio_hook)(int rw, struct page *page, unsigned long offset,
c8b97818
CM
77 size_t size, struct bio *bio,
78 unsigned long bio_flags);
ea466794 79 int (*readpage_io_failed_hook)(struct page *page, int failed_mirror);
70dec807 80 int (*readpage_end_io_hook)(struct page *page, u64 start, u64 end,
5cf1ab56 81 struct extent_state *state, 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,
41074888 85 unsigned long *bits);
1bf85046 86 void (*clear_bit_hook)(struct inode *inode, struct extent_state *state,
41074888 87 unsigned long *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;
19fe0a8b 97 struct radix_tree_root buffer;
d1310b2e
CM
98 struct address_space *mapping;
99 u64 dirty_bytes;
0b32f4bb 100 int track_uptodate;
70dec807 101 spinlock_t lock;
6af118ce 102 spinlock_t buffer_lock;
d1310b2e 103 struct extent_io_ops *ops;
d1310b2e
CM
104};
105
106struct extent_state {
107 u64 start;
108 u64 end; /* inclusive */
d1310b2e 109 struct rb_node rb_node;
9ed74f2d
JB
110
111 /* ADD NEW ELEMENTS AFTER THIS */
70dec807 112 struct extent_io_tree *tree;
d1310b2e
CM
113 wait_queue_head_t wq;
114 atomic_t refs;
115 unsigned long state;
116
117 /* for use by the FS */
118 u64 private;
119
6d49ba1b 120#ifdef CONFIG_BTRFS_DEBUG
2d2ae547 121 struct list_head leak_list;
6d49ba1b 122#endif
d1310b2e
CM
123};
124
727011e0
CM
125#define INLINE_EXTENT_BUFFER_PAGES 16
126#define MAX_INLINE_EXTENT_BUFFER_SIZE (INLINE_EXTENT_BUFFER_PAGES * PAGE_CACHE_SIZE)
d1310b2e
CM
127struct extent_buffer {
128 u64 start;
129 unsigned long len;
d1310b2e
CM
130 unsigned long map_start;
131 unsigned long map_len;
b4ce94de 132 unsigned long bflags;
4f2de97a 133 struct extent_io_tree *tree;
3083ee2e 134 spinlock_t refs_lock;
727011e0 135 atomic_t refs;
0b32f4bb 136 atomic_t io_pages;
5cf1ab56 137 int read_mirror;
19fe0a8b 138 struct rcu_head rcu_head;
5b25f70f 139 pid_t lock_owner;
b4ce94de 140
bd681513
CM
141 /* count of read lock holders on the extent buffer */
142 atomic_t write_locks;
143 atomic_t read_locks;
144 atomic_t blocking_writers;
145 atomic_t blocking_readers;
146 atomic_t spinning_readers;
147 atomic_t spinning_writers;
5b25f70f 148 int lock_nested;
bd681513
CM
149
150 /* protects write locks */
151 rwlock_t lock;
152
153 /* readers use lock_wq while they wait for the write
154 * lock holders to unlock
155 */
156 wait_queue_head_t write_lock_wq;
b4ce94de 157
bd681513
CM
158 /* writers use read_lock_wq while they wait for readers
159 * to unlock
b4ce94de 160 */
bd681513 161 wait_queue_head_t read_lock_wq;
727011e0 162 wait_queue_head_t lock_wq;
b8dae313 163 struct page *pages[INLINE_EXTENT_BUFFER_PAGES];
6d49ba1b
ES
164#ifdef CONFIG_BTRFS_DEBUG
165 struct list_head leak_list;
166#endif
d1310b2e
CM
167};
168
261507a0
LZ
169static inline void extent_set_compress_type(unsigned long *bio_flags,
170 int compress_type)
171{
172 *bio_flags |= compress_type << EXTENT_BIO_FLAG_SHIFT;
173}
174
175static inline int extent_compress_type(unsigned long bio_flags)
176{
177 return bio_flags >> EXTENT_BIO_FLAG_SHIFT;
178}
179
d1310b2e
CM
180struct extent_map_tree;
181
182typedef struct extent_map *(get_extent_t)(struct inode *inode,
183 struct page *page,
306e16ce 184 size_t pg_offset,
d1310b2e
CM
185 u64 start, u64 len,
186 int create);
187
188void extent_io_tree_init(struct extent_io_tree *tree,
f993c883 189 struct address_space *mapping);
d1310b2e 190int try_release_extent_mapping(struct extent_map_tree *map,
70dec807
CM
191 struct extent_io_tree *tree, struct page *page,
192 gfp_t mask);
f7a52a40 193int try_release_extent_buffer(struct page *page);
d0082371 194int lock_extent(struct extent_io_tree *tree, u64 start, u64 end);
1edbb734 195int lock_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
41074888 196 unsigned long bits, struct extent_state **cached);
d0082371 197int unlock_extent(struct extent_io_tree *tree, u64 start, u64 end);
2ac55d41
JB
198int unlock_extent_cached(struct extent_io_tree *tree, u64 start, u64 end,
199 struct extent_state **cached, gfp_t mask);
d0082371 200int try_lock_extent(struct extent_io_tree *tree, u64 start, u64 end);
d1310b2e 201int extent_read_full_page(struct extent_io_tree *tree, struct page *page,
8ddc7d9c 202 get_extent_t *get_extent, int mirror_num);
d1310b2e
CM
203int __init extent_io_init(void);
204void extent_io_exit(void);
205
206u64 count_range_bits(struct extent_io_tree *tree,
207 u64 *start, u64 search_end,
ec29ed5b 208 u64 max_bytes, unsigned long bits, int contig);
d1310b2e 209
4845e44f 210void free_extent_state(struct extent_state *state);
d1310b2e 211int test_range_bit(struct extent_io_tree *tree, u64 start, u64 end,
41074888
DS
212 unsigned long bits, int filled,
213 struct extent_state *cached_state);
d1310b2e 214int clear_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
41074888 215 unsigned long bits, gfp_t mask);
e6dcd2dc 216int clear_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
41074888
DS
217 unsigned long bits, int wake, int delete,
218 struct extent_state **cached, gfp_t mask);
d1310b2e 219int set_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
41074888 220 unsigned long bits, gfp_t mask);
4845e44f 221int set_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
41074888 222 unsigned long bits, u64 *failed_start,
4845e44f 223 struct extent_state **cached_state, gfp_t mask);
d1310b2e 224int set_extent_uptodate(struct extent_io_tree *tree, u64 start, u64 end,
507903b8 225 struct extent_state **cached_state, gfp_t mask);
5fd02043
JB
226int clear_extent_uptodate(struct extent_io_tree *tree, u64 start, u64 end,
227 struct extent_state **cached_state, gfp_t mask);
d1310b2e
CM
228int set_extent_new(struct extent_io_tree *tree, u64 start, u64 end,
229 gfp_t mask);
230int set_extent_dirty(struct extent_io_tree *tree, u64 start, u64 end,
231 gfp_t mask);
232int clear_extent_dirty(struct extent_io_tree *tree, u64 start, u64 end,
233 gfp_t mask);
462d6fac 234int convert_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
41074888 235 unsigned long bits, unsigned long clear_bits,
e6138876 236 struct extent_state **cached_state, gfp_t mask);
d1310b2e 237int set_extent_delalloc(struct extent_io_tree *tree, u64 start, u64 end,
2ac55d41 238 struct extent_state **cached_state, gfp_t mask);
9e8a4a8b
LB
239int set_extent_defrag(struct extent_io_tree *tree, u64 start, u64 end,
240 struct extent_state **cached_state, gfp_t mask);
d1310b2e 241int find_first_extent_bit(struct extent_io_tree *tree, u64 start,
41074888 242 u64 *start_ret, u64 *end_ret, unsigned long bits,
e6138876 243 struct extent_state **cached_state);
d1310b2e
CM
244int extent_invalidatepage(struct extent_io_tree *tree,
245 struct page *page, unsigned long offset);
246int extent_write_full_page(struct extent_io_tree *tree, struct page *page,
247 get_extent_t *get_extent,
248 struct writeback_control *wbc);
771ed689
CM
249int extent_write_locked_range(struct extent_io_tree *tree, struct inode *inode,
250 u64 start, u64 end, get_extent_t *get_extent,
251 int mode);
d1310b2e
CM
252int extent_writepages(struct extent_io_tree *tree,
253 struct address_space *mapping,
254 get_extent_t *get_extent,
255 struct writeback_control *wbc);
0b32f4bb
JB
256int btree_write_cache_pages(struct address_space *mapping,
257 struct writeback_control *wbc);
d1310b2e
CM
258int extent_readpages(struct extent_io_tree *tree,
259 struct address_space *mapping,
260 struct list_head *pages, unsigned nr_pages,
261 get_extent_t get_extent);
1506fcc8
YS
262int extent_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
263 __u64 start, __u64 len, get_extent_t *get_extent);
d1310b2e 264int set_state_private(struct extent_io_tree *tree, u64 start, u64 private);
e4100d98
MX
265void extent_cache_csums_dio(struct extent_io_tree *tree, u64 start, u32 csums[],
266 int count);
267void extent_cache_csums(struct extent_io_tree *tree, struct bio *bio,
268 int bvec_index, u32 csums[], int count);
d1310b2e
CM
269int get_state_private(struct extent_io_tree *tree, u64 start, u64 *private);
270void set_page_extent_mapped(struct page *page);
271
272struct extent_buffer *alloc_extent_buffer(struct extent_io_tree *tree,
727011e0 273 u64 start, unsigned long len);
815a51c7
JS
274struct extent_buffer *alloc_dummy_extent_buffer(u64 start, unsigned long len);
275struct extent_buffer *btrfs_clone_extent_buffer(struct extent_buffer *src);
d1310b2e 276struct extent_buffer *find_extent_buffer(struct extent_io_tree *tree,
f09d1f60 277 u64 start, unsigned long len);
d1310b2e 278void free_extent_buffer(struct extent_buffer *eb);
3083ee2e 279void free_extent_buffer_stale(struct extent_buffer *eb);
bb82ab88
AJ
280#define WAIT_NONE 0
281#define WAIT_COMPLETE 1
282#define WAIT_PAGE_LOCK 2
d1310b2e 283int read_extent_buffer_pages(struct extent_io_tree *tree,
a86c12c7 284 struct extent_buffer *eb, u64 start, int wait,
f188591e 285 get_extent_t *get_extent, int mirror_num);
fd8b2b61 286void wait_on_extent_buffer_writeback(struct extent_buffer *eb);
479ed9ab
RD
287
288static inline unsigned long num_extent_pages(u64 start, u64 len)
289{
290 return ((start + len + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT) -
291 (start >> PAGE_CACHE_SHIFT);
292}
293
294static inline struct page *extent_buffer_page(struct extent_buffer *eb,
295 unsigned long i)
296{
297 return eb->pages[i];
298}
d1310b2e
CM
299
300static inline void extent_buffer_get(struct extent_buffer *eb)
301{
302 atomic_inc(&eb->refs);
303}
304
305int memcmp_extent_buffer(struct extent_buffer *eb, const void *ptrv,
306 unsigned long start,
307 unsigned long len);
308void read_extent_buffer(struct extent_buffer *eb, void *dst,
309 unsigned long start,
310 unsigned long len);
311void write_extent_buffer(struct extent_buffer *eb, const void *src,
312 unsigned long start, unsigned long len);
313void copy_extent_buffer(struct extent_buffer *dst, struct extent_buffer *src,
314 unsigned long dst_offset, unsigned long src_offset,
315 unsigned long len);
316void memcpy_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
317 unsigned long src_offset, unsigned long len);
318void memmove_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
319 unsigned long src_offset, unsigned long len);
320void memset_extent_buffer(struct extent_buffer *eb, char c,
321 unsigned long start, unsigned long len);
1d4284bd 322void clear_extent_buffer_dirty(struct extent_buffer *eb);
0b32f4bb
JB
323int set_extent_buffer_dirty(struct extent_buffer *eb);
324int set_extent_buffer_uptodate(struct extent_buffer *eb);
325int clear_extent_buffer_uptodate(struct extent_buffer *eb);
326int extent_buffer_uptodate(struct extent_buffer *eb);
d1310b2e 327int map_private_extent_buffer(struct extent_buffer *eb, unsigned long offset,
a6591715 328 unsigned long min_len, char **map,
d1310b2e 329 unsigned long *map_start,
a6591715 330 unsigned long *map_len);
4adaa611
CM
331int extent_range_clear_dirty_for_io(struct inode *inode, u64 start, u64 end);
332int extent_range_redirty_for_io(struct inode *inode, u64 start, u64 end);
c8b97818
CM
333int extent_clear_unlock_delalloc(struct inode *inode,
334 struct extent_io_tree *tree,
335 u64 start, u64 end, struct page *locked_page,
a791e35e 336 unsigned long op);
88f794ed
MX
337struct bio *
338btrfs_bio_alloc(struct block_device *bdev, u64 first_sector, int nr_vecs,
339 gfp_t gfp_flags);
9be3395b
CM
340struct bio *btrfs_io_bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs);
341struct bio *btrfs_bio_clone(struct bio *bio, gfp_t gfp_mask);
4a54c8c1 342
3ec706c8 343struct btrfs_fs_info;
4a54c8c1 344
3ec706c8 345int repair_io_failure(struct btrfs_fs_info *fs_info, u64 start,
4a54c8c1
JS
346 u64 length, u64 logical, struct page *page,
347 int mirror_num);
87826df0 348int end_extent_writepage(struct page *page, int err, u64 start, u64 end);
ea466794
JB
349int repair_eb_io_failure(struct btrfs_root *root, struct extent_buffer *eb,
350 int mirror_num);
d1310b2e 351#endif