ioengines.h

   1 #ifndef FIO_IOENGINE_H
   2 #define FIO_IOENGINE_H
   3
   4 #include <stddef.h>
   5
   6 #include "compiler/compiler.h"
   7 #include "flist.h"
   8 #include "io_u.h"
   9
  10 #define FIO_IOOPS_VERSION       25
  11
  12 /*
  13  * io_ops->queue() return values
  14  */
  15 enum fio_q_status {
  16         FIO_Q_COMPLETED = 0,            /* completed sync */
  17         FIO_Q_QUEUED    = 1,            /* queued, will complete async */
  18         FIO_Q_BUSY      = 2,            /* no more room, call ->commit() */
  19 };
  20
  21 struct ioengine_ops {
  22         struct flist_head list;
  23         const char *name;
  24         int version;
  25         int flags;
  26         int (*setup)(struct thread_data *);
  27         int (*init)(struct thread_data *);
  28         int (*post_init)(struct thread_data *);
  29         int (*prep)(struct thread_data *, struct io_u *);
  30         enum fio_q_status (*queue)(struct thread_data *, struct io_u *);
  31         int (*commit)(struct thread_data *);
  32         int (*getevents)(struct thread_data *, unsigned int, unsigned int, const struct timespec *);
  33         struct io_u *(*event)(struct thread_data *, int);
  34         char *(*errdetails)(struct io_u *);
  35         int (*cancel)(struct thread_data *, struct io_u *);
  36         void (*cleanup)(struct thread_data *);
  37         int (*open_file)(struct thread_data *, struct fio_file *);
  38         int (*close_file)(struct thread_data *, struct fio_file *);
  39         int (*invalidate)(struct thread_data *, struct fio_file *);
  40         int (*unlink_file)(struct thread_data *, struct fio_file *);
  41         int (*get_file_size)(struct thread_data *, struct fio_file *);
  42         void (*terminate)(struct thread_data *);
  43         int (*iomem_alloc)(struct thread_data *, size_t);
  44         void (*iomem_free)(struct thread_data *);
  45         int (*io_u_init)(struct thread_data *, struct io_u *);
  46         void (*io_u_free)(struct thread_data *, struct io_u *);
  47         int option_struct_size;
  48         struct fio_option *options;
  49 };
  50
  51 enum fio_ioengine_flags {
  52         FIO_SYNCIO      = 1 << 0,       /* io engine has synchronous ->queue */
  53         FIO_RAWIO       = 1 << 1,       /* some sort of direct/raw io */
  54         FIO_DISKLESSIO  = 1 << 2,       /* no disk involved */
  55         FIO_NOEXTEND    = 1 << 3,       /* engine can't extend file */
  56         FIO_NODISKUTIL  = 1 << 4,       /* diskutil can't handle filename */
  57         FIO_UNIDIR      = 1 << 5,       /* engine is uni-directional */
  58         FIO_NOIO        = 1 << 6,       /* thread does only pseudo IO */
  59         FIO_PIPEIO      = 1 << 7,       /* input/output no seekable */
  60         FIO_BARRIER     = 1 << 8,       /* engine supports barriers */
  61         FIO_MEMALIGN    = 1 << 9,       /* engine wants aligned memory */
  62         FIO_BIT_BASED   = 1 << 10,      /* engine uses a bit base (e.g. uses Kbit as opposed to KB) */
  63         FIO_FAKEIO      = 1 << 11,      /* engine pretends to do IO */
  64         FIO_NOSTATS     = 1 << 12,      /* don't do IO stats */
  65         FIO_NOFILEHASH  = 1 << 13,      /* doesn't hash the files for lookup later. */
  66 };
  67
  68 /*
  69  * External engine defined symbol to fill in the engine ops structure
  70  */
  71 typedef void (*get_ioengine_t)(struct ioengine_ops **);
  72
  73 /*
  74  * io engine entry points
  75  */
  76 extern int __must_check td_io_init(struct thread_data *);
  77 extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
  78 extern enum fio_q_status __must_check td_io_queue(struct thread_data *, struct io_u *);
  79 extern int __must_check td_io_getevents(struct thread_data *, unsigned int, unsigned int, const struct timespec *);
  80 extern void td_io_commit(struct thread_data *);
  81 extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
  82 extern int td_io_close_file(struct thread_data *, struct fio_file *);
  83 extern int td_io_unlink_file(struct thread_data *, struct fio_file *);
  84 extern int __must_check td_io_get_file_size(struct thread_data *, struct fio_file *);
  85
  86 extern struct ioengine_ops *load_ioengine(struct thread_data *);
  87 extern void register_ioengine(struct ioengine_ops *);
  88 extern void unregister_ioengine(struct ioengine_ops *);
  89 extern void free_ioengine(struct thread_data *);
  90 extern void close_ioengine(struct thread_data *);
  91
  92 extern int fio_show_ioengine_help(const char *engine);
  93
  94 #endif