]> git.lizzy.rs Git - rust.git/blob - src/shims/fs.rs
minor fixes and updated docs
[rust.git] / 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 }
19
20 pub struct FileHandler {
21     handles: HashMap<i32, FileHandle>,
22     low: i32,
23 }
24
25 impl Default for FileHandler {
26     fn default() -> Self {
27         FileHandler {
28             handles: Default::default(),
29             // 0, 1 and 2 are reserved for stdin, stdout and stderr.
30             low: 3,
31         }
32     }
33 }
34
35 impl<'mir, 'tcx> EvalContextExt<'mir, 'tcx> for crate::MiriEvalContext<'mir, 'tcx> {}
36 pub trait EvalContextExt<'mir, 'tcx: 'mir>: crate::MiriEvalContextExt<'mir, 'tcx> {
37     fn open(
38         &mut self,
39         path_op: OpTy<'tcx, Tag>,
40         flag_op: OpTy<'tcx, Tag>,
41     ) -> InterpResult<'tcx, i32> {
42         let this = self.eval_context_mut();
43
44         this.check_no_isolation("open")?;
45
46         let flag = this.read_scalar(flag_op)?.to_i32()?;
47
48         let mut options = OpenOptions::new();
49
50         let o_rdonly = this.eval_libc_i32("O_RDONLY")?;
51         let o_wronly = this.eval_libc_i32("O_WRONLY")?;
52         let o_rdwr = this.eval_libc_i32("O_RDWR")?;
53         // The first two bits of the flag correspond to the access mode in linux, macOS and
54         // windows. We need to check that in fact the access mode flags for the current platform
55         // only use these two bits, otherwise we are in an unsupported platform and should error.
56         if (o_rdonly | o_wronly | o_rdwr) & !0b11 != 0 {
57             throw_unsup_format!("Access mode flags on this platform are unsupported");
58         }
59         // Now we check the access mode
60         let access_mode = flag & 0b11;
61
62         if access_mode == o_rdonly {
63             options.read(true);
64         } else if access_mode == o_wronly {
65             options.write(true);
66         } else if access_mode == o_rdwr {
67             options.read(true).write(true);
68         } else {
69             throw_unsup_format!("Unsupported access mode {:#x}", access_mode);
70         }
71         // We need to check that there aren't unsupported options in `flag`. For this we try to
72         // reproduce the content of `flag` in the `mirror` variable using only the supported
73         // options.
74         let mut mirror = access_mode;
75
76         let o_append = this.eval_libc_i32("O_APPEND")?;
77         if flag & o_append != 0 {
78             options.append(true);
79             mirror |= o_append;
80         }
81         let o_trunc = this.eval_libc_i32("O_TRUNC")?;
82         if flag & o_trunc != 0 {
83             options.truncate(true);
84             mirror |= o_trunc;
85         }
86         let o_creat = this.eval_libc_i32("O_CREAT")?;
87         if flag & o_creat != 0 {
88             options.create(true);
89             mirror |= o_creat;
90         }
91         let o_cloexec = this.eval_libc_i32("O_CLOEXEC")?;
92         if flag & o_cloexec != 0 {
93             // We do not need to do anything for this flag because `std` already sets it.
94             // (Technically we do not support *not* setting this flag, but we ignore that.)
95             mirror |= o_cloexec;
96         }
97         // If `flag` is not equal to `mirror`, there is an unsupported option enabled in `flag`,
98         // then we throw an error.
99         if flag != mirror {
100             throw_unsup_format!("unsupported flags {:#x}", flag & !mirror);
101         }
102
103         let path = this.read_os_str_from_c_str(this.read_scalar(path_op)?.not_undef()?)?;
104
105         let fd = options.open(&path).map(|file| {
106             let mut fh = &mut this.machine.file_handler;
107             fh.low += 1;
108             fh.handles.insert(fh.low, FileHandle { file }).unwrap_none();
109             fh.low
110         });
111
112         this.try_unwrap_io_result(fd)
113     }
114
115     fn fcntl(
116         &mut self,
117         fd_op: OpTy<'tcx, Tag>,
118         cmd_op: OpTy<'tcx, Tag>,
119         _arg1_op: Option<OpTy<'tcx, Tag>>,
120     ) -> InterpResult<'tcx, i32> {
121         let this = self.eval_context_mut();
122
123         this.check_no_isolation("fcntl")?;
124
125         let fd = this.read_scalar(fd_op)?.to_i32()?;
126         let cmd = this.read_scalar(cmd_op)?.to_i32()?;
127         // We only support getting the flags for a descriptor.
128         if cmd == this.eval_libc_i32("F_GETFD")? {
129             // Currently this is the only flag that `F_GETFD` returns. It is OK to just return the
130             // `FD_CLOEXEC` value without checking if the flag is set for the file because `std`
131             // always sets this flag when opening a file. However we still need to check that the
132             // file itself is open.
133             if this.machine.file_handler.handles.contains_key(&fd) {
134                 Ok(this.eval_libc_i32("FD_CLOEXEC")?)
135             } else {
136                 this.handle_not_found()
137             }
138         } else {
139             throw_unsup_format!("The {:#x} command is not supported for `fcntl`)", cmd);
140         }
141     }
142
143     fn close(&mut self, fd_op: OpTy<'tcx, Tag>) -> InterpResult<'tcx, i32> {
144         let this = self.eval_context_mut();
145
146         this.check_no_isolation("close")?;
147
148         let fd = this.read_scalar(fd_op)?.to_i32()?;
149
150         if let Some(handle) = this.machine.file_handler.handles.remove(&fd) {
151             // `File::sync_all` does the checks that are done when closing a file. We do this to
152             // to handle possible errors correctly.
153             let result = this.try_unwrap_io_result(handle.file.sync_all().map(|_| 0i32));
154             // Now we actually close the file.
155             drop(handle);
156             // And return the result.
157             result
158         } else {
159             this.handle_not_found()
160         }
161     }
162
163     fn read(
164         &mut self,
165         fd_op: OpTy<'tcx, Tag>,
166         buf_op: OpTy<'tcx, Tag>,
167         count_op: OpTy<'tcx, Tag>,
168     ) -> InterpResult<'tcx, i64> {
169         let this = self.eval_context_mut();
170
171         this.check_no_isolation("read")?;
172
173         let fd = this.read_scalar(fd_op)?.to_i32()?;
174         let buf = this.read_scalar(buf_op)?.not_undef()?;
175         let count = this.read_scalar(count_op)?.to_machine_usize(&*this.tcx)?;
176
177         // Check that the *entire* buffer is actually valid memory.
178         this.memory.check_ptr_access(
179             buf,
180             Size::from_bytes(count),
181             Align::from_bytes(1).unwrap(),
182         )?;
183
184         // We cap the number of read bytes to the largest value that we are able to fit in both the
185         // host's and target's `isize`. This saves us from having to handle overflows later.
186         let count = count.min(this.isize_max() as u64).min(isize::max_value() as u64);
187
188         if let Some(handle) = this.machine.file_handler.handles.get_mut(&fd) {
189             // This can never fail because `count` was capped to be smaller than
190             // `isize::max_value()`.
191             let count = isize::try_from(count).unwrap();
192             // We want to read at most `count` bytes. We are sure that `count` is not negative
193             // because it was a target's `usize`. Also we are sure that its smaller than
194             // `usize::max_value()` because it is a host's `isize`.
195             let mut bytes = vec![0; count as usize];
196             let result = handle
197                 .file
198                 .read(&mut bytes)
199                 // `File::read` never returns a value larger than `count`, so this cannot fail.
200                 .map(|c| i64::try_from(c).unwrap());
201
202             match result {
203                 Ok(read_bytes) => {
204                     // If reading to `bytes` did not fail, we write those bytes to the buffer.
205                     this.memory.write_bytes(buf, bytes)?;
206                     Ok(read_bytes)
207                 }
208                 Err(e) => {
209                     this.set_last_error_from_io_error(e)?;
210                     Ok(-1)
211                 }
212             }
213         } else {
214             this.handle_not_found()
215         }
216     }
217
218     fn write(
219         &mut self,
220         fd_op: OpTy<'tcx, Tag>,
221         buf_op: OpTy<'tcx, Tag>,
222         count_op: OpTy<'tcx, Tag>,
223     ) -> InterpResult<'tcx, i64> {
224         let this = self.eval_context_mut();
225
226         this.check_no_isolation("write")?;
227
228         let fd = this.read_scalar(fd_op)?.to_i32()?;
229         let buf = this.read_scalar(buf_op)?.not_undef()?;
230         let count = this.read_scalar(count_op)?.to_machine_usize(&*this.tcx)?;
231
232         // Check that the *entire* buffer is actually valid memory.
233         this.memory.check_ptr_access(
234             buf,
235             Size::from_bytes(count),
236             Align::from_bytes(1).unwrap(),
237         )?;
238
239         // We cap the number of written bytes to the largest value that we are able to fit in both the
240         // host's and target's `isize`. This saves us from having to handle overflows later.
241         let count = count.min(this.isize_max() as u64).min(isize::max_value() as u64);
242
243         if let Some(handle) = this.machine.file_handler.handles.get_mut(&fd) {
244             let bytes = this.memory.read_bytes(buf, Size::from_bytes(count))?;
245             let result = handle.file.write(&bytes).map(|c| i64::try_from(c).unwrap());
246             this.try_unwrap_io_result(result)
247         } else {
248             this.handle_not_found()
249         }
250     }
251
252     fn unlink(&mut self, path_op: OpTy<'tcx, Tag>) -> InterpResult<'tcx, i32> {
253         let this = self.eval_context_mut();
254
255         this.check_no_isolation("unlink")?;
256
257         let path = this.read_os_str_from_c_str(this.read_scalar(path_op)?.not_undef()?)?;
258
259         let result = remove_file(path).map(|_| 0);
260
261         this.try_unwrap_io_result(result)
262     }
263
264     fn stat(
265         &mut self,
266         path_op: OpTy<'tcx, Tag>,
267         buf_op: OpTy<'tcx, Tag>,
268     ) -> InterpResult<'tcx, i32> {
269         let this = self.eval_context_mut();
270
271         if this.tcx.sess.target.target.target_os.to_lowercase() != "macos" {
272             throw_unsup_format!("The `stat` shim is only only available for `macos` targets.")
273         }
274
275         let path_scalar = this.read_scalar(path_op)?.not_undef()?;
276         let path: PathBuf = this.read_os_str_from_c_str(path_scalar)?.into();
277
278         let buf = this.deref_operand(buf_op)?;
279
280         let status = match FileStatus::new(this, path, false)? {
281             Some(status) => status,
282             None => return Ok(-1),
283         };
284
285         // FIXME: use Scalar::to_u16
286         let mode: u16 = status.mode.to_bits(Size::from_bits(16))? as u16;
287
288         let (access_sec, access_nsec) = status.accessed.unwrap_or((0, 0));
289         let (created_sec, created_nsec) = status.created.unwrap_or((0, 0));
290         let (modified_sec, modified_nsec) = status.modified.unwrap_or((0, 0));
291
292         let dev_t_layout = this.libc_ty_layout("dev_t")?;
293         let mode_t_layout = this.libc_ty_layout("mode_t")?;
294         let nlink_t_layout = this.libc_ty_layout("nlink_t")?;
295         let ino_t_layout = this.libc_ty_layout("ino_t")?;
296         let uid_t_layout = this.libc_ty_layout("uid_t")?;
297         let gid_t_layout = this.libc_ty_layout("gid_t")?;
298         let time_t_layout = this.libc_ty_layout("time_t")?;
299         let long_layout = this.libc_ty_layout("c_long")?;
300         let off_t_layout = this.libc_ty_layout("off_t")?;
301         let blkcnt_t_layout = this.libc_ty_layout("blkcnt_t")?;
302         let blksize_t_layout = this.libc_ty_layout("blksize_t")?;
303         let uint32_t_layout = this.libc_ty_layout("uint32_t")?;
304
305         // We need to add 32 bits of padding after `st_rdev` if we are in a 64-bit platform.
306         let pad_layout = if this.tcx.sess.target.ptr_width == 64 {
307             uint32_t_layout
308         } else {
309             this.layout_of(this.tcx.mk_unit())?
310         };
311
312         let imms = [
313             immty_from_uint_checked(0u128, dev_t_layout)?, // st_dev
314             immty_from_uint_checked(mode, mode_t_layout)?, // st_mode
315             immty_from_uint_checked(0u128, nlink_t_layout)?, // st_nlink
316             immty_from_uint_checked(0u128, ino_t_layout)?, // st_ino
317             immty_from_uint_checked(0u128, uid_t_layout)?, // st_uid
318             immty_from_uint_checked(0u128, gid_t_layout)?, // st_gid
319             immty_from_uint_checked(0u128, dev_t_layout)?, // st_rdev
320             immty_from_uint_checked(0u128, pad_layout)?, // padding for 64-bit targets
321             immty_from_uint_checked(access_sec, time_t_layout)?, // st_atime
322             immty_from_uint_checked(access_nsec, long_layout)?, // st_atime_nsec
323             immty_from_uint_checked(modified_sec, time_t_layout)?, // st_mtime
324             immty_from_uint_checked(modified_nsec, long_layout)?, // st_mtime_nsec
325             immty_from_uint_checked(0u128, time_t_layout)?, // st_ctime
326             immty_from_uint_checked(0u128, long_layout)?, // st_ctime_nsec
327             immty_from_uint_checked(created_sec, time_t_layout)?, // st_birthtime
328             immty_from_uint_checked(created_nsec, long_layout)?, // st_birthtime_nsec
329             immty_from_uint_checked(status.size, off_t_layout)?, // st_size
330             immty_from_uint_checked(0u128, blkcnt_t_layout)?, // st_blocks
331             immty_from_uint_checked(0u128, blksize_t_layout)?, // st_blksize
332             immty_from_uint_checked(0u128, uint32_t_layout)?, // st_flags
333             immty_from_uint_checked(0u128, uint32_t_layout)?, // st_gen
334         ];
335
336         this.write_packed_immediates(&buf, &imms)?;
337
338         Ok(0)
339     }
340
341     fn statx(
342         &mut self,
343         dirfd_op: OpTy<'tcx, Tag>,    // Should be an `int`
344         pathname_op: OpTy<'tcx, Tag>, // Should be a `const char *`
345         flags_op: OpTy<'tcx, Tag>,    // Should be an `int`
346         _mask_op: OpTy<'tcx, Tag>,    // Should be an `unsigned int`
347         statxbuf_op: OpTy<'tcx, Tag>, // Should be a `struct statx *`
348     ) -> InterpResult<'tcx, i32> {
349         let this = self.eval_context_mut();
350
351         this.check_no_isolation("statx")?;
352
353         if this.tcx.sess.target.target.target_os.to_lowercase() != "linux" {
354             throw_unsup_format!("The `statx` shim is only only available for `linux` targets.")
355         }
356
357         let statxbuf_scalar = this.read_scalar(statxbuf_op)?.not_undef()?;
358         let pathname_scalar = this.read_scalar(pathname_op)?.not_undef()?;
359
360         // If the statxbuf or pathname pointers are null, the function fails with `EFAULT`.
361         if this.is_null(statxbuf_scalar)? || this.is_null(pathname_scalar)? {
362             let efault = this.eval_libc("EFAULT")?;
363             this.set_last_error(efault)?;
364             return Ok(-1);
365         }
366
367         // Under normal circumstances, we would use `deref_operand(statxbuf_op)` to produce a
368         // proper `MemPlace` and then write the results of this function to it. However, the
369         // `syscall` function is untyped. This means that all the `statx` parameters are provided
370         // as `isize`s instead of having the proper types. Thus, we have to recover the layout of
371         // `statxbuf_op` by using the `libc::statx` struct type.
372         let statxbuf_place = {
373             // FIXME: This long path is required because `libc::statx` is an struct and also a
374             // function and `resolve_path` is returning the latter.
375             let statx_ty = this
376                 .resolve_path(&["libc", "unix", "linux_like", "linux", "gnu", "statx"])?
377                 .ty(*this.tcx);
378             let statxbuf_ty = this.tcx.mk_mut_ptr(statx_ty);
379             let statxbuf_layout = this.layout_of(statxbuf_ty)?;
380             let statxbuf_imm = ImmTy::from_scalar(statxbuf_scalar, statxbuf_layout);
381             this.ref_to_mplace(statxbuf_imm)?
382         };
383
384         let path: PathBuf = this.read_os_str_from_c_str(pathname_scalar)?.into();
385         // `flags` should be a `c_int` but the `syscall` function provides an `isize`.
386         let flags: i32 =
387             this.read_scalar(flags_op)?.to_machine_isize(&*this.tcx)?.try_into().map_err(|e| {
388                 err_unsup_format!("Failed to convert pointer sized operand to integer: {}", e)
389             })?;
390         // `dirfd` should be a `c_int` but the `syscall` function provides an `isize`.
391         let dirfd: i32 =
392             this.read_scalar(dirfd_op)?.to_machine_isize(&*this.tcx)?.try_into().map_err(|e| {
393                 err_unsup_format!("Failed to convert pointer sized operand to integer: {}", e)
394             })?;
395         // we only support interpreting `path` as an absolute directory or as a directory relative
396         // to `dirfd` when the latter is `AT_FDCWD`. The behavior of `statx` with a relative path
397         // and a directory file descriptor other than `AT_FDCWD` is specified but it cannot be
398         // tested from `libstd`. If you found this error, please open an issue reporting it.
399         if !(path.is_absolute() || dirfd == this.eval_libc_i32("AT_FDCWD")?) {
400             throw_unsup_format!(
401                 "Using statx with a relative path and a file descriptor different from `AT_FDCWD` is not supported"
402             )
403         }
404
405         // the `_mask_op` paramter specifies the file information that the caller requested.
406         // However `statx` is allowed to return information that was not requested or to not
407         // return information that was requested. This `mask` represents the information we can
408         // actually provide in any host platform.
409         let mut mask =
410             this.eval_libc("STATX_TYPE")?.to_u32()? | this.eval_libc("STATX_SIZE")?.to_u32()?;
411
412         // If the `AT_SYMLINK_NOFOLLOW` flag is set, we query the file's metadata without following
413         // symbolic links.
414         let follow_symlink = flags & this.eval_libc("AT_SYMLINK_NOFOLLOW")?.to_i32()? == 0;
415
416         let status = match FileStatus::new(this, path, follow_symlink)? {
417             Some(status) => status,
418             None => return Ok(-1),
419         };
420
421         // The `mode` field specifies the type of the file and the permissions over the file for
422         // the owner, its group and other users. Given that we can only provide the file type
423         // without using platform specific methods, we only set the bits corresponding to the file
424         // type. This should be an `__u16` but `libc` provides its values as `u32`.
425         let mode: u16 = status
426             .mode
427             .to_u32()?
428             .try_into()
429             .unwrap_or_else(|_| bug!("libc contains bad value for constant"));
430
431         // We need to set the corresponding bits of `mask` if the access, creation and modification
432         // times were available. Otherwise we let them be zero.
433         let (access_sec, access_nsec) = status.accessed.map(|tup| {
434             mask |= this.eval_libc("STATX_ATIME")?.to_u32()?;
435             InterpResult::Ok(tup)
436         }).unwrap_or(Ok((0, 0)))?;
437
438         let (created_sec, created_nsec) = status.created.map(|tup| {
439             mask |= this.eval_libc("STATX_BTIME")?.to_u32()?;
440             InterpResult::Ok(tup)
441         }).unwrap_or(Ok((0, 0)))?;
442
443         let (modified_sec, modified_nsec) = status.modified.map(|tup| {
444             mask |= this.eval_libc("STATX_MTIME")?.to_u32()?;
445             InterpResult::Ok(tup)
446         }).unwrap_or(Ok((0, 0)))?;
447
448         let __u32_layout = this.libc_ty_layout("__u32")?;
449         let __u64_layout = this.libc_ty_layout("__u64")?;
450         let __u16_layout = this.libc_ty_layout("__u16")?;
451
452         // Now we transform all this fields into `ImmTy`s and write them to `statxbuf`. We write a
453         // zero for the unavailable fields.
454         let imms = [
455             immty_from_uint_checked(mask, __u32_layout)?, // stx_mask
456             immty_from_uint_checked(0u128, __u32_layout)?, // stx_blksize
457             immty_from_uint_checked(0u128, __u64_layout)?, // stx_attributes
458             immty_from_uint_checked(0u128, __u32_layout)?, // stx_nlink
459             immty_from_uint_checked(0u128, __u32_layout)?, // stx_uid
460             immty_from_uint_checked(0u128, __u32_layout)?, // stx_gid
461             immty_from_uint_checked(mode, __u16_layout)?, // stx_mode
462             immty_from_uint_checked(0u128, __u16_layout)?, // statx padding
463             immty_from_uint_checked(0u128, __u64_layout)?, // stx_ino
464             immty_from_uint_checked(status.size, __u64_layout)?, // stx_size
465             immty_from_uint_checked(0u128, __u64_layout)?, // stx_blocks
466             immty_from_uint_checked(0u128, __u64_layout)?, // stx_attributes
467             immty_from_uint_checked(access_sec, __u64_layout)?, // stx_atime.tv_sec
468             immty_from_uint_checked(access_nsec, __u32_layout)?, // stx_atime.tv_nsec
469             immty_from_uint_checked(0u128, __u32_layout)?, // statx_timestamp padding
470             immty_from_uint_checked(created_sec, __u64_layout)?, // stx_btime.tv_sec
471             immty_from_uint_checked(created_nsec, __u32_layout)?, // stx_btime.tv_nsec
472             immty_from_uint_checked(0u128, __u32_layout)?, // statx_timestamp padding
473             immty_from_uint_checked(0u128, __u64_layout)?, // stx_ctime.tv_sec
474             immty_from_uint_checked(0u128, __u32_layout)?, // stx_ctime.tv_nsec
475             immty_from_uint_checked(0u128, __u32_layout)?, // statx_timestamp padding
476             immty_from_uint_checked(modified_sec, __u64_layout)?, // stx_mtime.tv_sec
477             immty_from_uint_checked(modified_nsec, __u32_layout)?, // stx_mtime.tv_nsec
478             immty_from_uint_checked(0u128, __u32_layout)?, // statx_timestamp padding
479             immty_from_uint_checked(0u128, __u64_layout)?, // stx_rdev_major
480             immty_from_uint_checked(0u128, __u64_layout)?, // stx_rdev_minor
481             immty_from_uint_checked(0u128, __u64_layout)?, // stx_dev_major
482             immty_from_uint_checked(0u128, __u64_layout)?, // stx_dev_minor
483         ];
484
485         this.write_packed_immediates(&statxbuf_place, &imms)?;
486
487         Ok(0)
488     }
489
490     /// Function used when a handle is not found inside `FileHandler`. It returns `Ok(-1)`and sets
491     /// the last OS error to `libc::EBADF` (invalid file descriptor). This function uses
492     /// `T: From<i32>` instead of `i32` directly because some fs functions return different integer
493     /// types (like `read`, that returns an `i64`).
494     fn handle_not_found<T: From<i32>>(&mut self) -> InterpResult<'tcx, T> {
495         let this = self.eval_context_mut();
496         let ebadf = this.eval_libc("EBADF")?;
497         this.set_last_error(ebadf)?;
498         Ok((-1).into())
499     }
500 }
501
502 /// Extracts the number of seconds and nanoseconds elapsed between `time` and the unix epoch when
503 /// `time` is Ok. Returns `None` if `time` is an error. Fails if `time` happens before the unix
504 /// epoch.
505 fn extract_sec_and_nsec<'tcx>(
506     time: std::io::Result<SystemTime>
507 ) -> InterpResult<'tcx, Option<(u64, u32)>> {
508     time.ok().map(|time| {
509         let duration = system_time_to_duration(&time)?;
510         Ok((duration.as_secs(), duration.subsec_nanos()))
511     }).transpose()
512 }
513
514 struct FileStatus {
515     mode: Scalar<Tag>,
516     size: u64,
517     created: Option<(u64, u32)>,
518     accessed: Option<(u64, u32)>,
519     modified: Option<(u64, u32)>,
520 }
521
522 impl FileStatus {
523     fn new<'tcx, 'mir>(
524         ecx: &mut MiriEvalContext<'mir, 'tcx>,
525         path: PathBuf,
526         follow_symlink: bool
527     ) -> InterpResult<'tcx, Option<FileStatus>> {
528         let metadata = if follow_symlink {
529             // FIXME: metadata for symlinks need testing.
530             std::fs::symlink_metadata(path)
531         } else {
532             std::fs::metadata(path)
533         };
534
535         let metadata = match metadata {
536             Ok(metadata) => metadata,
537             Err(e) => {
538                 ecx.set_last_error_from_io_error(e)?;
539                 return Ok(None);
540             }
541         };
542
543         let file_type = metadata.file_type();
544
545         let mode_name = if file_type.is_file() {
546             "S_IFREG"
547         } else if file_type.is_dir() {
548             "S_IFDIR"
549         } else {
550             "S_IFLNK"
551         };
552
553         let mode = ecx.eval_libc(mode_name)?;
554
555         let size = metadata.len();
556
557         let created = extract_sec_and_nsec(metadata.created())?;
558         let accessed = extract_sec_and_nsec(metadata.accessed())?;
559         let modified = extract_sec_and_nsec(metadata.modified())?;
560
561         // FIXME: Provide more fields using platform specific methods.
562         Ok(Some(FileStatus { mode, size, created, accessed, modified }))
563     }
564 }