1 // SPDX-License-Identifier: GPL-2.0
3 * Zoned block device handling
5 * Copyright (c) 2015, Hannes Reinecke
6 * Copyright (c) 2015, SUSE Linux GmbH
8 * Copyright (c) 2016, Damien Le Moal
9 * Copyright (c) 2016, Western Digital
12 #include <linux/kernel.h>
13 #include <linux/module.h>
14 #include <linux/rbtree.h>
15 #include <linux/blkdev.h>
16 #include <linux/blk-mq.h>
18 #include <linux/vmalloc.h>
19 #include <linux/sched/mm.h>
23 #define ZONE_COND_NAME(name) [BLK_ZONE_COND_##name] = #name
24 static const char *const zone_cond_name[] = {
25 ZONE_COND_NAME(NOT_WP),
26 ZONE_COND_NAME(EMPTY),
27 ZONE_COND_NAME(IMP_OPEN),
28 ZONE_COND_NAME(EXP_OPEN),
29 ZONE_COND_NAME(CLOSED),
30 ZONE_COND_NAME(READONLY),
32 ZONE_COND_NAME(OFFLINE),
37 * blk_zone_cond_str - Return string XXX in BLK_ZONE_COND_XXX.
38 * @zone_cond: BLK_ZONE_COND_XXX.
40 * Description: Centralize block layer function to convert BLK_ZONE_COND_XXX
41 * into string format. Useful in the debugging and tracing zone conditions. For
42 * invalid BLK_ZONE_COND_XXX it returns string "UNKNOWN".
44 const char *blk_zone_cond_str(enum blk_zone_cond zone_cond)
46 static const char *zone_cond_str = "UNKNOWN";
48 if (zone_cond < ARRAY_SIZE(zone_cond_name) && zone_cond_name[zone_cond])
49 zone_cond_str = zone_cond_name[zone_cond];
53 EXPORT_SYMBOL_GPL(blk_zone_cond_str);
56 * Return true if a request is a write requests that needs zone write locking.
58 bool blk_req_needs_zone_write_lock(struct request *rq)
60 if (!rq->q->seq_zones_wlock)
63 if (blk_rq_is_passthrough(rq))
67 case REQ_OP_WRITE_ZEROES:
68 case REQ_OP_WRITE_SAME:
70 return blk_rq_zone_is_seq(rq);
75 EXPORT_SYMBOL_GPL(blk_req_needs_zone_write_lock);
77 bool blk_req_zone_write_trylock(struct request *rq)
79 unsigned int zno = blk_rq_zone_no(rq);
81 if (test_and_set_bit(zno, rq->q->seq_zones_wlock))
84 WARN_ON_ONCE(rq->rq_flags & RQF_ZONE_WRITE_LOCKED);
85 rq->rq_flags |= RQF_ZONE_WRITE_LOCKED;
89 EXPORT_SYMBOL_GPL(blk_req_zone_write_trylock);
91 void __blk_req_zone_write_lock(struct request *rq)
93 if (WARN_ON_ONCE(test_and_set_bit(blk_rq_zone_no(rq),
94 rq->q->seq_zones_wlock)))
97 WARN_ON_ONCE(rq->rq_flags & RQF_ZONE_WRITE_LOCKED);
98 rq->rq_flags |= RQF_ZONE_WRITE_LOCKED;
100 EXPORT_SYMBOL_GPL(__blk_req_zone_write_lock);
102 void __blk_req_zone_write_unlock(struct request *rq)
104 rq->rq_flags &= ~RQF_ZONE_WRITE_LOCKED;
105 if (rq->q->seq_zones_wlock)
106 WARN_ON_ONCE(!test_and_clear_bit(blk_rq_zone_no(rq),
107 rq->q->seq_zones_wlock));
109 EXPORT_SYMBOL_GPL(__blk_req_zone_write_unlock);
112 * blkdev_nr_zones - Get number of zones
113 * @disk: Target gendisk
115 * Return the total number of zones of a zoned block device. For a block
116 * device without zone capabilities, the number of zones is always 0.
118 unsigned int blkdev_nr_zones(struct gendisk *disk)
120 sector_t zone_sectors = blk_queue_zone_sectors(disk->queue);
122 if (!blk_queue_is_zoned(disk->queue))
124 return (get_capacity(disk) + zone_sectors - 1) >> ilog2(zone_sectors);
126 EXPORT_SYMBOL_GPL(blkdev_nr_zones);
129 * blkdev_report_zones - Get zones information
130 * @bdev: Target block device
131 * @sector: Sector from which to report zones
132 * @nr_zones: Maximum number of zones to report
133 * @cb: Callback function called for each reported zone
134 * @data: Private data for the callback
137 * Get zone information starting from the zone containing @sector for at most
138 * @nr_zones, and call @cb for each zone reported by the device.
139 * To report all zones in a device starting from @sector, the BLK_ALL_ZONES
140 * constant can be passed to @nr_zones.
141 * Returns the number of zones reported by the device, or a negative errno
142 * value in case of failure.
144 * Note: The caller must use memalloc_noXX_save/restore() calls to control
145 * memory allocations done within this function.
147 int blkdev_report_zones(struct block_device *bdev, sector_t sector,
148 unsigned int nr_zones, report_zones_cb cb, void *data)
150 struct gendisk *disk = bdev->bd_disk;
151 sector_t capacity = get_capacity(disk);
153 if (!blk_queue_is_zoned(bdev_get_queue(bdev)) ||
154 WARN_ON_ONCE(!disk->fops->report_zones))
157 if (!nr_zones || sector >= capacity)
160 return disk->fops->report_zones(disk, sector, nr_zones, cb, data);
162 EXPORT_SYMBOL_GPL(blkdev_report_zones);
164 static inline unsigned long *blk_alloc_zone_bitmap(int node,
165 unsigned int nr_zones)
167 return kcalloc_node(BITS_TO_LONGS(nr_zones), sizeof(unsigned long),
171 static int blk_zone_need_reset_cb(struct blk_zone *zone, unsigned int idx,
175 * For an all-zones reset, ignore conventional, empty, read-only
178 switch (zone->cond) {
179 case BLK_ZONE_COND_NOT_WP:
180 case BLK_ZONE_COND_EMPTY:
181 case BLK_ZONE_COND_READONLY:
182 case BLK_ZONE_COND_OFFLINE:
185 set_bit(idx, (unsigned long *)data);
190 static int blkdev_zone_reset_all_emulated(struct block_device *bdev,
193 struct request_queue *q = bdev_get_queue(bdev);
194 sector_t capacity = get_capacity(bdev->bd_disk);
195 sector_t zone_sectors = blk_queue_zone_sectors(q);
196 unsigned long *need_reset;
197 struct bio *bio = NULL;
201 need_reset = blk_alloc_zone_bitmap(q->node, q->nr_zones);
205 ret = bdev->bd_disk->fops->report_zones(bdev->bd_disk, 0,
206 q->nr_zones, blk_zone_need_reset_cb,
209 goto out_free_need_reset;
212 while (sector < capacity) {
213 if (!test_bit(blk_queue_zone_no(q, sector), need_reset)) {
214 sector += zone_sectors;
218 bio = blk_next_bio(bio, bdev, 0, REQ_OP_ZONE_RESET | REQ_SYNC,
220 bio->bi_iter.bi_sector = sector;
221 sector += zone_sectors;
223 /* This may take a while, so be nice to others */
228 ret = submit_bio_wait(bio);
237 static int blkdev_zone_reset_all(struct block_device *bdev, gfp_t gfp_mask)
241 bio_init(&bio, bdev, NULL, 0, REQ_OP_ZONE_RESET_ALL | REQ_SYNC);
242 return submit_bio_wait(&bio);
246 * blkdev_zone_mgmt - Execute a zone management operation on a range of zones
247 * @bdev: Target block device
248 * @op: Operation to be performed on the zones
249 * @sector: Start sector of the first zone to operate on
250 * @nr_sectors: Number of sectors, should be at least the length of one zone and
251 * must be zone size aligned.
252 * @gfp_mask: Memory allocation flags (for bio_alloc)
255 * Perform the specified operation on the range of zones specified by
256 * @sector..@sector+@nr_sectors. Specifying the entire disk sector range
257 * is valid, but the specified range should not contain conventional zones.
258 * The operation to execute on each zone can be a zone reset, open, close
261 int blkdev_zone_mgmt(struct block_device *bdev, enum req_opf op,
262 sector_t sector, sector_t nr_sectors,
265 struct request_queue *q = bdev_get_queue(bdev);
266 sector_t zone_sectors = blk_queue_zone_sectors(q);
267 sector_t capacity = get_capacity(bdev->bd_disk);
268 sector_t end_sector = sector + nr_sectors;
269 struct bio *bio = NULL;
272 if (!blk_queue_is_zoned(q))
275 if (bdev_read_only(bdev))
278 if (!op_is_zone_mgmt(op))
281 if (end_sector <= sector || end_sector > capacity)
285 /* Check alignment (handle eventual smaller last zone) */
286 if (sector & (zone_sectors - 1))
289 if ((nr_sectors & (zone_sectors - 1)) && end_sector != capacity)
293 * In the case of a zone reset operation over all zones,
294 * REQ_OP_ZONE_RESET_ALL can be used with devices supporting this
295 * command. For other devices, we emulate this command behavior by
296 * identifying the zones needing a reset.
298 if (op == REQ_OP_ZONE_RESET && sector == 0 && nr_sectors == capacity) {
299 if (!blk_queue_zone_resetall(q))
300 return blkdev_zone_reset_all_emulated(bdev, gfp_mask);
301 return blkdev_zone_reset_all(bdev, gfp_mask);
304 while (sector < end_sector) {
305 bio = blk_next_bio(bio, bdev, 0, op | REQ_SYNC, gfp_mask);
306 bio->bi_iter.bi_sector = sector;
307 sector += zone_sectors;
309 /* This may take a while, so be nice to others */
313 ret = submit_bio_wait(bio);
318 EXPORT_SYMBOL_GPL(blkdev_zone_mgmt);
320 struct zone_report_args {
321 struct blk_zone __user *zones;
324 static int blkdev_copy_zone_to_user(struct blk_zone *zone, unsigned int idx,
327 struct zone_report_args *args = data;
329 if (copy_to_user(&args->zones[idx], zone, sizeof(struct blk_zone)))
335 * BLKREPORTZONE ioctl processing.
336 * Called from blkdev_ioctl.
338 int blkdev_report_zones_ioctl(struct block_device *bdev, fmode_t mode,
339 unsigned int cmd, unsigned long arg)
341 void __user *argp = (void __user *)arg;
342 struct zone_report_args args;
343 struct request_queue *q;
344 struct blk_zone_report rep;
350 q = bdev_get_queue(bdev);
354 if (!blk_queue_is_zoned(q))
357 if (copy_from_user(&rep, argp, sizeof(struct blk_zone_report)))
363 args.zones = argp + sizeof(struct blk_zone_report);
364 ret = blkdev_report_zones(bdev, rep.sector, rep.nr_zones,
365 blkdev_copy_zone_to_user, &args);
370 rep.flags = BLK_ZONE_REP_CAPACITY;
371 if (copy_to_user(argp, &rep, sizeof(struct blk_zone_report)))
376 static int blkdev_truncate_zone_range(struct block_device *bdev, fmode_t mode,
377 const struct blk_zone_range *zrange)
381 if (zrange->sector + zrange->nr_sectors <= zrange->sector ||
382 zrange->sector + zrange->nr_sectors > get_capacity(bdev->bd_disk))
386 start = zrange->sector << SECTOR_SHIFT;
387 end = ((zrange->sector + zrange->nr_sectors) << SECTOR_SHIFT) - 1;
389 return truncate_bdev_range(bdev, mode, start, end);
393 * BLKRESETZONE, BLKOPENZONE, BLKCLOSEZONE and BLKFINISHZONE ioctl processing.
394 * Called from blkdev_ioctl.
396 int blkdev_zone_mgmt_ioctl(struct block_device *bdev, fmode_t mode,
397 unsigned int cmd, unsigned long arg)
399 void __user *argp = (void __user *)arg;
400 struct request_queue *q;
401 struct blk_zone_range zrange;
408 q = bdev_get_queue(bdev);
412 if (!blk_queue_is_zoned(q))
415 if (!(mode & FMODE_WRITE))
418 if (copy_from_user(&zrange, argp, sizeof(struct blk_zone_range)))
423 op = REQ_OP_ZONE_RESET;
425 /* Invalidate the page cache, including dirty pages. */
426 filemap_invalidate_lock(bdev->bd_inode->i_mapping);
427 ret = blkdev_truncate_zone_range(bdev, mode, &zrange);
432 op = REQ_OP_ZONE_OPEN;
435 op = REQ_OP_ZONE_CLOSE;
438 op = REQ_OP_ZONE_FINISH;
444 ret = blkdev_zone_mgmt(bdev, op, zrange.sector, zrange.nr_sectors,
448 if (cmd == BLKRESETZONE)
449 filemap_invalidate_unlock(bdev->bd_inode->i_mapping);
454 void blk_queue_free_zone_bitmaps(struct request_queue *q)
456 kfree(q->conv_zones_bitmap);
457 q->conv_zones_bitmap = NULL;
458 kfree(q->seq_zones_wlock);
459 q->seq_zones_wlock = NULL;
462 struct blk_revalidate_zone_args {
463 struct gendisk *disk;
464 unsigned long *conv_zones_bitmap;
465 unsigned long *seq_zones_wlock;
466 unsigned int nr_zones;
467 sector_t zone_sectors;
472 * Helper function to check the validity of zones of a zoned block device.
474 static int blk_revalidate_zone_cb(struct blk_zone *zone, unsigned int idx,
477 struct blk_revalidate_zone_args *args = data;
478 struct gendisk *disk = args->disk;
479 struct request_queue *q = disk->queue;
480 sector_t capacity = get_capacity(disk);
483 * All zones must have the same size, with the exception on an eventual
486 if (zone->start == 0) {
487 if (zone->len == 0 || !is_power_of_2(zone->len)) {
488 pr_warn("%s: Invalid zoned device with non power of two zone size (%llu)\n",
489 disk->disk_name, zone->len);
493 args->zone_sectors = zone->len;
494 args->nr_zones = (capacity + zone->len - 1) >> ilog2(zone->len);
495 } else if (zone->start + args->zone_sectors < capacity) {
496 if (zone->len != args->zone_sectors) {
497 pr_warn("%s: Invalid zoned device with non constant zone size\n",
502 if (zone->len > args->zone_sectors) {
503 pr_warn("%s: Invalid zoned device with larger last zone size\n",
509 /* Check for holes in the zone report */
510 if (zone->start != args->sector) {
511 pr_warn("%s: Zone gap at sectors %llu..%llu\n",
512 disk->disk_name, args->sector, zone->start);
516 /* Check zone type */
517 switch (zone->type) {
518 case BLK_ZONE_TYPE_CONVENTIONAL:
519 if (!args->conv_zones_bitmap) {
520 args->conv_zones_bitmap =
521 blk_alloc_zone_bitmap(q->node, args->nr_zones);
522 if (!args->conv_zones_bitmap)
525 set_bit(idx, args->conv_zones_bitmap);
527 case BLK_ZONE_TYPE_SEQWRITE_REQ:
528 case BLK_ZONE_TYPE_SEQWRITE_PREF:
529 if (!args->seq_zones_wlock) {
530 args->seq_zones_wlock =
531 blk_alloc_zone_bitmap(q->node, args->nr_zones);
532 if (!args->seq_zones_wlock)
537 pr_warn("%s: Invalid zone type 0x%x at sectors %llu\n",
538 disk->disk_name, (int)zone->type, zone->start);
542 args->sector += zone->len;
547 * blk_revalidate_disk_zones - (re)allocate and initialize zone bitmaps
549 * @update_driver_data: Callback to update driver data on the frozen disk
551 * Helper function for low-level device drivers to (re) allocate and initialize
552 * a disk request queue zone bitmaps. This functions should normally be called
553 * within the disk ->revalidate method for blk-mq based drivers. For BIO based
554 * drivers only q->nr_zones needs to be updated so that the sysfs exposed value
556 * If the @update_driver_data callback function is not NULL, the callback is
557 * executed with the device request queue frozen after all zones have been
560 int blk_revalidate_disk_zones(struct gendisk *disk,
561 void (*update_driver_data)(struct gendisk *disk))
563 struct request_queue *q = disk->queue;
564 struct blk_revalidate_zone_args args = {
567 unsigned int noio_flag;
570 if (WARN_ON_ONCE(!blk_queue_is_zoned(q)))
572 if (WARN_ON_ONCE(!queue_is_mq(q)))
575 if (!get_capacity(disk))
579 * Ensure that all memory allocations in this context are done as if
580 * GFP_NOIO was specified.
582 noio_flag = memalloc_noio_save();
583 ret = disk->fops->report_zones(disk, 0, UINT_MAX,
584 blk_revalidate_zone_cb, &args);
586 pr_warn("%s: No zones reported\n", disk->disk_name);
589 memalloc_noio_restore(noio_flag);
592 * If zones where reported, make sure that the entire disk capacity
595 if (ret > 0 && args.sector != get_capacity(disk)) {
596 pr_warn("%s: Missing zones from sector %llu\n",
597 disk->disk_name, args.sector);
602 * Install the new bitmaps and update nr_zones only once the queue is
603 * stopped and all I/Os are completed (i.e. a scheduler is not
604 * referencing the bitmaps).
606 blk_mq_freeze_queue(q);
608 blk_queue_chunk_sectors(q, args.zone_sectors);
609 q->nr_zones = args.nr_zones;
610 swap(q->seq_zones_wlock, args.seq_zones_wlock);
611 swap(q->conv_zones_bitmap, args.conv_zones_bitmap);
612 if (update_driver_data)
613 update_driver_data(disk);
616 pr_warn("%s: failed to revalidate zones\n", disk->disk_name);
617 blk_queue_free_zone_bitmaps(q);
619 blk_mq_unfreeze_queue(q);
621 kfree(args.seq_zones_wlock);
622 kfree(args.conv_zones_bitmap);
625 EXPORT_SYMBOL_GPL(blk_revalidate_disk_zones);
627 void blk_queue_clear_zone_settings(struct request_queue *q)
629 blk_mq_freeze_queue(q);
631 blk_queue_free_zone_bitmaps(q);
632 blk_queue_flag_clear(QUEUE_FLAG_ZONE_RESETALL, q);
633 q->required_elevator_features &= ~ELEVATOR_F_ZBD_SEQ_WRITE;
635 q->max_open_zones = 0;
636 q->max_active_zones = 0;
637 q->limits.chunk_sectors = 0;
638 q->limits.zone_write_granularity = 0;
639 q->limits.max_zone_append_sectors = 0;
641 blk_mq_unfreeze_queue(q);