Cleanup end IO handling
[fio.git] / fio.h
diff --git a/fio.h b/fio.h
index 1115c62ea3b7555fdaf6e43368b15c6e3086099e..aa66ecd4e06bce3dbe7591c8fad859e05f7571b9 100644 (file)
--- a/fio.h
+++ b/fio.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
@@ -59,19 +89,32 @@ 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;
 
+       /*
+        * Allocated/set buffer and length
+        */
        void *buf;
-       unsigned int buflen;
+       unsigned long buflen;
        unsigned long long offset;
 
+       /*
+        * 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 ddir;
+       enum fio_ddir ddir;
 
        /*
         * io engine private data
@@ -86,14 +129,25 @@ struct io_u {
        struct list_head list;
 };
 
+/*
+ * io_ops->queue() return values
+ */
+enum {
+       FIO_Q_COMPLETED = 0,            /* completed sync */
+       FIO_Q_QUEUED    = 1,            /* queued, will complete async */
+};
+
 #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;
@@ -111,37 +165,39 @@ struct group_run_stats {
        unsigned long long agg[2];
 };
 
-enum fio_ddir {
-       DDIR_READ = 0,
-       DDIR_WRITE,
-       DDIR_SYNC,
-};
-
 /*
  * 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_RAWIO       = 1 << 3,
+       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
@@ -156,15 +212,29 @@ struct fio_file {
        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 *description;
        char *name;
        char *directory;
        char *filename;
@@ -209,8 +279,11 @@ struct thread_data {
        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;
@@ -220,6 +293,8 @@ 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 numjobs;
        unsigned int iodepth;
@@ -254,6 +329,9 @@ 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;
 
@@ -307,6 +385,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
@@ -355,8 +434,8 @@ extern int groupid;
 extern int terse_output;
 extern FILE *f_out;
 extern FILE *f_err;
-extern const char *fio_inst_prefix;
 extern int temp_stall_ts;
+extern unsigned long long mlock_size;
 
 extern struct thread_data *threads;
 
@@ -383,6 +462,9 @@ static inline int should_fsync(struct thread_data *td)
        return 0;
 }
 
+/*
+ * Disk utils as read in /sys/block/<dev>/stat
+ */
 struct disk_util_stat {
        unsigned ios[2];
        unsigned merges[2];
@@ -392,6 +474,9 @@ struct disk_util_stat {
        unsigned time_in_queue;
 };
 
+/*
+ * Per-device disk util management
+ */
 struct disk_util {
        struct list_head list;
 
@@ -406,12 +491,10 @@ 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)
 
@@ -435,9 +518,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 *);
@@ -445,13 +528,17 @@ 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 void time_init(void);
 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 *);
@@ -460,6 +547,7 @@ 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 fill_start_time(struct timeval *);
+extern void fio_gettime(struct timeval *, void *);
 
 /*
  * Init functions
@@ -503,7 +591,7 @@ enum {
  */
 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 do_io_u_verify(struct thread_data *, struct io_u **);
+extern int verify_io_u(struct io_u *);
 
 /*
  * Memory helpers
@@ -520,8 +608,8 @@ extern void free_io_mem(struct thread_data *);
 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 ios_completed(struct thread_data *, struct io_completion_data *);
-extern void io_completed(struct thread_data *, struct io_u *, struct io_completion_data *);
+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
@@ -580,9 +668,10 @@ struct ioengine_ops {
        void (*cleanup)(struct thread_data *);
        void *data;
        void *dlhandle;
+       unsigned long priv;
 };
 
-#define FIO_IOOPS_VERSION      3
+#define FIO_IOOPS_VERSION      4
 
 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
 extern int register_ioengine(struct ioengine_ops *);
@@ -601,4 +690,14 @@ extern void close_ioengine(struct thread_data *);
 #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