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 (host, port_str) = try_opt!(s.rsplit_once(':'), "invalid socket address");
181 let port: u16 = try_opt!(port_str.parse().ok(), "invalid port value");
182 (host, port).try_into()
186 impl<'a> TryFrom<(&'a str, u16)> for LookupHost {
187 type Error = io::Error;
189 fn try_from((host, port): (&'a str, u16)) -> io::Result<LookupHost> {
192 let c_host = CString::new(host)?;
193 let mut hints: c::addrinfo = unsafe { mem::zeroed() };
194 hints.ai_socktype = c::SOCK_STREAM;
195 let mut res = ptr::null_mut();
197 cvt_gai(c::getaddrinfo(c_host.as_ptr(), ptr::null(), &hints, &mut res))
198 .map(|_| LookupHost { original: res, cur: res, port })
203 ////////////////////////////////////////////////////////////////////////////////
205 ////////////////////////////////////////////////////////////////////////////////
207 pub struct TcpStream {
212 pub fn connect(addr: io::Result<&SocketAddr>) -> io::Result<TcpStream> {
217 let sock = Socket::new(addr, c::SOCK_STREAM)?;
219 let (addrp, len) = addr.into_inner();
220 cvt_r(|| unsafe { c::connect(*sock.as_inner(), addrp, len) })?;
221 Ok(TcpStream { inner: sock })
224 pub fn connect_timeout(addr: &SocketAddr, timeout: Duration) -> io::Result<TcpStream> {
227 let sock = Socket::new(addr, c::SOCK_STREAM)?;
228 sock.connect_timeout(addr, timeout)?;
229 Ok(TcpStream { inner: sock })
232 pub fn socket(&self) -> &Socket {
236 pub fn into_socket(self) -> Socket {
240 pub fn set_read_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
241 self.inner.set_timeout(dur, c::SO_RCVTIMEO)
244 pub fn set_write_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
245 self.inner.set_timeout(dur, c::SO_SNDTIMEO)
248 pub fn read_timeout(&self) -> io::Result<Option<Duration>> {
249 self.inner.timeout(c::SO_RCVTIMEO)
252 pub fn write_timeout(&self) -> io::Result<Option<Duration>> {
253 self.inner.timeout(c::SO_SNDTIMEO)
256 pub fn peek(&self, buf: &mut [u8]) -> io::Result<usize> {
260 pub fn read(&self, buf: &mut [u8]) -> io::Result<usize> {
264 pub fn read_vectored(&self, bufs: &mut [IoSliceMut<'_>]) -> io::Result<usize> {
265 self.inner.read_vectored(bufs)
269 pub fn is_read_vectored(&self) -> bool {
270 self.inner.is_read_vectored()
273 pub fn write(&self, buf: &[u8]) -> io::Result<usize> {
274 let len = cmp::min(buf.len(), <wrlen_t>::MAX as usize) as wrlen_t;
275 let ret = cvt(unsafe {
276 c::send(*self.inner.as_inner(), buf.as_ptr() as *const c_void, len, MSG_NOSIGNAL)
281 pub fn write_vectored(&self, bufs: &[IoSlice<'_>]) -> io::Result<usize> {
282 self.inner.write_vectored(bufs)
286 pub fn is_write_vectored(&self) -> bool {
287 self.inner.is_write_vectored()
290 pub fn peer_addr(&self) -> io::Result<SocketAddr> {
291 sockname(|buf, len| unsafe { c::getpeername(*self.inner.as_inner(), buf, len) })
294 pub fn socket_addr(&self) -> io::Result<SocketAddr> {
295 sockname(|buf, len| unsafe { c::getsockname(*self.inner.as_inner(), buf, len) })
298 pub fn shutdown(&self, how: Shutdown) -> io::Result<()> {
299 self.inner.shutdown(how)
302 pub fn duplicate(&self) -> io::Result<TcpStream> {
303 self.inner.duplicate().map(|s| TcpStream { inner: s })
306 pub fn set_nodelay(&self, nodelay: bool) -> io::Result<()> {
307 self.inner.set_nodelay(nodelay)
310 pub fn nodelay(&self) -> io::Result<bool> {
314 pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
315 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL, ttl as c_int)
318 pub fn ttl(&self) -> io::Result<u32> {
319 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL)?;
323 pub fn take_error(&self) -> io::Result<Option<io::Error>> {
324 self.inner.take_error()
327 pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
328 self.inner.set_nonblocking(nonblocking)
332 impl FromInner<Socket> for TcpStream {
333 fn from_inner(socket: Socket) -> TcpStream {
334 TcpStream { inner: socket }
338 impl fmt::Debug for TcpStream {
339 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
340 let mut res = f.debug_struct("TcpStream");
342 if let Ok(addr) = self.socket_addr() {
343 res.field("addr", &addr);
346 if let Ok(peer) = self.peer_addr() {
347 res.field("peer", &peer);
350 let name = if cfg!(windows) { "socket" } else { "fd" };
351 res.field(name, &self.inner.as_inner()).finish()
355 ////////////////////////////////////////////////////////////////////////////////
357 ////////////////////////////////////////////////////////////////////////////////
359 pub struct TcpListener {
364 pub fn bind(addr: io::Result<&SocketAddr>) -> io::Result<TcpListener> {
369 let sock = Socket::new(addr, c::SOCK_STREAM)?;
371 // On platforms with Berkeley-derived sockets, this allows to quickly
372 // rebind a socket, without needing to wait for the OS to clean up the
375 // On Windows, this allows rebinding sockets which are actively in use,
376 // which allows “socket hijacking”, so we explicitly don't set it here.
377 // https://docs.microsoft.com/en-us/windows/win32/winsock/using-so-reuseaddr-and-so-exclusiveaddruse
379 setsockopt(&sock, c::SOL_SOCKET, c::SO_REUSEADDR, 1 as c_int)?;
381 // Bind our new socket
382 let (addrp, len) = addr.into_inner();
383 cvt(unsafe { c::bind(*sock.as_inner(), addrp, len as _) })?;
386 cvt(unsafe { c::listen(*sock.as_inner(), 128) })?;
387 Ok(TcpListener { inner: sock })
390 pub fn socket(&self) -> &Socket {
394 pub fn into_socket(self) -> Socket {
398 pub fn socket_addr(&self) -> io::Result<SocketAddr> {
399 sockname(|buf, len| unsafe { c::getsockname(*self.inner.as_inner(), buf, len) })
402 pub fn accept(&self) -> io::Result<(TcpStream, SocketAddr)> {
403 let mut storage: c::sockaddr_storage = unsafe { mem::zeroed() };
404 let mut len = mem::size_of_val(&storage) as c::socklen_t;
405 let sock = self.inner.accept(&mut storage as *mut _ as *mut _, &mut len)?;
406 let addr = sockaddr_to_addr(&storage, len as usize)?;
407 Ok((TcpStream { inner: sock }, addr))
410 pub fn duplicate(&self) -> io::Result<TcpListener> {
411 self.inner.duplicate().map(|s| TcpListener { inner: s })
414 pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
415 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL, ttl as c_int)
418 pub fn ttl(&self) -> io::Result<u32> {
419 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL)?;
423 pub fn set_only_v6(&self, only_v6: bool) -> io::Result<()> {
424 setsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_V6ONLY, only_v6 as c_int)
427 pub fn only_v6(&self) -> io::Result<bool> {
428 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_V6ONLY)?;
432 pub fn take_error(&self) -> io::Result<Option<io::Error>> {
433 self.inner.take_error()
436 pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
437 self.inner.set_nonblocking(nonblocking)
441 impl FromInner<Socket> for TcpListener {
442 fn from_inner(socket: Socket) -> TcpListener {
443 TcpListener { inner: socket }
447 impl fmt::Debug for TcpListener {
448 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
449 let mut res = f.debug_struct("TcpListener");
451 if let Ok(addr) = self.socket_addr() {
452 res.field("addr", &addr);
455 let name = if cfg!(windows) { "socket" } else { "fd" };
456 res.field(name, &self.inner.as_inner()).finish()
460 ////////////////////////////////////////////////////////////////////////////////
462 ////////////////////////////////////////////////////////////////////////////////
464 pub struct UdpSocket {
469 pub fn bind(addr: io::Result<&SocketAddr>) -> io::Result<UdpSocket> {
474 let sock = Socket::new(addr, c::SOCK_DGRAM)?;
475 let (addrp, len) = addr.into_inner();
476 cvt(unsafe { c::bind(*sock.as_inner(), addrp, len as _) })?;
477 Ok(UdpSocket { inner: sock })
480 pub fn socket(&self) -> &Socket {
484 pub fn into_socket(self) -> Socket {
488 pub fn peer_addr(&self) -> io::Result<SocketAddr> {
489 sockname(|buf, len| unsafe { c::getpeername(*self.inner.as_inner(), buf, len) })
492 pub fn socket_addr(&self) -> io::Result<SocketAddr> {
493 sockname(|buf, len| unsafe { c::getsockname(*self.inner.as_inner(), buf, len) })
496 pub fn recv_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> {
497 self.inner.recv_from(buf)
500 pub fn peek_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> {
501 self.inner.peek_from(buf)
504 pub fn send_to(&self, buf: &[u8], dst: &SocketAddr) -> io::Result<usize> {
505 let len = cmp::min(buf.len(), <wrlen_t>::MAX as usize) as wrlen_t;
506 let (dstp, dstlen) = dst.into_inner();
507 let ret = cvt(unsafe {
509 *self.inner.as_inner(),
510 buf.as_ptr() as *const c_void,
520 pub fn duplicate(&self) -> io::Result<UdpSocket> {
521 self.inner.duplicate().map(|s| UdpSocket { inner: s })
524 pub fn set_read_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
525 self.inner.set_timeout(dur, c::SO_RCVTIMEO)
528 pub fn set_write_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
529 self.inner.set_timeout(dur, c::SO_SNDTIMEO)
532 pub fn read_timeout(&self) -> io::Result<Option<Duration>> {
533 self.inner.timeout(c::SO_RCVTIMEO)
536 pub fn write_timeout(&self) -> io::Result<Option<Duration>> {
537 self.inner.timeout(c::SO_SNDTIMEO)
540 pub fn set_broadcast(&self, broadcast: bool) -> io::Result<()> {
541 setsockopt(&self.inner, c::SOL_SOCKET, c::SO_BROADCAST, broadcast as c_int)
544 pub fn broadcast(&self) -> io::Result<bool> {
545 let raw: c_int = getsockopt(&self.inner, c::SOL_SOCKET, c::SO_BROADCAST)?;
549 pub fn set_multicast_loop_v4(&self, multicast_loop_v4: bool) -> io::Result<()> {
553 c::IP_MULTICAST_LOOP,
554 multicast_loop_v4 as IpV4MultiCastType,
558 pub fn multicast_loop_v4(&self) -> io::Result<bool> {
559 let raw: IpV4MultiCastType = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_MULTICAST_LOOP)?;
563 pub fn set_multicast_ttl_v4(&self, multicast_ttl_v4: u32) -> io::Result<()> {
568 multicast_ttl_v4 as IpV4MultiCastType,
572 pub fn multicast_ttl_v4(&self) -> io::Result<u32> {
573 let raw: IpV4MultiCastType = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_MULTICAST_TTL)?;
577 pub fn set_multicast_loop_v6(&self, multicast_loop_v6: bool) -> io::Result<()> {
578 setsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_MULTICAST_LOOP, multicast_loop_v6 as c_int)
581 pub fn multicast_loop_v6(&self) -> io::Result<bool> {
582 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_MULTICAST_LOOP)?;
586 pub fn join_multicast_v4(&self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr) -> io::Result<()> {
587 let mreq = c::ip_mreq {
588 imr_multiaddr: multiaddr.into_inner(),
589 imr_interface: interface.into_inner(),
591 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_ADD_MEMBERSHIP, mreq)
594 pub fn join_multicast_v6(&self, multiaddr: &Ipv6Addr, interface: u32) -> io::Result<()> {
595 let mreq = c::ipv6_mreq {
596 ipv6mr_multiaddr: *multiaddr.as_inner(),
597 ipv6mr_interface: to_ipv6mr_interface(interface),
599 setsockopt(&self.inner, c::IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP, mreq)
602 pub fn leave_multicast_v4(&self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr) -> io::Result<()> {
603 let mreq = c::ip_mreq {
604 imr_multiaddr: multiaddr.into_inner(),
605 imr_interface: interface.into_inner(),
607 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_DROP_MEMBERSHIP, mreq)
610 pub fn leave_multicast_v6(&self, multiaddr: &Ipv6Addr, interface: u32) -> io::Result<()> {
611 let mreq = c::ipv6_mreq {
612 ipv6mr_multiaddr: *multiaddr.as_inner(),
613 ipv6mr_interface: to_ipv6mr_interface(interface),
615 setsockopt(&self.inner, c::IPPROTO_IPV6, IPV6_DROP_MEMBERSHIP, mreq)
618 pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
619 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL, ttl as c_int)
622 pub fn ttl(&self) -> io::Result<u32> {
623 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL)?;
627 pub fn take_error(&self) -> io::Result<Option<io::Error>> {
628 self.inner.take_error()
631 pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
632 self.inner.set_nonblocking(nonblocking)
635 pub fn recv(&self, buf: &mut [u8]) -> io::Result<usize> {
639 pub fn peek(&self, buf: &mut [u8]) -> io::Result<usize> {
643 pub fn send(&self, buf: &[u8]) -> io::Result<usize> {
644 let len = cmp::min(buf.len(), <wrlen_t>::MAX as usize) as wrlen_t;
645 let ret = cvt(unsafe {
646 c::send(*self.inner.as_inner(), buf.as_ptr() as *const c_void, len, MSG_NOSIGNAL)
651 pub fn connect(&self, addr: io::Result<&SocketAddr>) -> io::Result<()> {
652 let (addrp, len) = addr?.into_inner();
653 cvt_r(|| unsafe { c::connect(*self.inner.as_inner(), addrp, len) }).map(drop)
657 impl FromInner<Socket> for UdpSocket {
658 fn from_inner(socket: Socket) -> UdpSocket {
659 UdpSocket { inner: socket }
663 impl fmt::Debug for UdpSocket {
664 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
665 let mut res = f.debug_struct("UdpSocket");
667 if let Ok(addr) = self.socket_addr() {
668 res.field("addr", &addr);
671 let name = if cfg!(windows) { "socket" } else { "fd" };
672 res.field(name, &self.inner.as_inner()).finish()