ioengine.h

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