library/std/src/sys/windows/net.rs

   1 #![unstable(issue = "none", feature = "windows_net")]
   2
   3 use crate::cmp;
   4 use crate::io::{self, IoSlice, IoSliceMut, Read};
   5 use crate::mem;
   6 use crate::net::{Shutdown, SocketAddr};
   7 use crate::ptr;
   8 use crate::sync::Once;
   9 use crate::sys;
  10 use crate::sys::c;
  11 use crate::sys_common::net;
  12 use crate::sys_common::{self, AsInner, FromInner, IntoInner};
  13 use crate::time::Duration;
  14
  15 use libc::{c_int, c_long, c_ulong, c_void};
  16
  17 pub type wrlen_t = i32;
  18
  19 pub mod netc {
  20     pub use crate::sys::c::ADDRESS_FAMILY as sa_family_t;
  21     pub use crate::sys::c::ADDRINFOA as addrinfo;
  22     pub use crate::sys::c::SOCKADDR as sockaddr;
  23     pub use crate::sys::c::SOCKADDR_STORAGE_LH as sockaddr_storage;
  24     pub use crate::sys::c::*;
  25 }
  26
  27 pub struct Socket(c::SOCKET);
  28
  29 /// Checks whether the Windows socket interface has been started already, and
  30 /// if not, starts it.
  31 pub fn init() {
  32     static START: Once = Once::new();
  33
  34     START.call_once(|| unsafe {
  35         let mut data: c::WSADATA = mem::zeroed();
  36         let ret = c::WSAStartup(
  37             0x202, // version 2.2
  38             &mut data,
  39         );
  40         assert_eq!(ret, 0);
  41
  42         let _ = sys_common::at_exit(|| {
  43             c::WSACleanup();
  44         });
  45     });
  46 }
  47
  48 /// Returns the last error from the Windows socket interface.
  49 fn last_error() -> io::Error {
  50     io::Error::from_raw_os_error(unsafe { c::WSAGetLastError() })
  51 }
  52
  53 #[doc(hidden)]
  54 pub trait IsMinusOne {
  55     fn is_minus_one(&self) -> bool;
  56 }
  57
  58 macro_rules! impl_is_minus_one {
  59     ($($t:ident)*) => ($(impl IsMinusOne for $t {
  60         fn is_minus_one(&self) -> bool {
  61             *self == -1
  62         }
  63     })*)
  64 }
  65
  66 impl_is_minus_one! { i8 i16 i32 i64 isize }
  67
  68 /// Checks if the signed integer is the Windows constant `SOCKET_ERROR` (-1)
  69 /// and if so, returns the last error from the Windows socket interface. This
  70 /// function must be called before another call to the socket API is made.
  71 pub fn cvt<T: IsMinusOne>(t: T) -> io::Result<T> {
  72     if t.is_minus_one() { Err(last_error()) } else { Ok(t) }
  73 }
  74
  75 /// A variant of `cvt` for `getaddrinfo` which return 0 for a success.
  76 pub fn cvt_gai(err: c_int) -> io::Result<()> {
  77     if err == 0 { Ok(()) } else { Err(last_error()) }
  78 }
  79
  80 /// Just to provide the same interface as sys/unix/net.rs
  81 pub fn cvt_r<T, F>(mut f: F) -> io::Result<T>
  82 where
  83     T: IsMinusOne,
  84     F: FnMut() -> T,
  85 {
  86     cvt(f())
  87 }
  88
  89 impl Socket {
  90     pub fn new(addr: &SocketAddr, ty: c_int) -> io::Result<Socket> {
  91         let fam = match *addr {
  92             SocketAddr::V4(..) => c::AF_INET,
  93             SocketAddr::V6(..) => c::AF_INET6,
  94         };
  95         let socket = unsafe {
  96             match c::WSASocketW(
  97                 fam,
  98                 ty,
  99                 0,
 100                 ptr::null_mut(),
 101                 0,
 102                 c::WSA_FLAG_OVERLAPPED | c::WSA_FLAG_NO_HANDLE_INHERIT,
 103             ) {
 104                 c::INVALID_SOCKET => match c::WSAGetLastError() {
 105                     c::WSAEPROTOTYPE | c::WSAEINVAL => {
 106                         match c::WSASocketW(fam, ty, 0, ptr::null_mut(), 0, c::WSA_FLAG_OVERLAPPED)
 107                         {
 108                             c::INVALID_SOCKET => Err(last_error()),
 109                             n => {
 110                                 let s = Socket(n);
 111                                 s.set_no_inherit()?;
 112                                 Ok(s)
 113                             }
 114                         }
 115                     }
 116                     n => Err(io::Error::from_raw_os_error(n)),
 117                 },
 118                 n => Ok(Socket(n)),
 119             }
 120         }?;
 121         Ok(socket)
 122     }
 123
 124     pub fn connect_timeout(&self, addr: &SocketAddr, timeout: Duration) -> io::Result<()> {
 125         self.set_nonblocking(true)?;
 126         let r = unsafe {
 127             let (addrp, len) = addr.into_inner();
 128             cvt(c::connect(self.0, addrp, len))
 129         };
 130         self.set_nonblocking(false)?;
 131
 132         match r {
 133             Ok(_) => return Ok(()),
 134             Err(ref e) if e.kind() == io::ErrorKind::WouldBlock => {}
 135             Err(e) => return Err(e),
 136         }
 137
 138         if timeout.as_secs() == 0 && timeout.subsec_nanos() == 0 {
 139             return Err(io::Error::new_const(
 140                 io::ErrorKind::InvalidInput,
 141                 &"cannot set a 0 duration timeout",
 142             ));
 143         }
 144
 145         let mut timeout = c::timeval {
 146             tv_sec: timeout.as_secs() as c_long,
 147             tv_usec: (timeout.subsec_nanos() / 1000) as c_long,
 148         };
 149         if timeout.tv_sec == 0 && timeout.tv_usec == 0 {
 150             timeout.tv_usec = 1;
 151         }
 152
 153         let fds = unsafe {
 154             let mut fds = mem::zeroed::<c::fd_set>();
 155             fds.fd_count = 1;
 156             fds.fd_array[0] = self.0;
 157             fds
 158         };
 159
 160         let mut writefds = fds;
 161         let mut errorfds = fds;
 162
 163         let n =
 164             unsafe { cvt(c::select(1, ptr::null_mut(), &mut writefds, &mut errorfds, &timeout))? };
 165
 166         match n {
 167             0 => Err(io::Error::new_const(io::ErrorKind::TimedOut, &"connection timed out")),
 168             _ => {
 169                 if writefds.fd_count != 1 {
 170                     if let Some(e) = self.take_error()? {
 171                         return Err(e);
 172                     }
 173                 }
 174                 Ok(())
 175             }
 176         }
 177     }
 178
 179     pub fn accept(&self, storage: *mut c::SOCKADDR, len: *mut c_int) -> io::Result<Socket> {
 180         let socket = unsafe {
 181             match c::accept(self.0, storage, len) {
 182                 c::INVALID_SOCKET => Err(last_error()),
 183                 n => Ok(Socket(n)),
 184             }
 185         }?;
 186         Ok(socket)
 187     }
 188
 189     pub fn duplicate(&self) -> io::Result<Socket> {
 190         let socket = unsafe {
 191             let mut info: c::WSAPROTOCOL_INFO = mem::zeroed();
 192             cvt(c::WSADuplicateSocketW(self.0, c::GetCurrentProcessId(), &mut info))?;
 193
 194             match c::WSASocketW(
 195                 info.iAddressFamily,
 196                 info.iSocketType,
 197                 info.iProtocol,
 198                 &mut info,
 199                 0,
 200                 c::WSA_FLAG_OVERLAPPED | c::WSA_FLAG_NO_HANDLE_INHERIT,
 201             ) {
 202                 c::INVALID_SOCKET => match c::WSAGetLastError() {
 203                     c::WSAEPROTOTYPE | c::WSAEINVAL => {
 204                         match c::WSASocketW(
 205                             info.iAddressFamily,
 206                             info.iSocketType,
 207                             info.iProtocol,
 208                             &mut info,
 209                             0,
 210                             c::WSA_FLAG_OVERLAPPED,
 211                         ) {
 212                             c::INVALID_SOCKET => Err(last_error()),
 213                             n => {
 214                                 let s = Socket(n);
 215                                 s.set_no_inherit()?;
 216                                 Ok(s)
 217                             }
 218                         }
 219                     }
 220                     n => Err(io::Error::from_raw_os_error(n)),
 221                 },
 222                 n => Ok(Socket(n)),
 223             }
 224         }?;
 225         Ok(socket)
 226     }
 227
 228     fn recv_with_flags(&self, buf: &mut [u8], flags: c_int) -> io::Result<usize> {
 229         // On unix when a socket is shut down all further reads return 0, so we
 230         // do the same on windows to map a shut down socket to returning EOF.
 231         let len = cmp::min(buf.len(), i32::MAX as usize) as i32;
 232         unsafe {
 233             match c::recv(self.0, buf.as_mut_ptr() as *mut c_void, len, flags) {
 234                 -1 if c::WSAGetLastError() == c::WSAESHUTDOWN => Ok(0),
 235                 -1 => Err(last_error()),
 236                 n => Ok(n as usize),
 237             }
 238         }
 239     }
 240
 241     pub fn read(&self, buf: &mut [u8]) -> io::Result<usize> {
 242         self.recv_with_flags(buf, 0)
 243     }
 244
 245     pub fn read_vectored(&self, bufs: &mut [IoSliceMut<'_>]) -> io::Result<usize> {
 246         // On unix when a socket is shut down all further reads return 0, so we
 247         // do the same on windows to map a shut down socket to returning EOF.
 248         let len = cmp::min(bufs.len(), c::DWORD::MAX as usize) as c::DWORD;
 249         let mut nread = 0;
 250         let mut flags = 0;
 251         unsafe {
 252             let ret = c::WSARecv(
 253                 self.0,
 254                 bufs.as_mut_ptr() as *mut c::WSABUF,
 255                 len,
 256                 &mut nread,
 257                 &mut flags,
 258                 ptr::null_mut(),
 259                 ptr::null_mut(),
 260             );
 261             match ret {
 262                 0 => Ok(nread as usize),
 263                 _ if c::WSAGetLastError() == c::WSAESHUTDOWN => Ok(0),
 264                 _ => Err(last_error()),
 265             }
 266         }
 267     }
 268
 269     #[inline]
 270     pub fn is_read_vectored(&self) -> bool {
 271         true
 272     }
 273
 274     pub fn peek(&self, buf: &mut [u8]) -> io::Result<usize> {
 275         self.recv_with_flags(buf, c::MSG_PEEK)
 276     }
 277
 278     fn recv_from_with_flags(
 279         &self,
 280         buf: &mut [u8],
 281         flags: c_int,
 282     ) -> io::Result<(usize, SocketAddr)> {
 283         let mut storage: c::SOCKADDR_STORAGE_LH = unsafe { mem::zeroed() };
 284         let mut addrlen = mem::size_of_val(&storage) as c::socklen_t;
 285         let len = cmp::min(buf.len(), <wrlen_t>::MAX as usize) as wrlen_t;
 286
 287         // On unix when a socket is shut down all further reads return 0, so we
 288         // do the same on windows to map a shut down socket to returning EOF.
 289         unsafe {
 290             match c::recvfrom(
 291                 self.0,
 292                 buf.as_mut_ptr() as *mut c_void,
 293                 len,
 294                 flags,
 295                 &mut storage as *mut _ as *mut _,
 296                 &mut addrlen,
 297             ) {
 298                 -1 if c::WSAGetLastError() == c::WSAESHUTDOWN => {
 299                     Ok((0, net::sockaddr_to_addr(&storage, addrlen as usize)?))
 300                 }
 301                 -1 => Err(last_error()),
 302                 n => Ok((n as usize, net::sockaddr_to_addr(&storage, addrlen as usize)?)),
 303             }
 304         }
 305     }
 306
 307     pub fn recv_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> {
 308         self.recv_from_with_flags(buf, 0)
 309     }
 310
 311     pub fn peek_from(&self, buf: &mut [u8]) -> io::Result<(usize, SocketAddr)> {
 312         self.recv_from_with_flags(buf, c::MSG_PEEK)
 313     }
 314
 315     pub fn write_vectored(&self, bufs: &[IoSlice<'_>]) -> io::Result<usize> {
 316         let len = cmp::min(bufs.len(), c::DWORD::MAX as usize) as c::DWORD;
 317         let mut nwritten = 0;
 318         unsafe {
 319             cvt(c::WSASend(
 320                 self.0,
 321                 bufs.as_ptr() as *const c::WSABUF as *mut c::WSABUF,
 322                 len,
 323                 &mut nwritten,
 324                 0,
 325                 ptr::null_mut(),
 326                 ptr::null_mut(),
 327             ))?;
 328         }
 329         Ok(nwritten as usize)
 330     }
 331
 332     #[inline]
 333     pub fn is_write_vectored(&self) -> bool {
 334         true
 335     }
 336
 337     pub fn set_timeout(&self, dur: Option<Duration>, kind: c_int) -> io::Result<()> {
 338         let timeout = match dur {
 339             Some(dur) => {
 340                 let timeout = sys::dur2timeout(dur);
 341                 if timeout == 0 {
 342                     return Err(io::Error::new_const(
 343                         io::ErrorKind::InvalidInput,
 344                         &"cannot set a 0 duration timeout",
 345                     ));
 346                 }
 347                 timeout
 348             }
 349             None => 0,
 350         };
 351         net::setsockopt(self, c::SOL_SOCKET, kind, timeout)
 352     }
 353
 354     pub fn timeout(&self, kind: c_int) -> io::Result<Option<Duration>> {
 355         let raw: c::DWORD = net::getsockopt(self, c::SOL_SOCKET, kind)?;
 356         if raw == 0 {
 357             Ok(None)
 358         } else {
 359             let secs = raw / 1000;
 360             let nsec = (raw % 1000) * 1000000;
 361             Ok(Some(Duration::new(secs as u64, nsec as u32)))
 362         }
 363     }
 364
 365     #[cfg(not(target_vendor = "uwp"))]
 366     fn set_no_inherit(&self) -> io::Result<()> {
 367         sys::cvt(unsafe { c::SetHandleInformation(self.0 as c::HANDLE, c::HANDLE_FLAG_INHERIT, 0) })
 368             .map(drop)
 369     }
 370
 371     #[cfg(target_vendor = "uwp")]
 372     fn set_no_inherit(&self) -> io::Result<()> {
 373         Err(io::Error::new_const(io::ErrorKind::Other, &"Unavailable on UWP"))
 374     }
 375
 376     pub fn shutdown(&self, how: Shutdown) -> io::Result<()> {
 377         let how = match how {
 378             Shutdown::Write => c::SD_SEND,
 379             Shutdown::Read => c::SD_RECEIVE,
 380             Shutdown::Both => c::SD_BOTH,
 381         };
 382         cvt(unsafe { c::shutdown(self.0, how) })?;
 383         Ok(())
 384     }
 385
 386     pub fn set_nonblocking(&self, nonblocking: bool) -> io::Result<()> {
 387         let mut nonblocking = nonblocking as c_ulong;
 388         let r = unsafe { c::ioctlsocket(self.0, c::FIONBIO as c_int, &mut nonblocking) };
 389         if r == 0 { Ok(()) } else { Err(io::Error::last_os_error()) }
 390     }
 391
 392     pub fn set_nodelay(&self, nodelay: bool) -> io::Result<()> {
 393         net::setsockopt(self, c::IPPROTO_TCP, c::TCP_NODELAY, nodelay as c::BYTE)
 394     }
 395
 396     pub fn nodelay(&self) -> io::Result<bool> {
 397         let raw: c::BYTE = net::getsockopt(self, c::IPPROTO_TCP, c::TCP_NODELAY)?;
 398         Ok(raw != 0)
 399     }
 400
 401     pub fn take_error(&self) -> io::Result<Option<io::Error>> {
 402         let raw: c_int = net::getsockopt(self, c::SOL_SOCKET, c::SO_ERROR)?;
 403         if raw == 0 { Ok(None) } else { Ok(Some(io::Error::from_raw_os_error(raw as i32))) }
 404     }
 405 }
 406
 407 #[unstable(reason = "not public", issue = "none", feature = "fd_read")]
 408 impl<'a> Read for &'a Socket {
 409     fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
 410         (**self).read(buf)
 411     }
 412 }
 413
 414 impl Drop for Socket {
 415     fn drop(&mut self) {
 416         let _ = unsafe { c::closesocket(self.0) };
 417     }
 418 }
 419
 420 impl AsInner<c::SOCKET> for Socket {
 421     fn as_inner(&self) -> &c::SOCKET {
 422         &self.0
 423     }
 424 }
 425
 426 impl FromInner<c::SOCKET> for Socket {
 427     fn from_inner(sock: c::SOCKET) -> Socket {
 428         Socket(sock)
 429     }
 430 }
 431
 432 impl IntoInner<c::SOCKET> for Socket {
 433     fn into_inner(self) -> c::SOCKET {
 434         let ret = self.0;
 435         mem::forget(self);
 436         ret
 437     }
 438 }