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

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
	};
	struct timeval start_time;
	struct timeval issue_time;

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

	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 max_run[2], min_run[2];
	unsigned long max_bw[2], min_bw[2];
	unsigned long io_mb[2];
	unsigned 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 file_offset;
	unsigned int sync_io;
	unsigned int mem_type;
	unsigned int verify;
	unsigned int stonewall;
	unsigned int numjobs;
	unsigned int use_thread;
	unsigned int use_mmap;
	os_cpu_mask_t cpumask;

	struct drand48_data bsrange_state;
	struct drand48_data verify_state;

	int shm_id;

	unsigned long long cur_off;

	void *aio_data;
	int (*io_prep)(struct thread_data *, struct io_u *, int);
	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 aio_depth;

	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;		/* sec */
	unsigned long long io_size;

	unsigned long io_blocks;
	unsigned long io_bytes;
	unsigned long this_io_bytes;
	unsigned long last_bytes;
	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;		/* completion latency */
	struct io_stat slat_stat;		/* submission latency */

	struct io_stat bw_stat;			/* bandwidth stats */
	unsigned long stat_io_bytes;
	struct timeval stat_sample_time;

	struct io_log *lat_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;

	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 char run_str[];

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

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

#define DISK_UTIL_MSEC	(250)

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