e-utils 0.4.19

use std::ffi::CString;
use std::fs::File;
use std::io::{Error, ErrorKind, Result};
use std::mem;
use std::os::unix::ffi::OsStrExt;
use std::os::unix::fs::MetadataExt;
use std::os::unix::io::{AsRawFd, FromRawFd};
use std::path::Path;

use super::FsStats;

/// 文件属性
#[repr(u32)]
#[derive(Debug, Clone)]
pub enum FileAttribute {
  /// 无权限
  Empty = 0,
}
/// 共享
#[repr(u32)]
#[derive(Debug, Clone)]
pub enum FileShare {
  /// 只读
  Read = 1,
  /// 只写
  Write = 2,
  /// 只删
  Delete = 4,
  /// 读写
  ReadWrite = 1 | 2,
  /// 所有
  All = 1 | 2 | 4,
  /// 无权限
  Empty = 0,
}
/// This will override the read, write, and append flags on the OpenOptions structure. This method provides fine-grained control over the permissions to read, write and append data, attributes (like hidden and system), and extended attributes.
#[repr(u32)]
#[derive(Debug, Clone)]
pub enum FileAccess {
  /// 无权限
  Empty = 0,
}

/// 安全
#[repr(u32)]
#[derive(Debug, Clone)]
pub enum FileSecurity {
  /// 无权限
  Empty = 0,
}
/// 安全
#[repr(u32)]
#[derive(Debug, Clone)]
pub enum FileCustom {
  /// 无权限
  Empty = 0,
}

///
pub(crate) fn duplicate(file: &File) -> Result<File> {
  unsafe {
    let fd = libc::dup(file.as_raw_fd());

    if fd < 0 {
      Err(Error::last_os_error())
    } else {
      Ok(File::from_raw_fd(fd))
    }
  }
}
///
pub(crate) fn lock_shared(file: &File) -> Result<()> {
  flock(file, libc::LOCK_SH)
}
///
pub(crate) fn lock_exclusive(file: &File) -> Result<()> {
  flock(file, libc::LOCK_EX)
}
///
pub(crate) fn try_lock_shared(file: &File) -> Result<()> {
  flock(file, libc::LOCK_SH | libc::LOCK_NB)
}
///
pub(crate) fn try_lock_exclusive(file: &File) -> Result<()> {
  flock(file, libc::LOCK_EX | libc::LOCK_NB)
}
///
pub(crate) fn unlock(file: &File) -> Result<()> {
  flock(file, libc::LOCK_UN)
}
///
pub(crate) fn lock_error() -> Error {
  Error::from_raw_os_error(libc::EWOULDBLOCK)
}
///
#[cfg(not(target_os = "solaris"))]
fn flock(file: &File, flag: libc::c_int) -> Result<()> {
  let ret = unsafe { libc::flock(file.as_raw_fd(), flag) };
  if ret < 0 {
    Err(Error::last_os_error())
  } else {
    Ok(())
  }
}

/// Simulate flock() using fcntl(); primarily for Oracle Solaris.
#[cfg(target_os = "solaris")]
fn flock(file: &File, flag: libc::c_int) -> Result<()> {
  let mut fl = libc::flock {
    l_whence: 0,
    l_start: 0,
    l_len: 0,
    l_type: 0,
    l_pad: [0; 4],
    l_pid: 0,
    l_sysid: 0,
  };

  // In non-blocking mode, use F_SETLK for cmd, F_SETLKW otherwise, and don't forget to clear
  // LOCK_NB.
  let (cmd, operation) = match flag & libc::LOCK_NB {
    0 => (libc::F_SETLKW, flag),
    _ => (libc::F_SETLK, flag & !libc::LOCK_NB),
  };

  match operation {
    libc::LOCK_SH => fl.l_type |= libc::F_RDLCK,
    libc::LOCK_EX => fl.l_type |= libc::F_WRLCK,
    libc::LOCK_UN => fl.l_type |= libc::F_UNLCK,
    _ => return Err(Error::from_raw_os_error(libc::EINVAL)),
  }

  let ret = unsafe { libc::fcntl(file.as_raw_fd(), cmd, &fl) };
  match ret {
    // Translate EACCES to EWOULDBLOCK
    -1 => match Error::last_os_error().raw_os_error() {
      Some(libc::EACCES) => return Err(lock_error()),
      _ => return Err(Error::last_os_error()),
    },
    _ => Ok(()),
  }
}
///
pub(crate) fn allocated_size(file: &File) -> Result<u64> {
  file.metadata().map(|m| m.blocks() as u64 * 512)
}

///
#[cfg(any(target_os = "linux", target_os = "freebsd", target_os = "android"))]
pub(crate) fn allocate(file: &File, len: u64) -> Result<()> {
  let ret = unsafe { libc::posix_fallocate(file.as_raw_fd(), 0, len as libc::off_t) };
  if ret == 0 {
    Ok(())
  } else {
    Err(Error::last_os_error())
  }
}
///
#[cfg(any(target_os = "macos", target_os = "ios"))]
pub(crate) fn allocate(file: &File, len: u64) -> Result<()> {
  let stat = file.metadata()?;

  if len > stat.blocks() as u64 * 512 {
    let mut fstore = libc::fstore_t {
      fst_flags: libc::F_ALLOCATECONTIG,
      fst_posmode: libc::F_PEOFPOSMODE,
      fst_offset: 0,
      fst_length: len as libc::off_t,
      fst_bytesalloc: 0,
    };

    let ret = unsafe { libc::fcntl(file.as_raw_fd(), libc::F_PREALLOCATE, &fstore) };
    if ret == -1 {
      // Unable to allocate contiguous disk space; attempt to allocate non-contiguously.
      fstore.fst_flags = libc::F_ALLOCATEALL;
      let ret = unsafe { libc::fcntl(file.as_raw_fd(), libc::F_PREALLOCATE, &fstore) };
      if ret == -1 {
        return Err(Error::last_os_error());
      }
    }
  }

  if len > stat.size() as u64 {
    file.set_len(len)
  } else {
    Ok(())
  }
}

