1 // Copyright 2014 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 #![allow(missing_docs, bad_style)]
15 use ffi::{OsStr, OsString};
16 use io::{self, ErrorKind};
18 use os::windows::ffi::{OsStrExt, OsStringExt};
22 #[macro_use] pub mod compat;
38 pub mod stack_overflow;
46 ::alloc::oom::set_oom_handler(oom_handler);
48 // See comment in sys/unix/mod.rs
49 fn oom_handler() -> ! {
52 let msg = "fatal runtime error: out of memory\n";
54 // WriteFile silently fails if it is passed an invalid handle, so
55 // there is no need to check the result of GetStdHandle.
56 c::WriteFile(c::GetStdHandle(c::STD_ERROR_HANDLE),
57 msg.as_ptr() as c::LPVOID,
58 msg.len() as c::DWORD,
66 pub fn decode_error_kind(errno: i32) -> ErrorKind {
67 match errno as c::DWORD {
68 c::ERROR_ACCESS_DENIED => return ErrorKind::PermissionDenied,
69 c::ERROR_ALREADY_EXISTS => return ErrorKind::AlreadyExists,
70 c::ERROR_BROKEN_PIPE => return ErrorKind::BrokenPipe,
71 c::ERROR_FILE_NOT_FOUND => return ErrorKind::NotFound,
72 c::ERROR_PATH_NOT_FOUND => return ErrorKind::NotFound,
73 c::ERROR_NO_DATA => return ErrorKind::BrokenPipe,
74 c::ERROR_OPERATION_ABORTED => return ErrorKind::TimedOut,
79 c::WSAEACCES => ErrorKind::PermissionDenied,
80 c::WSAEADDRINUSE => ErrorKind::AddrInUse,
81 c::WSAEADDRNOTAVAIL => ErrorKind::AddrNotAvailable,
82 c::WSAECONNABORTED => ErrorKind::ConnectionAborted,
83 c::WSAECONNREFUSED => ErrorKind::ConnectionRefused,
84 c::WSAECONNRESET => ErrorKind::ConnectionReset,
85 c::WSAEINVAL => ErrorKind::InvalidInput,
86 c::WSAENOTCONN => ErrorKind::NotConnected,
87 c::WSAEWOULDBLOCK => ErrorKind::WouldBlock,
88 c::WSAETIMEDOUT => ErrorKind::TimedOut,
90 _ => ErrorKind::Other,
94 pub fn to_u16s<S: AsRef<OsStr>>(s: S) -> io::Result<Vec<u16>> {
95 fn inner(s: &OsStr) -> io::Result<Vec<u16>> {
96 let mut maybe_result: Vec<u16> = s.encode_wide().collect();
97 if maybe_result.iter().any(|&u| u == 0) {
98 return Err(io::Error::new(io::ErrorKind::InvalidInput,
99 "strings passed to WinAPI cannot contain NULs"));
101 maybe_result.push(0);
107 // Many Windows APIs follow a pattern of where we hand a buffer and then they
108 // will report back to us how large the buffer should be or how many bytes
109 // currently reside in the buffer. This function is an abstraction over these
110 // functions by making them easier to call.
112 // The first callback, `f1`, is yielded a (pointer, len) pair which can be
113 // passed to a syscall. The `ptr` is valid for `len` items (u16 in this case).
114 // The closure is expected to return what the syscall returns which will be
115 // interpreted by this function to determine if the syscall needs to be invoked
116 // again (with more buffer space).
118 // Once the syscall has completed (errors bail out early) the second closure is
119 // yielded the data which has been read from the syscall. The return value
120 // from this closure is then the return value of the function.
121 fn fill_utf16_buf<F1, F2, T>(mut f1: F1, f2: F2) -> io::Result<T>
122 where F1: FnMut(*mut u16, c::DWORD) -> c::DWORD,
123 F2: FnOnce(&[u16]) -> T
125 // Start off with a stack buf but then spill over to the heap if we end up
126 // needing more space.
127 let mut stack_buf = [0u16; 512];
128 let mut heap_buf = Vec::new();
130 let mut n = stack_buf.len();
132 let buf = if n <= stack_buf.len() {
135 let extra = n - heap_buf.len();
136 heap_buf.reserve(extra);
141 // This function is typically called on windows API functions which
142 // will return the correct length of the string, but these functions
143 // also return the `0` on error. In some cases, however, the
144 // returned "correct length" may actually be 0!
146 // To handle this case we call `SetLastError` to reset it to 0 and
147 // then check it again if we get the "0 error value". If the "last
148 // error" is still 0 then we interpret it as a 0 length buffer and
149 // not an actual error.
151 let k = match f1(buf.as_mut_ptr(), n as c::DWORD) {
152 0 if c::GetLastError() == 0 => 0,
153 0 => return Err(io::Error::last_os_error()),
156 if k == n && c::GetLastError() == c::ERROR_INSUFFICIENT_BUFFER {
161 return Ok(f2(&buf[..k]))
167 fn os2path(s: &[u16]) -> PathBuf {
168 PathBuf::from(OsString::from_wide(s))
171 pub fn truncate_utf16_at_nul<'a>(v: &'a [u16]) -> &'a [u16] {
172 match v.iter().position(|c| *c == 0) {
173 // don't include the 0
179 fn cvt<I: PartialEq + Zero>(i: I) -> io::Result<I> {
181 Err(io::Error::last_os_error())
187 fn dur2timeout(dur: Duration) -> c::DWORD {
188 // Note that a duration is a (u64, u32) (seconds, nanoseconds) pair, and the
189 // timeouts in windows APIs are typically u32 milliseconds. To translate, we
190 // have two pieces to take care of:
192 // * Nanosecond precision is rounded up
193 // * Greater than u32::MAX milliseconds (50 days) is rounded up to INFINITE
195 dur.as_secs().checked_mul(1000).and_then(|ms| {
196 ms.checked_add((dur.subsec_nanos() as u64) / 1_000_000)
198 ms.checked_add(if dur.subsec_nanos() % 1_000_000 > 0 {1} else {0})
200 if ms > <c::DWORD>::max_value() as u64 {
205 }).unwrap_or(c::INFINITE)