Port to Rustix 1.0.

Author: jordanisaacs

Cargo.lock

@@ -1,12 +1,12 @@
 [package]
-name = "io-uring"
-version = "0.7.4"
-authors = ["quininer <quininer@live.com>"]
+name = "rustix-uring"
+version = "0.3.0"
+authors = ["Jordan Isaacs <mail@jdisaacs.com>"]
 edition = "2021"
 license = "MIT OR Apache-2.0"
-repository = "https://github.com/tokio-rs/io-uring"
-homepage = "https://github.com/tokio-rs/io-uring"
-documentation = "https://docs.rs/io-uring"
+repository = "https://github.com/jordanisaacs/rustix-uring"
+homepage = "https://github.com/jordanisaacs/rustix-uring"
+documentation = "https://docs.rs/rustix-uring"
 description = "The low-level `io_uring` userspace interface for Rust"
 categories = [ "asynchronous", "network-programming", "filesystem" ]
 rust-version = "1.63"
@@ -23,7 +23,7 @@ std = ["rustix/std", "bitflags/std"]
 
 [dependencies]
 bitflags = { version = "2.4.0", default-features = false }
-rustix = { version = "0.38.32", default-features = false, features = ["io_uring", "mm"] }
+rustix = { version = "1.0.2", default-features = false, features = ["io_uring", "mm", "thread"] }
 
 [dev-dependencies]
 libc = "0.2.98"

Cargo.toml

@@ -20,14 +20,14 @@ To use `io-uring` crate, first add this to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-io-uring = "0.6"
+rustix-uring = "0.1"
 ```
 
 Next we can start using `io-uring` crate.
 The following is quick introduction using `Read` for file.
 
 ```rust
-use io_uring::{opcode, types, IoUring};
+use rustix_uring::{opcode, types, IoUring};
 use std::os::unix::io::AsRawFd;
 use std::{fs, io};
 
