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