1 use crate::os::unix::prelude::*;
3 use crate::ffi::{CStr, OsStr, OsString};
5 use crate::io::{self, BorrowedCursor, Error, IoSlice, IoSliceMut, SeekFrom};
7 use crate::os::unix::io::{AsFd, AsRawFd, BorrowedFd, FromRawFd, IntoRawFd};
8 use crate::path::{Path, PathBuf};
11 use crate::sys::common::small_c_string::run_path_with_cstr;
12 use crate::sys::fd::FileDesc;
13 use crate::sys::time::SystemTime;
14 use crate::sys::{cvt, cvt_r};
15 use crate::sys_common::{AsInner, AsInnerMut, FromInner, IntoInner};
18 all(target_os = "linux", target_env = "gnu"),
21 target_os = "watchos",
23 use crate::sys::weak::syscall;
24 #[cfg(any(target_os = "android", target_os = "macos"))]
25 use crate::sys::weak::weak;
27 use libc::{c_int, mode_t};
32 target_os = "watchos",
33 all(target_os = "linux", target_env = "gnu")
36 #[cfg(any(target_os = "linux", target_os = "emscripten", target_os = "android"))]
38 #[cfg(any(target_os = "linux", target_os = "emscripten"))]
41 target_os = "android",
42 target_os = "solaris",
43 target_os = "fuchsia",
47 use libc::readdir as readdir64;
48 #[cfg(target_os = "linux")]
50 #[cfg(any(target_os = "emscripten", target_os = "l4re"))]
51 use libc::readdir64_r;
53 target_os = "android",
55 target_os = "emscripten",
56 target_os = "solaris",
57 target_os = "illumos",
59 target_os = "fuchsia",
62 use libc::readdir_r as readdir64_r;
63 #[cfg(target_os = "android")]
65 dirent as dirent64, fstat as fstat64, fstatat as fstatat64, ftruncate64, lseek64,
66 lstat as lstat64, off64_t, open as open64, stat as stat64,
70 target_os = "emscripten",
75 dirent as dirent64, fstat as fstat64, ftruncate as ftruncate64, lseek as lseek64,
76 lstat as lstat64, off_t as off64_t, open as open64, stat as stat64,
78 #[cfg(any(target_os = "linux", target_os = "emscripten", target_os = "l4re"))]
79 use libc::{dirent64, fstat64, ftruncate64, lseek64, lstat64, off64_t, open64, stat64};
81 pub use crate::sys_common::fs::try_exists;
83 pub struct File(FileDesc);
85 // FIXME: This should be available on Linux with all `target_env`.
86 // But currently only glibc exposes `statx` fn and structs.
87 // We don't want to import unverified raw C structs here directly.
88 // https://github.com/rust-lang/rust/pull/67774
89 macro_rules! cfg_has_statx {
90 ({ $($then_tt:tt)* } else { $($else_tt:tt)* }) => {
92 if #[cfg(all(target_os = "linux", target_env = "gnu"))] {
99 ($($block_inner:tt)*) => {
100 #[cfg(all(target_os = "linux", target_env = "gnu"))]
109 pub struct FileAttr {
111 statx_extra_fields: Option<StatxExtraFields>,
115 struct StatxExtraFields {
116 // This is needed to check if btime is supported by the filesystem.
118 stx_btime: libc::statx_timestamp,
119 // With statx, we can overcome 32-bit `time_t` too.
120 #[cfg(target_pointer_width = "32")]
121 stx_atime: libc::statx_timestamp,
122 #[cfg(target_pointer_width = "32")]
123 stx_ctime: libc::statx_timestamp,
124 #[cfg(target_pointer_width = "32")]
125 stx_mtime: libc::statx_timestamp,
129 // We prefer `statx` on Linux if available, which contains file creation time,
130 // as well as 64-bit timestamps of all kinds.
131 // Default `stat64` contains no creation time and may have 32-bit `time_t`.
137 ) -> Option<io::Result<FileAttr>> {
138 use crate::sync::atomic::{AtomicU8, Ordering};
140 // Linux kernel prior to 4.11 or glibc prior to glibc 2.28 don't support `statx`
141 // We store the availability in global to avoid unnecessary syscalls.
145 static STATX_STATE: AtomicU8 = AtomicU8::new(0);
149 pathname: *const c_char,
152 statxbuf: *mut libc::statx
156 match STATX_STATE.load(Ordering::Relaxed) {
158 // It is a trick to call `statx` with null pointers to check if the syscall
159 // is available. According to the manual, it is expected to fail with EFAULT.
160 // We do this mainly for performance, since it is nearly hundreds times
161 // faster than a normal successful call.
162 let err = cvt(statx(0, ptr::null(), 0, libc::STATX_ALL, ptr::null_mut()))
164 .and_then(|e| e.raw_os_error());
165 // We don't check `err == Some(libc::ENOSYS)` because the syscall may be limited
166 // and returns `EPERM`. Listing all possible errors seems not a good idea.
167 // See: https://github.com/rust-lang/rust/issues/65662
168 if err != Some(libc::EFAULT) {
169 STATX_STATE.store(1, Ordering::Relaxed);
172 STATX_STATE.store(2, Ordering::Relaxed);
178 let mut buf: libc::statx = mem::zeroed();
179 if let Err(err) = cvt(statx(fd, path, flags, mask, &mut buf)) {
180 return Some(Err(err));
183 // We cannot fill `stat64` exhaustively because of private padding fields.
184 let mut stat: stat64 = mem::zeroed();
185 // `c_ulong` on gnu-mips, `dev_t` otherwise
186 stat.st_dev = libc::makedev(buf.stx_dev_major, buf.stx_dev_minor) as _;
187 stat.st_ino = buf.stx_ino as libc::ino64_t;
188 stat.st_nlink = buf.stx_nlink as libc::nlink_t;
189 stat.st_mode = buf.stx_mode as libc::mode_t;
190 stat.st_uid = buf.stx_uid as libc::uid_t;
191 stat.st_gid = buf.stx_gid as libc::gid_t;
192 stat.st_rdev = libc::makedev(buf.stx_rdev_major, buf.stx_rdev_minor) as _;
193 stat.st_size = buf.stx_size as off64_t;
194 stat.st_blksize = buf.stx_blksize as libc::blksize_t;
195 stat.st_blocks = buf.stx_blocks as libc::blkcnt64_t;
196 stat.st_atime = buf.stx_atime.tv_sec as libc::time_t;
197 // `i64` on gnu-x86_64-x32, `c_ulong` otherwise.
198 stat.st_atime_nsec = buf.stx_atime.tv_nsec as _;
199 stat.st_mtime = buf.stx_mtime.tv_sec as libc::time_t;
200 stat.st_mtime_nsec = buf.stx_mtime.tv_nsec as _;
201 stat.st_ctime = buf.stx_ctime.tv_sec as libc::time_t;
202 stat.st_ctime_nsec = buf.stx_ctime.tv_nsec as _;
204 let extra = StatxExtraFields {
205 stx_mask: buf.stx_mask,
206 stx_btime: buf.stx_btime,
207 // Store full times to avoid 32-bit `time_t` truncation.
208 #[cfg(target_pointer_width = "32")]
209 stx_atime: buf.stx_atime,
210 #[cfg(target_pointer_width = "32")]
211 stx_ctime: buf.stx_ctime,
212 #[cfg(target_pointer_width = "32")]
213 stx_mtime: buf.stx_mtime,
216 Some(Ok(FileAttr { stat, statx_extra_fields: Some(extra) }))
221 pub struct FileAttr {
226 // all DirEntry's will have a reference to this struct
227 struct InnerReadDir {
233 inner: Arc<InnerReadDir>,
235 target_os = "android",
237 target_os = "solaris",
238 target_os = "illumos",
239 target_os = "fuchsia",
245 struct Dir(*mut libc::DIR);
247 unsafe impl Send for Dir {}
248 unsafe impl Sync for Dir {}
251 target_os = "android",
253 target_os = "solaris",
254 target_os = "illumos",
255 target_os = "fuchsia",
258 pub struct DirEntry {
259 dir: Arc<InnerReadDir>,
261 // We need to store an owned copy of the entry name on platforms that use
262 // readdir() (not readdir_r()), because a) struct dirent may use a flexible
263 // array to store the name, b) it lives only until the next readdir() call.
264 name: crate::ffi::CString,
267 // Define a minimal subset of fields we need from `dirent64`, especially since
268 // we're not using the immediate `d_name` on these targets. Keeping this as an
269 // `entry` field in `DirEntry` helps reduce the `cfg` boilerplate elsewhere.
271 target_os = "android",
273 target_os = "solaris",
274 target_os = "illumos",
275 target_os = "fuchsia",
278 struct dirent64_min {
280 #[cfg(not(any(target_os = "solaris", target_os = "illumos")))]
285 target_os = "android",
287 target_os = "solaris",
288 target_os = "illumos",
289 target_os = "fuchsia",
292 pub struct DirEntry {
293 dir: Arc<InnerReadDir>,
294 // The full entry includes a fixed-length `d_name`.
298 #[derive(Clone, Debug)]
299 pub struct OpenOptions {
312 #[derive(Clone, PartialEq, Eq, Debug)]
313 pub struct FilePermissions {
317 #[derive(Copy, Clone, Debug, Default)]
318 pub struct FileTimes {
319 accessed: Option<SystemTime>,
320 modified: Option<SystemTime>,
323 #[derive(Copy, Clone, PartialEq, Eq, Hash, Debug)]
324 pub struct FileType {
329 pub struct DirBuilder {
335 fn from_stat64(stat: stat64) -> Self {
336 Self { stat, statx_extra_fields: None }
339 #[cfg(target_pointer_width = "32")]
340 pub fn stx_mtime(&self) -> Option<&libc::statx_timestamp> {
341 if let Some(ext) = &self.statx_extra_fields {
342 if (ext.stx_mask & libc::STATX_MTIME) != 0 {
343 return Some(&ext.stx_mtime);
349 #[cfg(target_pointer_width = "32")]
350 pub fn stx_atime(&self) -> Option<&libc::statx_timestamp> {
351 if let Some(ext) = &self.statx_extra_fields {
352 if (ext.stx_mask & libc::STATX_ATIME) != 0 {
353 return Some(&ext.stx_atime);
359 #[cfg(target_pointer_width = "32")]
360 pub fn stx_ctime(&self) -> Option<&libc::statx_timestamp> {
361 if let Some(ext) = &self.statx_extra_fields {
362 if (ext.stx_mask & libc::STATX_CTIME) != 0 {
363 return Some(&ext.stx_ctime);
371 fn from_stat64(stat: stat64) -> Self {
378 pub fn size(&self) -> u64 {
379 self.stat.st_size as u64
381 pub fn perm(&self) -> FilePermissions {
382 FilePermissions { mode: (self.stat.st_mode as mode_t) }
385 pub fn file_type(&self) -> FileType {
386 FileType { mode: self.stat.st_mode as mode_t }
390 #[cfg(target_os = "netbsd")]
392 pub fn modified(&self) -> io::Result<SystemTime> {
393 Ok(SystemTime::new(self.stat.st_mtime as i64, self.stat.st_mtimensec as i64))
396 pub fn accessed(&self) -> io::Result<SystemTime> {
397 Ok(SystemTime::new(self.stat.st_atime as i64, self.stat.st_atimensec as i64))
400 pub fn created(&self) -> io::Result<SystemTime> {
401 Ok(SystemTime::new(self.stat.st_birthtime as i64, self.stat.st_birthtimensec as i64))
405 #[cfg(not(target_os = "netbsd"))]
407 #[cfg(not(any(target_os = "vxworks", target_os = "espidf", target_os = "horizon")))]
408 pub fn modified(&self) -> io::Result<SystemTime> {
409 #[cfg(target_pointer_width = "32")]
411 if let Some(mtime) = self.stx_mtime() {
412 return Ok(SystemTime::new(mtime.tv_sec, mtime.tv_nsec as i64));
416 Ok(SystemTime::new(self.stat.st_mtime as i64, self.stat.st_mtime_nsec as i64))
419 #[cfg(any(target_os = "vxworks", target_os = "espidf"))]
420 pub fn modified(&self) -> io::Result<SystemTime> {
421 Ok(SystemTime::new(self.stat.st_mtime as i64, 0))
424 #[cfg(target_os = "horizon")]
425 pub fn modified(&self) -> io::Result<SystemTime> {
426 Ok(SystemTime::from(self.stat.st_mtim))
429 #[cfg(not(any(target_os = "vxworks", target_os = "espidf", target_os = "horizon")))]
430 pub fn accessed(&self) -> io::Result<SystemTime> {
431 #[cfg(target_pointer_width = "32")]
433 if let Some(atime) = self.stx_atime() {
434 return Ok(SystemTime::new(atime.tv_sec, atime.tv_nsec as i64));
438 Ok(SystemTime::new(self.stat.st_atime as i64, self.stat.st_atime_nsec as i64))
441 #[cfg(any(target_os = "vxworks", target_os = "espidf"))]
442 pub fn accessed(&self) -> io::Result<SystemTime> {
443 Ok(SystemTime::new(self.stat.st_atime as i64, 0))
446 #[cfg(target_os = "horizon")]
447 pub fn accessed(&self) -> io::Result<SystemTime> {
448 Ok(SystemTime::from(self.stat.st_atim))
452 target_os = "freebsd",
453 target_os = "openbsd",
456 target_os = "watchos",
458 pub fn created(&self) -> io::Result<SystemTime> {
459 Ok(SystemTime::new(self.stat.st_birthtime as i64, self.stat.st_birthtime_nsec as i64))
463 target_os = "freebsd",
464 target_os = "openbsd",
467 target_os = "watchos",
469 pub fn created(&self) -> io::Result<SystemTime> {
471 if let Some(ext) = &self.statx_extra_fields {
472 return if (ext.stx_mask & libc::STATX_BTIME) != 0 {
473 Ok(SystemTime::new(ext.stx_btime.tv_sec, ext.stx_btime.tv_nsec as i64))
475 Err(io::const_io_error!(
476 io::ErrorKind::Uncategorized,
477 "creation time is not available for the filesystem",
483 Err(io::const_io_error!(
484 io::ErrorKind::Unsupported,
485 "creation time is not available on this platform \
491 impl AsInner<stat64> for FileAttr {
492 fn as_inner(&self) -> &stat64 {
497 impl FilePermissions {
498 pub fn readonly(&self) -> bool {
499 // check if any class (owner, group, others) has write permission
500 self.mode & 0o222 == 0
503 pub fn set_readonly(&mut self, readonly: bool) {
505 // remove write permission for all classes; equivalent to `chmod a-w <file>`
508 // add write permission for all classes; equivalent to `chmod a+w <file>`
512 pub fn mode(&self) -> u32 {
518 pub fn set_accessed(&mut self, t: SystemTime) {
519 self.accessed = Some(t);
522 pub fn set_modified(&mut self, t: SystemTime) {
523 self.modified = Some(t);
528 pub fn is_dir(&self) -> bool {
529 self.is(libc::S_IFDIR)
531 pub fn is_file(&self) -> bool {
532 self.is(libc::S_IFREG)
534 pub fn is_symlink(&self) -> bool {
535 self.is(libc::S_IFLNK)
538 pub fn is(&self, mode: mode_t) -> bool {
539 self.mode & libc::S_IFMT == mode
543 impl FromInner<u32> for FilePermissions {
544 fn from_inner(mode: u32) -> FilePermissions {
545 FilePermissions { mode: mode as mode_t }
549 impl fmt::Debug for ReadDir {
550 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
551 // This will only be called from std::fs::ReadDir, which will add a "ReadDir()" frame.
552 // Thus the result will be e g 'ReadDir("/home")'
553 fmt::Debug::fmt(&*self.inner.root, f)
557 impl Iterator for ReadDir {
558 type Item = io::Result<DirEntry>;
561 target_os = "android",
563 target_os = "solaris",
564 target_os = "fuchsia",
566 target_os = "illumos"
568 fn next(&mut self) -> Option<io::Result<DirEntry>> {
571 // As of POSIX.1-2017, readdir() is not required to be thread safe; only
572 // readdir_r() is. However, readdir_r() cannot correctly handle platforms
573 // with unlimited or variable NAME_MAX. Many modern platforms guarantee
574 // thread safety for readdir() as long an individual DIR* is not accessed
575 // concurrently, which is sufficient for Rust.
576 super::os::set_errno(0);
577 let entry_ptr = readdir64(self.inner.dirp.0);
578 if entry_ptr.is_null() {
579 // null can mean either the end is reached or an error occurred.
580 // So we had to clear errno beforehand to check for an error now.
581 return match super::os::errno() {
583 e => Some(Err(Error::from_raw_os_error(e))),
587 // Only d_reclen bytes of *entry_ptr are valid, so we can't just copy the
588 // whole thing (#93384). Instead, copy everything except the name.
589 let mut copy: dirent64 = mem::zeroed();
590 // Can't dereference entry_ptr, so use the local entry to get
591 // offsetof(struct dirent, d_name)
592 let copy_bytes = &mut copy as *mut _ as *mut u8;
593 let copy_name = &mut copy.d_name as *mut _ as *mut u8;
594 let name_offset = copy_name.offset_from(copy_bytes) as usize;
595 let entry_bytes = entry_ptr as *const u8;
596 let entry_name = entry_bytes.add(name_offset);
597 ptr::copy_nonoverlapping(entry_bytes, copy_bytes, name_offset);
599 let entry = dirent64_min {
600 d_ino: copy.d_ino as u64,
601 #[cfg(not(any(target_os = "solaris", target_os = "illumos")))]
602 d_type: copy.d_type as u8,
607 // d_name is guaranteed to be null-terminated.
608 name: CStr::from_ptr(entry_name as *const _).to_owned(),
609 dir: Arc::clone(&self.inner),
611 if ret.name_bytes() != b"." && ret.name_bytes() != b".." {
612 return Some(Ok(ret));
619 target_os = "android",
621 target_os = "solaris",
622 target_os = "fuchsia",
624 target_os = "illumos"
626 fn next(&mut self) -> Option<io::Result<DirEntry>> {
627 if self.end_of_stream {
632 let mut ret = DirEntry { entry: mem::zeroed(), dir: Arc::clone(&self.inner) };
633 let mut entry_ptr = ptr::null_mut();
635 let err = readdir64_r(self.inner.dirp.0, &mut ret.entry, &mut entry_ptr);
637 if entry_ptr.is_null() {
638 // We encountered an error (which will be returned in this iteration), but
639 // we also reached the end of the directory stream. The `end_of_stream`
640 // flag is enabled to make sure that we return `None` in the next iteration
641 // (instead of looping forever)
642 self.end_of_stream = true;
644 return Some(Err(Error::from_raw_os_error(err)));
646 if entry_ptr.is_null() {
649 if ret.name_bytes() != b"." && ret.name_bytes() != b".." {
650 return Some(Ok(ret));
659 let r = unsafe { libc::closedir(self.0) };
661 r == 0 || crate::io::Error::last_os_error().kind() == crate::io::ErrorKind::Interrupted,
662 "unexpected error during closedir: {:?}",
663 crate::io::Error::last_os_error()
669 pub fn path(&self) -> PathBuf {
670 self.dir.root.join(self.file_name_os_str())
673 pub fn file_name(&self) -> OsString {
674 self.file_name_os_str().to_os_string()
678 any(target_os = "linux", target_os = "emscripten", target_os = "android"),
681 pub fn metadata(&self) -> io::Result<FileAttr> {
682 let fd = cvt(unsafe { dirfd(self.dir.dirp.0) })?;
683 let name = self.name_cstr().as_ptr();
686 if let Some(ret) = unsafe { try_statx(
689 libc::AT_SYMLINK_NOFOLLOW | libc::AT_STATX_SYNC_AS_STAT,
696 let mut stat: stat64 = unsafe { mem::zeroed() };
697 cvt(unsafe { fstatat64(fd, name, &mut stat, libc::AT_SYMLINK_NOFOLLOW) })?;
698 Ok(FileAttr::from_stat64(stat))
702 not(any(target_os = "linux", target_os = "emscripten", target_os = "android")),
705 pub fn metadata(&self) -> io::Result<FileAttr> {
710 target_os = "solaris",
711 target_os = "illumos",
713 target_os = "vxworks"
715 pub fn file_type(&self) -> io::Result<FileType> {
716 self.metadata().map(|m| m.file_type())
720 target_os = "solaris",
721 target_os = "illumos",
723 target_os = "vxworks"
725 pub fn file_type(&self) -> io::Result<FileType> {
726 match self.entry.d_type {
727 libc::DT_CHR => Ok(FileType { mode: libc::S_IFCHR }),
728 libc::DT_FIFO => Ok(FileType { mode: libc::S_IFIFO }),
729 libc::DT_LNK => Ok(FileType { mode: libc::S_IFLNK }),
730 libc::DT_REG => Ok(FileType { mode: libc::S_IFREG }),
731 libc::DT_SOCK => Ok(FileType { mode: libc::S_IFSOCK }),
732 libc::DT_DIR => Ok(FileType { mode: libc::S_IFDIR }),
733 libc::DT_BLK => Ok(FileType { mode: libc::S_IFBLK }),
734 _ => self.metadata().map(|m| m.file_type()),
741 target_os = "watchos",
743 target_os = "emscripten",
744 target_os = "android",
745 target_os = "solaris",
746 target_os = "illumos",
749 target_os = "fuchsia",
751 target_os = "vxworks",
752 target_os = "espidf",
753 target_os = "horizon"
755 pub fn ino(&self) -> u64 {
756 self.entry.d_ino as u64
760 target_os = "freebsd",
761 target_os = "openbsd",
762 target_os = "netbsd",
763 target_os = "dragonfly"
765 pub fn ino(&self) -> u64 {
766 self.entry.d_fileno as u64
772 target_os = "watchos",
773 target_os = "netbsd",
774 target_os = "openbsd",
775 target_os = "freebsd",
776 target_os = "dragonfly"
778 fn name_bytes(&self) -> &[u8] {
781 slice::from_raw_parts(
782 self.entry.d_name.as_ptr() as *const u8,
783 self.entry.d_namlen as usize,
790 target_os = "watchos",
791 target_os = "netbsd",
792 target_os = "openbsd",
793 target_os = "freebsd",
794 target_os = "dragonfly"
796 fn name_bytes(&self) -> &[u8] {
797 self.name_cstr().to_bytes()
801 target_os = "android",
803 target_os = "solaris",
804 target_os = "illumos",
805 target_os = "fuchsia",
808 #[cfg_attr(miri, allow(unused))]
809 fn name_cstr(&self) -> &CStr {
810 unsafe { CStr::from_ptr(self.entry.d_name.as_ptr()) }
813 target_os = "android",
815 target_os = "solaris",
816 target_os = "illumos",
817 target_os = "fuchsia",
820 #[cfg_attr(miri, allow(unused))]
821 fn name_cstr(&self) -> &CStr {
825 pub fn file_name_os_str(&self) -> &OsStr {
826 OsStr::from_bytes(self.name_bytes())
831 pub fn new() -> OpenOptions {
846 pub fn read(&mut self, read: bool) {
849 pub fn write(&mut self, write: bool) {
852 pub fn append(&mut self, append: bool) {
853 self.append = append;
855 pub fn truncate(&mut self, truncate: bool) {
856 self.truncate = truncate;
858 pub fn create(&mut self, create: bool) {
859 self.create = create;
861 pub fn create_new(&mut self, create_new: bool) {
862 self.create_new = create_new;
865 pub fn custom_flags(&mut self, flags: i32) {
866 self.custom_flags = flags;
868 pub fn mode(&mut self, mode: u32) {
869 self.mode = mode as mode_t;
872 fn get_access_mode(&self) -> io::Result<c_int> {
873 match (self.read, self.write, self.append) {
874 (true, false, false) => Ok(libc::O_RDONLY),
875 (false, true, false) => Ok(libc::O_WRONLY),
876 (true, true, false) => Ok(libc::O_RDWR),
877 (false, _, true) => Ok(libc::O_WRONLY | libc::O_APPEND),
878 (true, _, true) => Ok(libc::O_RDWR | libc::O_APPEND),
879 (false, false, false) => Err(Error::from_raw_os_error(libc::EINVAL)),
883 fn get_creation_mode(&self) -> io::Result<c_int> {
884 match (self.write, self.append) {
887 if self.truncate || self.create || self.create_new {
888 return Err(Error::from_raw_os_error(libc::EINVAL));
892 if self.truncate && !self.create_new {
893 return Err(Error::from_raw_os_error(libc::EINVAL));
898 Ok(match (self.create, self.truncate, self.create_new) {
899 (false, false, false) => 0,
900 (true, false, false) => libc::O_CREAT,
901 (false, true, false) => libc::O_TRUNC,
902 (true, true, false) => libc::O_CREAT | libc::O_TRUNC,
903 (_, _, true) => libc::O_CREAT | libc::O_EXCL,
909 pub fn open(path: &Path, opts: &OpenOptions) -> io::Result<File> {
910 run_path_with_cstr(path, |path| File::open_c(path, opts))
913 pub fn open_c(path: &CStr, opts: &OpenOptions) -> io::Result<File> {
914 let flags = libc::O_CLOEXEC
915 | opts.get_access_mode()?
916 | opts.get_creation_mode()?
917 | (opts.custom_flags as c_int & !libc::O_ACCMODE);
918 // The third argument of `open64` is documented to have type `mode_t`. On
919 // some platforms (like macOS, where `open64` is actually `open`), `mode_t` is `u16`.
920 // However, since this is a variadic function, C integer promotion rules mean that on
921 // the ABI level, this still gets passed as `c_int` (aka `u32` on Unix platforms).
922 let fd = cvt_r(|| unsafe { open64(path.as_ptr(), flags, opts.mode as c_int) })?;
923 Ok(File(unsafe { FileDesc::from_raw_fd(fd) }))
926 pub fn file_attr(&self) -> io::Result<FileAttr> {
927 let fd = self.as_raw_fd();
930 if let Some(ret) = unsafe { try_statx(
932 b"\0" as *const _ as *const c_char,
933 libc::AT_EMPTY_PATH | libc::AT_STATX_SYNC_AS_STAT,
940 let mut stat: stat64 = unsafe { mem::zeroed() };
941 cvt(unsafe { fstat64(fd, &mut stat) })?;
942 Ok(FileAttr::from_stat64(stat))
945 pub fn fsync(&self) -> io::Result<()> {
946 cvt_r(|| unsafe { os_fsync(self.as_raw_fd()) })?;
949 #[cfg(any(target_os = "macos", target_os = "ios", target_os = "watchos"))]
950 unsafe fn os_fsync(fd: c_int) -> c_int {
951 libc::fcntl(fd, libc::F_FULLFSYNC)
953 #[cfg(not(any(target_os = "macos", target_os = "ios", target_os = "watchos")))]
954 unsafe fn os_fsync(fd: c_int) -> c_int {
959 pub fn datasync(&self) -> io::Result<()> {
960 cvt_r(|| unsafe { os_datasync(self.as_raw_fd()) })?;
963 #[cfg(any(target_os = "macos", target_os = "ios", target_os = "watchos"))]
964 unsafe fn os_datasync(fd: c_int) -> c_int {
965 libc::fcntl(fd, libc::F_FULLFSYNC)
968 target_os = "freebsd",
970 target_os = "android",
971 target_os = "netbsd",
972 target_os = "openbsd"
974 unsafe fn os_datasync(fd: c_int) -> c_int {
978 target_os = "android",
979 target_os = "freebsd",
983 target_os = "netbsd",
984 target_os = "openbsd",
985 target_os = "watchos",
987 unsafe fn os_datasync(fd: c_int) -> c_int {
992 pub fn truncate(&self, size: u64) -> io::Result<()> {
994 size.try_into().map_err(|e| io::Error::new(io::ErrorKind::InvalidInput, e))?;
995 cvt_r(|| unsafe { ftruncate64(self.as_raw_fd(), size) }).map(drop)
998 pub fn read(&self, buf: &mut [u8]) -> io::Result<usize> {
1002 pub fn read_vectored(&self, bufs: &mut [IoSliceMut<'_>]) -> io::Result<usize> {
1003 self.0.read_vectored(bufs)
1007 pub fn is_read_vectored(&self) -> bool {
1008 self.0.is_read_vectored()
1011 pub fn read_at(&self, buf: &mut [u8], offset: u64) -> io::Result<usize> {
1012 self.0.read_at(buf, offset)
1015 pub fn read_buf(&self, cursor: BorrowedCursor<'_>) -> io::Result<()> {
1016 self.0.read_buf(cursor)
1019 pub fn write(&self, buf: &[u8]) -> io::Result<usize> {
1023 pub fn write_vectored(&self, bufs: &[IoSlice<'_>]) -> io::Result<usize> {
1024 self.0.write_vectored(bufs)
1028 pub fn is_write_vectored(&self) -> bool {
1029 self.0.is_write_vectored()
1032 pub fn write_at(&self, buf: &[u8], offset: u64) -> io::Result<usize> {
1033 self.0.write_at(buf, offset)
1036 pub fn flush(&self) -> io::Result<()> {
1040 pub fn seek(&self, pos: SeekFrom) -> io::Result<u64> {
1041 let (whence, pos) = match pos {
1042 // Casting to `i64` is fine, too large values will end up as
1043 // negative which will cause an error in `lseek64`.
1044 SeekFrom::Start(off) => (libc::SEEK_SET, off as i64),
1045 SeekFrom::End(off) => (libc::SEEK_END, off),
1046 SeekFrom::Current(off) => (libc::SEEK_CUR, off),
1048 let n = cvt(unsafe { lseek64(self.as_raw_fd(), pos as off64_t, whence) })?;
1052 pub fn duplicate(&self) -> io::Result<File> {
1053 self.0.duplicate().map(File)
1056 pub fn set_permissions(&self, perm: FilePermissions) -> io::Result<()> {
1057 cvt_r(|| unsafe { libc::fchmod(self.as_raw_fd(), perm.mode) })?;
1061 pub fn set_times(&self, times: FileTimes) -> io::Result<()> {
1062 #[cfg(not(any(target_os = "redox", target_os = "espidf", target_os = "horizon")))]
1063 let to_timespec = |time: Option<SystemTime>| {
1065 Some(time) if let Some(ts) = time.t.to_timespec() => Ok(ts),
1066 Some(time) if time > crate::sys::time::UNIX_EPOCH => Err(io::const_io_error!(io::ErrorKind::InvalidInput, "timestamp is too large to set as a file time")),
1067 Some(_) => Err(io::const_io_error!(io::ErrorKind::InvalidInput, "timestamp is too small to set as a file time")),
1068 None => Ok(libc::timespec { tv_sec: 0, tv_nsec: libc::UTIME_OMIT as _ }),
1071 #[cfg(not(any(target_os = "redox", target_os = "espidf", target_os = "horizon")))]
1072 let times = [to_timespec(times.accessed)?, to_timespec(times.modified)?];
1074 if #[cfg(any(target_os = "redox", target_os = "espidf", target_os = "horizon"))] {
1075 // Redox doesn't appear to support `UTIME_OMIT`.
1076 // ESP-IDF and HorizonOS do not support `futimens` at all and the behavior for those OS is therefore
1077 // the same as for Redox.
1079 Err(io::const_io_error!(
1080 io::ErrorKind::Unsupported,
1081 "setting file times not supported",
1083 } else if #[cfg(any(target_os = "android", target_os = "macos"))] {
1084 // futimens requires macOS 10.13, and Android API level 19
1086 weak!(fn futimens(c_int, *const libc::timespec) -> c_int);
1087 match futimens.get() {
1088 Some(futimens) => futimens(self.as_raw_fd(), times.as_ptr()),
1089 #[cfg(target_os = "macos")]
1091 fn ts_to_tv(ts: &libc::timespec) -> libc::timeval {
1094 tv_usec: (ts.tv_nsec / 1000) as _
1097 let timevals = [ts_to_tv(×[0]), ts_to_tv(×[1])];
1098 libc::futimes(self.as_raw_fd(), timevals.as_ptr())
1100 // futimes requires even newer Android.
1101 #[cfg(target_os = "android")]
1102 None => return Err(io::const_io_error!(
1103 io::ErrorKind::Unsupported,
1104 "setting file times requires Android API level >= 19",
1110 cvt(unsafe { libc::futimens(self.as_raw_fd(), times.as_ptr()) })?;
1118 pub fn new() -> DirBuilder {
1119 DirBuilder { mode: 0o777 }
1122 pub fn mkdir(&self, p: &Path) -> io::Result<()> {
1123 run_path_with_cstr(p, |p| cvt(unsafe { libc::mkdir(p.as_ptr(), self.mode) }).map(|_| ()))
1126 pub fn set_mode(&mut self, mode: u32) {
1127 self.mode = mode as mode_t;
1131 impl AsInner<FileDesc> for File {
1132 fn as_inner(&self) -> &FileDesc {
1137 impl AsInnerMut<FileDesc> for File {
1138 fn as_inner_mut(&mut self) -> &mut FileDesc {
1143 impl IntoInner<FileDesc> for File {
1144 fn into_inner(self) -> FileDesc {
1149 impl FromInner<FileDesc> for File {
1150 fn from_inner(file_desc: FileDesc) -> Self {
1155 impl AsFd for File {
1156 fn as_fd(&self) -> BorrowedFd<'_> {
1161 impl AsRawFd for File {
1162 fn as_raw_fd(&self) -> RawFd {
1167 impl IntoRawFd for File {
1168 fn into_raw_fd(self) -> RawFd {
1169 self.0.into_raw_fd()
1173 impl FromRawFd for File {
1174 unsafe fn from_raw_fd(raw_fd: RawFd) -> Self {
1175 Self(FromRawFd::from_raw_fd(raw_fd))
1179 impl fmt::Debug for File {
1180 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1182 target_os = "linux",
1183 target_os = "netbsd",
1184 target_os = "illumos",
1185 target_os = "solaris"
1187 fn get_path(fd: c_int) -> Option<PathBuf> {
1188 let mut p = PathBuf::from("/proc/self/fd");
1189 p.push(&fd.to_string());
1193 #[cfg(target_os = "macos")]
1194 fn get_path(fd: c_int) -> Option<PathBuf> {
1195 // FIXME: The use of PATH_MAX is generally not encouraged, but it
1196 // is inevitable in this case because macOS defines `fcntl` with
1197 // `F_GETPATH` in terms of `MAXPATHLEN`, and there are no
1198 // alternatives. If a better method is invented, it should be used
1200 let mut buf = vec![0; libc::PATH_MAX as usize];
1201 let n = unsafe { libc::fcntl(fd, libc::F_GETPATH, buf.as_ptr()) };
1205 let l = buf.iter().position(|&c| c == 0).unwrap();
1206 buf.truncate(l as usize);
1207 buf.shrink_to_fit();
1208 Some(PathBuf::from(OsString::from_vec(buf)))
1211 #[cfg(all(target_os = "freebsd", target_arch = "x86_64"))]
1212 fn get_path(fd: c_int) -> Option<PathBuf> {
1213 let info = Box::<libc::kinfo_file>::new_zeroed();
1214 let mut info = unsafe { info.assume_init() };
1215 info.kf_structsize = mem::size_of::<libc::kinfo_file>() as libc::c_int;
1216 let n = unsafe { libc::fcntl(fd, libc::F_KINFO, &mut *info) };
1220 let buf = unsafe { CStr::from_ptr(info.kf_path.as_mut_ptr()).to_bytes().to_vec() };
1221 Some(PathBuf::from(OsString::from_vec(buf)))
1224 #[cfg(target_os = "vxworks")]
1225 fn get_path(fd: c_int) -> Option<PathBuf> {
1226 let mut buf = vec![0; libc::PATH_MAX as usize];
1227 let n = unsafe { libc::ioctl(fd, libc::FIOGETNAME, buf.as_ptr()) };
1231 let l = buf.iter().position(|&c| c == 0).unwrap();
1232 buf.truncate(l as usize);
1233 Some(PathBuf::from(OsString::from_vec(buf)))
1237 target_os = "linux",
1238 target_os = "macos",
1239 target_os = "vxworks",
1240 all(target_os = "freebsd", target_arch = "x86_64"),
1241 target_os = "netbsd",
1242 target_os = "illumos",
1243 target_os = "solaris"
1245 fn get_path(_fd: c_int) -> Option<PathBuf> {
1246 // FIXME(#24570): implement this for other Unix platforms
1251 target_os = "linux",
1252 target_os = "macos",
1253 target_os = "freebsd",
1254 target_os = "netbsd",
1255 target_os = "openbsd",
1256 target_os = "vxworks"
1258 fn get_mode(fd: c_int) -> Option<(bool, bool)> {
1259 let mode = unsafe { libc::fcntl(fd, libc::F_GETFL) };
1263 match mode & libc::O_ACCMODE {
1264 libc::O_RDONLY => Some((true, false)),
1265 libc::O_RDWR => Some((true, true)),
1266 libc::O_WRONLY => Some((false, true)),
1272 target_os = "linux",
1273 target_os = "macos",
1274 target_os = "freebsd",
1275 target_os = "netbsd",
1276 target_os = "openbsd",
1277 target_os = "vxworks"
1279 fn get_mode(_fd: c_int) -> Option<(bool, bool)> {
1280 // FIXME(#24570): implement this for other Unix platforms
1284 let fd = self.as_raw_fd();
1285 let mut b = f.debug_struct("File");
1287 if let Some(path) = get_path(fd) {
1288 b.field("path", &path);
1290 if let Some((read, write)) = get_mode(fd) {
1291 b.field("read", &read).field("write", &write);
1297 pub fn readdir(path: &Path) -> io::Result<ReadDir> {
1298 let ptr = run_path_with_cstr(path, |p| unsafe { Ok(libc::opendir(p.as_ptr())) })?;
1300 Err(Error::last_os_error())
1302 let root = path.to_path_buf();
1303 let inner = InnerReadDir { dirp: Dir(ptr), root };
1305 inner: Arc::new(inner),
1307 target_os = "android",
1308 target_os = "linux",
1309 target_os = "solaris",
1310 target_os = "illumos",
1311 target_os = "fuchsia",
1312 target_os = "redox",
1314 end_of_stream: false,
1319 pub fn unlink(p: &Path) -> io::Result<()> {
1320 run_path_with_cstr(p, |p| cvt(unsafe { libc::unlink(p.as_ptr()) }).map(|_| ()))
1323 pub fn rename(old: &Path, new: &Path) -> io::Result<()> {
1324 run_path_with_cstr(old, |old| {
1325 run_path_with_cstr(new, |new| {
1326 cvt(unsafe { libc::rename(old.as_ptr(), new.as_ptr()) }).map(|_| ())
1331 pub fn set_perm(p: &Path, perm: FilePermissions) -> io::Result<()> {
1332 run_path_with_cstr(p, |p| cvt_r(|| unsafe { libc::chmod(p.as_ptr(), perm.mode) }).map(|_| ()))
1335 pub fn rmdir(p: &Path) -> io::Result<()> {
1336 run_path_with_cstr(p, |p| cvt(unsafe { libc::rmdir(p.as_ptr()) }).map(|_| ()))
1339 pub fn readlink(p: &Path) -> io::Result<PathBuf> {
1340 run_path_with_cstr(p, |c_path| {
1341 let p = c_path.as_ptr();
1343 let mut buf = Vec::with_capacity(256);
1347 cvt(unsafe { libc::readlink(p, buf.as_mut_ptr() as *mut _, buf.capacity()) })?
1351 buf.set_len(buf_read);
1354 if buf_read != buf.capacity() {
1355 buf.shrink_to_fit();
1357 return Ok(PathBuf::from(OsString::from_vec(buf)));
1360 // Trigger the internal buffer resizing logic of `Vec` by requiring
1361 // more space than the current capacity. The length is guaranteed to be
1362 // the same as the capacity due to the if statement above.
1368 pub fn symlink(original: &Path, link: &Path) -> io::Result<()> {
1369 run_path_with_cstr(original, |original| {
1370 run_path_with_cstr(link, |link| {
1371 cvt(unsafe { libc::symlink(original.as_ptr(), link.as_ptr()) }).map(|_| ())
1376 pub fn link(original: &Path, link: &Path) -> io::Result<()> {
1377 run_path_with_cstr(original, |original| {
1378 run_path_with_cstr(link, |link| {
1380 if #[cfg(any(target_os = "vxworks", target_os = "redox", target_os = "android", target_os = "espidf", target_os = "horizon"))] {
1381 // VxWorks, Redox and ESP-IDF lack `linkat`, so use `link` instead. POSIX leaves
1382 // it implementation-defined whether `link` follows symlinks, so rely on the
1383 // `symlink_hard_link` test in library/std/src/fs/tests.rs to check the behavior.
1384 // Android has `linkat` on newer versions, but we happen to know `link`
1385 // always has the correct behavior, so it's here as well.
1386 cvt(unsafe { libc::link(original.as_ptr(), link.as_ptr()) })?;
1387 } else if #[cfg(target_os = "macos")] {
1388 // On MacOS, older versions (<=10.9) lack support for linkat while newer
1389 // versions have it. We want to use linkat if it is available, so we use weak!
1390 // to check. `linkat` is preferable to `link` because it gives us a flag to
1391 // specify how symlinks should be handled. We pass 0 as the flags argument,
1392 // meaning it shouldn't follow symlinks.
1393 weak!(fn linkat(c_int, *const c_char, c_int, *const c_char, c_int) -> c_int);
1395 if let Some(f) = linkat.get() {
1396 cvt(unsafe { f(libc::AT_FDCWD, original.as_ptr(), libc::AT_FDCWD, link.as_ptr(), 0) })?;
1398 cvt(unsafe { libc::link(original.as_ptr(), link.as_ptr()) })?;
1401 // Where we can, use `linkat` instead of `link`; see the comment above
1402 // this one for details on why.
1403 cvt(unsafe { libc::linkat(libc::AT_FDCWD, original.as_ptr(), libc::AT_FDCWD, link.as_ptr(), 0) })?;
1411 pub fn stat(p: &Path) -> io::Result<FileAttr> {
1412 run_path_with_cstr(p, |p| {
1414 if let Some(ret) = unsafe { try_statx(
1417 libc::AT_STATX_SYNC_AS_STAT,
1424 let mut stat: stat64 = unsafe { mem::zeroed() };
1425 cvt(unsafe { stat64(p.as_ptr(), &mut stat) })?;
1426 Ok(FileAttr::from_stat64(stat))
1430 pub fn lstat(p: &Path) -> io::Result<FileAttr> {
1431 run_path_with_cstr(p, |p| {
1433 if let Some(ret) = unsafe { try_statx(
1436 libc::AT_SYMLINK_NOFOLLOW | libc::AT_STATX_SYNC_AS_STAT,
1443 let mut stat: stat64 = unsafe { mem::zeroed() };
1444 cvt(unsafe { lstat64(p.as_ptr(), &mut stat) })?;
1445 Ok(FileAttr::from_stat64(stat))
1449 pub fn canonicalize(p: &Path) -> io::Result<PathBuf> {
1450 let r = run_path_with_cstr(p, |path| unsafe {
1451 Ok(libc::realpath(path.as_ptr(), ptr::null_mut()))
1454 return Err(io::Error::last_os_error());
1456 Ok(PathBuf::from(OsString::from_vec(unsafe {
1457 let buf = CStr::from_ptr(r).to_bytes().to_vec();
1458 libc::free(r as *mut _);
1463 fn open_from(from: &Path) -> io::Result<(crate::fs::File, crate::fs::Metadata)> {
1464 use crate::fs::File;
1465 use crate::sys_common::fs::NOT_FILE_ERROR;
1467 let reader = File::open(from)?;
1468 let metadata = reader.metadata()?;
1469 if !metadata.is_file() {
1470 return Err(NOT_FILE_ERROR);
1472 Ok((reader, metadata))
1475 #[cfg(target_os = "espidf")]
1476 fn open_to_and_set_permissions(
1478 reader_metadata: crate::fs::Metadata,
1479 ) -> io::Result<(crate::fs::File, crate::fs::Metadata)> {
1480 use crate::fs::OpenOptions;
1481 let writer = OpenOptions::new().open(to)?;
1482 let writer_metadata = writer.metadata()?;
1483 Ok((writer, writer_metadata))
1486 #[cfg(not(target_os = "espidf"))]
1487 fn open_to_and_set_permissions(
1489 reader_metadata: crate::fs::Metadata,
1490 ) -> io::Result<(crate::fs::File, crate::fs::Metadata)> {
1491 use crate::fs::OpenOptions;
1492 use crate::os::unix::fs::{OpenOptionsExt, PermissionsExt};
1494 let perm = reader_metadata.permissions();
1495 let writer = OpenOptions::new()
1496 // create the file with the correct mode right away
1502 let writer_metadata = writer.metadata()?;
1503 if writer_metadata.is_file() {
1504 // Set the correct file permissions, in case the file already existed.
1505 // Don't set the permissions on already existing non-files like
1506 // pipes/FIFOs or device nodes.
1507 writer.set_permissions(perm)?;
1509 Ok((writer, writer_metadata))
1513 target_os = "linux",
1514 target_os = "android",
1515 target_os = "macos",
1517 target_os = "watchos",
1519 pub fn copy(from: &Path, to: &Path) -> io::Result<u64> {
1520 let (mut reader, reader_metadata) = open_from(from)?;
1521 let (mut writer, _) = open_to_and_set_permissions(to, reader_metadata)?;
1523 io::copy(&mut reader, &mut writer)
1526 #[cfg(any(target_os = "linux", target_os = "android"))]
1527 pub fn copy(from: &Path, to: &Path) -> io::Result<u64> {
1528 let (mut reader, reader_metadata) = open_from(from)?;
1529 let max_len = u64::MAX;
1530 let (mut writer, _) = open_to_and_set_permissions(to, reader_metadata)?;
1532 use super::kernel_copy::{copy_regular_files, CopyResult};
1534 match copy_regular_files(reader.as_raw_fd(), writer.as_raw_fd(), max_len) {
1535 CopyResult::Ended(bytes) => Ok(bytes),
1536 CopyResult::Error(e, _) => Err(e),
1537 CopyResult::Fallback(written) => match io::copy::generic_copy(&mut reader, &mut writer) {
1538 Ok(bytes) => Ok(bytes + written),
1544 #[cfg(any(target_os = "macos", target_os = "ios", target_os = "watchos"))]
1545 pub fn copy(from: &Path, to: &Path) -> io::Result<u64> {
1546 use crate::sync::atomic::{AtomicBool, Ordering};
1548 const COPYFILE_ACL: u32 = 1 << 0;
1549 const COPYFILE_STAT: u32 = 1 << 1;
1550 const COPYFILE_XATTR: u32 = 1 << 2;
1551 const COPYFILE_DATA: u32 = 1 << 3;
1553 const COPYFILE_SECURITY: u32 = COPYFILE_STAT | COPYFILE_ACL;
1554 const COPYFILE_METADATA: u32 = COPYFILE_SECURITY | COPYFILE_XATTR;
1555 const COPYFILE_ALL: u32 = COPYFILE_METADATA | COPYFILE_DATA;
1557 const COPYFILE_STATE_COPIED: u32 = 8;
1559 #[allow(non_camel_case_types)]
1560 type copyfile_state_t = *mut libc::c_void;
1561 #[allow(non_camel_case_types)]
1562 type copyfile_flags_t = u32;
1568 state: copyfile_state_t,
1569 flags: copyfile_flags_t,
1571 fn copyfile_state_alloc() -> copyfile_state_t;
1572 fn copyfile_state_free(state: copyfile_state_t) -> libc::c_int;
1573 fn copyfile_state_get(
1574 state: copyfile_state_t,
1576 dst: *mut libc::c_void,
1580 struct FreeOnDrop(copyfile_state_t);
1581 impl Drop for FreeOnDrop {
1582 fn drop(&mut self) {
1583 // The code below ensures that `FreeOnDrop` is never a null pointer
1585 // `copyfile_state_free` returns -1 if the `to` or `from` files
1586 // cannot be closed. However, this is not considered this an
1588 copyfile_state_free(self.0);
1593 // MacOS prior to 10.12 don't support `fclonefileat`
1594 // We store the availability in a global to avoid unnecessary syscalls
1595 static HAS_FCLONEFILEAT: AtomicBool = AtomicBool::new(true);
1599 dst_dirfd: libc::c_int,
1605 let (reader, reader_metadata) = open_from(from)?;
1607 // Opportunistically attempt to create a copy-on-write clone of `from`
1608 // using `fclonefileat`.
1609 if HAS_FCLONEFILEAT.load(Ordering::Relaxed) {
1610 let clonefile_result = run_path_with_cstr(to, |to| {
1611 cvt(unsafe { fclonefileat(reader.as_raw_fd(), libc::AT_FDCWD, to.as_ptr(), 0) })
1613 match clonefile_result {
1614 Ok(_) => return Ok(reader_metadata.len()),
1615 Err(err) => match err.raw_os_error() {
1616 // `fclonefileat` will fail on non-APFS volumes, if the
1617 // destination already exists, or if the source and destination
1618 // are on different devices. In all these cases `fcopyfile`
1620 Some(libc::ENOTSUP) | Some(libc::EEXIST) | Some(libc::EXDEV) => (),
1621 Some(libc::ENOSYS) => HAS_FCLONEFILEAT.store(false, Ordering::Relaxed),
1622 _ => return Err(err),
1627 // Fall back to using `fcopyfile` if `fclonefileat` does not succeed.
1628 let (writer, writer_metadata) = open_to_and_set_permissions(to, reader_metadata)?;
1630 // We ensure that `FreeOnDrop` never contains a null pointer so it is
1631 // always safe to call `copyfile_state_free`
1632 let state = unsafe {
1633 let state = copyfile_state_alloc();
1634 if state.is_null() {
1635 return Err(crate::io::Error::last_os_error());
1640 let flags = if writer_metadata.is_file() { COPYFILE_ALL } else { COPYFILE_DATA };
1642 cvt(unsafe { fcopyfile(reader.as_raw_fd(), writer.as_raw_fd(), state.0, flags) })?;
1644 let mut bytes_copied: libc::off_t = 0;
1648 COPYFILE_STATE_COPIED,
1649 &mut bytes_copied as *mut libc::off_t as *mut libc::c_void,
1652 Ok(bytes_copied as u64)
1655 pub fn chown(path: &Path, uid: u32, gid: u32) -> io::Result<()> {
1656 run_path_with_cstr(path, |path| {
1657 cvt(unsafe { libc::chown(path.as_ptr(), uid as libc::uid_t, gid as libc::gid_t) })
1662 pub fn fchown(fd: c_int, uid: u32, gid: u32) -> io::Result<()> {
1663 cvt(unsafe { libc::fchown(fd, uid as libc::uid_t, gid as libc::gid_t) })?;
1667 pub fn lchown(path: &Path, uid: u32, gid: u32) -> io::Result<()> {
1668 run_path_with_cstr(path, |path| {
1669 cvt(unsafe { libc::lchown(path.as_ptr(), uid as libc::uid_t, gid as libc::gid_t) })
1674 #[cfg(not(any(target_os = "fuchsia", target_os = "vxworks")))]
1675 pub fn chroot(dir: &Path) -> io::Result<()> {
1676 run_path_with_cstr(dir, |dir| cvt(unsafe { libc::chroot(dir.as_ptr()) }).map(|_| ()))
1679 pub use remove_dir_impl::remove_dir_all;
1681 // Fallback for REDOX, ESP-ID, Horizon, and Miri
1682 #[cfg(any(target_os = "redox", target_os = "espidf", target_os = "horizon", miri))]
1683 mod remove_dir_impl {
1684 pub use crate::sys_common::fs::remove_dir_all;
1687 // Modern implementation using openat(), unlinkat() and fdopendir()
1688 #[cfg(not(any(target_os = "redox", target_os = "espidf", target_os = "horizon", miri)))]
1689 mod remove_dir_impl {
1690 use super::{lstat, Dir, DirEntry, InnerReadDir, ReadDir};
1691 use crate::ffi::CStr;
1693 use crate::os::unix::io::{AsRawFd, FromRawFd, IntoRawFd};
1694 use crate::os::unix::prelude::{OwnedFd, RawFd};
1695 use crate::path::{Path, PathBuf};
1696 use crate::sync::Arc;
1697 use crate::sys::common::small_c_string::run_path_with_cstr;
1698 use crate::sys::{cvt, cvt_r};
1700 #[cfg(not(all(target_os = "macos", not(target_arch = "aarch64")),))]
1701 use libc::{fdopendir, openat, unlinkat};
1702 #[cfg(all(target_os = "macos", not(target_arch = "aarch64")))]
1703 use macos_weak::{fdopendir, openat, unlinkat};
1705 #[cfg(all(target_os = "macos", not(target_arch = "aarch64")))]
1707 use crate::sys::weak::weak;
1708 use libc::{c_char, c_int, DIR};
1710 fn get_openat_fn() -> Option<unsafe extern "C" fn(c_int, *const c_char, c_int) -> c_int> {
1711 weak!(fn openat(c_int, *const c_char, c_int) -> c_int);
1715 pub fn has_openat() -> bool {
1716 get_openat_fn().is_some()
1719 pub unsafe fn openat(dirfd: c_int, pathname: *const c_char, flags: c_int) -> c_int {
1720 get_openat_fn().map(|openat| openat(dirfd, pathname, flags)).unwrap_or_else(|| {
1721 crate::sys::unix::os::set_errno(libc::ENOSYS);
1726 pub unsafe fn fdopendir(fd: c_int) -> *mut DIR {
1727 #[cfg(all(target_os = "macos", target_arch = "x86"))]
1728 weak!(fn fdopendir(c_int) -> *mut DIR, "fdopendir$INODE64$UNIX2003");
1729 #[cfg(all(target_os = "macos", target_arch = "x86_64"))]
1730 weak!(fn fdopendir(c_int) -> *mut DIR, "fdopendir$INODE64");
1731 fdopendir.get().map(|fdopendir| fdopendir(fd)).unwrap_or_else(|| {
1732 crate::sys::unix::os::set_errno(libc::ENOSYS);
1733 crate::ptr::null_mut()
1737 pub unsafe fn unlinkat(dirfd: c_int, pathname: *const c_char, flags: c_int) -> c_int {
1738 weak!(fn unlinkat(c_int, *const c_char, c_int) -> c_int);
1739 unlinkat.get().map(|unlinkat| unlinkat(dirfd, pathname, flags)).unwrap_or_else(|| {
1740 crate::sys::unix::os::set_errno(libc::ENOSYS);
1746 pub fn openat_nofollow_dironly(parent_fd: Option<RawFd>, p: &CStr) -> io::Result<OwnedFd> {
1747 let fd = cvt_r(|| unsafe {
1749 parent_fd.unwrap_or(libc::AT_FDCWD),
1751 libc::O_CLOEXEC | libc::O_RDONLY | libc::O_NOFOLLOW | libc::O_DIRECTORY,
1754 Ok(unsafe { OwnedFd::from_raw_fd(fd) })
1757 fn fdreaddir(dir_fd: OwnedFd) -> io::Result<(ReadDir, RawFd)> {
1758 let ptr = unsafe { fdopendir(dir_fd.as_raw_fd()) };
1760 return Err(io::Error::last_os_error());
1762 let dirp = Dir(ptr);
1763 // file descriptor is automatically closed by libc::closedir() now, so give up ownership
1764 let new_parent_fd = dir_fd.into_raw_fd();
1765 // a valid root is not needed because we do not call any functions involving the full path
1766 // of the DirEntrys.
1767 let dummy_root = PathBuf::new();
1770 inner: Arc::new(InnerReadDir { dirp, root: dummy_root }),
1772 target_os = "android",
1773 target_os = "linux",
1774 target_os = "solaris",
1775 target_os = "illumos",
1776 target_os = "fuchsia",
1777 target_os = "redox",
1779 end_of_stream: false,
1786 target_os = "solaris",
1787 target_os = "illumos",
1788 target_os = "haiku",
1789 target_os = "vxworks",
1791 fn is_dir(_ent: &DirEntry) -> Option<bool> {
1796 target_os = "solaris",
1797 target_os = "illumos",
1798 target_os = "haiku",
1799 target_os = "vxworks",
1801 fn is_dir(ent: &DirEntry) -> Option<bool> {
1802 match ent.entry.d_type {
1803 libc::DT_UNKNOWN => None,
1804 libc::DT_DIR => Some(true),
1809 fn remove_dir_all_recursive(parent_fd: Option<RawFd>, path: &CStr) -> io::Result<()> {
1810 // try opening as directory
1811 let fd = match openat_nofollow_dironly(parent_fd, &path) {
1812 Err(err) if matches!(err.raw_os_error(), Some(libc::ENOTDIR | libc::ELOOP)) => {
1813 // not a directory - don't traverse further
1814 // (for symlinks, older Linux kernels may return ELOOP instead of ENOTDIR)
1815 return match parent_fd {
1817 Some(parent_fd) => {
1818 cvt(unsafe { unlinkat(parent_fd, path.as_ptr(), 0) }).map(drop)
1820 // ...unless this was supposed to be the deletion root directory
1827 // open the directory passing ownership of the fd
1828 let (dir, fd) = fdreaddir(fd)?;
1831 let child_name = child.name_cstr();
1832 match is_dir(&child) {
1834 remove_dir_all_recursive(Some(fd), child_name)?;
1837 cvt(unsafe { unlinkat(fd, child_name.as_ptr(), 0) })?;
1840 // POSIX specifies that calling unlink()/unlinkat(..., 0) on a directory can succeed
1841 // if the process has the appropriate privileges. This however can causing orphaned
1842 // directories requiring an fsck e.g. on Solaris and Illumos. So we try recursing
1843 // into it first instead of trying to unlink() it.
1844 remove_dir_all_recursive(Some(fd), child_name)?;
1849 // unlink the directory after removing its contents
1851 unlinkat(parent_fd.unwrap_or(libc::AT_FDCWD), path.as_ptr(), libc::AT_REMOVEDIR)
1856 fn remove_dir_all_modern(p: &Path) -> io::Result<()> {
1857 // We cannot just call remove_dir_all_recursive() here because that would not delete a passed
1858 // symlink. No need to worry about races, because remove_dir_all_recursive() does not recurse
1860 let attr = lstat(p)?;
1861 if attr.file_type().is_symlink() {
1862 crate::fs::remove_file(p)
1864 run_path_with_cstr(p, |p| remove_dir_all_recursive(None, &p))
1868 #[cfg(not(all(target_os = "macos", not(target_arch = "aarch64"))))]
1869 pub fn remove_dir_all(p: &Path) -> io::Result<()> {
1870 remove_dir_all_modern(p)
1873 #[cfg(all(target_os = "macos", not(target_arch = "aarch64")))]
1874 pub fn remove_dir_all(p: &Path) -> io::Result<()> {
1875 if macos_weak::has_openat() {
1876 // openat() is available with macOS 10.10+, just like unlinkat() and fdopendir()
1877 remove_dir_all_modern(p)
1879 // fall back to classic implementation
1880 crate::sys_common::fs::remove_dir_all(p)