[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 <inttypes.h>
#include <assert.h>

struct thread_data;

#include "compiler/compiler.h"
#include "thread_options.h"
#include "flist.h"
#include "fifo.h"
#include "rbtree.h"
#include "arch/arch.h"
#include "os/os.h"
#include "mutex.h"
#include "log.h"
#include "debug.h"
#include "file.h"
#include "io_ddir.h"
#include "ioengine.h"
#include "iolog.h"
#include "helpers.h"
#include "options.h"
#include "profile.h"
#include "time.h"
#include "gettime.h"
#include "lib/getopt.h"
#include "lib/rand.h"
#include "client.h"
#include "server.h"
#include "stat.h"
#include "flow.h"

#ifdef FIO_HAVE_GUASI
#include <guasi.h>
#endif

#ifdef FIO_HAVE_SOLARISAIO
#include <sys/asynch.h>
#endif

/*
 * offset generator types
 */
enum {
	RW_SEQ_SEQ	= 0,
	RW_SEQ_IDENT,
};

/*
 * This describes a single thread/process executing a fio job.
 */
struct thread_data {
	struct thread_options o;
	void *eo;
	char verror[FIO_VERROR_SIZE];
	pthread_t thread;
	int thread_number;
	int groupid;
	struct thread_stat ts;

	int client_type;

	struct io_log *slat_log;
	struct io_log *clat_log;
	struct io_log *lat_log;
	struct io_log *bw_log;
	struct io_log *iops_log;

	uint64_t stat_io_bytes[2];
	struct timeval bw_sample_time;

	uint64_t stat_io_blocks[2];
	struct timeval iops_sample_time;

	struct rusage ru_start;
	struct rusage ru_end;

	struct fio_file **files;
	unsigned int files_size;
	unsigned int files_index;
	unsigned int nr_open_files;
	unsigned int nr_done_files;
	unsigned int nr_normal_files;
	union {
		unsigned int next_file;
		os_random_state_t next_file_state;
		struct frand_state __next_file_state;
	};
	int error;
	int done;
	pid_t pid;
	char *orig_buffer;
	size_t orig_buffer_size;
	volatile int terminate;
	volatile int runstate;
	unsigned int ioprio;
	unsigned int ioprio_set;
	unsigned int last_was_sync;
	enum fio_ddir last_ddir;

	char *mmapfile;
	int mmapfd;

	void *iolog_buf;
	FILE *iolog_f;

	char *sysfs_root;

	unsigned long rand_seeds[8];

	union {
		os_random_state_t bsrange_state;
		struct frand_state __bsrange_state;
	};
	union {
		os_random_state_t verify_state;
		struct frand_state __verify_state;
	};
	union {
		os_random_state_t trim_state;
		struct frand_state __trim_state;
	};

	struct frand_state buf_state;

	unsigned int verify_batch;
	unsigned int trim_batch;

	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;

	/*
	 * Queue depth of io_u's that fio MIGHT do
	 */
	unsigned int cur_depth;

	/*
	 * io_u's about to be committed
	 */
	unsigned int io_u_queued;

	/*
	 * io_u's submitted but not completed yet
	 */
	unsigned int io_u_in_flight;

	/*
	 * List of free and busy io_u's
	 */
	struct flist_head io_u_freelist;
	struct flist_head io_u_busylist;
	struct flist_head io_u_requeues;
	pthread_mutex_t io_u_lock;
	pthread_cond_t free_cond;

	/*
	 * async verify offload
	 */
	struct flist_head verify_list;
	pthread_t *verify_threads;
	unsigned int nr_verify_threads;
	pthread_cond_t verify_cond;
	int verify_thread_exit;

	/*
	 * Rate state
	 */
	unsigned long long rate_bps[2];
	long rate_pending_usleep[2];
	unsigned long rate_bytes[2];
	unsigned long rate_blocks[2];
	struct timeval lastrate[2];

	unsigned long long total_io_size;
	unsigned long long fill_device_size;

	unsigned long io_issues[2];
	unsigned long long io_blocks[2];
	unsigned long long this_io_blocks[2];
	unsigned long long io_bytes[2];
	unsigned long long io_skip_bytes;
	unsigned long long this_io_bytes[2];
	unsigned long long zone_bytes;
	struct fio_mutex *mutex;

	/*
	 * State for random io, a bitmap of blocks done vs not done
	 */
	union {
		os_random_state_t random_state;
		struct frand_state __random_state;
	};

	struct timeval start;	/* start of this loop */
	struct timeval epoch;	/* time job was started */
	struct timeval last_issue;
	struct timeval tv_cache;
	unsigned int tv_cache_nr;
	unsigned int tv_cache_mask;
	unsigned int ramp_time_over;

	/*
	 * read/write mixed workload state
	 */
	union {
		os_random_state_t rwmix_state;
		struct frand_state __rwmix_state;
	};
	unsigned long rwmix_issues;
	enum fio_ddir rwmix_ddir;
	unsigned int ddir_seq_nr;

	/*
	 * IO history logs for verification. We use a tree for sorting,
	 * if we are overwriting. Otherwise just use a fifo.
	 */
	struct rb_root io_hist_tree;
	struct flist_head io_hist_list;
	unsigned long io_hist_len;

	/*
	 * For IO replaying
	 */
	struct flist_head io_log_list;

	/*
	 * For tracking/handling discards
	 */
	struct flist_head trim_list;
	unsigned long trim_entries;

	/*
	 * for fileservice, how often to switch to a new file
	 */
	unsigned int file_service_nr;
	unsigned int file_service_left;
	struct fio_file *file_service_file;

	unsigned int sync_file_range_nr;

	/*
	 * For generating file sizes
	 */
	union {
		os_random_state_t file_size_state;
		struct frand_state __file_size_state;
	};

	/*
	 * Error counts
	 */
	unsigned int total_err_count;
	int first_error;

	struct fio_flow *flow;

	/*
	 * Can be overloaded by profiles
	 */
	struct prof_io_ops prof_io_ops;
	void *prof_data;
};

/*
 * when should interactive ETA output be generated
 */
enum {
	FIO_ETA_AUTO,
	FIO_ETA_ALWAYS,
	FIO_ETA_NEVER,
};

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


#define td_clear_error(td)		\
	(td)->error = 0;
#define td_verror(td, err, func)	\
	__td_verror((td), (err), strerror((err)), (func))
#define td_vmsg(td, err, msg, func)	\
	__td_verror((td), (err), (msg), (func))

#define __fio_stringify_1(x)	#x
#define __fio_stringify(x)	__fio_stringify_1(x)

extern int exitall_on_terminate;
extern unsigned int thread_number;
extern unsigned int nr_process, nr_thread;
extern int shm_id;
extern int groupid;
extern int terse_output;
extern int temp_stall_ts;
extern unsigned long long mlock_size;
extern unsigned long page_mask, page_size;
extern int read_only;
extern int eta_print;
extern unsigned long done_secs;
extern char *job_section;
extern int fio_gtod_offload;
extern int fio_gtod_cpu;
extern enum fio_cs fio_clock_source;
extern int warnings_fatal;
extern int terse_version;
extern int is_backend;
extern int nr_clients;
extern int log_syslog;
extern const char fio_version_string[];
extern const fio_fp64_t def_percentile_list[FIO_IO_U_LIST_MAX_LEN];

extern struct thread_data *threads;

static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
{
	assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
}

#define BLOCKS_PER_MAP		(8 * sizeof(unsigned long))
#define TO_MAP_BLOCK(f, b)	(b)
#define RAND_MAP_IDX(f, b)	(TO_MAP_BLOCK(f, b) / BLOCKS_PER_MAP)
#define RAND_MAP_BIT(f, b)	(TO_MAP_BLOCK(f, b) & (BLOCKS_PER_MAP - 1))

#define REAL_MAX_JOBS		2048

#define td_non_fatal_error(e)	((e) == EIO || (e) == EILSEQ)

static inline enum error_type td_error_type(enum fio_ddir ddir, int err)
{
	if (err == EILSEQ)
		return ERROR_TYPE_VERIFY;
	if (ddir == DDIR_READ)
		return ERROR_TYPE_READ;
	return ERROR_TYPE_WRITE;
}

static inline void update_error_count(struct thread_data *td, int err)
{
	td->total_err_count++;
	if (td->total_err_count == 1)
		td->first_error = err;
}

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

	return 0;
}

