zbd.c

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