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                 if (fio_fill_issue_time(td))
 313                         fio_gettime(&io_u->issue_time, NULL);
 314
 315                 /*
 316                  * only used for iolog
 317                  */
 318                 if (td->o.read_iolog_file)
 319                         memcpy(&td->last_issue, &io_u->issue_time,
 320                                         sizeof(io_u->issue_time));
 321         }
 322
 323         if (ddir_rw(ddir)) {
 324                 if (!(io_u->flags & IO_U_F_VER_LIST)) {
 325                         td->io_issues[ddir]++;
 326                         td->io_issue_bytes[ddir] += buflen;
 327                 }
 328                 td->rate_io_issue_bytes[ddir] += buflen;
 329         }
 330
 331         ret = td->io_ops->queue(td, io_u);
 332         zbd_queue_io_u(io_u, ret);
 333
 334         unlock_file(td, io_u->file);
 335
 336         if (ret == FIO_Q_BUSY && ddir_rw(ddir)) {
 337                 td->io_issues[ddir]--;
 338                 td->io_issue_bytes[ddir] -= buflen;
 339                 td->rate_io_issue_bytes[ddir] -= buflen;
 340                 io_u_clear(td, io_u, IO_U_F_FLIGHT);
 341         }
 342
 343         /*
 344          * If an error was seen and the io engine didn't propagate it
 345          * back to 'td', do so.
 346          */
 347         if (io_u->error && !td->error)
 348                 td_verror(td, io_u->error, "td_io_queue");
 349
 350         /*
 351          * Add warning for O_DIRECT so that users have an easier time
 352          * spotting potentially bad alignment. If this triggers for the first
 353          * IO, then it's likely an alignment problem or because the host fs
 354          * does not support O_DIRECT
 355          */
 356         if (io_u->error == EINVAL && td->io_issues[io_u->ddir & 1] == 1 &&
 357             td->o.odirect) {
 358
 359                 log_info("fio: first direct IO errored. File system may not "
 360                          "support direct IO, or iomem_align= is bad, or "
 361                          "invalid block size. Try setting direct=0.\n");
 362         }
 363
 364         if (zbd_unaligned_write(io_u->error) &&
 365             td->io_issues[io_u->ddir & 1] == 1 &&
 366             td->o.zone_mode != ZONE_MODE_ZBD) {
 367                 log_info("fio: first I/O failed. If %s is a zoned block device, consider --zonemode=zbd\n",
 368                          io_u->file->file_name);
 369         }
 370
 371         if (!td->io_ops->commit) {
 372                 io_u_mark_submit(td, 1);
 373                 io_u_mark_complete(td, 1);
 374                 zbd_put_io_u(io_u);
 375         }
 376
 377         if (ret == FIO_Q_COMPLETED) {
 378                 if (ddir_rw(io_u->ddir) || ddir_sync(io_u->ddir)) {
 379                         io_u_mark_depth(td, 1);
 380                         td->ts.total_io_u[io_u->ddir]++;
 381                 }
 382         } else if (ret == FIO_Q_QUEUED) {
 383                 td->io_u_queued++;
 384
 385                 if (ddir_rw(io_u->ddir) || ddir_sync(io_u->ddir))
 386                         td->ts.total_io_u[io_u->ddir]++;
 387
 388                 if (td->io_u_queued >= td->o.iodepth_batch)
 389                         td_io_commit(td);
 390         }
 391
 392         if (!td_ioengine_flagged(td, FIO_SYNCIO)) {
 393                 if (fio_fill_issue_time(td))
 394                         fio_gettime(&io_u->issue_time, NULL);
 395
 396                 /*
 397                  * only used for iolog
 398                  */
 399                 if (td->o.read_iolog_file)
 400                         memcpy(&td->last_issue, &io_u->issue_time,
 401                                         sizeof(io_u->issue_time));
 402         }
 403
 404         return ret;
 405 }
 406
 407 int td_io_init(struct thread_data *td)
 408 {
 409         int ret = 0;
 410
 411         if (td->io_ops->init) {
 412                 ret = td->io_ops->init(td);
 413                 if (ret)
 414                         log_err("fio: io engine %s init failed.%s\n",
 415                                 td->io_ops->name,
 416                                 td->o.iodepth > 1 ?
 417                                 " Perhaps try reducing io depth?" : "");
 418                 else
 419                         td->io_ops_init = 1;
 420                 if (!td->error)
 421                         td->error = ret;
 422         }
 423
 424         return ret;
 425 }
 426
 427 void td_io_commit(struct thread_data *td)
 428 {
 429         int ret;
 430
 431         dprint(FD_IO, "calling ->commit(), depth %d\n", td->cur_depth);
 432
 433         if (!td->cur_depth || !td->io_u_queued)
 434                 return;
 435
 436         io_u_mark_depth(td, td->io_u_queued);
 437
 438         if (td->io_ops->commit) {
 439                 ret = td->io_ops->commit(td);
 440                 if (ret)
 441                         td_verror(td, -ret, "io commit");
 442         }
 443
 444         /*
 445          * Reflect that events were submitted as async IO requests.
 446          */
 447         td->io_u_in_flight += td->io_u_queued;
 448         td->io_u_queued = 0;
 449 }
 450
 451 int td_io_open_file(struct thread_data *td, struct fio_file *f)
 452 {
 453         if (fio_file_closing(f)) {
 454                 /*
 455                  * Open translates to undo closing.
 456                  */
 457                 fio_file_clear_closing(f);
 458                 get_file(f);
 459                 return 0;
 460         }
 461         assert(!fio_file_open(f));
 462         assert(f->fd == -1);
 463         assert(td->io_ops->open_file);
 464
 465         if (td->io_ops->open_file(td, f)) {
 466                 if (td->error == EINVAL && td->o.odirect)
 467                         log_err("fio: destination does not support O_DIRECT\n");
 468                 if (td->error == EMFILE) {
 469                         log_err("fio: try reducing/setting openfiles (failed"
 470                                 " at %u of %u)\n", td->nr_open_files,
 471                                                         td->o.nr_files);
 472                 }
 473
 474                 assert(f->fd == -1);
 475                 assert(!fio_file_open(f));
 476                 return 1;
 477         }
 478
 479         fio_file_reset(td, f);
 480         fio_file_set_open(f);
 481         fio_file_clear_closing(f);
 482         disk_util_inc(f->du);
 483
 484         td->nr_open_files++;
 485         get_file(f);
 486
 487         if (f->filetype == FIO_TYPE_PIPE) {
 488                 if (td_random(td)) {
 489                         log_err("fio: can't seek on pipes (no random io)\n");
 490                         goto err;
 491                 }
 492         }
 493
 494         if (td_ioengine_flagged(td, FIO_DISKLESSIO))
 495                 goto done;
 496
 497         if (td->o.invalidate_cache && file_invalidate_cache(td, f))
 498                 goto err;
 499
 500         if (td->o.fadvise_hint != F_ADV_NONE &&
 501             (f->filetype == FIO_TYPE_BLOCK || f->filetype == FIO_TYPE_FILE)) {
 502                 int flags;
 503
 504                 if (td->o.fadvise_hint == F_ADV_TYPE) {
 505                         if (td_random(td))
 506                                 flags = POSIX_FADV_RANDOM;
 507                         else
 508                                 flags = POSIX_FADV_SEQUENTIAL;
 509                 } else if (td->o.fadvise_hint == F_ADV_RANDOM)
 510                         flags = POSIX_FADV_RANDOM;
 511                 else if (td->o.fadvise_hint == F_ADV_SEQUENTIAL)
 512                         flags = POSIX_FADV_SEQUENTIAL;
 513                 else {
 514                         log_err("fio: unknown fadvise type %d\n",
 515                                                         td->o.fadvise_hint);
 516                         flags = POSIX_FADV_NORMAL;
 517                 }
 518
 519                 if (posix_fadvise(f->fd, f->file_offset, f->io_size, flags) < 0) {
 520                         if (!fio_did_warn(FIO_WARN_FADVISE))
 521                                 log_err("fio: fadvise hint failed\n");
 522                 }
 523         }
 524 #ifdef FIO_HAVE_WRITE_HINT
 525         if (fio_option_is_set(&td->o, write_hint) &&
 526             (f->filetype == FIO_TYPE_BLOCK || f->filetype == FIO_TYPE_FILE)) {
 527                 uint64_t hint = td->o.write_hint;
 528                 int cmd;
 529
 530                 /*
 531                  * For direct IO, we just need/want to set the hint on
 532                  * the file descriptor. For buffered IO, we need to set
 533                  * it on the inode.
 534                  */
 535                 if (td->o.odirect)
 536                         cmd = F_SET_FILE_RW_HINT;
 537                 else
 538                         cmd = F_SET_RW_HINT;
 539
 540                 if (fcntl(f->fd, cmd, &hint) < 0) {
 541                         td_verror(td, errno, "fcntl write hint");
 542                         goto err;
 543                 }
 544         }
 545 #endif
 546
 547         if (td->o.odirect && !OS_O_DIRECT && fio_set_directio(td, f))
 548                 goto err;
 549
 550 done:
 551         log_file(td, f, FIO_LOG_OPEN_FILE);
 552         return 0;
 553 err:
 554         disk_util_dec(f->du);
 555         if (td->io_ops->close_file)
 556                 td->io_ops->close_file(td, f);
 557         return 1;
 558 }
 559
 560 int td_io_close_file(struct thread_data *td, struct fio_file *f)
 561 {
 562         if (!fio_file_closing(f))
 563                 log_file(td, f, FIO_LOG_CLOSE_FILE);
 564
 565         /*
 566          * mark as closing, do real close when last io on it has completed
 567          */
 568         fio_file_set_closing(f);
 569
 570         return put_file(td, f);
 571 }
 572
 573 int td_io_unlink_file(struct thread_data *td, struct fio_file *f)
 574 {
 575         if (td->io_ops->unlink_file)
 576                 return td->io_ops->unlink_file(td, f);
 577         else {
 578                 int ret;
 579
 580                 ret = unlink(f->file_name);
 581                 if (ret < 0)
 582                         return errno;
 583
 584                 return 0;
 585         }
 586 }
 587
 588 int td_io_get_file_size(struct thread_data *td, struct fio_file *f)
 589 {
 590         if (!td->io_ops->get_file_size)
 591                 return 0;
 592
 593         return td->io_ops->get_file_size(td, f);
 594 }
 595
 596 int fio_show_ioengine_help(const char *engine)
 597 {
 598         struct flist_head *entry;
 599         struct thread_data td;
 600         struct ioengine_ops *io_ops;
 601         char *sep;
 602         int ret = 1;
 603
 604         if (!engine || !*engine) {
 605                 log_info("Available IO engines:\n");
 606                 flist_for_each(entry, &engine_list) {
 607                         io_ops = flist_entry(entry, struct ioengine_ops, list);
 608                         log_info("\t%s\n", io_ops->name);
 609                 }
 610                 return 0;
 611         }
 612         sep = strchr(engine, ',');
 613         if (sep) {
 614                 *sep = 0;
 615                 sep++;
 616         }
 617
 618         memset(&td, 0, sizeof(struct thread_data));
 619         td.o.ioengine = (char *)engine;
 620         io_ops = load_ioengine(&td);
 621
 622         if (!io_ops) {
 623                 log_info("IO engine %s not found\n", engine);
 624                 return 1;
 625         }
 626
 627         if (io_ops->options)
 628                 ret = show_cmd_help(io_ops->options, sep);
 629         else
 630                 log_info("IO engine %s has no options\n", io_ops->name);
 631
 632         free_ioengine(&td);
 633         return ret;
 634 }