Skip to content

std::net: adding new option todevice. #129172

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.

Sign up for GitHub

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

Closed
wants to merge 4 commits into from
Closed

std::net: adding new option todevice. #129172

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dab4104
std::net: adding new option todevice.
devnexen Aug 16, 2024
f7d3a1a
changes from feedback
devnexen Aug 22, 2024
4be9631
changes from ACP feedback
devnexen Aug 25, 2024
7537a8f
migrate to tcp/udp layers.
devnexen Aug 27, 2024
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
42 changes: 42 additions & 0 deletions library/std/src/net/tcp.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
#[cfg(all(test, not(any(target_os = "emscripten", target_os = "xous"))))]
mod tests;

use crate::ffi::CString;
use crate::fmt;
use crate::io::prelude::*;
use crate::io::{self, BorrowedCursor, IoSlice, IoSliceMut};
Expand Down Expand Up @@ -603,6 +604,47 @@ impl TcpStream {
pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
self.0.set_nonblocking(nonblocking)
}

/// Bind the socket to an interface
///
/// ```no_run
/// #![feature(unix_set_device)]
///
/// use std::net::TcpStream;
///
/// fn main() -> std::io::Result<()> {
/// let stream = TcpStream::connect("127.0.0.1:8080")
/// .expect("Couldn't connect to the server...");
/// stream.set_device("eth0")?;
/// Ok(())
/// }
///
/// ```
#[unstable(feature = "unix_set_device", issue = "129182")]
pub fn set_device(&self, ifrname: &str) -> io::Result<()> {
self.0.set_device(ifrname)
}

/// Get the interface this socket is bound to
///
/// ```no_run
/// #![feature(unix_set_device)]
///
/// use std::net::TcpStream;
///
/// fn main() -> std::io::Result<()> {
/// let stream = TcpStream::connect("127.0.0.1:8080")
/// .expect("Couldn't connect to the server...");
/// stream.set_device("eth0")?;
/// let name = stream.device()?;
/// assert_eq!(Ok("eth0"), name.to_str());
/// Ok(())
/// }
/// ```
#[unstable(feature = "unix_set_device", issue = "129182")]
pub fn device(&self) -> io::Result<CString> {
self.0.device()
}
}

// In addition to the `impl`s here, `TcpStream` also has `impl`s for
Expand Down
40 changes: 40 additions & 0 deletions library/std/src/net/udp.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#[cfg(all(test, not(any(target_os = "emscripten", target_env = "sgx", target_os = "xous"))))]
mod tests;

use crate::ffi::CString;
use crate::fmt;
use crate::io::{self, ErrorKind};
use crate::net::{Ipv4Addr, Ipv6Addr, SocketAddr, ToSocketAddrs};
Expand Down Expand Up @@ -806,6 +807,45 @@ impl UdpSocket {
pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
self.0.set_nonblocking(nonblocking)
}

/// Bind the socket to an interface
///
/// ```no_run
/// #![feature(unix_set_device)]
///
/// use std::net::UdpSocket;
///
/// fn main() -> std::io::Result<()> {
/// let socket = UdpSocket::bind("127.0.0.1:7878").unwrap();
/// socket.set_device("eth0")?;
/// Ok(())
/// }
///
/// ```
#[unstable(feature = "unix_set_device", issue = "129182")]
pub fn set_device(&self, ifrname: &str) -> io::Result<()> {
self.0.set_device(ifrname)
}

/// Get the interface this socket is bound to
///
/// ```no_run
/// #![feature(unix_set_device)]
///
/// use std::net::UdpSocket;
///
/// fn main() -> std::io::Result<()> {
/// let socket = UdpSocket::bind("127.0.0.1:7878").unwrap();
/// socket.set_device("eth0")?;
/// let name = socket.device()?;
/// assert_eq!(Ok("eth0"), name.to_str());
/// Ok(())
/// }
/// ```
#[unstable(feature = "unix_set_device", issue = "129182")]
pub fn device(&self) -> io::Result<CString> {
self.0.device()
}
}

