Support unix sockets

networkException commented

2023-10-20 19:40:23 +00:00

First-time contributor

This pull request adds support for listening on and connecting to unix sockets.

This requires having wrapper types for various tokio specific network abstractions while also supporting things like serialization and deserialization.

Unfortionately i was unable to find a published crate fulfilling these
requirements.

For this reason I've published a crate myself. Called tokio-unix-tcp, it serves as a drop in replacement for Tokio's TCP and Unix network types.

I plan to maintain this library outside the scope of this project as well, in general the code should be simple and stable enough however to not require maintainance going forward.

As i said this crate aims to support the requirement mentioned above. In addition to this it also strives to be more correct about handling the different types of unix sockets, which the libraries i reviewed were weak at. A list of these crates can be found in the crate README under "Related work".

The changes to netapp can be summarized as the following:

std::net::SocketAddr has been replaced by tokio_unix_tcp::NamedSocketAddr in most places. This enum encapsulates a IP address and port as well as a path in its variants and describes a concrete socket address netapp can bind or connect to.
In some places tokio_unix_tcp::SocketAddr is used instead of tokio_unix_tcp::NamedSocketAddr as mentioned above. This is due to the way unix sockets work:

The remote peer of a client from the perspective of a server is not a concrete path but unnamed. They just share a file descriptor for the actual communication channel. The local address of the server is the actual file system path the server is listening on.

In some cases netapp might be configured to connect to another peer using a unix socket and to not send a reachable IP address and port or unix socket path using the HelloMessage.

As per the above (the client's remote address will be unnamed), we have no way of connecting back to that peer. This will currently cause the connection to be aborted by the server.
Listening on Unix sockets requires some additional handling like removing a previous file at the bind path and setting a correct mode (defaulting to 0o222 currently). This is handled by tokio_unix_tcp.

I've tested these changes by including them in garage and running basic administration commands against a node and by running the unit tests here.

Basalt peering is currently lacking a proper cost calculation for unix sockets - I'm sadly not familiar with this code.

This pull request adds support for listening on and connecting to unix sockets. This requires having wrapper types for various tokio specific network abstractions while also supporting things like serialization and deserialization. Unfortionately i was unable to find a published crate fulfilling these requirements. For this reason I've published a crate myself. Called [`tokio-unix-tcp`](https://crates.io/crates/tokio-unix-tcp), it serves as a drop in replacement for Tokio's TCP and Unix network types. I plan to maintain this library outside the scope of this project as well, in general the code should be simple and stable enough however to not require maintainance going forward. As i said this crate aims to support the requirement mentioned above. In addition to this it also strives to be more correct about handling the different types of unix sockets, which the libraries i reviewed were weak at. A list of these crates can be found in the crate [README](https://github.com/networkException/tokio-unix-tcp) under ["Related work"](https://github.com/networkException/tokio-unix-tcp#related-work). --- The changes to netapp can be summarized as the following: - `std::net::SocketAddr` has been replaced by `tokio_unix_tcp::NamedSocketAddr` in most places. This enum encapsulates a IP address and port as well as a path in its variants and describes a concrete socket address netapp can bind or connect to. - In some places `tokio_unix_tcp::SocketAddr` is used instead of `tokio_unix_tcp::NamedSocketAddr` as mentioned above. This is due to the way unix sockets work: The remote peer of a client from the perspective of a server is not a concrete path but `unnamed`. They just share a file descriptor for the actual communication channel. The local address of the server is the actual file system path the server is listening on. In some cases netapp might be configured to connect to another peer using a unix socket and to not send a reachable IP address and port or unix socket path using the `HelloMessage`. As per the above (the client's remote address will be `unnamed`), we have no way of connecting back to that peer. This will currently cause the connection to be aborted by the server. - Listening on Unix sockets requires some additional handling like removing a previous file at the bind path and setting a correct mode (defaulting to `0o222` currently). This is handled by `tokio_unix_tcp`. --- I've tested these changes by including them in garage and running basic administration commands against a node and by running the unit tests here. Basalt peering is currently lacking a proper cost calculation for unix sockets - I'm sadly not familiar with this code.

networkException force-pushed unix-sockets from 25c2376c6c to ee643a61ee

2023-10-20 19:42:13 +00:00

Compare

networkException force-pushed unix-sockets from ee643a61ee to 47a470b281

2023-11-05 21:29:23 +00:00

Compare

lx commented

2024-01-22 11:19:45 +00:00

Owner

Hi @networkException, I have not forgotten this PR, it's on my radar for inclusion at some point in the next few months. Sorry for the wait.

networkException commented

2024-01-22 16:25:01 +00:00

Author

First-time contributor

Thats alright, I'm quite happy with the unix socket support that landed in garage so far. I can also fully understand if the complexity of this is not worth it

continuous-integration/drone/pr Build is failing

Details

This pull request can be merged automatically.

You are not authorized to merge this pull request.

You can also view command line instructions.

Step 1:

From your project repository, check out a new branch and test the changes.

git checkout -b networkException-unix-sockets main

git pull unix-sockets

Step 2:

Merge the changes and update on Forgejo.

git checkout main

git merge --no-ff networkException-unix-sockets

git push origin main

Support unix sockets #13

Step 1:

Step 2: