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