Need help with io-uring?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

tokio-rs
601 Stars 50 Forks Other 219 Commits 7 Opened issues

Description

The `io_uring` library for Rust

Services available

!
?

Need anything else?

Contributors list

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.5"

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

  • Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
  • MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

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.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.