[fio.git] / ioengine.h

#ifndef FIO_IOENGINE_H
#define FIO_IOENGINE_H

#include "compiler/compiler.h"
#include "os/os.h"
#include "log.h"
#include "io_ddir.h"
#include "debug.h"
#include "file.h"

#ifdef CONFIG_LIBAIO
#include <libaio.h>
#endif
#ifdef CONFIG_GUASI
#include <guasi.h>
#endif

#define FIO_IOOPS_VERSION	21

enum {
	IO_U_F_FREE		= 1 << 0,
	IO_U_F_FLIGHT		= 1 << 1,
	IO_U_F_NO_FILE_PUT	= 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,
};

/*
 * The io unit
 */
struct io_u {
	struct timeval start_time;
	struct timeval issue_time;

	struct fio_file *file;
	unsigned int flags;
	enum fio_ddir ddir;

	/*
	 * For replay workloads, we may want to account as a different
	 * IO type than what is being submitted.
	 */
	enum fio_ddir acct_ddir;

	/*
	 * Write generation
	 */
	unsigned short numberio;

	/*
	 * Allocated/set buffer and length
	 */
	unsigned long buflen;
	unsigned long long offset;
	void *buf;

	/*
	 * Initial seed for generating the buffer contents
	 */
	uint64_t 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;

	struct io_piece *ipo;

	unsigned int resid;
	unsigned int error;

	/*
	 * io engine private data
	 */
	union {
		unsigned int index;
		unsigned int seen;
		void *engine_data;
	};

	struct flist_head verify_list;

	/*
	 * Callback for io completion
	 */
	int (*end_io)(struct thread_data *, struct io_u **);

	union {
#ifdef CONFIG_LIBAIO
		struct iocb iocb;
#endif
#ifdef CONFIG_POSIXAIO
		os_aiocb_t aiocb;
#endif
#ifdef FIO_HAVE_SGIO
		struct sg_io_hdr hdr;
#endif
#ifdef CONFIG_GUASI
		guasi_req_t greq;
#endif
#ifdef CONFIG_SOLARISAIO
		aio_result_t resultp;
#endif
#ifdef FIO_HAVE_BINJECT
		struct b_user_cmd buc;
#endif
#ifdef CONFIG_RDMA
		struct ibv_mr *mr;
#endif
		void *mmap_data;
	};
};

/*
 * 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, const 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 (*invalidate)(struct thread_data *, struct fio_file *);
	int (*unlink_file)(struct thread_data *, struct fio_file *);
	int (*get_file_size)(struct thread_data *, struct fio_file *);
	void (*terminate)(struct thread_data *);
	int (*io_u_init)(struct thread_data *, struct io_u *);
	void (*io_u_free)(struct thread_data *, struct io_u *);
	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_PIPEIO	= 1 << 7,	/* input/output no seekable */
	FIO_BARRIER	= 1 << 8,	/* engine supports barriers */
	FIO_MEMALIGN	= 1 << 9,	/* engine wants aligned memory */
	FIO_BIT_BASED	= 1 << 10,	/* engine uses a bit base (e.g. uses Kbit as opposed to KB) */
	FIO_FAKEIO	= 1 << 11,	/* engine pretends to do IO */
};

/*
 * External engine defined symbol to fill in the engine ops structure
 */
typedef void (*get_ioengine_t)(struct ioengine_ops **);

