src/libstd/sys/windows/mod.rs

   1 #![allow(missing_docs, nonstandard_style)]
   2
   3 use crate::ptr;
   4 use crate::ffi::{OsStr, OsString};
   5 use crate::io::ErrorKind;
   6 use crate::os::windows::ffi::{OsStrExt, OsStringExt};
   7 use crate::path::PathBuf;
   8 use crate::time::Duration;
   9
  10 pub use libc::strlen;
  11 pub use self::rand::hashmap_random_keys;
  12
  13 #[macro_use] 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 ext;
  22 pub mod fast_thread_local;
  23 pub mod fs;
  24 pub mod handle;
  25 pub mod io;
  26 pub mod memchr;
  27 pub mod mutex;
  28 pub mod net;
  29 pub mod os;
  30 pub mod os_str;
  31 pub mod path;
  32 pub mod pipe;
  33 pub mod process;
  34 pub mod rand;
  35 pub mod rwlock;
  36 pub mod stack_overflow;
  37 pub mod thread;
  38 pub mod thread_local;
  39 pub mod time;
  40 pub mod stdio;
  41
  42 #[cfg(not(test))]
  43 pub fn init() {
  44 }
  45
  46 pub fn decode_error_kind(errno: i32) -> ErrorKind {
  47     match errno as c::DWORD {
  48         c::ERROR_ACCESS_DENIED => return ErrorKind::PermissionDenied,
  49         c::ERROR_ALREADY_EXISTS => return ErrorKind::AlreadyExists,
  50         c::ERROR_FILE_EXISTS => return ErrorKind::AlreadyExists,
  51         c::ERROR_BROKEN_PIPE => return ErrorKind::BrokenPipe,
  52         c::ERROR_FILE_NOT_FOUND => return ErrorKind::NotFound,
  53         c::ERROR_PATH_NOT_FOUND => return ErrorKind::NotFound,
  54         c::ERROR_NO_DATA => return ErrorKind::BrokenPipe,
  55         c::ERROR_OPERATION_ABORTED => return ErrorKind::TimedOut,
  56         _ => {}
  57     }
  58
  59     match errno {
  60         c::WSAEACCES => ErrorKind::PermissionDenied,
  61         c::WSAEADDRINUSE => ErrorKind::AddrInUse,
  62         c::WSAEADDRNOTAVAIL => ErrorKind::AddrNotAvailable,
  63         c::WSAECONNABORTED => ErrorKind::ConnectionAborted,
  64         c::WSAECONNREFUSED => ErrorKind::ConnectionRefused,
  65         c::WSAECONNRESET => ErrorKind::ConnectionReset,
  66         c::WSAEINVAL => ErrorKind::InvalidInput,
  67         c::WSAENOTCONN => ErrorKind::NotConnected,
  68         c::WSAEWOULDBLOCK => ErrorKind::WouldBlock,
  69         c::WSAETIMEDOUT => ErrorKind::TimedOut,
  70
  71         _ => ErrorKind::Other,
  72     }
  73 }
  74
  75 pub fn to_u16s<S: AsRef<OsStr>>(s: S) -> crate::io::Result<Vec<u16>> {
  76     fn inner(s: &OsStr) -> crate::io::Result<Vec<u16>> {
  77         let mut maybe_result: Vec<u16> = s.encode_wide().collect();
  78         if maybe_result.iter().any(|&u| u == 0) {
  79             return Err(crate::io::Error::new(ErrorKind::InvalidInput,
  80                                         "strings passed to WinAPI cannot contain NULs"));
  81         }
  82         maybe_result.push(0);
  83         Ok(maybe_result)
  84     }
  85     inner(s.as_ref())
  86 }
  87
  88 // Many Windows APIs follow a pattern of where we hand a buffer and then they
  89 // will report back to us how large the buffer should be or how many bytes
  90 // currently reside in the buffer. This function is an abstraction over these
  91 // functions by making them easier to call.
  92 //
  93 // The first callback, `f1`, is yielded a (pointer, len) pair which can be
  94 // passed to a syscall. The `ptr` is valid for `len` items (u16 in this case).
  95 // The closure is expected to return what the syscall returns which will be
  96 // interpreted by this function to determine if the syscall needs to be invoked
  97 // again (with more buffer space).
  98 //
  99 // Once the syscall has completed (errors bail out early) the second closure is
 100 // yielded the data which has been read from the syscall. The return value
 101 // from this closure is then the return value of the function.
 102 fn fill_utf16_buf<F1, F2, T>(mut f1: F1, f2: F2) -> crate::io::Result<T>
 103     where F1: FnMut(*mut u16, c::DWORD) -> c::DWORD,
 104           F2: FnOnce(&[u16]) -> T
 105 {
 106     // Start off with a stack buf but then spill over to the heap if we end up
 107     // needing more space.
 108     let mut stack_buf = [0u16; 512];
 109     let mut heap_buf = Vec::new();
 110     unsafe {
 111         let mut n = stack_buf.len();
 112         loop {
 113             let buf = if n <= stack_buf.len() {
 114                 &mut stack_buf[..]
 115             } else {
 116                 let extra = n - heap_buf.len();
 117                 heap_buf.reserve(extra);
 118                 heap_buf.set_len(n);
 119                 &mut heap_buf[..]
 120             };
 121
 122             // This function is typically called on windows API functions which
 123             // will return the correct length of the string, but these functions
 124             // also return the `0` on error. In some cases, however, the
 125             // returned "correct length" may actually be 0!
 126             //
 127             // To handle this case we call `SetLastError` to reset it to 0 and
 128             // then check it again if we get the "0 error value". If the "last
 129             // error" is still 0 then we interpret it as a 0 length buffer and
 130             // not an actual error.
 131             c::SetLastError(0);
 132             let k = match f1(buf.as_mut_ptr(), n as c::DWORD) {
 133                 0 if c::GetLastError() == 0 => 0,
 134                 0 => return Err(crate::io::Error::last_os_error()),
 135                 n => n,
 136             } as usize;
 137             if k == n && c::GetLastError() == c::ERROR_INSUFFICIENT_BUFFER {
 138                 n *= 2;
 139             } else if k >= n {
 140                 n = k;
 141             } else {
 142                 return Ok(f2(&buf[..k]))
 143             }
 144         }
 145     }
 146 }
 147
 148 fn os2path(s: &[u16]) -> PathBuf {
 149     PathBuf::from(OsString::from_wide(s))
 150 }
 151
 152 #[allow(dead_code)] // Only used in backtrace::gnu::get_executable_filename()
 153 fn wide_char_to_multi_byte(code_page: u32,
 154                            flags: u32,
 155                            s: &[u16],
 156                            no_default_char: bool)
 157                            -> crate::io::Result<Vec<i8>> {
 158     unsafe {
 159         let mut size = c::WideCharToMultiByte(code_page,
 160                                               flags,
 161                                               s.as_ptr(),
 162                                               s.len() as i32,
 163                                               ptr::null_mut(),
 164                                               0,
 165                                               ptr::null(),
 166                                               ptr::null_mut());
 167         if size == 0 {
 168             return Err(crate::io::Error::last_os_error());
 169         }
 170
 171         let mut buf = Vec::with_capacity(size as usize);
 172         buf.set_len(size as usize);
 173
 174         let mut used_default_char = c::FALSE;
 175         size = c::WideCharToMultiByte(code_page,
 176                                       flags,
 177                                       s.as_ptr(),
 178                                       s.len() as i32,
 179                                       buf.as_mut_ptr(),
 180                                       buf.len() as i32,
 181                                       ptr::null(),
 182                                       if no_default_char { &mut used_default_char }
 183                                       else { ptr::null_mut() });
 184         if size == 0 {
 185             return Err(crate::io::Error::last_os_error());
 186         }
 187         if no_default_char && used_default_char == c::TRUE {
 188             return Err(crate::io::Error::new(crate::io::ErrorKind::InvalidData,
 189                                       "string cannot be converted to requested code page"));
 190         }
 191
 192         buf.set_len(size as usize);
 193
 194         Ok(buf)
 195     }
 196 }
 197
 198 pub fn truncate_utf16_at_nul<'a>(v: &'a [u16]) -> &'a [u16] {
 199     match v.iter().position(|c| *c == 0) {
 200         // don't include the 0
 201         Some(i) => &v[..i],
 202         None => v
 203     }
 204 }
 205
 206 pub trait IsZero {
 207     fn is_zero(&self) -> bool;
 208 }
 209
 210 macro_rules! impl_is_zero {
 211     ($($t:ident)*) => ($(impl IsZero for $t {
 212         fn is_zero(&self) -> bool {
 213             *self == 0
 214         }
 215     })*)
 216 }
 217
 218 impl_is_zero! { i8 i16 i32 i64 isize u8 u16 u32 u64 usize }
 219
 220 pub fn cvt<I: IsZero>(i: I) -> crate::io::Result<I> {
 221     if i.is_zero() {
 222         Err(crate::io::Error::last_os_error())
 223     } else {
 224         Ok(i)
 225     }
 226 }
 227
 228 pub fn dur2timeout(dur: Duration) -> c::DWORD {
 229     // Note that a duration is a (u64, u32) (seconds, nanoseconds) pair, and the
 230     // timeouts in windows APIs are typically u32 milliseconds. To translate, we
 231     // have two pieces to take care of:
 232     //
 233     // * Nanosecond precision is rounded up
 234     // * Greater than u32::MAX milliseconds (50 days) is rounded up to INFINITE
 235     //   (never time out).
 236     dur.as_secs().checked_mul(1000).and_then(|ms| {
 237         ms.checked_add((dur.subsec_nanos() as u64) / 1_000_000)
 238     }).and_then(|ms| {
 239         ms.checked_add(if dur.subsec_nanos() % 1_000_000 > 0 {1} else {0})
 240     }).map(|ms| {
 241         if ms > <c::DWORD>::max_value() as u64 {
 242             c::INFINITE
 243         } else {
 244             ms as c::DWORD
 245         }
 246     }).unwrap_or(c::INFINITE)
 247 }
 248
 249 // On Windows, use the processor-specific __fastfail mechanism.  In Windows 8
 250 // and later, this will terminate the process immediately without running any
 251 // in-process exception handlers.  In earlier versions of Windows, this
 252 // sequence of instructions will be treated as an access violation,
 253 // terminating the process but without necessarily bypassing all exception
 254 // handlers.
 255 //
 256 // https://msdn.microsoft.com/en-us/library/dn774154.aspx
 257 #[allow(unreachable_code)]
 258 pub unsafe fn abort_internal() -> ! {
 259     #[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
 260     {
 261         asm!("int $$0x29" :: "{ecx}"(7) ::: volatile); // 7 is FAST_FAIL_FATAL_APP_EXIT
 262         crate::intrinsics::unreachable();
 263     }
 264     crate::intrinsics::abort();
 265 }