xref: /linux/fs/btrfs/extent_io.h (revision 95e9fd10f06cb5642028b6b851e32b8c8afb4571)
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 #define EXTENT_BUFFER_DUMMY 9
43 
44 /* these are flags for extent_clear_unlock_delalloc */
45 #define EXTENT_CLEAR_UNLOCK_PAGE 0x1
46 #define EXTENT_CLEAR_UNLOCK	 0x2
47 #define EXTENT_CLEAR_DELALLOC	 0x4
48 #define EXTENT_CLEAR_DIRTY	 0x8
49 #define EXTENT_SET_WRITEBACK	 0x10
50 #define EXTENT_END_WRITEBACK	 0x20
51 #define EXTENT_SET_PRIVATE2	 0x40
52 #define EXTENT_CLEAR_ACCOUNTING  0x80
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 
64 typedef	int (extent_submit_bio_hook_t)(struct inode *inode, int rw,
65 				       struct bio *bio, int mirror_num,
66 				       unsigned long bio_flags, u64 bio_offset);
67 struct extent_io_ops {
68 	int (*fill_delalloc)(struct inode *inode, struct page *locked_page,
69 			     u64 start, u64 end, int *page_started,
70 			     unsigned long *nr_written);
71 	int (*writepage_start_hook)(struct page *page, u64 start, u64 end);
72 	int (*writepage_io_hook)(struct page *page, u64 start, u64 end);
73 	extent_submit_bio_hook_t *submit_bio_hook;
74 	int (*merge_bio_hook)(struct page *page, unsigned long offset,
75 			      size_t size, struct bio *bio,
76 			      unsigned long bio_flags);
77 	int (*readpage_io_hook)(struct page *page, u64 start, u64 end);
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 	int (*write_cache_pages_lock_hook)(struct page *page, void *data,
93 					   void (*flush_fn)(void *));
94 };
95 
96 struct extent_io_tree {
97 	struct rb_root state;
98 	struct radix_tree_root buffer;
99 	struct address_space *mapping;
100 	u64 dirty_bytes;
101 	int track_uptodate;
102 	spinlock_t lock;
103 	spinlock_t buffer_lock;
104 	struct extent_io_ops *ops;
105 };
106 
107 struct extent_state {
108 	u64 start;
109 	u64 end; /* inclusive */
110 	struct rb_node rb_node;
111 
112 	/* ADD NEW ELEMENTS AFTER THIS */
113 	struct extent_io_tree *tree;
114 	wait_queue_head_t wq;
115 	atomic_t refs;
116 	unsigned long state;
117 
118 	/* for use by the FS */
119 	u64 private;
120 
121 	struct list_head leak_list;
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 extent_io_tree *tree;
133 	spinlock_t refs_lock;
134 	atomic_t refs;
135 	atomic_t io_pages;
136 	int read_mirror;
137 	struct list_head leak_list;
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 *inline_pages[INLINE_EXTENT_BUFFER_PAGES];
164 	struct page **pages;
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, gfp_t mask);
192 int try_release_extent_state(struct extent_map_tree *map,
193 			     struct extent_io_tree *tree, struct page *page,
194 			     gfp_t mask);
195 int lock_extent(struct extent_io_tree *tree, u64 start, u64 end);
196 int lock_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
197 		     int bits, struct extent_state **cached);
198 int unlock_extent(struct extent_io_tree *tree, u64 start, u64 end);
199 int unlock_extent_cached(struct extent_io_tree *tree, u64 start, u64 end,
200 			 struct extent_state **cached, gfp_t mask);
201 int try_lock_extent(struct extent_io_tree *tree, u64 start, u64 end);
202 int extent_read_full_page(struct extent_io_tree *tree, struct page *page,
203 			  get_extent_t *get_extent, int mirror_num);
204 int __init extent_io_init(void);
205 void extent_io_exit(void);
206 
207 u64 count_range_bits(struct extent_io_tree *tree,
208 		     u64 *start, u64 search_end,
209 		     u64 max_bytes, unsigned long bits, int contig);
210 
211 void free_extent_state(struct extent_state *state);
212 int test_range_bit(struct extent_io_tree *tree, u64 start, u64 end,
213 		   int bits, int filled, struct extent_state *cached_state);
214 int clear_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
215 		      int bits, gfp_t mask);
216 int clear_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
217 		     int bits, int wake, int delete, struct extent_state **cached,
218 		     gfp_t mask);
219 int set_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
220 		    int bits, gfp_t mask);
221 int set_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
222 		   int 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 		       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 *alloc_dummy_extent_buffer(u64 start, unsigned long len);
269 struct extent_buffer *btrfs_clone_extent_buffer(struct extent_buffer *src);
270 struct extent_buffer *find_extent_buffer(struct extent_io_tree *tree,
271 					 u64 start, unsigned long len);
272 void free_extent_buffer(struct extent_buffer *eb);
273 void free_extent_buffer_stale(struct extent_buffer *eb);
274 #define WAIT_NONE	0
275 #define WAIT_COMPLETE	1
276 #define WAIT_PAGE_LOCK	2
277 int read_extent_buffer_pages(struct extent_io_tree *tree,
278 			     struct extent_buffer *eb, u64 start, int wait,
279 			     get_extent_t *get_extent, int mirror_num);
280 unsigned long num_extent_pages(u64 start, u64 len);
281 struct page *extent_buffer_page(struct extent_buffer *eb, unsigned long i);
282 
283 static inline void extent_buffer_get(struct extent_buffer *eb)
284 {
285 	atomic_inc(&eb->refs);
286 }
287 
288 int memcmp_extent_buffer(struct extent_buffer *eb, const void *ptrv,
289 			  unsigned long start,
290 			  unsigned long len);
291 void read_extent_buffer(struct extent_buffer *eb, void *dst,
292 			unsigned long start,
293 			unsigned long len);
294 void write_extent_buffer(struct extent_buffer *eb, const void *src,
295 			 unsigned long start, unsigned long len);
296 void copy_extent_buffer(struct extent_buffer *dst, struct extent_buffer *src,
297 			unsigned long dst_offset, unsigned long src_offset,
298 			unsigned long len);
299 void memcpy_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
300 			   unsigned long src_offset, unsigned long len);
301 void memmove_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
302 			   unsigned long src_offset, unsigned long len);
303 void memset_extent_buffer(struct extent_buffer *eb, char c,
304 			  unsigned long start, unsigned long len);
305 void wait_extent_bit(struct extent_io_tree *tree, u64 start, u64 end, int bits);
306 void clear_extent_buffer_dirty(struct extent_buffer *eb);
307 int set_extent_buffer_dirty(struct extent_buffer *eb);
308 int set_extent_buffer_uptodate(struct extent_buffer *eb);
309 int clear_extent_buffer_uptodate(struct extent_buffer *eb);
310 int extent_buffer_uptodate(struct extent_buffer *eb);
311 int map_private_extent_buffer(struct extent_buffer *eb, unsigned long offset,
312 		      unsigned long min_len, char **map,
313 		      unsigned long *map_start,
314 		      unsigned long *map_len);
315 int extent_range_uptodate(struct extent_io_tree *tree,
316 			  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
334