engines/http: set FIO_SYNCIO flag
[fio.git] / t / io_uring.c
index 595e6f2059d71721bf1b0ed83c18b9560e52a264..62dee8058a5922b673a4e5c92c65add6735f4574 100644 (file)
@@ -22,9 +22,7 @@
 
 #include "../arch/arch.h"
 #include "../lib/types.h"
-#include "../os/io_uring.h"
-
-#define barrier()      __asm__ __volatile__("": : :"memory")
+#include "../os/linux/io_uring.h"
 
 #define min(a, b)              ((a < b) ? (a) : (b))
 
@@ -46,9 +44,8 @@ struct io_cq_ring {
 };
 
 #define DEPTH                  128
-
-#define BATCH_SUBMIT           64
-#define BATCH_COMPLETE         64
+#define BATCH_SUBMIT           32
+#define BATCH_COMPLETE         32
 
 #define BS                     4096
 
@@ -69,13 +66,11 @@ struct submitter {
        struct drand48_data rand;
        struct io_sq_ring sq_ring;
        struct io_uring_sqe *sqes;
-       struct iovec iovecs[DEPTH];
        struct io_cq_ring cq_ring;
        int inflight;
        unsigned long reaps;
        unsigned long done;
        unsigned long calls;
-       unsigned long cachehit, cachemiss;
        volatile int finish;
 
        __s32 *fds;
@@ -83,43 +78,47 @@ struct submitter {
        struct file files[MAX_FDS];
        unsigned nr_files;
        unsigned cur_file;
+       struct iovec iovecs[];
 };
 
-static struct submitter submitters[1];
+static struct submitter *submitter;
 static volatile int finish;
 
+static int depth = DEPTH;
+static int batch_submit = BATCH_SUBMIT;
+static int batch_complete = BATCH_COMPLETE;
 static int polled = 1;         /* use IO polling */
 static int fixedbufs = 1;      /* use fixed user buffers */
+static int register_files = 1; /* use fixed files */
 static int buffered = 0;       /* use buffered IO, not O_DIRECT */
 static int sq_thread_poll = 0; /* use kernel submission/poller thread */
 static int sq_thread_cpu = -1; /* pin above thread to this CPU */
+static int do_nop = 0;         /* no-op SQ ring commands */
 
 static int io_uring_register_buffers(struct submitter *s)
 {
-       struct io_uring_register_buffers reg = {
-               .iovecs = s->iovecs,
-               .nr_iovecs = DEPTH
-       };
+       if (do_nop)
+               return 0;
 
        return syscall(__NR_sys_io_uring_register, s->ring_fd,
-                       IORING_REGISTER_BUFFERS, &reg);
+                       IORING_REGISTER_BUFFERS, s->iovecs, depth);
 }
 
 static int io_uring_register_files(struct submitter *s)
 {
-       struct io_uring_register_files reg;
        int i;
 
+       if (do_nop)
+               return 0;
+
        s->fds = calloc(s->nr_files, sizeof(__s32));
        for (i = 0; i < s->nr_files; i++) {
                s->fds[i] = s->files[i].real_fd;
                s->files[i].fixed_fd = i;
        }
-       reg.fds = s->fds;
-       reg.nr_fds = s->nr_files;
 
        return syscall(__NR_sys_io_uring_register, s->ring_fd,
-                       IORING_REGISTER_FILES, &reg);
+                       IORING_REGISTER_FILES, s->fds, s->nr_files);
 }
 
 static int io_uring_setup(unsigned entries, struct io_uring_params *p)
@@ -131,7 +130,7 @@ static int io_uring_enter(struct submitter *s, unsigned int to_submit,
                          unsigned int min_complete, unsigned int flags)
 {
        return syscall(__NR_sys_io_uring_enter, s->ring_fd, to_submit,
-                       min_complete, flags);
+                       min_complete, flags, NULL, 0);
 }
 
 static int gettid(void)
@@ -141,7 +140,7 @@ static int gettid(void)
 
 static unsigned file_depth(struct submitter *s)
 {
-       return (DEPTH + s->nr_files - 1) / s->nr_files;
+       return (depth + s->nr_files - 1) / s->nr_files;
 }
 
 static void init_io(struct submitter *s, unsigned index)
@@ -151,6 +150,11 @@ static void init_io(struct submitter *s, unsigned index)
        struct file *f;
        long r;
 
