关于 linux io_uring 性能测试 及其 实现原理的一些探索

先看看性能

io_uring 需要内核版本在5.1 及以上才支持，liburing的编译安装 很简单，直接clone 官方的代码，sudo make && sudo make install 就好了，本文是在内核5.12版本 上测试的。

在描述io_uring 的性能之前，我们先直接看一组实测数据：

这组数据是在3D XPoint 介质的硬盘 ： optane-5800上测试的，optane5800 能够提供(randread100% 150w/s , randwrite 100% 150w/s)的性能。

进行测试的fio 脚本如下：

# aio
[global]
ioengine=libaio
direct=0
randrepeat=1
threads=8
runtime=15
time_based
size=1G
directory=../test-data
group_reporting
[read256B-rand]
bs=4096
rw=randread
numjobs=1
iodepth=128# io_uring
[global]
ioengine=io_uring
sqthread_poll=1 #开启io_uring sq_poll模式
direct=1
randrepeat=1
threads=8
runtime=15
time_based
size=1G
directory=../test-data
group_reporting
[read256B-rand]
bs=4096
rw=randread
numjobs=1
iodepth=128

通过上面的测试，我们能够得到如下几个结论：

1. 这种高队列深度的测试下，可以看到io_uring 在开启sq_poll之后的性能 相比于aio 的高队列深度的处理能力好接近一倍；
2. 在较低队列深度 以及不开启 sq_poll 模式的情况下，io_uring 整体没有太大的优势，或者说一样的性能。
3. 在buffer I/O (direct=0) 下，io_uring 也不会有太大的优势，因为都得通过 os-cache 来操作。

需要注意的是，如果aio和io_uring 在高并发下(jobs 的数目不断增加)，都是可以达到当前磁盘的性能瓶颈的。

AIO 的基本实现

那有这样的测试现象，我们可能会有一些疑问，就这性能？我们在nvme上做软件，希望发挥的是整个磁盘的性能，而不是比拼谁的队列深度大，谁的优势更大。。。 我用aio 做batch 也能达到磁盘的性能瓶颈，为什么要选择 对于数据库/存储 领域来说 好像“如日中天”的io_uring呢。

我们先来看看aio 的大体实现，没有涉及到源代码。
aio 主要提供了三个系统调用：

• io_setup 初始化一些内核态的数据结构
• io_submit 用于用户态提交io 请求
• io_getevents 用于io 请求处理完成之后的io 收割
  
  大体的IO调度过程如下：

1. io_setup 完成一些内核数据结构的初始化（包括内核中的 aio 调度队列，aio_ring_info 的ring-buffer缓冲区）
2. 用户态构造一批io请求，通过io_submit 拷贝请求到内核态io 队列（文件系统之上，上图没有体现出来）之后返回到用户态。
3. 内核态继续通过内核i/o 栈处理io请求，处理完成之后 通过 aio_complete 函数将处理完成的请求放入到 aio_ring_info，每一个io请求是一个io_event。
4. 用户态通过 io_getevents 系统调用 从 aio_ring_info(ring-buffer) 的head 拿处理完成的io_event，如果head==tail，则表示这个ring-buffer是空的。拿到之后，将拿到的io_event 一批从内核态拷贝到用户态。

如果单纯看 谁能将磁盘性能完整发挥出来，那毋庸置疑，大家都可以；那为什么做存储的对io_uring 的出现如此热衷呢？我们就得结合实际的应用场景来看看两者之间的差异了：

1. 使用AIO的话，请求调度都需要直接由通用块层来调度处理，所以需要O_DIRECT标记。这就意味着，使用AIO的应用都无法享受os cache，这对与存储应用来说并不友好，cache都得自己来维护，而且显然没有os page-cache性能以及稳定性有优势。

   而使用io_uring 则没有这样的限制，当然，io_uring在 buffer I/O下显然没有太大的优势。

2. 延时上的开销。AIO 提交用户请求的时候 通过io_submit调用，收割用户请求的时候通过io_getevents，正常应用的时候每一个请求都意味着至少两次系统调用（I/O提交和I/O收割），而对于io_uring来说，I/O 提交和I/O收割都可以 offload 给内核。这样相比于AIO 来说，io_uring能够极大得减少 系统调用引入的上下文切换。

