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