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