3. io_uring 能够支持针对submit queue的polling，启动一个内核线程进行polling，加速请求的提交和收割；对于aio来说，这里就没有这样的机制。

总的来说，io_uring 能够保证上层应用 对系统资源(cache)正常使用的同时 ，降低应用 下发的请求延时和CPU的开销，在单实例高队深下，能够显著优于同等队深下的AIO性能。

io_ring 使用

io_uring 基本接口

io_uring的用户态API 提供了三个系统调用，io_uring_setup，io_uring_enter，io_uring_register。

• int io_uring_setup(u32 entries, struct io_uring_params *p); 这个接口 用于创建 拥有 entries 个请求的 提交队列(SQ) 和 完成队列(CQ)，并且返回给用户一个fd。这个fd可以用做在同一个uring实例上 用户空间和内核空间共享sq和cq 队列，这样能够避免在请求完成时不需要从完成队列拷贝数据到用户态了。io_uring_params 主要是根据用户的配置来设置uring 实例的创建行为。包括 单不限于开启 IORING_SETUP_IOPOLL 和 IORING_SETUP_SQPOLL 两种 poll 模式。 后面会细说。

• int io_uring_register(unsigned int fd, unsigned int opcode, void *arg, unsigned int nr_args);

  这个接口主要用于注册用户态和内核态共享的缓冲区，即将 setup 返回的fd中的数据结构 映射到共享内存，从而进一步减少用户I/O 提交到uring 队列中的开销。

• int io_uring_enter(unsigned int fd, unsigned int to_submit, unsigned int min_complete, unsigned int flags, sigset_t *sig);

  这个接口既能够提交 新的I/O请求 ，又能够支持I/O收割。

liburing 的使用

可以从上面的几个系统调用能够简单看到 用户在自主使用这三个系统调用来调度 I/O请求时 还是比较麻烦的，像io_uring_setup 之后的fd，我们用户层想要使用创建好的sq/cq ，则需要自主进行mmap，并且维护用户态的sq/cq 数据结构，并在后续的 enter 中自主进行用户态的sq 的填充。这个过程相对来说还是比较麻烦的。更不要说用三个系统调用中数十个的flags的灵活配置，如果全部结合起来，对于刚接触io_uring的用户来说还是需要较大的学习成本。

比如，我想启动io_uring，并初始化好用户态的sq/cq 数据结构，就需要写下面这一些代码：

