xref: /openbmc/linux/fs/btrfs/extent_io.h (revision 840ef8b7cc584a23c4f9d05352f4dbaf8e56e5ab)
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_TREE_LOG 2
31 #define EXTENT_BIO_FLAG_SHIFT 16
32 
33 /* these are bit numbers for test/set bit */
34 #define EXTENT_BUFFER_UPTODATE 0
35 #define EXTENT_BUFFER_BLOCKING 1
36 #define EXTENT_BUFFER_DIRTY 2
37 #define EXTENT_BUFFER_CORRUPT 3
38 #define EXTENT_BUFFER_READAHEAD 4	/* this got triggered by readahead */
39 #define EXTENT_BUFFER_TREE_REF 5
40 #define EXTENT_BUFFER_STALE 6
41 #define EXTENT_BUFFER_WRITEBACK 7
42 #define EXTENT_BUFFER_IOERR 8
43 #define EXTENT_BUFFER_DUMMY 9
44 
45 /* these are flags for extent_clear_unlock_delalloc */
46 #define EXTENT_CLEAR_UNLOCK_PAGE 0x1
47 #define EXTENT_CLEAR_UNLOCK	 0x2
48 #define EXTENT_CLEAR_DELALLOC	 0x4
49 #define EXTENT_CLEAR_DIRTY	 0x8
50 #define EXTENT_SET_WRITEBACK	 0x10
51 #define EXTENT_END_WRITEBACK	 0x20
52 #define EXTENT_SET_PRIVATE2	 0x40
53 #define EXTENT_CLEAR_ACCOUNTING  0x80
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 
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 page *page, u64 start, u64 end,
80 				    struct extent_state *state, int mirror);
81 	int (*writepage_end_io_hook)(struct page *page, u64 start, u64 end,
82 				      struct extent_state *state, int uptodate);
83 	void (*set_bit_hook)(struct inode *inode, struct extent_state *state,
84 			     int *bits);
85 	void (*clear_bit_hook)(struct inode *inode, struct extent_state *state,
86 			       int *bits);
87 	void (*merge_extent_hook)(struct inode *inode,
88 				  struct extent_state *new,
89 				  struct extent_state *other);
90 	void (*split_extent_hook)(struct inode *inode,
91 				  struct extent_state *orig, u64 split);
92 };
93 
94 struct extent_io_tree {
95 	struct rb_root state;
96 	struct radix_tree_root buffer;
97 	struct address_space *mapping;
98 	u64 dirty_bytes;
99 	int track_uptodate;
100 	spinlock_t lock;
101 	spinlock_t buffer_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 	struct list_head leak_list;
120 };
121 
122 #define INLINE_EXTENT_BUFFER_PAGES 16
123 #define MAX_INLINE_EXTENT_BUFFER_SIZE (INLINE_EXTENT_BUFFER_PAGES * PAGE_CACHE_SIZE)
124 struct extent_buffer {
125 	u64 start;
126 	unsigned long len;
127 	unsigned long map_start;
128 	unsigned long map_len;
129 	unsigned long bflags;
130 	struct extent_io_tree *tree;
131 	spinlock_t refs_lock;
132 	atomic_t refs;
133 	atomic_t io_pages;
134 	int read_mirror;
135 	struct list_head leak_list;
136 	struct rcu_head rcu_head;
137 	pid_t lock_owner;
138 
139 	/* count of read lock holders on the extent buffer */
140 	atomic_t write_locks;
141 	atomic_t read_locks;
142 	atomic_t blocking_writers;
143 	atomic_t blocking_readers;
144 	atomic_t spinning_readers;
145 	atomic_t spinning_writers;
146 	int lock_nested;
147 
148 	/* protects write locks */
149 	rwlock_t lock;
150 
151 	/* readers use lock_wq while they wait for the write
152 	 * lock holders to unlock
153 	 */
154 	wait_queue_head_t write_lock_wq;
155 
156 	/* writers use read_lock_wq while they wait for readers
157 	 * to unlock
158 	 */
159 	wait_queue_head_t read_lock_wq;
160 	wait_queue_head_t lock_wq;
161 	struct page *pages[INLINE_EXTENT_BUFFER_PAGES];
162 };
163 
164 static inline void extent_set_compress_type(unsigned long *bio_flags,
165 					    int compress_type)
166 {
167 	*bio_flags |= compress_type << EXTENT_BIO_FLAG_SHIFT;
168 }
169 
170 static inline int extent_compress_type(unsigned long bio_flags)
171 {
172 	return bio_flags >> EXTENT_BIO_FLAG_SHIFT;
173 }
174 
175 struct extent_map_tree;
176 
177 typedef struct extent_map *(get_extent_t)(struct inode *inode,
178 					  struct page *page,
179 					  size_t pg_offset,
180 					  u64 start, u64 len,
181 					  int create);
182 
183 void extent_io_tree_init(struct extent_io_tree *tree,
184 			 struct address_space *mapping);
185 int try_release_extent_mapping(struct extent_map_tree *map,
186 			       struct extent_io_tree *tree, struct page *page,
187 			       gfp_t mask);
188 int try_release_extent_buffer(struct page *page, gfp_t mask);
189 int try_release_extent_state(struct extent_map_tree *map,
190 			     struct extent_io_tree *tree, struct page *page,
191 			     gfp_t mask);
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 		     int 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 __init extent_io_init(void);
202 void extent_io_exit(void);
203 
204 u64 count_range_bits(struct extent_io_tree *tree,
205 		     u64 *start, u64 search_end,
206 		     u64 max_bytes, unsigned long bits, int contig);
207 
208 void free_extent_state(struct extent_state *state);
209 int test_range_bit(struct extent_io_tree *tree, u64 start, u64 end,
210 		   int bits, int filled, struct extent_state *cached_state);
211 int clear_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
212 		      int bits, gfp_t mask);
213 int clear_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
214 		     int bits, int wake, int delete, struct extent_state **cached,
215 		     gfp_t mask);
216 int set_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
217 		    int bits, gfp_t mask);
218 int set_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
219 		   int bits, u64 *failed_start,
220 		   struct extent_state **cached_state, gfp_t mask);
221 int set_extent_uptodate(struct extent_io_tree *tree, u64 start, u64 end,
222 			struct extent_state **cached_state, gfp_t mask);
223 int clear_extent_uptodate(struct extent_io_tree *tree, u64 start, u64 end,
224 			  struct extent_state **cached_state, gfp_t mask);
225 int set_extent_new(struct extent_io_tree *tree, u64 start, u64 end,
226 		   gfp_t mask);
227 int set_extent_dirty(struct extent_io_tree *tree, u64 start, u64 end,
228 		     gfp_t mask);
229 int clear_extent_dirty(struct extent_io_tree *tree, u64 start, u64 end,
230 		       gfp_t mask);
231 int convert_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
232 		       int bits, int clear_bits,
233 		       struct extent_state **cached_state, gfp_t mask);
234 int set_extent_delalloc(struct extent_io_tree *tree, u64 start, u64 end,
235 			struct extent_state **cached_state, gfp_t mask);
236 int set_extent_defrag(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 **cached_state);
241 struct extent_state *find_first_extent_bit_state(struct extent_io_tree *tree,
242 						 u64 start, int bits);
243 int extent_invalidatepage(struct extent_io_tree *tree,
244 			  struct page *page, unsigned long offset);
245 int extent_write_full_page(struct extent_io_tree *tree, struct page *page,
246 			  get_extent_t *get_extent,
247 			  struct writeback_control *wbc);
248 int extent_write_locked_range(struct extent_io_tree *tree, struct inode *inode,
249 			      u64 start, u64 end, get_extent_t *get_extent,
250 			      int mode);
251 int extent_writepages(struct extent_io_tree *tree,
252 		      struct address_space *mapping,
253 		      get_extent_t *get_extent,
254 		      struct writeback_control *wbc);
255 int btree_write_cache_pages(struct address_space *mapping,
256 			    struct writeback_control *wbc);
257 int extent_readpages(struct extent_io_tree *tree,
258 		     struct address_space *mapping,
259 		     struct list_head *pages, unsigned nr_pages,
260 		     get_extent_t get_extent);
261 int extent_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
262 		__u64 start, __u64 len, get_extent_t *get_extent);
263 int set_state_private(struct extent_io_tree *tree, u64 start, u64 private);
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 extent_io_tree *tree,
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 extent_io_tree *tree,
272 					 u64 start, unsigned long len);
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 
282 static inline unsigned long num_extent_pages(u64 start, u64 len)
283 {
284 	return ((start + len + PAGE_CACHE_SIZE - 1) >> PAGE_CACHE_SHIFT) -
285 		(start >> PAGE_CACHE_SHIFT);
286 }
287 
288 static inline struct page *extent_buffer_page(struct extent_buffer *eb,
289 					      unsigned long i)
290 {
291 	return eb->pages[i];
292 }
293 
294 static inline void extent_buffer_get(struct extent_buffer *eb)
295 {
296 	atomic_inc(&eb->refs);
297 }
298 
299 int memcmp_extent_buffer(struct extent_buffer *eb, const void *ptrv,
300 			  unsigned long start,
301 			  unsigned long len);
302 void read_extent_buffer(struct extent_buffer *eb, void *dst,
303 			unsigned long start,
304 			unsigned long len);
305 void write_extent_buffer(struct extent_buffer *eb, const void *src,
306 			 unsigned long start, unsigned long len);
307 void copy_extent_buffer(struct extent_buffer *dst, struct extent_buffer *src,
308 			unsigned long dst_offset, unsigned long src_offset,
309 			unsigned long len);
310 void memcpy_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
311 			   unsigned long src_offset, unsigned long len);
312 void memmove_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
313 			   unsigned long src_offset, unsigned long len);
314 void memset_extent_buffer(struct extent_buffer *eb, char c,
315 			  unsigned long start, unsigned long len);
316 void wait_extent_bit(struct extent_io_tree *tree, u64 start, u64 end, int bits);
317 void clear_extent_buffer_dirty(struct extent_buffer *eb);
318 int set_extent_buffer_dirty(struct extent_buffer *eb);
319 int set_extent_buffer_uptodate(struct extent_buffer *eb);
320 int clear_extent_buffer_uptodate(struct extent_buffer *eb);
321 int extent_buffer_uptodate(struct extent_buffer *eb);
322 int map_private_extent_buffer(struct extent_buffer *eb, unsigned long offset,
323 		      unsigned long min_len, char **map,
324 		      unsigned long *map_start,
325 		      unsigned long *map_len);
326 int extent_range_uptodate(struct extent_io_tree *tree,
327 			  u64 start, u64 end);
328 int extent_clear_unlock_delalloc(struct inode *inode,
329 				struct extent_io_tree *tree,
330 				u64 start, u64 end, struct page *locked_page,
331 				unsigned long op);
332 struct bio *
333 btrfs_bio_alloc(struct block_device *bdev, u64 first_sector, int nr_vecs,
334 		gfp_t gfp_flags);
335 
336 struct btrfs_fs_info;
337 
338 int repair_io_failure(struct btrfs_fs_info *fs_info, u64 start,
339 			u64 length, u64 logical, struct page *page,
340 			int mirror_num);
341 int end_extent_writepage(struct page *page, int err, u64 start, u64 end);
342 int repair_eb_io_failure(struct btrfs_root *root, struct extent_buffer *eb,
343 			 int mirror_num);
344 #endif
345