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