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 <assert.h>
  18
  19 #include "fio.h"
  20
  21 static FLIST_HEAD(engine_list);
  22
  23 static int check_engine_ops(struct ioengine_ops *ops)
  24 {
  25         if (ops->version != FIO_IOOPS_VERSION) {
  26                 log_err("bad ioops version %d (want %d)\n", ops->version,
  27                                                         FIO_IOOPS_VERSION);
  28                 return 1;
  29         }
  30
  31         if (!ops->queue) {
  32                 log_err("%s: no queue handler\n", ops->name);
  33                 return 1;
  34         }
  35
  36         /*
  37          * sync engines only need a ->queue()
  38          */
  39         if (ops->flags & FIO_SYNCIO)
  40                 return 0;
  41
  42         if (!ops->event) {
  43                 log_err("%s: no event handler\n", ops->name);
  44                 return 1;
  45         }
  46         if (!ops->getevents) {
  47                 log_err("%s: no getevents handler\n", ops->name);
  48                 return 1;
  49         }
  50         if (!ops->queue) {
  51                 log_err("%s: no queue handler\n", ops->name);
  52                 return 1;
  53         }
  54
  55         return 0;
  56 }
  57
  58 void unregister_ioengine(struct ioengine_ops *ops)
  59 {
  60         dprint(FD_IO, "ioengine %s unregistered\n", ops->name);
  61         flist_del(&ops->list);
  62         INIT_FLIST_HEAD(&ops->list);
  63 }
  64
  65 void register_ioengine(struct ioengine_ops *ops)
  66 {
  67         dprint(FD_IO, "ioengine %s registered\n", ops->name);
  68         INIT_FLIST_HEAD(&ops->list);
  69         flist_add_tail(&ops->list, &engine_list);
  70 }
  71
  72 static struct ioengine_ops *find_ioengine(const char *name)
  73 {
  74         struct ioengine_ops *ops;
  75         struct flist_head *entry;
  76
  77         flist_for_each(entry, &engine_list) {
  78                 ops = flist_entry(entry, struct ioengine_ops, list);
  79                 if (!strcmp(name, ops->name))
  80                         return ops;
  81         }
  82
  83         return NULL;
  84 }
  85
  86 static struct ioengine_ops *dlopen_ioengine(struct thread_data *td,
  87                                             const char *engine_lib)
  88 {
  89         struct ioengine_ops *ops;
  90         void *dlhandle;
  91
  92         dprint(FD_IO, "dload engine %s\n", engine_lib);
  93
  94         dlerror();
  95         dlhandle = dlopen(engine_lib, RTLD_LAZY);
  96         if (!dlhandle) {
  97                 td_vmsg(td, -1, dlerror(), "dlopen");
  98                 return NULL;
  99         }
 100
 101         /*
 102          * Unlike the included modules, external engines should have a
 103          * non-static ioengine structure that we can reference.
 104          */
 105         ops = dlsym(dlhandle, "ioengine");
 106         if (!ops) {
 107                 td_vmsg(td, -1, dlerror(), "dlsym");
 108                 dlclose(dlhandle);
 109                 return NULL;
 110         }
 111
 112         ops->dlhandle = dlhandle;
 113         return ops;
 114 }
 115
 116 struct ioengine_ops *load_ioengine(struct thread_data *td, const char *name)
 117 {
 118         struct ioengine_ops *ops, *ret;
 119         char engine[16];
 120
 121         dprint(FD_IO, "load ioengine %s\n", name);
 122
 123         strncpy(engine, name, sizeof(engine) - 1);
 124
 125         /*
 126          * linux libaio has alias names, so convert to what we want
 127          */
 128         if (!strncmp(engine, "linuxaio", 8) || !strncmp(engine, "aio", 3))
 129                 strcpy(engine, "libaio");
 130
 131         ops = find_ioengine(engine);
 132         if (!ops)
 133                 ops = dlopen_ioengine(td, name);
 134
 135         if (!ops) {
 136                 log_err("fio: engine %s not loadable\n", name);
 137                 return NULL;
 138         }
 139
 140         /*
 141          * Check that the required methods are there.
 142          */
 143         if (check_engine_ops(ops))
 144                 return NULL;
 145
 146         ret = malloc(sizeof(*ret));
 147         memcpy(ret, ops, sizeof(*ret));
 148         ret->data = NULL;
 149
 150         return ret;
 151 }
 152
 153 void close_ioengine(struct thread_data *td)
 154 {
 155         dprint(FD_IO, "close ioengine %s\n", td->io_ops->name);
 156
 157         if (td->io_ops->cleanup) {
 158                 td->io_ops->cleanup(td);
 159                 td->io_ops->data = NULL;
 160         }
 161
 162         if (td->io_ops->dlhandle)
 163                 dlclose(td->io_ops->dlhandle);
 164
 165         free(td->io_ops);
 166         td->io_ops = NULL;
 167 }
 168
 169 int td_io_prep(struct thread_data *td, struct io_u *io_u)
 170 {
 171         dprint_io_u(io_u, "prep");
 172         fio_ro_check(td, io_u);
 173
 174         lock_file(td, io_u->file, io_u->ddir);
 175
 176         if (td->io_ops->prep) {
 177                 int ret = td->io_ops->prep(td, io_u);
 178
 179                 dprint(FD_IO, "->prep(%p)=%d\n", io_u, ret);
 180                 if (ret)
 181                         unlock_file(td, io_u->file);
 182                 return ret;
 183         }
 184
 185         return 0;
 186 }
 187
 188 int td_io_getevents(struct thread_data *td, unsigned int min, unsigned int max,
 189                     struct timespec *t)
 190 {
 191         int r = 0;
 192
 193         if (min > 0 && td->io_ops->commit) {
 194                 r = td->io_ops->commit(td);
 195                 if (r < 0)
 196                         goto out;
 197         }
 198         if (max > td->cur_depth)
 199                 max = td->cur_depth;
 200         if (min > max)
 201                 max = min;
 202
 203         r = 0;
 204         if (max && td->io_ops->getevents)
 205                 r = td->io_ops->getevents(td, min, max, t);
 206 out:
 207         if (r >= 0)
 208                 io_u_mark_complete(td, r);
 209         dprint(FD_IO, "getevents: %d\n", r);
 210         return r;
 211 }
 212
 213 static inline int get_issue_time(struct thread_data *td)
 214 {
 215         if (td->o.read_iolog_file ||
 216             !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
 217                 return 1;
 218
 219         return 0;
 220 }
 221
 222 int td_io_queue(struct thread_data *td, struct io_u *io_u)
 223 {
 224         int ret;
 225
 226         dprint_io_u(io_u, "queue");
 227         fio_ro_check(td, io_u);
 228
 229         assert((io_u->flags & IO_U_F_FLIGHT) == 0);
 230         io_u->flags |= IO_U_F_FLIGHT;
 231
 232         assert(io_u->file->flags & FIO_FILE_OPEN);
 233
 234         io_u->error = 0;
 235         io_u->resid = 0;
 236
 237         if (td->io_ops->flags & FIO_SYNCIO) {
 238                 if (get_issue_time(td))
 239                         fio_gettime(&io_u->issue_time, NULL);
 240
 241                 /*
 242                  * only used for iolog
 243                  */
 244                 if (td->o.read_iolog_file)
 245                         memcpy(&td->last_issue, &io_u->issue_time,
 246                                         sizeof(struct timeval));
 247         }
 248
 249         if (io_u->ddir != DDIR_SYNC)
 250                 td->io_issues[io_u->ddir]++;
 251
 252         ret = td->io_ops->queue(td, io_u);
 253
 254         unlock_file(td, io_u->file);
 255
 256         if (!td->io_ops->commit) {
 257                 io_u_mark_submit(td, 1);
 258                 io_u_mark_complete(td, 1);
 259         }
 260
 261         if (ret == FIO_Q_COMPLETED) {
 262                 if (io_u->ddir != DDIR_SYNC) {
 263                         io_u_mark_depth(td, 1);
 264                         td->ts.total_io_u[io_u->ddir]++;
 265                 }
 266         } else if (ret == FIO_Q_QUEUED) {
 267                 int r;
 268
 269                 if (io_u->ddir != DDIR_SYNC) {
 270                         td->io_u_queued++;
 271                         td->ts.total_io_u[io_u->ddir]++;
 272                 }
 273
 274                 if (td->io_u_queued >= td->o.iodepth_batch) {
 275                         r = td_io_commit(td);
 276                         if (r < 0)
 277                                 return r;
 278                 }
 279         }
 280
 281         if ((td->io_ops->flags & FIO_SYNCIO) == 0) {
 282                 if (get_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(struct timeval));
 291         }
 292
 293         return ret;
 294 }
 295
 296 int td_io_init(struct thread_data *td)
 297 {
 298         int ret = 0;
 299
 300         if (td->io_ops->init) {
 301                 ret = td->io_ops->init(td);
 302                 if (ret && td->o.iodepth > 1) {
 303                         log_err("fio: io engine init failed. Perhaps try"
 304                                 " reducing io depth?\n");
 305                 }
 306         }
 307
 308         return ret;
 309 }
 310
 311 int td_io_commit(struct thread_data *td)
 312 {
 313         dprint(FD_IO, "calling ->commit(), depth %d\n", td->cur_depth);
 314
 315         if (!td->cur_depth || !td->io_u_queued)
 316                 return 0;
 317
 318         io_u_mark_depth(td, td->io_u_queued);
 319         td->io_u_queued = 0;
 320
 321         if (td->io_ops->commit)
 322                 return td->io_ops->commit(td);
 323
 324         return 0;
 325 }
 326
 327 int td_io_open_file(struct thread_data *td, struct fio_file *f)
 328 {
 329         if (td->io_ops->open_file(td, f)) {
 330                 if (td->error == EINVAL && td->o.odirect)
 331                         log_err("fio: destination does not support O_DIRECT\n");
 332                 if (td->error == EMFILE) {
 333                         log_err("fio: try reducing/setting openfiles (failed"
 334                                 " at %u of %u)\n", td->nr_open_files,
 335                                                         td->o.nr_files);
 336                 }
 337
 338                 return 1;
 339         }
 340
 341         fio_file_reset(f);
 342         f->flags |= FIO_FILE_OPEN;
 343         f->flags &= ~FIO_FILE_CLOSING;
 344
 345         td->nr_open_files++;
 346         get_file(f);
 347
 348         if (f->filetype == FIO_TYPE_PIPE) {
 349                 if (td_random(td)) {
 350                         log_err("fio: can't seek on pipes (no random io)\n");
 351                         goto err;
 352                 }
 353         }
 354
 355         if (td->io_ops->flags & FIO_DISKLESSIO)
 356                 goto done;
 357
 358         if (td->o.invalidate_cache && file_invalidate_cache(td, f))
 359                 goto err;
 360
 361         if (td->o.fadvise_hint &&
 362             (f->filetype == FIO_TYPE_BD || f->filetype == FIO_TYPE_FILE)) {
 363                 int flags;
 364
 365                 if (td_random(td))
 366                         flags = POSIX_FADV_RANDOM;
 367                 else
 368                         flags = POSIX_FADV_SEQUENTIAL;
 369
 370                 if (fadvise(f->fd, f->file_offset, f->io_size, flags) < 0) {
 371                         td_verror(td, errno, "fadvise");
 372                         goto err;
 373                 }
 374         }
 375
 376         if (f->file_map)
 377                 memset(f->file_map, 0, f->num_maps * sizeof(int));
 378
 379 #ifdef FIO_OS_DIRECTIO
 380         /*
 381          * Some OS's have a distinct call to mark the file non-buffered,
 382          * instead of using O_DIRECT (Solaris)
 383          */
 384         if (td->o.odirect) {
 385                 int ret = fio_set_odirect(f->fd);
 386
 387                 if (ret) {
 388                         td_verror(td, ret, "fio_set_odirect");
 389                         goto err;
 390                 }
 391         }
 392 #endif
 393
 394 done:
 395         log_file(td, f, FIO_LOG_OPEN_FILE);
 396         return 0;
 397 err:
 398         if (td->io_ops->close_file)
 399                 td->io_ops->close_file(td, f);
 400         return 1;
 401 }
 402
 403 int td_io_close_file(struct thread_data *td, struct fio_file *f)
 404 {
 405         if (!(f->flags & FIO_FILE_CLOSING))
 406                 log_file(td, f, FIO_LOG_CLOSE_FILE);
 407
 408         /*
 409          * mark as closing, do real close when last io on it has completed
 410          */
 411         f->flags |= FIO_FILE_CLOSING;
 412
 413         unlock_file_all(td, f);
 414
 415         return put_file(td, f);
 416 }