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