xref: /openbmc/linux/fs/btrfs/extent_io.h (revision 64405360)
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 
39 /* these are flags for extent_clear_unlock_delalloc */
40 #define EXTENT_CLEAR_UNLOCK_PAGE 0x1
41 #define EXTENT_CLEAR_UNLOCK	 0x2
42 #define EXTENT_CLEAR_DELALLOC	 0x4
43 #define EXTENT_CLEAR_DIRTY	 0x8
44 #define EXTENT_SET_WRITEBACK	 0x10
45 #define EXTENT_END_WRITEBACK	 0x20
46 #define EXTENT_SET_PRIVATE2	 0x40
47 #define EXTENT_CLEAR_ACCOUNTING  0x80
48 
49 /*
50  * page->private values.  Every page that is controlled by the extent
51  * map has page->private set to one.
52  */
53 #define EXTENT_PAGE_PRIVATE 1
54 #define EXTENT_PAGE_PRIVATE_FIRST_PAGE 3
55 
56 struct extent_state;
57 
58 typedef	int (extent_submit_bio_hook_t)(struct inode *inode, int rw,
59 				       struct bio *bio, int mirror_num,
60 				       unsigned long bio_flags, u64 bio_offset);
61 struct extent_io_ops {
62 	int (*fill_delalloc)(struct inode *inode, struct page *locked_page,
63 			     u64 start, u64 end, int *page_started,
64 			     unsigned long *nr_written);
65 	int (*writepage_start_hook)(struct page *page, u64 start, u64 end);
66 	int (*writepage_io_hook)(struct page *page, u64 start, u64 end);
67 	extent_submit_bio_hook_t *submit_bio_hook;
68 	int (*merge_bio_hook)(struct page *page, unsigned long offset,
69 			      size_t size, struct bio *bio,
70 			      unsigned long bio_flags);
71 	int (*readpage_io_hook)(struct page *page, u64 start, u64 end);
72 	int (*readpage_io_failed_hook)(struct bio *bio, struct page *page,
73 				       u64 start, u64 end, int failed_mirror,
74 				       struct extent_state *state);
75 	int (*writepage_io_failed_hook)(struct bio *bio, struct page *page,
76 					u64 start, u64 end,
77 				       struct extent_state *state);
78 	int (*readpage_end_io_hook)(struct page *page, u64 start, u64 end,
79 				    struct extent_state *state);
80 	int (*writepage_end_io_hook)(struct page *page, u64 start, u64 end,
81 				      struct extent_state *state, int uptodate);
82 	void (*set_bit_hook)(struct inode *inode, struct extent_state *state,
83 			     int *bits);
84 	void (*clear_bit_hook)(struct inode *inode, struct extent_state *state,
85 			       int *bits);
86 	void (*merge_extent_hook)(struct inode *inode,
87 				  struct extent_state *new,
88 				  struct extent_state *other);
89 	void (*split_extent_hook)(struct inode *inode,
90 				  struct extent_state *orig, u64 split);
91 	int (*write_cache_pages_lock_hook)(struct page *page, void *data,
92 					   void (*flush_fn)(void *));
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 	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 struct extent_buffer {
123 	u64 start;
124 	unsigned long len;
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 	pid_t lock_owner;
133 
134 	/* count of read lock holders on the extent buffer */
135 	atomic_t write_locks;
136 	atomic_t read_locks;
137 	atomic_t blocking_writers;
138 	atomic_t blocking_readers;
139 	atomic_t spinning_readers;
140 	atomic_t spinning_writers;
141 	int lock_nested;
142 
143 	/* protects write locks */
144 	rwlock_t lock;
145 
146 	/* readers use lock_wq while they wait for the write
147 	 * lock holders to unlock
148 	 */
149 	wait_queue_head_t write_lock_wq;
150 
151 	/* writers use read_lock_wq while they wait for readers
152 	 * to unlock
153 	 */
154 	wait_queue_head_t read_lock_wq;
155 };
156 
157 static inline void extent_set_compress_type(unsigned long *bio_flags,
158 					    int compress_type)
159 {
160 	*bio_flags |= compress_type << EXTENT_BIO_FLAG_SHIFT;
161 }
162 
163 static inline int extent_compress_type(unsigned long bio_flags)
164 {
165 	return bio_flags >> EXTENT_BIO_FLAG_SHIFT;
166 }
167 
168 struct extent_map_tree;
169 
170 typedef struct extent_map *(get_extent_t)(struct inode *inode,
171 					  struct page *page,
172 					  size_t pg_offset,
173 					  u64 start, u64 len,
174 					  int create);
175 
176 void extent_io_tree_init(struct extent_io_tree *tree,
177 			 struct address_space *mapping);
178 int try_release_extent_mapping(struct extent_map_tree *map,
179 			       struct extent_io_tree *tree, struct page *page,
180 			       gfp_t mask);
181 int try_release_extent_buffer(struct extent_io_tree *tree, struct page *page);
182 int try_release_extent_state(struct extent_map_tree *map,
183 			     struct extent_io_tree *tree, struct page *page,
184 			     gfp_t mask);
185 int lock_extent(struct extent_io_tree *tree, u64 start, u64 end, gfp_t mask);
186 int lock_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
187 		     int bits, struct extent_state **cached, gfp_t mask);
188 int unlock_extent(struct extent_io_tree *tree, u64 start, u64 end, gfp_t mask);
189 int unlock_extent_cached(struct extent_io_tree *tree, u64 start, u64 end,
190 			 struct extent_state **cached, gfp_t mask);
191 int try_lock_extent(struct extent_io_tree *tree, u64 start, u64 end,
192 		    gfp_t mask);
193 int extent_read_full_page(struct extent_io_tree *tree, struct page *page,
194 			  get_extent_t *get_extent, int mirror_num);
195 int __init extent_io_init(void);
196 void extent_io_exit(void);
197 
198 u64 count_range_bits(struct extent_io_tree *tree,
199 		     u64 *start, u64 search_end,
200 		     u64 max_bytes, unsigned long bits, int contig);
201 
202 void free_extent_state(struct extent_state *state);
203 int test_range_bit(struct extent_io_tree *tree, u64 start, u64 end,
204 		   int bits, int filled, struct extent_state *cached_state);
205 int clear_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
206 		      int bits, gfp_t mask);
207 int clear_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
208 		     int bits, int wake, int delete, struct extent_state **cached,
209 		     gfp_t mask);
210 int set_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
211 		    int bits, gfp_t mask);
212 int set_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
213 		   int bits, int exclusive_bits, u64 *failed_start,
214 		   struct extent_state **cached_state, gfp_t mask);
215 int set_extent_uptodate(struct extent_io_tree *tree, u64 start, u64 end,
216 			struct extent_state **cached_state, gfp_t mask);
217 int set_extent_new(struct extent_io_tree *tree, u64 start, u64 end,
218 		   gfp_t mask);
219 int set_extent_dirty(struct extent_io_tree *tree, u64 start, u64 end,
220 		     gfp_t mask);
221 int clear_extent_dirty(struct extent_io_tree *tree, u64 start, u64 end,
222 		       gfp_t mask);
223 int convert_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
224 		       int bits, int clear_bits, gfp_t mask);
225 int set_extent_delalloc(struct extent_io_tree *tree, u64 start, u64 end,
226 			struct extent_state **cached_state, gfp_t mask);
227 int find_first_extent_bit(struct extent_io_tree *tree, u64 start,
228 			  u64 *start_ret, u64 *end_ret, int bits);
229 struct extent_state *find_first_extent_bit_state(struct extent_io_tree *tree,
230 						 u64 start, int bits);
231 int extent_invalidatepage(struct extent_io_tree *tree,
232 			  struct page *page, unsigned long offset);
233 int extent_write_full_page(struct extent_io_tree *tree, struct page *page,
234 			  get_extent_t *get_extent,
235 			  struct writeback_control *wbc);
236 int extent_write_locked_range(struct extent_io_tree *tree, struct inode *inode,
237 			      u64 start, u64 end, get_extent_t *get_extent,
238 			      int mode);
239 int extent_writepages(struct extent_io_tree *tree,
240 		      struct address_space *mapping,
241 		      get_extent_t *get_extent,
242 		      struct writeback_control *wbc);
243 int extent_readpages(struct extent_io_tree *tree,
244 		     struct address_space *mapping,
245 		     struct list_head *pages, unsigned nr_pages,
246 		     get_extent_t get_extent);
247 int extent_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
248 		__u64 start, __u64 len, get_extent_t *get_extent);
249 int set_state_private(struct extent_io_tree *tree, u64 start, u64 private);
250 int get_state_private(struct extent_io_tree *tree, u64 start, u64 *private);
251 void set_page_extent_mapped(struct page *page);
252 
253 struct extent_buffer *alloc_extent_buffer(struct extent_io_tree *tree,
254 					  u64 start, unsigned long len,
255 					  struct page *page0);
256 struct extent_buffer *find_extent_buffer(struct extent_io_tree *tree,
257 					 u64 start, unsigned long len);
258 void free_extent_buffer(struct extent_buffer *eb);
259 #define WAIT_NONE	0
260 #define WAIT_COMPLETE	1
261 #define WAIT_PAGE_LOCK	2
262 int read_extent_buffer_pages(struct extent_io_tree *tree,
263 			     struct extent_buffer *eb, u64 start, int wait,
264 			     get_extent_t *get_extent, int mirror_num);
265 unsigned long num_extent_pages(u64 start, u64 len);
266 struct page *extent_buffer_page(struct extent_buffer *eb, unsigned long i);
267 
268 static inline void extent_buffer_get(struct extent_buffer *eb)
269 {
270 	atomic_inc(&eb->refs);
271 }
272 
273 int memcmp_extent_buffer(struct extent_buffer *eb, const void *ptrv,
274 			  unsigned long start,
275 			  unsigned long len);
276 void read_extent_buffer(struct extent_buffer *eb, void *dst,
277 			unsigned long start,
278 			unsigned long len);
279 void write_extent_buffer(struct extent_buffer *eb, const void *src,
280 			 unsigned long start, unsigned long len);
281 void copy_extent_buffer(struct extent_buffer *dst, struct extent_buffer *src,
282 			unsigned long dst_offset, unsigned long src_offset,
283 			unsigned long len);
284 void memcpy_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
285 			   unsigned long src_offset, unsigned long len);
286 void memmove_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
287 			   unsigned long src_offset, unsigned long len);
288 void memset_extent_buffer(struct extent_buffer *eb, char c,
289 			  unsigned long start, unsigned long len);
290 int wait_extent_bit(struct extent_io_tree *tree, u64 start, u64 end, int bits);
291 int clear_extent_buffer_dirty(struct extent_io_tree *tree,
292 			      struct extent_buffer *eb);
293 int set_extent_buffer_dirty(struct extent_io_tree *tree,
294 			     struct extent_buffer *eb);
295 int set_extent_buffer_uptodate(struct extent_io_tree *tree,
296 			       struct extent_buffer *eb);
297 int clear_extent_buffer_uptodate(struct extent_io_tree *tree,
298 				struct extent_buffer *eb,
299 				struct extent_state **cached_state);
300 int extent_buffer_uptodate(struct extent_io_tree *tree,
301 			   struct extent_buffer *eb,
302 			   struct extent_state *cached_state);
303 int map_private_extent_buffer(struct extent_buffer *eb, unsigned long offset,
304 		      unsigned long min_len, char **map,
305 		      unsigned long *map_start,
306 		      unsigned long *map_len);
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 struct bio *
314 btrfs_bio_alloc(struct block_device *bdev, u64 first_sector, int nr_vecs,
315 		gfp_t gfp_flags);
316 
317 struct btrfs_mapping_tree;
318 
319 int repair_io_failure(struct btrfs_mapping_tree *map_tree, u64 start,
320 			u64 length, u64 logical, struct page *page,
321 			int mirror_num);
322 int end_extent_writepage(struct page *page, int err, u64 start, u64 end);
323 #endif
324