fio: Introduce the log_prio option
[fio.git] / engines / io_uring.c
index ef56345b15be3ed3252acbb1243e97fc28a5fb8f..27a4a67860956153a450e3aab099dbd47c63b909 100644 (file)
 #include "../optgroup.h"
 #include "../lib/memalign.h"
 #include "../lib/fls.h"
+#include "../lib/roundup.h"
 
 #ifdef ARCH_HAVE_IOURING
 
 #include "../lib/types.h"
 #include "../os/linux/io_uring.h"
+#include "cmdprio.h"
 
 struct io_sq_ring {
        unsigned *head;
@@ -63,18 +65,36 @@ struct ioring_data {
        int queued;
        int cq_ring_off;
        unsigned iodepth;
+       int prepped;
 
        struct ioring_mmap mmap[3];
+
+       bool use_cmdprio;
 };
 
 struct ioring_options {
-       void *pad;
+       struct thread_data *td;
        unsigned int hipri;
+       struct cmdprio cmdprio;
        unsigned int fixedbufs;
        unsigned int registerfiles;
        unsigned int sqpoll_thread;
        unsigned int sqpoll_set;
        unsigned int sqpoll_cpu;
+       unsigned int nonvectored;
+       unsigned int uncached;
+       unsigned int nowait;
+       unsigned int force_async;
+};
+
+static const int ddir_to_op[2][2] = {
+       { IORING_OP_READV, IORING_OP_READ },
+       { IORING_OP_WRITEV, IORING_OP_WRITE }
+};
+
+static const int fixed_ddir_to_op[2] = {
+       IORING_OP_READ_FIXED,
+       IORING_OP_WRITE_FIXED
 };
 
 static int fio_ioring_sqpoll_cb(void *data, unsigned long long *val)
@@ -86,6 +106,15 @@ static int fio_ioring_sqpoll_cb(void *data, unsigned long long *val)
        return 0;
 }
 
