Update fio io engine version
[fio.git] / fio.h
diff --git a/fio.h b/fio.h
index c1c71465b8789ada64ebf51a8c611358ca1e6fac..1b8a66d1fdac3c0eab6ba2f55efd67f026104880 100644 (file)
--- a/fio.h
+++ b/fio.h
 #include <stdio.h>
 #include <unistd.h>
 #include <string.h>
+#include <getopt.h>
 
 #include "list.h"
+#include "rbtree.h"
 #include "md5.h"
 #include "crc32.h"
 #include "arch.h"
 #include "os.h"
+#include "mutex.h"
 
 #ifdef FIO_HAVE_SYSLET
 #include "syslet.h"
 #endif
 
+#ifdef FIO_HAVE_GUASI
+#include <guasi.h>
+#endif
+
 enum fio_ddir {
        DDIR_READ = 0,
        DDIR_WRITE,
        DDIR_SYNC,
 };
 
+enum td_ddir {
+       TD_DDIR_READ            = 1 << 0,
+       TD_DDIR_WRITE           = 1 << 1,
+       TD_DDIR_RAND            = 1 << 2,
+       TD_DDIR_RW              = TD_DDIR_READ | TD_DDIR_WRITE,
+       TD_DDIR_RANDREAD        = TD_DDIR_READ | TD_DDIR_RAND,
+       TD_DDIR_RANDWRITE       = TD_DDIR_WRITE | TD_DDIR_RAND,
+       TD_DDIR_RANDRW          = TD_DDIR_RW | TD_DDIR_RAND,
+};
+
 /*
  * Use for maintaining statistics
  */
