1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
//! syscall for networking.
use std::{
io,
net::{Ipv4Addr, Ipv6Addr, Shutdown, SocketAddr},
sync::OnceLock,
task::Waker,
};
use crate::{cancellable::CancelablePoll, handle::Handle};
/// Network-related system call interface
pub trait Network: Sync + Send {
/// Executes an operation of the IP_ADD_MEMBERSHIP type.
///
/// This function specifies a new multicast group for this socket to join.
/// The address must be a valid multicast address, and interface is the
/// address of the local interface with which the system should join the
/// multicast group. If it’s equal to INADDR_ANY then an appropriate
/// interface is chosen by the system.
fn udp_join_multicast_v4(
&self,
handle: &Handle,
multiaddr: &Ipv4Addr,
interface: &Ipv4Addr,
) -> io::Result<()>;
/// Executes an operation of the `IPV6_ADD_MEMBERSHIP` type.
///
/// This function specifies a new multicast group for this socket to join.
/// The address must be a valid multicast address, and `interface` is the
/// index of the interface to join/leave (or 0 to indicate any interface).
fn udp_join_multicast_v6(
&self,
handle: &Handle,
multiaddr: &Ipv6Addr,
interface: u32,
) -> io::Result<()>;
/// Executes an operation of the `IP_DROP_MEMBERSHIP` type.
///
/// For more information about this option, see
/// [`join_multicast_v4`][link].
///
/// [link]: #method.join_multicast_v4
fn udp_leave_multicast_v4(
&self,
handle: &Handle,
multiaddr: &Ipv4Addr,
interface: &Ipv4Addr,
) -> io::Result<()>;
/// Executes an operation of the `IPV6_DROP_MEMBERSHIP` type.
///
/// For more information about this option, see
/// [`join_multicast_v6`][link].
///
/// [link]: #method.join_multicast_v6
fn udp_leave_multicast_v6(
&self,
handle: &Handle,
multiaddr: &Ipv6Addr,
interface: u32,
) -> io::Result<()>;
/// Sets the value of the SO_BROADCAST option for this socket.
/// When enabled, this socket is allowed to send packets to a broadcast address.
fn udp_set_broadcast(&self, handle: &Handle, on: bool) -> io::Result<()>;
/// Gets the value of the SO_BROADCAST option for this socket.
/// For more information about this option, see [`udp_set_broadcast`](Self::udp_set_broadcast).
fn udp_broadcast(&self, handle: &Handle) -> io::Result<bool>;
/// Gets the value of the IP_TTL option for this socket.
/// For more information about this option, see [`tcp_listener_set_ttl`](Self::tcp_listener_set_ttl).
fn udp_ttl(&self, handle: &Handle) -> io::Result<u32>;
/// Sets the value for the IP_TTL option on this socket.
/// This value sets the time-to-live field that is used in every packet sent from this socket.
fn udp_set_ttl(&self, handle: &Handle, ttl: u32) -> io::Result<()>;
/// Returns the local [`socket address`](SocketAddr) bound to this udp socket.
fn udp_local_addr(&self, handle: &Handle) -> io::Result<SocketAddr>;
/// Create udp socket and bind it to `laddrs`.
///
/// Binding with a port number of 0 will request that the OS assigns a port to this socket. The
/// port allocated can be queried via the [`udp_local_addr`](Self::udp_local_addr) method.
///
/// Returns [`CancelablePoll::Pending(CancelHandle)`](CancelablePoll::Pending),
/// indicating that the current operation could not be completed
/// immediately and needs to be retried later.
fn udp_bind(&self, waker: Waker, laddrs: &[SocketAddr]) -> CancelablePoll<io::Result<Handle>>;
/// Sends data on the socket to the given `target` address.
///
/// On success, returns the number of bytes written.
///
/// Returns [`CancelablePoll::Pending(CancelHandle)`](CancelablePoll::Pending),
/// indicating that the current operation could not be completed
/// immediately and needs to be retried later.
fn udp_send_to(
&self,
waker: Waker,
socket: &Handle,
buf: &[u8],
target: SocketAddr,
) -> CancelablePoll<io::Result<usize>>;
/// Receives data from the socket.
///
/// On success, returns the number of bytes read and the origin.
///
/// Returns [`CancelablePoll::Pending(CancelHandle)`](CancelablePoll::Pending),
/// indicating that the current operation could not be completed
/// immediately and needs to be retried later.
fn udp_recv_from(
&self,
waker: Waker,
socket: &Handle,
buf: &mut [u8],
) -> CancelablePoll<io::Result<(usize, SocketAddr)>>;
/// Create new `TcpListener` which will be bound to the specified `laddrs`
///
/// The returned listener is ready for accepting connections.
///
/// Binding with a port number of 0 will request that the OS assigns a port to this listener.
/// The port allocated can be queried via the [`tcp_listener_local_addr`](Self::tcp_listener_local_addr) method.
///
/// Returns [`CancelablePoll::Pending(CancelHandle)`](CancelablePoll::Pending),
/// indicating that the current operation could not be completed
/// immediately and needs to be retried later.
fn tcp_listener_bind(
&self,
waker: Waker,
laddrs: &[SocketAddr],
) -> CancelablePoll<io::Result<Handle>>;
/// Returns the local [`socket address`](SocketAddr) bound to this tcp listener.
fn tcp_listener_local_addr(&self, handle: &Handle) -> io::Result<SocketAddr>;
/// Gets the value of the IP_TTL option for this socket.
/// For more information about this option, see [`tcp_listener_set_ttl`](Self::tcp_listener_set_ttl).
fn tcp_listener_ttl(&self, handle: &Handle) -> io::Result<u32>;
/// Sets the value for the IP_TTL option on this socket.
/// This value sets the time-to-live field that is used in every packet sent from this socket.
fn tcp_listener_set_ttl(&self, handle: &Handle, ttl: u32) -> io::Result<()>;
/// Accepts a new incoming connection to this tcp listener.
///
/// When a connection is established, the corresponding stream and address will be returned.
///
/// Returns [`CancelablePoll::Pending(CancelHandle)`](CancelablePoll::Pending),
/// indicating that the current operation could not be completed
/// immediately and needs to be retried later.
fn tcp_listener_accept(
&self,
waker: Waker,
handle: &Handle,
) -> CancelablePoll<io::Result<(Handle, SocketAddr)>>;
/// Create a new `TcpStream` and connect to `raddrs`.
///
/// The port allocated can be queried via the [`tcp_stream_local_addr`](Self::tcp_stream_local_addr) method.
///
/// Returns [`CancelablePoll::Pending(CancelHandle)`](CancelablePoll::Pending),
/// indicating that the current operation could not be completed
/// immediately and needs to be retried later.
fn tcp_stream_connect(
&self,
waker: Waker,
raddrs: &[SocketAddr],
) -> CancelablePoll<io::Result<Handle>>;
/// Sends data on the socket to the remote address
///
/// On success, returns the number of bytes written.
fn tcp_stream_write(
&self,
waker: Waker,
socket: &Handle,
buf: &[u8],
) -> CancelablePoll<io::Result<usize>>;
/// Receives data from the socket.
///
/// On success, returns the number of bytes read.
fn tcp_stream_read(
&self,
waker: Waker,
socket: &Handle,
buf: &mut [u8],
) -> CancelablePoll<io::Result<usize>>;
/// Returns the local [`socket address`](SocketAddr) bound to this tcp stream.
fn tcp_stream_local_addr(&self, handle: &Handle) -> io::Result<SocketAddr>;
/// Returns the remote [`socket address`](SocketAddr) this tcp stream connected.
fn tcp_stream_remote_addr(&self, handle: &Handle) -> io::Result<SocketAddr>;
/// Gets the value of the TCP_NODELAY option on this socket.
/// For more information about this option, see [`tcp_stream_set_nodelay`](Self::tcp_stream_set_nodelay).
fn tcp_stream_nodelay(&self, handle: &Handle) -> io::Result<bool>;
/// Sets the value of the TCP_NODELAY option on this socket.
///
/// If set, this option disables the Nagle algorithm.
/// This means that segments are always sent as soon as possible,
/// even if there is only a small amount of data. When not set,
/// data is buffered until there is a sufficient amount to send out,
/// thereby avoiding the frequent sending of small packets.
fn tcp_stream_set_nodelay(&self, handle: &Handle, nodelay: bool) -> io::Result<()>;
/// Gets the value of the IP_TTL option for this socket.
/// For more information about this option, see [`tcp_listener_set_ttl`](Self::tcp_listener_set_ttl).
fn tcp_stream_ttl(&self, handle: &Handle) -> io::Result<u32>;
/// Sets the value for the IP_TTL option on this socket.
/// This value sets the time-to-live field that is used in every packet sent from this socket.
fn tcp_stream_set_ttl(&self, handle: &Handle, ttl: u32) -> io::Result<()>;
/// Shuts down the read, write, or both halves of this connection.
/// This function will cause all pending and future I/O on the specified
/// portions to return immediately with an appropriate value (see the documentation of Shutdown).
fn tcp_stream_shutdown(&self, handle: &Handle, how: Shutdown) -> io::Result<()>;
/// Creates a new UnixListener bound to the specified socket path.
#[cfg(unix)]
fn unix_listener_bind(
&self,
waker: Waker,
path: &std::path::Path,
) -> CancelablePoll<io::Result<Handle>>;
/// Accepts a new incoming connection to this listener.
/// The call is responsible for ensuring that the listening socket is in non-blocking mode.
#[cfg(unix)]
fn unix_listener_accept(
&self,
waker: Waker,
handle: &Handle,
) -> CancelablePoll<io::Result<(Handle, std::os::unix::net::SocketAddr)>>;
/// Returns the local socket address of this listener.
#[cfg(unix)]
fn unix_listener_local_addr(
&self,
handle: &Handle,
) -> io::Result<std::os::unix::net::SocketAddr>;
/// Connects to the unix socket named by address.
#[cfg(unix)]
fn unix_stream_connect(
&self,
waker: Waker,
path: &std::path::Path,
) -> CancelablePoll<io::Result<Handle>>;
/// Returns the socket address of the local half of this connection.
#[cfg(all(unix, feature = "unix_socket"))]
fn unix_stream_local_addr(&self, handle: &Handle)
-> io::Result<std::os::unix::net::SocketAddr>;
/// Returns the socket address of the remote half of this connection.
#[cfg(all(unix, feature = "unix_socket"))]
fn unix_stream_peer_addr(&self, handle: &Handle) -> io::Result<std::os::unix::net::SocketAddr>;
/// huts down the read, write, or both halves of this connection.
/// This function will cause all pending and future I/O calls on the specified portions
/// to immediately return with an appropriate value (see the documentation of [`Shutdown`]).
#[cfg(all(unix, feature = "unix_socket"))]
fn unix_stream_shutdown(&self, handle: &Handle, how: Shutdown) -> io::Result<()>;
/// Sends data on the socket to the remote address
///
/// On success, returns the number of bytes written.
#[cfg(all(unix, feature = "unix_socket"))]
fn unix_stream_write(
&self,
waker: Waker,
socket: &Handle,
buf: &[u8],
) -> CancelablePoll<io::Result<usize>>;
/// Receives data from the socket.
///
/// On success, returns the number of bytes read.
#[cfg(all(unix, feature = "unix_socket"))]
fn unix_stream_read(
&self,
waker: Waker,
socket: &Handle,
buf: &mut [u8],
) -> CancelablePoll<io::Result<usize>>;
}
static GLOBAL_NETWORK: OnceLock<Box<dyn Network>> = OnceLock::new();
/// Register provided [`Network`] as global network implementation.
///
/// # Panic
///
/// Multiple calls to this function are not permitted!!!
pub fn register_global_network<E: Network + 'static>(executor: E) {
if GLOBAL_NETWORK.set(Box::new(executor)).is_err() {
panic!("Multiple calls to register_global_network are not permitted!!!");
}
}
/// Get the globally registered instance of [`Network`].
///
/// # Panic
///
/// You should call [`register_global_network`] first to register implementation,
/// otherwise this function will cause a panic with `Call register_global_network first`
pub fn global_network() -> &'static dyn Network {
GLOBAL_NETWORK
.get()
.expect("Call register_global_network first")
.as_ref()
}