5 use crate::convert::{TryFrom, TryInto};
7 use crate::io::{self, ErrorKind, IoSlice, IoSliceMut};
9 use crate::net::{Ipv4Addr, Ipv6Addr, Shutdown, SocketAddr};
11 use crate::sys::common::small_c_string::run_with_cstr;
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", target_os = "watchos",
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 run_with_cstr(host.as_bytes(), |c_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 })
213 ////////////////////////////////////////////////////////////////////////////////
215 ////////////////////////////////////////////////////////////////////////////////
217 pub struct TcpStream {
222 pub fn connect(addr: io::Result<&SocketAddr>) -> io::Result<TcpStream> {
227 let sock = Socket::new(addr, c::SOCK_STREAM)?;
229 let (addr, len) = addr.into_inner();
230 cvt_r(|| unsafe { c::connect(sock.as_raw(), addr.as_ptr(), len) })?;
231 Ok(TcpStream { inner: sock })
234 pub fn connect_timeout(addr: &SocketAddr, timeout: Duration) -> io::Result<TcpStream> {
237 let sock = Socket::new(addr, c::SOCK_STREAM)?;
238 sock.connect_timeout(addr, timeout)?;
239 Ok(TcpStream { inner: sock })
242 pub fn socket(&self) -> &Socket {
246 pub fn into_socket(self) -> Socket {
250 pub fn set_read_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
251 self.inner.set_timeout(dur, c::SO_RCVTIMEO)
254 pub fn set_write_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
255 self.inner.set_timeout(dur, c::SO_SNDTIMEO)
258 pub fn read_timeout(&self) -> io::Result<Option<Duration>> {
259 self.inner.timeout(c::SO_RCVTIMEO)
262 pub fn write_timeout(&self) -> io::Result<Option<Duration>> {
263 self.inner.timeout(c::SO_SNDTIMEO)
266 pub fn peek(&self, buf: &mut [u8]) -> io::Result<usize> {
270 pub fn read(&self, buf: &mut [u8]) -> io::Result<usize> {
274 pub fn read_vectored(&self, bufs: &mut [IoSliceMut<'_>]) -> io::Result<usize> {
275 self.inner.read_vectored(bufs)
279 pub fn is_read_vectored(&self) -> bool {
280 self.inner.is_read_vectored()
283 pub fn write(&self, buf: &[u8]) -> io::Result<usize> {
284 let len = cmp::min(buf.len(), <wrlen_t>::MAX as usize) as wrlen_t;
285 let ret = cvt(unsafe {
286 c::send(self.inner.as_raw(), buf.as_ptr() as *const c_void, len, MSG_NOSIGNAL)
291 pub fn write_vectored(&self, bufs: &[IoSlice<'_>]) -> io::Result<usize> {
292 self.inner.write_vectored(bufs)
296 pub fn is_write_vectored(&self) -> bool {
297 self.inner.is_write_vectored()
300 pub fn peer_addr(&self) -> io::Result<SocketAddr> {
301 sockname(|buf, len| unsafe { c::getpeername(self.inner.as_raw(), buf, len) })
304 pub fn socket_addr(&self) -> io::Result<SocketAddr> {
305 sockname(|buf, len| unsafe { c::getsockname(self.inner.as_raw(), buf, len) })
308 pub fn shutdown(&self, how: Shutdown) -> io::Result<()> {
309 self.inner.shutdown(how)
312 pub fn duplicate(&self) -> io::Result<TcpStream> {
313 self.inner.duplicate().map(|s| TcpStream { inner: s })
316 pub fn set_linger(&self, linger: Option<Duration>) -> io::Result<()> {
317 self.inner.set_linger(linger)
320 pub fn linger(&self) -> io::Result<Option<Duration>> {
324 pub fn set_nodelay(&self, nodelay: bool) -> io::Result<()> {
325 self.inner.set_nodelay(nodelay)
328 pub fn nodelay(&self) -> io::Result<bool> {
332 pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
333 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL, ttl as c_int)
336 pub fn ttl(&self) -> io::Result<u32> {
337 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL)?;
341 pub fn take_error(&self) -> io::Result<Option<io::Error>> {
342 self.inner.take_error()
345 pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
346 self.inner.set_nonblocking(nonblocking)
350 impl AsInner<Socket> for TcpStream {
351 fn as_inner(&self) -> &Socket {
356 impl FromInner<Socket> for TcpStream {
357 fn from_inner(socket: Socket) -> TcpStream {
358 TcpStream { inner: socket }
362 impl fmt::Debug for TcpStream {
363 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
364 let mut res = f.debug_struct("TcpStream");
366 if let Ok(addr) = self.socket_addr() {
367 res.field("addr", &addr);
370 if let Ok(peer) = self.peer_addr() {
371 res.field("peer", &peer);
374 let name = if cfg!(windows) { "socket" } else { "fd" };
375 res.field(name, &self.inner.as_raw()).finish()
379 ////////////////////////////////////////////////////////////////////////////////
381 ////////////////////////////////////////////////////////////////////////////////
383 pub struct TcpListener {
388 pub fn bind(addr: io::Result<&SocketAddr>) -> io::Result<TcpListener> {
393 let sock = Socket::new(addr, c::SOCK_STREAM)?;
395 // On platforms with Berkeley-derived sockets, this allows to quickly
396 // rebind a socket, without needing to wait for the OS to clean up the
399 // On Windows, this allows rebinding sockets which are actively in use,
400 // which allows “socket hijacking”, so we explicitly don't set it here.
401 // https://docs.microsoft.com/en-us/windows/win32/winsock/using-so-reuseaddr-and-so-exclusiveaddruse
403 setsockopt(&sock, c::SOL_SOCKET, c::SO_REUSEADDR, 1 as c_int)?;
405 // Bind our new socket
406 let (addr, len) = addr.into_inner();
407 cvt(unsafe { c::bind(sock.as_raw(), addr.as_ptr(), len as _) })?;
410 if #[cfg(target_os = "horizon")] {
411 // The 3DS doesn't support a big connection backlog. Sometimes
412 // it allows up to about 37, but other times it doesn't even
413 // accept 32. There may be a global limitation causing this.
416 // The default for all other platforms
422 cvt(unsafe { c::listen(sock.as_raw(), backlog) })?;
423 Ok(TcpListener { inner: sock })
426 pub fn socket(&self) -> &Socket {
430 pub fn into_socket(self) -> Socket {
434 pub fn socket_addr(&self) -> io::Result<SocketAddr> {
435 sockname(|buf, len| unsafe { c::getsockname(self.inner.as_raw(), buf, len) })
438 pub fn accept(&self) -> io::Result<(TcpStream, SocketAddr)> {
439 let mut storage: c::sockaddr_storage = unsafe { mem::zeroed() };
440 let mut len = mem::size_of_val(&storage) as c::socklen_t;
441 let sock = self.inner.accept(&mut storage as *mut _ as *mut _, &mut len)?;
442 let addr = sockaddr_to_addr(&storage, len as usize)?;
443 Ok((TcpStream { inner: sock }, addr))
446 pub fn duplicate(&self) -> io::Result<TcpListener> {
447 self.inner.duplicate().map(|s| TcpListener { inner: s })
450 pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
451 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL, ttl as c_int)
454 pub fn ttl(&self) -> io::Result<u32> {
455 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL)?;
459 pub fn set_only_v6(&self, only_v6: bool) -> io::Result<()> {
460 setsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_V6ONLY, only_v6 as c_int)
463 pub fn only_v6(&self) -> io::Result<bool> {
464 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_V6ONLY)?;
468 pub fn take_error(&self) -> io::Result<Option<io::Error>> {
469 self.inner.take_error()
472 pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
473 self.inner.set_nonblocking(nonblocking)
477 impl FromInner<Socket> for TcpListener {
478 fn from_inner(socket: Socket) -> TcpListener {
479 TcpListener { inner: socket }
483 impl fmt::Debug for TcpListener {
484 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
485 let mut res = f.debug_struct("TcpListener");
487 if let Ok(addr) = self.socket_addr() {
488 res.field("addr", &addr);
491 let name = if cfg!(windows) { "socket" } else { "fd" };
492 res.field(name, &self.inner.as_raw()).finish()
496 ////////////////////////////////////////////////////////////////////////////////
498 ////////////////////////////////////////////////////////////////////////////////
500 pub struct UdpSocket {
505 pub fn bind(addr: io::Result<&SocketAddr>) -> io::Result<UdpSocket> {
510 let sock = Socket::new(addr, c::SOCK_DGRAM)?;
511 let (addr, len) = addr.into_inner();
512 cvt(unsafe { c::bind(sock.as_raw(), addr.as_ptr(), len as _) })?;
513 Ok(UdpSocket { inner: sock })
516 pub fn socket(&self) -> &Socket {
520 pub fn into_socket(self) -> Socket {
524 pub fn peer_addr(&self) -> io::Result<SocketAddr> {
525 sockname(|buf, len| unsafe { c::getpeername(self.inner.as_raw(), buf, len) })
528 pub fn socket_addr(&self) -> io::Result<SocketAddr> {
529 sockname(|buf, len| unsafe { c::getsockname(self.inner.as_raw(), buf, len) })
532 pub fn recv_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> {
533 self.inner.recv_from(buf)
536 pub fn peek_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> {
537 self.inner.peek_from(buf)
540 pub fn send_to(&self, buf: &[u8], dst: &SocketAddr) -> io::Result<usize> {
541 let len = cmp::min(buf.len(), <wrlen_t>::MAX as usize) as wrlen_t;
542 let (dst, dstlen) = dst.into_inner();
543 let ret = cvt(unsafe {
546 buf.as_ptr() as *const c_void,
556 pub fn duplicate(&self) -> io::Result<UdpSocket> {
557 self.inner.duplicate().map(|s| UdpSocket { inner: s })
560 pub fn set_read_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
561 self.inner.set_timeout(dur, c::SO_RCVTIMEO)
564 pub fn set_write_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
565 self.inner.set_timeout(dur, c::SO_SNDTIMEO)
568 pub fn read_timeout(&self) -> io::Result<Option<Duration>> {
569 self.inner.timeout(c::SO_RCVTIMEO)
572 pub fn write_timeout(&self) -> io::Result<Option<Duration>> {
573 self.inner.timeout(c::SO_SNDTIMEO)
576 pub fn set_broadcast(&self, broadcast: bool) -> io::Result<()> {
577 setsockopt(&self.inner, c::SOL_SOCKET, c::SO_BROADCAST, broadcast as c_int)
580 pub fn broadcast(&self) -> io::Result<bool> {
581 let raw: c_int = getsockopt(&self.inner, c::SOL_SOCKET, c::SO_BROADCAST)?;
585 pub fn set_multicast_loop_v4(&self, multicast_loop_v4: bool) -> io::Result<()> {
589 c::IP_MULTICAST_LOOP,
590 multicast_loop_v4 as IpV4MultiCastType,
594 pub fn multicast_loop_v4(&self) -> io::Result<bool> {
595 let raw: IpV4MultiCastType = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_MULTICAST_LOOP)?;
599 pub fn set_multicast_ttl_v4(&self, multicast_ttl_v4: u32) -> io::Result<()> {
604 multicast_ttl_v4 as IpV4MultiCastType,
608 pub fn multicast_ttl_v4(&self) -> io::Result<u32> {
609 let raw: IpV4MultiCastType = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_MULTICAST_TTL)?;
613 pub fn set_multicast_loop_v6(&self, multicast_loop_v6: bool) -> io::Result<()> {
614 setsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_MULTICAST_LOOP, multicast_loop_v6 as c_int)
617 pub fn multicast_loop_v6(&self) -> io::Result<bool> {
618 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_MULTICAST_LOOP)?;
622 pub fn join_multicast_v4(&self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr) -> io::Result<()> {
623 let mreq = c::ip_mreq {
624 imr_multiaddr: multiaddr.into_inner(),
625 imr_interface: interface.into_inner(),
627 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_ADD_MEMBERSHIP, mreq)
630 pub fn join_multicast_v6(&self, multiaddr: &Ipv6Addr, interface: u32) -> io::Result<()> {
631 let mreq = c::ipv6_mreq {
632 ipv6mr_multiaddr: multiaddr.into_inner(),
633 ipv6mr_interface: to_ipv6mr_interface(interface),
635 setsockopt(&self.inner, c::IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP, mreq)
638 pub fn leave_multicast_v4(&self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr) -> io::Result<()> {
639 let mreq = c::ip_mreq {
640 imr_multiaddr: multiaddr.into_inner(),
641 imr_interface: interface.into_inner(),
643 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_DROP_MEMBERSHIP, mreq)
646 pub fn leave_multicast_v6(&self, multiaddr: &Ipv6Addr, interface: u32) -> io::Result<()> {
647 let mreq = c::ipv6_mreq {
648 ipv6mr_multiaddr: multiaddr.into_inner(),
649 ipv6mr_interface: to_ipv6mr_interface(interface),
651 setsockopt(&self.inner, c::IPPROTO_IPV6, IPV6_DROP_MEMBERSHIP, mreq)
654 pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
655 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL, ttl as c_int)
658 pub fn ttl(&self) -> io::Result<u32> {
659 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL)?;
663 pub fn take_error(&self) -> io::Result<Option<io::Error>> {
664 self.inner.take_error()
667 pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
668 self.inner.set_nonblocking(nonblocking)
671 pub fn recv(&self, buf: &mut [u8]) -> io::Result<usize> {
675 pub fn peek(&self, buf: &mut [u8]) -> io::Result<usize> {
679 pub fn send(&self, buf: &[u8]) -> io::Result<usize> {
680 let len = cmp::min(buf.len(), <wrlen_t>::MAX as usize) as wrlen_t;
681 let ret = cvt(unsafe {
682 c::send(self.inner.as_raw(), buf.as_ptr() as *const c_void, len, MSG_NOSIGNAL)
687 pub fn connect(&self, addr: io::Result<&SocketAddr>) -> io::Result<()> {
688 let (addr, len) = addr?.into_inner();
689 cvt_r(|| unsafe { c::connect(self.inner.as_raw(), addr.as_ptr(), len) }).map(drop)
693 impl FromInner<Socket> for UdpSocket {
694 fn from_inner(socket: Socket) -> UdpSocket {
695 UdpSocket { inner: socket }
699 impl fmt::Debug for UdpSocket {
700 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
701 let mut res = f.debug_struct("UdpSocket");
703 if let Ok(addr) = self.socket_addr() {
704 res.field("addr", &addr);
707 let name = if cfg!(windows) { "socket" } else { "fd" };
708 res.field(name, &self.inner.as_raw()).finish()
712 ////////////////////////////////////////////////////////////////////////////////
713 // Converting SocketAddr to libc representation
714 ////////////////////////////////////////////////////////////////////////////////
716 /// A type with the same memory layout as `c::sockaddr`. Used in converting Rust level
717 /// SocketAddr* types into their system representation. The benefit of this specific
718 /// type over using `c::sockaddr_storage` is that this type is exactly as large as it
719 /// needs to be and not a lot larger. And it can be initialized more cleanly from Rust.
721 pub(crate) union SocketAddrCRepr {
726 impl SocketAddrCRepr {
727 pub fn as_ptr(&self) -> *const c::sockaddr {
728 self as *const _ as *const c::sockaddr
732 impl<'a> IntoInner<(SocketAddrCRepr, c::socklen_t)> for &'a SocketAddr {
733 fn into_inner(self) -> (SocketAddrCRepr, c::socklen_t) {
735 SocketAddr::V4(ref a) => {
736 let sockaddr = SocketAddrCRepr { v4: a.into_inner() };
737 (sockaddr, mem::size_of::<c::sockaddr_in>() as c::socklen_t)
739 SocketAddr::V6(ref a) => {
740 let sockaddr = SocketAddrCRepr { v6: a.into_inner() };
741 (sockaddr, mem::size_of::<c::sockaddr_in6>() as c::socklen_t)