4 * IO engine using the new native Linux aio io_uring interface. See:
6 * http://git.kernel.dk/cgit/linux-block/log/?h=io_uring
13 #include <sys/resource.h>
16 #include "../lib/pow2.h"
17 #include "../optgroup.h"
18 #include "../lib/memalign.h"
19 #include "../lib/fls.h"
20 #include "../lib/roundup.h"
22 #ifdef ARCH_HAVE_IOURING
24 #include "../lib/types.h"
25 #include "../os/linux/io_uring.h"
32 FIO_URING_CMD_NVME = 1,
39 unsigned *ring_entries;
48 unsigned *ring_entries;
49 struct io_uring_cqe *cqes;
60 struct io_u **io_u_index;
64 struct io_sq_ring sq_ring;
65 struct io_uring_sqe *sqes;
67 unsigned sq_ring_mask;
69 struct io_cq_ring cq_ring;
70 unsigned cq_ring_mask;
77 struct ioring_mmap mmap[3];
79 struct cmdprio cmdprio;
82 struct ioring_options {
83 struct thread_data *td;
85 struct cmdprio_options cmdprio_options;
86 unsigned int fixedbufs;
87 unsigned int registerfiles;
88 unsigned int sqpoll_thread;
89 unsigned int sqpoll_set;
90 unsigned int sqpoll_cpu;
91 unsigned int nonvectored;
92 unsigned int uncached;
94 unsigned int force_async;
95 enum uring_cmd_type cmd_type;
98 static const int ddir_to_op[2][2] = {
99 { IORING_OP_READV, IORING_OP_READ },
100 { IORING_OP_WRITEV, IORING_OP_WRITE }
103 static const int fixed_ddir_to_op[2] = {
104 IORING_OP_READ_FIXED,
105 IORING_OP_WRITE_FIXED
108 static int fio_ioring_sqpoll_cb(void *data, unsigned long long *val)
110 struct ioring_options *o = data;
112 o->sqpoll_cpu = *val;
117 static struct fio_option options[] = {
120 .lname = "High Priority",
121 .type = FIO_OPT_STR_SET,
122 .off1 = offsetof(struct ioring_options, hipri),
123 .help = "Use polled IO completions",
124 .category = FIO_OPT_C_ENGINE,
125 .group = FIO_OPT_G_IOURING,
127 #ifdef FIO_HAVE_IOPRIO_CLASS
129 .name = "cmdprio_percentage",
130 .lname = "high priority percentage",
132 .off1 = offsetof(struct ioring_options,
133 cmdprio_options.percentage[DDIR_READ]),
134 .off2 = offsetof(struct ioring_options,
135 cmdprio_options.percentage[DDIR_WRITE]),
138 .help = "Send high priority I/O this percentage of the time",
139 .category = FIO_OPT_C_ENGINE,
140 .group = FIO_OPT_G_IOURING,
143 .name = "cmdprio_class",
144 .lname = "Asynchronous I/O priority class",
146 .off1 = offsetof(struct ioring_options,
147 cmdprio_options.class[DDIR_READ]),
148 .off2 = offsetof(struct ioring_options,
149 cmdprio_options.class[DDIR_WRITE]),
150 .help = "Set asynchronous IO priority class",
151 .minval = IOPRIO_MIN_PRIO_CLASS + 1,
152 .maxval = IOPRIO_MAX_PRIO_CLASS,
154 .category = FIO_OPT_C_ENGINE,
155 .group = FIO_OPT_G_IOURING,
159 .lname = "Asynchronous I/O priority level",
161 .off1 = offsetof(struct ioring_options,
162 cmdprio_options.level[DDIR_READ]),
163 .off2 = offsetof(struct ioring_options,
164 cmdprio_options.level[DDIR_WRITE]),
165 .help = "Set asynchronous IO priority level",
166 .minval = IOPRIO_MIN_PRIO,
167 .maxval = IOPRIO_MAX_PRIO,
169 .category = FIO_OPT_C_ENGINE,
170 .group = FIO_OPT_G_IOURING,
173 .name = "cmdprio_bssplit",
174 .lname = "Priority percentage block size split",
175 .type = FIO_OPT_STR_STORE,
176 .off1 = offsetof(struct ioring_options,
177 cmdprio_options.bssplit_str),
178 .help = "Set priority percentages for different block sizes",
179 .category = FIO_OPT_C_ENGINE,
180 .group = FIO_OPT_G_IOURING,
184 .name = "cmdprio_percentage",
185 .lname = "high priority percentage",
186 .type = FIO_OPT_UNSUPPORTED,
187 .help = "Your platform does not support I/O priority classes",
190 .name = "cmdprio_class",
191 .lname = "Asynchronous I/O priority class",
192 .type = FIO_OPT_UNSUPPORTED,
193 .help = "Your platform does not support I/O priority classes",
197 .lname = "Asynchronous I/O priority level",
198 .type = FIO_OPT_UNSUPPORTED,
199 .help = "Your platform does not support I/O priority classes",
202 .name = "cmdprio_bssplit",
203 .lname = "Priority percentage block size split",
204 .type = FIO_OPT_UNSUPPORTED,
205 .help = "Your platform does not support I/O priority classes",
210 .lname = "Fixed (pre-mapped) IO buffers",
211 .type = FIO_OPT_STR_SET,
212 .off1 = offsetof(struct ioring_options, fixedbufs),
213 .help = "Pre map IO buffers",
214 .category = FIO_OPT_C_ENGINE,
215 .group = FIO_OPT_G_IOURING,
218 .name = "registerfiles",
219 .lname = "Register file set",
220 .type = FIO_OPT_STR_SET,
221 .off1 = offsetof(struct ioring_options, registerfiles),
222 .help = "Pre-open/register files",
223 .category = FIO_OPT_C_ENGINE,
224 .group = FIO_OPT_G_IOURING,
227 .name = "sqthread_poll",
228 .lname = "Kernel SQ thread polling",
229 .type = FIO_OPT_STR_SET,
230 .off1 = offsetof(struct ioring_options, sqpoll_thread),
231 .help = "Offload submission/completion to kernel thread",
232 .category = FIO_OPT_C_ENGINE,
233 .group = FIO_OPT_G_IOURING,
236 .name = "sqthread_poll_cpu",
237 .lname = "SQ Thread Poll CPU",
239 .cb = fio_ioring_sqpoll_cb,
240 .help = "What CPU to run SQ thread polling on",
241 .category = FIO_OPT_C_ENGINE,
242 .group = FIO_OPT_G_IOURING,
245 .name = "nonvectored",
246 .lname = "Non-vectored",
248 .off1 = offsetof(struct ioring_options, nonvectored),
250 .help = "Use non-vectored read/write commands",
251 .category = FIO_OPT_C_ENGINE,
252 .group = FIO_OPT_G_IOURING,
258 .off1 = offsetof(struct ioring_options, uncached),
259 .help = "Use RWF_UNCACHED for buffered read/writes",
260 .category = FIO_OPT_C_ENGINE,
261 .group = FIO_OPT_G_IOURING,
265 .lname = "RWF_NOWAIT",
266 .type = FIO_OPT_BOOL,
267 .off1 = offsetof(struct ioring_options, nowait),
268 .help = "Use RWF_NOWAIT for reads/writes",
269 .category = FIO_OPT_C_ENGINE,
270 .group = FIO_OPT_G_IOURING,
273 .name = "force_async",
274 .lname = "Force async",
276 .off1 = offsetof(struct ioring_options, force_async),
277 .help = "Set IOSQE_ASYNC every N requests",
278 .category = FIO_OPT_C_ENGINE,
279 .group = FIO_OPT_G_IOURING,
283 .lname = "Uring cmd type",
285 .off1 = offsetof(struct ioring_options, cmd_type),
286 .help = "Specify uring-cmd type",
290 .oval = FIO_URING_CMD_NVME,
291 .help = "Issue nvme-uring-cmd",
294 .category = FIO_OPT_C_ENGINE,
295 .group = FIO_OPT_G_IOURING,
302 static int io_uring_enter(struct ioring_data *ld, unsigned int to_submit,
303 unsigned int min_complete, unsigned int flags)
305 #ifdef FIO_ARCH_HAS_SYSCALL
306 return __do_syscall6(__NR_io_uring_enter, ld->ring_fd, to_submit,
307 min_complete, flags, NULL, 0);
309 return syscall(__NR_io_uring_enter, ld->ring_fd, to_submit,
310 min_complete, flags, NULL, 0);
314 static int fio_ioring_prep(struct thread_data *td, struct io_u *io_u)
316 struct ioring_data *ld = td->io_ops_data;
317 struct ioring_options *o = td->eo;
318 struct fio_file *f = io_u->file;
319 struct io_uring_sqe *sqe;
321 sqe = &ld->sqes[io_u->index];
323 if (o->registerfiles) {
324 sqe->fd = f->engine_pos;
325 sqe->flags = IOSQE_FIXED_FILE;
331 if (io_u->ddir == DDIR_READ || io_u->ddir == DDIR_WRITE) {
333 sqe->opcode = fixed_ddir_to_op[io_u->ddir];
334 sqe->addr = (unsigned long) io_u->xfer_buf;
335 sqe->len = io_u->xfer_buflen;
336 sqe->buf_index = io_u->index;
338 struct iovec *iov = &ld->iovecs[io_u->index];
341 * Update based on actual io_u, requeue could have
344 iov->iov_base = io_u->xfer_buf;
345 iov->iov_len = io_u->xfer_buflen;
347 sqe->opcode = ddir_to_op[io_u->ddir][!!o->nonvectored];
348 if (o->nonvectored) {
349 sqe->addr = (unsigned long) iov->iov_base;
350 sqe->len = iov->iov_len;
352 sqe->addr = (unsigned long) iov;
357 if (!td->o.odirect && o->uncached)
358 sqe->rw_flags |= RWF_UNCACHED;
360 sqe->rw_flags |= RWF_NOWAIT;
363 * Since io_uring can have a submission context (sqthread_poll)
364 * that is different from the process context, we cannot rely on
365 * the IO priority set by ioprio_set() (option prio/prioclass)
367 * td->ioprio will have the value of the "default prio", so set
368 * this unconditionally. This value might get overridden by
369 * fio_ioring_cmdprio_prep() if the option cmdprio_percentage or
370 * cmdprio_bssplit is used.
372 sqe->ioprio = td->ioprio;
373 sqe->off = io_u->offset;
374 } else if (ddir_sync(io_u->ddir)) {
376 if (io_u->ddir == DDIR_SYNC_FILE_RANGE) {
377 sqe->off = f->first_write;
378 sqe->len = f->last_write - f->first_write;
379 sqe->sync_range_flags = td->o.sync_file_range;
380 sqe->opcode = IORING_OP_SYNC_FILE_RANGE;
385 if (io_u->ddir == DDIR_DATASYNC)
386 sqe->fsync_flags |= IORING_FSYNC_DATASYNC;
387 sqe->opcode = IORING_OP_FSYNC;
391 if (o->force_async && ++ld->prepped == o->force_async) {
393 sqe->flags |= IOSQE_ASYNC;
396 sqe->user_data = (unsigned long) io_u;
400 static int fio_ioring_cmd_prep(struct thread_data *td, struct io_u *io_u)
402 struct ioring_data *ld = td->io_ops_data;
403 struct ioring_options *o = td->eo;
404 struct fio_file *f = io_u->file;
405 struct nvme_uring_cmd *cmd;
406 struct io_uring_sqe *sqe;
408 /* only supports nvme_uring_cmd */
409 if (o->cmd_type != FIO_URING_CMD_NVME)
412 sqe = &ld->sqes[(io_u->index) << 1];
414 if (o->registerfiles) {
415 sqe->fd = f->engine_pos;
416 sqe->flags = IOSQE_FIXED_FILE;
421 if (!td->o.odirect && o->uncached)
422 sqe->rw_flags |= RWF_UNCACHED;
424 sqe->rw_flags |= RWF_NOWAIT;
426 sqe->opcode = IORING_OP_URING_CMD;
427 sqe->user_data = (unsigned long) io_u;
429 sqe->cmd_op = NVME_URING_CMD_IO;
431 sqe->cmd_op = NVME_URING_CMD_IO_VEC;
432 if (o->force_async && ++ld->prepped == o->force_async) {
434 sqe->flags |= IOSQE_ASYNC;
437 sqe->uring_cmd_flags = IORING_URING_CMD_FIXED;
438 sqe->buf_index = io_u->index;
441 cmd = (struct nvme_uring_cmd *)sqe->cmd;
442 return fio_nvme_uring_cmd_prep(cmd, io_u,
443 o->nonvectored ? NULL : &ld->iovecs[io_u->index]);
446 static struct io_u *fio_ioring_event(struct thread_data *td, int event)
448 struct ioring_data *ld = td->io_ops_data;
449 struct io_uring_cqe *cqe;
453 index = (event + ld->cq_ring_off) & ld->cq_ring_mask;
455 cqe = &ld->cq_ring.cqes[index];
456 io_u = (struct io_u *) (uintptr_t) cqe->user_data;
458 if (cqe->res != io_u->xfer_buflen) {
459 if (cqe->res > io_u->xfer_buflen)
460 io_u->error = -cqe->res;
462 io_u->resid = io_u->xfer_buflen - cqe->res;
469 static struct io_u *fio_ioring_cmd_event(struct thread_data *td, int event)
471 struct ioring_data *ld = td->io_ops_data;
472 struct ioring_options *o = td->eo;
473 struct io_uring_cqe *cqe;
477 index = (event + ld->cq_ring_off) & ld->cq_ring_mask;
478 if (o->cmd_type == FIO_URING_CMD_NVME)
481 cqe = &ld->cq_ring.cqes[index];
482 io_u = (struct io_u *) (uintptr_t) cqe->user_data;
485 io_u->error = -cqe->res;
492 static int fio_ioring_cqring_reap(struct thread_data *td, unsigned int events,
495 struct ioring_data *ld = td->io_ops_data;
496 struct io_cq_ring *ring = &ld->cq_ring;
497 unsigned head, reaped = 0;
501 if (head == atomic_load_acquire(ring->tail))
505 } while (reaped + events < max);
508 atomic_store_release(ring->head, head);
513 static int fio_ioring_getevents(struct thread_data *td, unsigned int min,
514 unsigned int max, const struct timespec *t)
516 struct ioring_data *ld = td->io_ops_data;
517 unsigned actual_min = td->o.iodepth_batch_complete_min == 0 ? 0 : min;
518 struct ioring_options *o = td->eo;
519 struct io_cq_ring *ring = &ld->cq_ring;
523 ld->cq_ring_off = *ring->head;
525 r = fio_ioring_cqring_reap(td, events, max);
533 if (!o->sqpoll_thread) {
534 r = io_uring_enter(ld, 0, actual_min,
535 IORING_ENTER_GETEVENTS);
537 if (errno == EAGAIN || errno == EINTR)
540 td_verror(td, errno, "io_uring_enter");
544 } while (events < min);
546 return r < 0 ? r : events;
549 static inline void fio_ioring_cmdprio_prep(struct thread_data *td,
552 struct ioring_data *ld = td->io_ops_data;
553 struct cmdprio *cmdprio = &ld->cmdprio;
555 if (fio_cmdprio_set_ioprio(td, cmdprio, io_u))
556 ld->sqes[io_u->index].ioprio = io_u->ioprio;
559 static enum fio_q_status fio_ioring_queue(struct thread_data *td,
562 struct ioring_data *ld = td->io_ops_data;
563 struct io_sq_ring *ring = &ld->sq_ring;
564 unsigned tail, next_tail;
566 fio_ro_check(td, io_u);
568 if (ld->queued == ld->iodepth)
571 if (io_u->ddir == DDIR_TRIM) {
575 do_io_u_trim(td, io_u);
576 io_u_mark_submit(td, 1);
577 io_u_mark_complete(td, 1);
578 return FIO_Q_COMPLETED;
582 next_tail = tail + 1;
583 if (next_tail == atomic_load_acquire(ring->head))
586 if (ld->cmdprio.mode != CMDPRIO_MODE_NONE)
587 fio_ioring_cmdprio_prep(td, io_u);
589 ring->array[tail & ld->sq_ring_mask] = io_u->index;
590 atomic_store_release(ring->tail, next_tail);
596 static void fio_ioring_queued(struct thread_data *td, int start, int nr)
598 struct ioring_data *ld = td->io_ops_data;
601 if (!fio_fill_issue_time(td))
604 fio_gettime(&now, NULL);
607 struct io_sq_ring *ring = &ld->sq_ring;
608 int index = ring->array[start & ld->sq_ring_mask];
609 struct io_u *io_u = ld->io_u_index[index];
611 memcpy(&io_u->issue_time, &now, sizeof(now));
612 io_u_queued(td, io_u);
618 * only used for iolog
620 if (td->o.read_iolog_file)
621 memcpy(&td->last_issue, &now, sizeof(now));
624 static int fio_ioring_commit(struct thread_data *td)
626 struct ioring_data *ld = td->io_ops_data;
627 struct ioring_options *o = td->eo;
634 * Kernel side does submission. just need to check if the ring is
635 * flagged as needing a kick, if so, call io_uring_enter(). This
636 * only happens if we've been idle too long.
638 if (o->sqpoll_thread) {
639 struct io_sq_ring *ring = &ld->sq_ring;
642 flags = atomic_load_acquire(ring->flags);
643 if (flags & IORING_SQ_NEED_WAKEUP)
644 io_uring_enter(ld, ld->queued, 0,
645 IORING_ENTER_SQ_WAKEUP);
651 unsigned start = *ld->sq_ring.head;
652 long nr = ld->queued;
654 ret = io_uring_enter(ld, nr, 0, IORING_ENTER_GETEVENTS);
656 fio_ioring_queued(td, start, ret);
657 io_u_mark_submit(td, ret);
662 io_u_mark_submit(td, ret);
665 if (errno == EAGAIN || errno == EINTR) {
666 ret = fio_ioring_cqring_reap(td, 0, ld->queued);
669 /* Shouldn't happen */
674 td_verror(td, errno, "io_uring_enter submit");
677 } while (ld->queued);
682 static void fio_ioring_unmap(struct ioring_data *ld)
686 for (i = 0; i < FIO_ARRAY_SIZE(ld->mmap); i++)
687 munmap(ld->mmap[i].ptr, ld->mmap[i].len);
691 static void fio_ioring_cleanup(struct thread_data *td)
693 struct ioring_data *ld = td->io_ops_data;
696 if (!(td->flags & TD_F_CHILD))
697 fio_ioring_unmap(ld);
699 fio_cmdprio_cleanup(&ld->cmdprio);
700 free(ld->io_u_index);
707 static int fio_ioring_mmap(struct ioring_data *ld, struct io_uring_params *p)
709 struct io_sq_ring *sring = &ld->sq_ring;
710 struct io_cq_ring *cring = &ld->cq_ring;
713 ld->mmap[0].len = p->sq_off.array + p->sq_entries * sizeof(__u32);
714 ptr = mmap(0, ld->mmap[0].len, PROT_READ | PROT_WRITE,
715 MAP_SHARED | MAP_POPULATE, ld->ring_fd,
717 ld->mmap[0].ptr = ptr;
718 sring->head = ptr + p->sq_off.head;
719 sring->tail = ptr + p->sq_off.tail;
720 sring->ring_mask = ptr + p->sq_off.ring_mask;
721 sring->ring_entries = ptr + p->sq_off.ring_entries;
722 sring->flags = ptr + p->sq_off.flags;
723 sring->array = ptr + p->sq_off.array;
724 ld->sq_ring_mask = *sring->ring_mask;
726 if (p->flags & IORING_SETUP_SQE128)
727 ld->mmap[1].len = 2 * p->sq_entries * sizeof(struct io_uring_sqe);
729 ld->mmap[1].len = p->sq_entries * sizeof(struct io_uring_sqe);
730 ld->sqes = mmap(0, ld->mmap[1].len, PROT_READ | PROT_WRITE,
731 MAP_SHARED | MAP_POPULATE, ld->ring_fd,
733 ld->mmap[1].ptr = ld->sqes;
735 if (p->flags & IORING_SETUP_CQE32) {
736 ld->mmap[2].len = p->cq_off.cqes +
737 2 * p->cq_entries * sizeof(struct io_uring_cqe);
739 ld->mmap[2].len = p->cq_off.cqes +
740 p->cq_entries * sizeof(struct io_uring_cqe);
742 ptr = mmap(0, ld->mmap[2].len, PROT_READ | PROT_WRITE,
743 MAP_SHARED | MAP_POPULATE, ld->ring_fd,
745 ld->mmap[2].ptr = ptr;
746 cring->head = ptr + p->cq_off.head;
747 cring->tail = ptr + p->cq_off.tail;
748 cring->ring_mask = ptr + p->cq_off.ring_mask;
749 cring->ring_entries = ptr + p->cq_off.ring_entries;
750 cring->cqes = ptr + p->cq_off.cqes;
751 ld->cq_ring_mask = *cring->ring_mask;
755 static void fio_ioring_probe(struct thread_data *td)
757 struct ioring_data *ld = td->io_ops_data;
758 struct ioring_options *o = td->eo;
759 struct io_uring_probe *p;
762 /* already set by user, don't touch */
763 if (o->nonvectored != -1)
766 /* default to off, as that's always safe */
769 p = malloc(sizeof(*p) + 256 * sizeof(struct io_uring_probe_op));
773 memset(p, 0, sizeof(*p) + 256 * sizeof(struct io_uring_probe_op));
774 ret = syscall(__NR_io_uring_register, ld->ring_fd,
775 IORING_REGISTER_PROBE, p, 256);
779 if (IORING_OP_WRITE > p->ops_len)
782 if ((p->ops[IORING_OP_READ].flags & IO_URING_OP_SUPPORTED) &&
783 (p->ops[IORING_OP_WRITE].flags & IO_URING_OP_SUPPORTED))
789 static int fio_ioring_queue_init(struct thread_data *td)
791 struct ioring_data *ld = td->io_ops_data;
792 struct ioring_options *o = td->eo;
793 int depth = td->o.iodepth;
794 struct io_uring_params p;
797 memset(&p, 0, sizeof(p));
800 p.flags |= IORING_SETUP_IOPOLL;
801 if (o->sqpoll_thread) {
802 p.flags |= IORING_SETUP_SQPOLL;
804 p.flags |= IORING_SETUP_SQ_AFF;
805 p.sq_thread_cpu = o->sqpoll_cpu;
810 * Clamp CQ ring size at our SQ ring size, we don't need more entries
813 p.flags |= IORING_SETUP_CQSIZE;
814 p.cq_entries = depth;
817 * Setup COOP_TASKRUN as we don't need to get IPI interrupted for
818 * completing IO operations.
820 p.flags |= IORING_SETUP_COOP_TASKRUN;
823 * io_uring is always a single issuer, and we can defer task_work
824 * runs until we reap events.
826 p.flags |= IORING_SETUP_SINGLE_ISSUER | IORING_SETUP_DEFER_TASKRUN;
829 ret = syscall(__NR_io_uring_setup, depth, &p);
831 if (errno == EINVAL && p.flags & IORING_SETUP_DEFER_TASKRUN) {
832 p.flags &= ~IORING_SETUP_DEFER_TASKRUN;
833 p.flags &= ~IORING_SETUP_SINGLE_ISSUER;
836 if (errno == EINVAL && p.flags & IORING_SETUP_COOP_TASKRUN) {
837 p.flags &= ~IORING_SETUP_COOP_TASKRUN;
840 if (errno == EINVAL && p.flags & IORING_SETUP_CQSIZE) {
841 p.flags &= ~IORING_SETUP_CQSIZE;
849 fio_ioring_probe(td);
852 ret = syscall(__NR_io_uring_register, ld->ring_fd,
853 IORING_REGISTER_BUFFERS, ld->iovecs, depth);
858 return fio_ioring_mmap(ld, &p);
861 static int fio_ioring_cmd_queue_init(struct thread_data *td)
863 struct ioring_data *ld = td->io_ops_data;
864 struct ioring_options *o = td->eo;
865 int depth = td->o.iodepth;
866 struct io_uring_params p;
869 memset(&p, 0, sizeof(p));
872 p.flags |= IORING_SETUP_IOPOLL;
873 if (o->sqpoll_thread) {
874 p.flags |= IORING_SETUP_SQPOLL;
876 p.flags |= IORING_SETUP_SQ_AFF;
877 p.sq_thread_cpu = o->sqpoll_cpu;
880 if (o->cmd_type == FIO_URING_CMD_NVME) {
881 p.flags |= IORING_SETUP_SQE128;
882 p.flags |= IORING_SETUP_CQE32;
886 * Clamp CQ ring size at our SQ ring size, we don't need more entries
889 p.flags |= IORING_SETUP_CQSIZE;
890 p.cq_entries = depth;
893 * Setup COOP_TASKRUN as we don't need to get IPI interrupted for
894 * completing IO operations.
896 p.flags |= IORING_SETUP_COOP_TASKRUN;
899 * io_uring is always a single issuer, and we can defer task_work
900 * runs until we reap events.
902 p.flags |= IORING_SETUP_SINGLE_ISSUER | IORING_SETUP_DEFER_TASKRUN;
905 ret = syscall(__NR_io_uring_setup, depth, &p);
907 if (errno == EINVAL && p.flags & IORING_SETUP_DEFER_TASKRUN) {
908 p.flags &= ~IORING_SETUP_DEFER_TASKRUN;
909 p.flags &= ~IORING_SETUP_SINGLE_ISSUER;
912 if (errno == EINVAL && p.flags & IORING_SETUP_COOP_TASKRUN) {
913 p.flags &= ~IORING_SETUP_COOP_TASKRUN;
916 if (errno == EINVAL && p.flags & IORING_SETUP_CQSIZE) {
917 p.flags &= ~IORING_SETUP_CQSIZE;
925 fio_ioring_probe(td);
928 ret = syscall(__NR_io_uring_register, ld->ring_fd,
929 IORING_REGISTER_BUFFERS, ld->iovecs, depth);
934 return fio_ioring_mmap(ld, &p);
937 static int fio_ioring_register_files(struct thread_data *td)
939 struct ioring_data *ld = td->io_ops_data;
944 ld->fds = calloc(td->o.nr_files, sizeof(int));
946 for_each_file(td, f, i) {
947 ret = generic_open_file(td, f);
954 ret = syscall(__NR_io_uring_register, ld->ring_fd,
955 IORING_REGISTER_FILES, ld->fds, td->o.nr_files);
963 * Pretend the file is closed again, and really close it if we hit
966 for_each_file(td, f, i) {
969 ret2 = generic_close_file(td, f);
977 static int fio_ioring_post_init(struct thread_data *td)
979 struct ioring_data *ld = td->io_ops_data;
980 struct ioring_options *o = td->eo;
984 for (i = 0; i < td->o.iodepth; i++) {
985 struct iovec *iov = &ld->iovecs[i];
987 io_u = ld->io_u_index[i];
988 iov->iov_base = io_u->buf;
989 iov->iov_len = td_max_bs(td);
992 err = fio_ioring_queue_init(td);
994 int init_err = errno;
996 if (init_err == ENOSYS)
997 log_err("fio: your kernel doesn't support io_uring\n");
998 td_verror(td, init_err, "io_queue_init");
1002 for (i = 0; i < td->o.iodepth; i++) {
1003 struct io_uring_sqe *sqe;
1006 memset(sqe, 0, sizeof(*sqe));
1009 if (o->registerfiles) {
1010 err = fio_ioring_register_files(td);
1012 td_verror(td, errno, "ioring_register_files");
1020 static int fio_ioring_cmd_post_init(struct thread_data *td)
1022 struct ioring_data *ld = td->io_ops_data;
1023 struct ioring_options *o = td->eo;
1027 for (i = 0; i < td->o.iodepth; i++) {
1028 struct iovec *iov = &ld->iovecs[i];
1030 io_u = ld->io_u_index[i];
1031 iov->iov_base = io_u->buf;
1032 iov->iov_len = td_max_bs(td);
1035 err = fio_ioring_cmd_queue_init(td);
1037 int init_err = errno;
1039 td_verror(td, init_err, "io_queue_init");
1043 for (i = 0; i < td->o.iodepth; i++) {
1044 struct io_uring_sqe *sqe;
1046 if (o->cmd_type == FIO_URING_CMD_NVME) {
1047 sqe = &ld->sqes[i << 1];
1048 memset(sqe, 0, 2 * sizeof(*sqe));
1051 memset(sqe, 0, sizeof(*sqe));
1055 if (o->registerfiles) {
1056 err = fio_ioring_register_files(td);
1058 td_verror(td, errno, "ioring_register_files");
1066 static int fio_ioring_init(struct thread_data *td)
1068 struct ioring_options *o = td->eo;
1069 struct ioring_data *ld;
1072 /* sqthread submission requires registered files */
1073 if (o->sqpoll_thread)
1074 o->registerfiles = 1;
1076 if (o->registerfiles && td->o.nr_files != td->o.open_files) {
1077 log_err("fio: io_uring registered files require nr_files to "
1078 "be identical to open_files\n");
1082 ld = calloc(1, sizeof(*ld));
1084 /* ring depth must be a power-of-2 */
1085 ld->iodepth = td->o.iodepth;
1086 td->o.iodepth = roundup_pow2(td->o.iodepth);
1089 ld->io_u_index = calloc(td->o.iodepth, sizeof(struct io_u *));
1090 ld->iovecs = calloc(td->o.iodepth, sizeof(struct iovec));
1092 td->io_ops_data = ld;
1094 ret = fio_cmdprio_init(td, &ld->cmdprio, &o->cmdprio_options);
1096 td_verror(td, EINVAL, "fio_ioring_init");
1103 static int fio_ioring_io_u_init(struct thread_data *td, struct io_u *io_u)
1105 struct ioring_data *ld = td->io_ops_data;
1107 ld->io_u_index[io_u->index] = io_u;
1111 static int fio_ioring_open_file(struct thread_data *td, struct fio_file *f)
1113 struct ioring_data *ld = td->io_ops_data;
1114 struct ioring_options *o = td->eo;
1116 if (!ld || !o->registerfiles)
1117 return generic_open_file(td, f);
1119 f->fd = ld->fds[f->engine_pos];
1123 static int fio_ioring_cmd_open_file(struct thread_data *td, struct fio_file *f)
1125 struct ioring_data *ld = td->io_ops_data;
1126 struct ioring_options *o = td->eo;
1128 if (o->cmd_type == FIO_URING_CMD_NVME) {
1129 struct nvme_data *data = NULL;
1130 unsigned int nsid, lba_size = 0;
1131 unsigned long long nlba = 0;
1134 /* Store the namespace-id and lba size. */
1135 data = FILE_ENG_DATA(f);
1137 ret = fio_nvme_get_info(f, &nsid, &lba_size, &nlba);
1141 data = calloc(1, sizeof(struct nvme_data));
1143 data->lba_shift = ilog2(lba_size);
1145 FILE_SET_ENG_DATA(f, data);
1148 if (!ld || !o->registerfiles)
1149 return generic_open_file(td, f);
1151 f->fd = ld->fds[f->engine_pos];
1155 static int fio_ioring_close_file(struct thread_data *td, struct fio_file *f)
1157 struct ioring_data *ld = td->io_ops_data;
1158 struct ioring_options *o = td->eo;
1160 if (!ld || !o->registerfiles)
1161 return generic_close_file(td, f);
1167 static int fio_ioring_cmd_close_file(struct thread_data *td,
1170 struct ioring_data *ld = td->io_ops_data;
1171 struct ioring_options *o = td->eo;
1173 if (o->cmd_type == FIO_URING_CMD_NVME) {
1174 struct nvme_data *data = FILE_ENG_DATA(f);
1176 FILE_SET_ENG_DATA(f, NULL);
1179 if (!ld || !o->registerfiles)
1180 return generic_close_file(td, f);
1186 static int fio_ioring_cmd_get_file_size(struct thread_data *td,
1189 struct ioring_options *o = td->eo;
1191 if (fio_file_size_known(f))
1194 if (o->cmd_type == FIO_URING_CMD_NVME) {
1195 struct nvme_data *data = NULL;
1196 unsigned int nsid, lba_size = 0;
1197 unsigned long long nlba = 0;
1200 ret = fio_nvme_get_info(f, &nsid, &lba_size, &nlba);
1204 data = calloc(1, sizeof(struct nvme_data));
1206 data->lba_shift = ilog2(lba_size);
1208 f->real_file_size = lba_size * nlba;
1209 fio_file_set_size_known(f);
1211 FILE_SET_ENG_DATA(f, data);
1214 return generic_get_file_size(td, f);
1217 static int fio_ioring_cmd_get_zoned_model(struct thread_data *td,
1219 enum zbd_zoned_model *model)
1221 return fio_nvme_get_zoned_model(td, f, model);
1224 static int fio_ioring_cmd_report_zones(struct thread_data *td,
1225 struct fio_file *f, uint64_t offset,
1226 struct zbd_zone *zbdz,
1227 unsigned int nr_zones)
1229 return fio_nvme_report_zones(td, f, offset, zbdz, nr_zones);
1232 static int fio_ioring_cmd_reset_wp(struct thread_data *td, struct fio_file *f,
1233 uint64_t offset, uint64_t length)
1235 return fio_nvme_reset_wp(td, f, offset, length);
1238 static int fio_ioring_cmd_get_max_open_zones(struct thread_data *td,
1240 unsigned int *max_open_zones)
1242 return fio_nvme_get_max_open_zones(td, f, max_open_zones);
1245 static struct ioengine_ops ioengine_uring = {
1247 .version = FIO_IOOPS_VERSION,
1248 .flags = FIO_ASYNCIO_SYNC_TRIM | FIO_NO_OFFLOAD |
1249 FIO_ASYNCIO_SETS_ISSUE_TIME,
1250 .init = fio_ioring_init,
1251 .post_init = fio_ioring_post_init,
1252 .io_u_init = fio_ioring_io_u_init,
1253 .prep = fio_ioring_prep,
1254 .queue = fio_ioring_queue,
1255 .commit = fio_ioring_commit,
1256 .getevents = fio_ioring_getevents,
1257 .event = fio_ioring_event,
1258 .cleanup = fio_ioring_cleanup,
1259 .open_file = fio_ioring_open_file,
1260 .close_file = fio_ioring_close_file,
1261 .get_file_size = generic_get_file_size,
1263 .option_struct_size = sizeof(struct ioring_options),
1266 static struct ioengine_ops ioengine_uring_cmd = {
1267 .name = "io_uring_cmd",
1268 .version = FIO_IOOPS_VERSION,
1269 .flags = FIO_ASYNCIO_SYNC_TRIM | FIO_NO_OFFLOAD |
1270 FIO_MEMALIGN | FIO_RAWIO |
1271 FIO_ASYNCIO_SETS_ISSUE_TIME,
1272 .init = fio_ioring_init,
1273 .post_init = fio_ioring_cmd_post_init,
1274 .io_u_init = fio_ioring_io_u_init,
1275 .prep = fio_ioring_cmd_prep,
1276 .queue = fio_ioring_queue,
1277 .commit = fio_ioring_commit,
1278 .getevents = fio_ioring_getevents,
1279 .event = fio_ioring_cmd_event,
1280 .cleanup = fio_ioring_cleanup,
1281 .open_file = fio_ioring_cmd_open_file,
1282 .close_file = fio_ioring_cmd_close_file,
1283 .get_file_size = fio_ioring_cmd_get_file_size,
1284 .get_zoned_model = fio_ioring_cmd_get_zoned_model,
1285 .report_zones = fio_ioring_cmd_report_zones,
1286 .reset_wp = fio_ioring_cmd_reset_wp,
1287 .get_max_open_zones = fio_ioring_cmd_get_max_open_zones,
1289 .option_struct_size = sizeof(struct ioring_options),
1292 static void fio_init fio_ioring_register(void)
1294 register_ioengine(&ioengine_uring);
1295 register_ioengine(&ioengine_uring_cmd);
1298 static void fio_exit fio_ioring_unregister(void)
1300 unregister_ioengine(&ioengine_uring);
1301 unregister_ioengine(&ioengine_uring_cmd);