ioengine.h

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