Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mitigate cpu_usage() from returning NaN on Macs #1236

Merged
merged 3 commits into from
Mar 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -454,6 +454,7 @@ mod test {
}

#[test]
#[allow(clippy::const_is_empty)]
fn check_nb_supported_signals() {
if IS_SUPPORTED_SYSTEM {
assert!(
Expand Down
37 changes: 29 additions & 8 deletions src/unix/apple/cpu.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,14 @@ use libc::{c_char, c_void, host_processor_info, mach_port_t, mach_task_self};
use std::mem;
use std::ops::Deref;
use std::sync::Arc;
use std::time::Instant;

pub(crate) struct CpusWrapper {
pub(crate) global_cpu: Cpu,
pub(crate) cpus: Vec<Cpu>,
pub(crate) got_cpu_frequency: bool,
/// This field is needed to prevent updating when not enough time passed since last update.
last_update: Option<Instant>,
}

impl CpusWrapper {
Expand All @@ -28,13 +31,19 @@ impl CpusWrapper {
},
cpus: Vec::new(),
got_cpu_frequency: false,
last_update: None,
}
}

pub(crate) fn refresh(&mut self, refresh_kind: CpuRefreshKind, port: mach_port_t) {
let need_cpu_usage_update = self
.last_update
.is_some_and(|last_update| last_update.elapsed() > crate::MINIMUM_CPU_UPDATE_INTERVAL);

let cpus = &mut self.cpus;
if cpus.is_empty() {
init_cpus(port, cpus, &mut self.global_cpu, refresh_kind);
self.last_update = Some(Instant::now());
self.got_cpu_frequency = refresh_kind.frequency();
return;
}
Expand All @@ -45,7 +54,8 @@ impl CpusWrapper {
}
self.got_cpu_frequency = true;
}
if refresh_kind.cpu_usage() {
if refresh_kind.cpu_usage() && need_cpu_usage_update {
self.last_update = Some(Instant::now());
update_cpu_usage(port, &mut self.global_cpu, |proc_data, cpu_info| {
let mut percentage = 0f32;
let mut offset = 0;
Expand Down Expand Up @@ -229,19 +239,30 @@ fn get_idle(cpu_info: *mut i32, offset: isize) -> i32 {
pub(crate) fn compute_usage_of_cpu(proc_: &Cpu, cpu_info: *mut i32, offset: isize) -> f32 {
let old_cpu_info = proc_.inner.data().cpu_info.0;
let in_use;
let total;
let idle;

// In case we are initializing cpus, there is no "old value" yet.
if old_cpu_info == cpu_info {
in_use = get_in_use(cpu_info, offset);
total = in_use.saturating_add(get_idle(cpu_info, offset) as _);
idle = get_idle(cpu_info, offset);
} else {
in_use = get_in_use(cpu_info, offset).saturating_sub(get_in_use(old_cpu_info, offset));
total = in_use.saturating_add(
get_idle(cpu_info, offset).saturating_sub(get_idle(old_cpu_info, offset)) as _,
);
let new_in_use = get_in_use(cpu_info, offset);
let old_in_use = get_in_use(old_cpu_info, offset);

let new_idle = get_idle(cpu_info, offset);
let old_idle = get_idle(old_cpu_info, offset);

in_use = new_in_use.saturating_sub(old_in_use);
idle = new_idle.saturating_sub(old_idle) as _;
}
let total = in_use.saturating_add(idle as _);
let usage = (in_use as f32 / total as f32) * 100.;
if usage.is_nan() {
// If divided by zero, avoid returning a NaN
0.
} else {
usage
}
in_use as f32 / total as f32 * 100.
}

pub(crate) fn update_cpu_usage<F: FnOnce(Arc<CpuData>, *mut i32) -> (f32, usize)>(
Expand Down
15 changes: 15 additions & 0 deletions tests/cpu.rs
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,18 @@ fn test_global_cpu_info_not_set() {
assert_eq!(s.global_cpu_info().brand(), "");
assert_eq!(s.global_cpu_info().frequency(), 0);
}

#[test]
fn test_too_rapid_cpu_refresh() {
let mut s = sysinfo::System::new();
assert!(s.cpus().is_empty());

if !sysinfo::IS_SUPPORTED_SYSTEM {
return;
}

s.refresh_cpu();
s.refresh_cpu();

assert!(s.cpus().iter().any(|c| !c.cpu_usage().is_nan()));
}