[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 <errno.h>
#include <stdlib.h>
#include <stdio.h>
#include <unistd.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;
	struct fio_file *file;
	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 fio_file *file;

	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_kb[2];
	unsigned long long agg[2];
};

enum fio_ddir {
	DDIR_READ = 0,
	DDIR_WRITE,
};

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

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

enum fio_ioengine_flags {
	FIO_SYNCIO	= 1 << 0,
	FIO_CPUIO	= 1 << 1,
	FIO_MMAPIO	= 1 << 2,
	FIO_RAWIO	= 1 << 3,
};

struct fio_file {
	/*
	 * A file may not be a file descriptor, let the io engine decide
	 */
	union {
		unsigned long file_data;
		int fd;
	};
	char *file_name;
	void *mmap;
	unsigned long long file_size;
	unsigned long long real_file_size;
	unsigned long long file_offset;
	unsigned long long last_pos;

	unsigned long *file_map;
	unsigned int num_maps;

	int fileno;
};

/*
 * This describes a single thread/process executing a fio job.
 */
struct thread_data {
	char name[32];
	char *directory;
	char *filename;
	char verror[80];
	pthread_t thread;
	int thread_number;
	int groupid;
	enum fio_filetype filetype;
	struct fio_file *files;
	unsigned int nr_files;
	unsigned int nr_uniq_files;
	unsigned int next_file;
	int error;
	pid_t pid;
	char *orig_buffer;
	size_t orig_buffer_size;
	volatile int terminate;
	volatile int runstate;
	enum fio_ddir ddir;
	unsigned int iomix;
	unsigned int ioprio;

	unsigned char sequential;
	unsigned char odirect;
	unsigned char invalidate_cache;
	unsigned char create_serialize;
	unsigned char create_fsync;
	unsigned char end_fsync;
	unsigned char sync_io;
	unsigned char verify;
	unsigned char use_thread;
	unsigned char unlink;
	unsigned char do_disk_util;
	unsigned char override_sync;
	unsigned char rand_repeatable;
	unsigned char write_lat_log;
	unsigned char write_bw_log;

	unsigned int bs;
	unsigned int min_bs;
	unsigned int max_bs;
	unsigned int thinktime;
	unsigned int fsync_blocks;
	unsigned int start_delay;
	unsigned long timeout;
	unsigned int overwrite;
	unsigned int bw_avg_time;
	unsigned int loops;
	unsigned long long zone_size;
	unsigned long long zone_skip;
	enum fio_memtype mem_type;
	unsigned int stonewall;
	unsigned int numjobs;
	unsigned int iodepth;
	os_cpu_mask_t cpumask;
	unsigned int iolog;
	unsigned int read_iolog;
	unsigned int write_iolog;
	unsigned int rwmixcycle;
	unsigned int rwmixread;
	unsigned int nice;

	char *iolog_file;
	void *iolog_buf;
	FILE *iolog_f;

	char *sysfs_root;
	char *ioscheduler;

	os_random_state_t bsrange_state;
	os_random_state_t verify_state;

	int shm_id;

	/*
	 * IO engine hooks, contains everything needed to submit an io_u
	 * to any of the available IO engines.
	 */
	struct ioengine_ops *io_ops;

	/*
	 * Current IO depth and list of free and busy io_u's.
	 */
	unsigned int cur_depth;
	struct list_head io_u_freelist;
	struct list_head io_u_busylist;

	/*
	 * Rate state
	 */
	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_file_size;
	unsigned long long start_offset;
	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];
	volatile int mutex;

	/*
	 * State for random io, a bitmap of blocks done vs not done
	 */
	os_random_state_t random_state;

	/*
	 * CPU "io" cycle burner
	 */
	unsigned int cpuload;
	unsigned int cpucycle;

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

	/*
	 * fio system usage accounting
	 */
	struct rusage ru_start;
	struct rusage ru_end;
	unsigned long usr_time;
	unsigned long sys_time;
	unsigned long ctx;

	/*
	 * read/write mixed workload state
	 */
	os_random_state_t rwmix_state;
	struct timeval rwmix_switch;
	enum fio_ddir rwmix_ddir;

	/*
	 * Pre-run and post-run shell
	 */
	char *exec_prerun;
	char *exec_postrun;

	/*
	 * IO historic logs
	 */
	struct list_head io_hist_list;
	struct list_head io_log_list;
};

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


