src/libstd/sys/windows/mod.rs

   1 // Copyright 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.
   4 //
   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.
  10
  11 #![allow(missing_docs)]
  12 #![allow(non_camel_case_types)]
  13 #![allow(non_snake_case)]
  14
  15 use prelude::v1::*;
  16
  17 use ffi::{OsStr, OsString};
  18 use io::{self, ErrorKind};
  19 use libc;
  20 use num::Zero;
  21 use os::windows::ffi::{OsStrExt, OsStringExt};
  22 use path::PathBuf;
  23 use time::Duration;
  24
  25 #[macro_use] pub mod compat;
  26
  27 pub mod backtrace;
  28 pub mod c;
  29 pub mod condvar;
  30 pub mod ext;
  31 pub mod fs;
  32 pub mod handle;
  33 pub mod mutex;
  34 pub mod net;
  35 pub mod os;
  36 pub mod os_str;
  37 pub mod pipe;
  38 pub mod process;
  39 pub mod rwlock;
  40 pub mod stack_overflow;
  41 pub mod thread;
  42 pub mod thread_local;
  43 pub mod time;
  44 pub mod stdio;
  45
  46 pub fn init() {}
  47
  48 pub fn decode_error_kind(errno: i32) -> ErrorKind {
  49     match errno as libc::c_int {
  50         libc::ERROR_ACCESS_DENIED => ErrorKind::PermissionDenied,
  51         libc::ERROR_ALREADY_EXISTS => ErrorKind::AlreadyExists,
  52         libc::ERROR_BROKEN_PIPE => ErrorKind::BrokenPipe,
  53         libc::ERROR_FILE_NOT_FOUND => ErrorKind::NotFound,
  54         libc::ERROR_NO_DATA => ErrorKind::BrokenPipe,
  55         libc::ERROR_OPERATION_ABORTED => ErrorKind::TimedOut,
  56
  57         libc::WSAEACCES => ErrorKind::PermissionDenied,
  58         libc::WSAEADDRINUSE => ErrorKind::AddrInUse,
  59         libc::WSAEADDRNOTAVAIL => ErrorKind::AddrNotAvailable,
  60         libc::WSAECONNABORTED => ErrorKind::ConnectionAborted,
  61         libc::WSAECONNREFUSED => ErrorKind::ConnectionRefused,
  62         libc::WSAECONNRESET => ErrorKind::ConnectionReset,
  63         libc::WSAEINVAL => ErrorKind::InvalidInput,
  64         libc::WSAENOTCONN => ErrorKind::NotConnected,
  65         libc::WSAEWOULDBLOCK => ErrorKind::WouldBlock,
  66         libc::WSAETIMEDOUT => ErrorKind::TimedOut,
  67
  68         _ => ErrorKind::Other,
  69     }
  70 }
  71
  72 fn to_utf16_os(s: &OsStr) -> Vec<u16> {
  73     let mut v: Vec<_> = s.encode_wide().collect();
  74     v.push(0);
  75     v
  76 }
  77
  78 // Many Windows APIs follow a pattern of where we hand a buffer and then they
  79 // will report back to us how large the buffer should be or how many bytes
  80 // currently reside in the buffer. This function is an abstraction over these
  81 // functions by making them easier to call.
  82 //
  83 // The first callback, `f1`, is yielded a (pointer, len) pair which can be
  84 // passed to a syscall. The `ptr` is valid for `len` items (u16 in this case).
  85 // The closure is expected to return what the syscall returns which will be
  86 // interpreted by this function to determine if the syscall needs to be invoked
  87 // again (with more buffer space).
  88 //
  89 // Once the syscall has completed (errors bail out early) the second closure is
  90 // yielded the data which has been read from the syscall. The return value
  91 // from this closure is then the return value of the function.
  92 fn fill_utf16_buf<F1, F2, T>(mut f1: F1, f2: F2) -> io::Result<T>
  93     where F1: FnMut(*mut u16, libc::DWORD) -> libc::DWORD,
  94           F2: FnOnce(&[u16]) -> T
  95 {
  96     // Start off with a stack buf but then spill over to the heap if we end up
  97     // needing more space.
  98     let mut stack_buf = [0u16; 512];
  99     let mut heap_buf = Vec::new();
 100     unsafe {
 101         let mut n = stack_buf.len();
 102         loop {
 103             let buf = if n <= stack_buf.len() {
 104                 &mut stack_buf[..]
 105             } else {
 106                 let extra = n - heap_buf.len();
 107                 heap_buf.reserve(extra);
 108                 heap_buf.set_len(n);
 109                 &mut heap_buf[..]
 110             };
 111
 112             // This function is typically called on windows API functions which
 113             // will return the correct length of the string, but these functions
 114             // also return the `0` on error. In some cases, however, the
 115             // returned "correct length" may actually be 0!
 116             //
 117             // To handle this case we call `SetLastError` to reset it to 0 and
 118             // then check it again if we get the "0 error value". If the "last
 119             // error" is still 0 then we interpret it as a 0 length buffer and
 120             // not an actual error.
 121             c::SetLastError(0);
 122             let k = match f1(buf.as_mut_ptr(), n as libc::DWORD) {
 123                 0 if libc::GetLastError() == 0 => 0,
 124                 0 => return Err(io::Error::last_os_error()),
 125                 n => n,
 126             } as usize;
 127             if k == n && libc::GetLastError() ==
 128                             libc::ERROR_INSUFFICIENT_BUFFER as libc::DWORD {
 129                 n *= 2;
 130             } else if k >= n {
 131                 n = k;
 132             } else {
 133                 return Ok(f2(&buf[..k]))
 134             }
 135         }
 136     }
 137 }
 138
 139 fn os2path(s: &[u16]) -> PathBuf {
 140     PathBuf::from(OsString::from_wide(s))
 141 }
 142
 143 pub fn truncate_utf16_at_nul<'a>(v: &'a [u16]) -> &'a [u16] {
 144     match v.iter().position(|c| *c == 0) {
 145         // don't include the 0
 146         Some(i) => &v[..i],
 147         None => v
 148     }
 149 }
 150
 151 fn cvt<I: PartialEq + Zero>(i: I) -> io::Result<I> {
 152     if i == I::zero() {
 153         Err(io::Error::last_os_error())
 154     } else {
 155         Ok(i)
 156     }
 157 }
 158
 159 fn dur2timeout(dur: Duration) -> libc::DWORD {
 160     // Note that a duration is a (u64, u32) (seconds, nanoseconds) pair, and the
 161     // timeouts in windows APIs are typically u32 milliseconds. To translate, we
 162     // have two pieces to take care of:
 163     //
 164     // * Nanosecond precision is rounded up
 165     // * Greater than u32::MAX milliseconds (50 days) is rounded up to INFINITE
 166     //   (never time out).
 167     dur.as_secs().checked_mul(1000).and_then(|ms| {
 168         ms.checked_add((dur.subsec_nanos() as u64) / 1_000_000)
 169     }).and_then(|ms| {
 170         ms.checked_add(if dur.subsec_nanos() % 1_000_000 > 0 {1} else {0})
 171     }).map(|ms| {
 172         if ms > <libc::DWORD>::max_value() as u64 {
 173             libc::INFINITE
 174         } else {
 175             ms as libc::DWORD
 176         }
 177     }).unwrap_or(libc::INFINITE)
 178 }