Full readonly check
[fio.git] / fio.h
diff --git a/fio.h b/fio.h
index 2b4b3c65e1974926386f987b0f1aa462ed2fcdc5..1b392a0372b0ddbe60984eefc1cc09b60180ffc4 100644 (file)
--- a/fio.h
+++ b/fio.h
 #include <unistd.h>
 #include <string.h>
 #include <getopt.h>
+#include <inttypes.h>
+#include <assert.h>
 
+#include "compiler/compiler.h"
 #include "list.h"
-#include "md5.h"
-#include "crc32.h"
-#include "arch.h"
-#include "os.h"
+#include "fifo.h"
+#include "rbtree.h"
+#include "arch/arch.h"
+#include "os/os.h"
 #include "mutex.h"
 
 #ifdef FIO_HAVE_SYSLET
@@ -32,6 +35,7 @@ enum fio_ddir {
        DDIR_READ = 0,
        DDIR_WRITE,
        DDIR_SYNC,
+       DDIR_INVAL = -1,
 };
 
 enum td_ddir {
@@ -78,11 +82,21 @@ struct io_log {
  * When logging io actions, this matches a single sent io_u
  */
 struct io_piece {
-       struct list_head list;
-       struct fio_file *file;
+       union {
+               struct rb_node rb_node;
+               struct list_head list;
+       };
+       union {
+               int fileno;
+               struct fio_file *file;
+       };
        unsigned long long offset;
        unsigned long len;
        enum fio_ddir ddir;
+       union {
+               unsigned long delay;
+               unsigned int file_action;
+       };
 };
 
 #ifdef FIO_HAVE_SYSLET
@@ -98,6 +112,8 @@ enum {
        IO_U_F_FLIGHT   = 1 << 1,
 };
 
+struct thread_data;
+
 /*
  * The io unit
  */
@@ -128,6 +144,7 @@ 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
@@ -158,7 +175,7 @@ struct io_u {
        /*
         * Callback for io completion
         */
-       int (*end_io)(struct io_u *);
+       int (*end_io)(struct thread_data *, struct io_u *);
 };
 
 /*
@@ -175,20 +192,55 @@ enum {
 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_PATTERN,                 /* verify a specific pattern */
+       VERIFY_NULL,                    /* pretend to verify */
 };
 
 /*
- * A header structure associated with each checksummed data block
+ * 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;
-       union {
-               char md5_digest[MD5_HASH_WORDS * 4];
-               unsigned long crc32;
-       };
+};
+
+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 {
@@ -216,6 +268,7 @@ 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 {
@@ -224,13 +277,17 @@ enum fio_ioengine_flags {
        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 */
+       FIO_UNIDIR      = 1 << 5,       /* engine is uni-directional */
 };
 
 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,       /* no need to create */
+       FIO_FILE_CLOSING        = 1 << 1,       /* file being closed */
+       FIO_FILE_EXISTS         = 1 << 2,       /* file there */
+       FIO_FILE_EXTEND         = 1 << 3,       /* needs extend */
+       FIO_FILE_NOSORT         = 1 << 4,       /* don't sort verify blocks */
+       FIO_FILE_DONE           = 1 << 5,       /* io completed to this file */
+       FIO_SIZE_KNOWN          = 1 << 6,       /* size has been set */
 };
 
 /*
@@ -247,11 +304,21 @@ struct fio_file {
                unsigned long file_data;
                int fd;
        };
+
+       /*
+        * filename and possible memory mapping
+        */
        char *file_name;
        void *mmap;
-       unsigned long long file_size;
+       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;
        unsigned long long last_completed_pos;
 
