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