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 ffi::{CStr, CString};
16 use io::{self, Error, ErrorKind};
17 use libc::{c_int, c_char, c_void};
20 use net::{SocketAddr, Shutdown, IpAddr, Ipv4Addr, Ipv6Addr};
23 use sys::net::{cvt, cvt_r, cvt_gai, Socket, init, wrlen_t};
24 use sys::net::netc as c;
25 use sys_common::{AsInner, FromInner, IntoInner};
28 #[cfg(any(target_os = "dragonfly", target_os = "freebsd",
29 target_os = "ios", target_os = "macos",
30 target_os = "openbsd", target_os = "netbsd"))]
31 use sys::net::netc::IPV6_JOIN_GROUP as IPV6_ADD_MEMBERSHIP;
32 #[cfg(not(any(target_os = "dragonfly", target_os = "freebsd",
33 target_os = "ios", target_os = "macos",
34 target_os = "openbsd", target_os = "netbsd")))]
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 use sys::net::netc::IPV6_LEAVE_GROUP as IPV6_DROP_MEMBERSHIP;
40 #[cfg(not(any(target_os = "dragonfly", target_os = "freebsd",
41 target_os = "ios", target_os = "macos",
42 target_os = "openbsd", target_os = "netbsd")))]
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 try!(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 try!(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 try!(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 = io::Result<SocketAddr>;
125 fn next(&mut self) -> Option<io::Result<SocketAddr>> {
127 if self.cur.is_null() { return None }
128 let ret = sockaddr_to_addr(mem::transmute((*self.cur).ai_addr),
129 (*self.cur).ai_addrlen as usize);
130 self.cur = (*self.cur).ai_next as *mut c::addrinfo;
136 unsafe impl Sync for LookupHost {}
137 unsafe impl Send for LookupHost {}
139 impl Drop for LookupHost {
141 unsafe { c::freeaddrinfo(self.original) }
145 pub fn lookup_host(host: &str) -> io::Result<LookupHost> {
148 let c_host = try!(CString::new(host));
149 let mut res = ptr::null_mut();
151 try!(cvt_gai(c::getaddrinfo(c_host.as_ptr(), ptr::null(), ptr::null(),
153 Ok(LookupHost { original: res, cur: res })
157 ////////////////////////////////////////////////////////////////////////////////
159 ////////////////////////////////////////////////////////////////////////////////
162 pub fn lookup_addr(addr: &IpAddr) -> io::Result<String> {
165 let saddr = SocketAddr::new(*addr, 0);
166 let (inner, len) = saddr.into_inner();
167 let mut hostbuf = [0 as c_char; c::NI_MAXHOST as usize];
170 try!(cvt_gai(c::getnameinfo(inner, len,
171 hostbuf.as_mut_ptr(),
173 ptr::null_mut(), 0, 0)));
175 CStr::from_ptr(hostbuf.as_ptr())
178 match from_utf8(data.to_bytes()) {
179 Ok(name) => Ok(name.to_owned()),
180 Err(_) => Err(io::Error::new(io::ErrorKind::Other,
181 "failed to lookup address information"))
185 ////////////////////////////////////////////////////////////////////////////////
187 ////////////////////////////////////////////////////////////////////////////////
189 pub struct TcpStream {
194 pub fn connect(addr: &SocketAddr) -> io::Result<TcpStream> {
197 let sock = try!(Socket::new(addr, c::SOCK_STREAM));
199 let (addrp, len) = addr.into_inner();
200 try!(cvt_r(|| unsafe { c::connect(*sock.as_inner(), addrp, len) }));
201 Ok(TcpStream { inner: sock })
204 pub fn socket(&self) -> &Socket { &self.inner }
206 pub fn into_socket(self) -> Socket { self.inner }
208 pub fn set_read_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
209 self.inner.set_timeout(dur, c::SO_RCVTIMEO)
212 pub fn set_write_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
213 self.inner.set_timeout(dur, c::SO_SNDTIMEO)
216 pub fn read_timeout(&self) -> io::Result<Option<Duration>> {
217 self.inner.timeout(c::SO_RCVTIMEO)
220 pub fn write_timeout(&self) -> io::Result<Option<Duration>> {
221 self.inner.timeout(c::SO_SNDTIMEO)
224 pub fn read(&self, buf: &mut [u8]) -> io::Result<usize> {
228 pub fn read_to_end(&self, buf: &mut Vec<u8>) -> io::Result<usize> {
229 self.inner.read_to_end(buf)
232 pub fn write(&self, buf: &[u8]) -> io::Result<usize> {
233 let len = cmp::min(buf.len(), <wrlen_t>::max_value() as usize) as wrlen_t;
234 let ret = try!(cvt(unsafe {
235 c::send(*self.inner.as_inner(),
236 buf.as_ptr() as *const c_void,
243 pub fn peer_addr(&self) -> io::Result<SocketAddr> {
244 sockname(|buf, len| unsafe {
245 c::getpeername(*self.inner.as_inner(), buf, len)
249 pub fn socket_addr(&self) -> io::Result<SocketAddr> {
250 sockname(|buf, len| unsafe {
251 c::getsockname(*self.inner.as_inner(), buf, len)
255 pub fn shutdown(&self, how: Shutdown) -> io::Result<()> {
256 self.inner.shutdown(how)
259 pub fn duplicate(&self) -> io::Result<TcpStream> {
260 self.inner.duplicate().map(|s| TcpStream { inner: s })
263 pub fn set_nodelay(&self, nodelay: bool) -> io::Result<()> {
264 self.inner.set_nodelay(nodelay)
267 pub fn nodelay(&self) -> io::Result<bool> {
271 pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
272 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL, ttl as c_int)
275 pub fn ttl(&self) -> io::Result<u32> {
276 let raw: c_int = try!(getsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL));
280 pub fn set_only_v6(&self, only_v6: bool) -> io::Result<()> {
281 setsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_V6ONLY, only_v6 as c_int)
284 pub fn only_v6(&self) -> io::Result<bool> {
285 let raw: c_int = try!(getsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_V6ONLY));
289 pub fn take_error(&self) -> io::Result<Option<io::Error>> {
290 let raw: c_int = try!(getsockopt(&self.inner, c::SOL_SOCKET, c::SO_ERROR));
294 Ok(Some(io::Error::from_raw_os_error(raw as i32)))
298 pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
299 self.inner.set_nonblocking(nonblocking)
303 impl FromInner<Socket> for TcpStream {
304 fn from_inner(socket: Socket) -> TcpStream {
305 TcpStream { inner: socket }
309 impl fmt::Debug for TcpStream {
310 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
311 let mut res = f.debug_struct("TcpStream");
313 if let Ok(addr) = self.socket_addr() {
314 res.field("addr", &addr);
317 if let Ok(peer) = self.peer_addr() {
318 res.field("peer", &peer);
321 let name = if cfg!(windows) {"socket"} else {"fd"};
322 res.field(name, &self.inner.as_inner())
327 ////////////////////////////////////////////////////////////////////////////////
329 ////////////////////////////////////////////////////////////////////////////////
331 pub struct TcpListener {
336 pub fn bind(addr: &SocketAddr) -> io::Result<TcpListener> {
339 let sock = try!(Socket::new(addr, c::SOCK_STREAM));
341 // On platforms with Berkeley-derived sockets, this allows
342 // to quickly rebind a socket, without needing to wait for
343 // the OS to clean up the previous one.
345 try!(setsockopt(&sock, c::SOL_SOCKET, c::SO_REUSEADDR,
349 // Bind our new socket
350 let (addrp, len) = addr.into_inner();
351 try!(cvt(unsafe { c::bind(*sock.as_inner(), addrp, len) }));
354 try!(cvt(unsafe { c::listen(*sock.as_inner(), 128) }));
355 Ok(TcpListener { inner: sock })
358 pub fn socket(&self) -> &Socket { &self.inner }
360 pub fn into_socket(self) -> Socket { self.inner }
362 pub fn socket_addr(&self) -> io::Result<SocketAddr> {
363 sockname(|buf, len| unsafe {
364 c::getsockname(*self.inner.as_inner(), buf, len)
368 pub fn accept(&self) -> io::Result<(TcpStream, SocketAddr)> {
369 let mut storage: c::sockaddr_storage = unsafe { mem::zeroed() };
370 let mut len = mem::size_of_val(&storage) as c::socklen_t;
371 let sock = try!(self.inner.accept(&mut storage as *mut _ as *mut _,
373 let addr = try!(sockaddr_to_addr(&storage, len as usize));
374 Ok((TcpStream { inner: sock, }, addr))
377 pub fn duplicate(&self) -> io::Result<TcpListener> {
378 self.inner.duplicate().map(|s| TcpListener { inner: s })
381 pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
382 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL, ttl as c_int)
385 pub fn ttl(&self) -> io::Result<u32> {
386 let raw: c_int = try!(getsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL));
390 pub fn set_only_v6(&self, only_v6: bool) -> io::Result<()> {
391 setsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_V6ONLY, only_v6 as c_int)
394 pub fn only_v6(&self) -> io::Result<bool> {
395 let raw: c_int = try!(getsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_V6ONLY));
399 pub fn take_error(&self) -> io::Result<Option<io::Error>> {
400 let raw: c_int = try!(getsockopt(&self.inner, c::SOL_SOCKET, c::SO_ERROR));
404 Ok(Some(io::Error::from_raw_os_error(raw as i32)))
408 pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
409 self.inner.set_nonblocking(nonblocking)
413 impl FromInner<Socket> for TcpListener {
414 fn from_inner(socket: Socket) -> TcpListener {
415 TcpListener { inner: socket }
419 impl fmt::Debug for TcpListener {
420 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
421 let mut res = f.debug_struct("TcpListener");
423 if let Ok(addr) = self.socket_addr() {
424 res.field("addr", &addr);
427 let name = if cfg!(windows) {"socket"} else {"fd"};
428 res.field(name, &self.inner.as_inner())
433 ////////////////////////////////////////////////////////////////////////////////
435 ////////////////////////////////////////////////////////////////////////////////
437 pub struct UdpSocket {
442 pub fn bind(addr: &SocketAddr) -> io::Result<UdpSocket> {
445 let sock = try!(Socket::new(addr, c::SOCK_DGRAM));
446 let (addrp, len) = addr.into_inner();
447 try!(cvt(unsafe { c::bind(*sock.as_inner(), addrp, len) }));
448 Ok(UdpSocket { inner: sock })
451 pub fn socket(&self) -> &Socket { &self.inner }
453 pub fn into_socket(self) -> Socket { self.inner }
455 pub fn socket_addr(&self) -> io::Result<SocketAddr> {
456 sockname(|buf, len| unsafe {
457 c::getsockname(*self.inner.as_inner(), buf, len)
461 pub fn recv_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> {
462 let mut storage: c::sockaddr_storage = unsafe { mem::zeroed() };
463 let mut addrlen = mem::size_of_val(&storage) as c::socklen_t;
464 let len = cmp::min(buf.len(), <wrlen_t>::max_value() as usize) as wrlen_t;
466 let n = try!(cvt(unsafe {
467 c::recvfrom(*self.inner.as_inner(),
468 buf.as_mut_ptr() as *mut c_void,
470 &mut storage as *mut _ as *mut _, &mut addrlen)
472 Ok((n as usize, try!(sockaddr_to_addr(&storage, addrlen as usize))))
475 pub fn send_to(&self, buf: &[u8], dst: &SocketAddr) -> io::Result<usize> {
476 let len = cmp::min(buf.len(), <wrlen_t>::max_value() as usize) as wrlen_t;
477 let (dstp, dstlen) = dst.into_inner();
478 let ret = try!(cvt(unsafe {
479 c::sendto(*self.inner.as_inner(),
480 buf.as_ptr() as *const c_void, len,
486 pub fn duplicate(&self) -> io::Result<UdpSocket> {
487 self.inner.duplicate().map(|s| UdpSocket { inner: s })
490 pub fn set_read_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
491 self.inner.set_timeout(dur, c::SO_RCVTIMEO)
494 pub fn set_write_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
495 self.inner.set_timeout(dur, c::SO_SNDTIMEO)
498 pub fn read_timeout(&self) -> io::Result<Option<Duration>> {
499 self.inner.timeout(c::SO_RCVTIMEO)
502 pub fn write_timeout(&self) -> io::Result<Option<Duration>> {
503 self.inner.timeout(c::SO_SNDTIMEO)
506 pub fn set_broadcast(&self, broadcast: bool) -> io::Result<()> {
507 setsockopt(&self.inner, c::SOL_SOCKET, c::SO_BROADCAST, broadcast as c_int)
510 pub fn broadcast(&self) -> io::Result<bool> {
511 let raw: c_int = try!(getsockopt(&self.inner, c::SOL_SOCKET, c::SO_BROADCAST));
515 pub fn set_multicast_loop_v4(&self, multicast_loop_v4: bool) -> io::Result<()> {
516 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_MULTICAST_LOOP, multicast_loop_v4 as c_int)
519 pub fn multicast_loop_v4(&self) -> io::Result<bool> {
520 let raw: c_int = try!(getsockopt(&self.inner, c::IPPROTO_IP, c::IP_MULTICAST_LOOP));
524 pub fn set_multicast_ttl_v4(&self, multicast_ttl_v4: u32) -> io::Result<()> {
525 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_MULTICAST_TTL, multicast_ttl_v4 as c_int)
528 pub fn multicast_ttl_v4(&self) -> io::Result<u32> {
529 let raw: c_int = try!(getsockopt(&self.inner, c::IPPROTO_IP, c::IP_MULTICAST_TTL));
533 pub fn set_multicast_loop_v6(&self, multicast_loop_v6: bool) -> io::Result<()> {
534 setsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_MULTICAST_LOOP, multicast_loop_v6 as c_int)
537 pub fn multicast_loop_v6(&self) -> io::Result<bool> {
538 let raw: c_int = try!(getsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_MULTICAST_LOOP));
542 pub fn join_multicast_v4(&self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr)
544 let mreq = c::ip_mreq {
545 imr_multiaddr: *multiaddr.as_inner(),
546 imr_interface: *interface.as_inner(),
548 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_ADD_MEMBERSHIP, mreq)
551 pub fn join_multicast_v6(&self, multiaddr: &Ipv6Addr, interface: u32)
553 let mreq = c::ipv6_mreq {
554 ipv6mr_multiaddr: *multiaddr.as_inner(),
555 ipv6mr_interface: to_ipv6mr_interface(interface),
557 setsockopt(&self.inner, c::IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP, mreq)
560 pub fn leave_multicast_v4(&self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr)
562 let mreq = c::ip_mreq {
563 imr_multiaddr: *multiaddr.as_inner(),
564 imr_interface: *interface.as_inner(),
566 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_DROP_MEMBERSHIP, mreq)
569 pub fn leave_multicast_v6(&self, multiaddr: &Ipv6Addr, interface: u32)
571 let mreq = c::ipv6_mreq {
572 ipv6mr_multiaddr: *multiaddr.as_inner(),
573 ipv6mr_interface: to_ipv6mr_interface(interface),
575 setsockopt(&self.inner, c::IPPROTO_IPV6, IPV6_DROP_MEMBERSHIP, mreq)
578 pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
579 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL, ttl as c_int)
582 pub fn ttl(&self) -> io::Result<u32> {
583 let raw: c_int = try!(getsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL));
587 pub fn set_only_v6(&self, only_v6: bool) -> io::Result<()> {
588 setsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_V6ONLY, only_v6 as c_int)
591 pub fn only_v6(&self) -> io::Result<bool> {
592 let raw: c_int = try!(getsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_V6ONLY));
596 pub fn take_error(&self) -> io::Result<Option<io::Error>> {
597 let raw: c_int = try!(getsockopt(&self.inner, c::SOL_SOCKET, c::SO_ERROR));
601 Ok(Some(io::Error::from_raw_os_error(raw as i32)))
605 pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
606 self.inner.set_nonblocking(nonblocking)
609 pub fn recv(&self, buf: &mut [u8]) -> io::Result<usize> {
613 pub fn send(&self, buf: &[u8]) -> io::Result<usize> {
614 let len = cmp::min(buf.len(), <wrlen_t>::max_value() as usize) as wrlen_t;
615 let ret = try!(cvt(unsafe {
616 c::send(*self.inner.as_inner(),
617 buf.as_ptr() as *const c_void,
624 pub fn connect(&self, addr: &SocketAddr) -> io::Result<()> {
625 let (addrp, len) = addr.into_inner();
626 cvt_r(|| unsafe { c::connect(*self.inner.as_inner(), addrp, len) }).map(|_| ())
630 impl FromInner<Socket> for UdpSocket {
631 fn from_inner(socket: Socket) -> UdpSocket {
632 UdpSocket { inner: socket }
636 impl fmt::Debug for UdpSocket {
637 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
638 let mut res = f.debug_struct("UdpSocket");
640 if let Ok(addr) = self.socket_addr() {
641 res.field("addr", &addr);
644 let name = if cfg!(windows) {"socket"} else {"fd"};
645 res.field(name, &self.inner.as_inner())