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.
12 use os::unix::prelude::*;
14 use ffi::{CString, CStr, OsString, OsStr};
16 use io::{self, Error, ErrorKind, SeekFrom};
17 use libc::{self, c_int, mode_t};
19 use path::{Path, PathBuf};
22 use sys::fd::FileDesc;
23 use sys::time::SystemTime;
24 use sys::{cvt, cvt_r};
25 use sys_common::{AsInner, FromInner};
27 #[cfg(any(target_os = "linux", target_os = "emscripten"))]
28 use libc::{stat64, fstat64, lstat64, off64_t, ftruncate64, lseek64, dirent64, readdir64_r, open64};
29 #[cfg(target_os = "android")]
30 use libc::{stat as stat64, fstat as fstat64, lstat as lstat64, off64_t, lseek64,
31 dirent as dirent64, open as open64};
32 #[cfg(not(any(target_os = "linux",
33 target_os = "emscripten",
34 target_os = "android")))]
35 use libc::{stat as stat64, fstat as fstat64, lstat as lstat64, off_t as off64_t,
36 ftruncate as ftruncate64, lseek as lseek64, dirent as dirent64, open as open64};
37 #[cfg(not(any(target_os = "linux",
38 target_os = "emscripten",
39 target_os = "solaris")))]
40 use libc::{readdir_r as readdir64_r};
42 pub struct File(FileDesc);
54 struct Dir(*mut libc::DIR);
56 unsafe impl Send for Dir {}
57 unsafe impl Sync for Dir {}
62 // We need to store an owned copy of the directory name
63 // on Solaris because a) it uses a zero-length array to
64 // store the name, b) its lifetime between readdir calls
66 #[cfg(target_os = "solaris")]
71 pub struct OpenOptions {
84 #[derive(Clone, PartialEq, Eq, Debug)]
85 pub struct FilePermissions { mode: mode_t }
87 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
88 pub struct FileType { mode: mode_t }
90 pub struct DirBuilder { mode: mode_t }
93 pub fn size(&self) -> u64 { self.stat.st_size as u64 }
94 pub fn perm(&self) -> FilePermissions {
95 FilePermissions { mode: (self.stat.st_mode as mode_t) & 0o777 }
98 pub fn file_type(&self) -> FileType {
99 FileType { mode: self.stat.st_mode as mode_t }
103 #[cfg(target_os = "netbsd")]
105 pub fn modified(&self) -> io::Result<SystemTime> {
106 Ok(SystemTime::from(libc::timespec {
107 tv_sec: self.stat.st_mtime as libc::time_t,
108 tv_nsec: self.stat.st_mtimensec as libc::c_long,
112 pub fn accessed(&self) -> io::Result<SystemTime> {
113 Ok(SystemTime::from(libc::timespec {
114 tv_sec: self.stat.st_atime as libc::time_t,
115 tv_nsec: self.stat.st_atimensec as libc::c_long,
119 pub fn created(&self) -> io::Result<SystemTime> {
120 Ok(SystemTime::from(libc::timespec {
121 tv_sec: self.stat.st_birthtime as libc::time_t,
122 tv_nsec: self.stat.st_birthtimensec as libc::c_long,
127 #[cfg(not(target_os = "netbsd"))]
129 pub fn modified(&self) -> io::Result<SystemTime> {
130 Ok(SystemTime::from(libc::timespec {
131 tv_sec: self.stat.st_mtime as libc::time_t,
132 tv_nsec: self.stat.st_mtime_nsec as libc::c_long,
136 pub fn accessed(&self) -> io::Result<SystemTime> {
137 Ok(SystemTime::from(libc::timespec {
138 tv_sec: self.stat.st_atime as libc::time_t,
139 tv_nsec: self.stat.st_atime_nsec as libc::c_long,
143 #[cfg(any(target_os = "bitrig",
144 target_os = "freebsd",
145 target_os = "openbsd",
148 pub fn created(&self) -> io::Result<SystemTime> {
149 Ok(SystemTime::from(libc::timespec {
150 tv_sec: self.stat.st_birthtime as libc::time_t,
151 tv_nsec: self.stat.st_birthtime_nsec as libc::c_long,
155 #[cfg(not(any(target_os = "bitrig",
156 target_os = "freebsd",
157 target_os = "openbsd",
159 target_os = "ios")))]
160 pub fn created(&self) -> io::Result<SystemTime> {
161 Err(io::Error::new(io::ErrorKind::Other,
162 "creation time is not available on this platform \
167 impl AsInner<stat64> for FileAttr {
168 fn as_inner(&self) -> &stat64 { &self.stat }
171 impl FilePermissions {
172 pub fn readonly(&self) -> bool { self.mode & 0o222 == 0 }
173 pub fn set_readonly(&mut self, readonly: bool) {
180 pub fn mode(&self) -> u32 { self.mode as u32 }
184 pub fn is_dir(&self) -> bool { self.is(libc::S_IFDIR) }
185 pub fn is_file(&self) -> bool { self.is(libc::S_IFREG) }
186 pub fn is_symlink(&self) -> bool { self.is(libc::S_IFLNK) }
188 pub fn is(&self, mode: mode_t) -> bool { self.mode & libc::S_IFMT == mode }
191 impl FromInner<u32> for FilePermissions {
192 fn from_inner(mode: u32) -> FilePermissions {
193 FilePermissions { mode: mode as mode_t }
197 impl Iterator for ReadDir {
198 type Item = io::Result<DirEntry>;
200 #[cfg(target_os = "solaris")]
201 fn next(&mut self) -> Option<io::Result<DirEntry>> {
204 // Although readdir_r(3) would be a correct function to use here because
205 // of the thread safety, on Illumos the readdir(3C) function is safe to use
206 // in threaded applications and it is generally preferred over the
207 // readdir_r(3C) function.
208 let entry_ptr = libc::readdir(self.dirp.0);
209 if entry_ptr.is_null() {
213 let name = (*entry_ptr).d_name.as_ptr();
214 let namelen = libc::strlen(name) as usize;
218 name: ::slice::from_raw_parts(name as *const u8,
219 namelen as usize).to_owned().into_boxed_slice(),
220 root: self.root.clone()
222 if ret.name_bytes() != b"." && ret.name_bytes() != b".." {
229 #[cfg(not(target_os = "solaris"))]
230 fn next(&mut self) -> Option<io::Result<DirEntry>> {
232 let mut ret = DirEntry {
233 entry: mem::zeroed(),
234 root: self.root.clone()
236 let mut entry_ptr = ptr::null_mut();
238 if readdir64_r(self.dirp.0, &mut ret.entry, &mut entry_ptr) != 0 {
239 return Some(Err(Error::last_os_error()))
241 if entry_ptr.is_null() {
244 if ret.name_bytes() != b"." && ret.name_bytes() != b".." {
254 let r = unsafe { libc::closedir(self.0) };
255 debug_assert_eq!(r, 0);
260 pub fn path(&self) -> PathBuf {
261 self.root.join(OsStr::from_bytes(self.name_bytes()))
264 pub fn file_name(&self) -> OsString {
265 OsStr::from_bytes(self.name_bytes()).to_os_string()
268 pub fn metadata(&self) -> io::Result<FileAttr> {
272 #[cfg(target_os = "solaris")]
273 pub fn file_type(&self) -> io::Result<FileType> {
274 stat(&self.path()).map(|m| m.file_type())
277 #[cfg(not(target_os = "solaris"))]
278 pub fn file_type(&self) -> io::Result<FileType> {
279 match self.entry.d_type {
280 libc::DT_CHR => Ok(FileType { mode: libc::S_IFCHR }),
281 libc::DT_FIFO => Ok(FileType { mode: libc::S_IFIFO }),
282 libc::DT_LNK => Ok(FileType { mode: libc::S_IFLNK }),
283 libc::DT_REG => Ok(FileType { mode: libc::S_IFREG }),
284 libc::DT_SOCK => Ok(FileType { mode: libc::S_IFSOCK }),
285 libc::DT_DIR => Ok(FileType { mode: libc::S_IFDIR }),
286 libc::DT_BLK => Ok(FileType { mode: libc::S_IFBLK }),
287 _ => lstat(&self.path()).map(|m| m.file_type()),
291 #[cfg(any(target_os = "macos",
294 target_os = "emscripten",
295 target_os = "android",
296 target_os = "solaris"))]
297 pub fn ino(&self) -> u64 {
298 self.entry.d_ino as u64
301 #[cfg(any(target_os = "freebsd",
302 target_os = "openbsd",
303 target_os = "bitrig",
304 target_os = "netbsd",
305 target_os = "dragonfly"))]
306 pub fn ino(&self) -> u64 {
307 self.entry.d_fileno as u64
310 #[cfg(any(target_os = "macos",
312 target_os = "netbsd",
313 target_os = "openbsd",
314 target_os = "freebsd",
315 target_os = "dragonfly",
316 target_os = "bitrig"))]
317 fn name_bytes(&self) -> &[u8] {
319 ::slice::from_raw_parts(self.entry.d_name.as_ptr() as *const u8,
320 self.entry.d_namlen as usize)
323 #[cfg(any(target_os = "android",
325 target_os = "emscripten"))]
326 fn name_bytes(&self) -> &[u8] {
328 CStr::from_ptr(self.entry.d_name.as_ptr()).to_bytes()
331 #[cfg(target_os = "solaris")]
332 fn name_bytes(&self) -> &[u8] {
338 pub fn new() -> OpenOptions {
353 pub fn read(&mut self, read: bool) { self.read = read; }
354 pub fn write(&mut self, write: bool) { self.write = write; }
355 pub fn append(&mut self, append: bool) { self.append = append; }
356 pub fn truncate(&mut self, truncate: bool) { self.truncate = truncate; }
357 pub fn create(&mut self, create: bool) { self.create = create; }
358 pub fn create_new(&mut self, create_new: bool) { self.create_new = create_new; }
360 pub fn custom_flags(&mut self, flags: i32) { self.custom_flags = flags; }
361 pub fn mode(&mut self, mode: u32) { self.mode = mode as mode_t; }
363 fn get_access_mode(&self) -> io::Result<c_int> {
364 match (self.read, self.write, self.append) {
365 (true, false, false) => Ok(libc::O_RDONLY),
366 (false, true, false) => Ok(libc::O_WRONLY),
367 (true, true, false) => Ok(libc::O_RDWR),
368 (false, _, true) => Ok(libc::O_WRONLY | libc::O_APPEND),
369 (true, _, true) => Ok(libc::O_RDWR | libc::O_APPEND),
370 (false, false, false) => Err(Error::from_raw_os_error(libc::EINVAL)),
374 fn get_creation_mode(&self) -> io::Result<c_int> {
375 match (self.write, self.append) {
378 if self.truncate || self.create || self.create_new {
379 return Err(Error::from_raw_os_error(libc::EINVAL));
382 if self.truncate && !self.create_new {
383 return Err(Error::from_raw_os_error(libc::EINVAL));
387 Ok(match (self.create, self.truncate, self.create_new) {
388 (false, false, false) => 0,
389 (true, false, false) => libc::O_CREAT,
390 (false, true, false) => libc::O_TRUNC,
391 (true, true, false) => libc::O_CREAT | libc::O_TRUNC,
392 (_, _, true) => libc::O_CREAT | libc::O_EXCL,
398 pub fn open(path: &Path, opts: &OpenOptions) -> io::Result<File> {
399 let path = cstr(path)?;
400 File::open_c(&path, opts)
403 pub fn open_c(path: &CStr, opts: &OpenOptions) -> io::Result<File> {
404 let flags = libc::O_CLOEXEC |
405 opts.get_access_mode()? |
406 opts.get_creation_mode()? |
407 (opts.custom_flags as c_int & !libc::O_ACCMODE);
408 let fd = cvt_r(|| unsafe {
409 open64(path.as_ptr(), flags, opts.mode as c_int)
411 let fd = FileDesc::new(fd);
413 // Currently the standard library supports Linux 2.6.18 which did not
414 // have the O_CLOEXEC flag (passed above). If we're running on an older
415 // Linux kernel then the flag is just ignored by the OS, so we continue
416 // to explicitly ask for a CLOEXEC fd here.
418 // The CLOEXEC flag, however, is supported on versions of OSX/BSD/etc
419 // that we support, so we only do this on Linux currently.
420 if cfg!(target_os = "linux") {
427 pub fn file_attr(&self) -> io::Result<FileAttr> {
428 let mut stat: stat64 = unsafe { mem::zeroed() };
430 fstat64(self.0.raw(), &mut stat)
432 Ok(FileAttr { stat: stat })
435 pub fn fsync(&self) -> io::Result<()> {
436 cvt_r(|| unsafe { libc::fsync(self.0.raw()) })?;
440 pub fn datasync(&self) -> io::Result<()> {
441 cvt_r(|| unsafe { os_datasync(self.0.raw()) })?;
444 #[cfg(any(target_os = "macos", target_os = "ios"))]
445 unsafe fn os_datasync(fd: c_int) -> c_int {
446 libc::fcntl(fd, libc::F_FULLFSYNC)
448 #[cfg(target_os = "linux")]
449 unsafe fn os_datasync(fd: c_int) -> c_int { libc::fdatasync(fd) }
450 #[cfg(not(any(target_os = "macos",
452 target_os = "linux")))]
453 unsafe fn os_datasync(fd: c_int) -> c_int { libc::fsync(fd) }
456 pub fn truncate(&self, size: u64) -> io::Result<()> {
457 #[cfg(target_os = "android")]
458 return ::sys::android::ftruncate64(self.0.raw(), size);
460 #[cfg(not(target_os = "android"))]
461 return cvt_r(|| unsafe {
462 ftruncate64(self.0.raw(), size as off64_t)
466 pub fn read(&self, buf: &mut [u8]) -> io::Result<usize> {
470 pub fn read_to_end(&self, buf: &mut Vec<u8>) -> io::Result<usize> {
471 self.0.read_to_end(buf)
474 pub fn write(&self, buf: &[u8]) -> io::Result<usize> {
478 pub fn flush(&self) -> io::Result<()> { Ok(()) }
480 pub fn seek(&self, pos: SeekFrom) -> io::Result<u64> {
481 let (whence, pos) = match pos {
482 SeekFrom::Start(off) => (libc::SEEK_SET, off as off64_t),
483 SeekFrom::End(off) => (libc::SEEK_END, off as off64_t),
484 SeekFrom::Current(off) => (libc::SEEK_CUR, off as off64_t),
486 let n = cvt(unsafe { lseek64(self.0.raw(), pos, whence) })?;
490 pub fn duplicate(&self) -> io::Result<File> {
491 self.0.duplicate().map(File)
494 pub fn fd(&self) -> &FileDesc { &self.0 }
496 pub fn into_fd(self) -> FileDesc { self.0 }
500 pub fn new() -> DirBuilder {
501 DirBuilder { mode: 0o777 }
504 pub fn mkdir(&self, p: &Path) -> io::Result<()> {
506 cvt(unsafe { libc::mkdir(p.as_ptr(), self.mode) })?;
510 pub fn set_mode(&mut self, mode: u32) {
511 self.mode = mode as mode_t;
515 fn cstr(path: &Path) -> io::Result<CString> {
516 Ok(CString::new(path.as_os_str().as_bytes())?)
519 impl FromInner<c_int> for File {
520 fn from_inner(fd: c_int) -> File {
521 File(FileDesc::new(fd))
525 impl fmt::Debug for File {
526 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
527 #[cfg(target_os = "linux")]
528 fn get_path(fd: c_int) -> Option<PathBuf> {
529 use string::ToString;
530 let mut p = PathBuf::from("/proc/self/fd");
531 p.push(&fd.to_string());
535 #[cfg(target_os = "macos")]
536 fn get_path(fd: c_int) -> Option<PathBuf> {
537 // FIXME: The use of PATH_MAX is generally not encouraged, but it
538 // is inevitable in this case because OS X defines `fcntl` with
539 // `F_GETPATH` in terms of `MAXPATHLEN`, and there are no
540 // alternatives. If a better method is invented, it should be used
542 let mut buf = vec![0;libc::PATH_MAX as usize];
543 let n = unsafe { libc::fcntl(fd, libc::F_GETPATH, buf.as_ptr()) };
547 let l = buf.iter().position(|&c| c == 0).unwrap();
548 buf.truncate(l as usize);
550 Some(PathBuf::from(OsString::from_vec(buf)))
553 #[cfg(not(any(target_os = "linux", target_os = "macos")))]
554 fn get_path(_fd: c_int) -> Option<PathBuf> {
555 // FIXME(#24570): implement this for other Unix platforms
559 #[cfg(any(target_os = "linux", target_os = "macos"))]
560 fn get_mode(fd: c_int) -> Option<(bool, bool)> {
561 let mode = unsafe { libc::fcntl(fd, libc::F_GETFL) };
565 match mode & libc::O_ACCMODE {
566 libc::O_RDONLY => Some((true, false)),
567 libc::O_RDWR => Some((true, true)),
568 libc::O_WRONLY => Some((false, true)),
573 #[cfg(not(any(target_os = "linux", target_os = "macos")))]
574 fn get_mode(_fd: c_int) -> Option<(bool, bool)> {
575 // FIXME(#24570): implement this for other Unix platforms
579 let fd = self.0.raw();
580 let mut b = f.debug_struct("File");
582 if let Some(path) = get_path(fd) {
583 b.field("path", &path);
585 if let Some((read, write)) = get_mode(fd) {
586 b.field("read", &read).field("write", &write);
592 pub fn readdir(p: &Path) -> io::Result<ReadDir> {
593 let root = Arc::new(p.to_path_buf());
596 let ptr = libc::opendir(p.as_ptr());
598 Err(Error::last_os_error())
600 Ok(ReadDir { dirp: Dir(ptr), root: root })
605 pub fn unlink(p: &Path) -> io::Result<()> {
607 cvt(unsafe { libc::unlink(p.as_ptr()) })?;
611 pub fn rename(old: &Path, new: &Path) -> io::Result<()> {
612 let old = cstr(old)?;
613 let new = cstr(new)?;
614 cvt(unsafe { libc::rename(old.as_ptr(), new.as_ptr()) })?;
618 pub fn set_perm(p: &Path, perm: FilePermissions) -> io::Result<()> {
620 cvt_r(|| unsafe { libc::chmod(p.as_ptr(), perm.mode) })?;
624 pub fn rmdir(p: &Path) -> io::Result<()> {
626 cvt(unsafe { libc::rmdir(p.as_ptr()) })?;
630 pub fn remove_dir_all(path: &Path) -> io::Result<()> {
631 let filetype = lstat(path)?.file_type();
632 if filetype.is_symlink() {
635 remove_dir_all_recursive(path)
639 fn remove_dir_all_recursive(path: &Path) -> io::Result<()> {
640 for child in readdir(path)? {
642 if child.file_type()?.is_dir() {
643 remove_dir_all_recursive(&child.path())?;
645 unlink(&child.path())?;
651 pub fn readlink(p: &Path) -> io::Result<PathBuf> {
652 let c_path = cstr(p)?;
653 let p = c_path.as_ptr();
655 let mut buf = Vec::with_capacity(256);
658 let buf_read = cvt(unsafe {
659 libc::readlink(p, buf.as_mut_ptr() as *mut _, buf.capacity() as libc::size_t)
662 unsafe { buf.set_len(buf_read); }
664 if buf_read != buf.capacity() {
667 return Ok(PathBuf::from(OsString::from_vec(buf)));
670 // Trigger the internal buffer resizing logic of `Vec` by requiring
671 // more space than the current capacity. The length is guaranteed to be
672 // the same as the capacity due to the if statement above.
677 pub fn symlink(src: &Path, dst: &Path) -> io::Result<()> {
678 let src = cstr(src)?;
679 let dst = cstr(dst)?;
680 cvt(unsafe { libc::symlink(src.as_ptr(), dst.as_ptr()) })?;
684 pub fn link(src: &Path, dst: &Path) -> io::Result<()> {
685 let src = cstr(src)?;
686 let dst = cstr(dst)?;
687 cvt(unsafe { libc::link(src.as_ptr(), dst.as_ptr()) })?;
691 pub fn stat(p: &Path) -> io::Result<FileAttr> {
693 let mut stat: stat64 = unsafe { mem::zeroed() };
695 stat64(p.as_ptr(), &mut stat as *mut _ as *mut _)
697 Ok(FileAttr { stat: stat })
700 pub fn lstat(p: &Path) -> io::Result<FileAttr> {
702 let mut stat: stat64 = unsafe { mem::zeroed() };
704 lstat64(p.as_ptr(), &mut stat as *mut _ as *mut _)
706 Ok(FileAttr { stat: stat })
709 pub fn canonicalize(p: &Path) -> io::Result<PathBuf> {
710 let path = CString::new(p.as_os_str().as_bytes())?;
713 let r = libc::realpath(path.as_ptr(), ptr::null_mut());
715 return Err(io::Error::last_os_error())
717 buf = CStr::from_ptr(r).to_bytes().to_vec();
718 libc::free(r as *mut _);
720 Ok(PathBuf::from(OsString::from_vec(buf)))
723 pub fn copy(from: &Path, to: &Path) -> io::Result<u64> {
724 use fs::{File, set_permissions};
726 return Err(Error::new(ErrorKind::InvalidInput,
727 "the source path is not an existing regular file"))
730 let mut reader = File::open(from)?;
731 let mut writer = File::create(to)?;
732 let perm = reader.metadata()?.permissions();
734 let ret = io::copy(&mut reader, &mut writer)?;
735 set_permissions(to, perm)?;