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