Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for abstract sockets #176

Merged
merged 5 commits into from
Dec 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 31 additions & 5 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1847,12 +1847,10 @@ impl Async<UnixStream> {
/// # std::io::Result::Ok(()) });
/// ```
pub async fn connect<P: AsRef<Path>>(path: P) -> io::Result<Async<UnixStream>> {
let address = convert_path_to_socket_address(path.as_ref())?;

// Begin async connect.
let socket = connect(
rn::SocketAddrUnix::new(path.as_ref())?.into(),
rn::AddressFamily::UNIX,
None,
)?;
let socket = connect(address.into(), rn::AddressFamily::UNIX, None)?;
// Use new_nonblocking because connect already sets socket to non-blocking mode.
let stream = Async::new_nonblocking(UnixStream::from(socket))?;

Expand Down Expand Up @@ -2195,3 +2193,31 @@ fn set_nonblocking(

Ok(())
}

/// Converts a `Path` to its socket address representation.
///
/// This function is abstract socket-aware.
#[cfg(unix)]
#[inline]
fn convert_path_to_socket_address(path: &Path) -> io::Result<rn::SocketAddrUnix> {
// SocketAddrUnix::new() will throw EINVAL when a path with a zero in it is passed in.
// However, some users expect to be able to pass in paths to abstract sockets, which
// triggers this error as it has a zero in it. Therefore, if a path starts with a zero,
// make it an abstract socket.
#[cfg(any(target_os = "linux", target_os = "android"))]
let address = {
use std::os::unix::ffi::OsStrExt;

let path = path.as_os_str();
match path.as_bytes().first() {
Some(0) => rn::SocketAddrUnix::new_abstract_name(path.as_bytes().get(1..).unwrap())?,
_ => rn::SocketAddrUnix::new(path)?,
}
};

// Only Linux and Android support abstract sockets.
#[cfg(not(any(target_os = "linux", target_os = "android")))]
let address = rn::SocketAddrUnix::new(path)?;

Ok(address)
}
56 changes: 56 additions & 0 deletions tests/async.rs
Original file line number Diff line number Diff line change
Expand Up @@ -383,3 +383,59 @@ fn duplicate_socket_insert() -> io::Result<()> {
Ok(())
})
}

#[cfg(any(target_os = "linux", target_os = "android"))]
#[test]
fn abstract_socket() -> io::Result<()> {
use std::ffi::OsStr;
#[cfg(target_os = "android")]
use std::os::android::net::SocketAddrExt;
#[cfg(target_os = "linux")]
use std::os::linux::net::SocketAddrExt;
use std::os::unix::ffi::OsStrExt;
use std::os::unix::net::{SocketAddr, UnixListener, UnixStream};

future::block_on(async {
// Bind a listener to a socket.
let path = OsStr::from_bytes(b"\0smolabstract");
let addr = SocketAddr::from_abstract_name(b"smolabstract")?;
let listener = Async::new(UnixListener::bind_addr(&addr)?)?;

// Future that connects to the listener.
let connector = async {
// Connect to the socket.
let mut stream = Async::<UnixStream>::connect(path).await?;

// Write some bytes to the stream.
stream.write_all(LOREM_IPSUM).await?;

// Read some bytes from the stream.
let mut buf = vec![0; LOREM_IPSUM.len()];
stream.read_exact(&mut buf).await?;
assert_eq!(buf.as_slice(), LOREM_IPSUM);

io::Result::Ok(())
};

// Future that drives the listener.
let driver = async {
// Wait for a new connection.
let (mut stream, _) = listener.accept().await?;

// Read some bytes from the stream.
let mut buf = vec![0; LOREM_IPSUM.len()];
stream.read_exact(&mut buf).await?;
assert_eq!(buf.as_slice(), LOREM_IPSUM);

// Write some bytes to the stream.
stream.write_all(LOREM_IPSUM).await?;

io::Result::Ok(())
};

// Run both in parallel.
future::try_zip(connector, driver).await?;

Ok(())
})
}
Loading