xref: /openbmc/linux/fs/btrfs/extent_io.h (revision 79f08d9e)
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 
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 
54 /*
55  * page->private values.  Every page that is controlled by the extent
56  * map has page->private set to one.
57  */
58 #define EXTENT_PAGE_PRIVATE 1
59 #define EXTENT_PAGE_PRIVATE_FIRST_PAGE 3
60 
61 struct extent_state;
62 struct btrfs_root;
63 struct btrfs_io_bio;
64 
65 typedef	int (extent_submit_bio_hook_t)(struct inode *inode, int rw,
66 				       struct bio *bio, int mirror_num,
67 				       unsigned long bio_flags, u64 bio_offset);
68 struct extent_io_ops {
69 	int (*fill_delalloc)(struct inode *inode, struct page *locked_page,
70 			     u64 start, u64 end, int *page_started,
71 			     unsigned long *nr_written);
72 	int (*writepage_start_hook)(struct page *page, u64 start, u64 end);
73 	int (*writepage_io_hook)(struct page *page, u64 start, u64 end);
74 	extent_submit_bio_hook_t *submit_bio_hook;
75 	int (*merge_bio_hook)(int rw, struct page *page, unsigned long offset,
76 			      size_t size, struct bio *bio,
77 			      unsigned long bio_flags);
78 	int (*readpage_io_failed_hook)(struct page *page, int failed_mirror);
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);
82 	int (*writepage_end_io_hook)(struct page *page, u64 start, u64 end,
83 				      struct extent_state *state, int uptodate);
84 	void (*set_bit_hook)(struct inode *inode, struct extent_state *state,
85 			     unsigned long *bits);
86 	void (*clear_bit_hook)(struct inode *inode, struct extent_state *state,
87 			       unsigned long *bits);
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);
93 };
94 
95 struct extent_io_tree {
96 	struct rb_root state;
97 	struct radix_tree_root buffer;
98 	struct address_space *mapping;
99 	u64 dirty_bytes;
100 	int track_uptodate;
101 	spinlock_t lock;
102 	spinlock_t buffer_lock;
103 	struct extent_io_ops *ops;
104 };
105 
106 struct extent_state {
107 	u64 start;
108 	u64 end; /* inclusive */
109 	struct rb_node rb_node;
110 
111 	/* ADD NEW ELEMENTS AFTER THIS */
112 	struct extent_io_tree *tree;
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 
120 #ifdef CONFIG_BTRFS_DEBUG
121 	struct list_head leak_list;
122 #endif
123 };
124 
125 #define INLINE_EXTENT_BUFFER_PAGES 16
126 #define MAX_INLINE_EXTENT_BUFFER_SIZE (INLINE_EXTENT_BUFFER_PAGES * PAGE_CACHE_SIZE)
127 struct extent_buffer {
128 	u64 start;
129 	unsigned long len;
130 	unsigned long map_start;
131 	unsigned long map_len;
132 	unsigned long bflags;
133 	struct extent_io_tree *tree;
134 	spinlock_t refs_lock;
135 	atomic_t refs;
136 	atomic_t io_pages;
137 	int read_mirror;
138 	struct rcu_head rcu_head;
139 	pid_t lock_owner;
140 
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;
148 	int lock_nested;
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;
157 
158 	/* writers use read_lock_wq while they wait for readers
159 	 * to unlock
160 	 */
161 	wait_queue_head_t read_lock_wq;
162 	wait_queue_head_t lock_wq;
163 	struct page *pages[INLINE_EXTENT_BUFFER_PAGES];
164 #ifdef CONFIG_BTRFS_DEBUG
165 	struct list_head leak_list;
166 #endif
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);
194 int lock_extent(struct extent_io_tree *tree, u64 start, u64 end);
195 int lock_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
196 		     unsigned long bits, struct extent_state **cached);
197 int unlock_extent(struct extent_io_tree *tree, u64 start, u64 end);
198 int unlock_extent_cached(struct extent_io_tree *tree, u64 start, u64 end,
199 			 struct extent_state **cached, gfp_t mask);
200 int try_lock_extent(struct extent_io_tree *tree, u64 start, u64 end);
201 int extent_read_full_page(struct extent_io_tree *tree, struct page *page,
202 			  get_extent_t *get_extent, int mirror_num);
203 int extent_read_full_page_nolock(struct extent_io_tree *tree, struct page *page,
204 				 get_extent_t *get_extent, int mirror_num);
205 int __init extent_io_init(void);
206 void extent_io_exit(void);
207 
208 u64 count_range_bits(struct extent_io_tree *tree,
209 		     u64 *start, u64 search_end,
210 		     u64 max_bytes, unsigned long bits, int contig);
211 
212 void free_extent_state(struct extent_state *state);
213 int test_range_bit(struct extent_io_tree *tree, u64 start, u64 end,
214 		   unsigned long bits, int filled,
215 		   struct extent_state *cached_state);
216 int clear_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
217 		      unsigned long bits, gfp_t mask);
218 int clear_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
219 		     unsigned long bits, int wake, int delete,
220 		     struct extent_state **cached, gfp_t mask);
221 int set_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
222 		    unsigned long bits, gfp_t mask);
223 int set_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
224 		   unsigned long 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 clear_extent_uptodate(struct extent_io_tree *tree, u64 start, u64 end,
229 			  struct extent_state **cached_state, gfp_t mask);
230 int set_extent_new(struct extent_io_tree *tree, u64 start, u64 end,
231 		   gfp_t mask);
232 int set_extent_dirty(struct extent_io_tree *tree, u64 start, u64 end,
233 		     gfp_t mask);
234 int clear_extent_dirty(struct extent_io_tree *tree, u64 start, u64 end,
235 		       gfp_t mask);
236 int convert_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
237 		       unsigned long bits, unsigned long clear_bits,
238 		       struct extent_state **cached_state, gfp_t mask);
239 int set_extent_delalloc(struct extent_io_tree *tree, u64 start, u64 end,
240 			struct extent_state **cached_state, gfp_t mask);
241 int set_extent_defrag(struct extent_io_tree *tree, u64 start, u64 end,
242 		      struct extent_state **cached_state, gfp_t mask);
243 int find_first_extent_bit(struct extent_io_tree *tree, u64 start,
244 			  u64 *start_ret, u64 *end_ret, unsigned long bits,
245 			  struct extent_state **cached_state);
246 int extent_invalidatepage(struct extent_io_tree *tree,
247 			  struct page *page, unsigned long offset);
248 int extent_write_full_page(struct extent_io_tree *tree, struct page *page,
249 			  get_extent_t *get_extent,
250 			  struct writeback_control *wbc);
251 int extent_write_locked_range(struct extent_io_tree *tree, struct inode *inode,
252 			      u64 start, u64 end, get_extent_t *get_extent,
253 			      int mode);
254 int extent_writepages(struct extent_io_tree *tree,
255 		      struct address_space *mapping,
256 		      get_extent_t *get_extent,
257 		      struct writeback_control *wbc);
258 int btree_write_cache_pages(struct address_space *mapping,
259 			    struct writeback_control *wbc);
260 int extent_readpages(struct extent_io_tree *tree,
261 		     struct address_space *mapping,
262 		     struct list_head *pages, unsigned nr_pages,
263 		     get_extent_t get_extent);
264 int extent_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
265 		__u64 start, __u64 len, get_extent_t *get_extent);
266 int get_state_private(struct extent_io_tree *tree, u64 start, u64 *private);
267 void set_page_extent_mapped(struct page *page);
268 
269 struct extent_buffer *alloc_extent_buffer(struct extent_io_tree *tree,
270 					  u64 start, unsigned long len);
271 struct extent_buffer *alloc_dummy_extent_buffer(u64 start, unsigned long len);
272 struct extent_buffer *btrfs_clone_extent_buffer(struct extent_buffer *src);
273 struct extent_buffer *find_extent_buffer(struct extent_io_tree *tree,
274 					 u64 start);
275 void free_extent_buffer(struct extent_buffer *eb);
276 void free_extent_buffer_stale(struct extent_buffer *eb);
277 #define WAIT_NONE	0
278 #define WAIT_COMPLETE	1
279 #define WAIT_PAGE_LOCK	2
280 int read_extent_buffer_pages(struct extent_io_tree *tree,
281 			     struct extent_buffer *eb, u64 start, int wait,
282 			     get_extent_t *get_extent, int mirror_num);
283 void wait_on_extent_buffer_writeback(struct extent_buffer *eb);
284 
285 static inline unsigned long num_extent_pages(u64 start, u64 len)
286 {
287 	return ((start + len + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT) -
288 		(start >> PAGE_CACHE_SHIFT);
289 }
290 
291 static inline struct page *extent_buffer_page(struct extent_buffer *eb,
292 					      unsigned long i)
293 {
294 	return eb->pages[i];
295 }
296 
297 static inline void extent_buffer_get(struct extent_buffer *eb)
298 {
299 	atomic_inc(&eb->refs);
300 }
301 
302 int memcmp_extent_buffer(struct extent_buffer *eb, const void *ptrv,
303 			  unsigned long start,
304 			  unsigned long len);
305 void read_extent_buffer(struct extent_buffer *eb, void *dst,
306 			unsigned long start,
307 			unsigned long len);
308 void write_extent_buffer(struct extent_buffer *eb, const void *src,
309 			 unsigned long start, unsigned long len);
310 void copy_extent_buffer(struct extent_buffer *dst, struct extent_buffer *src,
311 			unsigned long dst_offset, unsigned long src_offset,
312 			unsigned long len);
313 void memcpy_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
314 			   unsigned long src_offset, unsigned long len);
315 void memmove_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
316 			   unsigned long src_offset, unsigned long len);
317 void memset_extent_buffer(struct extent_buffer *eb, char c,
318 			  unsigned long start, unsigned long len);
319 void clear_extent_buffer_dirty(struct extent_buffer *eb);
320 int set_extent_buffer_dirty(struct extent_buffer *eb);
321 int set_extent_buffer_uptodate(struct extent_buffer *eb);
322 int clear_extent_buffer_uptodate(struct extent_buffer *eb);
323 int extent_buffer_uptodate(struct extent_buffer *eb);
324 int map_private_extent_buffer(struct extent_buffer *eb, unsigned long offset,
325 		      unsigned long min_len, char **map,
326 		      unsigned long *map_start,
327 		      unsigned long *map_len);
328 int extent_range_clear_dirty_for_io(struct inode *inode, u64 start, u64 end);
329 int extent_range_redirty_for_io(struct inode *inode, u64 start, u64 end);
330 int extent_clear_unlock_delalloc(struct inode *inode, u64 start, u64 end,
331 				 struct page *locked_page,
332 				 unsigned long bits_to_clear,
333 				 unsigned long page_ops);
334 struct bio *
335 btrfs_bio_alloc(struct block_device *bdev, u64 first_sector, int nr_vecs,
336 		gfp_t gfp_flags);
337 struct bio *btrfs_io_bio_alloc(gfp_t gfp_mask, unsigned int nr_iovecs);
338 struct bio *btrfs_bio_clone(struct bio *bio, gfp_t gfp_mask);
339 
340 struct btrfs_fs_info;
341 
342 int repair_io_failure(struct btrfs_fs_info *fs_info, u64 start,
343 			u64 length, u64 logical, struct page *page,
344 			int mirror_num);
345 int end_extent_writepage(struct page *page, int err, u64 start, u64 end);
346 int repair_eb_io_failure(struct btrfs_root *root, struct extent_buffer *eb,
347 			 int mirror_num);
348 #ifdef CONFIG_BTRFS_FS_RUN_SANITY_TESTS
349 noinline u64 find_lock_delalloc_range(struct inode *inode,
350 				      struct extent_io_tree *tree,
351 				      struct page *locked_page, u64 *start,
352 				      u64 *end, u64 max_bytes);
353 #endif
354 #endif
355