Merge branch 'master' into gfio
[fio.git] / engines / libaio.c
index c95600548c645449a07946b7cabb8c7b6de5162b..be54dca9d0ba10c4b109f29e9387884e2e6b70d0 100644 (file)
@@ -1,5 +1,7 @@
 /*
- * native linux aio io engine
+ * libaio engine
+ *
+ * IO engine using the Linux native aio interface.
  *
  */
 #include <stdio.h>
@@ -7,17 +9,36 @@
 #include <unistd.h>
 #include <errno.h>
 #include <assert.h>
+#include <libaio.h>
 
 #include "../fio.h"
-#include "../os.h"
-
-#ifdef FIO_HAVE_LIBAIO
-
-#define ev_to_iou(ev)  (struct io_u *) ((unsigned long) (ev)->obj)
 
 struct libaio_data {
        io_context_t aio_ctx;
        struct io_event *aio_events;
+       struct iocb **iocbs;
+       struct io_u **io_us;
+       int iocbs_nr;
+};
+
+struct libaio_options {
+       struct thread_data *td;
+       unsigned int userspace_reap;
+};
+
+static struct fio_option options[] = {
+       {
+               .name   = "userspace_reap",
+               .lname  = "Libaio userspace reaping",
+               .type   = FIO_OPT_STR_SET,
+               .off1   = offsetof(struct libaio_options, userspace_reap),
+               .help   = "Use alternative user-space reap implementation",
+               .category = FIO_OPT_C_ENGINE,
+               .category = FIO_OPT_G_LIBAIO,
+       },
+       {
+               .name   = NULL,
+       },
 };
 
 static int fio_libaio_prep(struct thread_data fio_unused *td, struct io_u *io_u)
@@ -28,10 +49,8 @@ static int fio_libaio_prep(struct thread_data fio_unused *td, struct io_u *io_u)
                io_prep_pread(&io_u->iocb, f->fd, io_u->xfer_buf, io_u->xfer_buflen, io_u->offset);
        else if (io_u->ddir == DDIR_WRITE)
                io_prep_pwrite(&io_u->iocb, f->fd, io_u->xfer_buf, io_u->xfer_buflen, io_u->offset);
-       else if (io_u->ddir == DDIR_SYNC)
+       else if (ddir_sync(io_u->ddir))
                io_prep_fsync(&io_u->iocb, f->fd);
-       else
-               return 1;
 
        return 0;
 }
@@ -39,70 +58,178 @@ static int fio_libaio_prep(struct thread_data fio_unused *td, struct io_u *io_u)
 static struct io_u *fio_libaio_event(struct thread_data *td, int event)
 {
        struct libaio_data *ld = td->io_ops->data;
+       struct io_event *ev;
+       struct io_u *io_u;
+
+       ev = ld->aio_events + event;
+       io_u = container_of(ev->obj, struct io_u, iocb);
 
-       return ev_to_iou(ld->aio_events + event);
+       if (ev->res != io_u->xfer_buflen) {
+               if (ev->res > io_u->xfer_buflen)
+                       io_u->error = -ev->res;
+               else
+                       io_u->resid = io_u->xfer_buflen - ev->res;
+       } else
+               io_u->error = 0;
+
+       return io_u;
 }
 
-static int fio_libaio_getevents(struct thread_data *td, int min, int max,
-                               struct timespec *t)
+struct aio_ring {
+       unsigned id;             /** kernel internal index number */
+       unsigned nr;             /** number of io_events */
+       unsigned head;
+       unsigned tail;
+
+       unsigned magic;
+       unsigned compat_features;
+       unsigned incompat_features;
+       unsigned header_length; /** size of aio_ring */
+
+       struct io_event events[0];
+};
+
+#define AIO_RING_MAGIC 0xa10a10a1
+
+static int user_io_getevents(io_context_t aio_ctx, unsigned int max,
+                            struct io_event *events)
+{
+       long i = 0;
+       unsigned head;
+       struct aio_ring *ring = (struct aio_ring*) aio_ctx;
+
+       while (i < max) {
+               head = ring->head;
+
+               if (head == ring->tail) {
+                       /* There are no more completions */
+                       break;
+               } else {
+                       /* There is another completion to reap */
+                       events[i] = ring->events[head];
+                       read_barrier();
+                       ring->head = (head + 1) % ring->nr;
+                       i++;
+               }
+       }
+
+       return i;
+}
+
+static int fio_libaio_getevents(struct thread_data *td, unsigned int min,
+                               unsigned int max, struct timespec *t)
 {
        struct libaio_data *ld = td->io_ops->data;
-       long r;
+       struct libaio_options *o = td->eo;
+       unsigned actual_min = td->o.iodepth_batch_complete == 0 ? 0 : min;
+       int r, events = 0;
 
        do {
-               r = io_getevents(ld->aio_ctx, min, max, ld->aio_events, t);
-               if (r >= min)
-                       break;
-               else if (r == -EAGAIN) {
+               if (o->userspace_reap == 1
+                   && actual_min == 0
+                   && ((struct aio_ring *)(ld->aio_ctx))->magic
+                               == AIO_RING_MAGIC) {
+                       r = user_io_getevents(ld->aio_ctx, max,
+                               ld->aio_events + events);
+               } else {
+                       r = io_getevents(ld->aio_ctx, actual_min,
+                               max, ld->aio_events + events, t);
+               }
+               if (r >= 0)
+                       events += r;
+               else if (r == -EAGAIN)
                        usleep(100);
-                       continue;
-               } else if (r == -EINTR)
-                       continue;
-               else if (r != 0)
-                       break;
-       } while (1);
+       } while (events < min);
 
