55039578d9edad878519cde64b665ea81c5e2b0f
[fio.git] / ioengine.h
1 #ifndef FIO_IOENGINE_H
2 #define FIO_IOENGINE_H
3
4 #include "compiler/compiler.h"
5 #include "os/os.h"
6 #include "log.h"
7 #include "io_ddir.h"
8 #include "debug.h"
9 #include "file.h"
10
11 #ifdef CONFIG_LIBAIO
12 #include <libaio.h>
13 #endif
14 #ifdef CONFIG_GUASI
15 #include <guasi.h>
16 #endif
17
18 #define FIO_IOOPS_VERSION       15
19
20 enum {
21         IO_U_F_FREE             = 1 << 0,
22         IO_U_F_FLIGHT           = 1 << 1,
23         IO_U_F_FREE_DEF         = 1 << 2,
24         IO_U_F_IN_CUR_DEPTH     = 1 << 3,
25         IO_U_F_BUSY_OK          = 1 << 4,
26         IO_U_F_TRIMMED          = 1 << 5,
27         IO_U_F_BARRIER          = 1 << 6,
28         IO_U_F_VER_LIST         = 1 << 7,
29 };
30
31 struct thread_data;
32
33 /*
34  * The io unit
35  */
36 struct io_u {
37         union {
38 #ifdef CONFIG_LIBAIO
39                 struct iocb iocb;
40 #endif
41 #ifdef CONFIG_POSIXAIO
42                 os_aiocb_t aiocb;
43 #endif
44 #ifdef FIO_HAVE_SGIO
45                 struct sg_io_hdr hdr;
46 #endif
47 #ifdef CONFIG_GUASI
48                 guasi_req_t greq;
49 #endif
50 #ifdef CONFIG_SOLARISAIO
51                 aio_result_t resultp;
52 #endif
53 #ifdef FIO_HAVE_BINJECT
54                 struct b_user_cmd buc;
55 #endif
56 #ifdef CONFIG_RDMA
57                 struct ibv_mr *mr;
58 #endif
59                 void *mmap_data;
60         };
61         struct timeval start_time;
62         struct timeval issue_time;
63
64         struct fio_file *file;
65         unsigned int flags;
66         enum fio_ddir ddir;
67
68         /*
69          * For replay workloads, we may want to account as a different
70          * IO type than what is being submitted.
71          */
72         enum fio_ddir acct_ddir;
73
74         /*
75          * Allocated/set buffer and length
76          */
77         unsigned long buflen;
78         unsigned long long offset;
79         void *buf;
80
81         /*
82          * Initial seed for generating the buffer contents
83          */
84         unsigned long rand_seed;
85
86         /*
87          * IO engine state, may be different from above when we get
88          * partial transfers / residual data counts
89          */
90         void *xfer_buf;
91         unsigned long xfer_buflen;
92
93         /*
94          * Parameter related to pre-filled buffers and
95          * their size to handle variable block sizes.
96          */
97         unsigned long buf_filled_len;
98
99         unsigned int resid;
100         unsigned int error;
101
102         /*
103          * io engine private data
104          */
105         union {
106                 unsigned int index;
107                 unsigned int seen;
108                 void *engine_data;
109         };
110
111         struct flist_head list;
112
113         /*
114          * Callback for io completion
115          */
116         int (*end_io)(struct thread_data *, struct io_u *);
117 };
118
119 /*
120  * io_ops->queue() return values
121  */
122 enum {
123         FIO_Q_COMPLETED = 0,            /* completed sync */
124         FIO_Q_QUEUED    = 1,            /* queued, will complete async */
125         FIO_Q_BUSY      = 2,            /* no more room, call ->commit() */
126 };
127
128 struct ioengine_ops {
129         struct flist_head list;
130         char name[16];
131         int version;
132         int flags;
133         int (*setup)(struct thread_data *);
134         int (*init)(struct thread_data *);
135         int (*prep)(struct thread_data *, struct io_u *);
136         int (*queue)(struct thread_data *, struct io_u *);
137         int (*commit)(struct thread_data *);
138         int (*getevents)(struct thread_data *, unsigned int, unsigned int, struct timespec *);
139         struct io_u *(*event)(struct thread_data *, int);
140         int (*cancel)(struct thread_data *, struct io_u *);
141         void (*cleanup)(struct thread_data *);
142         int (*open_file)(struct thread_data *, struct fio_file *);
143         int (*close_file)(struct thread_data *, struct fio_file *);
144         int (*get_file_size)(struct thread_data *, struct fio_file *);
145         void (*terminate)(struct thread_data *);
146         int (*io_u_init)(struct thread_data *, struct io_u *);
147         void (*io_u_free)(struct thread_data *, struct io_u *);
148         int option_struct_size;
149         struct fio_option *options;
150         void *data;
151         void *dlhandle;
152 };
153
154 enum fio_ioengine_flags {
155         FIO_SYNCIO      = 1 << 0,       /* io engine has synchronous ->queue */
156         FIO_RAWIO       = 1 << 1,       /* some sort of direct/raw io */
157         FIO_DISKLESSIO  = 1 << 2,       /* no disk involved */
158         FIO_NOEXTEND    = 1 << 3,       /* engine can't extend file */
159         FIO_NODISKUTIL  = 1 << 4,       /* diskutil can't handle filename */
160         FIO_UNIDIR      = 1 << 5,       /* engine is uni-directional */
161         FIO_NOIO        = 1 << 6,       /* thread does only pseudo IO */
162         FIO_PIPEIO      = 1 << 7,       /* input/output no seekable */
163         FIO_BARRIER     = 1 << 8,       /* engine supports barriers */
164         FIO_MEMALIGN    = 1 << 9,       /* engine wants aligned memory */
165 };
166
167 /*
168  * io engine entry points
169  */
170 extern int __must_check td_io_init(struct thread_data *);
171 extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
172 extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
173 extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
174 extern int __must_check td_io_getevents(struct thread_data *, unsigned int, unsigned int, struct timespec *);
175 extern int __must_check td_io_commit(struct thread_data *);
176 extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
177 extern int td_io_close_file(struct thread_data *, struct fio_file *);
178 extern int __must_check td_io_get_file_size(struct thread_data *, struct fio_file *);
179
180 extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
181 extern void register_ioengine(struct ioengine_ops *);
182 extern void unregister_ioengine(struct ioengine_ops *);
183 extern void free_ioengine(struct thread_data *);
184 extern void close_ioengine(struct thread_data *);
185
186 extern int fio_show_ioengine_help(const char *engine);
187
188 /*
189  * io unit handling
190  */
191 #define queue_full(td)  flist_empty(&(td)->io_u_freelist)
192 extern struct io_u *__get_io_u(struct thread_data *);
193 extern struct io_u *get_io_u(struct thread_data *);
194 extern void put_io_u(struct thread_data *, struct io_u *);
195 extern void clear_io_u(struct thread_data *, struct io_u *);
196 extern void requeue_io_u(struct thread_data *, struct io_u **);
197 extern int __must_check io_u_sync_complete(struct thread_data *, struct io_u *, uint64_t *);
198 extern int __must_check io_u_queued_complete(struct thread_data *, int, uint64_t *);
199 extern void io_u_queued(struct thread_data *, struct io_u *);
200 extern void io_u_log_error(struct thread_data *, struct io_u *);
201 extern void io_u_mark_depth(struct thread_data *, unsigned int);
202 extern void io_u_fill_buffer(struct thread_data *td, struct io_u *, unsigned int, unsigned int);
203 void io_u_mark_complete(struct thread_data *, unsigned int);
204 void io_u_mark_submit(struct thread_data *, unsigned int);
205
206 int do_io_u_sync(struct thread_data *, struct io_u *);
207 int do_io_u_trim(struct thread_data *, struct io_u *);
208
209 #ifdef FIO_INC_DEBUG
210 static inline void dprint_io_u(struct io_u *io_u, const char *p)
211 {
212         struct fio_file *f = io_u->file;
213
214         dprint(FD_IO, "%s: io_u %p: off=%llu/len=%lu/ddir=%d", p, io_u,
215                                         (unsigned long long) io_u->offset,
216                                         io_u->buflen, io_u->ddir);
217         if (fio_debug & (1 << FD_IO)) {
218                 if (f)
219                         log_info("/%s", f->file_name);
220
221                 log_info("\n");
222         }
223 }
224 #else
225 #define dprint_io_u(io_u, p)
226 #endif
227
228 static inline enum fio_ddir acct_ddir(struct io_u *io_u)
229 {
230         if (io_u->acct_ddir != -1)
231                 return io_u->acct_ddir;
232
233         return io_u->ddir;
234 }
235
236 #endif