t/io_uring.c

   1 #include <stdio.h>
   2 #include <errno.h>
   3 #include <assert.h>
   4 #include <stdlib.h>
   5 #include <stddef.h>
   6 #include <signal.h>
   7 #include <inttypes.h>
   8
   9 #include <sys/types.h>
  10 #include <sys/stat.h>
  11 #include <sys/ioctl.h>
  12 #include <sys/syscall.h>
  13 #include <sys/resource.h>
  14 #include <sys/mman.h>
  15 #include <sys/uio.h>
  16 #include <linux/fs.h>
  17 #include <fcntl.h>
  18 #include <unistd.h>
  19 #include <string.h>
  20 #include <pthread.h>
  21 #include <sched.h>
  22
  23 #include "../arch/arch.h"
  24 #include "../lib/types.h"
  25 #include "../os/io_uring.h"
  26
  27 #define barrier()       __asm__ __volatile__("": : :"memory")
  28
  29 #define min(a, b)               ((a < b) ? (a) : (b))
  30
  31 struct io_sq_ring {
  32         unsigned *head;
  33         unsigned *tail;
  34         unsigned *ring_mask;
  35         unsigned *ring_entries;
  36         unsigned *flags;
  37         unsigned *array;
  38 };
  39
  40 struct io_cq_ring {
  41         unsigned *head;
  42         unsigned *tail;
  43         unsigned *ring_mask;
  44         unsigned *ring_entries;
  45         struct io_uring_cqe *cqes;
  46 };
  47
  48 #define DEPTH                   128
  49
  50 #define BATCH_SUBMIT            64
  51 #define BATCH_COMPLETE          64
  52
  53 #define BS                      4096
  54
  55 #define MAX_FDS                 16
  56
  57 static unsigned sq_ring_mask, cq_ring_mask;
  58
  59 struct file {
  60         unsigned long max_blocks;
  61         unsigned pending_ios;
  62         int real_fd;
  63         int fixed_fd;
  64 };
  65
  66 struct submitter {
  67         pthread_t thread;
  68         int ring_fd;
  69         struct drand48_data rand;
  70         struct io_sq_ring sq_ring;
  71         struct io_uring_sqe *sqes;
  72         struct iovec iovecs[DEPTH];
  73         struct io_cq_ring cq_ring;
  74         int inflight;
  75         unsigned long reaps;
  76         unsigned long done;
  77         unsigned long calls;
  78         unsigned long cachehit, cachemiss;
  79         volatile int finish;
  80
  81         __s32 *fds;
  82
  83         struct file files[MAX_FDS];
  84         unsigned nr_files;
  85         unsigned cur_file;
  86 };
  87
  88 static struct submitter submitters[1];
  89 static volatile int finish;
  90
  91 static int polled = 1;          /* use IO polling */
  92 static int fixedbufs = 1;       /* use fixed user buffers */
  93 static int buffered = 0;        /* use buffered IO, not O_DIRECT */
  94 static int sq_thread_poll = 0;  /* use kernel submission/poller thread */
  95 static int sq_thread_cpu = -1;  /* pin above thread to this CPU */
  96
  97 static int io_uring_register_buffers(struct submitter *s)
  98 {
  99         struct io_uring_register_buffers reg = {
 100                 .iovecs = s->iovecs,
 101                 .nr_iovecs = DEPTH
 102         };
 103
 104         return syscall(__NR_sys_io_uring_register, s->ring_fd,
 105                         IORING_REGISTER_BUFFERS, &reg);
 106 }
 107
 108 static int io_uring_register_files(struct submitter *s)
 109 {
 110         struct io_uring_register_files reg;
 111         int i;
 112
 113         s->fds = calloc(s->nr_files, sizeof(__s32));
 114         for (i = 0; i < s->nr_files; i++) {
 115                 s->fds[i] = s->files[i].real_fd;
 116                 s->files[i].fixed_fd = i;
 117         }
 118         reg.fds = s->fds;
 119         reg.nr_fds = s->nr_files;
 120
 121         return syscall(__NR_sys_io_uring_register, s->ring_fd,
 122                         IORING_REGISTER_FILES, &reg);
 123 }
 124
 125 static int io_uring_setup(unsigned entries, struct io_uring_params *p)
 126 {
 127         return syscall(__NR_sys_io_uring_setup, entries, p);
 128 }
 129
 130 static int io_uring_enter(struct submitter *s, unsigned int to_submit,
 131                           unsigned int min_complete, unsigned int flags)
 132 {
 133         return syscall(__NR_sys_io_uring_enter, s->ring_fd, to_submit,
 134                         min_complete, flags);
 135 }
 136
 137 static int gettid(void)
 138 {
 139         return syscall(__NR_gettid);
 140 }
 141
 142 static unsigned file_depth(struct submitter *s)
 143 {
 144         return (DEPTH + s->nr_files - 1) / s->nr_files;
 145 }
 146
 147 static void init_io(struct submitter *s, unsigned index)
 148 {
 149         struct io_uring_sqe *sqe = &s->sqes[index];
 150         unsigned long offset;
 151         struct file *f;
 152         long r;
 153
 154         if (s->nr_files == 1) {
 155                 f = &s->files[0];
 156         } else {
 157                 f = &s->files[s->cur_file];
 158                 if (f->pending_ios >= file_depth(s)) {
 159                         s->cur_file++;
 160                         if (s->cur_file == s->nr_files)
 161                                 s->cur_file = 0;
 162                 }
 163         }
 164         f->pending_ios++;
 165
 166         lrand48_r(&s->rand, &r);
 167         offset = (r % (f->max_blocks - 1)) * BS;
 168
 169         sqe->flags = IOSQE_FIXED_FILE;
 170         if (fixedbufs) {
 171                 sqe->opcode = IORING_OP_READ_FIXED;
 172                 sqe->addr = s->iovecs[index].iov_base;
 173                 sqe->len = BS;
 174                 sqe->buf_index = index;
 175         } else {
 176                 sqe->opcode = IORING_OP_READV;
 177                 sqe->addr = &s->iovecs[index];
 178                 sqe->len = 1;
 179                 sqe->buf_index = 0;
 180         }
 181         sqe->ioprio = 0;
 182         sqe->fd = f->fixed_fd;
 183         sqe->off = offset;
 184         sqe->user_data = (unsigned long) f;
 185 }
 186
 187 static int prep_more_ios(struct submitter *s, int max_ios)
 188 {
 189         struct io_sq_ring *ring = &s->sq_ring;
 190         unsigned index, tail, next_tail, prepped = 0;
 191
 192         next_tail = tail = *ring->tail;
 193         do {
 194                 next_tail++;
 195                 barrier();
 196                 if (next_tail == *ring->head)
 197                         break;
 198
 199                 index = tail & sq_ring_mask;
 200                 init_io(s, index);
 201                 ring->array[index] = index;
 202                 prepped++;
 203                 tail = next_tail;
 204         } while (prepped < max_ios);
 205
 206         if (*ring->tail != tail) {
 207                 /* order tail store with writes to sqes above */
 208                 barrier();
 209                 *ring->tail = tail;
 210                 barrier();
 211         }
 212         return prepped;
 213 }
 214
 215 static int get_file_size(struct file *f)
 216 {
 217         struct stat st;
 218
 219         if (fstat(f->real_fd, &st) < 0)
 220                 return -1;
 221         if (S_ISBLK(st.st_mode)) {
 222                 unsigned long long bytes;
 223
 224                 if (ioctl(f->real_fd, BLKGETSIZE64, &bytes) != 0)
 225                         return -1;
 226
 227                 f->max_blocks = bytes / BS;
 228                 return 0;
 229         } else if (S_ISREG(st.st_mode)) {
 230                 f->max_blocks = st.st_size / BS;
 231                 return 0;
 232         }
 233
 234         return -1;
 235 }
 236
 237 static int reap_events(struct submitter *s)
 238 {
 239         struct io_cq_ring *ring = &s->cq_ring;
 240         struct io_uring_cqe *cqe;
 241         unsigned head, reaped = 0;
 242
 243         head = *ring->head;
 244         do {
 245                 struct file *f;
 246
 247                 barrier();
 248                 if (head == *ring->tail)
 249                         break;
 250                 cqe = &ring->cqes[head & cq_ring_mask];
 251                 f = (struct file *) cqe->user_data;
 252                 f->pending_ios--;
 253                 if (cqe->res != BS) {
 254                         printf("io: unexpected ret=%d\n", cqe->res);
 255                         return -1;
 256                 }
 257                 if (cqe->flags & IOCQE_FLAG_CACHEHIT)
 258                         s->cachehit++;
 259                 else
 260                         s->cachemiss++;
 261                 reaped++;
 262                 head++;
 263         } while (1);
 264
 265         s->inflight -= reaped;
 266         *ring->head = head;
 267         barrier();
 268         return reaped;
 269 }
 270
 271 static void *submitter_fn(void *data)
 272 {
 273         struct submitter *s = data;
 274         struct io_sq_ring *ring = &s->sq_ring;
 275         int ret, prepped;
 276
 277         printf("submitter=%d\n", gettid());
 278
 279         srand48_r(pthread_self(), &s->rand);
 280
 281         prepped = 0;
 282         do {
 283                 int to_wait, to_submit, this_reap, to_prep;
 284
 285                 if (!prepped && s->inflight < DEPTH) {
 286                         to_prep = min(DEPTH - s->inflight, BATCH_SUBMIT);
 287                         prepped = prep_more_ios(s, to_prep);
 288                 }
 289                 s->inflight += prepped;
 290 submit_more:
 291                 to_submit = prepped;
 292 submit:
 293                 if (s->inflight + BATCH_SUBMIT < DEPTH)
 294                         to_wait = 0;
 295                 else
 296                         to_wait = min(s->inflight + to_submit, BATCH_COMPLETE);
 297
 298                 /*
 299                  * Only need to call io_uring_enter if we're not using SQ thread
 300                  * poll, or if IORING_SQ_NEED_WAKEUP is set.
 301                  */
 302                 if (!sq_thread_poll || (*ring->flags & IORING_SQ_NEED_WAKEUP)) {
 303                         ret = io_uring_enter(s, to_submit, to_wait,
 304                                                 IORING_ENTER_GETEVENTS);
 305                         s->calls++;
 306                 }
 307
 308                 /*
 309                  * For non SQ thread poll, we already got the events we needed
 310                  * through the io_uring_enter() above. For SQ thread poll, we
 311                  * need to loop here until we find enough events.
 312                  */
 313                 this_reap = 0;
 314                 do {
 315                         int r;
 316                         r = reap_events(s);
 317                         if (r == -1)
 318                                 break;
 319                         else if (r > 0)
 320                                 this_reap += r;
 321                 } while (sq_thread_poll && this_reap < to_wait);
 322                 s->reaps += this_reap;
 323
 324                 if (ret >= 0) {
 325                         if (!ret) {
 326                                 to_submit = 0;
 327                                 if (s->inflight)
 328                                         goto submit;
 329                                 continue;
 330                         } else if (ret < to_submit) {
 331                                 int diff = to_submit - ret;
 332
 333                                 s->done += ret;
 334                                 prepped -= diff;
 335                                 goto submit_more;
 336                         }
 337                         s->done += ret;
 338                         prepped = 0;
 339                         continue;
 340                 } else if (ret < 0) {
 341                         if (errno == EAGAIN) {
 342                                 if (s->finish)
 343                                         break;
 344                                 if (this_reap)
 345                                         goto submit;
 346                                 to_submit = 0;
 347                                 goto submit;
 348                         }
 349                         printf("io_submit: %s\n", strerror(errno));
 350                         break;
 351                 }
 352         } while (!s->finish);
 353
 354         finish = 1;
 355         return NULL;
 356 }
 357
 358 static void sig_int(int sig)
 359 {
 360         printf("Exiting on signal %d\n", sig);
 361         submitters[0].finish = 1;
 362         finish = 1;
 363 }
 364
 365 static void arm_sig_int(void)
 366 {
 367         struct sigaction act;
 368
 369         memset(&act, 0, sizeof(act));
 370         act.sa_handler = sig_int;
 371         act.sa_flags = SA_RESTART;
 372         sigaction(SIGINT, &act, NULL);
 373 }
 374
 375 static int setup_ring(struct submitter *s)
 376 {
 377         struct io_sq_ring *sring = &s->sq_ring;
 378         struct io_cq_ring *cring = &s->cq_ring;
 379         struct io_uring_params p;
 380         int ret, fd;
 381         void *ptr;
 382
 383         memset(&p, 0, sizeof(p));
 384
 385         if (polled)
 386                 p.flags |= IORING_SETUP_IOPOLL;
 387         if (sq_thread_poll) {
 388                 p.flags |= IORING_SETUP_SQPOLL;
 389                 if (sq_thread_cpu != -1) {
 390                         p.flags |= IORING_SETUP_SQ_AFF;
 391                         p.sq_thread_cpu = sq_thread_cpu;
 392                 }
 393         }
 394
 395         fd = io_uring_setup(DEPTH, &p);
 396         if (fd < 0) {
 397                 perror("io_uring_setup");
 398                 return 1;
 399         }
 400         s->ring_fd = fd;
 401
 402         if (fixedbufs) {
 403                 ret = io_uring_register_buffers(s);
 404                 if (ret < 0) {
 405                         perror("io_uring_register_buffers");
 406                         return 1;
 407                 }
 408         }
 409
 410         ret = io_uring_register_files(s);
 411         if (ret < 0) {
 412                 perror("io_uring_register_files");
 413                 return 1;
 414         }
 415
 416         ptr = mmap(0, p.sq_off.array + p.sq_entries * sizeof(__u32),
 417                         PROT_READ | PROT_WRITE, MAP_SHARED | MAP_POPULATE, fd,
 418                         IORING_OFF_SQ_RING);
 419         printf("sq_ring ptr = 0x%p\n", ptr);
 420         sring->head = ptr + p.sq_off.head;
 421         sring->tail = ptr + p.sq_off.tail;
 422         sring->ring_mask = ptr + p.sq_off.ring_mask;
 423         sring->ring_entries = ptr + p.sq_off.ring_entries;
 424         sring->flags = ptr + p.sq_off.flags;
 425         sring->array = ptr + p.sq_off.array;
 426         sq_ring_mask = *sring->ring_mask;
 427
 428         s->sqes = mmap(0, p.sq_entries * sizeof(struct io_uring_sqe),
 429                         PROT_READ | PROT_WRITE, MAP_SHARED | MAP_POPULATE, fd,
 430                         IORING_OFF_SQES);
 431         printf("sqes ptr    = 0x%p\n", s->sqes);
 432
 433         ptr = mmap(0, p.cq_off.cqes + p.cq_entries * sizeof(struct io_uring_cqe),
 434                         PROT_READ | PROT_WRITE, MAP_SHARED | MAP_POPULATE, fd,
 435                         IORING_OFF_CQ_RING);
 436         printf("cq_ring ptr = 0x%p\n", ptr);
 437         cring->head = ptr + p.cq_off.head;
 438         cring->tail = ptr + p.cq_off.tail;
 439         cring->ring_mask = ptr + p.cq_off.ring_mask;
 440         cring->ring_entries = ptr + p.cq_off.ring_entries;
 441         cring->cqes = ptr + p.cq_off.cqes;
 442         cq_ring_mask = *cring->ring_mask;
 443         return 0;
 444 }
 445
 446 int main(int argc, char *argv[])
 447 {
 448         struct submitter *s = &submitters[0];
 449         unsigned long done, calls, reap, cache_hit, cache_miss;
 450         int err, i, flags, fd;
 451         struct rlimit rlim;
 452         void *ret;
 453
 454         if (argc < 2) {
 455                 printf("%s: filename\n", argv[0]);
 456                 return 1;
 457         }
 458
 459         flags = O_RDONLY | O_NOATIME;
 460         if (!buffered)
 461                 flags |= O_DIRECT;
 462
 463         i = 1;
 464         while (i < argc) {
 465                 struct file *f = &s->files[s->nr_files];
 466
 467                 fd = open(argv[i], flags);
 468                 if (fd < 0) {
 469                         perror("open");
 470                         return 1;
 471                 }
 472                 f->real_fd = fd;
 473                 if (get_file_size(f)) {
 474                         printf("failed getting size of device/file\n");
 475                         return 1;
 476                 }
 477                 if (f->max_blocks <= 1) {
 478                         printf("Zero file/device size?\n");
 479                         return 1;
 480                 }
 481                 f->max_blocks--;
 482
 483                 printf("Added file %s\n", argv[i]);
 484                 s->nr_files++;
 485                 i++;
 486         }
 487
 488         rlim.rlim_cur = RLIM_INFINITY;
 489         rlim.rlim_max = RLIM_INFINITY;
 490         if (setrlimit(RLIMIT_MEMLOCK, &rlim) < 0) {
 491                 perror("setrlimit");
 492                 return 1;
 493         }
 494
 495         arm_sig_int();
 496
 497         for (i = 0; i < DEPTH; i++) {
 498                 void *buf;
 499
 500                 if (posix_memalign(&buf, BS, BS)) {
 501                         printf("failed alloc\n");
 502                         return 1;
 503                 }
 504                 s->iovecs[i].iov_base = buf;
 505                 s->iovecs[i].iov_len = BS;
 506         }
 507
 508         err = setup_ring(s);
 509         if (err) {
 510                 printf("ring setup failed: %s, %d\n", strerror(errno), err);
 511                 return 1;
 512         }
 513         printf("polled=%d, fixedbufs=%d, buffered=%d", polled, fixedbufs, buffered);
 514         printf(" QD=%d, sq_ring=%d, cq_ring=%d\n", DEPTH, *s->sq_ring.ring_entries, *s->cq_ring.ring_entries);
 515
 516         pthread_create(&s->thread, NULL, submitter_fn, s);
 517
 518         cache_hit = cache_miss = reap = calls = done = 0;
 519         do {
 520                 unsigned long this_done = 0;
 521                 unsigned long this_reap = 0;
 522                 unsigned long this_call = 0;
 523                 unsigned long this_cache_hit = 0;
 524                 unsigned long this_cache_miss = 0;
 525                 unsigned long rpc = 0, ipc = 0;
 526                 double hit = 0.0;
 527
 528                 sleep(1);
 529                 this_done += s->done;
 530                 this_call += s->calls;
 531                 this_reap += s->reaps;
 532                 this_cache_hit += s->cachehit;
 533                 this_cache_miss += s->cachemiss;
 534                 if (this_cache_hit && this_cache_miss) {
 535                         unsigned long hits, total;
 536
 537                         hits = this_cache_hit - cache_hit;
 538                         total = hits + this_cache_miss - cache_miss;
 539                         hit = (double) hits / (double) total;
 540                         hit *= 100.0;
 541                 }
 542                 if (this_call - calls) {
 543                         rpc = (this_done - done) / (this_call - calls);
 544                         ipc = (this_reap - reap) / (this_call - calls);
 545                 } else
 546                         rpc = ipc = -1;
 547                 printf("IOPS=%lu, IOS/call=%ld/%ld, inflight=%u (head=%u tail=%u), Cachehit=%0.2f%%\n",
 548                                 this_done - done, rpc, ipc, s->inflight,
 549                                 *s->cq_ring.head, *s->cq_ring.tail, hit);
 550                 done = this_done;
 551                 calls = this_call;
 552                 reap = this_reap;
 553                 cache_hit = s->cachehit;
 554                 cache_miss = s->cachemiss;
 555         } while (!finish);
 556
 557         pthread_join(s->thread, &ret);
 558         close(s->ring_fd);
 559         return 0;
 560 }