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 1 commit
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
53 changes: 53 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,8 @@ 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};
#[cfg(any(doc, target_os = "linux", target_os = "haiku", target_os = "vxworks",))]
use crate::ffi::CStr;
#[cfg(any(doc, target_os = "android", target_os = "linux"))]
use crate::io::{IoSlice, IoSliceMut};
use crate::net::Shutdown;
Expand Down Expand Up @@ -836,6 +838,57 @@ impl UnixDatagram {
self.0.set_mark(mark)
}

/// Bind the socket to an interface
///
#[cfg_attr(
any(target_os = "linux", target_os = "haiku", target_os = "vxworks"),
doc = "```no_run"
)]
#[cfg_attr(
not(any(target_os = "linux", target_os = "haiku", target_os = "vxworks")),
doc = "```ignore"
)]
/// #![feature(unix_set_todevice)]
/// use std::os::unix::net::UnixDatagram;
///
/// fn main() -> std::io::Result<()> {
/// let socket = UnixDatagram::unbound()?;
/// socket.set_todevice(c"eth0")?;
/// Ok(())
/// }
/// ```
#[cfg(any(doc, target_os = "linux", target_os = "haiku", target_os = "vxworks",))]
#[unstable(feature = "unix_set_todevice", issue = "129182")]
pub fn set_todevice(&self, ifrname: &CStr) -> io::Result<()> {
self.0.set_todevice(ifrname)
}

/// Get the interface this socket is bound to
///
#[cfg_attr(
any(target_os = "linux", target_os = "haiku", target_os = "vxworks"),
doc = "```no_run"
)]
#[cfg_attr(
not(any(target_os = "linux", target_os = "haiku", target_os = "vxworks")),
doc = "```ignore"
)]
/// #![feature(unix_set_todevice)]
/// use std::os::unix::net::UnixDatagram;
///
/// fn main() -> std::io::Result<()> {
/// let socket = UnixDatagram::unbound()?;
/// socket.set_todevice(c"eth0")?;
/// let name = socket.todevice()?;
/// 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(())
/// }
/// ```
#[cfg(any(doc, target_os = "linux", target_os = "haiku", target_os = "vxworks",))]
#[unstable(feature = "unix_set_todevice", issue = "129182")]
pub fn todevice(&self) -> io::Result<&CStr> {
self.0.todevice()
}
/// Returns the value of the `SO_ERROR` option.
///
/// # Examples
Expand Down
54 changes: 54 additions & 0 deletions library/std/src/os/unix/net/stream.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ use super::{peer_cred, UCred};
#[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};
#[cfg(any(doc, target_os = "linux", target_os = "haiku", target_os = "vxworks",))]
use crate::ffi::CStr;
use crate::fmt;
use crate::io::{self, IoSlice, IoSliceMut};
use crate::net::Shutdown;
Expand Down Expand Up @@ -405,6 +407,58 @@ impl UnixStream {
self.0.set_mark(mark)
}

/// Bind the socket to an interface
///
#[cfg_attr(
any(target_os = "linux", target_os = "haiku", target_os = "vxworks"),
doc = "```no_run"
)]
#[cfg_attr(
not(any(target_os = "linux", target_os = "haiku", target_os = "vxworks")),
doc = "```ignore"
)]
/// #![feature(unix_set_todevice)]
/// use std::os::unix::net::UnixStream;
///
/// fn main() -> std::io::Result<()> {
/// let socket = UnixStream::connect("/tmp/sock")?;
Copy link
Member

@joshtriplett joshtriplett Aug 27, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Why is this using UnixStream? That...shouldn't work.

The examples should be things expected to work.

Copy link
Member

Choose a reason for hiding this comment

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

Wait, it looks like these are being added to UNIX sockets? Shouldn't these be for TCP/UDP, not UNIX?

/// socket.set_todevice(c"eth0")?;
/// Ok(())
/// }
/// ```
#[cfg(any(doc, target_os = "linux", target_os = "haiku", target_os = "vxworks",))]
#[unstable(feature = "unix_set_todevice", issue = "129182")]
pub fn set_todevice(&self, ifrname: &CStr) -> io::Result<()> {
self.0.set_todevice(ifrname)
}

/// Get the interface this socket is bound to
///
#[cfg_attr(
any(target_os = "linux", target_os = "haiku", target_os = "vxworks"),
doc = "```no_run"
)]
#[cfg_attr(
not(any(target_os = "linux", target_os = "haiku", target_os = "vxworks")),
doc = "```ignore"
)]
/// #![feature(unix_set_todevice)]
/// use std::os::unix::net::UnixStream;
///
/// fn main() -> std::io::Result<()> {
/// let socket = UnixStream::connect("/tmp/sock")?;
/// socket.set_todevice(c"eth0")?;
/// let name = socket.todevice()?;
/// assert_eq!(Ok("eth0"), name.to_str());
/// Ok(())
/// }
/// ```
#[cfg(any(doc, target_os = "linux", target_os = "haiku", target_os = "vxworks",))]
#[unstable(feature = "unix_set_todevice", issue = "129182")]
pub fn todevice(&self) -> io::Result<&CStr> {
self.0.todevice()
}

/// Returns the value of the `SO_ERROR` option.
///
/// # Examples
Expand Down
18 changes: 18 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,24 @@ 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 todevice(&self) -> io::Result<&CStr> {
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 ifrname = CStr::from_bytes_until_nul(s).unwrap();
Ok(ifrname)
}

#[cfg(any(target_os = "linux", target_os = "haiku", target_os = "vxworks"))]
pub fn set_todevice(&self, ifrname: &CStr) -> io::Result<()> {
let mut buf = [0; libc::IFNAMSIZ];
for (src, dst) in ifrname.to_bytes().iter().zip(&mut buf[..libc::IFNAMSIZ - 1]) {
Copy link
Member

Choose a reason for hiding this comment

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

this should probably check if the input name is too long rather than silently truncating it because you used zip()

Copy link
Contributor

@biabbas biabbas Aug 22, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

That value is already truncated to size specified by optlen when getsockopt is called with optlen.

Copy link
Contributor

Choose a reason for hiding this comment

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

Plus length of interface is 16 on most unix systems, so no value is truncated.

Copy link
Member

Choose a reason for hiding this comment

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

what I mean is, assuming IFNAMSIZ == 16, if you have an interface named mylonginterface (15 bytes), and you call this function with "mylonginterfacename" then it will silently truncate that and use mylonginterface instead of erroring like it should, because setsockopt never has a chance to see the bad name and report an error.

*dst = *src as libc::c_char;
}
setsockopt(self, libc::SOL_SOCKET, libc::SO_BINDTODEVICE, buf)
}

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
Loading