#define td_verror(td, err)	__td_verror((td), (err), strerror((err)))
#define td_vmsg(td, err, msg)	__td_verror((td), (err), (msg))

extern int rate_quit;
extern int exitall_on_terminate;
extern int thread_number;
extern int shm_id;
extern int groupid;
extern int terse_output;
extern FILE *f_out;
extern FILE *f_err;
extern char *fio_inst_prefix;
extern int temp_stall_ts;

extern struct thread_data *threads;

#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, f, b)	((b) - ((f)->file_offset / (td)->min_bs))
#define RAND_MAP_IDX(td, f, b)	(TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
#define RAND_MAP_BIT(td, f, b)	(TO_MAP_BLOCK(td, f, 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

/*
 * Log exports
 */
extern int read_iolog_get(struct thread_data *, struct io_u *);
extern void write_iolog_put(struct thread_data *, struct io_u *);
extern int init_iolog(struct thread_data *td);
extern void log_io_piece(struct thread_data *, struct io_u *);
extern void prune_io_piece_log(struct thread_data *);
extern void write_iolog_close(struct thread_data *);

/*
 * Logging
 */
extern void add_clat_sample(struct thread_data *, int, unsigned long);
extern void add_slat_sample(struct thread_data *, int, unsigned long);
extern void add_bw_sample(struct thread_data *, int);
extern void show_run_stats(void);
extern void init_disk_util(struct thread_data *);
extern void update_rusage_stat(struct thread_data *);
extern void update_io_ticks(void);
extern void disk_util_timer_arm(void);
extern void setup_log(struct io_log **);
extern void finish_log(struct thread_data *, struct io_log *, const char *);
extern int setup_rate(struct thread_data *);

/*
 * Time functions
 */
extern void time_init(void);
extern unsigned long utime_since(struct timeval *, struct timeval *);
extern unsigned long mtime_since(struct timeval *, struct timeval *);
extern unsigned long mtime_since_now(struct timeval *);
extern unsigned long time_since_now(struct timeval *);
extern unsigned long mtime_since_genesis(void);
extern void __usec_sleep(unsigned int);
extern void usec_sleep(struct thread_data *, unsigned long);
extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);

/*
 * Init functions
 */
extern int parse_options(int, char **);
extern int init_random_state(struct thread_data *);

/*
 * File setup/shutdown
 */
extern void close_files(struct thread_data *);
extern int setup_files(struct thread_data *);
extern int file_invalidate_cache(struct thread_data *, struct fio_file *);

/*
 * ETA/status stuff
 */
extern void print_thread_status(void);
extern void print_status_init(int);

/*
 * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
 * will never back again. It may cycle between running/verififying/fsyncing.
 * Once the thread reaches TD_EXITED, it is just waiting for the core to
 * reap it.
 */
enum {
	TD_NOT_CREATED = 0,
	TD_CREATED,
	TD_INITIALIZED,
	TD_RUNNING,
	TD_VERIFYING,
	TD_FSYNCING,
	TD_EXITED,
	TD_REAPED,
};

/*
 * Verify helpers
 */
extern void populate_verify_io_u(struct thread_data *, struct io_u *);
extern int get_next_verify(struct thread_data *td, struct io_u *);
extern int do_io_u_verify(struct thread_data *, struct io_u **);

/*
 * Memory helpers
 */
extern int fio_pin_memory(void);
extern void fio_unpin_memory(void);
extern int allocate_io_mem(struct thread_data *);
extern void free_io_mem(struct thread_data *);

