1 // Copyright 2013-2014 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
13 use os::unix::prelude::*;
15 use ffi::{CString, CStr, OsString, OsStr};
17 use io::{self, Error, ErrorKind, SeekFrom};
18 use libc::{self, dirent, c_int, mode_t};
20 use path::{Path, PathBuf};
23 use sys::fd::FileDesc;
24 use sys::time::SystemTime;
25 use sys::{cvt, cvt_r};
26 use sys_common::{AsInner, FromInner};
28 #[cfg(target_os = "linux")]
29 use libc::{stat64, fstat64, lstat64, off64_t, ftruncate64, lseek64};
30 #[cfg(not(target_os = "linux"))]
31 use libc::{stat as stat64, fstat as fstat64, lstat as lstat64, off_t as off64_t,
32 ftruncate as ftruncate64, lseek as lseek64};
34 pub struct File(FileDesc);
46 struct Dir(*mut libc::DIR);
48 unsafe impl Send for Dir {}
49 unsafe impl Sync for Dir {}
54 // We need to store an owned copy of the directory name
55 // on Solaris because a) it uses a zero-length array to
56 // store the name, b) its lifetime between readdir calls
58 #[cfg(target_os = "solaris")]
63 pub struct OpenOptions {
76 #[derive(Clone, PartialEq, Eq, Debug)]
77 pub struct FilePermissions { mode: mode_t }
79 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
80 pub struct FileType { mode: mode_t }
82 pub struct DirBuilder { mode: mode_t }
85 pub fn size(&self) -> u64 { self.stat.st_size as u64 }
86 pub fn perm(&self) -> FilePermissions {
87 FilePermissions { mode: (self.stat.st_mode as mode_t) & 0o777 }
90 pub fn file_type(&self) -> FileType {
91 FileType { mode: self.stat.st_mode as mode_t }
95 #[cfg(any(target_os = "ios", target_os = "macos"))]
96 // FIXME: update SystemTime to store a timespec and don't lose precision
98 pub fn modified(&self) -> io::Result<SystemTime> {
99 Ok(SystemTime::from(libc::timeval {
100 tv_sec: self.stat.st_mtime,
101 tv_usec: (self.stat.st_mtime_nsec / 1000) as libc::suseconds_t,
105 pub fn accessed(&self) -> io::Result<SystemTime> {
106 Ok(SystemTime::from(libc::timeval {
107 tv_sec: self.stat.st_atime,
108 tv_usec: (self.stat.st_atime_nsec / 1000) as libc::suseconds_t,
112 pub fn created(&self) -> io::Result<SystemTime> {
113 Ok(SystemTime::from(libc::timeval {
114 tv_sec: self.stat.st_birthtime,
115 tv_usec: (self.stat.st_birthtime_nsec / 1000) as libc::suseconds_t,
120 #[cfg(not(any(target_os = "ios", target_os = "macos")))]
122 pub fn modified(&self) -> io::Result<SystemTime> {
123 Ok(SystemTime::from(libc::timespec {
124 tv_sec: self.stat.st_mtime as libc::time_t,
125 tv_nsec: self.stat.st_mtime_nsec as libc::c_long,
129 pub fn accessed(&self) -> io::Result<SystemTime> {
130 Ok(SystemTime::from(libc::timespec {
131 tv_sec: self.stat.st_atime as libc::time_t,
132 tv_nsec: self.stat.st_atime_nsec as libc::c_long,
136 #[cfg(any(target_os = "bitrig",
137 target_os = "freebsd",
138 target_os = "openbsd"))]
139 pub fn created(&self) -> io::Result<SystemTime> {
140 Ok(SystemTime::from(libc::timespec {
141 tv_sec: self.stat.st_birthtime as libc::time_t,
142 tv_nsec: self.stat.st_birthtime_nsec as libc::c_long,
146 #[cfg(not(any(target_os = "bitrig",
147 target_os = "freebsd",
148 target_os = "openbsd")))]
149 pub fn created(&self) -> io::Result<SystemTime> {
150 Err(io::Error::new(io::ErrorKind::Other,
151 "creation time is not available on this platform \
156 impl AsInner<stat64> for FileAttr {
157 fn as_inner(&self) -> &stat64 { &self.stat }
160 impl FilePermissions {
161 pub fn readonly(&self) -> bool { self.mode & 0o222 == 0 }
162 pub fn set_readonly(&mut self, readonly: bool) {
169 pub fn mode(&self) -> u32 { self.mode as u32 }
173 pub fn is_dir(&self) -> bool { self.is(libc::S_IFDIR) }
174 pub fn is_file(&self) -> bool { self.is(libc::S_IFREG) }
175 pub fn is_symlink(&self) -> bool { self.is(libc::S_IFLNK) }
177 pub fn is(&self, mode: mode_t) -> bool { self.mode & libc::S_IFMT == mode }
180 impl FromInner<u32> for FilePermissions {
181 fn from_inner(mode: u32) -> FilePermissions {
182 FilePermissions { mode: mode as mode_t }
186 impl Iterator for ReadDir {
187 type Item = io::Result<DirEntry>;
189 #[cfg(target_os = "solaris")]
190 fn next(&mut self) -> Option<io::Result<DirEntry>> {
193 // Although readdir_r(3) would be a correct function to use here because
194 // of the thread safety, on Illumos the readdir(3C) function is safe to use
195 // in threaded applications and it is generally preferred over the
196 // readdir_r(3C) function.
197 let entry_ptr = libc::readdir(self.dirp.0);
198 if entry_ptr.is_null() {
202 let name = (*entry_ptr).d_name.as_ptr();
203 let namelen = libc::strlen(name) as usize;
207 name: ::slice::from_raw_parts(name as *const u8,
208 namelen as usize).to_owned().into_boxed_slice(),
209 root: self.root.clone()
211 if ret.name_bytes() != b"." && ret.name_bytes() != b".." {
218 #[cfg(not(target_os = "solaris"))]
219 fn next(&mut self) -> Option<io::Result<DirEntry>> {
221 let mut ret = DirEntry {
222 entry: mem::zeroed(),
223 root: self.root.clone()
225 let mut entry_ptr = ptr::null_mut();
227 if libc::readdir_r(self.dirp.0, &mut ret.entry, &mut entry_ptr) != 0 {
228 return Some(Err(Error::last_os_error()))
230 if entry_ptr.is_null() {
233 if ret.name_bytes() != b"." && ret.name_bytes() != b".." {
243 let r = unsafe { libc::closedir(self.0) };
244 debug_assert_eq!(r, 0);
249 pub fn path(&self) -> PathBuf {
250 self.root.join(OsStr::from_bytes(self.name_bytes()))
253 pub fn file_name(&self) -> OsString {
254 OsStr::from_bytes(self.name_bytes()).to_os_string()
257 pub fn metadata(&self) -> io::Result<FileAttr> {
261 #[cfg(target_os = "solaris")]
262 pub fn file_type(&self) -> io::Result<FileType> {
263 stat(&self.path()).map(|m| m.file_type())
266 #[cfg(not(target_os = "solaris"))]
267 pub fn file_type(&self) -> io::Result<FileType> {
268 match self.entry.d_type {
269 libc::DT_CHR => Ok(FileType { mode: libc::S_IFCHR }),
270 libc::DT_FIFO => Ok(FileType { mode: libc::S_IFIFO }),
271 libc::DT_LNK => Ok(FileType { mode: libc::S_IFLNK }),
272 libc::DT_REG => Ok(FileType { mode: libc::S_IFREG }),
273 libc::DT_SOCK => Ok(FileType { mode: libc::S_IFSOCK }),
274 libc::DT_DIR => Ok(FileType { mode: libc::S_IFDIR }),
275 libc::DT_BLK => Ok(FileType { mode: libc::S_IFBLK }),
276 _ => lstat(&self.path()).map(|m| m.file_type()),
280 #[cfg(any(target_os = "macos",
283 target_os = "emscripten",
284 target_os = "android",
285 target_os = "solaris"))]
286 pub fn ino(&self) -> u64 {
287 self.entry.d_ino as u64
290 #[cfg(any(target_os = "freebsd",
291 target_os = "openbsd",
292 target_os = "bitrig",
293 target_os = "netbsd",
294 target_os = "dragonfly"))]
295 pub fn ino(&self) -> u64 {
296 self.entry.d_fileno as u64
299 #[cfg(any(target_os = "macos",
301 target_os = "netbsd",
302 target_os = "openbsd",
303 target_os = "freebsd",
304 target_os = "dragonfly",
305 target_os = "bitrig"))]
306 fn name_bytes(&self) -> &[u8] {
308 ::slice::from_raw_parts(self.entry.d_name.as_ptr() as *const u8,
309 self.entry.d_namlen as usize)
312 #[cfg(any(target_os = "android",
314 target_os = "emscripten"))]
315 fn name_bytes(&self) -> &[u8] {
317 CStr::from_ptr(self.entry.d_name.as_ptr()).to_bytes()
320 #[cfg(target_os = "solaris")]
321 fn name_bytes(&self) -> &[u8] {
327 pub fn new() -> OpenOptions {
342 pub fn read(&mut self, read: bool) { self.read = read; }
343 pub fn write(&mut self, write: bool) { self.write = write; }
344 pub fn append(&mut self, append: bool) { self.append = append; }
345 pub fn truncate(&mut self, truncate: bool) { self.truncate = truncate; }
346 pub fn create(&mut self, create: bool) { self.create = create; }
347 pub fn create_new(&mut self, create_new: bool) { self.create_new = create_new; }
349 pub fn custom_flags(&mut self, flags: i32) { self.custom_flags = flags; }
350 pub fn mode(&mut self, mode: u32) { self.mode = mode as mode_t; }
352 fn get_access_mode(&self) -> io::Result<c_int> {
353 match (self.read, self.write, self.append) {
354 (true, false, false) => Ok(libc::O_RDONLY),
355 (false, true, false) => Ok(libc::O_WRONLY),
356 (true, true, false) => Ok(libc::O_RDWR),
357 (false, _, true) => Ok(libc::O_WRONLY | libc::O_APPEND),
358 (true, _, true) => Ok(libc::O_RDWR | libc::O_APPEND),
359 (false, false, false) => Err(Error::from_raw_os_error(libc::EINVAL)),
363 fn get_creation_mode(&self) -> io::Result<c_int> {
364 match (self.write, self.append) {
367 if self.truncate || self.create || self.create_new {
368 return Err(Error::from_raw_os_error(libc::EINVAL));
371 if self.truncate && !self.create_new {
372 return Err(Error::from_raw_os_error(libc::EINVAL));
376 Ok(match (self.create, self.truncate, self.create_new) {
377 (false, false, false) => 0,
378 (true, false, false) => libc::O_CREAT,
379 (false, true, false) => libc::O_TRUNC,
380 (true, true, false) => libc::O_CREAT | libc::O_TRUNC,
381 (_, _, true) => libc::O_CREAT | libc::O_EXCL,
387 pub fn open(path: &Path, opts: &OpenOptions) -> io::Result<File> {
388 let path = try!(cstr(path));
389 File::open_c(&path, opts)
392 pub fn open_c(path: &CStr, opts: &OpenOptions) -> io::Result<File> {
393 let flags = libc::O_CLOEXEC |
394 try!(opts.get_access_mode()) |
395 try!(opts.get_creation_mode()) |
396 (opts.custom_flags as c_int & !libc::O_ACCMODE);
397 let fd = try!(cvt_r(|| unsafe {
398 libc::open(path.as_ptr(), flags, opts.mode as c_int)
400 let fd = FileDesc::new(fd);
402 // Currently the standard library supports Linux 2.6.18 which did not
403 // have the O_CLOEXEC flag (passed above). If we're running on an older
404 // Linux kernel then the flag is just ignored by the OS, so we continue
405 // to explicitly ask for a CLOEXEC fd here.
407 // The CLOEXEC flag, however, is supported on versions of OSX/BSD/etc
408 // that we support, so we only do this on Linux currently.
409 if cfg!(target_os = "linux") {
416 pub fn file_attr(&self) -> io::Result<FileAttr> {
417 let mut stat: stat64 = unsafe { mem::zeroed() };
419 fstat64(self.0.raw(), &mut stat)
421 Ok(FileAttr { stat: stat })
424 pub fn fsync(&self) -> io::Result<()> {
425 try!(cvt_r(|| unsafe { libc::fsync(self.0.raw()) }));
429 pub fn datasync(&self) -> io::Result<()> {
430 try!(cvt_r(|| unsafe { os_datasync(self.0.raw()) }));
433 #[cfg(any(target_os = "macos", target_os = "ios"))]
434 unsafe fn os_datasync(fd: c_int) -> c_int {
435 libc::fcntl(fd, libc::F_FULLFSYNC)
437 #[cfg(target_os = "linux")]
438 unsafe fn os_datasync(fd: c_int) -> c_int { libc::fdatasync(fd) }
439 #[cfg(not(any(target_os = "macos",
441 target_os = "linux")))]
442 unsafe fn os_datasync(fd: c_int) -> c_int { libc::fsync(fd) }
445 pub fn truncate(&self, size: u64) -> io::Result<()> {
446 try!(cvt_r(|| unsafe {
447 ftruncate64(self.0.raw(), size as off64_t)
452 pub fn read(&self, buf: &mut [u8]) -> io::Result<usize> {
456 pub fn write(&self, buf: &[u8]) -> io::Result<usize> {
460 pub fn flush(&self) -> io::Result<()> { Ok(()) }
462 pub fn seek(&self, pos: SeekFrom) -> io::Result<u64> {
463 let (whence, pos) = match pos {
464 SeekFrom::Start(off) => (libc::SEEK_SET, off as off64_t),
465 SeekFrom::End(off) => (libc::SEEK_END, off as off64_t),
466 SeekFrom::Current(off) => (libc::SEEK_CUR, off as off64_t),
468 let n = try!(cvt(unsafe { lseek64(self.0.raw(), pos, whence) }));
472 pub fn duplicate(&self) -> io::Result<File> {
473 self.0.duplicate().map(File)
476 pub fn fd(&self) -> &FileDesc { &self.0 }
478 pub fn into_fd(self) -> FileDesc { self.0 }
482 pub fn new() -> DirBuilder {
483 DirBuilder { mode: 0o777 }
486 pub fn mkdir(&self, p: &Path) -> io::Result<()> {
487 let p = try!(cstr(p));
488 try!(cvt(unsafe { libc::mkdir(p.as_ptr(), self.mode) }));
492 pub fn set_mode(&mut self, mode: u32) {
493 self.mode = mode as mode_t;
497 fn cstr(path: &Path) -> io::Result<CString> {
498 Ok(try!(CString::new(path.as_os_str().as_bytes())))
501 impl FromInner<c_int> for File {
502 fn from_inner(fd: c_int) -> File {
503 File(FileDesc::new(fd))
507 impl fmt::Debug for File {
508 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
509 #[cfg(target_os = "linux")]
510 fn get_path(fd: c_int) -> Option<PathBuf> {
511 use string::ToString;
512 let mut p = PathBuf::from("/proc/self/fd");
513 p.push(&fd.to_string());
517 #[cfg(target_os = "macos")]
518 fn get_path(fd: c_int) -> Option<PathBuf> {
519 // FIXME: The use of PATH_MAX is generally not encouraged, but it
520 // is inevitable in this case because OS X defines `fcntl` with
521 // `F_GETPATH` in terms of `MAXPATHLEN`, and there are no
522 // alternatives. If a better method is invented, it should be used
524 let mut buf = vec![0;libc::PATH_MAX as usize];
525 let n = unsafe { libc::fcntl(fd, libc::F_GETPATH, buf.as_ptr()) };
529 let l = buf.iter().position(|&c| c == 0).unwrap();
530 buf.truncate(l as usize);
532 Some(PathBuf::from(OsString::from_vec(buf)))
535 #[cfg(not(any(target_os = "linux", target_os = "macos")))]
536 fn get_path(_fd: c_int) -> Option<PathBuf> {
537 // FIXME(#24570): implement this for other Unix platforms
541 #[cfg(any(target_os = "linux", target_os = "macos"))]
542 fn get_mode(fd: c_int) -> Option<(bool, bool)> {
543 let mode = unsafe { libc::fcntl(fd, libc::F_GETFL) };
547 match mode & libc::O_ACCMODE {
548 libc::O_RDONLY => Some((true, false)),
549 libc::O_RDWR => Some((true, true)),
550 libc::O_WRONLY => Some((false, true)),
555 #[cfg(not(any(target_os = "linux", target_os = "macos")))]
556 fn get_mode(_fd: c_int) -> Option<(bool, bool)> {
557 // FIXME(#24570): implement this for other Unix platforms
561 let fd = self.0.raw();
562 let mut b = f.debug_struct("File");
564 if let Some(path) = get_path(fd) {
565 b.field("path", &path);
567 if let Some((read, write)) = get_mode(fd) {
568 b.field("read", &read).field("write", &write);
574 pub fn readdir(p: &Path) -> io::Result<ReadDir> {
575 let root = Arc::new(p.to_path_buf());
576 let p = try!(cstr(p));
578 let ptr = libc::opendir(p.as_ptr());
580 Err(Error::last_os_error())
582 Ok(ReadDir { dirp: Dir(ptr), root: root })
587 pub fn unlink(p: &Path) -> io::Result<()> {
588 let p = try!(cstr(p));
589 try!(cvt(unsafe { libc::unlink(p.as_ptr()) }));
593 pub fn rename(old: &Path, new: &Path) -> io::Result<()> {
594 let old = try!(cstr(old));
595 let new = try!(cstr(new));
596 try!(cvt(unsafe { libc::rename(old.as_ptr(), new.as_ptr()) }));
600 pub fn set_perm(p: &Path, perm: FilePermissions) -> io::Result<()> {
601 let p = try!(cstr(p));
602 try!(cvt_r(|| unsafe { libc::chmod(p.as_ptr(), perm.mode) }));
606 pub fn rmdir(p: &Path) -> io::Result<()> {
607 let p = try!(cstr(p));
608 try!(cvt(unsafe { libc::rmdir(p.as_ptr()) }));
612 pub fn remove_dir_all(path: &Path) -> io::Result<()> {
613 let filetype = try!(lstat(path)).file_type();
614 if filetype.is_symlink() {
617 remove_dir_all_recursive(path)
621 fn remove_dir_all_recursive(path: &Path) -> io::Result<()> {
622 for child in try!(readdir(path)) {
623 let child = try!(child);
624 if try!(child.file_type()).is_dir() {
625 try!(remove_dir_all_recursive(&child.path()));
627 try!(unlink(&child.path()));
633 pub fn readlink(p: &Path) -> io::Result<PathBuf> {
634 let c_path = try!(cstr(p));
635 let p = c_path.as_ptr();
637 let mut buf = Vec::with_capacity(256);
640 let buf_read = try!(cvt(unsafe {
641 libc::readlink(p, buf.as_mut_ptr() as *mut _, buf.capacity() as libc::size_t)
644 unsafe { buf.set_len(buf_read); }
646 if buf_read != buf.capacity() {
649 return Ok(PathBuf::from(OsString::from_vec(buf)));
652 // Trigger the internal buffer resizing logic of `Vec` by requiring
653 // more space than the current capacity. The length is guaranteed to be
654 // the same as the capacity due to the if statement above.
659 pub fn symlink(src: &Path, dst: &Path) -> io::Result<()> {
660 let src = try!(cstr(src));
661 let dst = try!(cstr(dst));
662 try!(cvt(unsafe { libc::symlink(src.as_ptr(), dst.as_ptr()) }));
666 pub fn link(src: &Path, dst: &Path) -> io::Result<()> {
667 let src = try!(cstr(src));
668 let dst = try!(cstr(dst));
669 try!(cvt(unsafe { libc::link(src.as_ptr(), dst.as_ptr()) }));
673 pub fn stat(p: &Path) -> io::Result<FileAttr> {
674 let p = try!(cstr(p));
675 let mut stat: stat64 = unsafe { mem::zeroed() };
677 stat64(p.as_ptr(), &mut stat as *mut _ as *mut _)
679 Ok(FileAttr { stat: stat })
682 pub fn lstat(p: &Path) -> io::Result<FileAttr> {
683 let p = try!(cstr(p));
684 let mut stat: stat64 = unsafe { mem::zeroed() };
686 lstat64(p.as_ptr(), &mut stat as *mut _ as *mut _)
688 Ok(FileAttr { stat: stat })
691 pub fn canonicalize(p: &Path) -> io::Result<PathBuf> {
692 let path = try!(CString::new(p.as_os_str().as_bytes()));
695 let r = libc::realpath(path.as_ptr(), ptr::null_mut());
697 return Err(io::Error::last_os_error())
699 buf = CStr::from_ptr(r).to_bytes().to_vec();
700 libc::free(r as *mut _);
702 Ok(PathBuf::from(OsString::from_vec(buf)))
705 pub fn copy(from: &Path, to: &Path) -> io::Result<u64> {
706 use fs::{File, set_permissions};
708 return Err(Error::new(ErrorKind::InvalidInput,
709 "the source path is not an existing regular file"))
712 let mut reader = try!(File::open(from));
713 let mut writer = try!(File::create(to));
714 let perm = try!(reader.metadata()).permissions();
716 let ret = try!(io::copy(&mut reader, &mut writer));
717 try!(set_permissions(to, perm));