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 void close_ioengine(struct thread_data *td)
 156 {
 157         dprint(FD_IO, "close ioengine %s\n", td->io_ops->name);
 158
 159         if (td->io_ops->cleanup) {
 160                 td->io_ops->cleanup(td);
 161                 td->io_ops->data = NULL;
 162         }
 163
 164         if (td->io_ops->dlhandle)
 165                 dlclose(td->io_ops->dlhandle);
 166
 167         free(td->io_ops);
 168         td->io_ops = NULL;
 169 }
 170
 171 int td_io_prep(struct thread_data *td, struct io_u *io_u)
 172 {
 173         dprint_io_u(io_u, "prep");
 174         fio_ro_check(td, io_u);
 175
 176         lock_file(td, io_u->file, io_u->ddir);
 177
 178         if (td->io_ops->prep) {
 179                 int ret = td->io_ops->prep(td, io_u);
 180
 181                 dprint(FD_IO, "->prep(%p)=%d\n", io_u, ret);
 182                 if (ret)
 183                         unlock_file(td, io_u->file);
 184                 return ret;
 185         }
 186
 187         return 0;
 188 }
 189
 190 int td_io_getevents(struct thread_data *td, unsigned int min, unsigned int max,
 191                     struct timespec *t)
 192 {
 193         int r = 0;
 194
 195         if (min > 0 && td->io_ops->commit) {
 196                 r = td->io_ops->commit(td);
 197                 if (r < 0)
 198                         goto out;
 199         }
 200         if (max > td->cur_depth)
 201                 max = td->cur_depth;
 202         if (min > max)
 203                 max = min;
 204
 205         r = 0;
 206         if (max && td->io_ops->getevents)
 207                 r = td->io_ops->getevents(td, min, max, t);
 208 out:
 209         if (r >= 0)
 210                 io_u_mark_complete(td, r);
 211         else
 212                 td_verror(td, r, "get_events");
 213
 214         dprint(FD_IO, "getevents: %d\n", r);
 215         return r;
 216 }
 217
 218 int td_io_queue(struct thread_data *td, struct io_u *io_u)
 219 {
 220         int ret;
 221
 222         dprint_io_u(io_u, "queue");
 223         fio_ro_check(td, io_u);
 224
 225         assert((io_u->flags & IO_U_F_FLIGHT) == 0);
 226         io_u->flags |= IO_U_F_FLIGHT;
 227
 228         assert(fio_file_open(io_u->file));
 229
 230         io_u->error = 0;
 231         io_u->resid = 0;
 232
 233         if (td->io_ops->flags & FIO_SYNCIO) {
 234                 if (fio_fill_issue_time(td))
 235                         fio_gettime(&io_u->issue_time, NULL);
 236
 237                 /*
 238                  * only used for iolog
 239                  */
 240                 if (td->o.read_iolog_file)
 241                         memcpy(&td->last_issue, &io_u->issue_time,
 242                                         sizeof(struct timeval));
 243         }
 244
 245         if (ddir_rw(io_u->ddir))
 246                 td->io_issues[io_u->ddir]++;
 247
 248         ret = td->io_ops->queue(td, io_u);
 249
 250         unlock_file(td, io_u->file);
 251
 252         /*
 253          * Add warning for O_DIRECT so that users have an easier time
 254          * spotting potentially bad alignment. If this triggers for the first
 255          * IO, then it's likely an alignment problem or because the host fs
 256          * does not support O_DIRECT
 257          */
 258         if (io_u->error == EINVAL && td->io_issues[io_u->ddir & 1] == 1 &&
 259             td->o.odirect) {
 260                 log_info("fio: first direct IO errored. File system may not "
 261                          "support direct IO, or iomem_align= is bad.\n");
 262         }
 263
 264         if (!td->io_ops->commit) {
 265                 io_u_mark_submit(td, 1);
 266                 io_u_mark_complete(td, 1);
 267         }
 268
 269         if (ret == FIO_Q_COMPLETED) {
 270                 if (ddir_rw(io_u->ddir)) {
 271                         io_u_mark_depth(td, 1);
 272                         td->ts.total_io_u[io_u->ddir]++;
 273                 } else if (io_u->ddir == DDIR_TRIM)
 274                         td->ts.total_io_u[2]++;
 275         } else if (ret == FIO_Q_QUEUED) {
 276                 int r;
 277
 278                 if (ddir_rw(io_u->ddir)) {
 279                         td->io_u_queued++;
 280                         td->ts.total_io_u[io_u->ddir]++;
 281                 }
 282
 283                 if (td->io_u_queued >= td->o.iodepth_batch) {
 284                         r = td_io_commit(td);
 285                         if (r < 0)
 286                                 return r;
 287                 }
 288         }
 289
 290         if ((td->io_ops->flags & FIO_SYNCIO) == 0) {
 291                 if (fio_fill_issue_time(td))
 292                         fio_gettime(&io_u->issue_time, NULL);
 293
 294                 /*
 295                  * only used for iolog
 296                  */
 297                 if (td->o.read_iolog_file)
 298                         memcpy(&td->last_issue, &io_u->issue_time,
 299                                         sizeof(struct timeval));
 300         }
 301
 302         return ret;
 303 }
 304
 305 int td_io_init(struct thread_data *td)
 306 {
 307         int ret = 0;
 308
 309         if (td->io_ops->init) {
 310                 ret = td->io_ops->init(td);
 311                 if (ret && td->o.iodepth > 1) {
 312                         log_err("fio: io engine init failed. Perhaps try"
 313                                 " reducing io depth?\n");
 314                 }
 315                 if (!td->error)
 316                         td->error = ret;
 317         }
 318
 319         return ret;
 320 }
 321
 322 int td_io_commit(struct thread_data *td)
 323 {
 324         int ret;
 325
 326         dprint(FD_IO, "calling ->commit(), depth %d\n", td->cur_depth);
 327
 328         if (!td->cur_depth || !td->io_u_queued)
 329                 return 0;
 330
 331         io_u_mark_depth(td, td->io_u_queued);
 332         td->io_u_queued = 0;
 333
 334         if (td->io_ops->commit) {
 335                 ret = td->io_ops->commit(td);
 336                 if (ret)
 337                         td_verror(td, -ret, "io commit");
 338         }
 339
 340         return 0;
 341 }
 342
 343 int td_io_open_file(struct thread_data *td, struct fio_file *f)
 344 {
 345         assert(!fio_file_open(f));
 346         assert(f->fd == -1);
 347
 348         if (td->io_ops->open_file(td, f)) {
 349                 if (td->error == EINVAL && td->o.odirect)
 350                         log_err("fio: destination does not support O_DIRECT\n");
 351                 if (td->error == EMFILE) {
 352                         log_err("fio: try reducing/setting openfiles (failed"
 353                                 " at %u of %u)\n", td->nr_open_files,
 354                                                         td->o.nr_files);
 355                 }
 356
 357                 assert(f->fd == -1);
 358                 assert(!fio_file_open(f));
 359                 return 1;
 360         }
 361
 362         fio_file_reset(f);
 363         fio_file_set_open(f);
 364         fio_file_clear_closing(f);
 365         disk_util_inc(f->du);
 366
 367         td->nr_open_files++;
 368         get_file(f);
 369
 370         if (f->filetype == FIO_TYPE_PIPE) {
 371                 if (td_random(td)) {
 372                         log_err("fio: can't seek on pipes (no random io)\n");
 373                         goto err;
 374                 }
 375         }
 376
 377         if (td->io_ops->flags & FIO_DISKLESSIO)
 378                 goto done;
 379
 380         if (td->o.invalidate_cache && file_invalidate_cache(td, f))
 381                 goto err;
 382
 383         if (td->o.fadvise_hint &&
 384             (f->filetype == FIO_TYPE_BD || f->filetype == FIO_TYPE_FILE)) {
 385                 int flags;
 386
 387                 if (td_random(td))
 388                         flags = POSIX_FADV_RANDOM;
 389                 else
 390                         flags = POSIX_FADV_SEQUENTIAL;
 391
 392                 if (posix_fadvise(f->fd, f->file_offset, f->io_size, flags) < 0) {
 393                         td_verror(td, errno, "fadvise");
 394                         goto err;
 395                 }
 396         }
 397
 398 #ifdef FIO_OS_DIRECTIO
 399         /*
 400          * Some OS's have a distinct call to mark the file non-buffered,
 401          * instead of using O_DIRECT (Solaris)
 402          */
 403         if (td->o.odirect) {
 404                 int ret = fio_set_odirect(f->fd);
 405
 406                 if (ret) {
 407                         td_verror(td, ret, "fio_set_odirect");
 408                         log_err("fio: the file system does not seem to support direct IO\n");
 409                         goto err;
 410                 }
 411         }
 412 #endif
 413
 414 done:
 415         log_file(td, f, FIO_LOG_OPEN_FILE);
 416         return 0;
 417 err:
 418         disk_util_dec(f->du);
 419         if (td->io_ops->close_file)
 420                 td->io_ops->close_file(td, f);
 421         return 1;
 422 }
 423
 424 int td_io_close_file(struct thread_data *td, struct fio_file *f)
 425 {
 426         if (!fio_file_closing(f))
 427                 log_file(td, f, FIO_LOG_CLOSE_FILE);
 428
 429         /*
 430          * mark as closing, do real close when last io on it has completed
 431          */
 432         fio_file_set_closing(f);
 433
 434         disk_util_dec(f->du);
 435         unlock_file_all(td, f);
 436
 437         return put_file(td, f);
 438 }
 439
 440 int td_io_get_file_size(struct thread_data *td, struct fio_file *f)
 441 {
 442         if (!td->io_ops->get_file_size)
 443                 return 0;
 444
 445         return td->io_ops->get_file_size(td, f);
 446 }
 447
 448 static int do_sync_file_range(struct thread_data *td, struct fio_file *f)
 449 {
 450         off64_t offset, nbytes;
 451
 452         offset = f->first_write;
 453         nbytes = f->last_write - f->first_write;
 454
 455         if (!nbytes)
 456                 return 0;
 457
 458         return sync_file_range(f->fd, offset, nbytes, td->o.sync_file_range);
 459 }
 460
 461 int do_io_u_sync(struct thread_data *td, struct io_u *io_u)
 462 {
 463         int ret;
 464
 465         if (io_u->ddir == DDIR_SYNC) {
 466                 ret = fsync(io_u->file->fd);
 467         } else if (io_u->ddir == DDIR_DATASYNC) {
 468 #ifdef FIO_HAVE_FDATASYNC
 469                 ret = fdatasync(io_u->file->fd);
 470 #else
 471                 ret = io_u->xfer_buflen;
 472                 io_u->error = EINVAL;
 473 #endif
 474         } else if (io_u->ddir == DDIR_SYNC_FILE_RANGE)
 475                 ret = do_sync_file_range(td, io_u->file);
 476         else {
 477                 ret = io_u->xfer_buflen;
 478                 io_u->error = EINVAL;
 479         }
 480
 481         if (ret < 0)
 482                 io_u->error = errno;
 483
 484         return ret;
 485 }
 486
 487 int do_io_u_trim(struct thread_data *td, struct io_u *io_u)
 488 {
 489 #ifndef FIO_HAVE_TRIM
 490         io_u->error = EINVAL;
 491         return 0;
 492 #else
 493         struct fio_file *f = io_u->file;
 494         int ret;
 495
 496         ret = os_trim(f->fd, io_u->offset, io_u->xfer_buflen);
 497         if (!ret)
 498                 return io_u->xfer_buflen;;
 499
 500         io_u->error = ret;
 501         return 0;
 502 #endif
 503 }