int app_setup_uring(struct submitter *s) {struct app_io_sq_ring *sring = &s->sq_ring;struct app_io_cq_ring *cring = &s->cq_ring;struct io_uring_params p;void *sq_ptr, *cq_ptr;/** We need to pass in the io_uring_params structure to the io_uring_setup()* call zeroed out. We could set any flags if we need to, but for this* example, we don't.* */memset(&p, 0, sizeof(p));s->ring_fd = io_uring_setup(QUEUE_DEPTH, &p);if (s->ring_fd < 0) {perror("io_uring_setup");return 1;}/** io_uring communication happens via 2 shared kernel-user space ring buffers,* which can be jointly mapped with a single mmap() call in recent kernels.* While the completion queue is directly manipulated, the submission queue* has an indirection array in between. We map that in as well.* */int sring_sz = p.sq_off.array + p.sq_entries * sizeof(unsigned);int cring_sz = p.cq_off.cqes + p.cq_entries * sizeof(struct io_uring_cqe);/* In kernel version 5.4 and above, it is possible to map the submission and* completion buffers with a single mmap() call. Rather than check for kernel* versions, the recommended way is to just check the features field of the* io_uring_params structure, which is a bit mask. If the* IORING_FEAT_SINGLE_MMAP is set, then we can do away with the second mmap()* call to map the completion ring.* */if (p.features & IORING_FEAT_SINGLE_MMAP) {if (cring_sz > sring_sz) {sring_sz = cring_sz;}cring_sz = sring_sz;}/* Map in the submission and completion queue ring buffers.* Older kernels only map in the submission queue, though.* */sq_ptr = mmap(0, sring_sz, PROT_READ | PROT_WRITE,MAP_SHARED | MAP_POPULATE,s->ring_fd, IORING_OFF_SQ_RING);if (sq_ptr == MAP_FAILED) {perror("mmap");return 1;}if (p.features & IORING_FEAT_SINGLE_MMAP) {cq_ptr = sq_ptr;} else {/* Map in the completion queue ring buffer in older kernels separately */// 放置内存被page faultcq_ptr = mmap(0, cring_sz, PROT_READ | PROT_WRITE,MAP_SHARED | MAP_POPULATE,s->ring_fd, IORING_OFF_CQ_RING);if (cq_ptr == MAP_FAILED) {perror("mmap");return 1;}}/* Save useful fields in a global app_io_sq_ring struct for later* easy reference */sring->head = sq_ptr + p.sq_off.head;sring->tail = sq_ptr + p.sq_off.tail;sring->ring_mask = sq_ptr + p.sq_off.ring_mask;sring->ring_entries = sq_ptr + p.sq_off.ring_entries;sring->flags = sq_ptr + p.sq_off.flags;sring->array = sq_ptr + p.sq_off.array;/* Map in the submission queue entries array */s->sqes = mmap(0, p.sq_entries * sizeof(struct io_uring_sqe),PROT_READ | PROT_WRITE, MAP_SHARED | MAP_POPULATE,s->ring_fd, IORING_OFF_SQES);if (s->sqes == MAP_FAILED) {perror("mmap");return 1;}/* Save useful fields in a global app_io_cq_ring struct for later* easy reference */cring->head = cq_ptr + p.cq_off.head;cring->tail = cq_ptr + p.cq_off.tail;cring->ring_mask = cq_ptr + p.cq_off.ring_mask;cring->ring_entries = cq_ptr + p.cq_off.ring_entries;cring->cqes = cq_ptr + p.cq_off.cqes;return 0;
}

所以Jens Axboe 将三个系统调用做了一个封装，形成了liburing，在这里面我想要初始化一个uring实例，并完成用户态的数据结构的映射，只需要调用下面io_uring_queue_init 这个接口:

	struct io_uring ring;struct io_uring_params p = { };int ret;ret = io_uring_queue_init(IORING_MAX_ENTRIES, &ring, IORING_SETUP_IOPOLL);

关于liburing的使用，可以看下面这个100行的小案例：

大体的功能就是利用io_uring 去读一个用户输入的文件，每次读请求的大小是4K，读完整个文件结束。

#include <stdio.h>
#include <fcntl.h>
#include <string.h>
#include <stdlib.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include "liburing.h"#define QD      4int main(int argc, char *argv[])
{struct io_uring ring;int i, fd, ret, pending, done;struct io_uring_sqe *sqe;struct io_uring_cqe *cqe;struct iovec *iovecs;struct stat sb;ssize_t fsize;off_t offset;void *buf;if (argc < 2) {printf("%s: file\n", argv[0]);return 1;}// 初始化io_uring，并拿到初始化的结果，0是成功的，小于0 是失败的ret = io_uring_queue_init(QD, &ring, 0);if (ret < 0) {fprintf(stderr, "queue_init: %s\n", strerror(-ret));return 1;}// 打开用户输入的文件fd = open(argv[1], O_RDONLY | O_DIRECT);if (fd < 0) {perror("open");return 1;}// 将文件属性放在sb中，主要是获取文件的大小if (fstat(fd, &sb) < 0) {perror("fstat");return 1;}// 拆分成 设置的 io_uring支持的最大队列深度 个请求，4个fsize = 0;iovecs = calloc(QD, sizeof(struct iovec));for (i = 0; i < QD; i++) {if (posix_memalign(&buf, 4096, 4096))return 1;iovecs[i].iov_base = buf;iovecs[i].iov_len = 4096;fsize += 4096;}// 构造请求，并存放在 seq中offset = 0;i = 0;do {sqe = io_uring_get_sqe(&ring);if (!sqe)break;io_uring_prep_readv(sqe, fd, &iovecs[i], 1, offset);offset += iovecs[i].iov_len;i++;if (offset > sb.st_size)break;} while (1);// 提交请求sqe 中的请求到内核ret = io_uring_submit(&ring);if (ret < 0) {fprintf(stderr, "io_uring_submit: %s\n", strerror(-ret));return 1;} else if (ret != i) {fprintf(stderr, "io_uring_submit submitted less %d\n", ret);return 1;}done = 0;pending = ret;fsize = 0;// 等待内核处理完所有的请求，并由用户态拿到cqe，表示请求处理完成for (i = 0; i < pending; i++) {ret = io_uring_wait_cqe(&ring, &cqe);if (ret < 0) {fprintf(stderr, "io_uring_wait_cqe: %s\n", strerror(-ret));return 1;}done++;ret = 0;if (cqe->res != 4096 && cqe->res + fsize != sb.st_size) {fprintf(stderr, "ret=%d, wanted 4096\n", cqe->res);ret = 1;}fsize += cqe->res;io_uring_cqe_seen(&ring, cqe);if (ret)break;}// 最后输出 提交的请求的个数（4k），完成请求的个数，总共处理的请求大小printf("Submitted=%d, completed=%d, bytes=%lu\n", pending, done,(unsigned long) fsize);close(fd);io_uring_queue_exit(&ring);return 0;
}

编译: gcc -O2 -D_GNU_SOURCE -o io_uring-test io_uring-test.c -luring

运行: ./io_uring-test test-file.txt

io_uring 非poll 模式下 的实现

接下来记录一下io_uring的实现，来填之前说到的一些小坑，当然…这里描述的内容也是站在前人的肩膀 以及 自己经过一些测试验证总体来看的。

io_uring 能够支持其他多种I/O相关的请求：

• 文件I/O：read, write, remove, update, link,unlink, fadivse, allocate, rename, fsync等
• 网络I/O：send, recv, socket, connet, accept等
• 进程间通信：pipe
• …

还是以 上面案例中 io_uring 处理read 请求为例， 通过io_uring_prep_readv 来填充之前已经创建好的sqe。

static inline void io_uring_prep_readv(struct io_uring_sqe *sqe, int fd,const struct iovec *iovecs,unsigned nr_vecs, __u64 offset)
{// 调度读请求，将构造好的iovecs 中的内容填充到sqe中。io_uring_prep_rw(IORING_OP_READV, sqe, fd, iovecs, nr_vecs, offset);
}static inline void io_uring_prep_rw(int op, struct io_uring_sqe *sqe, int fd,const void *addr, unsigned len,__u64 offset)
{sqe->opcode = (__u8) op;...sqe->fd = fd;sqe->off = offset;sqe->addr = (unsigned long) addr;sqe->len = len;...sqe->__pad2[0] = sqe->__pad2[1] = 0;
}

那我们需要先回到最开始的io_uring_setup 以及 后续的mmap setup返回的结果 之后 用户态和内核态共享的数据结构内容。

数据结构 在内存中的分布 如上图：

1. io_uring_setup 之后，会将内核中创建好的一块内存区域 用 fd标识 以及各个数据结构在这个内存区域中的偏移量存放在io_uring_params中， 通过mmap 来将这部分内存区域的数据结构映射到用用户空间。

   其中io_uring_params 中的 关键数据结构如下：

   struct io_uring_params {__u32 sq_entries; // sq 队列的个数__u32 cq_entries; // cq 队列的个数__u32 flags; // setup设置的一些标识，比如是否开启内核的io_poll 或者 sq_poll等__u32 sq_thread_cpu; // 设置sq_poll 模式下 轮询的cpu 编号__u32 sq_thread_idle; __u32 features;__u32 wq_fd;__u32 resv[3];struct io_sqring_offsets sq_off; // sq的偏移量struct io_cqring_offsets cq_off; // cq的偏移量
   };
   

2. Mmap 之后的内存形态就是上图中的数据结构形态，mmap的过程就是填充用户态可访问的sq/cq。

   • SQ ，submission queue，保存用户空间提交的请求的地址，实际的用户请求会存放在 io_uring_sqe的sqes中。

     struct io_uring_sq {unsigned *khead;unsigned *ktail;...struct io_uring_sqe *sqes; // 较为复杂的数据结构，保存请求的实际内容unsigned sqe_head;unsigned sqe_tail;...
     };
     

     用户空间的sq更新会追加到SQ 的队尾部，内核空间消费 SQ 时则会消费队头。

   • CQ, complete queue，保存内核空间完成请求的地址，实际的完成请求的数据会存放在io_uring_cqe的cqes中。

     struct io_uring_cq {unsigned *khead;unsigned *ktail;...struct io_uring_cqe *cqes;...
     };
     

     内核完成IO 收割之后会将请求填充到cqes 中，并更新cq 的队尾，用户空间则会从cq的队头消费 处理完成的请求。

3. 在前面的read 案例代码中，调用的liburing 的函数 io_uring_get_sqe 就是在用户空间更新sq的队尾部。

   struct io_uring_sqe *io_uring_get_sqe(struct io_uring *ring)
   {struct io_uring_sq *sq = &ring->sq;unsigned int head = io_uring_smp_load_acquire(sq->khead);unsigned int next = sq->sqe_tail + 1;struct io_uring_sqe *sqe = NULL;// 当前sq的 tail 和 head之间的容量满足sq的大小，则将当前请求的填充到sqe中// 并更新sq 的队尾，向上移动if (next - head <= *sq->kring_entries) {sqe = &sq->sqes[sq->sqe_tail & *sq->kring_mask];sq->sqe_tail = next;}return sqe;
   }
   

   后续，内核处理完成之后，用户空间从cq中获取 处理完成的请求时则会调用io_uring_wait_cqe_nr 进行收割。

io_uring 中的ring就是 上图中的io 链路，从sq队尾进入，最后请求从cq 队头出来，整个链路就是一个环形(ring)。而sq和cq在数据结构上被存放在了 io_uring 中。加了uring 中的u 猜测是指用户态(userspace)可访问的，目的是好的，不过读起来的单词谐音就让一些人略微尴尬(urine。。。)

非poll 模式下的内核火焰图调用栈如下：

io_uring poll模式下的实现

我们在最开始的性能测试过程中可以看到在开启 poll 之后，io_uring的性能才能显著提高。

我们从前面 io_uring 内存分布图 中可以看到在内核调度两个队列请求的过程中 可以通过异步轮询的方式进行调度的，也就是io_uring的 poll模式。

io_uring 在io_uring_setup的时候可以通过设置flag 来开启poll模式，io-uring 支持两种方式poll模式。

• IORING_SETUP_IOPOLL，这种方式是由nvme 驱动支持的 io_poll。即用户态通过io_uring_enter提交请求到内核的文件读写队列中即可，nvme驱动会不断得轮询文件读写队列进行io消费，同时用户态在设置IORING_ENTER_GETEVENTS得flag之后，还需要不断得调用io_uring_enter 通过io_iopoll_check 调用内核接口查看 nvme的io_poll 是否完成任务调度，从而进行填充 cqes。

  如果使用nvme驱动，则需要单独开启io_poll 才能真正让 IORING_SETUP_IOPOLL 配置生效。

  开启的话，直接尝试 root 用户操作：echo 1 > /sys/block/nvme2n1/queue/io_poll，成功则表示开启。

  如果出现bash: echo: write error: Invalid argument ，则表示当前nvme驱动还不支持，需要通过驱动层打开这个配置才行，可以尝试执行如下步骤：

  如果执行之前，通过modinfo nvme 查看当前设备是否有nvme驱动失败，则需要先编译当前内核版本的nvme驱动才行，否则下面的操作没有nvme驱动都是无法进行的。

  1. umount fs ， 卸载磁盘上挂载的文件系统
  2. echo 1 > /sys/block/nvme0n1/device/device/remove ， 将设备从当前服务器移除
  3. rmmod nvme
  4. modprobe nvme poll_queues=1， 重新加载nvme驱动，来支持io_poll的队列深度为1
  5. echo 1 > /sys/bus/pci/rescan ，重新将磁盘加载回来

• IORING_SETUP_SQPOLL，这种模式的poll则是我们fio测试下的 sqthread_poll开启的配置。开启之后io_uring会启动一个内核线程，用来轮询submit queue，从而达到不需要系统调用的参与就可以提交请求。用户请求在用户空间提交到SQ 之后，这个内核线程处于唤醒状态时会不断得轮询SQ，也就可以立即捕获到这次请求。（我们前面的案例中会先在用户空间构造指定数量的SQ放到ring-buffer中，再由io_uring_enter一起提交到内核），这个时候有了sq_thread 的轮询，只要用户空间提交到SQ，内核就能够捕获到并进行处理。如果sq_thread 长时间捕获不到请求，则会进入休眠状态，需要通过调用io_uring_enter系统调用，并设置IORING_SQ_NEED_WAKEUP来唤醒sq_thread。
  大体的调度方式如下图：
  

  这种sq_thread 内核对SQ的轮询模式能够极大得减少请求在submit queue中的排队时间，同时减少了io_uring_enter系统调用的开销。

开启sq_thread之后的轮询模式可以看到 用户提交请求 对CPU消耗仅仅只占用了一小部分的cpu。

io_uring 在 rocksdb 中的应用

Rocksdb 针对io_uring的调用大体类似前面提到的使用liburing 接口实现的一个read 文件的案例，同样是调用io_uring_prep_readv 来实现对文件的读写。

Io_uring 的特性决定了在I/O层 的批量读才能体现它的优势，所以rocksdb 将io_uring集成到了 MultiGet 中的 MultiRead 接口之中。

需要注意的是 rocksdb 设置的 io_uring的SQ 队列深度大小是256，且setup的时候并没有开启sq_poll模式，而是默认开启io_poll，即flag是0;如果想要开启sq_poll模式，则需要变更这个接口的flags配置，比如将0设置为IORING_SETUP_SQPOLL，然后重新编译源代码即可。

inline struct io_uring* CreateIOUring() {struct io_uring* new_io_uring = new struct io_uring;int ret = io_uring_queue_init(kIoUringDepth, new_io_uring, 0);if (ret) {delete new_io_uring;new_io_uring = nullptr;}return new_io_uring;
}

大家在使用db_bench测试io_uring的时候 如果不变更rocksdb这里的io_uring_queue_init接口的话，需要保证自己的磁盘支持io_poll模式，也就是通过上一节说的那种查看/修改 nvme 驱动配置来支持io_poll。

在io_poll模式下，对MultiGet的接口测试性能数据大概如下：

我的环境不支持io_poll，大体收益应该和fio的poll模式下的性能收益差不了太多

图片来自官方

db_bench的配置可以使用，直接用rocksdb的master, CMakeList.txt 默认会开启io_uring：

生成数据：

 ./db_bench_uring \--benchmarks=fillrandom,stats \--num=3000000000 \--threads=32 \--db=./db \--wal_dir=./db \--duration=3600 \-report_interval_seconds=1 \--stats_interval_seconds=10 \--key_size=16 \--value_size=128 \--max_write_buffer_number=16 \-max_background_compactions=32 \-max_background_flushes=7 \-subcompactions=8 \-compression_type=none \

io_uring 测试MultiGet，不使用block_cache:

 ./db_bench_uring \--benchmarks=multireadrandom,stats \--num=3000000000 \--threads=32 \--db=./db \ --wal_dir=./db \--duration=3600 \-report_interval_seconds=1 \--stats_interval_seconds=10 \--key_size=16 \--value_size=128 \-compression_type=none \-cache_size=0 \-use_existing_db=1 \-batch_size=256 \ # 每次MultiGet的 请求总个数-multiread_batched=true \ # 使用 MultiGet 的新的API，支持MultiRead，否则就是逐个Get-multiread_stride=0 # 指定MultiGet 时生成的key之间的跨度，本来是连续的随机key，现在可以让上一个随机key和下一个随机key之间间隔指定的长度。

总结

总的来说，io_uring能够在内核的各个组件都能够正常运行的基础上进一步提升了性能，提升的部分包括 减少系统调用的开销，减少内核上下文的开销，以及支持io_poll和sq_poll 这样的高速轮询处理机制。而且相比于libaio 仅能够使用direct-io来调度，那这个限制本身就对存储应用软件不够友好了。

可见的未来，存储系统是内核的直接用户，随着未来硬件介质的超高速发展，互联网应用对存储系统的高性能需求就会反作用于内核，那内核的一些I/O链路的性能也需要不断得跟进提升，然而每一项on-linux kernel的更改都因为内核精密复杂高要求 的 标准都会比普通的应用复杂很多，io_uring 能够合入5系内核的upstream，那显然证明了其未来的发展潜力 以及 内核社区 对其潜力的认可。

参考

1. https://kernel.dk/io_uring.pdf
2. https://zhuanlan.zhihu.com/p/380726590
3. https://developers.mattermost.com/blog/hands-on-iouring-go/