Add support for queuing > 1 command at the time
[fio.git] / fio.h
diff --git a/fio.h b/fio.h
index db39ea125ec31a9c74bdde4d23c51648e353cff9..baaa9a8d51f57512d2a5ed062e12fa0d4cc658be 100644 (file)
--- a/fio.h
+++ b/fio.h
@@ -10,6 +10,7 @@
 #include <stdlib.h>
 #include <stdio.h>
 #include <unistd.h>
+#include <string.h>
 
 #include "list.h"
 #include "md5.h"
 #include "arch.h"
 #include "os.h"
 
+#ifdef FIO_HAVE_SYSLET
+#include "syslet.h"
+#endif
+
+enum fio_ddir {
+       DDIR_READ = 0,
+       DDIR_WRITE,
+       DDIR_SYNC,
+};
+
+/*
+ * Use for maintaining statistics
+ */
 struct io_stat {
-       unsigned long val;
-       unsigned long val_sq;
        unsigned long max_val;
        unsigned long min_val;
        unsigned long samples;
+
+       double mean;
+       double S;
 };
 
+/*
+ * A single data sample
+ */
 struct io_sample {
        unsigned long time;
        unsigned long val;
-       unsigned int ddir;
+       enum fio_ddir ddir;
 };
 
+/*
+ * Dynamically growing data sample log
+ */
 struct io_log {
        unsigned long nr_samples;
        unsigned long max_samples;
        struct io_sample *log;
 };
 
+/*
+ * When logging io actions, this matches a single sent io_u
+ */
 struct io_piece {
        struct list_head list;
+       struct fio_file *file;
        unsigned long long offset;
-       unsigned int len;
-       int ddir;
+       unsigned long len;
+       enum fio_ddir ddir;
 };
 
+#ifdef FIO_HAVE_SYSLET
+struct syslet_req {
+       struct syslet_uatom atom;
+       long ret;
+};
+#endif
+
 /*
  * The io unit
  */
@@ -57,33 +89,66 @@ struct io_u {
 #endif
 #ifdef FIO_HAVE_SGIO
                struct sg_io_hdr hdr;
+#endif
+#ifdef FIO_HAVE_SYSLET
+               struct syslet_req req;
 #endif
        };
        struct timeval start_time;
        struct timeval issue_time;
 
-       char *buf;
-       unsigned int buflen;
+       /*
+        * Allocated/set buffer and length
+        */
+       void *buf;
+       unsigned long buflen;
        unsigned long long offset;
-       unsigned int index;
+
+       /*
+        * IO engine state, may be different from above when we get
+        * partial transfers / residual data counts
+        */
+       void *xfer_buf;
+       unsigned long xfer_buflen;
 
        unsigned int resid;
        unsigned int error;
 
-       unsigned char seen;
-       unsigned char ddir;
+       enum fio_ddir ddir;
+
+       /*
+        * io engine private data
+        */
+       union {
+               unsigned int index;
+               unsigned int seen;
+       };
+
+       struct fio_file *file;
 
        struct list_head list;
 };
 
+/*
+ * io_ops->queue() return values
+ */
+enum {
+       FIO_Q_COMPLETED = 0,            /* completed sync */
+       FIO_Q_QUEUED    = 1,            /* queued, will complete async */
+       FIO_Q_BUSY      = 2,            /* no more room, call ->commit() */
+};
+
 #define FIO_HDR_MAGIC  0xf00baaef
 
 enum {
-       VERIFY_NONE = 0,
-       VERIFY_MD5,
-       VERIFY_CRC32,
+       VERIFY_NONE = 0,                /* no verification */
+       VERIFY_MD5,                     /* md5 sum data blocks */
+       VERIFY_CRC32,                   /* crc32 sum data blocks */
 };
 
