ioengine.h

   1 #ifndef FIO_IOENGINE_H
   2 #define FIO_IOENGINE_H
   3
   4 #include "compiler/compiler.h"
   5 #include "os/os.h"
   6 #include "log.h"
   7 #include "io_ddir.h"
   8 #include "debug.h"
   9 #include "file.h"
  10
  11 #ifdef CONFIG_LIBAIO
  12 #include <libaio.h>
  13 #endif
  14 #ifdef CONFIG_GUASI
  15 #include <guasi.h>
  16 #endif
  17
  18 #define FIO_IOOPS_VERSION       15
  19
  20 enum {
  21         IO_U_F_FREE             = 1 << 0,
  22         IO_U_F_FLIGHT           = 1 << 1,
  23         IO_U_F_FREE_DEF         = 1 << 2,
  24         IO_U_F_IN_CUR_DEPTH     = 1 << 3,
  25         IO_U_F_BUSY_OK          = 1 << 4,
  26         IO_U_F_TRIMMED          = 1 << 5,
  27         IO_U_F_BARRIER          = 1 << 6,
  28         IO_U_F_VER_LIST         = 1 << 7,
  29 };
  30
  31 /*
  32  * The io unit
  33  */
  34 struct io_u {
  35         union {
  36 #ifdef CONFIG_LIBAIO
  37                 struct iocb iocb;
  38 #endif
  39 #ifdef CONFIG_POSIXAIO
  40                 os_aiocb_t aiocb;
  41 #endif
  42 #ifdef FIO_HAVE_SGIO
  43                 struct sg_io_hdr hdr;
  44 #endif
  45 #ifdef CONFIG_GUASI
  46                 guasi_req_t greq;
  47 #endif
  48 #ifdef CONFIG_SOLARISAIO
  49                 aio_result_t resultp;
  50 #endif
  51 #ifdef FIO_HAVE_BINJECT
  52                 struct b_user_cmd buc;
  53 #endif
  54 #ifdef CONFIG_RDMA
  55                 struct ibv_mr *mr;
  56 #endif
  57                 void *mmap_data;
  58         };
  59         struct timeval start_time;
  60         struct timeval issue_time;
  61
  62         struct fio_file *file;
  63         unsigned int flags;
  64         enum fio_ddir ddir;
  65
  66         /*
  67          * For replay workloads, we may want to account as a different
  68          * IO type than what is being submitted.
  69          */
  70         enum fio_ddir acct_ddir;
  71
  72         /*
  73          * Allocated/set buffer and length
  74          */
  75         unsigned long buflen;
  76         unsigned long long offset;
  77         void *buf;
  78
  79         /*
  80          * Initial seed for generating the buffer contents
  81          */
  82         unsigned long rand_seed;
  83
  84         /*
  85          * IO engine state, may be different from above when we get
  86          * partial transfers / residual data counts
  87          */
  88         void *xfer_buf;
  89         unsigned long xfer_buflen;
  90
  91         /*
  92          * Parameter related to pre-filled buffers and
  93          * their size to handle variable block sizes.
  94          */
  95         unsigned long buf_filled_len;
  96
  97         unsigned int resid;
  98         unsigned int error;
  99
 100         /*
 101          * io engine private data
 102          */
 103         union {
 104                 unsigned int index;
 105                 unsigned int seen;
 106                 void *engine_data;
 107         };
 108
 109         struct flist_head list;
 110
 111         /*
 112          * Callback for io completion
 113          */
 114         int (*end_io)(struct thread_data *, struct io_u *);
 115 };
 116
 117 /*
 118  * io_ops->queue() return values
 119  */
 120 enum {
 121         FIO_Q_COMPLETED = 0,            /* completed sync */
 122         FIO_Q_QUEUED    = 1,            /* queued, will complete async */
 123         FIO_Q_BUSY      = 2,            /* no more room, call ->commit() */
 124 };
 125
 126 struct ioengine_ops {
 127         struct flist_head list;
 128         char name[16];
 129         int version;
 130         int flags;
 131         int (*setup)(struct thread_data *);
 132         int (*init)(struct thread_data *);
 133         int (*prep)(struct thread_data *, struct io_u *);
 134         int (*queue)(struct thread_data *, struct io_u *);
 135         int (*commit)(struct thread_data *);
 136         int (*getevents)(struct thread_data *, unsigned int, unsigned int, struct timespec *);
 137         struct io_u *(*event)(struct thread_data *, int);
 138         int (*cancel)(struct thread_data *, struct io_u *);
 139         void (*cleanup)(struct thread_data *);
 140         int (*open_file)(struct thread_data *, struct fio_file *);
 141         int (*close_file)(struct thread_data *, struct fio_file *);
 142         int (*get_file_size)(struct thread_data *, struct fio_file *);
 143         void (*terminate)(struct thread_data *);
 144         int (*io_u_init)(struct thread_data *, struct io_u *);
 145         void (*io_u_free)(struct thread_data *, struct io_u *);
 146         int option_struct_size;
 147         struct fio_option *options;
 148         void *data;
 149         void *dlhandle;
 150 };
 151
 152 enum fio_ioengine_flags {
 153         FIO_SYNCIO      = 1 << 0,       /* io engine has synchronous ->queue */
 154         FIO_RAWIO       = 1 << 1,       /* some sort of direct/raw io */
 155         FIO_DISKLESSIO  = 1 << 2,       /* no disk involved */
 156         FIO_NOEXTEND    = 1 << 3,       /* engine can't extend file */
 157         FIO_NODISKUTIL  = 1 << 4,       /* diskutil can't handle filename */
 158         FIO_UNIDIR      = 1 << 5,       /* engine is uni-directional */
 159         FIO_NOIO        = 1 << 6,       /* thread does only pseudo IO */
 160         FIO_PIPEIO      = 1 << 7,       /* input/output no seekable */
 161         FIO_BARRIER     = 1 << 8,       /* engine supports barriers */
 162         FIO_MEMALIGN    = 1 << 9,       /* engine wants aligned memory */
 163         FIO_BIT_BASED   = 1 << 10,      /* engine uses a bit base (e.g. uses Kbit as opposed to KB) */
 164 };
 165
 166 /*
 167  * io engine entry points
 168  */
 169 extern int __must_check td_io_init(struct thread_data *);
 170 extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
 171 extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
 172 extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
 173 extern int __must_check td_io_getevents(struct thread_data *, unsigned int, unsigned int, struct timespec *);
 174 extern int __must_check td_io_commit(struct thread_data *);
 175 extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
 176 extern int td_io_close_file(struct thread_data *, struct fio_file *);
 177 extern int __must_check td_io_get_file_size(struct thread_data *, struct fio_file *);
 178
 179 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
 180 extern void register_ioengine(struct ioengine_ops *);
 181 extern void unregister_ioengine(struct ioengine_ops *);
 182 extern void free_ioengine(struct thread_data *);
 183 extern void close_ioengine(struct thread_data *);
 184
 185 extern int fio_show_ioengine_help(const char *engine);
 186
 187 /*
 188  * io unit handling
 189  */
 190 #define queue_full(td)  flist_empty(&(td)->io_u_freelist)
 191 extern struct io_u *__get_io_u(struct thread_data *);
 192 extern struct io_u *get_io_u(struct thread_data *);
 193 extern void put_io_u(struct thread_data *, struct io_u *);
 194 extern void clear_io_u(struct thread_data *, struct io_u *);
 195 extern void requeue_io_u(struct thread_data *, struct io_u **);
 196 extern int __must_check io_u_sync_complete(struct thread_data *, struct io_u *, uint64_t *);
 197 extern int __must_check io_u_queued_complete(struct thread_data *, int, uint64_t *);
 198 extern void io_u_queued(struct thread_data *, struct io_u *);
 199 extern void io_u_log_error(struct thread_data *, struct io_u *);
 200 extern void io_u_mark_depth(struct thread_data *, unsigned int);
 201 extern void io_u_fill_buffer(struct thread_data *td, struct io_u *, unsigned int, unsigned int);
 202 void io_u_mark_complete(struct thread_data *, unsigned int);
 203 void io_u_mark_submit(struct thread_data *, unsigned int);
 204
 205 int do_io_u_sync(struct thread_data *, struct io_u *);
 206 int do_io_u_trim(struct thread_data *, struct io_u *);
 207
 208 #ifdef FIO_INC_DEBUG
 209 static inline void dprint_io_u(struct io_u *io_u, const char *p)
 210 {
 211         struct fio_file *f = io_u->file;
 212
 213         dprint(FD_IO, "%s: io_u %p: off=%llu/len=%lu/ddir=%d", p, io_u,
 214                                         (unsigned long long) io_u->offset,
 215                                         io_u->buflen, io_u->ddir);
 216         if (fio_debug & (1 << FD_IO)) {
 217                 if (f)
 218                         log_info("/%s", f->file_name);
 219
 220                 log_info("\n");
 221         }
 222 }
 223 #else
 224 #define dprint_io_u(io_u, p)
 225 #endif
 226
 227 static inline enum fio_ddir acct_ddir(struct io_u *io_u)
 228 {
 229         if (io_u->acct_ddir != -1)
 230                 return io_u->acct_ddir;
 231
 232         return io_u->ddir;
 233 }
 234
 235 #endif