[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 resid;
	unsigned int error;

	unsigned char ddir;

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

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

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

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

	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 rwmixwrite;
	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)

static inline int should_fsync(struct thread_data *td)
{
	if (td->last_was_sync)
		return 0;
	if (td->odirect)
		return 0;
	if (td_write(td) || td_rw(td) || td->override_sync)
		return 1;

	return 0;
}

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 *);
	void *data;
	void *dlhandle;
};

#define FIO_IOOPS_VERSION	3

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