#io #file-io #userspace #linux-kernel #low-level #uring #queue

io-uring

The low-level io_uring userspace interface for Rust

37 releases

0.7.1 Oct 17, 2024
0.6.4 Apr 21, 2024
0.6.3 Jan 31, 2024
0.6.2 Sep 17, 2023
0.2.0 Jun 5, 2019

#63 in Asynchronous

Download history 15058/week @ 2024-08-04 18255/week @ 2024-08-11 16621/week @ 2024-08-18 18576/week @ 2024-08-25 18198/week @ 2024-09-01 15137/week @ 2024-09-08 15139/week @ 2024-09-15 18576/week @ 2024-09-22 17470/week @ 2024-09-29 21649/week @ 2024-10-06 26984/week @ 2024-10-13 27428/week @ 2024-10-20 26124/week @ 2024-10-27 26585/week @ 2024-11-03 31574/week @ 2024-11-10 27732/week @ 2024-11-17

113,370 downloads per month
Used in 116 crates (48 directly)

MIT/Apache

355KB
9K SLoC

Linux IO Uring

github actions crates license license docs.rs

The low-level io_uring userspace interface for Rust.

Usage

To use io-uring crate, first add this to your Cargo.toml:

[dependencies]
io-uring = "0.6"

Next we can start using io-uring crate. The following is quick introduction using Read for file.

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(())
}

Note that opcode Read is only available after kernel 5.6. If you use a kernel lower than 5.6, this example will fail.

Test and Benchmarks

You can run the test and benchmark of the library with the following commands.

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

License

This project is licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in io-uring by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~77–330KB