/*
 * Init/option functions
 */
extern int __must_check fio_init_options(void);
extern int __must_check parse_options(int, char **);
extern int parse_jobs_ini(char *, int, int, int);
extern int parse_cmd_line(int, char **, int);
extern int fio_backend(void);
extern void reset_fio_state(void);
extern void clear_io_state(struct thread_data *);
extern int fio_options_parse(struct thread_data *, char **, int);
extern void fio_keywords_init(void);
extern int fio_cmd_option_parse(struct thread_data *, const char *, char *);
extern int fio_cmd_ioengine_option_parse(struct thread_data *, const char *, char *);
extern void fio_fill_default_options(struct thread_data *);
extern int fio_show_option_help(const char *);
extern void fio_options_set_ioengine_opts(struct option *long_options, struct thread_data *td);
extern void fio_options_dup_and_init(struct option *);
extern void fio_options_mem_dupe(struct thread_data *);
extern void options_mem_dupe(void *data, struct fio_option *options);
extern void td_fill_rand_seeds(struct thread_data *);
extern void add_job_opts(const char **, int);
extern char *num2str(unsigned long, int, int, int);
extern int ioengine_load(struct thread_data *);

extern unsigned long page_mask;
extern unsigned long page_size;
extern int initialize_fio(char *envp[]);

