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
  22 static FLIST_HEAD(engine_list);
  23
  24 static bool check_engine_ops(struct ioengine_ops *ops)
  25 {
  26         if (ops->version != FIO_IOOPS_VERSION) {
  27                 log_err("bad ioops version %d (want %d)\n", ops->version,
  28                                                         FIO_IOOPS_VERSION);
  29                 return true;
  30         }
  31
  32         if (!ops->queue) {
  33                 log_err("%s: no queue handler\n", ops->name);
  34                 return true;
  35         }
  36
  37         /*
  38          * sync engines only need a ->queue()
  39          */
  40         if (ops->flags & FIO_SYNCIO)
  41                 return false;
  42
  43         if (!ops->event || !ops->getevents) {
  44                 log_err("%s: no event/getevents handler\n", ops->name);
  45                 return true;
  46         }
  47
  48         return false;
  49 }
  50
  51 void unregister_ioengine(struct ioengine_ops *ops)
  52 {
  53         dprint(FD_IO, "ioengine %s unregistered\n", ops->name);
  54         flist_del_init(&ops->list);
  55 }
  56
  57 void register_ioengine(struct ioengine_ops *ops)
  58 {
  59         dprint(FD_IO, "ioengine %s registered\n", ops->name);
  60         flist_add_tail(&ops->list, &engine_list);
  61 }
  62
  63 static struct ioengine_ops *find_ioengine(const char *name)
  64 {
  65         struct ioengine_ops *ops;
  66         struct flist_head *entry;
  67
  68         flist_for_each(entry, &engine_list) {
  69                 ops = flist_entry(entry, struct ioengine_ops, list);
  70                 if (!strcmp(name, ops->name))
  71                         return ops;
  72         }
  73
  74         return NULL;
  75 }
  76
  77 static struct ioengine_ops *dlopen_ioengine(struct thread_data *td,
  78                                             const char *engine_lib)
  79 {
  80         struct ioengine_ops *ops;
  81         void *dlhandle;
  82
  83         dprint(FD_IO, "dload engine %s\n", engine_lib);
  84
  85         dlerror();
  86         dlhandle = dlopen(engine_lib, RTLD_LAZY);
  87         if (!dlhandle) {
  88                 td_vmsg(td, -1, dlerror(), "dlopen");
  89                 return NULL;
  90         }
  91
  92         /*
  93          * Unlike the included modules, external engines should have a
  94          * non-static ioengine structure that we can reference.
  95          */
  96         ops = dlsym(dlhandle, engine_lib);
  97         if (!ops)
  98                 ops = dlsym(dlhandle, "ioengine");
  99
 100         /*
 101          * For some external engines (like C++ ones) it is not that trivial
 102          * to provide a non-static ionengine structure that we can reference.
 103          * Instead we call a method which allocates the required ioengine
 104          * structure.
 105          */
 106         if (!ops) {
 107                 get_ioengine_t get_ioengine = dlsym(dlhandle, "get_ioengine");
 108
 109                 if (get_ioengine)
 110                         get_ioengine(&ops);
 111         }
 112
 113         if (!ops) {
 114                 td_vmsg(td, -1, dlerror(), "dlsym");
 115                 dlclose(dlhandle);
 116                 return NULL;
 117         }
 118
 119         td->io_ops_dlhandle = dlhandle;
 120         return ops;
 121 }
 122
 123 static struct ioengine_ops *__load_ioengine(const char *name)
 124 {
 125         char engine[64];
 126
 127         engine[sizeof(engine) - 1] = '\0';
 128         strncpy(engine, name, sizeof(engine) - 1);
 129
 130         /*
 131          * linux libaio has alias names, so convert to what we want
 132          */
 133         if (!strncmp(engine, "linuxaio", 8) || !strncmp(engine, "aio", 3)) {
 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 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         assert(fio_file_open(io_u->file));
 292
 293         /*
 294          * If using a write iolog, store this entry.
 295          */
 296         log_io_u(td, io_u);
 297
 298         io_u->error = 0;
 299         io_u->resid = 0;
 300
 301         if (td_ioengine_flagged(td, FIO_SYNCIO)) {
 302                 if (fio_fill_issue_time(td))
 303                         fio_gettime(&io_u->issue_time, NULL);
 304
 305                 /*
 306                  * only used for iolog
 307                  */
 308                 if (td->o.read_iolog_file)
 309                         memcpy(&td->last_issue, &io_u->issue_time,
 310                                         sizeof(io_u->issue_time));
 311         }
 312
 313         if (ddir_rw(ddir)) {
 314                 if (!(io_u->flags & IO_U_F_VER_LIST)) {
 315                         td->io_issues[ddir]++;
 316                         td->io_issue_bytes[ddir] += buflen;
 317                 }
 318                 td->rate_io_issue_bytes[ddir] += buflen;
 319         }
 320
 321         ret = td->io_ops->queue(td, io_u);
 322
 323         unlock_file(td, io_u->file);
 324
 325         if (ret == FIO_Q_BUSY && ddir_rw(ddir)) {
 326                 td->io_issues[ddir]--;
 327                 td->io_issue_bytes[ddir] -= buflen;
 328                 td->rate_io_issue_bytes[ddir] -= buflen;
 329                 io_u_clear(td, io_u, IO_U_F_FLIGHT);
 330         }
 331
 332         /*
 333          * If an error was seen and the io engine didn't propagate it
 334          * back to 'td', do so.
 335          */
 336         if (io_u->error && !td->error)
 337                 td_verror(td, io_u->error, "td_io_queue");
 338
 339         /*
 340          * Add warning for O_DIRECT so that users have an easier time
 341          * spotting potentially bad alignment. If this triggers for the first
 342          * IO, then it's likely an alignment problem or because the host fs
 343          * does not support O_DIRECT
 344          */
 345         if (io_u->error == EINVAL && td->io_issues[io_u->ddir & 1] == 1 &&
 346             td->o.odirect) {
 347
 348                 log_info("fio: first direct IO errored. File system may not "
 349                          "support direct IO, or iomem_align= is bad, or "
 350                          "invalid block size. Try setting direct=0.\n");
 351         }
 352
 353         if (!td->io_ops->commit || io_u->ddir == DDIR_TRIM) {
 354                 io_u_mark_submit(td, 1);
 355                 io_u_mark_complete(td, 1);
 356         }
 357
 358         if (ret == FIO_Q_COMPLETED) {
 359                 if (ddir_rw(io_u->ddir) || ddir_sync(io_u->ddir)) {
 360                         io_u_mark_depth(td, 1);
 361                         td->ts.total_io_u[io_u->ddir]++;
 362                 }
 363         } else if (ret == FIO_Q_QUEUED) {
 364                 td->io_u_queued++;
 365
 366                 if (ddir_rw(io_u->ddir) || ddir_sync(io_u->ddir))
 367                         td->ts.total_io_u[io_u->ddir]++;
 368
 369                 if (td->io_u_queued >= td->o.iodepth_batch)
 370                         td_io_commit(td);
 371         }
 372
 373         if (!td_ioengine_flagged(td, FIO_SYNCIO)) {
 374                 if (fio_fill_issue_time(td))
 375                         fio_gettime(&io_u->issue_time, NULL);
 376
 377                 /*
 378                  * only used for iolog
 379                  */
 380                 if (td->o.read_iolog_file)
 381                         memcpy(&td->last_issue, &io_u->issue_time,
 382                                         sizeof(io_u->issue_time));
 383         }
 384
 385         return ret;
 386 }
 387
 388 int td_io_init(struct thread_data *td)
 389 {
 390         int ret = 0;
 391
 392         if (td->io_ops->init) {
 393                 ret = td->io_ops->init(td);
 394                 if (ret)
 395                         log_err("fio: io engine %s init failed.%s\n",
 396                                 td->io_ops->name,
 397                                 td->o.iodepth > 1 ?
 398                                 " Perhaps try reducing io depth?" : "");
 399                 else
 400                         td->io_ops_init = 1;
 401                 if (!td->error)
 402                         td->error = ret;
 403         }
 404
 405         return ret;
 406 }
 407
 408 void td_io_commit(struct thread_data *td)
 409 {
 410         int ret;
 411
 412         dprint(FD_IO, "calling ->commit(), depth %d\n", td->cur_depth);
 413
 414         if (!td->cur_depth || !td->io_u_queued)
 415                 return;
 416
 417         io_u_mark_depth(td, td->io_u_queued);
 418
 419         if (td->io_ops->commit) {
 420                 ret = td->io_ops->commit(td);
 421                 if (ret)
 422                         td_verror(td, -ret, "io commit");
 423         }
 424
 425         /*
 426          * Reflect that events were submitted as async IO requests.
 427          */
 428         td->io_u_in_flight += td->io_u_queued;
 429         td->io_u_queued = 0;
 430 }
 431
 432 int td_io_open_file(struct thread_data *td, struct fio_file *f)
 433 {
 434         assert(!fio_file_open(f));
 435         assert(f->fd == -1);
 436         assert(td->io_ops->open_file);
 437
 438         if (td->io_ops->open_file(td, f)) {
 439                 if (td->error == EINVAL && td->o.odirect)
 440                         log_err("fio: destination does not support O_DIRECT\n");
 441                 if (td->error == EMFILE) {
 442                         log_err("fio: try reducing/setting openfiles (failed"
 443                                 " at %u of %u)\n", td->nr_open_files,
 444                                                         td->o.nr_files);
 445                 }
 446
 447                 assert(f->fd == -1);
 448                 assert(!fio_file_open(f));
 449                 return 1;
 450         }
 451
 452         fio_file_reset(td, f);
 453         fio_file_set_open(f);
 454         fio_file_clear_closing(f);
 455         disk_util_inc(f->du);
 456
 457         td->nr_open_files++;
 458         get_file(f);
 459
 460         if (f->filetype == FIO_TYPE_PIPE) {
 461                 if (td_random(td)) {
 462                         log_err("fio: can't seek on pipes (no random io)\n");
 463                         goto err;
 464                 }
 465         }
 466
 467         if (td_ioengine_flagged(td, FIO_DISKLESSIO))
 468                 goto done;
 469
 470         if (td->o.invalidate_cache && file_invalidate_cache(td, f))
 471                 goto err;
 472
 473         if (td->o.fadvise_hint != F_ADV_NONE &&
 474             (f->filetype == FIO_TYPE_BLOCK || f->filetype == FIO_TYPE_FILE)) {
 475                 int flags;
 476
 477                 if (td->o.fadvise_hint == F_ADV_TYPE) {
 478                         if (td_random(td))
 479                                 flags = POSIX_FADV_RANDOM;
 480                         else
 481                                 flags = POSIX_FADV_SEQUENTIAL;
 482                 } else if (td->o.fadvise_hint == F_ADV_RANDOM)
 483                         flags = POSIX_FADV_RANDOM;
 484                 else if (td->o.fadvise_hint == F_ADV_SEQUENTIAL)
 485                         flags = POSIX_FADV_SEQUENTIAL;
 486                 else {
 487                         log_err("fio: unknown fadvise type %d\n",
 488                                                         td->o.fadvise_hint);
 489                         flags = POSIX_FADV_NORMAL;
 490                 }
 491
 492                 if (posix_fadvise(f->fd, f->file_offset, f->io_size, flags) < 0) {
 493                         if (!fio_did_warn(FIO_WARN_FADVISE))
 494                                 log_err("fio: fadvise hint failed\n");
 495                 }
 496         }
 497 #ifdef FIO_HAVE_WRITE_HINT
 498         if (fio_option_is_set(&td->o, write_hint) &&
 499             (f->filetype == FIO_TYPE_BLOCK || f->filetype == FIO_TYPE_FILE)) {
 500                 uint64_t hint = td->o.write_hint;
 501                 int cmd;
 502
 503                 /*
 504                  * For direct IO, we just need/want to set the hint on
 505                  * the file descriptor. For buffered IO, we need to set
 506                  * it on the inode.
 507                  */
 508                 if (td->o.odirect)
 509                         cmd = F_SET_FILE_RW_HINT;
 510                 else
 511                         cmd = F_SET_RW_HINT;
 512
 513                 if (fcntl(f->fd, cmd, &hint) < 0) {
 514                         td_verror(td, errno, "fcntl write hint");
 515                         goto err;
 516                 }
 517         }
 518 #endif
 519
 520         if (td->o.odirect && !OS_O_DIRECT && fio_set_directio(td, f))
 521                 goto err;
 522
 523 done:
 524         log_file(td, f, FIO_LOG_OPEN_FILE);
 525         return 0;
 526 err:
 527         disk_util_dec(f->du);
 528         if (td->io_ops->close_file)
 529                 td->io_ops->close_file(td, f);
 530         return 1;
 531 }
 532
 533 int td_io_close_file(struct thread_data *td, struct fio_file *f)
 534 {
 535         if (!fio_file_closing(f))
 536                 log_file(td, f, FIO_LOG_CLOSE_FILE);
 537
 538         /*
 539          * mark as closing, do real close when last io on it has completed
 540          */
 541         fio_file_set_closing(f);
 542
 543         disk_util_dec(f->du);
 544
 545         if (td->o.file_lock_mode != FILE_LOCK_NONE)
 546                 unlock_file_all(td, f);
 547
 548         return put_file(td, f);
 549 }
 550
 551 int td_io_unlink_file(struct thread_data *td, struct fio_file *f)
 552 {
 553         if (td->io_ops->unlink_file)
 554                 return td->io_ops->unlink_file(td, f);
 555         else {
 556                 int ret;
 557
 558                 ret = unlink(f->file_name);
 559                 if (ret < 0)
 560                         return errno;
 561
 562                 return 0;
 563         }
 564 }
 565
 566 int td_io_get_file_size(struct thread_data *td, struct fio_file *f)
 567 {
 568         if (!td->io_ops->get_file_size)
 569                 return 0;
 570
 571         return td->io_ops->get_file_size(td, f);
 572 }
 573
 574 int fio_show_ioengine_help(const char *engine)
 575 {
 576         struct flist_head *entry;
 577         struct thread_data td;
 578         struct ioengine_ops *io_ops;
 579         char *sep;
 580         int ret = 1;
 581
 582         if (!engine || !*engine) {
 583                 log_info("Available IO engines:\n");
 584                 flist_for_each(entry, &engine_list) {
 585                         io_ops = flist_entry(entry, struct ioengine_ops, list);
 586                         log_info("\t%s\n", io_ops->name);
 587                 }
 588                 return 0;
 589         }
 590         sep = strchr(engine, ',');
 591         if (sep) {
 592                 *sep = 0;
 593                 sep++;
 594         }
 595
 596         memset(&td, 0, sizeof(struct thread_data));
 597         td.o.ioengine = (char *)engine;
 598         io_ops = load_ioengine(&td);
 599
 600         if (!io_ops) {
 601                 log_info("IO engine %s not found\n", engine);
 602                 return 1;
 603         }
 604
 605         if (io_ops->options)
 606                 ret = show_cmd_help(io_ops->options, sep);
 607         else
 608                 log_info("IO engine %s has no options\n", io_ops->name);
 609
 610         free_ioengine(&td);
 611         return ret;
 612 }