5 use crate::convert::{TryFrom, TryInto};
6 use crate::ffi::CString;
8 use crate::io::{self, ErrorKind, IoSlice, IoSliceMut};
10 use crate::net::{Ipv4Addr, Ipv6Addr, Shutdown, SocketAddr};
12 use crate::sys::net::netc as c;
13 use crate::sys::net::{cvt, cvt_gai, cvt_r, init, wrlen_t, Socket};
14 use crate::sys_common::{AsInner, FromInner, IntoInner};
15 use crate::time::Duration;
17 use libc::{c_int, c_void};
21 target_os = "dragonfly", target_os = "freebsd",
22 target_os = "ios", target_os = "macos",
23 target_os = "openbsd", target_os = "netbsd", target_os = "illumos",
24 target_os = "solaris", target_os = "haiku", target_os = "l4re"))] {
25 use crate::sys::net::netc::IPV6_JOIN_GROUP as IPV6_ADD_MEMBERSHIP;
26 use crate::sys::net::netc::IPV6_LEAVE_GROUP as IPV6_DROP_MEMBERSHIP;
28 use crate::sys::net::netc::IPV6_ADD_MEMBERSHIP;
29 use crate::sys::net::netc::IPV6_DROP_MEMBERSHIP;
35 target_os = "linux", target_os = "android",
36 target_os = "dragonfly", target_os = "freebsd",
37 target_os = "openbsd", target_os = "netbsd",
38 target_os = "haiku"))] {
39 use libc::MSG_NOSIGNAL;
41 const MSG_NOSIGNAL: c_int = 0x0;
47 target_os = "dragonfly", target_os = "freebsd",
48 target_os = "openbsd", target_os = "netbsd",
49 target_os = "solaris", target_os = "illumos"))] {
51 type IpV4MultiCastType = c_uchar;
53 type IpV4MultiCastType = c_int;
57 ////////////////////////////////////////////////////////////////////////////////
58 // sockaddr and misc bindings
59 ////////////////////////////////////////////////////////////////////////////////
72 &option_value as *const T as *const _,
73 mem::size_of::<T>() as c::socklen_t,
79 pub fn getsockopt<T: Copy>(sock: &Socket, level: c_int, option_name: c_int) -> io::Result<T> {
81 let mut option_value: T = mem::zeroed();
82 let mut option_len = mem::size_of::<T>() as c::socklen_t;
87 &mut option_value as *mut T as *mut _,
94 fn sockname<F>(f: F) -> io::Result<SocketAddr>
96 F: FnOnce(*mut c::sockaddr, *mut c::socklen_t) -> c_int,
99 let mut storage: c::sockaddr_storage = mem::zeroed();
100 let mut len = mem::size_of_val(&storage) as c::socklen_t;
101 cvt(f(&mut storage as *mut _ as *mut _, &mut len))?;
102 sockaddr_to_addr(&storage, len as usize)
106 pub fn sockaddr_to_addr(storage: &c::sockaddr_storage, len: usize) -> io::Result<SocketAddr> {
107 match storage.ss_family as c_int {
109 assert!(len as usize >= mem::size_of::<c::sockaddr_in>());
110 Ok(SocketAddr::V4(FromInner::from_inner(unsafe {
111 *(storage as *const _ as *const c::sockaddr_in)
115 assert!(len as usize >= mem::size_of::<c::sockaddr_in6>());
116 Ok(SocketAddr::V6(FromInner::from_inner(unsafe {
117 *(storage as *const _ as *const c::sockaddr_in6)
120 _ => Err(io::const_io_error!(ErrorKind::InvalidInput, "invalid argument")),
124 #[cfg(target_os = "android")]
125 fn to_ipv6mr_interface(value: u32) -> c_int {
129 #[cfg(not(target_os = "android"))]
130 fn to_ipv6mr_interface(value: u32) -> libc::c_uint {
131 value as libc::c_uint
134 ////////////////////////////////////////////////////////////////////////////////
135 // get_host_addresses
136 ////////////////////////////////////////////////////////////////////////////////
138 pub struct LookupHost {
139 original: *mut c::addrinfo,
140 cur: *mut c::addrinfo,
145 pub fn port(&self) -> u16 {
150 impl Iterator for LookupHost {
151 type Item = SocketAddr;
152 fn next(&mut self) -> Option<SocketAddr> {
155 let cur = self.cur.as_ref()?;
156 self.cur = cur.ai_next;
157 match sockaddr_to_addr(mem::transmute(cur.ai_addr), cur.ai_addrlen as usize) {
158 Ok(addr) => return Some(addr),
166 unsafe impl Sync for LookupHost {}
167 unsafe impl Send for LookupHost {}
169 impl Drop for LookupHost {
171 unsafe { c::freeaddrinfo(self.original) }
175 impl TryFrom<&str> for LookupHost {
176 type Error = io::Error;
178 fn try_from(s: &str) -> io::Result<LookupHost> {
179 macro_rules! try_opt {
180 ($e:expr, $msg:expr) => {
183 None => return Err(io::const_io_error!(io::ErrorKind::InvalidInput, $msg)),
188 // split the string by ':' and convert the second part to u16
189 let (host, port_str) = try_opt!(s.rsplit_once(':'), "invalid socket address");
190 let port: u16 = try_opt!(port_str.parse().ok(), "invalid port value");
191 (host, port).try_into()
195 impl<'a> TryFrom<(&'a str, u16)> for LookupHost {
196 type Error = io::Error;
198 fn try_from((host, port): (&'a str, u16)) -> io::Result<LookupHost> {
201 let c_host = CString::new(host)?;
202 let mut hints: c::addrinfo = unsafe { mem::zeroed() };
203 hints.ai_socktype = c::SOCK_STREAM;
204 let mut res = ptr::null_mut();
206 cvt_gai(c::getaddrinfo(c_host.as_ptr(), ptr::null(), &hints, &mut res))
207 .map(|_| LookupHost { original: res, cur: res, port })
212 ////////////////////////////////////////////////////////////////////////////////
214 ////////////////////////////////////////////////////////////////////////////////
216 pub struct TcpStream {
221 pub fn connect(addr: io::Result<&SocketAddr>) -> io::Result<TcpStream> {
226 let sock = Socket::new(addr, c::SOCK_STREAM)?;
228 let (addrp, len) = addr.into_inner();
229 cvt_r(|| unsafe { c::connect(sock.as_raw(), addrp, len) })?;
230 Ok(TcpStream { inner: sock })
233 pub fn connect_timeout(addr: &SocketAddr, timeout: Duration) -> io::Result<TcpStream> {
236 let sock = Socket::new(addr, c::SOCK_STREAM)?;
237 sock.connect_timeout(addr, timeout)?;
238 Ok(TcpStream { inner: sock })
241 pub fn socket(&self) -> &Socket {
245 pub fn into_socket(self) -> Socket {
249 pub fn set_read_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
250 self.inner.set_timeout(dur, c::SO_RCVTIMEO)
253 pub fn set_write_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
254 self.inner.set_timeout(dur, c::SO_SNDTIMEO)
257 pub fn read_timeout(&self) -> io::Result<Option<Duration>> {
258 self.inner.timeout(c::SO_RCVTIMEO)
261 pub fn write_timeout(&self) -> io::Result<Option<Duration>> {
262 self.inner.timeout(c::SO_SNDTIMEO)
265 pub fn peek(&self, buf: &mut [u8]) -> io::Result<usize> {
269 pub fn read(&self, buf: &mut [u8]) -> io::Result<usize> {
273 pub fn read_vectored(&self, bufs: &mut [IoSliceMut<'_>]) -> io::Result<usize> {
274 self.inner.read_vectored(bufs)
278 pub fn is_read_vectored(&self) -> bool {
279 self.inner.is_read_vectored()
282 pub fn write(&self, buf: &[u8]) -> io::Result<usize> {
283 let len = cmp::min(buf.len(), <wrlen_t>::MAX as usize) as wrlen_t;
284 let ret = cvt(unsafe {
285 c::send(self.inner.as_raw(), buf.as_ptr() as *const c_void, len, MSG_NOSIGNAL)
290 pub fn write_vectored(&self, bufs: &[IoSlice<'_>]) -> io::Result<usize> {
291 self.inner.write_vectored(bufs)
295 pub fn is_write_vectored(&self) -> bool {
296 self.inner.is_write_vectored()
299 pub fn peer_addr(&self) -> io::Result<SocketAddr> {
300 sockname(|buf, len| unsafe { c::getpeername(self.inner.as_raw(), buf, len) })
303 pub fn socket_addr(&self) -> io::Result<SocketAddr> {
304 sockname(|buf, len| unsafe { c::getsockname(self.inner.as_raw(), buf, len) })
307 pub fn shutdown(&self, how: Shutdown) -> io::Result<()> {
308 self.inner.shutdown(how)
311 pub fn duplicate(&self) -> io::Result<TcpStream> {
312 self.inner.duplicate().map(|s| TcpStream { inner: s })
315 pub fn set_linger(&self, linger: Option<Duration>) -> io::Result<()> {
316 self.inner.set_linger(linger)
319 pub fn linger(&self) -> io::Result<Option<Duration>> {
323 pub fn set_nodelay(&self, nodelay: bool) -> io::Result<()> {
324 self.inner.set_nodelay(nodelay)
327 pub fn nodelay(&self) -> io::Result<bool> {
331 pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
332 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL, ttl as c_int)
335 pub fn ttl(&self) -> io::Result<u32> {
336 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL)?;
340 pub fn take_error(&self) -> io::Result<Option<io::Error>> {
341 self.inner.take_error()
344 pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
345 self.inner.set_nonblocking(nonblocking)
349 impl FromInner<Socket> for TcpStream {
350 fn from_inner(socket: Socket) -> TcpStream {
351 TcpStream { inner: socket }
355 impl fmt::Debug for TcpStream {
356 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
357 let mut res = f.debug_struct("TcpStream");
359 if let Ok(addr) = self.socket_addr() {
360 res.field("addr", &addr);
363 if let Ok(peer) = self.peer_addr() {
364 res.field("peer", &peer);
367 let name = if cfg!(windows) { "socket" } else { "fd" };
368 res.field(name, &self.inner.as_raw()).finish()
372 ////////////////////////////////////////////////////////////////////////////////
374 ////////////////////////////////////////////////////////////////////////////////
376 pub struct TcpListener {
381 pub fn bind(addr: io::Result<&SocketAddr>) -> io::Result<TcpListener> {
386 let sock = Socket::new(addr, c::SOCK_STREAM)?;
388 // On platforms with Berkeley-derived sockets, this allows to quickly
389 // rebind a socket, without needing to wait for the OS to clean up the
392 // On Windows, this allows rebinding sockets which are actively in use,
393 // which allows “socket hijacking”, so we explicitly don't set it here.
394 // https://docs.microsoft.com/en-us/windows/win32/winsock/using-so-reuseaddr-and-so-exclusiveaddruse
396 setsockopt(&sock, c::SOL_SOCKET, c::SO_REUSEADDR, 1 as c_int)?;
398 // Bind our new socket
399 let (addrp, len) = addr.into_inner();
400 cvt(unsafe { c::bind(sock.as_raw(), addrp, len as _) })?;
403 cvt(unsafe { c::listen(sock.as_raw(), 128) })?;
404 Ok(TcpListener { inner: sock })
407 pub fn socket(&self) -> &Socket {
411 pub fn into_socket(self) -> Socket {
415 pub fn socket_addr(&self) -> io::Result<SocketAddr> {
416 sockname(|buf, len| unsafe { c::getsockname(self.inner.as_raw(), buf, len) })
419 pub fn accept(&self) -> io::Result<(TcpStream, SocketAddr)> {
420 let mut storage: c::sockaddr_storage = unsafe { mem::zeroed() };
421 let mut len = mem::size_of_val(&storage) as c::socklen_t;
422 let sock = self.inner.accept(&mut storage as *mut _ as *mut _, &mut len)?;
423 let addr = sockaddr_to_addr(&storage, len as usize)?;
424 Ok((TcpStream { inner: sock }, addr))
427 pub fn duplicate(&self) -> io::Result<TcpListener> {
428 self.inner.duplicate().map(|s| TcpListener { inner: s })
431 pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
432 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL, ttl as c_int)
435 pub fn ttl(&self) -> io::Result<u32> {
436 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL)?;
440 pub fn set_only_v6(&self, only_v6: bool) -> io::Result<()> {
441 setsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_V6ONLY, only_v6 as c_int)
444 pub fn only_v6(&self) -> io::Result<bool> {
445 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_V6ONLY)?;
449 pub fn take_error(&self) -> io::Result<Option<io::Error>> {
450 self.inner.take_error()
453 pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
454 self.inner.set_nonblocking(nonblocking)
458 impl FromInner<Socket> for TcpListener {
459 fn from_inner(socket: Socket) -> TcpListener {
460 TcpListener { inner: socket }
464 impl fmt::Debug for TcpListener {
465 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
466 let mut res = f.debug_struct("TcpListener");
468 if let Ok(addr) = self.socket_addr() {
469 res.field("addr", &addr);
472 let name = if cfg!(windows) { "socket" } else { "fd" };
473 res.field(name, &self.inner.as_raw()).finish()
477 ////////////////////////////////////////////////////////////////////////////////
479 ////////////////////////////////////////////////////////////////////////////////
481 pub struct UdpSocket {
486 pub fn bind(addr: io::Result<&SocketAddr>) -> io::Result<UdpSocket> {
491 let sock = Socket::new(addr, c::SOCK_DGRAM)?;
492 let (addrp, len) = addr.into_inner();
493 cvt(unsafe { c::bind(sock.as_raw(), addrp, len as _) })?;
494 Ok(UdpSocket { inner: sock })
497 pub fn socket(&self) -> &Socket {
501 pub fn into_socket(self) -> Socket {
505 pub fn peer_addr(&self) -> io::Result<SocketAddr> {
506 sockname(|buf, len| unsafe { c::getpeername(self.inner.as_raw(), buf, len) })
509 pub fn socket_addr(&self) -> io::Result<SocketAddr> {
510 sockname(|buf, len| unsafe { c::getsockname(self.inner.as_raw(), buf, len) })
513 pub fn recv_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> {
514 self.inner.recv_from(buf)
517 pub fn peek_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> {
518 self.inner.peek_from(buf)
521 pub fn send_to(&self, buf: &[u8], dst: &SocketAddr) -> io::Result<usize> {
522 let len = cmp::min(buf.len(), <wrlen_t>::MAX as usize) as wrlen_t;
523 let (dstp, dstlen) = dst.into_inner();
524 let ret = cvt(unsafe {
527 buf.as_ptr() as *const c_void,
537 pub fn duplicate(&self) -> io::Result<UdpSocket> {
538 self.inner.duplicate().map(|s| UdpSocket { inner: s })
541 pub fn set_read_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
542 self.inner.set_timeout(dur, c::SO_RCVTIMEO)
545 pub fn set_write_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
546 self.inner.set_timeout(dur, c::SO_SNDTIMEO)
549 pub fn read_timeout(&self) -> io::Result<Option<Duration>> {
550 self.inner.timeout(c::SO_RCVTIMEO)
553 pub fn write_timeout(&self) -> io::Result<Option<Duration>> {
554 self.inner.timeout(c::SO_SNDTIMEO)
557 pub fn set_broadcast(&self, broadcast: bool) -> io::Result<()> {
558 setsockopt(&self.inner, c::SOL_SOCKET, c::SO_BROADCAST, broadcast as c_int)
561 pub fn broadcast(&self) -> io::Result<bool> {
562 let raw: c_int = getsockopt(&self.inner, c::SOL_SOCKET, c::SO_BROADCAST)?;
566 pub fn set_multicast_loop_v4(&self, multicast_loop_v4: bool) -> io::Result<()> {
570 c::IP_MULTICAST_LOOP,
571 multicast_loop_v4 as IpV4MultiCastType,
575 pub fn multicast_loop_v4(&self) -> io::Result<bool> {
576 let raw: IpV4MultiCastType = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_MULTICAST_LOOP)?;
580 pub fn set_multicast_ttl_v4(&self, multicast_ttl_v4: u32) -> io::Result<()> {
585 multicast_ttl_v4 as IpV4MultiCastType,
589 pub fn multicast_ttl_v4(&self) -> io::Result<u32> {
590 let raw: IpV4MultiCastType = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_MULTICAST_TTL)?;
594 pub fn set_multicast_loop_v6(&self, multicast_loop_v6: bool) -> io::Result<()> {
595 setsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_MULTICAST_LOOP, multicast_loop_v6 as c_int)
598 pub fn multicast_loop_v6(&self) -> io::Result<bool> {
599 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_MULTICAST_LOOP)?;
603 pub fn join_multicast_v4(&self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr) -> io::Result<()> {
604 let mreq = c::ip_mreq {
605 imr_multiaddr: multiaddr.into_inner(),
606 imr_interface: interface.into_inner(),
608 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_ADD_MEMBERSHIP, mreq)
611 pub fn join_multicast_v6(&self, multiaddr: &Ipv6Addr, interface: u32) -> io::Result<()> {
612 let mreq = c::ipv6_mreq {
613 ipv6mr_multiaddr: *multiaddr.as_inner(),
614 ipv6mr_interface: to_ipv6mr_interface(interface),
616 setsockopt(&self.inner, c::IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP, mreq)
619 pub fn leave_multicast_v4(&self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr) -> io::Result<()> {
620 let mreq = c::ip_mreq {
621 imr_multiaddr: multiaddr.into_inner(),
622 imr_interface: interface.into_inner(),
624 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_DROP_MEMBERSHIP, mreq)
627 pub fn leave_multicast_v6(&self, multiaddr: &Ipv6Addr, interface: u32) -> io::Result<()> {
628 let mreq = c::ipv6_mreq {
629 ipv6mr_multiaddr: *multiaddr.as_inner(),
630 ipv6mr_interface: to_ipv6mr_interface(interface),
632 setsockopt(&self.inner, c::IPPROTO_IPV6, IPV6_DROP_MEMBERSHIP, mreq)
635 pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
636 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL, ttl as c_int)
639 pub fn ttl(&self) -> io::Result<u32> {
640 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL)?;
644 pub fn take_error(&self) -> io::Result<Option<io::Error>> {
645 self.inner.take_error()
648 pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
649 self.inner.set_nonblocking(nonblocking)
652 pub fn recv(&self, buf: &mut [u8]) -> io::Result<usize> {
656 pub fn peek(&self, buf: &mut [u8]) -> io::Result<usize> {
660 pub fn send(&self, buf: &[u8]) -> io::Result<usize> {
661 let len = cmp::min(buf.len(), <wrlen_t>::MAX as usize) as wrlen_t;
662 let ret = cvt(unsafe {
663 c::send(self.inner.as_raw(), buf.as_ptr() as *const c_void, len, MSG_NOSIGNAL)
668 pub fn connect(&self, addr: io::Result<&SocketAddr>) -> io::Result<()> {
669 let (addrp, len) = addr?.into_inner();
670 cvt_r(|| unsafe { c::connect(self.inner.as_raw(), addrp, len) }).map(drop)
674 impl FromInner<Socket> for UdpSocket {
675 fn from_inner(socket: Socket) -> UdpSocket {
676 UdpSocket { inner: socket }
680 impl fmt::Debug for UdpSocket {
681 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
682 let mut res = f.debug_struct("UdpSocket");
684 if let Ok(addr) = self.socket_addr() {
685 res.field("addr", &addr);
688 let name = if cfg!(windows) { "socket" } else { "fd" };
689 res.field(name, &self.inner.as_raw()).finish()