block: merge invalidate_partitions into rescan_partitions
[linux-2.6-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
5eac3eb3 96 return __blkdev_nr_zones(q, get_capacity(bdev->bd_disk));
a91e1380
DLM
97}
98EXPORT_SYMBOL_GPL(blkdev_nr_zones);
99
6a0cb1bc
HR
100/**
101 * blkdev_report_zones - Get zones information
102 * @bdev: Target block device
103 * @sector: Sector from which to report zones
d4100351
CH
104 * @nr_zones: Maximum number of zones to report
105 * @cb: Callback function called for each reported zone
106 * @data: Private data for the callback
6a0cb1bc
HR
107 *
108 * Description:
d4100351
CH
109 * Get zone information starting from the zone containing @sector for at most
110 * @nr_zones, and call @cb for each zone reported by the device.
111 * To report all zones in a device starting from @sector, the BLK_ALL_ZONES
112 * constant can be passed to @nr_zones.
113 * Returns the number of zones reported by the device, or a negative errno
114 * value in case of failure.
115 *
116 * Note: The caller must use memalloc_noXX_save/restore() calls to control
117 * memory allocations done within this function.
6a0cb1bc 118 */
e76239a3 119int blkdev_report_zones(struct block_device *bdev, sector_t sector,
d4100351 120 unsigned int nr_zones, report_zones_cb cb, void *data)
6a0cb1bc 121{
ceeb373a 122 struct gendisk *disk = bdev->bd_disk;
5eac3eb3 123 sector_t capacity = get_capacity(disk);
6a0cb1bc 124
d4100351
CH
125 if (!blk_queue_is_zoned(bdev_get_queue(bdev)) ||
126 WARN_ON_ONCE(!disk->fops->report_zones))
e76239a3 127 return -EOPNOTSUPP;
6a0cb1bc 128
d4100351 129 if (!nr_zones || sector >= capacity)
6a0cb1bc 130 return 0;
6a0cb1bc 131
d4100351 132 return disk->fops->report_zones(disk, sector, nr_zones, cb, data);
6a0cb1bc
HR
133}
134EXPORT_SYMBOL_GPL(blkdev_report_zones);
135
6e33dbf2 136static inline bool blkdev_allow_reset_all_zones(struct block_device *bdev,
c7a1d926 137 sector_t sector,
6e33dbf2
CK
138 sector_t nr_sectors)
139{
140 if (!blk_queue_zone_resetall(bdev_get_queue(bdev)))
141 return false;
142
6e33dbf2 143 /*
5eac3eb3
DLM
144 * REQ_OP_ZONE_RESET_ALL can be executed only if the number of sectors
145 * of the applicable zone range is the entire disk.
6e33dbf2 146 */
5eac3eb3 147 return !sector && nr_sectors == get_capacity(bdev->bd_disk);
6e33dbf2
CK
148}
149
6a0cb1bc 150/**
6c1b1da5 151 * blkdev_zone_mgmt - Execute a zone management operation on a range of zones
6a0cb1bc 152 * @bdev: Target block device
6c1b1da5
AJ
153 * @op: Operation to be performed on the zones
154 * @sector: Start sector of the first zone to operate on
155 * @nr_sectors: Number of sectors, should be at least the length of one zone and
156 * must be zone size aligned.
6a0cb1bc
HR
157 * @gfp_mask: Memory allocation flags (for bio_alloc)
158 *
159 * Description:
6c1b1da5 160 * Perform the specified operation on the range of zones specified by
6a0cb1bc
HR
161 * @sector..@sector+@nr_sectors. Specifying the entire disk sector range
162 * is valid, but the specified range should not contain conventional zones.
6c1b1da5
AJ
163 * The operation to execute on each zone can be a zone reset, open, close
164 * or finish request.
6a0cb1bc 165 */
6c1b1da5
AJ
166int blkdev_zone_mgmt(struct block_device *bdev, enum req_opf op,
167 sector_t sector, sector_t nr_sectors,
168 gfp_t gfp_mask)
6a0cb1bc
HR
169{
170 struct request_queue *q = bdev_get_queue(bdev);
6c1b1da5 171 sector_t zone_sectors = blk_queue_zone_sectors(q);
5eac3eb3 172 sector_t capacity = get_capacity(bdev->bd_disk);
6a0cb1bc 173 sector_t end_sector = sector + nr_sectors;
a2d6b3a2 174 struct bio *bio = NULL;
6a0cb1bc
HR
175 int ret;
176
6a0cb1bc
HR
177 if (!blk_queue_is_zoned(q))
178 return -EOPNOTSUPP;
179
a2d6b3a2
DLM
180 if (bdev_read_only(bdev))
181 return -EPERM;
182
6c1b1da5
AJ
183 if (!op_is_zone_mgmt(op))
184 return -EOPNOTSUPP;
185
5eac3eb3 186 if (!nr_sectors || end_sector > capacity)
6a0cb1bc
HR
187 /* Out of range */
188 return -EINVAL;
189
190 /* Check alignment (handle eventual smaller last zone) */
6a0cb1bc
HR
191 if (sector & (zone_sectors - 1))
192 return -EINVAL;
193
5eac3eb3 194 if ((nr_sectors & (zone_sectors - 1)) && end_sector != capacity)
6a0cb1bc
HR
195 return -EINVAL;
196
197 while (sector < end_sector) {
a2d6b3a2 198 bio = blk_next_bio(bio, 0, gfp_mask);
74d46992 199 bio_set_dev(bio, bdev);
6a0cb1bc 200
c7a1d926
DLM
201 /*
202 * Special case for the zone reset operation that reset all
203 * zones, this is useful for applications like mkfs.
204 */
6c1b1da5
AJ
205 if (op == REQ_OP_ZONE_RESET &&
206 blkdev_allow_reset_all_zones(bdev, sector, nr_sectors)) {
c7a1d926
DLM
207 bio->bi_opf = REQ_OP_ZONE_RESET_ALL;
208 break;
209 }
210
6c1b1da5 211 bio->bi_opf = op;
c7a1d926 212 bio->bi_iter.bi_sector = sector;
6a0cb1bc
HR
213 sector += zone_sectors;
214
215 /* This may take a while, so be nice to others */
216 cond_resched();
6a0cb1bc
HR
217 }
218
a2d6b3a2
DLM
219 ret = submit_bio_wait(bio);
220 bio_put(bio);
221
a2d6b3a2 222 return ret;
6a0cb1bc 223}
6c1b1da5 224EXPORT_SYMBOL_GPL(blkdev_zone_mgmt);
3ed05a98 225
d4100351
CH
226struct zone_report_args {
227 struct blk_zone __user *zones;
228};
229
230static int blkdev_copy_zone_to_user(struct blk_zone *zone, unsigned int idx,
231 void *data)
232{
233 struct zone_report_args *args = data;
234
235 if (copy_to_user(&args->zones[idx], zone, sizeof(struct blk_zone)))
236 return -EFAULT;
237 return 0;
238}
239
56c4bddb 240/*
3ed05a98
ST
241 * BLKREPORTZONE ioctl processing.
242 * Called from blkdev_ioctl.
243 */
244int blkdev_report_zones_ioctl(struct block_device *bdev, fmode_t mode,
245 unsigned int cmd, unsigned long arg)
246{
247 void __user *argp = (void __user *)arg;
d4100351 248 struct zone_report_args args;
3ed05a98
ST
249 struct request_queue *q;
250 struct blk_zone_report rep;
3ed05a98
ST
251 int ret;
252
253 if (!argp)
254 return -EINVAL;
255
256 q = bdev_get_queue(bdev);
257 if (!q)
258 return -ENXIO;
259
260 if (!blk_queue_is_zoned(q))
261 return -ENOTTY;
262
263 if (!capable(CAP_SYS_ADMIN))
264 return -EACCES;
265
266 if (copy_from_user(&rep, argp, sizeof(struct blk_zone_report)))
267 return -EFAULT;
268
269 if (!rep.nr_zones)
270 return -EINVAL;
271
d4100351
CH
272 args.zones = argp + sizeof(struct blk_zone_report);
273 ret = blkdev_report_zones(bdev, rep.sector, rep.nr_zones,
274 blkdev_copy_zone_to_user, &args);
275 if (ret < 0)
276 return ret;
3ed05a98 277
d4100351
CH
278 rep.nr_zones = ret;
279 if (copy_to_user(argp, &rep, sizeof(struct blk_zone_report)))
280 return -EFAULT;
281 return 0;
3ed05a98
ST
282}
283
56c4bddb 284/*
e876df1f 285 * BLKRESETZONE, BLKOPENZONE, BLKCLOSEZONE and BLKFINISHZONE ioctl processing.
3ed05a98
ST
286 * Called from blkdev_ioctl.
287 */
e876df1f
AJ
288int blkdev_zone_mgmt_ioctl(struct block_device *bdev, fmode_t mode,
289 unsigned int cmd, unsigned long arg)
3ed05a98
ST
290{
291 void __user *argp = (void __user *)arg;
292 struct request_queue *q;
293 struct blk_zone_range zrange;
e876df1f 294 enum req_opf op;
3ed05a98
ST
295
296 if (!argp)
297 return -EINVAL;
298
299 q = bdev_get_queue(bdev);
300 if (!q)
301 return -ENXIO;
302
303 if (!blk_queue_is_zoned(q))
304 return -ENOTTY;
305
306 if (!capable(CAP_SYS_ADMIN))
307 return -EACCES;
308
309 if (!(mode & FMODE_WRITE))
310 return -EBADF;
311
312 if (copy_from_user(&zrange, argp, sizeof(struct blk_zone_range)))
313 return -EFAULT;
314
e876df1f
AJ
315 switch (cmd) {
316 case BLKRESETZONE:
317 op = REQ_OP_ZONE_RESET;
318 break;
319 case BLKOPENZONE:
320 op = REQ_OP_ZONE_OPEN;
321 break;
322 case BLKCLOSEZONE:
323 op = REQ_OP_ZONE_CLOSE;
324 break;
325 case BLKFINISHZONE:
326 op = REQ_OP_ZONE_FINISH;
327 break;
328 default:
329 return -ENOTTY;
330 }
331
332 return blkdev_zone_mgmt(bdev, op, zrange.sector, zrange.nr_sectors,
333 GFP_KERNEL);
3ed05a98 334}
bf505456
DLM
335
336static inline unsigned long *blk_alloc_zone_bitmap(int node,
337 unsigned int nr_zones)
338{
339 return kcalloc_node(BITS_TO_LONGS(nr_zones), sizeof(unsigned long),
340 GFP_NOIO, node);
341}
342
bf505456
DLM
343void blk_queue_free_zone_bitmaps(struct request_queue *q)
344{
345 kfree(q->seq_zones_bitmap);
346 q->seq_zones_bitmap = NULL;
347 kfree(q->seq_zones_wlock);
348 q->seq_zones_wlock = NULL;
349}
350
d4100351
CH
351struct blk_revalidate_zone_args {
352 struct gendisk *disk;
353 unsigned long *seq_zones_bitmap;
354 unsigned long *seq_zones_wlock;
355 sector_t sector;
356};
357
d9dd7308
DLM
358/*
359 * Helper function to check the validity of zones of a zoned block device.
360 */
d4100351
CH
361static int blk_revalidate_zone_cb(struct blk_zone *zone, unsigned int idx,
362 void *data)
d9dd7308 363{
d4100351
CH
364 struct blk_revalidate_zone_args *args = data;
365 struct gendisk *disk = args->disk;
d9dd7308
DLM
366 struct request_queue *q = disk->queue;
367 sector_t zone_sectors = blk_queue_zone_sectors(q);
368 sector_t capacity = get_capacity(disk);
369
370 /*
371 * All zones must have the same size, with the exception on an eventual
372 * smaller last zone.
373 */
374 if (zone->start + zone_sectors < capacity &&
375 zone->len != zone_sectors) {
376 pr_warn("%s: Invalid zoned device with non constant zone size\n",
377 disk->disk_name);
378 return false;
379 }
380
381 if (zone->start + zone->len >= capacity &&
382 zone->len > zone_sectors) {
383 pr_warn("%s: Invalid zoned device with larger last zone size\n",
384 disk->disk_name);
d4100351 385 return -ENODEV;
d9dd7308
DLM
386 }
387
388 /* Check for holes in the zone report */
d4100351 389 if (zone->start != args->sector) {
d9dd7308 390 pr_warn("%s: Zone gap at sectors %llu..%llu\n",
d4100351
CH
391 disk->disk_name, args->sector, zone->start);
392 return -ENODEV;
d9dd7308
DLM
393 }
394
395 /* Check zone type */
396 switch (zone->type) {
397 case BLK_ZONE_TYPE_CONVENTIONAL:
398 case BLK_ZONE_TYPE_SEQWRITE_REQ:
399 case BLK_ZONE_TYPE_SEQWRITE_PREF:
400 break;
401 default:
402 pr_warn("%s: Invalid zone type 0x%x at sectors %llu\n",
403 disk->disk_name, (int)zone->type, zone->start);
d4100351 404 return -ENODEV;
d9dd7308
DLM
405 }
406
d4100351
CH
407 if (zone->type != BLK_ZONE_TYPE_CONVENTIONAL)
408 set_bit(idx, args->seq_zones_bitmap);
d9dd7308 409
d4100351
CH
410 args->sector += zone->len;
411 return 0;
412}
413
414static int blk_update_zone_info(struct gendisk *disk, unsigned int nr_zones,
415 struct blk_revalidate_zone_args *args)
416{
417 /*
418 * Ensure that all memory allocations in this context are done as
419 * if GFP_NOIO was specified.
420 */
421 unsigned int noio_flag = memalloc_noio_save();
422 struct request_queue *q = disk->queue;
423 int ret;
424
425 args->seq_zones_wlock = blk_alloc_zone_bitmap(q->node, nr_zones);
426 if (!args->seq_zones_wlock)
427 return -ENOMEM;
428 args->seq_zones_bitmap = blk_alloc_zone_bitmap(q->node, nr_zones);
429 if (!args->seq_zones_bitmap)
430 return -ENOMEM;
431
432 ret = disk->fops->report_zones(disk, 0, nr_zones,
433 blk_revalidate_zone_cb, args);
434 memalloc_noio_restore(noio_flag);
435 return ret;
d9dd7308
DLM
436}
437
bf505456
DLM
438/**
439 * blk_revalidate_disk_zones - (re)allocate and initialize zone bitmaps
440 * @disk: Target disk
441 *
442 * Helper function for low-level device drivers to (re) allocate and initialize
443 * a disk request queue zone bitmaps. This functions should normally be called
444 * within the disk ->revalidate method. For BIO based queues, no zone bitmap
445 * is allocated.
446 */
447int blk_revalidate_disk_zones(struct gendisk *disk)
448{
449 struct request_queue *q = disk->queue;
450 unsigned int nr_zones = __blkdev_nr_zones(q, get_capacity(disk));
d4100351 451 struct blk_revalidate_zone_args args = { .disk = disk };
bf505456
DLM
452 int ret = 0;
453
c98c3d09
CH
454 if (WARN_ON_ONCE(!blk_queue_is_zoned(q)))
455 return -EIO;
456
bf505456
DLM
457 /*
458 * BIO based queues do not use a scheduler so only q->nr_zones
459 * needs to be updated so that the sysfs exposed value is correct.
460 */
344e9ffc 461 if (!queue_is_mq(q)) {
bf505456
DLM
462 q->nr_zones = nr_zones;
463 return 0;
464 }
465
d4100351
CH
466 if (nr_zones)
467 ret = blk_update_zone_info(disk, nr_zones, &args);
bf505456 468
bf505456
DLM
469 /*
470 * Install the new bitmaps, making sure the queue is stopped and
471 * all I/Os are completed (i.e. a scheduler is not referencing the
472 * bitmaps).
473 */
474 blk_mq_freeze_queue(q);
d4100351
CH
475 if (ret >= 0) {
476 q->nr_zones = nr_zones;
477 swap(q->seq_zones_wlock, args.seq_zones_wlock);
478 swap(q->seq_zones_bitmap, args.seq_zones_bitmap);
479 ret = 0;
480 } else {
bf505456 481 pr_warn("%s: failed to revalidate zones\n", disk->disk_name);
bf505456 482 blk_queue_free_zone_bitmaps(q);
bf505456 483 }
d4100351 484 blk_mq_unfreeze_queue(q);
bf505456 485
d4100351
CH
486 kfree(args.seq_zones_wlock);
487 kfree(args.seq_zones_bitmap);
bf505456
DLM
488 return ret;
489}
490EXPORT_SYMBOL_GPL(blk_revalidate_disk_zones);
491