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