[fio.git] / fio.h

#ifndef FIO_H
#define FIO_H

#include <sched.h>
#include <limits.h>
#include <pthread.h>
#include <sys/time.h>
#include <sys/resource.h>
#include <semaphore.h>

#include "list.h"
#include "md5.h"
#include "crc32.h"
#include "arch.h"
#include "os.h"

struct io_stat {
	unsigned long val;
	unsigned long val_sq;
	unsigned long max_val;
	unsigned long min_val;
	unsigned long samples;
};

struct io_sample {
	unsigned long time;
	unsigned long val;
	unsigned int ddir;
};

struct io_log {
	unsigned long nr_samples;
	unsigned long max_samples;
	struct io_sample *log;
};

struct io_piece {
	struct list_head list;
	unsigned long long offset;
	unsigned int len;
	int ddir;
};

/*
 * The io unit
 */
struct io_u {
	union {
#ifdef FIO_HAVE_LIBAIO
		struct iocb iocb;
#endif
#ifdef FIO_HAVE_POSIXAIO
		struct aiocb aiocb;
#endif
#ifdef FIO_HAVE_SGIO
		struct sg_io_hdr hdr;
#endif
	};
	struct timeval start_time;
	struct timeval issue_time;

	char *buf;
	unsigned int buflen;
	unsigned long long offset;
	unsigned int index;

	unsigned int resid;
	unsigned int error;

	unsigned char seen;
	unsigned char ddir;

	struct list_head list;
};

#define FIO_HDR_MAGIC	0xf00baaef

enum {
	VERIFY_NONE = 0,
	VERIFY_MD5,
	VERIFY_CRC32,
};

struct verify_header {
	unsigned int fio_magic;
	unsigned int len;
	unsigned int verify_type;
	union {
		char md5_digest[MD5_HASH_WORDS * 4];
		unsigned long crc32;
	};
};

struct group_run_stats {
	unsigned long long max_run[2], min_run[2];
	unsigned long long max_bw[2], min_bw[2];
	unsigned long long io_mb[2];
	unsigned long long agg[2];
};

struct thread_data {
	char file_name[256];
	char directory[256];
	char verror[80];
	pthread_t thread;
	int thread_number;
	int groupid;
	int filetype;
	int error;
	int fd;
	void *mmap;
	pid_t pid;
	char *orig_buffer;
	size_t orig_buffer_size;
	volatile int terminate;
	volatile int runstate;
	volatile int old_runstate;
	unsigned int ddir;
	unsigned int iomix;
	unsigned int ioprio;
	unsigned int sequential;
	unsigned int bs;
	unsigned int min_bs;
	unsigned int max_bs;
	unsigned int odirect;
	unsigned int thinktime;
	unsigned int fsync_blocks;
	unsigned int start_delay;
	unsigned int timeout;
	unsigned int io_engine;
	unsigned int create_file;
	unsigned int overwrite;
	unsigned int invalidate_cache;
	unsigned int bw_avg_time;
	unsigned int create_serialize;
	unsigned int create_fsync;
	unsigned int end_fsync;
	unsigned int loops;
	unsigned long long file_size;
	unsigned long long real_file_size;
	unsigned long long file_offset;
	unsigned long long zone_size;
	unsigned long long zone_skip;
	unsigned int sync_io;
	unsigned int mem_type;
	unsigned int verify;
	unsigned int stonewall;
	unsigned int numjobs;
	unsigned int use_thread;
	unsigned int iodepth;
	os_cpu_mask_t cpumask;
	unsigned int jobnum;
	unsigned int read_iolog;
	unsigned int write_iolog;

	char iolog_file[256];
	void *iolog_buf;
	FILE *iolog_f;

	struct drand48_data bsrange_state;
	struct drand48_data verify_state;

	int shm_id;

	void *io_data;
	char io_engine_name[16];
	int (*io_prep)(struct thread_data *, struct io_u *);
	int (*io_queue)(struct thread_data *, struct io_u *);
	int (*io_getevents)(struct thread_data *, int, int, struct timespec *);
	struct io_u *(*io_event)(struct thread_data *, int);
	int (*io_cancel)(struct thread_data *, struct io_u *);
	void (*io_cleanup)(struct thread_data *);
	int (*io_sync)(struct thread_data *);

