src/shims/os_str.rs

   1 use std::borrow::Cow;
   2 use std::convert::TryFrom;
   3 use std::ffi::{OsStr, OsString};
   4 use std::iter;
   5 use std::path::{Path, PathBuf};
   6
   7 #[cfg(unix)]
   8 use std::os::unix::ffi::{OsStrExt, OsStringExt};
   9 #[cfg(windows)]
  10 use std::os::windows::ffi::{OsStrExt, OsStringExt};
  11
  12 use rustc_middle::ty::layout::LayoutOf;
  13 use rustc_target::abi::{Align, Size};
  14
  15 use crate::*;
  16
  17 /// Represent how path separator conversion should be done.
  18 pub enum PathConversion {
  19     HostToTarget,
  20     TargetToHost,
  21 }
  22
  23 #[cfg(unix)]
  24 pub fn os_str_to_bytes<'a, 'tcx>(os_str: &'a OsStr) -> InterpResult<'tcx, &'a [u8]> {
  25     Ok(os_str.as_bytes())
  26 }
  27
  28 #[cfg(not(unix))]
  29 pub fn os_str_to_bytes<'a, 'tcx>(os_str: &'a OsStr) -> InterpResult<'tcx, &'a [u8]> {
  30     // On non-unix platforms the best we can do to transform bytes from/to OS strings is to do the
  31     // intermediate transformation into strings. Which invalidates non-utf8 paths that are actually
  32     // valid.
  33     os_str
  34         .to_str()
  35         .map(|s| s.as_bytes())
  36         .ok_or_else(|| err_unsup_format!("{:?} is not a valid utf-8 string", os_str).into())
  37 }
  38
  39 #[cfg(unix)]
  40 pub fn bytes_to_os_str<'a, 'tcx>(bytes: &'a [u8]) -> InterpResult<'tcx, &'a OsStr> {
  41     Ok(OsStr::from_bytes(bytes))
  42 }
  43 #[cfg(not(unix))]
  44 pub fn bytes_to_os_str<'a, 'tcx>(bytes: &'a [u8]) -> InterpResult<'tcx, &'a OsStr> {
  45     let s = std::str::from_utf8(bytes)
  46         .map_err(|_| err_unsup_format!("{:?} is not a valid utf-8 string", bytes))?;
  47     Ok(OsStr::new(s))
  48 }
  49
  50 impl<'mir, 'tcx: 'mir> EvalContextExt<'mir, 'tcx> for crate::MiriEvalContext<'mir, 'tcx> {}
  51 pub trait EvalContextExt<'mir, 'tcx: 'mir>: crate::MiriEvalContextExt<'mir, 'tcx> {
  52     /// Helper function to read an OsString from a null-terminated sequence of bytes, which is what
  53     /// the Unix APIs usually handle.
  54     fn read_os_str_from_c_str<'a>(
  55         &'a self,
  56         ptr: Pointer<Option<Tag>>,
  57     ) -> InterpResult<'tcx, &'a OsStr>
  58     where
  59         'tcx: 'a,
  60         'mir: 'a,
  61     {
  62         let this = self.eval_context_ref();
  63         let bytes = this.read_c_str(ptr)?;
  64         bytes_to_os_str(bytes)
  65     }
  66
  67     /// Helper function to read an OsString from a 0x0000-terminated sequence of u16,
  68     /// which is what the Windows APIs usually handle.
  69     fn read_os_str_from_wide_str<'a>(
  70         &'a self,
  71         ptr: Pointer<Option<Tag>>,
  72     ) -> InterpResult<'tcx, OsString>
  73     where
  74         'tcx: 'a,
  75         'mir: 'a,
  76     {
  77         #[cfg(windows)]
  78         pub fn u16vec_to_osstring<'tcx, 'a>(u16_vec: Vec<u16>) -> InterpResult<'tcx, OsString> {
  79             Ok(OsString::from_wide(&u16_vec[..]))
  80         }
  81         #[cfg(not(windows))]
  82         pub fn u16vec_to_osstring<'tcx, 'a>(u16_vec: Vec<u16>) -> InterpResult<'tcx, OsString> {
  83             let s = String::from_utf16(&u16_vec[..])
  84                 .map_err(|_| err_unsup_format!("{:?} is not a valid utf-16 string", u16_vec))?;
  85             Ok(s.into())
  86         }
  87
  88         let u16_vec = self.eval_context_ref().read_wide_str(ptr)?;
  89         u16vec_to_osstring(u16_vec)
  90     }
  91
  92     /// Helper function to write an OsStr as a null-terminated sequence of bytes, which is what
  93     /// the Unix APIs usually handle. This function returns `Ok((false, length))` without trying
  94     /// to write if `size` is not large enough to fit the contents of `os_string` plus a null
  95     /// terminator. It returns `Ok((true, length))` if the writing process was successful. The
  96     /// string length returned does not include the null terminator.
  97     fn write_os_str_to_c_str(
  98         &mut self,
  99         os_str: &OsStr,
 100         ptr: Pointer<Option<Tag>>,
 101         size: u64,
 102     ) -> InterpResult<'tcx, (bool, u64)> {
 103         let bytes = os_str_to_bytes(os_str)?;
 104         // If `size` is smaller or equal than `bytes.len()`, writing `bytes` plus the required null
 105         // terminator to memory using the `ptr` pointer would cause an out-of-bounds access.
 106         let string_length = u64::try_from(bytes.len()).unwrap();
 107         if size <= string_length {
 108             return Ok((false, string_length));
 109         }
 110         self.eval_context_mut()
 111             .write_bytes_ptr(ptr, bytes.iter().copied().chain(iter::once(0u8)))?;
 112         Ok((true, string_length))
 113     }
 114
 115     /// Helper function to write an OsStr as a 0x0000-terminated u16-sequence, which is what
 116     /// the Windows APIs usually handle. This function returns `Ok((false, length))` without trying
 117     /// to write if `size` is not large enough to fit the contents of `os_string` plus a null
 118     /// terminator. It returns `Ok((true, length))` if the writing process was successful. The
 119     /// string length returned does not include the null terminator.
 120     fn write_os_str_to_wide_str(
 121         &mut self,
 122         os_str: &OsStr,
 123         ptr: Pointer<Option<Tag>>,
 124         size: u64,
 125     ) -> InterpResult<'tcx, (bool, u64)> {
 126         #[cfg(windows)]
 127         fn os_str_to_u16vec<'tcx>(os_str: &OsStr) -> InterpResult<'tcx, Vec<u16>> {
 128             Ok(os_str.encode_wide().collect())
 129         }
 130         #[cfg(not(windows))]
 131         fn os_str_to_u16vec<'tcx>(os_str: &OsStr) -> InterpResult<'tcx, Vec<u16>> {
 132             // On non-Windows platforms the best we can do to transform Vec<u16> from/to OS strings is to do the
 133             // intermediate transformation into strings. Which invalidates non-utf8 paths that are actually
 134             // valid.
 135             os_str
 136                 .to_str()
 137                 .map(|s| s.encode_utf16().collect())
 138                 .ok_or_else(|| err_unsup_format!("{:?} is not a valid utf-8 string", os_str).into())
 139         }
 140
 141         let u16_vec = os_str_to_u16vec(os_str)?;
 142         // If `size` is smaller or equal than `bytes.len()`, writing `bytes` plus the required
 143         // 0x0000 terminator to memory would cause an out-of-bounds access.
 144         let string_length = u64::try_from(u16_vec.len()).unwrap();
 145         let string_length = string_length.checked_add(1).unwrap();
 146         if size < string_length {
 147             return Ok((false, string_length));
 148         }
 149
 150         // Store the UTF-16 string.
 151         let size2 = Size::from_bytes(2);
 152         let this = self.eval_context_mut();
 153         let mut alloc = this
 154             .get_ptr_alloc_mut(ptr, size2 * string_length, Align::from_bytes(2).unwrap())?
 155             .unwrap(); // not a ZST, so we will get a result
 156         for (offset, wchar) in u16_vec.into_iter().chain(iter::once(0x0000)).enumerate() {
 157             let offset = u64::try_from(offset).unwrap();
 158             alloc
 159                 .write_scalar(alloc_range(size2 * offset, size2), Scalar::from_u16(wchar).into())?;
 160         }
 161         Ok((true, string_length - 1))
 162     }
 163
 164     /// Allocate enough memory to store the given `OsStr` as a null-terminated sequence of bytes.
 165     fn alloc_os_str_as_c_str(
 166         &mut self,
 167         os_str: &OsStr,
 168         memkind: MemoryKind<MiriMemoryKind>,
 169     ) -> InterpResult<'tcx, Pointer<Option<Tag>>> {
 170         let size = u64::try_from(os_str.len()).unwrap().checked_add(1).unwrap(); // Make space for `0` terminator.
 171         let this = self.eval_context_mut();
 172
 173         let arg_type = this.tcx.mk_array(this.tcx.types.u8, size);
 174         let arg_place = this.allocate(this.layout_of(arg_type).unwrap(), memkind)?;
 175         assert!(self.write_os_str_to_c_str(os_str, arg_place.ptr, size).unwrap().0);
 176         Ok(arg_place.ptr)
 177     }
 178
 179     /// Allocate enough memory to store the given `OsStr` as a null-terminated sequence of `u16`.
 180     fn alloc_os_str_as_wide_str(
 181         &mut self,
 182         os_str: &OsStr,
 183         memkind: MemoryKind<MiriMemoryKind>,
 184     ) -> InterpResult<'tcx, Pointer<Option<Tag>>> {
 185         let size = u64::try_from(os_str.len()).unwrap().checked_add(1).unwrap(); // Make space for `0x0000` terminator.
 186         let this = self.eval_context_mut();
 187
 188         let arg_type = this.tcx.mk_array(this.tcx.types.u16, size);
 189         let arg_place = this.allocate(this.layout_of(arg_type).unwrap(), memkind)?;
 190         assert!(self.write_os_str_to_wide_str(os_str, arg_place.ptr, size).unwrap().0);
 191         Ok(arg_place.ptr)
 192     }
 193
 194     /// Read a null-terminated sequence of bytes, and perform path separator conversion if needed.
 195     fn read_path_from_c_str<'a>(
 196         &'a self,
 197         ptr: Pointer<Option<Tag>>,
 198     ) -> InterpResult<'tcx, Cow<'a, Path>>
 199     where
 200         'tcx: 'a,
 201         'mir: 'a,
 202     {
 203         let this = self.eval_context_ref();
 204         let os_str = this.read_os_str_from_c_str(ptr)?;
 205
 206         Ok(match this.convert_path_separator(Cow::Borrowed(os_str), PathConversion::TargetToHost) {
 207             Cow::Borrowed(x) => Cow::Borrowed(Path::new(x)),
 208             Cow::Owned(y) => Cow::Owned(PathBuf::from(y)),
 209         })
 210     }
 211
 212     /// Read a null-terminated sequence of `u16`s, and perform path separator conversion if needed.
 213     fn read_path_from_wide_str(&self, ptr: Pointer<Option<Tag>>) -> InterpResult<'tcx, PathBuf> {
 214         let this = self.eval_context_ref();
 215         let os_str = this.read_os_str_from_wide_str(ptr)?;
 216
 217         Ok(this
 218             .convert_path_separator(Cow::Owned(os_str), PathConversion::TargetToHost)
 219             .into_owned()
 220             .into())
 221     }
 222
 223     /// Write a Path to the machine memory (as a null-terminated sequence of bytes),
 224     /// adjusting path separators if needed.
 225     fn write_path_to_c_str(
 226         &mut self,
 227         path: &Path,
 228         ptr: Pointer<Option<Tag>>,
 229         size: u64,
 230     ) -> InterpResult<'tcx, (bool, u64)> {
 231         let this = self.eval_context_mut();
 232         let os_str = this
 233             .convert_path_separator(Cow::Borrowed(path.as_os_str()), PathConversion::HostToTarget);
 234         this.write_os_str_to_c_str(&os_str, ptr, size)
 235     }
 236
 237     /// Write a Path to the machine memory (as a null-terminated sequence of `u16`s),
 238     /// adjusting path separators if needed.
 239     fn write_path_to_wide_str(
 240         &mut self,
 241         path: &Path,
 242         ptr: Pointer<Option<Tag>>,
 243         size: u64,
 244     ) -> InterpResult<'tcx, (bool, u64)> {
 245         let this = self.eval_context_mut();
 246         let os_str = this
 247             .convert_path_separator(Cow::Borrowed(path.as_os_str()), PathConversion::HostToTarget);
 248         this.write_os_str_to_wide_str(&os_str, ptr, size)
 249     }
 250
 251     fn convert_path_separator<'a>(
 252         &self,
 253         os_str: Cow<'a, OsStr>,
 254         direction: PathConversion,
 255     ) -> Cow<'a, OsStr> {
 256         let this = self.eval_context_ref();
 257         let target_os = &this.tcx.sess.target.os;
 258         #[cfg(windows)]
 259         return if target_os == "windows" {
 260             // Windows-on-Windows, all fine.
 261             os_str
 262         } else {
 263             // Unix target, Windows host.
 264             let (from, to) = match direction {
 265                 PathConversion::HostToTarget => ('\\', '/'),
 266                 PathConversion::TargetToHost => ('/', '\\'),
 267             };
 268             let converted = os_str
 269                 .encode_wide()
 270                 .map(|wchar| if wchar == from as u16 { to as u16 } else { wchar })
 271                 .collect::<Vec<_>>();
 272             Cow::Owned(OsString::from_wide(&converted))
 273         };
 274         #[cfg(unix)]
 275         return if target_os == "windows" {
 276             // Windows target, Unix host.
 277             let (from, to) = match direction {
 278                 PathConversion::HostToTarget => ('/', '\\'),
 279                 PathConversion::TargetToHost => ('\\', '/'),
 280             };
 281             let converted = os_str
 282                 .as_bytes()
 283                 .iter()
 284                 .map(|&wchar| if wchar == from as u8 { to as u8 } else { wchar })
 285                 .collect::<Vec<_>>();
 286             Cow::Owned(OsString::from_vec(converted))
 287         } else {
 288             // Unix-on-Unix, all is fine.
 289             os_str
 290         };
 291     }
 292 }