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