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 use sys::net::netc::IPV6_JOIN_GROUP as IPV6_ADD_MEMBERSHIP;
30 #[cfg(not(any(target_os = "dragonfly", target_os = "freebsd",
31 target_os = "ios", target_os = "macos",
32 target_os = "openbsd", target_os = "netbsd")))]
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 use sys::net::netc::IPV6_LEAVE_GROUP as IPV6_DROP_MEMBERSHIP;
38 #[cfg(not(any(target_os = "dragonfly", target_os = "freebsd",
39 target_os = "ios", target_os = "macos",
40 target_os = "openbsd", target_os = "netbsd")))]
41 use sys::net::netc::IPV6_DROP_MEMBERSHIP;
43 ////////////////////////////////////////////////////////////////////////////////
44 // sockaddr and misc bindings
45 ////////////////////////////////////////////////////////////////////////////////
47 pub fn setsockopt<T>(sock: &Socket, opt: c_int, val: c_int,
48 payload: T) -> io::Result<()> {
50 let payload = &payload as *const T as *const c_void;
51 try!(cvt(c::setsockopt(*sock.as_inner(), opt, val, payload,
52 mem::size_of::<T>() as c::socklen_t)));
57 pub fn getsockopt<T: Copy>(sock: &Socket, opt: c_int,
58 val: c_int) -> io::Result<T> {
60 let mut slot: T = mem::zeroed();
61 let mut len = mem::size_of::<T>() as c::socklen_t;
62 try!(cvt(c::getsockopt(*sock.as_inner(), opt, val,
63 &mut slot as *mut _ as *mut _,
65 assert_eq!(len as usize, mem::size_of::<T>());
70 fn sockname<F>(f: F) -> io::Result<SocketAddr>
71 where F: FnOnce(*mut c::sockaddr, *mut c::socklen_t) -> c_int
74 let mut storage: c::sockaddr_storage = mem::zeroed();
75 let mut len = mem::size_of_val(&storage) as c::socklen_t;
76 try!(cvt(f(&mut storage as *mut _ as *mut _, &mut len)));
77 sockaddr_to_addr(&storage, len as usize)
81 fn sockaddr_to_addr(storage: &c::sockaddr_storage,
82 len: usize) -> io::Result<SocketAddr> {
83 match storage.ss_family as c_int {
85 assert!(len as usize >= mem::size_of::<c::sockaddr_in>());
86 Ok(SocketAddr::V4(FromInner::from_inner(unsafe {
87 *(storage as *const _ as *const c::sockaddr_in)
91 assert!(len as usize >= mem::size_of::<c::sockaddr_in6>());
92 Ok(SocketAddr::V6(FromInner::from_inner(unsafe {
93 *(storage as *const _ as *const c::sockaddr_in6)
97 Err(Error::new(ErrorKind::InvalidInput, "invalid argument"))
102 #[cfg(target_os = "android")]
103 fn to_ipv6mr_interface(value: u32) -> c_int {
107 #[cfg(not(target_os = "android"))]
108 fn to_ipv6mr_interface(value: u32) -> ::libc::c_uint {
109 value as ::libc::c_uint
112 ////////////////////////////////////////////////////////////////////////////////
113 // get_host_addresses
114 ////////////////////////////////////////////////////////////////////////////////
116 pub struct LookupHost {
117 original: *mut c::addrinfo,
118 cur: *mut c::addrinfo,
121 impl Iterator for LookupHost {
122 type Item = io::Result<SocketAddr>;
123 fn next(&mut self) -> Option<io::Result<SocketAddr>> {
125 if self.cur.is_null() { return None }
126 let ret = sockaddr_to_addr(mem::transmute((*self.cur).ai_addr),
127 (*self.cur).ai_addrlen as usize);
128 self.cur = (*self.cur).ai_next as *mut c::addrinfo;
134 unsafe impl Sync for LookupHost {}
135 unsafe impl Send for LookupHost {}
137 impl Drop for LookupHost {
139 unsafe { c::freeaddrinfo(self.original) }
143 pub fn lookup_host(host: &str) -> io::Result<LookupHost> {
146 let c_host = try!(CString::new(host));
147 let mut res = ptr::null_mut();
149 try!(cvt_gai(c::getaddrinfo(c_host.as_ptr(), ptr::null(), ptr::null(),
151 Ok(LookupHost { original: res, cur: res })
155 ////////////////////////////////////////////////////////////////////////////////
157 ////////////////////////////////////////////////////////////////////////////////
159 pub struct TcpStream {
164 pub fn connect(addr: &SocketAddr) -> io::Result<TcpStream> {
167 let sock = try!(Socket::new(addr, c::SOCK_STREAM));
169 let (addrp, len) = addr.into_inner();
170 try!(cvt_r(|| unsafe { c::connect(*sock.as_inner(), addrp, len) }));
171 Ok(TcpStream { inner: sock })
174 pub fn socket(&self) -> &Socket { &self.inner }
176 pub fn into_socket(self) -> Socket { self.inner }
178 pub fn set_read_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
179 self.inner.set_timeout(dur, c::SO_RCVTIMEO)
182 pub fn set_write_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
183 self.inner.set_timeout(dur, c::SO_SNDTIMEO)
186 pub fn read_timeout(&self) -> io::Result<Option<Duration>> {
187 self.inner.timeout(c::SO_RCVTIMEO)
190 pub fn write_timeout(&self) -> io::Result<Option<Duration>> {
191 self.inner.timeout(c::SO_SNDTIMEO)
194 pub fn read(&self, buf: &mut [u8]) -> io::Result<usize> {
198 pub fn read_to_end(&self, buf: &mut Vec<u8>) -> io::Result<usize> {
199 self.inner.read_to_end(buf)
202 pub fn write(&self, buf: &[u8]) -> io::Result<usize> {
203 let len = cmp::min(buf.len(), <wrlen_t>::max_value() as usize) as wrlen_t;
204 let ret = try!(cvt(unsafe {
205 c::send(*self.inner.as_inner(),
206 buf.as_ptr() as *const c_void,
213 pub fn peer_addr(&self) -> io::Result<SocketAddr> {
214 sockname(|buf, len| unsafe {
215 c::getpeername(*self.inner.as_inner(), buf, len)
219 pub fn socket_addr(&self) -> io::Result<SocketAddr> {
220 sockname(|buf, len| unsafe {
221 c::getsockname(*self.inner.as_inner(), buf, len)
225 pub fn shutdown(&self, how: Shutdown) -> io::Result<()> {
226 self.inner.shutdown(how)
229 pub fn duplicate(&self) -> io::Result<TcpStream> {
230 self.inner.duplicate().map(|s| TcpStream { inner: s })
233 pub fn set_nodelay(&self, nodelay: bool) -> io::Result<()> {
234 self.inner.set_nodelay(nodelay)
237 pub fn nodelay(&self) -> io::Result<bool> {
241 pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
242 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL, ttl as c_int)
245 pub fn ttl(&self) -> io::Result<u32> {
246 let raw: c_int = try!(getsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL));
250 pub fn set_only_v6(&self, only_v6: bool) -> io::Result<()> {
251 setsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_V6ONLY, only_v6 as c_int)
254 pub fn only_v6(&self) -> io::Result<bool> {
255 let raw: c_int = try!(getsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_V6ONLY));
259 pub fn take_error(&self) -> io::Result<Option<io::Error>> {
260 let raw: c_int = try!(getsockopt(&self.inner, c::SOL_SOCKET, c::SO_ERROR));
264 Ok(Some(io::Error::from_raw_os_error(raw as i32)))
268 pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
269 self.inner.set_nonblocking(nonblocking)
273 impl FromInner<Socket> for TcpStream {
274 fn from_inner(socket: Socket) -> TcpStream {
275 TcpStream { inner: socket }
279 impl fmt::Debug for TcpStream {
280 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
281 let mut res = f.debug_struct("TcpStream");
283 if let Ok(addr) = self.socket_addr() {
284 res.field("addr", &addr);
287 if let Ok(peer) = self.peer_addr() {
288 res.field("peer", &peer);
291 let name = if cfg!(windows) {"socket"} else {"fd"};
292 res.field(name, &self.inner.as_inner())
297 ////////////////////////////////////////////////////////////////////////////////
299 ////////////////////////////////////////////////////////////////////////////////
301 pub struct TcpListener {
306 pub fn bind(addr: &SocketAddr) -> io::Result<TcpListener> {
309 let sock = try!(Socket::new(addr, c::SOCK_STREAM));
311 // On platforms with Berkeley-derived sockets, this allows
312 // to quickly rebind a socket, without needing to wait for
313 // the OS to clean up the previous one.
315 try!(setsockopt(&sock, c::SOL_SOCKET, c::SO_REUSEADDR,
319 // Bind our new socket
320 let (addrp, len) = addr.into_inner();
321 try!(cvt(unsafe { c::bind(*sock.as_inner(), addrp, len) }));
324 try!(cvt(unsafe { c::listen(*sock.as_inner(), 128) }));
325 Ok(TcpListener { inner: sock })
328 pub fn socket(&self) -> &Socket { &self.inner }
330 pub fn into_socket(self) -> Socket { self.inner }
332 pub fn socket_addr(&self) -> io::Result<SocketAddr> {
333 sockname(|buf, len| unsafe {
334 c::getsockname(*self.inner.as_inner(), buf, len)
338 pub fn accept(&self) -> io::Result<(TcpStream, SocketAddr)> {
339 let mut storage: c::sockaddr_storage = unsafe { mem::zeroed() };
340 let mut len = mem::size_of_val(&storage) as c::socklen_t;
341 let sock = try!(self.inner.accept(&mut storage as *mut _ as *mut _,
343 let addr = try!(sockaddr_to_addr(&storage, len as usize));
344 Ok((TcpStream { inner: sock, }, addr))
347 pub fn duplicate(&self) -> io::Result<TcpListener> {
348 self.inner.duplicate().map(|s| TcpListener { inner: s })
351 pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
352 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL, ttl as c_int)
355 pub fn ttl(&self) -> io::Result<u32> {
356 let raw: c_int = try!(getsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL));
360 pub fn set_only_v6(&self, only_v6: bool) -> io::Result<()> {
361 setsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_V6ONLY, only_v6 as c_int)
364 pub fn only_v6(&self) -> io::Result<bool> {
365 let raw: c_int = try!(getsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_V6ONLY));
369 pub fn take_error(&self) -> io::Result<Option<io::Error>> {
370 let raw: c_int = try!(getsockopt(&self.inner, c::SOL_SOCKET, c::SO_ERROR));
374 Ok(Some(io::Error::from_raw_os_error(raw as i32)))
378 pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
379 self.inner.set_nonblocking(nonblocking)
383 impl FromInner<Socket> for TcpListener {
384 fn from_inner(socket: Socket) -> TcpListener {
385 TcpListener { inner: socket }
389 impl fmt::Debug for TcpListener {
390 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
391 let mut res = f.debug_struct("TcpListener");
393 if let Ok(addr) = self.socket_addr() {
394 res.field("addr", &addr);
397 let name = if cfg!(windows) {"socket"} else {"fd"};
398 res.field(name, &self.inner.as_inner())
403 ////////////////////////////////////////////////////////////////////////////////
405 ////////////////////////////////////////////////////////////////////////////////
407 pub struct UdpSocket {
412 pub fn bind(addr: &SocketAddr) -> io::Result<UdpSocket> {
415 let sock = try!(Socket::new(addr, c::SOCK_DGRAM));
416 let (addrp, len) = addr.into_inner();
417 try!(cvt(unsafe { c::bind(*sock.as_inner(), addrp, len) }));
418 Ok(UdpSocket { inner: sock })
421 pub fn socket(&self) -> &Socket { &self.inner }
423 pub fn into_socket(self) -> Socket { self.inner }
425 pub fn socket_addr(&self) -> io::Result<SocketAddr> {
426 sockname(|buf, len| unsafe {
427 c::getsockname(*self.inner.as_inner(), buf, len)
431 pub fn recv_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> {
432 let mut storage: c::sockaddr_storage = unsafe { mem::zeroed() };
433 let mut addrlen = mem::size_of_val(&storage) as c::socklen_t;
434 let len = cmp::min(buf.len(), <wrlen_t>::max_value() as usize) as wrlen_t;
436 let n = try!(cvt(unsafe {
437 c::recvfrom(*self.inner.as_inner(),
438 buf.as_mut_ptr() as *mut c_void,
440 &mut storage as *mut _ as *mut _, &mut addrlen)
442 Ok((n as usize, try!(sockaddr_to_addr(&storage, addrlen as usize))))
445 pub fn send_to(&self, buf: &[u8], dst: &SocketAddr) -> io::Result<usize> {
446 let len = cmp::min(buf.len(), <wrlen_t>::max_value() as usize) as wrlen_t;
447 let (dstp, dstlen) = dst.into_inner();
448 let ret = try!(cvt(unsafe {
449 c::sendto(*self.inner.as_inner(),
450 buf.as_ptr() as *const c_void, len,
456 pub fn duplicate(&self) -> io::Result<UdpSocket> {
457 self.inner.duplicate().map(|s| UdpSocket { inner: s })
460 pub fn set_read_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
461 self.inner.set_timeout(dur, c::SO_RCVTIMEO)
464 pub fn set_write_timeout(&self, dur: Option<Duration>) -> io::Result<()> {
465 self.inner.set_timeout(dur, c::SO_SNDTIMEO)
468 pub fn read_timeout(&self) -> io::Result<Option<Duration>> {
469 self.inner.timeout(c::SO_RCVTIMEO)
472 pub fn write_timeout(&self) -> io::Result<Option<Duration>> {
473 self.inner.timeout(c::SO_SNDTIMEO)
476 pub fn set_broadcast(&self, broadcast: bool) -> io::Result<()> {
477 setsockopt(&self.inner, c::SOL_SOCKET, c::SO_BROADCAST, broadcast as c_int)
480 pub fn broadcast(&self) -> io::Result<bool> {
481 let raw: c_int = try!(getsockopt(&self.inner, c::SOL_SOCKET, c::SO_BROADCAST));
485 pub fn set_multicast_loop_v4(&self, multicast_loop_v4: bool) -> io::Result<()> {
486 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_MULTICAST_LOOP, multicast_loop_v4 as c_int)
489 pub fn multicast_loop_v4(&self) -> io::Result<bool> {
490 let raw: c_int = try!(getsockopt(&self.inner, c::IPPROTO_IP, c::IP_MULTICAST_LOOP));
494 pub fn set_multicast_ttl_v4(&self, multicast_ttl_v4: u32) -> io::Result<()> {
495 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_MULTICAST_TTL, multicast_ttl_v4 as c_int)
498 pub fn multicast_ttl_v4(&self) -> io::Result<u32> {
499 let raw: c_int = try!(getsockopt(&self.inner, c::IPPROTO_IP, c::IP_MULTICAST_TTL));
503 pub fn set_multicast_loop_v6(&self, multicast_loop_v6: bool) -> io::Result<()> {
504 setsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_MULTICAST_LOOP, multicast_loop_v6 as c_int)
507 pub fn multicast_loop_v6(&self) -> io::Result<bool> {
508 let raw: c_int = try!(getsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_MULTICAST_LOOP));
512 pub fn join_multicast_v4(&self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr)
514 let mreq = c::ip_mreq {
515 imr_multiaddr: *multiaddr.as_inner(),
516 imr_interface: *interface.as_inner(),
518 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_ADD_MEMBERSHIP, mreq)
521 pub fn join_multicast_v6(&self, multiaddr: &Ipv6Addr, interface: u32)
523 let mreq = c::ipv6_mreq {
524 ipv6mr_multiaddr: *multiaddr.as_inner(),
525 ipv6mr_interface: to_ipv6mr_interface(interface),
527 setsockopt(&self.inner, c::IPPROTO_IPV6, IPV6_ADD_MEMBERSHIP, mreq)
530 pub fn leave_multicast_v4(&self, multiaddr: &Ipv4Addr, interface: &Ipv4Addr)
532 let mreq = c::ip_mreq {
533 imr_multiaddr: *multiaddr.as_inner(),
534 imr_interface: *interface.as_inner(),
536 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_DROP_MEMBERSHIP, mreq)
539 pub fn leave_multicast_v6(&self, multiaddr: &Ipv6Addr, interface: u32)
541 let mreq = c::ipv6_mreq {
542 ipv6mr_multiaddr: *multiaddr.as_inner(),
543 ipv6mr_interface: to_ipv6mr_interface(interface),
545 setsockopt(&self.inner, c::IPPROTO_IPV6, IPV6_DROP_MEMBERSHIP, mreq)
548 pub fn set_ttl(&self, ttl: u32) -> io::Result<()> {
549 setsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL, ttl as c_int)
552 pub fn ttl(&self) -> io::Result<u32> {
553 let raw: c_int = try!(getsockopt(&self.inner, c::IPPROTO_IP, c::IP_TTL));
557 pub fn set_only_v6(&self, only_v6: bool) -> io::Result<()> {
558 setsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_V6ONLY, only_v6 as c_int)
561 pub fn only_v6(&self) -> io::Result<bool> {
562 let raw: c_int = try!(getsockopt(&self.inner, c::IPPROTO_IPV6, c::IPV6_V6ONLY));
566 pub fn take_error(&self) -> io::Result<Option<io::Error>> {
567 let raw: c_int = try!(getsockopt(&self.inner, c::SOL_SOCKET, c::SO_ERROR));
571 Ok(Some(io::Error::from_raw_os_error(raw as i32)))
575 pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
576 self.inner.set_nonblocking(nonblocking)
579 pub fn recv(&self, buf: &mut [u8]) -> io::Result<usize> {
583 pub fn send(&self, buf: &[u8]) -> io::Result<usize> {
584 let len = cmp::min(buf.len(), <wrlen_t>::max_value() as usize) as wrlen_t;
585 let ret = try!(cvt(unsafe {
586 c::send(*self.inner.as_inner(),
587 buf.as_ptr() as *const c_void,
594 pub fn connect(&self, addr: &SocketAddr) -> io::Result<()> {
595 let (addrp, len) = addr.into_inner();
596 cvt_r(|| unsafe { c::connect(*self.inner.as_inner(), addrp, len) }).map(|_| ())
600 impl FromInner<Socket> for UdpSocket {
601 fn from_inner(socket: Socket) -> UdpSocket {
602 UdpSocket { inner: socket }
606 impl fmt::Debug for UdpSocket {
607 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
608 let mut res = f.debug_struct("UdpSocket");
610 if let Ok(addr) = self.socket_addr() {
611 res.field("addr", &addr);
614 let name = if cfg!(windows) {"socket"} else {"fd"};
615 res.field(name, &self.inner.as_inner())