Rename SockAddr -> SocketAddrArg, SockAddrRaw -> SocketAddrOpaque

Author: kevinmehall

src/backend/libc/net/msghdr.rs

@@ -7,7 +7,7 @@ use crate::backend::c;
 use crate::backend::conv::{msg_control_len, msg_iov_len};
 
 use crate::io::{self, IoSlice, IoSliceMut};
-use crate::net::{RecvAncillaryBuffer, SendAncillaryBuffer, SockAddr};
+use crate::net::{RecvAncillaryBuffer, SendAncillaryBuffer, SocketAddrArg};
 
 use core::mem::{size_of, zeroed, MaybeUninit};
 
@@ -62,7 +62,7 @@ pub(crate) fn with_noaddr_msghdr<R>(
 
 /// Create a message header intended to send with the specified address.
 pub(crate) fn with_msghdr<R>(
-    addr: &impl SockAddr,
+    addr: &impl SocketAddrArg,
     iov: &[IoSlice<'_>],
     control: &mut SendAncillaryBuffer<'_, '_, '_>,
     f: impl FnOnce(c::msghdr) -> R,

src/backend/libc/net/syscalls.rs

@@ -4,7 +4,7 @@ use crate::backend::c;
 use crate::backend::conv::{borrowed_fd, ret, ret_owned_fd, ret_send_recv, send_recv_len};
 use crate::fd::{BorrowedFd, OwnedFd};
 use crate::io;
-use crate::net::{SockAddr, SocketAddrAny};
+use crate::net::{SocketAddrAny, SocketAddrArg};
 use crate::utils::as_ptr;
 use core::mem::{size_of, MaybeUninit};
 #[cfg(not(any(
@@ -90,7 +90,7 @@ pub(crate) fn sendto(
     fd: BorrowedFd<'_>,
     buf: &[u8],
     flags: SendFlags,
-    addr: &impl SockAddr,
+    addr: &impl SocketAddrArg,
 ) -> io::Result<usize> {
     unsafe {
         addr.with_sockaddr(|addr_ptr, addr_len| {
@@ -146,7 +146,7 @@ pub(crate) fn socket_with(
 }
 
 #[cfg(not(any(target_os = "redox", target_os = "wasi")))]
-pub(crate) fn bind(sockfd: BorrowedFd<'_>, addr: &impl SockAddr) -> io::Result<()> {
+pub(crate) fn bind(sockfd: BorrowedFd<'_>, addr: &impl SocketAddrArg) -> io::Result<()> {
     unsafe {
         addr.with_sockaddr(|addr_ptr, addr_len| {
             ret(c::bind(
@@ -159,7 +159,7 @@ pub(crate) fn bind(sockfd: BorrowedFd<'_>, addr: &impl SockAddr) -> io::Result<(
 }
 
 #[cfg(not(any(target_os = "redox", target_os = "wasi")))]
-pub(crate) fn connect(sockfd: BorrowedFd<'_>, addr: &impl SockAddr) -> io::Result<()> {
+pub(crate) fn connect(sockfd: BorrowedFd<'_>, addr: &impl SocketAddrArg) -> io::Result<()> {
     unsafe {
         addr.with_sockaddr(|addr_ptr, addr_len| {
             ret(c::connect(
@@ -266,7 +266,7 @@ pub(crate) fn sendmsg(
 )))]
 pub(crate) fn sendmsg_addr(
     sockfd: BorrowedFd<'_>,
-    addr: &impl SockAddr,
+    addr: &impl SocketAddrArg,
     iov: &[IoSlice<'_>],
     control: &mut SendAncillaryBuffer<'_, '_, '_>,
     msg_flags: SendFlags,

src/backend/linux_raw/net/msghdr.rs

@@ -8,7 +8,7 @@
 use crate::backend::c;
 
 use crate::io::{self, IoSlice, IoSliceMut};
-use crate::net::{RecvAncillaryBuffer, SendAncillaryBuffer, SockAddr};
+use crate::net::{RecvAncillaryBuffer, SendAncillaryBuffer, SocketAddrArg};
 
 use core::mem::{size_of, MaybeUninit};
 use core::ptr::null_mut;
@@ -74,7 +74,7 @@ pub(crate) fn with_noaddr_msghdr<R>(
 
 /// Create a message header intended to send with the specified address
 pub(crate) fn with_msghdr<R>(
-    addr: &impl SockAddr,
+    addr: &impl SocketAddrArg,
     iov: &[IoSlice<'_>],
     control: &mut SendAncillaryBuffer<'_, '_, '_>,
     f: impl FnOnce(c::msghdr) -> R,

src/backend/linux_raw/net/syscalls.rs

@@ -18,7 +18,7 @@ use crate::fd::{BorrowedFd, OwnedFd};
 use crate::io::{self, IoSlice, IoSliceMut};
 use crate::net::{
     AddressFamily, Protocol, RecvAncillaryBuffer, RecvMsgReturn, SendAncillaryBuffer, Shutdown,
-    SockAddr, SocketAddrAny, SocketFlags, SocketType,
+    SocketAddrAny, SocketAddrArg, SocketFlags, SocketType,
 };
 use c::{sockaddr_storage, socklen_t};
 use core::mem::MaybeUninit;
@@ -323,7 +323,7 @@ pub(crate) fn sendmsg(
 #[inline]
 pub(crate) fn sendmsg_addr(
     sockfd: BorrowedFd<'_>,
-    addr: &impl SockAddr,
+    addr: &impl SocketAddrArg,
     iov: &[IoSlice<'_>],
     control: &mut SendAncillaryBuffer<'_, '_, '_>,
     msg_flags: SendFlags,
@@ -425,7 +425,7 @@ pub(crate) fn sendto(
     fd: BorrowedFd<'_>,
     buf: &[u8],
     flags: SendFlags,
-    addr: &impl SockAddr,
+    addr: &impl SocketAddrArg,
 ) -> io::Result<usize> {
     let (buf_addr, buf_len) = slice(buf);
 
@@ -633,7 +633,7 @@ pub(crate) fn getsockname(fd: BorrowedFd<'_>) -> io::Result<SocketAddrAny> {
 }
 
 #[inline]
-pub(crate) fn bind(fd: BorrowedFd<'_>, addr: &impl SockAddr) -> io::Result<()> {
+pub(crate) fn bind(fd: BorrowedFd<'_>, addr: &impl SocketAddrArg) -> io::Result<()> {
     addr.with_sockaddr(|addr_ptr, addr_len| {
         #[cfg(not(target_arch = "x86"))]
         unsafe {
@@ -660,7 +660,7 @@ pub(crate) fn bind(fd: BorrowedFd<'_>, addr: &impl SockAddr) -> io::Result<()> {
 }
 
 #[inline]
-pub(crate) fn connect(fd: BorrowedFd<'_>, addr: &impl SockAddr) -> io::Result<()> {
+pub(crate) fn connect(fd: BorrowedFd<'_>, addr: &impl SocketAddrArg) -> io::Result<()> {
     addr.with_sockaddr(|addr_ptr, addr_len| {
         #[cfg(not(target_arch = "x86"))]
         unsafe {

src/net/mod.rs

@@ -27,7 +27,7 @@ pub use crate::maybe_polyfill::net::{
 pub use send_recv::*;
 pub use socket::*;
 pub use socket_addr_any::{SocketAddrAny, SocketAddrStorage};
-pub use socket_address::{SockAddr, SockAddrRaw};
+pub use socket_address::{SocketAddrArg, SocketAddrOpaque};
 #[cfg(not(any(windows, target_os = "wasi")))]
 pub use socketpair::socketpair;
 pub use types::*;

src/net/send_recv/mod.rs

@@ -33,7 +33,7 @@ mod msg;
 )))]
 pub use msg::*;
 
-use super::SockAddr;
+use super::SocketAddrArg;
 
 /// `recv(fd, buf, flags)`—Reads data from a socket.
 ///
@@ -227,7 +227,7 @@ pub fn sendto<Fd: AsFd>(
     fd: Fd,
     buf: &[u8],
     flags: SendFlags,
-    addr: &impl SockAddr,
+    addr: &impl SocketAddrArg,
 ) -> io::Result<usize> {
     backend::net::syscalls::sendto(fd.as_fd(), buf, flags, addr)
 }

src/net/send_recv/msg.rs

@@ -5,7 +5,7 @@
 use crate::backend::{self, c};
 use crate::fd::{AsFd, BorrowedFd, OwnedFd};
 use crate::io::{self, IoSlice, IoSliceMut};
-use crate::net::SockAddr;
+use crate::net::SocketAddrArg;
 #[cfg(linux_kernel)]
 use crate::net::UCred;
 #[cfg(feature = "std")]
@@ -651,7 +651,7 @@ pub fn sendmsg<Fd: AsFd>(
 #[inline]
 pub fn sendmsg_addr(
     socket: impl AsFd,
-    addr: &impl SockAddr,
+    addr: &impl SocketAddrArg,
     iov: &[IoSlice<'_>],
     control: &mut SendAncillaryBuffer<'_, '_, '_>,
     flags: SendFlags,

src/net/socket.rs

@@ -9,7 +9,7 @@ pub use crate::net::{AddressFamily, Protocol, Shutdown, SocketFlags, SocketType}
 #[cfg(unix)]
 pub use backend::net::addr::SocketAddrUnix;
 
-use super::SockAddr;
+use super::SocketAddrArg;
 
 /// `socket(domain, type_, protocol)`—Creates a socket.
 ///
@@ -124,7 +124,7 @@ pub fn socket_with(
 /// [DragonFly BSD]: https://man.dragonflybsd.org/?command=bind&section=2
 /// [illumos]: https://illumos.org/man/3SOCKET/bind
 /// [glibc]: https://sourceware.org/glibc/manual/latest/html_node/Setting-Address.html
-pub fn bind<Fd: AsFd>(sockfd: Fd, addr: &impl SockAddr) -> io::Result<()> {
+pub fn bind<Fd: AsFd>(sockfd: Fd, addr: &impl SocketAddrArg) -> io::Result<()> {
     backend::net::syscalls::bind(sockfd.as_fd(), addr)
 }
 
@@ -303,7 +303,7 @@ pub fn bind_xdp<Fd: AsFd>(sockfd: Fd, addr: &SocketAddrXdp) -> io::Result<()> {
 /// [illumos]: https://illumos.org/man/3SOCKET/connect
 /// [glibc]: https://sourceware.org/glibc/manual/latest/html_node/Connecting.html
 /// [`Errno::WOULDBLOCK`]: io::Errno::WOULDBLOCK
-pub fn connect<Fd: AsFd>(sockfd: Fd, addr: &impl SockAddr) -> io::Result<()> {
+pub fn connect<Fd: AsFd>(sockfd: Fd, addr: &impl SocketAddrArg) -> io::Result<()> {
     backend::net::syscalls::connect(sockfd.as_fd(), addr)
 }
 

src/net/socket_addr_any.rs

@@ -15,7 +15,9 @@ use crate::net::netlink::SocketAddrNetlink;
 use crate::net::xdp::SocketAddrXdp;
 #[cfg(unix)]
 use crate::net::SocketAddrUnix;
-use crate::net::{AddressFamily, SockAddr, SockAddrRaw, SocketAddr, SocketAddrV4, SocketAddrV6};
+use crate::net::{
+    AddressFamily, SocketAddr, SocketAddrArg, SocketAddrOpaque, SocketAddrV4, SocketAddrV6,
+};
 use crate::{backend, io};
 #[cfg(feature = "std")]
 use core::fmt;
@@ -136,8 +138,8 @@ impl fmt::Debug for SocketAddrAny {
     }
 }
 
-unsafe impl SockAddr for SocketAddrAny {
-    fn with_sockaddr<R>(&self, f: impl FnOnce(*const SockAddrRaw, usize) -> R) -> R {
+unsafe impl SocketAddrArg for SocketAddrAny {
+    fn with_sockaddr<R>(&self, f: impl FnOnce(*const SocketAddrOpaque, usize) -> R) -> R {
         match self {
             Self::V4(a) => a.with_sockaddr(f),
             Self::V6(a) => a.with_sockaddr(f),

src/net/socket_address.rs

@@ -17,17 +17,18 @@ use super::SocketAddrUnix;
 /// `sockaddr`-compatible C type, and then cast back to a `sockaddr` pointer
 /// to be passed to a system call.
 #[repr(C)]
-pub struct SockAddrRaw {
+pub struct SocketAddrOpaque {
     _data: [u8; 0],
 }
 
 /// A trait abstracting over the types that can be passed as a `sockaddr`.
 ///
-/// Safety: implementers of this trait must ensure that `with_sockaddr` calls
+/// # Safety
+/// Implementers of this trait must ensure that `with_sockaddr` calls
 /// `f` with a pointer that is readable for the passed length, and points
 /// to data that is a valid socket address for the system calls that accept
 /// `sockaddr` as a const pointer.
-pub unsafe trait SockAddr {
+pub unsafe trait SocketAddrArg {
     /// Call a closure with the pointer and length to the corresponding C type.
     ///
     /// The API uses a closure so that:
@@ -36,43 +37,43 @@ pub unsafe trait SockAddr {
     ///     C type can pass it directly without a copy.
     ///   * Other socket types can construct their C-compatible struct on the
     ///     stack and call the closure with a pointer to it.
-    fn with_sockaddr<R>(&self, f: impl FnOnce(*const SockAddrRaw, usize) -> R) -> R;
+    fn with_sockaddr<R>(&self, f: impl FnOnce(*const SocketAddrOpaque, usize) -> R) -> R;
 }
 
-/// Helper for implementing SockAddr::with_sockaddr
+/// Helper for implementing SocketAddrArg::with_sockaddr
 pub(crate) fn call_with_sockaddr<A, R>(
     addr: &A,
-    f: impl FnOnce(*const SockAddrRaw, usize) -> R,
+    f: impl FnOnce(*const SocketAddrOpaque, usize) -> R,
 ) -> R {
     let ptr = (addr as *const A).cast();
     let len = size_of::<A>();
     f(ptr, len)
 }
 
-unsafe impl SockAddr for super::SocketAddr {
-    fn with_sockaddr<R>(&self, f: impl FnOnce(*const SockAddrRaw, usize) -> R) -> R {
+unsafe impl SocketAddrArg for super::SocketAddr {
+    fn with_sockaddr<R>(&self, f: impl FnOnce(*const SocketAddrOpaque, usize) -> R) -> R {
         match self {
             SocketAddr::V4(v4) => v4.with_sockaddr(f),
             SocketAddr::V6(v6) => v6.with_sockaddr(f),
         }
     }
 }
 
-unsafe impl SockAddr for SocketAddrV4 {
-    fn with_sockaddr<R>(&self, f: impl FnOnce(*const SockAddrRaw, usize) -> R) -> R {
+unsafe impl SocketAddrArg for SocketAddrV4 {
+    fn with_sockaddr<R>(&self, f: impl FnOnce(*const SocketAddrOpaque, usize) -> R) -> R {
         call_with_sockaddr(&encode_sockaddr_v4(self), f)
     }
 }
 
-unsafe impl SockAddr for SocketAddrV6 {
-    fn with_sockaddr<R>(&self, f: impl FnOnce(*const SockAddrRaw, usize) -> R) -> R {
+unsafe impl SocketAddrArg for SocketAddrV6 {
+    fn with_sockaddr<R>(&self, f: impl FnOnce(*const SocketAddrOpaque, usize) -> R) -> R {
         call_with_sockaddr(&encode_sockaddr_v6(self), f)
     }
 }
 
 #[cfg(unix)]
-unsafe impl SockAddr for SocketAddrUnix {
-    fn with_sockaddr<R>(&self, f: impl FnOnce(*const SockAddrRaw, usize) -> R) -> R {
+unsafe impl SocketAddrArg for SocketAddrUnix {
+    fn with_sockaddr<R>(&self, f: impl FnOnce(*const SocketAddrOpaque, usize) -> R) -> R {
         f(
             (&self.unix as *const c::sockaddr_un).cast(),
             self.addr_len() as usize,

src/net/types.rs

@@ -945,7 +945,7 @@ pub mod netlink {
     use {
         super::{new_raw_protocol, Protocol},
         crate::backend::c,
-        crate::net::{socket_address::call_with_sockaddr, SockAddr, SockAddrRaw},
+        crate::net::{socket_address::call_with_sockaddr, SocketAddrArg, SocketAddrOpaque},
         core::mem,
     };
 
@@ -1107,8 +1107,8 @@ pub mod netlink {
 
     #[cfg(linux_kernel)]
     #[allow(unsafe_code)]
-    unsafe impl SockAddr for SocketAddrNetlink {
-        fn with_sockaddr<R>(&self, f: impl FnOnce(*const SockAddrRaw, usize) -> R) -> R {
+    unsafe impl SocketAddrArg for SocketAddrNetlink {
+        fn with_sockaddr<R>(&self, f: impl FnOnce(*const SocketAddrOpaque, usize) -> R) -> R {
             let mut addr: c::sockaddr_nl = unsafe { mem::zeroed() };
             addr.nl_family = c::AF_NETLINK as _;
             addr.nl_pid = self.pid;
@@ -1543,7 +1543,7 @@ bitflags! {
 /// `AF_XDP` related types and constants.
 #[cfg(target_os = "linux")]
 pub mod xdp {
-    use crate::net::{socket_address::call_with_sockaddr, SockAddr, SockAddrRaw};
+    use crate::net::{socket_address::call_with_sockaddr, SocketAddrArg, SocketAddrOpaque};
 
     use super::{bitflags, c};
 
@@ -1685,8 +1685,8 @@ pub mod xdp {
     }
 
     #[allow(unsafe_code)]
-    unsafe impl SockAddr for SocketAddrXdp {
-        fn with_sockaddr<R>(&self, f: impl FnOnce(*const SockAddrRaw, usize) -> R) -> R {
+    unsafe impl SocketAddrArg for SocketAddrXdp {
+        fn with_sockaddr<R>(&self, f: impl FnOnce(*const SocketAddrOpaque, usize) -> R) -> R {
             let addr = c::sockaddr_xdp {
                 sxdp_family: c::AF_XDP as _,
                 sxdp_flags: self.flags().bits(),