ioengines.c

   1 /*
   2  * The io parts of the fio tool, includes workers for sync and mmap'ed
   3  * io, as well as both posix and linux libaio support.
   4  *
   5  * sync io is implemented on top of aio.
   6  *
   7  * This is not really specific to fio, if the get_io_u/put_io_u and
   8  * structures was pulled into this as well it would be a perfectly
   9  * generic io engine that could be used for other projects.
  10  *
  11  */
  12 #include <stdlib.h>
  13 #include <unistd.h>
  14 #include <string.h>
  15 #include <dlfcn.h>
  16 #include <fcntl.h>
  17 #include <assert.h>
  18
  19 #include "fio.h"
  20 #include "diskutil.h"
  21 #include "zbd.h"
  22
  23 static FLIST_HEAD(engine_list);
  24
  25 static bool check_engine_ops(struct ioengine_ops *ops)
  26 {
  27         if (ops->version != FIO_IOOPS_VERSION) {
  28                 log_err("bad ioops version %d (want %d)\n", ops->version,
  29                                                         FIO_IOOPS_VERSION);
  30                 return true;
  31         }
  32
  33         if (!ops->queue) {
  34                 log_err("%s: no queue handler\n", ops->name);
  35                 return true;
  36         }
  37
  38         /*
  39          * sync engines only need a ->queue()
  40          */
  41         if (ops->flags & FIO_SYNCIO)
  42                 return false;
  43
  44         if (!ops->event || !ops->getevents) {
  45                 log_err("%s: no event/getevents handler\n", ops->name);
  46                 return true;
  47         }
  48
  49         return false;
  50 }
  51
  52 void unregister_ioengine(struct ioengine_ops *ops)
  53 {
  54         dprint(FD_IO, "ioengine %s unregistered\n", ops->name);
  55         flist_del_init(&ops->list);
  56 }
  57
  58 void register_ioengine(struct ioengine_ops *ops)
  59 {
  60         dprint(FD_IO, "ioengine %s registered\n", ops->name);
  61         flist_add_tail(&ops->list, &engine_list);
  62 }
  63
  64 static struct ioengine_ops *find_ioengine(const char *name)
  65 {
  66         struct ioengine_ops *ops;
  67         struct flist_head *entry;
  68
  69         flist_for_each(entry, &engine_list) {
  70                 ops = flist_entry(entry, struct ioengine_ops, list);
  71                 if (!strcmp(name, ops->name))
  72                         return ops;
  73         }
  74
  75         return NULL;
  76 }
  77
  78 static struct ioengine_ops *dlopen_ioengine(struct thread_data *td,
  79                                             const char *engine_lib)
  80 {
  81         struct ioengine_ops *ops;
  82         void *dlhandle;
  83
  84         dprint(FD_IO, "dload engine %s\n", engine_lib);
  85
  86         dlerror();
  87         dlhandle = dlopen(engine_lib, RTLD_LAZY);
  88         if (!dlhandle) {
  89                 td_vmsg(td, -1, dlerror(), "dlopen");
  90                 return NULL;
  91         }
  92
  93         /*
  94          * Unlike the included modules, external engines should have a
  95          * non-static ioengine structure that we can reference.
  96          */
  97         ops = dlsym(dlhandle, engine_lib);
  98         if (!ops)
  99                 ops = dlsym(dlhandle, "ioengine");
 100
 101         /*
 102          * For some external engines (like C++ ones) it is not that trivial
 103          * to provide a non-static ionengine structure that we can reference.
 104          * Instead we call a method which allocates the required ioengine
 105          * structure.
 106          */
 107         if (!ops) {
 108                 get_ioengine_t get_ioengine = dlsym(dlhandle, "get_ioengine");
 109
 110                 if (get_ioengine)
 111                         get_ioengine(&ops);
 112         }
 113
 114         if (!ops) {
 115                 td_vmsg(td, -1, dlerror(), "dlsym");
 116                 dlclose(dlhandle);
 117                 return NULL;
 118         }
 119
 120         td->io_ops_dlhandle = dlhandle;
 121         return ops;
 122 }
 123
 124 static struct ioengine_ops *__load_ioengine(const char *name)
 125 {
 126         char engine[64];
 127
 128         snprintf(engine, sizeof(engine), "%s", name);
 129
 130         /*
 131          * linux libaio has alias names, so convert to what we want
 132          */
 133         if (!strncmp(engine, "linuxaio", 8)) {
 134                 dprint(FD_IO, "converting ioengine name: %s -> libaio\n", name);
 135                 strcpy(engine, "libaio");
 136         }
 137
 138         dprint(FD_IO, "load ioengine %s\n", engine);
 139         return find_ioengine(engine);
 140 }
 141
 142 struct ioengine_ops *load_ioengine(struct thread_data *td)
 143 {
 144         struct ioengine_ops *ops = NULL;
 145         const char *name;
 146
 147         /*
 148          * Use ->ioengine_so_path if an external ioengine path is specified.
 149          * In this case, ->ioengine is "external" which also means the prefix
 150          * for external ioengines "external:" is properly used.
 151          */
 152         name = td->o.ioengine_so_path ?: td->o.ioengine;
 153
 154         /*
 155          * Try to load ->ioengine first, and if failed try to dlopen(3) either
 156          * ->ioengine or ->ioengine_so_path.  This is redundant for an external
 157          * ioengine with prefix, and also leaves the possibility of unexpected
 158          * behavior (e.g. if the "external" ioengine exists), but we do this
 159          * so as not to break job files not using the prefix.
 160          */
 161         ops = __load_ioengine(td->o.ioengine);
 162         if (!ops)
 163                 ops = dlopen_ioengine(td, name);
 164
 165         /*
 166          * If ops is NULL, we failed to load ->ioengine, and also failed to
 167          * dlopen(3) either ->ioengine or ->ioengine_so_path as a path.
 168          */
 169         if (!ops) {
 170                 log_err("fio: engine %s not loadable\n", name);
 171                 return NULL;
 172         }
 173
 174         /*
 175          * Check that the required methods are there.
 176          */
 177         if (check_engine_ops(ops))
 178                 return NULL;
 179
 180         return ops;
 181 }
 182
 183 /*
 184  * For cleaning up an ioengine which never made it to init().
 185  */
 186 void free_ioengine(struct thread_data *td)
 187 {
 188         dprint(FD_IO, "free ioengine %s\n", td->io_ops->name);
 189
 190         if (td->eo && td->io_ops->options) {
 191                 options_free(td->io_ops->options, td->eo);
 192                 free(td->eo);
 193                 td->eo = NULL;
 194         }
 195
 196         if (td->io_ops_dlhandle) {
 197                 dlclose(td->io_ops_dlhandle);
 198                 td->io_ops_dlhandle = NULL;
 199         }
 200
 201         td->io_ops = NULL;
 202 }
 203
 204 void close_ioengine(struct thread_data *td)
 205 {
 206         dprint(FD_IO, "close ioengine %s\n", td->io_ops->name);
 207
 208         if (td->io_ops->cleanup) {
 209                 td->io_ops->cleanup(td);
 210                 td->io_ops_data = NULL;
 211         }
 212
 213         free_ioengine(td);
 214 }
 215
 216 int td_io_prep(struct thread_data *td, struct io_u *io_u)
 217 {
 218         dprint_io_u(io_u, "prep");
 219         fio_ro_check(td, io_u);
 220
 221         lock_file(td, io_u->file, io_u->ddir);
 222
 223         if (td->io_ops->prep) {
 224                 int ret = td->io_ops->prep(td, io_u);
 225
 226                 dprint(FD_IO, "prep: io_u %p: ret=%d\n", io_u, ret);
 227
 228                 if (ret)
 229                         unlock_file(td, io_u->file);
 230                 return ret;
 231         }
 232
 233         return 0;
 234 }
 235
 236 int td_io_getevents(struct thread_data *td, unsigned int min, unsigned int max,
 237                     const struct timespec *t)
 238 {
 239         int r = 0;
 240
 241         /*
 242          * For ioengine=rdma one side operation RDMA_WRITE or RDMA_READ,
 243          * server side gets a message from the client
 244          * side that the task is finished, and
 245          * td->done is set to 1 after td_io_commit(). In this case,
 246          * there is no need to reap complete event in server side.
 247          */
 248         if (td->done)
 249                 return 0;
 250
 251         if (min > 0 && td->io_ops->commit) {
 252                 r = td->io_ops->commit(td);
 253                 if (r < 0)
 254                         goto out;
 255         }
 256         if (max > td->cur_depth)
 257                 max = td->cur_depth;
 258         if (min > max)
 259                 max = min;
 260
 261         r = 0;
 262         if (max && td->io_ops->getevents)
 263                 r = td->io_ops->getevents(td, min, max, t);
 264 out:
 265         if (r >= 0) {
 266                 /*
 267                  * Reflect that our submitted requests were retrieved with
 268                  * whatever OS async calls are in the underlying engine.
 269                  */
 270                 td->io_u_in_flight -= r;
 271                 io_u_mark_complete(td, r);
 272         } else
 273                 td_verror(td, r, "get_events");
 274
 275         dprint(FD_IO, "getevents: %d\n", r);
 276         return r;
 277 }
 278
 279 enum fio_q_status td_io_queue(struct thread_data *td, struct io_u *io_u)
 280 {
 281         const enum fio_ddir ddir = acct_ddir(io_u);
 282         unsigned long long buflen = io_u->xfer_buflen;
 283         enum fio_q_status ret;
 284
 285         dprint_io_u(io_u, "queue");
 286         fio_ro_check(td, io_u);
 287
 288         assert((io_u->flags & IO_U_F_FLIGHT) == 0);
 289         io_u_set(td, io_u, IO_U_F_FLIGHT);
 290
 291         /*
 292          * If overlap checking was enabled in offload mode we
 293          * can release this lock that was acquired when we
 294          * started the overlap check because the IO_U_F_FLIGHT
 295          * flag is now set
 296          */
 297         if (td_offload_overlap(td))
 298                 pthread_mutex_unlock(&overlap_check);
 299
 300         assert(fio_file_open(io_u->file));
 301
 302         /*
 303          * If using a write iolog, store this entry.
 304          */
 305         log_io_u(td, io_u);
 306
 307         io_u->error = 0;
 308         io_u->resid = 0;
 309
 310         if (td_ioengine_flagged(td, FIO_SYNCIO) ||
 311                 (td_ioengine_flagged(td, FIO_ASYNCIO_SYNC_TRIM) &&
 312                 io_u->ddir == DDIR_TRIM)) {
 313                 if (fio_fill_issue_time(td))
 314                         fio_gettime(&io_u->issue_time, NULL);
 315
 316                 /*
 317                  * only used for iolog
 318                  */
 319                 if (td->o.read_iolog_file)
 320                         memcpy(&td->last_issue, &io_u->issue_time,
 321                                         sizeof(io_u->issue_time));
 322         }
 323
 324         if (ddir_rw(ddir)) {
 325                 if (!(io_u->flags & IO_U_F_VER_LIST)) {
 326                         td->io_issues[ddir]++;
 327                         td->io_issue_bytes[ddir] += buflen;
 328                 }
 329                 td->rate_io_issue_bytes[ddir] += buflen;
 330         }
 331
 332         ret = td->io_ops->queue(td, io_u);
 333         zbd_queue_io_u(io_u, ret);
 334
 335         unlock_file(td, io_u->file);
 336
 337         if (ret == FIO_Q_BUSY && ddir_rw(ddir)) {
 338                 td->io_issues[ddir]--;
 339                 td->io_issue_bytes[ddir] -= buflen;
 340                 td->rate_io_issue_bytes[ddir] -= buflen;
 341                 io_u_clear(td, io_u, IO_U_F_FLIGHT);
 342         }
 343
 344         /*
 345          * If an error was seen and the io engine didn't propagate it
 346          * back to 'td', do so.
 347          */
 348         if (io_u->error && !td->error)
 349                 td_verror(td, io_u->error, "td_io_queue");
 350
 351         /*
 352          * Add warning for O_DIRECT so that users have an easier time
 353          * spotting potentially bad alignment. If this triggers for the first
 354          * IO, then it's likely an alignment problem or because the host fs
 355          * does not support O_DIRECT
 356          */
 357         if (io_u->error == EINVAL && td->io_issues[io_u->ddir & 1] == 1 &&
 358             td->o.odirect) {
 359
 360                 log_info("fio: first direct IO errored. File system may not "
 361                          "support direct IO, or iomem_align= is bad, or "
 362                          "invalid block size. Try setting direct=0.\n");
 363         }
 364
 365         if (zbd_unaligned_write(io_u->error) &&
 366             td->io_issues[io_u->ddir & 1] == 1 &&
 367             td->o.zone_mode != ZONE_MODE_ZBD) {
 368                 log_info("fio: first I/O failed. If %s is a zoned block device, consider --zonemode=zbd\n",
 369                          io_u->file->file_name);
 370         }
 371
 372         if (!td->io_ops->commit) {
 373                 io_u_mark_submit(td, 1);
 374                 io_u_mark_complete(td, 1);
 375                 zbd_put_io_u(io_u);
 376         }
 377
 378         if (ret == FIO_Q_COMPLETED) {
 379                 if (ddir_rw(io_u->ddir) ||
 380                     (ddir_sync(io_u->ddir) && td->runstate != TD_FSYNCING)) {
 381                         io_u_mark_depth(td, 1);
 382                         td->ts.total_io_u[io_u->ddir]++;
 383                 }
 384         } else if (ret == FIO_Q_QUEUED) {
 385                 td->io_u_queued++;
 386
 387                 if (ddir_rw(io_u->ddir) ||
 388                     (ddir_sync(io_u->ddir) && td->runstate != TD_FSYNCING))
 389                         td->ts.total_io_u[io_u->ddir]++;
 390
 391                 if (td->io_u_queued >= td->o.iodepth_batch)
 392                         td_io_commit(td);
 393         }
 394
 395         if (!td_ioengine_flagged(td, FIO_SYNCIO) &&
 396                 (!td_ioengine_flagged(td, FIO_ASYNCIO_SYNC_TRIM) ||
 397                  io_u->ddir != DDIR_TRIM)) {
 398                 if (fio_fill_issue_time(td))
 399                         fio_gettime(&io_u->issue_time, NULL);
 400
 401                 /*
 402                  * only used for iolog
 403                  */
 404                 if (td->o.read_iolog_file)
 405                         memcpy(&td->last_issue, &io_u->issue_time,
 406                                         sizeof(io_u->issue_time));
 407         }
 408
 409         return ret;
 410 }
 411
 412 int td_io_init(struct thread_data *td)
 413 {
 414         int ret = 0;
 415
 416         if (td->io_ops->init) {
 417                 ret = td->io_ops->init(td);
 418                 if (ret)
 419                         log_err("fio: io engine %s init failed.%s\n",
 420                                 td->io_ops->name,
 421                                 td->o.iodepth > 1 ?
 422                                 " Perhaps try reducing io depth?" : "");
 423                 else
 424                         td->io_ops_init = 1;
 425                 if (!td->error)
 426                         td->error = ret;
 427         }
 428
 429         return ret;
 430 }
 431
 432 void td_io_commit(struct thread_data *td)
 433 {
 434         int ret;
 435
 436         dprint(FD_IO, "calling ->commit(), depth %d\n", td->cur_depth);
 437
 438         if (!td->cur_depth || !td->io_u_queued)
 439                 return;
 440
 441         io_u_mark_depth(td, td->io_u_queued);
 442
 443         if (td->io_ops->commit) {
 444                 ret = td->io_ops->commit(td);
 445                 if (ret)
 446                         td_verror(td, -ret, "io commit");
 447         }
 448
 449         /*
 450          * Reflect that events were submitted as async IO requests.
 451          */
 452         td->io_u_in_flight += td->io_u_queued;
 453         td->io_u_queued = 0;
 454 }
 455
 456 int td_io_open_file(struct thread_data *td, struct fio_file *f)
 457 {
 458         if (fio_file_closing(f)) {
 459                 /*
 460                  * Open translates to undo closing.
 461                  */
 462                 fio_file_clear_closing(f);
 463                 get_file(f);
 464                 return 0;
 465         }
 466         assert(!fio_file_open(f));
 467         assert(f->fd == -1);
 468         assert(td->io_ops->open_file);
 469
 470         if (td->io_ops->open_file(td, f)) {
 471                 if (td->error == EINVAL && td->o.odirect)
 472                         log_err("fio: destination does not support O_DIRECT\n");
 473                 if (td->error == EMFILE) {
 474                         log_err("fio: try reducing/setting openfiles (failed"
 475                                 " at %u of %u)\n", td->nr_open_files,
 476                                                         td->o.nr_files);
 477                 }
 478
 479                 assert(f->fd == -1);
 480                 assert(!fio_file_open(f));
 481                 return 1;
 482         }
 483
 484         fio_file_reset(td, f);
 485         fio_file_set_open(f);
 486         fio_file_clear_closing(f);
 487         disk_util_inc(f->du);
 488
 489         td->nr_open_files++;
 490         get_file(f);
 491
 492         if (f->filetype == FIO_TYPE_PIPE) {
 493                 if (td_random(td)) {
 494                         log_err("fio: can't seek on pipes (no random io)\n");
 495                         goto err;
 496                 }
 497         }
 498
 499         if (td_ioengine_flagged(td, FIO_DISKLESSIO))
 500                 goto done;
 501
 502         if (td->o.invalidate_cache && file_invalidate_cache(td, f))
 503                 goto err;
 504
 505         if (td->o.fadvise_hint != F_ADV_NONE &&
 506             (f->filetype == FIO_TYPE_BLOCK || f->filetype == FIO_TYPE_FILE)) {
 507                 int flags;
 508
 509                 if (td->o.fadvise_hint == F_ADV_TYPE) {
 510                         if (td_random(td))
 511                                 flags = POSIX_FADV_RANDOM;
 512                         else
 513                                 flags = POSIX_FADV_SEQUENTIAL;
 514                 } else if (td->o.fadvise_hint == F_ADV_RANDOM)
 515                         flags = POSIX_FADV_RANDOM;
 516                 else if (td->o.fadvise_hint == F_ADV_SEQUENTIAL)
 517                         flags = POSIX_FADV_SEQUENTIAL;
 518                 else {
 519                         log_err("fio: unknown fadvise type %d\n",
 520                                                         td->o.fadvise_hint);
 521                         flags = POSIX_FADV_NORMAL;
 522                 }
 523
 524                 if (posix_fadvise(f->fd, f->file_offset, f->io_size, flags) < 0) {
 525                         if (!fio_did_warn(FIO_WARN_FADVISE))
 526                                 log_err("fio: fadvise hint failed\n");
 527                 }
 528         }
 529 #ifdef FIO_HAVE_WRITE_HINT
 530         if (fio_option_is_set(&td->o, write_hint) &&
 531             (f->filetype == FIO_TYPE_BLOCK || f->filetype == FIO_TYPE_FILE)) {
 532                 uint64_t hint = td->o.write_hint;
 533                 int cmd;
 534
 535                 /*
 536                  * For direct IO, we just need/want to set the hint on
 537                  * the file descriptor. For buffered IO, we need to set
 538                  * it on the inode.
 539                  */
 540                 if (td->o.odirect)
 541                         cmd = F_SET_FILE_RW_HINT;
 542                 else
 543                         cmd = F_SET_RW_HINT;
 544
 545                 if (fcntl(f->fd, cmd, &hint) < 0) {
 546                         td_verror(td, errno, "fcntl write hint");
 547                         goto err;
 548                 }
 549         }
 550 #endif
 551
 552         if (td->o.odirect && !OS_O_DIRECT && fio_set_directio(td, f))
 553                 goto err;
 554
 555 done:
 556         log_file(td, f, FIO_LOG_OPEN_FILE);
 557         return 0;
 558 err:
 559         disk_util_dec(f->du);
 560         if (td->io_ops->close_file)
 561                 td->io_ops->close_file(td, f);
 562         return 1;
 563 }
 564
 565 int td_io_close_file(struct thread_data *td, struct fio_file *f)
 566 {
 567         if (!fio_file_closing(f))
 568                 log_file(td, f, FIO_LOG_CLOSE_FILE);
 569
 570         /*
 571          * mark as closing, do real close when last io on it has completed
 572          */
 573         fio_file_set_closing(f);
 574
 575         return put_file(td, f);
 576 }
 577
 578 int td_io_unlink_file(struct thread_data *td, struct fio_file *f)
 579 {
 580         if (td->io_ops->unlink_file)
 581                 return td->io_ops->unlink_file(td, f);
 582         else {
 583                 int ret;
 584
 585                 ret = unlink(f->file_name);
 586                 if (ret < 0)
 587                         return errno;
 588
 589                 return 0;
 590         }
 591 }
 592
 593 int td_io_get_file_size(struct thread_data *td, struct fio_file *f)
 594 {
 595         if (!td->io_ops->get_file_size)
 596                 return 0;
 597
 598         return td->io_ops->get_file_size(td, f);
 599 }
 600
 601 int fio_show_ioengine_help(const char *engine)
 602 {
 603         struct flist_head *entry;
 604         struct thread_data td;
 605         struct ioengine_ops *io_ops;
 606         char *sep;
 607         int ret = 1;
 608
 609         if (!engine || !*engine) {
 610                 log_info("Available IO engines:\n");
 611                 flist_for_each(entry, &engine_list) {
 612                         io_ops = flist_entry(entry, struct ioengine_ops, list);
 613                         log_info("\t%s\n", io_ops->name);
 614                 }
 615                 return 0;
 616         }
 617         sep = strchr(engine, ',');
 618         if (sep) {
 619                 *sep = 0;
 620                 sep++;
 621         }
 622
 623         memset(&td, 0, sizeof(struct thread_data));
 624         td.o.ioengine = (char *)engine;
 625         io_ops = load_ioengine(&td);
 626
 627         if (!io_ops) {
 628                 log_info("IO engine %s not found\n", engine);
 629                 return 1;
 630         }
 631
 632         if (io_ops->options)
 633                 ret = show_cmd_help(io_ops->options, sep);
 634         else
 635                 log_info("IO engine %s has no options\n", io_ops->name);
 636
 637         free_ioengine(&td);
 638         return ret;
 639 }