[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;
};

/*
 * 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 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 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 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;

	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;
};

#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 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,
};

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

#define td_read(td)		((td)->ddir == DDIR_READ)
#define td_write(td)		((td)->ddir == DDIR_WRITE)

#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)

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