@@ -53,7 +53,7 @@ fn main() -> io::Result<()> {
 
     let cqe = ring.completion().next().expect("completion queue is empty");
 
-    assert_eq!(cqe.user_data(), 0x42);
+    assert_eq!(cqe.user_data().u64_(), 0x42);
     assert!(cqe.result() >= 0, "read error: {}", cqe.result());
 
     Ok(())

README.md

@@ -1,4 +1,4 @@
-use io_uring::{opcode, types, IoUring};
+use rustix_uring::{opcode, types, IoUring};
 use std::os::unix::io::AsRawFd;
 use std::{fs, io};
 
@@ -24,7 +24,7 @@ fn main() -> io::Result<()> {
 
     let cqe = ring.completion().next().expect("completion queue is empty");
 
-    assert_eq!(cqe.user_data(), 0x42);
+    assert_eq!(cqe.user_data().u64_(), 0x42);
     assert!(cqe.result() >= 0, "read error: {}", cqe.result());
 
     Ok(())

examples/readme.rs

@@ -3,7 +3,7 @@ use std::net::TcpListener;
 use std::os::unix::io::{AsRawFd, RawFd};
 use std::{io, ptr};
 
-use io_uring::{opcode, squeue, types, Errno, IoUring, SubmissionQueue};
+use rustix_uring::{opcode, squeue, types, Errno, IoUring, SubmissionQueue};
 use slab::Slab;
 
 #[derive(Clone, Debug)]
@@ -34,7 +34,7 @@ impl AcceptCount {
         AcceptCount {
             entry: opcode::Accept::new(types::Fd(fd), ptr::null_mut(), ptr::null_mut())
                 .build()
-                .user_data(token as _),
+                .user_data(token as u64),
             count,
         }
     }
@@ -101,7 +101,7 @@ fn main() -> anyhow::Result<()> {
 
         for cqe in &mut cq {
             let ret = cqe.result();
-            let token_index = cqe.user_data() as usize;
+            let token_index = cqe.user_data().u64_() as usize;
 
             if ret < 0 {
                 eprintln!(
@@ -124,7 +124,7 @@ fn main() -> anyhow::Result<()> {
 
                     let poll_e = opcode::PollAdd::new(types::Fd(fd), libc::POLLIN as _)
                         .build()
-                        .user_data(poll_token as _);
+                        .user_data(poll_token as u64);
 
                     unsafe {
                         if sq.push(&poll_e).is_err() {
@@ -147,7 +147,7 @@ fn main() -> anyhow::Result<()> {
 
                     let read_e = opcode::Recv::new(types::Fd(fd), buf.as_mut_ptr(), buf.len() as _)
                         .build()
-                        .user_data(token_index as _);
+                        .user_data(token_index as u64);
 
                     unsafe {
                         if sq.push(&read_e).is_err() {
@@ -178,7 +178,7 @@ fn main() -> anyhow::Result<()> {
 
                         let write_e = opcode::Send::new(types::Fd(fd), buf.as_ptr(), len as _)
                             .build()
-                            .user_data(token_index as _);
+                            .user_data(token_index as u64);
 
                         unsafe {
                             if sq.push(&write_e).is_err() {
@@ -202,7 +202,7 @@ fn main() -> anyhow::Result<()> {
 
                         opcode::PollAdd::new(types::Fd(fd), libc::POLLIN as _)
                             .build()
-                            .user_data(token_index as _)
+                            .user_data(token_index as u64)
                     } else {
                         let offset = offset + write_len;
                         let len = len - offset;
@@ -218,7 +218,7 @@ fn main() -> anyhow::Result<()> {
 
                         opcode::Write::new(types::Fd(fd), buf.as_ptr(), len as _)
                             .build()
-                            .user_data(token_index as _)
+                            .user_data(token_index as u64)
                     };
 
                     unsafe {

examples/tcp_echo.rs

@@ -1,14 +1,14 @@
 [package]
 name = "io-uring-bench"
 version = "0.1.0"
-authors = ["quininer <quininer@live.com>"]
+authors = ["Jordan Isaacs <mail@jdisaacs.com>"]
 edition = "2021"
 publish = false
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-io-uring = { path = ".." }
+io-uring = { path = "..", package = "rustix-uring" }
 criterion = "0.5"
 tempfile = "3"
 

io-uring-bench/Cargo.toml

@@ -1,16 +1,16 @@
 [package]
 name = "io-uring-test"
 version = "0.1.0"
-authors = ["quininer <quininer@live.com>"]
+authors = ["Jordan Isaacs <mail@jdisaacs.com>"]
 edition = "2021"
 publish = false
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-io-uring = { path = ".." }
+io-uring = { path = "..", package = "rustix-uring" }
 libc = { version = "0.2", features = [ "extra_traits" ] }
-rustix = { version = "0.38.0", features = ["fs"] }
+rustix = { version = "1.0.2", features = ["fs"] }
 anyhow = "1"
 tempfile = "3"
 once_cell = "1"

io-uring-test/Cargo.toml

@@ -49,10 +49,10 @@ fn test<S: squeue::EntryMarker, C: cqueue::EntryMarker>(
     println!(
         "ring type: IoUring<{}, {}>",
         std::any::type_name::<S>()
-            .strip_prefix("io_uring::")
+            .strip_prefix("rustix_uring::")
             .unwrap(),
         std::any::type_name::<C>()
-            .strip_prefix("io_uring::")
+            .strip_prefix("rustix_uring::")
             .unwrap(),
     );
     println!("params: {:#?}", ring.params());
@@ -133,16 +133,14 @@ fn test<S: squeue::EntryMarker, C: cqueue::EntryMarker>(
     tests::net::test_tcp_buffer_select(&mut ring, &test)?;
     tests::net::test_tcp_buffer_select_recvmsg(&mut ring, &test)?;
     tests::net::test_tcp_buffer_select_readv(&mut ring, &test)?;
-    // FIXME: This test hangs on upstream.
-    //tests::net::test_tcp_recv_multi(&mut ring, &test)?;
+    tests::net::test_tcp_recv_multi(&mut ring, &test)?;
     tests::net::test_tcp_recv_bundle(&mut ring, &test)?;
     tests::net::test_tcp_recv_multi_bundle(&mut ring, &test)?;
 
     tests::net::test_tcp_shutdown(&mut ring, &test)?;
     tests::net::test_socket(&mut ring, &test)?;
     tests::net::test_udp_recvmsg_multishot(&mut ring, &test)?;
-    // FIXME: This test fails on upstream.
-    //tests::net::test_udp_recvmsg_multishot_trunc(&mut ring, &test)?;
+    tests::net::test_udp_recvmsg_multishot_trunc(&mut ring, &test)?;
     tests::net::test_udp_send_with_dest(&mut ring, &test)?;
     tests::net::test_udp_sendzc_with_dest(&mut ring, &test)?;
 

io-uring-test/src/main.rs

@@ -39,12 +39,12 @@ pub fn test_async_cancel_user_data<S: squeue::EntryMarker, C: cqueue::EntryMarke
     ring.submit_and_wait(entries.len())?;
 
     let mut cqes: Vec<cqueue::Entry> = ring.completion().map(Into::into).collect();
-    cqes.sort_unstable_by_key(cqueue::Entry::user_data);
+    cqes.sort_unstable_by_key(cqueue::Entry::user_data_u64);
 
     assert_eq!(cqes.len(), entries.len());
 
-    assert_eq!(cqes[0].user_data(), 2003);
-    assert_eq!(cqes[1].user_data(), 2004);
+    assert_eq!(cqes[0].user_data().u64_(), 2003);
+    assert_eq!(cqes[1].user_data().u64_(), 2004);
 
     assert_eq!(cqes[0].result(), -libc::ECANCELED); // -ECANCELED
     assert_eq!(cqes[1].result(), 0); // the number of requests cancelled
@@ -92,9 +92,9 @@ pub fn test_async_cancel_user_data_all<S: squeue::EntryMarker, C: cqueue::EntryM
 
     assert_eq!(cqes.len(), entries.len());
 
-    assert_eq!(cqes[0].user_data(), 2003);
-    assert_eq!(cqes[1].user_data(), 2003);
-    assert_eq!(cqes[2].user_data(), 2004);
+    assert_eq!(cqes[0].user_data().u64_(), 2003);
+    assert_eq!(cqes[1].user_data().u64_(), 2003);
+    assert_eq!(cqes[2].user_data().u64_(), 2004);
 
     assert_eq!(cqes[0].result(), -libc::ECANCELED); // -ECANCELED
     assert_eq!(cqes[1].result(), -libc::ECANCELED); // -ECANCELED
@@ -143,9 +143,9 @@ pub fn test_async_cancel_any<S: squeue::EntryMarker, C: cqueue::EntryMarker>(
 
     assert_eq!(cqes.len(), entries.len());
 
-    assert_eq!(cqes[0].user_data(), 2003);
-    assert_eq!(cqes[1].user_data(), 2004);
-    assert_eq!(cqes[2].user_data(), 2005);
+    assert_eq!(cqes[0].user_data().u64_(), 2003);
+    assert_eq!(cqes[1].user_data().u64_(), 2004);
+    assert_eq!(cqes[2].user_data().u64_(), 2005);
 
     assert_eq!(cqes[0].result(), -libc::ECANCELED); // -ECANCELED
     assert_eq!(cqes[1].result(), -libc::ECANCELED);
@@ -193,8 +193,8 @@ pub fn test_async_cancel_fd<S: squeue::EntryMarker, C: cqueue::EntryMarker>(
 
     assert_eq!(cqes.len(), entries.len());
 
-    assert_eq!(cqes[0].user_data(), 2003);
-    assert_eq!(cqes[1].user_data(), 2004);
+    assert_eq!(cqes[0].user_data().u64_(), 2003);
+    assert_eq!(cqes[1].user_data().u64_(), 2004);
 
     assert_eq!(cqes[0].result(), -libc::ECANCELED); // -ECANCELED
     assert_eq!(cqes[1].result(), 0);
@@ -243,9 +243,9 @@ pub fn test_async_cancel_fd_all<S: squeue::EntryMarker, C: cqueue::EntryMarker>(
 
     assert_eq!(cqes.len(), entries.len());
 
-    assert_eq!(cqes[0].user_data(), 2003);
-    assert_eq!(cqes[1].user_data(), 2004);
-    assert_eq!(cqes[2].user_data(), 2005);
+    assert_eq!(cqes[0].user_data().u64_(), 2003);
+    assert_eq!(cqes[1].user_data().u64_(), 2004);
+    assert_eq!(cqes[2].user_data().u64_(), 2005);
 
     assert_eq!(cqes[0].result(), -libc::ECANCELED); // -ECANCELED
     assert_eq!(cqes[1].result(), -libc::ECANCELED);