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         if (min > 0 && td->io_ops->commit) {
 212                 r = td->io_ops->commit(td);
 213                 if (r < 0)
 214                         goto out;
 215         }
 216         if (max > td->cur_depth)
 217                 max = td->cur_depth;
 218         if (min > max)
 219                 max = min;
 220
 221         r = 0;
 222         if (max && td->io_ops->getevents)
 223                 r = td->io_ops->getevents(td, min, max, t);
 224 out:
 225         if (r >= 0) {
 226                 /*
 227                  * Reflect that our submitted requests were retrieved with
 228                  * whatever OS async calls are in the underlying engine.
 229                  */
 230                 td->io_u_in_flight -= r;
 231                 io_u_mark_complete(td, r);
 232         } else
 233                 td_verror(td, r, "get_events");
 234
 235         dprint(FD_IO, "getevents: %d\n", r);
 236         return r;
 237 }
 238
 239 int td_io_queue(struct thread_data *td, struct io_u *io_u)
 240 {
 241         int ret;
 242
 243         dprint_io_u(io_u, "queue");
 244         fio_ro_check(td, io_u);
 245
 246         assert((io_u->flags & IO_U_F_FLIGHT) == 0);
 247         io_u->flags |= IO_U_F_FLIGHT;
 248
 249         assert(fio_file_open(io_u->file));
 250
 251         io_u->error = 0;
 252         io_u->resid = 0;
 253
 254         if (td->io_ops->flags & FIO_SYNCIO) {
 255                 if (fio_fill_issue_time(td))
 256                         fio_gettime(&io_u->issue_time, NULL);
 257
 258                 /*
 259                  * only used for iolog
 260                  */
 261                 if (td->o.read_iolog_file)
 262                         memcpy(&td->last_issue, &io_u->issue_time,
 263                                         sizeof(struct timeval));
 264         }
 265
 266         if (ddir_rw(io_u->ddir))
 267                 td->io_issues[io_u->ddir]++;
 268
 269         ret = td->io_ops->queue(td, io_u);
 270
 271         unlock_file(td, io_u->file);
 272
 273         /*
 274          * Add warning for O_DIRECT so that users have an easier time
 275          * spotting potentially bad alignment. If this triggers for the first
 276          * IO, then it's likely an alignment problem or because the host fs
 277          * does not support O_DIRECT
 278          */
 279         if (io_u->error == EINVAL && td->io_issues[io_u->ddir & 1] == 1 &&
 280             td->o.odirect) {
 281
 282                 log_info("fio: first direct IO errored. File system may not "
 283                          "support direct IO, or iomem_align= is bad.\n");
 284         }
 285
 286         if (!td->io_ops->commit) {
 287                 io_u_mark_submit(td, 1);
 288                 io_u_mark_complete(td, 1);
 289         }
 290
 291         if (ret == FIO_Q_COMPLETED) {
 292                 if (ddir_rw(io_u->ddir)) {
 293                         io_u_mark_depth(td, 1);
 294                         td->ts.total_io_u[io_u->ddir]++;
 295                 } else if (io_u->ddir == DDIR_TRIM)
 296                         td->ts.total_io_u[2]++;
 297         } else if (ret == FIO_Q_QUEUED) {
 298                 int r;
 299
 300                 if (ddir_rw(io_u->ddir)) {
 301                         td->io_u_queued++;
 302                         td->ts.total_io_u[io_u->ddir]++;
 303                 }
 304
 305                 if (td->io_u_queued >= td->o.iodepth_batch) {
 306                         r = td_io_commit(td);
 307                         if (r < 0)
 308                                 return r;
 309                 }
 310         }
 311
 312         if ((td->io_ops->flags & FIO_SYNCIO) == 0) {
 313                 if (fio_fill_issue_time(td))
 314                         fio_gettime(&io_u->issue_time, NULL);
 315
 316                 /*
 317                  * only used for iolog
 318                  */
 319                 if (td->o.read_iolog_file)
 320                         memcpy(&td->last_issue, &io_u->issue_time,
 321                                         sizeof(struct timeval));
 322         }
 323
 324         return ret;
 325 }
 326
 327 int td_io_init(struct thread_data *td)
 328 {
 329         int ret = 0;
 330
 331         if (td->io_ops->init) {
 332                 ret = td->io_ops->init(td);
 333                 if (ret && td->o.iodepth > 1) {
 334                         log_err("fio: io engine init failed. Perhaps try"
 335                                 " reducing io depth?\n");
 336                 }
 337                 if (!td->error)
 338                         td->error = ret;
 339         }
 340
 341         return ret;
 342 }
 343
 344 int td_io_commit(struct thread_data *td)
 345 {
 346         int ret;
 347
 348         dprint(FD_IO, "calling ->commit(), depth %d\n", td->cur_depth);
 349
 350         if (!td->cur_depth || !td->io_u_queued)
 351                 return 0;
 352
 353         io_u_mark_depth(td, td->io_u_queued);
 354
 355         if (td->io_ops->commit) {
 356                 ret = td->io_ops->commit(td);
 357                 if (ret)
 358                         td_verror(td, -ret, "io commit");
 359         }
 360
 361         /*
 362          * Reflect that events were submitted as async IO requests.
 363          */
 364         td->io_u_in_flight += td->io_u_queued;
 365         td->io_u_queued = 0;
 366
 367         return 0;
 368 }
 369
 370 int td_io_open_file(struct thread_data *td, struct fio_file *f)
 371 {
 372         assert(!fio_file_open(f));
 373         assert(f->fd == -1);
 374
 375         if (td->io_ops->open_file(td, f)) {
 376                 if (td->error == EINVAL && td->o.odirect)
 377                         log_err("fio: destination does not support O_DIRECT\n");
 378                 if (td->error == EMFILE) {
 379                         log_err("fio: try reducing/setting openfiles (failed"
 380                                 " at %u of %u)\n", td->nr_open_files,
 381                                                         td->o.nr_files);
 382                 }
 383
 384                 assert(f->fd == -1);
 385                 assert(!fio_file_open(f));
 386                 return 1;
 387         }
 388
 389         fio_file_reset(f);
 390         fio_file_set_open(f);
 391         fio_file_clear_closing(f);
 392         disk_util_inc(f->du);
 393
 394         td->nr_open_files++;
 395         get_file(f);
 396
 397         if (f->filetype == FIO_TYPE_PIPE) {
 398                 if (td_random(td)) {
 399                         log_err("fio: can't seek on pipes (no random io)\n");
 400                         goto err;
 401                 }
 402         }
 403
 404         if (td->io_ops->flags & FIO_DISKLESSIO)
 405                 goto done;
 406
 407         if (td->o.invalidate_cache && file_invalidate_cache(td, f))
 408                 goto err;
 409
 410         if (td->o.fadvise_hint &&
 411             (f->filetype == FIO_TYPE_BD || f->filetype == FIO_TYPE_FILE)) {
 412                 int flags;
 413
 414                 if (td_random(td))
 415                         flags = POSIX_FADV_RANDOM;
 416                 else
 417                         flags = POSIX_FADV_SEQUENTIAL;
 418
 419                 if (posix_fadvise(f->fd, f->file_offset, f->io_size, flags) < 0) {
 420                         td_verror(td, errno, "fadvise");
 421                         goto err;
 422                 }
 423         }
 424
 425 #ifdef FIO_OS_DIRECTIO
 426         /*
 427          * Some OS's have a distinct call to mark the file non-buffered,
 428          * instead of using O_DIRECT (Solaris)
 429          */
 430         if (td->o.odirect) {
 431                 int ret = fio_set_odirect(f->fd);
 432
 433                 if (ret) {
 434                         td_verror(td, ret, "fio_set_odirect");
 435                         log_err("fio: the file system does not seem to support direct IO\n");
 436                         goto err;
 437                 }
 438         }
 439 #endif
 440
 441 done:
 442         log_file(td, f, FIO_LOG_OPEN_FILE);
 443         return 0;
 444 err:
 445         disk_util_dec(f->du);
 446         if (td->io_ops->close_file)
 447                 td->io_ops->close_file(td, f);
 448         return 1;
 449 }
 450
 451 int td_io_close_file(struct thread_data *td, struct fio_file *f)
 452 {
 453         if (!fio_file_closing(f))
 454                 log_file(td, f, FIO_LOG_CLOSE_FILE);
 455
 456         /*
 457          * mark as closing, do real close when last io on it has completed
 458          */
 459         fio_file_set_closing(f);
 460
 461         disk_util_dec(f->du);
 462         unlock_file_all(td, f);
 463
 464         return put_file(td, f);
 465 }
 466
 467 int td_io_get_file_size(struct thread_data *td, struct fio_file *f)
 468 {
 469         if (!td->io_ops->get_file_size)
 470                 return 0;
 471
 472         return td->io_ops->get_file_size(td, f);
 473 }
 474
 475 static int do_sync_file_range(struct thread_data *td, struct fio_file *f)
 476 {
 477         off64_t offset, nbytes;
 478
 479         offset = f->first_write;
 480         nbytes = f->last_write - f->first_write;
 481
 482         if (!nbytes)
 483                 return 0;
 484
 485         return sync_file_range(f->fd, offset, nbytes, td->o.sync_file_range);
 486 }
 487
 488 int do_io_u_sync(struct thread_data *td, struct io_u *io_u)
 489 {
 490         int ret;
 491
 492         if (io_u->ddir == DDIR_SYNC) {
 493                 ret = fsync(io_u->file->fd);
 494         } else if (io_u->ddir == DDIR_DATASYNC) {
 495 #ifdef FIO_HAVE_FDATASYNC
 496                 ret = fdatasync(io_u->file->fd);
 497 #else
 498                 ret = io_u->xfer_buflen;
 499                 io_u->error = EINVAL;
 500 #endif
 501         } else if (io_u->ddir == DDIR_SYNC_FILE_RANGE)
 502                 ret = do_sync_file_range(td, io_u->file);
 503         else {
 504                 ret = io_u->xfer_buflen;
 505                 io_u->error = EINVAL;
 506         }
 507
 508         if (ret < 0)
 509                 io_u->error = errno;
 510
 511         return ret;
 512 }
 513
 514 int do_io_u_trim(struct thread_data *td, struct io_u *io_u)
 515 {
 516 #ifndef FIO_HAVE_TRIM
 517         io_u->error = EINVAL;
 518         return 0;
 519 #else
 520         struct fio_file *f = io_u->file;
 521         int ret;
 522
 523         ret = os_trim(f->fd, io_u->offset, io_u->xfer_buflen);
 524         if (!ret)
 525                 return io_u->xfer_buflen;;
 526
 527         io_u->error = ret;
 528         return 0;
 529 #endif
 530 }
 531
 532 int fio_show_ioengine_help(const char *engine)
 533 {
 534         struct flist_head *entry;
 535         struct thread_data td;
 536         char *sep;
 537         int ret = 1;
 538
 539         if (!engine || !*engine) {
 540                 log_info("Available IO engines:\n");
 541                 flist_for_each(entry, &engine_list) {
 542                         td.io_ops = flist_entry(entry, struct ioengine_ops,
 543                                                 list);
 544                         log_info("\t%s\n", td.io_ops->name);
 545                 }
 546                 return 0;
 547         }
 548         sep = strchr(engine, ',');
 549         if (sep) {
 550                 *sep = 0;
 551                 sep++;
 552         }
 553
 554         memset(&td, 0, sizeof(td));
 555
 556         td.io_ops = load_ioengine(&td, engine);
 557         if (!td.io_ops) {
 558                 log_info("IO engine %s not found\n", engine);
 559                 return 1;
 560         }
 561
 562         if (td.io_ops->options)
 563                 ret = show_cmd_help(td.io_ops->options, sep);
 564         else
 565                 log_info("IO engine %s has no options\n", td.io_ops->name);
 566
 567         free_ioengine(&td);
 568
 569         return ret;
 570 }