Merge branch 'epoch' of https://github.com/cronburg/fio
[fio.git] / fio.h
diff --git a/fio.h b/fio.h
index 4d4af0a7917f12b5b666ca38ea06a038659dc3b3..df4fbb16da9d4ab7dec15870c3e6826d50c329dc 100644 (file)
--- a/fio.h
+++ b/fio.h
@@ -32,7 +32,7 @@
 #include "profile.h"
 #include "fio_time.h"
 #include "gettime.h"
-#include "lib/getopt.h"
+#include "oslib/getopt.h"
 #include "lib/rand.h"
 #include "lib/rbtree.h"
 #include "client.h"
@@ -40,6 +40,7 @@
 #include "stat.h"
 #include "flow.h"
 #include "io_u_queue.h"
+#include "workqueue.h"
 
 #ifdef CONFIG_SOLARISAIO
 #include <sys/asynch.h>
@@ -64,15 +65,21 @@ enum {
 };
 
 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_VER_BACKLOG        = 1U << 0,
+       TD_F_TRIM_BACKLOG       = 1U << 1,
+       TD_F_READ_IOLOG         = 1U << 2,
+       TD_F_REFILL_BUFFERS     = 1U << 3,
+       TD_F_SCRAMBLE_BUFFERS   = 1U << 4,
+       TD_F_VER_NONE           = 1U << 5,
+       TD_F_PROFILE_OPS        = 1U << 6,
+       TD_F_COMPRESS           = 1U << 7,
+       TD_F_NOIO               = 1U << 8,
+       TD_F_COMPRESS_LOG       = 1U << 9,
+       TD_F_VSTATE_SAVED       = 1U << 10,
+       TD_F_NEED_LOCK          = 1U << 11,
+       TD_F_CHILD              = 1U << 12,
+       TD_F_NO_PROGRESS        = 1U << 13,
+       TD_F_REGROW_LOGS        = 1U << 14,
 };
 
 enum {
@@ -88,19 +95,44 @@ enum {
        FIO_RAND_SEQ_RAND_WRITE_OFF,
        FIO_RAND_SEQ_RAND_TRIM_OFF,
        FIO_RAND_START_DELAY,
+       FIO_DEDUPE_OFF,
+       FIO_RAND_POISSON_OFF,
+       FIO_RAND_ZONE_OFF,
        FIO_RAND_NR_OFFS,
 };
 
+enum {
+       IO_MODE_INLINE = 0,
+       IO_MODE_OFFLOAD = 1,
+
+       RATE_PROCESS_LINEAR = 0,
+       RATE_PROCESS_POISSON = 1,
+};
+
+/*
+ * Per-thread/process specific data. Only used for the network client
+ * for now.
+ */
+struct sk_out;
+void sk_out_assign(struct sk_out *);
+void sk_out_drop(void);
+
+struct zone_split_index {
+       uint8_t size_perc;
+       uint8_t size_perc_prev;
+};
+
 /*
  * This describes a single thread/process executing a fio job.
  */
 struct thread_data {
-       struct thread_options o;
+       struct flist_head opt_list;
        unsigned long flags;
+       struct thread_options o;
        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;
 
@@ -108,10 +140,15 @@ struct thread_data {
 
        struct io_log *slat_log;
        struct io_log *clat_log;
+       struct io_log *clat_hist_log;
        struct io_log *lat_log;
        struct io_log *bw_log;
        struct io_log *iops_log;
 
+       struct workqueue log_compress_wq;
+
+       struct thread_data *parent;
+
        uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
        struct timeval bw_sample_time;
 
@@ -132,12 +169,21 @@ struct thread_data {
        unsigned int nr_normal_files;
        union {
                unsigned int next_file;
-               os_random_state_t next_file_state;
-               struct frand_state __next_file_state;
+               struct frand_state next_file_state;
+       };
+       union {
+               struct zipf_state next_file_zipf;
+               struct gauss_state next_file_gauss;
+       };
+       union {
+               double zipf_theta;
+               double pareto_h;
+               double gauss_dev;
        };
        int error;
        int sig;
        int done;
+       int stop_io;
        pid_t pid;
        char *orig_buffer;
        size_t orig_buffer_size;
@@ -155,28 +201,23 @@ struct thread_data {
 
        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 bsrange_state;
+       struct frand_state verify_state;
+       struct frand_state trim_state;
+       struct frand_state delay_state;
 
        struct frand_state buf_state;
+       struct frand_state buf_state_prev;
+       struct frand_state dedupe_state;
+       struct frand_state zone_state;
+
+       struct zone_split_index **zone_state_index;
 
        unsigned int verify_batch;
        unsigned int trim_batch;
 
+       struct thread_io_list *vstate;
+
        int shm_id;
 
        /*
@@ -185,6 +226,12 @@ struct thread_data {
         */
        struct ioengine_ops *io_ops;
 
+       /*
+        * IO engine private data and dlhandle.
+        */
+       void *io_ops_data;
+       void *io_ops_dlhandle;
+
        /*
         * Queue depth of io_u's that fio MIGHT do
         */
@@ -222,35 +269,53 @@ struct thread_data {
         * Rate state
         */
        uint64_t rate_bps[DDIR_RWDIR_CNT];
-       long rate_pending_usleep[DDIR_RWDIR_CNT];
+       unsigned long rate_next_io_time[DDIR_RWDIR_CNT];
        unsigned long rate_bytes[DDIR_RWDIR_CNT];
        unsigned long rate_blocks[DDIR_RWDIR_CNT];
+       unsigned long rate_io_issue_bytes[DDIR_RWDIR_CNT];
        struct timeval lastrate[DDIR_RWDIR_CNT];
+       int64_t last_usec;
+       struct frand_state poisson_state;
+
+       /*
+        * Enforced rate submission/completion workqueue
+        */
+       struct workqueue io_wq;
 
        uint64_t total_io_size;
        uint64_t fill_device_size;
 
-       unsigned long io_issues[DDIR_RWDIR_CNT];
+       /*
+        * Issue side
+        */
+       uint64_t io_issues[DDIR_RWDIR_CNT];
+       uint64_t io_issue_bytes[DDIR_RWDIR_CNT];
+       uint64_t loops;
+
+       /*
+        * Completions
+        */
        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 io_skip_bytes;
        uint64_t zone_bytes;
        struct fio_mutex *mutex;
+       uint64_t bytes_done[DDIR_RWDIR_CNT];
 
        /*
         * 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 frand_state random_state;
 
        struct timeval start;   /* start of this loop */
        struct timeval epoch;   /* time job was started */
+       unsigned long long unix_epoch; /* Time job was started, unix epoch based. */
        struct timeval last_issue;
+       long time_offset;
        struct timeval tv_cache;
+       struct timeval terminate_time;
        unsigned int tv_cache_nr;
        unsigned int tv_cache_mask;
        unsigned int ramp_time_over;
@@ -269,10 +334,7 @@ struct thread_data {
        /*
         * read/write mixed workload state
         */
-       union {
-               os_random_state_t rwmix_state;
-               struct frand_state __rwmix_state;
-       };
+       struct frand_state rwmix_state;
        unsigned long rwmix_issues;
        enum fio_ddir rwmix_ddir;
        unsigned int ddir_seq_nr;
@@ -280,10 +342,7 @@ struct thread_data {
        /*
         * 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];
-       };
+       struct frand_state seq_rand_state[DDIR_RWDIR_CNT];
 
        /*
         * IO history logs for verification. We use a tree for sorting,
@@ -318,10 +377,7 @@ struct thread_data {
        /*
         * For generating file sizes
         */
-       union {
-               os_random_state_t file_size_state;
-               struct frand_state __file_size_state;
-       };
+       struct frand_state file_size_state;
 
        /*
         * Error counts
@@ -338,6 +394,8 @@ struct thread_data {
        void *prof_data;
 
        void *pinned_mem;
+
+       char verror[FIO_VERROR_SIZE];
 };
 
 /*
@@ -360,12 +418,23 @@ enum {
        } 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 td_clear_error(td)             do {            \
+       (td)->error = 0;                                \
+       if ((td)->parent)                               \
+               (td)->parent->error = 0;                \
+} while (0)
+
+#define td_verror(td, err, func)       do {                    \
+       __td_verror((td), (err), strerror((err)), (func));      \
+       if ((td)->parent)                                       \
+               __td_verror((td)->parent, (err), strerror((err)), (func)); \
+} while (0)
+
+#define td_vmsg(td, err, msg, func)    do {                    \
+       __td_verror((td), (err), (msg), (func));                \
+       if ((td)->parent)                                       \
+               __td_verror((td)->parent, (err), (msg), (func));        \
+} while (0)
 
 #define __fio_stringify_1(x)   #x
 #define __fio_stringify(x)     __fio_stringify_1(x)
@@ -383,7 +452,6 @@ 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;
@@ -395,10 +463,15 @@ extern int nr_clients;
 extern int log_syslog;
 extern int status_interval;
 extern const char fio_version_string[];
+extern char *trigger_file;
+extern char *trigger_cmd;
+extern char *trigger_remote_cmd;
+extern long long trigger_timeout;
+extern char *aux_path;
 
 extern struct thread_data *threads;
 
-static inline void fio_ro_check(struct thread_data *td, struct io_u *io_u)
+static inline void fio_ro_check(const struct thread_data *td, struct io_u *io_u)
 {
        assert(!(io_u->ddir == DDIR_WRITE && !td_write(td)));
 }
@@ -422,11 +495,12 @@ 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 int fio_backend(struct sk_out *);
 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 clear_io_state(struct thread_data *, int);
+extern int fio_options_parse(struct thread_data *, char **, int);
 extern void fio_keywords_init(void);
+extern void fio_keywords_exit(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 *);
@@ -436,16 +510,20 @@ 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 td_fill_verify_state_seed(struct thread_data *);
 extern void add_job_opts(const char **, int);
-extern char *num2str(unsigned long, int, int, int, int);
+extern char *num2str(uint64_t, int, int, int, int);
 extern int ioengine_load(struct thread_data *);
-extern int parse_dryrun(void);
+extern bool parse_dryrun(void);
 extern int fio_running_or_pending_io_threads(void);
 extern int fio_set_fd_nonblocking(int, const char *);
+extern void sig_show_status(int sig);
+extern struct thread_data *get_global_options(void);
 
 extern uintptr_t page_mask;
 extern uintptr_t page_size;
 extern int initialize_fio(char *envp[]);
+extern void deinitialize_fio(void);
 
 #define FIO_GETOPT_JOB         0x89000000
 #define FIO_GETOPT_IOENGINE    0x98000000
@@ -477,14 +555,44 @@ enum {
        TD_FINISHING,
        TD_EXITED,
        TD_REAPED,
+       TD_LAST,
+       TD_NR,
 };
 
+#define TD_ENG_FLAG_SHIFT      16
+#define TD_ENG_FLAG_MASK       ((1U << 16) - 1)
+
+static inline enum fio_ioengine_flags td_ioengine_flags(struct thread_data *td)
+{
+       return (enum fio_ioengine_flags)
+               ((td->flags >> TD_ENG_FLAG_SHIFT) & TD_ENG_FLAG_MASK);
+}
+
+static inline void td_set_ioengine_flags(struct thread_data *td)
+{
+       td->flags |= (td->io_ops->flags << TD_ENG_FLAG_SHIFT);
+}
+
+static inline bool td_ioengine_flagged(struct thread_data *td,
+                                      enum fio_ioengine_flags flags)
+{
+       return ((td->flags >> TD_ENG_FLAG_SHIFT) & flags) != 0;
+}
+
 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);
+extern const char *runstate_to_name(int runstate);
+
+/*
+ * 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);
+#define TERMINATE_ALL          (-1U)
+extern void fio_terminate_threads(unsigned int);
+extern void fio_mark_td_terminate(struct thread_data *);
 
 /*
  * Memory helpers
@@ -508,6 +616,10 @@ extern int is_blktrace(const char *, int *);
 extern int load_blktrace(struct thread_data *, const char *, int);
 #endif
 
+extern int io_queue_event(struct thread_data *td, struct io_u *io_u, int *ret,
+                  enum fio_ddir ddir, uint64_t *bytes_issued, int from_verify,
+                  struct timeval *comp_time);
+
 /*
  * Latency target helpers
  */
@@ -533,17 +645,17 @@ extern void lat_target_reset(struct thread_data *);
        }       \
 } while (0)
 
-static inline int fio_fill_issue_time(struct thread_data *td)
+static inline bool 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 true;
 
-       return 0;
+       return false;
 }
 
-static inline int __should_check_rate(struct thread_data *td,
-                                     enum fio_ddir ddir)
+static inline bool __should_check_rate(struct thread_data *td,
+                                      enum fio_ddir ddir)
 {
        struct thread_options *o = &td->o;
 
@@ -552,24 +664,21 @@ static inline int __should_check_rate(struct thread_data *td,
         */
        if (o->rate[ddir] || o->ratemin[ddir] || o->rate_iops[ddir] ||
            o->rate_iops_min[ddir])
-               return 1;
+               return true;
 
-       return 0;
+       return false;
 }
 
-static inline int should_check_rate(struct thread_data *td,
-                                   uint64_t *bytes_done)
+static inline bool should_check_rate(struct thread_data *td)
 {
-       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;
+       if (td->bytes_done[DDIR_READ] && __should_check_rate(td, DDIR_READ))
+               return true;
+       if (td->bytes_done[DDIR_WRITE] && __should_check_rate(td, DDIR_WRITE))
+               return true;
+       if (td->bytes_done[DDIR_TRIM] && __should_check_rate(td, DDIR_TRIM))
+               return true;
+
+       return false;
 }
 
 static inline unsigned int td_max_bs(struct thread_data *td)
@@ -588,9 +697,9 @@ static inline unsigned int td_min_bs(struct thread_data *td)
        return min(td->o.min_bs[DDIR_TRIM], min_bs);
 }
 
-static inline int is_power_of_2(unsigned long val)
+static inline bool td_async_processing(struct thread_data *td)
 {
-       return (val != 0 && ((val & (val - 1)) == 0));
+       return (td->flags & TD_F_NEED_LOCK) != 0;
 }
 
 /*
@@ -599,44 +708,76 @@ static inline int is_power_of_2(unsigned long val)
  */
 static inline void td_io_u_lock(struct thread_data *td)
 {
-       if (td->o.verify_async)
+       if (td_async_processing(td))
                pthread_mutex_lock(&td->io_u_lock);
 }
 
 static inline void td_io_u_unlock(struct thread_data *td)
 {
-       if (td->o.verify_async)
+       if (td_async_processing(td))
                pthread_mutex_unlock(&td->io_u_lock);
 }
 
 static inline void td_io_u_free_notify(struct thread_data *td)
 {
-       if (td->o.verify_async)
+       if (td_async_processing(td))
                pthread_cond_signal(&td->free_cond);
 }
 
+static inline void td_flags_clear(struct thread_data *td, unsigned int *flags,
+                                 unsigned int value)
+{
+       if (!td_async_processing(td))
+               *flags &= ~value;
+       else
+               __sync_fetch_and_and(flags, ~value);
+}
+
+static inline void td_flags_set(struct thread_data *td, unsigned int *flags,
+                               unsigned int value)
+{
+       if (!td_async_processing(td))
+               *flags |= value;
+       else
+               __sync_fetch_and_or(flags, value);
+}
+
 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])))
+#define ARRAY_SIZE(x)    (sizeof((x)) / (sizeof((x)[0])))
+#define FIELD_SIZE(s, f) (sizeof(((typeof(s))0)->f))
 #endif
 
 enum {
-       FIO_OUTPUT_TERSE        = 0,
-       FIO_OUTPUT_JSON,
-       FIO_OUTPUT_NORMAL,
+       __FIO_OUTPUT_TERSE      = 0,
+       __FIO_OUTPUT_JSON       = 1,
+       __FIO_OUTPUT_NORMAL     = 2,
+        __FIO_OUTPUT_JSON_PLUS  = 3,
+       FIO_OUTPUT_NR           = 4,
+
+       FIO_OUTPUT_TERSE        = 1U << __FIO_OUTPUT_TERSE,
+       FIO_OUTPUT_JSON         = 1U << __FIO_OUTPUT_JSON,
+       FIO_OUTPUT_NORMAL       = 1U << __FIO_OUTPUT_NORMAL,
+       FIO_OUTPUT_JSON_PLUS    = 1U << __FIO_OUTPUT_JSON_PLUS,
 };
 
 enum {
        FIO_RAND_DIST_RANDOM    = 0,
        FIO_RAND_DIST_ZIPF,
        FIO_RAND_DIST_PARETO,
+       FIO_RAND_DIST_GAUSS,
+       FIO_RAND_DIST_ZONED,
 };
 
+#define FIO_DEF_ZIPF           1.1
+#define FIO_DEF_PARETO         0.2
+
 enum {
        FIO_RAND_GEN_TAUSWORTHE = 0,
        FIO_RAND_GEN_LFSR,
+       FIO_RAND_GEN_TAUSWORTHE64,
 };
 
 enum {
@@ -644,4 +785,7 @@ enum {
        FIO_CPUS_SPLIT,
 };
 
+extern void exec_trigger(const char *);
+extern void check_trigger_file(void);
+
 #endif