1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296
// Take a look at the license at the top of the repository in the LICENSE file.
use crate::sys::utils::{get_all_data, to_cpath};
use crate::{DiskExt, DiskType};
use libc::statvfs;
use std::ffi::{OsStr, OsString};
use std::fs;
use std::mem;
use std::os::unix::ffi::OsStrExt;
use std::path::{Path, PathBuf};
macro_rules! cast {
($x:expr) => {
u64::from($x)
};
}
#[doc = include_str!("../../md_doc/disk.md")]
#[derive(PartialEq, Eq)]
pub struct Disk {
type_: DiskType,
device_name: OsString,
file_system: Vec<u8>,
mount_point: PathBuf,
total_space: u64,
available_space: u64,
is_removable: bool,
}
impl DiskExt for Disk {
fn type_(&self) -> DiskType {
self.type_
}
fn name(&self) -> &OsStr {
&self.device_name
}
fn file_system(&self) -> &[u8] {
&self.file_system
}
fn mount_point(&self) -> &Path {
&self.mount_point
}
fn total_space(&self) -> u64 {
self.total_space
}
fn available_space(&self) -> u64 {
self.available_space
}
fn is_removable(&self) -> bool {
self.is_removable
}
fn refresh(&mut self) -> bool {
unsafe {
let mut stat: statvfs = mem::zeroed();
let mount_point_cpath = to_cpath(&self.mount_point);
if statvfs(mount_point_cpath.as_ptr() as *const _, &mut stat) == 0 {
let tmp = cast!(stat.f_bsize).saturating_mul(cast!(stat.f_bavail));
self.available_space = cast!(tmp);
true
} else {
false
}
}
}
}
fn new_disk(
device_name: &OsStr,
mount_point: &Path,
file_system: &[u8],
removable_entries: &[PathBuf],
) -> Option<Disk> {
let mount_point_cpath = to_cpath(mount_point);
let type_ = find_type_for_device_name(device_name);
let mut total = 0;
let mut available = 0;
unsafe {
let mut stat: statvfs = mem::zeroed();
if statvfs(mount_point_cpath.as_ptr() as *const _, &mut stat) == 0 {
let bsize = cast!(stat.f_bsize);
let blocks = cast!(stat.f_blocks);
let bavail = cast!(stat.f_bavail);
total = bsize.saturating_mul(blocks);
available = bsize.saturating_mul(bavail);
}
if total == 0 {
return None;
}
let mount_point = mount_point.to_owned();
let is_removable = removable_entries
.iter()
.any(|e| e.as_os_str() == device_name);
Some(Disk {
type_,
device_name: device_name.to_owned(),
file_system: file_system.to_owned(),
mount_point,
total_space: cast!(total),
available_space: cast!(available),
is_removable,
})
}
}
#[allow(clippy::manual_range_contains)]
fn find_type_for_device_name(device_name: &OsStr) -> DiskType {
// The format of devices are as follows:
// - device_name is symbolic link in the case of /dev/mapper/
// and /dev/root, and the target is corresponding device under
// /sys/block/
// - In the case of /dev/sd, the format is /dev/sd[a-z][1-9],
// corresponding to /sys/block/sd[a-z]
// - In the case of /dev/nvme, the format is /dev/nvme[0-9]n[0-9]p[0-9],
// corresponding to /sys/block/nvme[0-9]n[0-9]
// - In the case of /dev/mmcblk, the format is /dev/mmcblk[0-9]p[0-9],
// corresponding to /sys/block/mmcblk[0-9]
let device_name_path = device_name.to_str().unwrap_or_default();
let real_path = fs::canonicalize(device_name).unwrap_or_else(|_| PathBuf::from(device_name));
let mut real_path = real_path.to_str().unwrap_or_default();
if device_name_path.starts_with("/dev/mapper/") {
// Recursively solve, for example /dev/dm-0
if real_path != device_name_path {
return find_type_for_device_name(OsStr::new(&real_path));
}
} else if device_name_path.starts_with("/dev/sd") || device_name_path.starts_with("/dev/vd") {
// Turn "sda1" into "sda" or "vda1" into "vda"
real_path = real_path.trim_start_matches("/dev/");
real_path = real_path.trim_end_matches(|c| c >= '0' && c <= '9');
} else if device_name_path.starts_with("/dev/nvme") {
// Turn "nvme0n1p1" into "nvme0n1"
real_path = match real_path.find('p') {
Some(idx) => &real_path["/dev/".len()..idx],
None => &real_path["/dev/".len()..],
};
} else if device_name_path.starts_with("/dev/root") {
// Recursively solve, for example /dev/mmcblk0p1
if real_path != device_name_path {
return find_type_for_device_name(OsStr::new(&real_path));
}
} else if device_name_path.starts_with("/dev/mmcblk") {
// Turn "mmcblk0p1" into "mmcblk0"
real_path = match real_path.find('p') {
Some(idx) => &real_path["/dev/".len()..idx],
None => &real_path["/dev/".len()..],
};
} else {
// Default case: remove /dev/ and expects the name presents under /sys/block/
// For example, /dev/dm-0 to dm-0
real_path = real_path.trim_start_matches("/dev/");
}
let trimmed: &OsStr = OsStrExt::from_bytes(real_path.as_bytes());
let path = Path::new("/sys/block/")
.to_owned()
.join(trimmed)
.join("queue/rotational");
// Normally, this file only contains '0' or '1' but just in case, we get 8 bytes...
match get_all_data(path, 8)
.unwrap_or_default()
.trim()
.parse()
.ok()
{
// The disk is marked as rotational so it's a HDD.
Some(1) => DiskType::HDD,
// The disk is marked as non-rotational so it's very likely a SSD.
Some(0) => DiskType::SSD,
// Normally it shouldn't happen but welcome to the wonderful world of IT! :D
Some(x) => DiskType::Unknown(x),
// The information isn't available...
None => DiskType::Unknown(-1),
}
}
fn get_all_disks_inner(content: &str) -> Vec<Disk> {
// The goal of this array is to list all removable devices (the ones whose name starts with
// "usb-"). Then we check if
let removable_entries = match fs::read_dir("/dev/disk/by-id/") {
Ok(r) => r
.filter_map(|res| Some(res.ok()?.path()))
.filter_map(|e| {
if e.file_name()
.and_then(|x| Some(x.to_str()?.starts_with("usb-")))
.unwrap_or_default()
{
e.canonicalize().ok()
} else {
None
}
})
.collect::<Vec<PathBuf>>(),
_ => Vec::new(),
};
content
.lines()
.map(|line| {
let line = line.trim_start();
// mounts format
// http://man7.org/linux/man-pages/man5/fstab.5.html
// fs_spec<tab>fs_file<tab>fs_vfstype<tab>other fields
let mut fields = line.split_whitespace();
let fs_spec = fields.next().unwrap_or("");
let fs_file = fields
.next()
.unwrap_or("")
.replace("\\134", "\\")
.replace("\\040", " ")
.replace("\\011", "\t")
.replace("\\012", "\n");
let fs_vfstype = fields.next().unwrap_or("");
(fs_spec, fs_file, fs_vfstype)
})
.filter(|(fs_spec, fs_file, fs_vfstype)| {
// Check if fs_vfstype is one of our 'ignored' file systems.
let filtered = matches!(
*fs_vfstype,
"rootfs" | // https://www.kernel.org/doc/Documentation/filesystems/ramfs-rootfs-initramfs.txt
"sysfs" | // pseudo file system for kernel objects
"proc" | // another pseudo file system
"tmpfs" |
"devtmpfs" |
"cgroup" |
"cgroup2" |
"pstore" | // https://www.kernel.org/doc/Documentation/ABI/testing/pstore
"squashfs" | // squashfs is a compressed read-only file system (for snaps)
"rpc_pipefs" | // The pipefs pseudo file system service
"iso9660" | // optical media
"nfs4" | // calling statvfs on a mounted NFS may hang
"nfs" // nfs2 or nfs3
);
!(filtered ||
fs_file.starts_with("/sys") || // check if fs_file is an 'ignored' mount point
fs_file.starts_with("/proc") ||
(fs_file.starts_with("/run") && !fs_file.starts_with("/run/media")) ||
fs_spec.starts_with("sunrpc"))
})
.filter_map(|(fs_spec, fs_file, fs_vfstype)| {
new_disk(
fs_spec.as_ref(),
Path::new(&fs_file),
fs_vfstype.as_bytes(),
&removable_entries,
)
})
.collect()
}
pub(crate) fn get_all_disks() -> Vec<Disk> {
get_all_disks_inner(&get_all_data("/proc/mounts", 16_385).unwrap_or_default())
}
// #[test]
// fn check_all_disks() {
// let disks = get_all_disks_inner(
// r#"tmpfs /proc tmpfs rw,seclabel,relatime 0 0
// proc /proc proc rw,nosuid,nodev,noexec,relatime 0 0
// systemd-1 /proc/sys/fs/binfmt_misc autofs rw,relatime,fd=29,pgrp=1,timeout=0,minproto=5,maxproto=5,direct,pipe_ino=17771 0 0
// tmpfs /sys tmpfs rw,seclabel,relatime 0 0
// sysfs /sys sysfs rw,seclabel,nosuid,nodev,noexec,relatime 0 0
// securityfs /sys/kernel/security securityfs rw,nosuid,nodev,noexec,relatime 0 0
// cgroup2 /sys/fs/cgroup cgroup2 rw,seclabel,nosuid,nodev,noexec,relatime,nsdelegate 0 0
// pstore /sys/fs/pstore pstore rw,seclabel,nosuid,nodev,noexec,relatime 0 0
// none /sys/fs/bpf bpf rw,nosuid,nodev,noexec,relatime,mode=700 0 0
// configfs /sys/kernel/config configfs rw,nosuid,nodev,noexec,relatime 0 0
// selinuxfs /sys/fs/selinux selinuxfs rw,relatime 0 0
// debugfs /sys/kernel/debug debugfs rw,seclabel,nosuid,nodev,noexec,relatime 0 0
// tmpfs /dev/shm tmpfs rw,seclabel,relatime 0 0
// devpts /dev/pts devpts rw,seclabel,relatime,gid=5,mode=620,ptmxmode=666 0 0
// tmpfs /sys/fs/selinux tmpfs rw,seclabel,relatime 0 0
// /dev/vda2 /proc/filesystems xfs rw,seclabel,relatime,attr2,inode64,logbufs=8,logbsize=32k,noquota 0 0
// "#,
// );
// assert_eq!(disks.len(), 1);
// assert_eq!(
// disks[0],
// Disk {
// type_: DiskType::Unknown(-1),
// name: OsString::from("devpts"),
// file_system: vec![100, 101, 118, 112, 116, 115],
// mount_point: PathBuf::from("/dev/pts"),
// total_space: 0,
// available_space: 0,
// }
// );
// }