Rewrite internals

.github/workflows/ci.yaml

@@ -13,17 +13,18 @@ permissions:
 
 jobs:
   Test:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     timeout-minutes: 5
+    if: false # Enable once Rust 1.85 is released.
     steps:
     - uses: actions/checkout@v4
-    - uses: dtolnay/rust-toolchain@stable
+    - uses: dtolnay/rust-toolchain@1.85
     - name: Run Tests
       run: cargo test
     - name: Run Tests (release build)
       run: cargo test --release
   Nightly:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     timeout-minutes: 5
     steps:
     - uses: actions/checkout@v4
@@ -37,7 +38,7 @@ jobs:
     - name: Run Tests (nightly feature, release build)
       run: cargo test --features nightly --release
   Clippy:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     timeout-minutes: 5
     steps:
     - uses: actions/checkout@v4
@@ -47,15 +48,15 @@ jobs:
     - name: Run Clippy
       run: make clippy
   Docs:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     timeout-minutes: 5
     steps:
     - uses: actions/checkout@v4
     - uses: dtolnay/rust-toolchain@nightly
     - name: Check docs
       run: RUSTDOCFLAGS="-D warnings" cargo doc --no-deps
   Rustfmt:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     timeout-minutes: 5
     steps:
     - uses: actions/checkout@v4
@@ -65,7 +66,7 @@ jobs:
     - name: Check formatting
       run: cargo fmt --all -- --check
   Sanitizer:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     timeout-minutes: 5
     strategy:
       fail-fast: false

CHANGELOG.md

@@ -1,3 +1,19 @@
+# v0.3.0 (unreleased)
+
+* Complete rewrite of the internals in an attempt to make it easier to port.
+* The methods on `Config` are now implementation specific.
+* Removed the `AsFd` implementation for `Ring` as that might not always be
+  possible to provide.
+* The `net::SocketAddress` is now implemented for the socket address types for
+  in the standard library, not in libc.
+* `net::Connect` no longer implements `Extract` as all socket address types in
+  the library are `Copy`.
+* The `BufSlice` and `BufMutSlice` types now use `IoSlice` and `IoMutSlice` as
+  wrapper around `libc::iovec`.
+* The `msg` module now uses the `MsgData` type as type for message data, instead
+  of `u32` (though `MsgData` is also `u32`).
+* `process::ReceiveSignals` is now a proper `AsyncIter`.
+
 # v0.2.2
 
 * Fix possible overflow in ReadBuf::release

Cargo.toml

@@ -1,7 +1,8 @@
 [package]
 name          = "a10"
 description   = "A10 is an io_uring library."
-version       = "0.2.2"
+version       = "0.3.0"
+publish       = false # In development.
 authors       = ["Thomas de Zeeuw <[email protected]>"]
 license       = "MIT"
 documentation = "https://docs.rs/a10"
@@ -11,6 +12,7 @@ keywords      = ["io_uring", "io", "async", "non-blocking"]
 categories    = ["asynchronous"]
 include       = ["/Cargo.toml", "/src/**/*.rs", "/tests/**/*.rs", "/README.md", "/LICENSE"]
 edition       = "2021"
+rust-version  = "1.85"
 
 [features]
 default = []
