[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 "lib/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

#ifdef FIO_HAVE_LIBNUMA
#include <linux/mempolicy.h>
#include <numa.h>

/*
 * "local" is pseudo-policy
 */
#define MPOL_LOCAL MPOL_MAX
#endif

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


enum {
	TD_F_VER_BACKLOG	= 1,
	TD_F_TRIM_BACKLOG	= 2,
	TD_F_READ_IOLOG		= 4,
	TD_F_REFILL_BUFFERS	= 8,
	TD_F_SCRAMBLE_BUFFERS	= 16,
	TD_F_VER_NONE		= 32,
	TD_F_PROFILE_OPS	= 64,
};

/*
 * This describes a single thread/process executing a fio job.
 */
struct thread_data {
	struct thread_options o;
	unsigned long flags;
	void *eo;
	char verror[FIO_VERROR_SIZE];
	pthread_t thread;
	unsigned int thread_number;
	unsigned 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[DDIR_RWDIR_CNT];
	struct timeval bw_sample_time;

	uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
	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 sig;
	int done;
	pid_t pid;
	char *orig_buffer;
	size_t orig_buffer_size;
	volatile int terminate;
	volatile int runstate;
	unsigned int last_was_sync;
	enum fio_ddir last_ddir;

	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[DDIR_RWDIR_CNT];
	long rate_pending_usleep[DDIR_RWDIR_CNT];
	unsigned long rate_bytes[DDIR_RWDIR_CNT];
	unsigned long rate_blocks[DDIR_RWDIR_CNT];
	struct timeval lastrate[DDIR_RWDIR_CNT];

	unsigned long long total_io_size;
	unsigned long long fill_device_size;

	unsigned long io_issues[DDIR_RWDIR_CNT];
	unsigned long long io_blocks[DDIR_RWDIR_CNT];
	unsigned long long this_io_blocks[DDIR_RWDIR_CNT];
	unsigned long long io_bytes[DDIR_RWDIR_CNT];
	unsigned long long io_skip_bytes;
	unsigned long long this_io_bytes[DDIR_RWDIR_CNT];
	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;

	void *pinned_mem;
};

/*
 * 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 stat_number;
extern int shm_id;
extern int groupid;
extern int output_format;
extern int temp_stall_ts;
extern uintptr_t 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 REAL_MAX_JOBS		2048

static inline enum error_type_bit td_error_type(enum fio_ddir ddir, int err)
{
	if (err == EILSEQ)
		return ERROR_TYPE_VERIFY_BIT;
	if (ddir == DDIR_READ)
		return ERROR_TYPE_READ_BIT;
	return ERROR_TYPE_WRITE_BIT;
}

static int __NON_FATAL_ERR[] = {EIO, EILSEQ};
static inline int td_non_fatal_error(struct thread_data *td,
				     enum error_type_bit etype, int err)
{
	int i;
	if (!td->o.ignore_error[etype]) {
		td->o.ignore_error[etype] = __NON_FATAL_ERR;
		td->o.ignore_error_nr[etype] = sizeof(__NON_FATAL_ERR)
			/ sizeof(int);
	}

	if (!(td->o.continue_on_error & (1 << etype)))
		return 0;
	for (i = 0; i < td->o.ignore_error_nr[etype]; i++)
		if (td->o.ignore_error[etype][i] == err)
			return 1;
	return 0;
}

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);
extern char *fio_uint_to_kmg(unsigned int val);

/*
 * 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_SETTING_UP,
	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(struct thread_data *);
extern void fio_unpin_memory(struct thread_data *);
extern int __must_check allocate_io_mem(struct thread_data *);
extern void free_io_mem(struct thread_data *);
extern void free_threads_shm(void);

/*
 * 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[DDIR_READ])
		ret |= __should_check_rate(td, DDIR_READ);
	if (bytes_done[DDIR_WRITE])
		ret |= __should_check_rate(td, DDIR_WRITE);
	if (bytes_done[DDIR_TRIM])
		ret |= __should_check_rate(td, DDIR_TRIM);

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

#define ARRAY_SIZE(x) (sizeof((x)) / (sizeof((x)[0])))

enum {
	FIO_OUTPUT_TERSE	= 0,
	FIO_OUTPUT_JSON,
	FIO_OUTPUT_NORMAL,
};

enum {
	FIO_RAND_DIST_RANDOM	= 0,
	FIO_RAND_DIST_ZIPF,
	FIO_RAND_DIST_PARETO,
};

enum {
	FIO_RAND_GEN_TAUSWORTHE = 0,
	FIO_RAND_GEN_LFSR,
};

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