src/libstd/sys/windows/mod.rs

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