1 // Copyright 2013-2014 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
14 use io::{self, Error, ErrorKind};
15 use libc::{c_int, c_void};
17 use net::{SocketAddr, Shutdown, Ipv4Addr, Ipv6Addr};
19 use sys::net::{cvt, cvt_r, cvt_gai, Socket, init, wrlen_t};
20 use sys::net::netc as c;
21 use sys_common::{AsInner, FromInner, IntoInner};
24 #[cfg(any(target_os = "dragonfly", target_os = "freebsd",
25 target_os = "ios", target_os = "macos",
26 target_os = "openbsd", target_os = "netbsd",
27 target_os = "solaris"))]
28 use sys::net::netc::IPV6_JOIN_GROUP as IPV6_ADD_MEMBERSHIP;
29 #[cfg(not(any(target_os = "dragonfly", target_os = "freebsd",
30 target_os = "ios", target_os = "macos",
31 target_os = "openbsd", target_os = "netbsd",
32 target_os = "solaris")))]
33 use sys::net::netc::IPV6_ADD_MEMBERSHIP;
34 #[cfg(any(target_os = "dragonfly", target_os = "freebsd",
35 target_os = "ios", target_os = "macos",
36 target_os = "openbsd", target_os = "netbsd",
37 target_os = "solaris"))]
38 use sys::net::netc::IPV6_LEAVE_GROUP as IPV6_DROP_MEMBERSHIP;
39 #[cfg(not(any(target_os = "dragonfly", target_os = "freebsd",
40 target_os = "ios", target_os = "macos",
41 target_os = "openbsd", target_os = "netbsd",
42 target_os = "solaris")))]
43 use sys::net::netc::IPV6_DROP_MEMBERSHIP;
45 ////////////////////////////////////////////////////////////////////////////////
46 // sockaddr and misc bindings
47 ////////////////////////////////////////////////////////////////////////////////
49 pub fn setsockopt<T>(sock: &Socket, opt: c_int, val: c_int,
50 payload: T) -> io::Result<()> {
52 let payload = &payload as *const T as *const c_void;
53 cvt(c::setsockopt(*sock.as_inner(), opt, val, payload,
54 mem::size_of::<T>() as c::socklen_t))?;
59 pub fn getsockopt<T: Copy>(sock: &Socket, opt: c_int,
60 val: c_int) -> io::Result<T> {
62 let mut slot: T = mem::zeroed();
63 let mut len = mem::size_of::<T>() as c::socklen_t;
64 cvt(c::getsockopt(*sock.as_inner(), opt, val,
65 &mut slot as *mut _ as *mut _,
67 assert_eq!(len as usize, mem::size_of::<T>());
72 fn sockname<F>(f: F) -> io::Result<SocketAddr>
73 where F: FnOnce(*mut c::sockaddr, *mut c::socklen_t) -> c_int
76 let mut storage: c::sockaddr_storage = mem::zeroed();
77 let mut len = mem::size_of_val(&storage) as c::socklen_t;
78 cvt(f(&mut storage as *mut _ as *mut _, &mut len))?;
79 sockaddr_to_addr(&storage, len as usize)
83 fn sockaddr_to_addr(storage: &c::sockaddr_storage,
84 len: usize) -> io::Result<SocketAddr> {
85 match storage.ss_family as c_int {
87 assert!(len as usize >= mem::size_of::<c::sockaddr_in>());
88 Ok(SocketAddr::V4(FromInner::from_inner(unsafe {
89 *(storage as *const _ as *const c::sockaddr_in)
93 assert!(len as usize >= mem::size_of::<c::sockaddr_in6>());
94 Ok(SocketAddr::V6(FromInner::from_inner(unsafe {
95 *(storage as *const _ as *const c::sockaddr_in6)
99 Err(Error::new(ErrorKind::InvalidInput, "invalid argument"))
104 #[cfg(target_os = "android")]
105 fn to_ipv6mr_interface(value: u32) -> c_int {
109 #[cfg(not(target_os = "android"))]
110 fn to_ipv6mr_interface(value: u32) -> ::libc::c_uint {
111 value as ::libc::c_uint
114 ////////////////////////////////////////////////////////////////////////////////
115 // get_host_addresses
116 ////////////////////////////////////////////////////////////////////////////////
118 pub struct LookupHost {
119 original: *mut c::addrinfo,
120 cur: *mut c::addrinfo,
123 impl Iterator for LookupHost {
124 type Item = SocketAddr;
125 fn next(&mut self) -> Option<SocketAddr> {
128 let cur = match self.cur.as_ref() {
132 self.cur = cur.ai_next;
133 match sockaddr_to_addr(mem::transmute(cur.ai_addr),
134 cur.ai_addrlen as usize)
136 Ok(addr) => return Some(addr),
144 unsafe impl Sync for LookupHost {}
145 unsafe impl Send for LookupHost {}
147 impl Drop for LookupHost {
149 unsafe { c::freeaddrinfo(self.original) }
153 pub fn lookup_host(host: &str) -> io::Result<LookupHost> {
156 let c_host = CString::new(host)?;
157 let hints = c::addrinfo {
160 ai_socktype: c::SOCK_STREAM,
163 ai_addr: ptr::null_mut(),
164 ai_canonname: ptr::null_mut(),
165 ai_next: ptr::null_mut()
167 let mut res = ptr::null_mut();
169 cvt_gai(c::getaddrinfo(c_host.as_ptr(), ptr::null(), &hints,
171 Ok(LookupHost { original: res, cur: res })
175 ////////////////////////////////////////////////////////////////////////////////
177 ////////////////////////////////////////////////////////////////////////////////
179 pub struct TcpStream {
184 pub fn connect(addr: &SocketAddr) -> io::Result<TcpStream> {
187 let sock = Socket::new(addr, c::SOCK_STREAM)?;
189 let (addrp, len) = addr.into_inner();
190 cvt_r(|| unsafe { c::connect(*sock.as_inner(), addrp, len) })?;
191 Ok(TcpStream { inner: sock })
194 pub fn socket(&self) -> &Socket { &self.inner }
196 pub fn into_socket(self) -> Socket { self.inner }
198 pub fn set_read_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
199 self.inner.set_timeout(dur, c::SO_RCVTIMEO)
202 pub fn set_write_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
203 self.inner.set_timeout(dur, c::SO_SNDTIMEO)
206 pub fn read_timeout(&self) -> io::Result<Option<Duration>> {
207 self.inner.timeout(c::SO_RCVTIMEO)
210 pub fn write_timeout(&self) -> io::Result<Option<Duration>> {
211 self.inner.timeout(c::SO_SNDTIMEO)
214 pub fn read(&self, buf: &mut [u8]) -> io::Result<usize> {
218 pub fn read_to_end(&self, buf: &mut Vec<u8>) -> io::Result<usize> {
219 self.inner.read_to_end(buf)
222 pub fn write(&self, buf: &[u8]) -> io::Result<usize> {
223 let len = cmp::min(buf.len(), <wrlen_t>::max_value() as usize) as wrlen_t;
224 let ret = cvt(unsafe {
225 c::send(*self.inner.as_inner(),
226 buf.as_ptr() as *const c_void,
233 pub fn peer_addr(&self) -> io::Result<SocketAddr> {
234 sockname(|buf, len| unsafe {
235 c::getpeername(*self.inner.as_inner(), buf, len)
239 pub fn socket_addr(&self) -> io::Result<SocketAddr> {
240 sockname(|buf, len| unsafe {
241 c::getsockname(*self.inner.as_inner(), buf, len)
245 pub fn shutdown(&self, how: Shutdown) -> io::Result<()> {
246 self.inner.shutdown(how)
249 pub fn duplicate(&self) -> io::Result<TcpStream> {
250 self.inner.duplicate().map(|s| TcpStream { inner: s })
253 pub fn set_nodelay(&self, nodelay: bool) -> io::Result<()> {
254 self.inner.set_nodelay(nodelay)
257 pub fn nodelay(&self) -> io::Result<bool> {
261 pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
262 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL, ttl as c_int)
265 pub fn ttl(&self) -> io::Result<u32> {
266 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL)?;
270 pub fn take_error(&self) -> io::Result<Option<io::Error>> {
271 self.inner.take_error()
274 pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
275 self.inner.set_nonblocking(nonblocking)
279 impl FromInner<Socket> for TcpStream {
280 fn from_inner(socket: Socket) -> TcpStream {
281 TcpStream { inner: socket }
285 impl fmt::Debug for TcpStream {
286 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
287 let mut res = f.debug_struct("TcpStream");
289 if let Ok(addr) = self.socket_addr() {
290 res.field("addr", &addr);
293 if let Ok(peer) = self.peer_addr() {
294 res.field("peer", &peer);
297 let name = if cfg!(windows) {"socket"} else {"fd"};
298 res.field(name, &self.inner.as_inner())
303 ////////////////////////////////////////////////////////////////////////////////
305 ////////////////////////////////////////////////////////////////////////////////
307 pub struct TcpListener {
312 pub fn bind(addr: &SocketAddr) -> io::Result<TcpListener> {
315 let sock = Socket::new(addr, c::SOCK_STREAM)?;
317 // On platforms with Berkeley-derived sockets, this allows
318 // to quickly rebind a socket, without needing to wait for
319 // the OS to clean up the previous one.
321 setsockopt(&sock, c::SOL_SOCKET, c::SO_REUSEADDR,
325 // Bind our new socket
326 let (addrp, len) = addr.into_inner();
327 cvt(unsafe { c::bind(*sock.as_inner(), addrp, len) })?;
330 cvt(unsafe { c::listen(*sock.as_inner(), 128) })?;
331 Ok(TcpListener { inner: sock })
334 pub fn socket(&self) -> &Socket { &self.inner }
336 pub fn into_socket(self) -> Socket { self.inner }
338 pub fn socket_addr(&self) -> io::Result<SocketAddr> {
339 sockname(|buf, len| unsafe {
340 c::getsockname(*self.inner.as_inner(), buf, len)
344 pub fn accept(&self) -> io::Result<(TcpStream, SocketAddr)> {
345 let mut storage: c::sockaddr_storage = unsafe { mem::zeroed() };
346 let mut len = mem::size_of_val(&storage) as c::socklen_t;
347 let sock = self.inner.accept(&mut storage as *mut _ as *mut _,
349 let addr = sockaddr_to_addr(&storage, len as usize)?;
350 Ok((TcpStream { inner: sock, }, addr))
353 pub fn duplicate(&self) -> io::Result<TcpListener> {
354 self.inner.duplicate().map(|s| TcpListener { inner: s })
357 pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
358 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL, ttl as c_int)
361 pub fn ttl(&self) -> io::Result<u32> {
362 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL)?;
366 pub fn set_only_v6(&self, only_v6: bool) -> io::Result<()> {
367 setsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_V6ONLY, only_v6 as c_int)
370 pub fn only_v6(&self) -> io::Result<bool> {
371 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_V6ONLY)?;
375 pub fn take_error(&self) -> io::Result<Option<io::Error>> {
376 self.inner.take_error()
379 pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
380 self.inner.set_nonblocking(nonblocking)
384 impl FromInner<Socket> for TcpListener {
385 fn from_inner(socket: Socket) -> TcpListener {
386 TcpListener { inner: socket }
390 impl fmt::Debug for TcpListener {
391 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
392 let mut res = f.debug_struct("TcpListener");
394 if let Ok(addr) = self.socket_addr() {
395 res.field("addr", &addr);
398 let name = if cfg!(windows) {"socket"} else {"fd"};
399 res.field(name, &self.inner.as_inner())
404 ////////////////////////////////////////////////////////////////////////////////
406 ////////////////////////////////////////////////////////////////////////////////
408 pub struct UdpSocket {
413 pub fn bind(addr: &SocketAddr) -> io::Result<UdpSocket> {
416 let sock = Socket::new(addr, c::SOCK_DGRAM)?;
417 let (addrp, len) = addr.into_inner();
418 cvt(unsafe { c::bind(*sock.as_inner(), addrp, len) })?;
419 Ok(UdpSocket { inner: sock })
422 pub fn socket(&self) -> &Socket { &self.inner }
424 pub fn into_socket(self) -> Socket { self.inner }
426 pub fn socket_addr(&self) -> io::Result<SocketAddr> {
427 sockname(|buf, len| unsafe {
428 c::getsockname(*self.inner.as_inner(), buf, len)
432 pub fn recv_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> {
433 let mut storage: c::sockaddr_storage = unsafe { mem::zeroed() };
434 let mut addrlen = mem::size_of_val(&storage) as c::socklen_t;
435 let len = cmp::min(buf.len(), <wrlen_t>::max_value() as usize) as wrlen_t;
438 c::recvfrom(*self.inner.as_inner(),
439 buf.as_mut_ptr() as *mut c_void,
441 &mut storage as *mut _ as *mut _, &mut addrlen)
443 Ok((n as usize, sockaddr_to_addr(&storage, addrlen as usize)?))
446 pub fn send_to(&self, buf: &[u8], dst: &SocketAddr) -> io::Result<usize> {
447 let len = cmp::min(buf.len(), <wrlen_t>::max_value() as usize) as wrlen_t;
448 let (dstp, dstlen) = dst.into_inner();
449 let ret = cvt(unsafe {
450 c::sendto(*self.inner.as_inner(),
451 buf.as_ptr() as *const c_void, len,
457 pub fn duplicate(&self) -> io::Result<UdpSocket> {
458 self.inner.duplicate().map(|s| UdpSocket { inner: s })
461 pub fn set_read_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
462 self.inner.set_timeout(dur, c::SO_RCVTIMEO)
465 pub fn set_write_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
466 self.inner.set_timeout(dur, c::SO_SNDTIMEO)
469 pub fn read_timeout(&self) -> io::Result<Option<Duration>> {
470 self.inner.timeout(c::SO_RCVTIMEO)
473 pub fn write_timeout(&self) -> io::Result<Option<Duration>> {
474 self.inner.timeout(c::SO_SNDTIMEO)
477 pub fn set_broadcast(&self, broadcast: bool) -> io::Result<()> {
478 setsockopt(&self.inner, c::SOL_SOCKET, c::SO_BROADCAST, broadcast as c_int)
481 pub fn broadcast(&self) -> io::Result<bool> {
482 let raw: c_int = getsockopt(&self.inner, c::SOL_SOCKET, c::SO_BROADCAST)?;
486 pub fn set_multicast_loop_v4(&self, multicast_loop_v4: bool) -> io::Result<()> {
487 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_MULTICAST_LOOP, multicast_loop_v4 as c_int)
490 pub fn multicast_loop_v4(&self) -> io::Result<bool> {
491 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_MULTICAST_LOOP)?;
495 pub fn set_multicast_ttl_v4(&self, multicast_ttl_v4: u32) -> io::Result<()> {
496 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_MULTICAST_TTL, multicast_ttl_v4 as c_int)
499 pub fn multicast_ttl_v4(&self) -> io::Result<u32> {
500 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_MULTICAST_TTL)?;
504 pub fn set_multicast_loop_v6(&self, multicast_loop_v6: bool) -> io::Result<()> {
505 setsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_MULTICAST_LOOP, multicast_loop_v6 as c_int)
508 pub fn multicast_loop_v6(&self) -> io::Result<bool> {
509 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_MULTICAST_LOOP)?;
513 pub fn join_multicast_v4(&self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr)
515 let mreq = c::ip_mreq {
516 imr_multiaddr: *multiaddr.as_inner(),
517 imr_interface: *interface.as_inner(),
519 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_ADD_MEMBERSHIP, mreq)
522 pub fn join_multicast_v6(&self, multiaddr: &Ipv6Addr, interface: u32)
524 let mreq = c::ipv6_mreq {
525 ipv6mr_multiaddr: *multiaddr.as_inner(),
526 ipv6mr_interface: to_ipv6mr_interface(interface),
528 setsockopt(&self.inner, c::IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP, mreq)
531 pub fn leave_multicast_v4(&self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr)
533 let mreq = c::ip_mreq {
534 imr_multiaddr: *multiaddr.as_inner(),
535 imr_interface: *interface.as_inner(),
537 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_DROP_MEMBERSHIP, mreq)
540 pub fn leave_multicast_v6(&self, multiaddr: &Ipv6Addr, interface: u32)
542 let mreq = c::ipv6_mreq {
543 ipv6mr_multiaddr: *multiaddr.as_inner(),
544 ipv6mr_interface: to_ipv6mr_interface(interface),
546 setsockopt(&self.inner, c::IPPROTO_IPV6, IPV6_DROP_MEMBERSHIP, mreq)
549 pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
550 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL, ttl as c_int)
553 pub fn ttl(&self) -> io::Result<u32> {
554 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL)?;
558 pub fn take_error(&self) -> io::Result<Option<io::Error>> {
559 self.inner.take_error()
562 pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
563 self.inner.set_nonblocking(nonblocking)
566 pub fn recv(&self, buf: &mut [u8]) -> io::Result<usize> {
570 pub fn send(&self, buf: &[u8]) -> io::Result<usize> {
571 let len = cmp::min(buf.len(), <wrlen_t>::max_value() as usize) as wrlen_t;
572 let ret = cvt(unsafe {
573 c::send(*self.inner.as_inner(),
574 buf.as_ptr() as *const c_void,
581 pub fn connect(&self, addr: &SocketAddr) -> io::Result<()> {
582 let (addrp, len) = addr.into_inner();
583 cvt_r(|| unsafe { c::connect(*self.inner.as_inner(), addrp, len) }).map(|_| ())
587 impl FromInner<Socket> for UdpSocket {
588 fn from_inner(socket: Socket) -> UdpSocket {
589 UdpSocket { inner: socket }
593 impl fmt::Debug for UdpSocket {
594 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
595 let mut res = f.debug_struct("UdpSocket");
597 if let Ok(addr) = self.socket_addr() {
598 res.field("addr", &addr);
601 let name = if cfg!(windows) {"socket"} else {"fd"};
602 res.field(name, &self.inner.as_inner())
610 use collections::HashMap;
613 fn no_lookup_host_duplicates() {
614 let mut addrs = HashMap::new();
615 let lh = match lookup_host("localhost") {
617 Err(e) => panic!("couldn't resolve `localhost': {}", e)
619 let _na = lh.map(|sa| *addrs.entry(sa).or_insert(0) += 1).count();
620 assert!(addrs.values().filter(|&&v| v > 1).count() == 0);