Btrfs: fix race between mmap writes and compression
[linux-2.6.git] / fs / btrfs / extent_io.h
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)
16 #define EXTENT_BOUNDARY (1 << 9)
17 #define EXTENT_NODATASUM (1 << 10)
18 #define EXTENT_DO_ACCOUNTING (1 << 11)
19 #define EXTENT_FIRST_DELALLOC (1 << 12)
20 #define EXTENT_NEED_WAIT (1 << 13)
21 #define EXTENT_DAMAGED (1 << 14)
22 #define EXTENT_IOBITS (EXTENT_LOCKED | EXTENT_WRITEBACK)
23 #define EXTENT_CTLBITS (EXTENT_DO_ACCOUNTING | EXTENT_FIRST_DELALLOC)
24
25 /*
26  * flags for bio submission. The high bits indicate the compression
27  * type for this bio
28  */
29 #define EXTENT_BIO_COMPRESSED 1
30 #define EXTENT_BIO_FLAG_SHIFT 16
31
32 /* these are bit numbers for test/set bit */
33 #define EXTENT_BUFFER_UPTODATE 0
34 #define EXTENT_BUFFER_BLOCKING 1
35 #define EXTENT_BUFFER_DIRTY 2
36 #define EXTENT_BUFFER_CORRUPT 3
37 #define EXTENT_BUFFER_READAHEAD 4       /* this got triggered by readahead */
38 #define EXTENT_BUFFER_TREE_REF 5
39 #define EXTENT_BUFFER_STALE 6
40 #define EXTENT_BUFFER_WRITEBACK 7
41 #define EXTENT_BUFFER_IOERR 8
42
43 /* these are flags for extent_clear_unlock_delalloc */
44 #define EXTENT_CLEAR_UNLOCK_PAGE 0x1
45 #define EXTENT_CLEAR_UNLOCK      0x2
46 #define EXTENT_CLEAR_DELALLOC    0x4
47 #define EXTENT_CLEAR_DIRTY       0x8
48 #define EXTENT_SET_WRITEBACK     0x10
49 #define EXTENT_END_WRITEBACK     0x20
50 #define EXTENT_SET_PRIVATE2      0x40
51 #define EXTENT_CLEAR_ACCOUNTING  0x80
52
53 /*
54  * page->private values.  Every page that is controlled by the extent
55  * map has page->private set to one.
56  */
57 #define EXTENT_PAGE_PRIVATE 1
58 #define EXTENT_PAGE_PRIVATE_FIRST_PAGE 3
59
60 struct extent_state;
61 struct btrfs_root;
62
63 typedef int (extent_submit_bio_hook_t)(struct inode *inode, int rw,
64                                        struct bio *bio, int mirror_num,
65                                        unsigned long bio_flags, u64 bio_offset);
66 struct extent_io_ops {
67         int (*fill_delalloc)(struct inode *inode, struct page *locked_page,
68                              u64 start, u64 end, int *page_started,
69                              unsigned long *nr_written);
70         int (*writepage_start_hook)(struct page *page, u64 start, u64 end);
71         int (*writepage_io_hook)(struct page *page, u64 start, u64 end);
72         extent_submit_bio_hook_t *submit_bio_hook;
73         int (*merge_bio_hook)(struct page *page, unsigned long offset,
74                               size_t size, struct bio *bio,
75                               unsigned long bio_flags);
76         int (*readpage_io_hook)(struct page *page, u64 start, u64 end);
77         int (*readpage_io_failed_hook)(struct page *page, int failed_mirror);
78         int (*writepage_io_failed_hook)(struct bio *bio, struct page *page,
79                                         u64 start, u64 end,
80                                        struct extent_state *state);
81         int (*readpage_end_io_hook)(struct page *page, u64 start, u64 end,
82                                     struct extent_state *state, 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                              int *bits);
87         void (*clear_bit_hook)(struct inode *inode, struct extent_state *state,
88                                int *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         int (*write_cache_pages_lock_hook)(struct page *page, void *data,
95                                            void (*flush_fn)(void *));
96 };
97
98 struct extent_io_tree {
99         struct rb_root state;
100         struct radix_tree_root buffer;
101         struct address_space *mapping;
102         u64 dirty_bytes;
103         int track_uptodate;
104         spinlock_t lock;
105         spinlock_t buffer_lock;
106         struct extent_io_ops *ops;
107 };
108
109 struct extent_state {
110         u64 start;
111         u64 end; /* inclusive */
112         struct rb_node rb_node;
113
114         /* ADD NEW ELEMENTS AFTER THIS */
115         struct extent_io_tree *tree;
116         wait_queue_head_t wq;
117         atomic_t refs;
118         unsigned long state;
119
120         /* for use by the FS */
121         u64 private;
122
123         struct list_head leak_list;
124 };
125
126 #define INLINE_EXTENT_BUFFER_PAGES 16
127 #define MAX_INLINE_EXTENT_BUFFER_SIZE (INLINE_EXTENT_BUFFER_PAGES * PAGE_CACHE_SIZE)
128 struct extent_buffer {
129         u64 start;
130         unsigned long len;
131         unsigned long map_start;
132         unsigned long map_len;
133         unsigned long bflags;
134         struct extent_io_tree *tree;
135         spinlock_t refs_lock;
136         atomic_t refs;
137         atomic_t io_pages;
138         int read_mirror;
139         struct list_head leak_list;
140         struct rcu_head rcu_head;
141         pid_t lock_owner;
142
143         /* count of read lock holders on the extent buffer */
144         atomic_t write_locks;
145         atomic_t read_locks;
146         atomic_t blocking_writers;
147         atomic_t blocking_readers;
148         atomic_t spinning_readers;
149         atomic_t spinning_writers;
150         int lock_nested;
151
152         /* protects write locks */
153         rwlock_t lock;
154
155         /* readers use lock_wq while they wait for the write
156          * lock holders to unlock
157          */
158         wait_queue_head_t write_lock_wq;
159
160         /* writers use read_lock_wq while they wait for readers
161          * to unlock
162          */
163         wait_queue_head_t read_lock_wq;
164         wait_queue_head_t lock_wq;
165         struct page *inline_pages[INLINE_EXTENT_BUFFER_PAGES];
166         struct page **pages;
167 };
168
169 static 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
175 static inline int extent_compress_type(unsigned long bio_flags)
176 {
177         return bio_flags >> EXTENT_BIO_FLAG_SHIFT;
178 }
179
180 struct extent_map_tree;
181
182 typedef struct extent_map *(get_extent_t)(struct inode *inode,
183                                           struct page *page,
184                                           size_t pg_offset,
185                                           u64 start, u64 len,
186                                           int create);
187
188 void extent_io_tree_init(struct extent_io_tree *tree,
189                          struct address_space *mapping);
190 int try_release_extent_mapping(struct extent_map_tree *map,
191                                struct extent_io_tree *tree, struct page *page,
192                                gfp_t mask);
193 int try_release_extent_buffer(struct page *page, gfp_t mask);
194 int try_release_extent_state(struct extent_map_tree *map,
195                              struct extent_io_tree *tree, struct page *page,
196                              gfp_t mask);
197 int lock_extent(struct extent_io_tree *tree, u64 start, u64 end);
198 int lock_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
199                      int bits, struct extent_state **cached);
200 int unlock_extent(struct extent_io_tree *tree, u64 start, u64 end);
201 int unlock_extent_cached(struct extent_io_tree *tree, u64 start, u64 end,
202                          struct extent_state **cached, gfp_t mask);
203 int try_lock_extent(struct extent_io_tree *tree, u64 start, u64 end);
204 int extent_read_full_page(struct extent_io_tree *tree, struct page *page,
205                           get_extent_t *get_extent, int mirror_num);
206 int __init extent_io_init(void);
207 void extent_io_exit(void);
208
209 u64 count_range_bits(struct extent_io_tree *tree,
210                      u64 *start, u64 search_end,
211                      u64 max_bytes, unsigned long bits, int contig);
212
213 void free_extent_state(struct extent_state *state);
214 int test_range_bit(struct extent_io_tree *tree, u64 start, u64 end,
215                    int bits, int filled, struct extent_state *cached_state);
216 int clear_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
217                       int bits, gfp_t mask);
218 int clear_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
219                      int bits, int wake, int delete, struct extent_state **cached,
220                      gfp_t mask);
221 int set_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
222                     int bits, gfp_t mask);
223 int set_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
224                    int bits, u64 *failed_start,
225                    struct extent_state **cached_state, gfp_t mask);
226 int set_extent_uptodate(struct extent_io_tree *tree, u64 start, u64 end,
227                         struct extent_state **cached_state, gfp_t mask);
228 int set_extent_new(struct extent_io_tree *tree, u64 start, u64 end,
229                    gfp_t mask);
230 int set_extent_dirty(struct extent_io_tree *tree, u64 start, u64 end,
231                      gfp_t mask);
232 int clear_extent_dirty(struct extent_io_tree *tree, u64 start, u64 end,
233                        gfp_t mask);
234 int convert_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
235                        int bits, int clear_bits, gfp_t mask);
236 int set_extent_delalloc(struct extent_io_tree *tree, u64 start, u64 end,
237                         struct extent_state **cached_state, gfp_t mask);
238 int find_first_extent_bit(struct extent_io_tree *tree, u64 start,
239                           u64 *start_ret, u64 *end_ret, int bits);
240 struct extent_state *find_first_extent_bit_state(struct extent_io_tree *tree,
241                                                  u64 start, int bits);
242 int extent_invalidatepage(struct extent_io_tree *tree,
243                           struct page *page, unsigned long offset);
244 int extent_write_full_page(struct extent_io_tree *tree, struct page *page,
245                           get_extent_t *get_extent,
246                           struct writeback_control *wbc);
247 int extent_write_locked_range(struct extent_io_tree *tree, struct inode *inode,
248                               u64 start, u64 end, get_extent_t *get_extent,
249                               int mode);
250 int extent_writepages(struct extent_io_tree *tree,
251                       struct address_space *mapping,
252                       get_extent_t *get_extent,
253                       struct writeback_control *wbc);
254 int btree_write_cache_pages(struct address_space *mapping,
255                             struct writeback_control *wbc);
256 int extent_readpages(struct extent_io_tree *tree,
257                      struct address_space *mapping,
258                      struct list_head *pages, unsigned nr_pages,
259                      get_extent_t get_extent);
260 int extent_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
261                 __u64 start, __u64 len, get_extent_t *get_extent);
262 int set_state_private(struct extent_io_tree *tree, u64 start, u64 private);
263 int get_state_private(struct extent_io_tree *tree, u64 start, u64 *private);
264 void set_page_extent_mapped(struct page *page);
265
266 struct extent_buffer *alloc_extent_buffer(struct extent_io_tree *tree,
267                                           u64 start, unsigned long len);
268 struct extent_buffer *find_extent_buffer(struct extent_io_tree *tree,
269                                          u64 start, unsigned long len);
270 void free_extent_buffer(struct extent_buffer *eb);
271 void free_extent_buffer_stale(struct extent_buffer *eb);
272 #define WAIT_NONE       0
273 #define WAIT_COMPLETE   1
274 #define WAIT_PAGE_LOCK  2
275 int read_extent_buffer_pages(struct extent_io_tree *tree,
276                              struct extent_buffer *eb, u64 start, int wait,
277                              get_extent_t *get_extent, int mirror_num);
278 unsigned long num_extent_pages(u64 start, u64 len);
279 struct page *extent_buffer_page(struct extent_buffer *eb, unsigned long i);
280
281 static inline void extent_buffer_get(struct extent_buffer *eb)
282 {
283         atomic_inc(&eb->refs);
284 }
285
286 int memcmp_extent_buffer(struct extent_buffer *eb, const void *ptrv,
287                           unsigned long start,
288                           unsigned long len);
289 void read_extent_buffer(struct extent_buffer *eb, void *dst,
290                         unsigned long start,
291                         unsigned long len);
292 void write_extent_buffer(struct extent_buffer *eb, const void *src,
293                          unsigned long start, unsigned long len);
294 void copy_extent_buffer(struct extent_buffer *dst, struct extent_buffer *src,
295                         unsigned long dst_offset, unsigned long src_offset,
296                         unsigned long len);
297 void memcpy_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
298                            unsigned long src_offset, unsigned long len);
299 void memmove_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
300                            unsigned long src_offset, unsigned long len);
301 void memset_extent_buffer(struct extent_buffer *eb, char c,
302                           unsigned long start, unsigned long len);
303 void wait_extent_bit(struct extent_io_tree *tree, u64 start, u64 end, int bits);
304 void clear_extent_buffer_dirty(struct extent_buffer *eb);
305 int set_extent_buffer_dirty(struct extent_buffer *eb);
306 int set_extent_buffer_uptodate(struct extent_buffer *eb);
307 int clear_extent_buffer_uptodate(struct extent_buffer *eb);
308 int extent_buffer_uptodate(struct extent_buffer *eb);
309 int map_private_extent_buffer(struct extent_buffer *eb, unsigned long offset,
310                       unsigned long min_len, char **map,
311                       unsigned long *map_start,
312                       unsigned long *map_len);
313 int extent_range_uptodate(struct extent_io_tree *tree,
314                           u64 start, u64 end);
315 int extent_range_clear_dirty_for_io(struct inode *inode, u64 start, u64 end);
316 int extent_range_redirty_for_io(struct inode *inode, u64 start, u64 end);
317 int extent_clear_unlock_delalloc(struct inode *inode,
318                                 struct extent_io_tree *tree,
319                                 u64 start, u64 end, struct page *locked_page,
320                                 unsigned long op);
321 struct bio *
322 btrfs_bio_alloc(struct block_device *bdev, u64 first_sector, int nr_vecs,
323                 gfp_t gfp_flags);
324
325 struct btrfs_mapping_tree;
326
327 int repair_io_failure(struct btrfs_mapping_tree *map_tree, u64 start,
328                         u64 length, u64 logical, struct page *page,
329                         int mirror_num);
330 int end_extent_writepage(struct page *page, int err, u64 start, u64 end);
331 int repair_eb_io_failure(struct btrfs_root *root, struct extent_buffer *eb,
332                          int mirror_num);
333 #endif