blob: be74b66fd65c8770e715c717617f97e94385f41d [file] [log] [blame]
#ifndef FIO_IOENGINE_H
#define FIO_IOENGINE_H
#define FIO_IOOPS_VERSION 13
enum {
IO_U_F_FREE = 1 << 0,
IO_U_F_FLIGHT = 1 << 1,
IO_U_F_FREE_DEF = 1 << 2,
IO_U_F_IN_CUR_DEPTH = 1 << 3,
IO_U_F_BUSY_OK = 1 << 4,
IO_U_F_TRIMMED = 1 << 5,
IO_U_F_BARRIER = 1 << 6,
};
/*
* The io unit
*/
struct io_u {
union {
#ifdef FIO_HAVE_LIBAIO
struct iocb iocb;
#endif
#ifdef FIO_HAVE_POSIXAIO
os_aiocb_t aiocb;
#endif
#ifdef FIO_HAVE_SGIO
struct sg_io_hdr hdr;
#endif
#ifdef FIO_HAVE_GUASI
guasi_req_t greq;
#endif
#ifdef FIO_HAVE_SOLARISAIO
aio_result_t resultp;
#endif
#ifdef FIO_HAVE_BINJECT
struct b_user_cmd buc;
#endif
#ifdef FIO_HAVE_RDMA
struct ibv_mr *mr;
#endif
void *mmap_data;
};
struct timeval start_time;
struct timeval issue_time;
/*
* Allocated/set buffer and length
*/
void *buf;
unsigned long buflen;
unsigned long long offset;
/*
* Initial seed for generating the buffer contents
*/
unsigned long rand_seed;
/*
* IO engine state, may be different from above when we get
* partial transfers / residual data counts
*/
void *xfer_buf;
unsigned long xfer_buflen;
/*
* Parameter related to pre-filled buffers and
* their size to handle variable block sizes.
*/
unsigned long buf_filled_len;
unsigned int resid;
unsigned int error;
enum fio_ddir ddir;
/*
* io engine private data
*/
union {
unsigned int index;
unsigned int seen;
void *engine_data;
};
unsigned int flags;
struct fio_file *file;
struct flist_head list;
/*
* Callback for io completion
*/
int (*end_io)(struct thread_data *, struct io_u *);
};
/*
* io_ops->queue() return values
*/
enum {
FIO_Q_COMPLETED = 0, /* completed sync */
FIO_Q_QUEUED = 1, /* queued, will complete async */
FIO_Q_BUSY = 2, /* no more room, call ->commit() */
};
struct ioengine_ops {
struct flist_head list;
char name[16];
int version;
int flags;
int (*setup)(struct thread_data *);
int (*init)(struct thread_data *);
int (*prep)(struct thread_data *, struct io_u *);
int (*queue)(struct thread_data *, struct io_u *);
int (*commit)(struct thread_data *);
int (*getevents)(struct thread_data *, unsigned int, unsigned int, struct timespec *);
struct io_u *(*event)(struct thread_data *, int);
int (*cancel)(struct thread_data *, struct io_u *);
void (*cleanup)(struct thread_data *);
int (*open_file)(struct thread_data *, struct fio_file *);
int (*close_file)(struct thread_data *, struct fio_file *);
int (*get_file_size)(struct thread_data *, struct fio_file *);
int option_struct_size;
struct fio_option *options;
void *data;
void *dlhandle;
};
enum fio_ioengine_flags {
FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */
FIO_RAWIO = 1 << 1, /* some sort of direct/raw io */
FIO_DISKLESSIO = 1 << 2, /* no disk involved */
FIO_NOEXTEND = 1 << 3, /* engine can't extend file */
FIO_NODISKUTIL = 1 << 4, /* diskutil can't handle filename */
FIO_UNIDIR = 1 << 5, /* engine is uni-directional */
FIO_NOIO = 1 << 6, /* thread does only pseudo IO */
FIO_SIGTERM = 1 << 7, /* needs SIGTERM to exit */
FIO_PIPEIO = 1 << 8, /* input/output no seekable */
FIO_BARRIER = 1 << 9, /* engine supports barriers */
FIO_MEMALIGN = 1 << 10, /* engine wants aligned memory */
};
/*
* io engine entry points
*/
extern int __must_check td_io_init(struct thread_data *);
extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
extern int __must_check td_io_getevents(struct thread_data *, unsigned int, unsigned int, struct timespec *);
extern int __must_check td_io_commit(struct thread_data *);
extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
extern int td_io_close_file(struct thread_data *, struct fio_file *);
extern int __must_check td_io_get_file_size(struct thread_data *, struct fio_file *);
extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
extern void register_ioengine(struct ioengine_ops *);
extern void unregister_ioengine(struct ioengine_ops *);
extern void free_ioengine(struct thread_data *);
extern void close_ioengine(struct thread_data *);
extern int fio_show_ioengine_help(const char *engine);
/*
* io unit handling
*/
#define queue_full(td) flist_empty(&(td)->io_u_freelist)
extern struct io_u *__get_io_u(struct thread_data *);
extern struct io_u *get_io_u(struct thread_data *);
extern void put_io_u(struct thread_data *, struct io_u *);
extern void clear_io_u(struct thread_data *, struct io_u *);
extern void requeue_io_u(struct thread_data *, struct io_u **);
extern int __must_check io_u_sync_complete(struct thread_data *, struct io_u *, unsigned long *);
extern int __must_check io_u_queued_complete(struct thread_data *, int, unsigned long *);
extern void io_u_queued(struct thread_data *, struct io_u *);
extern void io_u_log_error(struct thread_data *, struct io_u *);
extern void io_u_mark_depth(struct thread_data *, unsigned int);
extern void io_u_fill_buffer(struct thread_data *td, struct io_u *, unsigned int);
void io_u_mark_complete(struct thread_data *, unsigned int);
void io_u_mark_submit(struct thread_data *, unsigned int);
int do_io_u_sync(struct thread_data *, struct io_u *);
int do_io_u_trim(struct thread_data *, struct io_u *);
#ifdef FIO_INC_DEBUG
static inline void dprint_io_u(struct io_u *io_u, const char *p)
{
struct fio_file *f = io_u->file;
dprint(FD_IO, "%s: io_u %p: off=%llu/len=%lu/ddir=%d", p, io_u,
(unsigned long long) io_u->offset,
io_u->buflen, io_u->ddir);
if (fio_debug & (1 << FD_IO)) {
if (f)
log_info("/%s", f->file_name);
log_info("\n");
}
}
#else
#define dprint_io_u(io_u, p)
#endif
#endif