HOWTO/manpage: update percentage explanation using '%'
[fio.git] / fio.h
diff --git a/fio.h b/fio.h
index fb527dab501c1051a0dbd87468cf7968f737c782..d5d6bfe42fcde0d1dcb8711cc31e4e774a673fd4 100644 (file)
--- a/fio.h
+++ b/fio.h
 #include "debug.h"
 #include "file.h"
 #include "io_ddir.h"
-#include "ioengine.h"
+#include "ioengines.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 "oslib/getopt.h"
 #include "lib/rand.h"
 #include "lib/rbtree.h"
+#include "lib/num2str.h"
 #include "client.h"
 #include "server.h"
 #include "stat.h"
 #include "flow.h"
+#include "io_u.h"
 #include "io_u_queue.h"
 #include "workqueue.h"
+#include "steadystate.h"
 
 #ifdef CONFIG_SOLARISAIO
 #include <sys/asynch.h>
 #define MPOL_LOCAL MPOL_MAX
 #endif
 
+#ifdef CONFIG_CUDA
+#include <cuda.h>
+#endif
+
 /*
  * offset generator types
  */
@@ -73,12 +80,13 @@ enum {
        TD_F_VER_NONE           = 1U << 5,
        TD_F_PROFILE_OPS        = 1U << 6,
        TD_F_COMPRESS           = 1U << 7,
-       TD_F_NOIO               = 1U << 8,
+       TD_F_RESERVED           = 1U << 8, /* not used */
        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 {
@@ -96,6 +104,9 @@ enum {
        FIO_RAND_START_DELAY,
        FIO_DEDUPE_OFF,
        FIO_RAND_POISSON_OFF,
+       FIO_RAND_ZONE_OFF,
+       FIO_RAND_POISSON2_OFF,
+       FIO_RAND_POISSON3_OFF,
        FIO_RAND_NR_OFFS,
 };
 
@@ -107,32 +118,44 @@ enum {
        RATE_PROCESS_POISSON = 1,
 };
 
+enum {
+       F_ADV_NONE = 0,
+       F_ADV_TYPE,
+       F_ADV_RANDOM,
+       F_ADV_SEQUENTIAL,
+};
+
 /*
  * 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;
+       struct thread_stat ts __attribute__ ((aligned(8)));
 
        int client_type;
 
        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;
@@ -142,17 +165,10 @@ struct thread_data {
        struct thread_data *parent;
 
        uint64_t stat_io_bytes[DDIR_RWDIR_CNT];
-       struct timeval bw_sample_time;
+       struct timespec bw_sample_time;
 
        uint64_t stat_io_blocks[DDIR_RWDIR_CNT];
-       struct timeval iops_sample_time;
-
-       /*
-        * Tracks the last iodepth number of completed writes, if data
-        * verification is enabled
-        */
-       uint64_t *last_write_comp;
-       unsigned int last_write_idx;
+       struct timespec iops_sample_time;
 
        volatile int update_rusage;
        struct fio_mutex *rusage_sem;
@@ -170,6 +186,15 @@ struct thread_data {
                unsigned int next_file;
                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;
@@ -187,8 +212,6 @@ struct thread_data {
        void *iolog_buf;
        FILE *iolog_f;
 
-       char *sysfs_root;
-
        unsigned long rand_seeds[FIO_RAND_NR_OFFS];
 
        struct frand_state bsrange_state;
@@ -199,6 +222,9 @@ struct thread_data {
        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;
@@ -212,6 +238,13 @@ struct thread_data {
         * to any of the available IO engines.
         */
        struct ioengine_ops *io_ops;
+       int io_ops_init;
+
+       /*
+        * IO engine private data and dlhandle.
+        */
+       void *io_ops_data;
+       void *io_ops_dlhandle;
 
        /*
         * Queue depth of io_u's that fio MIGHT do
@@ -250,13 +283,13 @@ struct thread_data {
         * Rate state
         */
        uint64_t rate_bps[DDIR_RWDIR_CNT];
-       unsigned long rate_next_io_time[DDIR_RWDIR_CNT];
+       uint64_t 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;
+       unsigned long long rate_io_issue_bytes[DDIR_RWDIR_CNT];
+       struct timespec lastrate[DDIR_RWDIR_CNT];
+       int64_t last_usec[DDIR_RWDIR_CNT];
+       struct frand_state poisson_state[DDIR_RWDIR_CNT];
 
        /*
         * Enforced rate submission/completion workqueue
@@ -290,20 +323,21 @@ struct thread_data {
         */
        struct frand_state random_state;
 
-       struct timeval start;   /* start of this loop */
-       struct timeval epoch;   /* time job was started */
-       struct timeval last_issue;
+       struct timespec start;  /* start of this loop */
+       struct timespec epoch;  /* time job was started */
+       unsigned long long unix_epoch; /* Time job was started, unix epoch based. */
+       struct timespec last_issue;
        long time_offset;
-       struct timeval tv_cache;
-       struct timeval terminate_time;
-       unsigned int tv_cache_nr;
-       unsigned int tv_cache_mask;
+       struct timespec ts_cache;
+       struct timespec terminate_time;
+       unsigned int ts_cache_nr;
+       unsigned int ts_cache_mask;
        unsigned int ramp_time_over;
 
        /*
         * Time since last latency_window was started
         */
-       struct timeval latency_ts;
+       struct timespec latency_ts;
        unsigned int latency_qd;
        unsigned int latency_qd_high;
        unsigned int latency_qd_low;
@@ -374,6 +408,22 @@ struct thread_data {
        void *prof_data;
 
        void *pinned_mem;
+
+       struct steadystate_data ss;
+
+       char verror[FIO_VERROR_SIZE];
+
+#ifdef CONFIG_CUDA
+       /*
+        * for GPU memory management
+        */
+       int gpu_dev_cnt;
+       int gpu_dev_id;
+       CUdevice  cu_dev;
+       CUcontext cu_ctx;
+       CUdeviceptr dev_mem_ptr;
+#endif 
+
 };
 
 /*
@@ -430,7 +480,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;
@@ -442,8 +491,6 @@ extern int nr_clients;
 extern int log_syslog;
 extern int status_interval;
 extern const char fio_version_string[];
-extern int helper_do_stat;
-extern pthread_cond_t helper_cond;
 extern char *trigger_file;
 extern char *trigger_cmd;
 extern char *trigger_remote_cmd;
@@ -457,13 +504,13 @@ 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)));
 }
 
-#define REAL_MAX_JOBS          2048
+#define REAL_MAX_JOBS          4096
 
 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)
+       if (td_write(td) || td->o.override_sync)
                return 1;
 
        return 0;
@@ -479,7 +526,7 @@ extern int parse_cmd_line(int, char **, int);
 extern int fio_backend(struct sk_out *);
 extern void reset_fio_state(void);
 extern void clear_io_state(struct thread_data *, int);
-extern int fio_options_parse(struct thread_data *, char **, int, 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 *);
@@ -489,15 +536,15 @@ 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 td_fill_verify_state_seed(struct thread_data *);
 extern void add_job_opts(const char **, 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;
@@ -535,17 +582,40 @@ enum {
        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_ENG_FLAG_MASK << TD_ENG_FLAG_SHIFT) & 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 FIO_REAP_TIMEOUT       300
 
 #define TERMINATE_ALL          (-1U)
 extern void fio_terminate_threads(unsigned int);
@@ -560,22 +630,19 @@ extern int __must_check allocate_io_mem(struct thread_data *);
 extern void free_io_mem(struct thread_data *);
 extern void free_threads_shm(void);
 
+#ifdef FIO_INTERNAL
+#define PTR_ALIGN(ptr, mask)   \
+       (char *) (((uintptr_t) (ptr) + (mask)) & ~(mask))
+#endif
+
 /*
  * 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
-
 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);
+                  struct timespec *comp_time);
 
 /*
  * Latency target helpers
@@ -584,6 +651,9 @@ extern void lat_target_check(struct thread_data *);
 extern void lat_target_init(struct thread_data *);
 extern void lat_target_reset(struct thread_data *);
 
+/*
+ * Iterates all threads/processes within all the defined jobs
+ */
 #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)        \
@@ -602,17 +672,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;
 
@@ -621,23 +691,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)
+static inline bool should_check_rate(struct thread_data *td)
 {
-       int ret = 0;
-
-       if (td->bytes_done[DDIR_READ])
-               ret |= __should_check_rate(td, DDIR_READ);
-       if (td->bytes_done[DDIR_WRITE])
-               ret |= __should_check_rate(td, DDIR_WRITE);
-       if (td->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)
@@ -656,7 +724,7 @@ static inline unsigned int td_min_bs(struct thread_data *td)
        return min(td->o.min_bs[DDIR_TRIM], min_bs);
 }
 
-static inline int td_async_processing(struct thread_data *td)
+static inline bool td_async_processing(struct thread_data *td)
 {
        return (td->flags & TD_F_NEED_LOCK) != 0;
 }
@@ -683,6 +751,24 @@ static inline void td_io_u_free_notify(struct thread_data *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);
 
@@ -709,6 +795,7 @@ enum {
        FIO_RAND_DIST_ZIPF,
        FIO_RAND_DIST_PARETO,
        FIO_RAND_DIST_GAUSS,
+       FIO_RAND_DIST_ZONED,
 };
 
 #define FIO_DEF_ZIPF           1.1