+       if (do_nop) {
+               sqe->opcode = IORING_OP_NOP;
+               return;
+       }
+
        if (s->nr_files == 1) {
                f = &s->files[0];
        } else {
@@ -159,6 +163,7 @@ static void init_io(struct submitter *s, unsigned index)
                        s->cur_file++;
                        if (s->cur_file == s->nr_files)
                                s->cur_file = 0;
+                       f = &s->files[s->cur_file];
                }
        }
        f->pending_ios++;
@@ -166,20 +171,25 @@ static void init_io(struct submitter *s, unsigned index)
        lrand48_r(&s->rand, &r);
        offset = (r % (f->max_blocks - 1)) * BS;
 
-       sqe->flags = IOSQE_FIXED_FILE;
+       if (register_files) {
+               sqe->flags = IOSQE_FIXED_FILE;
+               sqe->fd = f->fixed_fd;
+       } else {
+               sqe->flags = 0;
+               sqe->fd = f->real_fd;
+       }
        if (fixedbufs) {
                sqe->opcode = IORING_OP_READ_FIXED;
-               sqe->addr = s->iovecs[index].iov_base;
+               sqe->addr = (unsigned long) s->iovecs[index].iov_base;
                sqe->len = BS;
                sqe->buf_index = index;
        } else {
                sqe->opcode = IORING_OP_READV;
-               sqe->addr = &s->iovecs[index];
+               sqe->addr = (unsigned long) &s->iovecs[index];
                sqe->len = 1;
                sqe->buf_index = 0;
        }
        sqe->ioprio = 0;
-       sqe->fd = f->fixed_fd;
        sqe->off = offset;
        sqe->user_data = (unsigned long) f;
 }
@@ -192,7 +202,7 @@ static int prep_more_ios(struct submitter *s, int max_ios)
        next_tail = tail = *ring->tail;
        do {
                next_tail++;
-               barrier();
+               read_barrier();
                if (next_tail == *ring->head)
                        break;
 
@@ -205,9 +215,9 @@ static int prep_more_ios(struct submitter *s, int max_ios)
 
        if (*ring->tail != tail) {
                /* order tail store with writes to sqes above */
-               barrier();
+               write_barrier();
                *ring->tail = tail;
-               barrier();
+               write_barrier();
        }
        return prepped;
 }
@@ -244,27 +254,27 @@ static int reap_events(struct submitter *s)
        do {
                struct file *f;
 
-               barrier();
+               read_barrier();
                if (head == *ring->tail)
                        break;
                cqe = &ring->cqes[head & cq_ring_mask];
-               f = (struct file *) cqe->user_data;
-               f->pending_ios--;
-               if (cqe->res != BS) {
-                       printf("io: unexpected ret=%d\n", cqe->res);
-                       return -1;
+               if (!do_nop) {
+                       f = (struct file *) (uintptr_t) cqe->user_data;
+                       f->pending_ios--;
+                       if (cqe->res != BS) {
+                               printf("io: unexpected ret=%d\n", cqe->res);
+                               if (polled && cqe->res == -EOPNOTSUPP)
+                                       printf("Your filesystem/driver/kernel doesn't support polled IO\n");
+                               return -1;
+                       }
                }
-               if (cqe->flags & IOCQE_FLAG_CACHEHIT)
-                       s->cachehit++;
-               else
-                       s->cachemiss++;
                reaped++;
                head++;
        } while (1);
 
        s->inflight -= reaped;
        *ring->head = head;
-       barrier();
+       write_barrier();
        return reaped;
 }
 
