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 /* The caller must hold f->zbd_info->mutex */
 691 static void zbd_close_zone(struct thread_data *td, const struct fio_file *f,
 692                            unsigned int open_zone_idx)
 693 {
 694         uint32_t zone_idx;
 695
 696         assert(open_zone_idx < f->zbd_info->num_open_zones);
 697         zone_idx = f->zbd_info->open_zones[open_zone_idx];
 698         memmove(f->zbd_info->open_zones + open_zone_idx,
 699                 f->zbd_info->open_zones + open_zone_idx + 1,
 700                 (ZBD_MAX_OPEN_ZONES - (open_zone_idx + 1)) *
 701                 sizeof(f->zbd_info->open_zones[0]));
 702         f->zbd_info->num_open_zones--;
 703         f->zbd_info->zone_info[zone_idx].open = 0;
 704 }
 705
 706 /*
 707  * Reset a range of zones. Returns 0 upon success and 1 upon failure.
 708  * @td: fio thread data.
 709  * @f: fio file for which to reset zones
 710  * @zb: first zone to reset.
 711  * @ze: first zone not to reset.
 712  * @all_zones: whether to reset all zones or only those zones for which the
 713  *      write pointer is not a multiple of td->o.min_bs[DDIR_WRITE].
 714  */
 715 static int zbd_reset_zones(struct thread_data *td, struct fio_file *f,
 716                            struct fio_zone_info *const zb,
 717                            struct fio_zone_info *const ze, bool all_zones)
 718 {
 719         struct fio_zone_info *z;
 720         const uint32_t min_bs = td->o.min_bs[DDIR_WRITE];
 721         bool reset_wp;
 722         int res = 0;
 723
 724         assert(min_bs);
 725
 726         dprint(FD_ZBD, "%s: examining zones %u .. %u\n", f->file_name,
 727                 zbd_zone_nr(f->zbd_info, zb), zbd_zone_nr(f->zbd_info, ze));
 728         for (z = zb; z < ze; z++) {
 729                 uint32_t nz = z - f->zbd_info->zone_info;
 730
 731                 if (!zbd_zone_swr(z))
 732                         continue;
 733                 zone_lock(td, z);
 734                 if (all_zones) {
 735                         unsigned int i;
 736
 737                         pthread_mutex_lock(&f->zbd_info->mutex);
 738                         for (i = 0; i < f->zbd_info->num_open_zones; i++) {
 739                                 if (f->zbd_info->open_zones[i] == nz)
 740                                         zbd_close_zone(td, f, i);
 741                         }
 742                         pthread_mutex_unlock(&f->zbd_info->mutex);
 743
 744                         reset_wp = z->wp != z->start;
 745                 } else {
 746                         reset_wp = z->wp % min_bs != 0;
 747                 }
 748                 if (reset_wp) {
 749                         dprint(FD_ZBD, "%s: resetting zone %u\n",
 750                                f->file_name,
 751                                zbd_zone_nr(f->zbd_info, z));
 752                         if (zbd_reset_zone(td, f, z) < 0)
 753                                 res = 1;
 754                 }
 755                 pthread_mutex_unlock(&z->mutex);
 756         }
 757
 758         return res;
 759 }
 760
 761 /*
 762  * Reset zbd_info.write_cnt, the counter that counts down towards the next
 763  * zone reset.
 764  */
 765 static void zbd_reset_write_cnt(const struct thread_data *td,
 766                                 const struct fio_file *f)
 767 {
 768         assert(0 <= td->o.zrf.u.f && td->o.zrf.u.f <= 1);
 769
 770         pthread_mutex_lock(&f->zbd_info->mutex);
 771         f->zbd_info->write_cnt = td->o.zrf.u.f ?
 772                 min(1.0 / td->o.zrf.u.f, 0.0 + UINT_MAX) : UINT_MAX;
 773         pthread_mutex_unlock(&f->zbd_info->mutex);
 774 }
 775
 776 static bool zbd_dec_and_reset_write_cnt(const struct thread_data *td,
 777                                         const struct fio_file *f)
 778 {
 779         uint32_t write_cnt = 0;
 780
 781         pthread_mutex_lock(&f->zbd_info->mutex);
 782         assert(f->zbd_info->write_cnt);
 783         if (f->zbd_info->write_cnt)
 784                 write_cnt = --f->zbd_info->write_cnt;
 785         if (write_cnt == 0)
 786                 zbd_reset_write_cnt(td, f);
 787         pthread_mutex_unlock(&f->zbd_info->mutex);
 788
 789         return write_cnt == 0;
 790 }
 791
 792 enum swd_action {
 793         CHECK_SWD,
 794         SET_SWD,
 795 };
 796
 797 /* Calculate the number of sectors with data (swd) and perform action 'a' */
 798 static uint64_t zbd_process_swd(const struct fio_file *f, enum swd_action a)
 799 {
 800         struct fio_zone_info *zb, *ze, *z;
 801         uint64_t swd = 0;
 802
 803         zb = &f->zbd_info->zone_info[zbd_zone_idx(f, f->file_offset)];
 804         ze = &f->zbd_info->zone_info[zbd_zone_idx(f, f->file_offset +
 805                                                   f->io_size)];
 806         for (z = zb; z < ze; z++) {
 807                 pthread_mutex_lock(&z->mutex);
 808                 swd += z->wp - z->start;
 809         }
 810         pthread_mutex_lock(&f->zbd_info->mutex);
 811         switch (a) {
 812         case CHECK_SWD:
 813                 assert(f->zbd_info->sectors_with_data == swd);
 814                 break;
 815         case SET_SWD:
 816                 f->zbd_info->sectors_with_data = swd;
 817                 break;
 818         }
 819         pthread_mutex_unlock(&f->zbd_info->mutex);
 820         for (z = zb; z < ze; z++)
 821                 pthread_mutex_unlock(&z->mutex);
 822
 823         return swd;
 824 }
 825
 826 /*
 827  * The swd check is useful for debugging but takes too much time to leave
 828  * it enabled all the time. Hence it is disabled by default.
 829  */
 830 static const bool enable_check_swd = false;
 831
 832 /* Check whether the value of zbd_info.sectors_with_data is correct. */
 833 static void zbd_check_swd(const struct fio_file *f)
 834 {
 835         if (!enable_check_swd)
 836                 return;
 837
 838         zbd_process_swd(f, CHECK_SWD);
 839 }
 840
 841 static void zbd_init_swd(struct fio_file *f)
 842 {
 843         uint64_t swd;
 844
 845         if (!enable_check_swd)
 846                 return;
 847
 848         swd = zbd_process_swd(f, SET_SWD);
 849         dprint(FD_ZBD, "%s(%s): swd = %" PRIu64 "\n", __func__, f->file_name,
 850                swd);
 851 }
 852
 853 void zbd_file_reset(struct thread_data *td, struct fio_file *f)
 854 {
 855         struct fio_zone_info *zb, *ze;
 856         uint32_t zone_idx_e;
 857
 858         if (!f->zbd_info || !td_write(td))
 859                 return;
 860
 861         zb = &f->zbd_info->zone_info[zbd_zone_idx(f, f->file_offset)];
 862         zone_idx_e = zbd_zone_idx(f, f->file_offset + f->io_size);
 863         ze = &f->zbd_info->zone_info[zone_idx_e];
 864         zbd_init_swd(f);
 865         /*
 866          * If data verification is enabled reset the affected zones before
 867          * writing any data to avoid that a zone reset has to be issued while
 868          * writing data, which causes data loss.
 869          */
 870         zbd_reset_zones(td, f, zb, ze, td->o.verify != VERIFY_NONE &&
 871                         td->runstate != TD_VERIFYING);
 872         zbd_reset_write_cnt(td, f);
 873 }
 874
 875 /* The caller must hold f->zbd_info->mutex. */
 876 static bool is_zone_open(const struct thread_data *td, const struct fio_file *f,
 877                          unsigned int zone_idx)
 878 {
 879         struct zoned_block_device_info *zbdi = f->zbd_info;
 880         int i;
 881
 882         assert(td->o.max_open_zones <= ARRAY_SIZE(zbdi->open_zones));
 883         assert(zbdi->num_open_zones <= td->o.max_open_zones);
 884
 885         for (i = 0; i < zbdi->num_open_zones; i++)
 886                 if (zbdi->open_zones[i] == zone_idx)
 887                         return true;
 888
 889         return false;
 890 }
 891
 892 /*
 893  * Open a ZBD zone if it was not yet open. Returns true if either the zone was
 894  * already open or if opening a new zone is allowed. Returns false if the zone
 895  * was not yet open and opening a new zone would cause the zone limit to be
 896  * exceeded.
 897  */
 898 static bool zbd_open_zone(struct thread_data *td, const struct io_u *io_u,
 899                           uint32_t zone_idx)
 900 {
 901         const uint32_t min_bs = td->o.min_bs[DDIR_WRITE];
 902         const struct fio_file *f = io_u->file;
 903         struct fio_zone_info *z = &f->zbd_info->zone_info[zone_idx];
 904         bool res = true;
 905
 906         if (z->cond == ZBD_ZONE_COND_OFFLINE)
 907                 return false;
 908
 909         /*
 910          * Skip full zones with data verification enabled because resetting a
 911          * zone causes data loss and hence causes verification to fail.
 912          */
 913         if (td->o.verify != VERIFY_NONE && zbd_zone_full(f, z, min_bs))
 914                 return false;
 915
 916         /* Zero means no limit */
 917         if (!td->o.max_open_zones)
 918                 return true;
 919
 920         pthread_mutex_lock(&f->zbd_info->mutex);
 921         if (is_zone_open(td, f, zone_idx))
 922                 goto out;
 923         res = false;
 924         if (f->zbd_info->num_open_zones >= td->o.max_open_zones)
 925                 goto out;
 926         dprint(FD_ZBD, "%s: opening zone %d\n", f->file_name, zone_idx);
 927         f->zbd_info->open_zones[f->zbd_info->num_open_zones++] = zone_idx;
 928         z->open = 1;
 929         res = true;
 930
 931 out:
 932         pthread_mutex_unlock(&f->zbd_info->mutex);
 933         return res;
 934 }
 935
 936 /* Anything goes as long as it is not a constant. */
 937 static uint32_t pick_random_zone_idx(const struct fio_file *f,
 938                                      const struct io_u *io_u)
 939 {
 940         return io_u->offset * f->zbd_info->num_open_zones / f->real_file_size;
 941 }
 942
 943 /*
 944  * Modify the offset of an I/O unit that does not refer to an open zone such
 945  * that it refers to an open zone. Close an open zone and open a new zone if
 946  * necessary. This algorithm can only work correctly if all write pointers are
 947  * a multiple of the fio block size. The caller must neither hold z->mutex
 948  * nor f->zbd_info->mutex. Returns with z->mutex held upon success.
 949  */
 950 static struct fio_zone_info *zbd_convert_to_open_zone(struct thread_data *td,
 951                                                       struct io_u *io_u)
 952 {
 953         const uint32_t min_bs = td->o.min_bs[io_u->ddir];
 954         const struct fio_file *f = io_u->file;
 955         struct fio_zone_info *z;
 956         unsigned int open_zone_idx = -1;
 957         uint32_t zone_idx, new_zone_idx;
 958         int i;
 959
 960         assert(is_valid_offset(f, io_u->offset));
 961
 962         if (td->o.max_open_zones) {
 963                 /*
 964                  * This statement accesses f->zbd_info->open_zones[] on purpose
 965                  * without locking.
 966                  */
 967                 zone_idx = f->zbd_info->open_zones[pick_random_zone_idx(f, io_u)];
 968         } else {
 969                 zone_idx = zbd_zone_idx(f, io_u->offset);
 970         }
 971         dprint(FD_ZBD, "%s(%s): starting from zone %d (offset %lld, buflen %lld)\n",
 972                __func__, f->file_name, zone_idx, io_u->offset, io_u->buflen);
 973
 974         /*
 975          * Since z->mutex is the outer lock and f->zbd_info->mutex the inner
 976          * lock it can happen that the state of the zone with index zone_idx
 977          * has changed after 'z' has been assigned and before f->zbd_info->mutex
 978          * has been obtained. Hence the loop.
 979          */
 980         for (;;) {
 981                 uint32_t tmp_idx;
 982
 983                 z = &f->zbd_info->zone_info[zone_idx];
 984
 985                 zone_lock(td, z);
 986                 pthread_mutex_lock(&f->zbd_info->mutex);
 987                 if (td->o.max_open_zones == 0)
 988                         goto examine_zone;
 989                 if (f->zbd_info->num_open_zones == 0) {
 990                         pthread_mutex_unlock(&f->zbd_info->mutex);
 991                         pthread_mutex_unlock(&z->mutex);
 992                         dprint(FD_ZBD, "%s(%s): no zones are open\n",
 993                                __func__, f->file_name);
 994                         return NULL;
 995                 }
 996
 997                 /*
 998                  * List of opened zones is per-device, shared across all threads.
 999                  * Start with quasi-random candidate zone.
1000                  * Ignore zones which don't belong to thread's offset/size area.
1001                  */
1002                 open_zone_idx = pick_random_zone_idx(f, io_u);
1003                 assert(open_zone_idx < f->zbd_info->num_open_zones);
1004                 tmp_idx = open_zone_idx;
1005                 for (i = 0; i < f->zbd_info->num_open_zones; i++) {
1006                         uint32_t tmpz;
1007
1008                         if (tmp_idx >= f->zbd_info->num_open_zones)
1009                                 tmp_idx = 0;
1010                         tmpz = f->zbd_info->open_zones[tmp_idx];
1011
1012                         if (is_valid_offset(f, f->zbd_info->zone_info[tmpz].start)) {
1013                                 open_zone_idx = tmp_idx;
1014                                 goto found_candidate_zone;
1015                         }
1016
1017                         tmp_idx++;
1018                 }
1019
1020                 dprint(FD_ZBD, "%s(%s): no candidate zone\n",
1021                         __func__, f->file_name);
1022                 pthread_mutex_unlock(&f->zbd_info->mutex);
1023                 pthread_mutex_unlock(&z->mutex);
1024                 return NULL;
1025
1026 found_candidate_zone:
1027                 new_zone_idx = f->zbd_info->open_zones[open_zone_idx];
1028                 if (new_zone_idx == zone_idx)
1029                         break;
1030                 zone_idx = new_zone_idx;
1031                 pthread_mutex_unlock(&f->zbd_info->mutex);
1032                 pthread_mutex_unlock(&z->mutex);
1033         }
1034
1035         /* Both z->mutex and f->zbd_info->mutex are held. */
1036
1037 examine_zone:
1038         if (z->wp + min_bs <= (z+1)->start) {
1039                 pthread_mutex_unlock(&f->zbd_info->mutex);
1040                 goto out;
1041         }
1042         dprint(FD_ZBD, "%s(%s): closing zone %d\n", __func__, f->file_name,
1043                zone_idx);
1044         if (td->o.max_open_zones)
1045                 zbd_close_zone(td, f, open_zone_idx);
1046         pthread_mutex_unlock(&f->zbd_info->mutex);
1047
1048         /* Only z->mutex is held. */
1049
1050         /* Zone 'z' is full, so try to open a new zone. */
1051         for (i = f->io_size / f->zbd_info->zone_size; i > 0; i--) {
1052                 zone_idx++;
1053                 pthread_mutex_unlock(&z->mutex);
1054                 z++;
1055                 if (!is_valid_offset(f, z->start)) {
1056                         /* Wrap-around. */
1057                         zone_idx = zbd_zone_idx(f, f->file_offset);
1058                         z = &f->zbd_info->zone_info[zone_idx];
1059                 }
1060                 assert(is_valid_offset(f, z->start));
1061                 zone_lock(td, z);
1062                 if (z->open)
1063                         continue;
1064                 if (zbd_open_zone(td, io_u, zone_idx))
1065                         goto out;
1066         }
1067
1068         /* Only z->mutex is held. */
1069
1070         /* Check whether the write fits in any of the already opened zones. */
1071         pthread_mutex_lock(&f->zbd_info->mutex);
1072         for (i = 0; i < f->zbd_info->num_open_zones; i++) {
1073                 zone_idx = f->zbd_info->open_zones[i];
1074                 pthread_mutex_unlock(&f->zbd_info->mutex);
1075                 pthread_mutex_unlock(&z->mutex);
1076
1077                 z = &f->zbd_info->zone_info[zone_idx];
1078
1079                 zone_lock(td, z);
1080                 if (z->wp + min_bs <= (z+1)->start)
1081                         goto out;
1082                 pthread_mutex_lock(&f->zbd_info->mutex);
1083         }
1084         pthread_mutex_unlock(&f->zbd_info->mutex);
1085         pthread_mutex_unlock(&z->mutex);
1086         dprint(FD_ZBD, "%s(%s): did not open another zone\n", __func__,
1087                f->file_name);
1088         return NULL;
1089
1090 out:
1091         dprint(FD_ZBD, "%s(%s): returning zone %d\n", __func__, f->file_name,
1092                zone_idx);
1093         io_u->offset = z->start;
1094         return z;
1095 }
1096
1097 /* The caller must hold z->mutex. */
1098 static struct fio_zone_info *zbd_replay_write_order(struct thread_data *td,
1099                                                     struct io_u *io_u,
1100                                                     struct fio_zone_info *z)
1101 {
1102         const struct fio_file *f = io_u->file;
1103         const uint32_t min_bs = td->o.min_bs[DDIR_WRITE];
1104
1105         if (!zbd_open_zone(td, io_u, z - f->zbd_info->zone_info)) {
1106                 pthread_mutex_unlock(&z->mutex);
1107                 z = zbd_convert_to_open_zone(td, io_u);
1108                 assert(z);
1109         }
1110
1111         if (z->verify_block * min_bs >= f->zbd_info->zone_size)
1112                 log_err("%s: %d * %d >= %llu\n", f->file_name, z->verify_block,
1113                         min_bs, (unsigned long long) f->zbd_info->zone_size);
1114         io_u->offset = z->start + z->verify_block++ * min_bs;
1115         return z;
1116 }
1117
1118 /*
1119  * Find another zone for which @io_u fits below the write pointer. Start
1120  * searching in zones @zb + 1 .. @zl and continue searching in zones
1121  * @zf .. @zb - 1.
1122  *
1123  * Either returns NULL or returns a zone pointer and holds the mutex for that
1124  * zone.
1125  */
1126 static struct fio_zone_info *
1127 zbd_find_zone(struct thread_data *td, struct io_u *io_u,
1128               struct fio_zone_info *zb, struct fio_zone_info *zl)
1129 {
1130         const uint32_t min_bs = td->o.min_bs[io_u->ddir];
1131         const struct fio_file *f = io_u->file;
1132         struct fio_zone_info *z1, *z2;
1133         const struct fio_zone_info *const zf =
1134                 &f->zbd_info->zone_info[zbd_zone_idx(f, f->file_offset)];
1135
1136         /*
1137          * Skip to the next non-empty zone in case of sequential I/O and to
1138          * the nearest non-empty zone in case of random I/O.
1139          */
1140         for (z1 = zb + 1, z2 = zb - 1; z1 < zl || z2 >= zf; z1++, z2--) {
1141                 if (z1 < zl && z1->cond != ZBD_ZONE_COND_OFFLINE) {
1142                         zone_lock(td, z1);
1143                         if (z1->start + min_bs <= z1->wp)
1144                                 return z1;
1145                         pthread_mutex_unlock(&z1->mutex);
1146                 } else if (!td_random(td)) {
1147                         break;
1148                 }
1149                 if (td_random(td) && z2 >= zf &&
1150                     z2->cond != ZBD_ZONE_COND_OFFLINE) {
1151                         zone_lock(td, z2);
1152                         if (z2->start + min_bs <= z2->wp)
1153                                 return z2;
1154                         pthread_mutex_unlock(&z2->mutex);
1155                 }
1156         }
1157         dprint(FD_ZBD, "%s: adjusting random read offset failed\n",
1158                f->file_name);
1159         return NULL;
1160 }
1161
1162 /**
1163  * zbd_queue_io - update the write pointer of a sequential zone
1164  * @io_u: I/O unit
1165  * @success: Whether or not the I/O unit has been queued successfully
1166  * @q: queueing status (busy, completed or queued).
1167  *
1168  * For write and trim operations, update the write pointer of the I/O unit
1169  * target zone.
1170  */
1171 static void zbd_queue_io(struct io_u *io_u, int q, bool success)
1172 {
1173         const struct fio_file *f = io_u->file;
1174         struct zoned_block_device_info *zbd_info = f->zbd_info;
1175         struct fio_zone_info *z;
1176         uint32_t zone_idx;
1177         uint64_t zone_end;
1178
1179         if (!zbd_info)
1180                 return;
1181
1182         zone_idx = zbd_zone_idx(f, io_u->offset);
1183         assert(zone_idx < zbd_info->nr_zones);
1184         z = &zbd_info->zone_info[zone_idx];
1185
1186         if (!zbd_zone_swr(z))
1187                 return;
1188
1189         if (!success)
1190                 goto unlock;
1191
1192         dprint(FD_ZBD,
1193                "%s: queued I/O (%lld, %llu) for zone %u\n",
1194                f->file_name, io_u->offset, io_u->buflen, zone_idx);
1195
1196         switch (io_u->ddir) {
1197         case DDIR_WRITE:
1198                 zone_end = min((uint64_t)(io_u->offset + io_u->buflen),
1199                                (z + 1)->start);
1200                 pthread_mutex_lock(&zbd_info->mutex);
1201                 /*
1202                  * z->wp > zone_end means that one or more I/O errors
1203                  * have occurred.
1204                  */
1205                 if (z->wp <= zone_end)
1206                         zbd_info->sectors_with_data += zone_end - z->wp;
1207                 pthread_mutex_unlock(&zbd_info->mutex);
1208                 z->wp = zone_end;
1209                 break;
1210         case DDIR_TRIM:
1211                 assert(z->wp == z->start);
1212                 break;
1213         default:
1214                 break;
1215         }
1216
1217 unlock:
1218         if (!success || q != FIO_Q_QUEUED) {
1219                 /* BUSY or COMPLETED: unlock the zone */
1220                 pthread_mutex_unlock(&z->mutex);
1221                 io_u->zbd_put_io = NULL;
1222         }
1223 }
1224
1225 /**
1226  * zbd_put_io - Unlock an I/O unit target zone lock
1227  * @io_u: I/O unit
1228  */
1229 static void zbd_put_io(const struct io_u *io_u)
1230 {
1231         const struct fio_file *f = io_u->file;
1232         struct zoned_block_device_info *zbd_info = f->zbd_info;
1233         struct fio_zone_info *z;
1234         uint32_t zone_idx;
1235         int ret;
1236
1237         if (!zbd_info)
1238                 return;
1239
1240         zone_idx = zbd_zone_idx(f, io_u->offset);
1241         assert(zone_idx < zbd_info->nr_zones);
1242         z = &zbd_info->zone_info[zone_idx];
1243
1244         if (!zbd_zone_swr(z))
1245                 return;
1246
1247         dprint(FD_ZBD,
1248                "%s: terminate I/O (%lld, %llu) for zone %u\n",
1249                f->file_name, io_u->offset, io_u->buflen, zone_idx);
1250
1251         ret = pthread_mutex_unlock(&z->mutex);
1252         assert(ret == 0);
1253         zbd_check_swd(f);
1254 }
1255
1256 /*
1257  * Windows and MacOS do not define this.
1258  */
1259 #ifndef EREMOTEIO
1260 #define EREMOTEIO       121     /* POSIX value */
1261 #endif
1262
1263 bool zbd_unaligned_write(int error_code)
1264 {
1265         switch (error_code) {
1266         case EIO:
1267         case EREMOTEIO:
1268                 return true;
1269         }
1270         return false;
1271 }
1272
1273 /**
1274  * setup_zbd_zone_mode - handle zoneskip as necessary for ZBD drives
1275  * @td: FIO thread data.
1276  * @io_u: FIO I/O unit.
1277  *
1278  * For sequential workloads, change the file offset to skip zoneskip bytes when
1279  * no more IO can be performed in the current zone.
1280  * - For read workloads, zoneskip is applied when the io has reached the end of
1281  *   the zone or the zone write position (when td->o.read_beyond_wp is false).
1282  * - For write workloads, zoneskip is applied when the zone is full.
1283  * This applies only to read and write operations.
1284  */
1285 void setup_zbd_zone_mode(struct thread_data *td, struct io_u *io_u)
1286 {
1287         struct fio_file *f = io_u->file;
1288         enum fio_ddir ddir = io_u->ddir;
1289         struct fio_zone_info *z;
1290         uint32_t zone_idx;
1291
1292         assert(td->o.zone_mode == ZONE_MODE_ZBD);
1293         assert(td->o.zone_size);
1294
1295         /*
1296          * zone_skip is valid only for sequential workloads.
1297          */
1298         if (td_random(td) || !td->o.zone_skip)
1299                 return;
1300
1301         /*
1302          * It is time to switch to a new zone if:
1303          * - zone_bytes == zone_size bytes have already been accessed
1304          * - The last position reached the end of the current zone.
1305          * - For reads with td->o.read_beyond_wp == false, the last position
1306          *   reached the zone write pointer.
1307          */
1308         zone_idx = zbd_zone_idx(f, f->last_pos[ddir]);
1309         z = &f->zbd_info->zone_info[zone_idx];
1310
1311         if (td->zone_bytes >= td->o.zone_size ||
1312             f->last_pos[ddir] >= (z+1)->start ||
1313             (ddir == DDIR_READ &&
1314              (!td->o.read_beyond_wp) && f->last_pos[ddir] >= z->wp)) {
1315                 /*
1316                  * Skip zones.
1317                  */
1318                 td->zone_bytes = 0;
1319                 f->file_offset += td->o.zone_size + td->o.zone_skip;
1320
1321                 /*
1322                  * Wrap from the beginning, if we exceed the file size
1323                  */
1324                 if (f->file_offset >= f->real_file_size)
1325                         f->file_offset = get_start_offset(td, f);
1326
1327                 f->last_pos[ddir] = f->file_offset;
1328                 td->io_skip_bytes += td->o.zone_skip;
1329         }
1330 }
1331
1332 /**
1333  * zbd_adjust_ddir - Adjust an I/O direction for zonedmode=zbd.
1334  *
1335  * @td: FIO thread data.
1336  * @io_u: FIO I/O unit.
1337  * @ddir: I/O direction before adjustment.
1338  *
1339  * Return adjusted I/O direction.
1340  */
1341 enum fio_ddir zbd_adjust_ddir(struct thread_data *td, struct io_u *io_u,
1342                               enum fio_ddir ddir)
1343 {
1344         /*
1345          * In case read direction is chosen for the first random I/O, fio with
1346          * zonemode=zbd stops because no data can be read from zoned block
1347          * devices with all empty zones. Overwrite the first I/O direction as
1348          * write to make sure data to read exists.
1349          */
1350         if (td->o.zone_mode != ZONE_MODE_ZBD ||
1351             ddir != DDIR_READ ||
1352             !td_rw(td))
1353                 return ddir;
1354
1355         if (io_u->file->zbd_info->sectors_with_data ||
1356             td->o.read_beyond_wp)
1357                 return DDIR_READ;
1358
1359         return DDIR_WRITE;
1360 }
1361
1362 /**
1363  * zbd_adjust_block - adjust the offset and length as necessary for ZBD drives
1364  * @td: FIO thread data.
1365  * @io_u: FIO I/O unit.
1366  *
1367  * Locking strategy: returns with z->mutex locked if and only if z refers
1368  * to a sequential zone and if io_u_accept is returned. z is the zone that
1369  * corresponds to io_u->offset at the end of this function.
1370  */
1371 enum io_u_action zbd_adjust_block(struct thread_data *td, struct io_u *io_u)
1372 {
1373         struct fio_file *f = io_u->file;
1374         uint32_t zone_idx_b;
1375         struct fio_zone_info *zb, *zl, *orig_zb;
1376         uint32_t orig_len = io_u->buflen;
1377         uint32_t min_bs = td->o.min_bs[io_u->ddir];
1378         uint64_t new_len;
1379         int64_t range;
1380
1381         if (!f->zbd_info)
1382                 return io_u_accept;
1383
1384         assert(min_bs);
1385         assert(is_valid_offset(f, io_u->offset));
1386         assert(io_u->buflen);
1387         zone_idx_b = zbd_zone_idx(f, io_u->offset);
1388         zb = &f->zbd_info->zone_info[zone_idx_b];
1389         orig_zb = zb;
1390
1391         /* Accept the I/O offset for conventional zones. */
1392         if (!zbd_zone_swr(zb))
1393                 return io_u_accept;
1394
1395         /*
1396          * Accept the I/O offset for reads if reading beyond the write pointer
1397          * is enabled.
1398          */
1399         if (zb->cond != ZBD_ZONE_COND_OFFLINE &&
1400             io_u->ddir == DDIR_READ && td->o.read_beyond_wp)
1401                 return io_u_accept;
1402
1403         zbd_check_swd(f);
1404
1405         zone_lock(td, zb);
1406
1407         switch (io_u->ddir) {
1408         case DDIR_READ:
1409                 if (td->runstate == TD_VERIFYING) {
1410                         if (td_write(td))
1411                                 zb = zbd_replay_write_order(td, io_u, zb);
1412                         goto accept;
1413                 }
1414                 /*
1415                  * Check that there is enough written data in the zone to do an
1416                  * I/O of at least min_bs B. If there isn't, find a new zone for
1417                  * the I/O.
1418                  */
1419                 range = zb->cond != ZBD_ZONE_COND_OFFLINE ?
1420                         zb->wp - zb->start : 0;
1421                 if (range < min_bs ||
1422                     ((!td_random(td)) && (io_u->offset + min_bs > zb->wp))) {
1423                         pthread_mutex_unlock(&zb->mutex);
1424                         zl = &f->zbd_info->zone_info[zbd_zone_idx(f,
1425                                                 f->file_offset + f->io_size)];
1426                         zb = zbd_find_zone(td, io_u, zb, zl);
1427                         if (!zb) {
1428                                 dprint(FD_ZBD,
1429                                        "%s: zbd_find_zone(%lld, %llu) failed\n",
1430                                        f->file_name, io_u->offset,
1431                                        io_u->buflen);
1432                                 goto eof;
1433                         }
1434                         /*
1435                          * zbd_find_zone() returned a zone with a range of at
1436                          * least min_bs.
1437                          */
1438                         range = zb->wp - zb->start;
1439                         assert(range >= min_bs);
1440
1441                         if (!td_random(td))
1442                                 io_u->offset = zb->start;
1443                 }
1444                 /*
1445                  * Make sure the I/O is within the zone valid data range while
1446                  * maximizing the I/O size and preserving randomness.
1447                  */
1448                 if (range <= io_u->buflen)
1449                         io_u->offset = zb->start;
1450                 else if (td_random(td))
1451                         io_u->offset = zb->start +
1452                                 ((io_u->offset - orig_zb->start) %
1453                                  (range - io_u->buflen)) / min_bs * min_bs;
1454                 /*
1455                  * Make sure the I/O does not cross over the zone wp position.
1456                  */
1457                 new_len = min((unsigned long long)io_u->buflen,
1458                               (unsigned long long)(zb->wp - io_u->offset));
1459                 new_len = new_len / min_bs * min_bs;
1460                 if (new_len < io_u->buflen) {
1461                         io_u->buflen = new_len;
1462                         dprint(FD_IO, "Changed length from %u into %llu\n",
1463                                orig_len, io_u->buflen);
1464                 }
1465                 assert(zb->start <= io_u->offset);
1466                 assert(io_u->offset + io_u->buflen <= zb->wp);
1467                 goto accept;
1468         case DDIR_WRITE:
1469                 if (io_u->buflen > f->zbd_info->zone_size)
1470                         goto eof;
1471                 if (!zbd_open_zone(td, io_u, zone_idx_b)) {
1472                         pthread_mutex_unlock(&zb->mutex);
1473                         zb = zbd_convert_to_open_zone(td, io_u);
1474                         if (!zb)
1475                                 goto eof;
1476                         zone_idx_b = zb - f->zbd_info->zone_info;
1477                 }
1478                 /* Check whether the zone reset threshold has been exceeded */
1479                 if (td->o.zrf.u.f) {
1480                         if (f->zbd_info->sectors_with_data >=
1481                             f->io_size * td->o.zrt.u.f &&
1482                             zbd_dec_and_reset_write_cnt(td, f)) {
1483                                 zb->reset_zone = 1;
1484                         }
1485                 }
1486                 /* Reset the zone pointer if necessary */
1487                 if (zb->reset_zone || zbd_zone_full(f, zb, min_bs)) {
1488                         assert(td->o.verify == VERIFY_NONE);
1489                         /*
1490                          * Since previous write requests may have been submitted
1491                          * asynchronously and since we will submit the zone
1492                          * reset synchronously, wait until previously submitted
1493                          * write requests have completed before issuing a
1494                          * zone reset.
1495                          */
1496                         io_u_quiesce(td);
1497                         zb->reset_zone = 0;
1498                         if (zbd_reset_zone(td, f, zb) < 0)
1499                                 goto eof;
1500                 }
1501                 /* Make writes occur at the write pointer */
1502                 assert(!zbd_zone_full(f, zb, min_bs));
1503                 io_u->offset = zb->wp;
1504                 if (!is_valid_offset(f, io_u->offset)) {
1505                         dprint(FD_ZBD, "Dropped request with offset %llu\n",
1506                                io_u->offset);
1507                         goto eof;
1508                 }
1509                 /*
1510                  * Make sure that the buflen is a multiple of the minimal
1511                  * block size. Give up if shrinking would make the request too
1512                  * small.
1513                  */
1514                 new_len = min((unsigned long long)io_u->buflen,
1515                               (zb + 1)->start - io_u->offset);
1516                 new_len = new_len / min_bs * min_bs;
1517                 if (new_len == io_u->buflen)
1518                         goto accept;
1519                 if (new_len >= min_bs) {
1520                         io_u->buflen = new_len;
1521                         dprint(FD_IO, "Changed length from %u into %llu\n",
1522                                orig_len, io_u->buflen);
1523                         goto accept;
1524                 }
1525                 log_err("Zone remainder %lld smaller than minimum block size %d\n",
1526                         ((zb + 1)->start - io_u->offset),
1527                         min_bs);
1528                 goto eof;
1529         case DDIR_TRIM:
1530                 /* fall-through */
1531         case DDIR_SYNC:
1532         case DDIR_DATASYNC:
1533         case DDIR_SYNC_FILE_RANGE:
1534         case DDIR_WAIT:
1535         case DDIR_LAST:
1536         case DDIR_INVAL:
1537                 goto accept;
1538         }
1539
1540         assert(false);
1541
1542 accept:
1543         assert(zb);
1544         assert(zb->cond != ZBD_ZONE_COND_OFFLINE);
1545         assert(!io_u->zbd_queue_io);
1546         assert(!io_u->zbd_put_io);
1547         io_u->zbd_queue_io = zbd_queue_io;
1548         io_u->zbd_put_io = zbd_put_io;
1549         return io_u_accept;
1550
1551 eof:
1552         if (zb)
1553                 pthread_mutex_unlock(&zb->mutex);
1554         return io_u_eof;
1555 }
1556
1557 /* Return a string with ZBD statistics */
1558 char *zbd_write_status(const struct thread_stat *ts)
1559 {
1560         char *res;
1561
1562         if (asprintf(&res, "; %llu zone resets", (unsigned long long) ts->nr_zone_resets) < 0)
1563                 return NULL;
1564         return res;
1565 }