#define FIO_GETOPT_JOB		0x89000000
#define FIO_GETOPT_IOENGINE	0x98000000
#define FIO_NR_OPTIONS		(FIO_MAX_OPTS + 128)

/*
 * 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_RAMP,
	TD_RUNNING,
	TD_PRE_READING,
	TD_VERIFYING,
	TD_FSYNCING,
	TD_EXITED,
	TD_REAPED,
};

extern void td_set_runstate(struct thread_data *, int);
#define TERMINATE_ALL		(-1)
extern void fio_terminate_threads(int);

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

/*
 * Reset stats after ramp time completes
 */
extern void reset_all_stats(struct thread_data *);

/*
 * blktrace support
 */
#ifdef FIO_HAVE_BLKTRACE
extern int is_blktrace(const char *);
extern int load_blktrace(struct thread_data *, const char *);
#endif

/*
 * 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)	\
	if ((td)->files_index)						\
		for ((i) = 0, (f) = (td)->files[0];			\
	    	 (i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
		 (i)++)

#define fio_assert(td, cond)	do {	\
	if (!(cond)) {			\
		int *__foo = NULL;	\
		fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond);	\
		td_set_runstate((td), TD_EXITED);	\
		(td)->error = EFAULT;		\
		*__foo = 0;			\
	}	\
} while (0)

static inline int fio_fill_issue_time(struct thread_data *td)
{
	if (td->o.read_iolog_file ||
	    !td->o.disable_clat || !td->o.disable_slat || !td->o.disable_bw)
		return 1;

	return 0;
}

static inline int __should_check_rate(struct thread_data *td,
				      enum fio_ddir ddir)
{
	struct thread_options *o = &td->o;

	/*
	 * If some rate setting was given, we need to check it
	 */
	if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
	    o->rate_iops_min[ddir])
		return 1;

	return 0;
}

static inline int should_check_rate(struct thread_data *td,
				    unsigned long *bytes_done)
{
	int ret = 0;

	if (bytes_done[0])
		ret |= __should_check_rate(td, 0);
	if (bytes_done[1])
		ret |= __should_check_rate(td, 1);

	return ret;
}

static inline int is_power_of_2(unsigned int val)
{
	return (val != 0 && ((val & (val - 1)) == 0));
}

/*
 * We currently only need to do locking if we have verifier threads
 * accessing our internal structures too
 */
static inline void td_io_u_lock(struct thread_data *td)
{
	if (td->o.verify_async)
		pthread_mutex_lock(&td->io_u_lock);
}

static inline void td_io_u_unlock(struct thread_data *td)
{
	if (td->o.verify_async)
		pthread_mutex_unlock(&td->io_u_lock);
}

static inline void td_io_u_free_notify(struct thread_data *td)
{
	if (td->o.verify_async)
		pthread_cond_signal(&td->free_cond);
}

extern const char *fio_get_arch_string(int);
extern const char *fio_get_os_string(int);

