5 use crate::convert::{TryFrom, TryInto};
6 use crate::ffi::CString;
8 use crate::io::{self, Error, 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 ////////////////////////////////////////////////////////////////////////////////
61 pub fn setsockopt<T>(sock: &Socket, opt: c_int, val: c_int, payload: T) -> io::Result<()> {
63 let payload = &payload as *const T as *const c_void;
69 mem::size_of::<T>() as c::socklen_t,
75 pub fn getsockopt<T: Copy>(sock: &Socket, opt: c_int, val: c_int) -> io::Result<T> {
77 let mut slot: T = mem::zeroed();
78 let mut len = mem::size_of::<T>() as c::socklen_t;
79 cvt(c::getsockopt(*sock.as_inner(), opt, val, &mut slot as *mut _ as *mut _, &mut len))?;
80 assert_eq!(len as usize, mem::size_of::<T>());
85 fn sockname<F>(f: F) -> io::Result<SocketAddr>
87 F: FnOnce(*mut c::sockaddr, *mut c::socklen_t) -> c_int,
90 let mut storage: c::sockaddr_storage = mem::zeroed();
91 let mut len = mem::size_of_val(&storage) as c::socklen_t;
92 cvt(f(&mut storage as *mut _ as *mut _, &mut len))?;
93 sockaddr_to_addr(&storage, len as usize)
97 pub fn sockaddr_to_addr(storage: &c::sockaddr_storage, len: usize) -> io::Result<SocketAddr> {
98 match storage.ss_family as c_int {
100 assert!(len as usize >= mem::size_of::<c::sockaddr_in>());
101 Ok(SocketAddr::V4(FromInner::from_inner(unsafe {
102 *(storage as *const _ as *const c::sockaddr_in)
106 assert!(len as usize >= mem::size_of::<c::sockaddr_in6>());
107 Ok(SocketAddr::V6(FromInner::from_inner(unsafe {
108 *(storage as *const _ as *const c::sockaddr_in6)
111 _ => Err(Error::new(ErrorKind::InvalidInput, "invalid argument")),
115 #[cfg(target_os = "android")]
116 fn to_ipv6mr_interface(value: u32) -> c_int {
120 #[cfg(not(target_os = "android"))]
121 fn to_ipv6mr_interface(value: u32) -> libc::c_uint {
122 value as libc::c_uint
125 ////////////////////////////////////////////////////////////////////////////////
126 // get_host_addresses
127 ////////////////////////////////////////////////////////////////////////////////
129 pub struct LookupHost {
130 original: *mut c::addrinfo,
131 cur: *mut c::addrinfo,
136 pub fn port(&self) -> u16 {
141 impl Iterator for LookupHost {
142 type Item = SocketAddr;
143 fn next(&mut self) -> Option<SocketAddr> {
146 let cur = self.cur.as_ref()?;
147 self.cur = cur.ai_next;
148 match sockaddr_to_addr(mem::transmute(cur.ai_addr), cur.ai_addrlen as usize) {
149 Ok(addr) => return Some(addr),
157 unsafe impl Sync for LookupHost {}
158 unsafe impl Send for LookupHost {}
160 impl Drop for LookupHost {
162 unsafe { c::freeaddrinfo(self.original) }
166 impl TryFrom<&str> for LookupHost {
167 type Error = io::Error;
169 fn try_from(s: &str) -> io::Result<LookupHost> {
170 macro_rules! try_opt {
171 ($e:expr, $msg:expr) => {
174 None => return Err(io::Error::new(io::ErrorKind::InvalidInput, $msg)),
179 // split the string by ':' and convert the second part to u16
180 let (port_str, host) = try_opt!(s.rsplit_once(':'), "invalid socket address");
181 let port: u16 = try_opt!(port_str.parse().ok(), "invalid port value");
183 (host, port).try_into()
187 impl<'a> TryFrom<(&'a str, u16)> for LookupHost {
188 type Error = io::Error;
190 fn try_from((host, port): (&'a str, u16)) -> io::Result<LookupHost> {
193 let c_host = CString::new(host)?;
194 let mut hints: c::addrinfo = unsafe { mem::zeroed() };
195 hints.ai_socktype = c::SOCK_STREAM;
196 let mut res = ptr::null_mut();
198 cvt_gai(c::getaddrinfo(c_host.as_ptr(), ptr::null(), &hints, &mut res))
199 .map(|_| LookupHost { original: res, cur: res, port })
204 ////////////////////////////////////////////////////////////////////////////////
206 ////////////////////////////////////////////////////////////////////////////////
208 pub struct TcpStream {
213 pub fn connect(addr: io::Result<&SocketAddr>) -> io::Result<TcpStream> {
218 let sock = Socket::new(addr, c::SOCK_STREAM)?;
220 let (addrp, len) = addr.into_inner();
221 cvt_r(|| unsafe { c::connect(*sock.as_inner(), addrp, len) })?;
222 Ok(TcpStream { inner: sock })
225 pub fn connect_timeout(addr: &SocketAddr, timeout: Duration) -> io::Result<TcpStream> {
228 let sock = Socket::new(addr, c::SOCK_STREAM)?;
229 sock.connect_timeout(addr, timeout)?;
230 Ok(TcpStream { inner: sock })
233 pub fn socket(&self) -> &Socket {
237 pub fn into_socket(self) -> Socket {
241 pub fn set_read_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
242 self.inner.set_timeout(dur, c::SO_RCVTIMEO)
245 pub fn set_write_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
246 self.inner.set_timeout(dur, c::SO_SNDTIMEO)
249 pub fn read_timeout(&self) -> io::Result<Option<Duration>> {
250 self.inner.timeout(c::SO_RCVTIMEO)
253 pub fn write_timeout(&self) -> io::Result<Option<Duration>> {
254 self.inner.timeout(c::SO_SNDTIMEO)
257 pub fn peek(&self, buf: &mut [u8]) -> io::Result<usize> {
261 pub fn read(&self, buf: &mut [u8]) -> io::Result<usize> {
265 pub fn read_vectored(&self, bufs: &mut [IoSliceMut<'_>]) -> io::Result<usize> {
266 self.inner.read_vectored(bufs)
270 pub fn is_read_vectored(&self) -> bool {
271 self.inner.is_read_vectored()
274 pub fn write(&self, buf: &[u8]) -> io::Result<usize> {
275 let len = cmp::min(buf.len(), <wrlen_t>::MAX as usize) as wrlen_t;
276 let ret = cvt(unsafe {
277 c::send(*self.inner.as_inner(), buf.as_ptr() as *const c_void, len, MSG_NOSIGNAL)
282 pub fn write_vectored(&self, bufs: &[IoSlice<'_>]) -> io::Result<usize> {
283 self.inner.write_vectored(bufs)
287 pub fn is_write_vectored(&self) -> bool {
288 self.inner.is_write_vectored()
291 pub fn peer_addr(&self) -> io::Result<SocketAddr> {
292 sockname(|buf, len| unsafe { c::getpeername(*self.inner.as_inner(), buf, len) })
295 pub fn socket_addr(&self) -> io::Result<SocketAddr> {
296 sockname(|buf, len| unsafe { c::getsockname(*self.inner.as_inner(), buf, len) })
299 pub fn shutdown(&self, how: Shutdown) -> io::Result<()> {
300 self.inner.shutdown(how)
303 pub fn duplicate(&self) -> io::Result<TcpStream> {
304 self.inner.duplicate().map(|s| TcpStream { inner: s })
307 pub fn set_nodelay(&self, nodelay: bool) -> io::Result<()> {
308 self.inner.set_nodelay(nodelay)
311 pub fn nodelay(&self) -> io::Result<bool> {
315 pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
316 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL, ttl as c_int)
319 pub fn ttl(&self) -> io::Result<u32> {
320 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL)?;
324 pub fn take_error(&self) -> io::Result<Option<io::Error>> {
325 self.inner.take_error()
328 pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
329 self.inner.set_nonblocking(nonblocking)
333 impl FromInner<Socket> for TcpStream {
334 fn from_inner(socket: Socket) -> TcpStream {
335 TcpStream { inner: socket }
339 impl fmt::Debug for TcpStream {
340 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
341 let mut res = f.debug_struct("TcpStream");
343 if let Ok(addr) = self.socket_addr() {
344 res.field("addr", &addr);
347 if let Ok(peer) = self.peer_addr() {
348 res.field("peer", &peer);
351 let name = if cfg!(windows) { "socket" } else { "fd" };
352 res.field(name, &self.inner.as_inner()).finish()
356 ////////////////////////////////////////////////////////////////////////////////
358 ////////////////////////////////////////////////////////////////////////////////
360 pub struct TcpListener {
365 pub fn bind(addr: io::Result<&SocketAddr>) -> io::Result<TcpListener> {
370 let sock = Socket::new(addr, c::SOCK_STREAM)?;
372 // On platforms with Berkeley-derived sockets, this allows to quickly
373 // rebind a socket, without needing to wait for the OS to clean up the
376 // On Windows, this allows rebinding sockets which are actively in use,
377 // which allows “socket hijacking”, so we explicitly don't set it here.
378 // https://docs.microsoft.com/en-us/windows/win32/winsock/using-so-reuseaddr-and-so-exclusiveaddruse
380 setsockopt(&sock, c::SOL_SOCKET, c::SO_REUSEADDR, 1 as c_int)?;
382 // Bind our new socket
383 let (addrp, len) = addr.into_inner();
384 cvt(unsafe { c::bind(*sock.as_inner(), addrp, len as _) })?;
387 cvt(unsafe { c::listen(*sock.as_inner(), 128) })?;
388 Ok(TcpListener { inner: sock })
391 pub fn socket(&self) -> &Socket {
395 pub fn into_socket(self) -> Socket {
399 pub fn socket_addr(&self) -> io::Result<SocketAddr> {
400 sockname(|buf, len| unsafe { c::getsockname(*self.inner.as_inner(), buf, len) })
403 pub fn accept(&self) -> io::Result<(TcpStream, SocketAddr)> {
404 let mut storage: c::sockaddr_storage = unsafe { mem::zeroed() };
405 let mut len = mem::size_of_val(&storage) as c::socklen_t;
406 let sock = self.inner.accept(&mut storage as *mut _ as *mut _, &mut len)?;
407 let addr = sockaddr_to_addr(&storage, len as usize)?;
408 Ok((TcpStream { inner: sock }, addr))
411 pub fn duplicate(&self) -> io::Result<TcpListener> {
412 self.inner.duplicate().map(|s| TcpListener { inner: s })
415 pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
416 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL, ttl as c_int)
419 pub fn ttl(&self) -> io::Result<u32> {
420 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL)?;
424 pub fn set_only_v6(&self, only_v6: bool) -> io::Result<()> {
425 setsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_V6ONLY, only_v6 as c_int)
428 pub fn only_v6(&self) -> io::Result<bool> {
429 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_V6ONLY)?;
433 pub fn take_error(&self) -> io::Result<Option<io::Error>> {
434 self.inner.take_error()
437 pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
438 self.inner.set_nonblocking(nonblocking)
442 impl FromInner<Socket> for TcpListener {
443 fn from_inner(socket: Socket) -> TcpListener {
444 TcpListener { inner: socket }
448 impl fmt::Debug for TcpListener {
449 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
450 let mut res = f.debug_struct("TcpListener");
452 if let Ok(addr) = self.socket_addr() {
453 res.field("addr", &addr);
456 let name = if cfg!(windows) { "socket" } else { "fd" };
457 res.field(name, &self.inner.as_inner()).finish()
461 ////////////////////////////////////////////////////////////////////////////////
463 ////////////////////////////////////////////////////////////////////////////////
465 pub struct UdpSocket {
470 pub fn bind(addr: io::Result<&SocketAddr>) -> io::Result<UdpSocket> {
475 let sock = Socket::new(addr, c::SOCK_DGRAM)?;
476 let (addrp, len) = addr.into_inner();
477 cvt(unsafe { c::bind(*sock.as_inner(), addrp, len as _) })?;
478 Ok(UdpSocket { inner: sock })
481 pub fn socket(&self) -> &Socket {
485 pub fn into_socket(self) -> Socket {
489 pub fn peer_addr(&self) -> io::Result<SocketAddr> {
490 sockname(|buf, len| unsafe { c::getpeername(*self.inner.as_inner(), buf, len) })
493 pub fn socket_addr(&self) -> io::Result<SocketAddr> {
494 sockname(|buf, len| unsafe { c::getsockname(*self.inner.as_inner(), buf, len) })
497 pub fn recv_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> {
498 self.inner.recv_from(buf)
501 pub fn peek_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> {
502 self.inner.peek_from(buf)
505 pub fn send_to(&self, buf: &[u8], dst: &SocketAddr) -> io::Result<usize> {
506 let len = cmp::min(buf.len(), <wrlen_t>::MAX as usize) as wrlen_t;
507 let (dstp, dstlen) = dst.into_inner();
508 let ret = cvt(unsafe {
510 *self.inner.as_inner(),
511 buf.as_ptr() as *const c_void,
521 pub fn duplicate(&self) -> io::Result<UdpSocket> {
522 self.inner.duplicate().map(|s| UdpSocket { inner: s })
525 pub fn set_read_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
526 self.inner.set_timeout(dur, c::SO_RCVTIMEO)
529 pub fn set_write_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
530 self.inner.set_timeout(dur, c::SO_SNDTIMEO)
533 pub fn read_timeout(&self) -> io::Result<Option<Duration>> {
534 self.inner.timeout(c::SO_RCVTIMEO)
537 pub fn write_timeout(&self) -> io::Result<Option<Duration>> {
538 self.inner.timeout(c::SO_SNDTIMEO)
541 pub fn set_broadcast(&self, broadcast: bool) -> io::Result<()> {
542 setsockopt(&self.inner, c::SOL_SOCKET, c::SO_BROADCAST, broadcast as c_int)
545 pub fn broadcast(&self) -> io::Result<bool> {
546 let raw: c_int = getsockopt(&self.inner, c::SOL_SOCKET, c::SO_BROADCAST)?;
550 pub fn set_multicast_loop_v4(&self, multicast_loop_v4: bool) -> io::Result<()> {
554 c::IP_MULTICAST_LOOP,
555 multicast_loop_v4 as IpV4MultiCastType,
559 pub fn multicast_loop_v4(&self) -> io::Result<bool> {
560 let raw: IpV4MultiCastType = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_MULTICAST_LOOP)?;
564 pub fn set_multicast_ttl_v4(&self, multicast_ttl_v4: u32) -> io::Result<()> {
569 multicast_ttl_v4 as IpV4MultiCastType,
573 pub fn multicast_ttl_v4(&self) -> io::Result<u32> {
574 let raw: IpV4MultiCastType = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_MULTICAST_TTL)?;
578 pub fn set_multicast_loop_v6(&self, multicast_loop_v6: bool) -> io::Result<()> {
579 setsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_MULTICAST_LOOP, multicast_loop_v6 as c_int)
582 pub fn multicast_loop_v6(&self) -> io::Result<bool> {
583 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_MULTICAST_LOOP)?;
587 pub fn join_multicast_v4(&self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr) -> io::Result<()> {
588 let mreq = c::ip_mreq {
589 imr_multiaddr: multiaddr.into_inner(),
590 imr_interface: interface.into_inner(),
592 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_ADD_MEMBERSHIP, mreq)
595 pub fn join_multicast_v6(&self, multiaddr: &Ipv6Addr, interface: u32) -> io::Result<()> {
596 let mreq = c::ipv6_mreq {
597 ipv6mr_multiaddr: *multiaddr.as_inner(),
598 ipv6mr_interface: to_ipv6mr_interface(interface),
600 setsockopt(&self.inner, c::IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP, mreq)
603 pub fn leave_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_DROP_MEMBERSHIP, mreq)
611 pub fn leave_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_DROP_MEMBERSHIP, mreq)
619 pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
620 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL, ttl as c_int)
623 pub fn ttl(&self) -> io::Result<u32> {
624 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL)?;
628 pub fn take_error(&self) -> io::Result<Option<io::Error>> {
629 self.inner.take_error()
632 pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
633 self.inner.set_nonblocking(nonblocking)
636 pub fn recv(&self, buf: &mut [u8]) -> io::Result<usize> {
640 pub fn peek(&self, buf: &mut [u8]) -> io::Result<usize> {
644 pub fn send(&self, buf: &[u8]) -> io::Result<usize> {
645 let len = cmp::min(buf.len(), <wrlen_t>::MAX as usize) as wrlen_t;
646 let ret = cvt(unsafe {
647 c::send(*self.inner.as_inner(), buf.as_ptr() as *const c_void, len, MSG_NOSIGNAL)
652 pub fn connect(&self, addr: io::Result<&SocketAddr>) -> io::Result<()> {
653 let (addrp, len) = addr?.into_inner();
654 cvt_r(|| unsafe { c::connect(*self.inner.as_inner(), addrp, len) }).map(drop)
658 impl FromInner<Socket> for UdpSocket {
659 fn from_inner(socket: Socket) -> UdpSocket {
660 UdpSocket { inner: socket }
664 impl fmt::Debug for UdpSocket {
665 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
666 let mut res = f.debug_struct("UdpSocket");
668 if let Ok(addr) = self.socket_addr() {
669 res.field("addr", &addr);
672 let name = if cfg!(windows) { "socket" } else { "fd" };
673 res.field(name, &self.inner.as_inner()).finish()