xref: /openbmc/linux/fs/btrfs/extent_io.h (revision aa3fc090)
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_NORESERVE (1 << 15)
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_PARENT_LOCKED 4
33 #define EXTENT_BIO_FLAG_SHIFT 16
34 
35 /* these are bit numbers for test/set bit */
36 #define EXTENT_BUFFER_UPTODATE 0
37 #define EXTENT_BUFFER_BLOCKING 1
38 #define EXTENT_BUFFER_DIRTY 2
39 #define EXTENT_BUFFER_CORRUPT 3
40 #define EXTENT_BUFFER_READAHEAD 4	/* this got triggered by readahead */
41 #define EXTENT_BUFFER_TREE_REF 5
42 #define EXTENT_BUFFER_STALE 6
43 #define EXTENT_BUFFER_WRITEBACK 7
44 #define EXTENT_BUFFER_IOERR 8
45 #define EXTENT_BUFFER_DUMMY 9
46 #define EXTENT_BUFFER_IN_TREE 10
47 
48 /* these are flags for extent_clear_unlock_delalloc */
49 #define PAGE_UNLOCK		(1 << 0)
50 #define PAGE_CLEAR_DIRTY	(1 << 1)
51 #define PAGE_SET_WRITEBACK	(1 << 2)
52 #define PAGE_END_WRITEBACK	(1 << 3)
53 #define PAGE_SET_PRIVATE2	(1 << 4)
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 #define EXTENT_PAGE_PRIVATE_FIRST_PAGE 3
61 
62 struct extent_state;
63 struct btrfs_root;
64 struct btrfs_io_bio;
65 
66 typedef	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);
69 struct 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 long *bits);
87 	void (*clear_bit_hook)(struct inode *inode, struct extent_state *state,
88 			       unsigned long *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 
96 struct 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 	struct extent_io_ops *ops;
103 };
104 
105 struct extent_state {
106 	u64 start;
107 	u64 end; /* inclusive */
108 	struct rb_node rb_node;
109 
110 	/* ADD NEW ELEMENTS AFTER THIS */
111 	struct extent_io_tree *tree;
112 	wait_queue_head_t wq;
113 	atomic_t refs;
114 	unsigned long state;
115 
116 	/* for use by the FS */
117 	u64 private;
118 
119 #ifdef CONFIG_BTRFS_DEBUG
120 	struct list_head leak_list;
121 #endif
122 };
123 
124 #define INLINE_EXTENT_BUFFER_PAGES 16
125 #define MAX_INLINE_EXTENT_BUFFER_SIZE (INLINE_EXTENT_BUFFER_PAGES * PAGE_CACHE_SIZE)
126 struct extent_buffer {
127 	u64 start;
128 	unsigned long len;
129 	unsigned long map_start;
130 	unsigned long map_len;
131 	unsigned long bflags;
132 	struct btrfs_fs_info *fs_info;
133 	spinlock_t refs_lock;
134 	atomic_t refs;
135 	atomic_t io_pages;
136 	int read_mirror;
137 	struct rcu_head rcu_head;
138 	pid_t lock_owner;
139 
140 	/* count of read lock holders on the extent buffer */
141 	atomic_t write_locks;
142 	atomic_t read_locks;
143 	atomic_t blocking_writers;
144 	atomic_t blocking_readers;
145 	atomic_t spinning_readers;
146 	atomic_t spinning_writers;
147 	int lock_nested;
148 
149 	/* protects write locks */
150 	rwlock_t lock;
151 
152 	/* readers use lock_wq while they wait for the write
153 	 * lock holders to unlock
154 	 */
155 	wait_queue_head_t write_lock_wq;
156 
157 	/* writers use read_lock_wq while they wait for readers
158 	 * to unlock
159 	 */
160 	wait_queue_head_t read_lock_wq;
161 	struct page *pages[INLINE_EXTENT_BUFFER_PAGES];
162 #ifdef CONFIG_BTRFS_DEBUG
163 	struct list_head leak_list;
164 #endif
165 };
166 
167 static inline void extent_set_compress_type(unsigned long *bio_flags,
168 					    int compress_type)
169 {
170 	*bio_flags |= compress_type << EXTENT_BIO_FLAG_SHIFT;
171 }
172 
173 static inline int extent_compress_type(unsigned long bio_flags)
174 {
175 	return bio_flags >> EXTENT_BIO_FLAG_SHIFT;
176 }
177 
178 struct extent_map_tree;
179 
180 typedef struct extent_map *(get_extent_t)(struct inode *inode,
181 					  struct page *page,
182 					  size_t pg_offset,
183 					  u64 start, u64 len,
184 					  int create);
185 
186 void extent_io_tree_init(struct extent_io_tree *tree,
187 			 struct address_space *mapping);
188 int try_release_extent_mapping(struct extent_map_tree *map,
189 			       struct extent_io_tree *tree, struct page *page,
190 			       gfp_t mask);
191 int try_release_extent_buffer(struct page *page);
192 int lock_extent(struct extent_io_tree *tree, u64 start, u64 end);
193 int lock_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
194 		     unsigned long bits, struct extent_state **cached);
195 int unlock_extent(struct extent_io_tree *tree, u64 start, u64 end);
196 int unlock_extent_cached(struct extent_io_tree *tree, u64 start, u64 end,
197 			 struct extent_state **cached, gfp_t mask);
198 int try_lock_extent(struct extent_io_tree *tree, u64 start, u64 end);
199 int extent_read_full_page(struct extent_io_tree *tree, struct page *page,
200 			  get_extent_t *get_extent, int mirror_num);
201 int extent_read_full_page_nolock(struct extent_io_tree *tree, struct page *page,
202 				 get_extent_t *get_extent, int mirror_num);
203 int __init extent_io_init(void);
204 void extent_io_exit(void);
205 
206 u64 count_range_bits(struct extent_io_tree *tree,
207 		     u64 *start, u64 search_end,
208 		     u64 max_bytes, unsigned long bits, int contig);
209 
210 void free_extent_state(struct extent_state *state);
211 int test_range_bit(struct extent_io_tree *tree, u64 start, u64 end,
212 		   unsigned long bits, int filled,
213 		   struct extent_state *cached_state);
214 int clear_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
215 		      unsigned long bits, gfp_t mask);
216 int clear_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
217 		     unsigned long bits, int wake, int delete,
218 		     struct extent_state **cached, gfp_t mask);
219 int set_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
220 		    unsigned long bits, gfp_t mask);
221 int set_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
222 		   unsigned long bits, u64 *failed_start,
223 		   struct extent_state **cached_state, gfp_t mask);
224 int set_extent_uptodate(struct extent_io_tree *tree, u64 start, u64 end,
225 			struct extent_state **cached_state, gfp_t mask);
226 int clear_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 		       unsigned long bits, unsigned long clear_bits,
236 		       struct extent_state **cached_state, gfp_t mask);
237 int set_extent_delalloc(struct extent_io_tree *tree, u64 start, u64 end,
238 			struct extent_state **cached_state, gfp_t mask);
239 int set_extent_defrag(struct extent_io_tree *tree, u64 start, u64 end,
240 		      struct extent_state **cached_state, gfp_t mask);
241 int find_first_extent_bit(struct extent_io_tree *tree, u64 start,
242 			  u64 *start_ret, u64 *end_ret, unsigned long bits,
243 			  struct extent_state **cached_state);
244 int extent_invalidatepage(struct extent_io_tree *tree,
245 			  struct page *page, unsigned long offset);
246 int extent_write_full_page(struct extent_io_tree *tree, struct page *page,
247 			  get_extent_t *get_extent,
248 			  struct writeback_control *wbc);
249 int 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);
252 int extent_writepages(struct extent_io_tree *tree,
253 		      struct address_space *mapping,
254 		      get_extent_t *get_extent,
255 		      struct writeback_control *wbc);
256 int btree_write_cache_pages(struct address_space *mapping,
257 			    struct writeback_control *wbc);
258 int 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);
262 int extent_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
263 		__u64 start, __u64 len, get_extent_t *get_extent);
264 int get_state_private(struct extent_io_tree *tree, u64 start, u64 *private);
265 void set_page_extent_mapped(struct page *page);
266 
267 struct extent_buffer *alloc_extent_buffer(struct btrfs_fs_info *fs_info,
268 					  u64 start, unsigned long len);
269 struct extent_buffer *alloc_dummy_extent_buffer(u64 start, unsigned long len);
270 struct extent_buffer *btrfs_clone_extent_buffer(struct extent_buffer *src);
271 struct extent_buffer *find_extent_buffer(struct btrfs_fs_info *fs_info,
272 					 u64 start);
273 void free_extent_buffer(struct extent_buffer *eb);
274 void free_extent_buffer_stale(struct extent_buffer *eb);
275 #define WAIT_NONE	0
276 #define WAIT_COMPLETE	1
277 #define WAIT_PAGE_LOCK	2
278 int read_extent_buffer_pages(struct extent_io_tree *tree,
279 			     struct extent_buffer *eb, u64 start, int wait,
280 			     get_extent_t *get_extent, int mirror_num);
281 void wait_on_extent_buffer_writeback(struct extent_buffer *eb);
282 
283 static inline unsigned long num_extent_pages(u64 start, u64 len)
284 {
285 	return ((start + len + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT) -
286 		(start >> PAGE_CACHE_SHIFT);
287 }
288 
289 static inline struct page *extent_buffer_page(struct extent_buffer *eb,
290 					      unsigned long i)
291 {
292 	return eb->pages[i];
293 }
294 
295 static inline void extent_buffer_get(struct extent_buffer *eb)
296 {
297 	atomic_inc(&eb->refs);
298 }
299 
300 int memcmp_extent_buffer(struct extent_buffer *eb, const void *ptrv,
301 			  unsigned long start,
302 			  unsigned long len);
303 void read_extent_buffer(struct extent_buffer *eb, void *dst,
304 			unsigned long start,
305 			unsigned long len);
306 int read_extent_buffer_to_user(struct extent_buffer *eb, void __user *dst,
307 			       unsigned long start,
308 			       unsigned long len);
309 void write_extent_buffer(struct extent_buffer *eb, const void *src,
310 			 unsigned long start, unsigned long len);
311 void copy_extent_buffer(struct extent_buffer *dst, struct extent_buffer *src,
312 			unsigned long dst_offset, unsigned long src_offset,
313 			unsigned long len);
314 void memcpy_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
315 			   unsigned long src_offset, unsigned long len);
316 void memmove_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
317 			   unsigned long src_offset, unsigned long len);
318 void memset_extent_buffer(struct extent_buffer *eb, char c,
319 			  unsigned long start, unsigned long len);
320 void clear_extent_buffer_dirty(struct extent_buffer *eb);
321 int set_extent_buffer_dirty(struct extent_buffer *eb);
322 int set_extent_buffer_uptodate(struct extent_buffer *eb);
323 int clear_extent_buffer_uptodate(struct extent_buffer *eb);
324 int extent_buffer_uptodate(struct extent_buffer *eb);
325 int extent_buffer_under_io(struct extent_buffer *eb);
326 int map_private_extent_buffer(struct extent_buffer *eb, unsigned long offset,
327 		      unsigned long min_len, char **map,
328 		      unsigned long *map_start,
329 		      unsigned long *map_len);
330 int extent_range_clear_dirty_for_io(struct inode *inode, u64 start, u64 end);
331 int extent_range_redirty_for_io(struct inode *inode, u64 start, u64 end);
332 int extent_clear_unlock_delalloc(struct inode *inode, u64 start, u64 end,
333 				 struct page *locked_page,
334 				 unsigned long bits_to_clear,
335 				 unsigned long page_ops);
336 struct bio *
337 btrfs_bio_alloc(struct block_device *bdev, u64 first_sector, int nr_vecs,
338 		gfp_t gfp_flags);
339 struct bio *btrfs_io_bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs);
340 struct bio *btrfs_bio_clone(struct bio *bio, gfp_t gfp_mask);
341 
342 struct btrfs_fs_info;
343 
344 int repair_io_failure(struct btrfs_fs_info *fs_info, u64 start,
345 			u64 length, u64 logical, struct page *page,
346 			int mirror_num);
347 int end_extent_writepage(struct page *page, int err, u64 start, u64 end);
348 int repair_eb_io_failure(struct btrfs_root *root, struct extent_buffer *eb,
349 			 int mirror_num);
350 #ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
351 noinline u64 find_lock_delalloc_range(struct inode *inode,
352 				      struct extent_io_tree *tree,
353 				      struct page *locked_page, u64 *start,
354 				      u64 *end, u64 max_bytes);
355 struct extent_buffer *alloc_test_extent_buffer(struct btrfs_fs_info *fs_info,
356 					       u64 start, unsigned long len);
357 #endif
358 #endif
359