[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 "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_SEQ_RAND_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;

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

	/*
	 * 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 {								\
		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 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);
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

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