#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>
cd14cc10	14	#include <inttypes.h>
7101d9c2	15	#include <assert.h>
ebac4655	16
ecc314ba BC	17	struct thread_data;
ecc314ba BC	18
317b95d0	19	#include "compiler/compiler.h"
ec41265e	20	#include "thread_options.h"
01743ee1	21	#include "flist.h"
e2887563	22	#include "fifo.h"
4b87898e	23	#include "rbtree.h"
317b95d0 JA	24	#include "arch/arch.h"
317b95d0 JA	25	#include "os/os.h"
07739b57	26	#include "mutex.h"
a3d741fa JA	27	#include "log.h"
a3d741fa JA	28	#include "debug.h"
d6aed795 JA	29	#include "file.h"
d6aed795 JA	30	#include "io_ddir.h"
dcefb588	31	#include "ioengine.h"
5995a6a4	32	#include "iolog.h"
c5c8bd5c	33	#include "helpers.h"
07b3232d	34	#include "options.h"
7eb36574	35	#include "profile.h"
c223da83	36	#include "time.h"
a7346816	37	#include "gettime.h"
bf2e821a	38	#include "lib/getopt.h"
2615cc4b	39	#include "lib/rand.h"
dd366728	40	#include "client.h"
37db14fe	41	#include "server.h"
a64e88da	42	#include "stat.h"
9e684a49	43	#include "flow.h"
ebac4655	44
609342ff DL	45	#ifdef FIO_HAVE_GUASI
	46	#include <guasi.h>
	47	#endif
	48
417f0068 JA	49	#ifdef FIO_HAVE_SOLARISAIO
	50	#include <sys/asynch.h>
	51	#endif
	52
38dad62d JA	53	/*
	54	* offset generator types
	55	*/
	56	enum {
	57	RW_SEQ_SEQ = 0,
	58	RW_SEQ_IDENT,
	59	};
	60
