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 fs;
  22 pub mod handle;
  23 pub mod io;
  24 pub mod memchr;
  25 pub mod mutex;
  26 pub mod net;
  27 pub mod os;
  28 pub mod os_str;
  29 pub mod path;
  30 pub mod pipe;
  31 pub mod process;
  32 pub mod rand;
  33 pub mod rwlock;
  34 pub mod thread;
  35 pub mod thread_local_dtor;
  36 pub mod thread_local_key;
  37 pub mod thread_parker;
  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 // SAFETY: must be called only once during runtime initialization.
  52 // NOTE: this is not guaranteed to run, for example when Rust code is called externally.
  53 pub unsafe fn init(_argc: isize, _argv: *const *const u8) {
  54     stack_overflow::init();
  55 }
  56
  57 // SAFETY: must be called only once during runtime cleanup.
  58 // NOTE: this is not guaranteed to run, for example when the program aborts.
  59 pub unsafe fn cleanup() {
  60     net::cleanup();
  61 }
  62
  63 pub fn decode_error_kind(errno: i32) -> ErrorKind {
  64     use ErrorKind::*;
  65
  66     match errno as c::DWORD {
  67         c::ERROR_ACCESS_DENIED => return PermissionDenied,
  68         c::ERROR_ALREADY_EXISTS => return AlreadyExists,
  69         c::ERROR_FILE_EXISTS => return AlreadyExists,
  70         c::ERROR_BROKEN_PIPE => return BrokenPipe,
  71         c::ERROR_FILE_NOT_FOUND => return NotFound,
  72         c::ERROR_PATH_NOT_FOUND => return NotFound,
  73         c::ERROR_NO_DATA => return BrokenPipe,
  74         c::ERROR_INVALID_NAME => return InvalidFilename,
  75         c::ERROR_INVALID_PARAMETER => return InvalidInput,
  76         c::ERROR_NOT_ENOUGH_MEMORY | c::ERROR_OUTOFMEMORY => return OutOfMemory,
  77         c::ERROR_SEM_TIMEOUT
  78         | c::WAIT_TIMEOUT
  79         | c::ERROR_DRIVER_CANCEL_TIMEOUT
  80         | c::ERROR_OPERATION_ABORTED
  81         | c::ERROR_SERVICE_REQUEST_TIMEOUT
  82         | c::ERROR_COUNTER_TIMEOUT
  83         | c::ERROR_TIMEOUT
  84         | c::ERROR_RESOURCE_CALL_TIMED_OUT
  85         | c::ERROR_CTX_MODEM_RESPONSE_TIMEOUT
  86         | c::ERROR_CTX_CLIENT_QUERY_TIMEOUT
  87         | c::FRS_ERR_SYSVOL_POPULATE_TIMEOUT
  88         | c::ERROR_DS_TIMELIMIT_EXCEEDED
  89         | c::DNS_ERROR_RECORD_TIMED_OUT
  90         | c::ERROR_IPSEC_IKE_TIMED_OUT
  91         | c::ERROR_RUNLEVEL_SWITCH_TIMEOUT
  92         | c::ERROR_RUNLEVEL_SWITCH_AGENT_TIMEOUT => return TimedOut,
  93         c::ERROR_CALL_NOT_IMPLEMENTED => return Unsupported,
  94         c::ERROR_HOST_UNREACHABLE => return HostUnreachable,
  95         c::ERROR_NETWORK_UNREACHABLE => return NetworkUnreachable,
  96         c::ERROR_DIRECTORY => return NotADirectory,
  97         c::ERROR_DIRECTORY_NOT_SUPPORTED => return IsADirectory,
  98         c::ERROR_DIR_NOT_EMPTY => return DirectoryNotEmpty,
  99         c::ERROR_WRITE_PROTECT => return ReadOnlyFilesystem,
 100         c::ERROR_DISK_FULL | c::ERROR_HANDLE_DISK_FULL => return StorageFull,
 101         c::ERROR_SEEK_ON_DEVICE => return NotSeekable,
 102         c::ERROR_DISK_QUOTA_EXCEEDED => return FilesystemQuotaExceeded,
 103         c::ERROR_FILE_TOO_LARGE => return FileTooLarge,
 104         c::ERROR_BUSY => return ResourceBusy,
 105         c::ERROR_POSSIBLE_DEADLOCK => return Deadlock,
 106         c::ERROR_NOT_SAME_DEVICE => return CrossesDevices,
 107         c::ERROR_TOO_MANY_LINKS => return TooManyLinks,
 108         c::ERROR_FILENAME_EXCED_RANGE => return InvalidFilename,
 109         _ => {}
 110     }
 111
 112     match errno {
 113         c::WSAEACCES => PermissionDenied,
 114         c::WSAEADDRINUSE => AddrInUse,
 115         c::WSAEADDRNOTAVAIL => AddrNotAvailable,
 116         c::WSAECONNABORTED => ConnectionAborted,
 117         c::WSAECONNREFUSED => ConnectionRefused,
 118         c::WSAECONNRESET => ConnectionReset,
 119         c::WSAEINVAL => InvalidInput,
 120         c::WSAENOTCONN => NotConnected,
 121         c::WSAEWOULDBLOCK => WouldBlock,
 122         c::WSAETIMEDOUT => TimedOut,
 123         c::WSAEHOSTUNREACH => HostUnreachable,
 124         c::WSAENETDOWN => NetworkDown,
 125         c::WSAENETUNREACH => NetworkUnreachable,
 126
 127         _ => Uncategorized,
 128     }
 129 }
 130
 131 pub fn unrolled_find_u16s(needle: u16, haystack: &[u16]) -> Option<usize> {
 132     let ptr = haystack.as_ptr();
 133     let mut start = &haystack[..];
 134
 135     // For performance reasons unfold the loop eight times.
 136     while start.len() >= 8 {
 137         macro_rules! if_return {
 138             ($($n:literal,)+) => {
 139                 $(
 140                     if start[$n] == needle {
 141                         return Some((&start[$n] as *const u16 as usize - ptr as usize) / 2);
 142                     }
 143                 )+
 144             }
 145         }
 146
 147         if_return!(0, 1, 2, 3, 4, 5, 6, 7,);
 148
 149         start = &start[8..];
 150     }
 151
 152     for c in start {
 153         if *c == needle {
 154             return Some((c as *const u16 as usize - ptr as usize) / 2);
 155         }
 156     }
 157     None
 158 }
 159
 160 pub fn to_u16s<S: AsRef<OsStr>>(s: S) -> crate::io::Result<Vec<u16>> {
 161     fn inner(s: &OsStr) -> crate::io::Result<Vec<u16>> {
 162         let mut maybe_result: Vec<u16> = s.encode_wide().collect();
 163         if unrolled_find_u16s(0, &maybe_result).is_some() {
 164             return Err(crate::io::const_io_error!(
 165                 ErrorKind::InvalidInput,
 166                 "strings passed to WinAPI cannot contain NULs",
 167             ));
 168         }
 169         maybe_result.push(0);
 170         Ok(maybe_result)
 171     }
 172     inner(s.as_ref())
 173 }
 174
 175 // Many Windows APIs follow a pattern of where we hand a buffer and then they
 176 // will report back to us how large the buffer should be or how many bytes
 177 // currently reside in the buffer. This function is an abstraction over these
 178 // functions by making them easier to call.
 179 //
 180 // The first callback, `f1`, is yielded a (pointer, len) pair which can be
 181 // passed to a syscall. The `ptr` is valid for `len` items (u16 in this case).
 182 // The closure is expected to return what the syscall returns which will be
 183 // interpreted by this function to determine if the syscall needs to be invoked
 184 // again (with more buffer space).
 185 //
 186 // Once the syscall has completed (errors bail out early) the second closure is
 187 // yielded the data which has been read from the syscall. The return value
 188 // from this closure is then the return value of the function.
 189 fn fill_utf16_buf<F1, F2, T>(mut f1: F1, f2: F2) -> crate::io::Result<T>
 190 where
 191     F1: FnMut(*mut u16, c::DWORD) -> c::DWORD,
 192     F2: FnOnce(&[u16]) -> T,
 193 {
 194     // Start off with a stack buf but then spill over to the heap if we end up
 195     // needing more space.
 196     let mut stack_buf = [0u16; 512];
 197     let mut heap_buf = Vec::new();
 198     unsafe {
 199         let mut n = stack_buf.len();
 200         loop {
 201             let buf = if n <= stack_buf.len() {
 202                 &mut stack_buf[..]
 203             } else {
 204                 let extra = n - heap_buf.len();
 205                 heap_buf.reserve(extra);
 206                 heap_buf.set_len(n);
 207                 &mut heap_buf[..]
 208             };
 209
 210             // This function is typically called on windows API functions which
 211             // will return the correct length of the string, but these functions
 212             // also return the `0` on error. In some cases, however, the
 213             // returned "correct length" may actually be 0!
 214             //
 215             // To handle this case we call `SetLastError` to reset it to 0 and
 216             // then check it again if we get the "0 error value". If the "last
 217             // error" is still 0 then we interpret it as a 0 length buffer and
 218             // not an actual error.
 219             c::SetLastError(0);
 220             let k = match f1(buf.as_mut_ptr(), n as c::DWORD) {
 221                 0 if c::GetLastError() == 0 => 0,
 222                 0 => return Err(crate::io::Error::last_os_error()),
 223                 n => n,
 224             } as usize;
 225             if k == n && c::GetLastError() == c::ERROR_INSUFFICIENT_BUFFER {
 226                 n *= 2;
 227             } else if k >= n {
 228                 n = k;
 229             } else {
 230                 return Ok(f2(&buf[..k]));
 231             }
 232         }
 233     }
 234 }
 235
 236 fn os2path(s: &[u16]) -> PathBuf {
 237     PathBuf::from(OsString::from_wide(s))
 238 }
 239
 240 pub fn truncate_utf16_at_nul(v: &[u16]) -> &[u16] {
 241     match unrolled_find_u16s(0, v) {
 242         // don't include the 0
 243         Some(i) => &v[..i],
 244         None => v,
 245     }
 246 }
 247
 248 pub trait IsZero {
 249     fn is_zero(&self) -> bool;
 250 }
 251
 252 macro_rules! impl_is_zero {
 253     ($($t:ident)*) => ($(impl IsZero for $t {
 254         fn is_zero(&self) -> bool {
 255             *self == 0
 256         }
 257     })*)
 258 }
 259
 260 impl_is_zero! { i8 i16 i32 i64 isize u8 u16 u32 u64 usize }
 261
 262 pub fn cvt<I: IsZero>(i: I) -> crate::io::Result<I> {
 263     if i.is_zero() { Err(crate::io::Error::last_os_error()) } else { Ok(i) }
 264 }
 265
 266 pub fn dur2timeout(dur: Duration) -> c::DWORD {
 267     // Note that a duration is a (u64, u32) (seconds, nanoseconds) pair, and the
 268     // timeouts in windows APIs are typically u32 milliseconds. To translate, we
 269     // have two pieces to take care of:
 270     //
 271     // * Nanosecond precision is rounded up
 272     // * Greater than u32::MAX milliseconds (50 days) is rounded up to INFINITE
 273     //   (never time out).
 274     dur.as_secs()
 275         .checked_mul(1000)
 276         .and_then(|ms| ms.checked_add((dur.subsec_nanos() as u64) / 1_000_000))
 277         .and_then(|ms| ms.checked_add(if dur.subsec_nanos() % 1_000_000 > 0 { 1 } else { 0 }))
 278         .map(|ms| if ms > <c::DWORD>::MAX as u64 { c::INFINITE } else { ms as c::DWORD })
 279         .unwrap_or(c::INFINITE)
 280 }
 281
 282 /// Use `__fastfail` to abort the process
 283 ///
 284 /// This is the same implementation as in libpanic_abort's `__rust_start_panic`. See
 285 /// that function for more information on `__fastfail`
 286 #[allow(unreachable_code)]
 287 pub fn abort_internal() -> ! {
 288     const FAST_FAIL_FATAL_APP_EXIT: usize = 7;
 289     #[cfg(not(miri))] // inline assembly does not work in Miri
 290     unsafe {
 291         cfg_if::cfg_if! {
 292             if #[cfg(any(target_arch = "x86", target_arch = "x86_64"))] {
 293                 core::arch::asm!("int $$0x29", in("ecx") FAST_FAIL_FATAL_APP_EXIT);
 294                 crate::intrinsics::unreachable();
 295             } else if #[cfg(all(target_arch = "arm", target_feature = "thumb-mode"))] {
 296                 core::arch::asm!(".inst 0xDEFB", in("r0") FAST_FAIL_FATAL_APP_EXIT);
 297                 crate::intrinsics::unreachable();
 298             } else if #[cfg(target_arch = "aarch64")] {
 299                 core::arch::asm!("brk 0xF003", in("x0") FAST_FAIL_FATAL_APP_EXIT);
 300                 crate::intrinsics::unreachable();
 301             }
 302         }
 303     }
 304     crate::intrinsics::abort();
 305 }