xref: /linux/fs/btrfs/extent_io.h (revision d39d0ed196aa1685bb24771e92f78633c66ac9cb)
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_IOBITS (EXTENT_LOCKED | EXTENT_WRITEBACK)
21 #define EXTENT_CTLBITS (EXTENT_DO_ACCOUNTING | EXTENT_FIRST_DELALLOC)
22 
23 /* flags for bio submission */
24 #define EXTENT_BIO_COMPRESSED 1
25 
26 /* these are bit numbers for test/set bit */
27 #define EXTENT_BUFFER_UPTODATE 0
28 #define EXTENT_BUFFER_BLOCKING 1
29 #define EXTENT_BUFFER_DIRTY 2
30 
31 /* these are flags for extent_clear_unlock_delalloc */
32 #define EXTENT_CLEAR_UNLOCK_PAGE 0x1
33 #define EXTENT_CLEAR_UNLOCK	 0x2
34 #define EXTENT_CLEAR_DELALLOC	 0x4
35 #define EXTENT_CLEAR_DIRTY	 0x8
36 #define EXTENT_SET_WRITEBACK	 0x10
37 #define EXTENT_END_WRITEBACK	 0x20
38 #define EXTENT_SET_PRIVATE2	 0x40
39 #define EXTENT_CLEAR_ACCOUNTING  0x80
40 
41 /*
42  * page->private values.  Every page that is controlled by the extent
43  * map has page->private set to one.
44  */
45 #define EXTENT_PAGE_PRIVATE 1
46 #define EXTENT_PAGE_PRIVATE_FIRST_PAGE 3
47 
48 struct extent_state;
49 
50 typedef	int (extent_submit_bio_hook_t)(struct inode *inode, int rw,
51 				       struct bio *bio, int mirror_num,
52 				       unsigned long bio_flags, u64 bio_offset);
53 struct extent_io_ops {
54 	int (*fill_delalloc)(struct inode *inode, struct page *locked_page,
55 			     u64 start, u64 end, int *page_started,
56 			     unsigned long *nr_written);
57 	int (*writepage_start_hook)(struct page *page, u64 start, u64 end);
58 	int (*writepage_io_hook)(struct page *page, u64 start, u64 end);
59 	extent_submit_bio_hook_t *submit_bio_hook;
60 	int (*merge_bio_hook)(struct page *page, unsigned long offset,
61 			      size_t size, struct bio *bio,
62 			      unsigned long bio_flags);
63 	int (*readpage_io_hook)(struct page *page, u64 start, u64 end);
64 	int (*readpage_io_failed_hook)(struct bio *bio, struct page *page,
65 				       u64 start, u64 end,
66 				       struct extent_state *state);
67 	int (*writepage_io_failed_hook)(struct bio *bio, struct page *page,
68 					u64 start, u64 end,
69 				       struct extent_state *state);
70 	int (*readpage_end_io_hook)(struct page *page, u64 start, u64 end,
71 				    struct extent_state *state);
72 	int (*writepage_end_io_hook)(struct page *page, u64 start, u64 end,
73 				      struct extent_state *state, int uptodate);
74 	int (*set_bit_hook)(struct inode *inode, struct extent_state *state,
75 			    int *bits);
76 	int (*clear_bit_hook)(struct inode *inode, struct extent_state *state,
77 			      int *bits);
78 	int (*merge_extent_hook)(struct inode *inode,
79 				 struct extent_state *new,
80 				 struct extent_state *other);
81 	int (*split_extent_hook)(struct inode *inode,
82 				 struct extent_state *orig, u64 split);
83 	int (*write_cache_pages_lock_hook)(struct page *page);
84 };
85 
86 struct extent_io_tree {
87 	struct rb_root state;
88 	struct rb_root buffer;
89 	struct address_space *mapping;
90 	u64 dirty_bytes;
91 	spinlock_t lock;
92 	spinlock_t buffer_lock;
93 	struct extent_io_ops *ops;
94 };
95 
96 struct extent_state {
97 	u64 start;
98 	u64 end; /* inclusive */
99 	struct rb_node rb_node;
100 
101 	/* ADD NEW ELEMENTS AFTER THIS */
102 	struct extent_io_tree *tree;
103 	wait_queue_head_t wq;
104 	atomic_t refs;
105 	unsigned long state;
106 	u64 split_start;
107 	u64 split_end;
108 
109 	/* for use by the FS */
110 	u64 private;
111 
112 	struct list_head leak_list;
113 };
114 
115 struct extent_buffer {
116 	u64 start;
117 	unsigned long len;
118 	char *map_token;
119 	char *kaddr;
120 	unsigned long map_start;
121 	unsigned long map_len;
122 	struct page *first_page;
123 	unsigned long bflags;
124 	atomic_t refs;
125 	struct list_head leak_list;
126 	struct rb_node rb_node;
127 
128 	/* the spinlock is used to protect most operations */
129 	spinlock_t lock;
130 
131 	/*
132 	 * when we keep the lock held while blocking, waiters go onto
133 	 * the wq
134 	 */
135 	wait_queue_head_t lock_wq;
136 };
137 
138 struct extent_map_tree;
139 
140 static inline struct extent_state *extent_state_next(struct extent_state *state)
141 {
142 	struct rb_node *node;
143 	node = rb_next(&state->rb_node);
144 	if (!node)
145 		return NULL;
146 	return rb_entry(node, struct extent_state, rb_node);
147 }
148 
149 typedef struct extent_map *(get_extent_t)(struct inode *inode,
150 					  struct page *page,
151 					  size_t page_offset,
152 					  u64 start, u64 len,
153 					  int create);
154 
155 void extent_io_tree_init(struct extent_io_tree *tree,
156 			  struct address_space *mapping, gfp_t mask);
157 int try_release_extent_mapping(struct extent_map_tree *map,
158 			       struct extent_io_tree *tree, struct page *page,
159 			       gfp_t mask);
160 int try_release_extent_buffer(struct extent_io_tree *tree, struct page *page);
161 int try_release_extent_state(struct extent_map_tree *map,
162 			     struct extent_io_tree *tree, struct page *page,
163 			     gfp_t mask);
164 int lock_extent(struct extent_io_tree *tree, u64 start, u64 end, gfp_t mask);
165 int lock_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
166 		     int bits, struct extent_state **cached, gfp_t mask);
167 int unlock_extent(struct extent_io_tree *tree, u64 start, u64 end, gfp_t mask);
168 int unlock_extent_cached(struct extent_io_tree *tree, u64 start, u64 end,
169 			 struct extent_state **cached, gfp_t mask);
170 int try_lock_extent(struct extent_io_tree *tree, u64 start, u64 end,
171 		    gfp_t mask);
172 int extent_read_full_page(struct extent_io_tree *tree, struct page *page,
173 			  get_extent_t *get_extent);
174 int __init extent_io_init(void);
175 void extent_io_exit(void);
176 
177 u64 count_range_bits(struct extent_io_tree *tree,
178 		     u64 *start, u64 search_end,
179 		     u64 max_bytes, unsigned long bits);
180 
181 void free_extent_state(struct extent_state *state);
182 int test_range_bit(struct extent_io_tree *tree, u64 start, u64 end,
183 		   int bits, int filled, struct extent_state *cached_state);
184 int clear_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
185 		      int bits, gfp_t mask);
186 int clear_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
187 		     int bits, int wake, int delete, struct extent_state **cached,
188 		     gfp_t mask);
189 int set_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
190 		    int bits, gfp_t mask);
191 int set_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
192 		   int bits, int exclusive_bits, u64 *failed_start,
193 		   struct extent_state **cached_state, gfp_t mask);
194 int set_extent_uptodate(struct extent_io_tree *tree, u64 start, u64 end,
195 			gfp_t mask);
196 int set_extent_new(struct extent_io_tree *tree, u64 start, u64 end,
197 		   gfp_t mask);
198 int set_extent_dirty(struct extent_io_tree *tree, u64 start, u64 end,
199 		     gfp_t mask);
200 int clear_extent_dirty(struct extent_io_tree *tree, u64 start, u64 end,
201 		       gfp_t mask);
202 int clear_extent_ordered(struct extent_io_tree *tree, u64 start, u64 end,
203 		       gfp_t mask);
204 int clear_extent_ordered_metadata(struct extent_io_tree *tree, u64 start,
205 				  u64 end, gfp_t mask);
206 int set_extent_delalloc(struct extent_io_tree *tree, u64 start, u64 end,
207 			struct extent_state **cached_state, gfp_t mask);
208 int set_extent_ordered(struct extent_io_tree *tree, u64 start, u64 end,
209 		     gfp_t mask);
210 int find_first_extent_bit(struct extent_io_tree *tree, u64 start,
211 			  u64 *start_ret, u64 *end_ret, int bits);
212 struct extent_state *find_first_extent_bit_state(struct extent_io_tree *tree,
213 						 u64 start, int bits);
214 int extent_invalidatepage(struct extent_io_tree *tree,
215 			  struct page *page, unsigned long offset);
216 int extent_write_full_page(struct extent_io_tree *tree, struct page *page,
217 			  get_extent_t *get_extent,
218 			  struct writeback_control *wbc);
219 int extent_write_locked_range(struct extent_io_tree *tree, struct inode *inode,
220 			      u64 start, u64 end, get_extent_t *get_extent,
221 			      int mode);
222 int extent_writepages(struct extent_io_tree *tree,
223 		      struct address_space *mapping,
224 		      get_extent_t *get_extent,
225 		      struct writeback_control *wbc);
226 int extent_readpages(struct extent_io_tree *tree,
227 		     struct address_space *mapping,
228 		     struct list_head *pages, unsigned nr_pages,
229 		     get_extent_t get_extent);
230 int extent_prepare_write(struct extent_io_tree *tree,
231 			 struct inode *inode, struct page *page,
232 			 unsigned from, unsigned to, get_extent_t *get_extent);
233 int extent_commit_write(struct extent_io_tree *tree,
234 			struct inode *inode, struct page *page,
235 			unsigned from, unsigned to);
236 sector_t extent_bmap(struct address_space *mapping, sector_t iblock,
237 		get_extent_t *get_extent);
238 int extent_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
239 		__u64 start, __u64 len, get_extent_t *get_extent);
240 int set_range_dirty(struct extent_io_tree *tree, u64 start, u64 end);
241 int set_state_private(struct extent_io_tree *tree, u64 start, u64 private);
242 int get_state_private(struct extent_io_tree *tree, u64 start, u64 *private);
243 void set_page_extent_mapped(struct page *page);
244 
245 struct extent_buffer *alloc_extent_buffer(struct extent_io_tree *tree,
246 					  u64 start, unsigned long len,
247 					  struct page *page0,
248 					  gfp_t mask);
249 struct extent_buffer *find_extent_buffer(struct extent_io_tree *tree,
250 					 u64 start, unsigned long len,
251 					  gfp_t mask);
252 void free_extent_buffer(struct extent_buffer *eb);
253 int read_extent_buffer_pages(struct extent_io_tree *tree,
254 			     struct extent_buffer *eb, u64 start, int wait,
255 			     get_extent_t *get_extent, int mirror_num);
256 
257 static inline void extent_buffer_get(struct extent_buffer *eb)
258 {
259 	atomic_inc(&eb->refs);
260 }
261 
262 int memcmp_extent_buffer(struct extent_buffer *eb, const void *ptrv,
263 			  unsigned long start,
264 			  unsigned long len);
265 void read_extent_buffer(struct extent_buffer *eb, void *dst,
266 			unsigned long start,
267 			unsigned long len);
268 void write_extent_buffer(struct extent_buffer *eb, const void *src,
269 			 unsigned long start, unsigned long len);
270 void copy_extent_buffer(struct extent_buffer *dst, struct extent_buffer *src,
271 			unsigned long dst_offset, unsigned long src_offset,
272 			unsigned long len);
273 void memcpy_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
274 			   unsigned long src_offset, unsigned long len);
275 void memmove_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
276 			   unsigned long src_offset, unsigned long len);
277 void memset_extent_buffer(struct extent_buffer *eb, char c,
278 			  unsigned long start, unsigned long len);
279 int wait_on_extent_buffer_writeback(struct extent_io_tree *tree,
280 				    struct extent_buffer *eb);
281 int wait_on_extent_writeback(struct extent_io_tree *tree, u64 start, u64 end);
282 int wait_extent_bit(struct extent_io_tree *tree, u64 start, u64 end, int bits);
283 int clear_extent_buffer_dirty(struct extent_io_tree *tree,
284 			      struct extent_buffer *eb);
285 int set_extent_buffer_dirty(struct extent_io_tree *tree,
286 			     struct extent_buffer *eb);
287 int test_extent_buffer_dirty(struct extent_io_tree *tree,
288 			     struct extent_buffer *eb);
289 int set_extent_buffer_uptodate(struct extent_io_tree *tree,
290 			       struct extent_buffer *eb);
291 int clear_extent_buffer_uptodate(struct extent_io_tree *tree,
292 				struct extent_buffer *eb,
293 				struct extent_state **cached_state);
294 int extent_buffer_uptodate(struct extent_io_tree *tree,
295 			   struct extent_buffer *eb,
296 			   struct extent_state *cached_state);
297 int map_extent_buffer(struct extent_buffer *eb, unsigned long offset,
298 		      unsigned long min_len, char **token, char **map,
299 		      unsigned long *map_start,
300 		      unsigned long *map_len, int km);
301 int map_private_extent_buffer(struct extent_buffer *eb, unsigned long offset,
302 		      unsigned long min_len, char **token, char **map,
303 		      unsigned long *map_start,
304 		      unsigned long *map_len, int km);
305 void unmap_extent_buffer(struct extent_buffer *eb, char *token, int km);
306 int release_extent_buffer_tail_pages(struct extent_buffer *eb);
307 int extent_range_uptodate(struct extent_io_tree *tree,
308 			  u64 start, u64 end);
309 int extent_clear_unlock_delalloc(struct inode *inode,
310 				struct extent_io_tree *tree,
311 				u64 start, u64 end, struct page *locked_page,
312 				unsigned long op);
313 #endif
314