blob: 8c67fccb8d3dcea029ea3710874efb9c63e2876c [file] [log] [blame]
#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"
#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,
};
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 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;
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