zbd.c

   1 /*
   2  * Copyright (C) 2018 Western Digital Corporation or its affiliates.
   3  *
   4  * This file is released under the GPL.
   5  */
   6
   7 #include <errno.h>
   8 #include <string.h>
   9 #include <stdlib.h>
  10 #include <fcntl.h>
  11 #include <sys/stat.h>
  12 #include <unistd.h>
  13
  14 #include "os/os.h"
  15 #include "file.h"
  16 #include "fio.h"
  17 #include "lib/pow2.h"
  18 #include "log.h"
  19 #include "oslib/asprintf.h"
  20 #include "smalloc.h"
  21 #include "verify.h"
  22 #include "pshared.h"
  23 #include "zbd.h"
  24
  25 /**
  26  * zbd_get_zoned_model - Get a device zoned model
  27  * @td: FIO thread data
  28  * @f: FIO file for which to get model information
  29  */
  30 int zbd_get_zoned_model(struct thread_data *td, struct fio_file *f,
  31                         enum zbd_zoned_model *model)
  32 {
  33         int ret;
  34
  35         if (td->io_ops && td->io_ops->get_zoned_model)
  36                 ret = td->io_ops->get_zoned_model(td, f, model);
  37         else
  38                 ret = blkzoned_get_zoned_model(td, f, model);
  39         if (ret < 0) {
  40                 td_verror(td, errno, "get zoned model failed");
  41                 log_err("%s: get zoned model failed (%d).\n",
  42                         f->file_name, errno);
  43         }
  44
  45         return ret;
  46 }
  47
  48 /**
  49  * zbd_report_zones - Get zone information
  50  * @td: FIO thread data.
  51  * @f: FIO file for which to get zone information
  52  * @offset: offset from which to report zones
  53  * @zones: Array of struct zbd_zone
  54  * @nr_zones: Size of @zones array
  55  *
  56  * Get zone information into @zones starting from the zone at offset @offset
  57  * for the device specified by @f.
  58  *
  59  * Returns the number of zones reported upon success and a negative error code
  60  * upon failure. If the zone report is empty, always assume an error (device
  61  * problem) and return -EIO.
  62  */
  63 int zbd_report_zones(struct thread_data *td, struct fio_file *f,
  64                      uint64_t offset, struct zbd_zone *zones,
  65                      unsigned int nr_zones)
  66 {
  67         int ret;
  68
  69         if (td->io_ops && td->io_ops->report_zones)
  70                 ret = td->io_ops->report_zones(td, f, offset, zones, nr_zones);
  71         else
  72                 ret = blkzoned_report_zones(td, f, offset, zones, nr_zones);
  73         if (ret < 0) {
  74                 td_verror(td, errno, "report zones failed");
  75                 log_err("%s: report zones from sector %llu failed (%d).\n",
  76                         f->file_name, (unsigned long long)offset >> 9, errno);
  77         } else if (ret == 0) {
  78                 td_verror(td, errno, "Empty zone report");
  79                 log_err("%s: report zones from sector %llu is empty.\n",
  80                         f->file_name, (unsigned long long)offset >> 9);
  81                 ret = -EIO;
  82         }
  83
  84         return ret;
  85 }
  86
  87 /**
  88  * zbd_reset_wp - reset the write pointer of a range of zones
  89  * @td: FIO thread data.
  90  * @f: FIO file for which to reset zones
  91  * @offset: Starting offset of the first zone to reset
  92  * @length: Length of the range of zones to reset
  93  *
  94  * Reset the write pointer of all zones in the range @offset...@offset+@length.
  95  * Returns 0 upon success and a negative error code upon failure.
  96  */
  97 int zbd_reset_wp(struct thread_data *td, struct fio_file *f,
  98                  uint64_t offset, uint64_t length)
  99 {
 100         int ret;
 101
 102         if (td->io_ops && td->io_ops->reset_wp)
 103                 ret = td->io_ops->reset_wp(td, f, offset, length);
 104         else
 105                 ret = blkzoned_reset_wp(td, f, offset, length);
 106         if (ret < 0) {
 107                 td_verror(td, errno, "resetting wp failed");
 108                 log_err("%s: resetting wp for %llu sectors at sector %llu failed (%d).\n",
 109                         f->file_name, (unsigned long long)length >> 9,
 110                         (unsigned long long)offset >> 9, errno);
 111         }
 112
 113         return ret;
 114 }
 115
 116 /**
 117  * zbd_zone_idx - convert an offset into a zone number
 118  * @f: file pointer.
 119  * @offset: offset in bytes. If this offset is in the first zone_size bytes
 120  *          past the disk size then the index of the sentinel is returned.
 121  */
 122 static uint32_t zbd_zone_idx(const struct fio_file *f, uint64_t offset)
 123 {
 124         uint32_t zone_idx;
 125
 126         if (f->zbd_info->zone_size_log2 > 0)
 127                 zone_idx = offset >> f->zbd_info->zone_size_log2;
 128         else
 129                 zone_idx = offset / f->zbd_info->zone_size;
 130
 131         return min(zone_idx, f->zbd_info->nr_zones);
 132 }
 133
 134 /**
 135  * zbd_zone_end - Return zone end location
 136  * @z: zone info pointer.
 137  */
 138 static inline uint64_t zbd_zone_end(const struct fio_zone_info *z)
 139 {
 140         return (z+1)->start;
 141 }
 142
 143 /**
 144  * zbd_zone_capacity_end - Return zone capacity limit end location
 145  * @z: zone info pointer.
 146  */
 147 static inline uint64_t zbd_zone_capacity_end(const struct fio_zone_info *z)
 148 {
 149         return z->start + z->capacity;
 150 }
 151
 152 /**
 153  * zbd_zone_full - verify whether a minimum number of bytes remain in a zone
 154  * @f: file pointer.
 155  * @z: zone info pointer.
 156  * @required: minimum number of bytes that must remain in a zone.
 157  *
 158  * The caller must hold z->mutex.
 159  */
 160 static bool zbd_zone_full(const struct fio_file *f, struct fio_zone_info *z,
 161                           uint64_t required)
 162 {
 163         assert((required & 511) == 0);
 164
 165         return z->has_wp &&
 166                 z->wp + required > zbd_zone_capacity_end(z);
 167 }
 168
 169 static void zone_lock(struct thread_data *td, const struct fio_file *f,
 170                       struct fio_zone_info *z)
 171 {
 172         struct zoned_block_device_info *zbd = f->zbd_info;
 173         uint32_t nz = z - zbd->zone_info;
 174
 175         /* A thread should never lock zones outside its working area. */
 176         assert(f->min_zone <= nz && nz < f->max_zone);
 177
 178         assert(z->has_wp);
 179
 180         /*
 181          * Lock the io_u target zone. The zone will be unlocked if io_u offset
 182          * is changed or when io_u completes and zbd_put_io() executed.
 183          * To avoid multiple jobs doing asynchronous I/Os from deadlocking each
 184          * other waiting for zone locks when building an io_u batch, first
 185          * only trylock the zone. If the zone is already locked by another job,
 186          * process the currently queued I/Os so that I/O progress is made and
 187          * zones unlocked.
 188          */
 189         if (pthread_mutex_trylock(&z->mutex) != 0) {
 190                 if (!td_ioengine_flagged(td, FIO_SYNCIO))
 191                         io_u_quiesce(td);
 192                 pthread_mutex_lock(&z->mutex);
 193         }
 194 }
 195
 196 static inline void zone_unlock(struct fio_zone_info *z)
 197 {
 198         int ret;
 199
 200         assert(z->has_wp);
 201         ret = pthread_mutex_unlock(&z->mutex);
 202         assert(!ret);
 203 }
 204
 205 static bool is_valid_offset(const struct fio_file *f, uint64_t offset)
 206 {
 207         return (uint64_t)(offset - f->file_offset) < f->io_size;
 208 }
 209
 210 static inline struct fio_zone_info *get_zone(const struct fio_file *f,
 211                                              unsigned int zone_nr)
 212 {
 213         return &f->zbd_info->zone_info[zone_nr];
 214 }
 215
 216 /* Verify whether direct I/O is used for all host-managed zoned drives. */
 217 static bool zbd_using_direct_io(void)
 218 {
 219         struct thread_data *td;
 220         struct fio_file *f;
 221         int i, j;
 222
 223         for_each_td(td, i) {
 224                 if (td->o.odirect || !(td->o.td_ddir & TD_DDIR_WRITE))
 225                         continue;
 226                 for_each_file(td, f, j) {
 227                         if (f->zbd_info &&
 228                             f->zbd_info->model == ZBD_HOST_MANAGED)
 229                                 return false;
 230                 }
 231         }
 232
 233         return true;
 234 }
 235
 236 /* Whether or not the I/O range for f includes one or more sequential zones */
 237 static bool zbd_is_seq_job(struct fio_file *f)
 238 {
 239         uint32_t zone_idx, zone_idx_b, zone_idx_e;
 240
 241         assert(f->zbd_info);
 242         if (f->io_size == 0)
 243                 return false;
 244         zone_idx_b = zbd_zone_idx(f, f->file_offset);
 245         zone_idx_e = zbd_zone_idx(f, f->file_offset + f->io_size - 1);
 246         for (zone_idx = zone_idx_b; zone_idx <= zone_idx_e; zone_idx++)
 247                 if (get_zone(f, zone_idx)->has_wp)
 248                         return true;
 249
 250         return false;
 251 }
 252
 253 /*
 254  * Verify whether offset and size parameters are aligned with zone boundaries.
 255  */
 256 static bool zbd_verify_sizes(void)
 257 {
 258         const struct fio_zone_info *z;
 259         struct thread_data *td;
 260         struct fio_file *f;
 261         uint64_t new_offset, new_end;
 262         uint32_t zone_idx;
 263         int i, j;
 264
 265         for_each_td(td, i) {
 266                 for_each_file(td, f, j) {
 267                         if (!f->zbd_info)
 268                                 continue;
 269                         if (f->file_offset >= f->real_file_size)
 270                                 continue;
 271                         if (!zbd_is_seq_job(f))
 272                                 continue;
 273
 274                         if (!td->o.zone_size) {
 275                                 td->o.zone_size = f->zbd_info->zone_size;
 276                                 if (!td->o.zone_size) {
 277                                         log_err("%s: invalid 0 zone size\n",
 278                                                 f->file_name);
 279                                         return false;
 280                                 }
 281                         } else if (td->o.zone_size != f->zbd_info->zone_size) {
 282                                 log_err("%s: job parameter zonesize %llu does not match disk zone size %llu.\n",
 283                                         f->file_name, (unsigned long long) td->o.zone_size,
 284                                         (unsigned long long) f->zbd_info->zone_size);
 285                                 return false;
 286                         }
 287
 288                         if (td->o.zone_skip &&
 289                             (td->o.zone_skip < td->o.zone_size ||
 290                              td->o.zone_skip % td->o.zone_size)) {
 291                                 log_err("%s: zoneskip %llu is not a multiple of the device zone size %llu.\n",
 292                                         f->file_name, (unsigned long long) td->o.zone_skip,
 293                                         (unsigned long long) td->o.zone_size);
 294                                 return false;
 295                         }
 296
 297                         zone_idx = zbd_zone_idx(f, f->file_offset);
 298                         z = get_zone(f, zone_idx);
 299                         if ((f->file_offset != z->start) &&
 300                             (td->o.td_ddir != TD_DDIR_READ)) {
 301                                 new_offset = zbd_zone_end(z);
 302                                 if (new_offset >= f->file_offset + f->io_size) {
 303                                         log_info("%s: io_size must be at least one zone\n",
 304                                                  f->file_name);
 305                                         return false;
 306                                 }
 307                                 log_info("%s: rounded up offset from %llu to %llu\n",
 308                                          f->file_name, (unsigned long long) f->file_offset,
 309                                          (unsigned long long) new_offset);
 310                                 f->io_size -= (new_offset - f->file_offset);
 311                                 f->file_offset = new_offset;
 312                         }
 313                         zone_idx = zbd_zone_idx(f, f->file_offset + f->io_size);
 314                         z = get_zone(f, zone_idx);
 315                         new_end = z->start;
 316                         if ((td->o.td_ddir != TD_DDIR_READ) &&
 317                             (f->file_offset + f->io_size != new_end)) {
 318                                 if (new_end <= f->file_offset) {
 319                                         log_info("%s: io_size must be at least one zone\n",
 320                                                  f->file_name);
 321                                         return false;
 322                                 }
 323                                 log_info("%s: rounded down io_size from %llu to %llu\n",
 324                                          f->file_name, (unsigned long long) f->io_size,
 325                                          (unsigned long long) new_end - f->file_offset);
 326                                 f->io_size = new_end - f->file_offset;
 327                         }
 328                 }
 329         }
 330
 331         return true;
 332 }
 333
 334 static bool zbd_verify_bs(void)
 335 {
 336         struct thread_data *td;
 337         struct fio_file *f;
 338         uint32_t zone_size;
 339         int i, j, k;
 340
 341         for_each_td(td, i) {
 342                 for_each_file(td, f, j) {
 343                         if (!f->zbd_info)
 344                                 continue;
 345                         zone_size = f->zbd_info->zone_size;
 346                         for (k = 0; k < FIO_ARRAY_SIZE(td->o.bs); k++) {
 347                                 if (td->o.verify != VERIFY_NONE &&
 348                                     zone_size % td->o.bs[k] != 0) {
 349                                         log_info("%s: block size %llu is not a divisor of the zone size %d\n",
 350                                                  f->file_name, td->o.bs[k],
 351                                                  zone_size);
 352                                         return false;
 353                                 }
 354                         }
 355                 }
 356         }
 357         return true;
 358 }
 359
 360 static int ilog2(uint64_t i)
 361 {
 362         int log = -1;
 363
 364         while (i) {
 365                 i >>= 1;
 366                 log++;
 367         }
 368         return log;
 369 }
 370
 371 /*
 372  * Initialize f->zbd_info for devices that are not zoned block devices. This
 373  * allows to execute a ZBD workload against a non-ZBD device.
 374  */
 375 static int init_zone_info(struct thread_data *td, struct fio_file *f)
 376 {
 377         uint32_t nr_zones;
 378         struct fio_zone_info *p;
 379         uint64_t zone_size = td->o.zone_size;
 380         uint64_t zone_capacity = td->o.zone_capacity;
 381         struct zoned_block_device_info *zbd_info = NULL;
 382         int i;
 383
 384         if (zone_size == 0) {
 385                 log_err("%s: Specifying the zone size is mandatory for regular block devices with --zonemode=zbd\n\n",
 386                         f->file_name);
 387                 return 1;
 388         }
 389
 390         if (zone_size < 512) {
 391                 log_err("%s: zone size must be at least 512 bytes for --zonemode=zbd\n\n",
 392                         f->file_name);
 393                 return 1;
 394         }
 395
 396         if (zone_capacity == 0)
 397                 zone_capacity = zone_size;
 398
 399         if (zone_capacity > zone_size) {
 400                 log_err("%s: job parameter zonecapacity %llu is larger than zone size %llu\n",
 401                         f->file_name, (unsigned long long) td->o.zone_capacity,
 402                         (unsigned long long) td->o.zone_size);
 403                 return 1;
 404         }
 405
 406         nr_zones = (f->real_file_size + zone_size - 1) / zone_size;
 407         zbd_info = scalloc(1, sizeof(*zbd_info) +
 408                            (nr_zones + 1) * sizeof(zbd_info->zone_info[0]));
 409         if (!zbd_info)
 410                 return -ENOMEM;
 411
 412         mutex_init_pshared(&zbd_info->mutex);
 413         zbd_info->refcount = 1;
 414         p = &zbd_info->zone_info[0];
 415         for (i = 0; i < nr_zones; i++, p++) {
 416                 mutex_init_pshared_with_type(&p->mutex,
 417                                              PTHREAD_MUTEX_RECURSIVE);
 418                 p->start = i * zone_size;
 419                 p->wp = p->start;
 420                 p->type = ZBD_ZONE_TYPE_SWR;
 421                 p->cond = ZBD_ZONE_COND_EMPTY;
 422                 p->capacity = zone_capacity;
 423                 p->has_wp = 1;
 424         }
 425         /* a sentinel */
 426         p->start = nr_zones * zone_size;
 427
 428         f->zbd_info = zbd_info;
 429         f->zbd_info->zone_size = zone_size;
 430         f->zbd_info->zone_size_log2 = is_power_of_2(zone_size) ?
 431                 ilog2(zone_size) : 0;
 432         f->zbd_info->nr_zones = nr_zones;
 433         return 0;
 434 }
 435
 436 /*
 437  * Maximum number of zones to report in one operation.
 438  */
 439 #define ZBD_REPORT_MAX_ZONES    8192U
 440
 441 /*
 442  * Parse the device zone report and store it in f->zbd_info. Must be called
 443  * only for devices that are zoned, namely those with a model != ZBD_NONE.
 444  */
 445 static int parse_zone_info(struct thread_data *td, struct fio_file *f)
 446 {
 447         int nr_zones, nrz;
 448         struct zbd_zone *zones, *z;
 449         struct fio_zone_info *p;
 450         uint64_t zone_size, offset;
 451         struct zoned_block_device_info *zbd_info = NULL;
 452         int i, j, ret = -ENOMEM;
 453
 454         zones = calloc(ZBD_REPORT_MAX_ZONES, sizeof(struct zbd_zone));
 455         if (!zones)
 456                 goto out;
 457
 458         nrz = zbd_report_zones(td, f, 0, zones, ZBD_REPORT_MAX_ZONES);
 459         if (nrz < 0) {
 460                 ret = nrz;
 461                 log_info("fio: report zones (offset 0) failed for %s (%d).\n",
 462                          f->file_name, -ret);
 463                 goto out;
 464         }
 465
 466         zone_size = zones[0].len;
 467         nr_zones = (f->real_file_size + zone_size - 1) / zone_size;
 468
 469         if (td->o.zone_size == 0) {
 470                 td->o.zone_size = zone_size;
 471         } else if (td->o.zone_size != zone_size) {
 472                 log_err("fio: %s job parameter zonesize %llu does not match disk zone size %llu.\n",
 473                         f->file_name, (unsigned long long) td->o.zone_size,
 474                         (unsigned long long) zone_size);
 475                 ret = -EINVAL;
 476                 goto out;
 477         }
 478
 479         dprint(FD_ZBD, "Device %s has %d zones of size %llu KB\n", f->file_name,
 480                nr_zones, (unsigned long long) zone_size / 1024);
 481
 482         zbd_info = scalloc(1, sizeof(*zbd_info) +
 483                            (nr_zones + 1) * sizeof(zbd_info->zone_info[0]));
 484         if (!zbd_info)
 485                 goto out;
 486         mutex_init_pshared(&zbd_info->mutex);
 487         zbd_info->refcount = 1;
 488         p = &zbd_info->zone_info[0];
 489         for (offset = 0, j = 0; j < nr_zones;) {
 490                 z = &zones[0];
 491                 for (i = 0; i < nrz; i++, j++, z++, p++) {
 492                         mutex_init_pshared_with_type(&p->mutex,
 493                                                      PTHREAD_MUTEX_RECURSIVE);
 494                         p->start = z->start;
 495                         p->capacity = z->capacity;
 496                         switch (z->cond) {
 497                         case ZBD_ZONE_COND_NOT_WP:
 498                         case ZBD_ZONE_COND_FULL:
 499                                 p->wp = p->start + p->capacity;
 500                                 break;
 501                         default:
 502                                 assert(z->start <= z->wp);
 503                                 assert(z->wp <= z->start + zone_size);
 504                                 p->wp = z->wp;
 505                                 break;
 506                         }
 507
 508                         switch (z->type) {
 509                         case ZBD_ZONE_TYPE_SWR:
 510                                 p->has_wp = 1;
 511                                 break;
 512                         default:
 513                                 p->has_wp = 0;
 514                         }
 515                         p->type = z->type;
 516                         p->cond = z->cond;
 517
 518                         if (j > 0 && p->start != p[-1].start + zone_size) {
 519                                 log_info("%s: invalid zone data\n",
 520                                          f->file_name);
 521                                 ret = -EINVAL;
 522                                 goto out;
 523                         }
 524                 }
 525                 z--;
 526                 offset = z->start + z->len;
 527                 if (j >= nr_zones)
 528                         break;
 529                 nrz = zbd_report_zones(td, f, offset, zones,
 530                                        min((uint32_t)(nr_zones - j),
 531                                            ZBD_REPORT_MAX_ZONES));
 532                 if (nrz < 0) {
 533                         ret = nrz;
 534                         log_info("fio: report zones (offset %llu) failed for %s (%d).\n",
 535                                  (unsigned long long)offset,
 536                                  f->file_name, -ret);
 537                         goto out;
 538                 }
 539         }
 540
 541         /* a sentinel */
 542         zbd_info->zone_info[nr_zones].start = offset;
 543
 544         f->zbd_info = zbd_info;
 545         f->zbd_info->zone_size = zone_size;
 546         f->zbd_info->zone_size_log2 = is_power_of_2(zone_size) ?
 547                 ilog2(zone_size) : 0;
 548         f->zbd_info->nr_zones = nr_zones;
 549         zbd_info = NULL;
 550         ret = 0;
 551
 552 out:
 553         sfree(zbd_info);
 554         free(zones);
 555         return ret;
 556 }
 557
 558 /*
 559  * Allocate zone information and store it into f->zbd_info if zonemode=zbd.
 560  *
 561  * Returns 0 upon success and a negative error code upon failure.
 562  */
 563 static int zbd_create_zone_info(struct thread_data *td, struct fio_file *f)
 564 {
 565         enum zbd_zoned_model zbd_model;
 566         int ret;
 567
 568         assert(td->o.zone_mode == ZONE_MODE_ZBD);
 569
 570         ret = zbd_get_zoned_model(td, f, &zbd_model);
 571         if (ret)
 572                 return ret;
 573
 574         switch (zbd_model) {
 575         case ZBD_IGNORE:
 576                 return 0;
 577         case ZBD_HOST_AWARE:
 578         case ZBD_HOST_MANAGED:
 579                 ret = parse_zone_info(td, f);
 580                 break;
 581         case ZBD_NONE:
 582                 ret = init_zone_info(td, f);
 583                 break;
 584         default:
 585                 td_verror(td, EINVAL, "Unsupported zoned model");
 586                 log_err("Unsupported zoned model\n");
 587                 return -EINVAL;
 588         }
 589
 590         if (ret == 0) {
 591                 f->zbd_info->model = zbd_model;
 592                 f->zbd_info->max_open_zones = td->o.max_open_zones;
 593         }
 594         return ret;
 595 }
 596
 597 void zbd_free_zone_info(struct fio_file *f)
 598 {
 599         uint32_t refcount;
 600
 601         assert(f->zbd_info);
 602
 603         pthread_mutex_lock(&f->zbd_info->mutex);
 604         refcount = --f->zbd_info->refcount;
 605         pthread_mutex_unlock(&f->zbd_info->mutex);
 606
 607         assert((int32_t)refcount >= 0);
 608         if (refcount == 0)
 609                 sfree(f->zbd_info);
 610         f->zbd_info = NULL;
 611 }
 612
 613 /*
 614  * Initialize f->zbd_info.
 615  *
 616  * Returns 0 upon success and a negative error code upon failure.
 617  *
 618  * Note: this function can only work correctly if it is called before the first
 619  * fio fork() call.
 620  */
 621 static int zbd_init_zone_info(struct thread_data *td, struct fio_file *file)
 622 {
 623         struct thread_data *td2;
 624         struct fio_file *f2;
 625         int i, j, ret;
 626
 627         for_each_td(td2, i) {
 628                 for_each_file(td2, f2, j) {
 629                         if (td2 == td && f2 == file)
 630                                 continue;
 631                         if (!f2->zbd_info ||
 632                             strcmp(f2->file_name, file->file_name) != 0)
 633                                 continue;
 634                         file->zbd_info = f2->zbd_info;
 635                         file->zbd_info->refcount++;
 636                         return 0;
 637                 }
 638         }
 639
 640         ret = zbd_create_zone_info(td, file);
 641         if (ret < 0)
 642                 td_verror(td, -ret, "zbd_create_zone_info() failed");
 643         return ret;
 644 }
 645
 646 static bool zbd_open_zone(struct thread_data *td, const struct fio_file *f,
 647                           uint32_t zone_idx);
 648 static int zbd_reset_zone(struct thread_data *td, struct fio_file *f,
 649                           struct fio_zone_info *z);
 650
 651 int zbd_setup_files(struct thread_data *td)
 652 {
 653         struct fio_file *f;
 654         int i;
 655
 656         for_each_file(td, f, i) {
 657                 if (zbd_init_zone_info(td, f))
 658                         return 1;
 659         }
 660
 661         if (!zbd_using_direct_io()) {
 662                 log_err("Using direct I/O is mandatory for writing to ZBD drives\n\n");
 663                 return 1;
 664         }
 665
 666         if (!zbd_verify_sizes())
 667                 return 1;
 668
 669         if (!zbd_verify_bs())
 670                 return 1;
 671
 672         for_each_file(td, f, i) {
 673                 struct zoned_block_device_info *zbd = f->zbd_info;
 674                 struct fio_zone_info *z;
 675                 int zi;
 676
 677                 if (!zbd)
 678                         continue;
 679
 680                 f->min_zone = zbd_zone_idx(f, f->file_offset);
 681                 f->max_zone = zbd_zone_idx(f, f->file_offset + f->io_size);
 682
 683                 /*
 684                  * When all zones in the I/O range are conventional, io_size
 685                  * can be smaller than zone size, making min_zone the same
 686                  * as max_zone. This is why the assert below needs to be made
 687                  * conditional.
 688                  */
 689                 if (zbd_is_seq_job(f))
 690                         assert(f->min_zone < f->max_zone);
 691
 692                 zbd->max_open_zones = zbd->max_open_zones ?: ZBD_MAX_OPEN_ZONES;
 693
 694                 if (td->o.max_open_zones > 0 &&
 695                     zbd->max_open_zones != td->o.max_open_zones) {
 696                         log_err("Different 'max_open_zones' values\n");
 697                         return 1;
 698                 }
 699                 if (zbd->max_open_zones > ZBD_MAX_OPEN_ZONES) {
 700                         log_err("'max_open_zones' value is limited by %u\n", ZBD_MAX_OPEN_ZONES);
 701                         return 1;
 702                 }
 703
 704                 for (zi = f->min_zone; zi < f->max_zone; zi++) {
 705                         z = &zbd->zone_info[zi];
 706                         if (z->cond != ZBD_ZONE_COND_IMP_OPEN &&
 707                             z->cond != ZBD_ZONE_COND_EXP_OPEN)
 708                                 continue;
 709                         if (zbd_open_zone(td, f, zi))
 710                                 continue;
 711                         /*
 712                          * If the number of open zones exceeds specified limits,
 713                          * reset all extra open zones.
 714                          */
 715                         if (zbd_reset_zone(td, f, z) < 0) {
 716                                 log_err("Failed to reest zone %d\n", zi);
 717                                 return 1;
 718                         }
 719                 }
 720         }
 721
 722         return 0;
 723 }
 724
 725 static inline unsigned int zbd_zone_nr(const struct fio_file *f,
 726                                        struct fio_zone_info *zone)
 727 {
 728         return zone - f->zbd_info->zone_info;
 729 }
 730
 731 /**
 732  * zbd_reset_zone - reset the write pointer of a single zone
 733  * @td: FIO thread data.
 734  * @f: FIO file associated with the disk for which to reset a write pointer.
 735  * @z: Zone to reset.
 736  *
 737  * Returns 0 upon success and a negative error code upon failure.
 738  *
 739  * The caller must hold z->mutex.
 740  */
 741 static int zbd_reset_zone(struct thread_data *td, struct fio_file *f,
 742                           struct fio_zone_info *z)
 743 {
 744         uint64_t offset = z->start;
 745         uint64_t length = (z+1)->start - offset;
 746         uint64_t data_in_zone = z->wp - z->start;
 747         int ret = 0;
 748
 749         if (!data_in_zone)
 750                 return 0;
 751
 752         assert(is_valid_offset(f, offset + length - 1));
 753
 754         dprint(FD_ZBD, "%s: resetting wp of zone %u.\n", f->file_name,
 755                 zbd_zone_nr(f, z));
 756         switch (f->zbd_info->model) {
 757         case ZBD_HOST_AWARE:
 758         case ZBD_HOST_MANAGED:
 759                 ret = zbd_reset_wp(td, f, offset, length);
 760                 if (ret < 0)
 761                         return ret;
 762                 break;
 763         default:
 764                 break;
 765         }
 766
 767         pthread_mutex_lock(&f->zbd_info->mutex);
 768         f->zbd_info->sectors_with_data -= data_in_zone;
 769         f->zbd_info->wp_sectors_with_data -= data_in_zone;
 770         pthread_mutex_unlock(&f->zbd_info->mutex);
 771         z->wp = z->start;
 772         z->verify_block = 0;
 773
 774         td->ts.nr_zone_resets++;
 775
 776         return ret;
 777 }
 778
 779 /* The caller must hold f->zbd_info->mutex */
 780 static void zbd_close_zone(struct thread_data *td, const struct fio_file *f,
 781                            unsigned int zone_idx)
 782 {
 783         uint32_t open_zone_idx = 0;
 784
 785         for (; open_zone_idx < f->zbd_info->num_open_zones; open_zone_idx++) {
 786                 if (f->zbd_info->open_zones[open_zone_idx] == zone_idx)
 787                         break;
 788         }
 789         if (open_zone_idx == f->zbd_info->num_open_zones)
 790                 return;
 791
 792         dprint(FD_ZBD, "%s: closing zone %d\n", f->file_name, zone_idx);
 793         memmove(f->zbd_info->open_zones + open_zone_idx,
 794                 f->zbd_info->open_zones + open_zone_idx + 1,
 795                 (ZBD_MAX_OPEN_ZONES - (open_zone_idx + 1)) *
 796                 sizeof(f->zbd_info->open_zones[0]));
 797         f->zbd_info->num_open_zones--;
 798         td->num_open_zones--;
 799         get_zone(f, zone_idx)->open = 0;
 800 }
 801
 802 /*
 803  * Reset a range of zones. Returns 0 upon success and 1 upon failure.
 804  * @td: fio thread data.
 805  * @f: fio file for which to reset zones
 806  * @zb: first zone to reset.
 807  * @ze: first zone not to reset.
 808  * @all_zones: whether to reset all zones or only those zones for which the
 809  *      write pointer is not a multiple of td->o.min_bs[DDIR_WRITE].
 810  */
 811 static int zbd_reset_zones(struct thread_data *td, struct fio_file *f,
 812                            struct fio_zone_info *const zb,
 813                            struct fio_zone_info *const ze, bool all_zones)
 814 {
 815         struct fio_zone_info *z;
 816         const uint32_t min_bs = td->o.min_bs[DDIR_WRITE];
 817         bool reset_wp;
 818         int res = 0;
 819
 820         assert(min_bs);
 821
 822         dprint(FD_ZBD, "%s: examining zones %u .. %u\n", f->file_name,
 823                 zbd_zone_nr(f, zb), zbd_zone_nr(f, ze));
 824         for (z = zb; z < ze; z++) {
 825                 uint32_t nz = zbd_zone_nr(f, z);
 826
 827                 if (!z->has_wp)
 828                         continue;
 829                 zone_lock(td, f, z);
 830                 if (all_zones) {
 831                         pthread_mutex_lock(&f->zbd_info->mutex);
 832                         zbd_close_zone(td, f, nz);
 833                         pthread_mutex_unlock(&f->zbd_info->mutex);
 834
 835                         reset_wp = z->wp != z->start;
 836                 } else {
 837                         reset_wp = z->wp % min_bs != 0;
 838                 }
 839                 if (reset_wp) {
 840                         dprint(FD_ZBD, "%s: resetting zone %u\n",
 841                                f->file_name, zbd_zone_nr(f, z));
 842                         if (zbd_reset_zone(td, f, z) < 0)
 843                                 res = 1;
 844                 }
 845                 zone_unlock(z);
 846         }
 847
 848         return res;
 849 }
 850
 851 /*
 852  * Reset zbd_info.write_cnt, the counter that counts down towards the next
 853  * zone reset.
 854  */
 855 static void _zbd_reset_write_cnt(const struct thread_data *td,
 856                                  const struct fio_file *f)
 857 {
 858         assert(0 <= td->o.zrf.u.f && td->o.zrf.u.f <= 1);
 859
 860         f->zbd_info->write_cnt = td->o.zrf.u.f ?
 861                 min(1.0 / td->o.zrf.u.f, 0.0 + UINT_MAX) : UINT_MAX;
 862 }
 863
 864 static void zbd_reset_write_cnt(const struct thread_data *td,
 865                                 const struct fio_file *f)
 866 {
 867         pthread_mutex_lock(&f->zbd_info->mutex);
 868         _zbd_reset_write_cnt(td, f);
 869         pthread_mutex_unlock(&f->zbd_info->mutex);
 870 }
 871
 872 static bool zbd_dec_and_reset_write_cnt(const struct thread_data *td,
 873                                         const struct fio_file *f)
 874 {
 875         uint32_t write_cnt = 0;
 876
 877         pthread_mutex_lock(&f->zbd_info->mutex);
 878         assert(f->zbd_info->write_cnt);
 879         if (f->zbd_info->write_cnt)
 880                 write_cnt = --f->zbd_info->write_cnt;
 881         if (write_cnt == 0)
 882                 _zbd_reset_write_cnt(td, f);
 883         pthread_mutex_unlock(&f->zbd_info->mutex);
 884
 885         return write_cnt == 0;
 886 }
 887
 888 enum swd_action {
 889         CHECK_SWD,
 890         SET_SWD,
 891 };
 892
 893 /* Calculate the number of sectors with data (swd) and perform action 'a' */
 894 static uint64_t zbd_process_swd(struct thread_data *td,
 895                                 const struct fio_file *f, enum swd_action a)
 896 {
 897         struct fio_zone_info *zb, *ze, *z;
 898         uint64_t swd = 0;
 899         uint64_t wp_swd = 0;
 900
 901         zb = get_zone(f, f->min_zone);
 902         ze = get_zone(f, f->max_zone);
 903         for (z = zb; z < ze; z++) {
 904                 if (z->has_wp) {
 905                         zone_lock(td, f, z);
 906                         wp_swd += z->wp - z->start;
 907                 }
 908                 swd += z->wp - z->start;
 909         }
 910         pthread_mutex_lock(&f->zbd_info->mutex);
 911         switch (a) {
 912         case CHECK_SWD:
 913                 assert(f->zbd_info->sectors_with_data == swd);
 914                 assert(f->zbd_info->wp_sectors_with_data == wp_swd);
 915                 break;
 916         case SET_SWD:
 917                 f->zbd_info->sectors_with_data = swd;
 918                 f->zbd_info->wp_sectors_with_data = wp_swd;
 919                 break;
 920         }
 921         pthread_mutex_unlock(&f->zbd_info->mutex);
 922         for (z = zb; z < ze; z++)
 923                 if (z->has_wp)
 924                         zone_unlock(z);
 925
 926         return swd;
 927 }
 928
 929 /*
 930  * The swd check is useful for debugging but takes too much time to leave
 931  * it enabled all the time. Hence it is disabled by default.
 932  */
 933 static const bool enable_check_swd = false;
 934
 935 /* Check whether the values of zbd_info.*sectors_with_data are correct. */
 936 static void zbd_check_swd(struct thread_data *td, const struct fio_file *f)
 937 {
 938         if (!enable_check_swd)
 939                 return;
 940
 941         zbd_process_swd(td, f, CHECK_SWD);
 942 }
 943
 944 void zbd_file_reset(struct thread_data *td, struct fio_file *f)
 945 {
 946         struct fio_zone_info *zb, *ze;
 947         uint64_t swd;
 948
 949         if (!f->zbd_info || !td_write(td))
 950                 return;
 951
 952         zb = get_zone(f, f->min_zone);
 953         ze = get_zone(f, f->max_zone);
 954         swd = zbd_process_swd(td, f, SET_SWD);
 955         dprint(FD_ZBD, "%s(%s): swd = %" PRIu64 "\n", __func__, f->file_name,
 956                swd);
 957         /*
 958          * If data verification is enabled reset the affected zones before
 959          * writing any data to avoid that a zone reset has to be issued while
 960          * writing data, which causes data loss.
 961          */
 962         zbd_reset_zones(td, f, zb, ze, td->o.verify != VERIFY_NONE &&
 963                         td->runstate != TD_VERIFYING);
 964         zbd_reset_write_cnt(td, f);
 965 }
 966
 967 /* The caller must hold f->zbd_info->mutex. */
 968 static bool is_zone_open(const struct thread_data *td, const struct fio_file *f,
 969                          unsigned int zone_idx)
 970 {
 971         struct zoned_block_device_info *zbdi = f->zbd_info;
 972         int i;
 973
 974         assert(td->o.job_max_open_zones == 0 || td->num_open_zones <= td->o.job_max_open_zones);
 975         assert(td->o.job_max_open_zones <= zbdi->max_open_zones);
 976         assert(zbdi->num_open_zones <= zbdi->max_open_zones);
 977
 978         for (i = 0; i < zbdi->num_open_zones; i++)
 979                 if (zbdi->open_zones[i] == zone_idx)
 980                         return true;
 981
 982         return false;
 983 }
 984
 985 /*
 986  * Open a ZBD zone if it was not yet open. Returns true if either the zone was
 987  * already open or if opening a new zone is allowed. Returns false if the zone
 988  * was not yet open and opening a new zone would cause the zone limit to be
 989  * exceeded.
 990  */
 991 static bool zbd_open_zone(struct thread_data *td, const struct fio_file *f,
 992                           uint32_t zone_idx)
 993 {
 994         const uint32_t min_bs = td->o.min_bs[DDIR_WRITE];
 995         struct fio_zone_info *z = get_zone(f, zone_idx);
 996         bool res = true;
 997
 998         if (z->cond == ZBD_ZONE_COND_OFFLINE)
 999                 return false;
1000
1001         /*
1002          * Skip full zones with data verification enabled because resetting a
1003          * zone causes data loss and hence causes verification to fail.
1004          */
1005         if (td->o.verify != VERIFY_NONE && zbd_zone_full(f, z, min_bs))
1006                 return false;
1007
1008         pthread_mutex_lock(&f->zbd_info->mutex);
1009         if (is_zone_open(td, f, zone_idx)) {
1010                 /*
1011                  * If the zone is already open and going to be full by writes
1012                  * in-flight, handle it as a full zone instead of an open zone.
1013                  */
1014                 if (z->wp >= zbd_zone_capacity_end(z))
1015                         res = false;
1016                 goto out;
1017         }
1018         res = false;
1019         /* Zero means no limit */
1020         if (td->o.job_max_open_zones > 0 &&
1021             td->num_open_zones >= td->o.job_max_open_zones)
1022                 goto out;
1023         if (f->zbd_info->num_open_zones >= f->zbd_info->max_open_zones)
1024                 goto out;
1025         dprint(FD_ZBD, "%s: opening zone %d\n", f->file_name, zone_idx);
1026         f->zbd_info->open_zones[f->zbd_info->num_open_zones++] = zone_idx;
1027         td->num_open_zones++;
1028         z->open = 1;
1029         res = true;
1030
1031 out:
1032         pthread_mutex_unlock(&f->zbd_info->mutex);
1033         return res;
1034 }
1035
1036 /* Anything goes as long as it is not a constant. */
1037 static uint32_t pick_random_zone_idx(const struct fio_file *f,
1038                                      const struct io_u *io_u)
1039 {
1040         return io_u->offset * f->zbd_info->num_open_zones / f->real_file_size;
1041 }
1042
1043 /*
1044  * Modify the offset of an I/O unit that does not refer to an open zone such
1045  * that it refers to an open zone. Close an open zone and open a new zone if
1046  * necessary. The open zone is searched across sequential zones.
1047  * This algorithm can only work correctly if all write pointers are
1048  * a multiple of the fio block size. The caller must neither hold z->mutex
1049  * nor f->zbd_info->mutex. Returns with z->mutex held upon success.
1050  */
1051 static struct fio_zone_info *zbd_convert_to_open_zone(struct thread_data *td,
1052                                                       struct io_u *io_u)
1053 {
1054         const uint32_t min_bs = td->o.min_bs[io_u->ddir];
1055         struct fio_file *f = io_u->file;
1056         struct fio_zone_info *z;
1057         unsigned int open_zone_idx = -1;
1058         uint32_t zone_idx, new_zone_idx;
1059         int i;
1060         bool wait_zone_close;
1061
1062         assert(is_valid_offset(f, io_u->offset));
1063
1064         if (td->o.max_open_zones || td->o.job_max_open_zones) {
1065                 /*
1066                  * This statement accesses f->zbd_info->open_zones[] on purpose
1067                  * without locking.
1068                  */
1069                 zone_idx = f->zbd_info->open_zones[pick_random_zone_idx(f, io_u)];
1070         } else {
1071                 zone_idx = zbd_zone_idx(f, io_u->offset);
1072         }
1073         if (zone_idx < f->min_zone)
1074                 zone_idx = f->min_zone;
1075         else if (zone_idx >= f->max_zone)
1076                 zone_idx = f->max_zone - 1;
1077         dprint(FD_ZBD, "%s(%s): starting from zone %d (offset %lld, buflen %lld)\n",
1078                __func__, f->file_name, zone_idx, io_u->offset, io_u->buflen);
1079
1080         /*
1081          * Since z->mutex is the outer lock and f->zbd_info->mutex the inner
1082          * lock it can happen that the state of the zone with index zone_idx
1083          * has changed after 'z' has been assigned and before f->zbd_info->mutex
1084          * has been obtained. Hence the loop.
1085          */
1086         for (;;) {
1087                 uint32_t tmp_idx;
1088
1089                 z = get_zone(f, zone_idx);
1090                 if (z->has_wp)
1091                         zone_lock(td, f, z);
1092                 pthread_mutex_lock(&f->zbd_info->mutex);
1093                 if (z->has_wp) {
1094                         if (z->cond != ZBD_ZONE_COND_OFFLINE &&
1095                             td->o.max_open_zones == 0 && td->o.job_max_open_zones == 0)
1096                                 goto examine_zone;
1097                         if (f->zbd_info->num_open_zones == 0) {
1098                                 dprint(FD_ZBD, "%s(%s): no zones are open\n",
1099                                        __func__, f->file_name);
1100                                 goto open_other_zone;
1101                         }
1102                 }
1103
1104                 /*
1105                  * List of opened zones is per-device, shared across all threads.
1106                  * Start with quasi-random candidate zone.
1107                  * Ignore zones which don't belong to thread's offset/size area.
1108                  */
1109                 open_zone_idx = pick_random_zone_idx(f, io_u);
1110                 assert(open_zone_idx < f->zbd_info->num_open_zones);
1111                 tmp_idx = open_zone_idx;
1112                 for (i = 0; i < f->zbd_info->num_open_zones; i++) {
1113                         uint32_t tmpz;
1114
1115                         if (tmp_idx >= f->zbd_info->num_open_zones)
1116                                 tmp_idx = 0;
1117                         tmpz = f->zbd_info->open_zones[tmp_idx];
1118                         if (f->min_zone <= tmpz && tmpz < f->max_zone) {
1119                                 open_zone_idx = tmp_idx;
1120                                 goto found_candidate_zone;
1121                         }
1122
1123                         tmp_idx++;
1124                 }
1125
1126                 dprint(FD_ZBD, "%s(%s): no candidate zone\n",
1127                         __func__, f->file_name);
1128                 pthread_mutex_unlock(&f->zbd_info->mutex);
1129                 if (z->has_wp)
1130                         zone_unlock(z);
1131                 return NULL;
1132
1133 found_candidate_zone:
1134                 new_zone_idx = f->zbd_info->open_zones[open_zone_idx];
1135                 if (new_zone_idx == zone_idx)
1136                         break;
1137                 zone_idx = new_zone_idx;
1138                 pthread_mutex_unlock(&f->zbd_info->mutex);
1139                 if (z->has_wp)
1140                         zone_unlock(z);
1141         }
1142
1143         /* Both z->mutex and f->zbd_info->mutex are held. */
1144
1145 examine_zone:
1146         if (z->wp + min_bs <= zbd_zone_capacity_end(z)) {
1147                 pthread_mutex_unlock(&f->zbd_info->mutex);
1148                 goto out;
1149         }
1150
1151 open_other_zone:
1152         /* Check if number of open zones reaches one of limits. */
1153         wait_zone_close =
1154                 f->zbd_info->num_open_zones == f->max_zone - f->min_zone ||
1155                 (td->o.max_open_zones &&
1156                  f->zbd_info->num_open_zones == td->o.max_open_zones) ||
1157                 (td->o.job_max_open_zones &&
1158                  td->num_open_zones == td->o.job_max_open_zones);
1159
1160         pthread_mutex_unlock(&f->zbd_info->mutex);
1161
1162         /* Only z->mutex is held. */
1163
1164         /*
1165          * When number of open zones reaches to one of limits, wait for
1166          * zone close before opening a new zone.
1167          */
1168         if (wait_zone_close) {
1169                 dprint(FD_ZBD, "%s(%s): quiesce to allow open zones to close\n",
1170                        __func__, f->file_name);
1171                 io_u_quiesce(td);
1172         }
1173
1174         /* Zone 'z' is full, so try to open a new zone. */
1175         for (i = f->io_size / f->zbd_info->zone_size; i > 0; i--) {
1176                 zone_idx++;
1177                 if (z->has_wp)
1178                         zone_unlock(z);
1179                 z++;
1180                 if (!is_valid_offset(f, z->start)) {
1181                         /* Wrap-around. */
1182                         zone_idx = f->min_zone;
1183                         z = get_zone(f, zone_idx);
1184                 }
1185                 assert(is_valid_offset(f, z->start));
1186                 if (!z->has_wp)
1187                         continue;
1188                 zone_lock(td, f, z);
1189                 if (z->open)
1190                         continue;
1191                 if (zbd_open_zone(td, f, zone_idx))
1192                         goto out;
1193         }
1194
1195         /* Only z->mutex is held. */
1196
1197         /* Check whether the write fits in any of the already opened zones. */
1198         pthread_mutex_lock(&f->zbd_info->mutex);
1199         for (i = 0; i < f->zbd_info->num_open_zones; i++) {
1200                 zone_idx = f->zbd_info->open_zones[i];
1201                 if (zone_idx < f->min_zone || zone_idx >= f->max_zone)
1202                         continue;
1203                 pthread_mutex_unlock(&f->zbd_info->mutex);
1204                 zone_unlock(z);
1205
1206                 z = get_zone(f, zone_idx);
1207
1208                 zone_lock(td, f, z);
1209                 if (z->wp + min_bs <= zbd_zone_capacity_end(z))
1210                         goto out;
1211                 pthread_mutex_lock(&f->zbd_info->mutex);
1212         }
1213         pthread_mutex_unlock(&f->zbd_info->mutex);
1214         zone_unlock(z);
1215         dprint(FD_ZBD, "%s(%s): did not open another zone\n", __func__,
1216                f->file_name);
1217         return NULL;
1218
1219 out:
1220         dprint(FD_ZBD, "%s(%s): returning zone %d\n", __func__, f->file_name,
1221                zone_idx);
1222         io_u->offset = z->start;
1223         assert(z->has_wp);
1224         assert(z->cond != ZBD_ZONE_COND_OFFLINE);
1225         return z;
1226 }
1227
1228 /* The caller must hold z->mutex. */
1229 static struct fio_zone_info *zbd_replay_write_order(struct thread_data *td,
1230                                                     struct io_u *io_u,
1231                                                     struct fio_zone_info *z)
1232 {
1233         const struct fio_file *f = io_u->file;
1234         const uint32_t min_bs = td->o.min_bs[DDIR_WRITE];
1235
1236         if (!zbd_open_zone(td, f, zbd_zone_nr(f, z))) {
1237                 zone_unlock(z);
1238                 z = zbd_convert_to_open_zone(td, io_u);
1239                 assert(z);
1240         }
1241
1242         if (z->verify_block * min_bs >= z->capacity) {
1243                 log_err("%s: %d * %d >= %llu\n", f->file_name, z->verify_block,
1244                         min_bs, (unsigned long long)z->capacity);
1245                 /*
1246                  * If the assertion below fails during a test run, adding
1247                  * "--experimental_verify=1" to the command line may help.
1248                  */
1249                 assert(false);
1250         }
1251         io_u->offset = z->start + z->verify_block * min_bs;
1252         if (io_u->offset + io_u->buflen >= zbd_zone_capacity_end(z)) {
1253                 log_err("%s: %llu + %llu >= %lu\n", f->file_name, io_u->offset,
1254                         io_u->buflen, zbd_zone_capacity_end(z));
1255                 assert(false);
1256         }
1257         z->verify_block += io_u->buflen / min_bs;
1258
1259         return z;
1260 }
1261
1262 /*
1263  * Find another zone for which @io_u fits in the readable data in the zone.
1264  * Search in zones @zb + 1 .. @zl. For random workload, also search in zones
1265  * @zb - 1 .. @zf.
1266  *
1267  * Either returns NULL or returns a zone pointer. When the zone has write
1268  * pointer, hold the mutex for the zone.
1269  */
1270 static struct fio_zone_info *
1271 zbd_find_zone(struct thread_data *td, struct io_u *io_u,
1272               struct fio_zone_info *zb, struct fio_zone_info *zl)
1273 {
1274         const uint32_t min_bs = td->o.min_bs[io_u->ddir];
1275         struct fio_file *f = io_u->file;
1276         struct fio_zone_info *z1, *z2;
1277         const struct fio_zone_info *const zf = get_zone(f, f->min_zone);
1278
1279         /*
1280          * Skip to the next non-empty zone in case of sequential I/O and to
1281          * the nearest non-empty zone in case of random I/O.
1282          */
1283         for (z1 = zb + 1, z2 = zb - 1; z1 < zl || z2 >= zf; z1++, z2--) {
1284                 if (z1 < zl && z1->cond != ZBD_ZONE_COND_OFFLINE) {
1285                         if (z1->has_wp)
1286                                 zone_lock(td, f, z1);
1287                         if (z1->start + min_bs <= z1->wp)
1288                                 return z1;
1289                         if (z1->has_wp)
1290                                 zone_unlock(z1);
1291                 } else if (!td_random(td)) {
1292                         break;
1293                 }
1294                 if (td_random(td) && z2 >= zf &&
1295                     z2->cond != ZBD_ZONE_COND_OFFLINE) {
1296                         if (z2->has_wp)
1297                                 zone_lock(td, f, z2);
1298                         if (z2->start + min_bs <= z2->wp)
1299                                 return z2;
1300                         if (z2->has_wp)
1301                                 zone_unlock(z2);
1302                 }
1303         }
1304         dprint(FD_ZBD, "%s: adjusting random read offset failed\n",
1305                f->file_name);
1306         return NULL;
1307 }
1308
1309 /**
1310  * zbd_end_zone_io - update zone status at command completion
1311  * @io_u: I/O unit
1312  * @z: zone info pointer
1313  *
1314  * If the write command made the zone full, close it.
1315  *
1316  * The caller must hold z->mutex.
1317  */
1318 static void zbd_end_zone_io(struct thread_data *td, const struct io_u *io_u,
1319                             struct fio_zone_info *z)
1320 {
1321         const struct fio_file *f = io_u->file;
1322
1323         if (io_u->ddir == DDIR_WRITE &&
1324             io_u->offset + io_u->buflen >= zbd_zone_capacity_end(z)) {
1325                 pthread_mutex_lock(&f->zbd_info->mutex);
1326                 zbd_close_zone(td, f, zbd_zone_nr(f, z));
1327                 pthread_mutex_unlock(&f->zbd_info->mutex);
1328         }
1329 }
1330
1331 /**
1332  * zbd_queue_io - update the write pointer of a sequential zone
1333  * @io_u: I/O unit
1334  * @success: Whether or not the I/O unit has been queued successfully
1335  * @q: queueing status (busy, completed or queued).
1336  *
1337  * For write and trim operations, update the write pointer of the I/O unit
1338  * target zone.
1339  */
1340 static void zbd_queue_io(struct thread_data *td, struct io_u *io_u, int q,
1341                          bool success)
1342 {
1343         const struct fio_file *f = io_u->file;
1344         struct zoned_block_device_info *zbd_info = f->zbd_info;
1345         struct fio_zone_info *z;
1346         uint32_t zone_idx;
1347         uint64_t zone_end;
1348
1349         if (!zbd_info)
1350                 return;
1351
1352         zone_idx = zbd_zone_idx(f, io_u->offset);
1353         assert(zone_idx < zbd_info->nr_zones);
1354         z = get_zone(f, zone_idx);
1355
1356         assert(z->has_wp);
1357
1358         if (!success)
1359                 goto unlock;
1360
1361         dprint(FD_ZBD,
1362                "%s: queued I/O (%lld, %llu) for zone %u\n",
1363                f->file_name, io_u->offset, io_u->buflen, zone_idx);
1364
1365         switch (io_u->ddir) {
1366         case DDIR_WRITE:
1367                 zone_end = min((uint64_t)(io_u->offset + io_u->buflen),
1368                                zbd_zone_capacity_end(z));
1369                 pthread_mutex_lock(&zbd_info->mutex);
1370                 /*
1371                  * z->wp > zone_end means that one or more I/O errors
1372                  * have occurred.
1373                  */
1374                 if (z->wp <= zone_end) {
1375                         zbd_info->sectors_with_data += zone_end - z->wp;
1376                         zbd_info->wp_sectors_with_data += zone_end - z->wp;
1377                 }
1378                 pthread_mutex_unlock(&zbd_info->mutex);
1379                 z->wp = zone_end;
1380                 break;
1381         case DDIR_TRIM:
1382                 assert(z->wp == z->start);
1383                 break;
1384         default:
1385                 break;
1386         }
1387
1388         if (q == FIO_Q_COMPLETED && !io_u->error)
1389                 zbd_end_zone_io(td, io_u, z);
1390
1391 unlock:
1392         if (!success || q != FIO_Q_QUEUED) {
1393                 /* BUSY or COMPLETED: unlock the zone */
1394                 zone_unlock(z);
1395                 io_u->zbd_put_io = NULL;
1396         }
1397 }
1398
1399 /**
1400  * zbd_put_io - Unlock an I/O unit target zone lock
1401  * @io_u: I/O unit
1402  */
1403 static void zbd_put_io(struct thread_data *td, const struct io_u *io_u)
1404 {
1405         const struct fio_file *f = io_u->file;
1406         struct zoned_block_device_info *zbd_info = f->zbd_info;
1407         struct fio_zone_info *z;
1408         uint32_t zone_idx;
1409
1410         if (!zbd_info)
1411                 return;
1412
1413         zone_idx = zbd_zone_idx(f, io_u->offset);
1414         assert(zone_idx < zbd_info->nr_zones);
1415         z = get_zone(f, zone_idx);
1416
1417         assert(z->has_wp);
1418
1419         dprint(FD_ZBD,
1420                "%s: terminate I/O (%lld, %llu) for zone %u\n",
1421                f->file_name, io_u->offset, io_u->buflen, zone_idx);
1422
1423         zbd_end_zone_io(td, io_u, z);
1424
1425         zone_unlock(z);
1426         zbd_check_swd(td, f);
1427 }
1428
1429 /*
1430  * Windows and MacOS do not define this.
1431  */
1432 #ifndef EREMOTEIO
1433 #define EREMOTEIO       121     /* POSIX value */
1434 #endif
1435
1436 bool zbd_unaligned_write(int error_code)
1437 {
1438         switch (error_code) {
1439         case EIO:
1440         case EREMOTEIO:
1441                 return true;
1442         }
1443         return false;
1444 }
1445
1446 /**
1447  * setup_zbd_zone_mode - handle zoneskip as necessary for ZBD drives
1448  * @td: FIO thread data.
1449  * @io_u: FIO I/O unit.
1450  *
1451  * For sequential workloads, change the file offset to skip zoneskip bytes when
1452  * no more IO can be performed in the current zone.
1453  * - For read workloads, zoneskip is applied when the io has reached the end of
1454  *   the zone or the zone write position (when td->o.read_beyond_wp is false).
1455  * - For write workloads, zoneskip is applied when the zone is full.
1456  * This applies only to read and write operations.
1457  */
1458 void setup_zbd_zone_mode(struct thread_data *td, struct io_u *io_u)
1459 {
1460         struct fio_file *f = io_u->file;
1461         enum fio_ddir ddir = io_u->ddir;
1462         struct fio_zone_info *z;
1463         uint32_t zone_idx;
1464
1465         assert(td->o.zone_mode == ZONE_MODE_ZBD);
1466         assert(td->o.zone_size);
1467
1468         zone_idx = zbd_zone_idx(f, f->last_pos[ddir]);
1469         z = get_zone(f, zone_idx);
1470
1471         /*
1472          * When the zone capacity is smaller than the zone size and the I/O is
1473          * sequential write, skip to zone end if the latest position is at the
1474          * zone capacity limit.
1475          */
1476         if (z->capacity < f->zbd_info->zone_size && !td_random(td) &&
1477             ddir == DDIR_WRITE &&
1478             f->last_pos[ddir] >= zbd_zone_capacity_end(z)) {
1479                 dprint(FD_ZBD,
1480                        "%s: Jump from zone capacity limit to zone end:"
1481                        " (%llu -> %llu) for zone %u (%llu)\n",
1482                        f->file_name, (unsigned long long) f->last_pos[ddir],
1483                        (unsigned long long) zbd_zone_end(z), zone_idx,
1484                        (unsigned long long) z->capacity);
1485                 td->io_skip_bytes += zbd_zone_end(z) - f->last_pos[ddir];
1486                 f->last_pos[ddir] = zbd_zone_end(z);
1487         }
1488
1489         /*
1490          * zone_skip is valid only for sequential workloads.
1491          */
1492         if (td_random(td) || !td->o.zone_skip)
1493                 return;
1494
1495         /*
1496          * It is time to switch to a new zone if:
1497          * - zone_bytes == zone_size bytes have already been accessed
1498          * - The last position reached the end of the current zone.
1499          * - For reads with td->o.read_beyond_wp == false, the last position
1500          *   reached the zone write pointer.
1501          */
1502         if (td->zone_bytes >= td->o.zone_size ||
1503             f->last_pos[ddir] >= zbd_zone_end(z) ||
1504             (ddir == DDIR_READ &&
1505              (!td->o.read_beyond_wp) && f->last_pos[ddir] >= z->wp)) {
1506                 /*
1507                  * Skip zones.
1508                  */
1509                 td->zone_bytes = 0;
1510                 f->file_offset += td->o.zone_size + td->o.zone_skip;
1511
1512                 /*
1513                  * Wrap from the beginning, if we exceed the file size
1514                  */
1515                 if (f->file_offset >= f->real_file_size)
1516                         f->file_offset = get_start_offset(td, f);
1517
1518                 f->last_pos[ddir] = f->file_offset;
1519                 td->io_skip_bytes += td->o.zone_skip;
1520         }
1521 }
1522
1523 /**
1524  * zbd_adjust_ddir - Adjust an I/O direction for zonemode=zbd.
1525  *
1526  * @td: FIO thread data.
1527  * @io_u: FIO I/O unit.
1528  * @ddir: I/O direction before adjustment.
1529  *
1530  * Return adjusted I/O direction.
1531  */
1532 enum fio_ddir zbd_adjust_ddir(struct thread_data *td, struct io_u *io_u,
1533                               enum fio_ddir ddir)
1534 {
1535         /*
1536          * In case read direction is chosen for the first random I/O, fio with
1537          * zonemode=zbd stops because no data can be read from zoned block
1538          * devices with all empty zones. Overwrite the first I/O direction as
1539          * write to make sure data to read exists.
1540          */
1541         if (ddir != DDIR_READ || !td_rw(td))
1542                 return ddir;
1543
1544         if (io_u->file->zbd_info->sectors_with_data ||
1545             td->o.read_beyond_wp)
1546                 return DDIR_READ;
1547
1548         return DDIR_WRITE;
1549 }
1550
1551 /**
1552  * zbd_adjust_block - adjust the offset and length as necessary for ZBD drives
1553  * @td: FIO thread data.
1554  * @io_u: FIO I/O unit.
1555  *
1556  * Locking strategy: returns with z->mutex locked if and only if z refers
1557  * to a sequential zone and if io_u_accept is returned. z is the zone that
1558  * corresponds to io_u->offset at the end of this function.
1559  */
1560 enum io_u_action zbd_adjust_block(struct thread_data *td, struct io_u *io_u)
1561 {
1562         struct fio_file *f = io_u->file;
1563         uint32_t zone_idx_b;
1564         struct fio_zone_info *zb, *zl, *orig_zb;
1565         uint32_t orig_len = io_u->buflen;
1566         uint32_t min_bs = td->o.min_bs[io_u->ddir];
1567         uint64_t new_len;
1568         int64_t range;
1569
1570         if (!f->zbd_info)
1571                 return io_u_accept;
1572
1573         assert(min_bs);
1574         assert(is_valid_offset(f, io_u->offset));
1575         assert(io_u->buflen);
1576         zone_idx_b = zbd_zone_idx(f, io_u->offset);
1577         zb = get_zone(f, zone_idx_b);
1578         orig_zb = zb;
1579
1580         if (!zb->has_wp) {
1581                 /* Accept non-write I/Os for conventional zones. */
1582                 if (io_u->ddir != DDIR_WRITE)
1583                         return io_u_accept;
1584                 /*
1585                  * Make sure that writes to conventional zones
1586                  * don't cross over to any sequential zones.
1587                  */
1588                 if (!(zb + 1)->has_wp ||
1589                     io_u->offset + io_u->buflen <= (zb + 1)->start)
1590                         return io_u_accept;
1591
1592                 if (io_u->offset + min_bs > (zb + 1)->start) {
1593                         dprint(FD_IO,
1594                                "%s: off=%llu + min_bs=%u > next zone %lu\n",
1595                                f->file_name, io_u->offset, min_bs,
1596                                (zb + 1)->start);
1597                         io_u->offset = zb->start + (zb + 1)->start - io_u->offset;
1598                         new_len = min(io_u->buflen, (zb + 1)->start - io_u->offset);
1599                 } else {
1600                         new_len = (zb + 1)->start - io_u->offset;
1601                 }
1602                 io_u->buflen = new_len / min_bs * min_bs;
1603                 return io_u_accept;
1604         }
1605
1606         /*
1607          * Accept the I/O offset for reads if reading beyond the write pointer
1608          * is enabled.
1609          */
1610         if (zb->cond != ZBD_ZONE_COND_OFFLINE &&
1611             io_u->ddir == DDIR_READ && td->o.read_beyond_wp)
1612                 return io_u_accept;
1613
1614         zbd_check_swd(td, f);
1615
1616         zone_lock(td, f, zb);
1617
1618         switch (io_u->ddir) {
1619         case DDIR_READ:
1620                 if (td->runstate == TD_VERIFYING && td_write(td)) {
1621                         zb = zbd_replay_write_order(td, io_u, zb);
1622                         /*
1623                          * Since we return with the zone lock still held,
1624                          * add an annotation to let Coverity know that it
1625                          * is intentional.
1626                          */
1627                         /* coverity[missing_unlock] */
1628                         goto accept;
1629                 }
1630                 /*
1631                  * Check that there is enough written data in the zone to do an
1632                  * I/O of at least min_bs B. If there isn't, find a new zone for
1633                  * the I/O.
1634                  */
1635                 range = zb->cond != ZBD_ZONE_COND_OFFLINE ?
1636                         zb->wp - zb->start : 0;
1637                 if (range < min_bs ||
1638                     ((!td_random(td)) && (io_u->offset + min_bs > zb->wp))) {
1639                         zone_unlock(zb);
1640                         zl = get_zone(f, f->max_zone);
1641                         zb = zbd_find_zone(td, io_u, zb, zl);
1642                         if (!zb) {
1643                                 dprint(FD_ZBD,
1644                                        "%s: zbd_find_zone(%lld, %llu) failed\n",
1645                                        f->file_name, io_u->offset,
1646                                        io_u->buflen);
1647                                 goto eof;
1648                         }
1649                         /*
1650                          * zbd_find_zone() returned a zone with a range of at
1651                          * least min_bs.
1652                          */
1653                         range = zb->wp - zb->start;
1654                         assert(range >= min_bs);
1655
1656                         if (!td_random(td))
1657                                 io_u->offset = zb->start;
1658                 }
1659                 /*
1660                  * Make sure the I/O is within the zone valid data range while
1661                  * maximizing the I/O size and preserving randomness.
1662                  */
1663                 if (range <= io_u->buflen)
1664                         io_u->offset = zb->start;
1665                 else if (td_random(td))
1666                         io_u->offset = zb->start +
1667                                 ((io_u->offset - orig_zb->start) %
1668                                  (range - io_u->buflen)) / min_bs * min_bs;
1669                 /*
1670                  * When zbd_find_zone() returns a conventional zone,
1671                  * we can simply accept the new i/o offset here.
1672                  */
1673                 if (!zb->has_wp)
1674                         return io_u_accept;
1675                 /*
1676                  * Make sure the I/O does not cross over the zone wp position.
1677                  */
1678                 new_len = min((unsigned long long)io_u->buflen,
1679                               (unsigned long long)(zb->wp - io_u->offset));
1680                 new_len = new_len / min_bs * min_bs;
1681                 if (new_len < io_u->buflen) {
1682                         io_u->buflen = new_len;
1683                         dprint(FD_IO, "Changed length from %u into %llu\n",
1684                                orig_len, io_u->buflen);
1685                 }
1686                 assert(zb->start <= io_u->offset);
1687                 assert(io_u->offset + io_u->buflen <= zb->wp);
1688                 goto accept;
1689         case DDIR_WRITE:
1690                 if (io_u->buflen > f->zbd_info->zone_size)
1691                         goto eof;
1692                 if (!zbd_open_zone(td, f, zone_idx_b)) {
1693                         zone_unlock(zb);
1694                         zb = zbd_convert_to_open_zone(td, io_u);
1695                         if (!zb)
1696                                 goto eof;
1697                         zone_idx_b = zbd_zone_nr(f, zb);
1698                 }
1699                 /* Check whether the zone reset threshold has been exceeded */
1700                 if (td->o.zrf.u.f) {
1701                         if (f->zbd_info->wp_sectors_with_data >=
1702                             f->io_size * td->o.zrt.u.f &&
1703                             zbd_dec_and_reset_write_cnt(td, f)) {
1704                                 zb->reset_zone = 1;
1705                         }
1706                 }
1707                 /* Reset the zone pointer if necessary */
1708                 if (zb->reset_zone || zbd_zone_full(f, zb, min_bs)) {
1709                         assert(td->o.verify == VERIFY_NONE);
1710                         /*
1711                          * Since previous write requests may have been submitted
1712                          * asynchronously and since we will submit the zone
1713                          * reset synchronously, wait until previously submitted
1714                          * write requests have completed before issuing a
1715                          * zone reset.
1716                          */
1717                         io_u_quiesce(td);
1718                         zb->reset_zone = 0;
1719                         if (zbd_reset_zone(td, f, zb) < 0)
1720                                 goto eof;
1721
1722                         if (zb->capacity < min_bs) {
1723                                 log_err("zone capacity %llu smaller than minimum block size %d\n",
1724                                         (unsigned long long)zb->capacity,
1725                                         min_bs);
1726                                 goto eof;
1727                         }
1728                 }
1729                 /* Make writes occur at the write pointer */
1730                 assert(!zbd_zone_full(f, zb, min_bs));
1731                 io_u->offset = zb->wp;
1732                 if (!is_valid_offset(f, io_u->offset)) {
1733                         dprint(FD_ZBD, "Dropped request with offset %llu\n",
1734                                io_u->offset);
1735                         goto eof;
1736                 }
1737                 /*
1738                  * Make sure that the buflen is a multiple of the minimal
1739                  * block size. Give up if shrinking would make the request too
1740                  * small.
1741                  */
1742                 new_len = min((unsigned long long)io_u->buflen,
1743                               zbd_zone_capacity_end(zb) - io_u->offset);
1744                 new_len = new_len / min_bs * min_bs;
1745                 if (new_len == io_u->buflen)
1746                         goto accept;
1747                 if (new_len >= min_bs) {
1748                         io_u->buflen = new_len;
1749                         dprint(FD_IO, "Changed length from %u into %llu\n",
1750                                orig_len, io_u->buflen);
1751                         goto accept;
1752                 }
1753                 log_err("Zone remainder %lld smaller than minimum block size %d\n",
1754                         (zbd_zone_capacity_end(zb) - io_u->offset),
1755                         min_bs);
1756                 goto eof;
1757         case DDIR_TRIM:
1758                 /* fall-through */
1759         case DDIR_SYNC:
1760         case DDIR_DATASYNC:
1761         case DDIR_SYNC_FILE_RANGE:
1762         case DDIR_WAIT:
1763         case DDIR_LAST:
1764         case DDIR_INVAL:
1765                 goto accept;
1766         }
1767
1768         assert(false);
1769
1770 accept:
1771         assert(zb->has_wp);
1772         assert(zb->cond != ZBD_ZONE_COND_OFFLINE);
1773         assert(!io_u->zbd_queue_io);
1774         assert(!io_u->zbd_put_io);
1775         io_u->zbd_queue_io = zbd_queue_io;
1776         io_u->zbd_put_io = zbd_put_io;
1777         return io_u_accept;
1778
1779 eof:
1780         if (zb && zb->has_wp)
1781                 zone_unlock(zb);
1782         return io_u_eof;
1783 }
1784
1785 /* Return a string with ZBD statistics */
1786 char *zbd_write_status(const struct thread_stat *ts)
1787 {
1788         char *res;
1789
1790         if (asprintf(&res, "; %llu zone resets", (unsigned long long) ts->nr_zone_resets) < 0)
1791                 return NULL;
1792         return res;
1793 }