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