2dc1bbeb JA	61	/*
	62	* This describes a single thread/process executing a fio job.
	63	*/
	64	struct thread_data {
	65	struct thread_options o;
de890a1e	66	void *eo;
e4e33258	67	char verror[FIO_VERROR_SIZE];
2dc1bbeb JA	68	pthread_t thread;
	69	int thread_number;
	70	int groupid;
	71	struct thread_stat ts;
7b9f733a	72
46bcd498 JA	73	int client_type;
46bcd498 JA	74
7b9f733a JA	75	struct io_log *slat_log;
	76	struct io_log *clat_log;
	77	struct io_log *lat_log;
	78	struct io_log *bw_log;
c8eeb9df	79	struct io_log *iops_log;
7b9f733a	80
f0505a14	81	uint64_t stat_io_bytes[2];
c8eeb9df JA	82	struct timeval bw_sample_time;
	83
	84	uint64_t stat_io_blocks[2];
	85	struct timeval iops_sample_time;
f0505a14	86
c8aaba19 JA	87	struct rusage ru_start;
	88	struct rusage ru_end;
	89
126d65c6	90	struct fio_file **files;
dd87b2c9	91	unsigned int files_size;
2dc1bbeb JA	92	unsigned int files_index;
2dc1bbeb JA	93	unsigned int nr_open_files;
1020a139	94	unsigned int nr_done_files;
2dc1bbeb JA	95	unsigned int nr_normal_files;
	96	union {
	97	unsigned int next_file;
	98	os_random_state_t next_file_state;
4c07ad86	99	struct frand_state __next_file_state;
2dc1bbeb JA	100	};
2dc1bbeb JA	101	int error;
20e354ef	102	int done;
2dc1bbeb JA	103	pid_t pid;
	104	char *orig_buffer;
	105	size_t orig_buffer_size;
	106	volatile int terminate;
	107	volatile int runstate;
	108	unsigned int ioprio;
ac684785	109	unsigned int ioprio_set;
2dc1bbeb	110	unsigned int last_was_sync;
9e144189	111	enum fio_ddir last_ddir;
2dc1bbeb JA	112
	113	char *mmapfile;
	114	int mmapfd;
	115
843a7413 JA	116	void *iolog_buf;
843a7413 JA	117	FILE *iolog_f;
ebac4655	118
da86774e	119	char *sysfs_root;
da86774e	120
3545a109	121	unsigned long rand_seeds[8];
5bfc35d7	122
4c07ad86 JA	123	union {
	124	os_random_state_t bsrange_state;
	125	struct frand_state __bsrange_state;
	126	};
	127	union {
	128	os_random_state_t verify_state;
	129	struct frand_state __verify_state;
	130	};
	131	union {
	132	os_random_state_t trim_state;
	133	struct frand_state __trim_state;
	134	};
ebac4655	135
3545a109 JA	136	struct frand_state buf_state;
3545a109 JA	137
9e144189	138	unsigned int verify_batch;
0d29de83	139	unsigned int trim_batch;
9e144189	140
ebac4655 JA	141	int shm_id;
ebac4655 JA	142
e9c047a0 JA	143	/*
	144	* IO engine hooks, contains everything needed to submit an io_u
	145	* to any of the available IO engines.
	146	*/
2866c82d	147	struct ioengine_ops *io_ops;
ebac4655	148
e9c047a0	149	/*
422f9e4b	150	* Queue depth of io_u's that fio MIGHT do
e9c047a0	151	*/
ebac4655	152	unsigned int cur_depth;
422f9e4b RM	153
	154	/*
	155	* io_u's about to be committed
	156	*/
d8005759	157	unsigned int io_u_queued;
422f9e4b RM	158
	159	/*
	160	* io_u's submitted but not completed yet
	161	*/
	162	unsigned int io_u_in_flight;
	163
	164	/*
	165	* List of free and busy io_u's
	166	*/
01743ee1 JA	167	struct flist_head io_u_freelist;
	168	struct flist_head io_u_busylist;
	169	struct flist_head io_u_requeues;
e8462bd8 JA	170	pthread_mutex_t io_u_lock;
	171	pthread_cond_t free_cond;
	172
	173	/*
	174	* async verify offload
	175	*/
	176	struct flist_head verify_list;
	177	pthread_t *verify_threads;
	178	unsigned int nr_verify_threads;
	179	pthread_cond_t verify_cond;
	180	int verify_thread_exit;
ebac4655	181
e9c047a0 JA	182	/*
	183	* Rate state
	184	*/
1b8dbf25	185	unsigned long long rate_bps[2];
581e7141 JA	186	long rate_pending_usleep[2];
	187	unsigned long rate_bytes[2];
	188	unsigned long rate_blocks[2];
	189	struct timeval lastrate[2];
ebac4655	190
ebac4655	191	unsigned long long total_io_size;
2e3bd4c2	192	unsigned long long fill_device_size;
ebac4655	193
755200a3	194	unsigned long io_issues[2];
9104f874	195	unsigned long long io_blocks[2];
c8eeb9df	196	unsigned long long this_io_blocks[2];
9104f874	197	unsigned long long io_bytes[2];
48f5abd3	198	unsigned long long io_skip_bytes;
9104f874	199	unsigned long long this_io_bytes[2];
079ad09b	200	unsigned long long zone_bytes;
cdd18ad8	201	struct fio_mutex *mutex;
ebac4655	202
e9c047a0 JA	203	/*
	204	* State for random io, a bitmap of blocks done vs not done
	205	*/
4c07ad86 JA	206	union {
	207	os_random_state_t random_state;
	208	struct frand_state __random_state;
	209	};
ebac4655	210
ebac4655 JA	211	struct timeval start; /* start of this loop */
ebac4655 JA	212	struct timeval epoch; /* time job was started */
a61eddec	213	struct timeval last_issue;
993bf48b JA	214	struct timeval tv_cache;
	215	unsigned int tv_cache_nr;
	216	unsigned int tv_cache_mask;
721938ae	217	unsigned int ramp_time_over;
ebac4655	218
e9c047a0 JA	219	/*
	220	* read/write mixed workload state
	221	*/
4c07ad86 JA	222	union {
	223	os_random_state_t rwmix_state;
	224	struct frand_state __rwmix_state;
	225	};
e4928662	226	unsigned long rwmix_issues;
e9c047a0	227	enum fio_ddir rwmix_ddir;
5736c10d	228	unsigned int ddir_seq_nr;
a6ccc7be	229
e9c047a0	230	/*
8de8f047 JA	231	* IO history logs for verification. We use a tree for sorting,
8de8f047 JA	232	* if we are overwriting. Otherwise just use a fifo.
e9c047a0	233	*/
4b87898e	234	struct rb_root io_hist_tree;
01743ee1	235	struct flist_head io_hist_list;
9e144189	236	unsigned long io_hist_len;
8de8f047 JA	237
	238	/*
	239	* For IO replaying
	240	*/
01743ee1	241	struct flist_head io_log_list;
433afcb4	242
0d29de83 JA	243	/*
	244	* For tracking/handling discards
	245	*/
	246	struct flist_head trim_list;
	247	unsigned long trim_entries;
	248
1907dbc6 JA	249	/*
	250	* for fileservice, how often to switch to a new file
	251	*/
	252	unsigned int file_service_nr;
	253	unsigned int file_service_left;
	254	struct fio_file *file_service_file;
9c60ce64	255
44f29692 JA	256	unsigned int sync_file_range_nr;
44f29692 JA	257
9c60ce64 JA	258	/*
	259	* For generating file sizes
	260	*/
4c07ad86 JA	261	union {
	262	os_random_state_t file_size_state;
	263	struct frand_state __file_size_state;
	264	};
f2bba182 RR	265
	266	/*
	267	* Error counts
	268	*/
	269	unsigned int total_err_count;
	270	int first_error;
15dc1934	271
9e684a49 DE	272	struct fio_flow *flow;
9e684a49 DE	273
15dc1934 JA	274	/*
	275	* Can be overloaded by profiles
	276	*/
7eb36574	277	struct prof_io_ops prof_io_ops;
58c55ba0	278	void *prof_data;
ebac4655 JA	279	};
ebac4655 JA	280
e592a06b AC	281	/*
	282	* when should interactive ETA output be generated
	283	*/
	284	enum {
	285	FIO_ETA_AUTO,
	286	FIO_ETA_ALWAYS,
	287	FIO_ETA_NEVER,
	288	};
	289
