Add abstract namespace support for Unix domain sockets #85379

mdaverde · 2021-05-16T19:54:58Z

Hello! The other day I wanted to mess around with UDS in Rust and found that abstract namespaces (unix(7)) on Linux still needed development. I took the approach of adding _addr specific public functions to reduce conflicts.

Feature name: unix_socket_abstract
Tracking issue: #85410
Further context: #42048

Non-platform specific additions

UnixListener::bind_addr(&SocketAddr) -> Result<UnixListener>

UnixStream::connect_addr(&SocketAddr) -> Result<()>

UnixDatagram::bind_addr(&SocketAddr) -> Result<UnixDatagram>

UnixDatagram::connect_addr(&SocketAddr) -> Result<()>

UnixDatagram::send_to_addr(&self, &[u8], &SocketAddr) -> Result<usize>

Platform-specific (Linux) additions

SocketAddr::from_abstract_namespace(&[u8]) -> SocketAddr

SockerAddr::as_abstract_namespace() -> Option<&[u8]>

Example

#![feature(unix_socket_abstract)]
use std::os::unix::net::{UnixListener, SocketAddr};

fn main() -> std::io::Result<()> {
    let addr = SocketAddr::from_abstract_namespace(b"namespace")?; // Linux only
    let listener = match UnixListener::bind_addr(&addr) {
        Ok(sock) => sock,
        Err(err) => {
            println!("Couldn't bind: {:?}", err);
            return Err(err);
        }
    };
    Ok(())
}

Further Details

The main inspiration for the implementation came from the nix-rust crate but there are also other historical attempts with similar approaches.

A comment I did have was with this change, we now allow a SocketAddr to be constructed explicitly rather than just used almost as a handle for the return of peer_addr and local_addr. We could consider adding other explicit constructors (e.g. SocketAddr::from_pathname, SockerAddr::from_unnamed).

Cheers!

