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