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 static inline sector_t blk_zone_start(struct request_queue *q,
  24                                       sector_t sector)
  25 {
  26         sector_t zone_mask = blk_queue_zone_sectors(q) - 1;
  27
  28         return sector & ~zone_mask;
  29 }
  30
  31 /*
  32  * Return true if a request is a write requests that needs zone write locking.
  33  */
  34 bool 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 }
  51 EXPORT_SYMBOL_GPL(blk_req_needs_zone_write_lock);
  52
  53 void __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 }
  62 EXPORT_SYMBOL_GPL(__blk_req_zone_write_lock);
  63
  64 void __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 }
  71 EXPORT_SYMBOL_GPL(__blk_req_zone_write_unlock);
  72
  73 static inline unsigned int __blkdev_nr_zones(struct request_queue *q,
  74                                              sector_t nr_sectors)
  75 {
  76         sector_t zone_sectors = blk_queue_zone_sectors(q);
  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  */
  89 unsigned 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 }
  98 EXPORT_SYMBOL_GPL(blkdev_nr_zones);
  99
 100 /*
 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.
 103  */
 104 static bool blkdev_report_zone(struct block_device *bdev, struct blk_zone *rep)
 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;
 119         return true;
 120 }
 121
 122 static int blk_report_zones(struct gendisk *disk, sector_t sector,
 123                             struct blk_zone *zones, unsigned int *nr_zones)
 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;
 132                 ret = disk->fops->report_zones(disk, sector, &zones[z], &n);
 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
 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
 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.
 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).
 162  */
 163 int blkdev_report_zones(struct block_device *bdev, sector_t sector,
 164                         struct blk_zone *zones, unsigned int *nr_zones)
 165 {
 166         struct request_queue *q = bdev_get_queue(bdev);
 167         unsigned int i, nrz;
 168         int ret;
 169
 170         if (!blk_queue_is_zoned(q))
 171                 return -EOPNOTSUPP;
 172
 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;
 180
 181         if (!*nr_zones || sector >= bdev->bd_part->nr_sects) {
 182                 *nr_zones = 0;
 183                 return 0;
 184         }
 185
 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,
 189                                zones, &nrz);
 190         if (ret)
 191                 return ret;
 192
 193         for (i = 0; i < nrz; i++) {
 194                 if (!blkdev_report_zone(bdev, zones))
 195                         break;
 196                 zones++;
 197         }
 198
 199         *nr_zones = i;
 200
 201         return 0;
 202 }
 203 EXPORT_SYMBOL_GPL(blkdev_report_zones);
 204
 205 static inline bool blkdev_allow_reset_all_zones(struct block_device *bdev,
 206                                                 sector_t sector,
 207                                                 sector_t nr_sectors)
 208 {
 209         if (!blk_queue_zone_resetall(bdev_get_queue(bdev)))
 210                 return false;
 211
 212         if (sector || nr_sectors != part_nr_sects_read(bdev->bd_part))
 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
 223 /**
 224  * blkdev_zone_mgmt - Execute a zone management operation on a range of zones
 225  * @bdev:       Target block device
 226  * @op:         Operation to be performed on the zones
 227  * @sector:     Start sector of the first zone to operate on
 228  * @nr_sectors: Number of sectors, should be at least the length of one zone and
 229  *              must be zone size aligned.
 230  * @gfp_mask:   Memory allocation flags (for bio_alloc)
 231  *
 232  * Description:
 233  *    Perform the specified operation on the range of zones specified by
 234  *    @sector..@sector+@nr_sectors. Specifying the entire disk sector range
 235  *    is valid, but the specified range should not contain conventional zones.
 236  *    The operation to execute on each zone can be a zone reset, open, close
 237  *    or finish request.
 238  */
 239 int blkdev_zone_mgmt(struct block_device *bdev, enum req_opf op,
 240                      sector_t sector, sector_t nr_sectors,
 241                      gfp_t gfp_mask)
 242 {
 243         struct request_queue *q = bdev_get_queue(bdev);
 244         sector_t zone_sectors = blk_queue_zone_sectors(q);
 245         sector_t end_sector = sector + nr_sectors;
 246         struct bio *bio = NULL;
 247         int ret;
 248
 249         if (!blk_queue_is_zoned(q))
 250                 return -EOPNOTSUPP;
 251
 252         if (bdev_read_only(bdev))
 253                 return -EPERM;
 254
 255         if (!op_is_zone_mgmt(op))
 256                 return -EOPNOTSUPP;
 257
 258         if (!nr_sectors || end_sector > bdev->bd_part->nr_sects)
 259                 /* Out of range */
 260                 return -EINVAL;
 261
 262         /* Check alignment (handle eventual smaller last zone) */
 263         if (sector & (zone_sectors - 1))
 264                 return -EINVAL;
 265
 266         if ((nr_sectors & (zone_sectors - 1)) &&
 267             end_sector != bdev->bd_part->nr_sects)
 268                 return -EINVAL;
 269
 270         while (sector < end_sector) {
 271                 bio = blk_next_bio(bio, 0, gfp_mask);
 272                 bio_set_dev(bio, bdev);
 273
 274                 /*
 275                  * Special case for the zone reset operation that reset all
 276                  * zones, this is useful for applications like mkfs.
 277                  */
 278                 if (op == REQ_OP_ZONE_RESET &&
 279                     blkdev_allow_reset_all_zones(bdev, sector, nr_sectors)) {
 280                         bio->bi_opf = REQ_OP_ZONE_RESET_ALL;
 281                         break;
 282                 }
 283
 284                 bio->bi_opf = op;
 285                 bio->bi_iter.bi_sector = sector;
 286                 sector += zone_sectors;
 287
 288                 /* This may take a while, so be nice to others */
 289                 cond_resched();
 290         }
 291
 292         ret = submit_bio_wait(bio);
 293         bio_put(bio);
 294
 295         return ret;
 296 }
 297 EXPORT_SYMBOL_GPL(blkdev_zone_mgmt);
 298
 299 /*
 300  * BLKREPORTZONE ioctl processing.
 301  * Called from blkdev_ioctl.
 302  */
 303 int blkdev_report_zones_ioctl(struct block_device *bdev, fmode_t mode,
 304                               unsigned int cmd, unsigned long arg)
 305 {
 306         void __user *argp = (void __user *)arg;
 307         struct request_queue *q;
 308         struct blk_zone_report rep;
 309         struct blk_zone *zones;
 310         int ret;
 311
 312         if (!argp)
 313                 return -EINVAL;
 314
 315         q = bdev_get_queue(bdev);
 316         if (!q)
 317                 return -ENXIO;
 318
 319         if (!blk_queue_is_zoned(q))
 320                 return -ENOTTY;
 321
 322         if (!capable(CAP_SYS_ADMIN))
 323                 return -EACCES;
 324
 325         if (copy_from_user(&rep, argp, sizeof(struct blk_zone_report)))
 326                 return -EFAULT;
 327
 328         if (!rep.nr_zones)
 329                 return -EINVAL;
 330
 331         rep.nr_zones = min(blkdev_nr_zones(bdev), rep.nr_zones);
 332
 333         zones = kvmalloc_array(rep.nr_zones, sizeof(struct blk_zone),
 334                                GFP_KERNEL | __GFP_ZERO);
 335         if (!zones)
 336                 return -ENOMEM;
 337
 338         ret = blkdev_report_zones(bdev, rep.sector, zones, &rep.nr_zones);
 339         if (ret)
 340                 goto out;
 341
 342         if (copy_to_user(argp, &rep, sizeof(struct blk_zone_report))) {
 343                 ret = -EFAULT;
 344                 goto out;
 345         }
 346
 347         if (rep.nr_zones) {
 348                 if (copy_to_user(argp + sizeof(struct blk_zone_report), zones,
 349                                  sizeof(struct blk_zone) * rep.nr_zones))
 350                         ret = -EFAULT;
 351         }
 352
 353  out:
 354         kvfree(zones);
 355
 356         return ret;
 357 }
 358
 359 /*
 360  * BLKRESETZONE, BLKOPENZONE, BLKCLOSEZONE and BLKFINISHZONE ioctl processing.
 361  * Called from blkdev_ioctl.
 362  */
 363 int blkdev_zone_mgmt_ioctl(struct block_device *bdev, fmode_t mode,
 364                            unsigned int cmd, unsigned long arg)
 365 {
 366         void __user *argp = (void __user *)arg;
 367         struct request_queue *q;
 368         struct blk_zone_range zrange;
 369         enum req_opf op;
 370
 371         if (!argp)
 372                 return -EINVAL;
 373
 374         q = bdev_get_queue(bdev);
 375         if (!q)
 376                 return -ENXIO;
 377
 378         if (!blk_queue_is_zoned(q))
 379                 return -ENOTTY;
 380
 381         if (!capable(CAP_SYS_ADMIN))
 382                 return -EACCES;
 383
 384         if (!(mode & FMODE_WRITE))
 385                 return -EBADF;
 386
 387         if (copy_from_user(&zrange, argp, sizeof(struct blk_zone_range)))
 388                 return -EFAULT;
 389
 390         switch (cmd) {
 391         case BLKRESETZONE:
 392                 op = REQ_OP_ZONE_RESET;
 393                 break;
 394         case BLKOPENZONE:
 395                 op = REQ_OP_ZONE_OPEN;
 396                 break;
 397         case BLKCLOSEZONE:
 398                 op = REQ_OP_ZONE_CLOSE;
 399                 break;
 400         case BLKFINISHZONE:
 401                 op = REQ_OP_ZONE_FINISH;
 402                 break;
 403         default:
 404                 return -ENOTTY;
 405         }
 406
 407         return blkdev_zone_mgmt(bdev, op, zrange.sector, zrange.nr_sectors,
 408                                 GFP_KERNEL);
 409 }
 410
 411 static inline unsigned long *blk_alloc_zone_bitmap(int node,
 412                                                    unsigned int nr_zones)
 413 {
 414         return kcalloc_node(BITS_TO_LONGS(nr_zones), sizeof(unsigned long),
 415                             GFP_NOIO, node);
 416 }
 417
 418 /*
 419  * Allocate an array of struct blk_zone to get nr_zones zone information.
 420  * The allocated array may be smaller than nr_zones.
 421  */
 422 static struct blk_zone *blk_alloc_zones(unsigned int *nr_zones)
 423 {
 424         struct blk_zone *zones;
 425         size_t nrz = min(*nr_zones, BLK_ZONED_REPORT_MAX_ZONES);
 426
 427         /*
 428          * GFP_KERNEL here is meaningless as the caller task context has
 429          * the PF_MEMALLOC_NOIO flag set in blk_revalidate_disk_zones()
 430          * with memalloc_noio_save().
 431          */
 432         zones = kvcalloc(nrz, sizeof(struct blk_zone), GFP_KERNEL);
 433         if (!zones) {
 434                 *nr_zones = 0;
 435                 return NULL;
 436         }
 437
 438         *nr_zones = nrz;
 439
 440         return zones;
 441 }
 442
 443 void blk_queue_free_zone_bitmaps(struct request_queue *q)
 444 {
 445         kfree(q->seq_zones_bitmap);
 446         q->seq_zones_bitmap = NULL;
 447         kfree(q->seq_zones_wlock);
 448         q->seq_zones_wlock = NULL;
 449 }
 450
 451 /*
 452  * Helper function to check the validity of zones of a zoned block device.
 453  */
 454 static bool blk_zone_valid(struct gendisk *disk, struct blk_zone *zone,
 455                            sector_t *sector)
 456 {
 457         struct request_queue *q = disk->queue;
 458         sector_t zone_sectors = blk_queue_zone_sectors(q);
 459         sector_t capacity = get_capacity(disk);
 460
 461         /*
 462          * All zones must have the same size, with the exception on an eventual
 463          * smaller last zone.
 464          */
 465         if (zone->start + zone_sectors < capacity &&
 466             zone->len != zone_sectors) {
 467                 pr_warn("%s: Invalid zoned device with non constant zone size\n",
 468                         disk->disk_name);
 469                 return false;
 470         }
 471
 472         if (zone->start + zone->len >= capacity &&
 473             zone->len > zone_sectors) {
 474                 pr_warn("%s: Invalid zoned device with larger last zone size\n",
 475                         disk->disk_name);
 476                 return false;
 477         }
 478
 479         /* Check for holes in the zone report */
 480         if (zone->start != *sector) {
 481                 pr_warn("%s: Zone gap at sectors %llu..%llu\n",
 482                         disk->disk_name, *sector, zone->start);
 483                 return false;
 484         }
 485
 486         /* Check zone type */
 487         switch (zone->type) {
 488         case BLK_ZONE_TYPE_CONVENTIONAL:
 489         case BLK_ZONE_TYPE_SEQWRITE_REQ:
 490         case BLK_ZONE_TYPE_SEQWRITE_PREF:
 491                 break;
 492         default:
 493                 pr_warn("%s: Invalid zone type 0x%x at sectors %llu\n",
 494                         disk->disk_name, (int)zone->type, zone->start);
 495                 return false;
 496         }
 497
 498         *sector += zone->len;
 499
 500         return true;
 501 }
 502
 503 /**
 504  * blk_revalidate_disk_zones - (re)allocate and initialize zone bitmaps
 505  * @disk:       Target disk
 506  *
 507  * Helper function for low-level device drivers to (re) allocate and initialize
 508  * a disk request queue zone bitmaps. This functions should normally be called
 509  * within the disk ->revalidate method. For BIO based queues, no zone bitmap
 510  * is allocated.
 511  */
 512 int blk_revalidate_disk_zones(struct gendisk *disk)
 513 {
 514         struct request_queue *q = disk->queue;
 515         unsigned int nr_zones = __blkdev_nr_zones(q, get_capacity(disk));
 516         unsigned long *seq_zones_wlock = NULL, *seq_zones_bitmap = NULL;
 517         unsigned int i, rep_nr_zones = 0, z = 0, nrz;
 518         struct blk_zone *zones = NULL;
 519         unsigned int noio_flag;
 520         sector_t sector = 0;
 521         int ret = 0;
 522
 523         if (WARN_ON_ONCE(!blk_queue_is_zoned(q)))
 524                 return -EIO;
 525
 526         /*
 527          * BIO based queues do not use a scheduler so only q->nr_zones
 528          * needs to be updated so that the sysfs exposed value is correct.
 529          */
 530         if (!queue_is_mq(q)) {
 531                 q->nr_zones = nr_zones;
 532                 return 0;
 533         }
 534
 535         /*
 536          * Ensure that all memory allocations in this context are done as
 537          * if GFP_NOIO was specified.
 538          */
 539         noio_flag = memalloc_noio_save();
 540
 541         if (!nr_zones)
 542                 goto update;
 543
 544         /* Allocate bitmaps */
 545         ret = -ENOMEM;
 546         seq_zones_wlock = blk_alloc_zone_bitmap(q->node, nr_zones);
 547         if (!seq_zones_wlock)
 548                 goto out;
 549         seq_zones_bitmap = blk_alloc_zone_bitmap(q->node, nr_zones);
 550         if (!seq_zones_bitmap)
 551                 goto out;
 552
 553         /*
 554          * Get zone information to check the zones and initialize
 555          * seq_zones_bitmap.
 556          */
 557         rep_nr_zones = nr_zones;
 558         zones = blk_alloc_zones(&rep_nr_zones);
 559         if (!zones)
 560                 goto out;
 561
 562         while (z < nr_zones) {
 563                 nrz = min(nr_zones - z, rep_nr_zones);
 564                 ret = blk_report_zones(disk, sector, zones, &nrz);
 565                 if (ret)
 566                         goto out;
 567                 if (!nrz)
 568                         break;
 569                 for (i = 0; i < nrz; i++) {
 570                         if (!blk_zone_valid(disk, &zones[i], &sector)) {
 571                                 ret = -ENODEV;
 572                                 goto out;
 573                         }
 574                         if (zones[i].type != BLK_ZONE_TYPE_CONVENTIONAL)
 575                                 set_bit(z, seq_zones_bitmap);
 576                         z++;
 577                 }
 578         }
 579
 580         if (WARN_ON(z != nr_zones)) {
 581                 ret = -EIO;
 582                 goto out;
 583         }
 584
 585 update:
 586         /*
 587          * Install the new bitmaps, making sure the queue is stopped and
 588          * all I/Os are completed (i.e. a scheduler is not referencing the
 589          * bitmaps).
 590          */
 591         blk_mq_freeze_queue(q);
 592         q->nr_zones = nr_zones;
 593         swap(q->seq_zones_wlock, seq_zones_wlock);
 594         swap(q->seq_zones_bitmap, seq_zones_bitmap);
 595         blk_mq_unfreeze_queue(q);
 596
 597 out:
 598         memalloc_noio_restore(noio_flag);
 599
 600         kvfree(zones);
 601         kfree(seq_zones_wlock);
 602         kfree(seq_zones_bitmap);
 603
 604         if (ret) {
 605                 pr_warn("%s: failed to revalidate zones\n", disk->disk_name);
 606                 blk_mq_freeze_queue(q);
 607                 blk_queue_free_zone_bitmaps(q);
 608                 blk_mq_unfreeze_queue(q);
 609         }
 610
 611         return ret;
 612 }
 613 EXPORT_SYMBOL_GPL(blk_revalidate_disk_zones);
 614