OSDN Git Service

Merge tag 'prlimit-tasklist_lock-for-v5.18' of git://git.kernel.org/pub/scm/linux...
[uclinux-h8/linux.git] / block / blk-zoned.c
1 // SPDX-License-Identifier: GPL-2.0
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>
16 #include <linux/blk-mq.h>
17 #include <linux/mm.h>
18 #include <linux/vmalloc.h>
19 #include <linux/sched/mm.h>
20
21 #include "blk.h"
22
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),
31         ZONE_COND_NAME(FULL),
32         ZONE_COND_NAME(OFFLINE),
33 };
34 #undef ZONE_COND_NAME
35
36 /**
37  * blk_zone_cond_str - Return string XXX in BLK_ZONE_COND_XXX.
38  * @zone_cond: BLK_ZONE_COND_XXX.
39  *
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".
43  */
44 const char *blk_zone_cond_str(enum blk_zone_cond zone_cond)
45 {
46         static const char *zone_cond_str = "UNKNOWN";
47
48         if (zone_cond < ARRAY_SIZE(zone_cond_name) && zone_cond_name[zone_cond])
49                 zone_cond_str = zone_cond_name[zone_cond];
50
51         return zone_cond_str;
52 }
53 EXPORT_SYMBOL_GPL(blk_zone_cond_str);
54
55 /*
56  * Return true if a request is a write requests that needs zone write locking.
57  */
58 bool blk_req_needs_zone_write_lock(struct request *rq)
59 {
60         if (!rq->q->seq_zones_wlock)
61                 return false;
62
63         if (blk_rq_is_passthrough(rq))
64                 return false;
65
66         switch (req_op(rq)) {
67         case REQ_OP_WRITE_ZEROES:
68         case REQ_OP_WRITE_SAME:
69         case REQ_OP_WRITE:
70                 return blk_rq_zone_is_seq(rq);
71         default:
72                 return false;
73         }
74 }
75 EXPORT_SYMBOL_GPL(blk_req_needs_zone_write_lock);
76
77 bool blk_req_zone_write_trylock(struct request *rq)
78 {
79         unsigned int zno = blk_rq_zone_no(rq);
80
81         if (test_and_set_bit(zno, rq->q->seq_zones_wlock))
82                 return false;
83
84         WARN_ON_ONCE(rq->rq_flags & RQF_ZONE_WRITE_LOCKED);
85         rq->rq_flags |= RQF_ZONE_WRITE_LOCKED;
86
87         return true;
88 }
89 EXPORT_SYMBOL_GPL(blk_req_zone_write_trylock);
90
91 void __blk_req_zone_write_lock(struct request *rq)
92 {
93         if (WARN_ON_ONCE(test_and_set_bit(blk_rq_zone_no(rq),
94                                           rq->q->seq_zones_wlock)))
95                 return;
96
97         WARN_ON_ONCE(rq->rq_flags & RQF_ZONE_WRITE_LOCKED);
98         rq->rq_flags |= RQF_ZONE_WRITE_LOCKED;
99 }
100 EXPORT_SYMBOL_GPL(__blk_req_zone_write_lock);
101
102 void __blk_req_zone_write_unlock(struct request *rq)
103 {
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));
108 }
109 EXPORT_SYMBOL_GPL(__blk_req_zone_write_unlock);
110
111 /**
112  * blkdev_nr_zones - Get number of zones
113  * @disk:       Target gendisk
114  *
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.
117  */
118 unsigned int blkdev_nr_zones(struct gendisk *disk)
119 {
120         sector_t zone_sectors = blk_queue_zone_sectors(disk->queue);
121
122         if (!blk_queue_is_zoned(disk->queue))
123                 return 0;
124         return (get_capacity(disk) + zone_sectors - 1) >> ilog2(zone_sectors);
125 }
126 EXPORT_SYMBOL_GPL(blkdev_nr_zones);
127
128 /**
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
135  *
136  * Description:
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.
143  *
144  *    Note: The caller must use memalloc_noXX_save/restore() calls to control
145  *    memory allocations done within this function.
146  */
147 int blkdev_report_zones(struct block_device *bdev, sector_t sector,
148                         unsigned int nr_zones, report_zones_cb cb, void *data)
149 {
150         struct gendisk *disk = bdev->bd_disk;
151         sector_t capacity = get_capacity(disk);
152
153         if (!blk_queue_is_zoned(bdev_get_queue(bdev)) ||
154             WARN_ON_ONCE(!disk->fops->report_zones))
155                 return -EOPNOTSUPP;
156
157         if (!nr_zones || sector >= capacity)
158                 return 0;
159
160         return disk->fops->report_zones(disk, sector, nr_zones, cb, data);
161 }
162 EXPORT_SYMBOL_GPL(blkdev_report_zones);
163
164 static inline unsigned long *blk_alloc_zone_bitmap(int node,
165                                                    unsigned int nr_zones)
166 {
167         return kcalloc_node(BITS_TO_LONGS(nr_zones), sizeof(unsigned long),
168                             GFP_NOIO, node);
169 }
170
171 static int blk_zone_need_reset_cb(struct blk_zone *zone, unsigned int idx,
172                                   void *data)
173 {
174         /*
175          * For an all-zones reset, ignore conventional, empty, read-only
176          * and offline zones.
177          */
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:
183                 return 0;
184         default:
185                 set_bit(idx, (unsigned long *)data);
186                 return 0;
187         }
188 }
189
190 static int blkdev_zone_reset_all_emulated(struct block_device *bdev,
191                                           gfp_t gfp_mask)
192 {
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;
198         sector_t sector = 0;
199         int ret;
200
201         need_reset = blk_alloc_zone_bitmap(q->node, q->nr_zones);
202         if (!need_reset)
203                 return -ENOMEM;
204
205         ret = bdev->bd_disk->fops->report_zones(bdev->bd_disk, 0,
206                                 q->nr_zones, blk_zone_need_reset_cb,
207                                 need_reset);
208         if (ret < 0)
209                 goto out_free_need_reset;
210
211         ret = 0;
212         while (sector < capacity) {
213                 if (!test_bit(blk_queue_zone_no(q, sector), need_reset)) {
214                         sector += zone_sectors;
215                         continue;
216                 }
217
218                 bio = blk_next_bio(bio, bdev, 0, REQ_OP_ZONE_RESET | REQ_SYNC,
219                                    gfp_mask);
220                 bio->bi_iter.bi_sector = sector;
221                 sector += zone_sectors;
222
223                 /* This may take a while, so be nice to others */
224                 cond_resched();
225         }
226
227         if (bio) {
228                 ret = submit_bio_wait(bio);
229                 bio_put(bio);
230         }
231
232 out_free_need_reset:
233         kfree(need_reset);
234         return ret;
235 }
236
237 static int blkdev_zone_reset_all(struct block_device *bdev, gfp_t gfp_mask)
238 {
239         struct bio bio;
240
241         bio_init(&bio, bdev, NULL, 0, REQ_OP_ZONE_RESET_ALL | REQ_SYNC);
242         return submit_bio_wait(&bio);
243 }
244
245 /**
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)
253  *
254  * Description:
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
259  *    or finish request.
260  */
261 int blkdev_zone_mgmt(struct block_device *bdev, enum req_opf op,
262                      sector_t sector, sector_t nr_sectors,
263                      gfp_t gfp_mask)
264 {
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;
270         int ret = 0;
271
272         if (!blk_queue_is_zoned(q))
273                 return -EOPNOTSUPP;
274
275         if (bdev_read_only(bdev))
276                 return -EPERM;
277
278         if (!op_is_zone_mgmt(op))
279                 return -EOPNOTSUPP;
280
281         if (end_sector <= sector || end_sector > capacity)
282                 /* Out of range */
283                 return -EINVAL;
284
285         /* Check alignment (handle eventual smaller last zone) */
286         if (sector & (zone_sectors - 1))
287                 return -EINVAL;
288
289         if ((nr_sectors & (zone_sectors - 1)) && end_sector != capacity)
290                 return -EINVAL;
291
292         /*
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.
297          */
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);
302         }
303
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;
308
309                 /* This may take a while, so be nice to others */
310                 cond_resched();
311         }
312
313         ret = submit_bio_wait(bio);
314         bio_put(bio);
315
316         return ret;
317 }
318 EXPORT_SYMBOL_GPL(blkdev_zone_mgmt);
319
320 struct zone_report_args {
321         struct blk_zone __user *zones;
322 };
323
324 static int blkdev_copy_zone_to_user(struct blk_zone *zone, unsigned int idx,
325                                     void *data)
326 {
327         struct zone_report_args *args = data;
328
329         if (copy_to_user(&args->zones[idx], zone, sizeof(struct blk_zone)))
330                 return -EFAULT;
331         return 0;
332 }
333
334 /*
335  * BLKREPORTZONE ioctl processing.
336  * Called from blkdev_ioctl.
337  */
338 int blkdev_report_zones_ioctl(struct block_device *bdev, fmode_t mode,
339                               unsigned int cmd, unsigned long arg)
340 {
341         void __user *argp = (void __user *)arg;
342         struct zone_report_args args;
343         struct request_queue *q;
344         struct blk_zone_report rep;
345         int ret;
346
347         if (!argp)
348                 return -EINVAL;
349
350         q = bdev_get_queue(bdev);
351         if (!q)
352                 return -ENXIO;
353
354         if (!blk_queue_is_zoned(q))
355                 return -ENOTTY;
356
357         if (copy_from_user(&rep, argp, sizeof(struct blk_zone_report)))
358                 return -EFAULT;
359
360         if (!rep.nr_zones)
361                 return -EINVAL;
362
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);
366         if (ret < 0)
367                 return ret;
368
369         rep.nr_zones = ret;
370         rep.flags = BLK_ZONE_REP_CAPACITY;
371         if (copy_to_user(argp, &rep, sizeof(struct blk_zone_report)))
372                 return -EFAULT;
373         return 0;
374 }
375
376 static int blkdev_truncate_zone_range(struct block_device *bdev, fmode_t mode,
377                                       const struct blk_zone_range *zrange)
378 {
379         loff_t start, end;
380
381         if (zrange->sector + zrange->nr_sectors <= zrange->sector ||
382             zrange->sector + zrange->nr_sectors > get_capacity(bdev->bd_disk))
383                 /* Out of range */
384                 return -EINVAL;
385
386         start = zrange->sector << SECTOR_SHIFT;
387         end = ((zrange->sector + zrange->nr_sectors) << SECTOR_SHIFT) - 1;
388
389         return truncate_bdev_range(bdev, mode, start, end);
390 }
391
392 /*
393  * BLKRESETZONE, BLKOPENZONE, BLKCLOSEZONE and BLKFINISHZONE ioctl processing.
394  * Called from blkdev_ioctl.
395  */
396 int blkdev_zone_mgmt_ioctl(struct block_device *bdev, fmode_t mode,
397                            unsigned int cmd, unsigned long arg)
398 {
399         void __user *argp = (void __user *)arg;
400         struct request_queue *q;
401         struct blk_zone_range zrange;
402         enum req_opf op;
403         int ret;
404
405         if (!argp)
406                 return -EINVAL;
407
408         q = bdev_get_queue(bdev);
409         if (!q)
410                 return -ENXIO;
411
412         if (!blk_queue_is_zoned(q))
413                 return -ENOTTY;
414
415         if (!(mode & FMODE_WRITE))
416                 return -EBADF;
417
418         if (copy_from_user(&zrange, argp, sizeof(struct blk_zone_range)))
419                 return -EFAULT;
420
421         switch (cmd) {
422         case BLKRESETZONE:
423                 op = REQ_OP_ZONE_RESET;
424
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);
428                 if (ret)
429                         goto fail;
430                 break;
431         case BLKOPENZONE:
432                 op = REQ_OP_ZONE_OPEN;
433                 break;
434         case BLKCLOSEZONE:
435                 op = REQ_OP_ZONE_CLOSE;
436                 break;
437         case BLKFINISHZONE:
438                 op = REQ_OP_ZONE_FINISH;
439                 break;
440         default:
441                 return -ENOTTY;
442         }
443
444         ret = blkdev_zone_mgmt(bdev, op, zrange.sector, zrange.nr_sectors,
445                                GFP_KERNEL);
446
447 fail:
448         if (cmd == BLKRESETZONE)
449                 filemap_invalidate_unlock(bdev->bd_inode->i_mapping);
450
451         return ret;
452 }
453
454 void blk_queue_free_zone_bitmaps(struct request_queue *q)
455 {
456         kfree(q->conv_zones_bitmap);
457         q->conv_zones_bitmap = NULL;
458         kfree(q->seq_zones_wlock);
459         q->seq_zones_wlock = NULL;
460 }
461
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;
468         sector_t        sector;
469 };
470
471 /*
472  * Helper function to check the validity of zones of a zoned block device.
473  */
474 static int blk_revalidate_zone_cb(struct blk_zone *zone, unsigned int idx,
475                                   void *data)
476 {
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);
481
482         /*
483          * All zones must have the same size, with the exception on an eventual
484          * smaller last zone.
485          */
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);
490                         return -ENODEV;
491                 }
492
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",
498                                 disk->disk_name);
499                         return -ENODEV;
500                 }
501         } else {
502                 if (zone->len > args->zone_sectors) {
503                         pr_warn("%s: Invalid zoned device with larger last zone size\n",
504                                 disk->disk_name);
505                         return -ENODEV;
506                 }
507         }
508
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);
513                 return -ENODEV;
514         }
515
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)
523                                 return -ENOMEM;
524                 }
525                 set_bit(idx, args->conv_zones_bitmap);
526                 break;
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)
533                                 return -ENOMEM;
534                 }
535                 break;
536         default:
537                 pr_warn("%s: Invalid zone type 0x%x at sectors %llu\n",
538                         disk->disk_name, (int)zone->type, zone->start);
539                 return -ENODEV;
540         }
541
542         args->sector += zone->len;
543         return 0;
544 }
545
546 /**
547  * blk_revalidate_disk_zones - (re)allocate and initialize zone bitmaps
548  * @disk:       Target disk
549  * @update_driver_data: Callback to update driver data on the frozen disk
550  *
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
555  * is correct.
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
558  * checked.
559  */
560 int blk_revalidate_disk_zones(struct gendisk *disk,
561                               void (*update_driver_data)(struct gendisk *disk))
562 {
563         struct request_queue *q = disk->queue;
564         struct blk_revalidate_zone_args args = {
565                 .disk           = disk,
566         };
567         unsigned int noio_flag;
568         int ret;
569
570         if (WARN_ON_ONCE(!blk_queue_is_zoned(q)))
571                 return -EIO;
572         if (WARN_ON_ONCE(!queue_is_mq(q)))
573                 return -EIO;
574
575         if (!get_capacity(disk))
576                 return -EIO;
577
578         /*
579          * Ensure that all memory allocations in this context are done as if
580          * GFP_NOIO was specified.
581          */
582         noio_flag = memalloc_noio_save();
583         ret = disk->fops->report_zones(disk, 0, UINT_MAX,
584                                        blk_revalidate_zone_cb, &args);
585         if (!ret) {
586                 pr_warn("%s: No zones reported\n", disk->disk_name);
587                 ret = -ENODEV;
588         }
589         memalloc_noio_restore(noio_flag);
590
591         /*
592          * If zones where reported, make sure that the entire disk capacity
593          * has been checked.
594          */
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);
598                 ret = -ENODEV;
599         }
600
601         /*
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).
605          */
606         blk_mq_freeze_queue(q);
607         if (ret > 0) {
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);
614                 ret = 0;
615         } else {
616                 pr_warn("%s: failed to revalidate zones\n", disk->disk_name);
617                 blk_queue_free_zone_bitmaps(q);
618         }
619         blk_mq_unfreeze_queue(q);
620
621         kfree(args.seq_zones_wlock);
622         kfree(args.conv_zones_bitmap);
623         return ret;
624 }
625 EXPORT_SYMBOL_GPL(blk_revalidate_disk_zones);
626
627 void blk_queue_clear_zone_settings(struct request_queue *q)
628 {
629         blk_mq_freeze_queue(q);
630
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;
634         q->nr_zones = 0;
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;
640
641         blk_mq_unfreeze_queue(q);
642 }