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