Bump IO engine version number
[fio.git] / engines / libaio.c
CommitLineData
2866c82d 1/*
da751ca9
JA
2 * libaio engine
3 *
4 * IO engine using the Linux native aio interface.
2866c82d
JA
5 *
6 */
7#include <stdio.h>
8#include <stdlib.h>
9#include <unistd.h>
10#include <errno.h>
11#include <assert.h>
67bf9823 12#include <libaio.h>
5f350952
JA
13
14#include "../fio.h"
2866c82d 15
2866c82d
JA
16struct libaio_data {
17 io_context_t aio_ctx;
18 struct io_event *aio_events;
755200a3 19 struct iocb **iocbs;
7e77dd02 20 struct io_u **io_us;
acd45e02
JA
21
22 /*
23 * Basic ring buffer. 'head' is incremented in _queue(), and
24 * 'tail' is incremented in _commit(). We keep 'queued' so
25 * that we know if the ring is full or empty, when
26 * 'head' == 'tail'. 'entries' is the ring size, and
27 * 'is_pow2' is just an optimization to use AND instead of
28 * modulus to get the remainder on ring increment.
29 */
30 int is_pow2;
31 unsigned int entries;
32 unsigned int queued;
33 unsigned int head;
34 unsigned int tail;
2866c82d
JA
35};
36
de890a1e
SL
37struct libaio_options {
38 struct thread_data *td;
39 unsigned int userspace_reap;
40};
41
42static struct fio_option options[] = {
43 {
44 .name = "userspace_reap",
e8b0e958 45 .lname = "Libaio userspace reaping",
de890a1e
SL
46 .type = FIO_OPT_STR_SET,
47 .off1 = offsetof(struct libaio_options, userspace_reap),
48 .help = "Use alternative user-space reap implementation",
e90a0adf 49 .category = FIO_OPT_C_ENGINE,
5a3cd5f3 50 .group = FIO_OPT_G_LIBAIO,
de890a1e
SL
51 },
52 {
53 .name = NULL,
54 },
55};
56
acd45e02
JA
57static inline void ring_inc(struct libaio_data *ld, unsigned int *val,
58 unsigned int add)
59{
60 if (ld->is_pow2)
61 *val = (*val + add) & (ld->entries - 1);
62 else
63 *val = (*val + add) % ld->entries;
64}
65
7a16dd02 66static int fio_libaio_prep(struct thread_data fio_unused *td, struct io_u *io_u)
2866c82d 67{
53cdc686
JA
68 struct fio_file *f = io_u->file;
69
2866c82d 70 if (io_u->ddir == DDIR_READ)
cec6b55d 71 io_prep_pread(&io_u->iocb, f->fd, io_u->xfer_buf, io_u->xfer_buflen, io_u->offset);
87dc1ab1 72 else if (io_u->ddir == DDIR_WRITE)
cec6b55d 73 io_prep_pwrite(&io_u->iocb, f->fd, io_u->xfer_buf, io_u->xfer_buflen, io_u->offset);
5f9099ea 74 else if (ddir_sync(io_u->ddir))
87dc1ab1 75 io_prep_fsync(&io_u->iocb, f->fd);
2866c82d
JA
76
77 return 0;
78}
79
80static struct io_u *fio_libaio_event(struct thread_data *td, int event)
81{
82 struct libaio_data *ld = td->io_ops->data;
f423479d
JA
83 struct io_event *ev;
84 struct io_u *io_u;
2866c82d 85
f423479d 86 ev = ld->aio_events + event;
0cc6ee59 87 io_u = container_of(ev->obj, struct io_u, iocb);
f423479d
JA
88
89 if (ev->res != io_u->xfer_buflen) {
90 if (ev->res > io_u->xfer_buflen)
91 io_u->error = -ev->res;
92 else
93 io_u->resid = io_u->xfer_buflen - ev->res;
94 } else
95 io_u->error = 0;
96
97 return io_u;
2866c82d
JA
98}
99
675012f0
DE
100struct aio_ring {
101 unsigned id; /** kernel internal index number */
102 unsigned nr; /** number of io_events */
103 unsigned head;
104 unsigned tail;
c44b1ff5 105
675012f0
DE
106 unsigned magic;
107 unsigned compat_features;
108 unsigned incompat_features;
109 unsigned header_length; /** size of aio_ring */
110
111 struct io_event events[0];
112};
113
114#define AIO_RING_MAGIC 0xa10a10a1
115
116static int user_io_getevents(io_context_t aio_ctx, unsigned int max,
c44b1ff5 117 struct io_event *events)
675012f0
DE
118{
119 long i = 0;
120 unsigned head;
c44b1ff5 121 struct aio_ring *ring = (struct aio_ring*) aio_ctx;
675012f0
DE
122
123 while (i < max) {
124 head = ring->head;
125
126 if (head == ring->tail) {
127 /* There are no more completions */
128 break;
129 } else {
130 /* There is another completion to reap */
131 events[i] = ring->events[head];
132 read_barrier();
c44b1ff5 133 ring->head = (head + 1) % ring->nr;
675012f0
DE
134 i++;
135 }
136 }
137
138 return i;
139}
140
e7d2e616 141static int fio_libaio_getevents(struct thread_data *td, unsigned int min,
1f440ece 142 unsigned int max, const struct timespec *t)
2866c82d
JA
143{
144 struct libaio_data *ld = td->io_ops->data;
de890a1e 145 struct libaio_options *o = td->eo;
0b7fdba7 146 unsigned actual_min = td->o.iodepth_batch_complete == 0 ? 0 : min;
1f440ece 147 struct timespec __lt, *lt = NULL;
0b7fdba7 148 int r, events = 0;
2866c82d 149
1f440ece
JA
150 if (t) {
151 __lt = *t;
152 lt = &__lt;
153 }
154
2866c82d 155 do {
de890a1e 156 if (o->userspace_reap == 1
675012f0
DE
157 && actual_min == 0
158 && ((struct aio_ring *)(ld->aio_ctx))->magic
159 == AIO_RING_MAGIC) {
160 r = user_io_getevents(ld->aio_ctx, max,
161 ld->aio_events + events);
162 } else {
163 r = io_getevents(ld->aio_ctx, actual_min,
1f440ece 164 max, ld->aio_events + events, lt);
675012f0 165 }
0b7fdba7
DE
166 if (r >= 0)
167 events += r;
168 else if (r == -EAGAIN)
2866c82d 169 usleep(100);
0b7fdba7
DE
170 } while (events < min);
171
172 return r < 0 ? r : events;
2866c82d
JA
173}
174
175static int fio_libaio_queue(struct thread_data *td, struct io_u *io_u)
176{
177 struct libaio_data *ld = td->io_ops->data;
2866c82d 178
7101d9c2
JA
179 fio_ro_check(td, io_u);
180
acd45e02 181 if (ld->queued == td->o.iodepth)
755200a3
JA
182 return FIO_Q_BUSY;
183
184 /*
185 * fsync is tricky, since it can fail and we need to do it
186 * serialized with other io. the reason is that linux doesn't
187 * support aio fsync yet. So return busy for the case where we
188 * have pending io, to let fio complete those first.
189 */
f011531e 190 if (ddir_sync(io_u->ddir)) {
acd45e02 191 if (ld->queued)
755200a3 192 return FIO_Q_BUSY;
5f9099ea 193
f011531e 194 do_io_u_sync(td, io_u);
755200a3
JA
195 return FIO_Q_COMPLETED;
196 }
197
a5f3027c 198 if (io_u->ddir == DDIR_TRIM) {
acd45e02 199 if (ld->queued)
a5f3027c
JA
200 return FIO_Q_BUSY;
201
202 do_io_u_trim(td, io_u);
203 return FIO_Q_COMPLETED;
204 }
205
acd45e02
JA
206 ld->iocbs[ld->head] = &io_u->iocb;
207 ld->io_us[ld->head] = io_u;
208 ring_inc(ld, &ld->head, 1);
209 ld->queued++;
755200a3
JA
210 return FIO_Q_QUEUED;
211}
212
7e77dd02
JA
213static void fio_libaio_queued(struct thread_data *td, struct io_u **io_us,
214 unsigned int nr)
215{
216 struct timeval now;
217 unsigned int i;
218
12d9d841
JA
219 if (!fio_fill_issue_time(td))
220 return;
221
7e77dd02
JA
222 fio_gettime(&now, NULL);
223
224 for (i = 0; i < nr; i++) {
225 struct io_u *io_u = io_us[i];
226
227 memcpy(&io_u->issue_time, &now, sizeof(now));
228 io_u_queued(td, io_u);
229 }
230}
231
755200a3
JA
232static int fio_libaio_commit(struct thread_data *td)
233{
234 struct libaio_data *ld = td->io_ops->data;
235 struct iocb **iocbs;
7e77dd02 236 struct io_u **io_us;
a120ca7f
JA
237 struct timeval tv;
238 int ret, wait_start = 0;
755200a3 239
acd45e02 240 if (!ld->queued)
755200a3
JA
241 return 0;
242
2866c82d 243 do {
acd45e02
JA
244 long nr = ld->queued;
245
246 nr = min((unsigned int) nr, ld->entries - ld->tail);
247 io_us = ld->io_us + ld->tail;
248 iocbs = ld->iocbs + ld->tail;
249
250 ret = io_submit(ld->aio_ctx, nr, iocbs);
5e00c2c4 251 if (ret > 0) {
7e77dd02 252 fio_libaio_queued(td, io_us, ret);
838bc709 253 io_u_mark_submit(td, ret);
acd45e02
JA
254
255 ld->queued -= ret;
256 ring_inc(ld, &ld->tail, ret);
5e00c2c4 257 ret = 0;
acd45e02 258 } else if (ret == -EINTR || !ret) {
838bc709
JA
259 if (!ret)
260 io_u_mark_submit(td, ret);
2866c82d 261 continue;
acd45e02
JA
262 } else if (ret == -EAGAIN) {
263 /*
264 * If we get EAGAIN, we should break out without
265 * error and let the upper layer reap some
a120ca7f
JA
266 * events for us. If we have no queued IO, we
267 * must loop here. If we loop for more than 30s,
268 * just error out, something must be buggy in the
269 * IO path.
acd45e02 270 */
a120ca7f
JA
271 if (ld->queued) {
272 ret = 0;
273 break;
274 }
275 if (!wait_start) {
276 fio_gettime(&tv, NULL);
277 wait_start = 0;
278 } else if (mtime_since_now(&tv) > 30000) {
279 log_err("fio: aio appears to be stalled, giving up\n");
280 break;
281 }
282 usleep(1);
283 continue;
838bc709 284 } else
2866c82d 285 break;
2c3a4ae9 286 } while (ld->queued);
2866c82d 287
36167d82 288 return ret;
2866c82d
JA
289}
290
291static int fio_libaio_cancel(struct thread_data *td, struct io_u *io_u)
292{
293 struct libaio_data *ld = td->io_ops->data;
294
295 return io_cancel(ld->aio_ctx, &io_u->iocb, ld->aio_events);
296}
297
298static void fio_libaio_cleanup(struct thread_data *td)
299{
300 struct libaio_data *ld = td->io_ops->data;
301
302 if (ld) {
303 io_destroy(ld->aio_ctx);
7e77dd02
JA
304 free(ld->aio_events);
305 free(ld->iocbs);
306 free(ld->io_us);
2866c82d 307 free(ld);
2866c82d
JA
308 }
309}
310
311static int fio_libaio_init(struct thread_data *td)
312{
c90e1017 313 struct libaio_options *o = td->eo;
acd45e02 314 struct libaio_data *ld;
c90e1017 315 int err = 0;
2866c82d 316
acd45e02 317 ld = calloc(1, sizeof(*ld));
c1db2dce 318
c90e1017
JA
319 /*
320 * First try passing in 0 for queue depth, since we don't
321 * care about the user ring. If that fails, the kernel is too old
322 * and we need the right depth.
323 */
324 if (!o->userspace_reap)
c224ec05 325 err = io_queue_init(INT_MAX, &ld->aio_ctx);
c90e1017
JA
326 if (o->userspace_reap || err == -EINVAL)
327 err = io_queue_init(td->o.iodepth, &ld->aio_ctx);
c1db2dce
JA
328 if (err) {
329 td_verror(td, -err, "io_queue_init");
75de55ac 330 log_err("fio: check /proc/sys/fs/aio-max-nr\n");
cb781c75 331 free(ld);
2866c82d
JA
332 return 1;
333 }
334
acd45e02
JA
335 ld->entries = td->o.iodepth;
336 ld->is_pow2 = is_power_of_2(ld->entries);
337 ld->aio_events = calloc(ld->entries, sizeof(struct io_event));
338 ld->iocbs = calloc(ld->entries, sizeof(struct iocb *));
339 ld->io_us = calloc(ld->entries, sizeof(struct io_u *));
755200a3 340
2866c82d
JA
341 td->io_ops->data = ld;
342 return 0;
343}
344
5f350952 345static struct ioengine_ops ioengine = {
de890a1e
SL
346 .name = "libaio",
347 .version = FIO_IOOPS_VERSION,
348 .init = fio_libaio_init,
349 .prep = fio_libaio_prep,
350 .queue = fio_libaio_queue,
351 .commit = fio_libaio_commit,
352 .cancel = fio_libaio_cancel,
353 .getevents = fio_libaio_getevents,
354 .event = fio_libaio_event,
355 .cleanup = fio_libaio_cleanup,
356 .open_file = generic_open_file,
357 .close_file = generic_close_file,
358 .get_file_size = generic_get_file_size,
359 .options = options,
360 .option_struct_size = sizeof(struct libaio_options),
2866c82d 361};
34cfcdaf 362
5f350952
JA
363static void fio_init fio_libaio_register(void)
364{
365 register_ioengine(&ioengine);
366}
367
368static void fio_exit fio_libaio_unregister(void)
369{
370 unregister_ioengine(&ioengine);
371}