/*
 * 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, const 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 td_io_unlink_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
 */
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 *, uint64_t *);
extern int __must_check io_u_queued_complete(struct thread_data *, int, uint64_t *);
extern void io_u_queued(struct thread_data *, struct io_u *);
extern void io_u_quiesce(struct thread_data *);
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 fill_io_buffer(struct thread_data *, void *, unsigned int, 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 queue_full(const struct thread_data *);

int do_io_u_sync(const struct thread_data *, struct io_u *);
int do_io_u_trim(const 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

static inline enum fio_ddir acct_ddir(struct io_u *io_u)
{
	if (io_u->acct_ddir != -1)
		return io_u->acct_ddir;

	return io_u->ddir;
}

#endif
Commit	Line	Data
dcefb588 JA	1	#ifndef FIO_IOENGINE_H
	2	#define FIO_IOENGINE_H
	3
41666588	4	#include "compiler/compiler.h"
836fcc0f JA	5	#include "os/os.h"
836fcc0f JA	6	#include "log.h"
41666588	7	#include "io_ddir.h"
ec41265e	8	#include "debug.h"
41666588	9	#include "file.h"
ec41265e	10
67bf9823 JA	11	#ifdef CONFIG_LIBAIO
	12	#include <libaio.h>
	13	#endif
	14	#ifdef CONFIG_GUASI
	15	#include <guasi.h>
	16	#endif
	17
43e82be7	18	#define FIO_IOOPS_VERSION 21
dcefb588 JA	19
dcefb588 JA	20	enum {
0c41214f RR	21	IO_U_F_FREE = 1 << 0,
0c41214f RR	22	IO_U_F_FLIGHT = 1 << 1,
f8b0bd10	23	IO_U_F_NO_FILE_PUT = 1 << 2,
0c41214f	24	IO_U_F_IN_CUR_DEPTH = 1 << 3,
38dad62d	25	IO_U_F_BUSY_OK = 1 << 4,
0d29de83	26	IO_U_F_TRIMMED = 1 << 5,
1ef2b6be	27	IO_U_F_BARRIER = 1 << 6,
82af2a7c	28	IO_U_F_VER_LIST = 1 << 7,
dcefb588 JA	29	};
	30
	31	/*
	32	* The io unit
	33	*/
	34	struct io_u {
dcefb588 JA	35	struct timeval start_time;
	36	struct timeval issue_time;
	37
d72be545 JA	38	struct fio_file *file;
	39	unsigned int flags;
	40	enum fio_ddir ddir;
	41
bcd5abfa JA	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
d8f1f7d4 JA	48	/*
	49	* Write generation
	50	*/
	51	unsigned short numberio;
	52
dcefb588 JA	53	/*
	54	* Allocated/set buffer and length
	55	*/
dcefb588 JA	56	unsigned long buflen;
dcefb588 JA	57	unsigned long long offset;
d72be545	58	void *buf;
dcefb588	59
7d9fb455 JA	60	/*
	61	* Initial seed for generating the buffer contents
	62	*/
363cffa7	63	uint64_t rand_seed;
7d9fb455	64
dcefb588 JA	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
95228507 JA	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
f9401285 JA	78	struct io_piece *ipo;
f9401285 JA	79
225ba9e3 JA	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	*/
f8b0bd10	97	int (end_io)(struct thread_data , struct io_u **);
225ba9e3	98
2ae0b204 JA	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	};
dcefb588 JA	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 );
1f440ece	144	int (getevents)(struct thread_data , unsigned int, unsigned int, const struct timespec *);
dcefb588 JA	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 *);
d9b100fc	150	int (invalidate)(struct thread_data , struct fio_file *);
38ef9c90	151	int (unlink_file)(struct thread_data , struct fio_file *);
dcefb588	152	int (get_file_size)(struct thread_data , struct fio_file *);
36d80bc7	153	void (terminate)(struct thread_data );
c73ed246 JA	154	int (io_u_init)(struct thread_data , struct io_u *);
c73ed246 JA	155	void (io_u_free)(struct thread_data , struct io_u *);
de890a1e SL	156	int option_struct_size;
de890a1e SL	157	struct fio_option *options;
dcefb588 JA	158	void *data;
	159	void *dlhandle;
	160	};
	161
2b4f4abe JA	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 */
93bcfd20	167	FIO_NODISKUTIL = 1 << 4, /* diskutil can't handle filename */
2b4f4abe JA	168	FIO_UNIDIR = 1 << 5, /* engine is uni-directional */
2b4f4abe JA	169	FIO_NOIO = 1 << 6, /* thread does only pseudo IO */
36d80bc7 JA	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 */
ad705bcb	173	FIO_BIT_BASED = 1 << 10, /* engine uses a bit base (e.g. uses Kbit as opposed to KB) */
5c57c084	174	FIO_FAKEIO = 1 << 11, /* engine pretends to do IO */
2b4f4abe	175	};
dcefb588	176
a8075704 DG	177	/*
	178	* External engine defined symbol to fill in the engine ops structure
	179	*/
	180	typedef void (get_ioengine_t)(struct ioengine_ops *);
	181
dcefb588 JA	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 );
1f440ece	189	extern int __must_check td_io_getevents(struct thread_data , unsigned int, unsigned int, const struct timespec );
dcefb588 JA	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 );
38ef9c90	193	extern int td_io_unlink_file(struct thread_data , struct fio_file );
dcefb588 JA	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 *);
de890a1e	199	extern void free_ioengine(struct thread_data *);
dcefb588 JA	200	extern void close_ioengine(struct thread_data *);
dcefb588 JA	201
de890a1e SL	202	extern int fio_show_ioengine_help(const char *engine);
de890a1e SL	203
dcefb588 JA	204	/*
	205	* io unit handling
	206	*/
dcefb588 JA	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 );
f2bba182	210	extern void clear_io_u(struct thread_data , struct io_u );
dcefb588	211	extern void requeue_io_u(struct thread_data , struct io_u *);
100f49f1 JA	212	extern int __must_check io_u_sync_complete(struct thread_data , struct io_u , uint64_t *);
100f49f1 JA	213	extern int __must_check io_u_queued_complete(struct thread_data , int, uint64_t );
dcefb588	214	extern void io_u_queued(struct thread_data , struct io_u );
002e7183	215	extern void io_u_quiesce(struct thread_data *);
dcefb588 JA	216	extern void io_u_log_error(struct thread_data , struct io_u );
dcefb588 JA	217	extern void io_u_mark_depth(struct thread_data *, unsigned int);
cc86c395	218	extern void fill_io_buffer(struct thread_data , void , unsigned int, unsigned int);
9c42684e	219	extern void io_u_fill_buffer(struct thread_data td, struct io_u , unsigned int, unsigned int);
dcefb588 JA	220	void io_u_mark_complete(struct thread_data *, unsigned int);
dcefb588 JA	221	void io_u_mark_submit(struct thread_data *, unsigned int);
effd6ff0	222	int queue_full(const struct thread_data *);
dcefb588	223
effd6ff0 JA	224	int do_io_u_sync(const struct thread_data , struct io_u );
effd6ff0 JA	225	int do_io_u_trim(const struct thread_data , struct io_u );
44f29692	226
c592b9fe JA	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
bcd5abfa JA	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
dcefb588	254	#endif