@@ -62,7 +79,10 @@ struct io_log {
  * When logging io actions, this matches a single sent io_u
  */
 struct io_piece {
-       struct list_head list;
+       union {
+               struct rb_node rb_node;
+               struct list_head list;
+       };
        struct fio_file *file;
        unsigned long long offset;
        unsigned long len;
@@ -71,8 +91,9 @@ struct io_piece {
 
 #ifdef FIO_HAVE_SYSLET
 struct syslet_req {
-       struct syslet_uatom atom;
-       long ret;
+       struct syslet_uatom atom;       /* the atom to submit */
+       struct syslet_uatom *head;      /* head of the sequence */
+       long ret;                       /* syscall return value */
 };
 #endif
 
@@ -81,6 +102,8 @@ enum {
        IO_U_F_FLIGHT   = 1 << 1,
 };
 
+struct thread_data;
+
 /*
  * The io unit
  */
@@ -97,6 +120,9 @@ struct io_u {
 #endif
 #ifdef FIO_HAVE_SYSLET
                struct syslet_req req;
+#endif
+#ifdef FIO_HAVE_GUASI
+               guasi_req_t greq;
 #endif
        };
        struct timeval start_time;
@@ -134,6 +160,11 @@ struct io_u {
        struct fio_file *file;
 
        struct list_head list;
+
+       /*
+        * Callback for io completion
+        */
+       int (*end_io)(struct thread_data *, struct io_u *);
 };
 
 /*
@@ -151,6 +182,7 @@ enum {
        VERIFY_NONE = 0,                /* no verification */
        VERIFY_MD5,                     /* md5 sum data blocks */
        VERIFY_CRC32,                   /* crc32 sum data blocks */
+       VERIFY_NULL,                    /* pretend to verify */
 };
 
 /*
@@ -195,11 +227,19 @@ enum fio_filetype {
 
 enum fio_ioengine_flags {
        FIO_SYNCIO      = 1 << 0,       /* io engine has synchronous ->queue */
-       FIO_CPUIO       = 1 << 1,       /* cpu burner, doesn't do real io */
-       FIO_MMAPIO      = 1 << 2,       /* uses memory mapped io */
-       FIO_RAWIO       = 1 << 3,       /* some sort of direct/raw io */
-       FIO_NETIO       = 1 << 4,       /* networked io */
-       FIO_NULLIO      = 1 << 5,       /* no real data transfer (cpu/null) */
+       FIO_RAWIO       = 1 << 1,       /* some sort of direct/raw io */
+       FIO_DISKLESSIO  = 1 << 2,       /* no disk involved */
+       FIO_NOEXTEND    = 1 << 3,       /* engine can't extend file */
+       FIO_NODISKUTIL  = 1 << 4,       /* diskutil can't handle filename */
+};
+
+enum fio_file_flags {
+       FIO_FILE_OPEN           = 1 << 0,       /* file is open */
+       FIO_FILE_UNLINK         = 1 << 1,       /* unlink on close */
+       FIO_FILE_CLOSING        = 1 << 2,       /* file being closed */
+       FIO_FILE_EXISTS         = 1 << 3,       /* file there */
+       FIO_FILE_EXTEND         = 1 << 4,       /* needs extend */
+       FIO_FILE_NOSORT         = 1 << 5,       /* don't sort verify blocks */
 };
 
 /*
@@ -207,6 +247,8 @@ enum fio_ioengine_flags {
  * this structure holds state information for a single file.
  */
 struct fio_file {
+       enum fio_filetype filetype;
+
        /*
         * A file may not be a file descriptor, let the io engine decide
         */
@@ -214,11 +256,20 @@ struct fio_file {
                unsigned long file_data;
                int fd;
        };
+
+       /*
+        * filename and possible memory mapping
+        */
        char *file_name;
        void *mmap;
-       unsigned long long file_size;
+
+       /*
+        * size of the file, offset into file, and io size from that offset
+        */
        unsigned long long real_file_size;
        unsigned long long file_offset;
+       unsigned long long io_size;
+
        unsigned long long last_pos;
        unsigned long long last_completed_pos;
 
@@ -229,10 +280,25 @@ struct fio_file {
        unsigned int num_maps;
        unsigned int last_free_lookup;
 
-       unsigned int unlink;
+       int references;
+       enum fio_file_flags flags;
 };
 
+/*
+ * How many depth levels to log
+ */
+#define FIO_IO_U_MAP_NR        8
+#define FIO_IO_U_LAT_NR 12
+
 struct thread_stat {
+       char *name;
+       char *verror;
+       int error;
+       int groupid;
+       pid_t pid;
+       char *description;
+       int members;
+
        struct io_log *slat_log;
        struct io_log *clat_log;
        struct io_log *bw_log;
@@ -255,44 +321,45 @@ struct thread_stat {
        unsigned long usr_time;
        unsigned long sys_time;
        unsigned long ctx;
-};
 
-/*
- * How many depth levels to log
- */
-#define FIO_IO_U_MAP_NR        8
-#define FIO_IO_U_LAT_NR 12
+       /*
+        * IO depth and latency stats
+        */
+       unsigned int io_u_map[FIO_IO_U_MAP_NR];
+       unsigned int io_u_lat[FIO_IO_U_LAT_NR];
+       unsigned long total_io_u[2];
 
-/*
- * This describes a single thread/process executing a fio job.
- */
-struct thread_data {
+       unsigned long long io_bytes[2];
+       unsigned long runtime[2];
+       unsigned long total_run_time;
+};
+
+struct thread_options {
+       int pad;
        char *description;
        char *name;
        char *directory;
        char *filename;
-       char verror[80];
-       pthread_t thread;
-       int thread_number;
-       int groupid;
-       struct thread_stat ts;
-       enum fio_filetype filetype;
-       struct fio_file *files;
+       char *opendir;
+       char *ioengine;
+       enum td_ddir td_ddir;
+       unsigned int ddir_nr;
+       unsigned int iodepth;
+       unsigned int iodepth_low;
+       unsigned int iodepth_batch;
+
+       unsigned long long size;
+       unsigned long long file_size_low;
+       unsigned long long file_size_high;
+       unsigned long long start_offset;
+
+       unsigned int bs[2];
+       unsigned int min_bs[2];
+       unsigned int max_bs[2];
+
        unsigned int nr_files;
-       unsigned int nr_uniq_files;
-       unsigned int next_file;
-       int error;
-       pid_t pid;
-       char *orig_buffer;
-       size_t orig_buffer_size;
-       volatile int terminate;
-       volatile int runstate;
-       enum fio_ddir ddir;
-       unsigned int iomix;
-       unsigned int ioprio;
-       unsigned int last_was_sync;
+       unsigned int open_files;
 
-       unsigned int sequential;
        unsigned int odirect;
        unsigned int invalidate_cache;
        unsigned int create_serialize;
@@ -300,6 +367,7 @@ struct thread_data {
        unsigned int end_fsync;
        unsigned int sync_io;
        unsigned int verify;
+       unsigned int verifysort;
        unsigned int use_thread;
        unsigned int unlink;
        unsigned int do_disk_util;
@@ -309,10 +377,8 @@ struct thread_data {
        unsigned int write_bw_log;
        unsigned int norandommap;
        unsigned int bs_unaligned;
+       unsigned int fsync_on_close;
 
-       unsigned int bs[2];
-       unsigned int min_bs[2];
-       unsigned int max_bs[2];
        unsigned int hugepage_size;
        unsigned int rw_min_bs;
        unsigned int thinktime;
@@ -327,27 +393,80 @@ struct thread_data {
        unsigned long long zone_size;
        unsigned long long zone_skip;
        enum fio_memtype mem_type;
-       char *mmapfile;
-       int mmapfd;
+
        unsigned int stonewall;
+       unsigned int new_group;
        unsigned int numjobs;
-       unsigned int iodepth;
-       unsigned int iodepth_low;
        os_cpu_mask_t cpumask;
        unsigned int iolog;
        unsigned int read_iolog;
        unsigned int rwmixcycle;
-       unsigned int rwmixread;
-       unsigned int rwmixwrite;
+       unsigned int rwmix[2];
        unsigned int nice;
+       unsigned int file_service_type;
+       unsigned int group_reporting;
+       unsigned int fadvise_hint;
 
        char *read_iolog_file;
        char *write_iolog_file;
+
+       /*
+        * Pre-run and post-run shell
+        */
+       char *exec_prerun;
+       char *exec_postrun;
+
+       unsigned int rate;
+       unsigned int ratemin;
+       unsigned int ratecycle;
+       unsigned int rate_iops;
+       unsigned int rate_iops_min;
+
+       char *ioscheduler;
+
+       /*
+        * CPU "io" cycle burner
+        */
+       unsigned int cpuload;
+       unsigned int cpucycle;
+};
+
+#define FIO_VERROR_SIZE        128
+
+/*
+ * This describes a single thread/process executing a fio job.
+ */
+struct thread_data {
+       struct thread_options o;
+       char verror[FIO_VERROR_SIZE];
+       pthread_t thread;
+       int thread_number;
+       int groupid;
+       struct thread_stat ts;
+       struct fio_file *files;
+       unsigned int files_index;
+       unsigned int nr_open_files;
+       unsigned int nr_normal_files;
+       union {
+               unsigned int next_file;
+               os_random_state_t next_file_state;
+       };
+       int error;
+       pid_t pid;
+       char *orig_buffer;
+       size_t orig_buffer_size;
+       volatile int terminate;
+       volatile int runstate;
+       unsigned int ioprio;
+       unsigned int last_was_sync;
+
+       char *mmapfile;
+       int mmapfd;
+
        void *iolog_buf;
        FILE *iolog_f;
 
        char *sysfs_root;
-       char *ioscheduler;
 
        os_random_state_t bsrange_state;
        os_random_state_t verify_state;
@@ -364,28 +483,20 @@ struct thread_data {
         * Current IO depth and list of free and busy io_u's.
         */
        unsigned int cur_depth;
-       unsigned int io_u_map[FIO_IO_U_MAP_NR];
-       unsigned int io_u_lat[FIO_IO_U_LAT_NR];
-       unsigned long total_io_u;
        struct list_head io_u_freelist;
        struct list_head io_u_busylist;
        struct list_head io_u_requeues;
+       unsigned int io_u_queued;
 
        /*
         * Rate state
         */
-       unsigned int rate;
-       unsigned int ratemin;
-       unsigned int ratecycle;
        unsigned long rate_usec_cycle;
        long rate_pending_usleep;
        unsigned long rate_bytes;
+       unsigned long rate_blocks;
        struct timeval lastrate;
 
-       unsigned long runtime[2];               /* msec */
-       unsigned long long io_size;
-       unsigned long long total_file_size;
-       unsigned long long start_offset;
        unsigned long long total_io_size;
 
        unsigned long io_issues[2];
@@ -393,40 +504,37 @@ struct thread_data {
        unsigned long long io_bytes[2];
        unsigned long long this_io_bytes[2];
        unsigned long long zone_bytes;
-       volatile int mutex;
+       struct fio_sem *mutex;
 
        /*
         * State for random io, a bitmap of blocks done vs not done
         */
        os_random_state_t random_state;
 
-       /*
-        * CPU "io" cycle burner
-        */
-       unsigned int cpuload;
-       unsigned int cpucycle;
-
        struct timeval start;   /* start of this loop */
        struct timeval epoch;   /* time job was started */
-       struct timeval end_time;/* time job ended */
+       struct timeval rw_end[2];
+       unsigned int rw_end_set[2];
 
        /*
         * read/write mixed workload state
         */
        os_random_state_t rwmix_state;
+       unsigned long long rwmix_bytes;
        struct timeval rwmix_switch;
        enum fio_ddir rwmix_ddir;
+       unsigned int ddir_nr;
 
        /*
-        * Pre-run and post-run shell
+        * IO history logs for verification. We use a tree for sorting,
+        * if we are overwriting. Otherwise just use a fifo.
         */
-       char *exec_prerun;
-       char *exec_postrun;
+       struct rb_root io_hist_tree;
+       struct list_head io_hist_list;
 
        /*
-        * IO historic logs
+        * For IO replaying
         */
-       struct list_head io_hist_list;
        struct list_head io_log_list;
 
        /*
@@ -434,6 +542,26 @@ struct thread_data {
         */
        struct timeval timeout_end;
        struct itimerval timer;
+
+       /*
+        * 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;
+
+       /*
+        * For generating file sizes
+        */
+       os_random_state_t file_size_state;
+};
+
+/*
+ * roundrobin available files, or choose one at random.
+ */
+enum {
+       FIO_FSERVICE_RANDOM     = 1,
+       FIO_FSERVICE_RR         = 2,
 };
 
 /*
@@ -443,21 +571,24 @@ struct thread_data {
 #define IO_U_TIMEOUT_INC       5
 #define IO_U_TIMEOUT           30
 
-#define __td_verror(td, err, msg)                                      \
+#define __td_verror(td, err, msg, func)                                        \
        do {                                                            \
                if ((td)->error)                                        \
                        break;                                          \
                int e = (err);                                          \
                (td)->error = e;                                        \
-               snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, error=%s", __FILE__, __LINE__, (msg));        \
+               snprintf(td->verror, sizeof(td->verror) - 1, "file:%s:%d, func=%s, error=%s", __FILE__, __LINE__, (func), (msg));       \
        } while (0)
 
 
-#define td_verror(td, err)     __td_verror((td), (err), strerror((err)))
-#define td_vmsg(td, err, msg)  __td_verror((td), (err), (msg))
+#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))
 
 extern int exitall_on_terminate;
 extern int thread_number;
+extern int nr_process, nr_thread;
 extern int shm_id;
 extern int groupid;
 extern int terse_output;
@@ -465,15 +596,17 @@ extern FILE *f_out;
 extern FILE *f_err;
 extern int temp_stall_ts;
 extern unsigned long long mlock_size;
+extern unsigned long page_mask, page_size;
 
 extern struct thread_data *threads;
 
-#define td_read(td)            ((td)->ddir == DDIR_READ)
-#define td_write(td)           ((td)->ddir == DDIR_WRITE)
-#define td_rw(td)              ((td)->iomix != 0)
+#define td_read(td)            ((td)->o.td_ddir & TD_DDIR_READ)
+#define td_write(td)           ((td)->o.td_ddir & TD_DDIR_WRITE)
+#define td_rw(td)              (((td)->o.td_ddir & TD_DDIR_RW) == TD_DDIR_RW)
+#define td_random(td)          ((td)->o.td_ddir & TD_DDIR_RAND)
 
 #define BLOCKS_PER_MAP         (8 * sizeof(long))
-#define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->rw_min_bs))
+#define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->o.rw_min_bs))
 #define RAND_MAP_IDX(td, f, b) (TO_MAP_BLOCK(td, f, b) / BLOCKS_PER_MAP)
 #define RAND_MAP_BIT(td, f, b) (TO_MAP_BLOCK(td, f, b) & (BLOCKS_PER_MAP - 1))
 
@@ -483,9 +616,9 @@ static inline int should_fsync(struct thread_data *td)
 {
        if (td->last_was_sync)
                return 0;
-       if (td->odirect)
+       if (td->o.odirect)
                return 0;
-       if (td_write(td) || td_rw(td) || td->override_sync)
+       if (td_write(td) || td_rw(td) || td->o.override_sync)
                return 1;
 
        return 0;
@@ -520,11 +653,6 @@ struct disk_util {
        struct timeval time;
 };
 
-/*
- * Callback for io completion
- */
-typedef int (endio_handler)(struct io_u *);
-
 #define DISK_UTIL_MSEC (250)
 
 #ifndef min
@@ -558,7 +686,6 @@ extern void disk_util_timer_arm(void);
 extern void setup_log(struct io_log **);
 extern void finish_log(struct thread_data *, struct io_log *, const char *);
 extern void __finish_log(struct io_log *, const char *);
-extern int setup_rate(struct thread_data *);
 extern struct io_log *agg_io_log[2];
 extern int write_bw_log;
 extern void add_agg_sample(unsigned long, enum fio_ddir);
@@ -574,15 +701,24 @@ extern unsigned long time_since_now(struct timeval *);
 extern unsigned long mtime_since_genesis(void);
 extern void __usec_sleep(unsigned int);
 extern void usec_sleep(struct thread_data *, unsigned long);
-extern void rate_throttle(struct thread_data *, unsigned long, unsigned int, int);
+extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
 extern void fill_start_time(struct timeval *);
 extern void fio_gettime(struct timeval *, void *);
+extern void set_genesis_time(void);
 
 /*
- * Init functions
+ * Init/option functions
  */
 extern int __must_check parse_options(int, char **);
-extern int __must_check init_random_state(struct thread_data *);
+extern int fio_option_parse(struct thread_data *, const char *);
+extern int fio_cmd_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_dup_and_init(struct option *);
+extern void options_mem_dupe(struct thread_data *);
+extern void options_mem_free(struct thread_data *);
+#define FIO_GETOPT_JOB         0x89988998
+#define FIO_NR_OPTIONS         128
 
 /*
  * File setup/shutdown
@@ -591,6 +727,14 @@ extern void close_files(struct thread_data *);
 extern int __must_check setup_files(struct thread_data *);
 extern int __must_check open_files(struct thread_data *);
 extern int __must_check file_invalidate_cache(struct thread_data *, struct fio_file *);
+extern int __must_check generic_open_file(struct thread_data *, struct fio_file *);
+extern void generic_close_file(struct thread_data *, struct fio_file *);
+extern void add_file(struct thread_data *, const char *);
+extern void get_file(struct fio_file *);
+extern void put_file(struct thread_data *, struct fio_file *);
+extern int add_dir_files(struct thread_data *, const char *);
+extern int init_random_map(struct thread_data *);
+extern void dup_files(struct thread_data *, struct thread_data *);
 
 /*
  * ETA/status stuff
@@ -620,7 +764,7 @@ enum {
  */
 extern void populate_verify_io_u(struct thread_data *, struct io_u *);
 extern int __must_check get_next_verify(struct thread_data *td, struct io_u *);
-extern int __must_check verify_io_u(struct io_u *);
+extern int __must_check verify_io_u(struct thread_data *, struct io_u *);
 
 /*
  * Memory helpers
@@ -638,11 +782,13 @@ extern struct io_u *__get_io_u(struct thread_data *);
 extern struct io_u *get_io_u(struct thread_data *);
 extern void put_io_u(struct thread_data *, struct io_u *);
 extern void requeue_io_u(struct thread_data *, struct io_u **);
-extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *, endio_handler *);
-extern long __must_check io_u_queued_complete(struct thread_data *, int, endio_handler *);
+extern long __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
+extern long __must_check io_u_queued_complete(struct thread_data *, int);
 extern void io_u_queued(struct thread_data *, struct io_u *);
+extern void io_u_log_error(struct thread_data *, struct io_u *);
 extern void io_u_init_timeout(void);
 extern void io_u_set_timeout(struct thread_data *);
+extern void io_u_mark_depth(struct thread_data *, struct io_u *);
 
 /*
  * io engine entry points
@@ -653,30 +799,8 @@ extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
 extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
 extern int __must_check td_io_getevents(struct thread_data *, int, int, struct timespec *);
 extern int __must_check td_io_commit(struct thread_data *);
-
-/*
- * This is a pretty crappy semaphore implementation, but with the use that fio
- * has (just signalling start/go conditions), it doesn't have to be better.
- * Naturally this would not work for any type of contended semaphore or
- * for real locking.
- */
-static inline void fio_sem_init(volatile int *sem, int val)
-{
-       *sem = val;
-}
-
-static inline void fio_sem_down(volatile int *sem)
-{
-       while (*sem == 0)
-               usleep(10000);
-
-       (*sem)--;
-}
-
-static inline void fio_sem_up(volatile int *sem)
-{
-       (*sem)++;
-}
+extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
+extern void td_io_close_file(struct thread_data *, struct fio_file *);
 
 /*
  * If logging output to a file, stderr should go to both stderr and f_err
@@ -687,6 +811,11 @@ static inline void fio_sem_up(volatile int *sem)
                fprintf(stderr, ##args);        \
        } while (0)
 
+#define log_info(args...)      fprintf(f_out, ##args)
+
+FILE *get_f_out(void);
+FILE *get_f_err(void);
+
 struct ioengine_ops {
        struct list_head list;
        char name[16];
@@ -701,12 +830,13 @@ struct ioengine_ops {
        struct io_u *(*event)(struct thread_data *, int);
        int (*cancel)(struct thread_data *, struct io_u *);
        void (*cleanup)(struct thread_data *);
+       int (*open_file)(struct thread_data *, struct fio_file *);
+       void (*close_file)(struct thread_data *, struct fio_file *);
        void *data;
        void *dlhandle;
-       unsigned long priv;
 };
 
-#define FIO_IOOPS_VERSION      5
+#define FIO_IOOPS_VERSION      7
 
 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
 extern void register_ioengine(struct ioengine_ops *);
@@ -723,7 +853,7 @@ extern void close_ioengine(struct thread_data *);
 #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)        \
-       for ((i) = 0, (f) = &(td)->files[0]; (i) < (int) (td)->nr_files; (i)++, (f)++)
+       for ((i) = 0, (f) = &(td)->files[0]; (i) < (td)->o.nr_files; (i)++, (f)++)
 
 #define fio_assert(td, cond)   do {    \
        if (!(cond)) {                  \