+static int str_cmdprio_bssplit_cb(void *data, const char *input)
+{
+       struct ioring_options *o = data;
+       struct thread_data *td = o->td;
+       struct cmdprio *cmdprio = &o->cmdprio;
+
+       return fio_cmdprio_bssplit_parse(td, input, cmdprio);
+}
+
 static struct fio_option options[] = {
        {
                .name   = "hipri",
@@ -96,6 +125,87 @@ static struct fio_option options[] = {
                .category = FIO_OPT_C_ENGINE,
                .group  = FIO_OPT_G_IOURING,
        },
+#ifdef FIO_HAVE_IOPRIO_CLASS
+       {
+               .name   = "cmdprio_percentage",
+               .lname  = "high priority percentage",
+               .type   = FIO_OPT_INT,
+               .off1   = offsetof(struct ioring_options,
+                                  cmdprio.percentage[DDIR_READ]),
+               .off2   = offsetof(struct ioring_options,
+                                  cmdprio.percentage[DDIR_WRITE]),
+               .minval = 0,
+               .maxval = 100,
+               .help   = "Send high priority I/O this percentage of the time",
+               .category = FIO_OPT_C_ENGINE,
+               .group  = FIO_OPT_G_IOURING,
+       },
+       {
+               .name   = "cmdprio_class",
+               .lname  = "Asynchronous I/O priority class",
+               .type   = FIO_OPT_INT,
+               .off1   = offsetof(struct ioring_options,
+                                  cmdprio.class[DDIR_READ]),
+               .off2   = offsetof(struct ioring_options,
+                                  cmdprio.class[DDIR_WRITE]),
+               .help   = "Set asynchronous IO priority class",
+               .minval = IOPRIO_MIN_PRIO_CLASS + 1,
+               .maxval = IOPRIO_MAX_PRIO_CLASS,
+               .interval = 1,
+               .category = FIO_OPT_C_ENGINE,
+               .group  = FIO_OPT_G_IOURING,
+       },
+       {
+               .name   = "cmdprio",
+               .lname  = "Asynchronous I/O priority level",
+               .type   = FIO_OPT_INT,
+               .off1   = offsetof(struct ioring_options,
+                                  cmdprio.level[DDIR_READ]),
+               .off2   = offsetof(struct ioring_options,
+                                  cmdprio.level[DDIR_WRITE]),
+               .help   = "Set asynchronous IO priority level",
+               .minval = IOPRIO_MIN_PRIO,
+               .maxval = IOPRIO_MAX_PRIO,
+               .interval = 1,
+               .category = FIO_OPT_C_ENGINE,
+               .group  = FIO_OPT_G_IOURING,
+       },
+       {
+               .name   = "cmdprio_bssplit",
+               .lname  = "Priority percentage block size split",
+               .type   = FIO_OPT_STR_ULL,
+               .cb     = str_cmdprio_bssplit_cb,
+               .off1   = offsetof(struct ioring_options, cmdprio.bssplit),
+               .help   = "Set priority percentages for different block sizes",
+               .category = FIO_OPT_C_ENGINE,
+               .group  = FIO_OPT_G_IOURING,
+       },
+#else
+       {
+               .name   = "cmdprio_percentage",
+               .lname  = "high priority percentage",
+               .type   = FIO_OPT_UNSUPPORTED,
+               .help   = "Your platform does not support I/O priority classes",
+       },
+       {
+               .name   = "cmdprio_class",
+               .lname  = "Asynchronous I/O priority class",
+               .type   = FIO_OPT_UNSUPPORTED,
+               .help   = "Your platform does not support I/O priority classes",
+       },
+       {
+               .name   = "cmdprio",
+               .lname  = "Asynchronous I/O priority level",
+               .type   = FIO_OPT_UNSUPPORTED,
+               .help   = "Your platform does not support I/O priority classes",
+       },
+       {
+               .name   = "cmdprio_bssplit",
+               .lname  = "Priority percentage block size split",
+               .type   = FIO_OPT_UNSUPPORTED,
+               .help   = "Your platform does not support I/O priority classes",
+       },
+#endif
        {
                .name   = "fixedbufs",
                .lname  = "Fixed (pre-mapped) IO buffers",
@@ -132,6 +242,43 @@ static struct fio_option options[] = {
                .category = FIO_OPT_C_ENGINE,
                .group  = FIO_OPT_G_IOURING,
        },
+       {
+               .name   = "nonvectored",
+               .lname  = "Non-vectored",
+               .type   = FIO_OPT_INT,
+               .off1   = offsetof(struct ioring_options, nonvectored),
+               .def    = "-1",
+               .help   = "Use non-vectored read/write commands",
+               .category = FIO_OPT_C_ENGINE,
+               .group  = FIO_OPT_G_IOURING,
+       },
+       {
+               .name   = "uncached",
+               .lname  = "Uncached",
+               .type   = FIO_OPT_INT,
+               .off1   = offsetof(struct ioring_options, uncached),
+               .help   = "Use RWF_UNCACHED for buffered read/writes",
+               .category = FIO_OPT_C_ENGINE,
+               .group  = FIO_OPT_G_IOURING,
+       },
+       {
+               .name   = "nowait",
+               .lname  = "RWF_NOWAIT",
+               .type   = FIO_OPT_BOOL,
+               .off1   = offsetof(struct ioring_options, nowait),
+               .help   = "Use RWF_NOWAIT for reads/writes",
+               .category = FIO_OPT_C_ENGINE,
+               .group  = FIO_OPT_G_IOURING,
+       },
+       {
+               .name   = "force_async",
+               .lname  = "Force async",
+               .type   = FIO_OPT_INT,
+               .off1   = offsetof(struct ioring_options, force_async),
+               .help   = "Set IOSQE_ASYNC every N requests",
+               .category = FIO_OPT_C_ENGINE,
+               .group  = FIO_OPT_G_IOURING,
+       },
        {
                .name   = NULL,
        },
@@ -140,7 +287,7 @@ static struct fio_option options[] = {
 static int io_uring_enter(struct ioring_data *ld, unsigned int to_submit,
                         unsigned int min_complete, unsigned int flags)
 {
-       return syscall(__NR_sys_io_uring_enter, ld->ring_fd, to_submit,
+       return syscall(__NR_io_uring_enter, ld->ring_fd, to_submit,
                        min_complete, flags, NULL, 0);
 }
 
@@ -153,47 +300,67 @@ static int fio_ioring_prep(struct thread_data *td, struct io_u *io_u)
 
        sqe = &ld->sqes[io_u->index];
 
-       /* zero out fields not used in this submission */
-       memset(sqe, 0, sizeof(*sqe));
-
        if (o->registerfiles) {
                sqe->fd = f->engine_pos;
                sqe->flags = IOSQE_FIXED_FILE;
        } else {
                sqe->fd = f->fd;
+               sqe->flags = 0;
        }
 
        if (io_u->ddir == DDIR_READ || io_u->ddir == DDIR_WRITE) {
                if (o->fixedbufs) {
-                       if (io_u->ddir == DDIR_READ)
-                               sqe->opcode = IORING_OP_READ_FIXED;
-                       else
-                               sqe->opcode = IORING_OP_WRITE_FIXED;
+                       sqe->opcode = fixed_ddir_to_op[io_u->ddir];
                        sqe->addr = (unsigned long) io_u->xfer_buf;
                        sqe->len = io_u->xfer_buflen;
                        sqe->buf_index = io_u->index;
                } else {
-                       if (io_u->ddir == DDIR_READ)
-                               sqe->opcode = IORING_OP_READV;
-                       else
-                               sqe->opcode = IORING_OP_WRITEV;
-                       sqe->addr = (unsigned long) &ld->iovecs[io_u->index];
-                       sqe->len = 1;
+                       struct iovec *iov = &ld->iovecs[io_u->index];
+
+                       /*
+                        * Update based on actual io_u, requeue could have
+                        * adjusted these
+                        */
+                       iov->iov_base = io_u->xfer_buf;
+                       iov->iov_len = io_u->xfer_buflen;
+
+                       sqe->opcode = ddir_to_op[io_u->ddir][!!o->nonvectored];
+                       if (o->nonvectored) {
+                               sqe->addr = (unsigned long) iov->iov_base;
+                               sqe->len = iov->iov_len;
+                       } else {
+                               sqe->addr = (unsigned long) iov;
+                               sqe->len = 1;
+                       }
                }
+               sqe->rw_flags = 0;
+               if (!td->o.odirect && o->uncached)
+                       sqe->rw_flags |= RWF_UNCACHED;
+               if (o->nowait)
+                       sqe->rw_flags |= RWF_NOWAIT;
                sqe->off = io_u->offset;
        } else if (ddir_sync(io_u->ddir)) {
+               sqe->ioprio = 0;
                if (io_u->ddir == DDIR_SYNC_FILE_RANGE) {
                        sqe->off = f->first_write;
                        sqe->len = f->last_write - f->first_write;
                        sqe->sync_range_flags = td->o.sync_file_range;
                        sqe->opcode = IORING_OP_SYNC_FILE_RANGE;
                } else {
+                       sqe->off = 0;
+                       sqe->addr = 0;
+                       sqe->len = 0;
                        if (io_u->ddir == DDIR_DATASYNC)
                                sqe->fsync_flags |= IORING_FSYNC_DATASYNC;
                        sqe->opcode = IORING_OP_FSYNC;
                }
        }
 
+       if (o->force_async && ++ld->prepped == o->force_async) {
+               ld->prepped = 0;
+               sqe->flags |= IOSQE_ASYNC;
+       }
+
        sqe->user_data = (unsigned long) io_u;
        return 0;
 }
@@ -230,15 +397,15 @@ static int fio_ioring_cqring_reap(struct thread_data *td, unsigned int events,
 
        head = *ring->head;
        do {
-               read_barrier();
-               if (head == *ring->tail)
+               if (head == atomic_load_acquire(ring->tail))
                        break;
                reaped++;
                head++;
        } while (reaped + events < max);
 
-       *ring->head = head;
-       write_barrier();
+       if (reaped)
+               atomic_store_release(ring->head, head);
+
        return reaped;
 }
 
@@ -277,6 +444,43 @@ static int fio_ioring_getevents(struct thread_data *td, unsigned int min,
        return r < 0 ? r : events;
 }
 
+static void fio_ioring_prio_prep(struct thread_data *td, struct io_u *io_u)
+{
+       struct ioring_options *o = td->eo;
+       struct ioring_data *ld = td->io_ops_data;
+       struct io_uring_sqe *sqe = &ld->sqes[io_u->index];
+       struct cmdprio *cmdprio = &o->cmdprio;
+       enum fio_ddir ddir = io_u->ddir;
+       unsigned int p = fio_cmdprio_percentage(cmdprio, io_u);
+       unsigned int cmdprio_value =
+               ioprio_value(cmdprio->class[ddir], cmdprio->level[ddir]);
+
+       if (p && rand_between(&td->prio_state, 0, 99) < p) {
+               sqe->ioprio = cmdprio_value;
+               if (!td->ioprio || cmdprio_value < td->ioprio) {
+                       /*
+                        * The async IO priority is higher (has a lower value)
+                        * than the priority set by "prio" and "prioclass"
+                        * options.
+                        */
+                       io_u->flags |= IO_U_F_HIGH_PRIO;
+               }
+       } else {
+               sqe->ioprio = td->ioprio;
+               if (cmdprio_value && td->ioprio && td->ioprio < cmdprio_value) {
+                       /*
+                        * The IO will be executed with the priority set by
+                        * "prio" and "prioclass" options, and this priority
+                        * is higher (has a lower value) than the async IO
+                        * priority.
+                        */
+                       io_u->flags |= IO_U_F_HIGH_PRIO;
+               }
+       }
+
+       io_u->ioprio = sqe->ioprio;
+}
+
 static enum fio_q_status fio_ioring_queue(struct thread_data *td,
                                          struct io_u *io_u)
 {
@@ -301,15 +505,13 @@ static enum fio_q_status fio_ioring_queue(struct thread_data *td,
 
        tail = *ring->tail;
        next_tail = tail + 1;
-       read_barrier();
-       if (next_tail == *ring->head)
+       if (next_tail == atomic_load_acquire(ring->head))
                return FIO_Q_BUSY;
 
-       /* ensure sqe stores are ordered with tail update */
-       write_barrier();
+       if (ld->use_cmdprio)
+               fio_ioring_prio_prep(td, io_u);
        ring->array[tail & ld->sq_ring_mask] = io_u->index;
-       *ring->tail = next_tail;
-       write_barrier();
+       atomic_store_release(ring->tail, next_tail);
 
        ld->queued++;
        return FIO_Q_QUEUED;
@@ -353,9 +555,10 @@ static int fio_ioring_commit(struct thread_data *td)
         */
        if (o->sqpoll_thread) {
                struct io_sq_ring *ring = &ld->sq_ring;
+               unsigned flags;
 
-               read_barrier();
-               if (*ring->flags & IORING_SQ_NEED_WAKEUP)
+               flags = atomic_load_acquire(ring->flags);
+               if (flags & IORING_SQ_NEED_WAKEUP)
                        io_uring_enter(ld, ld->queued, 0,
                                        IORING_ENTER_SQ_WAKEUP);
                ld->queued = 0;
@@ -397,7 +600,7 @@ static void fio_ioring_unmap(struct ioring_data *ld)
 {
        int i;
 
-       for (i = 0; i < ARRAY_SIZE(ld->mmap); i++)
+       for (i = 0; i < FIO_ARRAY_SIZE(ld->mmap); i++)
                munmap(ld->mmap[i].ptr, ld->mmap[i].len);
        close(ld->ring_fd);
 }
@@ -457,6 +660,40 @@ static int fio_ioring_mmap(struct ioring_data *ld, struct io_uring_params *p)
        return 0;
 }
 
+static void fio_ioring_probe(struct thread_data *td)
+{
+       struct ioring_data *ld = td->io_ops_data;
+       struct ioring_options *o = td->eo;
+       struct io_uring_probe *p;
+       int ret;
+
+       /* already set by user, don't touch */
+       if (o->nonvectored != -1)
+               return;
+
+       /* default to off, as that's always safe */
+       o->nonvectored = 0;
+
+       p = malloc(sizeof(*p) + 256 * sizeof(struct io_uring_probe_op));
+       if (!p)
+               return;
+
+       memset(p, 0, sizeof(*p) + 256 * sizeof(struct io_uring_probe_op));
+       ret = syscall(__NR_io_uring_register, ld->ring_fd,
+                       IORING_REGISTER_PROBE, p, 256);
+       if (ret < 0)
+               goto out;
+
+       if (IORING_OP_WRITE > p->ops_len)
+               goto out;
+
+       if ((p->ops[IORING_OP_READ].flags & IO_URING_OP_SUPPORTED) &&
+           (p->ops[IORING_OP_WRITE].flags & IO_URING_OP_SUPPORTED))
+               o->nonvectored = 1;
+out:
+       free(p);
+}
+
 static int fio_ioring_queue_init(struct thread_data *td)
 {
        struct ioring_data *ld = td->io_ops_data;
@@ -477,22 +714,16 @@ static int fio_ioring_queue_init(struct thread_data *td)
                }
        }
 
-       ret = syscall(__NR_sys_io_uring_setup, depth, &p);
+       ret = syscall(__NR_io_uring_setup, depth, &p);
        if (ret < 0)
                return ret;
 
        ld->ring_fd = ret;
 
-       if (o->fixedbufs) {
-               struct rlimit rlim = {
-                       .rlim_cur = RLIM_INFINITY,
-                       .rlim_max = RLIM_INFINITY,
-               };
+       fio_ioring_probe(td);
 
-               if (setrlimit(RLIMIT_MEMLOCK, &rlim) < 0)
-                       return -1;
-
-               ret = syscall(__NR_sys_io_uring_register, ld->ring_fd,
+       if (o->fixedbufs) {
+               ret = syscall(__NR_io_uring_register, ld->ring_fd,
                                IORING_REGISTER_BUFFERS, ld->iovecs, depth);
                if (ret < 0)
                        return ret;
@@ -518,7 +749,7 @@ static int fio_ioring_register_files(struct thread_data *td)
                f->engine_pos = i;
        }
 
-       ret = syscall(__NR_sys_io_uring_register, ld->ring_fd,
+       ret = syscall(__NR_io_uring_register, ld->ring_fd,
                        IORING_REGISTER_FILES, ld->fds, td->o.nr_files);
        if (ret) {
 err:
@@ -558,10 +789,21 @@ static int fio_ioring_post_init(struct thread_data *td)
 
        err = fio_ioring_queue_init(td);
        if (err) {
-               td_verror(td, errno, "io_queue_init");
+               int init_err = errno;
+
+               if (init_err == ENOSYS)
+                       log_err("fio: your kernel doesn't support io_uring\n");
+               td_verror(td, init_err, "io_queue_init");
                return 1;
        }
 
+       for (i = 0; i < td->o.iodepth; i++) {
+               struct io_uring_sqe *sqe;
+
+               sqe = &ld->sqes[i];
+               memset(sqe, 0, sizeof(*sqe));
+       }
+
        if (o->registerfiles) {
                err = fio_ioring_register_files(td);
                if (err) {
@@ -573,15 +815,13 @@ static int fio_ioring_post_init(struct thread_data *td)
        return 0;
 }
 
-static unsigned roundup_pow2(unsigned depth)
-{
-       return 1UL << __fls(depth - 1);
-}
-
 static int fio_ioring_init(struct thread_data *td)
 {
        struct ioring_options *o = td->eo;
        struct ioring_data *ld;
+       struct cmdprio *cmdprio = &o->cmdprio;
+       bool has_cmdprio = false;
+       int ret;
 
        /* sqthread submission requires registered files */
        if (o->sqpoll_thread)
@@ -604,6 +844,23 @@ static int fio_ioring_init(struct thread_data *td)
        ld->iovecs = calloc(td->o.iodepth, sizeof(struct iovec));
 
        td->io_ops_data = ld;
+
+       ret = fio_cmdprio_init(td, cmdprio, &has_cmdprio);
+       if (ret) {
+               td_verror(td, EINVAL, "fio_ioring_init");
+               return 1;
+       }
+
+       /*
+        * Since io_uring can have a submission context (sqthread_poll) that is
+        * different from the process context, we cannot rely on the the IO
+        * priority set by ioprio_set() (option prio/prioclass) to be inherited.
+        * Therefore, we set the sqe->ioprio field when prio/prioclass is used.
+        */
+       ld->use_cmdprio = has_cmdprio ||
+               fio_option_is_set(&td->o, ioprio_class) ||
+               fio_option_is_set(&td->o, ioprio);
+
        return 0;
 }
 
@@ -642,7 +899,7 @@ static int fio_ioring_close_file(struct thread_data *td, struct fio_file *f)
 static struct ioengine_ops ioengine = {
        .name                   = "io_uring",
        .version                = FIO_IOOPS_VERSION,
-       .flags                  = FIO_ASYNCIO_SYNC_TRIM,
+       .flags                  = FIO_ASYNCIO_SYNC_TRIM | FIO_NO_OFFLOAD,
        .init                   = fio_ioring_init,
        .post_init              = fio_ioring_post_init,
        .io_u_init              = fio_ioring_io_u_init,