src/shims/fs.rs

   1 use std::collections::HashMap;
   2 use std::convert::{TryFrom, TryInto};
   3 use std::fs::{remove_file, File, OpenOptions};
   4 use std::io::{Read, 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 unlink(&mut self, path_op: OpTy<'tcx, Tag>) -> InterpResult<'tcx, i32> {
 268         let this = self.eval_context_mut();
 269
 270         this.check_no_isolation("unlink")?;
 271
 272         let path = this.read_os_str_from_c_str(this.read_scalar(path_op)?.not_undef()?)?;
 273
 274         let result = remove_file(path).map(|_| 0);
 275
 276         this.try_unwrap_io_result(result)
 277     }
 278
 279     fn symlink(
 280         &mut self,
 281         target_op: OpTy<'tcx, Tag>,
 282         linkpath_op: OpTy<'tcx, Tag>
 283     ) -> InterpResult<'tcx, i32> {
 284         #[cfg(target_family = "unix")]
 285         fn create_link(src: PathBuf, dst: PathBuf) -> std::io::Result<()> {
 286             std::os::unix::fs::symlink(src, dst)
 287         }
 288
 289         #[cfg(target_family = "windows")]
 290         fn create_link(src: PathBuf, dst: PathBuf) -> std::io::Result<()> {
 291             use std::os::windows::fs;
 292             if src.is_dir() {
 293                 fs::symlink_dir(src, dst)
 294             } else {
 295                 fs::symlink_file(src, dst)
 296             }
 297         }
 298
 299         let this = self.eval_context_mut();
 300
 301         this.check_no_isolation("symlink")?;
 302
 303         let target = this.read_os_str_from_c_str(this.read_scalar(target_op)?.not_undef()?)?.into();
 304         let linkpath = this.read_os_str_from_c_str(this.read_scalar(linkpath_op)?.not_undef()?)?.into();
 305
 306         this.try_unwrap_io_result(create_link(target, linkpath).map(|_| 0))
 307     }
 308
 309     fn stat(
 310         &mut self,
 311         path_op: OpTy<'tcx, Tag>,
 312         buf_op: OpTy<'tcx, Tag>,
 313     ) -> InterpResult<'tcx, i32> {
 314         let this = self.eval_context_mut();
 315         this.check_no_isolation("stat")?;
 316         // `stat` always follows symlinks.
 317         this.stat_or_lstat(true, path_op, buf_op)
 318     }
 319
 320     // `lstat` is used to get symlink metadata.
 321     fn lstat(
 322         &mut self,
 323         path_op: OpTy<'tcx, Tag>,
 324         buf_op: OpTy<'tcx, Tag>,
 325     ) -> InterpResult<'tcx, i32> {
 326         let this = self.eval_context_mut();
 327         this.check_no_isolation("lstat")?;
 328         this.stat_or_lstat(false, path_op, buf_op)
 329     }
 330
 331     fn stat_or_lstat(
 332         &mut self,
 333         follow_symlink: bool,
 334         path_op: OpTy<'tcx, Tag>,
 335         buf_op: OpTy<'tcx, Tag>,
 336     ) -> InterpResult<'tcx, i32> {
 337         let this = self.eval_context_mut();
 338
 339         if this.tcx.sess.target.target.target_os.to_lowercase() != "macos" {
 340             throw_unsup_format!("The `stat` and `lstat` shims are only available for `macos` targets.")
 341         }
 342
 343         let path_scalar = this.read_scalar(path_op)?.not_undef()?;
 344         let path: PathBuf = this.read_os_str_from_c_str(path_scalar)?.into();
 345
 346         let buf = this.deref_operand(buf_op)?;
 347
 348         let metadata = match FileMetadata::from_path(this, path, follow_symlink)? {
 349             Some(metadata) => metadata,
 350             None => return Ok(-1),
 351         };
 352
 353         let mode: u16 = metadata.mode.to_u16()?;
 354
 355         let (access_sec, access_nsec) = metadata.accessed.unwrap_or((0, 0));
 356         let (created_sec, created_nsec) = metadata.created.unwrap_or((0, 0));
 357         let (modified_sec, modified_nsec) = metadata.modified.unwrap_or((0, 0));
 358
 359         let dev_t_layout = this.libc_ty_layout("dev_t")?;
 360         let mode_t_layout = this.libc_ty_layout("mode_t")?;
 361         let nlink_t_layout = this.libc_ty_layout("nlink_t")?;
 362         let ino_t_layout = this.libc_ty_layout("ino_t")?;
 363         let uid_t_layout = this.libc_ty_layout("uid_t")?;
 364         let gid_t_layout = this.libc_ty_layout("gid_t")?;
 365         let time_t_layout = this.libc_ty_layout("time_t")?;
 366         let long_layout = this.libc_ty_layout("c_long")?;
 367         let off_t_layout = this.libc_ty_layout("off_t")?;
 368         let blkcnt_t_layout = this.libc_ty_layout("blkcnt_t")?;
 369         let blksize_t_layout = this.libc_ty_layout("blksize_t")?;
 370         let uint32_t_layout = this.libc_ty_layout("uint32_t")?;
 371
 372         // We need to add 32 bits of padding after `st_rdev` if we are on a 64-bit platform.
 373         let pad_layout = if this.tcx.sess.target.ptr_width == 64 {
 374             uint32_t_layout
 375         } else {
 376             this.layout_of(this.tcx.mk_unit())?
 377         };
 378
 379         let imms = [
 380             immty_from_uint_checked(0u128, dev_t_layout)?, // st_dev
 381             immty_from_uint_checked(mode, mode_t_layout)?, // st_mode
 382             immty_from_uint_checked(0u128, nlink_t_layout)?, // st_nlink
 383             immty_from_uint_checked(0u128, ino_t_layout)?, // st_ino
 384             immty_from_uint_checked(0u128, uid_t_layout)?, // st_uid
 385             immty_from_uint_checked(0u128, gid_t_layout)?, // st_gid
 386             immty_from_uint_checked(0u128, dev_t_layout)?, // st_rdev
 387             immty_from_uint_checked(0u128, pad_layout)?, // padding for 64-bit targets
 388             immty_from_uint_checked(access_sec, time_t_layout)?, // st_atime
 389             immty_from_uint_checked(access_nsec, long_layout)?, // st_atime_nsec
 390             immty_from_uint_checked(modified_sec, time_t_layout)?, // st_mtime
 391             immty_from_uint_checked(modified_nsec, long_layout)?, // st_mtime_nsec
 392             immty_from_uint_checked(0u128, time_t_layout)?, // st_ctime
 393             immty_from_uint_checked(0u128, long_layout)?, // st_ctime_nsec
 394             immty_from_uint_checked(created_sec, time_t_layout)?, // st_birthtime
 395             immty_from_uint_checked(created_nsec, long_layout)?, // st_birthtime_nsec
 396             immty_from_uint_checked(metadata.size, off_t_layout)?, // st_size
 397             immty_from_uint_checked(0u128, blkcnt_t_layout)?, // st_blocks
 398             immty_from_uint_checked(0u128, blksize_t_layout)?, // st_blksize
 399             immty_from_uint_checked(0u128, uint32_t_layout)?, // st_flags
 400             immty_from_uint_checked(0u128, uint32_t_layout)?, // st_gen
 401         ];
 402
 403         this.write_packed_immediates(&buf, &imms)?;
 404
 405         Ok(0)
 406     }
 407
 408     fn statx(
 409         &mut self,
 410         dirfd_op: OpTy<'tcx, Tag>,    // Should be an `int`
 411         pathname_op: OpTy<'tcx, Tag>, // Should be a `const char *`
 412         flags_op: OpTy<'tcx, Tag>,    // Should be an `int`
 413         _mask_op: OpTy<'tcx, Tag>,    // Should be an `unsigned int`
 414         statxbuf_op: OpTy<'tcx, Tag>, // Should be a `struct statx *`
 415     ) -> InterpResult<'tcx, i32> {
 416         let this = self.eval_context_mut();
 417
 418         this.check_no_isolation("statx")?;
 419
 420         if this.tcx.sess.target.target.target_os.to_lowercase() != "linux" {
 421             throw_unsup_format!("The `statx` shim is only available for `linux` targets.")
 422         }
 423
 424         let statxbuf_scalar = this.read_scalar(statxbuf_op)?.not_undef()?;
 425         let pathname_scalar = this.read_scalar(pathname_op)?.not_undef()?;
 426
 427         // If the statxbuf or pathname pointers are null, the function fails with `EFAULT`.
 428         if this.is_null(statxbuf_scalar)? || this.is_null(pathname_scalar)? {
 429             let efault = this.eval_libc("EFAULT")?;
 430             this.set_last_error(efault)?;
 431             return Ok(-1);
 432         }
 433
 434         // Under normal circumstances, we would use `deref_operand(statxbuf_op)` to produce a
 435         // proper `MemPlace` and then write the results of this function to it. However, the
 436         // `syscall` function is untyped. This means that all the `statx` parameters are provided
 437         // as `isize`s instead of having the proper types. Thus, we have to recover the layout of
 438         // `statxbuf_op` by using the `libc::statx` struct type.
 439         let statxbuf_place = {
 440             // FIXME: This long path is required because `libc::statx` is an struct and also a
 441             // function and `resolve_path` is returning the latter.
 442             let statx_ty = this
 443                 .resolve_path(&["libc", "unix", "linux_like", "linux", "gnu", "statx"])?
 444                 .monomorphic_ty(*this.tcx);
 445             let statxbuf_ty = this.tcx.mk_mut_ptr(statx_ty);
 446             let statxbuf_layout = this.layout_of(statxbuf_ty)?;
 447             let statxbuf_imm = ImmTy::from_scalar(statxbuf_scalar, statxbuf_layout);
 448             this.ref_to_mplace(statxbuf_imm)?
 449         };
 450
 451         let path: PathBuf = this.read_os_str_from_c_str(pathname_scalar)?.into();
 452         // `flags` should be a `c_int` but the `syscall` function provides an `isize`.
 453         let flags: i32 =
 454             this.read_scalar(flags_op)?.to_machine_isize(&*this.tcx)?.try_into().map_err(|e| {
 455                 err_unsup_format!("Failed to convert pointer sized operand to integer: {}", e)
 456             })?;
 457         let empty_path_flag = flags & this.eval_libc("AT_EMPTY_PATH")?.to_i32()? != 0;
 458         // `dirfd` should be a `c_int` but the `syscall` function provides an `isize`.
 459         let dirfd: i32 =
 460             this.read_scalar(dirfd_op)?.to_machine_isize(&*this.tcx)?.try_into().map_err(|e| {
 461                 err_unsup_format!("Failed to convert pointer sized operand to integer: {}", e)
 462             })?;
 463         // we only support interpreting `path` as an absolute directory or as a directory relative
 464         // to `dirfd` when the latter is `AT_FDCWD`. The behavior of `statx` with a relative path
 465         // and a directory file descriptor other than `AT_FDCWD` is specified but it cannot be
 466         // tested from `libstd`. If you found this error, please open an issue reporting it.
 467         if !(
 468             path.is_absolute() ||
 469             dirfd == this.eval_libc_i32("AT_FDCWD")? ||
 470             (path.as_os_str().is_empty() && empty_path_flag)
 471         ) {
 472             throw_unsup_format!(
 473                 "Using statx with a relative path and a file descriptor different from `AT_FDCWD` is not supported"
 474             )
 475         }
 476
 477         // the `_mask_op` paramter specifies the file information that the caller requested.
 478         // However `statx` is allowed to return information that was not requested or to not
 479         // return information that was requested. This `mask` represents the information we can
 480         // actually provide in any host platform.
 481         let mut mask =
 482             this.eval_libc("STATX_TYPE")?.to_u32()? | this.eval_libc("STATX_SIZE")?.to_u32()?;
 483
 484         // If the `AT_SYMLINK_NOFOLLOW` flag is set, we query the file's metadata without following
 485         // symbolic links.
 486         let follow_symlink = flags & this.eval_libc("AT_SYMLINK_NOFOLLOW")?.to_i32()? == 0;
 487
 488         // If the path is empty, and the AT_EMPTY_PATH flag is set, we query the open file
 489         // represented by dirfd, whether it's a directory or otherwise.
 490         let metadata = if path.as_os_str().is_empty() && empty_path_flag {
 491             FileMetadata::from_fd(this, dirfd)?
 492         } else {
 493             FileMetadata::from_path(this, path, follow_symlink)?
 494         };
 495         let metadata = match metadata {
 496             Some(metadata) => metadata,
 497             None => return Ok(-1),
 498         };
 499
 500         // The `mode` field specifies the type of the file and the permissions over the file for
 501         // the owner, its group and other users. Given that we can only provide the file type
 502         // without using platform specific methods, we only set the bits corresponding to the file
 503         // type. This should be an `__u16` but `libc` provides its values as `u32`.
 504         let mode: u16 = metadata
 505             .mode
 506             .to_u32()?
 507             .try_into()
 508             .unwrap_or_else(|_| bug!("libc contains bad value for constant"));
 509
 510         // We need to set the corresponding bits of `mask` if the access, creation and modification
 511         // times were available. Otherwise we let them be zero.
 512         let (access_sec, access_nsec) = metadata.accessed.map(|tup| {
 513             mask |= this.eval_libc("STATX_ATIME")?.to_u32()?;
 514             InterpResult::Ok(tup)
 515         }).unwrap_or(Ok((0, 0)))?;
 516
 517         let (created_sec, created_nsec) = metadata.created.map(|tup| {
 518             mask |= this.eval_libc("STATX_BTIME")?.to_u32()?;
 519             InterpResult::Ok(tup)
 520         }).unwrap_or(Ok((0, 0)))?;
 521
 522         let (modified_sec, modified_nsec) = metadata.modified.map(|tup| {
 523             mask |= this.eval_libc("STATX_MTIME")?.to_u32()?;
 524             InterpResult::Ok(tup)
 525         }).unwrap_or(Ok((0, 0)))?;
 526
 527         let __u32_layout = this.libc_ty_layout("__u32")?;
 528         let __u64_layout = this.libc_ty_layout("__u64")?;
 529         let __u16_layout = this.libc_ty_layout("__u16")?;
 530
 531         // Now we transform all this fields into `ImmTy`s and write them to `statxbuf`. We write a
 532         // zero for the unavailable fields.
 533         let imms = [
 534             immty_from_uint_checked(mask, __u32_layout)?, // stx_mask
 535             immty_from_uint_checked(0u128, __u32_layout)?, // stx_blksize
 536             immty_from_uint_checked(0u128, __u64_layout)?, // stx_attributes
 537             immty_from_uint_checked(0u128, __u32_layout)?, // stx_nlink
 538             immty_from_uint_checked(0u128, __u32_layout)?, // stx_uid
 539             immty_from_uint_checked(0u128, __u32_layout)?, // stx_gid
 540             immty_from_uint_checked(mode, __u16_layout)?, // stx_mode
 541             immty_from_uint_checked(0u128, __u16_layout)?, // statx padding
 542             immty_from_uint_checked(0u128, __u64_layout)?, // stx_ino
 543             immty_from_uint_checked(metadata.size, __u64_layout)?, // stx_size
 544             immty_from_uint_checked(0u128, __u64_layout)?, // stx_blocks
 545             immty_from_uint_checked(0u128, __u64_layout)?, // stx_attributes
 546             immty_from_uint_checked(access_sec, __u64_layout)?, // stx_atime.tv_sec
 547             immty_from_uint_checked(access_nsec, __u32_layout)?, // stx_atime.tv_nsec
 548             immty_from_uint_checked(0u128, __u32_layout)?, // statx_timestamp padding
 549             immty_from_uint_checked(created_sec, __u64_layout)?, // stx_btime.tv_sec
 550             immty_from_uint_checked(created_nsec, __u32_layout)?, // stx_btime.tv_nsec
 551             immty_from_uint_checked(0u128, __u32_layout)?, // statx_timestamp padding
 552             immty_from_uint_checked(0u128, __u64_layout)?, // stx_ctime.tv_sec
 553             immty_from_uint_checked(0u128, __u32_layout)?, // stx_ctime.tv_nsec
 554             immty_from_uint_checked(0u128, __u32_layout)?, // statx_timestamp padding
 555             immty_from_uint_checked(modified_sec, __u64_layout)?, // stx_mtime.tv_sec
 556             immty_from_uint_checked(modified_nsec, __u32_layout)?, // stx_mtime.tv_nsec
 557             immty_from_uint_checked(0u128, __u32_layout)?, // statx_timestamp padding
 558             immty_from_uint_checked(0u128, __u64_layout)?, // stx_rdev_major
 559             immty_from_uint_checked(0u128, __u64_layout)?, // stx_rdev_minor
 560             immty_from_uint_checked(0u128, __u64_layout)?, // stx_dev_major
 561             immty_from_uint_checked(0u128, __u64_layout)?, // stx_dev_minor
 562         ];
 563
 564         this.write_packed_immediates(&statxbuf_place, &imms)?;
 565
 566         Ok(0)
 567     }
 568
 569     /// Function used when a handle is not found inside `FileHandler`. It returns `Ok(-1)`and sets
 570     /// the last OS error to `libc::EBADF` (invalid file descriptor). This function uses
 571     /// `T: From<i32>` instead of `i32` directly because some fs functions return different integer
 572     /// types (like `read`, that returns an `i64`).
 573     fn handle_not_found<T: From<i32>>(&mut self) -> InterpResult<'tcx, T> {
 574         let this = self.eval_context_mut();
 575         let ebadf = this.eval_libc("EBADF")?;
 576         this.set_last_error(ebadf)?;
 577         Ok((-1).into())
 578     }
 579 }
 580
 581 /// Extracts the number of seconds and nanoseconds elapsed between `time` and the unix epoch when
 582 /// `time` is Ok. Returns `None` if `time` is an error. Fails if `time` happens before the unix
 583 /// epoch.
 584 fn extract_sec_and_nsec<'tcx>(
 585     time: std::io::Result<SystemTime>
 586 ) -> InterpResult<'tcx, Option<(u64, u32)>> {
 587     time.ok().map(|time| {
 588         let duration = system_time_to_duration(&time)?;
 589         Ok((duration.as_secs(), duration.subsec_nanos()))
 590     }).transpose()
 591 }
 592
 593 /// Stores a file's metadata in order to avoid code duplication in the different metadata related
 594 /// shims.
 595 struct FileMetadata {
 596     mode: Scalar<Tag>,
 597     size: u64,
 598     created: Option<(u64, u32)>,
 599     accessed: Option<(u64, u32)>,
 600     modified: Option<(u64, u32)>,
 601 }
 602
 603 impl FileMetadata {
 604     fn from_path<'tcx, 'mir>(
 605         ecx: &mut MiriEvalContext<'mir, 'tcx>,
 606         path: PathBuf,
 607         follow_symlink: bool
 608     ) -> InterpResult<'tcx, Option<FileMetadata>> {
 609         let metadata = if follow_symlink {
 610             std::fs::metadata(path)
 611         } else {
 612             std::fs::symlink_metadata(path)
 613         };
 614
 615         FileMetadata::from_meta(ecx, metadata)
 616     }
 617
 618     fn from_fd<'tcx, 'mir>(
 619         ecx: &mut MiriEvalContext<'mir, 'tcx>,
 620         fd: i32,
 621     ) -> InterpResult<'tcx, Option<FileMetadata>> {
 622         let option = ecx.machine.file_handler.handles.get(&fd);
 623         let handle = match option {
 624             Some(handle) => handle,
 625             None => return ecx.handle_not_found().map(|_: i32| None),
 626         };
 627         let metadata = handle.file.metadata();
 628
 629         FileMetadata::from_meta(ecx, metadata)
 630     }
 631
 632     fn from_meta<'tcx, 'mir>(
 633         ecx: &mut MiriEvalContext<'mir, 'tcx>,
 634         metadata: Result<std::fs::Metadata, std::io::Error>,
 635     ) -> InterpResult<'tcx, Option<FileMetadata>> {
 636         let metadata = match metadata {
 637             Ok(metadata) => metadata,
 638             Err(e) => {
 639                 ecx.set_last_error_from_io_error(e)?;
 640                 return Ok(None);
 641             }
 642         };
 643
 644         let file_type = metadata.file_type();
 645
 646         let mode_name = if file_type.is_file() {
 647             "S_IFREG"
 648         } else if file_type.is_dir() {
 649             "S_IFDIR"
 650         } else {
 651             "S_IFLNK"
 652         };
 653
 654         let mode = ecx.eval_libc(mode_name)?;
 655
 656         let size = metadata.len();
 657
 658         let created = extract_sec_and_nsec(metadata.created())?;
 659         let accessed = extract_sec_and_nsec(metadata.accessed())?;
 660         let modified = extract_sec_and_nsec(metadata.modified())?;
 661
 662         // FIXME: Provide more fields using platform specific methods.
 663         Ok(Some(FileMetadata { mode, size, created, accessed, modified }))
 664     }
 665 }