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