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 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 #[allow(dead_code)] // Only used in backtrace::gnu::get_executable_filename()
 210 fn wide_char_to_multi_byte(
 211     code_page: u32,
 212     flags: u32,
 213     s: &[u16],
 214     no_default_char: bool,
 215 ) -> crate::io::Result<Vec<i8>> {
 216     unsafe {
 217         let mut size = c::WideCharToMultiByte(
 218             code_page,
 219             flags,
 220             s.as_ptr(),
 221             s.len() as i32,
 222             ptr::null_mut(),
 223             0,
 224             ptr::null(),
 225             ptr::null_mut(),
 226         );
 227         if size == 0 {
 228             return Err(crate::io::Error::last_os_error());
 229         }
 230
 231         let mut buf = Vec::with_capacity(size as usize);
 232         buf.set_len(size as usize);
 233
 234         let mut used_default_char = c::FALSE;
 235         size = c::WideCharToMultiByte(
 236             code_page,
 237             flags,
 238             s.as_ptr(),
 239             s.len() as i32,
 240             buf.as_mut_ptr(),
 241             buf.len() as i32,
 242             ptr::null(),
 243             if no_default_char { &mut used_default_char } else { ptr::null_mut() },
 244         );
 245         if size == 0 {
 246             return Err(crate::io::Error::last_os_error());
 247         }
 248         if no_default_char && used_default_char == c::TRUE {
 249             return Err(crate::io::Error::new(
 250                 crate::io::ErrorKind::InvalidData,
 251                 "string cannot be converted to requested code page",
 252             ));
 253         }
 254
 255         buf.set_len(size as usize);
 256
 257         Ok(buf)
 258     }
 259 }
 260
 261 pub fn truncate_utf16_at_nul(v: &[u16]) -> &[u16] {
 262     match unrolled_find_u16s(0, v) {
 263         // don't include the 0
 264         Some(i) => &v[..i],
 265         None => v,
 266     }
 267 }
 268
 269 pub trait IsZero {
 270     fn is_zero(&self) -> bool;
 271 }
 272
 273 macro_rules! impl_is_zero {
 274     ($($t:ident)*) => ($(impl IsZero for $t {
 275         fn is_zero(&self) -> bool {
 276             *self == 0
 277         }
 278     })*)
 279 }
 280
 281 impl_is_zero! { i8 i16 i32 i64 isize u8 u16 u32 u64 usize }
 282
 283 pub fn cvt<I: IsZero>(i: I) -> crate::io::Result<I> {
 284     if i.is_zero() { Err(crate::io::Error::last_os_error()) } else { Ok(i) }
 285 }
 286
 287 pub fn dur2timeout(dur: Duration) -> c::DWORD {
 288     // Note that a duration is a (u64, u32) (seconds, nanoseconds) pair, and the
 289     // timeouts in windows APIs are typically u32 milliseconds. To translate, we
 290     // have two pieces to take care of:
 291     //
 292     // * Nanosecond precision is rounded up
 293     // * Greater than u32::MAX milliseconds (50 days) is rounded up to INFINITE
 294     //   (never time out).
 295     dur.as_secs()
 296         .checked_mul(1000)
 297         .and_then(|ms| ms.checked_add((dur.subsec_nanos() as u64) / 1_000_000))
 298         .and_then(|ms| ms.checked_add(if dur.subsec_nanos() % 1_000_000 > 0 { 1 } else { 0 }))
 299         .map(|ms| if ms > <c::DWORD>::MAX as u64 { c::INFINITE } else { ms as c::DWORD })
 300         .unwrap_or(c::INFINITE)
 301 }
 302
 303 /// Use `__fastfail` to abort the process
 304 ///
 305 /// This is the same implementation as in libpanic_abort's `__rust_start_panic`. See
 306 /// that function for more information on `__fastfail`
 307 #[allow(unreachable_code)]
 308 pub fn abort_internal() -> ! {
 309     #[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
 310     unsafe {
 311         llvm_asm!("int $$0x29" :: "{ecx}"(7) ::: volatile); // 7 is FAST_FAIL_FATAL_APP_EXIT
 312         crate::intrinsics::unreachable();
 313     }
 314     crate::intrinsics::abort();
 315 }