Linux IO Uring

Rust 的底层 io_uring 用户空间接口。

用法

要使用 io-uring crate，首先将以下内容添加到您的 Cargo.toml

[dependencies]
io-uring = "0.6"

接下来我们可以开始使用 io-uring crate。以下是一个使用 Read 读取文件的快速介绍。

use io_uring::{opcode, types, IoUring};
use std::os::unix::io::AsRawFd;
use std::{fs, io};

fn main() -> io::Result<()> {
    let mut ring = IoUring::new(8)?;

    let fd = fs::File::open("README.md")?;
    let mut buf = vec![0; 1024];

    let read_e = opcode::Read::new(types::Fd(fd.as_raw_fd()), buf.as_mut_ptr(), buf.len() as _)
        .build()
        .user_data(0x42);

    // Note that the developer needs to ensure
    // that the entry pushed into submission queue is valid (e.g. fd, buffer).
    unsafe {
        ring.submission()
            .push(&read_e)
            .expect("submission queue is full");
    }

    ring.submit_and_wait(1)?;

    let cqe = ring.completion().next().expect("completion queue is empty");

    assert_eq!(cqe.user_data(), 0x42);
    assert!(cqe.result() >= 0, "read error: {}", cqe.result());

    Ok(())
}

请注意，opcode Read 只在内核 5.6 及以上版本中可用。如果您使用的是低于 5.6 的内核，此示例将失败。

测试和基准测试

您可以使用以下命令运行库的测试和基准测试。

$ cargo run --package io-uring-test
$ cargo bench --package io-uring-bench

许可证

本项目许可协议为以下之一

• Apache 许可证 2.0 版本，(LICENSE-APACHE 或 http://www.apache.org/licenses/LICENSE-2.0)
• MIT 许可证 (LICENSE-MIT 或 http://opensource.org/licenses/MIT)

任选其一。

贡献

除非您明确声明，否则根据 Apache-2.0 许可证定义的，您提交给 io-uring 的任何贡献都将按上述方式双重许可，不附加任何额外条款或条件。