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