	unsigned int cur_depth;
	struct list_head io_u_freelist;
	struct list_head io_u_busylist;

	unsigned int rate;
	unsigned int ratemin;
	unsigned int ratecycle;
	unsigned long rate_usec_cycle;
	long rate_pending_usleep;
	unsigned long rate_bytes;
	struct timeval lastrate;

	unsigned long runtime[2];		/* msec */
	unsigned long long io_size;
	unsigned long long total_io_size;

	unsigned long long io_blocks[2];
	unsigned long long io_bytes[2];
	unsigned long long zone_bytes;
	unsigned long long this_io_bytes[2];
	unsigned long long last_pos;
	sem_t mutex;

	struct drand48_data random_state;
	unsigned long *file_map;
	unsigned int num_maps;

	/*
	 * bandwidth and latency stats
	 */
	struct io_stat clat_stat[2];		/* completion latency */
	struct io_stat slat_stat[2];		/* submission latency */
	struct io_stat bw_stat[2];		/* bandwidth stats */

	unsigned long long stat_io_bytes[2];
	struct timeval stat_sample_time[2];

	struct io_log *slat_log;
	struct io_log *clat_log;
	struct io_log *bw_log;

	struct timeval start;	/* start of this loop */
	struct timeval epoch;	/* time job was started */

	struct rusage ru_start;
	struct rusage ru_end;
	unsigned long usr_time;
	unsigned long sys_time;
	unsigned long ctx;

	unsigned int do_disk_util;
	unsigned int override_sync;

	struct list_head io_hist_list;
	struct list_head io_log_list;
};

