[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 "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 "lib/rbtree.h"
#include "client.h"
#include "server.h"
#include "stat.h"
#include "flow.h"

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

#ifdef CONFIG_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,
};

enum {
	FIO_RAND_BS_OFF		= 0,
	FIO_RAND_VER_OFF,
	FIO_RAND_MIX_OFF,
	FIO_RAND_FILE_OFF,
	FIO_RAND_BLOCK_OFF,
	FIO_RAND_FILE_SIZE_OFF,
	FIO_RAND_TRIM_OFF,
	FIO_RAND_BUF_OFF,
	FIO_RAND_NR_OFFS,
};

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

	volatile int update_rusage;
	struct fio_mutex *rusage_sem;
	struct rusage ru_start;
	struct rusage ru_end;

	struct fio_file **files;
	unsigned char *file_locks;
	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[FIO_RAND_NR_OFFS];

	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
	 */
	uint64_t 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];

	uint64_t total_io_size;
	uint64_t fill_device_size;

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

	struct flist_head next_rand_list;

	/*
	 * 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), "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 int eta_new_line;
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 fio_clock_source_set;
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 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)
{
	unsigned 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_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, int);
extern int ioengine_load(struct thread_data *);

extern uintptr_t page_mask;
extern uintptr_t 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,
				    uint64_t *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 unsigned int td_max_bs(struct thread_data *td)
{
	unsigned int max_bs;

	max_bs = max(td->o.max_bs[DDIR_READ], td->o.max_bs[DDIR_WRITE]);
	return max(td->o.max_bs[DDIR_TRIM], max_bs);
}

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