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