Add options to have fio latency profile a device
[fio.git] / fio.h
diff --git a/fio.h b/fio.h
index e37e5ae1e8e38e55f7508afe8ca115a49ac6a15e..a0927bd9d60cebb8c03a873280ac097459be0390 100644 (file)
--- a/fio.h
+++ b/fio.h
 #include <inttypes.h>
 #include <assert.h>
 
-struct thread_data;
-
 #include "compiler/compiler.h"
 #include "thread_options.h"
 #include "flist.h"
 #include "fifo.h"
-#include "lib/rbtree.h"
 #include "arch/arch.h"
 #include "os/os.h"
 #include "mutex.h"
@@ -37,17 +34,25 @@ struct thread_data;
 #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 FIO_HAVE_GUASI
-#include <guasi.h>
+#ifdef CONFIG_SOLARISAIO
+#include <sys/asynch.h>
 #endif
 
-#ifdef FIO_HAVE_SOLARISAIO
-#include <sys/asynch.h>
+#ifdef CONFIG_LIBNUMA
+#include <linux/mempolicy.h>
+#include <numa.h>
+
+/*
+ * "local" is pseudo-policy
+ */
+#define MPOL_LOCAL MPOL_MAX
 #endif
 
 /*
@@ -58,11 +63,37 @@ enum {
        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_READ_OFF,
+       FIO_RAND_SEQ_RAND_WRITE_OFF,
+       FIO_RAND_SEQ_RAND_TRIM_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;
@@ -78,16 +109,19 @@ 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;
 
+       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;
@@ -99,14 +133,13 @@ struct thread_data {
                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 ioprio;
-       unsigned int ioprio_set;
        unsigned int last_was_sync;
        enum fio_ddir last_ddir;
 
@@ -117,7 +150,7 @@ struct thread_data {
 
        char *sysfs_root;
 
-       unsigned long rand_seeds[8];
+       unsigned long rand_seeds[FIO_RAND_NR_OFFS];
 
        union {
                os_random_state_t bsrange_state;
@@ -163,9 +196,9 @@ struct thread_data {
        /*
         * 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;
+       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;
 
@@ -181,22 +214,22 @@ struct thread_data {
        /*
         * Rate state
         */
-       unsigned long long rate_bps[2];
-       long rate_pending_usleep[2];
-       unsigned long rate_bytes[2];
-       unsigned long rate_blocks[2];
-       struct timeval lastrate[2];
-
-       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 long io_skip_bytes;
-       unsigned long long this_io_bytes[2];
-       unsigned long long zone_bytes;
+       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;
 
        /*
@@ -215,6 +248,16 @@ struct thread_data {
        unsigned int tv_cache_mask;
        unsigned int ramp_time_over;
 
+       /*
+        * Time since last latency_window was started
+        */
+       struct timeval latency_ts;
+       unsigned int latency_qd;
+       unsigned int latency_qd_high;
+       unsigned int latency_qd_low;
+       unsigned int latency_failed;
+       uint64_t latency_ios;
+
        /*
         * read/write mixed workload state
         */
@@ -226,6 +269,14 @@ struct thread_data {
        enum fio_ddir rwmix_ddir;
        unsigned int ddir_seq_nr;
 
+       /*
+        * 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];
+       };
+
        /*
         * IO history logs for verification. We use a tree for sorting,
         * if we are overwriting. Otherwise just use a fifo.
@@ -245,6 +296,8 @@ struct thread_data {
        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
         */
@@ -290,12 +343,12 @@ enum {
 
 #define __td_verror(td, err, msg, func)                                        \
        do {                                                            \
+               int e = (err);                                          \
                if ((td)->error)                                        \
                        break;                                          \
-               int e = (err);                                          \
                (td)->error = e;                                        \
                if (!(td)->first_error)                                 \
-                       snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg));               \
+                       snprintf(td->verror, sizeof(td->verror), "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg));           \
        } while (0)
 
 
@@ -311,25 +364,28 @@ enum {
 
 extern int exitall_on_terminate;
 extern unsigned int thread_number;
+extern unsigned int stat_number;
 extern int shm_id;
 extern int groupid;
-extern int terse_output;
+extern int output_format;
 extern int temp_stall_ts;
-extern unsigned long page_mask, page_size;
+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 const fio_fp64_t def_percentile_list[FIO_IO_U_LIST_MAX_LEN];
 
 extern struct thread_data *threads;
 
@@ -338,37 +394,12 @@ 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 BLOCKS_PER_MAP         (8 * sizeof(unsigned long))
-#define TO_MAP_BLOCK(f, b)     (b)
-#define RAND_MAP_IDX(f, b)     (TO_MAP_BLOCK(f, b) / BLOCKS_PER_MAP)
-#define RAND_MAP_BIT(f, b)     (TO_MAP_BLOCK(f, b) & (BLOCKS_PER_MAP - 1))
-
 #define REAL_MAX_JOBS          2048
 
-#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++;
-       if (td->total_err_count == 1)
-               td->first_error = err;
-}
-
 static inline int should_fsync(struct thread_data *td)
 {
        if (td->last_was_sync)
                return 0;
-       if (td->o.odirect)
-               return 0;
        if (td_write(td) || td_rw(td) || td->o.override_sync)
                return 1;
 
@@ -385,7 +416,7 @@ 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 int fio_options_parse(struct thread_data *, char **, int, 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 *);
@@ -397,11 +428,12 @@ 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);
+extern char *num2str(unsigned long, int, int, int, int);
 extern int ioengine_load(struct thread_data *);
+extern int parse_dryrun(void);
 
-extern unsigned long page_mask;
-extern unsigned long page_size;
+extern uintptr_t page_mask;
+extern uintptr_t page_size;
 extern int initialize_fio(char *envp[]);
 
 #define FIO_GETOPT_JOB         0x89000000
@@ -426,6 +458,7 @@ enum {
        TD_CREATED,
        TD_INITIALIZED,
        TD_RAMP,
+       TD_SETTING_UP,
        TD_RUNNING,
        TD_PRE_READING,
        TD_VERIFYING,
@@ -456,16 +489,15 @@ 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 *);
+extern int is_blktrace(const char *, int *);
+extern int load_blktrace(struct thread_data *, const char *, int);
 #endif
 
 /*
- * Mark unused variables passed to ops functions as unused, to silence gcc
+ * Latency target helpers
  */
-#define fio_unused     __attribute((__unused__))
-#define fio_init       __attribute__((constructor))
-#define fio_exit       __attribute__((destructor))
+extern void lat_target_check(struct thread_data *);
+extern void lat_target_init(struct thread_data *);
 
 #define for_each_td(td, i)     \
        for ((i) = 0, (td) = &threads[0]; (i) < (int) thread_number; (i)++, (td)++)
@@ -510,18 +542,36 @@ static inline int __should_check_rate(struct thread_data *td,
 }
 
 static inline int should_check_rate(struct thread_data *td,
-                                   unsigned long *bytes_done)
+                                   uint64_t *bytes_done)
 {
        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;
 }
 
+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));
@@ -554,4 +604,21 @@ 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