@@ -25,6 +27,7 @@ log          = { version = "0.4.21",  default-features = false, features = ["kv_
 
 [dev-dependencies]
 std-logger   = { version = "0.5.3", default-features = false }
+getrandom    = { version = "0.2.15", default-features = false }
 
 [[test]]
 name    = "signals"

LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2021-2024 Thomas de Zeeuw
+Copyright (C) 2021-2025 Thomas de Zeeuw
 
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of

Makefile

@@ -27,16 +27,15 @@ check:
 # Disabled lints:
 # * `doc-markdown`: has some annoying false positives.
 # * `equatable-if-let`: strongly disagree with this lint.
+# * `missing-const-for-fn`: has false positives.
 # * `missing-errors-doc`, `missing-panics-doc`: not worth it.
 # * `must-use-candidate`: too many bad suggestions.
 # * `needless-lifetimes`: lifetimes are additional docs.
 # * `option-if-let-else`: don't want to introduce more closures.
 # * `redundant-pub-crate`: useless lint.
 # * `single-match-else`: prefer match statements over if statements.
 # * `use-self`: strongly disagree.
-# TODO: resolve `cast-possible-truncation` errors.
-# TODO: resolve `manual-c-str-listerals`, `ref-as-ptr` and `inspect_err` once
-# the related features are a little older (1.77, 1.76 and 1.75).
+# TODO: resolve the lints after the empty line.
 lint: clippy
 clippy:
 	cargo clippy --all-features --workspace -- \
@@ -50,24 +49,23 @@ clippy:
 		--deny clippy::cargo \
 		--allow clippy::doc-markdown \
 		--allow clippy::equatable-if-let \
-		--allow clippy::manual-c-str-literals \
+		--allow clippy::missing-const-for-fn \
 		--allow clippy::missing-errors-doc \
 		--allow clippy::missing-panics-doc \
 		--allow clippy::must-use-candidate \
 		--allow clippy::needless-lifetimes \
 		--allow clippy::new-without-default \
 		--allow clippy::option-if-let-else \
 		--allow clippy::redundant-pub-crate \
-		--allow clippy::ref-as-ptr \
 		--allow clippy::single-match-else \
 		--allow clippy::use-self \
-		--allow clippy::manual-inspect \
 		\
 		--allow clippy::cast-possible-truncation \
 		--allow clippy::cast-possible-wrap \
+		--allow clippy::cast-sign-loss \
 
 doc:
-	cargo doc
+	cargo doc --all-features
 
 doc_private:
 	cargo doc --document-private-items

examples/http_client.rs

@@ -1,5 +1,5 @@
-use std::net::{SocketAddr, SocketAddrV4};
-use std::{env, io, mem, str};
+use std::net::SocketAddr;
+use std::{env, io, str};
 
 use a10::net::socket;
 use a10::{AsyncFd, Ring, SubmissionQueue};
@@ -22,13 +22,8 @@ fn main() -> io::Result<()> {
 
     // Get an IPv4 address for the domain (using blocking I/O).
     let address = std::net::ToSocketAddrs::to_socket_addrs(&addr_host)?
-        .filter(SocketAddr::is_ipv4)
         .next()
         .ok_or_else(|| io::Error::new(io::ErrorKind::Other, "failed to lookup ip"))?;
-    let address = match address {
-        SocketAddr::V4(address) => address,
-        SocketAddr::V6(_) => unreachable!(),
-    };
 
     // Create our future that makes the request.
     let request_future = request(ring.submission_queue().clone(), &host, address);
@@ -50,7 +45,7 @@ fn main() -> io::Result<()> {
 }
 
 /// Make a HTTP GET request to `address`.
-async fn request(sq: SubmissionQueue, host: &str, address: SocketAddrV4) -> io::Result<Vec<u8>> {
+async fn request(sq: SubmissionQueue, host: &str, address: SocketAddr) -> io::Result<Vec<u8>> {
     // Create a new TCP, IPv4 socket.
     let domain = libc::AF_INET;
     let r#type = libc::SOCK_STREAM | libc::SOCK_CLOEXEC;
@@ -59,14 +54,13 @@ async fn request(sq: SubmissionQueue, host: &str, address: SocketAddrV4) -> io::
     let socket: AsyncFd = socket(sq, domain, r#type, protocol, flags).await?;
 
     // Connect.
-    let addr = to_sockaddr_storage(address);
-    socket.connect(addr).await?;
+    socket.connect(address).await?;
 
     // Send a HTTP GET / request to the socket.
     let host = host.split_once(':').map(|(h, _)| h).unwrap_or(host);
     let version = env!("CARGO_PKG_VERSION");
     let request = format!("GET / HTTP/1.1\r\nHost: {host}\r\nUser-Agent: A10-example/{version}\r\nAccept: */*\r\n\r\n");
-    socket.send(request, 0).await?;
+    socket.send_all(request, 0).await?;
 
     // Receiving the response.
     let recv_buf = socket.recv(Vec::with_capacity(8192), 0).await?;
@@ -77,14 +71,3 @@ async fn request(sq: SubmissionQueue, host: &str, address: SocketAddrV4) -> io::
 
     Ok(recv_buf)
 }
-
-fn to_sockaddr_storage(addr: SocketAddrV4) -> libc::sockaddr_in {
-    // SAFETY: a `sockaddr_in` of all zeros is valid.
-    let mut storage: libc::sockaddr_in = unsafe { mem::zeroed() };
-    storage.sin_family = libc::AF_INET as _;
-    storage.sin_port = addr.port().to_be();
-    storage.sin_addr = libc::in_addr {
-        s_addr: u32::from_ne_bytes(addr.ip().octets()),
-    };
-    storage
-}