blob: 734e64547007b2df95f88f78b8bc5f94e1d9613d [file] [log] [blame]
// Take a look at the license at the top of the repository in the LICENSE file.
use crate::sys::cpu::{get_physical_core_count, CpusWrapper};
use crate::sys::process::{_get_process_data, compute_cpu_usage, refresh_procs, unset_updated};
use crate::sys::utils::{get_all_data, to_u64};
use crate::{Cpu, CpuRefreshKind, LoadAvg, MemoryRefreshKind, Pid, Process, ProcessRefreshKind};
use libc::{self, c_char, sysconf, _SC_CLK_TCK, _SC_HOST_NAME_MAX, _SC_PAGESIZE};
use std::cmp::min;
use std::collections::HashMap;
use std::ffi::CStr;
use std::fs::File;
use std::io::Read;
use std::path::Path;
use std::str::FromStr;
use std::sync::atomic::AtomicIsize;
// This whole thing is to prevent having too many files open at once. It could be problematic
// for processes using a lot of files and using sysinfo at the same time.
pub(crate) static REMAINING_FILES: once_cell::sync::Lazy<AtomicIsize> =
once_cell::sync::Lazy::new(|| {
unsafe {
let mut limits = libc::rlimit {
rlim_cur: 0,
rlim_max: 0,
};
if libc::getrlimit(libc::RLIMIT_NOFILE, &mut limits) != 0 {
// Most Linux system now defaults to 1024.
return AtomicIsize::new(1024 / 2);
}
// We save the value in case the update fails.
let current = limits.rlim_cur;
// The set the soft limit to the hard one.
limits.rlim_cur = limits.rlim_max;
// In this part, we leave minimum 50% of the available file descriptors to the process
// using sysinfo.
AtomicIsize::new(if libc::setrlimit(libc::RLIMIT_NOFILE, &limits) == 0 {
limits.rlim_cur / 2
} else {
current / 2
} as _)
}
});
pub(crate) fn get_max_nb_fds() -> isize {
unsafe {
let mut limits = libc::rlimit {
rlim_cur: 0,
rlim_max: 0,
};
if libc::getrlimit(libc::RLIMIT_NOFILE, &mut limits) != 0 {
// Most Linux system now defaults to 1024.
1024 / 2
} else {
limits.rlim_max as isize / 2
}
}
}
fn boot_time() -> u64 {
if let Ok(buf) = File::open("/proc/stat").and_then(|mut f| {
let mut buf = Vec::new();
f.read_to_end(&mut buf)?;
Ok(buf)
}) {
let line = buf.split(|c| *c == b'\n').find(|l| l.starts_with(b"btime"));
if let Some(line) = line {
return line
.split(|x| *x == b' ')
.filter(|s| !s.is_empty())
.nth(1)
.map(to_u64)
.unwrap_or(0);
}
}
// Either we didn't find "btime" or "/proc/stat" wasn't available for some reason...
unsafe {
let mut up: libc::timespec = std::mem::zeroed();
if libc::clock_gettime(libc::CLOCK_BOOTTIME, &mut up) == 0 {
up.tv_sec as u64
} else {
sysinfo_debug!("clock_gettime failed: boot time cannot be retrieve...");
0
}
}
}
pub(crate) struct SystemInfo {
pub(crate) page_size_b: u64,
pub(crate) clock_cycle: u64,
pub(crate) boot_time: u64,
}
impl SystemInfo {
fn new() -> Self {
unsafe {
Self {
page_size_b: sysconf(_SC_PAGESIZE) as _,
clock_cycle: sysconf(_SC_CLK_TCK) as _,
boot_time: boot_time(),
}
}
}
}
pub(crate) struct SystemInner {
process_list: HashMap<Pid, Process>,
mem_total: u64,
mem_free: u64,
mem_available: u64,
mem_buffers: u64,
mem_page_cache: u64,
mem_shmem: u64,
mem_slab_reclaimable: u64,
swap_total: u64,
swap_free: u64,
info: SystemInfo,
cpus: CpusWrapper,
}
impl SystemInner {
/// It is sometime possible that a CPU usage computation is bigger than
/// `"number of CPUs" * 100`.
///
/// To prevent that, we compute ahead of time this maximum value and ensure that processes'
/// CPU usage don't go over it.
fn get_max_process_cpu_usage(&self) -> f32 {
self.cpus.len() as f32 * 100.
}
fn clear_procs(&mut self, refresh_kind: ProcessRefreshKind) {
let (total_time, compute_cpu, max_value) = if refresh_kind.cpu() {
self.cpus
.refresh_if_needed(true, CpuRefreshKind::new().with_cpu_usage());
if self.cpus.is_empty() {
sysinfo_debug!("cannot compute processes CPU usage: no CPU found...");
(0., false, 0.)
} else {
let (new, old) = self.cpus.get_global_raw_times();
let total_time = if old > new { 1 } else { new - old };
(
total_time as f32 / self.cpus.len() as f32,
true,
self.get_max_process_cpu_usage(),
)
}
} else {
(0., false, 0.)
};
self.process_list.retain(|_, proc_| {
let proc_ = &mut proc_.inner;
if !proc_.updated {
return false;
}
if compute_cpu {
compute_cpu_usage(proc_, total_time, max_value);
}
unset_updated(proc_);
true
});
}
fn refresh_cpus(&mut self, only_update_global_cpu: bool, refresh_kind: CpuRefreshKind) {
self.cpus.refresh(only_update_global_cpu, refresh_kind);
}
}
impl SystemInner {
pub(crate) fn new() -> Self {
Self {
process_list: HashMap::new(),
mem_total: 0,
mem_free: 0,
mem_available: 0,
mem_buffers: 0,
mem_page_cache: 0,
mem_shmem: 0,
mem_slab_reclaimable: 0,
swap_total: 0,
swap_free: 0,
cpus: CpusWrapper::new(),
info: SystemInfo::new(),
}
}
pub(crate) fn refresh_memory_specifics(&mut self, refresh_kind: MemoryRefreshKind) {
if !refresh_kind.ram() && !refresh_kind.swap() {
return;
}
let mut mem_available_found = false;
read_table("/proc/meminfo", ':', |key, value_kib| {
let field = match key {
"MemTotal" => &mut self.mem_total,
"MemFree" => &mut self.mem_free,
"MemAvailable" => {
mem_available_found = true;
&mut self.mem_available
}
"Buffers" => &mut self.mem_buffers,
"Cached" => &mut self.mem_page_cache,
"Shmem" => &mut self.mem_shmem,
"SReclaimable" => &mut self.mem_slab_reclaimable,
"SwapTotal" => &mut self.swap_total,
"SwapFree" => &mut self.swap_free,
_ => return,
};
// /proc/meminfo reports KiB, though it says "kB". Convert it.
*field = value_kib.saturating_mul(1_024);
});
// Linux < 3.14 may not have MemAvailable in /proc/meminfo
// So it should fallback to the old way of estimating available memory
// https://github.com/KittyKatt/screenFetch/issues/386#issuecomment-249312716
if !mem_available_found {
self.mem_available = self
.mem_free
.saturating_add(self.mem_buffers)
.saturating_add(self.mem_page_cache)
.saturating_add(self.mem_slab_reclaimable)
.saturating_sub(self.mem_shmem);
}
}
pub(crate) fn cgroup_limits(&self) -> Option<crate::CGroupLimits> {
crate::CGroupLimits::new(self)
}
pub(crate) fn refresh_cpu_specifics(&mut self, refresh_kind: CpuRefreshKind) {
self.refresh_cpus(false, refresh_kind);
}
pub(crate) fn refresh_processes_specifics(
&mut self,
filter: Option<&[Pid]>,
refresh_kind: ProcessRefreshKind,
) {
let uptime = Self::uptime();
refresh_procs(
&mut self.process_list,
Path::new("/proc"),
uptime,
&self.info,
filter,
refresh_kind,
);
self.clear_procs(refresh_kind);
self.cpus.set_need_cpus_update();
}
pub(crate) fn refresh_process_specifics(
&mut self,
pid: Pid,
refresh_kind: ProcessRefreshKind,
) -> bool {
let uptime = Self::uptime();
match _get_process_data(
&Path::new("/proc/").join(pid.to_string()),
&mut self.process_list,
pid,
None,
uptime,
&self.info,
refresh_kind,
) {
Ok((Some(p), pid)) => {
self.process_list.insert(pid, p);
}
Ok(_) => {}
Err(_e) => {
sysinfo_debug!("Cannot get information for PID {:?}: {:?}", pid, _e);
return false;
}
};
if refresh_kind.cpu() {
self.refresh_cpus(true, CpuRefreshKind::new().with_cpu_usage());
if self.cpus.is_empty() {
eprintln!("Cannot compute process CPU usage: no cpus found...");
return true;
}
let (new, old) = self.cpus.get_global_raw_times();
let total_time = (if old >= new { 1 } else { new - old }) as f32;
let total_time = total_time / self.cpus.len() as f32;
let max_cpu_usage = self.get_max_process_cpu_usage();
if let Some(p) = self.process_list.get_mut(&pid) {
let p = &mut p.inner;
compute_cpu_usage(p, total_time, max_cpu_usage);
unset_updated(p);
}
} else if let Some(p) = self.process_list.get_mut(&pid) {
unset_updated(&mut p.inner);
}
true
}
// COMMON PART
//
// Need to be moved into a "common" file to avoid duplication.
pub(crate) fn processes(&self) -> &HashMap<Pid, Process> {
&self.process_list
}
pub(crate) fn process(&self, pid: Pid) -> Option<&Process> {
self.process_list.get(&pid)
}
pub(crate) fn global_cpu_info(&self) -> &Cpu {
&self.cpus.global_cpu
}
pub(crate) fn cpus(&self) -> &[Cpu] {
&self.cpus.cpus
}
pub(crate) fn physical_core_count(&self) -> Option<usize> {
get_physical_core_count()
}
pub(crate) fn total_memory(&self) -> u64 {
self.mem_total
}
pub(crate) fn free_memory(&self) -> u64 {
self.mem_free
}
pub(crate) fn available_memory(&self) -> u64 {
self.mem_available
}
pub(crate) fn used_memory(&self) -> u64 {
self.mem_total - self.mem_available
}
pub(crate) fn total_swap(&self) -> u64 {
self.swap_total
}
pub(crate) fn free_swap(&self) -> u64 {
self.swap_free
}
// need to be checked
pub(crate) fn used_swap(&self) -> u64 {
self.swap_total - self.swap_free
}
pub(crate) fn uptime() -> u64 {
let content = get_all_data("/proc/uptime", 50).unwrap_or_default();
content
.split('.')
.next()
.and_then(|t| t.parse().ok())
.unwrap_or_default()
}
pub(crate) fn boot_time() -> u64 {
boot_time()
}
pub(crate) fn load_average() -> LoadAvg {
let mut s = String::new();
if File::open("/proc/loadavg")
.and_then(|mut f| f.read_to_string(&mut s))
.is_err()
{
return LoadAvg::default();
}
let loads = s
.trim()
.split(' ')
.take(3)
.map(|val| val.parse::<f64>().unwrap())
.collect::<Vec<f64>>();
LoadAvg {
one: loads[0],
five: loads[1],
fifteen: loads[2],
}
}
#[cfg(not(target_os = "android"))]
pub(crate) fn name() -> Option<String> {
get_system_info_linux(
InfoType::Name,
Path::new("/etc/os-release"),
Path::new("/etc/lsb-release"),
)
}
#[cfg(target_os = "android")]
pub(crate) fn name() -> Option<String> {
get_system_info_android(InfoType::Name)
}
pub(crate) fn long_os_version() -> Option<String> {
#[cfg(target_os = "android")]
let system_name = "Android";
#[cfg(not(target_os = "android"))]
let system_name = "Linux";
Some(format!(
"{} {} {}",
system_name,
Self::os_version().unwrap_or_default(),
Self::name().unwrap_or_default()
))
}
pub(crate) fn host_name() -> Option<String> {
unsafe {
let hostname_max = sysconf(_SC_HOST_NAME_MAX);
let mut buffer = vec![0_u8; hostname_max as usize];
if libc::gethostname(buffer.as_mut_ptr() as *mut c_char, buffer.len()) == 0 {
if let Some(pos) = buffer.iter().position(|x| *x == 0) {
// Shrink buffer to terminate the null bytes
buffer.resize(pos, 0);
}
String::from_utf8(buffer).ok()
} else {
sysinfo_debug!("gethostname failed: hostname cannot be retrieved...");
None
}
}
}
pub(crate) fn kernel_version() -> Option<String> {
let mut raw = std::mem::MaybeUninit::<libc::utsname>::zeroed();
unsafe {
if libc::uname(raw.as_mut_ptr()) == 0 {
let info = raw.assume_init();
let release = info
.release
.iter()
.filter(|c| **c != 0)
.map(|c| *c as u8 as char)
.collect::<String>();
Some(release)
} else {
None
}
}
}
#[cfg(not(target_os = "android"))]
pub(crate) fn os_version() -> Option<String> {
get_system_info_linux(
InfoType::OsVersion,
Path::new("/etc/os-release"),
Path::new("/etc/lsb-release"),
)
}
#[cfg(target_os = "android")]
pub(crate) fn os_version() -> Option<String> {
get_system_info_android(InfoType::OsVersion)
}
#[cfg(not(target_os = "android"))]
pub(crate) fn distribution_id() -> String {
get_system_info_linux(
InfoType::DistributionID,
Path::new("/etc/os-release"),
Path::new(""),
)
.unwrap_or_else(|| std::env::consts::OS.to_owned())
}
#[cfg(target_os = "android")]
pub(crate) fn distribution_id() -> String {
// Currently get_system_info_android doesn't support InfoType::DistributionID and always
// returns None. This call is done anyway for consistency with non-Android implementation
// and to suppress dead-code warning for DistributionID on Android.
get_system_info_android(InfoType::DistributionID)
.unwrap_or_else(|| std::env::consts::OS.to_owned())
}
pub(crate) fn cpu_arch() -> Option<String> {
let mut raw = std::mem::MaybeUninit::<libc::utsname>::uninit();
unsafe {
if libc::uname(raw.as_mut_ptr()) != 0 {
return None;
}
let info = raw.assume_init();
// Converting `&[i8]` to `&[u8]`.
let machine: &[u8] =
std::slice::from_raw_parts(info.machine.as_ptr() as *const _, info.machine.len());
CStr::from_bytes_until_nul(machine)
.ok()
.and_then(|res| match res.to_str() {
Ok(arch) => Some(arch.to_string()),
Err(_) => None,
})
}
}
}
fn read_u64(filename: &str) -> Option<u64> {
get_all_data(filename, 16_635)
.ok()
.and_then(|d| u64::from_str(d.trim()).ok())
}
fn read_table<F>(filename: &str, colsep: char, mut f: F)
where
F: FnMut(&str, u64),
{
if let Ok(content) = get_all_data(filename, 16_635) {
content
.split('\n')
.flat_map(|line| {
let mut split = line.split(colsep);
let key = split.next()?;
let value = split.next()?;
let value0 = value.trim_start().split(' ').next()?;
let value0_u64 = u64::from_str(value0).ok()?;
Some((key, value0_u64))
})
.for_each(|(k, v)| f(k, v));
}
}
impl crate::CGroupLimits {
fn new(sys: &SystemInner) -> Option<Self> {
assert!(
sys.mem_total != 0,
"You need to call System::refresh_memory before trying to get cgroup limits!",
);
if let (Some(mem_cur), Some(mem_max)) = (
read_u64("/sys/fs/cgroup/memory.current"),
read_u64("/sys/fs/cgroup/memory.max"),
) {
// cgroups v2
let mut limits = Self {
total_memory: sys.mem_total,
free_memory: sys.mem_free,
free_swap: sys.swap_free,
};
limits.total_memory = min(mem_max, sys.mem_total);
limits.free_memory = limits.total_memory.saturating_sub(mem_cur);
if let Some(swap_cur) = read_u64("/sys/fs/cgroup/memory.swap.current") {
limits.free_swap = sys.swap_total.saturating_sub(swap_cur);
}
read_table("/sys/fs/cgroup/memory.stat", ' ', |_key, value| {
limits.free_memory = limits.free_memory.saturating_sub(value);
});
Some(limits)
} else if let (Some(mem_cur), Some(mem_max)) = (
// cgroups v1
read_u64("/sys/fs/cgroup/memory/memory.usage_in_bytes"),
read_u64("/sys/fs/cgroup/memory/memory.limit_in_bytes"),
) {
let mut limits = Self {
total_memory: sys.mem_total,
free_memory: sys.mem_free,
free_swap: sys.swap_free,
};
limits.total_memory = min(mem_max, sys.mem_total);
limits.free_memory = limits.total_memory.saturating_sub(mem_cur);
Some(limits)
} else {
None
}
}
}
#[derive(PartialEq, Eq)]
enum InfoType {
/// The end-user friendly name of:
/// - Android: The device model
/// - Linux: The distributions name
Name,
OsVersion,
/// Machine-parseable ID of a distribution, see
/// https://www.freedesktop.org/software/systemd/man/os-release.html#ID=
DistributionID,
}
#[cfg(not(target_os = "android"))]
fn get_system_info_linux(info: InfoType, path: &Path, fallback_path: &Path) -> Option<String> {
if let Ok(buf) = File::open(path).and_then(|mut f| {
let mut buf = String::new();
f.read_to_string(&mut buf)?;
Ok(buf)
}) {
let info_str = match info {
InfoType::Name => "NAME=",
InfoType::OsVersion => "VERSION_ID=",
InfoType::DistributionID => "ID=",
};
for line in buf.lines() {
if let Some(stripped) = line.strip_prefix(info_str) {
return Some(stripped.replace('"', ""));
}
}
}
// Fallback to `/etc/lsb-release` file for systems where VERSION_ID is not included.
// VERSION_ID is not required in the `/etc/os-release` file
// per https://www.linux.org/docs/man5/os-release.html
// If this fails for some reason, fallback to None
let buf = File::open(fallback_path)
.and_then(|mut f| {
let mut buf = String::new();
f.read_to_string(&mut buf)?;
Ok(buf)
})
.ok()?;
let info_str = match info {
InfoType::OsVersion => "DISTRIB_RELEASE=",
InfoType::Name => "DISTRIB_ID=",
InfoType::DistributionID => {
// lsb-release is inconsistent with os-release and unsupported.
return None;
}
};
for line in buf.lines() {
if let Some(stripped) = line.strip_prefix(info_str) {
return Some(stripped.replace('"', ""));
}
}
None
}
#[cfg(target_os = "android")]
fn get_system_info_android(info: InfoType) -> Option<String> {
// https://android.googlesource.com/platform/frameworks/base/+/refs/heads/master/core/java/android/os/Build.java#58
let name: &'static [u8] = match info {
InfoType::Name => b"ro.product.model\0",
InfoType::OsVersion => b"ro.build.version.release\0",
InfoType::DistributionID => {
// Not supported.
return None;
}
};
let mut value_buffer = vec![0u8; libc::PROP_VALUE_MAX as usize];
unsafe {
let len = libc::__system_property_get(
name.as_ptr() as *const c_char,
value_buffer.as_mut_ptr() as *mut c_char,
);
if len != 0 {
if let Some(pos) = value_buffer.iter().position(|c| *c == 0) {
value_buffer.resize(pos, 0);
}
String::from_utf8(value_buffer).ok()
} else {
None
}
}
}
#[cfg(test)]
mod test {
#[cfg(target_os = "android")]
use super::get_system_info_android;
#[cfg(not(target_os = "android"))]
use super::get_system_info_linux;
use super::InfoType;
#[test]
#[cfg(target_os = "android")]
fn lsb_release_fallback_android() {
assert!(get_system_info_android(InfoType::OsVersion).is_some());
assert!(get_system_info_android(InfoType::Name).is_some());
assert!(get_system_info_android(InfoType::DistributionID).is_none());
}
#[test]
#[cfg(not(target_os = "android"))]
fn lsb_release_fallback_not_android() {
use std::path::Path;
let dir = tempfile::tempdir().expect("failed to create temporary directory");
let tmp1 = dir.path().join("tmp1");
let tmp2 = dir.path().join("tmp2");
// /etc/os-release
std::fs::write(
&tmp1,
r#"NAME="Ubuntu"
VERSION="20.10 (Groovy Gorilla)"
ID=ubuntu
ID_LIKE=debian
PRETTY_NAME="Ubuntu 20.10"
VERSION_ID="20.10"
VERSION_CODENAME=groovy
UBUNTU_CODENAME=groovy
"#,
)
.expect("Failed to create tmp1");
// /etc/lsb-release
std::fs::write(
&tmp2,
r#"DISTRIB_ID=Ubuntu
DISTRIB_RELEASE=20.10
DISTRIB_CODENAME=groovy
DISTRIB_DESCRIPTION="Ubuntu 20.10"
"#,
)
.expect("Failed to create tmp2");
// Check for the "normal" path: "/etc/os-release"
assert_eq!(
get_system_info_linux(InfoType::OsVersion, &tmp1, Path::new("")),
Some("20.10".to_owned())
);
assert_eq!(
get_system_info_linux(InfoType::Name, &tmp1, Path::new("")),
Some("Ubuntu".to_owned())
);
assert_eq!(
get_system_info_linux(InfoType::DistributionID, &tmp1, Path::new("")),
Some("ubuntu".to_owned())
);
// Check for the "fallback" path: "/etc/lsb-release"
assert_eq!(
get_system_info_linux(InfoType::OsVersion, Path::new(""), &tmp2),
Some("20.10".to_owned())
);
assert_eq!(
get_system_info_linux(InfoType::Name, Path::new(""), &tmp2),
Some("Ubuntu".to_owned())
);
assert_eq!(
get_system_info_linux(InfoType::DistributionID, Path::new(""), &tmp2),
None
);
}
}