// In addition to the `impl`s here, `UdpSocket` also has `impl`s for
Expand Down
36 changes: 36 additions & 0 deletions library/std/src/os/unix/net/datagram.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ use libc::MSG_NOSIGNAL;
#[cfg(any(doc, target_os = "android", target_os = "linux"))]
use super::{recv_vectored_with_ancillary_from, send_vectored_with_ancillary_to, SocketAncillary};
use super::{sockaddr_un, SocketAddr};
use crate::ffi::CString;
#[cfg(any(doc, target_os = "android", target_os = "linux"))]
use crate::io::{IoSlice, IoSliceMut};
use crate::net::Shutdown;
Expand Down Expand Up @@ -836,6 +837,41 @@ impl UnixDatagram {
self.0.set_mark(mark)
}

/// Bind the socket to an interface
///
/// ```no_run
/// #![feature(unix_set_device)]
/// use std::os::unix::net::UnixDatagram;
///
/// fn main() -> std::io::Result<()> {
/// let socket = UnixDatagram::unbound()?;
/// socket.set_device("eth0")?;
/// Ok(())
/// }
/// ```
#[unstable(feature = "unix_set_device", issue = "129182")]
pub fn set_device(&self, ifrname: &str) -> io::Result<()> {
self.0.set_device(ifrname)
}

/// Get the interface this socket is bound to
///
/// ```no_run
/// #![feature(unix_set_device)]
/// use std::os::unix::net::UnixDatagram;
///
/// fn main() -> std::io::Result<()> {
/// let socket = UnixDatagram::unbound()?;
/// socket.set_device("eth0")?;
/// let name = socket.device()?;
/// assert_eq!(Ok("eth0"), name.to_str());
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something seems odd here.

#![feature(unix_set_todevice)]
use std::os::unix::net::UnixDatagram;
    ///
fn main() -> std::io::Result<()> {
    let socket = UnixDatagram::unbound()?;
    socket.set_todevice(c"eno1")?;
    let name = socket.todevice()?;
    assert_eq!(Ok("eno1"), name.to_str());
    Ok(())
}

The assertion fails.