e1161c32	290	#define __td_verror(td, err, msg, func) \
ebac4655	291	do { \
19abcd3d JA	292	if ((td)->error) \
19abcd3d JA	293	break; \
ebac4655 JA	294	int e = (err); \
ebac4655 JA	295	(td)->error = e; \
f2bba182 RR	296	if (!(td)->first_error) \
f2bba182 RR	297	snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg)); \
ebac4655 JA	298	} while (0)
ebac4655 JA	299
b990b5c0	300
f2bba182 RR	301	#define td_clear_error(td) \
f2bba182 RR	302	(td)->error = 0;
e1161c32 JA	303	#define td_verror(td, err, func) \
	304	__td_verror((td), (err), strerror((err)), (func))
	305	#define td_vmsg(td, err, msg, func) \
	306	__td_verror((td), (err), (msg), (func))
b990b5c0	307
81179eec JA	308	#define __fio_stringify_1(x) #x
	309	#define __fio_stringify(x) __fio_stringify_1(x)
	310
ebac4655	311	extern int exitall_on_terminate;
11e950bd JA	312	extern unsigned int thread_number;
11e950bd JA	313	extern unsigned int nr_process, nr_thread;
ebac4655 JA	314	extern int shm_id;
ebac4655 JA	315	extern int groupid;
c6ae0a5b	316	extern int terse_output;
53cdc686	317	extern int temp_stall_ts;
1e97cce9	318	extern unsigned long long mlock_size;
cfc99db7	319	extern unsigned long page_mask, page_size;
4241ea8f	320	extern int read_only;
e592a06b	321	extern int eta_print;
d3eeeabc	322	extern unsigned long done_secs;
01f06b63	323	extern char *job_section;
be4ecfdf JA	324	extern int fio_gtod_offload;
be4ecfdf JA	325	extern int fio_gtod_cpu;
c223da83	326	extern enum fio_cs fio_clock_source;
a9523c6f	327	extern int warnings_fatal;
f57a9c59	328	extern int terse_version;
5c341e9a	329	extern int is_backend;
a37f69b7	330	extern int nr_clients;
e46d8091	331	extern int log_syslog;
5e726d0a	332	extern const char fio_version_string[];
802ad4a8	333	extern const fio_fp64_t def_percentile_list[FIO_IO_U_LIST_MAX_LEN];
ebac4655 JA	334
	335	extern struct thread_data *threads;
	336
7101d9c2 JA	337	static inline void fio_ro_check(struct thread_data td, struct io_u io_u)
	338	{
	339	assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
	340	}
	341
0ce8b119	342	#define BLOCKS_PER_MAP (8 * sizeof(unsigned long))
aec2de20 JA	343	#define TO_MAP_BLOCK(f, b) (b)
	344	#define RAND_MAP_IDX(f, b) (TO_MAP_BLOCK(f, b) / BLOCKS_PER_MAP)
	345	#define RAND_MAP_BIT(f, b) (TO_MAP_BLOCK(f, b) & (BLOCKS_PER_MAP - 1))
