[fio.git] / ioengine.h

#ifndef FIO_IOENGINE_H
#define FIO_IOENGINE_H

#include "compiler/compiler.h"
#include "io_ddir.h"
#include "debug.h"
#include "file.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,
	IO_U_F_VER_LIST		= 1 << 7,
};

struct thread_data;

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