+/*
+ * A header structure associated with each checksummed data block
+ */
 struct verify_header {
        unsigned int fio_magic;
        unsigned int len;
@@ -101,50 +166,89 @@ struct group_run_stats {
        unsigned long long agg[2];
 };
 
-enum fio_ddir {
-       DDIR_READ = 0,
-       DDIR_WRITE,
-};
-
 /*
  * What type of allocation to use for io buffers
  */
 enum fio_memtype {
        MEM_MALLOC = 0, /* ordinary malloc */
        MEM_SHM,        /* use shared memory segments */
+       MEM_SHMHUGE,    /* use shared memory segments with huge pages */
        MEM_MMAP,       /* use anonynomous mmap */
+       MEM_MMAPHUGE,   /* memory mapped huge file */
 };
 
 /*
  * The type of object we are working on
  */
 enum fio_filetype {
-       FIO_TYPE_FILE = 1,
-       FIO_TYPE_BD,
-       FIO_TYPE_CHAR,
+       FIO_TYPE_FILE = 1,              /* plain file */
+       FIO_TYPE_BD,                    /* block device */
+       FIO_TYPE_CHAR,                  /* character device */
 };
 
 enum fio_ioengine_flags {
-       FIO_SYNCIO      = 1 << 0,
-       FIO_CPUIO       = 1 << 1,
-       FIO_MMAPIO      = 1 << 2,
+       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) */
+};
+
+/*
+ * Each thread_data structure has a number of files associated with it,
+ * this structure holds state information for a single file.
+ */
+struct fio_file {
+       /*
+        * A file may not be a file descriptor, let the io engine decide
+        */
+       union {
+               unsigned long file_data;
+               int fd;
+       };
+       char *file_name;
+       void *mmap;
+       unsigned long long file_size;
+       unsigned long long real_file_size;
+       unsigned long long file_offset;
+       unsigned long long last_pos;
+       unsigned long long last_completed_pos;
+
+       /*
+        * block map for random io
+        */
+       unsigned long *file_map;
+       unsigned int num_maps;
+       unsigned int last_free_lookup;
+
+       unsigned int unlink;
 };
 
