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