240 lines
8.0 KiB
Rust
240 lines
8.0 KiB
Rust
/*! Communication between endpoints.
|
|
|
|
The `socket` module deals with *network endpoints* and *buffering*.
|
|
It provides interfaces for accessing buffers of data, and protocol state machines
|
|
for filling and emptying these buffers.
|
|
|
|
The programming interface implemented here differs greatly from the common Berkeley socket
|
|
interface. Specifically, in the Berkeley interface the buffering is implicit:
|
|
the operating system decides on the good size for a buffer and manages it.
|
|
The interface implemented by this module uses explicit buffering: you decide on the good
|
|
size for a buffer, allocate it, and let the networking stack use it.
|
|
*/
|
|
|
|
use crate::phy::DeviceCapabilities;
|
|
use crate::time::Instant;
|
|
|
|
#[cfg(feature = "socket-dhcpv4")]
|
|
mod dhcpv4;
|
|
#[cfg(all(
|
|
feature = "socket-icmp",
|
|
any(feature = "proto-ipv4", feature = "proto-ipv6")
|
|
))]
|
|
mod icmp;
|
|
mod meta;
|
|
#[cfg(feature = "socket-raw")]
|
|
mod raw;
|
|
mod ref_;
|
|
mod set;
|
|
#[cfg(feature = "socket-tcp")]
|
|
mod tcp;
|
|
#[cfg(feature = "socket-udp")]
|
|
mod udp;
|
|
|
|
#[cfg(feature = "async")]
|
|
mod waker;
|
|
|
|
pub(crate) use self::meta::Meta as SocketMeta;
|
|
#[cfg(feature = "async")]
|
|
pub(crate) use self::waker::WakerRegistration;
|
|
|
|
#[cfg(feature = "socket-raw")]
|
|
pub use self::raw::{RawPacketMetadata, RawSocket, RawSocketBuffer};
|
|
|
|
#[cfg(all(
|
|
feature = "socket-icmp",
|
|
any(feature = "proto-ipv4", feature = "proto-ipv6")
|
|
))]
|
|
pub use self::icmp::{Endpoint as IcmpEndpoint, IcmpPacketMetadata, IcmpSocket, IcmpSocketBuffer};
|
|
|
|
#[cfg(feature = "socket-udp")]
|
|
pub use self::udp::{UdpPacketMetadata, UdpSocket, UdpSocketBuffer};
|
|
|
|
#[cfg(feature = "socket-tcp")]
|
|
pub use self::tcp::{SocketBuffer as TcpSocketBuffer, State as TcpState, TcpSocket};
|
|
|
|
#[cfg(feature = "socket-dhcpv4")]
|
|
pub use self::dhcpv4::{Config as Dhcpv4Config, Dhcpv4Socket, Event as Dhcpv4Event};
|
|
|
|
pub use self::set::{Handle as SocketHandle, Item as SocketSetItem, Set as SocketSet};
|
|
pub use self::set::{Iter as SocketSetIter, IterMut as SocketSetIterMut};
|
|
|
|
pub use self::ref_::Ref as SocketRef;
|
|
pub(crate) use self::ref_::Session as SocketSession;
|
|
|
|
/// Gives an indication on the next time the socket should be polled.
|
|
#[derive(Debug, PartialOrd, Ord, PartialEq, Eq, Clone, Copy)]
|
|
#[cfg_attr(feature = "defmt", derive(defmt::Format))]
|
|
pub(crate) enum PollAt {
|
|
/// The socket needs to be polled immidiately.
|
|
Now,
|
|
/// The socket needs to be polled at given [Instant][struct.Instant].
|
|
Time(Instant),
|
|
/// The socket does not need to be polled unless there are external changes.
|
|
Ingress,
|
|
}
|
|
|
|
/// A network socket.
|
|
///
|
|
/// This enumeration abstracts the various types of sockets based on the IP protocol.
|
|
/// To downcast a `Socket` value to a concrete socket, use the [AnySocket] trait,
|
|
/// e.g. to get `UdpSocket`, call `UdpSocket::downcast(socket)`.
|
|
///
|
|
/// It is usually more convenient to use [SocketSet::get] instead.
|
|
///
|
|
/// [AnySocket]: trait.AnySocket.html
|
|
/// [SocketSet::get]: struct.SocketSet.html#method.get
|
|
#[derive(Debug)]
|
|
pub enum Socket<'a> {
|
|
#[cfg(feature = "socket-raw")]
|
|
Raw(RawSocket<'a>),
|
|
#[cfg(all(
|
|
feature = "socket-icmp",
|
|
any(feature = "proto-ipv4", feature = "proto-ipv6")
|
|
))]
|
|
Icmp(IcmpSocket<'a>),
|
|
#[cfg(feature = "socket-udp")]
|
|
Udp(UdpSocket<'a>),
|
|
#[cfg(feature = "socket-tcp")]
|
|
Tcp(TcpSocket<'a>),
|
|
#[cfg(feature = "socket-dhcpv4")]
|
|
Dhcpv4(Dhcpv4Socket),
|
|
}
|
|
|
|
macro_rules! dispatch_socket {
|
|
($self_:expr, |$socket:ident| $code:expr) => {
|
|
dispatch_socket!(@inner $self_, |$socket| $code)
|
|
};
|
|
(mut $self_:expr, |$socket:ident| $code:expr) => {
|
|
dispatch_socket!(@inner mut $self_, |$socket| $code)
|
|
};
|
|
(@inner $( $mut_:ident )* $self_:expr, |$socket:ident| $code:expr) => {
|
|
match $self_ {
|
|
#[cfg(feature = "socket-raw")]
|
|
&$( $mut_ )* Socket::Raw(ref $( $mut_ )* $socket) => $code,
|
|
#[cfg(all(feature = "socket-icmp", any(feature = "proto-ipv4", feature = "proto-ipv6")))]
|
|
&$( $mut_ )* Socket::Icmp(ref $( $mut_ )* $socket) => $code,
|
|
#[cfg(feature = "socket-udp")]
|
|
&$( $mut_ )* Socket::Udp(ref $( $mut_ )* $socket) => $code,
|
|
#[cfg(feature = "socket-tcp")]
|
|
&$( $mut_ )* Socket::Tcp(ref $( $mut_ )* $socket) => $code,
|
|
#[cfg(feature = "socket-dhcpv4")]
|
|
&$( $mut_ )* Socket::Dhcpv4(ref $( $mut_ )* $socket) => $code,
|
|
}
|
|
};
|
|
}
|
|
|
|
impl<'a> Socket<'a> {
|
|
/// Return the socket handle.
|
|
#[inline]
|
|
pub fn handle(&self) -> SocketHandle {
|
|
self.meta().handle
|
|
}
|
|
|
|
pub(crate) fn meta(&self) -> &SocketMeta {
|
|
dispatch_socket!(self, |socket| &socket.meta)
|
|
}
|
|
|
|
pub(crate) fn meta_mut(&mut self) -> &mut SocketMeta {
|
|
dispatch_socket!(mut self, |socket| &mut socket.meta)
|
|
}
|
|
|
|
pub(crate) fn poll_at(&self, cx: &Context) -> PollAt {
|
|
dispatch_socket!(self, |socket| socket.poll_at(cx))
|
|
}
|
|
}
|
|
|
|
impl<'a> SocketSession for Socket<'a> {
|
|
fn finish(&mut self) {
|
|
dispatch_socket!(mut self, |socket| socket.finish())
|
|
}
|
|
}
|
|
|
|
/// A conversion trait for network sockets.
|
|
pub trait AnySocket<'a>: SocketSession + Sized {
|
|
fn downcast<'c>(socket_ref: SocketRef<'c, Socket<'a>>) -> Option<SocketRef<'c, Self>>;
|
|
}
|
|
|
|
macro_rules! from_socket {
|
|
($socket:ty, $variant:ident) => {
|
|
impl<'a> AnySocket<'a> for $socket {
|
|
fn downcast<'c>(ref_: SocketRef<'c, Socket<'a>>) -> Option<SocketRef<'c, Self>> {
|
|
if let Socket::$variant(ref mut socket) = SocketRef::into_inner(ref_) {
|
|
Some(SocketRef::new(socket))
|
|
} else {
|
|
None
|
|
}
|
|
}
|
|
}
|
|
};
|
|
}
|
|
|
|
#[cfg(feature = "socket-raw")]
|
|
from_socket!(RawSocket<'a>, Raw);
|
|
#[cfg(all(
|
|
feature = "socket-icmp",
|
|
any(feature = "proto-ipv4", feature = "proto-ipv6")
|
|
))]
|
|
from_socket!(IcmpSocket<'a>, Icmp);
|
|
#[cfg(feature = "socket-udp")]
|
|
from_socket!(UdpSocket<'a>, Udp);
|
|
#[cfg(feature = "socket-tcp")]
|
|
from_socket!(TcpSocket<'a>, Tcp);
|
|
#[cfg(feature = "socket-dhcpv4")]
|
|
from_socket!(Dhcpv4Socket, Dhcpv4);
|
|
|
|
/// Data passed to sockets when processing.
|
|
#[derive(Clone, Debug)]
|
|
pub(crate) struct Context {
|
|
pub now: Instant,
|
|
#[cfg(all(
|
|
any(feature = "medium-ethernet", feature = "medium-ieee802154"),
|
|
feature = "socket-dhcpv4"
|
|
))]
|
|
pub hardware_addr: Option<crate::wire::HardwareAddress>,
|
|
#[cfg(feature = "medium-ieee802154")]
|
|
pub src_pan_id: Option<crate::wire::Ieee802154Pan>,
|
|
#[cfg(feature = "medium-ieee802154")]
|
|
pub dst_pan_id: Option<crate::wire::Ieee802154Pan>,
|
|
pub caps: DeviceCapabilities,
|
|
}
|
|
|
|
#[cfg(test)]
|
|
impl Context {
|
|
pub(crate) const DUMMY: Context = Context {
|
|
caps: DeviceCapabilities {
|
|
#[cfg(feature = "medium-ethernet")]
|
|
medium: crate::phy::Medium::Ethernet,
|
|
#[cfg(not(feature = "medium-ethernet"))]
|
|
medium: crate::phy::Medium::Ip,
|
|
checksum: crate::phy::ChecksumCapabilities {
|
|
#[cfg(feature = "proto-ipv4")]
|
|
icmpv4: crate::phy::Checksum::Both,
|
|
#[cfg(feature = "proto-ipv6")]
|
|
icmpv6: crate::phy::Checksum::Both,
|
|
ipv4: crate::phy::Checksum::Both,
|
|
tcp: crate::phy::Checksum::Both,
|
|
udp: crate::phy::Checksum::Both,
|
|
},
|
|
max_burst_size: None,
|
|
#[cfg(feature = "medium-ethernet")]
|
|
max_transmission_unit: 1514,
|
|
#[cfg(not(feature = "medium-ethernet"))]
|
|
max_transmission_unit: 1500,
|
|
},
|
|
#[cfg(all(
|
|
any(feature = "medium-ethernet", feature = "medium-ieee802154"),
|
|
feature = "socket-dhcpv4"
|
|
))]
|
|
hardware_addr: Some(crate::wire::HardwareAddress::Ethernet(
|
|
crate::wire::EthernetAddress([0x02, 0x02, 0x02, 0x02, 0x02, 0x02]),
|
|
)),
|
|
now: Instant::from_millis_const(0),
|
|
|
|
#[cfg(feature = "medium-ieee802154")]
|
|
src_pan_id: Some(crate::wire::Ieee802154Pan(0xabcd)),
|
|
#[cfg(feature = "medium-ieee802154")]
|
|
dst_pan_id: Some(crate::wire::Ieee802154Pan(0xabcd)),
|
|
};
|
|
}
|