ebac4655	346
fca70358	347	#define REAL_MAX_JOBS 2048
ebac4655	348
1ec99eea	349	#define td_non_fatal_error(e) ((e) == EIO \|\| (e) == EILSEQ)
f2bba182	350
06842027 SL	351	static inline enum error_type td_error_type(enum fio_ddir ddir, int err)
	352	{
	353	if (err == EILSEQ)
	354	return ERROR_TYPE_VERIFY;
	355	if (ddir == DDIR_READ)
	356	return ERROR_TYPE_READ;
	357	return ERROR_TYPE_WRITE;
	358	}
	359
f2bba182 RR	360	static inline void update_error_count(struct thread_data *td, int err)
	361	{
	362	td->total_err_count++;
	363	if (td->total_err_count == 1)
	364	td->first_error = err;
	365	}
	366
87dc1ab1 JA	367	static inline int should_fsync(struct thread_data *td)
	368	{
	369	if (td->last_was_sync)
	370	return 0;
2dc1bbeb	371	if (td->o.odirect)
87dc1ab1	372	return 0;
2dc1bbeb	373	if (td_write(td) \|\| td_rw(td) \|\| td->o.override_sync)
87dc1ab1 JA	374	return 1;
	375
	376	return 0;
	377	}
	378
8914a9d8	379	/*
214e1eca	380	* Init/option functions
8914a9d8	381	*/
0420ba6a	382	extern int __must_check fio_init_options(void);
72cb971b	383	extern int __must_check parse_options(int, char **);
46bcd498 JA	384	extern int parse_jobs_ini(char *, int, int, int);
46bcd498 JA	385	extern int parse_cmd_line(int, char **, int);
2e1df07d	386	extern int fio_backend(void);
50d16976	387	extern void reset_fio_state(void);
2e1df07d	388	extern void clear_io_state(struct thread_data *);
3b8b7135	389	extern int fio_options_parse(struct thread_data , char *, int);
74929ac2	390	extern void fio_keywords_init(void);
214e1eca	391	extern int fio_cmd_option_parse(struct thread_data , const char , char *);
de890a1e	392	extern int fio_cmd_ioengine_option_parse(struct thread_data , const char , char *);
214e1eca JA	393	extern void fio_fill_default_options(struct thread_data *);
214e1eca JA	394	extern int fio_show_option_help(const char *);
de890a1e	395	extern void fio_options_set_ioengine_opts(struct option long_options, struct thread_data td);
214e1eca	396	extern void fio_options_dup_and_init(struct option *);
de890a1e SL	397	extern void fio_options_mem_dupe(struct thread_data *);
de890a1e SL	398	extern void options_mem_dupe(void data, struct fio_option options);
5bfc35d7	399	extern void td_fill_rand_seeds(struct thread_data *);
46bcd498	400	extern void add_job_opts(const char **, int);
1ec3d69b	401	extern char *num2str(unsigned long, int, int, int);
de890a1e	402	extern int ioengine_load(struct thread_data *);
1ec3d69b	403
e61ca217 JA	404	extern unsigned long page_mask;
	405	extern unsigned long page_size;
	406	extern int initialize_fio(char *envp[]);
	407
de890a1e SL	408	#define FIO_GETOPT_JOB 0x89000000
de890a1e SL	409	#define FIO_GETOPT_IOENGINE 0x98000000
07b3232d	410	#define FIO_NR_OPTIONS (FIO_MAX_OPTS + 128)
8914a9d8	411
263e529f JA	412	/*
	413	* ETA/status stuff
	414	*/
	415	extern void print_thread_status(void);
	416	extern void print_status_init(int);
	417
	418	/*
	419	* Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
	420	* will never back again. It may cycle between running/verififying/fsyncing.
	421	* Once the thread reaches TD_EXITED, it is just waiting for the core to
	422	* reap it.
	423	*/
	424	enum {
	425	TD_NOT_CREATED = 0,
	426	TD_CREATED,
	427	TD_INITIALIZED,
b29ee5b3	428	TD_RAMP,
263e529f	429	TD_RUNNING,
b0f65863	430	TD_PRE_READING,
263e529f JA	431	TD_VERIFYING,
	432	TD_FSYNCING,
	433	TD_EXITED,
	434	TD_REAPED,
	435	};
	436
b29ee5b3	437	extern void td_set_runstate(struct thread_data *, int);
cc0df00a JA	438	#define TERMINATE_ALL (-1)
cc0df00a JA	439	extern void fio_terminate_threads(int);
b29ee5b3	440
2f9ade3c JA	441	/*
	442	* Memory helpers
	443	*/
