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;
8 use crate::time::Duration;
10 pub use self::rand::hashmap_random_keys;
37 pub mod thread_local_dtor;
38 pub mod thread_local_key;
41 if #[cfg(not(target_vendor = "uwp"))] {
43 pub mod stack_overflow;
46 pub mod stack_overflow_uwp;
47 pub use self::stdio_uwp as stdio;
48 pub use self::stack_overflow_uwp as stack_overflow;
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,
67 | c::ERROR_DRIVER_CANCEL_TIMEOUT
68 | c::ERROR_OPERATION_ABORTED
69 | c::ERROR_SERVICE_REQUEST_TIMEOUT
70 | c::ERROR_COUNTER_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,
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,
96 _ => ErrorKind::Other,
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[..];
105 // For performance reasons unfold the loop eight times.
107 if start[0] == needle {
108 return Some((start.as_ptr() as usize - ptr as usize) / 2);
110 if start[1] == needle {
111 return Some((start[1..].as_ptr() as usize - ptr as usize) / 2);
113 if start[2] == needle {
114 return Some((start[2..].as_ptr() as usize - ptr as usize) / 2);
116 if start[3] == needle {
117 return Some((start[3..].as_ptr() as usize - ptr as usize) / 2);
119 if start[4] == needle {
120 return Some((start[4..].as_ptr() as usize - ptr as usize) / 2);
122 if start[5] == needle {
123 return Some((start[5..].as_ptr() as usize - ptr as usize) / 2);
125 if start[6] == needle {
126 return Some((start[6..].as_ptr() as usize - ptr as usize) / 2);
128 if start[7] == needle {
129 return Some((start[7..].as_ptr() as usize - ptr as usize) / 2);
136 for (i, c) in start.iter().enumerate() {
138 return Some((start.as_ptr() as usize - ptr as usize) / 2 + i);
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",
153 maybe_result.push(0);
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.
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).
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>
175 F1: FnMut(*mut u16, c::DWORD) -> c::DWORD,
176 F2: FnOnce(&[u16]) -> T,
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();
183 let mut n = stack_buf.len();
185 let buf = if n <= stack_buf.len() {
188 let extra = n - heap_buf.len();
189 heap_buf.reserve(extra);
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!
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.
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()),
209 if k == n && c::GetLastError() == c::ERROR_INSUFFICIENT_BUFFER {
214 return Ok(f2(&buf[..k]));
220 fn os2path(s: &[u16]) -> PathBuf {
221 PathBuf::from(OsString::from_wide(s))
224 #[allow(dead_code)] // Only used in backtrace::gnu::get_executable_filename()
225 fn wide_char_to_multi_byte(
229 no_default_char: bool,
230 ) -> crate::io::Result<Vec<i8>> {
232 let mut size = c::WideCharToMultiByte(
243 return Err(crate::io::Error::last_os_error());
246 let mut buf = Vec::with_capacity(size as usize);
247 buf.set_len(size as usize);
249 let mut used_default_char = c::FALSE;
250 size = c::WideCharToMultiByte(
258 if no_default_char { &mut used_default_char } else { ptr::null_mut() },
261 return Err(crate::io::Error::last_os_error());
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",
270 buf.set_len(size as usize);
276 pub fn truncate_utf16_at_nul(v: &[u16]) -> &[u16] {
277 match unrolled_find_u16s(0, v) {
278 // don't include the 0
285 fn is_zero(&self) -> bool;
288 macro_rules! impl_is_zero {
289 ($($t:ident)*) => ($(impl IsZero for $t {
290 fn is_zero(&self) -> bool {
296 impl_is_zero! { i8 i16 i32 i64 isize u8 u16 u32 u64 usize }
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) }
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:
307 // * Nanosecond precision is rounded up
308 // * Greater than u32::MAX milliseconds (50 days) is rounded up to INFINITE
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)
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
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"))]
330 llvm_asm!("int $$0x29" :: "{ecx}"(7) ::: volatile); // 7 is FAST_FAIL_FATAL_APP_EXIT
331 crate::intrinsics::unreachable();
333 crate::intrinsics::abort();