1 #![allow(missing_docs, nonstandard_style)]
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;
9 pub use self::rand::hashmap_random_keys;
32 pub mod thread_local_dtor;
33 pub mod thread_local_key;
34 pub mod thread_parker;
37 if #[cfg(not(target_vendor = "uwp"))] {
39 pub mod stack_overflow;
42 pub mod stack_overflow_uwp;
43 pub use self::stdio_uwp as stdio;
44 pub use self::stack_overflow_uwp as stack_overflow;
48 // SAFETY: must be called only once during runtime initialization.
49 // NOTE: this is not guaranteed to run, for example when Rust code is called externally.
50 pub unsafe fn init(_argc: isize, _argv: *const *const u8) {
51 stack_overflow::init();
54 // SAFETY: must be called only once during runtime cleanup.
55 // NOTE: this is not guaranteed to run, for example when the program aborts.
56 pub unsafe fn cleanup() {
60 pub fn decode_error_kind(errno: i32) -> ErrorKind {
63 match errno as c::DWORD {
64 c::ERROR_ACCESS_DENIED => return PermissionDenied,
65 c::ERROR_ALREADY_EXISTS => return AlreadyExists,
66 c::ERROR_FILE_EXISTS => return AlreadyExists,
67 c::ERROR_BROKEN_PIPE => return BrokenPipe,
68 c::ERROR_FILE_NOT_FOUND => return NotFound,
69 c::ERROR_PATH_NOT_FOUND => return NotFound,
70 c::ERROR_NO_DATA => return BrokenPipe,
71 c::ERROR_INVALID_NAME => return InvalidFilename,
72 c::ERROR_INVALID_PARAMETER => return InvalidInput,
73 c::ERROR_NOT_ENOUGH_MEMORY | c::ERROR_OUTOFMEMORY => return OutOfMemory,
76 | c::ERROR_DRIVER_CANCEL_TIMEOUT
77 | c::ERROR_OPERATION_ABORTED
78 | c::ERROR_SERVICE_REQUEST_TIMEOUT
79 | c::ERROR_COUNTER_TIMEOUT
81 | c::ERROR_RESOURCE_CALL_TIMED_OUT
82 | c::ERROR_CTX_MODEM_RESPONSE_TIMEOUT
83 | c::ERROR_CTX_CLIENT_QUERY_TIMEOUT
84 | c::FRS_ERR_SYSVOL_POPULATE_TIMEOUT
85 | c::ERROR_DS_TIMELIMIT_EXCEEDED
86 | c::DNS_ERROR_RECORD_TIMED_OUT
87 | c::ERROR_IPSEC_IKE_TIMED_OUT
88 | c::ERROR_RUNLEVEL_SWITCH_TIMEOUT
89 | c::ERROR_RUNLEVEL_SWITCH_AGENT_TIMEOUT => return TimedOut,
90 c::ERROR_CALL_NOT_IMPLEMENTED => return Unsupported,
91 c::ERROR_HOST_UNREACHABLE => return HostUnreachable,
92 c::ERROR_NETWORK_UNREACHABLE => return NetworkUnreachable,
93 c::ERROR_DIRECTORY => return NotADirectory,
94 c::ERROR_DIRECTORY_NOT_SUPPORTED => return IsADirectory,
95 c::ERROR_DIR_NOT_EMPTY => return DirectoryNotEmpty,
96 c::ERROR_WRITE_PROTECT => return ReadOnlyFilesystem,
97 c::ERROR_DISK_FULL | c::ERROR_HANDLE_DISK_FULL => return StorageFull,
98 c::ERROR_SEEK_ON_DEVICE => return NotSeekable,
99 c::ERROR_DISK_QUOTA_EXCEEDED => return FilesystemQuotaExceeded,
100 c::ERROR_FILE_TOO_LARGE => return FileTooLarge,
101 c::ERROR_BUSY => return ResourceBusy,
102 c::ERROR_POSSIBLE_DEADLOCK => return Deadlock,
103 c::ERROR_NOT_SAME_DEVICE => return CrossesDevices,
104 c::ERROR_TOO_MANY_LINKS => return TooManyLinks,
105 c::ERROR_FILENAME_EXCED_RANGE => return InvalidFilename,
110 c::WSAEACCES => PermissionDenied,
111 c::WSAEADDRINUSE => AddrInUse,
112 c::WSAEADDRNOTAVAIL => AddrNotAvailable,
113 c::WSAECONNABORTED => ConnectionAborted,
114 c::WSAECONNREFUSED => ConnectionRefused,
115 c::WSAECONNRESET => ConnectionReset,
116 c::WSAEINVAL => InvalidInput,
117 c::WSAENOTCONN => NotConnected,
118 c::WSAEWOULDBLOCK => WouldBlock,
119 c::WSAETIMEDOUT => TimedOut,
120 c::WSAEHOSTUNREACH => HostUnreachable,
121 c::WSAENETDOWN => NetworkDown,
122 c::WSAENETUNREACH => NetworkUnreachable,
128 pub fn unrolled_find_u16s(needle: u16, haystack: &[u16]) -> Option<usize> {
129 let ptr = haystack.as_ptr();
130 let mut start = &haystack[..];
132 // For performance reasons unfold the loop eight times.
133 while start.len() >= 8 {
134 macro_rules! if_return {
135 ($($n:literal,)+) => {
137 if start[$n] == needle {
138 return Some(((&start[$n] as *const u16).addr() - ptr.addr()) / 2);
144 if_return!(0, 1, 2, 3, 4, 5, 6, 7,);
151 return Some(((c as *const u16).addr() - ptr.addr()) / 2);
157 pub fn to_u16s<S: AsRef<OsStr>>(s: S) -> crate::io::Result<Vec<u16>> {
158 fn inner(s: &OsStr) -> crate::io::Result<Vec<u16>> {
159 // Most paths are ASCII, so reserve capacity for as much as there are bytes
160 // in the OsStr plus one for the null-terminating character. We are not
161 // wasting bytes here as paths created by this function are primarily used
162 // in an ephemeral fashion.
163 let mut maybe_result = Vec::with_capacity(s.len() + 1);
164 maybe_result.extend(s.encode_wide());
166 if unrolled_find_u16s(0, &maybe_result).is_some() {
167 return Err(crate::io::const_io_error!(
168 ErrorKind::InvalidInput,
169 "strings passed to WinAPI cannot contain NULs",
172 maybe_result.push(0);
178 // Many Windows APIs follow a pattern of where we hand a buffer and then they
179 // will report back to us how large the buffer should be or how many bytes
180 // currently reside in the buffer. This function is an abstraction over these
181 // functions by making them easier to call.
183 // The first callback, `f1`, is yielded a (pointer, len) pair which can be
184 // passed to a syscall. The `ptr` is valid for `len` items (u16 in this case).
185 // The closure is expected to return what the syscall returns which will be
186 // interpreted by this function to determine if the syscall needs to be invoked
187 // again (with more buffer space).
189 // Once the syscall has completed (errors bail out early) the second closure is
190 // yielded the data which has been read from the syscall. The return value
191 // from this closure is then the return value of the function.
192 fn fill_utf16_buf<F1, F2, T>(mut f1: F1, f2: F2) -> crate::io::Result<T>
194 F1: FnMut(*mut u16, c::DWORD) -> c::DWORD,
195 F2: FnOnce(&[u16]) -> T,
197 // Start off with a stack buf but then spill over to the heap if we end up
198 // needing more space.
200 // This initial size also works around `GetFullPathNameW` returning
201 // incorrect size hints for some short paths:
202 // https://github.com/dylni/normpath/issues/5
203 let mut stack_buf = [0u16; 512];
204 let mut heap_buf = Vec::new();
206 let mut n = stack_buf.len();
208 let buf = if n <= stack_buf.len() {
211 let extra = n - heap_buf.len();
212 heap_buf.reserve(extra);
217 // This function is typically called on windows API functions which
218 // will return the correct length of the string, but these functions
219 // also return the `0` on error. In some cases, however, the
220 // returned "correct length" may actually be 0!
222 // To handle this case we call `SetLastError` to reset it to 0 and
223 // then check it again if we get the "0 error value". If the "last
224 // error" is still 0 then we interpret it as a 0 length buffer and
225 // not an actual error.
227 let k = match f1(buf.as_mut_ptr(), n as c::DWORD) {
228 0 if c::GetLastError() == 0 => 0,
229 0 => return Err(crate::io::Error::last_os_error()),
232 if k == n && c::GetLastError() == c::ERROR_INSUFFICIENT_BUFFER {
237 // It is impossible to reach this point.
238 // On success, k is the returned string length excluding the null.
239 // On failure, k is the required buffer length including the null.
240 // Therefore k never equals n.
243 return Ok(f2(&buf[..k]));
249 fn os2path(s: &[u16]) -> PathBuf {
250 PathBuf::from(OsString::from_wide(s))
253 pub fn truncate_utf16_at_nul(v: &[u16]) -> &[u16] {
254 match unrolled_find_u16s(0, v) {
255 // don't include the 0
262 fn is_zero(&self) -> bool;
265 macro_rules! impl_is_zero {
266 ($($t:ident)*) => ($(impl IsZero for $t {
267 fn is_zero(&self) -> bool {
273 impl_is_zero! { i8 i16 i32 i64 isize u8 u16 u32 u64 usize }
275 pub fn cvt<I: IsZero>(i: I) -> crate::io::Result<I> {
276 if i.is_zero() { Err(crate::io::Error::last_os_error()) } else { Ok(i) }
279 pub fn dur2timeout(dur: Duration) -> c::DWORD {
280 // Note that a duration is a (u64, u32) (seconds, nanoseconds) pair, and the
281 // timeouts in windows APIs are typically u32 milliseconds. To translate, we
282 // have two pieces to take care of:
284 // * Nanosecond precision is rounded up
285 // * Greater than u32::MAX milliseconds (50 days) is rounded up to INFINITE
289 .and_then(|ms| ms.checked_add((dur.subsec_nanos() as u64) / 1_000_000))
290 .and_then(|ms| ms.checked_add(if dur.subsec_nanos() % 1_000_000 > 0 { 1 } else { 0 }))
291 .map(|ms| if ms > <c::DWORD>::MAX as u64 { c::INFINITE } else { ms as c::DWORD })
292 .unwrap_or(c::INFINITE)
295 /// Use `__fastfail` to abort the process
297 /// This is the same implementation as in libpanic_abort's `__rust_start_panic`. See
298 /// that function for more information on `__fastfail`
299 #[allow(unreachable_code)]
300 pub fn abort_internal() -> ! {
302 const FAST_FAIL_FATAL_APP_EXIT: usize = 7;
303 #[cfg(not(miri))] // inline assembly does not work in Miri
306 if #[cfg(any(target_arch = "x86", target_arch = "x86_64"))] {
307 core::arch::asm!("int $$0x29", in("ecx") FAST_FAIL_FATAL_APP_EXIT);
308 crate::intrinsics::unreachable();
309 } else if #[cfg(all(target_arch = "arm", target_feature = "thumb-mode"))] {
310 core::arch::asm!(".inst 0xDEFB", in("r0") FAST_FAIL_FATAL_APP_EXIT);
311 crate::intrinsics::unreachable();
312 } else if #[cfg(target_arch = "aarch64")] {
313 core::arch::asm!("brk 0xF003", in("x0") FAST_FAIL_FATAL_APP_EXIT);
314 crate::intrinsics::unreachable();
318 crate::intrinsics::abort();