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