block: Simplify REQ_OP_ZONE_RESET_ALL handling
[linux-block.git] / block / blk-zoned.c
CommitLineData
3dcf60bc 1// SPDX-License-Identifier: GPL-2.0
6a0cb1bc
HR
2/*
3 * Zoned block device handling
4 *
5 * Copyright (c) 2015, Hannes Reinecke
6 * Copyright (c) 2015, SUSE Linux GmbH
7 *
8 * Copyright (c) 2016, Damien Le Moal
9 * Copyright (c) 2016, Western Digital
10 */
11
12#include <linux/kernel.h>
13#include <linux/module.h>
14#include <linux/rbtree.h>
15#include <linux/blkdev.h>
bf505456 16#include <linux/blk-mq.h>
26202928
DLM
17#include <linux/mm.h>
18#include <linux/vmalloc.h>
bd976e52 19#include <linux/sched/mm.h>
6a0cb1bc 20
a2d6b3a2
DLM
21#include "blk.h"
22
6a0cb1bc
HR
23static inline sector_t blk_zone_start(struct request_queue *q,
24 sector_t sector)
25{
f99e8648 26 sector_t zone_mask = blk_queue_zone_sectors(q) - 1;
6a0cb1bc
HR
27
28 return sector & ~zone_mask;
29}
30
6cc77e9c
CH
31/*
32 * Return true if a request is a write requests that needs zone write locking.
33 */
34bool blk_req_needs_zone_write_lock(struct request *rq)
35{
36 if (!rq->q->seq_zones_wlock)
37 return false;
38
39 if (blk_rq_is_passthrough(rq))
40 return false;
41
42 switch (req_op(rq)) {
43 case REQ_OP_WRITE_ZEROES:
44 case REQ_OP_WRITE_SAME:
45 case REQ_OP_WRITE:
46 return blk_rq_zone_is_seq(rq);
47 default:
48 return false;
49 }
50}
51EXPORT_SYMBOL_GPL(blk_req_needs_zone_write_lock);
52
53void __blk_req_zone_write_lock(struct request *rq)
54{
55 if (WARN_ON_ONCE(test_and_set_bit(blk_rq_zone_no(rq),
56 rq->q->seq_zones_wlock)))
57 return;
58
59 WARN_ON_ONCE(rq->rq_flags & RQF_ZONE_WRITE_LOCKED);
60 rq->rq_flags |= RQF_ZONE_WRITE_LOCKED;
61}
62EXPORT_SYMBOL_GPL(__blk_req_zone_write_lock);
63
64void __blk_req_zone_write_unlock(struct request *rq)
65{
66 rq->rq_flags &= ~RQF_ZONE_WRITE_LOCKED;
67 if (rq->q->seq_zones_wlock)
68 WARN_ON_ONCE(!test_and_clear_bit(blk_rq_zone_no(rq),
69 rq->q->seq_zones_wlock));
70}
71EXPORT_SYMBOL_GPL(__blk_req_zone_write_unlock);
72
a91e1380
DLM
73static inline unsigned int __blkdev_nr_zones(struct request_queue *q,
74 sector_t nr_sectors)
75{
113ab72e 76 sector_t zone_sectors = blk_queue_zone_sectors(q);
a91e1380
DLM
77
78 return (nr_sectors + zone_sectors - 1) >> ilog2(zone_sectors);
79}
80
81/**
82 * blkdev_nr_zones - Get number of zones
83 * @bdev: Target block device
84 *
85 * Description:
86 * Return the total number of zones of a zoned block device.
87 * For a regular block device, the number of zones is always 0.
88 */
89unsigned int blkdev_nr_zones(struct block_device *bdev)
90{
91 struct request_queue *q = bdev_get_queue(bdev);
92
93 if (!blk_queue_is_zoned(q))
94 return 0;
95
96 return __blkdev_nr_zones(q, bdev->bd_part->nr_sects);
97}
98EXPORT_SYMBOL_GPL(blkdev_nr_zones);
99
6a0cb1bc 100/*
e76239a3
CH
101 * Check that a zone report belongs to this partition, and if yes, fix its start
102 * sector and write pointer and return true. Return false otherwise.
6a0cb1bc 103 */
e76239a3 104static bool blkdev_report_zone(struct block_device *bdev, struct blk_zone *rep)
6a0cb1bc
HR
105{
106 sector_t offset = get_start_sect(bdev);
107
108 if (rep->start < offset)
109 return false;
110
111 rep->start -= offset;
112 if (rep->start + rep->len > bdev->bd_part->nr_sects)
113 return false;
114
115 if (rep->type == BLK_ZONE_TYPE_CONVENTIONAL)
116 rep->wp = rep->start + rep->len;
117 else
118 rep->wp -= offset;
6a0cb1bc
HR
119 return true;
120}
121
e76239a3 122static int blk_report_zones(struct gendisk *disk, sector_t sector,
bd976e52 123 struct blk_zone *zones, unsigned int *nr_zones)
e76239a3
CH
124{
125 struct request_queue *q = disk->queue;
126 unsigned int z = 0, n, nrz = *nr_zones;
127 sector_t capacity = get_capacity(disk);
128 int ret;
129
130 while (z < nrz && sector < capacity) {
131 n = nrz - z;
bd976e52 132 ret = disk->fops->report_zones(disk, sector, &zones[z], &n);
e76239a3
CH
133 if (ret)
134 return ret;
135 if (!n)
136 break;
137 sector += blk_queue_zone_sectors(q) * n;
138 z += n;
139 }
140
141 WARN_ON(z > *nr_zones);
142 *nr_zones = z;
143
144 return 0;
145}
146
6a0cb1bc
HR
147/**
148 * blkdev_report_zones - Get zones information
149 * @bdev: Target block device
150 * @sector: Sector from which to report zones
151 * @zones: Array of zone structures where to return the zones information
152 * @nr_zones: Number of zone structures in the zone array
6a0cb1bc
HR
153 *
154 * Description:
155 * Get zone information starting from the zone containing @sector.
156 * The number of zone information reported may be less than the number
157 * requested by @nr_zones. The number of zones actually reported is
158 * returned in @nr_zones.
bd976e52
DLM
159 * The caller must use memalloc_noXX_save/restore() calls to control
160 * memory allocations done within this function (zone array and command
161 * buffer allocation by the device driver).
6a0cb1bc 162 */
e76239a3 163int blkdev_report_zones(struct block_device *bdev, sector_t sector,
bd976e52 164 struct blk_zone *zones, unsigned int *nr_zones)
6a0cb1bc
HR
165{
166 struct request_queue *q = bdev_get_queue(bdev);
e76239a3 167 unsigned int i, nrz;
3c4da758 168 int ret;
6a0cb1bc 169
6a0cb1bc
HR
170 if (!blk_queue_is_zoned(q))
171 return -EOPNOTSUPP;
172
e76239a3
CH
173 /*
174 * A block device that advertized itself as zoned must have a
175 * report_zones method. If it does not have one defined, the device
176 * driver has a bug. So warn about that.
177 */
178 if (WARN_ON_ONCE(!bdev->bd_disk->fops->report_zones))
179 return -EOPNOTSUPP;
6a0cb1bc 180
e76239a3 181 if (!*nr_zones || sector >= bdev->bd_part->nr_sects) {
6a0cb1bc
HR
182 *nr_zones = 0;
183 return 0;
184 }
185
e76239a3
CH
186 nrz = min(*nr_zones,
187 __blkdev_nr_zones(q, bdev->bd_part->nr_sects - sector));
188 ret = blk_report_zones(bdev->bd_disk, get_start_sect(bdev) + sector,
bd976e52 189 zones, &nrz);
6a0cb1bc 190 if (ret)
e76239a3 191 return ret;
6a0cb1bc 192
e76239a3
CH
193 for (i = 0; i < nrz; i++) {
194 if (!blkdev_report_zone(bdev, zones))
6a0cb1bc 195 break;
e76239a3 196 zones++;
6a0cb1bc
HR
197 }
198
e76239a3 199 *nr_zones = i;
6a0cb1bc 200
e76239a3 201 return 0;
6a0cb1bc
HR
202}
203EXPORT_SYMBOL_GPL(blkdev_report_zones);
204
6e33dbf2 205static inline bool blkdev_allow_reset_all_zones(struct block_device *bdev,
c7a1d926 206 sector_t sector,
6e33dbf2
CK
207 sector_t nr_sectors)
208{
209 if (!blk_queue_zone_resetall(bdev_get_queue(bdev)))
210 return false;
211
c7a1d926 212 if (sector || nr_sectors != part_nr_sects_read(bdev->bd_part))
6e33dbf2
CK
213 return false;
214 /*
215 * REQ_OP_ZONE_RESET_ALL can be executed only if the block device is
216 * the entire disk, that is, if the blocks device start offset is 0 and
217 * its capacity is the same as the entire disk.
218 */
219 return get_start_sect(bdev) == 0 &&
220 part_nr_sects_read(bdev->bd_part) == get_capacity(bdev->bd_disk);
221}
222
6a0cb1bc
HR
223/**
224 * blkdev_reset_zones - Reset zones write pointer
225 * @bdev: Target block device
226 * @sector: Start sector of the first zone to reset
227 * @nr_sectors: Number of sectors, at least the length of one zone
228 * @gfp_mask: Memory allocation flags (for bio_alloc)
229 *
230 * Description:
231 * Reset the write pointer of the zones contained in the range
232 * @sector..@sector+@nr_sectors. Specifying the entire disk sector range
233 * is valid, but the specified range should not contain conventional zones.
234 */
235int blkdev_reset_zones(struct block_device *bdev,
236 sector_t sector, sector_t nr_sectors,
237 gfp_t gfp_mask)
238{
239 struct request_queue *q = bdev_get_queue(bdev);
240 sector_t zone_sectors;
241 sector_t end_sector = sector + nr_sectors;
a2d6b3a2 242 struct bio *bio = NULL;
6a0cb1bc
HR
243 int ret;
244
6a0cb1bc
HR
245 if (!blk_queue_is_zoned(q))
246 return -EOPNOTSUPP;
247
a2d6b3a2
DLM
248 if (bdev_read_only(bdev))
249 return -EPERM;
250
251 if (!nr_sectors || end_sector > bdev->bd_part->nr_sects)
6a0cb1bc
HR
252 /* Out of range */
253 return -EINVAL;
254
255 /* Check alignment (handle eventual smaller last zone) */
f99e8648 256 zone_sectors = blk_queue_zone_sectors(q);
6a0cb1bc
HR
257 if (sector & (zone_sectors - 1))
258 return -EINVAL;
259
260 if ((nr_sectors & (zone_sectors - 1)) &&
261 end_sector != bdev->bd_part->nr_sects)
262 return -EINVAL;
263
264 while (sector < end_sector) {
a2d6b3a2 265 bio = blk_next_bio(bio, 0, gfp_mask);
74d46992 266 bio_set_dev(bio, bdev);
6a0cb1bc 267
c7a1d926
DLM
268 /*
269 * Special case for the zone reset operation that reset all
270 * zones, this is useful for applications like mkfs.
271 */
272 if (blkdev_allow_reset_all_zones(bdev, sector, nr_sectors)) {
273 bio->bi_opf = REQ_OP_ZONE_RESET_ALL;
274 break;
275 }
276
277 bio->bi_opf = REQ_OP_ZONE_RESET;
278 bio->bi_iter.bi_sector = sector;
6a0cb1bc
HR
279 sector += zone_sectors;
280
281 /* This may take a while, so be nice to others */
282 cond_resched();
6a0cb1bc
HR
283 }
284
a2d6b3a2
DLM
285 ret = submit_bio_wait(bio);
286 bio_put(bio);
287
a2d6b3a2 288 return ret;
6a0cb1bc
HR
289}
290EXPORT_SYMBOL_GPL(blkdev_reset_zones);
3ed05a98 291
56c4bddb 292/*
3ed05a98
ST
293 * BLKREPORTZONE ioctl processing.
294 * Called from blkdev_ioctl.
295 */
296int blkdev_report_zones_ioctl(struct block_device *bdev, fmode_t mode,
297 unsigned int cmd, unsigned long arg)
298{
299 void __user *argp = (void __user *)arg;
300 struct request_queue *q;
301 struct blk_zone_report rep;
302 struct blk_zone *zones;
303 int ret;
304
305 if (!argp)
306 return -EINVAL;
307
308 q = bdev_get_queue(bdev);
309 if (!q)
310 return -ENXIO;
311
312 if (!blk_queue_is_zoned(q))
313 return -ENOTTY;
314
315 if (!capable(CAP_SYS_ADMIN))
316 return -EACCES;
317
318 if (copy_from_user(&rep, argp, sizeof(struct blk_zone_report)))
319 return -EFAULT;
320
321 if (!rep.nr_zones)
322 return -EINVAL;
323
2e85fbaf 324 rep.nr_zones = min(blkdev_nr_zones(bdev), rep.nr_zones);
327ea4ad 325
344476e1
KC
326 zones = kvmalloc_array(rep.nr_zones, sizeof(struct blk_zone),
327 GFP_KERNEL | __GFP_ZERO);
3ed05a98
ST
328 if (!zones)
329 return -ENOMEM;
330
bd976e52 331 ret = blkdev_report_zones(bdev, rep.sector, zones, &rep.nr_zones);
3ed05a98
ST
332 if (ret)
333 goto out;
334
335 if (copy_to_user(argp, &rep, sizeof(struct blk_zone_report))) {
336 ret = -EFAULT;
337 goto out;
338 }
339
340 if (rep.nr_zones) {
341 if (copy_to_user(argp + sizeof(struct blk_zone_report), zones,
342 sizeof(struct blk_zone) * rep.nr_zones))
343 ret = -EFAULT;
344 }
345
346 out:
327ea4ad 347 kvfree(zones);
3ed05a98
ST
348
349 return ret;
350}
351
56c4bddb 352/*
3ed05a98
ST
353 * BLKRESETZONE ioctl processing.
354 * Called from blkdev_ioctl.
355 */
356int blkdev_reset_zones_ioctl(struct block_device *bdev, fmode_t mode,
357 unsigned int cmd, unsigned long arg)
358{
359 void __user *argp = (void __user *)arg;
360 struct request_queue *q;
361 struct blk_zone_range zrange;
362
363 if (!argp)
364 return -EINVAL;
365
366 q = bdev_get_queue(bdev);
367 if (!q)
368 return -ENXIO;
369
370 if (!blk_queue_is_zoned(q))
371 return -ENOTTY;
372
373 if (!capable(CAP_SYS_ADMIN))
374 return -EACCES;
375
376 if (!(mode & FMODE_WRITE))
377 return -EBADF;
378
379 if (copy_from_user(&zrange, argp, sizeof(struct blk_zone_range)))
380 return -EFAULT;
381
382 return blkdev_reset_zones(bdev, zrange.sector, zrange.nr_sectors,
383 GFP_KERNEL);
384}
bf505456
DLM
385
386static inline unsigned long *blk_alloc_zone_bitmap(int node,
387 unsigned int nr_zones)
388{
389 return kcalloc_node(BITS_TO_LONGS(nr_zones), sizeof(unsigned long),
390 GFP_NOIO, node);
391}
392
393/*
394 * Allocate an array of struct blk_zone to get nr_zones zone information.
395 * The allocated array may be smaller than nr_zones.
396 */
26202928 397static struct blk_zone *blk_alloc_zones(unsigned int *nr_zones)
bf505456 398{
26202928
DLM
399 struct blk_zone *zones;
400 size_t nrz = min(*nr_zones, BLK_ZONED_REPORT_MAX_ZONES);
401
402 /*
403 * GFP_KERNEL here is meaningless as the caller task context has
404 * the PF_MEMALLOC_NOIO flag set in blk_revalidate_disk_zones()
405 * with memalloc_noio_save().
406 */
407 zones = kvcalloc(nrz, sizeof(struct blk_zone), GFP_KERNEL);
408 if (!zones) {
409 *nr_zones = 0;
410 return NULL;
bf505456
DLM
411 }
412
26202928
DLM
413 *nr_zones = nrz;
414
415 return zones;
bf505456
DLM
416}
417
418void blk_queue_free_zone_bitmaps(struct request_queue *q)
419{
420 kfree(q->seq_zones_bitmap);
421 q->seq_zones_bitmap = NULL;
422 kfree(q->seq_zones_wlock);
423 q->seq_zones_wlock = NULL;
424}
425
426/**
427 * blk_revalidate_disk_zones - (re)allocate and initialize zone bitmaps
428 * @disk: Target disk
429 *
430 * Helper function for low-level device drivers to (re) allocate and initialize
431 * a disk request queue zone bitmaps. This functions should normally be called
432 * within the disk ->revalidate method. For BIO based queues, no zone bitmap
433 * is allocated.
434 */
435int blk_revalidate_disk_zones(struct gendisk *disk)
436{
437 struct request_queue *q = disk->queue;
438 unsigned int nr_zones = __blkdev_nr_zones(q, get_capacity(disk));
439 unsigned long *seq_zones_wlock = NULL, *seq_zones_bitmap = NULL;
440 unsigned int i, rep_nr_zones = 0, z = 0, nrz;
441 struct blk_zone *zones = NULL;
bd976e52 442 unsigned int noio_flag;
bf505456
DLM
443 sector_t sector = 0;
444 int ret = 0;
445
446 /*
447 * BIO based queues do not use a scheduler so only q->nr_zones
448 * needs to be updated so that the sysfs exposed value is correct.
449 */
344e9ffc 450 if (!queue_is_mq(q)) {
bf505456
DLM
451 q->nr_zones = nr_zones;
452 return 0;
453 }
454
bd976e52
DLM
455 /*
456 * Ensure that all memory allocations in this context are done as
457 * if GFP_NOIO was specified.
458 */
459 noio_flag = memalloc_noio_save();
460
bf505456
DLM
461 if (!blk_queue_is_zoned(q) || !nr_zones) {
462 nr_zones = 0;
463 goto update;
464 }
465
466 /* Allocate bitmaps */
467 ret = -ENOMEM;
468 seq_zones_wlock = blk_alloc_zone_bitmap(q->node, nr_zones);
469 if (!seq_zones_wlock)
470 goto out;
471 seq_zones_bitmap = blk_alloc_zone_bitmap(q->node, nr_zones);
472 if (!seq_zones_bitmap)
473 goto out;
474
475 /* Get zone information and initialize seq_zones_bitmap */
476 rep_nr_zones = nr_zones;
26202928 477 zones = blk_alloc_zones(&rep_nr_zones);
bf505456
DLM
478 if (!zones)
479 goto out;
480
481 while (z < nr_zones) {
482 nrz = min(nr_zones - z, rep_nr_zones);
bd976e52 483 ret = blk_report_zones(disk, sector, zones, &nrz);
bf505456
DLM
484 if (ret)
485 goto out;
486 if (!nrz)
487 break;
488 for (i = 0; i < nrz; i++) {
489 if (zones[i].type != BLK_ZONE_TYPE_CONVENTIONAL)
490 set_bit(z, seq_zones_bitmap);
491 z++;
492 }
493 sector += nrz * blk_queue_zone_sectors(q);
494 }
495
496 if (WARN_ON(z != nr_zones)) {
497 ret = -EIO;
498 goto out;
499 }
500
501update:
502 /*
503 * Install the new bitmaps, making sure the queue is stopped and
504 * all I/Os are completed (i.e. a scheduler is not referencing the
505 * bitmaps).
506 */
507 blk_mq_freeze_queue(q);
508 q->nr_zones = nr_zones;
509 swap(q->seq_zones_wlock, seq_zones_wlock);
510 swap(q->seq_zones_bitmap, seq_zones_bitmap);
511 blk_mq_unfreeze_queue(q);
512
513out:
bd976e52
DLM
514 memalloc_noio_restore(noio_flag);
515
26202928 516 kvfree(zones);
bf505456
DLM
517 kfree(seq_zones_wlock);
518 kfree(seq_zones_bitmap);
519
520 if (ret) {
521 pr_warn("%s: failed to revalidate zones\n", disk->disk_name);
522 blk_mq_freeze_queue(q);
523 blk_queue_free_zone_bitmaps(q);
524 blk_mq_unfreeze_queue(q);
525 }
526
527 return ret;
528}
529EXPORT_SYMBOL_GPL(blk_revalidate_disk_zones);
530