+/*
+ * How many depth levels to log
+ */
+#define FIO_IO_U_MAP_NR        8
+#define FIO_IO_U_LAT_NR 12
+
 /*
  * This describes a single thread/process executing a fio job.
  */
 struct thread_data {
-       char name[32];
-       char *file_name;
+       char *description;
+       char *name;
        char *directory;
+       char *filename;
        char verror[80];
        pthread_t thread;
        int thread_number;
        int groupid;
        enum fio_filetype filetype;
+       struct fio_file *files;
+       unsigned int nr_files;
+       unsigned int nr_uniq_files;
+       unsigned int next_file;
        int error;
-       int fd;
-       void *mmap;
        pid_t pid;
        char *orig_buffer;
        size_t orig_buffer_size;
@@ -153,49 +257,58 @@ struct thread_data {
        enum fio_ddir ddir;
        unsigned int iomix;
        unsigned int ioprio;
-
-       unsigned char sequential;
-       unsigned char odirect;
-       unsigned char create_file;
-       unsigned char invalidate_cache;
-       unsigned char create_serialize;
-       unsigned char create_fsync;
-       unsigned char end_fsync;
-       unsigned char sync_io;
-       unsigned char verify;
-       unsigned char use_thread;
-       unsigned char do_disk_util;
-       unsigned char override_sync;
-       unsigned char rand_repeatable;
-
-       unsigned int bs;
-       unsigned int min_bs;
-       unsigned int max_bs;
+       unsigned int last_was_sync;
+
+       unsigned int sequential;
+       unsigned int odirect;
+       unsigned int invalidate_cache;
+       unsigned int create_serialize;
+       unsigned int create_fsync;
+       unsigned int end_fsync;
+       unsigned int sync_io;
+       unsigned int verify;
+       unsigned int use_thread;
+       unsigned int unlink;
+       unsigned int do_disk_util;
+       unsigned int override_sync;
+       unsigned int rand_repeatable;
+       unsigned int write_lat_log;
+       unsigned int write_bw_log;
+       unsigned int norandommap;
+       unsigned int bs_unaligned;
+
+       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;
+       unsigned int thinktime_spin;
+       unsigned int thinktime_blocks;
        unsigned int fsync_blocks;
        unsigned int start_delay;
        unsigned long timeout;
        unsigned int overwrite;
        unsigned int bw_avg_time;
        unsigned int loops;
-       unsigned long long file_size;
-       unsigned long long real_file_size;
-       unsigned long long file_offset;
        unsigned long long zone_size;
        unsigned long long zone_skip;
        enum fio_memtype mem_type;
+       char *mmapfile;
+       int mmapfd;
        unsigned int stonewall;
        unsigned int numjobs;
        unsigned int iodepth;
        os_cpu_mask_t cpumask;
        unsigned int iolog;
        unsigned int read_iolog;
-       unsigned int write_iolog;
        unsigned int rwmixcycle;
        unsigned int rwmixread;
+       unsigned int rwmixwrite;
        unsigned int nice;
 
-       char *iolog_file;
+       char *read_iolog_file;
+       char *write_iolog_file;
        void *iolog_buf;
        FILE *iolog_f;
 
@@ -217,8 +330,12 @@ 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;
 
        /*
         * Rate state
@@ -233,21 +350,21 @@ struct thread_data {
 
        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];
        unsigned long long io_blocks[2];
        unsigned long long io_bytes[2];
        unsigned long long zone_bytes;
        unsigned long long this_io_bytes[2];
-       unsigned long long last_pos;
        volatile int mutex;
 
        /*
         * State for random io, a bitmap of blocks done vs not done
         */
        os_random_state_t random_state;
-       unsigned long *file_map;
-       unsigned int num_maps;
 
        /*
         * CPU "io" cycle burner
@@ -271,6 +388,7 @@ struct thread_data {
 
        struct timeval start;   /* start of this loop */
        struct timeval epoch;   /* time job was started */
+       struct timeval end_time;/* time job ended */
 
        /*
         * fio system usage accounting
@@ -312,12 +430,6 @@ struct thread_data {
 #define td_verror(td, err)     __td_verror((td), (err), strerror((err)))
 #define td_vmsg(td, err, msg)  __td_verror((td), (err), (msg))
 
-extern struct io_u *__get_io_u(struct thread_data *);
-extern void put_io_u(struct thread_data *, struct io_u *);
-
-extern int rate_quit;
-extern int write_lat_log;
-extern int write_bw_log;
 extern int exitall_on_terminate;
 extern int thread_number;
 extern int shm_id;
@@ -325,7 +437,8 @@ extern int groupid;
 extern int terse_output;
 extern FILE *f_out;
 extern FILE *f_err;
-extern char *fio_inst_prefix;
+extern int temp_stall_ts;
+extern unsigned long long mlock_size;
 
 extern struct thread_data *threads;
 
@@ -334,12 +447,27 @@ extern struct thread_data *threads;
 #define td_rw(td)              ((td)->iomix != 0)
 
 #define BLOCKS_PER_MAP         (8 * sizeof(long))
-#define TO_MAP_BLOCK(td, b)    ((b) - ((td)->file_offset / (td)->min_bs))
-#define RAND_MAP_IDX(td, b)    (TO_MAP_BLOCK(td, b) / BLOCKS_PER_MAP)
-#define RAND_MAP_BIT(td, b)    (TO_MAP_BLOCK(td, b) & (BLOCKS_PER_MAP - 1))
+#define TO_MAP_BLOCK(td, f, b) ((b) - ((f)->file_offset / (td)->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))
 
 #define MAX_JOBS       (1024)
 
+static inline int should_fsync(struct thread_data *td)
+{
+       if (td->last_was_sync)
+               return 0;
+       if (td->odirect)
+               return 0;
+       if (td_write(td) || td_rw(td) || td->override_sync)
+               return 1;
+
+       return 0;
+}
+
+/*
+ * Disk utils as read in /sys/block/<dev>/stat
+ */
 struct disk_util_stat {
        unsigned ios[2];
        unsigned merges[2];
@@ -349,6 +477,9 @@ struct disk_util_stat {
        unsigned time_in_queue;
 };
 
+/*
+ * Per-device disk util management
+ */
 struct disk_util {
        struct list_head list;
 
@@ -363,18 +494,19 @@ struct disk_util {
        struct timeval time;
 };
 
-struct io_completion_data {
-       int nr;                         /* input */
-
-       int error;                      /* output */
-       unsigned long bytes_done[2];    /* output */
-};
+/*
+ * Callback for io completion
+ */
+typedef int (endio_handler)(struct io_u *);
 
 #define DISK_UTIL_MSEC (250)
 
 #ifndef min
 #define min(a, b)      ((a) < (b) ? (a) : (b))
 #endif
+#ifndef max
+#define max(a, b)      ((a) > (b) ? (a) : (b))
+#endif
 
 /*
  * Log exports
@@ -389,9 +521,9 @@ extern void write_iolog_close(struct thread_data *);
 /*
  * Logging
  */
-extern void add_clat_sample(struct thread_data *, int, unsigned long);
-extern void add_slat_sample(struct thread_data *, int, unsigned long);
-extern void add_bw_sample(struct thread_data *, int);
+extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long);
+extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long);
+extern void add_bw_sample(struct thread_data *, enum fio_ddir, struct timeval *);
 extern void show_run_stats(void);
 extern void init_disk_util(struct thread_data *);
 extern void update_rusage_stat(struct thread_data *);
@@ -399,18 +531,26 @@ extern void update_io_ticks(void);
 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);
 
 /*
  * Time functions
  */
 extern unsigned long utime_since(struct timeval *, struct timeval *);
+extern unsigned long utime_since_now(struct timeval *);
 extern unsigned long mtime_since(struct timeval *, struct timeval *);
 extern unsigned long mtime_since_now(struct timeval *);
 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);
