drivers/block/null_blk_zoned.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 #include <linux/vmalloc.h>
   3 #include "null_blk.h"
   4
   5 #define CREATE_TRACE_POINTS
   6 #include "null_blk_trace.h"
   7
   8 /* zone_size in MBs to sectors. */
   9 #define ZONE_SIZE_SHIFT         11
  10
  11 static inline unsigned int null_zone_no(struct nullb_device *dev, sector_t sect)
  12 {
  13         return sect >> ilog2(dev->zone_size_sects);
  14 }
  15
  16 int null_init_zoned_dev(struct nullb_device *dev, struct request_queue *q)
  17 {
  18         sector_t dev_size = (sector_t)dev->size * 1024 * 1024;
  19         sector_t sector = 0;
  20         unsigned int i;
  21
  22         if (!is_power_of_2(dev->zone_size)) {
  23                 pr_err("zone_size must be power-of-two\n");
  24                 return -EINVAL;
  25         }
  26         if (dev->zone_size > dev->size) {
  27                 pr_err("Zone size larger than device capacity\n");
  28                 return -EINVAL;
  29         }
  30
  31         if (!dev->zone_capacity)
  32                 dev->zone_capacity = dev->zone_size;
  33
  34         if (dev->zone_capacity > dev->zone_size) {
  35                 pr_err("null_blk: zone capacity (%lu MB) larger than zone size (%lu MB)\n",
  36                                         dev->zone_capacity, dev->zone_size);
  37                 return -EINVAL;
  38         }
  39
  40         dev->zone_size_sects = dev->zone_size << ZONE_SIZE_SHIFT;
  41         dev->nr_zones = dev_size >>
  42                                 (SECTOR_SHIFT + ilog2(dev->zone_size_sects));
  43         dev->zones = kvmalloc_array(dev->nr_zones, sizeof(struct blk_zone),
  44                         GFP_KERNEL | __GFP_ZERO);
  45         if (!dev->zones)
  46                 return -ENOMEM;
  47
  48         if (dev->zone_nr_conv >= dev->nr_zones) {
  49                 dev->zone_nr_conv = dev->nr_zones - 1;
  50                 pr_info("changed the number of conventional zones to %u",
  51                         dev->zone_nr_conv);
  52         }
  53
  54         /* Max active zones has to be < nbr of seq zones in order to be enforceable */
  55         if (dev->zone_max_active >= dev->nr_zones - dev->zone_nr_conv) {
  56                 dev->zone_max_active = 0;
  57                 pr_info("zone_max_active limit disabled, limit >= zone count\n");
  58         }
  59
  60         /* Max open zones has to be <= max active zones */
  61         if (dev->zone_max_active && dev->zone_max_open > dev->zone_max_active) {
  62                 dev->zone_max_open = dev->zone_max_active;
  63                 pr_info("changed the maximum number of open zones to %u\n",
  64                         dev->nr_zones);
  65         } else if (dev->zone_max_open >= dev->nr_zones - dev->zone_nr_conv) {
  66                 dev->zone_max_open = 0;
  67                 pr_info("zone_max_open limit disabled, limit >= zone count\n");
  68         }
  69
  70         for (i = 0; i <  dev->zone_nr_conv; i++) {
  71                 struct blk_zone *zone = &dev->zones[i];
  72
  73                 zone->start = sector;
  74                 zone->len = dev->zone_size_sects;
  75                 zone->capacity = zone->len;
  76                 zone->wp = zone->start + zone->len;
  77                 zone->type = BLK_ZONE_TYPE_CONVENTIONAL;
  78                 zone->cond = BLK_ZONE_COND_NOT_WP;
  79
  80                 sector += dev->zone_size_sects;
  81         }
  82
  83         for (i = dev->zone_nr_conv; i < dev->nr_zones; i++) {
  84                 struct blk_zone *zone = &dev->zones[i];
  85
  86                 zone->start = zone->wp = sector;
  87                 zone->len = dev->zone_size_sects;
  88                 zone->capacity = dev->zone_capacity << ZONE_SIZE_SHIFT;
  89                 zone->type = BLK_ZONE_TYPE_SEQWRITE_REQ;
  90                 zone->cond = BLK_ZONE_COND_EMPTY;
  91
  92                 sector += dev->zone_size_sects;
  93         }
  94
  95         q->limits.zoned = BLK_ZONED_HM;
  96         blk_queue_flag_set(QUEUE_FLAG_ZONE_RESETALL, q);
  97         blk_queue_required_elevator_features(q, ELEVATOR_F_ZBD_SEQ_WRITE);
  98
  99         return 0;
 100 }
 101
 102 int null_register_zoned_dev(struct nullb *nullb)
 103 {
 104         struct nullb_device *dev = nullb->dev;
 105         struct request_queue *q = nullb->q;
 106
 107         if (queue_is_mq(q)) {
 108                 int ret = blk_revalidate_disk_zones(nullb->disk, NULL);
 109
 110                 if (ret)
 111                         return ret;
 112         } else {
 113                 blk_queue_chunk_sectors(q, dev->zone_size_sects);
 114                 q->nr_zones = blkdev_nr_zones(nullb->disk);
 115         }
 116
 117         blk_queue_max_zone_append_sectors(q, dev->zone_size_sects);
 118         blk_queue_max_open_zones(q, dev->zone_max_open);
 119         blk_queue_max_active_zones(q, dev->zone_max_active);
 120
 121         return 0;
 122 }
 123
 124 void null_free_zoned_dev(struct nullb_device *dev)
 125 {
 126         kvfree(dev->zones);
 127 }
 128
 129 int null_report_zones(struct gendisk *disk, sector_t sector,
 130                 unsigned int nr_zones, report_zones_cb cb, void *data)
 131 {
 132         struct nullb *nullb = disk->private_data;
 133         struct nullb_device *dev = nullb->dev;
 134         unsigned int first_zone, i;
 135         struct blk_zone zone;
 136         int error;
 137
 138         first_zone = null_zone_no(dev, sector);
 139         if (first_zone >= dev->nr_zones)
 140                 return 0;
 141
 142         nr_zones = min(nr_zones, dev->nr_zones - first_zone);
 143         trace_nullb_report_zones(nullb, nr_zones);
 144
 145         for (i = 0; i < nr_zones; i++) {
 146                 /*
 147                  * Stacked DM target drivers will remap the zone information by
 148                  * modifying the zone information passed to the report callback.
 149                  * So use a local copy to avoid corruption of the device zone
 150                  * array.
 151                  */
 152                 memcpy(&zone, &dev->zones[first_zone + i],
 153                        sizeof(struct blk_zone));
 154                 error = cb(&zone, i, data);
 155                 if (error)
 156                         return error;
 157         }
 158
 159         return nr_zones;
 160 }
 161
 162 size_t null_zone_valid_read_len(struct nullb *nullb,
 163                                 sector_t sector, unsigned int len)
 164 {
 165         struct nullb_device *dev = nullb->dev;
 166         struct blk_zone *zone = &dev->zones[null_zone_no(dev, sector)];
 167         unsigned int nr_sectors = len >> SECTOR_SHIFT;
 168
 169         /* Read must be below the write pointer position */
 170         if (zone->type == BLK_ZONE_TYPE_CONVENTIONAL ||
 171             sector + nr_sectors <= zone->wp)
 172                 return len;
 173
 174         if (sector > zone->wp)
 175                 return 0;
 176
 177         return (zone->wp - sector) << SECTOR_SHIFT;
 178 }
 179
 180 static blk_status_t null_close_zone(struct nullb_device *dev, struct blk_zone *zone)
 181 {
 182         if (zone->type == BLK_ZONE_TYPE_CONVENTIONAL)
 183                 return BLK_STS_IOERR;
 184
 185         switch (zone->cond) {
 186         case BLK_ZONE_COND_CLOSED:
 187                 /* close operation on closed is not an error */
 188                 return BLK_STS_OK;
 189         case BLK_ZONE_COND_IMP_OPEN:
 190                 dev->nr_zones_imp_open--;
 191                 break;
 192         case BLK_ZONE_COND_EXP_OPEN:
 193                 dev->nr_zones_exp_open--;
 194                 break;
 195         case BLK_ZONE_COND_EMPTY:
 196         case BLK_ZONE_COND_FULL:
 197         default:
 198                 return BLK_STS_IOERR;
 199         }
 200
 201         if (zone->wp == zone->start) {
 202                 zone->cond = BLK_ZONE_COND_EMPTY;
 203         } else {
 204                 zone->cond = BLK_ZONE_COND_CLOSED;
 205                 dev->nr_zones_closed++;
 206         }
 207
 208         return BLK_STS_OK;
 209 }
 210
 211 static void null_close_first_imp_zone(struct nullb_device *dev)
 212 {
 213         unsigned int i;
 214
 215         for (i = dev->zone_nr_conv; i < dev->nr_zones; i++) {
 216                 if (dev->zones[i].cond == BLK_ZONE_COND_IMP_OPEN) {
 217                         null_close_zone(dev, &dev->zones[i]);
 218                         return;
 219                 }
 220         }
 221 }
 222
 223 static bool null_can_set_active(struct nullb_device *dev)
 224 {
 225         if (!dev->zone_max_active)
 226                 return true;
 227
 228         return dev->nr_zones_exp_open + dev->nr_zones_imp_open +
 229                dev->nr_zones_closed < dev->zone_max_active;
 230 }
 231
 232 static bool null_can_open(struct nullb_device *dev)
 233 {
 234         if (!dev->zone_max_open)
 235                 return true;
 236
 237         if (dev->nr_zones_exp_open + dev->nr_zones_imp_open < dev->zone_max_open)
 238                 return true;
 239
 240         if (dev->nr_zones_imp_open && null_can_set_active(dev)) {
 241                 null_close_first_imp_zone(dev);
 242                 return true;
 243         }
 244
 245         return false;
 246 }
 247
 248 /*
 249  * This function matches the manage open zone resources function in the ZBC standard,
 250  * with the addition of max active zones support (added in the ZNS standard).
 251  *
 252  * The function determines if a zone can transition to implicit open or explicit open,
 253  * while maintaining the max open zone (and max active zone) limit(s). It may close an
 254  * implicit open zone in order to make additional zone resources available.
 255  *
 256  * ZBC states that an implicit open zone shall be closed only if there is not
 257  * room within the open limit. However, with the addition of an active limit,
 258  * it is not certain that closing an implicit open zone will allow a new zone
 259  * to be opened, since we might already be at the active limit capacity.
 260  */
 261 static bool null_has_zone_resources(struct nullb_device *dev, struct blk_zone *zone)
 262 {
 263         switch (zone->cond) {
 264         case BLK_ZONE_COND_EMPTY:
 265                 if (!null_can_set_active(dev))
 266                         return false;
 267                 fallthrough;
 268         case BLK_ZONE_COND_CLOSED:
 269                 return null_can_open(dev);
 270         default:
 271                 /* Should never be called for other states */
 272                 WARN_ON(1);
 273                 return false;
 274         }
 275 }
 276
 277 static blk_status_t null_zone_write(struct nullb_cmd *cmd, sector_t sector,
 278                                     unsigned int nr_sectors, bool append)
 279 {
 280         struct nullb_device *dev = cmd->nq->dev;
 281         unsigned int zno = null_zone_no(dev, sector);
 282         struct blk_zone *zone = &dev->zones[zno];
 283         blk_status_t ret;
 284
 285         trace_nullb_zone_op(cmd, zno, zone->cond);
 286
 287         if (zone->type == BLK_ZONE_TYPE_CONVENTIONAL)
 288                 return null_process_cmd(cmd, REQ_OP_WRITE, sector, nr_sectors);
 289
 290         switch (zone->cond) {
 291         case BLK_ZONE_COND_FULL:
 292                 /* Cannot write to a full zone */
 293                 return BLK_STS_IOERR;
 294         case BLK_ZONE_COND_EMPTY:
 295         case BLK_ZONE_COND_CLOSED:
 296                 if (!null_has_zone_resources(dev, zone))
 297                         return BLK_STS_IOERR;
 298                 break;
 299         case BLK_ZONE_COND_IMP_OPEN:
 300         case BLK_ZONE_COND_EXP_OPEN:
 301                 break;
 302         default:
 303                 /* Invalid zone condition */
 304                 return BLK_STS_IOERR;
 305         }
 306
 307         /*
 308          * Regular writes must be at the write pointer position.
 309          * Zone append writes are automatically issued at the write
 310          * pointer and the position returned using the request or BIO
 311          * sector.
 312          */
 313         if (append) {
 314                 sector = zone->wp;
 315                 if (cmd->bio)
 316                         cmd->bio->bi_iter.bi_sector = sector;
 317                 else
 318                         cmd->rq->__sector = sector;
 319         } else if (sector != zone->wp) {
 320                 return BLK_STS_IOERR;
 321         }
 322
 323         if (zone->wp + nr_sectors > zone->start + zone->capacity)
 324                 return BLK_STS_IOERR;
 325
 326         if (zone->cond == BLK_ZONE_COND_CLOSED) {
 327                 dev->nr_zones_closed--;
 328                 dev->nr_zones_imp_open++;
 329         } else if (zone->cond == BLK_ZONE_COND_EMPTY) {
 330                 dev->nr_zones_imp_open++;
 331         }
 332         if (zone->cond != BLK_ZONE_COND_EXP_OPEN)
 333                 zone->cond = BLK_ZONE_COND_IMP_OPEN;
 334
 335         ret = null_process_cmd(cmd, REQ_OP_WRITE, sector, nr_sectors);
 336         if (ret != BLK_STS_OK)
 337                 return ret;
 338
 339         zone->wp += nr_sectors;
 340         if (zone->wp == zone->start + zone->capacity) {
 341                 if (zone->cond == BLK_ZONE_COND_EXP_OPEN)
 342                         dev->nr_zones_exp_open--;
 343                 else if (zone->cond == BLK_ZONE_COND_IMP_OPEN)
 344                         dev->nr_zones_imp_open--;
 345                 zone->cond = BLK_ZONE_COND_FULL;
 346         }
 347         return BLK_STS_OK;
 348 }
 349
 350 static blk_status_t null_open_zone(struct nullb_device *dev, struct blk_zone *zone)
 351 {
 352         if (zone->type == BLK_ZONE_TYPE_CONVENTIONAL)
 353                 return BLK_STS_IOERR;
 354
 355         switch (zone->cond) {
 356         case BLK_ZONE_COND_EXP_OPEN:
 357                 /* open operation on exp open is not an error */
 358                 return BLK_STS_OK;
 359         case BLK_ZONE_COND_EMPTY:
 360                 if (!null_has_zone_resources(dev, zone))
 361                         return BLK_STS_IOERR;
 362                 break;
 363         case BLK_ZONE_COND_IMP_OPEN:
 364                 dev->nr_zones_imp_open--;
 365                 break;
 366         case BLK_ZONE_COND_CLOSED:
 367                 if (!null_has_zone_resources(dev, zone))
 368                         return BLK_STS_IOERR;
 369                 dev->nr_zones_closed--;
 370                 break;
 371         case BLK_ZONE_COND_FULL:
 372         default:
 373                 return BLK_STS_IOERR;
 374         }
 375
 376         zone->cond = BLK_ZONE_COND_EXP_OPEN;
 377         dev->nr_zones_exp_open++;
 378
 379         return BLK_STS_OK;
 380 }
 381
 382 static blk_status_t null_finish_zone(struct nullb_device *dev, struct blk_zone *zone)
 383 {
 384         if (zone->type == BLK_ZONE_TYPE_CONVENTIONAL)
 385                 return BLK_STS_IOERR;
 386
 387         switch (zone->cond) {
 388         case BLK_ZONE_COND_FULL:
 389                 /* finish operation on full is not an error */
 390                 return BLK_STS_OK;
 391         case BLK_ZONE_COND_EMPTY:
 392                 if (!null_has_zone_resources(dev, zone))
 393                         return BLK_STS_IOERR;
 394                 break;
 395         case BLK_ZONE_COND_IMP_OPEN:
 396                 dev->nr_zones_imp_open--;
 397                 break;
 398         case BLK_ZONE_COND_EXP_OPEN:
 399                 dev->nr_zones_exp_open--;
 400                 break;
 401         case BLK_ZONE_COND_CLOSED:
 402                 if (!null_has_zone_resources(dev, zone))
 403                         return BLK_STS_IOERR;
 404                 dev->nr_zones_closed--;
 405                 break;
 406         default:
 407                 return BLK_STS_IOERR;
 408         }
 409
 410         zone->cond = BLK_ZONE_COND_FULL;
 411         zone->wp = zone->start + zone->len;
 412
 413         return BLK_STS_OK;
 414 }
 415
 416 static blk_status_t null_reset_zone(struct nullb_device *dev, struct blk_zone *zone)
 417 {
 418         if (zone->type == BLK_ZONE_TYPE_CONVENTIONAL)
 419                 return BLK_STS_IOERR;
 420
 421         switch (zone->cond) {
 422         case BLK_ZONE_COND_EMPTY:
 423                 /* reset operation on empty is not an error */
 424                 return BLK_STS_OK;
 425         case BLK_ZONE_COND_IMP_OPEN:
 426                 dev->nr_zones_imp_open--;
 427                 break;
 428         case BLK_ZONE_COND_EXP_OPEN:
 429                 dev->nr_zones_exp_open--;
 430                 break;
 431         case BLK_ZONE_COND_CLOSED:
 432                 dev->nr_zones_closed--;
 433                 break;
 434         case BLK_ZONE_COND_FULL:
 435                 break;
 436         default:
 437                 return BLK_STS_IOERR;
 438         }
 439
 440         zone->cond = BLK_ZONE_COND_EMPTY;
 441         zone->wp = zone->start;
 442
 443         return BLK_STS_OK;
 444 }
 445
 446 static blk_status_t null_zone_mgmt(struct nullb_cmd *cmd, enum req_opf op,
 447                                    sector_t sector)
 448 {
 449         struct nullb_device *dev = cmd->nq->dev;
 450         unsigned int zone_no = null_zone_no(dev, sector);
 451         struct blk_zone *zone = &dev->zones[zone_no];
 452         blk_status_t ret = BLK_STS_OK;
 453         size_t i;
 454
 455         switch (op) {
 456         case REQ_OP_ZONE_RESET_ALL:
 457                 for (i = dev->zone_nr_conv; i < dev->nr_zones; i++)
 458                         null_reset_zone(dev, &dev->zones[i]);
 459                 break;
 460         case REQ_OP_ZONE_RESET:
 461                 ret = null_reset_zone(dev, zone);
 462                 break;
 463         case REQ_OP_ZONE_OPEN:
 464                 ret = null_open_zone(dev, zone);
 465                 break;
 466         case REQ_OP_ZONE_CLOSE:
 467                 ret = null_close_zone(dev, zone);
 468                 break;
 469         case REQ_OP_ZONE_FINISH:
 470                 ret = null_finish_zone(dev, zone);
 471                 break;
 472         default:
 473                 return BLK_STS_NOTSUPP;
 474         }
 475
 476         if (ret == BLK_STS_OK)
 477                 trace_nullb_zone_op(cmd, zone_no, zone->cond);
 478
 479         return ret;
 480 }
 481
 482 blk_status_t null_process_zoned_cmd(struct nullb_cmd *cmd, enum req_opf op,
 483                                     sector_t sector, sector_t nr_sectors)
 484 {
 485         switch (op) {
 486         case REQ_OP_WRITE:
 487                 return null_zone_write(cmd, sector, nr_sectors, false);
 488         case REQ_OP_ZONE_APPEND:
 489                 return null_zone_write(cmd, sector, nr_sectors, true);
 490         case REQ_OP_ZONE_RESET:
 491         case REQ_OP_ZONE_RESET_ALL:
 492         case REQ_OP_ZONE_OPEN:
 493         case REQ_OP_ZONE_CLOSE:
 494         case REQ_OP_ZONE_FINISH:
 495                 return null_zone_mgmt(cmd, op, sector);
 496         default:
 497                 return null_process_cmd(cmd, op, sector, nr_sectors);
 498         }
 499 }