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

#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 "fio_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"
#include "io_u_queue.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,
	TD_F_COMPRESS		= 128,
	TD_F_NOIO		= 256,
	TD_F_COMPRESS_LOG	= 512,
};

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_SEQ_RAND_READ_OFF,
	FIO_RAND_SEQ_RAND_WRITE_OFF,
	FIO_RAND_SEQ_RAND_TRIM_OFF,
	FIO_RAND_START_DELAY,
	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 subjob_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;

	struct tp_data *tp_data;

	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;
	};
	union {
		os_random_state_t delay_state;
		struct frand_state __delay_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 io_u_ring io_u_requeues;
	struct io_u_queue io_u_freelist;
	struct io_u_queue io_u_all;
	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;
	struct timeval terminate_time;
	unsigned int tv_cache_nr;
	unsigned int tv_cache_mask;
	unsigned int ramp_time_over;

	/*
	 * Time since last latency_window was started
	 */
	struct timeval latency_ts;
	unsigned int latency_qd;
	unsigned int latency_qd_high;
	unsigned int latency_qd_low;
	unsigned int latency_failed;
	uint64_t latency_ios;
	int latency_end_run;

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

	/*
	 * rand/seq mixed workload state
	 */
	union {
		os_random_state_t seq_rand_state[DDIR_RWDIR_CNT];
		struct frand_state __seq_rand_state[DDIR_RWDIR_CNT];
	};

	/*
	 * 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 {								\
		unsigned int ____e = (err);				\
		if ((td)->error)					\
			break;						\
		(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 append_terse_output;
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 int status_interval;
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 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, 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 int parse_dryrun(void);
extern int fio_running_or_pending_io_threads(void);
extern int fio_set_fd_nonblocking(int, const char *);

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_FINISHING,
	TD_EXITED,
	TD_REAPED,
};

extern void td_set_runstate(struct thread_data *, int);
extern int td_bump_runstate(struct thread_data *, int);
extern void td_restore_runstate(struct thread_data *, int);

/*
 * Allow 60 seconds for a job to quit on its own, otherwise reap with
 * a vengeance.
 */
#define FIO_REAP_TIMEOUT	60

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

/*
 * 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 *, int *);
extern int load_blktrace(struct thread_data *, const char *, int);
#endif

/*
 * Latency target helpers
 */
extern void lat_target_check(struct thread_data *);
extern void lat_target_init(struct thread_data *);
extern void lat_target_reset(struct thread_data *);

#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 unsigned int td_min_bs(struct thread_data *td)
{
	unsigned int min_bs;

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

static inline int is_power_of_2(unsigned long 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);

#ifdef FIO_INTERNAL
#define ARRAY_SIZE(x) (sizeof((x)) / (sizeof((x)[0])))
#endif

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,
};

enum {
	FIO_CPUS_SHARED		= 0,
	FIO_CPUS_SPLIT,
};

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