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;
36 pub mod thread_local_dtor;
37 pub mod thread_local_key;
38 pub mod thread_parker;
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;
52 // SAFETY: must be called only once during runtime initialization.
53 // NOTE: this is not guaranteed to run, for example when Rust code is called externally.
54 pub unsafe fn init(_argc: isize, _argv: *const *const u8) {
55 stack_overflow::init();
58 // SAFETY: must be called only once during runtime cleanup.
59 // NOTE: this is not guaranteed to run, for example when the program aborts.
60 pub unsafe fn cleanup() {
64 pub fn decode_error_kind(errno: i32) -> ErrorKind {
65 match errno as c::DWORD {
66 c::ERROR_ACCESS_DENIED => return ErrorKind::PermissionDenied,
67 c::ERROR_ALREADY_EXISTS => return ErrorKind::AlreadyExists,
68 c::ERROR_FILE_EXISTS => return ErrorKind::AlreadyExists,
69 c::ERROR_BROKEN_PIPE => return ErrorKind::BrokenPipe,
70 c::ERROR_FILE_NOT_FOUND => return ErrorKind::NotFound,
71 c::ERROR_PATH_NOT_FOUND => return ErrorKind::NotFound,
72 c::ERROR_NO_DATA => return ErrorKind::BrokenPipe,
73 c::ERROR_INVALID_PARAMETER => return ErrorKind::InvalidInput,
74 c::ERROR_NOT_ENOUGH_MEMORY | c::ERROR_OUTOFMEMORY => return ErrorKind::OutOfMemory,
77 | c::ERROR_DRIVER_CANCEL_TIMEOUT
78 | c::ERROR_OPERATION_ABORTED
79 | c::ERROR_SERVICE_REQUEST_TIMEOUT
80 | c::ERROR_COUNTER_TIMEOUT
82 | c::ERROR_RESOURCE_CALL_TIMED_OUT
83 | c::ERROR_CTX_MODEM_RESPONSE_TIMEOUT
84 | c::ERROR_CTX_CLIENT_QUERY_TIMEOUT
85 | c::FRS_ERR_SYSVOL_POPULATE_TIMEOUT
86 | c::ERROR_DS_TIMELIMIT_EXCEEDED
87 | c::DNS_ERROR_RECORD_TIMED_OUT
88 | c::ERROR_IPSEC_IKE_TIMED_OUT
89 | c::ERROR_RUNLEVEL_SWITCH_TIMEOUT
90 | c::ERROR_RUNLEVEL_SWITCH_AGENT_TIMEOUT => return ErrorKind::TimedOut,
91 c::ERROR_CALL_NOT_IMPLEMENTED => return ErrorKind::Unsupported,
96 c::WSAEACCES => ErrorKind::PermissionDenied,
97 c::WSAEADDRINUSE => ErrorKind::AddrInUse,
98 c::WSAEADDRNOTAVAIL => ErrorKind::AddrNotAvailable,
99 c::WSAECONNABORTED => ErrorKind::ConnectionAborted,
100 c::WSAECONNREFUSED => ErrorKind::ConnectionRefused,
101 c::WSAECONNRESET => ErrorKind::ConnectionReset,
102 c::WSAEINVAL => ErrorKind::InvalidInput,
103 c::WSAENOTCONN => ErrorKind::NotConnected,
104 c::WSAEWOULDBLOCK => ErrorKind::WouldBlock,
105 c::WSAETIMEDOUT => ErrorKind::TimedOut,
107 _ => ErrorKind::Other,
111 pub fn unrolled_find_u16s(needle: u16, haystack: &[u16]) -> Option<usize> {
112 let ptr = haystack.as_ptr();
113 let mut start = &haystack[..];
115 // For performance reasons unfold the loop eight times.
116 while start.len() >= 8 {
117 macro_rules! if_return {
118 ($($n:literal,)+) => {
120 if start[$n] == needle {
121 return Some((&start[$n] as *const u16 as usize - ptr as usize) / 2);
127 if_return!(0, 1, 2, 3, 4, 5, 6, 7,);
134 return Some((c as *const u16 as usize - ptr as usize) / 2);
140 pub fn to_u16s<S: AsRef<OsStr>>(s: S) -> crate::io::Result<Vec<u16>> {
141 fn inner(s: &OsStr) -> crate::io::Result<Vec<u16>> {
142 let mut maybe_result: Vec<u16> = s.encode_wide().collect();
143 if unrolled_find_u16s(0, &maybe_result).is_some() {
144 return Err(crate::io::Error::new_const(
145 ErrorKind::InvalidInput,
146 &"strings passed to WinAPI cannot contain NULs",
149 maybe_result.push(0);
155 // Many Windows APIs follow a pattern of where we hand a buffer and then they
156 // will report back to us how large the buffer should be or how many bytes
157 // currently reside in the buffer. This function is an abstraction over these
158 // functions by making them easier to call.
160 // The first callback, `f1`, is yielded a (pointer, len) pair which can be
161 // passed to a syscall. The `ptr` is valid for `len` items (u16 in this case).
162 // The closure is expected to return what the syscall returns which will be
163 // interpreted by this function to determine if the syscall needs to be invoked
164 // again (with more buffer space).
166 // Once the syscall has completed (errors bail out early) the second closure is
167 // yielded the data which has been read from the syscall. The return value
168 // from this closure is then the return value of the function.
169 fn fill_utf16_buf<F1, F2, T>(mut f1: F1, f2: F2) -> crate::io::Result<T>
171 F1: FnMut(*mut u16, c::DWORD) -> c::DWORD,
172 F2: FnOnce(&[u16]) -> T,
174 // Start off with a stack buf but then spill over to the heap if we end up
175 // needing more space.
176 let mut stack_buf = [0u16; 512];
177 let mut heap_buf = Vec::new();
179 let mut n = stack_buf.len();
181 let buf = if n <= stack_buf.len() {
184 let extra = n - heap_buf.len();
185 heap_buf.reserve(extra);
190 // This function is typically called on windows API functions which
191 // will return the correct length of the string, but these functions
192 // also return the `0` on error. In some cases, however, the
193 // returned "correct length" may actually be 0!
195 // To handle this case we call `SetLastError` to reset it to 0 and
196 // then check it again if we get the "0 error value". If the "last
197 // error" is still 0 then we interpret it as a 0 length buffer and
198 // not an actual error.
200 let k = match f1(buf.as_mut_ptr(), n as c::DWORD) {
201 0 if c::GetLastError() == 0 => 0,
202 0 => return Err(crate::io::Error::last_os_error()),
205 if k == n && c::GetLastError() == c::ERROR_INSUFFICIENT_BUFFER {
210 return Ok(f2(&buf[..k]));
216 fn os2path(s: &[u16]) -> PathBuf {
217 PathBuf::from(OsString::from_wide(s))
220 pub fn truncate_utf16_at_nul(v: &[u16]) -> &[u16] {
221 match unrolled_find_u16s(0, v) {
222 // don't include the 0
229 fn is_zero(&self) -> bool;
232 macro_rules! impl_is_zero {
233 ($($t:ident)*) => ($(impl IsZero for $t {
234 fn is_zero(&self) -> bool {
240 impl_is_zero! { i8 i16 i32 i64 isize u8 u16 u32 u64 usize }
242 pub fn cvt<I: IsZero>(i: I) -> crate::io::Result<I> {
243 if i.is_zero() { Err(crate::io::Error::last_os_error()) } else { Ok(i) }
246 pub fn dur2timeout(dur: Duration) -> c::DWORD {
247 // Note that a duration is a (u64, u32) (seconds, nanoseconds) pair, and the
248 // timeouts in windows APIs are typically u32 milliseconds. To translate, we
249 // have two pieces to take care of:
251 // * Nanosecond precision is rounded up
252 // * Greater than u32::MAX milliseconds (50 days) is rounded up to INFINITE
256 .and_then(|ms| ms.checked_add((dur.subsec_nanos() as u64) / 1_000_000))
257 .and_then(|ms| ms.checked_add(if dur.subsec_nanos() % 1_000_000 > 0 { 1 } else { 0 }))
258 .map(|ms| if ms > <c::DWORD>::MAX as u64 { c::INFINITE } else { ms as c::DWORD })
259 .unwrap_or(c::INFINITE)
262 /// Use `__fastfail` to abort the process
264 /// This is the same implementation as in libpanic_abort's `__rust_start_panic`. See
265 /// that function for more information on `__fastfail`
266 #[allow(unreachable_code)]
267 pub fn abort_internal() -> ! {
268 const FAST_FAIL_FATAL_APP_EXIT: usize = 7;
271 if #[cfg(any(target_arch = "x86", target_arch = "x86_64"))] {
272 asm!("int $$0x29", in("ecx") FAST_FAIL_FATAL_APP_EXIT);
273 crate::intrinsics::unreachable();
274 } else if #[cfg(all(target_arch = "arm", target_feature = "thumb-mode"))] {
275 asm!(".inst 0xDEFB", in("r0") FAST_FAIL_FATAL_APP_EXIT);
276 crate::intrinsics::unreachable();
277 } else if #[cfg(target_arch = "aarch64")] {
278 asm!("brk 0xF003", in("x0") FAST_FAIL_FATAL_APP_EXIT);
279 crate::intrinsics::unreachable();
283 crate::intrinsics::abort();
287 if #[cfg(target_vendor = "uwp")] {
288 #[link(name = "ws2_32")]
289 // For BCryptGenRandom
290 #[link(name = "bcrypt")]
293 #[link(name = "advapi32")]
294 #[link(name = "ws2_32")]
295 #[link(name = "userenv")]