Move more file stuff to file.h
[fio.git] / fio.h
diff --git a/fio.h b/fio.h
index ff4668e80f3a0d884e53cd4270c35b5813f9db58..19f7713b6558afb29e7a04097bc6aaa7adb7df2f 100644 (file)
--- a/fio.h
+++ b/fio.h
@@ -24,6 +24,8 @@
 #include "mutex.h"
 #include "log.h"
 #include "debug.h"
+#include "file.h"
+#include "io_ddir.h"
 
 #ifdef FIO_HAVE_GUASI
 #include <guasi.h>
 #include <sys/asynch.h>
 #endif
 
-enum fio_ddir {
-       DDIR_READ = 0,
-       DDIR_WRITE,
-       DDIR_SYNC,
-       DDIR_INVAL = -1,
-};
-
-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,
-};
-
-enum file_lock_mode {
-       FILE_LOCK_NONE,
-       FILE_LOCK_EXCLUSIVE,
-       FILE_LOCK_READWRITE,
-};
-
 /*
  * Use for maintaining statistics
  */
@@ -75,6 +54,7 @@ struct io_sample {
        unsigned long time;
        unsigned long val;
        enum fio_ddir ddir;
+       unsigned int bs;
 };
 
 /*
@@ -134,6 +114,7 @@ struct io_u {
 #ifdef FIO_HAVE_SOLARISAIO
                aio_result_t resultp;
 #endif
+               void *mmap_data;
        };
        struct timeval start_time;
        struct timeval issue_time;
@@ -144,7 +125,6 @@ struct io_u {
        void *buf;
        unsigned long buflen;
        unsigned long long offset;
-       unsigned long long endpos;
 
        /*
         * IO engine state, may be different from above when we get
@@ -188,61 +168,6 @@ enum {
        FIO_Q_BUSY      = 2,            /* no more room, call ->commit() */
 };
 
