一篇帶你了解io_uring和Node.js
前言：io_uring是大神Jens Axboe開發的異步IO框架，在Linux內核5.1引入。本文介紹什么是異步框架和io_uring的一些基礎內容，最后介紹Node.js(Libuv)中，之前有人提但至今還沒有合并的一個關于io_uring的pr。
1 io_uring介紹
在io_uring之前，Linux沒有成熟的異步IO能力，什么是異步IO呢?回想我們讀取資源的過程，我們可以以阻塞或非阻塞的模式調用read、readv，也可以通過epoll監聽文件描述符和事件的方式，在回調里調用read系列函數進行讀取，這些API有個共同的地方是，不管是主動探還是被動探測資源是否可讀，當可讀的時候，都需要進程自己去執行讀操作。而io_uring強大的地方是，進程不需要再自己主動執行讀操作，而是內核讀完后通知進程，相比epoll，io_uring又進了一步，類似的能力是windows的IOCP。
2 io_uring基本使用
2.1 初始化
io_uring和epoll一樣，API不多，但是io_uring比epoll復雜得多。我們首先需要調用io_uring_setup初始化io_uring，拿到一個fd。
- int ring_fd;
- unsigned *sring_tail, *sring_mask, *sring_array, *cring_head, *cring_tail, *cring_mask;
- struct io_uring_sqe *sqes;
- struct io_uring_cqe *cqes;
- char buff[BLOCK_SZ];
- off_t offset;
- struct io_uring_params p;
- void *sq_ptr, *cq_ptr;
- memset(&p, 0, sizeof(p));
- // 拿到io_uring對應的fd
- int ring_fd = io_uring_setup(QUEUE_DEPTH, &p);
- 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);
- // 映射ring_fd到mmap返回的地址，我們可以以操作返回地址的方式操作ring_fd，達到用戶和內核共享數據的目的
- cq_ptr = sq_ptr = mmap(0, sring_sz, PROT_READ | PROT_WRITE,
- MAP_SHARED | MAP_POPULATE,
- ring_fd, IORING_OFF_SQ_RING);
- sqes = mmap(0, p.sq_entries * sizeof(struct io_uring_sqe),
- PROT_READ | PROT_WRITE, MAP_SHARED | MAP_POPULATE,
- ring_fd, IORING_OFF_SQES);
- // 保存任務隊列和完成隊列的地址，后續提交任務和獲取完成任務節點時需要用
- sring_tail = sq_ptr + p.sq_off.tail;
- sring_mask = sq_ptr + p.sq_off.ring_mask;
- sring_array = sq_ptr + p.sq_off.array;
- cring_head = cq_ptr + p.cq_off.head;
- cring_tail = cq_ptr + p.cq_off.tail;
- cring_mask = cq_ptr + p.cq_off.ring_mask;
- cqes = cq_ptr + p.cq_off.cqes;
io_uring不僅實現非常復雜，就連使用也非常復雜，但是目前只需要大致了解原理就好了。上面的代碼主要目的有以下幾個。
1 出生后io_uring并拿到一個io_uring實例對應的fd。
2 通過mmap映射io_uring對應的fd到一個內存地址，后續我們就可以通過操作內存地址的方式和內核通信。
3 保存任務隊列和完成隊列的地址信息，后續需要用到。
2.2 提交任務
我們看到io_uring底層維護了任務隊列(sq)和完成隊列兩個隊列(cq)。對應的節點叫sqe和cqe。當我們需要操作一個資源的時候，就可以獲取一個seq，并且填充字段，然后提交給內核，我們看一下sqe的核心字段。
- struct io_uring_sqe {
- __u8 opcode; /* 操作類型，比如讀、寫 */
- __s32 fd; /* 資源對應的fd */
- __u64 off; /* 資源的偏移（操作的起點） */
- __u64 addr; /* 保存數據的內存首地址 */
- __u32 len; /* 數據長度 */
- __u64 user_data; /* 用戶定義的字段，通常用于關聯請求和響應 */
- __u8 flags; /* 標記 */
- ...
- };
io_uring_sqe的核心字段都比較好理解，構造了一個請求后，就插入到內核的請求任務隊列。接著調用io_uring_enter通知內核，有需要處理的任務，我們可以在調用io_uring_enter的時候設置等待多少個請求完成后再返回。另外內核處理poll的模式，這時候內核會開啟內核線程去檢測任務是否完成，不需要進程調用io_uring_enter。下面是我們發送一個讀取請求的邏輯。
- unsigned index, tail;
- tail = *sring_tail;
- // 拿到請求隊列的一個空閑位置，是一個環，需要做回環處理
- index = tail & *sring_mask;
- struct io_uring_sqe *sqe = &sqes[index];
- // 初始化請求結構體
- sqe->opcode = op;
- // 讀取的fd
- sqe->fd = fd;
- // 讀取的數據保存到buff
- // 可以通過關聯buff，等到響應的時候能找到對應的請求上下文
- sqe->addr = (unsigned long) buff;
- sqe->user_data = (unsigned long long) buff;
- memset(buff, 0, sizeof(buff));
- sqe->len = BLOCK_SZ;
- sqe->off = offset;
- // 插入請求隊列
- sring_array[index] = index;
- // 更新索引
- tail++;
- // 通知內核有任務需要處理，并等待有一個任務完成后再返回
- io_uring_smp_store_release(sring_tail, tail);
- int ret = io_uring_enter(ring_fd, 1,1, IORING_ENTER_GETEVENTS);
2.3 任務完成
當任務完成的時候，io_uring_enter就會返回。但是這里有個問題，請求任務和響應不是對應的，內核不保證任務完成的順序，內核只是告訴我們哪些任務完成了，我們可以通過user_data關聯請求和響應，類似rpc通信里的seq一樣。user_data字段在請求里設置，響應里會返回，從而請求方知道這個響應對應的是哪個請求。響應對應的結構體比較簡單。
- struct io_uring_cqe {
- /* 用戶定義字段，通常用于關聯請求和響應 */
- __u64 user_data;
- /* 系統調用的返回碼，比如read */
- __s32 res;
- // 暫時沒用到
- __u32 flags;
- };
我們這里假設請求和響應是串行的，所以不需要用到user_data字段關聯請求和響應。從前面代碼我們可以看到，我們把數據讀取到buff變量里。我們看看內核返回后我們的處理邏輯。
- struct io_uring_cqe *cqe;
- unsigned head, reaped = 0;
- // 拿到完成隊列隊頭節點，可消費buff里面存儲的數據
- head = io_uring_smp_load_acquire(cring_head);
- cqe = &cqes[head & (*cring_mask)];
- // 更新頭索引
- head++;
- io_uring_smp_store_release(cring_head, head);
這就是io_uring一個讀取操作的大致過程，我們看到用戶層面的邏輯還是挺復雜的，作者也想到了，所以又封裝了Liburing庫簡化使用。
3 Liburing的使用
那么我們到底怎么使用它呢，我們回想epoll的使用。
- // 創建epoll 實例
- int epollfd = epoll_create();
- // 封裝fd和訂閱事件
- struct epoll_event event;
- event.events = EPOLLIN;
- event.data.fd = listenFd;
- // 注冊到epoll
- epoll_ctl(epollfd, EPOLL_CTL_ADD, listenFd, &event);
- // 等待事件觸發
- int num = epoll_wait(epollfd, events, MAX_EVENTS, -1);
- for (i = 0; i < num; ++i) {
- // 處理事件，比如讀寫
- }
接著我們看看基于Liburing的o_uring的使用。
- // 拿到一個請求結構體
- struct io_uring_sqe *sqe = io_uring_get_sqe(ring);
- // 設置fd和數據地址
- io_uring_prep_recv(sqe, fd, data, len, 0);
- // 通知內核有任務處理
- io_uring_submit(&ring);
- // 等待事件完成
- io_uring_submit_and_wait(&ring, 1);
- // 獲取完成的任務
- int nums = io_uring_peek_batch_cqe(&ring, cqes, sizeof(cqes) / sizeof(cqes[0]));
- for (i = 0; i < nums; ++i) {
- // 處理完成的任務
- struct io_uring_cqe *cqe = cqes[i];
- }
我們看到基于Liburing的使用簡單了很多，有點epoll的風格了。io_uring就介紹到這里，io_uring的細節比較多，實現也比較復雜，代碼量也達到了近1萬行(epoll是2500左右)，關于io_uring網上有非常多講解得非常好的文章，大家可以自行閱讀。
4 Node.js中的io_uring
最后介紹一下之前看到的一個Node.js的pr(https://github.com/libuv/libuv/pull/2322)，這個pr引入了io_uring。雖然不是取代epoll對Libuv的核心進行重構，但是依然值得探討。該pr涉及了150+文件，不過大部分是Liburing的代碼，我們只關注核心改動。首先Libuv初始化的時候做了一個處理。
- // loop里做了修改
- struct loop {
- ...
- // int backend_fd; 改成下面的聯合體
- union {
- int fd;
- void* data;
- } backend;
- }
- // 定義一個使用io_uring時的結構體
- struct uv__backend_data_io_uring {
- // io_uring的fd
- int fd;
- // 等待io_uring處理的任務個數
- int32_t pending;
- // io_uring相關結構體
- struct io_uring ring;
- // 用于epoll中監聽io_uring是否有事件觸發
- uv_poll_t poll_handle;
- };
- // 分配一個uv__backend_data_io_uring結構體
- backend_data = uv__malloc(sizeof(*backend_data));
- ring = &backend_data->ring;
- // 初始化io_uring
- rc = io_uring_queue_init(IOURING_SQ_SIZE, ring, 0);
- // epoll的fd
- backend_data->fd = fd;
- // 初始化
- uv__handle_init(loop, &backend_data->poll_handle, UV_POLL);
- backend_data->poll_handle.flags |= UV_HANDLE_INTERNAL;
- // 初始化poll_handle的io觀察者，fd是io_uring的fd，回調是uv__io_uring_done。
- uv__io_init(&backend_data->poll_handle.io_watcher,
- uv__io_uring_done,
- ring->ring_fd);
- loop->flags |= UV_LOOP_USE_IOURING;
- loop->backend.data = backend_data;
我們看到初始化時對io_uring進行了初始化并且初始化了一個io觀察者。接下來我們看在哪里使用。
- int uv_fs_read(uv_loop_t* loop, uv_fs_t* req,
- uv_file file,
- const uv_buf_t bufs[],
- unsigned int nbufs,
- int64_t off,
- uv_fs_cb cb) {
- int rc;
- INIT(READ);
- req->file = file;
- req->nbufs = nbufs;
- req->bufs = req->bufsml;
- memcpy(req->bufs, bufs, nbufs * sizeof(*bufs));
- req->off = off;
- /*
- 優先調用uv__platform_fs_read，不支持則降級到原來線程池的方案
- static int uv__fs_retry_with_threadpool(int rc) {
- return rc == UV_ENOSYS || rc == UV_ENOTSUP || rc == UV_ENOMEM;
- }
- */
- rc = uv__platform_fs_read(loop, req, file, bufs, nbufs, off, cb);
- if (!uv__fs_retry_with_threadpool(rc))
- return rc;
- // 走到這說明使用降級方案
- POST;
- }
uv_fs_read函數是讀取文件內容時執行的函數，之前時候給線程池提交一個任務，修改后，加了個前置的邏輯uvplatform_fs_read。我們看看uvplatform_fs_read。
- int uv__platform_fs_read(uv_loop_t* loop,
- uv_fs_t* req,
- uv_os_fd_t file,
- const uv_buf_t bufs[],
- unsigned int nbufs,
- int64_t off,
- uv_fs_cb cb) {
- return uv__io_uring_fs_work(IORING_OP_READV,
- loop,
- req,
- file,
- bufs,
- nbufs,
- off,
- cb);}int uv__io_uring_fs_work(uint8_t opcode,
- uv_loop_t* loop,
- uv_fs_t* req,
- uv_os_fd_t file,
- const uv_buf_t bufs[],
- unsigned int nbufs,
- int64_t off,
- uv_fs_cb cb) {
- struct uv__backend_data_io_uring* backend_data;
- struct io_uring_sqe* sqe;
- int submitted;
- uint32_t incr_val;
- uv_poll_t* handle;
- backend_data = loop->backend.data;
- incr_val = (uint32_t)backend_data->pending + 1;
- // 獲取一個請求結構體
- sqe = io_uring_get_sqe(&backend_data->ring);
- // 初始化請求
- sqe->opcode = opcode;
- sqe->fd = file;
- sqe->off = off;
- sqe->addr = (uint64_t)req->bufs;
- sqe->len = nbufs;
- // 管理req上下文，任務完成時會用到
- sqe->user_data = (uint64_t)req;
- // 提交給內核，非阻塞式調用，返回提交任務的個數
- submitted = io_uring_submit(&backend_data->ring);
- // 提交成功
- if (submitted == 1) {
- req->priv.fs_req_engine |= UV__ENGINE_IOURING;
- // 提交的時是第一個任務，則注冊io觀察者的等待可讀事件
- if (backend_data->pending++ == 0) {
- handle = &backend_data->poll_handle;
- uv__io_start(loop, &handle->io_watcher, POLLIN);
- uv__handle_start(handle);
- }
- return 0;
- }
- return UV__ERR(errno);
- }
我們看到上面的代碼會給內核提交一個任務，但是不會等待內核返回，并在提交第一個任務的時候給epoll注冊一個等待可讀事件。我們看看io_uring的poll接口的實現(epoll原理可參考之前的文章)。
- static __poll_t io_uring_poll(struct file *file, poll_table *wait){
- struct io_ring_ctx *ctx = file->private_data;
- __poll_t mask = 0;
- poll_wait(file, &ctx->cq_wait, wait);
- smp_rmb();
- // 提交隊列沒滿則可寫
- if (READ_ONCE(ctx->rings->sq.tail) - ctx->cached_sq_head !=
- ctx->rings->sq_ring_entries)
- mask |= EPOLLOUT | EPOLLWRNORM;
- // 完成隊列非空則可讀
- if (io_cqring_events(ctx, false))
- mask |= EPOLLIN | EPOLLRDNORM;
- return mask;}static unsigned io_cqring_events(struct io_ring_ctx *ctx, bool noflush){
- struct io_rings *rings = ctx->rings;
- smp_rmb();
- // 完成隊列非空則可讀
- return ctx->cached_cq_tail - READ_ONCE(rings->cq.head);
- }
所以當io_uring有任務完成，即完成隊列非空的時候，就會在Libuv的poll io被檢測到，從而執行回調。
- void uv__io_uring_done(uv_loop_t* loop, uv__io_t* w, unsigned int events) {
- uv_poll_t* handle;
- struct io_uring* ring;
- struct uv__backend_data_io_uring* backend_data;
- struct io_uring_cqe* cqe;
- uv_fs_t* req;
- int finished1;
- handle = container_of(w, uv_poll_t, io_watcher);
- backend_data = loop->backend.data;
- ring = &backend_data->ring;
- finished1 = 0;
- while (1) {
- // 獲取完成節點
- io_uring_peek_cqe(ring, &cqe);
- // 全部任務完成則注銷事件
- if (--backend_data->pending == 0)
- uv_poll_stop(handle);
- // 獲取響應對應的請求上下文
- req = (void*) (uintptr_t) cqe->user_data;
- if (req->result == 0)
- req->result = cqe->res;
- io_uring_cq_advance(ring, 1);
- // 執行回調
- req->cb(req);
- }
- }
至此我們看到了這個pr的邏輯，主要是為文件io引入了io_uring，文件io因為兼容性問題，在Libuv中使用線程池實現的，而io_uring支持普通文件，自然可以用于在Linux新版本上替換掉線程池方案。
后記：io_uring既強大又復雜。一切都交給內核來處理，完成后通知我們，我們不僅不需要再手動執行read，同時也減少了系統調用的成本，尤其需要多次read的時候。看起來是一個很棒的事情，io_uring---Linux上真正的異步IO。但其中所蘊含的知識遠不止于此，有空再更。
