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
  21 #ifdef ARCH_HAVE_IOURING
  22
  23 #include "../lib/types.h"
  24 #include "../os/io_uring.h"
  25
  26 struct io_sq_ring {
  27         unsigned *head;
  28         unsigned *tail;
  29         unsigned *ring_mask;
  30         unsigned *ring_entries;
  31         unsigned *flags;
  32         unsigned *array;
  33 };
  34
  35 struct io_cq_ring {
  36         unsigned *head;
  37         unsigned *tail;
  38         unsigned *ring_mask;
  39         unsigned *ring_entries;
  40         struct io_uring_cqe *cqes;
  41 };
  42
  43 struct ioring_mmap {
  44         void *ptr;
  45         size_t len;
  46 };
  47
  48 struct ioring_data {
  49         int ring_fd;
  50
  51         struct io_u **io_us;
  52         struct io_u **io_u_index;
  53
  54         struct io_sq_ring sq_ring;
  55         struct io_uring_sqe *sqes;
  56         struct iovec *iovecs;
  57         unsigned sq_ring_mask;
  58
  59         struct io_cq_ring cq_ring;
  60         unsigned cq_ring_mask;
  61
  62         int queued;
  63         int cq_ring_off;
  64         unsigned iodepth;
  65
  66         uint64_t cachehit;
  67         uint64_t cachemiss;
  68
  69         struct ioring_mmap mmap[3];
  70 };
  71
  72 struct ioring_options {
  73         void *pad;
  74         unsigned int hipri;
  75         unsigned int fixedbufs;
  76         unsigned int sqthread;
  77         unsigned int sqthread_set;
  78         unsigned int sqthread_poll;
  79         unsigned int sqwq;
  80 };
  81
  82 static int fio_ioring_sqthread_cb(void *data, unsigned long long *val)
  83 {
  84         struct ioring_options *o = data;
  85
  86         o->sqthread = *val;
  87         o->sqthread_set = 1;
  88         return 0;
  89 }
  90
  91 static struct fio_option options[] = {
  92         {
  93                 .name   = "hipri",
  94                 .lname  = "High Priority",
  95                 .type   = FIO_OPT_STR_SET,
  96                 .off1   = offsetof(struct ioring_options, hipri),
  97                 .help   = "Use polled IO completions",
  98                 .category = FIO_OPT_C_ENGINE,
  99                 .group  = FIO_OPT_G_LIBAIO,
 100         },
 101         {
 102                 .name   = "fixedbufs",
 103                 .lname  = "Fixed (pre-mapped) IO buffers",
 104                 .type   = FIO_OPT_STR_SET,
 105                 .off1   = offsetof(struct ioring_options, fixedbufs),
 106                 .help   = "Pre map IO buffers",
 107                 .category = FIO_OPT_C_ENGINE,
 108                 .group  = FIO_OPT_G_LIBAIO,
 109         },
 110         {
 111                 .name   = "sqthread",
 112                 .lname  = "Use kernel SQ thread on this CPU",
 113                 .type   = FIO_OPT_INT,
 114                 .cb     = fio_ioring_sqthread_cb,
 115                 .help   = "Offload submission to kernel thread",
 116                 .category = FIO_OPT_C_ENGINE,
 117                 .group  = FIO_OPT_G_LIBAIO,
 118         },
 119         {
 120                 .name   = "sqthread_poll",
 121                 .lname  = "Kernel SQ thread should poll",
 122                 .type   = FIO_OPT_STR_SET,
 123                 .off1   = offsetof(struct ioring_options, sqthread_poll),
 124                 .help   = "Used with sqthread, enables kernel side polling",
 125                 .category = FIO_OPT_C_ENGINE,
 126                 .group  = FIO_OPT_G_LIBAIO,
 127         },
 128         {
 129                 .name   = "sqwq",
 130                 .lname  = "Offload submission to kernel workqueue",
 131                 .type   = FIO_OPT_STR_SET,
 132                 .off1   = offsetof(struct ioring_options, sqwq),
 133                 .help   = "Offload submission to kernel workqueue",
 134                 .category = FIO_OPT_C_ENGINE,
 135                 .group  = FIO_OPT_G_LIBAIO,
 136         },
 137         {
 138                 .name   = NULL,
 139         },
 140 };
 141
 142 static int io_uring_enter(struct ioring_data *ld, unsigned int to_submit,
 143                          unsigned int min_complete, unsigned int flags)
 144 {
 145         return syscall(__NR_sys_io_uring_enter, ld->ring_fd, to_submit,
 146                         min_complete, flags);
 147 }
 148
 149 static int fio_ioring_prep(struct thread_data *td, struct io_u *io_u)
 150 {
 151         struct ioring_data *ld = td->io_ops_data;
 152         struct ioring_options *o = td->eo;
 153         struct fio_file *f = io_u->file;
 154         struct io_uring_sqe *sqe;
 155
 156         sqe = &ld->sqes[io_u->index];
 157         sqe->fd = f->fd;
 158         sqe->flags = 0;
 159         sqe->ioprio = 0;
 160
 161         if (io_u->ddir == DDIR_READ || io_u->ddir == DDIR_WRITE) {
 162                 if (o->fixedbufs) {
 163                         if (io_u->ddir == DDIR_READ)
 164                                 sqe->opcode = IORING_OP_READ_FIXED;
 165                         else
 166                                 sqe->opcode = IORING_OP_WRITE_FIXED;
 167                         sqe->addr = io_u->xfer_buf;
 168                         sqe->len = io_u->xfer_buflen;
 169                         sqe->index = io_u->index;
 170                 } else {
 171                         if (io_u->ddir == DDIR_READ)
 172                                 sqe->opcode = IORING_OP_READV;
 173                         else
 174                                 sqe->opcode = IORING_OP_WRITEV;
 175                         sqe->addr = &ld->iovecs[io_u->index];
 176                         sqe->len = 1;
 177                 }
 178                 sqe->off = io_u->offset;
 179         } else if (ddir_sync(io_u->ddir))
 180                 sqe->opcode = IORING_OP_FSYNC;
 181
 182         sqe->data = (unsigned long) io_u;
 183         return 0;
 184 }
 185
 186 static struct io_u *fio_ioring_event(struct thread_data *td, int event)
 187 {
 188         struct ioring_data *ld = td->io_ops_data;
 189         struct io_uring_cqe *cqe;
 190         struct io_u *io_u;
 191         unsigned index;
 192
 193         index = (event + ld->cq_ring_off) & ld->cq_ring_mask;
 194
 195         cqe = &ld->cq_ring.cqes[index];
 196         io_u = (struct io_u *) cqe->data;
 197
 198         if (cqe->res != io_u->xfer_buflen) {
 199                 if (cqe->res > io_u->xfer_buflen)
 200                         io_u->error = -cqe->res;
 201                 else
 202                         io_u->resid = io_u->xfer_buflen - cqe->res;
 203         } else
 204                 io_u->error = 0;
 205
 206         if (io_u->ddir == DDIR_READ) {
 207                 if (cqe->flags & IOCQE_FLAG_CACHEHIT)
 208                         ld->cachehit++;
 209                 else
 210                         ld->cachemiss++;
 211         }
 212
 213         return io_u;
 214 }
 215
 216 static int fio_ioring_cqring_reap(struct thread_data *td, unsigned int events,
 217                                    unsigned int max)
 218 {
 219         struct ioring_data *ld = td->io_ops_data;
 220         struct io_cq_ring *ring = &ld->cq_ring;
 221         unsigned head, reaped = 0;
 222
 223         head = *ring->head;
 224         do {
 225                 read_barrier();
 226                 if (head == *ring->tail)
 227                         break;
 228                 reaped++;
 229                 head++;
 230         } while (reaped + events < max);
 231
 232         *ring->head = head;
 233         write_barrier();
 234         return reaped;
 235 }
 236
 237 static int fio_ioring_getevents(struct thread_data *td, unsigned int min,
 238                                 unsigned int max, const struct timespec *t)
 239 {
 240         struct ioring_data *ld = td->io_ops_data;
 241         unsigned actual_min = td->o.iodepth_batch_complete_min == 0 ? 0 : min;
 242         struct ioring_options *o = td->eo;
 243         struct io_cq_ring *ring = &ld->cq_ring;
 244         unsigned events = 0;
 245         int r;
 246
 247         ld->cq_ring_off = *ring->head;
 248         do {
 249                 r = fio_ioring_cqring_reap(td, events, max);
 250                 if (r) {
 251                         events += r;
 252                         continue;
 253                 }
 254
 255                 if (!o->sqthread_poll) {
 256                         r = io_uring_enter(ld, 0, actual_min,
 257                                                 IORING_ENTER_GETEVENTS);
 258                         if (r < 0) {
 259                                 if (errno == EAGAIN)
 260                                         continue;
 261                                 td_verror(td, errno, "io_uring_enter");
 262                                 break;
 263                         }
 264                 }
 265         } while (events < min);
 266
 267         return r < 0 ? r : events;
 268 }
 269
 270 static enum fio_q_status fio_ioring_queue(struct thread_data *td,
 271                                           struct io_u *io_u)
 272 {
 273         struct ioring_data *ld = td->io_ops_data;
 274         struct io_sq_ring *ring = &ld->sq_ring;
 275         unsigned tail, next_tail;
 276
 277         fio_ro_check(td, io_u);
 278
 279         if (ld->queued == ld->iodepth)
 280                 return FIO_Q_BUSY;
 281
 282         if (io_u->ddir == DDIR_TRIM) {
 283                 if (ld->queued)
 284                         return FIO_Q_BUSY;
 285
 286                 do_io_u_trim(td, io_u);
 287                 io_u_mark_submit(td, 1);
 288                 io_u_mark_complete(td, 1);
 289                 return FIO_Q_COMPLETED;
 290         }
 291
 292         tail = *ring->tail;
 293         next_tail = tail + 1;
 294         read_barrier();
 295         if (next_tail == *ring->head)
 296                 return FIO_Q_BUSY;
 297
 298         ring->array[tail & ld->sq_ring_mask] = io_u->index;
 299         *ring->tail = next_tail;
 300         write_barrier();
 301
 302         ld->queued++;
 303         return FIO_Q_QUEUED;
 304 }
 305
 306 static void fio_ioring_queued(struct thread_data *td, int start, int nr)
 307 {
 308         struct ioring_data *ld = td->io_ops_data;
 309         struct timespec now;
 310
 311         if (!fio_fill_issue_time(td))
 312                 return;
 313
 314         fio_gettime(&now, NULL);
 315
 316         while (nr--) {
 317                 struct io_sq_ring *ring = &ld->sq_ring;
 318                 int index = ring->array[start & ld->sq_ring_mask];
 319                 struct io_u *io_u = ld->io_u_index[index];
 320
 321                 memcpy(&io_u->issue_time, &now, sizeof(now));
 322                 io_u_queued(td, io_u);
 323
 324                 start++;
 325         }
 326 }
 327
 328 static int fio_ioring_commit(struct thread_data *td)
 329 {
 330         struct ioring_data *ld = td->io_ops_data;
 331         struct ioring_options *o = td->eo;
 332         int ret;
 333
 334         if (!ld->queued)
 335                 return 0;
 336
 337         /* Nothing to do */
 338         if (o->sqthread_poll) {
 339                 struct io_sq_ring *ring = &ld->sq_ring;
 340
 341                 if (*ring->flags & IORING_SQ_NEED_WAKEUP)
 342                         io_uring_enter(ld, ld->queued, 0, 0);
 343                 ld->queued = 0;
 344                 return 0;
 345         }
 346
 347         do {
 348                 unsigned start = *ld->sq_ring.head;
 349                 long nr = ld->queued;
 350
 351                 ret = io_uring_enter(ld, nr, 0, IORING_ENTER_GETEVENTS);
 352                 if (ret > 0) {
 353                         fio_ioring_queued(td, start, ret);
 354                         io_u_mark_submit(td, ret);
 355
 356                         ld->queued -= ret;
 357                         ret = 0;
 358                 } else if (!ret) {
 359                         io_u_mark_submit(td, ret);
 360                         continue;
 361                 } else {
 362                         if (errno == EAGAIN) {
 363                                 ret = fio_ioring_cqring_reap(td, 0, ld->queued);
 364                                 if (ret)
 365                                         continue;
 366                                 /* Shouldn't happen */
 367                                 usleep(1);
 368                                 continue;
 369                         }
 370                         td_verror(td, errno, "io_uring_enter submit");
 371                         break;
 372                 }
 373         } while (ld->queued);
 374
 375         return ret;
 376 }
 377
 378 static void fio_ioring_unmap(struct ioring_data *ld)
 379 {
 380         int i;
 381
 382         for (i = 0; i < ARRAY_SIZE(ld->mmap); i++)
 383                 munmap(ld->mmap[i].ptr, ld->mmap[i].len);
 384         close(ld->ring_fd);
 385 }
 386
 387 static void fio_ioring_cleanup(struct thread_data *td)
 388 {
 389         struct ioring_data *ld = td->io_ops_data;
 390
 391         if (ld) {
 392                 td->ts.cachehit += ld->cachehit;
 393                 td->ts.cachemiss += ld->cachemiss;
 394
 395                 if (!(td->flags & TD_F_CHILD))
 396                         fio_ioring_unmap(ld);
 397
 398                 free(ld->io_u_index);
 399                 free(ld->io_us);
 400                 free(ld->iovecs);
 401                 free(ld);
 402         }
 403 }
 404
 405 static int fio_ioring_mmap(struct ioring_data *ld, struct io_uring_params *p)
 406 {
 407         struct io_sq_ring *sring = &ld->sq_ring;
 408         struct io_cq_ring *cring = &ld->cq_ring;
 409         void *ptr;
 410
 411         ld->mmap[0].len = p->sq_off.array + p->sq_entries * sizeof(__u32);
 412         ptr = mmap(0, ld->mmap[0].len, PROT_READ | PROT_WRITE,
 413                         MAP_SHARED | MAP_POPULATE, ld->ring_fd,
 414                         IORING_OFF_SQ_RING);
 415         ld->mmap[0].ptr = ptr;
 416         sring->head = ptr + p->sq_off.head;
 417         sring->tail = ptr + p->sq_off.tail;
 418         sring->ring_mask = ptr + p->sq_off.ring_mask;
 419         sring->ring_entries = ptr + p->sq_off.ring_entries;
 420         sring->flags = ptr + p->sq_off.flags;
 421         sring->array = ptr + p->sq_off.array;
 422         ld->sq_ring_mask = *sring->ring_mask;
 423
 424         ld->mmap[1].len = p->sq_entries * sizeof(struct io_uring_sqe);
 425         ld->sqes = mmap(0, ld->mmap[1].len, PROT_READ | PROT_WRITE,
 426                                 MAP_SHARED | MAP_POPULATE, ld->ring_fd,
 427                                 IORING_OFF_SQES);
 428         ld->mmap[1].ptr = ld->sqes;
 429
 430         ld->mmap[2].len = p->cq_off.cqes +
 431                                 p->cq_entries * sizeof(struct io_uring_cqe);
 432         ptr = mmap(0, ld->mmap[2].len, PROT_READ | PROT_WRITE,
 433                         MAP_SHARED | MAP_POPULATE, ld->ring_fd,
 434                         IORING_OFF_CQ_RING);
 435         ld->mmap[2].ptr = ptr;
 436         cring->head = ptr + p->cq_off.head;
 437         cring->tail = ptr + p->cq_off.tail;
 438         cring->ring_mask = ptr + p->cq_off.ring_mask;
 439         cring->ring_entries = ptr + p->cq_off.ring_entries;
 440         cring->cqes = ptr + p->cq_off.cqes;
 441         ld->cq_ring_mask = *cring->ring_mask;
 442         return 0;
 443 }
 444
 445 static int fio_ioring_queue_init(struct thread_data *td)
 446 {
 447         struct ioring_data *ld = td->io_ops_data;
 448         struct ioring_options *o = td->eo;
 449         int depth = td->o.iodepth;
 450         struct iovec *vecs = NULL;
 451         struct io_uring_params p;
 452         int ret;
 453
 454         memset(&p, 0, sizeof(p));
 455
 456         if (o->hipri)
 457                 p.flags |= IORING_SETUP_IOPOLL;
 458         if (o->sqthread_set) {
 459                 p.sq_thread_cpu = o->sqthread;
 460                 p.flags |= IORING_SETUP_SQTHREAD;
 461                 if (o->sqthread_poll)
 462                         p.flags |= IORING_SETUP_SQPOLL;
 463         }
 464         if (o->sqwq)
 465                 p.flags |= IORING_SETUP_SQWQ;
 466
 467         if (o->fixedbufs) {
 468                 struct rlimit rlim = {
 469                         .rlim_cur = RLIM_INFINITY,
 470                         .rlim_max = RLIM_INFINITY,
 471                 };
 472
 473                 setrlimit(RLIMIT_MEMLOCK, &rlim);
 474                 vecs = ld->iovecs;
 475         }
 476
 477         ret = syscall(__NR_sys_io_uring_setup, depth, vecs, &p);
 478         if (ret < 0)
 479                 return ret;
 480
 481         ld->ring_fd = ret;
 482         return fio_ioring_mmap(ld, &p);
 483 }
 484
 485 static int fio_ioring_post_init(struct thread_data *td)
 486 {
 487         struct ioring_data *ld = td->io_ops_data;
 488         struct io_u *io_u;
 489         int err, i;
 490
 491         for (i = 0; i < td->o.iodepth; i++) {
 492                 struct iovec *iov = &ld->iovecs[i];
 493
 494                 io_u = ld->io_u_index[i];
 495                 iov->iov_base = io_u->buf;
 496                 iov->iov_len = td_max_bs(td);
 497         }
 498
 499         err = fio_ioring_queue_init(td);
 500         if (err) {
 501                 td_verror(td, errno, "io_queue_init");
 502                 return 1;
 503         }
 504
 505         return 0;
 506 }
 507
 508 static unsigned roundup_pow2(unsigned depth)
 509 {
 510         return 1UL << __fls(depth - 1);
 511 }
 512
 513 static int fio_ioring_init(struct thread_data *td)
 514 {
 515         struct ioring_data *ld;
 516
 517         ld = calloc(1, sizeof(*ld));
 518
 519         /* ring depth must be a power-of-2 */
 520         ld->iodepth = td->o.iodepth;
 521         td->o.iodepth = roundup_pow2(td->o.iodepth);
 522
 523         /* io_u index */
 524         ld->io_u_index = calloc(td->o.iodepth, sizeof(struct io_u *));
 525         ld->io_us = calloc(td->o.iodepth, sizeof(struct io_u *));
 526         ld->iovecs = calloc(td->o.iodepth, sizeof(struct iovec));
 527
 528         td->io_ops_data = ld;
 529         return 0;
 530 }
 531
 532 static int fio_ioring_io_u_init(struct thread_data *td, struct io_u *io_u)
 533 {
 534         struct ioring_data *ld = td->io_ops_data;
 535
 536         ld->io_u_index[io_u->index] = io_u;
 537         return 0;
 538 }
 539
 540 static struct ioengine_ops ioengine = {
 541         .name                   = "io_uring",
 542         .version                = FIO_IOOPS_VERSION,
 543         .init                   = fio_ioring_init,
 544         .post_init              = fio_ioring_post_init,
 545         .io_u_init              = fio_ioring_io_u_init,
 546         .prep                   = fio_ioring_prep,
 547         .queue                  = fio_ioring_queue,
 548         .commit                 = fio_ioring_commit,
 549         .getevents              = fio_ioring_getevents,
 550         .event                  = fio_ioring_event,
 551         .cleanup                = fio_ioring_cleanup,
 552         .open_file              = generic_open_file,
 553         .close_file             = generic_close_file,
 554         .get_file_size          = generic_get_file_size,
 555         .options                = options,
 556         .option_struct_size     = sizeof(struct ioring_options),
 557 };
 558
 559 static void fio_init fio_ioring_register(void)
 560 {
 561         register_ioengine(&ioengine);
 562 }
 563
 564 static void fio_exit fio_ioring_unregister(void)
 565 {
 566         unregister_ioengine(&ioengine);
 567 }
 568 #endif