/*
 * io unit handling
 */
#define queue_full(td)	list_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 *, struct fio_file *);
extern void put_io_u(struct thread_data *, struct io_u *);
extern void ios_completed(struct thread_data *, struct io_completion_data *);
extern void io_completed(struct thread_data *, struct io_u *, struct io_completion_data *);

/*
 * io engine entry points
 */
extern int td_io_init(struct thread_data *);
extern int td_io_prep(struct thread_data *, struct io_u *);
extern int td_io_queue(struct thread_data *, struct io_u *);
extern int td_io_sync(struct thread_data *, struct fio_file *);
extern int td_io_getevents(struct thread_data *, int, int, struct timespec *);

/*
 * This is a pretty crappy semaphore implementation, but with the use that fio
 * has (just signalling start/go conditions), it doesn't have to be better.
 * Naturally this would not work for any type of contended semaphore or
 * for real locking.
 */
static inline void fio_sem_init(volatile int *sem, int val)
{
	*sem = val;
}

static inline void fio_sem_down(volatile int *sem)
{
	while (*sem == 0)
		usleep(10000);

	(*sem)--;
}

static inline void fio_sem_up(volatile int *sem)
{
	(*sem)++;
}

/*
 * If logging output to a file, stderr should go to both stderr and f_err
 */
