xref: /openbmc/linux/fs/btrfs/zoned.h (revision 465191d6)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 
3 #ifndef BTRFS_ZONED_H
4 #define BTRFS_ZONED_H
5 
6 #include <linux/types.h>
7 #include <linux/blkdev.h>
8 #include "volumes.h"
9 #include "disk-io.h"
10 #include "block-group.h"
11 #include "btrfs_inode.h"
12 
13 #define BTRFS_DEFAULT_RECLAIM_THRESH           			(75)
14 
15 struct btrfs_zoned_device_info {
16 	/*
17 	 * Number of zones, zone size and types of zones if bdev is a
18 	 * zoned block device.
19 	 */
20 	u64 zone_size;
21 	u8  zone_size_shift;
22 	u32 nr_zones;
23 	unsigned int max_active_zones;
24 	atomic_t active_zones_left;
25 	unsigned long *seq_zones;
26 	unsigned long *empty_zones;
27 	unsigned long *active_zones;
28 	struct blk_zone *zone_cache;
29 	struct blk_zone sb_zones[2 * BTRFS_SUPER_MIRROR_MAX];
30 };
31 
32 #ifdef CONFIG_BLK_DEV_ZONED
33 int btrfs_get_dev_zone(struct btrfs_device *device, u64 pos,
34 		       struct blk_zone *zone);
35 int btrfs_get_dev_zone_info_all_devices(struct btrfs_fs_info *fs_info);
36 int btrfs_get_dev_zone_info(struct btrfs_device *device, bool populate_cache);
37 void btrfs_destroy_dev_zone_info(struct btrfs_device *device);
38 int btrfs_check_zoned_mode(struct btrfs_fs_info *fs_info);
39 int btrfs_check_mountopts_zoned(struct btrfs_fs_info *info);
40 int btrfs_sb_log_location_bdev(struct block_device *bdev, int mirror, int rw,
41 			       u64 *bytenr_ret);
42 int btrfs_sb_log_location(struct btrfs_device *device, int mirror, int rw,
43 			  u64 *bytenr_ret);
44 int btrfs_advance_sb_log(struct btrfs_device *device, int mirror);
45 int btrfs_reset_sb_log_zones(struct block_device *bdev, int mirror);
46 u64 btrfs_find_allocatable_zones(struct btrfs_device *device, u64 hole_start,
47 				 u64 hole_end, u64 num_bytes);
48 int btrfs_reset_device_zone(struct btrfs_device *device, u64 physical,
49 			    u64 length, u64 *bytes);
50 int btrfs_ensure_empty_zones(struct btrfs_device *device, u64 start, u64 size);
51 int btrfs_load_block_group_zone_info(struct btrfs_block_group *cache, bool new);
52 void btrfs_calc_zone_unusable(struct btrfs_block_group *cache);
53 void btrfs_redirty_list_add(struct btrfs_transaction *trans,
54 			    struct extent_buffer *eb);
55 void btrfs_free_redirty_list(struct btrfs_transaction *trans);
56 bool btrfs_use_zone_append(struct btrfs_inode *inode, u64 start);
57 void btrfs_record_physical_zoned(struct inode *inode, u64 file_offset,
58 				 struct bio *bio);
59 void btrfs_rewrite_logical_zoned(struct btrfs_ordered_extent *ordered);
60 bool btrfs_check_meta_write_pointer(struct btrfs_fs_info *fs_info,
61 				    struct extent_buffer *eb,
62 				    struct btrfs_block_group **cache_ret);
63 void btrfs_revert_meta_write_pointer(struct btrfs_block_group *cache,
64 				     struct extent_buffer *eb);
65 int btrfs_zoned_issue_zeroout(struct btrfs_device *device, u64 physical, u64 length);
66 int btrfs_sync_zone_write_pointer(struct btrfs_device *tgt_dev, u64 logical,
67 				  u64 physical_start, u64 physical_pos);
68 struct btrfs_device *btrfs_zoned_get_device(struct btrfs_fs_info *fs_info,
69 					    u64 logical, u64 length);
70 bool btrfs_zone_activate(struct btrfs_block_group *block_group);
71 int btrfs_zone_finish(struct btrfs_block_group *block_group);
72 bool btrfs_can_activate_zone(struct btrfs_fs_devices *fs_devices, u64 flags);
73 void btrfs_zone_finish_endio(struct btrfs_fs_info *fs_info, u64 logical,
74 			     u64 length);
75 void btrfs_schedule_zone_finish_bg(struct btrfs_block_group *bg,
76 				   struct extent_buffer *eb);
77 void btrfs_clear_data_reloc_bg(struct btrfs_block_group *bg);
78 void btrfs_free_zone_cache(struct btrfs_fs_info *fs_info);
79 bool btrfs_zoned_should_reclaim(struct btrfs_fs_info *fs_info);
80 #else /* CONFIG_BLK_DEV_ZONED */
81 static inline int btrfs_get_dev_zone(struct btrfs_device *device, u64 pos,
82 				     struct blk_zone *zone)
83 {
84 	return 0;
85 }
86 
87 static inline int btrfs_get_dev_zone_info_all_devices(struct btrfs_fs_info *fs_info)
88 {
89 	return 0;
90 }
91 
92 static inline int btrfs_get_dev_zone_info(struct btrfs_device *device,
93 					  bool populate_cache)
94 {
95 	return 0;
96 }
97 
98 static inline void btrfs_destroy_dev_zone_info(struct btrfs_device *device) { }
99 
100 static inline int btrfs_check_zoned_mode(const struct btrfs_fs_info *fs_info)
101 {
102 	if (!btrfs_is_zoned(fs_info))
103 		return 0;
104 
105 	btrfs_err(fs_info, "zoned block devices support is not enabled");
106 	return -EOPNOTSUPP;
107 }
108 
109 static inline int btrfs_check_mountopts_zoned(struct btrfs_fs_info *info)
110 {
111 	return 0;
112 }
113 
114 static inline int btrfs_sb_log_location_bdev(struct block_device *bdev,
115 					     int mirror, int rw, u64 *bytenr_ret)
116 {
117 	*bytenr_ret = btrfs_sb_offset(mirror);
118 	return 0;
119 }
120 
121 static inline int btrfs_sb_log_location(struct btrfs_device *device, int mirror,
122 					int rw, u64 *bytenr_ret)
123 {
124 	*bytenr_ret = btrfs_sb_offset(mirror);
125 	return 0;
126 }
127 
128 static inline int btrfs_advance_sb_log(struct btrfs_device *device, int mirror)
129 {
130 	return 0;
131 }
132 
133 static inline int btrfs_reset_sb_log_zones(struct block_device *bdev, int mirror)
134 {
135 	return 0;
136 }
137 
138 static inline u64 btrfs_find_allocatable_zones(struct btrfs_device *device,
139 					       u64 hole_start, u64 hole_end,
140 					       u64 num_bytes)
141 {
142 	return hole_start;
143 }
144 
145 static inline int btrfs_reset_device_zone(struct btrfs_device *device,
146 					  u64 physical, u64 length, u64 *bytes)
147 {
148 	*bytes = 0;
149 	return 0;
150 }
151 
152 static inline int btrfs_ensure_empty_zones(struct btrfs_device *device,
153 					   u64 start, u64 size)
154 {
155 	return 0;
156 }
157 
158 static inline int btrfs_load_block_group_zone_info(
159 		struct btrfs_block_group *cache, bool new)
160 {
161 	return 0;
162 }
163 
164 static inline void btrfs_calc_zone_unusable(struct btrfs_block_group *cache) { }
165 
166 static inline void btrfs_redirty_list_add(struct btrfs_transaction *trans,
167 					  struct extent_buffer *eb) { }
168 static inline void btrfs_free_redirty_list(struct btrfs_transaction *trans) { }
169 
170 static inline bool btrfs_use_zone_append(struct btrfs_inode *inode, u64 start)
171 {
172 	return false;
173 }
174 
175 static inline void btrfs_record_physical_zoned(struct inode *inode,
176 					       u64 file_offset, struct bio *bio)
177 {
178 }
179 
180 static inline void btrfs_rewrite_logical_zoned(
181 				struct btrfs_ordered_extent *ordered) { }
182 
183 static inline bool btrfs_check_meta_write_pointer(struct btrfs_fs_info *fs_info,
184 			       struct extent_buffer *eb,
185 			       struct btrfs_block_group **cache_ret)
186 {
187 	return true;
188 }
189 
190 static inline void btrfs_revert_meta_write_pointer(
191 						struct btrfs_block_group *cache,
192 						struct extent_buffer *eb)
193 {
194 }
195 
196 static inline int btrfs_zoned_issue_zeroout(struct btrfs_device *device,
197 					    u64 physical, u64 length)
198 {
199 	return -EOPNOTSUPP;
200 }
201 
202 static inline int btrfs_sync_zone_write_pointer(struct btrfs_device *tgt_dev,
203 						u64 logical, u64 physical_start,
204 						u64 physical_pos)
205 {
206 	return -EOPNOTSUPP;
207 }
208 
209 static inline struct btrfs_device *btrfs_zoned_get_device(
210 						  struct btrfs_fs_info *fs_info,
211 						  u64 logical, u64 length)
212 {
213 	return ERR_PTR(-EOPNOTSUPP);
214 }
215 
216 static inline bool btrfs_zone_activate(struct btrfs_block_group *block_group)
217 {
218 	return true;
219 }
220 
221 static inline int btrfs_zone_finish(struct btrfs_block_group *block_group)
222 {
223 	return 0;
224 }
225 
226 static inline bool btrfs_can_activate_zone(struct btrfs_fs_devices *fs_devices,
227 					   u64 flags)
228 {
229 	return true;
230 }
231 
232 static inline void btrfs_zone_finish_endio(struct btrfs_fs_info *fs_info,
233 					   u64 logical, u64 length) { }
234 
235 static inline void btrfs_schedule_zone_finish_bg(struct btrfs_block_group *bg,
236 						 struct extent_buffer *eb) { }
237 
238 static inline void btrfs_clear_data_reloc_bg(struct btrfs_block_group *bg) { }
239 
240 static inline void btrfs_free_zone_cache(struct btrfs_fs_info *fs_info) { }
241 
242 static inline bool btrfs_zoned_should_reclaim(struct btrfs_fs_info *fs_info)
243 {
244 	return false;
245 }
246 #endif
247 
248 static inline bool btrfs_dev_is_sequential(struct btrfs_device *device, u64 pos)
249 {
250 	struct btrfs_zoned_device_info *zone_info = device->zone_info;
251 
252 	if (!zone_info)
253 		return false;
254 
255 	return test_bit(pos >> zone_info->zone_size_shift, zone_info->seq_zones);
256 }
257 
258 static inline bool btrfs_dev_is_empty_zone(struct btrfs_device *device, u64 pos)
259 {
260 	struct btrfs_zoned_device_info *zone_info = device->zone_info;
261 
262 	if (!zone_info)
263 		return true;
264 
265 	return test_bit(pos >> zone_info->zone_size_shift, zone_info->empty_zones);
266 }
267 
268 static inline void btrfs_dev_set_empty_zone_bit(struct btrfs_device *device,
269 						u64 pos, bool set)
270 {
271 	struct btrfs_zoned_device_info *zone_info = device->zone_info;
272 	unsigned int zno;
273 
274 	if (!zone_info)
275 		return;
276 
277 	zno = pos >> zone_info->zone_size_shift;
278 	if (set)
279 		set_bit(zno, zone_info->empty_zones);
280 	else
281 		clear_bit(zno, zone_info->empty_zones);
282 }
283 
284 static inline void btrfs_dev_set_zone_empty(struct btrfs_device *device, u64 pos)
285 {
286 	btrfs_dev_set_empty_zone_bit(device, pos, true);
287 }
288 
289 static inline void btrfs_dev_clear_zone_empty(struct btrfs_device *device, u64 pos)
290 {
291 	btrfs_dev_set_empty_zone_bit(device, pos, false);
292 }
293 
294 static inline bool btrfs_check_device_zone_type(const struct btrfs_fs_info *fs_info,
295 						struct block_device *bdev)
296 {
297 	if (btrfs_is_zoned(fs_info)) {
298 		/*
299 		 * We can allow a regular device on a zoned filesystem, because
300 		 * we will emulate the zoned capabilities.
301 		 */
302 		if (!bdev_is_zoned(bdev))
303 			return true;
304 
305 		return fs_info->zone_size ==
306 			(bdev_zone_sectors(bdev) << SECTOR_SHIFT);
307 	}
308 
309 	/* Do not allow Host Manged zoned device */
310 	return bdev_zoned_model(bdev) != BLK_ZONED_HM;
311 }
312 
313 static inline bool btrfs_check_super_location(struct btrfs_device *device, u64 pos)
314 {
315 	/*
316 	 * On a non-zoned device, any address is OK. On a zoned device,
317 	 * non-SEQUENTIAL WRITE REQUIRED zones are capable.
318 	 */
319 	return device->zone_info == NULL || !btrfs_dev_is_sequential(device, pos);
320 }
321 
322 static inline bool btrfs_can_zone_reset(struct btrfs_device *device,
323 					u64 physical, u64 length)
324 {
325 	u64 zone_size;
326 
327 	if (!btrfs_dev_is_sequential(device, physical))
328 		return false;
329 
330 	zone_size = device->zone_info->zone_size;
331 	if (!IS_ALIGNED(physical, zone_size) || !IS_ALIGNED(length, zone_size))
332 		return false;
333 
334 	return true;
335 }
336 
337 static inline void btrfs_zoned_meta_io_lock(struct btrfs_fs_info *fs_info)
338 {
339 	if (!btrfs_is_zoned(fs_info))
340 		return;
341 	mutex_lock(&fs_info->zoned_meta_io_lock);
342 }
343 
344 static inline void btrfs_zoned_meta_io_unlock(struct btrfs_fs_info *fs_info)
345 {
346 	if (!btrfs_is_zoned(fs_info))
347 		return;
348 	mutex_unlock(&fs_info->zoned_meta_io_lock);
349 }
350 
351 static inline void btrfs_clear_treelog_bg(struct btrfs_block_group *bg)
352 {
353 	struct btrfs_fs_info *fs_info = bg->fs_info;
354 
355 	if (!btrfs_is_zoned(fs_info))
356 		return;
357 
358 	spin_lock(&fs_info->treelog_bg_lock);
359 	if (fs_info->treelog_bg == bg->start)
360 		fs_info->treelog_bg = 0;
361 	spin_unlock(&fs_info->treelog_bg_lock);
362 }
363 
364 static inline void btrfs_zoned_data_reloc_lock(struct btrfs_inode *inode)
365 {
366 	struct btrfs_root *root = inode->root;
367 
368 	if (btrfs_is_data_reloc_root(root) && btrfs_is_zoned(root->fs_info))
369 		mutex_lock(&root->fs_info->zoned_data_reloc_io_lock);
370 }
371 
372 static inline void btrfs_zoned_data_reloc_unlock(struct btrfs_inode *inode)
373 {
374 	struct btrfs_root *root = inode->root;
375 
376 	if (btrfs_is_data_reloc_root(root) && btrfs_is_zoned(root->fs_info))
377 		mutex_unlock(&root->fs_info->zoned_data_reloc_io_lock);
378 }
379 
380 static inline bool btrfs_zoned_bg_is_full(const struct btrfs_block_group *bg)
381 {
382 	ASSERT(btrfs_is_zoned(bg->fs_info));
383 	return (bg->alloc_offset == bg->zone_capacity);
384 }
385 
386 #endif
387