library/std/src/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 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_dtor;
  38 pub mod thread_local_key;
  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_INVALID_PARAMETER => return ErrorKind::InvalidInput,
  65         c::ERROR_SEM_TIMEOUT
  66         | c::WAIT_TIMEOUT
  67         | c::ERROR_DRIVER_CANCEL_TIMEOUT
  68         | c::ERROR_OPERATION_ABORTED
  69         | c::ERROR_SERVICE_REQUEST_TIMEOUT
  70         | c::ERROR_COUNTER_TIMEOUT
  71         | c::ERROR_TIMEOUT
  72         | c::ERROR_RESOURCE_CALL_TIMED_OUT
  73         | c::ERROR_CTX_MODEM_RESPONSE_TIMEOUT
  74         | c::ERROR_CTX_CLIENT_QUERY_TIMEOUT
  75         | c::FRS_ERR_SYSVOL_POPULATE_TIMEOUT
  76         | c::ERROR_DS_TIMELIMIT_EXCEEDED
  77         | c::DNS_ERROR_RECORD_TIMED_OUT
  78         | c::ERROR_IPSEC_IKE_TIMED_OUT
  79         | c::ERROR_RUNLEVEL_SWITCH_TIMEOUT
  80         | c::ERROR_RUNLEVEL_SWITCH_AGENT_TIMEOUT => return ErrorKind::TimedOut,
  81         _ => {}
  82     }
  83
  84     match errno {
  85         c::WSAEACCES => ErrorKind::PermissionDenied,
  86         c::WSAEADDRINUSE => ErrorKind::AddrInUse,
  87         c::WSAEADDRNOTAVAIL => ErrorKind::AddrNotAvailable,
  88         c::WSAECONNABORTED => ErrorKind::ConnectionAborted,
  89         c::WSAECONNREFUSED => ErrorKind::ConnectionRefused,
  90         c::WSAECONNRESET => ErrorKind::ConnectionReset,
  91         c::WSAEINVAL => ErrorKind::InvalidInput,
  92         c::WSAENOTCONN => ErrorKind::NotConnected,
  93         c::WSAEWOULDBLOCK => ErrorKind::WouldBlock,
  94         c::WSAETIMEDOUT => ErrorKind::TimedOut,
  95
  96         _ => ErrorKind::Other,
  97     }
  98 }
  99
 100 pub fn unrolled_find_u16s(needle: u16, haystack: &[u16]) -> Option<usize> {
 101     let ptr = haystack.as_ptr();
 102     let mut len = haystack.len();
 103     let mut start = &haystack[..];
 104
 105     // For performance reasons unfold the loop eight times.
 106     while len >= 8 {
 107         if start[0] == needle {
 108             return Some((start.as_ptr() as usize - ptr as usize) / 2);
 109         }
 110         if start[1] == needle {
 111             return Some((start[1..].as_ptr() as usize - ptr as usize) / 2);
 112         }
 113         if start[2] == needle {
 114             return Some((start[2..].as_ptr() as usize - ptr as usize) / 2);
 115         }
 116         if start[3] == needle {
 117             return Some((start[3..].as_ptr() as usize - ptr as usize) / 2);
 118         }
 119         if start[4] == needle {
 120             return Some((start[4..].as_ptr() as usize - ptr as usize) / 2);
 121         }
 122         if start[5] == needle {
 123             return Some((start[5..].as_ptr() as usize - ptr as usize) / 2);
 124         }
 125         if start[6] == needle {
 126             return Some((start[6..].as_ptr() as usize - ptr as usize) / 2);
 127         }
 128         if start[7] == needle {
 129             return Some((start[7..].as_ptr() as usize - ptr as usize) / 2);
 130         }
 131
 132         start = &start[8..];
 133         len -= 8;
 134     }
 135
 136     for (i, c) in start.iter().enumerate() {
 137         if *c == needle {
 138             return Some((start.as_ptr() as usize - ptr as usize) / 2 + i);
 139         }
 140     }
 141     None
 142 }
 143
 144 pub fn to_u16s<S: AsRef<OsStr>>(s: S) -> crate::io::Result<Vec<u16>> {
 145     fn inner(s: &OsStr) -> crate::io::Result<Vec<u16>> {
 146         let mut maybe_result: Vec<u16> = s.encode_wide().collect();
 147         if unrolled_find_u16s(0, &maybe_result).is_some() {
 148             return Err(crate::io::Error::new(
 149                 ErrorKind::InvalidInput,
 150                 "strings passed to WinAPI cannot contain NULs",
 151             ));
 152         }
 153         maybe_result.push(0);
 154         Ok(maybe_result)
 155     }
 156     inner(s.as_ref())
 157 }
 158
 159 // Many Windows APIs follow a pattern of where we hand a buffer and then they
 160 // will report back to us how large the buffer should be or how many bytes
 161 // currently reside in the buffer. This function is an abstraction over these
 162 // functions by making them easier to call.
 163 //
 164 // The first callback, `f1`, is yielded a (pointer, len) pair which can be
 165 // passed to a syscall. The `ptr` is valid for `len` items (u16 in this case).
 166 // The closure is expected to return what the syscall returns which will be
 167 // interpreted by this function to determine if the syscall needs to be invoked
 168 // again (with more buffer space).
 169 //
 170 // Once the syscall has completed (errors bail out early) the second closure is
 171 // yielded the data which has been read from the syscall. The return value
 172 // from this closure is then the return value of the function.
 173 fn fill_utf16_buf<F1, F2, T>(mut f1: F1, f2: F2) -> crate::io::Result<T>
 174 where
 175     F1: FnMut(*mut u16, c::DWORD) -> c::DWORD,
 176     F2: FnOnce(&[u16]) -> T,
 177 {
 178     // Start off with a stack buf but then spill over to the heap if we end up
 179     // needing more space.
 180     let mut stack_buf = [0u16; 512];
 181     let mut heap_buf = Vec::new();
 182     unsafe {
 183         let mut n = stack_buf.len();
 184         loop {
 185             let buf = if n <= stack_buf.len() {
 186                 &mut stack_buf[..]
 187             } else {
 188                 let extra = n - heap_buf.len();
 189                 heap_buf.reserve(extra);
 190                 heap_buf.set_len(n);
 191                 &mut heap_buf[..]
 192             };
 193
 194             // This function is typically called on windows API functions which
 195             // will return the correct length of the string, but these functions
 196             // also return the `0` on error. In some cases, however, the
 197             // returned "correct length" may actually be 0!
 198             //
 199             // To handle this case we call `SetLastError` to reset it to 0 and
 200             // then check it again if we get the "0 error value". If the "last
 201             // error" is still 0 then we interpret it as a 0 length buffer and
 202             // not an actual error.
 203             c::SetLastError(0);
 204             let k = match f1(buf.as_mut_ptr(), n as c::DWORD) {
 205                 0 if c::GetLastError() == 0 => 0,
 206                 0 => return Err(crate::io::Error::last_os_error()),
 207                 n => n,
 208             } as usize;
 209             if k == n && c::GetLastError() == c::ERROR_INSUFFICIENT_BUFFER {
 210                 n *= 2;
 211             } else if k >= n {
 212                 n = k;
 213             } else {
 214                 return Ok(f2(&buf[..k]));
 215             }
 216         }
 217     }
 218 }
 219
 220 fn os2path(s: &[u16]) -> PathBuf {
 221     PathBuf::from(OsString::from_wide(s))
 222 }
 223
 224 #[allow(dead_code)] // Only used in backtrace::gnu::get_executable_filename()
 225 fn wide_char_to_multi_byte(
 226     code_page: u32,
 227     flags: u32,
 228     s: &[u16],
 229     no_default_char: bool,
 230 ) -> crate::io::Result<Vec<i8>> {
 231     unsafe {
 232         let mut size = c::WideCharToMultiByte(
 233             code_page,
 234             flags,
 235             s.as_ptr(),
 236             s.len() as i32,
 237             ptr::null_mut(),
 238             0,
 239             ptr::null(),
 240             ptr::null_mut(),
 241         );
 242         if size == 0 {
 243             return Err(crate::io::Error::last_os_error());
 244         }
 245
 246         let mut buf = Vec::with_capacity(size as usize);
 247         buf.set_len(size as usize);
 248
 249         let mut used_default_char = c::FALSE;
 250         size = c::WideCharToMultiByte(
 251             code_page,
 252             flags,
 253             s.as_ptr(),
 254             s.len() as i32,
 255             buf.as_mut_ptr(),
 256             buf.len() as i32,
 257             ptr::null(),
 258             if no_default_char { &mut used_default_char } else { ptr::null_mut() },
 259         );
 260         if size == 0 {
 261             return Err(crate::io::Error::last_os_error());
 262         }
 263         if no_default_char && used_default_char == c::TRUE {
 264             return Err(crate::io::Error::new(
 265                 crate::io::ErrorKind::InvalidData,
 266                 "string cannot be converted to requested code page",
 267             ));
 268         }
 269
 270         buf.set_len(size as usize);
 271
 272         Ok(buf)
 273     }
 274 }
 275
 276 pub fn truncate_utf16_at_nul(v: &[u16]) -> &[u16] {
 277     match unrolled_find_u16s(0, v) {
 278         // don't include the 0
 279         Some(i) => &v[..i],
 280         None => v,
 281     }
 282 }
 283
 284 pub trait IsZero {
 285     fn is_zero(&self) -> bool;
 286 }
 287
 288 macro_rules! impl_is_zero {
 289     ($($t:ident)*) => ($(impl IsZero for $t {
 290         fn is_zero(&self) -> bool {
 291             *self == 0
 292         }
 293     })*)
 294 }
 295
 296 impl_is_zero! { i8 i16 i32 i64 isize u8 u16 u32 u64 usize }
 297
 298 pub fn cvt<I: IsZero>(i: I) -> crate::io::Result<I> {
 299     if i.is_zero() { Err(crate::io::Error::last_os_error()) } else { Ok(i) }
 300 }
 301
 302 pub fn dur2timeout(dur: Duration) -> c::DWORD {
 303     // Note that a duration is a (u64, u32) (seconds, nanoseconds) pair, and the
 304     // timeouts in windows APIs are typically u32 milliseconds. To translate, we
 305     // have two pieces to take care of:
 306     //
 307     // * Nanosecond precision is rounded up
 308     // * Greater than u32::MAX milliseconds (50 days) is rounded up to INFINITE
 309     //   (never time out).
 310     dur.as_secs()
 311         .checked_mul(1000)
 312         .and_then(|ms| ms.checked_add((dur.subsec_nanos() as u64) / 1_000_000))
 313         .and_then(|ms| ms.checked_add(if dur.subsec_nanos() % 1_000_000 > 0 { 1 } else { 0 }))
 314         .map(|ms| if ms > <c::DWORD>::MAX as u64 { c::INFINITE } else { ms as c::DWORD })
 315         .unwrap_or(c::INFINITE)
 316 }
 317
 318 // On Windows, use the processor-specific __fastfail mechanism.  In Windows 8
 319 // and later, this will terminate the process immediately without running any
 320 // in-process exception handlers.  In earlier versions of Windows, this
 321 // sequence of instructions will be treated as an access violation,
 322 // terminating the process but without necessarily bypassing all exception
 323 // handlers.
 324 //
 325 // https://docs.microsoft.com/en-us/cpp/intrinsics/fastfail
 326 #[allow(unreachable_code)]
 327 pub fn abort_internal() -> ! {
 328     #[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
 329     unsafe {
 330         llvm_asm!("int $$0x29" :: "{ecx}"(7) ::: volatile); // 7 is FAST_FAIL_FATAL_APP_EXIT
 331         crate::intrinsics::unreachable();
 332     }
 333     crate::intrinsics::abort();
 334 }