18 #include <sys/types.h>
20 #include <sys/ioctl.h>
21 #include <sys/syscall.h>
22 #include <sys/resource.h>
32 #include "../arch/arch.h"
34 #include "../lib/types.h"
35 #include "../lib/roundup.h"
36 #include "../lib/rand.h"
37 #include "../minmax.h"
38 #include "../os/linux/io_uring.h"
39 #include "../engines/nvme.h"
45 unsigned *ring_entries;
54 unsigned *ring_entries;
55 struct io_uring_cqe *cqes;
59 #define BATCH_SUBMIT 32
60 #define BATCH_COMPLETE 32
65 static unsigned sq_ring_mask, cq_ring_mask;
68 unsigned long max_blocks;
69 unsigned long max_size;
70 unsigned long cur_off;
72 unsigned int nsid; /* nsid field required for nvme-passthrough */
73 unsigned int lba_shift; /* lba_shift field required for nvme-passthrough */
80 #define PLAT_VAL (1 << PLAT_BITS)
81 #define PLAT_GROUP_NR 29
82 #define PLAT_NR (PLAT_GROUP_NR * PLAT_VAL)
89 struct io_sq_ring sq_ring;
90 struct io_uring_sqe *sqes;
91 struct io_cq_ring cq_ring;
101 struct taus258_state rand_state;
103 unsigned long *clock_batch;
108 io_context_t aio_ctx;
112 const char *filename;
114 struct file files[MAX_FDS];
117 struct iovec iovecs[];
120 static struct submitter *submitter;
121 static volatile int finish;
122 static int stats_running;
123 static unsigned long max_iops;
124 static long t_io_uring_page_size;
126 static int depth = DEPTH;
127 static int batch_submit = BATCH_SUBMIT;
128 static int batch_complete = BATCH_COMPLETE;
130 static int polled = 1; /* use IO polling */
131 static int fixedbufs = 1; /* use fixed user buffers */
132 static int dma_map; /* pre-map DMA buffers */
133 static int register_files = 1; /* use fixed files */
134 static int buffered = 0; /* use buffered IO, not O_DIRECT */
135 static int sq_thread_poll = 0; /* use kernel submission/poller thread */
136 static int sq_thread_cpu = -1; /* pin above thread to this CPU */
137 static int do_nop = 0; /* no-op SQ ring commands */
138 static int nthreads = 1;
139 static int stats = 0; /* generate IO stats */
140 static int aio = 0; /* use libaio */
141 static int runtime = 0; /* runtime */
142 static int random_io = 1; /* random or sequential IO */
143 static int register_ring = 1; /* register ring */
144 static int use_sync = 0; /* use preadv2 */
145 static int numa_placement = 0; /* set to node of device */
146 static int pt = 0; /* passthrough I/O or not */
148 static unsigned long tsc_rate;
150 #define TSC_RATE_FILE "tsc-rate"
152 static int vectored = 1;
154 static float plist[] = { 1.0, 5.0, 10.0, 20.0, 30.0, 40.0, 50.0, 60.0, 70.0,
155 80.0, 90.0, 95.0, 99.0, 99.5, 99.9, 99.95, 99.99 };
156 static int plist_len = 17;
158 #ifndef IORING_REGISTER_MAP_BUFFERS
159 #define IORING_REGISTER_MAP_BUFFERS 26
160 struct io_uring_map_buffers {
169 static int nvme_identify(int fd, __u32 nsid, enum nvme_identify_cns cns,
170 enum nvme_csi csi, void *data)
172 struct nvme_passthru_cmd cmd = {
173 .opcode = nvme_admin_identify,
175 .addr = (__u64)(uintptr_t)data,
176 .data_len = NVME_IDENTIFY_DATA_SIZE,
178 .cdw11 = csi << NVME_IDENTIFY_CSI_SHIFT,
179 .timeout_ms = NVME_DEFAULT_IOCTL_TIMEOUT,
182 return ioctl(fd, NVME_IOCTL_ADMIN_CMD, &cmd);
185 static int nvme_get_info(int fd, __u32 *nsid, __u32 *lba_sz, __u64 *nlba)
187 struct nvme_id_ns ns;
191 namespace_id = ioctl(fd, NVME_IOCTL_ID);
192 if (namespace_id < 0) {
193 fprintf(stderr, "error failed to fetch namespace-id\n");
199 * Identify namespace to get namespace-id, namespace size in LBA's
202 err = nvme_identify(fd, namespace_id, NVME_IDENTIFY_CNS_NS,
205 fprintf(stderr, "error failed to fetch identify namespace\n");
210 *nsid = namespace_id;
211 *lba_sz = 1 << ns.lbaf[(ns.flbas & 0x0f)].ds;
217 static unsigned long cycles_to_nsec(unsigned long cycles)
224 val = cycles * 1000000000ULL;
225 return val / tsc_rate;
228 static unsigned long plat_idx_to_val(unsigned int idx)
230 unsigned int error_bits;
231 unsigned long k, base;
233 assert(idx < PLAT_NR);
235 /* MSB <= (PLAT_BITS-1), cannot be rounded off. Use
236 * all bits of the sample as index */
237 if (idx < (PLAT_VAL << 1))
238 return cycles_to_nsec(idx);
240 /* Find the group and compute the minimum value of that group */
241 error_bits = (idx >> PLAT_BITS) - 1;
242 base = ((unsigned long) 1) << (error_bits + PLAT_BITS);
244 /* Find its bucket number of the group */
247 /* Return the mean of the range of the bucket */
248 return cycles_to_nsec(base + ((k + 0.5) * (1 << error_bits)));
251 unsigned int calculate_clat_percentiles(unsigned long *io_u_plat,
252 unsigned long nr, unsigned long **output,
253 unsigned long *maxv, unsigned long *minv)
255 unsigned long sum = 0;
256 unsigned int len = plist_len, i, j = 0;
257 unsigned long *ovals = NULL;
263 ovals = malloc(len * sizeof(*ovals));
268 * Calculate bucket values, note down max and min values
271 for (i = 0; i < PLAT_NR && !is_last; i++) {
273 while (sum >= ((long double) plist[j] / 100.0 * nr)) {
274 assert(plist[j] <= 100.0);
276 ovals[j] = plat_idx_to_val(i);
277 if (ovals[j] < *minv)
279 if (ovals[j] > *maxv)
282 is_last = (j == len - 1) != 0;
291 fprintf(stderr, "error calculating latency percentiles\n");
297 static void show_clat_percentiles(unsigned long *io_u_plat, unsigned long nr,
298 unsigned int precision)
300 unsigned int divisor, len, i, j = 0;
301 unsigned long minv, maxv;
302 unsigned long *ovals;
303 int per_line, scale_down, time_width;
307 len = calculate_clat_percentiles(io_u_plat, nr, &ovals, &maxv, &minv);
314 printf(" percentiles (tsc ticks):\n |");
315 } else if (minv > 2000 && maxv > 99999) {
318 printf(" percentiles (usec):\n |");
322 printf(" percentiles (nsec):\n |");
325 time_width = max(5, (int) (log10(maxv / divisor) + 1));
326 snprintf(fmt, sizeof(fmt), " %%%u.%ufth=[%%%dllu]%%c", precision + 3,
327 precision, time_width);
328 /* fmt will be something like " %5.2fth=[%4llu]%c" */
329 per_line = (80 - 7) / (precision + 10 + time_width);
331 for (j = 0; j < len; j++) {
333 if (j != 0 && (j % per_line) == 0)
336 /* end of the list */
337 is_last = (j == len - 1) != 0;
339 for (i = 0; i < scale_down; i++)
340 ovals[j] = (ovals[j] + 999) / 1000;
342 printf(fmt, plist[j], ovals[j], is_last ? '\n' : ',');
347 if ((j % per_line) == per_line - 1) /* for formatting */
355 #ifdef ARCH_HAVE_CPU_CLOCK
356 static unsigned int plat_val_to_idx(unsigned long val)
358 unsigned int msb, error_bits, base, offset, idx;
360 /* Find MSB starting from bit 0 */
364 msb = (sizeof(val)*8) - __builtin_clzll(val) - 1;
367 * MSB <= (PLAT_BITS-1), cannot be rounded off. Use
368 * all bits of the sample as index
370 if (msb <= PLAT_BITS)
373 /* Compute the number of error bits to discard*/
374 error_bits = msb - PLAT_BITS;
376 /* Compute the number of buckets before the group */
377 base = (error_bits + 1) << PLAT_BITS;
380 * Discard the error bits and apply the mask to find the
381 * index for the buckets in the group
383 offset = (PLAT_VAL - 1) & (val >> error_bits);
385 /* Make sure the index does not exceed (array size - 1) */
386 idx = (base + offset) < (PLAT_NR - 1) ?
387 (base + offset) : (PLAT_NR - 1);
393 static void add_stat(struct submitter *s, int clock_index, int nr)
395 #ifdef ARCH_HAVE_CPU_CLOCK
396 unsigned long cycles;
399 if (!s->finish && clock_index) {
400 cycles = get_cpu_clock();
401 cycles -= s->clock_batch[clock_index];
402 pidx = plat_val_to_idx(cycles);
408 static int io_uring_map_buffers(struct submitter *s)
410 struct io_uring_map_buffers map = {
411 .fd = s->files[0].real_fd,
418 fprintf(stdout, "Mapping buffers may not work with multiple files\n");
420 return syscall(__NR_io_uring_register, s->ring_fd,
421 IORING_REGISTER_MAP_BUFFERS, &map, 1);
424 static int io_uring_register_buffers(struct submitter *s)
429 return syscall(__NR_io_uring_register, s->ring_fd,
430 IORING_REGISTER_BUFFERS, s->iovecs, roundup_pow2(depth));
433 static int io_uring_register_files(struct submitter *s)
440 s->fds = calloc(s->nr_files, sizeof(__s32));
441 for (i = 0; i < s->nr_files; i++) {
442 s->fds[i] = s->files[i].real_fd;
443 s->files[i].fixed_fd = i;
446 return syscall(__NR_io_uring_register, s->ring_fd,
447 IORING_REGISTER_FILES, s->fds, s->nr_files);
450 static int io_uring_setup(unsigned entries, struct io_uring_params *p)
455 * Clamp CQ ring size at our SQ ring size, we don't need more entries
458 p->flags |= IORING_SETUP_CQSIZE;
459 p->cq_entries = entries;
461 p->flags |= IORING_SETUP_COOP_TASKRUN;
462 p->flags |= IORING_SETUP_SINGLE_ISSUER;
463 p->flags |= IORING_SETUP_DEFER_TASKRUN;
465 ret = syscall(__NR_io_uring_setup, entries, p);
469 if (errno == EINVAL && p->flags & IORING_SETUP_COOP_TASKRUN) {
470 p->flags &= ~IORING_SETUP_COOP_TASKRUN;
473 if (errno == EINVAL && p->flags & IORING_SETUP_SINGLE_ISSUER) {
474 p->flags &= ~IORING_SETUP_SINGLE_ISSUER;
477 if (errno == EINVAL && p->flags & IORING_SETUP_DEFER_TASKRUN) {
478 p->flags &= ~IORING_SETUP_DEFER_TASKRUN;
485 static void io_uring_probe(int fd)
487 struct io_uring_probe *p;
490 p = malloc(sizeof(*p) + 256 * sizeof(struct io_uring_probe_op));
494 memset(p, 0, sizeof(*p) + 256 * sizeof(struct io_uring_probe_op));
495 ret = syscall(__NR_io_uring_register, fd, IORING_REGISTER_PROBE, p, 256);
499 if (IORING_OP_READ > p->ops_len)
502 if ((p->ops[IORING_OP_READ].flags & IO_URING_OP_SUPPORTED))
508 static int io_uring_enter(struct submitter *s, unsigned int to_submit,
509 unsigned int min_complete, unsigned int flags)
512 flags |= IORING_ENTER_REGISTERED_RING;
513 #ifdef FIO_ARCH_HAS_SYSCALL
514 return __do_syscall6(__NR_io_uring_enter, s->enter_ring_fd, to_submit,
515 min_complete, flags, NULL, 0);
517 return syscall(__NR_io_uring_enter, s->enter_ring_fd, to_submit,
518 min_complete, flags, NULL, 0);
522 static unsigned file_depth(struct submitter *s)
524 return (depth + s->nr_files - 1) / s->nr_files;
527 static unsigned long long get_offset(struct submitter *s, struct file *f)
529 unsigned long long offset;
533 unsigned long long block;
535 r = __rand64(&s->rand_state);
536 block = r % f->max_blocks;
537 offset = block * (unsigned long long) bs;
541 if (f->cur_off + bs > f->max_size)
548 static struct file *init_new_io(struct submitter *s)
552 if (s->nr_files == 1) {
555 f = &s->files[s->cur_file];
556 if (f->pending_ios >= file_depth(s)) {
558 if (s->cur_file == s->nr_files)
560 f = &s->files[s->cur_file];
568 static void init_io(struct submitter *s, unsigned index)
570 struct io_uring_sqe *sqe = &s->sqes[index];
574 sqe->opcode = IORING_OP_NOP;
580 if (register_files) {
581 sqe->flags = IOSQE_FIXED_FILE;
582 sqe->fd = f->fixed_fd;
585 sqe->fd = f->real_fd;
588 sqe->opcode = IORING_OP_READ_FIXED;
589 sqe->addr = (unsigned long) s->iovecs[index].iov_base;
591 sqe->buf_index = index;
592 } else if (!vectored) {
593 sqe->opcode = IORING_OP_READ;
594 sqe->addr = (unsigned long) s->iovecs[index].iov_base;
598 sqe->opcode = IORING_OP_READV;
599 sqe->addr = (unsigned long) &s->iovecs[index];
604 sqe->off = get_offset(s, f);
605 sqe->user_data = (unsigned long) f->fileno;
606 if (stats && stats_running)
607 sqe->user_data |= ((uint64_t)s->clock_index << 32);
610 static void init_io_pt(struct submitter *s, unsigned index)
612 struct io_uring_sqe *sqe = &s->sqes[index << 1];
613 unsigned long offset;
615 struct nvme_uring_cmd *cmd;
616 unsigned long long slba;
617 unsigned long long nlb;
621 offset = get_offset(s, f);
623 if (register_files) {
624 sqe->fd = f->fixed_fd;
625 sqe->flags = IOSQE_FIXED_FILE;
627 sqe->fd = f->real_fd;
630 sqe->opcode = IORING_OP_URING_CMD;
631 sqe->user_data = (unsigned long) f->fileno;
633 sqe->user_data |= ((__u64) s->clock_index << 32ULL);
634 sqe->cmd_op = NVME_URING_CMD_IO;
635 slba = offset >> f->lba_shift;
636 nlb = (bs >> f->lba_shift) - 1;
637 cmd = (struct nvme_uring_cmd *)&sqe->cmd;
638 /* cdw10 and cdw11 represent starting slba*/
639 cmd->cdw10 = slba & 0xffffffff;
640 cmd->cdw11 = slba >> 32;
641 /* cdw12 represent number of lba to be read*/
643 cmd->addr = (unsigned long) s->iovecs[index].iov_base;
646 sqe->uring_cmd_flags = IORING_URING_CMD_FIXED;
647 sqe->buf_index = index;
653 static int prep_more_ios_uring(struct submitter *s, int max_ios)
655 struct io_sq_ring *ring = &s->sq_ring;
656 unsigned head, index, tail, next_tail, prepped = 0;
659 head = atomic_load_acquire(ring->head);
663 next_tail = tail = *ring->tail;
666 if (next_tail == head)
669 index = tail & sq_ring_mask;
671 init_io_pt(s, index);
676 } while (prepped < max_ios);
679 atomic_store_release(ring->tail, tail);
683 static int get_file_size(struct file *f)
687 if (fstat(f->real_fd, &st) < 0)
694 if (!S_ISCHR(st.st_mode)) {
695 fprintf(stderr, "passthrough works with only nvme-ns "
696 "generic devices (/dev/ngXnY)\n");
699 ret = nvme_get_info(f->real_fd, &f->nsid, &lbs, &nlba);
702 if ((bs % lbs) != 0) {
703 printf("error: bs:%d should be a multiple logical_block_size:%d\n",
707 f->max_blocks = nlba;
709 f->lba_shift = ilog2(lbs);
711 } else if (S_ISBLK(st.st_mode)) {
712 unsigned long long bytes;
714 if (ioctl(f->real_fd, BLKGETSIZE64, &bytes) != 0)
717 f->max_blocks = bytes / bs;
720 } else if (S_ISREG(st.st_mode)) {
721 f->max_blocks = st.st_size / bs;
722 f->max_size = st.st_size;
729 static int reap_events_uring(struct submitter *s)
731 struct io_cq_ring *ring = &s->cq_ring;
732 struct io_uring_cqe *cqe;
733 unsigned head, reaped = 0;
734 int last_idx = -1, stat_nr = 0;
740 if (head == atomic_load_acquire(ring->tail))
742 cqe = &ring->cqes[head & cq_ring_mask];
744 int fileno = cqe->user_data & 0xffffffff;
746 f = &s->files[fileno];
748 if (cqe->res != bs) {
749 printf("io: unexpected ret=%d\n", cqe->res);
750 if (polled && cqe->res == -EOPNOTSUPP)
751 printf("Your filesystem/driver/kernel doesn't support polled IO\n");
756 int clock_index = cqe->user_data >> 32;
758 if (last_idx != clock_index) {
759 if (last_idx != -1) {
760 add_stat(s, last_idx, stat_nr);
763 last_idx = clock_index;
772 add_stat(s, last_idx, stat_nr);
775 s->inflight -= reaped;
776 atomic_store_release(ring->head, head);
781 static int reap_events_uring_pt(struct submitter *s)
783 struct io_cq_ring *ring = &s->cq_ring;
784 struct io_uring_cqe *cqe;
785 unsigned head, reaped = 0;
786 int last_idx = -1, stat_nr = 0;
794 if (head == atomic_load_acquire(ring->tail))
796 index = head & cq_ring_mask;
797 cqe = &ring->cqes[index << 1];
798 fileno = cqe->user_data & 0xffffffff;
799 f = &s->files[fileno];
803 printf("io: unexpected ret=%d\n", cqe->res);
804 if (polled && cqe->res == -EINVAL)
805 printf("passthrough doesn't support polled IO\n");
809 int clock_index = cqe->user_data >> 32;
811 if (last_idx != clock_index) {
812 if (last_idx != -1) {
813 add_stat(s, last_idx, stat_nr);
816 last_idx = clock_index;
825 add_stat(s, last_idx, stat_nr);
828 s->inflight -= reaped;
829 atomic_store_release(ring->head, head);
834 static void set_affinity(struct submitter *s)
836 #ifdef CONFIG_LIBNUMA
837 struct bitmask *mask;
839 if (s->numa_node == -1)
842 numa_set_preferred(s->numa_node);
844 mask = numa_allocate_cpumask();
845 numa_node_to_cpus(s->numa_node, mask);
846 numa_sched_setaffinity(s->tid, mask);
850 static int detect_node(struct submitter *s, const char *name)
852 #ifdef CONFIG_LIBNUMA
853 const char *base = basename(name);
858 sprintf(str, "/sys/class/nvme-generic/%s/device/numa_node", base);
860 sprintf(str, "/sys/block/%s/device/numa_node", base);
861 fd = open(str, O_RDONLY);
865 ret = read(fd, str, sizeof(str));
879 static int setup_aio(struct submitter *s)
883 fprintf(stderr, "aio does not support polled IO\n");
886 if (sq_thread_poll) {
887 fprintf(stderr, "aio does not support SQPOLL IO\n");
891 fprintf(stderr, "aio does not support polled IO\n");
894 if (fixedbufs || register_files) {
895 fprintf(stderr, "aio does not support registered files or buffers\n");
896 fixedbufs = register_files = 0;
899 return io_queue_init(roundup_pow2(depth), &s->aio_ctx);
901 fprintf(stderr, "Legacy AIO not available on this system/build\n");
907 static int setup_ring(struct submitter *s)
909 struct io_sq_ring *sring = &s->sq_ring;
910 struct io_cq_ring *cring = &s->cq_ring;
911 struct io_uring_params p;
916 memset(&p, 0, sizeof(p));
918 if (polled && !do_nop)
919 p.flags |= IORING_SETUP_IOPOLL;
920 if (sq_thread_poll) {
921 p.flags |= IORING_SETUP_SQPOLL;
922 if (sq_thread_cpu != -1) {
923 p.flags |= IORING_SETUP_SQ_AFF;
924 p.sq_thread_cpu = sq_thread_cpu;
928 p.flags |= IORING_SETUP_SQE128;
929 p.flags |= IORING_SETUP_CQE32;
932 fd = io_uring_setup(depth, &p);
934 perror("io_uring_setup");
937 s->ring_fd = s->enter_ring_fd = fd;
944 rlim.rlim_cur = RLIM_INFINITY;
945 rlim.rlim_max = RLIM_INFINITY;
946 /* ignore potential error, not needed on newer kernels */
947 setrlimit(RLIMIT_MEMLOCK, &rlim);
949 ret = io_uring_register_buffers(s);
951 perror("io_uring_register_buffers");
956 ret = io_uring_map_buffers(s);
958 perror("io_uring_map_buffers");
964 if (register_files) {
965 ret = io_uring_register_files(s);
967 perror("io_uring_register_files");
972 ptr = mmap(0, p.sq_off.array + p.sq_entries * sizeof(__u32),
973 PROT_READ | PROT_WRITE, MAP_SHARED | MAP_POPULATE, fd,
975 sring->head = ptr + p.sq_off.head;
976 sring->tail = ptr + p.sq_off.tail;
977 sring->ring_mask = ptr + p.sq_off.ring_mask;
978 sring->ring_entries = ptr + p.sq_off.ring_entries;
979 sring->flags = ptr + p.sq_off.flags;
980 sring->array = ptr + p.sq_off.array;
981 sq_ring_mask = *sring->ring_mask;
983 if (p.flags & IORING_SETUP_SQE128)
984 len = 2 * p.sq_entries * sizeof(struct io_uring_sqe);
986 len = p.sq_entries * sizeof(struct io_uring_sqe);
987 s->sqes = mmap(0, len,
988 PROT_READ | PROT_WRITE, MAP_SHARED | MAP_POPULATE, fd,
991 if (p.flags & IORING_SETUP_CQE32) {
992 len = p.cq_off.cqes +
993 2 * p.cq_entries * sizeof(struct io_uring_cqe);
995 len = p.cq_off.cqes +
996 p.cq_entries * sizeof(struct io_uring_cqe);
999 PROT_READ | PROT_WRITE, MAP_SHARED | MAP_POPULATE, fd,
1000 IORING_OFF_CQ_RING);
1001 cring->head = ptr + p.cq_off.head;
1002 cring->tail = ptr + p.cq_off.tail;
1003 cring->ring_mask = ptr + p.cq_off.ring_mask;
1004 cring->ring_entries = ptr + p.cq_off.ring_entries;
1005 cring->cqes = ptr + p.cq_off.cqes;
1006 cq_ring_mask = *cring->ring_mask;
1008 for (i = 0; i < p.sq_entries; i++)
1009 sring->array[i] = i;
1014 static void *allocate_mem(struct submitter *s, int size)
1018 #ifdef CONFIG_LIBNUMA
1019 if (s->numa_node != -1)
1020 return numa_alloc_onnode(size, s->numa_node);
1023 if (posix_memalign(&buf, t_io_uring_page_size, bs)) {
1024 printf("failed alloc\n");
1031 static int submitter_init(struct submitter *s)
1033 int i, nr_batch, err;
1034 static int init_printed;
1037 printf("submitter=%d, tid=%d, file=%s, node=%d\n", s->index, s->tid,
1038 s->filename, s->numa_node);
1042 __init_rand64(&s->rand_state, s->tid);
1045 for (i = 0; i < MAX_FDS; i++)
1046 s->files[i].fileno = i;
1048 for (i = 0; i < roundup_pow2(depth); i++) {
1051 buf = allocate_mem(s, bs);
1054 s->iovecs[i].iov_base = buf;
1055 s->iovecs[i].iov_len = bs;
1059 sprintf(buf, "Engine=preadv2\n");
1062 err = setup_ring(s);
1063 sprintf(buf, "Engine=io_uring, sq_ring=%d, cq_ring=%d\n", *s->sq_ring.ring_entries, *s->cq_ring.ring_entries);
1065 sprintf(buf, "Engine=aio\n");
1069 printf("queue setup failed: %s, %d\n", strerror(errno), err);
1073 if (!init_printed) {
1074 printf("polled=%d, fixedbufs=%d/%d, register_files=%d, buffered=%d, QD=%d\n", polled, fixedbufs, dma_map, register_files, buffered, depth);
1080 nr_batch = roundup_pow2(depth / batch_submit);
1083 s->clock_batch = calloc(nr_batch, sizeof(unsigned long));
1086 s->plat = calloc(PLAT_NR, sizeof(unsigned long));
1088 s->clock_batch = NULL;
1092 /* perform the expensive command initialization part for passthrough here
1093 * rather than in the fast path
1096 for (i = 0; i < roundup_pow2(depth); i++) {
1097 struct io_uring_sqe *sqe = &s->sqes[i << 1];
1099 memset(&sqe->cmd, 0, sizeof(struct nvme_uring_cmd));
1105 #ifdef CONFIG_LIBAIO
1106 static int prep_more_ios_aio(struct submitter *s, int max_ios, struct iocb *iocbs)
1113 while (index < max_ios) {
1114 struct iocb *iocb = &iocbs[index];
1118 io_prep_pread(iocb, f->real_fd, s->iovecs[index].iov_base,
1119 s->iovecs[index].iov_len, get_offset(s, f));
1122 if (stats && stats_running)
1123 data |= (((uint64_t) s->clock_index) << 32);
1124 iocb->data = (void *) (uintptr_t) data;
1130 static int reap_events_aio(struct submitter *s, struct io_event *events, int evs)
1132 int last_idx = -1, stat_nr = 0;
1136 uint64_t data = (uintptr_t) events[reaped].data;
1137 struct file *f = &s->files[data & 0xffffffff];
1140 if (events[reaped].res != bs) {
1141 printf("io: unexpected ret=%ld\n", events[reaped].res);
1145 int clock_index = data >> 32;
1147 if (last_idx != clock_index) {
1148 if (last_idx != -1) {
1149 add_stat(s, last_idx, stat_nr);
1152 last_idx = clock_index;
1161 add_stat(s, last_idx, stat_nr);
1163 s->inflight -= reaped;
1168 static void *submitter_aio_fn(void *data)
1170 struct submitter *s = data;
1171 int i, ret, prepped;
1172 struct iocb **iocbsptr;
1174 struct io_event *events;
1175 #ifdef ARCH_HAVE_CPU_CLOCK
1176 int nr_batch = submitter_init(s);
1181 iocbsptr = calloc(depth, sizeof(struct iocb *));
1182 iocbs = calloc(depth, sizeof(struct iocb));
1183 events = calloc(depth, sizeof(struct io_event));
1185 for (i = 0; i < depth; i++)
1186 iocbsptr[i] = &iocbs[i];
1190 int to_wait, to_submit, to_prep;
1192 if (!prepped && s->inflight < depth) {
1193 to_prep = min(depth - s->inflight, batch_submit);
1194 prepped = prep_more_ios_aio(s, to_prep, iocbs);
1195 #ifdef ARCH_HAVE_CPU_CLOCK
1196 if (prepped && stats) {
1197 s->clock_batch[s->clock_index] = get_cpu_clock();
1198 s->clock_index = (s->clock_index + 1) & (nr_batch - 1);
1202 s->inflight += prepped;
1203 to_submit = prepped;
1205 if (to_submit && (s->inflight + to_submit <= depth))
1208 to_wait = min(s->inflight + to_submit, batch_complete);
1210 ret = io_submit(s->aio_ctx, to_submit, iocbsptr);
1213 perror("io_submit");
1215 } else if (ret != to_submit) {
1216 printf("submitted %d, wanted %d\n", ret, to_submit);
1225 r = io_getevents(s->aio_ctx, to_wait, to_wait, events, NULL);
1227 perror("io_getevents");
1229 } else if (r != to_wait) {
1230 printf("r=%d, wait=%d\n", r, to_wait);
1233 r = reap_events_aio(s, events, r);
1237 } while (!s->finish);
1247 static void io_uring_unregister_ring(struct submitter *s)
1249 struct io_uring_rsrc_update up = {
1250 .offset = s->enter_ring_fd,
1253 syscall(__NR_io_uring_register, s->ring_fd, IORING_UNREGISTER_RING_FDS,
1257 static int io_uring_register_ring(struct submitter *s)
1259 struct io_uring_rsrc_update up = {
1265 ret = syscall(__NR_io_uring_register, s->ring_fd,
1266 IORING_REGISTER_RING_FDS, &up, 1);
1268 s->enter_ring_fd = up.offset;
1275 static void *submitter_uring_fn(void *data)
1277 struct submitter *s = data;
1278 struct io_sq_ring *ring = &s->sq_ring;
1280 #ifdef ARCH_HAVE_CPU_CLOCK
1281 int nr_batch = submitter_init(s);
1287 io_uring_register_ring(s);
1291 int to_wait, to_submit, this_reap, to_prep;
1292 unsigned ring_flags = 0;
1294 if (!prepped && s->inflight < depth) {
1295 to_prep = min(depth - s->inflight, batch_submit);
1296 prepped = prep_more_ios_uring(s, to_prep);
1297 #ifdef ARCH_HAVE_CPU_CLOCK
1298 if (prepped && stats) {
1299 s->clock_batch[s->clock_index] = get_cpu_clock();
1300 s->clock_index = (s->clock_index + 1) & (nr_batch - 1);
1304 s->inflight += prepped;
1306 to_submit = prepped;
1308 if (to_submit && (s->inflight + to_submit <= depth))
1311 to_wait = min(s->inflight + to_submit, batch_complete);
1314 * Only need to call io_uring_enter if we're not using SQ thread
1315 * poll, or if IORING_SQ_NEED_WAKEUP is set.
1318 ring_flags = atomic_load_acquire(ring->flags);
1319 if (!sq_thread_poll || ring_flags & IORING_SQ_NEED_WAKEUP) {
1323 flags = IORING_ENTER_GETEVENTS;
1324 if (ring_flags & IORING_SQ_NEED_WAKEUP)
1325 flags |= IORING_ENTER_SQ_WAKEUP;
1326 ret = io_uring_enter(s, to_submit, to_wait, flags);
1329 /* for SQPOLL, we submitted it all effectively */
1334 * For non SQ thread poll, we already got the events we needed
1335 * through the io_uring_enter() above. For SQ thread poll, we
1336 * need to loop here until we find enough events.
1343 r = reap_events_uring_pt(s);
1345 r = reap_events_uring(s);
1351 } while (sq_thread_poll && this_reap < to_wait);
1352 s->reaps += this_reap;
1360 } else if (ret < to_submit) {
1361 int diff = to_submit - ret;
1370 } else if (ret < 0) {
1371 if (errno == EAGAIN) {
1379 printf("io_submit: %s\n", strerror(errno));
1382 } while (!s->finish);
1385 io_uring_unregister_ring(s);
1391 #ifdef CONFIG_PWRITEV2
1392 static void *submitter_sync_fn(void *data)
1394 struct submitter *s = data;
1405 #ifdef ARCH_HAVE_CPU_CLOCK
1407 s->clock_batch[s->clock_index] = get_cpu_clock();
1413 offset = get_offset(s, f);
1415 ret = preadv2(f->real_fd, &s->iovecs[0], 1, offset, RWF_HIPRI);
1417 ret = preadv2(f->real_fd, &s->iovecs[0], 1, offset, 0);
1422 } else if (ret != bs) {
1430 add_stat(s, s->clock_index, 1);
1431 } while (!s->finish);
1437 static void *submitter_sync_fn(void *data)
1444 static struct submitter *get_submitter(int offset)
1450 ret += offset * (sizeof(*submitter) + depth * sizeof(struct iovec));
1454 static void do_finish(const char *reason)
1458 printf("Exiting on %s\n", reason);
1459 for (j = 0; j < nthreads; j++) {
1460 struct submitter *s = get_submitter(j);
1463 if (max_iops > 1000000) {
1464 double miops = (double) max_iops / 1000000.0;
1465 printf("Maximum IOPS=%.2fM\n", miops);
1466 } else if (max_iops > 100000) {
1467 double kiops = (double) max_iops / 1000.0;
1468 printf("Maximum IOPS=%.2fK\n", kiops);
1470 printf("Maximum IOPS=%lu\n", max_iops);
1475 static void sig_int(int sig)
1477 do_finish("signal");
1480 static void arm_sig_int(void)
1482 struct sigaction act;
1484 memset(&act, 0, sizeof(act));
1485 act.sa_handler = sig_int;
1486 act.sa_flags = SA_RESTART;
1487 sigaction(SIGINT, &act, NULL);
1489 /* Windows uses SIGBREAK as a quit signal from other applications */
1491 sigaction(SIGBREAK, &act, NULL);
1495 static void usage(char *argv, int status)
1497 char runtime_str[16];
1498 snprintf(runtime_str, sizeof(runtime_str), "%d", runtime);
1499 printf("%s [options] -- [filenames]\n"
1500 " -d <int> : IO Depth, default %d\n"
1501 " -s <int> : Batch submit, default %d\n"
1502 " -c <int> : Batch complete, default %d\n"
1503 " -b <int> : Block size, default %d\n"
1504 " -p <bool> : Polled IO, default %d\n"
1505 " -B <bool> : Fixed buffers, default %d\n"
1506 " -D <bool> : DMA map fixed buffers, default %d\n"
1507 " -F <bool> : Register files, default %d\n"
1508 " -n <int> : Number of threads, default %d\n"
1509 " -O <bool> : Use O_DIRECT, default %d\n"
1510 " -N <bool> : Perform just no-op requests, default %d\n"
1511 " -t <bool> : Track IO latencies, default %d\n"
1512 " -T <int> : TSC rate in HZ\n"
1513 " -r <int> : Runtime in seconds, default %s\n"
1514 " -R <bool> : Use random IO, default %d\n"
1515 " -a <bool> : Use legacy aio, default %d\n"
1516 " -S <bool> : Use sync IO (preadv2), default %d\n"
1517 " -X <bool> : Use registered ring %d\n"
1518 " -P <bool> : Automatically place on device home node %d\n"
1519 " -u <bool> : Use nvme-passthrough I/O, default %d\n",
1520 argv, DEPTH, BATCH_SUBMIT, BATCH_COMPLETE, BS, polled,
1521 fixedbufs, dma_map, register_files, nthreads, !buffered, do_nop,
1522 stats, runtime == 0 ? "unlimited" : runtime_str, random_io, aio,
1523 use_sync, register_ring, numa_placement, pt);
1527 static void read_tsc_rate(void)
1535 fd = open(TSC_RATE_FILE, O_RDONLY);
1539 ret = read(fd, buffer, sizeof(buffer));
1545 tsc_rate = strtoul(buffer, NULL, 10);
1546 printf("Using TSC rate %luHz\n", tsc_rate);
1550 static void write_tsc_rate(void)
1556 if (!stat(TSC_RATE_FILE, &sb))
1559 fd = open(TSC_RATE_FILE, O_WRONLY | O_CREAT, 0644);
1563 memset(buffer, 0, sizeof(buffer));
1564 sprintf(buffer, "%lu", tsc_rate);
1565 ret = write(fd, buffer, strlen(buffer));
1571 int main(int argc, char *argv[])
1573 struct submitter *s;
1574 unsigned long done, calls, reap;
1575 int i, j, flags, fd, opt, threads_per_f, threads_rem = 0, nfiles;
1579 if (!do_nop && argc < 2)
1582 while ((opt = getopt(argc, argv, "d:s:c:b:p:B:F:n:N:O:t:T:a:r:D:R:X:S:P:u:h?")) != -1) {
1585 aio = !!atoi(optarg);
1588 depth = atoi(optarg);
1591 batch_submit = atoi(optarg);
1596 batch_complete = atoi(optarg);
1597 if (!batch_complete)
1604 polled = !!atoi(optarg);
1607 fixedbufs = !!atoi(optarg);
1610 register_files = !!atoi(optarg);
1613 nthreads = atoi(optarg);
1615 printf("Threads must be non-zero\n");
1620 do_nop = !!atoi(optarg);
1623 buffered = !atoi(optarg);
1626 #ifndef ARCH_HAVE_CPU_CLOCK
1627 fprintf(stderr, "Stats not supported on this CPU\n");
1630 stats = !!atoi(optarg);
1633 #ifndef ARCH_HAVE_CPU_CLOCK
1634 fprintf(stderr, "Stats not supported on this CPU\n");
1637 tsc_rate = strtoul(optarg, NULL, 10);
1641 runtime = atoi(optarg);
1644 dma_map = !!atoi(optarg);
1647 random_io = !!atoi(optarg);
1650 register_ring = !!atoi(optarg);
1653 #ifdef CONFIG_PWRITEV2
1654 use_sync = !!atoi(optarg);
1656 fprintf(stderr, "preadv2 not supported\n");
1661 numa_placement = !!atoi(optarg);
1664 pt = !!atoi(optarg);
1677 if (batch_complete > depth)
1678 batch_complete = depth;
1679 if (batch_submit > depth)
1680 batch_submit = depth;
1681 if (!fixedbufs && dma_map)
1684 submitter = calloc(nthreads, sizeof(*submitter) +
1685 roundup_pow2(depth) * sizeof(struct iovec));
1686 for (j = 0; j < nthreads; j++) {
1687 s = get_submitter(j);
1690 s->done = s->calls = s->reaps = 0;
1693 flags = O_RDONLY | O_NOATIME;
1702 printf("No files specified\n");
1705 threads_per_f = nthreads / nfiles;
1706 /* make sure each thread gets assigned files */
1707 if (threads_per_f == 0) {
1710 threads_rem = nthreads - threads_per_f * nfiles;
1713 while (!do_nop && i < argc) {
1716 memset(&f, 0, sizeof(f));
1718 fd = open(argv[i], flags);
1724 if (get_file_size(&f)) {
1725 printf("failed getting size of device/file\n");
1728 if (f.max_blocks <= 1) {
1729 printf("Zero file/device size?\n");
1734 limit = threads_per_f;
1735 limit += threads_rem > 0 ? 1 : 0;
1736 for (k = 0; k < limit; k++) {
1737 s = get_submitter((j + k) % nthreads);
1739 if (s->nr_files == MAX_FDS) {
1740 printf("Max number of files (%d) reached\n", MAX_FDS);
1744 memcpy(&s->files[s->nr_files], &f, sizeof(f));
1747 detect_node(s, argv[i]);
1749 s->filename = argv[i];
1759 t_io_uring_page_size = sysconf(_SC_PAGESIZE);
1760 if (t_io_uring_page_size < 0)
1761 t_io_uring_page_size = 4096;
1763 for (j = 0; j < nthreads; j++) {
1764 s = get_submitter(j);
1766 pthread_create(&s->thread, NULL, submitter_sync_fn, s);
1768 pthread_create(&s->thread, NULL, submitter_uring_fn, s);
1769 #ifdef CONFIG_LIBAIO
1771 pthread_create(&s->thread, NULL, submitter_aio_fn, s);
1775 reap = calls = done = 0;
1777 unsigned long this_done = 0;
1778 unsigned long this_reap = 0;
1779 unsigned long this_call = 0;
1780 unsigned long rpc = 0, ipc = 0;
1781 unsigned long iops, bw;
1784 if (runtime && !--runtime)
1785 do_finish("timeout");
1787 /* don't print partial run, if interrupted by signal */
1791 /* one second in to the run, enable stats */
1795 for (j = 0; j < nthreads; j++) {
1796 s = get_submitter(j);
1797 this_done += s->done;
1798 this_call += s->calls;
1799 this_reap += s->reaps;
1801 if (this_call - calls) {
1802 rpc = (this_done - done) / (this_call - calls);
1803 ipc = (this_reap - reap) / (this_call - calls);
1806 iops = this_done - done;
1808 bw = iops * (bs / 1048576);
1810 bw = iops / (1048576 / bs);
1811 if (iops > 1000000) {
1812 double miops = (double) iops / 1000000.0;
1813 printf("IOPS=%.2fM, ", miops);
1814 } else if (iops > 100000) {
1815 double kiops = (double) iops / 1000.0;
1816 printf("IOPS=%.2fK, ", kiops);
1818 printf("IOPS=%lu, ", iops);
1820 max_iops = max(max_iops, iops);
1823 double bw_g = (double) bw / 1000.0;
1825 printf("BW=%.2fGiB/s, ", bw_g);
1827 printf("BW=%luMiB/s, ", bw);
1830 printf("IOS/call=%ld/%ld\n", rpc, ipc);
1836 for (j = 0; j < nthreads; j++) {
1837 s = get_submitter(j);
1838 pthread_join(s->thread, &ret);
1844 printf("%d: Latency percentiles:\n", s->tid);
1845 for (i = 0, nr = 0; i < PLAT_NR; i++)
1847 show_clat_percentiles(s->plat, nr, 4);
1848 free(s->clock_batch);