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 #include "nvme.h"
  28
  29 #include <sys/stat.h>
  30
  31 enum uring_cmd_type {
  32         FIO_URING_CMD_NVME = 1,
  33 };
  34
  35 struct io_sq_ring {
  36         unsigned *head;
  37         unsigned *tail;
  38         unsigned *ring_mask;
  39         unsigned *ring_entries;
  40         unsigned *flags;
  41         unsigned *array;
  42 };
  43
  44 struct io_cq_ring {
  45         unsigned *head;
  46         unsigned *tail;
  47         unsigned *ring_mask;
  48         unsigned *ring_entries;
  49         struct io_uring_cqe *cqes;
  50 };
  51
  52 struct ioring_mmap {
  53         void *ptr;
  54         size_t len;
  55 };
  56
  57 struct ioring_data {
  58         int ring_fd;
  59
  60         struct io_u **io_u_index;
  61
  62         int *fds;
  63
  64         struct io_sq_ring sq_ring;
  65         struct io_uring_sqe *sqes;
  66         struct iovec *iovecs;
  67         unsigned sq_ring_mask;
  68
  69         struct io_cq_ring cq_ring;
  70         unsigned cq_ring_mask;
  71
  72         int queued;
  73         int cq_ring_off;
  74         unsigned iodepth;
  75         int prepped;
  76
  77         struct ioring_mmap mmap[3];
  78
  79         struct cmdprio cmdprio;
  80 };
  81
  82 struct ioring_options {
  83         struct thread_data *td;
  84         unsigned int hipri;
  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;
  93         unsigned int nowait;
  94         unsigned int force_async;
  95         enum uring_cmd_type cmd_type;
  96 };
  97
  98 static const int ddir_to_op[2][2] = {
  99         { IORING_OP_READV, IORING_OP_READ },
 100         { IORING_OP_WRITEV, IORING_OP_WRITE }
 101 };
 102
 103 static const int fixed_ddir_to_op[2] = {
 104         IORING_OP_READ_FIXED,
 105         IORING_OP_WRITE_FIXED
 106 };
 107
 108 static int fio_ioring_sqpoll_cb(void *data, unsigned long long *val)
 109 {
 110         struct ioring_options *o = data;
 111
 112         o->sqpoll_cpu = *val;
 113         o->sqpoll_set = 1;
 114         return 0;
 115 }
 116
 117 static struct fio_option options[] = {
 118         {
 119                 .name   = "hipri",
 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,
 126         },
 127 #ifdef FIO_HAVE_IOPRIO_CLASS
 128         {
 129                 .name   = "cmdprio_percentage",
 130                 .lname  = "high priority percentage",
 131                 .type   = FIO_OPT_INT,
 132                 .off1   = offsetof(struct ioring_options,
 133                                    cmdprio_options.percentage[DDIR_READ]),
 134                 .off2   = offsetof(struct ioring_options,
 135                                    cmdprio_options.percentage[DDIR_WRITE]),
 136                 .minval = 0,
 137                 .maxval = 100,
 138                 .help   = "Send high priority I/O this percentage of the time",
 139                 .category = FIO_OPT_C_ENGINE,
 140                 .group  = FIO_OPT_G_IOURING,
 141         },
 142         {
 143                 .name   = "cmdprio_class",
 144                 .lname  = "Asynchronous I/O priority class",
 145                 .type   = FIO_OPT_INT,
 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,
 153                 .interval = 1,
 154                 .category = FIO_OPT_C_ENGINE,
 155                 .group  = FIO_OPT_G_IOURING,
 156         },
 157         {
 158                 .name   = "cmdprio",
 159                 .lname  = "Asynchronous I/O priority level",
 160                 .type   = FIO_OPT_INT,
 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,
 168                 .interval = 1,
 169                 .category = FIO_OPT_C_ENGINE,
 170                 .group  = FIO_OPT_G_IOURING,
 171         },
 172         {
 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,
 181         },
 182 #else
 183         {
 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",
 188         },
 189         {
 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",
 194         },
 195         {
 196                 .name   = "cmdprio",
 197                 .lname  = "Asynchronous I/O priority level",
 198                 .type   = FIO_OPT_UNSUPPORTED,
 199                 .help   = "Your platform does not support I/O priority classes",
 200         },
 201         {
 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",
 206         },
 207 #endif
 208         {
 209                 .name   = "fixedbufs",
 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,
 216         },
 217         {
 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,
 225         },
 226         {
 227                 .name   = "sqthread_poll",
 228                 .lname  = "Kernel SQ thread polling",
 229                 .type   = FIO_OPT_INT,
 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,
 234         },
 235         {
 236                 .name   = "sqthread_poll_cpu",
 237                 .lname  = "SQ Thread Poll CPU",
 238                 .type   = FIO_OPT_INT,
 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,
 243         },
 244         {
 245                 .name   = "nonvectored",
 246                 .lname  = "Non-vectored",
 247                 .type   = FIO_OPT_INT,
 248                 .off1   = offsetof(struct ioring_options, nonvectored),
 249                 .def    = "-1",
 250                 .help   = "Use non-vectored read/write commands",
 251                 .category = FIO_OPT_C_ENGINE,
 252                 .group  = FIO_OPT_G_IOURING,
 253         },
 254         {
 255                 .name   = "uncached",
 256                 .lname  = "Uncached",
 257                 .type   = FIO_OPT_INT,
 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,
 262         },
 263         {
 264                 .name   = "nowait",
 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,
 271         },
 272         {
 273                 .name   = "force_async",
 274                 .lname  = "Force async",
 275                 .type   = FIO_OPT_INT,
 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,
 280         },
 281         {
 282                 .name   = "cmd_type",
 283                 .lname  = "Uring cmd type",
 284                 .type   = FIO_OPT_STR,
 285                 .off1   = offsetof(struct ioring_options, cmd_type),
 286                 .help   = "Specify uring-cmd type",
 287                 .def    = "nvme",
 288                 .posval = {
 289                           { .ival = "nvme",
 290                             .oval = FIO_URING_CMD_NVME,
 291                             .help = "Issue nvme-uring-cmd",
 292                           },
 293                 },
 294                 .category = FIO_OPT_C_ENGINE,
 295                 .group  = FIO_OPT_G_IOURING,
 296         },
 297         {
 298                 .name   = NULL,
 299         },
 300 };
 301
 302 static int io_uring_enter(struct ioring_data *ld, unsigned int to_submit,
 303                          unsigned int min_complete, unsigned int flags)
 304 {
 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);
 308 #else
 309         return syscall(__NR_io_uring_enter, ld->ring_fd, to_submit,
 310                         min_complete, flags, NULL, 0);
 311 #endif
 312 }
 313
 314 static int fio_ioring_prep(struct thread_data *td, struct io_u *io_u)
 315 {
 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;
 320
 321         sqe = &ld->sqes[io_u->index];
 322
 323         if (o->registerfiles) {
 324                 sqe->fd = f->engine_pos;
 325                 sqe->flags = IOSQE_FIXED_FILE;
 326         } else {
 327                 sqe->fd = f->fd;
 328                 sqe->flags = 0;
 329         }
 330
 331         if (io_u->ddir == DDIR_READ || io_u->ddir == DDIR_WRITE) {
 332                 if (o->fixedbufs) {
 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;
 337                 } else {
 338                         struct iovec *iov = &ld->iovecs[io_u->index];
 339
 340                         /*
 341                          * Update based on actual io_u, requeue could have
 342                          * adjusted these
 343                          */
 344                         iov->iov_base = io_u->xfer_buf;
 345                         iov->iov_len = io_u->xfer_buflen;
 346
 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;
 351                         } else {
 352                                 sqe->addr = (unsigned long) iov;
 353                                 sqe->len = 1;
 354                         }
 355                 }
 356                 sqe->rw_flags = 0;
 357                 if (!td->o.odirect && o->uncached)
 358                         sqe->rw_flags |= RWF_UNCACHED;
 359                 if (o->nowait)
 360                         sqe->rw_flags |= RWF_NOWAIT;
 361
 362                 /*
 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)
 366                  * to be inherited.
 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.
 371                  */
 372                 sqe->ioprio = td->ioprio;
 373                 sqe->off = io_u->offset;
 374         } else if (ddir_sync(io_u->ddir)) {
 375                 sqe->ioprio = 0;
 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;
 381                 } else {
 382                         sqe->off = 0;
 383                         sqe->addr = 0;
 384                         sqe->len = 0;
 385                         if (io_u->ddir == DDIR_DATASYNC)
 386                                 sqe->fsync_flags |= IORING_FSYNC_DATASYNC;
 387                         sqe->opcode = IORING_OP_FSYNC;
 388                 }
 389         }
 390
 391         if (o->force_async && ++ld->prepped == o->force_async) {
 392                 ld->prepped = 0;
 393                 sqe->flags |= IOSQE_ASYNC;
 394         }
 395
 396         sqe->user_data = (unsigned long) io_u;
 397         return 0;
 398 }
 399
 400 static int fio_ioring_cmd_prep(struct thread_data *td, struct io_u *io_u)
 401 {
 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;
 407
 408         /* only supports nvme_uring_cmd */
 409         if (o->cmd_type != FIO_URING_CMD_NVME)
 410                 return -EINVAL;
 411
 412         sqe = &ld->sqes[(io_u->index) << 1];
 413
 414         if (o->registerfiles) {
 415                 sqe->fd = f->engine_pos;
 416                 sqe->flags = IOSQE_FIXED_FILE;
 417         } else {
 418                 sqe->fd = f->fd;
 419         }
 420         sqe->rw_flags = 0;
 421         if (!td->o.odirect && o->uncached)
 422                 sqe->rw_flags |= RWF_UNCACHED;
 423         if (o->nowait)
 424                 sqe->rw_flags |= RWF_NOWAIT;
 425
 426         sqe->opcode = IORING_OP_URING_CMD;
 427         sqe->user_data = (unsigned long) io_u;
 428         if (o->nonvectored)
 429                 sqe->cmd_op = NVME_URING_CMD_IO;
 430         else
 431                 sqe->cmd_op = NVME_URING_CMD_IO_VEC;
 432         if (o->force_async && ++ld->prepped == o->force_async) {
 433                 ld->prepped = 0;
 434                 sqe->flags |= IOSQE_ASYNC;
 435         }
 436
 437         cmd = (struct nvme_uring_cmd *)sqe->cmd;
 438         return fio_nvme_uring_cmd_prep(cmd, io_u,
 439                         o->nonvectored ? NULL : &ld->iovecs[io_u->index]);
 440 }
 441
 442 static struct io_u *fio_ioring_event(struct thread_data *td, int event)
 443 {
 444         struct ioring_data *ld = td->io_ops_data;
 445         struct io_uring_cqe *cqe;
 446         struct io_u *io_u;
 447         unsigned index;
 448         static int eio;
 449
 450         index = (event + ld->cq_ring_off) & ld->cq_ring_mask;
 451
 452         cqe = &ld->cq_ring.cqes[index];
 453         io_u = (struct io_u *) (uintptr_t) cqe->user_data;
 454
 455         if (eio++ == 5) {
 456                 printf("mark EIO\n");
 457                 cqe->res = -EIO;
 458         }
 459
 460         if (cqe->res != io_u->xfer_buflen) {
 461                 if (cqe->res > io_u->xfer_buflen)
 462                         io_u->error = -cqe->res;
 463                 else
 464                         io_u->resid = io_u->xfer_buflen - cqe->res;
 465         } else
 466                 io_u->error = 0;
 467
 468         return io_u;
 469 }
 470
 471 static struct io_u *fio_ioring_cmd_event(struct thread_data *td, int event)
 472 {
 473         struct ioring_data *ld = td->io_ops_data;
 474         struct ioring_options *o = td->eo;
 475         struct io_uring_cqe *cqe;
 476         struct io_u *io_u;
 477         unsigned index;
 478
 479         index = (event + ld->cq_ring_off) & ld->cq_ring_mask;
 480         if (o->cmd_type == FIO_URING_CMD_NVME)
 481                 index <<= 1;
 482
 483         cqe = &ld->cq_ring.cqes[index];
 484         io_u = (struct io_u *) (uintptr_t) cqe->user_data;
 485
 486         if (cqe->res != 0)
 487                 io_u->error = -cqe->res;
 488         else
 489                 io_u->error = 0;
 490
 491         return io_u;
 492 }
 493
 494 static int fio_ioring_cqring_reap(struct thread_data *td, unsigned int events,
 495                                    unsigned int max)
 496 {
 497         struct ioring_data *ld = td->io_ops_data;
 498         struct io_cq_ring *ring = &ld->cq_ring;
 499         unsigned head, reaped = 0;
 500
 501         head = *ring->head;
 502         do {
 503                 if (head == atomic_load_acquire(ring->tail))
 504                         break;
 505                 reaped++;
 506                 head++;
 507         } while (reaped + events < max);
 508
 509         if (reaped)
 510                 atomic_store_release(ring->head, head);
 511
 512         return reaped;
 513 }
 514
 515 static int fio_ioring_getevents(struct thread_data *td, unsigned int min,
 516                                 unsigned int max, const struct timespec *t)
 517 {
 518         struct ioring_data *ld = td->io_ops_data;
 519         unsigned actual_min = td->o.iodepth_batch_complete_min == 0 ? 0 : min;
 520         struct ioring_options *o = td->eo;
 521         struct io_cq_ring *ring = &ld->cq_ring;
 522         unsigned events = 0;
 523         int r;
 524
 525         ld->cq_ring_off = *ring->head;
 526         do {
 527                 r = fio_ioring_cqring_reap(td, events, max);
 528                 if (r) {
 529                         events += r;
 530                         if (actual_min != 0)
 531                                 actual_min -= r;
 532                         continue;
 533                 }
 534
 535                 if (!o->sqpoll_thread) {
 536                         r = io_uring_enter(ld, 0, actual_min,
 537                                                 IORING_ENTER_GETEVENTS);
 538                         if (r < 0) {
 539                                 if (errno == EAGAIN || errno == EINTR)
 540                                         continue;
 541                                 r = -errno;
 542                                 td_verror(td, errno, "io_uring_enter");
 543                                 break;
 544                         }
 545                 }
 546         } while (events < min);
 547
 548         return r < 0 ? r : events;
 549 }
 550
 551 static inline void fio_ioring_cmdprio_prep(struct thread_data *td,
 552                                            struct io_u *io_u)
 553 {
 554         struct ioring_data *ld = td->io_ops_data;
 555         struct cmdprio *cmdprio = &ld->cmdprio;
 556
 557         if (fio_cmdprio_set_ioprio(td, cmdprio, io_u))
 558                 ld->sqes[io_u->index].ioprio = io_u->ioprio;
 559 }
 560
 561 static enum fio_q_status fio_ioring_queue(struct thread_data *td,
 562                                           struct io_u *io_u)
 563 {
 564         struct ioring_data *ld = td->io_ops_data;
 565         struct io_sq_ring *ring = &ld->sq_ring;
 566         unsigned tail, next_tail;
 567
 568         fio_ro_check(td, io_u);
 569
 570         if (ld->queued == ld->iodepth)
 571                 return FIO_Q_BUSY;
 572
 573         if (io_u->ddir == DDIR_TRIM) {
 574                 if (ld->queued)
 575                         return FIO_Q_BUSY;
 576
 577                 do_io_u_trim(td, io_u);
 578                 io_u_mark_submit(td, 1);
 579                 io_u_mark_complete(td, 1);
 580                 return FIO_Q_COMPLETED;
 581         }
 582
 583         tail = *ring->tail;
 584         next_tail = tail + 1;
 585         if (next_tail == atomic_load_acquire(ring->head))
 586                 return FIO_Q_BUSY;
 587
 588         if (ld->cmdprio.mode != CMDPRIO_MODE_NONE)
 589                 fio_ioring_cmdprio_prep(td, io_u);
 590
 591         ring->array[tail & ld->sq_ring_mask] = io_u->index;
 592         atomic_store_release(ring->tail, next_tail);
 593
 594         ld->queued++;
 595         return FIO_Q_QUEUED;
 596 }
 597
 598 static void fio_ioring_queued(struct thread_data *td, int start, int nr)
 599 {
 600         struct ioring_data *ld = td->io_ops_data;
 601         struct timespec now;
 602
 603         if (!fio_fill_issue_time(td))
 604                 return;
 605
 606         fio_gettime(&now, NULL);
 607
 608         while (nr--) {
 609                 struct io_sq_ring *ring = &ld->sq_ring;
 610                 int index = ring->array[start & ld->sq_ring_mask];
 611                 struct io_u *io_u = ld->io_u_index[index];
 612
 613                 memcpy(&io_u->issue_time, &now, sizeof(now));
 614                 io_u_queued(td, io_u);
 615
 616                 start++;
 617         }
 618
 619         /*
 620          * only used for iolog
 621          */
 622         if (td->o.read_iolog_file)
 623                 memcpy(&td->last_issue, &now, sizeof(now));
 624 }
 625
 626 static int fio_ioring_commit(struct thread_data *td)
 627 {
 628         struct ioring_data *ld = td->io_ops_data;
 629         struct ioring_options *o = td->eo;
 630         int ret;
 631
 632         if (!ld->queued)
 633                 return 0;
 634
 635         /*
 636          * Kernel side does submission. just need to check if the ring is
 637          * flagged as needing a kick, if so, call io_uring_enter(). This
 638          * only happens if we've been idle too long.
 639          */
 640         if (o->sqpoll_thread) {
 641                 struct io_sq_ring *ring = &ld->sq_ring;
 642                 unsigned flags;
 643
 644                 flags = atomic_load_acquire(ring->flags);
 645                 if (flags & IORING_SQ_NEED_WAKEUP)
 646                         io_uring_enter(ld, ld->queued, 0,
 647                                         IORING_ENTER_SQ_WAKEUP);
 648                 ld->queued = 0;
 649                 return 0;
 650         }
 651
 652         do {
 653                 unsigned start = *ld->sq_ring.head;
 654                 long nr = ld->queued;
 655
 656                 ret = io_uring_enter(ld, nr, 0, IORING_ENTER_GETEVENTS);
 657                 if (ret > 0) {
 658                         fio_ioring_queued(td, start, ret);
 659                         io_u_mark_submit(td, ret);
 660
 661                         ld->queued -= ret;
 662                         ret = 0;
 663                 } else if (!ret) {
 664                         io_u_mark_submit(td, ret);
 665                         continue;
 666                 } else {
 667                         if (errno == EAGAIN || errno == EINTR) {
 668                                 ret = fio_ioring_cqring_reap(td, 0, ld->queued);
 669                                 if (ret)
 670                                         continue;
 671                                 /* Shouldn't happen */
 672                                 usleep(1);
 673                                 continue;
 674                         }
 675                         ret = -errno;
 676                         td_verror(td, errno, "io_uring_enter submit");
 677                         break;
 678                 }
 679         } while (ld->queued);
 680
 681         return ret;
 682 }
 683
 684 static void fio_ioring_unmap(struct ioring_data *ld)
 685 {
 686         int i;
 687
 688         for (i = 0; i < FIO_ARRAY_SIZE(ld->mmap); i++)
 689                 munmap(ld->mmap[i].ptr, ld->mmap[i].len);
 690         close(ld->ring_fd);
 691 }
 692
 693 static void fio_ioring_cleanup(struct thread_data *td)
 694 {
 695         struct ioring_data *ld = td->io_ops_data;
 696
 697         if (ld) {
 698                 if (!(td->flags & TD_F_CHILD))
 699                         fio_ioring_unmap(ld);
 700
 701                 fio_cmdprio_cleanup(&ld->cmdprio);
 702                 free(ld->io_u_index);
 703                 free(ld->iovecs);
 704                 free(ld->fds);
 705                 free(ld);
 706         }
 707 }
 708
 709 static int fio_ioring_mmap(struct ioring_data *ld, struct io_uring_params *p)
 710 {
 711         struct io_sq_ring *sring = &ld->sq_ring;
 712         struct io_cq_ring *cring = &ld->cq_ring;
 713         void *ptr;
 714
 715         ld->mmap[0].len = p->sq_off.array + p->sq_entries * sizeof(__u32);
 716         ptr = mmap(0, ld->mmap[0].len, PROT_READ | PROT_WRITE,
 717                         MAP_SHARED | MAP_POPULATE, ld->ring_fd,
 718                         IORING_OFF_SQ_RING);
 719         ld->mmap[0].ptr = ptr;
 720         sring->head = ptr + p->sq_off.head;
 721         sring->tail = ptr + p->sq_off.tail;
 722         sring->ring_mask = ptr + p->sq_off.ring_mask;
 723         sring->ring_entries = ptr + p->sq_off.ring_entries;
 724         sring->flags = ptr + p->sq_off.flags;
 725         sring->array = ptr + p->sq_off.array;
 726         ld->sq_ring_mask = *sring->ring_mask;
 727
 728         if (p->flags & IORING_SETUP_SQE128)
 729                 ld->mmap[1].len = 2 * p->sq_entries * sizeof(struct io_uring_sqe);
 730         else
 731                 ld->mmap[1].len = p->sq_entries * sizeof(struct io_uring_sqe);
 732         ld->sqes = mmap(0, ld->mmap[1].len, PROT_READ | PROT_WRITE,
 733                                 MAP_SHARED | MAP_POPULATE, ld->ring_fd,
 734                                 IORING_OFF_SQES);
 735         ld->mmap[1].ptr = ld->sqes;
 736
 737         if (p->flags & IORING_SETUP_CQE32) {
 738                 ld->mmap[2].len = p->cq_off.cqes +
 739                                         2 * p->cq_entries * sizeof(struct io_uring_cqe);
 740         } else {
 741                 ld->mmap[2].len = p->cq_off.cqes +
 742                                         p->cq_entries * sizeof(struct io_uring_cqe);
 743         }
 744         ptr = mmap(0, ld->mmap[2].len, PROT_READ | PROT_WRITE,
 745                         MAP_SHARED | MAP_POPULATE, ld->ring_fd,
 746                         IORING_OFF_CQ_RING);
 747         ld->mmap[2].ptr = ptr;
 748         cring->head = ptr + p->cq_off.head;
 749         cring->tail = ptr + p->cq_off.tail;
 750         cring->ring_mask = ptr + p->cq_off.ring_mask;
 751         cring->ring_entries = ptr + p->cq_off.ring_entries;
 752         cring->cqes = ptr + p->cq_off.cqes;
 753         ld->cq_ring_mask = *cring->ring_mask;
 754         return 0;
 755 }
 756
 757 static void fio_ioring_probe(struct thread_data *td)
 758 {
 759         struct ioring_data *ld = td->io_ops_data;
 760         struct ioring_options *o = td->eo;
 761         struct io_uring_probe *p;
 762         int ret;
 763
 764         /* already set by user, don't touch */
 765         if (o->nonvectored != -1)
 766                 return;
 767
 768         /* default to off, as that's always safe */
 769         o->nonvectored = 0;
 770
 771         p = malloc(sizeof(*p) + 256 * sizeof(struct io_uring_probe_op));
 772         if (!p)
 773                 return;
 774
 775         memset(p, 0, sizeof(*p) + 256 * sizeof(struct io_uring_probe_op));
 776         ret = syscall(__NR_io_uring_register, ld->ring_fd,
 777                         IORING_REGISTER_PROBE, p, 256);
 778         if (ret < 0)
 779                 goto out;
 780
 781         if (IORING_OP_WRITE > p->ops_len)
 782                 goto out;
 783
 784         if ((p->ops[IORING_OP_READ].flags & IO_URING_OP_SUPPORTED) &&
 785             (p->ops[IORING_OP_WRITE].flags & IO_URING_OP_SUPPORTED))
 786                 o->nonvectored = 1;
 787 out:
 788         free(p);
 789 }
 790
 791 static int fio_ioring_queue_init(struct thread_data *td)
 792 {
 793         struct ioring_data *ld = td->io_ops_data;
 794         struct ioring_options *o = td->eo;
 795         int depth = td->o.iodepth;
 796         struct io_uring_params p;
 797         int ret;
 798
 799         memset(&p, 0, sizeof(p));
 800
 801         if (o->hipri)
 802                 p.flags |= IORING_SETUP_IOPOLL;
 803         if (o->sqpoll_thread) {
 804                 p.flags |= IORING_SETUP_SQPOLL;
 805                 if (o->sqpoll_set) {
 806                         p.flags |= IORING_SETUP_SQ_AFF;
 807                         p.sq_thread_cpu = o->sqpoll_cpu;
 808                 }
 809         }
 810
 811         /*
 812          * Clamp CQ ring size at our SQ ring size, we don't need more entries
 813          * than that.
 814          */
 815         p.flags |= IORING_SETUP_CQSIZE;
 816         p.cq_entries = depth;
 817
 818 retry:
 819         ret = syscall(__NR_io_uring_setup, depth, &p);
 820         if (ret < 0) {
 821                 if (errno == EINVAL && p.flags & IORING_SETUP_CQSIZE) {
 822                         p.flags &= ~IORING_SETUP_CQSIZE;
 823                         goto retry;
 824                 }
 825                 return ret;
 826         }
 827
 828         ld->ring_fd = ret;
 829
 830         fio_ioring_probe(td);
 831
 832         if (o->fixedbufs) {
 833                 ret = syscall(__NR_io_uring_register, ld->ring_fd,
 834                                 IORING_REGISTER_BUFFERS, ld->iovecs, depth);
 835                 if (ret < 0)
 836                         return ret;
 837         }
 838
 839         return fio_ioring_mmap(ld, &p);
 840 }
 841
 842 static int fio_ioring_cmd_queue_init(struct thread_data *td)
 843 {
 844         struct ioring_data *ld = td->io_ops_data;
 845         struct ioring_options *o = td->eo;
 846         int depth = td->o.iodepth;
 847         struct io_uring_params p;
 848         int ret;
 849
 850         memset(&p, 0, sizeof(p));
 851
 852         if (o->hipri)
 853                 p.flags |= IORING_SETUP_IOPOLL;
 854         if (o->sqpoll_thread) {
 855                 p.flags |= IORING_SETUP_SQPOLL;
 856                 if (o->sqpoll_set) {
 857                         p.flags |= IORING_SETUP_SQ_AFF;
 858                         p.sq_thread_cpu = o->sqpoll_cpu;
 859                 }
 860         }
 861         if (o->cmd_type == FIO_URING_CMD_NVME) {
 862                 p.flags |= IORING_SETUP_SQE128;
 863                 p.flags |= IORING_SETUP_CQE32;
 864         }
 865
 866         /*
 867          * Clamp CQ ring size at our SQ ring size, we don't need more entries
 868          * than that.
 869          */
 870         p.flags |= IORING_SETUP_CQSIZE;
 871         p.cq_entries = depth;
 872
 873 retry:
 874         ret = syscall(__NR_io_uring_setup, depth, &p);
 875         if (ret < 0) {
 876                 if (errno == EINVAL && p.flags & IORING_SETUP_CQSIZE) {
 877                         p.flags &= ~IORING_SETUP_CQSIZE;
 878                         goto retry;
 879                 }
 880                 return ret;
 881         }
 882
 883         ld->ring_fd = ret;
 884
 885         fio_ioring_probe(td);
 886
 887         if (o->fixedbufs) {
 888                 ret = syscall(__NR_io_uring_register, ld->ring_fd,
 889                                 IORING_REGISTER_BUFFERS, ld->iovecs, depth);
 890                 if (ret < 0)
 891                         return ret;
 892         }
 893
 894         return fio_ioring_mmap(ld, &p);
 895 }
 896
 897 static int fio_ioring_register_files(struct thread_data *td)
 898 {
 899         struct ioring_data *ld = td->io_ops_data;
 900         struct fio_file *f;
 901         unsigned int i;
 902         int ret;
 903
 904         ld->fds = calloc(td->o.nr_files, sizeof(int));
 905
 906         for_each_file(td, f, i) {
 907                 ret = generic_open_file(td, f);
 908                 if (ret)
 909                         goto err;
 910                 ld->fds[i] = f->fd;
 911                 f->engine_pos = i;
 912         }
 913
 914         ret = syscall(__NR_io_uring_register, ld->ring_fd,
 915                         IORING_REGISTER_FILES, ld->fds, td->o.nr_files);
 916         if (ret) {
 917 err:
 918                 free(ld->fds);
 919                 ld->fds = NULL;
 920         }
 921
 922         /*
 923          * Pretend the file is closed again, and really close it if we hit
 924          * an error.
 925          */
 926         for_each_file(td, f, i) {
 927                 if (ret) {
 928                         int fio_unused ret2;
 929                         ret2 = generic_close_file(td, f);
 930                 } else
 931                         f->fd = -1;
 932         }
 933
 934         return ret;
 935 }
 936
 937 static int fio_ioring_post_init(struct thread_data *td)
 938 {
 939         struct ioring_data *ld = td->io_ops_data;
 940         struct ioring_options *o = td->eo;
 941         struct io_u *io_u;
 942         int err, i;
 943
 944         for (i = 0; i < td->o.iodepth; i++) {
 945                 struct iovec *iov = &ld->iovecs[i];
 946
 947                 io_u = ld->io_u_index[i];
 948                 iov->iov_base = io_u->buf;
 949                 iov->iov_len = td_max_bs(td);
 950         }
 951
 952         err = fio_ioring_queue_init(td);
 953         if (err) {
 954                 int init_err = errno;
 955
 956                 if (init_err == ENOSYS)
 957                         log_err("fio: your kernel doesn't support io_uring\n");
 958                 td_verror(td, init_err, "io_queue_init");
 959                 return 1;
 960         }
 961
 962         for (i = 0; i < td->o.iodepth; i++) {
 963                 struct io_uring_sqe *sqe;
 964
 965                 sqe = &ld->sqes[i];
 966                 memset(sqe, 0, sizeof(*sqe));
 967         }
 968
 969         if (o->registerfiles) {
 970                 err = fio_ioring_register_files(td);
 971                 if (err) {
 972                         td_verror(td, errno, "ioring_register_files");
 973                         return 1;
 974                 }
 975         }
 976
 977         return 0;
 978 }
 979
 980 static int fio_ioring_cmd_post_init(struct thread_data *td)
 981 {
 982         struct ioring_data *ld = td->io_ops_data;
 983         struct ioring_options *o = td->eo;
 984         struct io_u *io_u;
 985         int err, i;
 986
 987         for (i = 0; i < td->o.iodepth; i++) {
 988                 struct iovec *iov = &ld->iovecs[i];
 989
 990                 io_u = ld->io_u_index[i];
 991                 iov->iov_base = io_u->buf;
 992                 iov->iov_len = td_max_bs(td);
 993         }
 994
 995         err = fio_ioring_cmd_queue_init(td);
 996         if (err) {
 997                 int init_err = errno;
 998
 999                 td_verror(td, init_err, "io_queue_init");
1000                 return 1;
1001         }
1002
1003         for (i = 0; i < td->o.iodepth; i++) {
1004                 struct io_uring_sqe *sqe;
1005
1006                 if (o->cmd_type == FIO_URING_CMD_NVME) {
1007                         sqe = &ld->sqes[i << 1];
1008                         memset(sqe, 0, 2 * sizeof(*sqe));
1009                 } else {
1010                         sqe = &ld->sqes[i];
1011                         memset(sqe, 0, sizeof(*sqe));
1012                 }
1013         }
1014
1015         if (o->registerfiles) {
1016                 err = fio_ioring_register_files(td);
1017                 if (err) {
1018                         td_verror(td, errno, "ioring_register_files");
1019                         return 1;
1020                 }
1021         }
1022
1023         return 0;
1024 }
1025
1026 static int fio_ioring_init(struct thread_data *td)
1027 {
1028         struct ioring_options *o = td->eo;
1029         struct ioring_data *ld;
1030         int ret;
1031
1032         /* sqthread submission requires registered files */
1033         if (o->sqpoll_thread)
1034                 o->registerfiles = 1;
1035
1036         if (o->registerfiles && td->o.nr_files != td->o.open_files) {
1037                 log_err("fio: io_uring registered files require nr_files to "
1038                         "be identical to open_files\n");
1039                 return 1;
1040         }
1041
1042         ld = calloc(1, sizeof(*ld));
1043
1044         /* ring depth must be a power-of-2 */
1045         ld->iodepth = td->o.iodepth;
1046         td->o.iodepth = roundup_pow2(td->o.iodepth);
1047
1048         /* io_u index */
1049         ld->io_u_index = calloc(td->o.iodepth, sizeof(struct io_u *));
1050         ld->iovecs = calloc(td->o.iodepth, sizeof(struct iovec));
1051
1052         td->io_ops_data = ld;
1053
1054         ret = fio_cmdprio_init(td, &ld->cmdprio, &o->cmdprio_options);
1055         if (ret) {
1056                 td_verror(td, EINVAL, "fio_ioring_init");
1057                 return 1;
1058         }
1059
1060         return 0;
1061 }
1062
1063 static int fio_ioring_io_u_init(struct thread_data *td, struct io_u *io_u)
1064 {
1065         struct ioring_data *ld = td->io_ops_data;
1066
1067         ld->io_u_index[io_u->index] = io_u;
1068         return 0;
1069 }
1070
1071 static int fio_ioring_open_file(struct thread_data *td, struct fio_file *f)
1072 {
1073         struct ioring_data *ld = td->io_ops_data;
1074         struct ioring_options *o = td->eo;
1075
1076         if (!ld || !o->registerfiles)
1077                 return generic_open_file(td, f);
1078
1079         f->fd = ld->fds[f->engine_pos];
1080         return 0;
1081 }
1082
1083 static int fio_ioring_cmd_open_file(struct thread_data *td, struct fio_file *f)
1084 {
1085         struct ioring_data *ld = td->io_ops_data;
1086         struct ioring_options *o = td->eo;
1087
1088         if (o->cmd_type == FIO_URING_CMD_NVME) {
1089                 struct nvme_data *data = NULL;
1090                 unsigned int nsid, lba_size = 0;
1091                 unsigned long long nlba = 0;
1092                 int ret;
1093
1094                 /* Store the namespace-id and lba size. */
1095                 data = FILE_ENG_DATA(f);
1096                 if (data == NULL) {
1097                         ret = fio_nvme_get_info(f, &nsid, &lba_size, &nlba);
1098                         if (ret)
1099                                 return ret;
1100
1101                         data = calloc(1, sizeof(struct nvme_data));
1102                         data->nsid = nsid;
1103                         data->lba_shift = ilog2(lba_size);
1104
1105                         FILE_SET_ENG_DATA(f, data);
1106                 }
1107         }
1108         if (!ld || !o->registerfiles)
1109                 return generic_open_file(td, f);
1110
1111         f->fd = ld->fds[f->engine_pos];
1112         return 0;
1113 }
1114
1115 static int fio_ioring_close_file(struct thread_data *td, struct fio_file *f)
1116 {
1117         struct ioring_data *ld = td->io_ops_data;
1118         struct ioring_options *o = td->eo;
1119
1120         if (!ld || !o->registerfiles)
1121                 return generic_close_file(td, f);
1122
1123         f->fd = -1;
1124         return 0;
1125 }
1126
1127 static int fio_ioring_cmd_close_file(struct thread_data *td,
1128                                      struct fio_file *f)
1129 {
1130         struct ioring_data *ld = td->io_ops_data;
1131         struct ioring_options *o = td->eo;
1132
1133         if (o->cmd_type == FIO_URING_CMD_NVME) {
1134                 struct nvme_data *data = FILE_ENG_DATA(f);
1135
1136                 FILE_SET_ENG_DATA(f, NULL);
1137                 free(data);
1138         }
1139         if (!ld || !o->registerfiles)
1140                 return generic_close_file(td, f);
1141
1142         f->fd = -1;
1143         return 0;
1144 }
1145
1146 static int fio_ioring_cmd_get_file_size(struct thread_data *td,
1147                                         struct fio_file *f)
1148 {
1149         struct ioring_options *o = td->eo;
1150
1151         if (fio_file_size_known(f))
1152                 return 0;
1153
1154         if (o->cmd_type == FIO_URING_CMD_NVME) {
1155                 struct nvme_data *data = NULL;
1156                 unsigned int nsid, lba_size = 0;
1157                 unsigned long long nlba = 0;
1158                 int ret;
1159
1160                 ret = fio_nvme_get_info(f, &nsid, &lba_size, &nlba);
1161                 if (ret)
1162                         return ret;
1163
1164                 data = calloc(1, sizeof(struct nvme_data));
1165                 data->nsid = nsid;
1166                 data->lba_shift = ilog2(lba_size);
1167
1168                 f->real_file_size = lba_size * nlba;
1169                 fio_file_set_size_known(f);
1170
1171                 FILE_SET_ENG_DATA(f, data);
1172                 return 0;
1173         }
1174         return generic_get_file_size(td, f);
1175 }
1176
1177 static int fio_ioring_cmd_get_zoned_model(struct thread_data *td,
1178                                           struct fio_file *f,
1179                                           enum zbd_zoned_model *model)
1180 {
1181         return fio_nvme_get_zoned_model(td, f, model);
1182 }
1183
1184 static int fio_ioring_cmd_report_zones(struct thread_data *td,
1185                                        struct fio_file *f, uint64_t offset,
1186                                        struct zbd_zone *zbdz,
1187                                        unsigned int nr_zones)
1188 {
1189         return fio_nvme_report_zones(td, f, offset, zbdz, nr_zones);
1190 }
1191
1192 static int fio_ioring_cmd_reset_wp(struct thread_data *td, struct fio_file *f,
1193                                    uint64_t offset, uint64_t length)
1194 {
1195         return fio_nvme_reset_wp(td, f, offset, length);
1196 }
1197
1198 static int fio_ioring_cmd_get_max_open_zones(struct thread_data *td,
1199                                              struct fio_file *f,
1200                                              unsigned int *max_open_zones)
1201 {
1202         return fio_nvme_get_max_open_zones(td, f, max_open_zones);
1203 }
1204
1205 static struct ioengine_ops ioengine_uring = {
1206         .name                   = "io_uring",
1207         .version                = FIO_IOOPS_VERSION,
1208         .flags                  = FIO_ASYNCIO_SYNC_TRIM | FIO_NO_OFFLOAD |
1209                                         FIO_ASYNCIO_SETS_ISSUE_TIME,
1210         .init                   = fio_ioring_init,
1211         .post_init              = fio_ioring_post_init,
1212         .io_u_init              = fio_ioring_io_u_init,
1213         .prep                   = fio_ioring_prep,
1214         .queue                  = fio_ioring_queue,
1215         .commit                 = fio_ioring_commit,
1216         .getevents              = fio_ioring_getevents,
1217         .event                  = fio_ioring_event,
1218         .cleanup                = fio_ioring_cleanup,
1219         .open_file              = fio_ioring_open_file,
1220         .close_file             = fio_ioring_close_file,
1221         .get_file_size          = generic_get_file_size,
1222         .options                = options,
1223         .option_struct_size     = sizeof(struct ioring_options),
1224 };
1225
1226 static struct ioengine_ops ioengine_uring_cmd = {
1227         .name                   = "io_uring_cmd",
1228         .version                = FIO_IOOPS_VERSION,
1229         .flags                  = FIO_ASYNCIO_SYNC_TRIM | FIO_NO_OFFLOAD |
1230                                         FIO_MEMALIGN | FIO_RAWIO |
1231                                         FIO_ASYNCIO_SETS_ISSUE_TIME,
1232         .init                   = fio_ioring_init,
1233         .post_init              = fio_ioring_cmd_post_init,
1234         .io_u_init              = fio_ioring_io_u_init,
1235         .prep                   = fio_ioring_cmd_prep,
1236         .queue                  = fio_ioring_queue,
1237         .commit                 = fio_ioring_commit,
1238         .getevents              = fio_ioring_getevents,
1239         .event                  = fio_ioring_cmd_event,
1240         .cleanup                = fio_ioring_cleanup,
1241         .open_file              = fio_ioring_cmd_open_file,
1242         .close_file             = fio_ioring_cmd_close_file,
1243         .get_file_size          = fio_ioring_cmd_get_file_size,
1244         .get_zoned_model        = fio_ioring_cmd_get_zoned_model,
1245         .report_zones           = fio_ioring_cmd_report_zones,
1246         .reset_wp               = fio_ioring_cmd_reset_wp,
1247         .get_max_open_zones     = fio_ioring_cmd_get_max_open_zones,
1248         .options                = options,
1249         .option_struct_size     = sizeof(struct ioring_options),
1250 };
1251
1252 static void fio_init fio_ioring_register(void)
1253 {
1254         register_ioengine(&ioengine_uring);
1255         register_ioengine(&ioengine_uring_cmd);
1256 }
1257
1258 static void fio_exit fio_ioring_unregister(void)
1259 {
1260         unregister_ioengine(&ioengine_uring);
1261         unregister_ioengine(&ioengine_uring_cmd);
1262 }
1263 #endif