engines/io_uring.c

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