xref: /openbmc/linux/fs/btrfs/extent_io.h (revision 9c1f8594)
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 	void (*set_bit_hook)(struct inode *inode, struct extent_state *state,
80 			     int *bits);
81 	void (*clear_bit_hook)(struct inode *inode, struct extent_state *state,
82 			       int *bits);
83 	void (*merge_extent_hook)(struct inode *inode,
84 				  struct extent_state *new,
85 				  struct extent_state *other);
86 	void (*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 
112 	/* for use by the FS */
113 	u64 private;
114 
115 	struct list_head leak_list;
116 };
117 
118 struct extent_buffer {
119 	u64 start;
120 	unsigned long len;
121 	unsigned long map_start;
122 	unsigned long map_len;
123 	struct page *first_page;
124 	unsigned long bflags;
125 	struct list_head leak_list;
126 	struct rcu_head rcu_head;
127 	atomic_t refs;
128 
129 	/* count of read lock holders on the extent buffer */
130 	atomic_t write_locks;
131 	atomic_t read_locks;
132 	atomic_t blocking_writers;
133 	atomic_t blocking_readers;
134 	atomic_t spinning_readers;
135 	atomic_t spinning_writers;
136 
137 	/* protects write locks */
138 	rwlock_t lock;
139 
140 	/* readers use lock_wq while they wait for the write
141 	 * lock holders to unlock
142 	 */
143 	wait_queue_head_t write_lock_wq;
144 
145 	/* writers use read_lock_wq while they wait for readers
146 	 * to unlock
147 	 */
148 	wait_queue_head_t read_lock_wq;
149 };
150 
151 static inline void extent_set_compress_type(unsigned long *bio_flags,
152 					    int compress_type)
153 {
154 	*bio_flags |= compress_type << EXTENT_BIO_FLAG_SHIFT;
155 }
156 
157 static inline int extent_compress_type(unsigned long bio_flags)
158 {
159 	return bio_flags >> EXTENT_BIO_FLAG_SHIFT;
160 }
161 
162 struct extent_map_tree;
163 
164 typedef struct extent_map *(get_extent_t)(struct inode *inode,
165 					  struct page *page,
166 					  size_t pg_offset,
167 					  u64 start, u64 len,
168 					  int create);
169 
170 void extent_io_tree_init(struct extent_io_tree *tree,
171 			 struct address_space *mapping);
172 int try_release_extent_mapping(struct extent_map_tree *map,
173 			       struct extent_io_tree *tree, struct page *page,
174 			       gfp_t mask);
175 int try_release_extent_buffer(struct extent_io_tree *tree, struct page *page);
176 int try_release_extent_state(struct extent_map_tree *map,
177 			     struct extent_io_tree *tree, struct page *page,
178 			     gfp_t mask);
179 int lock_extent(struct extent_io_tree *tree, u64 start, u64 end, gfp_t mask);
180 int lock_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
181 		     int bits, struct extent_state **cached, gfp_t mask);
182 int unlock_extent(struct extent_io_tree *tree, u64 start, u64 end, gfp_t mask);
183 int unlock_extent_cached(struct extent_io_tree *tree, u64 start, u64 end,
184 			 struct extent_state **cached, gfp_t mask);
185 int try_lock_extent(struct extent_io_tree *tree, u64 start, u64 end,
186 		    gfp_t mask);
187 int extent_read_full_page(struct extent_io_tree *tree, struct page *page,
188 			  get_extent_t *get_extent);
189 int __init extent_io_init(void);
190 void extent_io_exit(void);
191 
192 u64 count_range_bits(struct extent_io_tree *tree,
193 		     u64 *start, u64 search_end,
194 		     u64 max_bytes, unsigned long bits, int contig);
195 
196 void free_extent_state(struct extent_state *state);
197 int test_range_bit(struct extent_io_tree *tree, u64 start, u64 end,
198 		   int bits, int filled, struct extent_state *cached_state);
199 int clear_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
200 		      int bits, gfp_t mask);
201 int clear_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
202 		     int bits, int wake, int delete, struct extent_state **cached,
203 		     gfp_t mask);
204 int set_extent_bits(struct extent_io_tree *tree, u64 start, u64 end,
205 		    int bits, gfp_t mask);
206 int set_extent_bit(struct extent_io_tree *tree, u64 start, u64 end,
207 		   int bits, int exclusive_bits, u64 *failed_start,
208 		   struct extent_state **cached_state, gfp_t mask);
209 int set_extent_uptodate(struct extent_io_tree *tree, u64 start, u64 end,
210 			struct extent_state **cached_state, gfp_t mask);
211 int set_extent_new(struct extent_io_tree *tree, u64 start, u64 end,
212 		   gfp_t mask);
213 int set_extent_dirty(struct extent_io_tree *tree, u64 start, u64 end,
214 		     gfp_t mask);
215 int clear_extent_dirty(struct extent_io_tree *tree, u64 start, u64 end,
216 		       gfp_t mask);
217 int set_extent_delalloc(struct extent_io_tree *tree, u64 start, u64 end,
218 			struct extent_state **cached_state, gfp_t mask);
219 int find_first_extent_bit(struct extent_io_tree *tree, u64 start,
220 			  u64 *start_ret, u64 *end_ret, int bits);
221 struct extent_state *find_first_extent_bit_state(struct extent_io_tree *tree,
222 						 u64 start, int bits);
223 int extent_invalidatepage(struct extent_io_tree *tree,
224 			  struct page *page, unsigned long offset);
225 int extent_write_full_page(struct extent_io_tree *tree, struct page *page,
226 			  get_extent_t *get_extent,
227 			  struct writeback_control *wbc);
228 int extent_write_locked_range(struct extent_io_tree *tree, struct inode *inode,
229 			      u64 start, u64 end, get_extent_t *get_extent,
230 			      int mode);
231 int extent_writepages(struct extent_io_tree *tree,
232 		      struct address_space *mapping,
233 		      get_extent_t *get_extent,
234 		      struct writeback_control *wbc);
235 int extent_readpages(struct extent_io_tree *tree,
236 		     struct address_space *mapping,
237 		     struct list_head *pages, unsigned nr_pages,
238 		     get_extent_t get_extent);
239 int extent_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
240 		__u64 start, __u64 len, get_extent_t *get_extent);
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 struct extent_buffer *find_extent_buffer(struct extent_io_tree *tree,
249 					 u64 start, unsigned long len);
250 void free_extent_buffer(struct extent_buffer *eb);
251 int read_extent_buffer_pages(struct extent_io_tree *tree,
252 			     struct extent_buffer *eb, u64 start, int wait,
253 			     get_extent_t *get_extent, int mirror_num);
254 
255 static inline void extent_buffer_get(struct extent_buffer *eb)
256 {
257 	atomic_inc(&eb->refs);
258 }
259 
260 int memcmp_extent_buffer(struct extent_buffer *eb, const void *ptrv,
261 			  unsigned long start,
262 			  unsigned long len);
263 void read_extent_buffer(struct extent_buffer *eb, void *dst,
264 			unsigned long start,
265 			unsigned long len);
266 void write_extent_buffer(struct extent_buffer *eb, const void *src,
267 			 unsigned long start, unsigned long len);
268 void copy_extent_buffer(struct extent_buffer *dst, struct extent_buffer *src,
269 			unsigned long dst_offset, unsigned long src_offset,
270 			unsigned long len);
271 void memcpy_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
272 			   unsigned long src_offset, unsigned long len);
273 void memmove_extent_buffer(struct extent_buffer *dst, unsigned long dst_offset,
274 			   unsigned long src_offset, unsigned long len);
275 void memset_extent_buffer(struct extent_buffer *eb, char c,
276 			  unsigned long start, unsigned long len);
277 int wait_extent_bit(struct extent_io_tree *tree, u64 start, u64 end, int bits);
278 int clear_extent_buffer_dirty(struct extent_io_tree *tree,
279 			      struct extent_buffer *eb);
280 int set_extent_buffer_dirty(struct extent_io_tree *tree,
281 			     struct extent_buffer *eb);
282 int set_extent_buffer_uptodate(struct extent_io_tree *tree,
283 			       struct extent_buffer *eb);
284 int clear_extent_buffer_uptodate(struct extent_io_tree *tree,
285 				struct extent_buffer *eb,
286 				struct extent_state **cached_state);
287 int extent_buffer_uptodate(struct extent_io_tree *tree,
288 			   struct extent_buffer *eb,
289 			   struct extent_state *cached_state);
290 int map_private_extent_buffer(struct extent_buffer *eb, unsigned long offset,
291 		      unsigned long min_len, char **map,
292 		      unsigned long *map_start,
293 		      unsigned long *map_len);
294 int extent_range_uptodate(struct extent_io_tree *tree,
295 			  u64 start, u64 end);
296 int extent_clear_unlock_delalloc(struct inode *inode,
297 				struct extent_io_tree *tree,
298 				u64 start, u64 end, struct page *locked_page,
299 				unsigned long op);
300 struct bio *
301 btrfs_bio_alloc(struct block_device *bdev, u64 first_sector, int nr_vecs,
302 		gfp_t gfp_flags);
303 #endif
304