-#define FIO_HDR_MAGIC  0xf00baaef
-
-enum {
-       VERIFY_NONE = 0,                /* no verification */
-       VERIFY_MD5,                     /* md5 sum data blocks */
-       VERIFY_CRC64,                   /* crc64 sum data blocks */
-       VERIFY_CRC32,                   /* crc32 sum data blocks */
-       VERIFY_CRC16,                   /* crc16 sum data blocks */
-       VERIFY_CRC7,                    /* crc7 sum data blocks */
-       VERIFY_SHA256,                  /* sha256 sum data blocks */
-       VERIFY_SHA512,                  /* sha512 sum data blocks */
-       VERIFY_META,                    /* block_num, timestamp etc. */
-       VERIFY_NULL,                    /* pretend to verify */
-};
-
-/*
- * A header structure associated with each checksummed data block. It is
- * followed by a checksum specific header that contains the verification
- * data.
- */
-struct verify_header {
-       unsigned int fio_magic;
-       unsigned int len;
-       unsigned int verify_type;
-};
-
-struct vhdr_md5 {
-       uint32_t md5_digest[16];
-};
-struct vhdr_sha512 {
-       uint8_t sha512[128];
-};
-struct vhdr_sha256 {
-       uint8_t sha256[128];
-};
-struct vhdr_crc64 {
-       uint64_t crc64;
-};
-struct vhdr_crc32 {
-       uint32_t crc32;
-};
-struct vhdr_crc16 {
-       uint16_t crc16;
-};
-struct vhdr_crc7 {
-       uint8_t crc7;
-};
-struct vhdr_meta {
-       uint64_t offset;
-       unsigned char thread;
-       unsigned short numberio;
-       unsigned long time_sec;
-       unsigned long time_usec;
-};
-
 struct group_run_stats {
        unsigned long long max_run[2], min_run[2];
        unsigned long long max_bw[2], min_bw[2];
@@ -261,16 +186,6 @@ enum fio_memtype {
        MEM_MMAPHUGE,   /* memory mapped huge file */
 };
 
-/*
- * The type of object we are working on
- */
-enum fio_filetype {
-       FIO_TYPE_FILE = 1,              /* plain file */
-       FIO_TYPE_BD,                    /* block device */
-       FIO_TYPE_CHAR,                  /* character device */
-       FIO_TYPE_PIPE,                  /* pipe */
-};
-
 enum fio_ioengine_flags {
        FIO_SYNCIO      = 1 << 0,       /* io engine has synchronous ->queue */
        FIO_RAWIO       = 1 << 1,       /* some sort of direct/raw io */
@@ -282,66 +197,6 @@ enum fio_ioengine_flags {
        FIO_SIGQUIT     = 1 << 7,       /* needs SIGQUIT to exit */
 };
 
-enum fio_file_flags {
-       FIO_FILE_OPEN           = 1 << 0,       /* file is open */
-       FIO_FILE_CLOSING        = 1 << 1,       /* file being closed */
-       FIO_FILE_EXTEND         = 1 << 2,       /* needs extend */
-       FIO_FILE_DONE           = 1 << 3,       /* io completed to this file */
-       FIO_SIZE_KNOWN          = 1 << 4,       /* size has been set */
-       FIO_FILE_HASHED         = 1 << 5,       /* file is on hash */
-};
-
-/*
- * Each thread_data structure has a number of files associated with it,
- * this structure holds state information for a single file.
- */
-struct fio_file {
-       struct flist_head hash_list;
-       enum fio_filetype filetype;
-
-       /*
-        * A file may not be a file descriptor, let the io engine decide
-        */
-       union {
-               unsigned long file_data;
-               int fd;
-       };
-
-       /*
-        * filename and possible memory mapping
-        */
-       char *file_name;
-       void *mmap;
-       unsigned int major, minor;
-
-       /*
-        * 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;
-
-       /*
-        * if io is protected by a semaphore, this is set
-        */
-       struct fio_mutex *lock;
-       void *lock_owner;
-       unsigned int lock_batch;
-       enum fio_ddir lock_ddir;
-
-       /*
-        * block map for random io
-        */
-       unsigned int *file_map;
-       unsigned int num_maps;
-       unsigned int last_free_lookup;
-
-       int references;
-       enum fio_file_flags flags;
-};
-
 /*
  * How many depth levels to log
  */
@@ -427,10 +282,11 @@ struct thread_options {
        unsigned long long start_offset;
 
        unsigned int bs[2];
+       unsigned int ba[2];
        unsigned int min_bs[2];
        unsigned int max_bs[2];
-       struct bssplit *bssplit;
-       unsigned int bssplit_nr;
+       struct bssplit *bssplit[2];
+       unsigned int bssplit_nr[2];
 
        unsigned int nr_files;
        unsigned int open_files;
@@ -441,7 +297,9 @@ struct thread_options {
        unsigned int invalidate_cache;
        unsigned int create_serialize;
        unsigned int create_fsync;
+       unsigned int create_on_open;
        unsigned int end_fsync;
+       unsigned int pre_read;
        unsigned int sync_io;
        unsigned int verify;
        unsigned int do_verify;
@@ -471,6 +329,7 @@ struct thread_options {
        unsigned int fsync_blocks;
        unsigned int start_delay;
        unsigned long long timeout;
+       unsigned long long ramp_time;
        unsigned int overwrite;
        unsigned int bw_avg_time;
        unsigned int loops;
@@ -493,9 +352,17 @@ struct thread_options {
        unsigned int zero_buffers;
        unsigned int refill_buffers;
        unsigned int time_based;
+       unsigned int disable_clat;
+       unsigned int disable_slat;
+       unsigned int disable_bw;
+       unsigned int gtod_reduce;
+       unsigned int gtod_cpu;
+       unsigned int gtod_offload;
 
        char *read_iolog_file;
        char *write_iolog_file;
+       char *bw_log_file;
+       char *lat_log_file;
 
        /*
         * Pre-run and post-run shell
@@ -531,6 +398,7 @@ struct thread_data {
        int groupid;
        struct thread_stat ts;
        struct fio_file **files;
+       unsigned int files_size;
        unsigned int files_index;
        unsigned int nr_open_files;
        unsigned int nr_done_files;
@@ -558,6 +426,8 @@ struct thread_data {
 
        char *sysfs_root;
 
+       unsigned long rand_seeds[6];
+
        os_random_state_t bsrange_state;
        os_random_state_t verify_state;
 
@@ -606,7 +476,11 @@ struct thread_data {
        struct timeval epoch;   /* time job was started */
        struct timeval rw_end[2];
        struct timeval last_issue;
+       struct timeval tv_cache;
+       unsigned int tv_cache_nr;
+       unsigned int tv_cache_mask;
        unsigned int rw_end_set[2];
+       unsigned int ramp_time_over;
 
        /*
         * read/write mixed workload state
@@ -628,12 +502,6 @@ struct thread_data {
         */
        struct flist_head io_log_list;
 
-       /*
-        * timeout handling
-        */
-       struct timeval timeout_end;
-       struct itimerval timer;
-
        /*
         * for fileservice, how often to switch to a new file
         */
@@ -648,11 +516,13 @@ struct thread_data {
 };
 
 /*
- * roundrobin available files, or choose one at random.
+ * roundrobin available files, or choose one at random, or do each one
+ * serially.
  */
 enum {
        FIO_FSERVICE_RANDOM     = 1,
        FIO_FSERVICE_RR         = 2,
+       FIO_FSERVICE_SEQ        = 3,
 };
 
 /*
@@ -664,13 +534,6 @@ enum {
        FIO_ETA_NEVER,
 };
 
-/*
- * 30 second per-io_u timeout, with 5 second intervals to avoid resetting
- * the timer on each queue operation.
- */
-#define IO_U_TIMEOUT_INC       5
-#define IO_U_TIMEOUT           30
-
 #define __td_verror(td, err, msg, func)                                        \
        do {                                                            \
                if ((td)->error)                                        \
@@ -699,6 +562,8 @@ extern int read_only;
 extern int eta_print;
 extern unsigned long done_secs;
 extern char *job_section;
+extern int fio_gtod_offload;
+extern int fio_gtod_cpu;
 
 extern struct thread_data *threads;
 
@@ -749,6 +614,10 @@ struct disk_util_stat {
  */
 struct disk_util {
        struct flist_head list;
+       /* If this disk is a slave, hook it into the master's
+        * list using this head.
+        */
+       struct flist_head slavelist;
 
        char *name;
        char *sysfs_root;
@@ -758,10 +627,40 @@ struct disk_util {
        struct disk_util_stat dus;
        struct disk_util_stat last_dus;
 
+       /* For software raids, this entry maintains pointers to the
+        * entries for the slave devices. The disk_util entries for
+        * the slaves devices should primarily be maintained through
+        * the disk_list list, i.e. for memory allocation and
+        * de-allocation, etc. Whereas this list should be used only
+        * for aggregating a software RAID's disk util figures.
+        */
+       struct flist_head slaves;
+
        unsigned long msec;
        struct timeval time;
+
+       struct fio_mutex *lock;
+       unsigned long users;
 };
 
+static inline void disk_util_inc(struct disk_util *du)
+{
+       if (du) {
+               fio_mutex_down(du->lock);
+               du->users++;
+               fio_mutex_up(du->lock);
+       }
+}
+
+static inline void disk_util_dec(struct disk_util *du)
+{
+       if (du) {
+               fio_mutex_down(du->lock);
+               du->users--;
+               fio_mutex_up(du->lock);
+       }
+}
+
 #define DISK_UTIL_MSEC (250)
 
 /*
@@ -786,19 +685,23 @@ extern void write_iolog_close(struct thread_data *);
 /*
  * Logging
  */
-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 add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long,
+                               unsigned int);
+extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long,
+                               unsigned int);
+extern void add_bw_sample(struct thread_data *, enum fio_ddir, unsigned int,
+                               struct timeval *);
 extern void show_run_stats(void);
 extern void init_disk_util(struct thread_data *);
 extern void update_rusage_stat(struct thread_data *);
 extern void update_io_ticks(void);
 extern void setup_log(struct io_log **);
 extern void finish_log(struct thread_data *, struct io_log *, const char *);
+extern void finish_log_named(struct thread_data *, struct io_log *, const char *, const char *);
 extern void __finish_log(struct io_log *, const char *);
 extern struct io_log *agg_io_log[2];
 extern int write_bw_log;
-extern void add_agg_sample(unsigned long, enum fio_ddir);
+extern void add_agg_sample(unsigned long, enum fio_ddir, unsigned int);
 
 /*
  * Time functions
@@ -809,12 +712,16 @@ 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_spin(unsigned int);
 extern void usec_sleep(struct thread_data *, unsigned long);
 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 fio_gtod_init(void);
+extern void fio_gtod_update(void);
 extern void set_genesis_time(void);
+extern int ramp_time_over(struct thread_data *);
+extern int in_ramp_time(struct thread_data *);
 
 /*
  * Init/option functions
@@ -827,31 +734,10 @@ 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 *);
+extern void td_fill_rand_seeds(struct thread_data *);
 #define FIO_GETOPT_JOB         0x89988998
 #define FIO_NR_OPTIONS         128
 
-/*
- * File setup/shutdown
- */
-extern void close_files(struct thread_data *);
-extern void close_and_free_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 int __must_check generic_close_file(struct thread_data *, struct fio_file *);
-extern int add_file(struct thread_data *, const char *);
-extern void get_file(struct fio_file *);
-extern int __must_check put_file(struct thread_data *, struct fio_file *);
-extern void lock_file(struct thread_data *, struct fio_file *, enum fio_ddir);
-extern void unlock_file(struct thread_data *, struct fio_file *);
-extern void unlock_file_all(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 *);
-extern int get_fileno(struct thread_data *, const char *);
-extern void free_release_files(struct thread_data *);
-
 /*
  * ETA/status stuff
  */
@@ -881,19 +767,16 @@ enum {
        TD_NOT_CREATED = 0,
        TD_CREATED,
        TD_INITIALIZED,
+       TD_RAMP,
        TD_RUNNING,
+       TD_PRE_READING,
        TD_VERIFYING,
        TD_FSYNCING,
        TD_EXITED,
        TD_REAPED,
 };
 
-/*
- * Verify helpers
- */
-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 thread_data *, struct io_u *);
+extern void td_set_runstate(struct thread_data *, int);
 
 /*
  * Memory helpers
@@ -915,13 +798,16 @@ 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 *, unsigned int);
 extern void io_u_fill_buffer(struct thread_data *td, struct io_u *, unsigned int);
 void io_u_mark_complete(struct thread_data *, unsigned int);
 void io_u_mark_submit(struct thread_data *, unsigned int);
 
+/*
+ * Reset stats after ramp time completes
+ */
+extern void reset_all_stats(struct thread_data *);
+
 /*
  * io engine entry points
  */
@@ -933,6 +819,7 @@ extern int __must_check td_io_getevents(struct thread_data *, unsigned int, unsi
 extern int __must_check td_io_commit(struct thread_data *);
 extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
 extern int td_io_close_file(struct thread_data *, struct fio_file *);
+extern int __must_check td_io_get_file_size(struct thread_data *, struct fio_file *);
 
 /*
  * blktrace support
@@ -958,11 +845,12 @@ struct ioengine_ops {
        void (*cleanup)(struct thread_data *);
        int (*open_file)(struct thread_data *, struct fio_file *);
        int (*close_file)(struct thread_data *, struct fio_file *);
+       int (*get_file_size)(struct thread_data *, struct fio_file *);
        void *data;
        void *dlhandle;
 };
 
-#define FIO_IOOPS_VERSION      9
+#define FIO_IOOPS_VERSION      10
 
 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
 extern void register_ioengine(struct ioengine_ops *);
@@ -998,6 +886,8 @@ static inline void fio_file_reset(struct fio_file *f)
 {
        f->last_free_lookup = 0;
        f->last_pos = f->file_offset;
+       if (f->file_map)
+               memset(f->file_map, 0, f->num_maps * sizeof(int));
 }
 
 static inline void clear_error(struct thread_data *td)
@@ -1025,4 +915,13 @@ static inline void dprint_io_u(struct io_u *io_u, const char *p)
 #define dprint_io_u(io_u, p)
 #endif
 
+static inline int 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 0;
+}
+
 #endif