#define log_err(args...)	do {		\
	fprintf(f_err, ##args);			\
	if (f_err != stderr)			\
		fprintf(stderr, ##args);	\
	} while (0)

struct ioengine_ops {
	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 (*getevents)(struct thread_data *, int, 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 (*sync)(struct thread_data *, struct fio_file *);
	void *data;
	void *dlhandle;
};

#define FIO_IOOPS_VERSION	2

extern struct ioengine_ops *load_ioengine(struct thread_data *, char *);
extern void close_ioengine(struct thread_data *);

/*
 * Mark unused variables passed to ops functions as unused, to silence gcc
 */
#define fio_unused	__attribute((__unused__))

#define for_each_td(td, i)	\
	for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
#define for_each_file(td, f, i)	\
	for ((i) = 0, (f) = &(td)->files[0]; (i) < (int) (td)->nr_files; (i)++, (f)++)

#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>
3c39a379 JA	9	#include <errno.h>
	10	#include <stdlib.h>
	11	#include <stdio.h>
6d6f031f	12	#include <unistd.h>
ebac4655 JA	13
	14	#include "list.h"
	15	#include "md5.h"
	16	#include "crc32.h"
	17	#include "arch.h"
	18	#include "os.h"
	19
	20	struct io_stat {
	21	unsigned long val;
	22	unsigned long val_sq;
	23	unsigned long max_val;
	24	unsigned long min_val;
	25	unsigned long samples;
	26	};
	27
	28	struct io_sample {
	29	unsigned long time;
	30	unsigned long val;
	31	unsigned int ddir;
	32	};
	33
	34	struct io_log {
	35	unsigned long nr_samples;
	36	unsigned long max_samples;
	37	struct io_sample *log;
	38	};
	39
	40	struct io_piece {
	41	struct list_head list;
53cdc686	42	struct fio_file *file;
ebac4655 JA	43	unsigned long long offset;
ebac4655 JA	44	unsigned int len;
aea47d44	45	int ddir;
ebac4655 JA	46	};
	47
	48	/*
	49	* The io unit
	50	*/
	51	struct io_u {
	52	union {
	53	#ifdef FIO_HAVE_LIBAIO
	54	struct iocb iocb;
	55	#endif
	56	#ifdef FIO_HAVE_POSIXAIO
	57	struct aiocb aiocb;
	58	#endif
	59	#ifdef FIO_HAVE_SGIO
	60	struct sg_io_hdr hdr;
	61	#endif
	62	};
	63	struct timeval start_time;
	64	struct timeval issue_time;
	65
	66	char *buf;
	67	unsigned int buflen;
	68	unsigned long long offset;
b1ff3403	69	unsigned int index;
ebac4655 JA	70
	71	unsigned int resid;
	72	unsigned int error;
	73
	74	unsigned char seen;
	75	unsigned char ddir;
	76
53cdc686 JA	77	struct fio_file *file;
53cdc686 JA	78
ebac4655 JA	79	struct list_head list;
	80	};
	81
	82	#define FIO_HDR_MAGIC 0xf00baaef
	83
	84	enum {
	85	VERIFY_NONE = 0,
	86	VERIFY_MD5,
	87	VERIFY_CRC32,
	88	};
	89
	90	struct verify_header {
	91	unsigned int fio_magic;
	92	unsigned int len;
	93	unsigned int verify_type;
	94	union {
	95	char md5_digest[MD5_HASH_WORDS * 4];
	96	unsigned long crc32;
	97	};
	98	};
	99
	100	struct group_run_stats {
9104f874 JA	101	unsigned long long max_run[2], min_run[2];
9104f874 JA	102	unsigned long long max_bw[2], min_bw[2];
e9b2a3fa	103	unsigned long long io_kb[2];
9104f874	104	unsigned long long agg[2];
ebac4655 JA	105	};
ebac4655 JA	106
e9c047a0 JA	107	enum fio_ddir {
	108	DDIR_READ = 0,
	109	DDIR_WRITE,
	110	};
	111
	112	/*
	113	* What type of allocation to use for io buffers
	114	*/
	115	enum fio_memtype {
	116	MEM_MALLOC = 0, /* ordinary malloc */
	117	MEM_SHM, /* use shared memory segments */
	118	MEM_MMAP, /* use anonynomous mmap */
	119	};
	120
	121	/*
	122	* The type of object we are working on
	123	*/
	124	enum fio_filetype {
	125	FIO_TYPE_FILE = 1,
	126	FIO_TYPE_BD,
	127	FIO_TYPE_CHAR,
	128	};
	129
2866c82d	130	enum fio_ioengine_flags {
e9c047a0	131	FIO_SYNCIO = 1 << 0,
2866c82d JA	132	FIO_CPUIO = 1 << 1,
2866c82d JA	133	FIO_MMAPIO = 1 << 2,
b2a15192	134	FIO_RAWIO = 1 << 3,
e9c047a0 JA	135	};
e9c047a0 JA	136
53cdc686 JA	137	struct fio_file {
	138	/*
	139	* A file may not be a file descriptor, let the io engine decide
	140	*/
	141	union {
	142	unsigned long file_data;
	143	int fd;
	144	};
	145	char *file_name;
	146	void *mmap;
	147	unsigned long long file_size;
	148	unsigned long long real_file_size;
	149	unsigned long long file_offset;
	150	unsigned long long last_pos;
	151
	152	unsigned long *file_map;
	153	unsigned int num_maps;
b2a15192 JA	154
b2a15192 JA	155	int fileno;
53cdc686 JA	156	};
53cdc686 JA	157
e9c047a0 JA	158	/*
	159	* This describes a single thread/process executing a fio job.
	160	*/
ebac4655	161	struct thread_data {
e9c047a0	162	char name[32];
ef899b63	163	char *directory;
13f8e2d2	164	char *filename;
ebac4655 JA	165	char verror[80];
	166	pthread_t thread;
	167	int thread_number;
	168	int groupid;
e9c047a0	169	enum fio_filetype filetype;
53cdc686 JA	170	struct fio_file *files;
53cdc686 JA	171	unsigned int nr_files;
13f8e2d2	172	unsigned int nr_uniq_files;
53cdc686	173	unsigned int next_file;
ebac4655	174	int error;
ebac4655 JA	175	pid_t pid;
	176	char *orig_buffer;
	177	size_t orig_buffer_size;
	178	volatile int terminate;
	179	volatile int runstate;
e9c047a0	180	enum fio_ddir ddir;
3d60d1ed	181	unsigned int iomix;
ebac4655	182	unsigned int ioprio;
e9c047a0 JA	183
	184	unsigned char sequential;
	185	unsigned char odirect;
e9c047a0 JA	186	unsigned char invalidate_cache;
	187	unsigned char create_serialize;
	188	unsigned char create_fsync;
	189	unsigned char end_fsync;
	190	unsigned char sync_io;
	191	unsigned char verify;
	192	unsigned char use_thread;
f6cbb269	193	unsigned char unlink;
e9c047a0 JA	194	unsigned char do_disk_util;
e9c047a0 JA	195	unsigned char override_sync;
9ebc27e1	196	unsigned char rand_repeatable;
ec94ec56 JA	197	unsigned char write_lat_log;
ec94ec56 JA	198	unsigned char write_bw_log;
e9c047a0	199
ebac4655 JA	200	unsigned int bs;
	201	unsigned int min_bs;
	202	unsigned int max_bs;
ebac4655 JA	203	unsigned int thinktime;
	204	unsigned int fsync_blocks;
	205	unsigned int start_delay;
906c8d75	206	unsigned long timeout;
ebac4655	207	unsigned int overwrite;
ebac4655	208	unsigned int bw_avg_time;
ebac4655	209	unsigned int loops;
20dc95c4 JA	210	unsigned long long zone_size;
20dc95c4 JA	211	unsigned long long zone_skip;
e9c047a0	212	enum fio_memtype mem_type;
ebac4655 JA	213	unsigned int stonewall;
ebac4655 JA	214	unsigned int numjobs;
ebac4655 JA	215	unsigned int iodepth;
ebac4655 JA	216	os_cpu_mask_t cpumask;
aea47d44	217	unsigned int iolog;
843a7413 JA	218	unsigned int read_iolog;
843a7413 JA	219	unsigned int write_iolog;
a6ccc7be JA	220	unsigned int rwmixcycle;
a6ccc7be JA	221	unsigned int rwmixread;
b6f4d880	222	unsigned int nice;
aea47d44	223
ef899b63	224	char *iolog_file;
843a7413 JA	225	void *iolog_buf;
843a7413 JA	226	FILE *iolog_f;
ebac4655	227
da86774e	228	char *sysfs_root;
da86774e JA	229	char *ioscheduler;
da86774e JA	230
6dfd46b9 JA	231	os_random_state_t bsrange_state;
6dfd46b9 JA	232	os_random_state_t verify_state;
ebac4655 JA	233
	234	int shm_id;
	235
e9c047a0 JA	236	/*
	237	* IO engine hooks, contains everything needed to submit an io_u
	238	* to any of the available IO engines.
	239	*/
2866c82d	240	struct ioengine_ops *io_ops;
ebac4655	241
e9c047a0 JA	242	/*
	243	* Current IO depth and list of free and busy io_u's.
	244	*/
ebac4655 JA	245	unsigned int cur_depth;
	246	struct list_head io_u_freelist;
	247	struct list_head io_u_busylist;
	248
e9c047a0 JA	249	/*
	250	* Rate state
	251	*/
ebac4655 JA	252	unsigned int rate;
	253	unsigned int ratemin;
	254	unsigned int ratecycle;
	255	unsigned long rate_usec_cycle;
	256	long rate_pending_usleep;
	257	unsigned long rate_bytes;
	258	struct timeval lastrate;
	259
	260	unsigned long runtime[2]; /* msec */
	261	unsigned long long io_size;
53cdc686 JA	262	unsigned long long total_file_size;
53cdc686 JA	263	unsigned long long start_offset;
ebac4655 JA	264	unsigned long long total_io_size;
ebac4655 JA	265
9104f874 JA	266	unsigned long long io_blocks[2];
	267	unsigned long long io_bytes[2];
	268	unsigned long long zone_bytes;
	269	unsigned long long this_io_bytes[2];
bbfd6b00	270	volatile int mutex;
ebac4655	271
e9c047a0 JA	272	/*
	273	* State for random io, a bitmap of blocks done vs not done
	274	*/
6dfd46b9	275	os_random_state_t random_state;
ebac4655	276
b990b5c0 JA	277	/*
	278	* CPU "io" cycle burner
	279	*/
	280	unsigned int cpuload;
	281	unsigned int cpucycle;
	282
ebac4655 JA	283	/*
	284	* bandwidth and latency stats
	285	*/
	286	struct io_stat clat_stat[2]; /* completion latency */
	287	struct io_stat slat_stat[2]; /* submission latency */
	288	struct io_stat bw_stat[2]; /* bandwidth stats */
	289
9104f874	290	unsigned long long stat_io_bytes[2];
ebac4655 JA	291	struct timeval stat_sample_time[2];
	292
	293	struct io_log *slat_log;
	294	struct io_log *clat_log;
	295	struct io_log *bw_log;
	296
	297	struct timeval start; /* start of this loop */
	298	struct timeval epoch; /* time job was started */
	299
e9c047a0 JA	300	/*
	301	* fio system usage accounting
	302	*/
ebac4655 JA	303	struct rusage ru_start;
	304	struct rusage ru_end;
	305	unsigned long usr_time;
	306	unsigned long sys_time;
	307	unsigned long ctx;
	308
e9c047a0 JA	309	/*
	310	* read/write mixed workload state
	311	*/
6dfd46b9	312	os_random_state_t rwmix_state;
a6ccc7be	313	struct timeval rwmix_switch;
e9c047a0	314	enum fio_ddir rwmix_ddir;
a6ccc7be	315
4e0ba8af JA	316	/*
	317	* Pre-run and post-run shell
	318	*/
	319	char *exec_prerun;
	320	char *exec_postrun;
	321
e9c047a0 JA	322	/*
	323	* IO historic logs
	324	*/
ebac4655	325	struct list_head io_hist_list;
aea47d44	326	struct list_head io_log_list;
ebac4655 JA	327	};
ebac4655 JA	328
b990b5c0	329	#define __td_verror(td, err, msg) \
ebac4655 JA	330	do { \
	331	int e = (err); \
	332	(td)->error = e; \
b990b5c0	333	snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, error=%s", __FILE__, __LINE__, (msg)); \
ebac4655 JA	334	} while (0)
ebac4655 JA	335
b990b5c0 JA	336
	337	#define td_verror(td, err) __td_verror((td), (err), strerror((err)))
	338	#define td_vmsg(td, err, msg) __td_verror((td), (err), (msg))
	339
ebac4655	340	extern int rate_quit;
ebac4655 JA	341	extern int exitall_on_terminate;
	342	extern int thread_number;
	343	extern int shm_id;
	344	extern int groupid;
c6ae0a5b	345	extern int terse_output;
eb8bbf48 JA	346	extern FILE *f_out;
eb8bbf48 JA	347	extern FILE *f_err;
c1d5725e	348	extern char *fio_inst_prefix;
53cdc686	349	extern int temp_stall_ts;
ebac4655 JA	350
	351	extern struct thread_data *threads;
	352
ebac4655 JA	353	#define td_read(td) ((td)->ddir == DDIR_READ)
ebac4655 JA	354	#define td_write(td) ((td)->ddir == DDIR_WRITE)
3d60d1ed	355	#define td_rw(td) ((td)->iomix != 0)
ebac4655 JA	356
ebac4655 JA	357	#define BLOCKS_PER_MAP (8 * sizeof(long))
53cdc686 JA	358	#define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->min_bs))
	359	#define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
	360	#define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
ebac4655 JA	361
	362	#define MAX_JOBS (1024)
	363
	364	struct disk_util_stat {
	365	unsigned ios[2];
	366	unsigned merges[2];
	367	unsigned long long sectors[2];
	368	unsigned ticks[2];
	369	unsigned io_ticks;
	370	unsigned time_in_queue;
	371	};
	372
	373	struct disk_util {
	374	struct list_head list;
	375
	376	char *name;
	377	char path[256];
	378	dev_t dev;
	379
	380	struct disk_util_stat dus;
	381	struct disk_util_stat last_dus;
	382
	383	unsigned long msec;
	384	struct timeval time;
	385	};
	386
	387	struct io_completion_data {
	388	int nr; /* input */
	389
	390	int error; /* output */
	391	unsigned long bytes_done[2]; /* output */
	392	};
	393
	394	#define DISK_UTIL_MSEC (250)
	395
6a0106a0 JA	396	#ifndef min
	397	#define min(a, b) ((a) < (b) ? (a) : (b))
	398	#endif
	399
6796209a JA	400	/*
	401	* Log exports
	402	*/
	403	extern int read_iolog_get(struct thread_data , struct io_u );
	404	extern void write_iolog_put(struct thread_data , struct io_u );
	405	extern int init_iolog(struct thread_data *td);
	406	extern void log_io_piece(struct thread_data , struct io_u );
	407	extern void prune_io_piece_log(struct thread_data *);
	408	extern void write_iolog_close(struct thread_data *);
	409
	410	/*
	411	* Logging
	412	*/
	413	extern void add_clat_sample(struct thread_data *, int, unsigned long);
	414	extern void add_slat_sample(struct thread_data *, int, unsigned long);
	415	extern void add_bw_sample(struct thread_data *, int);
	416	extern void show_run_stats(void);
	417	extern void init_disk_util(struct thread_data *);
	418	extern void update_rusage_stat(struct thread_data *);
	419	extern void update_io_ticks(void);
	420	extern void disk_util_timer_arm(void);
8914a9d8 JA	421	extern void setup_log(struct io_log **);
	422	extern void finish_log(struct thread_data , struct io_log , const char *);
	423	extern int setup_rate(struct thread_data *);
6796209a JA	424
	425	/*
	426	* Time functions
	427	*/
263e529f	428	extern void time_init(void);
6796209a JA	429	extern unsigned long utime_since(struct timeval , struct timeval );
	430	extern unsigned long mtime_since(struct timeval , struct timeval );
	431	extern unsigned long mtime_since_now(struct timeval *);
	432	extern unsigned long time_since_now(struct timeval *);
263e529f	433	extern unsigned long mtime_since_genesis(void);
b990b5c0	434	extern void __usec_sleep(unsigned int);
6796209a JA	435	extern void usec_sleep(struct thread_data *, unsigned long);
	436	extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
	437
8914a9d8 JA	438	/*
	439	* Init functions
	440	*/
	441	extern int parse_options(int, char **);
	442	extern int init_random_state(struct thread_data *);
	443
53cdc686 JA	444	/*
	445	* File setup/shutdown
	446	*/
	447	extern void close_files(struct thread_data *);
	448	extern int setup_files(struct thread_data *);
e5b401d4	449	extern int file_invalidate_cache(struct thread_data , struct fio_file );
53cdc686	450
263e529f JA	451	/*
	452	* ETA/status stuff
	453	*/
	454	extern void print_thread_status(void);
	455	extern void print_status_init(int);
	456
	457	/*
	458	* Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
	459	* will never back again. It may cycle between running/verififying/fsyncing.
	460	* Once the thread reaches TD_EXITED, it is just waiting for the core to
	461	* reap it.
	462	*/
	463	enum {
	464	TD_NOT_CREATED = 0,
	465	TD_CREATED,
	466	TD_INITIALIZED,
	467	TD_RUNNING,
	468	TD_VERIFYING,
	469	TD_FSYNCING,
	470	TD_EXITED,
	471	TD_REAPED,
	472	};
	473
e29d1b70 JA	474	/*
	475	* Verify helpers
	476	*/
	477	extern void populate_verify_io_u(struct thread_data , struct io_u );
	478	extern int get_next_verify(struct thread_data td, struct io_u );
a9619d44	479	extern int do_io_u_verify(struct thread_data , struct io_u *);
e29d1b70	480
2f9ade3c JA	481	/*
	482	* Memory helpers
	483	*/
	484	extern int fio_pin_memory(void);
	485	extern void fio_unpin_memory(void);
	486	extern int allocate_io_mem(struct thread_data *);
	487	extern void free_io_mem(struct thread_data *);
	488
10ba535a JA	489	/*
	490	* io unit handling
	491	*/
	492	#define queue_full(td) list_empty(&(td)->io_u_freelist)
	493	extern struct io_u __get_io_u(struct thread_data );
	494	extern struct io_u get_io_u(struct thread_data , struct fio_file *);
	495	extern void put_io_u(struct thread_data , struct io_u );
	496	extern void ios_completed(struct thread_data , struct io_completion_data );
	497	extern void io_completed(struct thread_data , struct io_u , struct io_completion_data *);
	498
	499	/*
	500	* io engine entry points
	501	*/
8c16d840	502	extern int td_io_init(struct thread_data *);
10ba535a JA	503	extern int td_io_prep(struct thread_data , struct io_u );
	504	extern int td_io_queue(struct thread_data , struct io_u );
	505	extern int td_io_sync(struct thread_data , struct fio_file );
	506	extern int td_io_getevents(struct thread_data , int, int, struct timespec );
	507
bbfd6b00 JA	508	/*
	509	* This is a pretty crappy semaphore implementation, but with the use that fio
	510	* has (just signalling start/go conditions), it doesn't have to be better.
	511	* Naturally this would not work for any type of contended semaphore or
	512	* for real locking.
	513	*/
1056eaad	514	static inline void fio_sem_init(volatile int *sem, int val)
bbfd6b00 JA	515	{
	516	*sem = val;
	517	}
	518
1056eaad	519	static inline void fio_sem_down(volatile int *sem)
bbfd6b00 JA	520	{
	521	while (*sem == 0)
	522	usleep(10000);
	523
	524	(*sem)--;
	525	}
	526
1056eaad	527	static inline void fio_sem_up(volatile int *sem)
bbfd6b00 JA	528	{
	529	(*sem)++;
	530	}
	531
3b70d7e5 JA	532	/*
	533	* If logging output to a file, stderr should go to both stderr and f_err
	534	*/
	535	#define log_err(args...) do { \
	536	fprintf(f_err, ##args); \
	537	if (f_err != stderr) \
	538	fprintf(stderr, ##args); \
	539	} while (0)
	540
2866c82d JA	541	struct ioengine_ops {
	542	char name[16];
	543	int version;
	544	int flags;
ea2877a4	545	int (setup)(struct thread_data );
2866c82d JA	546	int (init)(struct thread_data );
	547	int (prep)(struct thread_data , struct io_u *);
	548	int (queue)(struct thread_data , struct io_u *);
	549	int (getevents)(struct thread_data , int, int, struct timespec *);
	550	struct io_u (event)(struct thread_data *, int);
	551	int (cancel)(struct thread_data , struct io_u *);
	552	void (cleanup)(struct thread_data );
53cdc686	553	int (sync)(struct thread_data , struct fio_file *);
2866c82d JA	554	void *data;
	555	void *dlhandle;
	556	};
	557
53cdc686	558	#define FIO_IOOPS_VERSION 2
2866c82d JA	559
	560	extern struct ioengine_ops load_ioengine(struct thread_data , char *);
	561	extern void close_ioengine(struct thread_data *);
	562
	563	/*
	564	* Mark unused variables passed to ops functions as unused, to silence gcc
	565	*/
	566	#define fio_unused __attribute((__unused__))
	567
34572e28 JA	568	#define for_each_td(td, i) \
34572e28 JA	569	for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
53cdc686	570	#define for_each_file(td, f, i) \
34572e28	571	for ((i) = 0, (f) = &(td)->files[0]; (i) < (int) (td)->nr_files; (i)++, (f)++)
53cdc686	572
ebac4655	573	#endif