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