@@ -282,26 +292,31 @@ static void *submitter_fn(void *data)
        do {
                int to_wait, to_submit, this_reap, to_prep;
 
-               if (!prepped && s->inflight < DEPTH) {
-                       to_prep = min(DEPTH - s->inflight, BATCH_SUBMIT);
+               if (!prepped && s->inflight < depth) {
+                       to_prep = min(depth - s->inflight, batch_submit);
                        prepped = prep_more_ios(s, to_prep);
                }
                s->inflight += prepped;
 submit_more:
                to_submit = prepped;
 submit:
-               if (s->inflight + BATCH_SUBMIT < DEPTH)
+               if (to_submit && (s->inflight + to_submit <= depth))
                        to_wait = 0;
                else
-                       to_wait = min(s->inflight + to_submit, BATCH_COMPLETE);
+                       to_wait = min(s->inflight + to_submit, batch_complete);
 
                /*
                 * Only need to call io_uring_enter if we're not using SQ thread
                 * poll, or if IORING_SQ_NEED_WAKEUP is set.
                 */
                if (!sq_thread_poll || (*ring->flags & IORING_SQ_NEED_WAKEUP)) {
-                       ret = io_uring_enter(s, to_submit, to_wait,
-                                               IORING_ENTER_GETEVENTS);
+                       unsigned flags = 0;
+
+                       if (to_wait)
+                               flags = IORING_ENTER_GETEVENTS;
+                       if ((*ring->flags & IORING_SQ_NEED_WAKEUP))
+                               flags |= IORING_ENTER_SQ_WAKEUP;
+                       ret = io_uring_enter(s, to_submit, to_wait, flags);
                        s->calls++;
                }
 
@@ -314,9 +329,10 @@ submit:
                do {
                        int r;
                        r = reap_events(s);
-                       if (r == -1)
+                       if (r == -1) {
+                               s->finish = 1;
                                break;
-                       else if (r > 0)
+                       else if (r > 0)
                                this_reap += r;
                } while (sq_thread_poll && this_reap < to_wait);
                s->reaps += this_reap;
@@ -358,7 +374,7 @@ submit:
 static void sig_int(int sig)
 {
        printf("Exiting on signal %d\n", sig);
-       submitters[0].finish = 1;
+       submitter->finish = 1;
        finish = 1;
 }
 
@@ -382,7 +398,7 @@ static int setup_ring(struct submitter *s)
 
        memset(&p, 0, sizeof(p));
 
-       if (polled)
+       if (polled && !do_nop)
                p.flags |= IORING_SETUP_IOPOLL;
        if (sq_thread_poll) {
                p.flags |= IORING_SETUP_SQPOLL;
@@ -392,7 +408,7 @@ static int setup_ring(struct submitter *s)
                }
        }
 
-       fd = io_uring_setup(DEPTH, &p);
+       fd = io_uring_setup(depth, &p);
        if (fd < 0) {
                perror("io_uring_setup");
                return 1;
@@ -407,10 +423,12 @@ static int setup_ring(struct submitter *s)
                }
        }
 
-       ret = io_uring_register_files(s);
-       if (ret < 0) {
-               perror("io_uring_register_files");
-               return 1;
+       if (register_files) {
+               ret = io_uring_register_files(s);
+               if (ret < 0) {
+                       perror("io_uring_register_files");
+                       return 1;
+               }
        }
 
        ptr = mmap(0, p.sq_off.array + p.sq_entries * sizeof(__u32),
@@ -443,32 +461,89 @@ static int setup_ring(struct submitter *s)
        return 0;
 }
 
+static void file_depths(char *buf)
+{
+       struct submitter *s = submitter;
+       char *p;
+       int i;
+
+       buf[0] = '\0';
+       p = buf;
+       for (i = 0; i < s->nr_files; i++) {
+               struct file *f = &s->files[i];
+
+               if (i + 1 == s->nr_files)
+                       p += sprintf(p, "%d", f->pending_ios);
+               else
+                       p += sprintf(p, "%d, ", f->pending_ios);
+       }
+}
+
+static void usage(char *argv)
+{
+       printf("%s [options] -- [filenames]\n"
+               " -d <int> : IO Depth, default %d\n"
+               " -s <int> : Batch submit, default %d\n"
+               " -c <int> : Batch complete, default %d\n",
+               argv, DEPTH, BATCH_SUBMIT, BATCH_COMPLETE);
+       exit(0);
+}
+
 int main(int argc, char *argv[])
 {
-       struct submitter *s = &submitters[0];
-       unsigned long done, calls, reap, cache_hit, cache_miss;
-       int err, i, flags, fd;
-       struct rlimit rlim;
+       struct submitter *s;
+       unsigned long done, calls, reap;
+       int err, i, flags, fd, opt;
+       char *fdepths;
        void *ret;
 
-       if (argc < 2) {
-               printf("%s: filename\n", argv[0]);
+       if (!do_nop && argc < 2) {
+               printf("%s: filename [options]\n", argv[0]);
                return 1;
        }
 
+       while ((opt = getopt(argc, argv, "d:s:c:h?")) != -1) {
+               switch (opt) {
+               case 'd':
+                       depth = atoi(optarg);
+                       break;
+               case 's':
+                       batch_submit = atoi(optarg);
+                       break;
+               case 'c':
+                       batch_complete = atoi(optarg);
+                       break;
+               case 'h':
+               case '?':
+               default:
+                       usage(argv[0]);
+                       break;
+               }
+       }
+
+       submitter = malloc(sizeof(*submitter) + depth * sizeof(struct iovec));
+       memset(submitter, 0, sizeof(*submitter) + depth * sizeof(struct iovec));
+       s = submitter;
+
        flags = O_RDONLY | O_NOATIME;
        if (!buffered)
                flags |= O_DIRECT;
 
-       i = 1;
-       while (i < argc) {
-               struct file *f = &s->files[s->nr_files];
+       i = optind;
+       while (!do_nop && i < argc) {
+               struct file *f;
 
+               if (s->nr_files == MAX_FDS) {
+                       printf("Max number of files (%d) reached\n", MAX_FDS);
+                       break;
+               }
                fd = open(argv[i], flags);
                if (fd < 0) {
                        perror("open");
                        return 1;
                }
+
+               f = &s->files[s->nr_files];
                f->real_fd = fd;
                if (get_file_size(f)) {
                        printf("failed getting size of device/file\n");
@@ -485,16 +560,20 @@ int main(int argc, char *argv[])
                i++;
        }
 
-       rlim.rlim_cur = RLIM_INFINITY;
-       rlim.rlim_max = RLIM_INFINITY;
-       if (setrlimit(RLIMIT_MEMLOCK, &rlim) < 0) {
-               perror("setrlimit");
-               return 1;
+       if (fixedbufs) {
+               struct rlimit rlim;
+
+               rlim.rlim_cur = RLIM_INFINITY;
+               rlim.rlim_max = RLIM_INFINITY;
+               if (setrlimit(RLIMIT_MEMLOCK, &rlim) < 0) {
+                       perror("setrlimit");
+                       return 1;
+               }
        }
 
        arm_sig_int();
 
-       for (i = 0; i < DEPTH; i++) {
+       for (i = 0; i < depth; i++) {
                void *buf;
 
                if (posix_memalign(&buf, BS, BS)) {
@@ -511,50 +590,38 @@ int main(int argc, char *argv[])
                return 1;
        }
        printf("polled=%d, fixedbufs=%d, buffered=%d", polled, fixedbufs, buffered);
-       printf(" QD=%d, sq_ring=%d, cq_ring=%d\n", DEPTH, *s->sq_ring.ring_entries, *s->cq_ring.ring_entries);
+       printf(" QD=%d, sq_ring=%d, cq_ring=%d\n", depth, *s->sq_ring.ring_entries, *s->cq_ring.ring_entries);
 
        pthread_create(&s->thread, NULL, submitter_fn, s);
 
-       cache_hit = cache_miss = reap = calls = done = 0;
+       fdepths = malloc(8 * s->nr_files);
+       reap = calls = done = 0;
        do {
                unsigned long this_done = 0;
                unsigned long this_reap = 0;
                unsigned long this_call = 0;
-               unsigned long this_cache_hit = 0;
-               unsigned long this_cache_miss = 0;
                unsigned long rpc = 0, ipc = 0;
-               double hit = 0.0;
 
                sleep(1);
                this_done += s->done;
                this_call += s->calls;
                this_reap += s->reaps;
-               this_cache_hit += s->cachehit;
-               this_cache_miss += s->cachemiss;
-               if (this_cache_hit && this_cache_miss) {
-                       unsigned long hits, total;
-
-                       hits = this_cache_hit - cache_hit;
-                       total = hits + this_cache_miss - cache_miss;
-                       hit = (double) hits / (double) total;
-                       hit *= 100.0;
-               }
                if (this_call - calls) {
                        rpc = (this_done - done) / (this_call - calls);
                        ipc = (this_reap - reap) / (this_call - calls);
                } else
                        rpc = ipc = -1;
-               printf("IOPS=%lu, IOS/call=%ld/%ld, inflight=%u (head=%u tail=%u), Cachehit=%0.2f%%\n",
+               file_depths(fdepths);
+               printf("IOPS=%lu, IOS/call=%ld/%ld, inflight=%u (%s)\n",
                                this_done - done, rpc, ipc, s->inflight,
-                               *s->cq_ring.head, *s->cq_ring.tail, hit);
+                               fdepths);
                done = this_done;
                calls = this_call;
                reap = this_reap;
-               cache_hit = s->cachehit;
-               cache_miss = s->cachemiss;
        } while (!finish);
 
        pthread_join(s->thread, &ret);
        close(s->ring_fd);
+       free(fdepths);
        return 0;
 }