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 static struct ioengine_ops *__load_ioengine(const char *name)
 127 {
 128         char engine[64];
 129
 130         engine[sizeof(engine) - 1] = '\0';
 131         strncpy(engine, name, sizeof(engine) - 1);
 132
 133         /*
 134          * linux libaio has alias names, so convert to what we want
 135          */
 136         if (!strncmp(engine, "linuxaio", 8) || !strncmp(engine, "aio", 3)) {
 137                 dprint(FD_IO, "converting ioengine name: %s -> libaio\n", name);
 138                 strcpy(engine, "libaio");
 139         }
 140
 141         dprint(FD_IO, "load ioengine %s\n", engine);
 142         return find_ioengine(engine);
 143 }
 144
 145 struct ioengine_ops *load_ioengine(struct thread_data *td)
 146 {
 147         struct ioengine_ops *ops = NULL;
 148         const char *name;
 149
 150         /*
 151          * Use ->ioengine_so_path if an external ioengine path is specified.
 152          * In this case, ->ioengine is "external" which also means the prefix
 153          * for external ioengines "external:" is properly used.
 154          */
 155         name = td->o.ioengine_so_path ?: td->o.ioengine;
 156
 157         /*
 158          * Try to load ->ioengine first, and if failed try to dlopen(3) either
 159          * ->ioengine or ->ioengine_so_path.  This is redundant for an external
 160          * ioengine with prefix, and also leaves the possibility of unexpected
 161          * behavior (e.g. if the "external" ioengine exists), but we do this
 162          * so as not to break job files not using the prefix.
 163          */
 164         ops = __load_ioengine(td->o.ioengine);
 165         if (!ops)
 166                 ops = dlopen_ioengine(td, name);
 167
 168         /*
 169          * If ops is NULL, we failed to load ->ioengine, and also failed to
 170          * dlopen(3) either ->ioengine or ->ioengine_so_path as a path.
 171          */
 172         if (!ops) {
 173                 log_err("fio: engine %s not loadable\n", name);
 174                 return NULL;
 175         }
 176
 177         /*
 178          * Check that the required methods are there.
 179          */
 180         if (check_engine_ops(ops))
 181                 return NULL;
 182
 183         return ops;
 184 }
 185
 186 /*
 187  * For cleaning up an ioengine which never made it to init().
 188  */
 189 void free_ioengine(struct thread_data *td)
 190 {
 191         dprint(FD_IO, "free ioengine %s\n", td->io_ops->name);
 192
 193         if (td->eo && td->io_ops->options) {
 194                 options_free(td->io_ops->options, td->eo);
 195                 free(td->eo);
 196                 td->eo = NULL;
 197         }
 198
 199         if (td->io_ops_dlhandle)
 200                 dlclose(td->io_ops_dlhandle);
 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(%p)=%d\n", io_u, ret);
 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 int 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         int 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                 td->io_issues[ddir]++;
 315                 td->io_issue_bytes[ddir] += buflen;
 316                 td->rate_io_issue_bytes[ddir] += buflen;
 317         }
 318
 319         ret = td->io_ops->queue(td, io_u);
 320
 321         unlock_file(td, io_u->file);
 322
 323         if (ret == FIO_Q_BUSY && ddir_rw(ddir)) {
 324                 td->io_issues[ddir]--;
 325                 td->io_issue_bytes[ddir] -= buflen;
 326                 td->rate_io_issue_bytes[ddir] -= buflen;
 327                 io_u_clear(td, io_u, IO_U_F_FLIGHT);
 328         }
 329
 330         /*
 331          * If an error was seen and the io engine didn't propagate it
 332          * back to 'td', do so.
 333          */
 334         if (io_u->error && !td->error)
 335                 td_verror(td, io_u->error, "td_io_queue");
 336
 337         /*
 338          * Add warning for O_DIRECT so that users have an easier time
 339          * spotting potentially bad alignment. If this triggers for the first
 340          * IO, then it's likely an alignment problem or because the host fs
 341          * does not support O_DIRECT
 342          */
 343         if (io_u->error == EINVAL && td->io_issues[io_u->ddir & 1] == 1 &&
 344             td->o.odirect) {
 345
 346                 log_info("fio: first direct IO errored. File system may not "
 347                          "support direct IO, or iomem_align= is bad, or "
 348                          "invalid block size. Try setting direct=0.\n");
 349         }
 350
 351         if (!td->io_ops->commit || io_u->ddir == DDIR_TRIM) {
 352                 io_u_mark_submit(td, 1);
 353                 io_u_mark_complete(td, 1);
 354         }
 355
 356         if (ret == FIO_Q_COMPLETED) {
 357                 if (ddir_rw(io_u->ddir)) {
 358                         io_u_mark_depth(td, 1);
 359                         td->ts.total_io_u[io_u->ddir]++;
 360                 }
 361         } else if (ret == FIO_Q_QUEUED) {
 362                 int r;
 363
 364                 td->io_u_queued++;
 365
 366                 if (ddir_rw(io_u->ddir))
 367                         td->ts.total_io_u[io_u->ddir]++;
 368
 369                 if (td->io_u_queued >= td->o.iodepth_batch) {
 370                         r = td_io_commit(td);
 371                         if (r < 0)
 372                                 return r;
 373                 }
 374         }
 375
 376         if (!td_ioengine_flagged(td, FIO_SYNCIO)) {
 377                 if (fio_fill_issue_time(td))
 378                         fio_gettime(&io_u->issue_time, NULL);
 379
 380                 /*
 381                  * only used for iolog
 382                  */
 383                 if (td->o.read_iolog_file)
 384                         memcpy(&td->last_issue, &io_u->issue_time,
 385                                         sizeof(io_u->issue_time));
 386         }
 387
 388         return ret;
 389 }
 390
 391 int td_io_init(struct thread_data *td)
 392 {
 393         int ret = 0;
 394
 395         if (td->io_ops->init) {
 396                 ret = td->io_ops->init(td);
 397                 if (ret)
 398                         log_err("fio: io engine %s init failed.%s\n",
 399                                 td->io_ops->name,
 400                                 td->o.iodepth > 1 ?
 401                                 " Perhaps try reducing io depth?" : "");
 402                 else
 403                         td->io_ops_init = 1;
 404                 if (!td->error)
 405                         td->error = ret;
 406         }
 407
 408         return ret;
 409 }
 410
 411 int td_io_commit(struct thread_data *td)
 412 {
 413         int ret;
 414
 415         dprint(FD_IO, "calling ->commit(), depth %d\n", td->cur_depth);
 416
 417         if (!td->cur_depth || !td->io_u_queued)
 418                 return 0;
 419
 420         io_u_mark_depth(td, td->io_u_queued);
 421
 422         if (td->io_ops->commit) {
 423                 ret = td->io_ops->commit(td);
 424                 if (ret)
 425                         td_verror(td, -ret, "io commit");
 426         }
 427
 428         /*
 429          * Reflect that events were submitted as async IO requests.
 430          */
 431         td->io_u_in_flight += td->io_u_queued;
 432         td->io_u_queued = 0;
 433
 434         return 0;
 435 }
 436
 437 int td_io_open_file(struct thread_data *td, struct fio_file *f)
 438 {
 439         assert(!fio_file_open(f));
 440         assert(f->fd == -1);
 441         assert(td->io_ops->open_file);
 442
 443         if (td->io_ops->open_file(td, f)) {
 444                 if (td->error == EINVAL && td->o.odirect)
 445                         log_err("fio: destination does not support O_DIRECT\n");
 446                 if (td->error == EMFILE) {
 447                         log_err("fio: try reducing/setting openfiles (failed"
 448                                 " at %u of %u)\n", td->nr_open_files,
 449                                                         td->o.nr_files);
 450                 }
 451
 452                 assert(f->fd == -1);
 453                 assert(!fio_file_open(f));
 454                 return 1;
 455         }
 456
 457         fio_file_reset(td, f);
 458         fio_file_set_open(f);
 459         fio_file_clear_closing(f);
 460         disk_util_inc(f->du);
 461
 462         td->nr_open_files++;
 463         get_file(f);
 464
 465         if (f->filetype == FIO_TYPE_PIPE) {
 466                 if (td_random(td)) {
 467                         log_err("fio: can't seek on pipes (no random io)\n");
 468                         goto err;
 469                 }
 470         }
 471
 472         if (td_ioengine_flagged(td, FIO_DISKLESSIO))
 473                 goto done;
 474
 475         if (td->o.invalidate_cache && file_invalidate_cache(td, f))
 476                 goto err;
 477
 478         if (td->o.fadvise_hint != F_ADV_NONE &&
 479             (f->filetype == FIO_TYPE_BLOCK || f->filetype == FIO_TYPE_FILE)) {
 480                 int flags;
 481
 482                 if (td->o.fadvise_hint == F_ADV_TYPE) {
 483                         if (td_random(td))
 484                                 flags = POSIX_FADV_RANDOM;
 485                         else
 486                                 flags = POSIX_FADV_SEQUENTIAL;
 487                 } else if (td->o.fadvise_hint == F_ADV_RANDOM)
 488                         flags = POSIX_FADV_RANDOM;
 489                 else if (td->o.fadvise_hint == F_ADV_SEQUENTIAL)
 490                         flags = POSIX_FADV_SEQUENTIAL;
 491                 else {
 492                         log_err("fio: unknown fadvise type %d\n",
 493                                                         td->o.fadvise_hint);
 494                         flags = POSIX_FADV_NORMAL;
 495                 }
 496
 497                 if (posix_fadvise(f->fd, f->file_offset, f->io_size, flags) < 0) {
 498                         td_verror(td, errno, "fadvise");
 499                         goto err;
 500                 }
 501         }
 502 #ifdef FIO_HAVE_WRITE_HINT
 503         if (fio_option_is_set(&td->o, write_hint) &&
 504             (f->filetype == FIO_TYPE_BLOCK || f->filetype == FIO_TYPE_FILE)) {
 505                 uint64_t hint = td->o.write_hint;
 506                 int cmd;
 507
 508                 /*
 509                  * For direct IO, we just need/want to set the hint on
 510                  * the file descriptor. For buffered IO, we need to set
 511                  * it on the inode.
 512                  */
 513                 if (td->o.odirect)
 514                         cmd = F_SET_FILE_RW_HINT;
 515                 else
 516                         cmd = F_SET_RW_HINT;
 517
 518                 if (fcntl(f->fd, cmd, &hint) < 0) {
 519                         td_verror(td, errno, "fcntl write hint");
 520                         goto err;
 521                 }
 522         }
 523 #endif
 524
 525         if (td->o.odirect && !OS_O_DIRECT && fio_set_directio(td, f))
 526                 goto err;
 527
 528 done:
 529         log_file(td, f, FIO_LOG_OPEN_FILE);
 530         return 0;
 531 err:
 532         disk_util_dec(f->du);
 533         if (td->io_ops->close_file)
 534                 td->io_ops->close_file(td, f);
 535         return 1;
 536 }
 537
 538 int td_io_close_file(struct thread_data *td, struct fio_file *f)
 539 {
 540         if (!fio_file_closing(f))
 541                 log_file(td, f, FIO_LOG_CLOSE_FILE);
 542
 543         /*
 544          * mark as closing, do real close when last io on it has completed
 545          */
 546         fio_file_set_closing(f);
 547
 548         disk_util_dec(f->du);
 549
 550         if (td->o.file_lock_mode != FILE_LOCK_NONE)
 551                 unlock_file_all(td, f);
 552
 553         return put_file(td, f);
 554 }
 555
 556 int td_io_unlink_file(struct thread_data *td, struct fio_file *f)
 557 {
 558         if (td->io_ops->unlink_file)
 559                 return td->io_ops->unlink_file(td, f);
 560         else {
 561                 int ret;
 562
 563                 ret = unlink(f->file_name);
 564                 if (ret < 0)
 565                         return errno;
 566
 567                 return 0;
 568         }
 569 }
 570
 571 int td_io_get_file_size(struct thread_data *td, struct fio_file *f)
 572 {
 573         if (!td->io_ops->get_file_size)
 574                 return 0;
 575
 576         return td->io_ops->get_file_size(td, f);
 577 }
 578
 579 int fio_show_ioengine_help(const char *engine)
 580 {
 581         struct flist_head *entry;
 582         struct ioengine_ops *io_ops;
 583         char *sep;
 584         int ret = 1;
 585
 586         if (!engine || !*engine) {
 587                 log_info("Available IO engines:\n");
 588                 flist_for_each(entry, &engine_list) {
 589                         io_ops = flist_entry(entry, struct ioengine_ops, list);
 590                         log_info("\t%s\n", io_ops->name);
 591                 }
 592                 return 0;
 593         }
 594         sep = strchr(engine, ',');
 595         if (sep) {
 596                 *sep = 0;
 597                 sep++;
 598         }
 599
 600         io_ops = __load_ioengine(engine);
 601         if (!io_ops) {
 602                 log_info("IO engine %s not found\n", engine);
 603                 return 1;
 604         }
 605
 606         if (io_ops->options)
 607                 ret = show_cmd_help(io_ops->options, sep);
 608         else
 609                 log_info("IO engine %s has no options\n", io_ops->name);
 610
 611         return ret;
 612 }