src/shims/fs.rs

   1 use std::collections::HashMap;
   2 use std::convert::{TryFrom, TryInto};
   3 use std::fs::{remove_file, rename, File, OpenOptions};
   4 use std::io::{Read, Seek, SeekFrom, Write};
   5 use std::path::PathBuf;
   6 use std::time::SystemTime;
   7
   8 use rustc::ty::layout::{Align, LayoutOf, Size};
   9
  10 use crate::stacked_borrows::Tag;
  11 use crate::*;
  12 use helpers::immty_from_uint_checked;
  13 use shims::time::system_time_to_duration;
  14
  15 #[derive(Debug)]
  16 pub struct FileHandle {
  17     file: File,
  18     writable: bool,
  19 }
  20
  21 pub struct FileHandler {
  22     handles: HashMap<i32, FileHandle>,
  23     low: i32,
  24 }
  25
  26 impl Default for FileHandler {
  27     fn default() -> Self {
  28         FileHandler {
  29             handles: Default::default(),
  30             // 0, 1 and 2 are reserved for stdin, stdout and stderr.
  31             low: 3,
  32         }
  33     }
  34 }
  35
  36 impl<'mir, 'tcx> EvalContextExt<'mir, 'tcx> for crate::MiriEvalContext<'mir, 'tcx> {}
  37 pub trait EvalContextExt<'mir, 'tcx: 'mir>: crate::MiriEvalContextExt<'mir, 'tcx> {
  38     fn open(
  39         &mut self,
  40         path_op: OpTy<'tcx, Tag>,
  41         flag_op: OpTy<'tcx, Tag>,
  42     ) -> InterpResult<'tcx, i32> {
  43         let this = self.eval_context_mut();
  44
  45         this.check_no_isolation("open")?;
  46
  47         let flag = this.read_scalar(flag_op)?.to_i32()?;
  48
  49         let mut options = OpenOptions::new();
  50
  51         let o_rdonly = this.eval_libc_i32("O_RDONLY")?;
  52         let o_wronly = this.eval_libc_i32("O_WRONLY")?;
  53         let o_rdwr = this.eval_libc_i32("O_RDWR")?;
  54         // The first two bits of the flag correspond to the access mode in linux, macOS and
  55         // windows. We need to check that in fact the access mode flags for the current platform
  56         // only use these two bits, otherwise we are in an unsupported platform and should error.
  57         if (o_rdonly | o_wronly | o_rdwr) & !0b11 != 0 {
  58             throw_unsup_format!("Access mode flags on this platform are unsupported");
  59         }
  60         let mut writable = true;
  61
  62         // Now we check the access mode
  63         let access_mode = flag & 0b11;
  64
  65         if access_mode == o_rdonly {
  66             writable = false;
  67             options.read(true);
  68         } else if access_mode == o_wronly {
  69             options.write(true);
  70         } else if access_mode == o_rdwr {
  71             options.read(true).write(true);
  72         } else {
  73             throw_unsup_format!("Unsupported access mode {:#x}", access_mode);
  74         }
  75         // We need to check that there aren't unsupported options in `flag`. For this we try to
  76         // reproduce the content of `flag` in the `mirror` variable using only the supported
  77         // options.
  78         let mut mirror = access_mode;
  79
  80         let o_append = this.eval_libc_i32("O_APPEND")?;
  81         if flag & o_append != 0 {
  82             options.append(true);
  83             mirror |= o_append;
  84         }
  85         let o_trunc = this.eval_libc_i32("O_TRUNC")?;
  86         if flag & o_trunc != 0 {
  87             options.truncate(true);
  88             mirror |= o_trunc;
  89         }
  90         let o_creat = this.eval_libc_i32("O_CREAT")?;
  91         if flag & o_creat != 0 {
  92             options.create(true);
  93             mirror |= o_creat;
  94         }
  95         let o_cloexec = this.eval_libc_i32("O_CLOEXEC")?;
  96         if flag & o_cloexec != 0 {
  97             // We do not need to do anything for this flag because `std` already sets it.
  98             // (Technically we do not support *not* setting this flag, but we ignore that.)
  99             mirror |= o_cloexec;
 100         }
 101         // If `flag` is not equal to `mirror`, there is an unsupported option enabled in `flag`,
 102         // then we throw an error.
 103         if flag != mirror {
 104             throw_unsup_format!("unsupported flags {:#x}", flag & !mirror);
 105         }
 106
 107         let path = this.read_os_str_from_c_str(this.read_scalar(path_op)?.not_undef()?)?;
 108
 109         let fd = options.open(&path).map(|file| {
 110             let mut fh = &mut this.machine.file_handler;
 111             fh.low += 1;
 112             fh.handles.insert(fh.low, FileHandle { file, writable }).unwrap_none();
 113             fh.low
 114         });
 115
 116         this.try_unwrap_io_result(fd)
 117     }
 118
 119     fn fcntl(
 120         &mut self,
 121         fd_op: OpTy<'tcx, Tag>,
 122         cmd_op: OpTy<'tcx, Tag>,
 123         _arg1_op: Option<OpTy<'tcx, Tag>>,
 124     ) -> InterpResult<'tcx, i32> {
 125         let this = self.eval_context_mut();
 126
 127         this.check_no_isolation("fcntl")?;
 128
 129         let fd = this.read_scalar(fd_op)?.to_i32()?;
 130         let cmd = this.read_scalar(cmd_op)?.to_i32()?;
 131         // We only support getting the flags for a descriptor.
 132         if cmd == this.eval_libc_i32("F_GETFD")? {
 133             // Currently this is the only flag that `F_GETFD` returns. It is OK to just return the
 134             // `FD_CLOEXEC` value without checking if the flag is set for the file because `std`
 135             // always sets this flag when opening a file. However we still need to check that the
 136             // file itself is open.
 137             if this.machine.file_handler.handles.contains_key(&fd) {
 138                 Ok(this.eval_libc_i32("FD_CLOEXEC")?)
 139             } else {
 140                 this.handle_not_found()
 141             }
 142         } else {
 143             throw_unsup_format!("The {:#x} command is not supported for `fcntl`)", cmd);
 144         }
 145     }
 146
 147     fn close(&mut self, fd_op: OpTy<'tcx, Tag>) -> InterpResult<'tcx, i32> {
 148         let this = self.eval_context_mut();
 149
 150         this.check_no_isolation("close")?;
 151
 152         let fd = this.read_scalar(fd_op)?.to_i32()?;
 153
 154         if let Some(handle) = this.machine.file_handler.handles.remove(&fd) {
 155             // We sync the file if it was opened in a mode different than read-only.
 156             if handle.writable {
 157                 // `File::sync_all` does the checks that are done when closing a file. We do this to
 158                 // to handle possible errors correctly.
 159                 let result = this.try_unwrap_io_result(handle.file.sync_all().map(|_| 0i32));
 160                 // Now we actually close the file.
 161                 drop(handle);
 162                 // And return the result.
 163                 result
 164             } else {
 165                 // We drop the file, this closes it but ignores any errors produced when closing
 166                 // it. This is done because `File::sync_call` cannot be done over files like
 167                 // `/dev/urandom` which are read-only. Check
 168                 // https://github.com/rust-lang/miri/issues/999#issuecomment-568920439 for a deeper
 169                 // discussion.
 170                 drop(handle);
 171                 Ok(0)
 172             }
 173         } else {
 174             this.handle_not_found()
 175         }
 176     }
 177
 178     fn read(
 179         &mut self,
 180         fd_op: OpTy<'tcx, Tag>,
 181         buf_op: OpTy<'tcx, Tag>,
 182         count_op: OpTy<'tcx, Tag>,
 183     ) -> InterpResult<'tcx, i64> {
 184         let this = self.eval_context_mut();
 185
 186         this.check_no_isolation("read")?;
 187
 188         let fd = this.read_scalar(fd_op)?.to_i32()?;
 189         let buf = this.read_scalar(buf_op)?.not_undef()?;
 190         let count = this.read_scalar(count_op)?.to_machine_usize(&*this.tcx)?;
 191
 192         // Check that the *entire* buffer is actually valid memory.
 193         this.memory.check_ptr_access(
 194             buf,
 195             Size::from_bytes(count),
 196             Align::from_bytes(1).unwrap(),
 197         )?;
 198
 199         // We cap the number of read bytes to the largest value that we are able to fit in both the
 200         // host's and target's `isize`. This saves us from having to handle overflows later.
 201         let count = count.min(this.isize_max() as u64).min(isize::max_value() as u64);
 202
 203         if let Some(handle) = this.machine.file_handler.handles.get_mut(&fd) {
 204             // This can never fail because `count` was capped to be smaller than
 205             // `isize::max_value()`.
 206             let count = isize::try_from(count).unwrap();
 207             // We want to read at most `count` bytes. We are sure that `count` is not negative
 208             // because it was a target's `usize`. Also we are sure that its smaller than
 209             // `usize::max_value()` because it is a host's `isize`.
 210             let mut bytes = vec![0; count as usize];
 211             let result = handle
 212                 .file
 213                 .read(&mut bytes)
 214                 // `File::read` never returns a value larger than `count`, so this cannot fail.
 215                 .map(|c| i64::try_from(c).unwrap());
 216
 217             match result {
 218                 Ok(read_bytes) => {
 219                     // If reading to `bytes` did not fail, we write those bytes to the buffer.
 220                     this.memory.write_bytes(buf, bytes)?;
 221                     Ok(read_bytes)
 222                 }
 223                 Err(e) => {
 224                     this.set_last_error_from_io_error(e)?;
 225                     Ok(-1)
 226                 }
 227             }
 228         } else {
 229             this.handle_not_found()
 230         }
 231     }
 232
 233     fn write(
 234         &mut self,
 235         fd_op: OpTy<'tcx, Tag>,
 236         buf_op: OpTy<'tcx, Tag>,
 237         count_op: OpTy<'tcx, Tag>,
 238     ) -> InterpResult<'tcx, i64> {
 239         let this = self.eval_context_mut();
 240
 241         this.check_no_isolation("write")?;
 242
 243         let fd = this.read_scalar(fd_op)?.to_i32()?;
 244         let buf = this.read_scalar(buf_op)?.not_undef()?;
 245         let count = this.read_scalar(count_op)?.to_machine_usize(&*this.tcx)?;
 246
 247         // Check that the *entire* buffer is actually valid memory.
 248         this.memory.check_ptr_access(
 249             buf,
 250             Size::from_bytes(count),
 251             Align::from_bytes(1).unwrap(),
 252         )?;
 253
 254         // We cap the number of written bytes to the largest value that we are able to fit in both the
 255         // host's and target's `isize`. This saves us from having to handle overflows later.
 256         let count = count.min(this.isize_max() as u64).min(isize::max_value() as u64);
 257
 258         if let Some(handle) = this.machine.file_handler.handles.get_mut(&fd) {
 259             let bytes = this.memory.read_bytes(buf, Size::from_bytes(count))?;
 260             let result = handle.file.write(&bytes).map(|c| i64::try_from(c).unwrap());
 261             this.try_unwrap_io_result(result)
 262         } else {
 263             this.handle_not_found()
 264         }
 265     }
 266
 267     fn lseek64(
 268         &mut self,
 269         fd_op: OpTy<'tcx, Tag>,
 270         offset_op: OpTy<'tcx, Tag>,
 271         whence_op: OpTy<'tcx, Tag>,
 272     ) -> InterpResult<'tcx, i64> {
 273         let this = self.eval_context_mut();
 274
 275         this.check_no_isolation("lseek64")?;
 276
 277         let fd = this.read_scalar(fd_op)?.to_i32()?;
 278         let offset = this.read_scalar(offset_op)?.to_i64()?;
 279         let whence = this.read_scalar(whence_op)?.to_i32()?;
 280
 281         let seek_from = if whence == this.eval_libc_i32("SEEK_SET")? {
 282             SeekFrom::Start(offset as u64)
 283         } else if whence == this.eval_libc_i32("SEEK_CUR")? {
 284             SeekFrom::Current(offset)
 285         } else if whence == this.eval_libc_i32("SEEK_END")? {
 286             SeekFrom::End(offset)
 287         } else {
 288             let einval = this.eval_libc("EINVAL")?;
 289             this.set_last_error(einval)?;
 290             return Ok(-1);
 291         };
 292
 293         if let Some(handle) = this.machine.file_handler.handles.get_mut(&fd) {
 294             let result = handle.file.seek(seek_from).map(|offset| offset as i64);
 295             this.try_unwrap_io_result(result)
 296         } else {
 297             this.handle_not_found()
 298         }
 299     }
 300
 301     fn unlink(&mut self, path_op: OpTy<'tcx, Tag>) -> InterpResult<'tcx, i32> {
 302         let this = self.eval_context_mut();
 303
 304         this.check_no_isolation("unlink")?;
 305
 306         let path = this.read_os_str_from_c_str(this.read_scalar(path_op)?.not_undef()?)?;
 307
 308         let result = remove_file(path).map(|_| 0);
 309
 310         this.try_unwrap_io_result(result)
 311     }
 312
 313     fn symlink(
 314         &mut self,
 315         target_op: OpTy<'tcx, Tag>,
 316         linkpath_op: OpTy<'tcx, Tag>
 317     ) -> InterpResult<'tcx, i32> {
 318         #[cfg(target_family = "unix")]
 319         fn create_link(src: PathBuf, dst: PathBuf) -> std::io::Result<()> {
 320             std::os::unix::fs::symlink(src, dst)
 321         }
 322
 323         #[cfg(target_family = "windows")]
 324         fn create_link(src: PathBuf, dst: PathBuf) -> std::io::Result<()> {
 325             use std::os::windows::fs;
 326             if src.is_dir() {
 327                 fs::symlink_dir(src, dst)
 328             } else {
 329                 fs::symlink_file(src, dst)
 330             }
 331         }
 332
 333         let this = self.eval_context_mut();
 334
 335         this.check_no_isolation("symlink")?;
 336
 337         let target = this.read_os_str_from_c_str(this.read_scalar(target_op)?.not_undef()?)?.into();
 338         let linkpath = this.read_os_str_from_c_str(this.read_scalar(linkpath_op)?.not_undef()?)?.into();
 339
 340         this.try_unwrap_io_result(create_link(target, linkpath).map(|_| 0))
 341     }
 342
 343     fn macos_stat(
 344         &mut self,
 345         path_op: OpTy<'tcx, Tag>,
 346         buf_op: OpTy<'tcx, Tag>,
 347     ) -> InterpResult<'tcx, i32> {
 348         let this = self.eval_context_mut();
 349         this.check_no_isolation("stat")?;
 350         this.check_platform("macos", "stat")?;
 351         // `stat` always follows symlinks.
 352         this.macos_stat_or_lstat(true, path_op, buf_op)
 353     }
 354
 355     // `lstat` is used to get symlink metadata.
 356     fn macos_lstat(
 357         &mut self,
 358         path_op: OpTy<'tcx, Tag>,
 359         buf_op: OpTy<'tcx, Tag>,
 360     ) -> InterpResult<'tcx, i32> {
 361         let this = self.eval_context_mut();
 362         this.check_no_isolation("lstat")?;
 363         this.check_platform("macos", "lstat")?;
 364         this.macos_stat_or_lstat(false, path_op, buf_op)
 365     }
 366
 367     fn macos_fstat(
 368         &mut self,
 369         fd_op: OpTy<'tcx, Tag>,
 370         buf_op: OpTy<'tcx, Tag>,
 371     ) -> InterpResult<'tcx, i32> {
 372         let this = self.eval_context_mut();
 373
 374         this.check_no_isolation("fstat")?;
 375         this.check_platform("macos", "fstat")?;
 376
 377         let fd = this.read_scalar(fd_op)?.to_i32()?;
 378
 379         let metadata = match FileMetadata::from_fd(this, fd)? {
 380             Some(metadata) => metadata,
 381             None => return Ok(-1),
 382         };
 383         macos_stat_write_buf(this, metadata, buf_op)
 384     }
 385
 386     fn macos_stat_or_lstat(
 387         &mut self,
 388         follow_symlink: bool,
 389         path_op: OpTy<'tcx, Tag>,
 390         buf_op: OpTy<'tcx, Tag>,
 391     ) -> InterpResult<'tcx, i32> {
 392         let this = self.eval_context_mut();
 393
 394         let path_scalar = this.read_scalar(path_op)?.not_undef()?;
 395         let path: PathBuf = this.read_os_str_from_c_str(path_scalar)?.into();
 396
 397         let metadata = match FileMetadata::from_path(this, path, follow_symlink)? {
 398             Some(metadata) => metadata,
 399             None => return Ok(-1),
 400         };
 401         macos_stat_write_buf(this, metadata, buf_op)
 402     }
 403
 404     fn linux_statx(
 405         &mut self,
 406         dirfd_op: OpTy<'tcx, Tag>,    // Should be an `int`
 407         pathname_op: OpTy<'tcx, Tag>, // Should be a `const char *`
 408         flags_op: OpTy<'tcx, Tag>,    // Should be an `int`
 409         _mask_op: OpTy<'tcx, Tag>,    // Should be an `unsigned int`
 410         statxbuf_op: OpTy<'tcx, Tag>, // Should be a `struct statx *`
 411     ) -> InterpResult<'tcx, i32> {
 412         let this = self.eval_context_mut();
 413
 414         this.check_no_isolation("statx")?;
 415         this.check_platform("linux", "statx")?;
 416
 417         let statxbuf_scalar = this.read_scalar(statxbuf_op)?.not_undef()?;
 418         let pathname_scalar = this.read_scalar(pathname_op)?.not_undef()?;
 419
 420         // If the statxbuf or pathname pointers are null, the function fails with `EFAULT`.
 421         if this.is_null(statxbuf_scalar)? || this.is_null(pathname_scalar)? {
 422             let efault = this.eval_libc("EFAULT")?;
 423             this.set_last_error(efault)?;
 424             return Ok(-1);
 425         }
 426
 427         // Under normal circumstances, we would use `deref_operand(statxbuf_op)` to produce a
 428         // proper `MemPlace` and then write the results of this function to it. However, the
 429         // `syscall` function is untyped. This means that all the `statx` parameters are provided
 430         // as `isize`s instead of having the proper types. Thus, we have to recover the layout of
 431         // `statxbuf_op` by using the `libc::statx` struct type.
 432         let statxbuf_place = {
 433             // FIXME: This long path is required because `libc::statx` is an struct and also a
 434             // function and `resolve_path` is returning the latter.
 435             let statx_ty = this
 436                 .resolve_path(&["libc", "unix", "linux_like", "linux", "gnu", "statx"])?
 437                 .monomorphic_ty(*this.tcx);
 438             let statxbuf_ty = this.tcx.mk_mut_ptr(statx_ty);
 439             let statxbuf_layout = this.layout_of(statxbuf_ty)?;
 440             let statxbuf_imm = ImmTy::from_scalar(statxbuf_scalar, statxbuf_layout);
 441             this.ref_to_mplace(statxbuf_imm)?
 442         };
 443
 444         let path: PathBuf = this.read_os_str_from_c_str(pathname_scalar)?.into();
 445         // `flags` should be a `c_int` but the `syscall` function provides an `isize`.
 446         let flags: i32 =
 447             this.read_scalar(flags_op)?.to_machine_isize(&*this.tcx)?.try_into().map_err(|e| {
 448                 err_unsup_format!("Failed to convert pointer sized operand to integer: {}", e)
 449             })?;
 450         let empty_path_flag = flags & this.eval_libc("AT_EMPTY_PATH")?.to_i32()? != 0;
 451         // `dirfd` should be a `c_int` but the `syscall` function provides an `isize`.
 452         let dirfd: i32 =
 453             this.read_scalar(dirfd_op)?.to_machine_isize(&*this.tcx)?.try_into().map_err(|e| {
 454                 err_unsup_format!("Failed to convert pointer sized operand to integer: {}", e)
 455             })?;
 456         // We only support:
 457         // * interpreting `path` as an absolute directory,
 458         // * interpreting `path` as a path relative to `dirfd` when the latter is `AT_FDCWD`, or
 459         // * interpreting `dirfd` as any file descriptor when `path` is empty and AT_EMPTY_PATH is
 460         // set.
 461         // Other behaviors cannot be tested from `libstd` and thus are not implemented. If you
 462         // found this error, please open an issue reporting it.
 463         if !(
 464             path.is_absolute() ||
 465             dirfd == this.eval_libc_i32("AT_FDCWD")? ||
 466             (path.as_os_str().is_empty() && empty_path_flag)
 467         ) {
 468             throw_unsup_format!(
 469                 "Using statx is only supported with absolute paths, relative paths with the file \
 470                 descriptor `AT_FDCWD`, and empty paths with the `AT_EMPTY_PATH` flag set and any \
 471                 file descriptor"
 472             )
 473         }
 474
 475         // the `_mask_op` paramter specifies the file information that the caller requested.
 476         // However `statx` is allowed to return information that was not requested or to not
 477         // return information that was requested. This `mask` represents the information we can
 478         // actually provide in any host platform.
 479         let mut mask =
 480             this.eval_libc("STATX_TYPE")?.to_u32()? | this.eval_libc("STATX_SIZE")?.to_u32()?;
 481
 482         // If the `AT_SYMLINK_NOFOLLOW` flag is set, we query the file's metadata without following
 483         // symbolic links.
 484         let follow_symlink = flags & this.eval_libc("AT_SYMLINK_NOFOLLOW")?.to_i32()? == 0;
 485
 486         // If the path is empty, and the AT_EMPTY_PATH flag is set, we query the open file
 487         // represented by dirfd, whether it's a directory or otherwise.
 488         let metadata = if path.as_os_str().is_empty() && empty_path_flag {
 489             FileMetadata::from_fd(this, dirfd)?
 490         } else {
 491             FileMetadata::from_path(this, path, follow_symlink)?
 492         };
 493         let metadata = match metadata {
 494             Some(metadata) => metadata,
 495             None => return Ok(-1),
 496         };
 497
 498         // The `mode` field specifies the type of the file and the permissions over the file for
 499         // the owner, its group and other users. Given that we can only provide the file type
 500         // without using platform specific methods, we only set the bits corresponding to the file
 501         // type. This should be an `__u16` but `libc` provides its values as `u32`.
 502         let mode: u16 = metadata
 503             .mode
 504             .to_u32()?
 505             .try_into()
 506             .unwrap_or_else(|_| bug!("libc contains bad value for constant"));
 507
 508         // We need to set the corresponding bits of `mask` if the access, creation and modification
 509         // times were available. Otherwise we let them be zero.
 510         let (access_sec, access_nsec) = metadata.accessed.map(|tup| {
 511             mask |= this.eval_libc("STATX_ATIME")?.to_u32()?;
 512             InterpResult::Ok(tup)
 513         }).unwrap_or(Ok((0, 0)))?;
 514
 515         let (created_sec, created_nsec) = metadata.created.map(|tup| {
 516             mask |= this.eval_libc("STATX_BTIME")?.to_u32()?;
 517             InterpResult::Ok(tup)
 518         }).unwrap_or(Ok((0, 0)))?;
 519
 520         let (modified_sec, modified_nsec) = metadata.modified.map(|tup| {
 521             mask |= this.eval_libc("STATX_MTIME")?.to_u32()?;
 522             InterpResult::Ok(tup)
 523         }).unwrap_or(Ok((0, 0)))?;
 524
 525         let __u32_layout = this.libc_ty_layout("__u32")?;
 526         let __u64_layout = this.libc_ty_layout("__u64")?;
 527         let __u16_layout = this.libc_ty_layout("__u16")?;
 528
 529         // Now we transform all this fields into `ImmTy`s and write them to `statxbuf`. We write a
 530         // zero for the unavailable fields.
 531         let imms = [
 532             immty_from_uint_checked(mask, __u32_layout)?, // stx_mask
 533             immty_from_uint_checked(0u128, __u32_layout)?, // stx_blksize
 534             immty_from_uint_checked(0u128, __u64_layout)?, // stx_attributes
 535             immty_from_uint_checked(0u128, __u32_layout)?, // stx_nlink
 536             immty_from_uint_checked(0u128, __u32_layout)?, // stx_uid
 537             immty_from_uint_checked(0u128, __u32_layout)?, // stx_gid
 538             immty_from_uint_checked(mode, __u16_layout)?, // stx_mode
 539             immty_from_uint_checked(0u128, __u16_layout)?, // statx padding
 540             immty_from_uint_checked(0u128, __u64_layout)?, // stx_ino
 541             immty_from_uint_checked(metadata.size, __u64_layout)?, // stx_size
 542             immty_from_uint_checked(0u128, __u64_layout)?, // stx_blocks
 543             immty_from_uint_checked(0u128, __u64_layout)?, // stx_attributes
 544             immty_from_uint_checked(access_sec, __u64_layout)?, // stx_atime.tv_sec
 545             immty_from_uint_checked(access_nsec, __u32_layout)?, // stx_atime.tv_nsec
 546             immty_from_uint_checked(0u128, __u32_layout)?, // statx_timestamp padding
 547             immty_from_uint_checked(created_sec, __u64_layout)?, // stx_btime.tv_sec
 548             immty_from_uint_checked(created_nsec, __u32_layout)?, // stx_btime.tv_nsec
 549             immty_from_uint_checked(0u128, __u32_layout)?, // statx_timestamp padding
 550             immty_from_uint_checked(0u128, __u64_layout)?, // stx_ctime.tv_sec
 551             immty_from_uint_checked(0u128, __u32_layout)?, // stx_ctime.tv_nsec
 552             immty_from_uint_checked(0u128, __u32_layout)?, // statx_timestamp padding
 553             immty_from_uint_checked(modified_sec, __u64_layout)?, // stx_mtime.tv_sec
 554             immty_from_uint_checked(modified_nsec, __u32_layout)?, // stx_mtime.tv_nsec
 555             immty_from_uint_checked(0u128, __u32_layout)?, // statx_timestamp padding
 556             immty_from_uint_checked(0u128, __u64_layout)?, // stx_rdev_major
 557             immty_from_uint_checked(0u128, __u64_layout)?, // stx_rdev_minor
 558             immty_from_uint_checked(0u128, __u64_layout)?, // stx_dev_major
 559             immty_from_uint_checked(0u128, __u64_layout)?, // stx_dev_minor
 560         ];
 561
 562         this.write_packed_immediates(statxbuf_place, &imms)?;
 563
 564         Ok(0)
 565     }
 566
 567     /// Function used when a handle is not found inside `FileHandler`. It returns `Ok(-1)`and sets
 568     /// the last OS error to `libc::EBADF` (invalid file descriptor). This function uses
 569     /// `T: From<i32>` instead of `i32` directly because some fs functions return different integer
 570     /// types (like `read`, that returns an `i64`).
 571     fn handle_not_found<T: From<i32>>(&mut self) -> InterpResult<'tcx, T> {
 572         let this = self.eval_context_mut();
 573         let ebadf = this.eval_libc("EBADF")?;
 574         this.set_last_error(ebadf)?;
 575         Ok((-1).into())
 576     }
 577
 578     fn rename(
 579         &mut self,
 580         oldpath_op: OpTy<'tcx, Tag>,
 581         newpath_op: OpTy<'tcx, Tag>,
 582     ) -> InterpResult<'tcx, i32> {
 583         let this = self.eval_context_mut();
 584
 585         this.check_no_isolation("rename")?;
 586
 587         let oldpath_scalar = this.read_scalar(oldpath_op)?.not_undef()?;
 588         let newpath_scalar = this.read_scalar(newpath_op)?.not_undef()?;
 589
 590         if this.is_null(oldpath_scalar)? || this.is_null(newpath_scalar)? {
 591             let efault = this.eval_libc("EFAULT")?;
 592             this.set_last_error(efault)?;
 593             return Ok(-1);
 594         }
 595
 596         let oldpath = this.read_os_str_from_c_str(oldpath_scalar)?;
 597         let newpath = this.read_os_str_from_c_str(newpath_scalar)?;
 598
 599         let result = rename(oldpath, newpath).map(|_| 0);
 600
 601         this.try_unwrap_io_result(result)
 602     }
 603 }
 604
 605 /// Extracts the number of seconds and nanoseconds elapsed between `time` and the unix epoch when
 606 /// `time` is Ok. Returns `None` if `time` is an error. Fails if `time` happens before the unix
 607 /// epoch.
 608 fn extract_sec_and_nsec<'tcx>(
 609     time: std::io::Result<SystemTime>
 610 ) -> InterpResult<'tcx, Option<(u64, u32)>> {
 611     time.ok().map(|time| {
 612         let duration = system_time_to_duration(&time)?;
 613         Ok((duration.as_secs(), duration.subsec_nanos()))
 614     }).transpose()
 615 }
 616
 617 /// Stores a file's metadata in order to avoid code duplication in the different metadata related
 618 /// shims.
 619 struct FileMetadata {
 620     mode: Scalar<Tag>,
 621     size: u64,
 622     created: Option<(u64, u32)>,
 623     accessed: Option<(u64, u32)>,
 624     modified: Option<(u64, u32)>,
 625 }
 626
 627 impl FileMetadata {
 628     fn from_path<'tcx, 'mir>(
 629         ecx: &mut MiriEvalContext<'mir, 'tcx>,
 630         path: PathBuf,
 631         follow_symlink: bool
 632     ) -> InterpResult<'tcx, Option<FileMetadata>> {
 633         let metadata = if follow_symlink {
 634             std::fs::metadata(path)
 635         } else {
 636             std::fs::symlink_metadata(path)
 637         };
 638
 639         FileMetadata::from_meta(ecx, metadata)
 640     }
 641
 642     fn from_fd<'tcx, 'mir>(
 643         ecx: &mut MiriEvalContext<'mir, 'tcx>,
 644         fd: i32,
 645     ) -> InterpResult<'tcx, Option<FileMetadata>> {
 646         let option = ecx.machine.file_handler.handles.get(&fd);
 647         let handle = match option {
 648             Some(handle) => handle,
 649             None => return ecx.handle_not_found().map(|_: i32| None),
 650         };
 651         let metadata = handle.file.metadata();
 652
 653         FileMetadata::from_meta(ecx, metadata)
 654     }
 655
 656     fn from_meta<'tcx, 'mir>(
 657         ecx: &mut MiriEvalContext<'mir, 'tcx>,
 658         metadata: Result<std::fs::Metadata, std::io::Error>,
 659     ) -> InterpResult<'tcx, Option<FileMetadata>> {
 660         let metadata = match metadata {
 661             Ok(metadata) => metadata,
 662             Err(e) => {
 663                 ecx.set_last_error_from_io_error(e)?;
 664                 return Ok(None);
 665             }
 666         };
 667
 668         let file_type = metadata.file_type();
 669
 670         let mode_name = if file_type.is_file() {
 671             "S_IFREG"
 672         } else if file_type.is_dir() {
 673             "S_IFDIR"
 674         } else {
 675             "S_IFLNK"
 676         };
 677
 678         let mode = ecx.eval_libc(mode_name)?;
 679
 680         let size = metadata.len();
 681
 682         let created = extract_sec_and_nsec(metadata.created())?;
 683         let accessed = extract_sec_and_nsec(metadata.accessed())?;
 684         let modified = extract_sec_and_nsec(metadata.modified())?;
 685
 686         // FIXME: Provide more fields using platform specific methods.
 687         Ok(Some(FileMetadata { mode, size, created, accessed, modified }))
 688     }
 689 }
 690
 691 fn macos_stat_write_buf<'tcx, 'mir>(
 692     ecx: &mut MiriEvalContext<'mir, 'tcx>,
 693     metadata: FileMetadata,
 694     buf_op: OpTy<'tcx, Tag>,
 695 ) -> InterpResult<'tcx, i32> {
 696     let mode: u16 = metadata.mode.to_u16()?;
 697
 698     let (access_sec, access_nsec) = metadata.accessed.unwrap_or((0, 0));
 699     let (created_sec, created_nsec) = metadata.created.unwrap_or((0, 0));
 700     let (modified_sec, modified_nsec) = metadata.modified.unwrap_or((0, 0));
 701
 702     let dev_t_layout = ecx.libc_ty_layout("dev_t")?;
 703     let mode_t_layout = ecx.libc_ty_layout("mode_t")?;
 704     let nlink_t_layout = ecx.libc_ty_layout("nlink_t")?;
 705     let ino_t_layout = ecx.libc_ty_layout("ino_t")?;
 706     let uid_t_layout = ecx.libc_ty_layout("uid_t")?;
 707     let gid_t_layout = ecx.libc_ty_layout("gid_t")?;
 708     let time_t_layout = ecx.libc_ty_layout("time_t")?;
 709     let long_layout = ecx.libc_ty_layout("c_long")?;
 710     let off_t_layout = ecx.libc_ty_layout("off_t")?;
 711     let blkcnt_t_layout = ecx.libc_ty_layout("blkcnt_t")?;
 712     let blksize_t_layout = ecx.libc_ty_layout("blksize_t")?;
 713     let uint32_t_layout = ecx.libc_ty_layout("uint32_t")?;
 714
 715     // We need to add 32 bits of padding after `st_rdev` if we are on a 64-bit platform.
 716     let pad_layout = if ecx.tcx.sess.target.ptr_width == 64 {
 717         uint32_t_layout
 718     } else {
 719         ecx.layout_of(ecx.tcx.mk_unit())?
 720     };
 721
 722     let imms = [
 723         immty_from_uint_checked(0u128, dev_t_layout)?, // st_dev
 724         immty_from_uint_checked(mode, mode_t_layout)?, // st_mode
 725         immty_from_uint_checked(0u128, nlink_t_layout)?, // st_nlink
 726         immty_from_uint_checked(0u128, ino_t_layout)?, // st_ino
 727         immty_from_uint_checked(0u128, uid_t_layout)?, // st_uid
 728         immty_from_uint_checked(0u128, gid_t_layout)?, // st_gid
 729         immty_from_uint_checked(0u128, dev_t_layout)?, // st_rdev
 730         immty_from_uint_checked(0u128, pad_layout)?, // padding for 64-bit targets
 731         immty_from_uint_checked(access_sec, time_t_layout)?, // st_atime
 732         immty_from_uint_checked(access_nsec, long_layout)?, // st_atime_nsec
 733         immty_from_uint_checked(modified_sec, time_t_layout)?, // st_mtime
 734         immty_from_uint_checked(modified_nsec, long_layout)?, // st_mtime_nsec
 735         immty_from_uint_checked(0u128, time_t_layout)?, // st_ctime
 736         immty_from_uint_checked(0u128, long_layout)?, // st_ctime_nsec
 737         immty_from_uint_checked(created_sec, time_t_layout)?, // st_birthtime
 738         immty_from_uint_checked(created_nsec, long_layout)?, // st_birthtime_nsec
 739         immty_from_uint_checked(metadata.size, off_t_layout)?, // st_size
 740         immty_from_uint_checked(0u128, blkcnt_t_layout)?, // st_blocks
 741         immty_from_uint_checked(0u128, blksize_t_layout)?, // st_blksize
 742         immty_from_uint_checked(0u128, uint32_t_layout)?, // st_flags
 743         immty_from_uint_checked(0u128, uint32_t_layout)?, // st_gen
 744     ];
 745
 746     let buf = ecx.deref_operand(buf_op)?;
 747     ecx.write_packed_immediates(buf, &imms)?;
 748
 749     Ok(0)
 750 }