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