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