1*13776c11Slogin use core::{ 2*13776c11Slogin fmt::{self, Debug}, 3*13776c11Slogin sync::atomic::AtomicUsize, 4*13776c11Slogin }; 54454d1a2Slogin 6*13776c11Slogin use alloc::{boxed::Box, collections::BTreeMap, sync::Arc}; 7*13776c11Slogin 8*13776c11Slogin use crate::{driver::net::NetDriver, libs::rwlock::RwLock, syscall::SystemError}; 9*13776c11Slogin use smoltcp::wire::IpEndpoint; 10*13776c11Slogin 11*13776c11Slogin use self::socket::SocketMetadata; 12*13776c11Slogin 13*13776c11Slogin pub mod endpoints; 14*13776c11Slogin pub mod net_core; 15*13776c11Slogin pub mod socket; 16*13776c11Slogin 17*13776c11Slogin lazy_static! { 18*13776c11Slogin /// @brief 所有网络接口的列表 19*13776c11Slogin pub static ref NET_DRIVERS: RwLock<BTreeMap<usize, Arc<dyn NetDriver>>> = RwLock::new(BTreeMap::new()); 20*13776c11Slogin } 21*13776c11Slogin 22*13776c11Slogin /// @brief 生成网络接口的id (全局自增) 23*13776c11Slogin pub fn generate_iface_id() -> usize { 24*13776c11Slogin static IFACE_ID: AtomicUsize = AtomicUsize::new(0); 25*13776c11Slogin return IFACE_ID 26*13776c11Slogin .fetch_add(1, core::sync::atomic::Ordering::SeqCst) 27*13776c11Slogin .into(); 28*13776c11Slogin } 29*13776c11Slogin 30*13776c11Slogin /// @brief 用于指定socket的关闭类型 31*13776c11Slogin #[derive(Debug, Clone)] 32*13776c11Slogin pub enum ShutdownType { 33*13776c11Slogin ShutRd, // Disables further receive operations. 34*13776c11Slogin ShutWr, // Disables further send operations. 35*13776c11Slogin ShutRdwr, // Disables further send and receive operations. 36*13776c11Slogin } 37*13776c11Slogin 38*13776c11Slogin #[derive(Debug, Clone)] 39*13776c11Slogin pub enum Endpoint { 40*13776c11Slogin /// 链路层端点 41*13776c11Slogin LinkLayer(endpoints::LinkLayerEndpoint), 42*13776c11Slogin /// 网络层端点 43*13776c11Slogin Ip(IpEndpoint), 44*13776c11Slogin // todo: 增加NetLink机制后,增加NetLink端点 45*13776c11Slogin } 464454d1a2Slogin 474454d1a2Slogin pub trait Socket: Sync + Send + Debug { 48*13776c11Slogin /// @brief 从socket中读取数据,如果socket是阻塞的,那么直到读取到数据才返回 49*13776c11Slogin /// 50*13776c11Slogin /// @param buf 读取到的数据存放的缓冲区 51*13776c11Slogin /// 52*13776c11Slogin /// @return - 成功:(返回读取的数据的长度,读取数据的端点). 53*13776c11Slogin /// - 失败:错误码 54*13776c11Slogin fn read(&self, buf: &mut [u8]) -> Result<(usize, Endpoint), SystemError>; 554454d1a2Slogin 56*13776c11Slogin /// @brief 向socket中写入数据。如果socket是阻塞的,那么直到写入的数据全部写入socket中才返回 57*13776c11Slogin /// 58*13776c11Slogin /// @param buf 要写入的数据 59*13776c11Slogin /// @param to 要写入的目的端点,如果是None,那么写入的数据将会被丢弃 60*13776c11Slogin /// 61*13776c11Slogin /// @return 返回写入的数据的长度 62*13776c11Slogin fn write(&self, buf: &[u8], to: Option<Endpoint>) -> Result<usize, SystemError>; 63*13776c11Slogin 64*13776c11Slogin /// @brief 对应于POSIX的connect函数,用于连接到指定的远程服务器端点 65*13776c11Slogin /// 66*13776c11Slogin /// It is used to establish a connection to a remote server. 67*13776c11Slogin /// When a socket is connected to a remote server, 68*13776c11Slogin /// the operating system will establish a network connection with the server 69*13776c11Slogin /// and allow data to be sent and received between the local socket and the remote server. 70*13776c11Slogin /// 71*13776c11Slogin /// @param endpoint 要连接的端点 72*13776c11Slogin /// 73*13776c11Slogin /// @return 返回连接是否成功 74*13776c11Slogin fn connect(&mut self, endpoint: Endpoint) -> Result<(), SystemError>; 75*13776c11Slogin 76*13776c11Slogin /// @brief 对应于POSIX的bind函数,用于绑定到本机指定的端点 77*13776c11Slogin /// 78*13776c11Slogin /// The bind() function is used to associate a socket with a particular IP address and port number on the local machine. 79*13776c11Slogin /// 80*13776c11Slogin /// @param endpoint 要绑定的端点 81*13776c11Slogin /// 82*13776c11Slogin /// @return 返回绑定是否成功 83*13776c11Slogin fn bind(&self, _endpoint: Endpoint) -> Result<(), SystemError> { 84*13776c11Slogin return Err(SystemError::ENOSYS); 85*13776c11Slogin } 86*13776c11Slogin 87*13776c11Slogin /// @brief 对应于 POSIX 的 shutdown 函数,用于关闭socket。 88*13776c11Slogin /// 89*13776c11Slogin /// shutdown() 函数用于启动网络连接的正常关闭。 90*13776c11Slogin /// 当在两个端点之间建立网络连接时,任一端点都可以通过调用其端点对象上的 shutdown() 函数来启动关闭序列。 91*13776c11Slogin /// 此函数向远程端点发送关闭消息以指示本地端点不再接受新数据。 92*13776c11Slogin /// 93*13776c11Slogin /// @return 返回是否成功关闭 94*13776c11Slogin fn shutdown(&self, _type: ShutdownType) -> Result<(), SystemError> { 95*13776c11Slogin return Err(SystemError::ENOSYS); 96*13776c11Slogin } 97*13776c11Slogin 98*13776c11Slogin /// @brief 对应于POSIX的listen函数,用于监听端点 99*13776c11Slogin /// 100*13776c11Slogin /// @param backlog 最大的等待连接数 101*13776c11Slogin /// 102*13776c11Slogin /// @return 返回监听是否成功 103*13776c11Slogin fn listen(&mut self, _backlog: usize) -> Result<(), SystemError> { 104*13776c11Slogin return Err(SystemError::ENOSYS); 105*13776c11Slogin } 106*13776c11Slogin 107*13776c11Slogin /// @brief 对应于POSIX的accept函数,用于接受连接 108*13776c11Slogin /// 109*13776c11Slogin /// @param endpoint 用于返回连接的端点 110*13776c11Slogin /// 111*13776c11Slogin /// @return 返回接受连接是否成功 112*13776c11Slogin fn accept(&mut self) -> Result<(Box<dyn Socket>, Endpoint), SystemError> { 113*13776c11Slogin return Err(SystemError::ENOSYS); 114*13776c11Slogin } 115*13776c11Slogin 116*13776c11Slogin /// @brief 获取socket的端点 117*13776c11Slogin /// 118*13776c11Slogin /// @return 返回socket的端点 119*13776c11Slogin fn endpoint(&self) -> Option<Endpoint> { 120*13776c11Slogin return None; 121*13776c11Slogin } 122*13776c11Slogin 123*13776c11Slogin /// @brief 获取socket的对端端点 124*13776c11Slogin /// 125*13776c11Slogin /// @return 返回socket的对端端点 126*13776c11Slogin fn peer_endpoint(&self) -> Option<Endpoint> { 127*13776c11Slogin return None; 128*13776c11Slogin } 129*13776c11Slogin 130*13776c11Slogin /// @brief 131*13776c11Slogin /// The purpose of the poll function is to provide 132*13776c11Slogin /// a non-blocking way to check if a socket is ready for reading or writing, 133*13776c11Slogin /// so that you can efficiently handle multiple sockets in a single thread or event loop. 134*13776c11Slogin /// 135*13776c11Slogin /// @return (in, out, err) 136*13776c11Slogin /// 137*13776c11Slogin /// The first boolean value indicates whether the socket is ready for reading. If it is true, then there is data available to be read from the socket without blocking. 138*13776c11Slogin /// The second boolean value indicates whether the socket is ready for writing. If it is true, then data can be written to the socket without blocking. 139*13776c11Slogin /// The third boolean value indicates whether the socket has encountered an error condition. If it is true, then the socket is in an error state and should be closed or reset 140*13776c11Slogin /// 141*13776c11Slogin fn poll(&self) -> (bool, bool, bool) { 142*13776c11Slogin return (false, false, false); 143*13776c11Slogin } 144*13776c11Slogin 145*13776c11Slogin /// @brief socket的ioctl函数 146*13776c11Slogin /// 147*13776c11Slogin /// @param cmd ioctl命令 148*13776c11Slogin /// @param arg0 ioctl命令的第一个参数 149*13776c11Slogin /// @param arg1 ioctl命令的第二个参数 150*13776c11Slogin /// @param arg2 ioctl命令的第三个参数 151*13776c11Slogin /// 152*13776c11Slogin /// @return 返回ioctl命令的返回值 153*13776c11Slogin fn ioctl( 154*13776c11Slogin &self, 155*13776c11Slogin _cmd: usize, 156*13776c11Slogin _arg0: usize, 157*13776c11Slogin _arg1: usize, 158*13776c11Slogin _arg2: usize, 159*13776c11Slogin ) -> Result<usize, SystemError> { 160*13776c11Slogin return Ok(0); 161*13776c11Slogin } 162*13776c11Slogin 163*13776c11Slogin /// @brief 获取socket的元数据 164*13776c11Slogin fn metadata(&self) -> Result<SocketMetadata, SystemError>; 165*13776c11Slogin 166*13776c11Slogin fn box_clone(&self) -> Box<dyn Socket>; 167*13776c11Slogin } 168*13776c11Slogin 169*13776c11Slogin impl Clone for Box<dyn Socket> { 170*13776c11Slogin fn clone(&self) -> Box<dyn Socket> { 171*13776c11Slogin self.box_clone() 172*13776c11Slogin } 173*13776c11Slogin } 174*13776c11Slogin 175*13776c11Slogin /// IP datagram encapsulated protocol. 176*13776c11Slogin #[derive(Debug, PartialEq, Eq, Clone, Copy)] 177*13776c11Slogin #[repr(u8)] 178*13776c11Slogin pub enum Protocol { 179*13776c11Slogin HopByHop = 0x00, 180*13776c11Slogin Icmp = 0x01, 181*13776c11Slogin Igmp = 0x02, 182*13776c11Slogin Tcp = 0x06, 183*13776c11Slogin Udp = 0x11, 184*13776c11Slogin Ipv6Route = 0x2b, 185*13776c11Slogin Ipv6Frag = 0x2c, 186*13776c11Slogin Icmpv6 = 0x3a, 187*13776c11Slogin Ipv6NoNxt = 0x3b, 188*13776c11Slogin Ipv6Opts = 0x3c, 189*13776c11Slogin Unknown(u8), 190*13776c11Slogin } 191*13776c11Slogin 192*13776c11Slogin impl fmt::Display for Protocol { 193*13776c11Slogin fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { 194*13776c11Slogin match *self { 195*13776c11Slogin Protocol::HopByHop => write!(f, "Hop-by-Hop"), 196*13776c11Slogin Protocol::Icmp => write!(f, "ICMP"), 197*13776c11Slogin Protocol::Igmp => write!(f, "IGMP"), 198*13776c11Slogin Protocol::Tcp => write!(f, "TCP"), 199*13776c11Slogin Protocol::Udp => write!(f, "UDP"), 200*13776c11Slogin Protocol::Ipv6Route => write!(f, "IPv6-Route"), 201*13776c11Slogin Protocol::Ipv6Frag => write!(f, "IPv6-Frag"), 202*13776c11Slogin Protocol::Icmpv6 => write!(f, "ICMPv6"), 203*13776c11Slogin Protocol::Ipv6NoNxt => write!(f, "IPv6-NoNxt"), 204*13776c11Slogin Protocol::Ipv6Opts => write!(f, "IPv6-Opts"), 205*13776c11Slogin Protocol::Unknown(id) => write!(f, "0x{id:02x}"), 206*13776c11Slogin } 207*13776c11Slogin } 208*13776c11Slogin } 209*13776c11Slogin 210*13776c11Slogin impl From<smoltcp::wire::IpProtocol> for Protocol { 211*13776c11Slogin fn from(value: smoltcp::wire::IpProtocol) -> Self { 212*13776c11Slogin let x: u8 = value.into(); 213*13776c11Slogin Protocol::from(x) 214*13776c11Slogin } 215*13776c11Slogin } 216*13776c11Slogin 217*13776c11Slogin impl From<u8> for Protocol { 218*13776c11Slogin fn from(value: u8) -> Self { 219*13776c11Slogin match value { 220*13776c11Slogin 0x00 => Protocol::HopByHop, 221*13776c11Slogin 0x01 => Protocol::Icmp, 222*13776c11Slogin 0x02 => Protocol::Igmp, 223*13776c11Slogin 0x06 => Protocol::Tcp, 224*13776c11Slogin 0x11 => Protocol::Udp, 225*13776c11Slogin 0x2b => Protocol::Ipv6Route, 226*13776c11Slogin 0x2c => Protocol::Ipv6Frag, 227*13776c11Slogin 0x3a => Protocol::Icmpv6, 228*13776c11Slogin 0x3b => Protocol::Ipv6NoNxt, 229*13776c11Slogin 0x3c => Protocol::Ipv6Opts, 230*13776c11Slogin _ => Protocol::Unknown(value), 231*13776c11Slogin } 232*13776c11Slogin } 233*13776c11Slogin } 234*13776c11Slogin 235*13776c11Slogin impl Into<u8> for Protocol { 236*13776c11Slogin fn into(self) -> u8 { 237*13776c11Slogin match self { 238*13776c11Slogin Protocol::HopByHop => 0x00, 239*13776c11Slogin Protocol::Icmp => 0x01, 240*13776c11Slogin Protocol::Igmp => 0x02, 241*13776c11Slogin Protocol::Tcp => 0x06, 242*13776c11Slogin Protocol::Udp => 0x11, 243*13776c11Slogin Protocol::Ipv6Route => 0x2b, 244*13776c11Slogin Protocol::Ipv6Frag => 0x2c, 245*13776c11Slogin Protocol::Icmpv6 => 0x3a, 246*13776c11Slogin Protocol::Ipv6NoNxt => 0x3b, 247*13776c11Slogin Protocol::Ipv6Opts => 0x3c, 248*13776c11Slogin Protocol::Unknown(id) => id, 249*13776c11Slogin } 250*13776c11Slogin } 2514454d1a2Slogin } 252