b2fdda43	444	extern int __must_check fio_pin_memory(void);
2f9ade3c	445	extern void fio_unpin_memory(void);
b2fdda43	446	extern int __must_check allocate_io_mem(struct thread_data *);
2f9ade3c JA	447	extern void free_io_mem(struct thread_data *);
2f9ade3c JA	448
b29ee5b3 JA	449	/*
	450	* Reset stats after ramp time completes
	451	*/
	452	extern void reset_all_stats(struct thread_data *);
	453
fb7b71a3 JA	454	/*
	455	* blktrace support
	456	*/
5e62c22a	457	#ifdef FIO_HAVE_BLKTRACE
fb7b71a3 JA	458	extern int is_blktrace(const char *);
fb7b71a3 JA	459	extern int load_blktrace(struct thread_data , const char );
5e62c22a	460	#endif
fb7b71a3	461
2866c82d JA	462	/*
	463	* Mark unused variables passed to ops functions as unused, to silence gcc
	464	*/
	465	#define fio_unused __attribute((__unused__))
5f350952 JA	466	#define fio_init __attribute__((constructor))
5f350952 JA	467	#define fio_exit __attribute__((destructor))
2866c82d	468
34572e28 JA	469	#define for_each_td(td, i) \
34572e28 JA	470	for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
53cdc686	471	#define for_each_file(td, f, i) \
691c8fb0 JA	472	if ((td)->files_index) \
	473	for ((i) = 0, (f) = (td)->files[0]; \
	474	(i) < (td)->o.nr_files && ((f) = (td)->files[i]) != NULL; \
	475	(i)++)
53cdc686	476
0032bf9f JA	477	#define fio_assert(td, cond) do { \
0032bf9f JA	478	if (!(cond)) { \
340fd243	479	int *__foo = NULL; \
0032bf9f	480	fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond); \
ac18ea38	481	td_set_runstate((td), TD_EXITED); \
437c9b71	482	(td)->error = EFAULT; \
340fd243	483	*__foo = 0; \
0032bf9f JA	484	} \
	485	} while (0)
	486
12d9d841 JA	487	static inline int fio_fill_issue_time(struct thread_data *td)
	488	{
	489	if (td->o.read_iolog_file \|\|
	490	!td->o.disable_clat \|\| !td->o.disable_slat \|\| !td->o.disable_bw)
	491	return 1;
	492
	493	return 0;
	494	}
	495
581e7141 JA	496	static inline int __should_check_rate(struct thread_data *td,
	497	enum fio_ddir ddir)
	498	{
	499	struct thread_options *o = &td->o;
	500
	501	/*
	502	* If some rate setting was given, we need to check it
	503	*/
	504	if (o->rate[ddir] \|\| o->ratemin[ddir] \|\| o->rate_iops[ddir] \|\|
	505	o->rate_iops_min[ddir])
	506	return 1;
	507
	508	return 0;
	509	}
	510
	511	static inline int should_check_rate(struct thread_data *td,
	512	unsigned long *bytes_done)
	513	{
	514	int ret = 0;
	515
	516	if (bytes_done[0])
	517	ret \|= __should_check_rate(td, 0);
	518	if (bytes_done[1])
	519	ret \|= __should_check_rate(td, 1);
	520
	521	return ret;
	522	}
	523
d529ee19 JA	524	static inline int is_power_of_2(unsigned int val)
	525	{
	526	return (val != 0 && ((val & (val - 1)) == 0));
	527	}
	528
e8462bd8 JA	529	/*
	530	* We currently only need to do locking if we have verifier threads
	531	* accessing our internal structures too
	532	*/
	533	static inline void td_io_u_lock(struct thread_data *td)
	534	{
	535	if (td->o.verify_async)
	536	pthread_mutex_lock(&td->io_u_lock);
	537	}
	538
	539	static inline void td_io_u_unlock(struct thread_data *td)
	540	{
	541	if (td->o.verify_async)
	542	pthread_mutex_unlock(&td->io_u_lock);
	543	}
	544
	545	static inline void td_io_u_free_notify(struct thread_data *td)
	546	{
	547	if (td->o.verify_async)
	548	pthread_cond_signal(&td->free_cond);
	549	}
	550
cca84643 JA	551	extern const char *fio_get_arch_string(int);
	552	extern const char *fio_get_os_string(int);
	553
ebac4655	554	#endif