run-fio-tests: make test runs more resilient
[fio.git] / engines / libaio.c
1 /*
2  * libaio engine
3  *
4  * IO engine using the Linux native aio interface.
5  *
6  */
7 #include <stdlib.h>
8 #include <unistd.h>
9 #include <errno.h>
10 #include <libaio.h>
11 #include <sys/time.h>
12 #include <sys/resource.h>
13
14 #include "../fio.h"
15 #include "../lib/pow2.h"
16 #include "../optgroup.h"
17 #include "../lib/memalign.h"
18 #include "cmdprio.h"
19
20 /* Should be defined in newest aio_abi.h */
21 #ifndef IOCB_FLAG_IOPRIO
22 #define IOCB_FLAG_IOPRIO    (1 << 1)
23 #endif
24
25 /* Hack for libaio < 0.3.111 */
26 #ifndef CONFIG_LIBAIO_RW_FLAGS
27 #define aio_rw_flags __pad2
28 #endif
29
30 static int fio_libaio_commit(struct thread_data *td);
31 static int fio_libaio_init(struct thread_data *td);
32
33 struct libaio_data {
34         io_context_t aio_ctx;
35         struct io_event *aio_events;
36         struct iocb **iocbs;
37         struct io_u **io_us;
38
39         struct io_u **io_u_index;
40
41         /*
42          * Basic ring buffer. 'head' is incremented in _queue(), and
43          * 'tail' is incremented in _commit(). We keep 'queued' so
44          * that we know if the ring is full or empty, when
45          * 'head' == 'tail'. 'entries' is the ring size, and
46          * 'is_pow2' is just an optimization to use AND instead of
47          * modulus to get the remainder on ring increment.
48          */
49         int is_pow2;
50         unsigned int entries;
51         unsigned int queued;
52         unsigned int head;
53         unsigned int tail;
54
55         bool use_cmdprio;
56 };
57
58 struct libaio_options {
59         struct thread_data *td;
60         unsigned int userspace_reap;
61         struct cmdprio cmdprio;
62         unsigned int nowait;
63 };
64
65 static int str_cmdprio_bssplit_cb(void *data, const char *input)
66 {
67         struct libaio_options *o = data;
68         struct thread_data *td = o->td;
69         struct cmdprio *cmdprio = &o->cmdprio;
70
71         return fio_cmdprio_bssplit_parse(td, input, cmdprio);
72 }
73
74 static struct fio_option options[] = {
75         {
76                 .name   = "userspace_reap",
77                 .lname  = "Libaio userspace reaping",
78                 .type   = FIO_OPT_STR_SET,
79                 .off1   = offsetof(struct libaio_options, userspace_reap),
80                 .help   = "Use alternative user-space reap implementation",
81                 .category = FIO_OPT_C_ENGINE,
82                 .group  = FIO_OPT_G_LIBAIO,
83         },
84 #ifdef FIO_HAVE_IOPRIO_CLASS
85         {
86                 .name   = "cmdprio_percentage",
87                 .lname  = "high priority percentage",
88                 .type   = FIO_OPT_INT,
89                 .off1   = offsetof(struct libaio_options,
90                                    cmdprio.percentage[DDIR_READ]),
91                 .off2   = offsetof(struct libaio_options,
92                                    cmdprio.percentage[DDIR_WRITE]),
93                 .minval = 0,
94                 .maxval = 100,
95                 .help   = "Send high priority I/O this percentage of the time",
96                 .category = FIO_OPT_C_ENGINE,
97                 .group  = FIO_OPT_G_LIBAIO,
98         },
99         {
100                 .name   = "cmdprio_class",
101                 .lname  = "Asynchronous I/O priority class",
102                 .type   = FIO_OPT_INT,
103                 .off1   = offsetof(struct libaio_options,
104                                    cmdprio.class[DDIR_READ]),
105                 .off2   = offsetof(struct libaio_options,
106                                    cmdprio.class[DDIR_WRITE]),
107                 .help   = "Set asynchronous IO priority class",
108                 .minval = IOPRIO_MIN_PRIO_CLASS + 1,
109                 .maxval = IOPRIO_MAX_PRIO_CLASS,
110                 .interval = 1,
111                 .category = FIO_OPT_C_ENGINE,
112                 .group  = FIO_OPT_G_LIBAIO,
113         },
114         {
115                 .name   = "cmdprio",
116                 .lname  = "Asynchronous I/O priority level",
117                 .type   = FIO_OPT_INT,
118                 .off1   = offsetof(struct libaio_options,
119                                    cmdprio.level[DDIR_READ]),
120                 .off2   = offsetof(struct libaio_options,
121                                    cmdprio.level[DDIR_WRITE]),
122                 .help   = "Set asynchronous IO priority level",
123                 .minval = IOPRIO_MIN_PRIO,
124                 .maxval = IOPRIO_MAX_PRIO,
125                 .interval = 1,
126                 .category = FIO_OPT_C_ENGINE,
127                 .group  = FIO_OPT_G_LIBAIO,
128         },
129         {
130                 .name   = "cmdprio_bssplit",
131                 .lname  = "Priority percentage block size split",
132                 .type   = FIO_OPT_STR_ULL,
133                 .cb     = str_cmdprio_bssplit_cb,
134                 .off1   = offsetof(struct libaio_options, cmdprio.bssplit),
135                 .help   = "Set priority percentages for different block sizes",
136                 .category = FIO_OPT_C_ENGINE,
137                 .group  = FIO_OPT_G_LIBAIO,
138         },
139 #else
140         {
141                 .name   = "cmdprio_percentage",
142                 .lname  = "high priority percentage",
143                 .type   = FIO_OPT_UNSUPPORTED,
144                 .help   = "Your platform does not support I/O priority classes",
145         },
146         {
147                 .name   = "cmdprio_class",
148                 .lname  = "Asynchronous I/O priority class",
149                 .type   = FIO_OPT_UNSUPPORTED,
150                 .help   = "Your platform does not support I/O priority classes",
151         },
152         {
153                 .name   = "cmdprio",
154                 .lname  = "Asynchronous I/O priority level",
155                 .type   = FIO_OPT_UNSUPPORTED,
156                 .help   = "Your platform does not support I/O priority classes",
157         },
158         {
159                 .name   = "cmdprio_bssplit",
160                 .lname  = "Priority percentage block size split",
161                 .type   = FIO_OPT_UNSUPPORTED,
162                 .help   = "Your platform does not support I/O priority classes",
163         },
164 #endif
165         {
166                 .name   = "nowait",
167                 .lname  = "RWF_NOWAIT",
168                 .type   = FIO_OPT_BOOL,
169                 .off1   = offsetof(struct libaio_options, nowait),
170                 .help   = "Set RWF_NOWAIT for reads/writes",
171                 .category = FIO_OPT_C_ENGINE,
172                 .group  = FIO_OPT_G_LIBAIO,
173         },
174         {
175                 .name   = NULL,
176         },
177 };
178
179 static inline void ring_inc(struct libaio_data *ld, unsigned int *val,
180                             unsigned int add)
181 {
182         if (ld->is_pow2)
183                 *val = (*val + add) & (ld->entries - 1);
184         else
185                 *val = (*val + add) % ld->entries;
186 }
187
188 static int fio_libaio_prep(struct thread_data *td, struct io_u *io_u)
189 {
190         struct libaio_options *o = td->eo;
191         struct fio_file *f = io_u->file;
192         struct iocb *iocb = &io_u->iocb;
193
194         if (io_u->ddir == DDIR_READ) {
195                 io_prep_pread(iocb, f->fd, io_u->xfer_buf, io_u->xfer_buflen, io_u->offset);
196                 if (o->nowait)
197                         iocb->aio_rw_flags |= RWF_NOWAIT;
198         } else if (io_u->ddir == DDIR_WRITE) {
199                 io_prep_pwrite(iocb, f->fd, io_u->xfer_buf, io_u->xfer_buflen, io_u->offset);
200                 if (o->nowait)
201                         iocb->aio_rw_flags |= RWF_NOWAIT;
202         } else if (ddir_sync(io_u->ddir))
203                 io_prep_fsync(iocb, f->fd);
204
205         return 0;
206 }
207
208 static void fio_libaio_prio_prep(struct thread_data *td, struct io_u *io_u)
209 {
210         struct libaio_options *o = td->eo;
211         struct cmdprio *cmdprio = &o->cmdprio;
212         enum fio_ddir ddir = io_u->ddir;
213         unsigned int p = fio_cmdprio_percentage(cmdprio, io_u);
214         unsigned int cmdprio_value =
215                 ioprio_value(cmdprio->class[ddir], cmdprio->level[ddir]);
216
217         if (p && rand_between(&td->prio_state, 0, 99) < p) {
218                 io_u->ioprio = cmdprio_value;
219                 io_u->iocb.aio_reqprio = cmdprio_value;
220                 io_u->iocb.u.c.flags |= IOCB_FLAG_IOPRIO;
221                 if (!td->ioprio || cmdprio_value < td->ioprio) {
222                         /*
223                          * The async IO priority is higher (has a lower value)
224                          * than the default context priority.
225                          */
226                         io_u->flags |= IO_U_F_HIGH_PRIO;
227                 }
228         } else if (td->ioprio && td->ioprio < cmdprio_value) {
229                 /*
230                  * The IO will be executed with the default context priority,
231                  * and this priority is higher (has a lower value) than the
232                  * async IO priority.
233                  */
234                 io_u->flags |= IO_U_F_HIGH_PRIO;
235         }
236 }
237
238 static struct io_u *fio_libaio_event(struct thread_data *td, int event)
239 {
240         struct libaio_data *ld = td->io_ops_data;
241         struct io_event *ev;
242         struct io_u *io_u;
243
244         ev = ld->aio_events + event;
245         io_u = container_of(ev->obj, struct io_u, iocb);
246
247         if (ev->res != io_u->xfer_buflen) {
248                 if (ev->res > io_u->xfer_buflen)
249                         io_u->error = -ev->res;
250                 else
251                         io_u->resid = io_u->xfer_buflen - ev->res;
252         } else
253                 io_u->error = 0;
254
255         return io_u;
256 }
257
258 struct aio_ring {
259         unsigned id;             /** kernel internal index number */
260         unsigned nr;             /** number of io_events */
261         unsigned head;
262         unsigned tail;
263
264         unsigned magic;
265         unsigned compat_features;
266         unsigned incompat_features;
267         unsigned header_length; /** size of aio_ring */
268
269         struct io_event events[0];
270 };
271
272 #define AIO_RING_MAGIC  0xa10a10a1
273
274 static int user_io_getevents(io_context_t aio_ctx, unsigned int max,
275                              struct io_event *events)
276 {
277         long i = 0;
278         unsigned head;
279         struct aio_ring *ring = (struct aio_ring*) aio_ctx;
280
281         while (i < max) {
282                 head = ring->head;
283
284                 if (head == ring->tail) {
285                         /* There are no more completions */
286                         break;
287                 } else {
288                         /* There is another completion to reap */
289                         events[i] = ring->events[head];
290                         atomic_store_release(&ring->head,
291                                              (head + 1) % ring->nr);
292                         i++;
293                 }
294         }
295
296         return i;
297 }
298
299 static int fio_libaio_getevents(struct thread_data *td, unsigned int min,
300                                 unsigned int max, const struct timespec *t)
301 {
302         struct libaio_data *ld = td->io_ops_data;
303         struct libaio_options *o = td->eo;
304         unsigned actual_min = td->o.iodepth_batch_complete_min == 0 ? 0 : min;
305         struct timespec __lt, *lt = NULL;
306         int r, events = 0;
307
308         if (t) {
309                 __lt = *t;
310                 lt = &__lt;
311         }
312
313         do {
314                 if (o->userspace_reap == 1
315                     && actual_min == 0
316                     && ((struct aio_ring *)(ld->aio_ctx))->magic
317                                 == AIO_RING_MAGIC) {
318                         r = user_io_getevents(ld->aio_ctx, max,
319                                 ld->aio_events + events);
320                 } else {
321                         r = io_getevents(ld->aio_ctx, actual_min,
322                                 max, ld->aio_events + events, lt);
323                 }
324                 if (r > 0)
325                         events += r;
326                 else if ((min && r == 0) || r == -EAGAIN) {
327                         fio_libaio_commit(td);
328                         if (actual_min)
329                                 usleep(10);
330                 } else if (r != -EINTR)
331                         break;
332         } while (events < min);
333
334         return r < 0 ? r : events;
335 }
336
337 static enum fio_q_status fio_libaio_queue(struct thread_data *td,
338                                           struct io_u *io_u)
339 {
340         struct libaio_data *ld = td->io_ops_data;
341
342         fio_ro_check(td, io_u);
343
344         if (ld->queued == td->o.iodepth)
345                 return FIO_Q_BUSY;
346
347         /*
348          * fsync is tricky, since it can fail and we need to do it
349          * serialized with other io. the reason is that linux doesn't
350          * support aio fsync yet. So return busy for the case where we
351          * have pending io, to let fio complete those first.
352          */
353         if (ddir_sync(io_u->ddir)) {
354                 if (ld->queued)
355                         return FIO_Q_BUSY;
356
357                 do_io_u_sync(td, io_u);
358                 return FIO_Q_COMPLETED;
359         }
360
361         if (io_u->ddir == DDIR_TRIM) {
362                 if (ld->queued)
363                         return FIO_Q_BUSY;
364
365                 do_io_u_trim(td, io_u);
366                 io_u_mark_submit(td, 1);
367                 io_u_mark_complete(td, 1);
368                 return FIO_Q_COMPLETED;
369         }
370
371         if (ld->use_cmdprio)
372                 fio_libaio_prio_prep(td, io_u);
373
374         ld->iocbs[ld->head] = &io_u->iocb;
375         ld->io_us[ld->head] = io_u;
376         ring_inc(ld, &ld->head, 1);
377         ld->queued++;
378         return FIO_Q_QUEUED;
379 }
380
381 static void fio_libaio_queued(struct thread_data *td, struct io_u **io_us,
382                               unsigned int nr)
383 {
384         struct timespec now;
385         unsigned int i;
386
387         if (!fio_fill_issue_time(td))
388                 return;
389
390         fio_gettime(&now, NULL);
391
392         for (i = 0; i < nr; i++) {
393                 struct io_u *io_u = io_us[i];
394
395                 memcpy(&io_u->issue_time, &now, sizeof(now));
396                 io_u_queued(td, io_u);
397         }
398 }
399
400 static int fio_libaio_commit(struct thread_data *td)
401 {
402         struct libaio_data *ld = td->io_ops_data;
403         struct iocb **iocbs;
404         struct io_u **io_us;
405         struct timespec ts;
406         int ret, wait_start = 0;
407
408         if (!ld->queued)
409                 return 0;
410
411         do {
412                 long nr = ld->queued;
413
414                 nr = min((unsigned int) nr, ld->entries - ld->tail);
415                 io_us = ld->io_us + ld->tail;
416                 iocbs = ld->iocbs + ld->tail;
417
418                 ret = io_submit(ld->aio_ctx, nr, iocbs);
419                 if (ret > 0) {
420                         fio_libaio_queued(td, io_us, ret);
421                         io_u_mark_submit(td, ret);
422
423                         ld->queued -= ret;
424                         ring_inc(ld, &ld->tail, ret);
425                         ret = 0;
426                         wait_start = 0;
427                 } else if (ret == -EINTR || !ret) {
428                         if (!ret)
429                                 io_u_mark_submit(td, ret);
430                         wait_start = 0;
431                         continue;
432                 } else if (ret == -EAGAIN) {
433                         /*
434                          * If we get EAGAIN, we should break out without
435                          * error and let the upper layer reap some
436                          * events for us. If we have no queued IO, we
437                          * must loop here. If we loop for more than 30s,
438                          * just error out, something must be buggy in the
439                          * IO path.
440                          */
441                         if (ld->queued) {
442                                 ret = 0;
443                                 break;
444                         }
445                         if (!wait_start) {
446                                 fio_gettime(&ts, NULL);
447                                 wait_start = 1;
448                         } else if (mtime_since_now(&ts) > 30000) {
449                                 log_err("fio: aio appears to be stalled, giving up\n");
450                                 break;
451                         }
452                         usleep(1);
453                         continue;
454                 } else if (ret == -ENOMEM) {
455                         /*
456                          * If we get -ENOMEM, reap events if we can. If
457                          * we cannot, treat it as a fatal event since there's
458                          * nothing we can do about it.
459                          */
460                         if (ld->queued)
461                                 ret = 0;
462                         break;
463                 } else
464                         break;
465         } while (ld->queued);
466
467         return ret;
468 }
469
470 static int fio_libaio_cancel(struct thread_data *td, struct io_u *io_u)
471 {
472         struct libaio_data *ld = td->io_ops_data;
473
474         return io_cancel(ld->aio_ctx, &io_u->iocb, ld->aio_events);
475 }
476
477 static void fio_libaio_cleanup(struct thread_data *td)
478 {
479         struct libaio_data *ld = td->io_ops_data;
480
481         if (ld) {
482                 /*
483                  * Work-around to avoid huge RCU stalls at exit time. If we
484                  * don't do this here, then it'll be torn down by exit_aio().
485                  * But for that case we can parallellize the freeing, thus
486                  * speeding it up a lot.
487                  */
488                 if (!(td->flags & TD_F_CHILD))
489                         io_destroy(ld->aio_ctx);
490                 free(ld->aio_events);
491                 free(ld->iocbs);
492                 free(ld->io_us);
493                 free(ld);
494         }
495 }
496
497 static int fio_libaio_post_init(struct thread_data *td)
498 {
499         struct libaio_data *ld = td->io_ops_data;
500         int err;
501
502         err = io_queue_init(td->o.iodepth, &ld->aio_ctx);
503         if (err) {
504                 td_verror(td, -err, "io_queue_init");
505                 return 1;
506         }
507
508         return 0;
509 }
510
511 static int fio_libaio_init(struct thread_data *td)
512 {
513         struct libaio_data *ld;
514         struct libaio_options *o = td->eo;
515         struct cmdprio *cmdprio = &o->cmdprio;
516         int ret;
517
518         ld = calloc(1, sizeof(*ld));
519
520         ld->entries = td->o.iodepth;
521         ld->is_pow2 = is_power_of_2(ld->entries);
522         ld->aio_events = calloc(ld->entries, sizeof(struct io_event));
523         ld->iocbs = calloc(ld->entries, sizeof(struct iocb *));
524         ld->io_us = calloc(ld->entries, sizeof(struct io_u *));
525
526         td->io_ops_data = ld;
527
528         ret = fio_cmdprio_init(td, cmdprio, &ld->use_cmdprio);
529         if (ret) {
530                 td_verror(td, EINVAL, "fio_libaio_init");
531                 return 1;
532         }
533
534         return 0;
535 }
536
537 FIO_STATIC struct ioengine_ops ioengine = {
538         .name                   = "libaio",
539         .version                = FIO_IOOPS_VERSION,
540         .flags                  = FIO_ASYNCIO_SYNC_TRIM,
541         .init                   = fio_libaio_init,
542         .post_init              = fio_libaio_post_init,
543         .prep                   = fio_libaio_prep,
544         .queue                  = fio_libaio_queue,
545         .commit                 = fio_libaio_commit,
546         .cancel                 = fio_libaio_cancel,
547         .getevents              = fio_libaio_getevents,
548         .event                  = fio_libaio_event,
549         .cleanup                = fio_libaio_cleanup,
550         .open_file              = generic_open_file,
551         .close_file             = generic_close_file,
552         .get_file_size          = generic_get_file_size,
553         .options                = options,
554         .option_struct_size     = sizeof(struct libaio_options),
555 };
556
557 static void fio_init fio_libaio_register(void)
558 {
559         register_ioengine(&ioengine);
560 }
561
562 static void fio_exit fio_libaio_unregister(void)
563 {
564         unregister_ioengine(&ioengine);
565 }