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         int prepped;
  69
  70         struct ioring_mmap mmap[3];
  71
  72         bool use_cmdprio;
  73 };
  74
  75 struct 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
  90 static const int ddir_to_op[2][2] = {
  91         { IORING_OP_READV, IORING_OP_READ },
  92         { IORING_OP_WRITEV, IORING_OP_WRITE }
  93 };
  94
  95 static const int fixed_ddir_to_op[2] = {
  96         IORING_OP_READ_FIXED,
  97         IORING_OP_WRITE_FIXED
  98 };
  99
 100 static 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
 109 static 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
 118 static 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
 287 static 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
 294 static 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                 sqe->off = io_u->offset;
 342         } else if (ddir_sync(io_u->ddir)) {
 343                 sqe->ioprio = 0;
 344                 if (io_u->ddir == DDIR_SYNC_FILE_RANGE) {
 345                         sqe->off = f->first_write;
 346                         sqe->len = f->last_write - f->first_write;
 347                         sqe->sync_range_flags = td->o.sync_file_range;
 348                         sqe->opcode = IORING_OP_SYNC_FILE_RANGE;
 349                 } else {
 350                         sqe->off = 0;
 351                         sqe->addr = 0;
 352                         sqe->len = 0;
 353                         if (io_u->ddir == DDIR_DATASYNC)
 354                                 sqe->fsync_flags |= IORING_FSYNC_DATASYNC;
 355                         sqe->opcode = IORING_OP_FSYNC;
 356                 }
 357         }
 358
 359         if (o->force_async && ++ld->prepped == o->force_async) {
 360                 ld->prepped = 0;
 361                 sqe->flags |= IOSQE_ASYNC;
 362         }
 363
 364         sqe->user_data = (unsigned long) io_u;
 365         return 0;
 366 }
 367
 368 static struct io_u *fio_ioring_event(struct thread_data *td, int event)
 369 {
 370         struct ioring_data *ld = td->io_ops_data;
 371         struct io_uring_cqe *cqe;
 372         struct io_u *io_u;
 373         unsigned index;
 374
 375         index = (event + ld->cq_ring_off) & ld->cq_ring_mask;
 376
 377         cqe = &ld->cq_ring.cqes[index];
 378         io_u = (struct io_u *) (uintptr_t) cqe->user_data;
 379
 380         if (cqe->res != io_u->xfer_buflen) {
 381                 if (cqe->res > io_u->xfer_buflen)
 382                         io_u->error = -cqe->res;
 383                 else
 384                         io_u->resid = io_u->xfer_buflen - cqe->res;
 385         } else
 386                 io_u->error = 0;
 387
 388         return io_u;
 389 }
 390
 391 static int fio_ioring_cqring_reap(struct thread_data *td, unsigned int events,
 392                                    unsigned int max)
 393 {
 394         struct ioring_data *ld = td->io_ops_data;
 395         struct io_cq_ring *ring = &ld->cq_ring;
 396         unsigned head, reaped = 0;
 397
 398         head = *ring->head;
 399         do {
 400                 if (head == atomic_load_acquire(ring->tail))
 401                         break;
 402                 reaped++;
 403                 head++;
 404         } while (reaped + events < max);
 405
 406         if (reaped)
 407                 atomic_store_release(ring->head, head);
 408
 409         return reaped;
 410 }
 411
 412 static int fio_ioring_getevents(struct thread_data *td, unsigned int min,
 413                                 unsigned int max, const struct timespec *t)
 414 {
 415         struct ioring_data *ld = td->io_ops_data;
 416         unsigned actual_min = td->o.iodepth_batch_complete_min == 0 ? 0 : min;
 417         struct ioring_options *o = td->eo;
 418         struct io_cq_ring *ring = &ld->cq_ring;
 419         unsigned events = 0;
 420         int r;
 421
 422         ld->cq_ring_off = *ring->head;
 423         do {
 424                 r = fio_ioring_cqring_reap(td, events, max);
 425                 if (r) {
 426                         events += r;
 427                         if (actual_min != 0)
 428                                 actual_min -= r;
 429                         continue;
 430                 }
 431
 432                 if (!o->sqpoll_thread) {
 433                         r = io_uring_enter(ld, 0, actual_min,
 434                                                 IORING_ENTER_GETEVENTS);
 435                         if (r < 0) {
 436                                 if (errno == EAGAIN || errno == EINTR)
 437                                         continue;
 438                                 td_verror(td, errno, "io_uring_enter");
 439                                 break;
 440                         }
 441                 }
 442         } while (events < min);
 443
 444         return r < 0 ? r : events;
 445 }
 446
 447 static void fio_ioring_prio_prep(struct thread_data *td, struct io_u *io_u)
 448 {
 449         struct ioring_options *o = td->eo;
 450         struct ioring_data *ld = td->io_ops_data;
 451         struct io_uring_sqe *sqe = &ld->sqes[io_u->index];
 452         struct cmdprio *cmdprio = &o->cmdprio;
 453         enum fio_ddir ddir = io_u->ddir;
 454         unsigned int p = fio_cmdprio_percentage(cmdprio, io_u);
 455         unsigned int cmdprio_value =
 456                 ioprio_value(cmdprio->class[ddir], cmdprio->level[ddir]);
 457
 458         if (p && rand_between(&td->prio_state, 0, 99) < p) {
 459                 sqe->ioprio = cmdprio_value;
 460                 if (!td->ioprio || cmdprio_value < td->ioprio) {
 461                         /*
 462                          * The async IO priority is higher (has a lower value)
 463                          * than the priority set by "prio" and "prioclass"
 464                          * options.
 465                          */
 466                         io_u->flags |= IO_U_F_PRIORITY;
 467                 }
 468         } else {
 469                 sqe->ioprio = td->ioprio;
 470                 if (cmdprio_value && td->ioprio && td->ioprio < cmdprio_value) {
 471                         /*
 472                          * The IO will be executed with the priority set by
 473                          * "prio" and "prioclass" options, and this priority
 474                          * is higher (has a lower value) than the async IO
 475                          * priority.
 476                          */
 477                         io_u->flags |= IO_U_F_PRIORITY;
 478                 }
 479         }
 480 }
 481
 482 static enum fio_q_status fio_ioring_queue(struct thread_data *td,
 483                                           struct io_u *io_u)
 484 {
 485         struct ioring_data *ld = td->io_ops_data;
 486         struct io_sq_ring *ring = &ld->sq_ring;
 487         unsigned tail, next_tail;
 488
 489         fio_ro_check(td, io_u);
 490
 491         if (ld->queued == ld->iodepth)
 492                 return FIO_Q_BUSY;
 493
 494         if (io_u->ddir == DDIR_TRIM) {
 495                 if (ld->queued)
 496                         return FIO_Q_BUSY;
 497
 498                 do_io_u_trim(td, io_u);
 499                 io_u_mark_submit(td, 1);
 500                 io_u_mark_complete(td, 1);
 501                 return FIO_Q_COMPLETED;
 502         }
 503
 504         tail = *ring->tail;
 505         next_tail = tail + 1;
 506         if (next_tail == atomic_load_acquire(ring->head))
 507                 return FIO_Q_BUSY;
 508
 509         if (ld->use_cmdprio)
 510                 fio_ioring_prio_prep(td, io_u);
 511         ring->array[tail & ld->sq_ring_mask] = io_u->index;
 512         atomic_store_release(ring->tail, next_tail);
 513
 514         ld->queued++;
 515         return FIO_Q_QUEUED;
 516 }
 517
 518 static void fio_ioring_queued(struct thread_data *td, int start, int nr)
 519 {
 520         struct ioring_data *ld = td->io_ops_data;
 521         struct timespec now;
 522
 523         if (!fio_fill_issue_time(td))
 524                 return;
 525
 526         fio_gettime(&now, NULL);
 527
 528         while (nr--) {
 529                 struct io_sq_ring *ring = &ld->sq_ring;
 530                 int index = ring->array[start & ld->sq_ring_mask];
 531                 struct io_u *io_u = ld->io_u_index[index];
 532
 533                 memcpy(&io_u->issue_time, &now, sizeof(now));
 534                 io_u_queued(td, io_u);
 535
 536                 start++;
 537         }
 538 }
 539
 540 static int fio_ioring_commit(struct thread_data *td)
 541 {
 542         struct ioring_data *ld = td->io_ops_data;
 543         struct ioring_options *o = td->eo;
 544         int ret;
 545
 546         if (!ld->queued)
 547                 return 0;
 548
 549         /*
 550          * Kernel side does submission. just need to check if the ring is
 551          * flagged as needing a kick, if so, call io_uring_enter(). This
 552          * only happens if we've been idle too long.
 553          */
 554         if (o->sqpoll_thread) {
 555                 struct io_sq_ring *ring = &ld->sq_ring;
 556                 unsigned flags;
 557
 558                 flags = atomic_load_acquire(ring->flags);
 559                 if (flags & IORING_SQ_NEED_WAKEUP)
 560                         io_uring_enter(ld, ld->queued, 0,
 561                                         IORING_ENTER_SQ_WAKEUP);
 562                 ld->queued = 0;
 563                 return 0;
 564         }
 565
 566         do {
 567                 unsigned start = *ld->sq_ring.head;
 568                 long nr = ld->queued;
 569
 570                 ret = io_uring_enter(ld, nr, 0, IORING_ENTER_GETEVENTS);
 571                 if (ret > 0) {
 572                         fio_ioring_queued(td, start, ret);
 573                         io_u_mark_submit(td, ret);
 574
 575                         ld->queued -= ret;
 576                         ret = 0;
 577                 } else if (!ret) {
 578                         io_u_mark_submit(td, ret);
 579                         continue;
 580                 } else {
 581                         if (errno == EAGAIN || errno == EINTR) {
 582                                 ret = fio_ioring_cqring_reap(td, 0, ld->queued);
 583                                 if (ret)
 584                                         continue;
 585                                 /* Shouldn't happen */
 586                                 usleep(1);
 587                                 continue;
 588                         }
 589                         td_verror(td, errno, "io_uring_enter submit");
 590                         break;
 591                 }
 592         } while (ld->queued);
 593
 594         return ret;
 595 }
 596
 597 static void fio_ioring_unmap(struct ioring_data *ld)
 598 {
 599         int i;
 600
 601         for (i = 0; i < FIO_ARRAY_SIZE(ld->mmap); i++)
 602                 munmap(ld->mmap[i].ptr, ld->mmap[i].len);
 603         close(ld->ring_fd);
 604 }
 605
 606 static void fio_ioring_cleanup(struct thread_data *td)
 607 {
 608         struct ioring_data *ld = td->io_ops_data;
 609
 610         if (ld) {
 611                 if (!(td->flags & TD_F_CHILD))
 612                         fio_ioring_unmap(ld);
 613
 614                 free(ld->io_u_index);
 615                 free(ld->iovecs);
 616                 free(ld->fds);
 617                 free(ld);
 618         }
 619 }
 620
 621 static int fio_ioring_mmap(struct ioring_data *ld, struct io_uring_params *p)
 622 {
 623         struct io_sq_ring *sring = &ld->sq_ring;
 624         struct io_cq_ring *cring = &ld->cq_ring;
 625         void *ptr;
 626
 627         ld->mmap[0].len = p->sq_off.array + p->sq_entries * sizeof(__u32);
 628         ptr = mmap(0, ld->mmap[0].len, PROT_READ | PROT_WRITE,
 629                         MAP_SHARED | MAP_POPULATE, ld->ring_fd,
 630                         IORING_OFF_SQ_RING);
 631         ld->mmap[0].ptr = ptr;
 632         sring->head = ptr + p->sq_off.head;
 633         sring->tail = ptr + p->sq_off.tail;
 634         sring->ring_mask = ptr + p->sq_off.ring_mask;
 635         sring->ring_entries = ptr + p->sq_off.ring_entries;
 636         sring->flags = ptr + p->sq_off.flags;
 637         sring->array = ptr + p->sq_off.array;
 638         ld->sq_ring_mask = *sring->ring_mask;
 639
 640         ld->mmap[1].len = p->sq_entries * sizeof(struct io_uring_sqe);
 641         ld->sqes = mmap(0, ld->mmap[1].len, PROT_READ | PROT_WRITE,
 642                                 MAP_SHARED | MAP_POPULATE, ld->ring_fd,
 643                                 IORING_OFF_SQES);
 644         ld->mmap[1].ptr = ld->sqes;
 645
 646         ld->mmap[2].len = p->cq_off.cqes +
 647                                 p->cq_entries * sizeof(struct io_uring_cqe);
 648         ptr = mmap(0, ld->mmap[2].len, PROT_READ | PROT_WRITE,
 649                         MAP_SHARED | MAP_POPULATE, ld->ring_fd,
 650                         IORING_OFF_CQ_RING);
 651         ld->mmap[2].ptr = ptr;
 652         cring->head = ptr + p->cq_off.head;
 653         cring->tail = ptr + p->cq_off.tail;
 654         cring->ring_mask = ptr + p->cq_off.ring_mask;
 655         cring->ring_entries = ptr + p->cq_off.ring_entries;
 656         cring->cqes = ptr + p->cq_off.cqes;
 657         ld->cq_ring_mask = *cring->ring_mask;
 658         return 0;
 659 }
 660
 661 static void fio_ioring_probe(struct thread_data *td)
 662 {
 663         struct ioring_data *ld = td->io_ops_data;
 664         struct ioring_options *o = td->eo;
 665         struct io_uring_probe *p;
 666         int ret;
 667
 668         /* already set by user, don't touch */
 669         if (o->nonvectored != -1)
 670                 return;
 671
 672         /* default to off, as that's always safe */
 673         o->nonvectored = 0;
 674
 675         p = malloc(sizeof(*p) + 256 * sizeof(struct io_uring_probe_op));
 676         if (!p)
 677                 return;
 678
 679         memset(p, 0, sizeof(*p) + 256 * sizeof(struct io_uring_probe_op));
 680         ret = syscall(__NR_io_uring_register, ld->ring_fd,
 681                         IORING_REGISTER_PROBE, p, 256);
 682         if (ret < 0)
 683                 goto out;
 684
 685         if (IORING_OP_WRITE > p->ops_len)
 686                 goto out;
 687
 688         if ((p->ops[IORING_OP_READ].flags & IO_URING_OP_SUPPORTED) &&
 689             (p->ops[IORING_OP_WRITE].flags & IO_URING_OP_SUPPORTED))
 690                 o->nonvectored = 1;
 691 out:
 692         free(p);
 693 }
 694
 695 static int fio_ioring_queue_init(struct thread_data *td)
 696 {
 697         struct ioring_data *ld = td->io_ops_data;
 698         struct ioring_options *o = td->eo;
 699         int depth = td->o.iodepth;
 700         struct io_uring_params p;
 701         int ret;
 702
 703         memset(&p, 0, sizeof(p));
 704
 705         if (o->hipri)
 706                 p.flags |= IORING_SETUP_IOPOLL;
 707         if (o->sqpoll_thread) {
 708                 p.flags |= IORING_SETUP_SQPOLL;
 709                 if (o->sqpoll_set) {
 710                         p.flags |= IORING_SETUP_SQ_AFF;
 711                         p.sq_thread_cpu = o->sqpoll_cpu;
 712                 }
 713         }
 714
 715         ret = syscall(__NR_io_uring_setup, depth, &p);
 716         if (ret < 0)
 717                 return ret;
 718
 719         ld->ring_fd = ret;
 720
 721         fio_ioring_probe(td);
 722
 723         if (o->fixedbufs) {
 724                 ret = syscall(__NR_io_uring_register, ld->ring_fd,
 725                                 IORING_REGISTER_BUFFERS, ld->iovecs, depth);
 726                 if (ret < 0)
 727                         return ret;
 728         }
 729
 730         return fio_ioring_mmap(ld, &p);
 731 }
 732
 733 static int fio_ioring_register_files(struct thread_data *td)
 734 {
 735         struct ioring_data *ld = td->io_ops_data;
 736         struct fio_file *f;
 737         unsigned int i;
 738         int ret;
 739
 740         ld->fds = calloc(td->o.nr_files, sizeof(int));
 741
 742         for_each_file(td, f, i) {
 743                 ret = generic_open_file(td, f);
 744                 if (ret)
 745                         goto err;
 746                 ld->fds[i] = f->fd;
 747                 f->engine_pos = i;
 748         }
 749
 750         ret = syscall(__NR_io_uring_register, ld->ring_fd,
 751                         IORING_REGISTER_FILES, ld->fds, td->o.nr_files);
 752         if (ret) {
 753 err:
 754                 free(ld->fds);
 755                 ld->fds = NULL;
 756         }
 757
 758         /*
 759          * Pretend the file is closed again, and really close it if we hit
 760          * an error.
 761          */
 762         for_each_file(td, f, i) {
 763                 if (ret) {
 764                         int fio_unused ret2;
 765                         ret2 = generic_close_file(td, f);
 766                 } else
 767                         f->fd = -1;
 768         }
 769
 770         return ret;
 771 }
 772
 773 static int fio_ioring_post_init(struct thread_data *td)
 774 {
 775         struct ioring_data *ld = td->io_ops_data;
 776         struct ioring_options *o = td->eo;
 777         struct io_u *io_u;
 778         int err, i;
 779
 780         for (i = 0; i < td->o.iodepth; i++) {
 781                 struct iovec *iov = &ld->iovecs[i];
 782
 783                 io_u = ld->io_u_index[i];
 784                 iov->iov_base = io_u->buf;
 785                 iov->iov_len = td_max_bs(td);
 786         }
 787
 788         err = fio_ioring_queue_init(td);
 789         if (err) {
 790                 int init_err = errno;
 791
 792                 if (init_err == ENOSYS)
 793                         log_err("fio: your kernel doesn't support io_uring\n");
 794                 td_verror(td, init_err, "io_queue_init");
 795                 return 1;
 796         }
 797
 798         for (i = 0; i < td->o.iodepth; i++) {
 799                 struct io_uring_sqe *sqe;
 800
 801                 sqe = &ld->sqes[i];
 802                 memset(sqe, 0, sizeof(*sqe));
 803         }
 804
 805         if (o->registerfiles) {
 806                 err = fio_ioring_register_files(td);
 807                 if (err) {
 808                         td_verror(td, errno, "ioring_register_files");
 809                         return 1;
 810                 }
 811         }
 812
 813         return 0;
 814 }
 815
 816 static int fio_ioring_init(struct thread_data *td)
 817 {
 818         struct ioring_options *o = td->eo;
 819         struct ioring_data *ld;
 820         struct cmdprio *cmdprio = &o->cmdprio;
 821         bool has_cmdprio = false;
 822         int ret;
 823
 824         /* sqthread submission requires registered files */
 825         if (o->sqpoll_thread)
 826                 o->registerfiles = 1;
 827
 828         if (o->registerfiles && td->o.nr_files != td->o.open_files) {
 829                 log_err("fio: io_uring registered files require nr_files to "
 830                         "be identical to open_files\n");
 831                 return 1;
 832         }
 833
 834         ld = calloc(1, sizeof(*ld));
 835
 836         /* ring depth must be a power-of-2 */
 837         ld->iodepth = td->o.iodepth;
 838         td->o.iodepth = roundup_pow2(td->o.iodepth);
 839
 840         /* io_u index */
 841         ld->io_u_index = calloc(td->o.iodepth, sizeof(struct io_u *));
 842         ld->iovecs = calloc(td->o.iodepth, sizeof(struct iovec));
 843
 844         td->io_ops_data = ld;
 845
 846         ret = fio_cmdprio_init(td, cmdprio, &has_cmdprio);
 847         if (ret) {
 848                 td_verror(td, EINVAL, "fio_ioring_init");
 849                 return 1;
 850         }
 851
 852         /*
 853          * Since io_uring can have a submission context (sqthread_poll) that is
 854          * different from the process context, we cannot rely on the the IO
 855          * priority set by ioprio_set() (option prio/prioclass) to be inherited.
 856          * Therefore, we set the sqe->ioprio field when prio/prioclass is used.
 857          */
 858         ld->use_cmdprio = has_cmdprio ||
 859                 fio_option_is_set(&td->o, ioprio_class) ||
 860                 fio_option_is_set(&td->o, ioprio);
 861
 862         return 0;
 863 }
 864
 865 static int fio_ioring_io_u_init(struct thread_data *td, struct io_u *io_u)
 866 {
 867         struct ioring_data *ld = td->io_ops_data;
 868
 869         ld->io_u_index[io_u->index] = io_u;
 870         return 0;
 871 }
 872
 873 static int fio_ioring_open_file(struct thread_data *td, struct fio_file *f)
 874 {
 875         struct ioring_data *ld = td->io_ops_data;
 876         struct ioring_options *o = td->eo;
 877
 878         if (!ld || !o->registerfiles)
 879                 return generic_open_file(td, f);
 880
 881         f->fd = ld->fds[f->engine_pos];
 882         return 0;
 883 }
 884
 885 static int fio_ioring_close_file(struct thread_data *td, struct fio_file *f)
 886 {
 887         struct ioring_data *ld = td->io_ops_data;
 888         struct ioring_options *o = td->eo;
 889
 890         if (!ld || !o->registerfiles)
 891                 return generic_close_file(td, f);
 892
 893         f->fd = -1;
 894         return 0;
 895 }
 896
 897 static struct ioengine_ops ioengine = {
 898         .name                   = "io_uring",
 899         .version                = FIO_IOOPS_VERSION,
 900         .flags                  = FIO_ASYNCIO_SYNC_TRIM | FIO_NO_OFFLOAD,
 901         .init                   = fio_ioring_init,
 902         .post_init              = fio_ioring_post_init,
 903         .io_u_init              = fio_ioring_io_u_init,
 904         .prep                   = fio_ioring_prep,
 905         .queue                  = fio_ioring_queue,
 906         .commit                 = fio_ioring_commit,
 907         .getevents              = fio_ioring_getevents,
 908         .event                  = fio_ioring_event,
 909         .cleanup                = fio_ioring_cleanup,
 910         .open_file              = fio_ioring_open_file,
 911         .close_file             = fio_ioring_close_file,
 912         .get_file_size          = generic_get_file_size,
 913         .options                = options,
 914         .option_struct_size     = sizeof(struct ioring_options),
 915 };
 916
 917 static void fio_init fio_ioring_register(void)
 918 {
 919         register_ioengine(&ioengine);
 920 }
 921
 922 static void fio_exit fio_ioring_unregister(void)
 923 {
 924         unregister_ioengine(&ioengine);
 925 }
 926 #endif