| 1 |
//! Get filesystem statistics |
| 2 |
//! |
| 3 |
//! See [the man pages](https://pubs.opengroup.org/onlinepubs/9699919799/functions/fstatvfs.html) |
| 4 |
//! for more details. |
| 5 |
use std::mem; |
| 6 |
use std::os::unix::io::{AsFd, AsRawFd}; |
| 7 |
|
| 8 |
use libc::{self, c_ulong}; |
| 9 |
|
| 10 |
use crate::{errno::Errno, NixPath, Result}; |
| 11 |
|
| 12 |
#[cfg(not(target_os = "redox"))] |
| 13 |
libc_bitflags!( |
| 14 |
/// File system mount Flags |
| 15 |
#[derive(Default)] |
| 16 |
pub struct FsFlags: c_ulong { |
| 17 |
/// Read Only |
| 18 |
#[cfg(not(target_os = "haiku"))] |
| 19 |
ST_RDONLY; |
| 20 |
/// Do not allow the set-uid bits to have an effect |
| 21 |
#[cfg(not(target_os = "haiku"))] |
| 22 |
ST_NOSUID; |
| 23 |
/// Do not interpret character or block-special devices |
| 24 |
#[cfg(linux_android)] |
| 25 |
ST_NODEV; |
| 26 |
/// Do not allow execution of binaries on the filesystem |
| 27 |
#[cfg(linux_android)] |
| 28 |
ST_NOEXEC; |
| 29 |
/// All IO should be done synchronously |
| 30 |
#[cfg(linux_android)] |
| 31 |
ST_SYNCHRONOUS; |
| 32 |
/// Allow mandatory locks on the filesystem |
| 33 |
#[cfg(linux_android)] |
| 34 |
ST_MANDLOCK; |
| 35 |
/// Write on file/directory/symlink |
| 36 |
#[cfg(target_os = "linux")] |
| 37 |
ST_WRITE; |
| 38 |
/// Append-only file |
| 39 |
#[cfg(target_os = "linux")] |
| 40 |
ST_APPEND; |
| 41 |
/// Immutable file |
| 42 |
#[cfg(target_os = "linux")] |
| 43 |
ST_IMMUTABLE; |
| 44 |
/// Do not update access times on files |
| 45 |
#[cfg(linux_android)] |
| 46 |
ST_NOATIME; |
| 47 |
/// Do not update access times on files |
| 48 |
#[cfg(linux_android)] |
| 49 |
ST_NODIRATIME; |
| 50 |
/// Update access time relative to modify/change time |
| 51 |
#[cfg(any(target_os = "android", all(target_os = "linux", not(target_env = "musl"), not(target_env = "ohos"))))] |
| 52 |
ST_RELATIME; |
| 53 |
} |
| 54 |
); |
| 55 |
|
| 56 |
/// Wrapper around the POSIX `statvfs` struct |
| 57 |
/// |
| 58 |
/// For more information see the [`statvfs(3)` man pages](https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/sys_statvfs.h.html). |
| 59 |
#[repr(transparent)] |
| 60 |
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)] |
| 61 |
pub struct Statvfs(libc::statvfs); |
| 62 |
|
| 63 |
impl Statvfs { |
| 64 |
/// get the file system block size |
| 65 |
pub fn block_size(&self) -> c_ulong { |
| 66 |
self.0.f_bsize |
| 67 |
} |
| 68 |
|
| 69 |
/// Get the fundamental file system block size |
| 70 |
pub fn fragment_size(&self) -> c_ulong { |
| 71 |
self.0.f_frsize |
| 72 |
} |
| 73 |
|
| 74 |
/// Get the number of blocks. |
| 75 |
/// |
| 76 |
/// Units are in units of `fragment_size()` |
| 77 |
pub fn blocks(&self) -> libc::fsblkcnt_t { |
| 78 |
self.0.f_blocks |
| 79 |
} |
| 80 |
|
| 81 |
/// Get the number of free blocks in the file system |
| 82 |
pub fn blocks_free(&self) -> libc::fsblkcnt_t { |
| 83 |
self.0.f_bfree |
| 84 |
} |
| 85 |
|
| 86 |
/// Get the number of free blocks for unprivileged users |
| 87 |
pub fn blocks_available(&self) -> libc::fsblkcnt_t { |
| 88 |
self.0.f_bavail |
| 89 |
} |
| 90 |
|
| 91 |
/// Get the total number of file inodes |
| 92 |
pub fn files(&self) -> libc::fsfilcnt_t { |
| 93 |
self.0.f_files |
| 94 |
} |
| 95 |
|
| 96 |
/// Get the number of free file inodes |
| 97 |
pub fn files_free(&self) -> libc::fsfilcnt_t { |
| 98 |
self.0.f_ffree |
| 99 |
} |
| 100 |
|
| 101 |
/// Get the number of free file inodes for unprivileged users |
| 102 |
pub fn files_available(&self) -> libc::fsfilcnt_t { |
| 103 |
self.0.f_favail |
| 104 |
} |
| 105 |
|
| 106 |
/// Get the file system id |
| 107 |
#[cfg(not(target_os = "hurd"))] |
| 108 |
pub fn filesystem_id(&self) -> c_ulong { |
| 109 |
self.0.f_fsid |
| 110 |
} |
| 111 |
/// Get the file system id |
| 112 |
#[cfg(target_os = "hurd")] |
| 113 |
pub fn filesystem_id(&self) -> u64 { |
| 114 |
self.0.f_fsid |
| 115 |
} |
| 116 |
|
| 117 |
/// Get the mount flags |
| 118 |
#[cfg(not(target_os = "redox"))] |
| 119 |
pub fn flags(&self) -> FsFlags { |
| 120 |
FsFlags::from_bits_truncate(self.0.f_flag) |
| 121 |
} |
| 122 |
|
| 123 |
/// Get the maximum filename length |
| 124 |
pub fn name_max(&self) -> c_ulong { |
| 125 |
self.0.f_namemax |
| 126 |
} |
| 127 |
} |
| 128 |
|
| 129 |
/// Return a `Statvfs` object with information about the `path` |
| 130 |
pub fn statvfs<P: ?Sized + NixPath>(path: &P) -> Result<Statvfs> { |
| 131 |
unsafe { |
| 132 |
Errno::clear(); |
| 133 |
let mut stat = mem::MaybeUninit::<libc::statvfs>::uninit(); |
| 134 |
let res = path.with_nix_path(|path| { |
| 135 |
libc::statvfs(path.as_ptr(), stat.as_mut_ptr()) |
| 136 |
})?; |
| 137 |
|
| 138 |
Errno::result(res).map(|_| Statvfs(stat.assume_init())) |
| 139 |
} |
| 140 |
} |
| 141 |
|
| 142 |
/// Return a `Statvfs` object with information about `fd` |
| 143 |
pub fn fstatvfs<Fd: AsFd>(fd: Fd) -> Result<Statvfs> { |
| 144 |
unsafe { |
| 145 |
Errno::clear(); |
| 146 |
let mut stat = mem::MaybeUninit::<libc::statvfs>::uninit(); |
| 147 |
Errno::result(libc::fstatvfs(fd.as_fd().as_raw_fd(), stat.as_mut_ptr())) |
| 148 |
.map(|_| Statvfs(stat.assume_init())) |
| 149 |
} |
| 150 |
} |