blob: 044c4da1a150af8ce239cd0bc57ca14a75ef0c6a [file] [log] [blame]
Jens Axboedcefb582009-06-03 08:49:39 +02001#ifndef FIO_IOENGINE_H
2#define FIO_IOENGINE_H
3
Jens Axboea5f30272010-07-19 16:19:55 -06004#define FIO_IOOPS_VERSION 12
Jens Axboedcefb582009-06-03 08:49:39 +02005
6enum {
Radha Ramachandran0c412142009-11-03 21:45:31 +01007 IO_U_F_FREE = 1 << 0,
8 IO_U_F_FLIGHT = 1 << 1,
9 IO_U_F_FREE_DEF = 1 << 2,
10 IO_U_F_IN_CUR_DEPTH = 1 << 3,
Jens Axboe38dad622010-07-20 14:46:00 -060011 IO_U_F_BUSY_OK = 1 << 4,
Jens Axboe0d29de82010-09-01 13:54:15 +020012 IO_U_F_TRIMMED = 1 << 5,
Jens Axboe1ef2b6b2010-10-08 15:07:01 +020013 IO_U_F_BARRIER = 1 << 6,
Jens Axboedcefb582009-06-03 08:49:39 +020014};
15
16/*
17 * The io unit
18 */
19struct io_u {
20 union {
21#ifdef FIO_HAVE_LIBAIO
22 struct iocb iocb;
23#endif
24#ifdef FIO_HAVE_POSIXAIO
Jens Axboee97c1442011-09-21 09:38:01 +020025 os_aiocb_t aiocb;
Jens Axboedcefb582009-06-03 08:49:39 +020026#endif
27#ifdef FIO_HAVE_SGIO
28 struct sg_io_hdr hdr;
29#endif
30#ifdef FIO_HAVE_GUASI
31 guasi_req_t greq;
32#endif
33#ifdef FIO_HAVE_SOLARISAIO
34 aio_result_t resultp;
35#endif
Jens Axboe79a43182010-09-07 13:28:58 +020036#ifdef FIO_HAVE_BINJECT
37 struct b_user_cmd buc;
38#endif
ren yufei21b8aee2011-08-01 10:01:57 +020039#ifdef FIO_HAVE_RDMA
40 struct ibv_mr *mr;
41#endif
Jens Axboedcefb582009-06-03 08:49:39 +020042 void *mmap_data;
43 };
44 struct timeval start_time;
45 struct timeval issue_time;
46
47 /*
48 * Allocated/set buffer and length
49 */
50 void *buf;
51 unsigned long buflen;
52 unsigned long long offset;
53
54 /*
Jens Axboe7d9fb452011-01-11 22:16:49 +010055 * Initial seed for generating the buffer contents
56 */
57 unsigned long rand_seed;
58
59 /*
Jens Axboedcefb582009-06-03 08:49:39 +020060 * IO engine state, may be different from above when we get
61 * partial transfers / residual data counts
62 */
63 void *xfer_buf;
64 unsigned long xfer_buflen;
65
Jens Axboe95228502010-07-14 08:42:03 +020066 /*
67 * Parameter related to pre-filled buffers and
68 * their size to handle variable block sizes.
69 */
70 unsigned long buf_filled_len;
71
Jens Axboedcefb582009-06-03 08:49:39 +020072 unsigned int resid;
73 unsigned int error;
74
75 enum fio_ddir ddir;
76
77 /*
78 * io engine private data
79 */
80 union {
81 unsigned int index;
82 unsigned int seen;
83 void *engine_data;
84 };
85
86 unsigned int flags;
87
88 struct fio_file *file;
89
90 struct flist_head list;
91
92 /*
93 * Callback for io completion
94 */
95 int (*end_io)(struct thread_data *, struct io_u *);
96};
97
98/*
99 * io_ops->queue() return values
100 */
101enum {
102 FIO_Q_COMPLETED = 0, /* completed sync */
103 FIO_Q_QUEUED = 1, /* queued, will complete async */
104 FIO_Q_BUSY = 2, /* no more room, call ->commit() */
105};
106
107struct ioengine_ops {
108 struct flist_head list;
109 char name[16];
110 int version;
111 int flags;
112 int (*setup)(struct thread_data *);
113 int (*init)(struct thread_data *);
114 int (*prep)(struct thread_data *, struct io_u *);
115 int (*queue)(struct thread_data *, struct io_u *);
116 int (*commit)(struct thread_data *);
117 int (*getevents)(struct thread_data *, unsigned int, unsigned int, struct timespec *);
118 struct io_u *(*event)(struct thread_data *, int);
119 int (*cancel)(struct thread_data *, struct io_u *);
120 void (*cleanup)(struct thread_data *);
121 int (*open_file)(struct thread_data *, struct fio_file *);
122 int (*close_file)(struct thread_data *, struct fio_file *);
123 int (*get_file_size)(struct thread_data *, struct fio_file *);
124 void *data;
125 void *dlhandle;
126};
127
Jens Axboe2b4f4ab2009-06-03 08:50:36 +0200128enum fio_ioengine_flags {
129 FIO_SYNCIO = 1 << 0, /* io engine has synchronous ->queue */
130 FIO_RAWIO = 1 << 1, /* some sort of direct/raw io */
131 FIO_DISKLESSIO = 1 << 2, /* no disk involved */
132 FIO_NOEXTEND = 1 << 3, /* engine can't extend file */
133 FIO_NODISKUTIL = 1 << 4, /* diskutil can't handle filename */
134 FIO_UNIDIR = 1 << 5, /* engine is uni-directional */
135 FIO_NOIO = 1 << 6, /* thread does only pseudo IO */
Bruce Cran03e20d62011-01-02 20:14:54 +0100136 FIO_SIGTERM = 1 << 7, /* needs SIGTERM to exit */
Jens Axboe9c0d2242009-07-01 12:26:28 +0200137 FIO_PIPEIO = 1 << 8, /* input/output no seekable */
Jens Axboe1ef2b6b2010-10-08 15:07:01 +0200138 FIO_BARRIER = 1 << 9, /* engine supports barriers */
Jens Axboeca7e0dd2010-10-28 08:52:13 -0600139 FIO_MEMALIGN = 1 << 10, /* engine wants aligned memory */
Jens Axboe2b4f4ab2009-06-03 08:50:36 +0200140};
Jens Axboedcefb582009-06-03 08:49:39 +0200141
142/*
143 * io engine entry points
144 */
145extern int __must_check td_io_init(struct thread_data *);
146extern int __must_check td_io_prep(struct thread_data *, struct io_u *);
147extern int __must_check td_io_queue(struct thread_data *, struct io_u *);
148extern int __must_check td_io_sync(struct thread_data *, struct fio_file *);
149extern int __must_check td_io_getevents(struct thread_data *, unsigned int, unsigned int, struct timespec *);
150extern int __must_check td_io_commit(struct thread_data *);
151extern int __must_check td_io_open_file(struct thread_data *, struct fio_file *);
152extern int td_io_close_file(struct thread_data *, struct fio_file *);
153extern int __must_check td_io_get_file_size(struct thread_data *, struct fio_file *);
154
155extern struct ioengine_ops *load_ioengine(struct thread_data *, const char *);
156extern void register_ioengine(struct ioengine_ops *);
157extern void unregister_ioengine(struct ioengine_ops *);
158extern void close_ioengine(struct thread_data *);
159
160/*
161 * io unit handling
162 */
163#define queue_full(td) flist_empty(&(td)->io_u_freelist)
164extern struct io_u *__get_io_u(struct thread_data *);
165extern struct io_u *get_io_u(struct thread_data *);
166extern void put_io_u(struct thread_data *, struct io_u *);
Radha Ramachandranf2bba182009-06-15 08:40:16 +0200167extern void clear_io_u(struct thread_data *, struct io_u *);
Jens Axboedcefb582009-06-03 08:49:39 +0200168extern void requeue_io_u(struct thread_data *, struct io_u **);
Jens Axboe581e7142009-06-09 12:47:16 +0200169extern int __must_check io_u_sync_complete(struct thread_data *, struct io_u *, unsigned long *);
170extern int __must_check io_u_queued_complete(struct thread_data *, int, unsigned long *);
Jens Axboedcefb582009-06-03 08:49:39 +0200171extern void io_u_queued(struct thread_data *, struct io_u *);
172extern void io_u_log_error(struct thread_data *, struct io_u *);
173extern void io_u_mark_depth(struct thread_data *, unsigned int);
174extern void io_u_fill_buffer(struct thread_data *td, struct io_u *, unsigned int);
175void io_u_mark_complete(struct thread_data *, unsigned int);
176void io_u_mark_submit(struct thread_data *, unsigned int);
177
Jens Axboe0a28ecd2010-03-09 21:40:38 +0100178int do_io_u_sync(struct thread_data *, struct io_u *);
Jens Axboea5f30272010-07-19 16:19:55 -0600179int do_io_u_trim(struct thread_data *, struct io_u *);
Jens Axboe44f29692010-03-09 20:09:44 +0100180
Jens Axboec592b9f2009-06-03 09:29:28 +0200181#ifdef FIO_INC_DEBUG
182static inline void dprint_io_u(struct io_u *io_u, const char *p)
183{
184 struct fio_file *f = io_u->file;
185
186 dprint(FD_IO, "%s: io_u %p: off=%llu/len=%lu/ddir=%d", p, io_u,
187 (unsigned long long) io_u->offset,
188 io_u->buflen, io_u->ddir);
189 if (fio_debug & (1 << FD_IO)) {
190 if (f)
191 log_info("/%s", f->file_name);
192
193 log_info("\n");
194 }
195}
196#else
197#define dprint_io_u(io_u, p)
198#endif
199
Jens Axboedcefb582009-06-03 08:49:39 +0200200#endif