[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 <string.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;

	void *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 long last_completed_pos;

	unsigned long *file_map;
	unsigned int num_maps;
};

/*
 * This describes a single thread/process executing a fio job.
 */
struct thread_data {
	char *name;
	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 int sequential;
	unsigned int odirect;
	unsigned int invalidate_cache;
	unsigned int create_serialize;
	unsigned int create_fsync;
	unsigned int end_fsync;
	unsigned int sync_io;
	unsigned int verify;
	unsigned int use_thread;
	unsigned int unlink;
	unsigned int do_disk_util;
	unsigned int override_sync;
	unsigned int rand_repeatable;
	unsigned int write_lat_log;
	unsigned int write_bw_log;
	unsigned int norandommap;
	unsigned int bs_unaligned;

	unsigned int bs[2];
	unsigned int min_bs[2];
	unsigned int max_bs[2];
	unsigned int rw_min_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 rwmixcycle;
	unsigned int rwmixread;
	unsigned int rwmixwrite;
	unsigned int nice;

	char *read_iolog_file;
	char *write_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 */
	struct timeval end_time;/* time job ended */

	/*
	 * 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 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 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)->rw_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 */
	struct timeval time;		/* output */
};

#define DISK_UTIL_MSEC	(250)

#ifndef min
#define min(a, b)	((a) < (b) ? (a) : (b))
#endif
#ifndef max
#define max(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, struct timeval *);
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 unsigned long utime_since(struct timeval *, struct timeval *);
extern unsigned long utime_since_now(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, int);
extern void fill_start_time(struct timeval *);
extern void fio_gettime(struct timeval *, void *);

/*
 * 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 open_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 {
	struct list_head list;
	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 *, const char *);
extern int register_ioengine(struct ioengine_ops *);
extern void unregister_ioengine(struct ioengine_ops *);
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 fio_init	__attribute__((constructor))
#define fio_exit	__attribute__((destructor))

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