src/libstd/sys/windows/mod.rs

   1 #![allow(missing_docs, nonstandard_style)]
   2
   3 use crate::ffi::{OsStr, OsString};
   4 use crate::io::ErrorKind;
   5 use crate::os::windows::ffi::{OsStrExt, OsStringExt};
   6 use crate::path::PathBuf;
   7 use crate::ptr;
   8 use crate::time::Duration;
   9
  10 pub use self::rand::hashmap_random_keys;
  11 pub use libc::strlen;
  12
  13 #[macro_use]
  14 pub mod compat;
  15
  16 pub mod alloc;
  17 pub mod args;
  18 pub mod c;
  19 pub mod cmath;
  20 pub mod condvar;
  21 pub mod env;
  22 pub mod ext;
  23 pub mod fast_thread_local;
  24 pub mod fs;
  25 pub mod handle;
  26 pub mod io;
  27 pub mod memchr;
  28 pub mod mutex;
  29 pub mod net;
  30 pub mod os;
  31 pub mod os_str;
  32 pub mod path;
  33 pub mod pipe;
  34 pub mod process;
  35 pub mod rand;
  36 pub mod rwlock;
  37 pub mod thread;
  38 pub mod thread_local;
  39 pub mod time;
  40 cfg_if::cfg_if! {
  41     if #[cfg(not(target_vendor = "uwp"))] {
  42         pub mod stdio;
  43         pub mod stack_overflow;
  44     } else {
  45         pub mod stdio_uwp;
  46         pub mod stack_overflow_uwp;
  47         pub use self::stdio_uwp as stdio;
  48         pub use self::stack_overflow_uwp as stack_overflow;
  49     }
  50 }
  51
  52 #[cfg(not(test))]
  53 pub fn init() {}
  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(
  89                 ErrorKind::InvalidInput,
  90                 "strings passed to WinAPI cannot contain NULs",
  91             ));
  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) -> crate::io::Result<T>
 114 where
 115     F1: FnMut(*mut u16, c::DWORD) -> c::DWORD,
 116     F2: FnOnce(&[u16]) -> T,
 117 {
 118     // Start off with a stack buf but then spill over to the heap if we end up
 119     // needing more space.
 120     let mut stack_buf = [0u16; 512];
 121     let mut heap_buf = Vec::new();
 122     unsafe {
 123         let mut n = stack_buf.len();
 124         loop {
 125             let buf = if n <= stack_buf.len() {
 126                 &mut stack_buf[..]
 127             } else {
 128                 let extra = n - heap_buf.len();
 129                 heap_buf.reserve(extra);
 130                 heap_buf.set_len(n);
 131                 &mut heap_buf[..]
 132             };
 133
 134             // This function is typically called on windows API functions which
 135             // will return the correct length of the string, but these functions
 136             // also return the `0` on error. In some cases, however, the
 137             // returned "correct length" may actually be 0!
 138             //
 139             // To handle this case we call `SetLastError` to reset it to 0 and
 140             // then check it again if we get the "0 error value". If the "last
 141             // error" is still 0 then we interpret it as a 0 length buffer and
 142             // not an actual error.
 143             c::SetLastError(0);
 144             let k = match f1(buf.as_mut_ptr(), n as c::DWORD) {
 145                 0 if c::GetLastError() == 0 => 0,
 146                 0 => return Err(crate::io::Error::last_os_error()),
 147                 n => n,
 148             } as usize;
 149             if k == n && c::GetLastError() == c::ERROR_INSUFFICIENT_BUFFER {
 150                 n *= 2;
 151             } else if k >= n {
 152                 n = k;
 153             } else {
 154                 return Ok(f2(&buf[..k]));
 155             }
 156         }
 157     }
 158 }
 159
 160 fn os2path(s: &[u16]) -> PathBuf {
 161     PathBuf::from(OsString::from_wide(s))
 162 }
 163
 164 #[allow(dead_code)] // Only used in backtrace::gnu::get_executable_filename()
 165 fn wide_char_to_multi_byte(
 166     code_page: u32,
 167     flags: u32,
 168     s: &[u16],
 169     no_default_char: bool,
 170 ) -> crate::io::Result<Vec<i8>> {
 171     unsafe {
 172         let mut size = c::WideCharToMultiByte(
 173             code_page,
 174             flags,
 175             s.as_ptr(),
 176             s.len() as i32,
 177             ptr::null_mut(),
 178             0,
 179             ptr::null(),
 180             ptr::null_mut(),
 181         );
 182         if size == 0 {
 183             return Err(crate::io::Error::last_os_error());
 184         }
 185
 186         let mut buf = Vec::with_capacity(size as usize);
 187         buf.set_len(size as usize);
 188
 189         let mut used_default_char = c::FALSE;
 190         size = c::WideCharToMultiByte(
 191             code_page,
 192             flags,
 193             s.as_ptr(),
 194             s.len() as i32,
 195             buf.as_mut_ptr(),
 196             buf.len() as i32,
 197             ptr::null(),
 198             if no_default_char { &mut used_default_char } else { ptr::null_mut() },
 199         );
 200         if size == 0 {
 201             return Err(crate::io::Error::last_os_error());
 202         }
 203         if no_default_char && used_default_char == c::TRUE {
 204             return Err(crate::io::Error::new(
 205                 crate::io::ErrorKind::InvalidData,
 206                 "string cannot be converted to requested code page",
 207             ));
 208         }
 209
 210         buf.set_len(size as usize);
 211
 212         Ok(buf)
 213     }
 214 }
 215
 216 pub fn truncate_utf16_at_nul(v: &[u16]) -> &[u16] {
 217     match v.iter().position(|c| *c == 0) {
 218         // don't include the 0
 219         Some(i) => &v[..i],
 220         None => v,
 221     }
 222 }
 223
 224 pub trait IsZero {
 225     fn is_zero(&self) -> bool;
 226 }
 227
 228 macro_rules! impl_is_zero {
 229     ($($t:ident)*) => ($(impl IsZero for $t {
 230         fn is_zero(&self) -> bool {
 231             *self == 0
 232         }
 233     })*)
 234 }
 235
 236 impl_is_zero! { i8 i16 i32 i64 isize u8 u16 u32 u64 usize }
 237
 238 pub fn cvt<I: IsZero>(i: I) -> crate::io::Result<I> {
 239     if i.is_zero() { Err(crate::io::Error::last_os_error()) } else { Ok(i) }
 240 }
 241
 242 pub fn dur2timeout(dur: Duration) -> c::DWORD {
 243     // Note that a duration is a (u64, u32) (seconds, nanoseconds) pair, and the
 244     // timeouts in windows APIs are typically u32 milliseconds. To translate, we
 245     // have two pieces to take care of:
 246     //
 247     // * Nanosecond precision is rounded up
 248     // * Greater than u32::MAX milliseconds (50 days) is rounded up to INFINITE
 249     //   (never time out).
 250     dur.as_secs()
 251         .checked_mul(1000)
 252         .and_then(|ms| ms.checked_add((dur.subsec_nanos() as u64) / 1_000_000))
 253         .and_then(|ms| ms.checked_add(if dur.subsec_nanos() % 1_000_000 > 0 { 1 } else { 0 }))
 254         .map(|ms| if ms > <c::DWORD>::max_value() as u64 { c::INFINITE } else { ms as c::DWORD })
 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 }