Add support for trim as a workload type
[fio.git] / fio.h
diff --git a/fio.h b/fio.h
index ba6806757df21601a02eee747a506335e5bdb1f6..0064a1d086fb2f42aea6c6fbe408fafd75bcaa5b 100644 (file)
--- a/fio.h
+++ b/fio.h
@@ -33,10 +33,12 @@ struct thread_data;
 #include "options.h"
 #include "profile.h"
 #include "time.h"
+#include "gettime.h"
 #include "lib/getopt.h"
 #include "lib/rand.h"
 #include "server.h"
 #include "stat.h"
+#include "flow.h"
 
 #ifdef FIO_HAVE_GUASI
 #include <guasi.h>
@@ -65,6 +67,17 @@ enum {
        RW_SEQ_IDENT,
 };
 
+/*
+ * What type of errors to continue on when continue_on_error is used
+ */
+enum error_type {
+        ERROR_TYPE_NONE = 0,
+        ERROR_TYPE_READ = 1 << 0,
+        ERROR_TYPE_WRITE = 1 << 1,
+        ERROR_TYPE_VERIFY = 1 << 2,
+        ERROR_TYPE_ANY = 0xffff,
+};
+
 struct bssplit {
        unsigned int bs;
        unsigned char perc;
@@ -95,12 +108,12 @@ struct thread_options {
        unsigned long long file_size_high;
        unsigned long long start_offset;
 
-       unsigned int bs[2];
-       unsigned int ba[2];
-       unsigned int min_bs[2];
-       unsigned int max_bs[2];
-       struct bssplit *bssplit[2];
-       unsigned int bssplit_nr[2];
+       unsigned int bs[DDIR_RWDIR_CNT];
+       unsigned int ba[DDIR_RWDIR_CNT];
+       unsigned int min_bs[DDIR_RWDIR_CNT];
+       unsigned int max_bs[DDIR_RWDIR_CNT];
+       struct bssplit *bssplit[DDIR_RWDIR_CNT];
+       unsigned int bssplit_nr[DDIR_RWDIR_CNT];
 
        unsigned int nr_files;
        unsigned int open_files;
@@ -112,6 +125,7 @@ struct thread_options {
        unsigned int create_serialize;
        unsigned int create_fsync;
        unsigned int create_on_open;
+       unsigned int create_only;
        unsigned int end_fsync;
        unsigned int pre_read;
        unsigned int sync_io;
@@ -136,6 +150,7 @@ struct thread_options {
        unsigned int write_lat_log;
        unsigned int write_bw_log;
        unsigned int write_iops_log;
+       unsigned int log_avg_msec;
        unsigned int norandommap;
        unsigned int softrandommap;
        unsigned int bs_unaligned;
@@ -156,6 +171,7 @@ struct thread_options {
        unsigned int bw_avg_time;
        unsigned int iops_avg_time;
        unsigned int loops;
+       unsigned long long zone_range;
        unsigned long long zone_size;
        unsigned long long zone_skip;
        enum fio_memtype mem_type;
@@ -179,6 +195,8 @@ struct thread_options {
        unsigned int zero_buffers;
        unsigned int refill_buffers;
        unsigned int scramble_buffers;
+       unsigned int compress_percentage;
+       unsigned int compress_chunk;
        unsigned int time_based;
        unsigned int disable_lat;
        unsigned int disable_clat;
@@ -210,11 +228,11 @@ struct thread_options {
        char *exec_prerun;
        char *exec_postrun;
 
-       unsigned int rate[2];
-       unsigned int ratemin[2];
+       unsigned int rate[DDIR_RWDIR_CNT];
+       unsigned int ratemin[DDIR_RWDIR_CNT];
        unsigned int ratecycle;
-       unsigned int rate_iops[2];
-       unsigned int rate_iops_min[2];
+       unsigned int rate_iops[DDIR_RWDIR_CNT];
+       unsigned int rate_iops_min[DDIR_RWDIR_CNT];
 
        char *ioscheduler;
 
@@ -227,7 +245,7 @@ struct thread_options {
        /*
         * I/O Error handling
         */
-       unsigned int continue_on_error;
+       enum error_type continue_on_error;
 
        /*
         * Benchmark profile type
@@ -244,9 +262,14 @@ struct thread_options {
        unsigned int uid;
        unsigned int gid;
 
-       unsigned int sync_file_range;
+       int flow_id;
+       int flow;
+       int flow_watermark;
+       unsigned int flow_sleep;
+
+       unsigned long long offset_increment;
 
-       unsigned int userspace_libaio_reap;
+       unsigned int sync_file_range;
 };
 
 /*
@@ -254,6 +277,7 @@ struct thread_options {
  */
 struct thread_data {
        struct thread_options o;
+       void *eo;
        char verror[FIO_VERROR_SIZE];
        pthread_t thread;
        int thread_number;
@@ -266,10 +290,10 @@ struct thread_data {
        struct io_log *bw_log;
        struct io_log *iops_log;
 
-       uint64_t stat_io_bytes[2];
+       uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
        struct timeval bw_sample_time;
 
-       uint64_t stat_io_blocks[2];
+       uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
        struct timeval iops_sample_time;
 
        struct rusage ru_start;
@@ -287,6 +311,7 @@ struct thread_data {
                struct frand_state __next_file_state;
        };
        int error;
+       int sig;
        int done;
        pid_t pid;
        char *orig_buffer;
@@ -335,10 +360,23 @@ struct thread_data {
        struct ioengine_ops *io_ops;
 
        /*
-        * Current IO depth and list of free and busy io_u's.
+        * 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;
@@ -357,21 +395,21 @@ struct thread_data {
        /*
         * Rate state
         */
-       unsigned long rate_nsec_cycle[2];
-       long rate_pending_usleep[2];
-       unsigned long rate_bytes[2];
-       unsigned long rate_blocks[2];
-       struct timeval lastrate[2];
+       unsigned long long rate_bps[DDIR_RWDIR_CNT];
+       long rate_pending_usleep[DDIR_RWDIR_CNT];
+       unsigned long rate_bytes[DDIR_RWDIR_CNT];
+       unsigned long rate_blocks[DDIR_RWDIR_CNT];
+       struct timeval lastrate[DDIR_RWDIR_CNT];
 
        unsigned long long total_io_size;
        unsigned long long fill_device_size;
 
-       unsigned long io_issues[2];
-       unsigned long long io_blocks[2];
-       unsigned long long this_io_blocks[2];
-       unsigned long long io_bytes[2];
+       unsigned long io_issues[DDIR_RWDIR_CNT];
+       unsigned long long io_blocks[DDIR_RWDIR_CNT];
+       unsigned long long this_io_blocks[DDIR_RWDIR_CNT];
+       unsigned long long io_bytes[DDIR_RWDIR_CNT];
        unsigned long long io_skip_bytes;
-       unsigned long long this_io_bytes[2];
+       unsigned long long this_io_bytes[DDIR_RWDIR_CNT];
        unsigned long long zone_bytes;
        struct fio_mutex *mutex;
 
@@ -444,6 +482,8 @@ struct thread_data {
        unsigned int total_err_count;
        int first_error;
 
+       struct fio_flow *flow;
+
        /*
         * Can be overloaded by profiles
         */
@@ -482,14 +522,14 @@ enum {
 #define __fio_stringify(x)     __fio_stringify_1(x)
 
 extern int exitall_on_terminate;
-extern int thread_number;
-extern int nr_process, nr_thread;
+extern unsigned int thread_number;
+extern unsigned int nr_process, nr_thread;
 extern int shm_id;
 extern int groupid;
 extern int terse_output;
 extern int temp_stall_ts;
 extern unsigned long long mlock_size;
-extern unsigned long page_mask, page_size;
+extern uintptr_t page_mask, page_size;
 extern int read_only;
 extern int eta_print;
 extern unsigned long done_secs;
@@ -502,6 +542,7 @@ extern int terse_version;
 extern int is_backend;
 extern int nr_clients;
 extern int log_syslog;
+extern const char fio_version_string[];
 extern const fio_fp64_t def_percentile_list[FIO_IO_U_LIST_MAX_LEN];
 
 extern struct thread_data *threads;
@@ -520,6 +561,15 @@ static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
 
 #define td_non_fatal_error(e)  ((e) == EIO || (e) == EILSEQ)
 
+static inline enum error_type td_error_type(enum fio_ddir ddir, int err)
+{
+       if (err == EILSEQ)
+               return ERROR_TYPE_VERIFY;
+       if (ddir == DDIR_READ)
+               return ERROR_TYPE_READ;
+       return ERROR_TYPE_WRITE;
+}
+
 static inline void update_error_count(struct thread_data *td, int err)
 {
        td->total_err_count++;
@@ -545,21 +595,26 @@ static inline int should_fsync(struct thread_data *td)
 extern int __must_check parse_options(int, char **);
 extern int parse_jobs_ini(char *, int, int);
 extern int parse_cmd_line(int, char **);
-extern int exec_run(void);
+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 options_mem_dupe(struct thread_data *);
-extern void options_mem_free(struct thread_data *);
+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 **);
 extern char *num2str(unsigned long, int, int, int);
+extern int ioengine_load(struct thread_data *);
 
-#define FIO_GETOPT_JOB         0x89988998
+#define FIO_GETOPT_JOB         0x89000000
+#define FIO_GETOPT_IOENGINE    0x98000000
 #define FIO_NR_OPTIONS         (FIO_MAX_OPTS + 128)
 
 /*
@@ -666,10 +721,12 @@ static inline int should_check_rate(struct thread_data *td,
 {
        int ret = 0;
 
-       if (bytes_done[0])
-               ret |= __should_check_rate(td, 0);
-       if (bytes_done[1])
-               ret |= __should_check_rate(td, 1);
+       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;
 }
@@ -701,4 +758,7 @@ static inline void td_io_u_free_notify(struct thread_data *td)
                pthread_cond_signal(&td->free_cond);
 }
 
+extern const char *fio_get_arch_string(int);
+extern const char *fio_get_os_string(int);
+
 #endif