thread 'main' panicked at test_case.rs:8:5:
assertion `left == right` failed
  left: Ok("eno1")
 right: Ok("�
�")
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

/// Ok(())
/// }
/// ```
#[unstable(feature = "unix_set_device", issue = "129182")]
pub fn device(&self) -> io::Result<CString> {
self.0.device()
}
/// Returns the value of the `SO_ERROR` option.
///
/// # Examples
Expand Down
8 changes: 8 additions & 0 deletions library/std/src/sys/pal/hermit/net.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,6 +312,14 @@ impl Socket {
pub fn as_raw(&self) -> RawFd {
self.0.as_raw_fd()
}

pub fn device(&self) -> io::Result<crate::ffi::CString> {
unimplemented!()
}

pub fn set_device(&self, _: &str) -> io::Result<()> {
unimplemented!()
}
}

impl AsInner<FileDesc> for Socket {
Expand Down
8 changes: 8 additions & 0 deletions library/std/src/sys/pal/sgx/net.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,14 @@ impl TcpStream {
pub fn set_nonblocking(&self, _: bool) -> io::Result<()> {
sgx_ineffective(())
}

pub fn device(&self) -> io::Result<crate::ffi::CString> {
unimplemented!()
}

pub fn set_device(&self, _: &str) -> io::Result<()> {
unimplemented!()
}
}

impl AsInner<Socket> for TcpStream {
Expand Down
8 changes: 8 additions & 0 deletions library/std/src/sys/pal/solid/net.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,6 +380,14 @@ impl Socket {
pub fn as_raw(&self) -> c_int {
self.as_raw_fd()
}

pub fn device(&self) -> io::Result<crate::ffi::CString> {
unimplemented!()
}

pub fn set_device(&self, _: &str) -> io::Result<()> {
unimplemented!()
}
}

impl FromInner<OwnedFd> for Socket {
Expand Down
34 changes: 34 additions & 0 deletions library/std/src/sys/pal/unix/net.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -563,6 +563,40 @@ impl Socket {
setsockopt(self, libc::SOL_SOCKET, option, mark as libc::c_int)
}

#[cfg(any(target_os = "linux", target_os = "haiku", target_os = "vxworks"))]
pub fn device(&self) -> io::Result<crate::ffi::CString> {
let buf: [libc::c_char; libc::IFNAMSIZ] =
getsockopt(self, libc::SOL_SOCKET, libc::SO_BINDTODEVICE)?;
let s: &[u8] = unsafe { core::slice::from_raw_parts(buf.as_ptr() as *const u8, buf.len()) };
let name = CStr::from_bytes_until_nul(s).unwrap();
Ok(crate::ffi::CString::new(name.to_bytes()).unwrap())
}

#[cfg(not(any(target_os = "linux", target_os = "haiku", target_os = "vxworks")))]
pub fn device(&self) -> io::Result<crate::ffi::CString> {
unimplemented!()
}

#[cfg(any(target_os = "linux", target_os = "haiku", target_os = "vxworks"))]
pub fn set_device(&self, ifrname: &str) -> io::Result<()> {
let istr = ifrname.as_bytes();

if istr.len() >= libc::IFNAMSIZ {
return Err(io::Error::from_raw_os_error(libc::ENAMETOOLONG));
}

let mut buf = [0; libc::IFNAMSIZ];
for (src, dst) in istr.iter().zip(&mut buf[..libc::IFNAMSIZ - 1]) {
*dst = *src as libc::c_char;
}
setsockopt(self, libc::SOL_SOCKET, libc::SO_BINDTODEVICE, buf)
}

#[cfg(not(any(target_os = "linux", target_os = "haiku", target_os = "vxworks")))]
pub fn set_device(&self, _: &str) -> io::Result<()> {
unimplemented!()
}

pub fn take_error(&self) -> io::Result<Option<io::Error>> {
let raw: c_int = getsockopt(self, libc::SOL_SOCKET, libc::SO_ERROR)?;
if raw == 0 { Ok(None) } else { Ok(Some(io::Error::from_raw_os_error(raw as i32))) }
Expand Down
8 changes: 8 additions & 0 deletions library/std/src/sys/pal/wasi/net.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,14 @@ impl TcpStream {
pub fn into_socket(self) -> Socket {
self.inner
}

pub fn device(&self) -> io::Result<crate::ffi::CString> {
unimplemented!()
}

pub fn set_device(&self, _: &str) -> io::Result<()> {
unimplemented!()
}
}

impl FromInner<Socket> for TcpStream {
Expand Down
8 changes: 8 additions & 0 deletions library/std/src/sys/pal/windows/net.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -521,6 +521,14 @@ impl Socket {
debug_assert_eq!(mem::align_of::<c::SOCKET>(), mem::align_of::<RawSocket>());
unsafe { Self::from_raw_socket(raw as RawSocket) }
}

pub fn device(&self) -> io::Result<crate::ffi::CString> {
unimplemented!()
}

pub fn set_device(&self, _: &str) -> io::Result<()> {
unimplemented!()
}
}

#[unstable(reason = "not public", issue = "none", feature = "fd_read")]
Expand Down
18 changes: 17 additions & 1 deletion library/std/src/sys_common/net.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#[cfg(test)]
mod tests;

use crate::ffi::{c_int, c_void};
use crate::ffi::{c_int, c_void, CString};
use crate::io::{self, BorrowedCursor, ErrorKind, IoSlice, IoSliceMut};
use crate::net::{Ipv4Addr, Ipv6Addr, Shutdown, SocketAddr};
use crate::sys::common::small_c_string::run_with_cstr;
Expand Down Expand Up @@ -352,6 +352,14 @@ impl TcpStream {
pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
self.inner.set_nonblocking(nonblocking)
}

pub fn device(&self) -> io::Result<CString> {
self.inner.device()
}

pub fn set_device(&self, ifrname: &str) -> io::Result<()> {
self.inner.set_device(ifrname)
}
}

impl AsInner<Socket> for TcpStream {
Expand Down Expand Up @@ -702,6 +710,14 @@ impl UdpSocket {
let (addr, len) = addr?.into_inner();
cvt_r(|| unsafe { c::connect(self.inner.as_raw(), addr.as_ptr(), len) }).map(drop)
}

pub fn device(&self) -> io::Result<CString> {
self.inner.device()
}

pub fn set_device(&self, ifrname: &str) -> io::Result<()> {
self.inner.set_device(ifrname)
}
}

impl FromInner<Socket> for UdpSocket {
Expand Down
Loading