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::time::Duration;
   8
   9 pub use self::rand::hashmap_random_keys;
  10 pub use libc::strlen;
  11
  12 #[macro_use]
  13 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 fs;
  23 pub mod handle;
  24 pub mod io;
  25 pub mod memchr;
  26 pub mod mutex;
  27 pub mod net;
  28 pub mod os;
  29 pub mod os_str;
  30 pub mod path;
  31 pub mod pipe;
  32 pub mod process;
  33 pub mod rand;
  34 pub mod rwlock;
  35 pub mod thread;
  36 pub mod thread_local_dtor;
  37 pub mod thread_local_key;
  38 pub mod thread_parker;
  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 start = &haystack[..];
 103
 104     // For performance reasons unfold the loop eight times.
 105     while start.len() >= 8 {
 106         macro_rules! if_return {
 107             ($($n:literal,)+) => {
 108                 $(
 109                     if start[$n] == needle {
 110                         return Some((&start[$n] as *const u16 as usize - ptr as usize) / 2);
 111                     }
 112                 )+
 113             }
 114         }
 115
 116         if_return!(0, 1, 2, 3, 4, 5, 6, 7,);
 117
 118         start = &start[8..];
 119     }
 120
 121     for c in start {
 122         if *c == needle {
 123             return Some((c as *const u16 as usize - ptr as usize) / 2);
 124         }
 125     }
 126     None
 127 }
 128
 129 pub fn to_u16s<S: AsRef<OsStr>>(s: S) -> crate::io::Result<Vec<u16>> {
 130     fn inner(s: &OsStr) -> crate::io::Result<Vec<u16>> {
 131         let mut maybe_result: Vec<u16> = s.encode_wide().collect();
 132         if unrolled_find_u16s(0, &maybe_result).is_some() {
 133             return Err(crate::io::Error::new(
 134                 ErrorKind::InvalidInput,
 135                 "strings passed to WinAPI cannot contain NULs",
 136             ));
 137         }
 138         maybe_result.push(0);
 139         Ok(maybe_result)
 140     }
 141     inner(s.as_ref())
 142 }
 143
 144 // Many Windows APIs follow a pattern of where we hand a buffer and then they
 145 // will report back to us how large the buffer should be or how many bytes
 146 // currently reside in the buffer. This function is an abstraction over these
 147 // functions by making them easier to call.
 148 //
 149 // The first callback, `f1`, is yielded a (pointer, len) pair which can be
 150 // passed to a syscall. The `ptr` is valid for `len` items (u16 in this case).
 151 // The closure is expected to return what the syscall returns which will be
 152 // interpreted by this function to determine if the syscall needs to be invoked
 153 // again (with more buffer space).
 154 //
 155 // Once the syscall has completed (errors bail out early) the second closure is
 156 // yielded the data which has been read from the syscall. The return value
 157 // from this closure is then the return value of the function.
 158 fn fill_utf16_buf<F1, F2, T>(mut f1: F1, f2: F2) -> crate::io::Result<T>
 159 where
 160     F1: FnMut(*mut u16, c::DWORD) -> c::DWORD,
 161     F2: FnOnce(&[u16]) -> T,
 162 {
 163     // Start off with a stack buf but then spill over to the heap if we end up
 164     // needing more space.
 165     let mut stack_buf = [0u16; 512];
 166     let mut heap_buf = Vec::new();
 167     unsafe {
 168         let mut n = stack_buf.len();
 169         loop {
 170             let buf = if n <= stack_buf.len() {
 171                 &mut stack_buf[..]
 172             } else {
 173                 let extra = n - heap_buf.len();
 174                 heap_buf.reserve(extra);
 175                 heap_buf.set_len(n);
 176                 &mut heap_buf[..]
 177             };
 178
 179             // This function is typically called on windows API functions which
 180             // will return the correct length of the string, but these functions
 181             // also return the `0` on error. In some cases, however, the
 182             // returned "correct length" may actually be 0!
 183             //
 184             // To handle this case we call `SetLastError` to reset it to 0 and
 185             // then check it again if we get the "0 error value". If the "last
 186             // error" is still 0 then we interpret it as a 0 length buffer and
 187             // not an actual error.
 188             c::SetLastError(0);
 189             let k = match f1(buf.as_mut_ptr(), n as c::DWORD) {
 190                 0 if c::GetLastError() == 0 => 0,
 191                 0 => return Err(crate::io::Error::last_os_error()),
 192                 n => n,
 193             } as usize;
 194             if k == n && c::GetLastError() == c::ERROR_INSUFFICIENT_BUFFER {
 195                 n *= 2;
 196             } else if k >= n {
 197                 n = k;
 198             } else {
 199                 return Ok(f2(&buf[..k]));
 200             }
 201         }
 202     }
 203 }
 204
 205 fn os2path(s: &[u16]) -> PathBuf {
 206     PathBuf::from(OsString::from_wide(s))
 207 }
 208
 209 pub fn truncate_utf16_at_nul(v: &[u16]) -> &[u16] {
 210     match unrolled_find_u16s(0, v) {
 211         // don't include the 0
 212         Some(i) => &v[..i],
 213         None => v,
 214     }
 215 }
 216
 217 pub trait IsZero {
 218     fn is_zero(&self) -> bool;
 219 }
 220
 221 macro_rules! impl_is_zero {
 222     ($($t:ident)*) => ($(impl IsZero for $t {
 223         fn is_zero(&self) -> bool {
 224             *self == 0
 225         }
 226     })*)
 227 }
 228
 229 impl_is_zero! { i8 i16 i32 i64 isize u8 u16 u32 u64 usize }
 230
 231 pub fn cvt<I: IsZero>(i: I) -> crate::io::Result<I> {
 232     if i.is_zero() { Err(crate::io::Error::last_os_error()) } else { Ok(i) }
 233 }
 234
 235 pub fn dur2timeout(dur: Duration) -> c::DWORD {
 236     // Note that a duration is a (u64, u32) (seconds, nanoseconds) pair, and the
 237     // timeouts in windows APIs are typically u32 milliseconds. To translate, we
 238     // have two pieces to take care of:
 239     //
 240     // * Nanosecond precision is rounded up
 241     // * Greater than u32::MAX milliseconds (50 days) is rounded up to INFINITE
 242     //   (never time out).
 243     dur.as_secs()
 244         .checked_mul(1000)
 245         .and_then(|ms| ms.checked_add((dur.subsec_nanos() as u64) / 1_000_000))
 246         .and_then(|ms| ms.checked_add(if dur.subsec_nanos() % 1_000_000 > 0 { 1 } else { 0 }))
 247         .map(|ms| if ms > <c::DWORD>::MAX as u64 { c::INFINITE } else { ms as c::DWORD })
 248         .unwrap_or(c::INFINITE)
 249 }
 250
 251 /// Use `__fastfail` to abort the process
 252 ///
 253 /// This is the same implementation as in libpanic_abort's `__rust_start_panic`. See
 254 /// that function for more information on `__fastfail`
 255 #[allow(unreachable_code)]
 256 pub fn abort_internal() -> ! {
 257     const FAST_FAIL_FATAL_APP_EXIT: usize = 7;
 258     unsafe {
 259         cfg_if::cfg_if! {
 260             if #[cfg(any(target_arch = "x86", target_arch = "x86_64"))] {
 261                 asm!("int $$0x29", in("ecx") FAST_FAIL_FATAL_APP_EXIT);
 262                 crate::intrinsics::unreachable();
 263             } else if #[cfg(all(target_arch = "arm", target_feature = "thumb-mode"))] {
 264                 asm!(".inst 0xDEFB", in("r0") FAST_FAIL_FATAL_APP_EXIT);
 265                 crate::intrinsics::unreachable();
 266             } else if #[cfg(target_arch = "aarch64")] {
 267                 asm!("brk 0xF003", in("x0") FAST_FAIL_FATAL_APP_EXIT);
 268                 crate::intrinsics::unreachable();
 269             }
 270         }
 271     }
 272     crate::intrinsics::abort();
 273 }
 274
 275 cfg_if::cfg_if! {
 276     if #[cfg(target_vendor = "uwp")] {
 277         #[link(name = "ws2_32")]
 278         // For BCryptGenRandom
 279         #[link(name = "bcrypt")]
 280         extern "C" {}
 281     } else {
 282         #[link(name = "advapi32")]
 283         #[link(name = "ws2_32")]
 284         #[link(name = "userenv")]
 285         extern "C" {}
 286     }
 287 }