-       if (r < 0)
-               r = -r;
-
-       return (int) r;
+       return r < 0 ? r : events;
 }
 
 static int fio_libaio_queue(struct thread_data *td, struct io_u *io_u)
 {
        struct libaio_data *ld = td->io_ops->data;
-       struct iocb *iocb = &io_u->iocb;
-       long ret;
 
+       fio_ro_check(td, io_u);
+
+       if (ld->iocbs_nr == (int) td->o.iodepth)
+               return FIO_Q_BUSY;
+
+       /*
+        * fsync is tricky, since it can fail and we need to do it
+        * serialized with other io. the reason is that linux doesn't
+        * support aio fsync yet. So return busy for the case where we
+        * have pending io, to let fio complete those first.
+        */
+       if (ddir_sync(io_u->ddir)) {
+               if (ld->iocbs_nr)
+                       return FIO_Q_BUSY;
+
+               do_io_u_sync(td, io_u);
+               return FIO_Q_COMPLETED;
+       }
+
+       if (io_u->ddir == DDIR_TRIM) {
+               if (ld->iocbs_nr)
+                       return FIO_Q_BUSY;
+
+               do_io_u_trim(td, io_u);
+               return FIO_Q_COMPLETED;
+       }
+
+       ld->iocbs[ld->iocbs_nr] = &io_u->iocb;
+       ld->io_us[ld->iocbs_nr] = io_u;
+       ld->iocbs_nr++;
+       return FIO_Q_QUEUED;
+}
+
+static void fio_libaio_queued(struct thread_data *td, struct io_u **io_us,
+                             unsigned int nr)
+{
+       struct timeval now;
+       unsigned int i;
+
+       if (!fio_fill_issue_time(td))
+               return;
+
+       fio_gettime(&now, NULL);
+
+       for (i = 0; i < nr; i++) {
+               struct io_u *io_u = io_us[i];
+
+               memcpy(&io_u->issue_time, &now, sizeof(now));
+               io_u_queued(td, io_u);
+       }
+}
+
+static int fio_libaio_commit(struct thread_data *td)
+{
+       struct libaio_data *ld = td->io_ops->data;
+       struct iocb **iocbs;
+       struct io_u **io_us;
+       int ret;
+
+       if (!ld->iocbs_nr)
+               return 0;
+
+       io_us = ld->io_us;
+       iocbs = ld->iocbs;
        do {
-               ret = io_submit(ld->aio_ctx, 1, &iocb);
-               if (ret == 1)
-                       return 0;
-               else if (ret == -EAGAIN || !ret)
-                       usleep(100);
-               else if (ret == -EINTR)
+               ret = io_submit(ld->aio_ctx, ld->iocbs_nr, iocbs);
+               if (ret > 0) {
+                       fio_libaio_queued(td, io_us, ret);
+                       io_u_mark_submit(td, ret);
+                       ld->iocbs_nr -= ret;
+                       io_us += ret;
+                       iocbs += ret;
+                       ret = 0;
+               } else if (!ret || ret == -EAGAIN || ret == -EINTR) {
+                       if (!ret)
+                               io_u_mark_submit(td, ret);
                        continue;
-               else if (ret == -EINVAL && io_u->ddir == DDIR_SYNC) {
-                       /*
-                        * the async fsync doesn't currently seem to be
-                        * supported, so just fsync if we fail with EINVAL
-                        * for a sync. since buffered io is also sync
-                        * with libaio (still), we don't have pending
-                        * requests to flush first.
-                        */
-                       ret = fsync(io_u->file->fd);
-                       break;
                } else
                        break;
-       } while (1);
+       } while (ld->iocbs_nr);
 
-       if (ret <= 0) {
-               io_u->resid = io_u->xfer_buflen;
-               io_u->error = -ret;
-               return 1;
-       }
-
-       return 0;
+       return ret;
 }
 
 static int fio_libaio_cancel(struct thread_data *td, struct io_u *io_u)
