Bump IO engine version number
[fio.git] / ioengine.h
index 6809501ffa795fa46e59419d91345bfc3904a0a6..85923fcee3fdc1ff2f75be2bdec79048fac00c26 100644 (file)
@@ -1,6 +1,13 @@
 #ifndef FIO_IOENGINE_H
 #define FIO_IOENGINE_H
 
+#include "compiler/compiler.h"
+#include "os/os.h"
+#include "log.h"
+#include "io_ddir.h"
+#include "debug.h"
+#include "file.h"
+
 #ifdef CONFIG_LIBAIO
 #include <libaio.h>
 #endif
 #include <guasi.h>
 #endif
 
-#define FIO_IOOPS_VERSION      14
+#define FIO_IOOPS_VERSION      21
 
 enum {
        IO_U_F_FREE             = 1 << 0,
        IO_U_F_FLIGHT           = 1 << 1,
-       IO_U_F_FREE_DEF         = 1 << 2,
+       IO_U_F_NO_FILE_PUT      = 1 << 2,
        IO_U_F_IN_CUR_DEPTH     = 1 << 3,
        IO_U_F_BUSY_OK          = 1 << 4,
        IO_U_F_TRIMMED          = 1 << 5,
@@ -25,30 +32,6 @@ enum {
  * The io unit
  */
 struct io_u {
-       union {
-#ifdef CONFIG_LIBAIO
-               struct iocb iocb;
-#endif
-#ifdef CONFIG_POSIXAIO
-               os_aiocb_t aiocb;
-#endif
-#ifdef FIO_HAVE_SGIO
-               struct sg_io_hdr hdr;
-#endif
-#ifdef CONFIG_GUASI
-               guasi_req_t greq;
-#endif
-#ifdef CONFIG_SOLARISAIO
-               aio_result_t resultp;
-#endif
-#ifdef FIO_HAVE_BINJECT
-               struct b_user_cmd buc;
-#endif
-#ifdef CONFIG_RDMA
-               struct ibv_mr *mr;
-#endif
-               void *mmap_data;
-       };
        struct timeval start_time;
        struct timeval issue_time;
 
@@ -56,17 +39,24 @@ struct io_u {
        unsigned int flags;
        enum fio_ddir ddir;
 
+       /*
+        * For replay workloads, we may want to account as a different
+        * IO type than what is being submitted.
+        */
+       enum fio_ddir acct_ddir;
+
        /*
         * Allocated/set buffer and length
         */
        unsigned long buflen;
        unsigned long long offset;
+       unsigned short numberio;
        void *buf;
 
        /*
         * Initial seed for generating the buffer contents
         */
-       unsigned long rand_seed;
+       uint64_t rand_seed;
 
        /*
         * IO engine state, may be different from above when we get
@@ -81,6 +71,8 @@ struct io_u {
         */
        unsigned long buf_filled_len;
 
+       struct io_piece *ipo;
+
        unsigned int resid;
        unsigned int error;
 
@@ -93,12 +85,37 @@ struct io_u {
                void *engine_data;
        };
 
-       struct flist_head list;
+       struct flist_head verify_list;
 
        /*
         * Callback for io completion
         */
-       int (*end_io)(struct thread_data *, struct io_u *);
+       int (*end_io)(struct thread_data *, struct io_u **);
+
+       union {
+#ifdef CONFIG_LIBAIO
+               struct iocb iocb;
+#endif
+#ifdef CONFIG_POSIXAIO
+               os_aiocb_t aiocb;
+#endif
+#ifdef FIO_HAVE_SGIO
+               struct sg_io_hdr hdr;
+#endif
+#ifdef CONFIG_GUASI
+               guasi_req_t greq;
+#endif
+#ifdef CONFIG_SOLARISAIO
+               aio_result_t resultp;
+#endif
+#ifdef FIO_HAVE_BINJECT
+               struct b_user_cmd buc;
+#endif
+#ifdef CONFIG_RDMA
+               struct ibv_mr *mr;
+#endif
+               void *mmap_data;
+       };
 };
 
 /*
@@ -120,12 +137,14 @@ struct ioengine_ops {
        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 *, unsigned int, unsigned int, struct timespec *);
+       int (*getevents)(struct thread_data *, unsigned int, unsigned int, const struct timespec *);
        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 *);
        int (*close_file)(struct thread_data *, struct fio_file *);
+       int (*invalidate)(struct thread_data *, struct fio_file *);
+       int (*unlink_file)(struct thread_data *, struct fio_file *);
        int (*get_file_size)(struct thread_data *, struct fio_file *);
        void (*terminate)(struct thread_data *);
        int (*io_u_init)(struct thread_data *, struct io_u *);
@@ -147,8 +166,15 @@ enum fio_ioengine_flags {
        FIO_PIPEIO      = 1 << 7,       /* input/output no seekable */
        FIO_BARRIER     = 1 << 8,       /* engine supports barriers */
        FIO_MEMALIGN    = 1 << 9,       /* engine wants aligned memory */
+       FIO_BIT_BASED   = 1 << 10,      /* engine uses a bit base (e.g. uses Kbit as opposed to KB) */
+       FIO_FAKEIO      = 1 << 11,      /* engine pretends to do IO */
 };
 
+/*
+ * External engine defined symbol to fill in the engine ops structure
+ */
+typedef void (*get_ioengine_t)(struct ioengine_ops **);
+
 /*
  * io engine entry points
  */
@@ -156,10 +182,11 @@ extern int __must_check td_io_init(struct thread_data *);
 extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
 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 *, unsigned int, unsigned int, struct timespec *);
+extern int __must_check td_io_getevents(struct thread_data *, unsigned int, unsigned int, const struct timespec *);
 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 td_io_unlink_file(struct thread_data *, struct fio_file *);
 extern int __must_check td_io_get_file_size(struct thread_data *, struct fio_file *);
 
 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
@@ -173,23 +200,25 @@ extern int fio_show_ioengine_help(const char *engine);
 /*
  * io unit handling
  */
-#define queue_full(td) flist_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 *);
 extern void put_io_u(struct thread_data *, struct io_u *);
 extern void clear_io_u(struct thread_data *, struct io_u *);
 extern void requeue_io_u(struct thread_data *, struct io_u **);
-extern int __must_check io_u_sync_complete(struct thread_data *, struct io_u *, unsigned long *);
-extern int __must_check io_u_queued_complete(struct thread_data *, int, unsigned long *);
+extern int __must_check io_u_sync_complete(struct thread_data *, struct io_u *, uint64_t *);
+extern int __must_check io_u_queued_complete(struct thread_data *, int, uint64_t *);
 extern void io_u_queued(struct thread_data *, struct io_u *);
+extern void io_u_quiesce(struct thread_data *);
 extern void io_u_log_error(struct thread_data *, struct io_u *);
 extern void io_u_mark_depth(struct thread_data *, unsigned int);
+extern void fill_io_buffer(struct thread_data *, void *, unsigned int, unsigned int);
 extern void io_u_fill_buffer(struct thread_data *td, struct io_u *, unsigned int, unsigned int);
 void io_u_mark_complete(struct thread_data *, unsigned int);
 void io_u_mark_submit(struct thread_data *, unsigned int);
+int queue_full(const struct thread_data *);
 
-int do_io_u_sync(struct thread_data *, struct io_u *);
-int do_io_u_trim(struct thread_data *, struct io_u *);
+int do_io_u_sync(const struct thread_data *, struct io_u *);
+int do_io_u_trim(const struct thread_data *, struct io_u *);
 
 #ifdef FIO_INC_DEBUG
 static inline void dprint_io_u(struct io_u *io_u, const char *p)
@@ -210,4 +239,12 @@ static inline void dprint_io_u(struct io_u *io_u, const char *p)
 #define dprint_io_u(io_u, p)
 #endif
 
+static inline enum fio_ddir acct_ddir(struct io_u *io_u)
+{
+       if (io_u->acct_ddir != -1)
+               return io_u->acct_ddir;
+
+       return io_u->ddir;
+}
+
 #endif