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, bad_style)]
  12
  13 use ptr;
  14 use ffi::{OsStr, OsString};
  15 use io::{self, ErrorKind};
  16 use os::windows::ffi::{OsStrExt, OsStringExt};
  17 use path::PathBuf;
  18 use time::Duration;
  19
  20 pub use self::rand::hashmap_random_keys;
  21
  22 #[macro_use] pub mod compat;
  23
  24 pub mod args;
  25 #[cfg(feature = "backtrace")]
  26 pub mod backtrace;
  27 pub mod c;
  28 pub mod cmath;
  29 pub mod condvar;
  30 #[cfg(feature = "backtrace")]
  31 pub mod dynamic_lib;
  32 pub mod env;
  33 pub mod ext;
  34 pub mod fast_thread_local;
  35 pub mod fs;
  36 pub mod handle;
  37 pub mod memchr;
  38 pub mod mutex;
  39 pub mod net;
  40 pub mod os;
  41 pub mod os_str;
  42 pub mod path;
  43 pub mod pipe;
  44 pub mod process;
  45 pub mod rand;
  46 pub mod rwlock;
  47 pub mod stack_overflow;
  48 pub mod thread;
  49 pub mod thread_local;
  50 pub mod time;
  51 pub mod stdio;
  52
  53 #[cfg(not(test))]
  54 pub fn init() {
  55 }
  56
  57 pub fn decode_error_kind(errno: i32) -> ErrorKind {
  58     match errno as c::DWORD {
  59         c::ERROR_ACCESS_DENIED => return ErrorKind::PermissionDenied,
  60         c::ERROR_ALREADY_EXISTS => return ErrorKind::AlreadyExists,
  61         c::ERROR_FILE_EXISTS => return ErrorKind::AlreadyExists,
  62         c::ERROR_BROKEN_PIPE => return ErrorKind::BrokenPipe,
  63         c::ERROR_FILE_NOT_FOUND => return ErrorKind::NotFound,
  64         c::ERROR_PATH_NOT_FOUND => return ErrorKind::NotFound,
  65         c::ERROR_NO_DATA => return ErrorKind::BrokenPipe,
  66         c::ERROR_OPERATION_ABORTED => return ErrorKind::TimedOut,
  67         _ => {}
  68     }
  69
  70     match errno {
  71         c::WSAEACCES => ErrorKind::PermissionDenied,
  72         c::WSAEADDRINUSE => ErrorKind::AddrInUse,
  73         c::WSAEADDRNOTAVAIL => ErrorKind::AddrNotAvailable,
  74         c::WSAECONNABORTED => ErrorKind::ConnectionAborted,
  75         c::WSAECONNREFUSED => ErrorKind::ConnectionRefused,
  76         c::WSAECONNRESET => ErrorKind::ConnectionReset,
  77         c::WSAEINVAL => ErrorKind::InvalidInput,
  78         c::WSAENOTCONN => ErrorKind::NotConnected,
  79         c::WSAEWOULDBLOCK => ErrorKind::WouldBlock,
  80         c::WSAETIMEDOUT => ErrorKind::TimedOut,
  81
  82         _ => ErrorKind::Other,
  83     }
  84 }
  85
  86 pub fn to_u16s<S: AsRef<OsStr>>(s: S) -> io::Result<Vec<u16>> {
  87     fn inner(s: &OsStr) -> io::Result<Vec<u16>> {
  88         let mut maybe_result: Vec<u16> = s.encode_wide().collect();
  89         if maybe_result.iter().any(|&u| u == 0) {
  90             return Err(io::Error::new(io::ErrorKind::InvalidInput,
  91                                       "strings passed to WinAPI cannot contain NULs"));
  92         }
  93         maybe_result.push(0);
  94         Ok(maybe_result)
  95     }
  96     inner(s.as_ref())
  97 }
  98
  99 // Many Windows APIs follow a pattern of where we hand a buffer and then they
 100 // will report back to us how large the buffer should be or how many bytes
 101 // currently reside in the buffer. This function is an abstraction over these
 102 // functions by making them easier to call.
 103 //
 104 // The first callback, `f1`, is yielded a (pointer, len) pair which can be
 105 // passed to a syscall. The `ptr` is valid for `len` items (u16 in this case).
 106 // The closure is expected to return what the syscall returns which will be
 107 // interpreted by this function to determine if the syscall needs to be invoked
 108 // again (with more buffer space).
 109 //
 110 // Once the syscall has completed (errors bail out early) the second closure is
 111 // yielded the data which has been read from the syscall. The return value
 112 // from this closure is then the return value of the function.
 113 fn fill_utf16_buf<F1, F2, T>(mut f1: F1, f2: F2) -> io::Result<T>
 114     where F1: FnMut(*mut u16, c::DWORD) -> c::DWORD,
 115           F2: FnOnce(&[u16]) -> T
 116 {
 117     // Start off with a stack buf but then spill over to the heap if we end up
 118     // needing more space.
 119     let mut stack_buf = [0u16; 512];
 120     let mut heap_buf = Vec::new();
 121     unsafe {
 122         let mut n = stack_buf.len();
 123         loop {
 124             let buf = if n <= stack_buf.len() {
 125                 &mut stack_buf[..]
 126             } else {
 127                 let extra = n - heap_buf.len();
 128                 heap_buf.reserve(extra);
 129                 heap_buf.set_len(n);
 130                 &mut heap_buf[..]
 131             };
 132
 133             // This function is typically called on windows API functions which
 134             // will return the correct length of the string, but these functions
 135             // also return the `0` on error. In some cases, however, the
 136             // returned "correct length" may actually be 0!
 137             //
 138             // To handle this case we call `SetLastError` to reset it to 0 and
 139             // then check it again if we get the "0 error value". If the "last
 140             // error" is still 0 then we interpret it as a 0 length buffer and
 141             // not an actual error.
 142             c::SetLastError(0);
 143             let k = match f1(buf.as_mut_ptr(), n as c::DWORD) {
 144                 0 if c::GetLastError() == 0 => 0,
 145                 0 => return Err(io::Error::last_os_error()),
 146                 n => n,
 147             } as usize;
 148             if k == n && c::GetLastError() == c::ERROR_INSUFFICIENT_BUFFER {
 149                 n *= 2;
 150             } else if k >= n {
 151                 n = k;
 152             } else {
 153                 return Ok(f2(&buf[..k]))
 154             }
 155         }
 156     }
 157 }
 158
 159 fn os2path(s: &[u16]) -> PathBuf {
 160     PathBuf::from(OsString::from_wide(s))
 161 }
 162
 163 #[allow(dead_code)] // Only used in backtrace::gnu::get_executable_filename()
 164 fn wide_char_to_multi_byte(code_page: u32,
 165                            flags: u32,
 166                            s: &[u16],
 167                            no_default_char: bool)
 168                            -> io::Result<Vec<i8>> {
 169     unsafe {
 170         let mut size = c::WideCharToMultiByte(code_page,
 171                                               flags,
 172                                               s.as_ptr(),
 173                                               s.len() as i32,
 174                                               ptr::null_mut(),
 175                                               0,
 176                                               ptr::null(),
 177                                               ptr::null_mut());
 178         if size == 0 {
 179             return Err(io::Error::last_os_error());
 180         }
 181
 182         let mut buf = Vec::with_capacity(size as usize);
 183         buf.set_len(size as usize);
 184
 185         let mut used_default_char = c::FALSE;
 186         size = c::WideCharToMultiByte(code_page,
 187                                       flags,
 188                                       s.as_ptr(),
 189                                       s.len() as i32,
 190                                       buf.as_mut_ptr(),
 191                                       buf.len() as i32,
 192                                       ptr::null(),
 193                                       if no_default_char { &mut used_default_char }
 194                                       else { ptr::null_mut() });
 195         if size == 0 {
 196             return Err(io::Error::last_os_error());
 197         }
 198         if no_default_char && used_default_char == c::TRUE {
 199             return Err(io::Error::new(io::ErrorKind::InvalidData,
 200                                       "string cannot be converted to requested code page"));
 201         }
 202
 203         buf.set_len(size as usize);
 204
 205         Ok(buf)
 206     }
 207 }
 208
 209 pub fn truncate_utf16_at_nul<'a>(v: &'a [u16]) -> &'a [u16] {
 210     match v.iter().position(|c| *c == 0) {
 211         // don't include the 0
 212         Some(i) => &v[..i],
 213         None => v
 214     }
 215 }
 216
 217 pub trait IsZero {
 218     fn is_zero(&self) -> bool;
 219 }
 220
 221 macro_rules! impl_is_zero {
 222     ($($t:ident)*) => ($(impl IsZero for $t {
 223         fn is_zero(&self) -> bool {
 224             *self == 0
 225         }
 226     })*)
 227 }
 228
 229 impl_is_zero! { i8 i16 i32 i64 isize u8 u16 u32 u64 usize }
 230
 231 pub fn cvt<I: IsZero>(i: I) -> io::Result<I> {
 232     if i.is_zero() {
 233         Err(io::Error::last_os_error())
 234     } else {
 235         Ok(i)
 236     }
 237 }
 238
 239 pub fn dur2timeout(dur: Duration) -> c::DWORD {
 240     // Note that a duration is a (u64, u32) (seconds, nanoseconds) pair, and the
 241     // timeouts in windows APIs are typically u32 milliseconds. To translate, we
 242     // have two pieces to take care of:
 243     //
 244     // * Nanosecond precision is rounded up
 245     // * Greater than u32::MAX milliseconds (50 days) is rounded up to INFINITE
 246     //   (never time out).
 247     dur.as_secs().checked_mul(1000).and_then(|ms| {
 248         ms.checked_add((dur.subsec_nanos() as u64) / 1_000_000)
 249     }).and_then(|ms| {
 250         ms.checked_add(if dur.subsec_nanos() % 1_000_000 > 0 {1} else {0})
 251     }).map(|ms| {
 252         if ms > <c::DWORD>::max_value() as u64 {
 253             c::INFINITE
 254         } else {
 255             ms as c::DWORD
 256         }
 257     }).unwrap_or(c::INFINITE)
 258 }
 259
 260 // On Windows, use the processor-specific __fastfail mechanism.  In Windows 8
 261 // and later, this will terminate the process immediately without running any
 262 // in-process exception handlers.  In earlier versions of Windows, this
 263 // sequence of instructions will be treated as an access violation,
 264 // terminating the process but without necessarily bypassing all exception
 265 // handlers.
 266 //
 267 // https://msdn.microsoft.com/en-us/library/dn774154.aspx
 268 #[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
 269 pub unsafe fn abort_internal() -> ! {
 270     asm!("int $$0x29" :: "{ecx}"(7) ::: volatile); // 7 is FAST_FAIL_FATAL_APP_EXIT
 271     ::intrinsics::unreachable();
 272 }