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