@@ -118,64 +245,67 @@ static void fio_libaio_cleanup(struct thread_data *td)
 
        if (ld) {
                io_destroy(ld->aio_ctx);
-               if (ld->aio_events)
-                       free(ld->aio_events);
-
+               free(ld->aio_events);
+               free(ld->iocbs);
+               free(ld->io_us);
                free(ld);
-               td->io_ops->data = NULL;
        }
 }
 
 static int fio_libaio_init(struct thread_data *td)
 {
        struct libaio_data *ld = malloc(sizeof(*ld));
+       struct libaio_options *o = td->eo;
+       int err = 0;
 
        memset(ld, 0, sizeof(*ld));
-       if (io_queue_init(td->iodepth, &ld->aio_ctx)) {
-               td_verror(td, errno);
+
+       /*
+        * First try passing in 0 for queue depth, since we don't
+        * care about the user ring. If that fails, the kernel is too old
+        * and we need the right depth.
+        */
+       if (!o->userspace_reap)
+               err = io_queue_init(INT_MAX, &ld->aio_ctx);
+       if (o->userspace_reap || err == -EINVAL)
+               err = io_queue_init(td->o.iodepth, &ld->aio_ctx);
+       if (err) {
+               td_verror(td, -err, "io_queue_init");
+               log_err("fio: check /proc/sys/fs/aio-max-nr\n");
                free(ld);
                return 1;
        }
 
-       ld->aio_events = malloc(td->iodepth * sizeof(struct io_event));
-       memset(ld->aio_events, 0, td->iodepth * sizeof(struct io_event));
+       ld->aio_events = malloc(td->o.iodepth * sizeof(struct io_event));
+       memset(ld->aio_events, 0, td->o.iodepth * sizeof(struct io_event));
+       ld->iocbs = malloc(td->o.iodepth * sizeof(struct iocb *));
+       memset(ld->iocbs, 0, sizeof(struct iocb *));
+       ld->io_us = malloc(td->o.iodepth * sizeof(struct io_u *));
+       memset(ld->io_us, 0, td->o.iodepth * sizeof(struct io_u *));
+       ld->iocbs_nr = 0;
+
        td->io_ops->data = ld;
        return 0;
 }
 
 static struct ioengine_ops ioengine = {
-       .name           = "libaio",
-       .version        = FIO_IOOPS_VERSION,
-       .init           = fio_libaio_init,
-       .prep           = fio_libaio_prep,
-       .queue          = fio_libaio_queue,
-       .cancel         = fio_libaio_cancel,
-       .getevents      = fio_libaio_getevents,
-       .event          = fio_libaio_event,
-       .cleanup        = fio_libaio_cleanup,
+       .name                   = "libaio",
+       .version                = FIO_IOOPS_VERSION,
+       .init                   = fio_libaio_init,
+       .prep                   = fio_libaio_prep,
+       .queue                  = fio_libaio_queue,
+       .commit                 = fio_libaio_commit,
+       .cancel                 = fio_libaio_cancel,
+       .getevents              = fio_libaio_getevents,
+       .event                  = fio_libaio_event,
+       .cleanup                = fio_libaio_cleanup,
+       .open_file              = generic_open_file,
+       .close_file             = generic_close_file,
+       .get_file_size          = generic_get_file_size,
+       .options                = options,
+       .option_struct_size     = sizeof(struct libaio_options),
 };
 
-#else /* FIO_HAVE_LIBAIO */
-
-/*
- * When we have a proper configure system in place, we simply wont build
- * and install this io engine. For now install a crippled version that
- * just complains and fails to load.
- */
-static int fio_libaio_init(struct thread_data fio_unused *td)
-{
-       fprintf(stderr, "fio: libaio not available\n");
-       return 1;
-}
-
-static struct ioengine_ops ioengine = {
-       .name           = "libaio",
-       .version        = FIO_IOOPS_VERSION,
-       .init           = fio_libaio_init,
-};
-
-#endif
-
 static void fio_init fio_libaio_register(void)
 {
        register_ioengine(&ioengine);