engines/null.c

   1 /*
   2  * null engine
   3  *
   4  * IO engine that doesn't do any real IO transfers, it just pretends to.
   5  * The main purpose is to test fio itself.
   6  *
   7  * It also can act as external C++ engine - compiled with:
   8  *
   9  * g++ -O2 -g -shared -rdynamic -fPIC -o cpp_null null.c \
  10  *      -include ../config-host.h -DFIO_EXTERNAL_ENGINE
  11  *
  12  * to test it execute:
  13  *
  14  * LD_LIBRARY_PATH=./engines ./fio examples/cpp_null.fio
  15  *
  16  */
  17 #include <stdlib.h>
  18 #include <assert.h>
  19
  20 #include "../fio.h"
  21
  22 struct null_data {
  23         struct io_u **io_us;
  24         int queued;
  25         int events;
  26 };
  27
  28 static struct io_u *null_event(struct null_data *nd, int event)
  29 {
  30         return nd->io_us[event];
  31 }
  32
  33 static int null_getevents(struct null_data *nd, unsigned int min_events,
  34                           unsigned int fio_unused max,
  35                           const struct timespec fio_unused *t)
  36 {
  37         int ret = 0;
  38
  39         if (min_events) {
  40                 ret = nd->events;
  41                 nd->events = 0;
  42         }
  43
  44         return ret;
  45 }
  46
  47 static int null_commit(struct thread_data *td, struct null_data *nd)
  48 {
  49         if (!nd->events) {
  50 #ifndef FIO_EXTERNAL_ENGINE
  51                 io_u_mark_submit(td, nd->queued);
  52 #endif
  53                 nd->events = nd->queued;
  54                 nd->queued = 0;
  55         }
  56
  57         return 0;
  58 }
  59
  60 static enum fio_q_status null_queue(struct thread_data *td,
  61                                     struct null_data *nd, struct io_u *io_u)
  62 {
  63         fio_ro_check(td, io_u);
  64
  65         if (td->io_ops->flags & FIO_SYNCIO)
  66                 return FIO_Q_COMPLETED;
  67         if (nd->events)
  68                 return FIO_Q_BUSY;
  69
  70         nd->io_us[nd->queued++] = io_u;
  71         return FIO_Q_QUEUED;
  72 }
  73
  74 static int null_open(struct null_data fio_unused *nd,
  75                      struct fio_file fio_unused *f)
  76 {
  77         return 0;
  78 }
  79
  80 static void null_cleanup(struct null_data *nd)
  81 {
  82         if (nd) {
  83                 free(nd->io_us);
  84                 free(nd);
  85         }
  86 }
  87
  88 static struct null_data *null_init(struct thread_data *td)
  89 {
  90         struct null_data *nd = (struct null_data *) malloc(sizeof(*nd));
  91
  92         memset(nd, 0, sizeof(*nd));
  93
  94         if (td->o.iodepth != 1) {
  95                 nd->io_us = (struct io_u **) malloc(td->o.iodepth * sizeof(struct io_u *));
  96                 memset(nd->io_us, 0, td->o.iodepth * sizeof(struct io_u *));
  97         } else
  98                 td->io_ops->flags |= FIO_SYNCIO;
  99
 100         return nd;
 101 }
 102
 103 #ifndef __cplusplus
 104
 105 static struct io_u *fio_null_event(struct thread_data *td, int event)
 106 {
 107         return null_event(td->io_ops_data, event);
 108 }
 109
 110 static int fio_null_getevents(struct thread_data *td, unsigned int min_events,
 111                               unsigned int max, const struct timespec *t)
 112 {
 113         struct null_data *nd = td->io_ops_data;
 114         return null_getevents(nd, min_events, max, t);
 115 }
 116
 117 static int fio_null_commit(struct thread_data *td)
 118 {
 119         return null_commit(td, td->io_ops_data);
 120 }
 121
 122 static enum fio_q_status fio_null_queue(struct thread_data *td,
 123                                         struct io_u *io_u)
 124 {
 125         return null_queue(td, td->io_ops_data, io_u);
 126 }
 127
 128 static int fio_null_open(struct thread_data *td, struct fio_file *f)
 129 {
 130         return null_open(td->io_ops_data, f);
 131 }
 132
 133 static void fio_null_cleanup(struct thread_data *td)
 134 {
 135         null_cleanup(td->io_ops_data);
 136 }
 137
 138 static int fio_null_init(struct thread_data *td)
 139 {
 140         td->io_ops_data = null_init(td);
 141         assert(td->io_ops_data);
 142         return 0;
 143 }
 144
 145 static struct ioengine_ops ioengine = {
 146         .name           = "null",
 147         .version        = FIO_IOOPS_VERSION,
 148         .queue          = fio_null_queue,
 149         .commit         = fio_null_commit,
 150         .getevents      = fio_null_getevents,
 151         .event          = fio_null_event,
 152         .init           = fio_null_init,
 153         .cleanup        = fio_null_cleanup,
 154         .open_file      = fio_null_open,
 155         .flags          = FIO_DISKLESSIO | FIO_FAKEIO,
 156 };
 157
 158 static void fio_init fio_null_register(void)
 159 {
 160         register_ioengine(&ioengine);
 161 }
 162
 163 static void fio_exit fio_null_unregister(void)
 164 {
 165         unregister_ioengine(&ioengine);
 166 }
 167
 168 #else
 169
 170 #ifdef FIO_EXTERNAL_ENGINE
 171
 172 struct NullData {
 173         NullData(struct thread_data *td)
 174         {
 175                 impl_ = null_init(td);
 176                 assert(impl_);
 177         }
 178
 179         ~NullData()
 180         {
 181                 null_cleanup(impl_);
 182         }
 183
 184         static NullData *get(struct thread_data *td)
 185         {
 186                 return reinterpret_cast<NullData *>(td->io_ops_data);
 187         }
 188
 189         io_u *fio_null_event(struct thread_data *, int event)
 190         {
 191                 return null_event(impl_, event);
 192         }
 193
 194         int fio_null_getevents(struct thread_data *, unsigned int min_events,
 195                                unsigned int max, const struct timespec *t)
 196         {
 197                 return null_getevents(impl_, min_events, max, t);
 198         }
 199
 200         int fio_null_commit(struct thread_data *td)
 201         {
 202                 return null_commit(td, impl_);
 203         }
 204
 205         fio_q_status fio_null_queue(struct thread_data *td, struct io_u *io_u)
 206         {
 207                 return null_queue(td, impl_, io_u);
 208         }
 209
 210         int fio_null_open(struct thread_data *, struct fio_file *f)
 211         {
 212                 return null_open(impl_, f);
 213         }
 214
 215 private:
 216         struct null_data *impl_;
 217 };
 218
 219 extern "C" {
 220
 221 static struct io_u *fio_null_event(struct thread_data *td, int event)
 222 {
 223         return NullData::get(td)->fio_null_event(td, event);
 224 }
 225
 226 static int fio_null_getevents(struct thread_data *td, unsigned int min_events,
 227                               unsigned int max, const struct timespec *t)
 228 {
 229         return NullData::get(td)->fio_null_getevents(td, min_events, max, t);
 230 }
 231
 232 static int fio_null_commit(struct thread_data *td)
 233 {
 234         return NullData::get(td)->fio_null_commit(td);
 235 }
 236
 237 static fio_q_status fio_null_queue(struct thread_data *td, struct io_u *io_u)
 238 {
 239         return NullData::get(td)->fio_null_queue(td, io_u);
 240 }
 241
 242 static int fio_null_open(struct thread_data *td, struct fio_file *f)
 243 {
 244         return NullData::get(td)->fio_null_open(td, f);
 245 }
 246
 247 static int fio_null_init(struct thread_data *td)
 248 {
 249         td->io_ops_data = new NullData(td);
 250         return 0;
 251 }
 252
 253 static void fio_null_cleanup(struct thread_data *td)
 254 {
 255         delete NullData::get(td);
 256 }
 257
 258 static struct ioengine_ops ioengine;
 259 void get_ioengine(struct ioengine_ops **ioengine_ptr)
 260 {
 261         *ioengine_ptr = &ioengine;
 262
 263         ioengine.name           = "cpp_null";
 264         ioengine.version        = FIO_IOOPS_VERSION;
 265         ioengine.queue          = fio_null_queue;
 266         ioengine.commit         = fio_null_commit;
 267         ioengine.getevents      = fio_null_getevents;
 268         ioengine.event          = fio_null_event;
 269         ioengine.init           = fio_null_init;
 270         ioengine.cleanup        = fio_null_cleanup;
 271         ioengine.open_file      = fio_null_open;
 272         ioengine.flags          = FIO_DISKLESSIO | FIO_FAKEIO;
 273 }
 274 }
 275 #endif /* FIO_EXTERNAL_ENGINE */
 276
 277 #endif /* __cplusplus */