engines/io_uring: add verbose error for ENOSYS
[fio.git] / engines / io_uring.c
CommitLineData
52885fa2 1/*
bffad86f 2 * io_uring engine
52885fa2 3 *
bffad86f 4 * IO engine using the new native Linux aio io_uring interface. See:
a90cd050 5 *
bffad86f 6 * http://git.kernel.dk/cgit/linux-block/log/?h=io_uring
52885fa2
JA
7 *
8 */
9#include <stdlib.h>
10#include <unistd.h>
11#include <errno.h>
52885fa2
JA
12#include <sys/time.h>
13#include <sys/resource.h>
14
15#include "../fio.h"
16#include "../lib/pow2.h"
17#include "../optgroup.h"
18#include "../lib/memalign.h"
b87aa01a 19#include "../lib/fls.h"
6d975f2c 20#include "../lib/roundup.h"
52885fa2 21
bffad86f 22#ifdef ARCH_HAVE_IOURING
52885fa2 23
57fa61f0 24#include "../lib/types.h"
f3e769a4 25#include "../os/linux/io_uring.h"
9a2d78b3 26
bffad86f 27struct io_sq_ring {
e2239016
JA
28 unsigned *head;
29 unsigned *tail;
30 unsigned *ring_mask;
31 unsigned *ring_entries;
32 unsigned *flags;
33 unsigned *array;
52885fa2
JA
34};
35
bffad86f 36struct io_cq_ring {
e2239016
JA
37 unsigned *head;
38 unsigned *tail;
39 unsigned *ring_mask;
40 unsigned *ring_entries;
f0403f94 41 struct io_uring_cqe *cqes;
9a2d78b3
JA
42};
43
bffad86f 44struct ioring_mmap {
9a2d78b3
JA
45 void *ptr;
46 size_t len;
52885fa2
JA
47};
48
bffad86f 49struct ioring_data {
9a2d78b3
JA
50 int ring_fd;
51
52885fa2
JA
52 struct io_u **io_u_index;
53
5ffd5626
JA
54 int *fds;
55
bffad86f 56 struct io_sq_ring sq_ring;
f0403f94 57 struct io_uring_sqe *sqes;
9a2d78b3 58 struct iovec *iovecs;
b87aa01a 59 unsigned sq_ring_mask;
52885fa2 60
bffad86f 61 struct io_cq_ring cq_ring;
b87aa01a 62 unsigned cq_ring_mask;
52885fa2
JA
63
64 int queued;
65 int cq_ring_off;
b87aa01a 66 unsigned iodepth;
1af44196
XW
67 bool ioprio_class_set;
68 bool ioprio_set;
5a59a81d 69 int prepped;
96563db9 70
bffad86f 71 struct ioring_mmap mmap[3];
52885fa2
JA
72};
73
bffad86f 74struct ioring_options {
52885fa2
JA
75 void *pad;
76 unsigned int hipri;
b2a432bf 77 unsigned int cmdprio_percentage;
52885fa2 78 unsigned int fixedbufs;
5ffd5626 79 unsigned int registerfiles;
3d7d00a3 80 unsigned int sqpoll_thread;
2ea53ca3
JA
81 unsigned int sqpoll_set;
82 unsigned int sqpoll_cpu;
b10b1e70 83 unsigned int nonvectored;
4a87b584 84 unsigned int uncached;
7d42e66e 85 unsigned int nowait;
5a59a81d 86 unsigned int force_async;
52885fa2
JA
87};
88
b10b1e70
JA
89static const int ddir_to_op[2][2] = {
90 { IORING_OP_READV, IORING_OP_READ },
91 { IORING_OP_WRITEV, IORING_OP_WRITE }
92};
93
3f1e3af7
KB
94static const int fixed_ddir_to_op[2] = {
95 IORING_OP_READ_FIXED,
96 IORING_OP_WRITE_FIXED
97};
98
2ea53ca3 99static int fio_ioring_sqpoll_cb(void *data, unsigned long long *val)
a90cd050 100{
bffad86f 101 struct ioring_options *o = data;
a90cd050 102
2ea53ca3
JA
103 o->sqpoll_cpu = *val;
104 o->sqpoll_set = 1;
a90cd050
JA
105 return 0;
106}
107
52885fa2
JA
108static struct fio_option options[] = {
109 {
110 .name = "hipri",
111 .lname = "High Priority",
112 .type = FIO_OPT_STR_SET,
bffad86f 113 .off1 = offsetof(struct ioring_options, hipri),
52885fa2
JA
114 .help = "Use polled IO completions",
115 .category = FIO_OPT_C_ENGINE,
27f436d9 116 .group = FIO_OPT_G_IOURING,
52885fa2 117 },
b2a432bf
PC
118#ifdef FIO_HAVE_IOPRIO_CLASS
119 {
120 .name = "cmdprio_percentage",
121 .lname = "high priority percentage",
122 .type = FIO_OPT_INT,
123 .off1 = offsetof(struct ioring_options, cmdprio_percentage),
124 .minval = 1,
125 .maxval = 100,
126 .help = "Send high priority I/O this percentage of the time",
127 .category = FIO_OPT_C_ENGINE,
128 .group = FIO_OPT_G_IOURING,
129 },
130#else
131 {
132 .name = "cmdprio_percentage",
133 .lname = "high priority percentage",
134 .type = FIO_OPT_UNSUPPORTED,
135 .help = "Your platform does not support I/O priority classes",
136 },
137#endif
52885fa2
JA
138 {
139 .name = "fixedbufs",
140 .lname = "Fixed (pre-mapped) IO buffers",
141 .type = FIO_OPT_STR_SET,
bffad86f 142 .off1 = offsetof(struct ioring_options, fixedbufs),
52885fa2
JA
143 .help = "Pre map IO buffers",
144 .category = FIO_OPT_C_ENGINE,
27f436d9 145 .group = FIO_OPT_G_IOURING,
52885fa2 146 },
5ffd5626
JA
147 {
148 .name = "registerfiles",
149 .lname = "Register file set",
150 .type = FIO_OPT_STR_SET,
151 .off1 = offsetof(struct ioring_options, registerfiles),
152 .help = "Pre-open/register files",
153 .category = FIO_OPT_C_ENGINE,
27f436d9 154 .group = FIO_OPT_G_IOURING,
5ffd5626 155 },
771c9901
JA
156 {
157 .name = "sqthread_poll",
3d7d00a3
JA
158 .lname = "Kernel SQ thread polling",
159 .type = FIO_OPT_INT,
160 .off1 = offsetof(struct ioring_options, sqpoll_thread),
161 .help = "Offload submission/completion to kernel thread",
162 .category = FIO_OPT_C_ENGINE,
27f436d9 163 .group = FIO_OPT_G_IOURING,
3d7d00a3
JA
164 },
165 {
166 .name = "sqthread_poll_cpu",
167 .lname = "SQ Thread Poll CPU",
2ea53ca3
JA
168 .type = FIO_OPT_INT,
169 .cb = fio_ioring_sqpoll_cb,
3d7d00a3 170 .help = "What CPU to run SQ thread polling on",
a90cd050 171 .category = FIO_OPT_C_ENGINE,
27f436d9 172 .group = FIO_OPT_G_IOURING,
a90cd050 173 },
b10b1e70
JA
174 {
175 .name = "nonvectored",
176 .lname = "Non-vectored",
177 .type = FIO_OPT_INT,
178 .off1 = offsetof(struct ioring_options, nonvectored),
556d8415 179 .def = "-1",
b10b1e70
JA
180 .help = "Use non-vectored read/write commands",
181 .category = FIO_OPT_C_ENGINE,
182 .group = FIO_OPT_G_IOURING,
183 },
4a87b584
JA
184 {
185 .name = "uncached",
186 .lname = "Uncached",
187 .type = FIO_OPT_INT,
188 .off1 = offsetof(struct ioring_options, uncached),
189 .help = "Use RWF_UNCACHED for buffered read/writes",
190 .category = FIO_OPT_C_ENGINE,
191 .group = FIO_OPT_G_IOURING,
192 },
7d42e66e
KK
193 {
194 .name = "nowait",
195 .lname = "RWF_NOWAIT",
196 .type = FIO_OPT_BOOL,
197 .off1 = offsetof(struct ioring_options, nowait),
198 .help = "Use RWF_NOWAIT for reads/writes",
199 .category = FIO_OPT_C_ENGINE,
200 .group = FIO_OPT_G_IOURING,
201 },
5a59a81d
JA
202 {
203 .name = "force_async",
204 .lname = "Force async",
205 .type = FIO_OPT_INT,
206 .off1 = offsetof(struct ioring_options, force_async),
207 .help = "Set IOSQE_ASYNC every N requests",
208 .category = FIO_OPT_C_ENGINE,
209 .group = FIO_OPT_G_IOURING,
210 },
52885fa2
JA
211 {
212 .name = NULL,
213 },
214};
215
bffad86f 216static int io_uring_enter(struct ioring_data *ld, unsigned int to_submit,
52885fa2
JA
217 unsigned int min_complete, unsigned int flags)
218{
bfed648c 219 return syscall(__NR_io_uring_enter, ld->ring_fd, to_submit,
521164fa 220 min_complete, flags, NULL, 0);
52885fa2
JA
221}
222
bffad86f 223static int fio_ioring_prep(struct thread_data *td, struct io_u *io_u)
52885fa2 224{
bffad86f 225 struct ioring_data *ld = td->io_ops_data;
cfcc8564 226 struct ioring_options *o = td->eo;
52885fa2 227 struct fio_file *f = io_u->file;
f0403f94 228 struct io_uring_sqe *sqe;
52885fa2 229
f0403f94 230 sqe = &ld->sqes[io_u->index];
34d6090e 231
5ffd5626
JA
232 if (o->registerfiles) {
233 sqe->fd = f->engine_pos;
234 sqe->flags = IOSQE_FIXED_FILE;
235 } else {
236 sqe->fd = f->fd;
5ffd5626 237 }
52885fa2 238
e3970057 239 if (io_u->ddir == DDIR_READ || io_u->ddir == DDIR_WRITE) {
f0403f94 240 if (o->fixedbufs) {
3f1e3af7 241 sqe->opcode = fixed_ddir_to_op[io_u->ddir];
919850d2 242 sqe->addr = (unsigned long) io_u->xfer_buf;
f0403f94 243 sqe->len = io_u->xfer_buflen;
2ea53ca3 244 sqe->buf_index = io_u->index;
cfcc8564 245 } else {
832faaaf
JA
246 struct iovec *iov = &ld->iovecs[io_u->index];
247
248 /*
249 * Update based on actual io_u, requeue could have
250 * adjusted these
251 */
252 iov->iov_base = io_u->xfer_buf;
253 iov->iov_len = io_u->xfer_buflen;
254
3f1e3af7 255 sqe->opcode = ddir_to_op[io_u->ddir][!!o->nonvectored];
b10b1e70 256 if (o->nonvectored) {
832faaaf
JA
257 sqe->addr = (unsigned long) iov->iov_base;
258 sqe->len = iov->iov_len;
b10b1e70 259 } else {
832faaaf 260 sqe->addr = (unsigned long) iov;
b10b1e70
JA
261 sqe->len = 1;
262 }
cfcc8564 263 }
4a87b584
JA
264 if (!td->o.odirect && o->uncached)
265 sqe->rw_flags = RWF_UNCACHED;
7d42e66e
KK
266 if (o->nowait)
267 sqe->rw_flags |= RWF_NOWAIT;
1af44196 268 if (ld->ioprio_class_set)
b7ed2a86 269 sqe->ioprio = td->o.ioprio_class << 13;
1af44196 270 if (ld->ioprio_set)
b7ed2a86 271 sqe->ioprio |= td->o.ioprio;
f0403f94 272 sqe->off = io_u->offset;
7c70f506 273 sqe->rw_flags = 0;
48e698fa 274 } else if (ddir_sync(io_u->ddir)) {
7c70f506 275 sqe->ioprio = 0;
01387bfe
AF
276 if (io_u->ddir == DDIR_SYNC_FILE_RANGE) {
277 sqe->off = f->first_write;
278 sqe->len = f->last_write - f->first_write;
279 sqe->sync_range_flags = td->o.sync_file_range;
280 sqe->opcode = IORING_OP_SYNC_FILE_RANGE;
281 } else {
7c70f506
JA
282 sqe->off = 0;
283 sqe->addr = 0;
284 sqe->len = 0;
01387bfe
AF
285 if (io_u->ddir == DDIR_DATASYNC)
286 sqe->fsync_flags |= IORING_FSYNC_DATASYNC;
287 sqe->opcode = IORING_OP_FSYNC;
288 }
48e698fa 289 }
52885fa2 290
5a59a81d
JA
291 if (o->force_async && ++ld->prepped == o->force_async) {
292 ld->prepped = 0;
293 sqe->flags |= IOSQE_ASYNC;
294 }
295
48e698fa 296 sqe->user_data = (unsigned long) io_u;
52885fa2
JA
297 return 0;
298}
299
bffad86f 300static struct io_u *fio_ioring_event(struct thread_data *td, int event)
52885fa2 301{
bffad86f 302 struct ioring_data *ld = td->io_ops_data;
f0403f94 303 struct io_uring_cqe *cqe;
52885fa2 304 struct io_u *io_u;
b87aa01a 305 unsigned index;
52885fa2 306
b87aa01a 307 index = (event + ld->cq_ring_off) & ld->cq_ring_mask;
52885fa2 308
f0403f94 309 cqe = &ld->cq_ring.cqes[index];
e3466352 310 io_u = (struct io_u *) (uintptr_t) cqe->user_data;
52885fa2 311
f0403f94
JA
312 if (cqe->res != io_u->xfer_buflen) {
313 if (cqe->res > io_u->xfer_buflen)
314 io_u->error = -cqe->res;
52885fa2 315 else
f0403f94 316 io_u->resid = io_u->xfer_buflen - cqe->res;
52885fa2
JA
317 } else
318 io_u->error = 0;
319
320 return io_u;
321}
322
bffad86f 323static int fio_ioring_cqring_reap(struct thread_data *td, unsigned int events,
52885fa2
JA
324 unsigned int max)
325{
bffad86f
JA
326 struct ioring_data *ld = td->io_ops_data;
327 struct io_cq_ring *ring = &ld->cq_ring;
e2239016 328 unsigned head, reaped = 0;
52885fa2 329
9a2d78b3 330 head = *ring->head;
52885fa2 331 do {
9e26aff9 332 if (head == atomic_load_acquire(ring->tail))
52885fa2
JA
333 break;
334 reaped++;
335 head++;
52885fa2
JA
336 } while (reaped + events < max);
337
76ce63dd
AB
338 if (reaped)
339 atomic_store_release(ring->head, head);
340
52885fa2
JA
341 return reaped;
342}
343
bffad86f
JA
344static int fio_ioring_getevents(struct thread_data *td, unsigned int min,
345 unsigned int max, const struct timespec *t)
52885fa2 346{
bffad86f 347 struct ioring_data *ld = td->io_ops_data;
52885fa2 348 unsigned actual_min = td->o.iodepth_batch_complete_min == 0 ? 0 : min;
bffad86f
JA
349 struct ioring_options *o = td->eo;
350 struct io_cq_ring *ring = &ld->cq_ring;
b87aa01a
JA
351 unsigned events = 0;
352 int r;
52885fa2 353
9a2d78b3 354 ld->cq_ring_off = *ring->head;
52885fa2 355 do {
bffad86f 356 r = fio_ioring_cqring_reap(td, events, max);
52885fa2
JA
357 if (r) {
358 events += r;
f7cbbbf8
ST
359 if (actual_min != 0)
360 actual_min -= r;
52885fa2
JA
361 continue;
362 }
363
3d7d00a3 364 if (!o->sqpoll_thread) {
9a2d78b3
JA
365 r = io_uring_enter(ld, 0, actual_min,
366 IORING_ENTER_GETEVENTS);
771c9901 367 if (r < 0) {
f6abd731 368 if (errno == EAGAIN || errno == EINTR)
771c9901 369 continue;
9a2d78b3 370 td_verror(td, errno, "io_uring_enter");
771c9901
JA
371 break;
372 }
52885fa2
JA
373 }
374 } while (events < min);
375
376 return r < 0 ? r : events;
377}
378
b2a432bf
PC
379static void fio_ioring_prio_prep(struct thread_data *td, struct io_u *io_u)
380{
381 struct ioring_options *o = td->eo;
382 struct ioring_data *ld = td->io_ops_data;
383 if (rand_between(&td->prio_state, 0, 99) < o->cmdprio_percentage) {
384 ld->sqes[io_u->index].ioprio = IOPRIO_CLASS_RT << IOPRIO_CLASS_SHIFT;
385 io_u->flags |= IO_U_F_PRIORITY;
386 }
387 return;
388}
389
bffad86f
JA
390static enum fio_q_status fio_ioring_queue(struct thread_data *td,
391 struct io_u *io_u)
52885fa2 392{
bffad86f
JA
393 struct ioring_data *ld = td->io_ops_data;
394 struct io_sq_ring *ring = &ld->sq_ring;
b2a432bf 395 struct ioring_options *o = td->eo;
52885fa2
JA
396 unsigned tail, next_tail;
397
398 fio_ro_check(td, io_u);
399
b87aa01a 400 if (ld->queued == ld->iodepth)
52885fa2
JA
401 return FIO_Q_BUSY;
402
52885fa2
JA
403 if (io_u->ddir == DDIR_TRIM) {
404 if (ld->queued)
405 return FIO_Q_BUSY;
406
407 do_io_u_trim(td, io_u);
408 io_u_mark_submit(td, 1);
409 io_u_mark_complete(td, 1);
410 return FIO_Q_COMPLETED;
411 }
412
9a2d78b3 413 tail = *ring->tail;
52885fa2 414 next_tail = tail + 1;
9e26aff9 415 if (next_tail == atomic_load_acquire(ring->head))
52885fa2
JA
416 return FIO_Q_BUSY;
417
b2a432bf
PC
418 if (o->cmdprio_percentage)
419 fio_ioring_prio_prep(td, io_u);
b87aa01a 420 ring->array[tail & ld->sq_ring_mask] = io_u->index;
9e26aff9 421 atomic_store_release(ring->tail, next_tail);
52885fa2
JA
422
423 ld->queued++;
424 return FIO_Q_QUEUED;
425}
426
bffad86f 427static void fio_ioring_queued(struct thread_data *td, int start, int nr)
52885fa2 428{
bffad86f 429 struct ioring_data *ld = td->io_ops_data;
52885fa2
JA
430 struct timespec now;
431
432 if (!fio_fill_issue_time(td))
433 return;
434
435 fio_gettime(&now, NULL);
436
437 while (nr--) {
bffad86f 438 struct io_sq_ring *ring = &ld->sq_ring;
9a2d78b3 439 int index = ring->array[start & ld->sq_ring_mask];
f8289afc 440 struct io_u *io_u = ld->io_u_index[index];
52885fa2
JA
441
442 memcpy(&io_u->issue_time, &now, sizeof(now));
443 io_u_queued(td, io_u);
444
445 start++;
52885fa2
JA
446 }
447}
448
bffad86f 449static int fio_ioring_commit(struct thread_data *td)
52885fa2 450{
bffad86f
JA
451 struct ioring_data *ld = td->io_ops_data;
452 struct ioring_options *o = td->eo;
52885fa2
JA
453 int ret;
454
455 if (!ld->queued)
456 return 0;
457
3d7d00a3
JA
458 /*
459 * Kernel side does submission. just need to check if the ring is
460 * flagged as needing a kick, if so, call io_uring_enter(). This
461 * only happens if we've been idle too long.
462 */
463 if (o->sqpoll_thread) {
bffad86f 464 struct io_sq_ring *ring = &ld->sq_ring;
2dd96cc4 465 unsigned flags;
4cdbc048 466
2dd96cc4
JA
467 flags = atomic_load_acquire(ring->flags);
468 if (flags & IORING_SQ_NEED_WAKEUP)
b532dd6d
JA
469 io_uring_enter(ld, ld->queued, 0,
470 IORING_ENTER_SQ_WAKEUP);
771c9901
JA
471 ld->queued = 0;
472 return 0;
473 }
474
52885fa2 475 do {
9a2d78b3 476 unsigned start = *ld->sq_ring.head;
52885fa2
JA
477 long nr = ld->queued;
478
9a2d78b3 479 ret = io_uring_enter(ld, nr, 0, IORING_ENTER_GETEVENTS);
52885fa2 480 if (ret > 0) {
bffad86f 481 fio_ioring_queued(td, start, ret);
52885fa2
JA
482 io_u_mark_submit(td, ret);
483
484 ld->queued -= ret;
485 ret = 0;
a90cd050
JA
486 } else if (!ret) {
487 io_u_mark_submit(td, ret);
52885fa2 488 continue;
a90cd050 489 } else {
f6abd731 490 if (errno == EAGAIN || errno == EINTR) {
bffad86f 491 ret = fio_ioring_cqring_reap(td, 0, ld->queued);
a90cd050
JA
492 if (ret)
493 continue;
494 /* Shouldn't happen */
495 usleep(1);
496 continue;
52885fa2 497 }
9a2d78b3 498 td_verror(td, errno, "io_uring_enter submit");
52885fa2 499 break;
a90cd050 500 }
52885fa2
JA
501 } while (ld->queued);
502
503 return ret;
504}
505
bffad86f 506static void fio_ioring_unmap(struct ioring_data *ld)
52885fa2 507{
9a2d78b3 508 int i;
52885fa2 509
59f94d26 510 for (i = 0; i < FIO_ARRAY_SIZE(ld->mmap); i++)
9a2d78b3
JA
511 munmap(ld->mmap[i].ptr, ld->mmap[i].len);
512 close(ld->ring_fd);
b87aa01a
JA
513}
514
bffad86f 515static void fio_ioring_cleanup(struct thread_data *td)
52885fa2 516{
bffad86f 517 struct ioring_data *ld = td->io_ops_data;
52885fa2
JA
518
519 if (ld) {
52885fa2 520 if (!(td->flags & TD_F_CHILD))
bffad86f 521 fio_ioring_unmap(ld);
9a2d78b3 522
52885fa2 523 free(ld->io_u_index);
9a2d78b3 524 free(ld->iovecs);
5ffd5626 525 free(ld->fds);
52885fa2
JA
526 free(ld);
527 }
528}
529
bffad86f 530static int fio_ioring_mmap(struct ioring_data *ld, struct io_uring_params *p)
9a2d78b3 531{
bffad86f
JA
532 struct io_sq_ring *sring = &ld->sq_ring;
533 struct io_cq_ring *cring = &ld->cq_ring;
9a2d78b3
JA
534 void *ptr;
535
e2239016 536 ld->mmap[0].len = p->sq_off.array + p->sq_entries * sizeof(__u32);
9a2d78b3
JA
537 ptr = mmap(0, ld->mmap[0].len, PROT_READ | PROT_WRITE,
538 MAP_SHARED | MAP_POPULATE, ld->ring_fd,
539 IORING_OFF_SQ_RING);
540 ld->mmap[0].ptr = ptr;
541 sring->head = ptr + p->sq_off.head;
542 sring->tail = ptr + p->sq_off.tail;
543 sring->ring_mask = ptr + p->sq_off.ring_mask;
544 sring->ring_entries = ptr + p->sq_off.ring_entries;
545 sring->flags = ptr + p->sq_off.flags;
ac122fea 546 sring->array = ptr + p->sq_off.array;
9a2d78b3
JA
547 ld->sq_ring_mask = *sring->ring_mask;
548
f0403f94
JA
549 ld->mmap[1].len = p->sq_entries * sizeof(struct io_uring_sqe);
550 ld->sqes = mmap(0, ld->mmap[1].len, PROT_READ | PROT_WRITE,
9a2d78b3 551 MAP_SHARED | MAP_POPULATE, ld->ring_fd,
f0403f94
JA
552 IORING_OFF_SQES);
553 ld->mmap[1].ptr = ld->sqes;
9a2d78b3 554
f0403f94
JA
555 ld->mmap[2].len = p->cq_off.cqes +
556 p->cq_entries * sizeof(struct io_uring_cqe);
9a2d78b3
JA
557 ptr = mmap(0, ld->mmap[2].len, PROT_READ | PROT_WRITE,
558 MAP_SHARED | MAP_POPULATE, ld->ring_fd,
559 IORING_OFF_CQ_RING);
560 ld->mmap[2].ptr = ptr;
561 cring->head = ptr + p->cq_off.head;
562 cring->tail = ptr + p->cq_off.tail;
563 cring->ring_mask = ptr + p->cq_off.ring_mask;
564 cring->ring_entries = ptr + p->cq_off.ring_entries;
f0403f94 565 cring->cqes = ptr + p->cq_off.cqes;
9a2d78b3
JA
566 ld->cq_ring_mask = *cring->ring_mask;
567 return 0;
568}
569
556d8415
JA
570static void fio_ioring_probe(struct thread_data *td)
571{
572 struct ioring_data *ld = td->io_ops_data;
573 struct ioring_options *o = td->eo;
574 struct io_uring_probe *p;
575 int ret;
576
577 /* already set by user, don't touch */
578 if (o->nonvectored != -1)
579 return;
580
581 /* default to off, as that's always safe */
582 o->nonvectored = 0;
583
584 p = malloc(sizeof(*p) + 256 * sizeof(struct io_uring_probe_op));
585 if (!p)
586 return;
587
588 memset(p, 0, sizeof(*p) + 256 * sizeof(struct io_uring_probe_op));
589 ret = syscall(__NR_io_uring_register, ld->ring_fd,
590 IORING_REGISTER_PROBE, p, 256);
591 if (ret < 0)
592 goto out;
593
594 if (IORING_OP_WRITE > p->ops_len)
595 goto out;
596
597 if ((p->ops[IORING_OP_READ].flags & IO_URING_OP_SUPPORTED) &&
598 (p->ops[IORING_OP_WRITE].flags & IO_URING_OP_SUPPORTED))
599 o->nonvectored = 1;
600out:
601 free(p);
602}
603
bffad86f 604static int fio_ioring_queue_init(struct thread_data *td)
52885fa2 605{
bffad86f
JA
606 struct ioring_data *ld = td->io_ops_data;
607 struct ioring_options *o = td->eo;
52885fa2 608 int depth = td->o.iodepth;
bffad86f 609 struct io_uring_params p;
9a2d78b3
JA
610 int ret;
611
612 memset(&p, 0, sizeof(p));
52885fa2
JA
613
614 if (o->hipri)
bffad86f 615 p.flags |= IORING_SETUP_IOPOLL;
3d7d00a3
JA
616 if (o->sqpoll_thread) {
617 p.flags |= IORING_SETUP_SQPOLL;
618 if (o->sqpoll_set) {
619 p.flags |= IORING_SETUP_SQ_AFF;
620 p.sq_thread_cpu = o->sqpoll_cpu;
621 }
f635f1fb 622 }
a90cd050 623
bfed648c 624 ret = syscall(__NR_io_uring_setup, depth, &p);
9a2d78b3
JA
625 if (ret < 0)
626 return ret;
627
628 ld->ring_fd = ret;
2ea53ca3 629
556d8415
JA
630 fio_ioring_probe(td);
631
2ea53ca3 632 if (o->fixedbufs) {
bfed648c 633 ret = syscall(__NR_io_uring_register, ld->ring_fd,
919850d2 634 IORING_REGISTER_BUFFERS, ld->iovecs, depth);
2ea53ca3
JA
635 if (ret < 0)
636 return ret;
637 }
638
bffad86f 639 return fio_ioring_mmap(ld, &p);
52885fa2
JA
640}
641
5ffd5626
JA
642static int fio_ioring_register_files(struct thread_data *td)
643{
644 struct ioring_data *ld = td->io_ops_data;
645 struct fio_file *f;
646 unsigned int i;
647 int ret;
648
649 ld->fds = calloc(td->o.nr_files, sizeof(int));
650
651 for_each_file(td, f, i) {
652 ret = generic_open_file(td, f);
653 if (ret)
654 goto err;
655 ld->fds[i] = f->fd;
656 f->engine_pos = i;
657 }
658
bfed648c 659 ret = syscall(__NR_io_uring_register, ld->ring_fd,
5ffd5626
JA
660 IORING_REGISTER_FILES, ld->fds, td->o.nr_files);
661 if (ret) {
662err:
663 free(ld->fds);
664 ld->fds = NULL;
665 }
666
667 /*
668 * Pretend the file is closed again, and really close it if we hit
669 * an error.
670 */
671 for_each_file(td, f, i) {
672 if (ret) {
673 int fio_unused ret2;
674 ret2 = generic_close_file(td, f);
675 } else
676 f->fd = -1;
677 }
678
679 return ret;
680}
681
bffad86f 682static int fio_ioring_post_init(struct thread_data *td)
52885fa2 683{
bffad86f 684 struct ioring_data *ld = td->io_ops_data;
5ffd5626 685 struct ioring_options *o = td->eo;
52885fa2 686 struct io_u *io_u;
650346e1 687 int err, i;
52885fa2 688
650346e1
JA
689 for (i = 0; i < td->o.iodepth; i++) {
690 struct iovec *iov = &ld->iovecs[i];
9a2d78b3 691
650346e1
JA
692 io_u = ld->io_u_index[i];
693 iov->iov_base = io_u->buf;
694 iov->iov_len = td_max_bs(td);
52885fa2
JA
695 }
696
bffad86f 697 err = fio_ioring_queue_init(td);
52885fa2 698 if (err) {
c4f5c92f
JA
699 int __errno = errno;
700
701 if (__errno == ENOSYS)
702 log_err("fio: your kernel doesn't support io_uring\n");
703 td_verror(td, __errno, "io_queue_init");
52885fa2
JA
704 return 1;
705 }
706
7c70f506
JA
707 for (i = 0; i < td->o.iodepth; i++) {
708 struct io_uring_sqe *sqe;
709
710 sqe = &ld->sqes[i];
711 memset(sqe, 0, sizeof(*sqe));
712 }
713
5ffd5626
JA
714 if (o->registerfiles) {
715 err = fio_ioring_register_files(td);
716 if (err) {
717 td_verror(td, errno, "ioring_register_files");
718 return 1;
719 }
720 }
721
52885fa2
JA
722 return 0;
723}
724
bffad86f 725static int fio_ioring_init(struct thread_data *td)
52885fa2 726{
5ffd5626 727 struct ioring_options *o = td->eo;
bffad86f 728 struct ioring_data *ld;
b2a432bf 729 struct thread_options *to = &td->o;
52885fa2 730
e007b56a
JA
731 if (to->io_submit_mode == IO_MODE_OFFLOAD) {
732 log_err("fio: io_submit_mode=offload is not compatible (or "
733 "useful) with io_uring\n");
734 return 1;
735 }
736
5ffd5626
JA
737 /* sqthread submission requires registered files */
738 if (o->sqpoll_thread)
739 o->registerfiles = 1;
740
741 if (o->registerfiles && td->o.nr_files != td->o.open_files) {
742 log_err("fio: io_uring registered files require nr_files to "
743 "be identical to open_files\n");
744 return 1;
745 }
746
52885fa2
JA
747 ld = calloc(1, sizeof(*ld));
748
b87aa01a
JA
749 /* ring depth must be a power-of-2 */
750 ld->iodepth = td->o.iodepth;
751 td->o.iodepth = roundup_pow2(td->o.iodepth);
752
52885fa2
JA
753 /* io_u index */
754 ld->io_u_index = calloc(td->o.iodepth, sizeof(struct io_u *));
650346e1 755 ld->iovecs = calloc(td->o.iodepth, sizeof(struct iovec));
52885fa2
JA
756
757 td->io_ops_data = ld;
b2a432bf
PC
758
759 /*
760 * Check for option conflicts
761 */
762 if ((fio_option_is_set(to, ioprio) || fio_option_is_set(to, ioprio_class)) &&
763 o->cmdprio_percentage != 0) {
764 log_err("%s: cmdprio_percentage option and mutually exclusive "
765 "prio or prioclass option is set, exiting\n", to->name);
766 td_verror(td, EINVAL, "fio_io_uring_init");
767 return 1;
768 }
1af44196
XW
769
770 if (fio_option_is_set(&td->o, ioprio_class))
771 ld->ioprio_class_set = true;
772 if (fio_option_is_set(&td->o, ioprio))
773 ld->ioprio_set = true;
774
52885fa2
JA
775 return 0;
776}
777
bffad86f 778static int fio_ioring_io_u_init(struct thread_data *td, struct io_u *io_u)
52885fa2 779{
bffad86f 780 struct ioring_data *ld = td->io_ops_data;
52885fa2
JA
781
782 ld->io_u_index[io_u->index] = io_u;
783 return 0;
784}
785
5ffd5626
JA
786static int fio_ioring_open_file(struct thread_data *td, struct fio_file *f)
787{
788 struct ioring_data *ld = td->io_ops_data;
789 struct ioring_options *o = td->eo;
790
17318cf6 791 if (!ld || !o->registerfiles)
5ffd5626
JA
792 return generic_open_file(td, f);
793
794 f->fd = ld->fds[f->engine_pos];
795 return 0;
796}
797
798static int fio_ioring_close_file(struct thread_data *td, struct fio_file *f)
799{
17318cf6 800 struct ioring_data *ld = td->io_ops_data;
5ffd5626
JA
801 struct ioring_options *o = td->eo;
802
17318cf6 803 if (!ld || !o->registerfiles)
5ffd5626
JA
804 return generic_close_file(td, f);
805
806 f->fd = -1;
807 return 0;
808}
809
52885fa2 810static struct ioengine_ops ioengine = {
bffad86f 811 .name = "io_uring",
52885fa2 812 .version = FIO_IOOPS_VERSION,
8bfe330e 813 .flags = FIO_ASYNCIO_SYNC_TRIM | FIO_NO_OFFLOAD,
bffad86f
JA
814 .init = fio_ioring_init,
815 .post_init = fio_ioring_post_init,
816 .io_u_init = fio_ioring_io_u_init,
817 .prep = fio_ioring_prep,
818 .queue = fio_ioring_queue,
819 .commit = fio_ioring_commit,
820 .getevents = fio_ioring_getevents,
821 .event = fio_ioring_event,
822 .cleanup = fio_ioring_cleanup,
5ffd5626
JA
823 .open_file = fio_ioring_open_file,
824 .close_file = fio_ioring_close_file,
52885fa2
JA
825 .get_file_size = generic_get_file_size,
826 .options = options,
bffad86f 827 .option_struct_size = sizeof(struct ioring_options),
52885fa2
JA
828};
829
bffad86f 830static void fio_init fio_ioring_register(void)
52885fa2 831{
52885fa2 832 register_ioengine(&ioengine);
52885fa2
JA
833}
834
bffad86f 835static void fio_exit fio_ioring_unregister(void)
52885fa2 836{
52885fa2 837 unregister_ioengine(&ioengine);
52885fa2 838}
1f90e9bb 839#endif