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 #include "os.h"
  21
  22 static LIST_HEAD(engine_list);
  23
  24 static int check_engine_ops(struct ioengine_ops *ops)
  25 {
  26         if (ops->version != FIO_IOOPS_VERSION) {
  27                 log_err("bad ioops version %d (want %d)\n", ops->version, FIO_IOOPS_VERSION);
  28                 return 1;
  29         }
  30
  31         /*
  32          * cpu thread doesn't need to provide anything
  33          */
  34         if (ops->flags & FIO_CPUIO)
  35                 return 0;
  36
  37         if (!ops->queue) {
  38                 log_err("%s: no queue handler\n", ops->name);
  39                 return 1;
  40         }
  41
  42         /*
  43          * sync engines only need a ->queue()
  44          */
  45         if (ops->flags & FIO_SYNCIO)
  46                 return 0;
  47
  48         if (!ops->event) {
  49                 log_err("%s: no event handler\n", ops->name);
  50                 return 1;
  51         }
  52         if (!ops->getevents) {
  53                 log_err("%s: no getevents handler\n", ops->name);
  54                 return 1;
  55         }
  56         if (!ops->queue) {
  57                 log_err("%s: no queue handler\n", ops->name);
  58                 return 1;
  59         }
  60
  61         return 0;
  62 }
  63
  64 void unregister_ioengine(struct ioengine_ops *ops)
  65 {
  66         list_del(&ops->list);
  67         INIT_LIST_HEAD(&ops->list);
  68 }
  69
  70 void register_ioengine(struct ioengine_ops *ops)
  71 {
  72         INIT_LIST_HEAD(&ops->list);
  73         list_add_tail(&ops->list, &engine_list);
  74 }
  75
  76 static struct ioengine_ops *find_ioengine(const char *name)
  77 {
  78         struct ioengine_ops *ops;
  79         struct list_head *entry;
  80         char engine[16];
  81
  82         strncpy(engine, name, sizeof(engine) - 1);
  83
  84         if (!strncmp(engine, "linuxaio", 8) || !strncmp(engine, "aio", 3))
  85                 strcpy(engine, "libaio");
  86
  87         list_for_each(entry, &engine_list) {
  88                 ops = list_entry(entry, struct ioengine_ops, list);
  89                 if (!strcmp(engine, ops->name))
  90                         return ops;
  91         }
  92
  93         return NULL;
  94 }
  95
  96 static struct ioengine_ops *dlopen_ioengine(struct thread_data *td,
  97                                             const char *engine_lib)
  98 {
  99         struct ioengine_ops *ops;
 100         void *dlhandle;
 101
 102         dlerror();
 103         dlhandle = dlopen(engine_lib, RTLD_LAZY);
 104         if (!dlhandle) {
 105                 td_vmsg(td, -1, dlerror(), "dlopen");
 106                 return NULL;
 107         }
 108
 109         /*
 110          * Unlike the included modules, external engines should have a
 111          * non-static ioengine structure that we can reference.
 112          */
 113         ops = dlsym(dlhandle, "ioengine");
 114         if (!ops) {
 115                 td_vmsg(td, -1, dlerror(), "dlsym");
 116                 dlclose(dlhandle);
 117                 return NULL;
 118         }
 119
 120         ops->dlhandle = dlhandle;
 121         return ops;
 122 }
 123
 124 struct ioengine_ops *load_ioengine(struct thread_data *td, const char *name)
 125 {
 126         struct ioengine_ops *ops, *ret;
 127         char engine[16];
 128
 129         strncpy(engine, name, sizeof(engine) - 1);
 130
 131         /*
 132          * linux libaio has alias names, so convert to what we want
 133          */
 134         if (!strncmp(engine, "linuxaio", 8) || !strncmp(engine, "aio", 3))
 135                 strcpy(engine, "libaio");
 136
 137         ops = find_ioengine(engine);
 138         if (!ops)
 139                 ops = dlopen_ioengine(td, name);
 140
 141         if (!ops) {
 142                 log_err("fio: engine %s not loadable\n", name);
 143                 return NULL;
 144         }
 145
 146         /*
 147          * Check that the required methods are there.
 148          */
 149         if (check_engine_ops(ops))
 150                 return NULL;
 151
 152         ret = malloc(sizeof(*ret));
 153         memcpy(ret, ops, sizeof(*ret));
 154         ret->data = NULL;
 155
 156         return ret;
 157 }
 158
 159 void close_ioengine(struct thread_data *td)
 160 {
 161         if (td->io_ops->cleanup)
 162                 td->io_ops->cleanup(td);
 163
 164         if (td->io_ops->dlhandle)
 165                 dlclose(td->io_ops->dlhandle);
 166
 167 #if 0
 168         /* we can't do this for threads, so just leak it, it's exiting */
 169         free(td->io_ops);
 170 #endif
 171         td->io_ops = NULL;
 172 }
 173
 174 int td_io_prep(struct thread_data *td, struct io_u *io_u)
 175 {
 176         if (td->io_ops->prep)
 177                 return td->io_ops->prep(td, io_u);
 178
 179         return 0;
 180 }
 181
 182 int td_io_getevents(struct thread_data *td, int min, int max,
 183                     struct timespec *t)
 184 {
 185         if (min > 0 && td->io_ops->commit) {
 186                 int r = td->io_ops->commit(td);
 187
 188                 if (r < 0)
 189                         return r;
 190         }
 191         if (td->io_ops->getevents)
 192                 return td->io_ops->getevents(td, min, max, t);
 193
 194         return 0;
 195 }
 196
 197 int td_io_queue(struct thread_data *td, struct io_u *io_u)
 198 {
 199         int ret;
 200
 201         assert((io_u->flags & IO_U_F_FLIGHT) == 0);
 202         io_u->flags |= IO_U_F_FLIGHT;
 203
 204         if (td->io_ops->flags & FIO_SYNCIO) {
 205                 fio_gettime(&io_u->issue_time, NULL);
 206
 207                 /*
 208                  * for a sync engine, set the timeout upfront
 209                  */
 210                 if (mtime_since(&td->timeout_end, &io_u->issue_time) < IO_U_TIMEOUT)
 211                         io_u_set_timeout(td);
 212         }
 213
 214         if (io_u->ddir != DDIR_SYNC)
 215                 td->io_issues[io_u->ddir]++;
 216
 217         ret = td->io_ops->queue(td, io_u);
 218
 219         if (ret == FIO_Q_QUEUED) {
 220                 int r;
 221
 222                 td->io_u_queued++;
 223                 if (td->io_u_queued > td->iodepth_batch) {
 224                         r = td_io_commit(td);
 225                         if (r < 0)
 226                                 return r;
 227                 }
 228         }
 229
 230         if ((td->io_ops->flags & FIO_SYNCIO) == 0) {
 231                 fio_gettime(&io_u->issue_time, NULL);
 232
 233                 /*
 234                  * async engine, set the timeout here
 235                  */
 236                 if (ret == FIO_Q_QUEUED &&
 237                     mtime_since(&td->timeout_end, &io_u->issue_time) < IO_U_TIMEOUT)
 238                         io_u_set_timeout(td);
 239         }
 240
 241         return ret;
 242 }
 243
 244 int td_io_init(struct thread_data *td)
 245 {
 246         if (td->io_ops->init)
 247                 return td->io_ops->init(td);
 248
 249         return 0;
 250 }
 251
 252 int td_io_commit(struct thread_data *td)
 253 {
 254         if (!td->cur_depth)
 255                 return 0;
 256
 257         td->io_u_queued = 0;
 258         if (td->io_ops->commit)
 259                 return td->io_ops->commit(td);
 260
 261         return 0;
 262 }