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

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

#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);
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, int);
extern void fill_start_time(struct timeval *);

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