#define td_verror(td, err)						\
	do {								\
		int e = (err);						\
		(td)->error = e;					\
		snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, error=%s", __FILE__, __LINE__, strerror(e));	\
	} while (0)

extern int parse_jobs_ini(char *);
extern int parse_options(int, char **);
extern void finish_log(struct thread_data *, struct io_log *, const char *);
extern int init_random_state(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 int rate_quit;
extern int write_lat_log;
extern int write_bw_log;
extern int exitall_on_terminate;
extern int thread_number;
extern int shm_id;
extern int groupid;

extern struct thread_data *threads;

enum {
	DDIR_READ = 0,
	DDIR_WRITE,
};

/*
 * What type of allocation to use for io buffers
 */
enum {
	MEM_MALLOC,	/* ordinary malloc */
	MEM_SHM,	/* use shared memory segments */
	MEM_MMAP,	/* use anonynomous mmap */
};

/*
 * The type of object we are working on
 */
enum {
	FIO_TYPE_FILE = 1,
	FIO_TYPE_BD,
	FIO_TYPE_CHAR,
};

enum {
	FIO_SYNCIO	= 1 << 0,
	FIO_MMAPIO	= 1 << 1 | FIO_SYNCIO,
	FIO_LIBAIO	= 1 << 2,
	FIO_POSIXAIO	= 1 << 3,
	FIO_SGIO	= 1 << 4,
	FIO_SPLICEIO	= 1 << 5 | FIO_SYNCIO,
};

#define td_read(td)		((td)->ddir == DDIR_READ)
#define td_write(td)		((td)->ddir == DDIR_WRITE)
#define td_rw(td)		((td)->iomix != 0)

#define BLOCKS_PER_MAP		(8 * sizeof(long))
#define TO_MAP_BLOCK(td, b)	((b) - ((td)->file_offset / (td)->min_bs))
#define RAND_MAP_IDX(td, b)	(TO_MAP_BLOCK(td, b) / BLOCKS_PER_MAP)
#define RAND_MAP_BIT(td, b)	(TO_MAP_BLOCK(td, b) & (BLOCKS_PER_MAP - 1))

#define MAX_JOBS	(1024)

struct disk_util_stat {
	unsigned ios[2];
	unsigned merges[2];
	unsigned long long sectors[2];
	unsigned ticks[2];
	unsigned io_ticks;
	unsigned time_in_queue;
};

struct disk_util {
	struct list_head list;

	char *name;
	char path[256];
	dev_t dev;

	struct disk_util_stat dus;
	struct disk_util_stat last_dus;

	unsigned long msec;
	struct timeval time;
};

struct io_completion_data {
	int nr;				/* input */

	int error;			/* output */
	unsigned long bytes_done[2];	/* output */
};

#define DISK_UTIL_MSEC	(250)

#ifndef min
#define min(a, b)	((a) < (b) ? (a) : (b))
#endif

#endif
Commit	Line	Data
ebac4655 JA	1	#ifndef FIO_H
	2	#define FIO_H
	3
	4	#include <sched.h>
	5	#include <limits.h>
	6	#include <pthread.h>
	7	#include <sys/time.h>
	8	#include <sys/resource.h>
	9	#include <semaphore.h>
	10
	11	#include "list.h"
	12	#include "md5.h"
	13	#include "crc32.h"
	14	#include "arch.h"
	15	#include "os.h"
	16
	17	struct io_stat {
	18	unsigned long val;
	19	unsigned long val_sq;
	20	unsigned long max_val;
	21	unsigned long min_val;
	22	unsigned long samples;
	23	};
	24
	25	struct io_sample {
	26	unsigned long time;
	27	unsigned long val;
	28	unsigned int ddir;
	29	};
	30
	31	struct io_log {
	32	unsigned long nr_samples;
	33	unsigned long max_samples;
	34	struct io_sample *log;
	35	};
	36
	37	struct io_piece {
	38	struct list_head list;
	39	unsigned long long offset;
	40	unsigned int len;
aea47d44	41	int ddir;
ebac4655 JA	42	};
	43
	44	/*
	45	* The io unit
	46	*/
	47	struct io_u {
	48	union {
	49	#ifdef FIO_HAVE_LIBAIO
	50	struct iocb iocb;
	51	#endif
	52	#ifdef FIO_HAVE_POSIXAIO
	53	struct aiocb aiocb;
	54	#endif
	55	#ifdef FIO_HAVE_SGIO
	56	struct sg_io_hdr hdr;
	57	#endif
	58	};
	59	struct timeval start_time;
	60	struct timeval issue_time;
	61
	62	char *buf;
	63	unsigned int buflen;
	64	unsigned long long offset;
b1ff3403	65	unsigned int index;
ebac4655 JA	66
	67	unsigned int resid;
	68	unsigned int error;
	69
	70	unsigned char seen;
	71	unsigned char ddir;
	72
	73	struct list_head list;
	74	};
	75
	76	#define FIO_HDR_MAGIC 0xf00baaef
	77
	78	enum {
	79	VERIFY_NONE = 0,
	80	VERIFY_MD5,
	81	VERIFY_CRC32,
	82	};
	83
	84	struct verify_header {
	85	unsigned int fio_magic;
	86	unsigned int len;
	87	unsigned int verify_type;
	88	union {
	89	char md5_digest[MD5_HASH_WORDS * 4];
	90	unsigned long crc32;
	91	};
	92	};
	93
	94	struct group_run_stats {
9104f874 JA	95	unsigned long long max_run[2], min_run[2];
	96	unsigned long long max_bw[2], min_bw[2];
	97	unsigned long long io_mb[2];
	98	unsigned long long agg[2];
ebac4655 JA	99	};
	100
	101	struct thread_data {
	102	char file_name[256];
	103	char directory[256];
	104	char verror[80];
	105	pthread_t thread;
	106	int thread_number;
	107	int groupid;
	108	int filetype;
	109	int error;
	110	int fd;
	111	void *mmap;
	112	pid_t pid;
	113	char *orig_buffer;
	114	size_t orig_buffer_size;
	115	volatile int terminate;
	116	volatile int runstate;
	117	volatile int old_runstate;
	118	unsigned int ddir;
3d60d1ed	119	unsigned int iomix;
ebac4655 JA	120	unsigned int ioprio;
	121	unsigned int sequential;
	122	unsigned int bs;
	123	unsigned int min_bs;
	124	unsigned int max_bs;
	125	unsigned int odirect;
	126	unsigned int thinktime;
	127	unsigned int fsync_blocks;
	128	unsigned int start_delay;
	129	unsigned int timeout;
	130	unsigned int io_engine;
	131	unsigned int create_file;
	132	unsigned int overwrite;
	133	unsigned int invalidate_cache;
	134	unsigned int bw_avg_time;
	135	unsigned int create_serialize;
	136	unsigned int create_fsync;
fc1a4713	137	unsigned int end_fsync;
ebac4655 JA	138	unsigned int loops;
ebac4655 JA	139	unsigned long long file_size;
838a3cd3	140	unsigned long long real_file_size;
ebac4655	141	unsigned long long file_offset;
20dc95c4 JA	142	unsigned long long zone_size;
20dc95c4 JA	143	unsigned long long zone_skip;
ebac4655 JA	144	unsigned int sync_io;
	145	unsigned int mem_type;
	146	unsigned int verify;
	147	unsigned int stonewall;
	148	unsigned int numjobs;
	149	unsigned int use_thread;
	150	unsigned int iodepth;
	151	os_cpu_mask_t cpumask;
eba09dd3	152	unsigned int jobnum;
843a7413 JA	153	unsigned int read_iolog;
843a7413 JA	154	unsigned int write_iolog;
aea47d44 JA	155
aea47d44 JA	156	char iolog_file[256];
843a7413 JA	157	void *iolog_buf;
843a7413 JA	158	FILE *iolog_f;
ebac4655 JA	159
	160	struct drand48_data bsrange_state;
	161	struct drand48_data verify_state;
	162
	163	int shm_id;
	164
ebac4655 JA	165	void *io_data;
	166	char io_engine_name[16];
	167	int (io_prep)(struct thread_data , struct io_u *);
	168	int (io_queue)(struct thread_data , struct io_u *);
	169	int (io_getevents)(struct thread_data , int, int, struct timespec *);
	170	struct io_u (io_event)(struct thread_data *, int);
	171	int (io_cancel)(struct thread_data , struct io_u *);
	172	void (io_cleanup)(struct thread_data );
	173	int (io_sync)(struct thread_data );
	174
	175	unsigned int cur_depth;
	176	struct list_head io_u_freelist;
	177	struct list_head io_u_busylist;
	178
	179	unsigned int rate;
	180	unsigned int ratemin;
	181	unsigned int ratecycle;
	182	unsigned long rate_usec_cycle;
	183	long rate_pending_usleep;
	184	unsigned long rate_bytes;
	185	struct timeval lastrate;
	186
	187	unsigned long runtime[2]; /* msec */
	188	unsigned long long io_size;
	189	unsigned long long total_io_size;
	190
9104f874 JA	191	unsigned long long io_blocks[2];
	192	unsigned long long io_bytes[2];
	193	unsigned long long zone_bytes;
	194	unsigned long long this_io_bytes[2];
20dc95c4	195	unsigned long long last_pos;
ebac4655 JA	196	sem_t mutex;
	197
	198	struct drand48_data random_state;
	199	unsigned long *file_map;
	200	unsigned int num_maps;
	201
	202	/*
	203	* bandwidth and latency stats
	204	*/
	205	struct io_stat clat_stat[2]; /* completion latency */
	206	struct io_stat slat_stat[2]; /* submission latency */
	207	struct io_stat bw_stat[2]; /* bandwidth stats */
	208
9104f874	209	unsigned long long stat_io_bytes[2];
ebac4655 JA	210	struct timeval stat_sample_time[2];
	211
	212	struct io_log *slat_log;
	213	struct io_log *clat_log;
	214	struct io_log *bw_log;
	215
	216	struct timeval start; /* start of this loop */
	217	struct timeval epoch; /* time job was started */
	218
	219	struct rusage ru_start;
	220	struct rusage ru_end;
	221	unsigned long usr_time;
	222	unsigned long sys_time;
	223	unsigned long ctx;
	224
	225	unsigned int do_disk_util;
	226	unsigned int override_sync;
	227
	228	struct list_head io_hist_list;
aea47d44	229	struct list_head io_log_list;
ebac4655 JA	230	};
	231
	232	#define td_verror(td, err) \
	233	do { \
	234	int e = (err); \
	235	(td)->error = e; \
	236	snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, error=%s", __FILE__, __LINE__, strerror(e)); \
	237	} while (0)
	238
	239	extern int parse_jobs_ini(char *);
	240	extern int parse_options(int, char **);
	241	extern void finish_log(struct thread_data , struct io_log , const char *);
	242	extern int init_random_state(struct thread_data *);
b1ff3403 JA	243	extern struct io_u __get_io_u(struct thread_data );
b1ff3403 JA	244	extern void put_io_u(struct thread_data , struct io_u );
ebac4655 JA	245
	246	extern int rate_quit;
	247	extern int write_lat_log;
	248	extern int write_bw_log;
	249	extern int exitall_on_terminate;
	250	extern int thread_number;
	251	extern int shm_id;
	252	extern int groupid;
	253
	254	extern struct thread_data *threads;
	255
	256	enum {
	257	DDIR_READ = 0,
	258	DDIR_WRITE,
	259	};
	260
	261	/*
	262	* What type of allocation to use for io buffers
	263	*/
	264	enum {
	265	MEM_MALLOC, /* ordinary malloc */
	266	MEM_SHM, /* use shared memory segments */
	267	MEM_MMAP, /* use anonynomous mmap */
	268	};
	269
	270	/*
	271	* The type of object we are working on
	272	*/
	273	enum {
	274	FIO_TYPE_FILE = 1,
	275	FIO_TYPE_BD,
0af7b542	276	FIO_TYPE_CHAR,
ebac4655 JA	277	};
	278
	279	enum {
	280	FIO_SYNCIO = 1 << 0,
	281	FIO_MMAPIO = 1 << 1 \| FIO_SYNCIO,
	282	FIO_LIBAIO = 1 << 2,
	283	FIO_POSIXAIO = 1 << 3,
	284	FIO_SGIO = 1 << 4,
8756e4d4	285	FIO_SPLICEIO = 1 << 5 \| FIO_SYNCIO,
ebac4655 JA	286	};
	287
	288	#define td_read(td) ((td)->ddir == DDIR_READ)
	289	#define td_write(td) ((td)->ddir == DDIR_WRITE)
3d60d1ed	290	#define td_rw(td) ((td)->iomix != 0)
ebac4655 JA	291
	292	#define BLOCKS_PER_MAP (8 * sizeof(long))
	293	#define TO_MAP_BLOCK(td, b) ((b) - ((td)->file_offset / (td)->min_bs))
	294	#define RAND_MAP_IDX(td, b) (TO_MAP_BLOCK(td, b) / BLOCKS_PER_MAP)
	295	#define RAND_MAP_BIT(td, b) (TO_MAP_BLOCK(td, b) & (BLOCKS_PER_MAP - 1))
	296
	297	#define MAX_JOBS (1024)
	298
	299	struct disk_util_stat {
	300	unsigned ios[2];
	301	unsigned merges[2];
	302	unsigned long long sectors[2];
	303	unsigned ticks[2];
	304	unsigned io_ticks;
	305	unsigned time_in_queue;
	306	};
	307
	308	struct disk_util {
	309	struct list_head list;
	310
	311	char *name;
	312	char path[256];
	313	dev_t dev;
	314
	315	struct disk_util_stat dus;
	316	struct disk_util_stat last_dus;
	317
	318	unsigned long msec;
	319	struct timeval time;
	320	};
	321
	322	struct io_completion_data {
	323	int nr; /* input */
	324
	325	int error; /* output */
	326	unsigned long bytes_done[2]; /* output */
	327	};
	328
	329	#define DISK_UTIL_MSEC (250)
	330
6a0106a0 JA	331	#ifndef min
	332	#define min(a, b) ((a) < (b) ? (a) : (b))
	333	#endif
	334
ebac4655	335	#endif