+extern void rate_throttle(struct thread_data *, unsigned long, unsigned int, int);
+extern void fill_start_time(struct timeval *);
+extern void fio_gettime(struct timeval *, void *);
 
 /*
  * Init functions
@@ -418,6 +558,73 @@ extern void rate_throttle(struct thread_data *, unsigned long, unsigned int);
 extern int parse_options(int, char **);
 extern int init_random_state(struct thread_data *);
 
+/*
+ * File setup/shutdown
+ */
+extern void close_files(struct thread_data *);
+extern int setup_files(struct thread_data *);
+extern int open_files(struct thread_data *);
+extern int file_invalidate_cache(struct thread_data *, struct fio_file *);
+
+/*
+ * ETA/status stuff
+ */
+extern void print_thread_status(void);
+extern void print_status_init(int);
+
+/*
+ * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
+ * will never back again. It may cycle between running/verififying/fsyncing.
+ * Once the thread reaches TD_EXITED, it is just waiting for the core to
+ * reap it.
+ */
+enum {
+       TD_NOT_CREATED = 0,
+       TD_CREATED,
+       TD_INITIALIZED,
+       TD_RUNNING,
+       TD_VERIFYING,
+       TD_FSYNCING,
+       TD_EXITED,
+       TD_REAPED,
+};
+
+/*
+ * Verify helpers
+ */
+extern void populate_verify_io_u(struct thread_data *, struct io_u *);
+extern int get_next_verify(struct thread_data *td, struct io_u *);
+extern int verify_io_u(struct io_u *);
+
+/*
+ * Memory helpers
+ */
+extern int fio_pin_memory(void);
+extern void fio_unpin_memory(void);
+extern int allocate_io_mem(struct thread_data *);
+extern void free_io_mem(struct thread_data *);
+
+/*
+ * io unit handling
+ */
+#define queue_full(td) list_empty(&(td)->io_u_freelist)
+extern struct io_u *__get_io_u(struct thread_data *);
+extern struct io_u *get_io_u(struct thread_data *, struct fio_file *);
+extern void put_io_u(struct thread_data *, struct io_u *);
+extern void requeue_io_u(struct thread_data *, struct io_u **);
+extern long io_u_sync_complete(struct thread_data *, struct io_u *, endio_handler *);
+extern long io_u_queued_complete(struct thread_data *, int, endio_handler *);
+
+/*
+ * io engine entry points
+ */
+extern int td_io_init(struct thread_data *);
+extern int td_io_prep(struct thread_data *, struct io_u *);
+extern int td_io_queue(struct thread_data *, struct io_u *);
+extern int td_io_sync(struct thread_data *, struct fio_file *);
+extern int td_io_getevents(struct thread_data *, int, int, struct timespec *);
+extern int 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.
@@ -452,6 +659,7 @@ static inline void fio_sem_up(volatile int *sem)
        } while (0)
 
 struct ioengine_ops {
+       struct list_head list;
        char name[16];
        int version;
        int flags;
@@ -459,23 +667,43 @@ struct ioengine_ops {
        int (*init)(struct thread_data *);
        int (*prep)(struct thread_data *, struct io_u *);
        int (*queue)(struct thread_data *, struct io_u *);
+       int (*commit)(struct thread_data *);
        int (*getevents)(struct thread_data *, int, int, struct timespec *);
        struct io_u *(*event)(struct thread_data *, int);
        int (*cancel)(struct thread_data *, struct io_u *);
        void (*cleanup)(struct thread_data *);
-       int (*sync)(struct thread_data *);
        void *data;
        void *dlhandle;
+       unsigned long priv;
 };
 
-#define FIO_IOOPS_VERSION      1
+#define FIO_IOOPS_VERSION      5
 
-extern struct ioengine_ops *load_ioengine(struct thread_data *, char *);
+extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
+extern int register_ioengine(struct ioengine_ops *);
+extern void unregister_ioengine(struct ioengine_ops *);
 extern void close_ioengine(struct thread_data *);
 
 /*
  * Mark unused variables passed to ops functions as unused, to silence gcc
  */
 #define fio_unused     __attribute((__unused__))
+#define fio_init       __attribute__((constructor))
+#define fio_exit       __attribute__((destructor))
+
+#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)++)
+
+#define fio_assert(td, cond)   do {    \
+       if (!(cond)) {                  \
+               int *__foo = NULL;      \
+               fprintf(stderr, "file:%s:%d, assert %s failed\n", __FILE__, __LINE__, #cond);   \
+               (td)->runstate = TD_EXITED;     \
+               (td)->error = EFAULT;           \
+               *__foo = 0;                     \
+       }       \
+} while (0)
 
 #endif