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.
16 use io::{self, Error, ErrorKind};
17 use libc::{c_int, c_void};
19 use net::{SocketAddr, Shutdown, Ipv4Addr, Ipv6Addr};
21 use sys::net::{cvt, cvt_r, cvt_gai, Socket, init, wrlen_t};
22 use sys::net::netc as c;
23 use sys_common::{AsInner, FromInner, IntoInner};
26 #[cfg(any(target_os = "dragonfly", target_os = "freebsd",
27 target_os = "ios", target_os = "macos",
28 target_os = "openbsd", target_os = "netbsd",
29 target_os = "solaris"))]
30 use sys::net::netc::IPV6_JOIN_GROUP as IPV6_ADD_MEMBERSHIP;
31 #[cfg(not(any(target_os = "dragonfly", target_os = "freebsd",
32 target_os = "ios", target_os = "macos",
33 target_os = "openbsd", target_os = "netbsd",
34 target_os = "solaris")))]
35 use sys::net::netc::IPV6_ADD_MEMBERSHIP;
36 #[cfg(any(target_os = "dragonfly", target_os = "freebsd",
37 target_os = "ios", target_os = "macos",
38 target_os = "openbsd", target_os = "netbsd",
39 target_os = "solaris"))]
40 use sys::net::netc::IPV6_LEAVE_GROUP as IPV6_DROP_MEMBERSHIP;
41 #[cfg(not(any(target_os = "dragonfly", target_os = "freebsd",
42 target_os = "ios", target_os = "macos",
43 target_os = "openbsd", target_os = "netbsd",
44 target_os = "solaris")))]
45 use sys::net::netc::IPV6_DROP_MEMBERSHIP;
47 ////////////////////////////////////////////////////////////////////////////////
48 // sockaddr and misc bindings
49 ////////////////////////////////////////////////////////////////////////////////
51 pub fn setsockopt<T>(sock: &Socket, opt: c_int, val: c_int,
52 payload: T) -> io::Result<()> {
54 let payload = &payload as *const T as *const c_void;
55 cvt(c::setsockopt(*sock.as_inner(), opt, val, payload,
56 mem::size_of::<T>() as c::socklen_t))?;
61 pub fn getsockopt<T: Copy>(sock: &Socket, opt: c_int,
62 val: c_int) -> io::Result<T> {
64 let mut slot: T = mem::zeroed();
65 let mut len = mem::size_of::<T>() as c::socklen_t;
66 cvt(c::getsockopt(*sock.as_inner(), opt, val,
67 &mut slot as *mut _ as *mut _,
69 assert_eq!(len as usize, mem::size_of::<T>());
74 fn sockname<F>(f: F) -> io::Result<SocketAddr>
75 where F: FnOnce(*mut c::sockaddr, *mut c::socklen_t) -> c_int
78 let mut storage: c::sockaddr_storage = mem::zeroed();
79 let mut len = mem::size_of_val(&storage) as c::socklen_t;
80 cvt(f(&mut storage as *mut _ as *mut _, &mut len))?;
81 sockaddr_to_addr(&storage, len as usize)
85 fn sockaddr_to_addr(storage: &c::sockaddr_storage,
86 len: usize) -> io::Result<SocketAddr> {
87 match storage.ss_family as c_int {
89 assert!(len as usize >= mem::size_of::<c::sockaddr_in>());
90 Ok(SocketAddr::V4(FromInner::from_inner(unsafe {
91 *(storage as *const _ as *const c::sockaddr_in)
95 assert!(len as usize >= mem::size_of::<c::sockaddr_in6>());
96 Ok(SocketAddr::V6(FromInner::from_inner(unsafe {
97 *(storage as *const _ as *const c::sockaddr_in6)
101 Err(Error::new(ErrorKind::InvalidInput, "invalid argument"))
106 #[cfg(target_os = "android")]
107 fn to_ipv6mr_interface(value: u32) -> c_int {
111 #[cfg(not(target_os = "android"))]
112 fn to_ipv6mr_interface(value: u32) -> ::libc::c_uint {
113 value as ::libc::c_uint
116 ////////////////////////////////////////////////////////////////////////////////
117 // get_host_addresses
118 ////////////////////////////////////////////////////////////////////////////////
120 pub struct LookupHost {
121 original: *mut c::addrinfo,
122 cur: *mut c::addrinfo,
125 impl Iterator for LookupHost {
126 type Item = SocketAddr;
127 fn next(&mut self) -> Option<SocketAddr> {
130 let cur = match self.cur.as_ref() {
134 self.cur = cur.ai_next;
135 match sockaddr_to_addr(mem::transmute(cur.ai_addr),
136 cur.ai_addrlen as usize)
138 Ok(addr) => return Some(addr),
146 unsafe impl Sync for LookupHost {}
147 unsafe impl Send for LookupHost {}
149 impl Drop for LookupHost {
151 unsafe { c::freeaddrinfo(self.original) }
155 pub fn lookup_host(host: &str) -> io::Result<LookupHost> {
158 let c_host = CString::new(host)?;
159 let hints = c::addrinfo {
162 ai_socktype: c::SOCK_STREAM,
165 ai_addr: ptr::null_mut(),
166 ai_canonname: ptr::null_mut(),
167 ai_next: ptr::null_mut()
169 let mut res = ptr::null_mut();
171 cvt_gai(c::getaddrinfo(c_host.as_ptr(), ptr::null(), &hints,
173 Ok(LookupHost { original: res, cur: res })
177 ////////////////////////////////////////////////////////////////////////////////
179 ////////////////////////////////////////////////////////////////////////////////
181 pub struct TcpStream {
186 pub fn connect(addr: &SocketAddr) -> io::Result<TcpStream> {
189 let sock = Socket::new(addr, c::SOCK_STREAM)?;
191 let (addrp, len) = addr.into_inner();
192 cvt_r(|| unsafe { c::connect(*sock.as_inner(), addrp, len) })?;
193 Ok(TcpStream { inner: sock })
196 pub fn socket(&self) -> &Socket { &self.inner }
198 pub fn into_socket(self) -> Socket { self.inner }
200 pub fn set_read_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
201 self.inner.set_timeout(dur, c::SO_RCVTIMEO)
204 pub fn set_write_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
205 self.inner.set_timeout(dur, c::SO_SNDTIMEO)
208 pub fn read_timeout(&self) -> io::Result<Option<Duration>> {
209 self.inner.timeout(c::SO_RCVTIMEO)
212 pub fn write_timeout(&self) -> io::Result<Option<Duration>> {
213 self.inner.timeout(c::SO_SNDTIMEO)
216 pub fn read(&self, buf: &mut [u8]) -> io::Result<usize> {
220 pub fn read_to_end(&self, buf: &mut Vec<u8>) -> io::Result<usize> {
221 self.inner.read_to_end(buf)
224 pub fn write(&self, buf: &[u8]) -> io::Result<usize> {
225 let len = cmp::min(buf.len(), <wrlen_t>::max_value() as usize) as wrlen_t;
226 let ret = cvt(unsafe {
227 c::send(*self.inner.as_inner(),
228 buf.as_ptr() as *const c_void,
235 pub fn peer_addr(&self) -> io::Result<SocketAddr> {
236 sockname(|buf, len| unsafe {
237 c::getpeername(*self.inner.as_inner(), buf, len)
241 pub fn socket_addr(&self) -> io::Result<SocketAddr> {
242 sockname(|buf, len| unsafe {
243 c::getsockname(*self.inner.as_inner(), buf, len)
247 pub fn shutdown(&self, how: Shutdown) -> io::Result<()> {
248 self.inner.shutdown(how)
251 pub fn duplicate(&self) -> io::Result<TcpStream> {
252 self.inner.duplicate().map(|s| TcpStream { inner: s })
255 pub fn set_nodelay(&self, nodelay: bool) -> io::Result<()> {
256 self.inner.set_nodelay(nodelay)
259 pub fn nodelay(&self) -> io::Result<bool> {
263 pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
264 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL, ttl as c_int)
267 pub fn ttl(&self) -> io::Result<u32> {
268 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL)?;
272 pub fn take_error(&self) -> io::Result<Option<io::Error>> {
273 self.inner.take_error()
276 pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
277 self.inner.set_nonblocking(nonblocking)
281 impl FromInner<Socket> for TcpStream {
282 fn from_inner(socket: Socket) -> TcpStream {
283 TcpStream { inner: socket }
287 impl fmt::Debug for TcpStream {
288 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
289 let mut res = f.debug_struct("TcpStream");
291 if let Ok(addr) = self.socket_addr() {
292 res.field("addr", &addr);
295 if let Ok(peer) = self.peer_addr() {
296 res.field("peer", &peer);
299 let name = if cfg!(windows) {"socket"} else {"fd"};
300 res.field(name, &self.inner.as_inner())
305 ////////////////////////////////////////////////////////////////////////////////
307 ////////////////////////////////////////////////////////////////////////////////
309 pub struct TcpListener {
314 pub fn bind(addr: &SocketAddr) -> io::Result<TcpListener> {
317 let sock = Socket::new(addr, c::SOCK_STREAM)?;
319 // On platforms with Berkeley-derived sockets, this allows
320 // to quickly rebind a socket, without needing to wait for
321 // the OS to clean up the previous one.
323 setsockopt(&sock, c::SOL_SOCKET, c::SO_REUSEADDR,
327 // Bind our new socket
328 let (addrp, len) = addr.into_inner();
329 cvt(unsafe { c::bind(*sock.as_inner(), addrp, len) })?;
332 cvt(unsafe { c::listen(*sock.as_inner(), 128) })?;
333 Ok(TcpListener { inner: sock })
336 pub fn socket(&self) -> &Socket { &self.inner }
338 pub fn into_socket(self) -> Socket { self.inner }
340 pub fn socket_addr(&self) -> io::Result<SocketAddr> {
341 sockname(|buf, len| unsafe {
342 c::getsockname(*self.inner.as_inner(), buf, len)
346 pub fn accept(&self) -> io::Result<(TcpStream, SocketAddr)> {
347 let mut storage: c::sockaddr_storage = unsafe { mem::zeroed() };
348 let mut len = mem::size_of_val(&storage) as c::socklen_t;
349 let sock = self.inner.accept(&mut storage as *mut _ as *mut _,
351 let addr = sockaddr_to_addr(&storage, len as usize)?;
352 Ok((TcpStream { inner: sock, }, addr))
355 pub fn duplicate(&self) -> io::Result<TcpListener> {
356 self.inner.duplicate().map(|s| TcpListener { inner: s })
359 pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
360 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL, ttl as c_int)
363 pub fn ttl(&self) -> io::Result<u32> {
364 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL)?;
368 pub fn set_only_v6(&self, only_v6: bool) -> io::Result<()> {
369 setsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_V6ONLY, only_v6 as c_int)
372 pub fn only_v6(&self) -> io::Result<bool> {
373 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_V6ONLY)?;
377 pub fn take_error(&self) -> io::Result<Option<io::Error>> {
378 self.inner.take_error()
381 pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
382 self.inner.set_nonblocking(nonblocking)
386 impl FromInner<Socket> for TcpListener {
387 fn from_inner(socket: Socket) -> TcpListener {
388 TcpListener { inner: socket }
392 impl fmt::Debug for TcpListener {
393 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
394 let mut res = f.debug_struct("TcpListener");
396 if let Ok(addr) = self.socket_addr() {
397 res.field("addr", &addr);
400 let name = if cfg!(windows) {"socket"} else {"fd"};
401 res.field(name, &self.inner.as_inner())
406 ////////////////////////////////////////////////////////////////////////////////
408 ////////////////////////////////////////////////////////////////////////////////
410 pub struct UdpSocket {
415 pub fn bind(addr: &SocketAddr) -> io::Result<UdpSocket> {
418 let sock = Socket::new(addr, c::SOCK_DGRAM)?;
419 let (addrp, len) = addr.into_inner();
420 cvt(unsafe { c::bind(*sock.as_inner(), addrp, len) })?;
421 Ok(UdpSocket { inner: sock })
424 pub fn socket(&self) -> &Socket { &self.inner }
426 pub fn into_socket(self) -> Socket { self.inner }
428 pub fn socket_addr(&self) -> io::Result<SocketAddr> {
429 sockname(|buf, len| unsafe {
430 c::getsockname(*self.inner.as_inner(), buf, len)
434 pub fn recv_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> {
435 let mut storage: c::sockaddr_storage = unsafe { mem::zeroed() };
436 let mut addrlen = mem::size_of_val(&storage) as c::socklen_t;
437 let len = cmp::min(buf.len(), <wrlen_t>::max_value() as usize) as wrlen_t;
440 c::recvfrom(*self.inner.as_inner(),
441 buf.as_mut_ptr() as *mut c_void,
443 &mut storage as *mut _ as *mut _, &mut addrlen)
445 Ok((n as usize, sockaddr_to_addr(&storage, addrlen as usize)?))
448 pub fn send_to(&self, buf: &[u8], dst: &SocketAddr) -> io::Result<usize> {
449 let len = cmp::min(buf.len(), <wrlen_t>::max_value() as usize) as wrlen_t;
450 let (dstp, dstlen) = dst.into_inner();
451 let ret = cvt(unsafe {
452 c::sendto(*self.inner.as_inner(),
453 buf.as_ptr() as *const c_void, len,
459 pub fn duplicate(&self) -> io::Result<UdpSocket> {
460 self.inner.duplicate().map(|s| UdpSocket { inner: s })
463 pub fn set_read_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
464 self.inner.set_timeout(dur, c::SO_RCVTIMEO)
467 pub fn set_write_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
468 self.inner.set_timeout(dur, c::SO_SNDTIMEO)
471 pub fn read_timeout(&self) -> io::Result<Option<Duration>> {
472 self.inner.timeout(c::SO_RCVTIMEO)
475 pub fn write_timeout(&self) -> io::Result<Option<Duration>> {
476 self.inner.timeout(c::SO_SNDTIMEO)
479 pub fn set_broadcast(&self, broadcast: bool) -> io::Result<()> {
480 setsockopt(&self.inner, c::SOL_SOCKET, c::SO_BROADCAST, broadcast as c_int)
483 pub fn broadcast(&self) -> io::Result<bool> {
484 let raw: c_int = getsockopt(&self.inner, c::SOL_SOCKET, c::SO_BROADCAST)?;
488 pub fn set_multicast_loop_v4(&self, multicast_loop_v4: bool) -> io::Result<()> {
489 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_MULTICAST_LOOP, multicast_loop_v4 as c_int)
492 pub fn multicast_loop_v4(&self) -> io::Result<bool> {
493 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_MULTICAST_LOOP)?;
497 pub fn set_multicast_ttl_v4(&self, multicast_ttl_v4: u32) -> io::Result<()> {
498 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_MULTICAST_TTL, multicast_ttl_v4 as c_int)
501 pub fn multicast_ttl_v4(&self) -> io::Result<u32> {
502 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_MULTICAST_TTL)?;
506 pub fn set_multicast_loop_v6(&self, multicast_loop_v6: bool) -> io::Result<()> {
507 setsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_MULTICAST_LOOP, multicast_loop_v6 as c_int)
510 pub fn multicast_loop_v6(&self) -> io::Result<bool> {
511 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_MULTICAST_LOOP)?;
515 pub fn join_multicast_v4(&self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr)
517 let mreq = c::ip_mreq {
518 imr_multiaddr: *multiaddr.as_inner(),
519 imr_interface: *interface.as_inner(),
521 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_ADD_MEMBERSHIP, mreq)
524 pub fn join_multicast_v6(&self, multiaddr: &Ipv6Addr, interface: u32)
526 let mreq = c::ipv6_mreq {
527 ipv6mr_multiaddr: *multiaddr.as_inner(),
528 ipv6mr_interface: to_ipv6mr_interface(interface),
530 setsockopt(&self.inner, c::IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP, mreq)
533 pub fn leave_multicast_v4(&self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr)
535 let mreq = c::ip_mreq {
536 imr_multiaddr: *multiaddr.as_inner(),
537 imr_interface: *interface.as_inner(),
539 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_DROP_MEMBERSHIP, mreq)
542 pub fn leave_multicast_v6(&self, multiaddr: &Ipv6Addr, interface: u32)
544 let mreq = c::ipv6_mreq {
545 ipv6mr_multiaddr: *multiaddr.as_inner(),
546 ipv6mr_interface: to_ipv6mr_interface(interface),
548 setsockopt(&self.inner, c::IPPROTO_IPV6, IPV6_DROP_MEMBERSHIP, mreq)
551 pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
552 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL, ttl as c_int)
555 pub fn ttl(&self) -> io::Result<u32> {
556 let raw: c_int = getsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL)?;
560 pub fn take_error(&self) -> io::Result<Option<io::Error>> {
561 self.inner.take_error()
564 pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
565 self.inner.set_nonblocking(nonblocking)
568 pub fn recv(&self, buf: &mut [u8]) -> io::Result<usize> {
572 pub fn send(&self, buf: &[u8]) -> io::Result<usize> {
573 let len = cmp::min(buf.len(), <wrlen_t>::max_value() as usize) as wrlen_t;
574 let ret = cvt(unsafe {
575 c::send(*self.inner.as_inner(),
576 buf.as_ptr() as *const c_void,
583 pub fn connect(&self, addr: &SocketAddr) -> io::Result<()> {
584 let (addrp, len) = addr.into_inner();
585 cvt_r(|| unsafe { c::connect(*self.inner.as_inner(), addrp, len) }).map(|_| ())
589 impl FromInner<Socket> for UdpSocket {
590 fn from_inner(socket: Socket) -> UdpSocket {
591 UdpSocket { inner: socket }
595 impl fmt::Debug for UdpSocket {
596 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
597 let mut res = f.debug_struct("UdpSocket");
599 if let Ok(addr) = self.socket_addr() {
600 res.field("addr", &addr);
603 let name = if cfg!(windows) {"socket"} else {"fd"};
604 res.field(name, &self.inner.as_inner())
614 use collections::HashMap;
617 fn no_lookup_host_duplicates() {
618 let mut addrs = HashMap::new();
619 let lh = match lookup_host("localhost") {
621 Err(e) => panic!("couldn't resolve `localhost': {}", e)
623 let _na = lh.map(|sa| *addrs.entry(sa).or_insert(0) += 1).count();
624 assert!(addrs.values().filter(|&&v| v > 1).count() == 0);