@@ -270,7 +337,8 @@ struct fio_file {
  * How many depth levels to log
  */
 #define FIO_IO_U_MAP_NR        8
-#define FIO_IO_U_LAT_NR 12
+#define FIO_IO_U_LAT_U_NR 10
+#define FIO_IO_U_LAT_M_NR 12
 
 struct thread_stat {
        char *name;
@@ -303,13 +371,16 @@ struct thread_stat {
        unsigned long usr_time;
        unsigned long sys_time;
        unsigned long ctx;
+       unsigned long minf, majf;
 
        /*
         * 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 int io_u_lat_u[FIO_IO_U_LAT_U_NR];
+       unsigned int io_u_lat_m[FIO_IO_U_LAT_M_NR];
        unsigned long total_io_u[2];
+       unsigned long short_io_u[2];
 
        unsigned long long io_bytes[2];
        unsigned long runtime[2];
@@ -325,6 +396,7 @@ struct thread_options {
        char *opendir;
        char *ioengine;
        enum td_ddir td_ddir;
+       unsigned int ddir_nr;
        unsigned int iodepth;
        unsigned int iodepth_low;
        unsigned int iodepth_batch;
@@ -348,6 +420,13 @@ struct thread_options {
        unsigned int end_fsync;
        unsigned int sync_io;
        unsigned int verify;
+       unsigned int do_verify;
+       unsigned int verifysort;
+       unsigned int verify_interval;
+       unsigned int verify_offset;
+       unsigned int verify_pattern;
+       unsigned int verify_pattern_bytes;
+       unsigned int verify_fatal;
        unsigned int use_thread;
        unsigned int unlink;
        unsigned int do_disk_util;
@@ -366,7 +445,7 @@ struct thread_options {
        unsigned int thinktime_blocks;
        unsigned int fsync_blocks;
        unsigned int start_delay;
-       unsigned long timeout;
+       unsigned long long timeout;
        unsigned int overwrite;
        unsigned int bw_avg_time;
        unsigned int loops;
@@ -378,14 +457,16 @@ struct thread_options {
        unsigned int new_group;
        unsigned int numjobs;
        os_cpu_mask_t cpumask;
+       unsigned int cpumask_set;
        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;
+       unsigned int zero_buffers;
+       unsigned int time_based;
 
        char *read_iolog_file;
        char *write_iolog_file;
@@ -411,12 +492,14 @@ struct thread_options {
        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[128];
+       char verror[FIO_VERROR_SIZE];
        pthread_t thread;
        int thread_number;
        int groupid;
@@ -424,12 +507,14 @@ struct thread_data {
        struct fio_file *files;
        unsigned int files_index;
        unsigned int nr_open_files;
+       unsigned int nr_done_files;
        unsigned int nr_normal_files;
        union {
                unsigned int next_file;
                os_random_state_t next_file_state;
        };
        int error;
+       int done;
        pid_t pid;
        char *orig_buffer;
        size_t orig_buffer_size;
@@ -475,12 +560,12 @@ struct thread_data {
        unsigned long rate_blocks;
        struct timeval lastrate;
 
-       unsigned long long io_size;
        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 io_skip_bytes;
        unsigned long long this_io_bytes[2];
        unsigned long long zone_bytes;
        struct fio_sem *mutex;
@@ -492,6 +577,9 @@ struct thread_data {
 
        struct timeval start;   /* start of this loop */
        struct timeval epoch;   /* time job was started */
+       struct timeval rw_end[2];
+       struct timeval last_issue;
+       unsigned int rw_end_set[2];
 
        /*
         * read/write mixed workload state
@@ -500,11 +588,18 @@ struct thread_data {
        unsigned long long rwmix_bytes;
        struct timeval rwmix_switch;
        enum fio_ddir rwmix_ddir;
+       unsigned int ddir_nr;
 
        /*
-        * IO historic logs
+        * IO history logs for verification. We use a tree for sorting,
+        * if we are overwriting. Otherwise just use a fifo.
         */
+       struct rb_root io_hist_tree;
        struct list_head io_hist_list;
+
+       /*
+        * For IO replaying
+        */
        struct list_head io_log_list;
 
        /*
@@ -567,6 +662,7 @@ extern FILE *f_err;
 extern int temp_stall_ts;
 extern unsigned long long mlock_size;
 extern unsigned long page_mask, page_size;
+extern int read_only;
 
 extern struct thread_data *threads;
 
@@ -575,6 +671,11 @@ extern struct thread_data *threads;
 #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)
 
+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(long))
 #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)
@@ -613,8 +714,9 @@ struct disk_util {
        struct list_head list;
 
        char *name;
+       char *sysfs_root;
        char path[256];
-       dev_t dev;
+       int major, minor;
 
        struct disk_util_stat dus;
        struct disk_util_stat last_dus;
@@ -625,18 +727,18 @@ struct disk_util {
 
 #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
  */
+enum file_log_act {
+       FIO_LOG_ADD_FILE,
+       FIO_LOG_OPEN_FILE,
+       FIO_LOG_CLOSE_FILE,
+};
+
 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
-extern void write_iolog_put(struct thread_data *, struct io_u *);
+extern void log_io_u(struct thread_data *, struct io_u *);
+extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act);
 extern int __must_check init_iolog(struct thread_data *td);
 extern void log_io_piece(struct thread_data *, struct io_u *);
 extern void prune_io_piece_log(struct thread_data *);
@@ -685,6 +787,8 @@ 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
 
@@ -697,11 +801,14 @@ 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 int 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 *);
+extern int get_fileno(struct thread_data *, const char *);
+extern void free_release_files(struct thread_data *);
 
 /*
  * ETA/status stuff
@@ -709,6 +816,21 @@ extern int init_random_map(struct thread_data *);
 extern void print_thread_status(void);
 extern void print_status_init(int);
 
+/*
+ * disk util stuff
+ */
+#ifdef FIO_HAVE_DISK_UTIL
+extern void show_disk_util(void);
+extern void disk_util_timer_arm(void);
+extern void init_disk_util(struct thread_data *);
+extern void update_io_ticks(void);
+#else
+#define show_disk_util()
+#define disk_util_timer_arm()
+#define init_disk_util(td)
+#define update_io_ticks()
+#endif
+
 /*
  * Thread life cycle. Once a thread has a runstate beyond TD_INITIALIZED, it
  * will never back again. It may cycle between running/verififying/fsyncing.
@@ -731,7 +853,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
@@ -769,6 +891,14 @@ 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 void td_io_close_file(struct thread_data *, struct fio_file *);
 
+/*
+ * blktrace support
+ */
+#ifdef FIO_HAVE_BLKTRACE
+extern int is_blktrace(const char *);
+extern int load_blktrace(struct thread_data *, const char *);
+#endif
+
 /*
  * If logging output to a file, stderr should go to both stderr and f_err
  */
@@ -803,7 +933,7 @@ struct ioengine_ops {
        void *dlhandle;
 };
 
-#define FIO_IOOPS_VERSION      6
+#define FIO_IOOPS_VERSION      7
 
 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
 extern void register_ioengine(struct ioengine_ops *);
@@ -832,4 +962,10 @@ extern void close_ioengine(struct thread_data *);
        }       \
 } while (0)
 
+static inline void clear_error(struct thread_data *td)
+{
+       td->error = 0;
+       td->verror[0] = '\0';
+}
+
 #endif