///
#[cfg(any(
  target_os = "openbsd",
  target_os = "netbsd",
  target_os = "dragonfly",
  target_os = "solaris",
  target_os = "haiku"
))]
pub(crate) fn allocate(file: &File, len: u64) -> Result<()> {
  // No file allocation API available, just set the length if necessary.
  if len > file.metadata()?.len() as u64 {
    file.set_len(len)
  } else {
    Ok(())
  }
}
///
pub(crate) fn statvfs(path: &Path) -> Result<FsStats> {
  let cstr = match CString::new(path.as_os_str().as_bytes()) {
    Ok(cstr) => cstr,
    Err(..) => return Err(Error::new(ErrorKind::InvalidInput, "path contained a null")),
  };

  unsafe {
    let mut stat: libc::statvfs = mem::zeroed();
    // danburkert/fs2-rs#1: cast is necessary for platforms where c_char != u8.
    if libc::statvfs(cstr.as_ptr() as *const _, &mut stat) != 0 {
      Err(Error::last_os_error())
    } else {
      Ok(FsStats {
        free_space: stat.f_frsize as u64 * stat.f_bfree as u64,
        available_space: stat.f_frsize as u64 * stat.f_bavail as u64,
        total_space: stat.f_frsize as u64 * stat.f_blocks as u64,
        allocation_granularity: stat.f_frsize as u64,
      })
    }
  }
}
///
#[cfg(test)]
mod test {
  use std::fs::{self, File};
  use std::os::unix::io::AsRawFd;

  use crate::fs::options::{lock_contended_error, FileExt};

  /// The duplicate method returns a file with a new file descriptor.
  #[test]
  fn duplicate_new_fd() {
    let tempdir = tempdir::TempDir::new("fs2").unwrap();
    let path = tempdir.path().join("fs2");
    let file1 = fs::OpenOptions::new()
      .write(true)
      .create(true)
      .open(&path)
      .unwrap();
    let file2 = file1.duplicate().unwrap();
    assert!(file1.as_raw_fd() != file2.as_raw_fd());
  }

  /// The duplicate method should preservesthe close on exec flag.
  #[test]
  fn duplicate_cloexec() {
    fn flags(file: &File) -> libc::c_int {
      unsafe { libc::fcntl(file.as_raw_fd(), libc::F_GETFL, 0) }
    }

    let tempdir = tempdir::TempDir::new("fs2").unwrap();
    let path = tempdir.path().join("fs2");
    let file1 = fs::OpenOptions::new()
      .write(true)
      .create(true)
      .open(&path)
      .unwrap();
    let file2 = file1.duplicate().unwrap();

    assert_eq!(flags(&file1), flags(&file2));
  }

  /// Tests that locking a file descriptor will replace any existing locks
  /// held on the file descriptor.
  #[test]
  fn lock_replace() {
    let tempdir = tempdir::TempDir::new("fs2").unwrap();
    let path = tempdir.path().join("fs2");
    let file1 = fs::OpenOptions::new()
      .write(true)
      .create(true)
      .open(&path)
      .unwrap();
    let file2 = fs::OpenOptions::new()
      .write(true)
      .create(true)
      .open(&path)
      .unwrap();

    // Creating a shared lock will drop an exclusive lock.
    file1.lock_exclusive().unwrap();
    file1.lock_shared().unwrap();
    file2.lock_shared().unwrap();

    // Attempting to replace a shared lock with an exclusive lock will fail
    // with multiple lock holders, and remove the original shared lock.
    assert_eq!(
      file2.try_lock_exclusive().unwrap_err().raw_os_error(),
      lock_contended_error().raw_os_error()
    );
    file1.lock_shared().unwrap();
  }

  /// Tests that locks are shared among duplicated file descriptors.
  #[test]
  fn lock_duplicate() {
    let tempdir = tempdir::TempDir::new("fs2").unwrap();
    let path = tempdir.path().join("fs2");
    let file1 = fs::OpenOptions::new()
      .write(true)
      .create(true)
      .open(&path)
      .unwrap();
    let file2 = file1.duplicate().unwrap();
    let file3 = fs::OpenOptions::new()
      .write(true)
      .create(true)
      .open(&path)
      .unwrap();

    // Create a lock through fd1, then replace it through fd2.
    file1.lock_shared().unwrap();
    file2.lock_exclusive().unwrap();
    assert_eq!(
      file3.try_lock_shared().unwrap_err().raw_os_error(),
      lock_contended_error().raw_os_error()
    );

    // Either of the file descriptors should be able to unlock.
    file1.unlock().unwrap();
    file3.lock_shared().unwrap();
  }
}