rust-highfive · 2021-05-16T19:55:00Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @kennytm (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

joshtriplett · 2021-05-17T09:59:17Z

This looks reasonable to me!

You need to create a tracking issue, and change the issue number in the stability attributes to reference that tracking issue.

With that fixed, if CI passes and a try build passes, r=me.

mdaverde · 2021-05-17T16:35:38Z

Updated the stability attributes to a new tracking issue! Although, I think I need maintainer approval to rerun the build?

joshtriplett · 2021-05-17T22:53:38Z

@bors try

bors · 2021-05-17T22:53:47Z

⌛ Trying commit a4d0489 with merge 1c03bdf6c40e17f64fa452dd50a3e41fcd70fb69...

bors · 2021-05-17T23:42:19Z

☀️ Try build successful - checks-actions
Build commit: 1c03bdf6c40e17f64fa452dd50a3e41fcd70fb69 (1c03bdf6c40e17f64fa452dd50a3e41fcd70fb69)

joshtriplett · 2021-05-18T00:28:03Z

@bors r+

bors · 2021-05-18T00:28:05Z

📌 Commit a4d0489 has been approved by joshtriplett

Add abstract namespace support for Unix domain sockets Hello! The other day I wanted to mess around with UDS in Rust and found that abstract namespaces ([unix(7)](https://man7.org/linux/man-pages/man7/unix.7.html)) on Linux still needed development. I took the approach of adding `_addr` specific public functions to reduce conflicts. Feature name: `unix_socket_abstract` Tracking issue: rust-lang#85410 Further context: rust-lang#42048 ## Non-platform specific additions `UnixListener::bind_addr(&SocketAddr) -> Result<UnixListener>` `UnixStream::connect_addr(&SocketAddr) -> Result<()>` `UnixDatagram::bind_addr(&SocketAddr) -> Result<UnixDatagram>` `UnixDatagram::connect_addr(&SocketAddr) -> Result<()>` `UnixDatagram::send_to_addr(&self, &[u8], &SocketAddr) -> Result<usize>` ## Platform-specific (Linux) additions `SocketAddr::from_abstract_namespace(&[u8]) -> SocketAddr` `SockerAddr::as_abstract_namespace() -> Option<&[u8]>` ## Example ```rust #![feature(unix_socket_abstract)] use std::os::unix::net::{UnixListener, SocketAddr}; fn main() -> std::io::Result<()> { let addr = SocketAddr::from_abstract_namespace(b"namespace")?; // Linux only let listener = match UnixListener::bind_addr(&addr) { Ok(sock) => sock, Err(err) => { println!("Couldn't bind: {:?}", err); return Err(err); } }; Ok(()) } ``` ## Further Details The main inspiration for the implementation came from the [nix-rust](https://github.com/nix-rust/nix/blob/master/src/sys/socket/addr.rs#L558) crate but there are also other [historical](rust-lang@c4db068) [attempts](https://github.com/tormol/uds/blob/master/src/addr.rs#L324) with similar approaches. A comment I did have was with this change, we now allow a `SocketAddr` to be constructed explicitly rather than just used almost as a handle for the return of `peer_addr` and `local_addr`. We could consider adding other explicit constructors (e.g. `SocketAddr::from_pathname`, `SockerAddr::from_unnamed`). Cheers!

GuillaumeGomez · 2021-05-18T12:07:40Z

Failed in CI:

[RUSTC-TIMING] object test:false 10.149
error: unused import: `ptr`
 --> library/std/src/os/./unix/net/addr.rs:5:40
  |
5 | use crate::{ascii, fmt, io, iter, mem, ptr};
  |
  |
  = note: `-D unused-imports` implied by `-D warnings`
error: aborting due to previous error

[RUSTC-TIMING] std test:false 2.398
error: could not compile `std`

@bors: r-

mdaverde · 2021-05-18T12:29:01Z

Hmm is that an allowable import? I believe I am using it on line :288 of /unix/net/addr.rs but maybe something changed:

            ptr::copy_nonoverlapping(
                namespace.as_ptr(),
                addr.sun_path.as_mut_ptr().offset(1) as *mut u8,
                namespace.len(),
            );

GuillaumeGomez · 2021-05-18T12:36:05Z

Is it behind a cfg by any chance? Worst case, simply replace ptr with std::ptr and you're good to go. :)

mdaverde · 2021-05-18T13:29:58Z

Ah yes, that was it. Went ahead and moved the use declaration within the fn block. Thank you!

GuillaumeGomez · 2021-05-18T14:25:59Z

@bors: r=joshtriplett,GuillaumeGomez

bors · 2021-05-18T14:26:00Z

📌 Commit b0b0267 has been approved by joshtriplett,GuillaumeGomez

…tt,GuillaumeGomez Add abstract namespace support for Unix domain sockets Hello! The other day I wanted to mess around with UDS in Rust and found that abstract namespaces ([unix(7)](https://man7.org/linux/man-pages/man7/unix.7.html)) on Linux still needed development. I took the approach of adding `_addr` specific public functions to reduce conflicts. Feature name: `unix_socket_abstract` Tracking issue: rust-lang#85410 Further context: rust-lang#42048 ## Non-platform specific additions `UnixListener::bind_addr(&SocketAddr) -> Result<UnixListener>` `UnixStream::connect_addr(&SocketAddr) -> Result<()>` `UnixDatagram::bind_addr(&SocketAddr) -> Result<UnixDatagram>` `UnixDatagram::connect_addr(&SocketAddr) -> Result<()>` `UnixDatagram::send_to_addr(&self, &[u8], &SocketAddr) -> Result<usize>` ## Platform-specific (Linux) additions `SocketAddr::from_abstract_namespace(&[u8]) -> SocketAddr` `SockerAddr::as_abstract_namespace() -> Option<&[u8]>` ## Example ```rust #![feature(unix_socket_abstract)] use std::os::unix::net::{UnixListener, SocketAddr}; fn main() -> std::io::Result<()> { let addr = SocketAddr::from_abstract_namespace(b"namespace")?; // Linux only let listener = match UnixListener::bind_addr(&addr) { Ok(sock) => sock, Err(err) => { println!("Couldn't bind: {:?}", err); return Err(err); } }; Ok(()) } ``` ## Further Details The main inspiration for the implementation came from the [nix-rust](https://github.com/nix-rust/nix/blob/master/src/sys/socket/addr.rs#L558) crate but there are also other [historical](rust-lang@c4db068) [attempts](https://github.com/tormol/uds/blob/master/src/addr.rs#L324) with similar approaches. A comment I did have was with this change, we now allow a `SocketAddr` to be constructed explicitly rather than just used almost as a handle for the return of `peer_addr` and `local_addr`. We could consider adding other explicit constructors (e.g. `SocketAddr::from_pathname`, `SockerAddr::from_unnamed`). Cheers!

bors · 2021-10-06T09:50:46Z

⌛ Testing commit 3b441c8 with merge 1aa771d03efaa4bcb086adbf0e9e38fb98a6f428...

bors · 2021-10-06T09:54:22Z

💔 Test failed - checks-actions

mdaverde · 2021-10-10T18:52:11Z

Integrated the I/O safety changes and did a rebase 🙏

r? @joshtriplett

joshtriplett · 2021-10-15T13:11:39Z

@bors r+

bors · 2021-10-15T13:11:41Z

📌 Commit 15b1198 has been approved by joshtriplett

bors · 2021-10-15T22:31:56Z

⌛ Testing commit 15b1198 with merge 6cc0a76...

bors · 2021-10-16T01:41:41Z

☀️ Test successful - checks-actions
Approved by: joshtriplett
Pushing 6cc0a76 to master...

rust-timer · 2021-10-16T03:14:28Z

Finished benchmarking commit (6cc0a76): comparison url.

Summary: This benchmark run did not return any relevant changes.

If you disagree with this performance assessment, please file an issue in rust-lang/rustc-perf.

@rustbot label: -perf-regression

rust-highfive assigned kennytm May 16, 2021

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label May 16, 2021

This comment has been minimized.

Sign in to view

mdaverde mentioned this pull request May 17, 2021

Tracking Issue for abstract namespaces in Unix domain sockets #85410

Closed

4 tasks

mdaverde force-pushed the uds-abstract branch from 82544f2 to a4d0489 Compare May 17, 2021 12:36

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 18, 2021

GuillaumeGomez mentioned this pull request May 18, 2021

Rollup of 7 pull requests #85431

Closed

bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels May 18, 2021

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels May 18, 2021

bors added the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label Oct 4, 2021

bors added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Oct 6, 2021

This comment has been minimized.

Sign in to view

kennytm added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Oct 7, 2021

mdaverde added 6 commits October 10, 2021 14:01

Add abstract namespace support for Unix domain sockets

63ebfc2

rustfmt

1c21431

Update tracking issue in stability refs

565e349

moves use ptr within from_abstract_namespace fn

d68a8d9

cross-platform doctests

92d6805

integrate I/O safety changes

15b1198

mdaverde force-pushed the uds-abstract branch from 3b441c8 to 15b1198 Compare October 10, 2021 18:01

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Oct 15, 2021

bors added the merged-by-bors This PR was explicitly merged by bors. label Oct 16, 2021

bors merged commit 6cc0a76 into rust-lang:master Oct 16, 2021

rustbot added this to the 1.57.0 milestone Oct 16, 2021

This was referenced Apr 5, 2022

Support for unix abstract sockets hyperium/tonic#966

Open

Support for unix abstract sockets tokio-rs/tokio#4610

Open

zeenix mentioned this pull request Apr 13, 2023

Use std's abstract unix socket API dbus2/zbus#329

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add abstract namespace support for Unix domain sockets #85379

Add abstract namespace support for Unix domain sockets #85379

mdaverde commented May 16, 2021 •

edited

Loading

rust-highfive commented May 16, 2021

This comment has been minimized.

joshtriplett commented May 17, 2021

mdaverde commented May 17, 2021

joshtriplett commented May 17, 2021

bors commented May 17, 2021

bors commented May 17, 2021

joshtriplett commented May 18, 2021

bors commented May 18, 2021

GuillaumeGomez commented May 18, 2021

mdaverde commented May 18, 2021

GuillaumeGomez commented May 18, 2021

mdaverde commented May 18, 2021

GuillaumeGomez commented May 18, 2021

bors commented May 18, 2021

bors commented Oct 6, 2021

bors commented Oct 6, 2021

This comment has been minimized.

mdaverde commented Oct 10, 2021

joshtriplett commented Oct 15, 2021

bors commented Oct 15, 2021

bors commented Oct 15, 2021

bors commented Oct 16, 2021

rust-timer commented Oct 16, 2021

Add abstract namespace support for Unix domain sockets #85379

Add abstract namespace support for Unix domain sockets #85379

Conversation

mdaverde commented May 16, 2021 • edited Loading

Non-platform specific additions

Platform-specific (Linux) additions

Example

Further Details

rust-highfive commented May 16, 2021

This comment has been minimized.

joshtriplett commented May 17, 2021

mdaverde commented May 17, 2021

joshtriplett commented May 17, 2021

bors commented May 17, 2021

bors commented May 17, 2021

joshtriplett commented May 18, 2021

bors commented May 18, 2021

GuillaumeGomez commented May 18, 2021

mdaverde commented May 18, 2021

GuillaumeGomez commented May 18, 2021

mdaverde commented May 18, 2021

GuillaumeGomez commented May 18, 2021

bors commented May 18, 2021

bors commented Oct 6, 2021

bors commented Oct 6, 2021

This comment has been minimized.

mdaverde commented Oct 10, 2021

joshtriplett commented Oct 15, 2021

bors commented Oct 15, 2021

bors commented Oct 15, 2021

bors commented Oct 16, 2021

rust-timer commented Oct 16, 2021

mdaverde commented May 16, 2021 •

edited

Loading