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