blob: ce4f6145ba1e76ff0e0bc5aeeaf54f104292ca91 [file] [log] [blame]
// Take a look at the license at the top of the repository in the LICENSE file.
use crate::sys::tools::KeyHandler;
use crate::{Cpu, CpuRefreshKind, LoadAvg};
use std::collections::HashMap;
use std::ffi::c_void;
use std::io::Error;
use std::mem;
use std::ops::DerefMut;
use std::sync::Mutex;
use windows::core::{s, PCSTR, PCWSTR};
use windows::Win32::Foundation::{
CloseHandle, BOOLEAN, ERROR_INSUFFICIENT_BUFFER, ERROR_SUCCESS, FALSE, HANDLE,
};
use windows::Win32::System::Performance::{
PdhAddEnglishCounterA, PdhAddEnglishCounterW, PdhCloseQuery, PdhCollectQueryData,
PdhCollectQueryDataEx, PdhGetFormattedCounterValue, PdhOpenQueryA, PdhRemoveCounter,
PDH_FMT_COUNTERVALUE, PDH_FMT_DOUBLE,
};
use windows::Win32::System::Power::{
CallNtPowerInformation, ProcessorInformation, PROCESSOR_POWER_INFORMATION,
};
use windows::Win32::System::SystemInformation;
use windows::Win32::System::SystemInformation::{
GetLogicalProcessorInformationEx, GetSystemInfo, RelationAll, RelationProcessorCore,
SYSTEM_INFO, SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX,
};
use windows::Win32::System::Threading::{
CreateEventA, RegisterWaitForSingleObject, INFINITE, WT_EXECUTEDEFAULT,
};
// This formula comes from Linux's include/linux/sched/loadavg.h
// https://github.com/torvalds/linux/blob/345671ea0f9258f410eb057b9ced9cefbbe5dc78/include/linux/sched/loadavg.h#L20-L23
#[allow(clippy::excessive_precision)]
const LOADAVG_FACTOR_1F: f64 = 0.9200444146293232478931553241;
#[allow(clippy::excessive_precision)]
const LOADAVG_FACTOR_5F: f64 = 0.9834714538216174894737477501;
#[allow(clippy::excessive_precision)]
const LOADAVG_FACTOR_15F: f64 = 0.9944598480048967508795473394;
// The time interval in seconds between taking load counts, same as Linux
const SAMPLING_INTERVAL: usize = 5;
// maybe use a read/write lock instead?
static LOAD_AVG: once_cell::sync::Lazy<Mutex<Option<LoadAvg>>> =
once_cell::sync::Lazy::new(|| unsafe { init_load_avg() });
pub(crate) fn get_load_average() -> LoadAvg {
if let Ok(avg) = LOAD_AVG.lock() {
if let Some(avg) = &*avg {
return avg.clone();
}
}
LoadAvg::default()
}
unsafe extern "system" fn load_avg_callback(counter: *mut c_void, _: BOOLEAN) {
let mut display_value = mem::MaybeUninit::<PDH_FMT_COUNTERVALUE>::uninit();
if PdhGetFormattedCounterValue(
counter as _,
PDH_FMT_DOUBLE,
None,
display_value.as_mut_ptr(),
) != ERROR_SUCCESS.0
{
return;
}
let display_value = display_value.assume_init();
if let Ok(mut avg) = LOAD_AVG.lock() {
if let Some(avg) = avg.deref_mut() {
let current_load = display_value.Anonymous.doubleValue;
avg.one = avg.one * LOADAVG_FACTOR_1F + current_load * (1.0 - LOADAVG_FACTOR_1F);
avg.five = avg.five * LOADAVG_FACTOR_5F + current_load * (1.0 - LOADAVG_FACTOR_5F);
avg.fifteen =
avg.fifteen * LOADAVG_FACTOR_15F + current_load * (1.0 - LOADAVG_FACTOR_15F);
}
}
}
unsafe fn init_load_avg() -> Mutex<Option<LoadAvg>> {
// You can see the original implementation here: https://github.com/giampaolo/psutil
let mut query = 0;
if PdhOpenQueryA(PCSTR::null(), 0, &mut query) != ERROR_SUCCESS.0 {
sysinfo_debug!("init_load_avg: PdhOpenQueryA failed");
return Mutex::new(None);
}
let mut counter = 0;
if PdhAddEnglishCounterA(query, s!("\\System\\Cpu Queue Length"), 0, &mut counter)
!= ERROR_SUCCESS.0
{
PdhCloseQuery(query);
sysinfo_debug!("init_load_avg: failed to get CPU queue length");
return Mutex::new(None);
}
let event = match CreateEventA(None, FALSE, FALSE, s!("LoadUpdateEvent")) {
Ok(ev) => ev,
Err(_) => {
PdhCloseQuery(query);
sysinfo_debug!("init_load_avg: failed to create event `LoadUpdateEvent`");
return Mutex::new(None);
}
};
if PdhCollectQueryDataEx(query, SAMPLING_INTERVAL as _, event) != ERROR_SUCCESS.0 {
PdhCloseQuery(query);
sysinfo_debug!("init_load_avg: PdhCollectQueryDataEx failed");
return Mutex::new(None);
}
let mut wait_handle = HANDLE::default();
if RegisterWaitForSingleObject(
&mut wait_handle,
event,
Some(load_avg_callback),
Some(counter as *const c_void),
INFINITE,
WT_EXECUTEDEFAULT,
)
.is_ok()
{
Mutex::new(Some(LoadAvg::default()))
} else {
PdhRemoveCounter(counter);
PdhCloseQuery(query);
sysinfo_debug!("init_load_avg: RegisterWaitForSingleObject failed");
Mutex::new(None)
}
}
struct InternalQuery {
query: HANDLE,
event: HANDLE,
data: HashMap<String, HANDLE>,
}
unsafe impl Send for InternalQuery {}
unsafe impl Sync for InternalQuery {}
impl Drop for InternalQuery {
fn drop(&mut self) {
unsafe {
for (_, counter) in self.data.iter() {
PdhRemoveCounter(counter.0);
}
if !self.event.is_invalid() {
let _err = CloseHandle(self.event);
}
if !self.query.is_invalid() {
PdhCloseQuery(self.query.0);
}
}
}
}
pub(crate) struct Query {
internal: InternalQuery,
}
impl Query {
pub fn new() -> Option<Query> {
let mut query = 0;
unsafe {
if PdhOpenQueryA(PCSTR::null(), 0, &mut query) == ERROR_SUCCESS.0 {
let q = InternalQuery {
query: HANDLE(query),
event: HANDLE::default(),
data: HashMap::new(),
};
Some(Query { internal: q })
} else {
sysinfo_debug!("Query::new: PdhOpenQueryA failed");
None
}
}
}
#[allow(clippy::ptr_arg)]
pub fn get(&self, name: &String) -> Option<f32> {
if let Some(counter) = self.internal.data.get(name) {
unsafe {
let mut display_value = mem::MaybeUninit::<PDH_FMT_COUNTERVALUE>::uninit();
return if PdhGetFormattedCounterValue(
counter.0,
PDH_FMT_DOUBLE,
None,
display_value.as_mut_ptr(),
) == ERROR_SUCCESS.0
{
let display_value = display_value.assume_init();
Some(display_value.Anonymous.doubleValue as f32)
} else {
sysinfo_debug!("Query::get: PdhGetFormattedCounterValue failed");
Some(0.)
};
}
}
None
}
#[allow(clippy::ptr_arg)]
pub fn add_english_counter(&mut self, name: &String, getter: Vec<u16>) -> bool {
if self.internal.data.contains_key(name) {
sysinfo_debug!("Query::add_english_counter: doesn't have key `{:?}`", name);
return false;
}
unsafe {
let mut counter = 0;
let ret = PdhAddEnglishCounterW(
self.internal.query.0,
PCWSTR::from_raw(getter.as_ptr()),
0,
&mut counter,
);
if ret == ERROR_SUCCESS.0 {
self.internal.data.insert(name.clone(), HANDLE(counter));
} else {
sysinfo_debug!(
"Query::add_english_counter: failed to add counter '{}': {:x}...",
name,
ret,
);
return false;
}
}
true
}
pub fn refresh(&self) {
unsafe {
if PdhCollectQueryData(self.internal.query.0) != ERROR_SUCCESS.0 {
sysinfo_debug!("failed to refresh CPU data");
}
}
}
}
pub(crate) struct CpusWrapper {
global: Cpu,
cpus: Vec<Cpu>,
got_cpu_frequency: bool,
}
impl CpusWrapper {
pub fn new() -> Self {
Self {
global: Cpu {
inner: CpuInner::new_with_values(
"Total CPU".to_owned(),
String::new(),
String::new(),
0,
),
},
cpus: Vec::new(),
got_cpu_frequency: false,
}
}
pub fn global_cpu(&self) -> &Cpu {
&self.global
}
pub fn global_cpu_mut(&mut self) -> &mut Cpu {
&mut self.global
}
pub fn cpus(&self) -> &[Cpu] {
&self.cpus
}
fn init_if_needed(&mut self, refresh_kind: CpuRefreshKind) {
if self.cpus.is_empty() {
self.cpus = init_cpus(refresh_kind);
self.got_cpu_frequency = refresh_kind.frequency();
}
}
pub fn len(&mut self) -> usize {
self.init_if_needed(CpuRefreshKind::new());
self.cpus.len()
}
pub fn iter_mut(&mut self, refresh_kind: CpuRefreshKind) -> impl Iterator<Item = &mut Cpu> {
self.init_if_needed(refresh_kind);
self.cpus.iter_mut()
}
pub fn get_frequencies(&mut self) {
if self.got_cpu_frequency {
return;
}
let frequencies = get_frequencies(self.cpus.len());
for (cpu, frequency) in self.cpus.iter_mut().zip(frequencies) {
cpu.inner.set_frequency(frequency);
}
self.global
.inner
.set_frequency(self.cpus.first().map(|cpu| cpu.frequency()).unwrap_or(0));
self.got_cpu_frequency = true;
}
}
pub(crate) struct CpuInner {
name: String,
cpu_usage: f32,
key_used: Option<KeyHandler>,
vendor_id: String,
brand: String,
frequency: u64,
}
impl CpuInner {
pub(crate) fn cpu_usage(&self) -> f32 {
self.cpu_usage
}
pub(crate) fn name(&self) -> &str {
&self.name
}
pub(crate) fn frequency(&self) -> u64 {
self.frequency
}
pub(crate) fn vendor_id(&self) -> &str {
&self.vendor_id
}
pub(crate) fn brand(&self) -> &str {
&self.brand
}
pub(crate) fn new_with_values(
name: String,
vendor_id: String,
brand: String,
frequency: u64,
) -> Self {
Self {
name,
cpu_usage: 0f32,
key_used: None,
vendor_id,
brand,
frequency,
}
}
pub(crate) fn set_cpu_usage(&mut self, value: f32) {
self.cpu_usage = value;
}
pub(crate) fn set_frequency(&mut self, value: u64) {
self.frequency = value;
}
}
fn get_vendor_id_not_great(info: &SYSTEM_INFO) -> String {
// https://docs.microsoft.com/fr-fr/windows/win32/api/sysinfoapi/ns-sysinfoapi-system_info
unsafe {
match info.Anonymous.Anonymous.wProcessorArchitecture {
SystemInformation::PROCESSOR_ARCHITECTURE_INTEL => "Intel x86",
SystemInformation::PROCESSOR_ARCHITECTURE_MIPS => "MIPS",
SystemInformation::PROCESSOR_ARCHITECTURE_ALPHA => "RISC Alpha",
SystemInformation::PROCESSOR_ARCHITECTURE_PPC => "PPC",
SystemInformation::PROCESSOR_ARCHITECTURE_SHX => "SHX",
SystemInformation::PROCESSOR_ARCHITECTURE_ARM => "ARM",
SystemInformation::PROCESSOR_ARCHITECTURE_IA64 => "Intel Itanium-based x64",
SystemInformation::PROCESSOR_ARCHITECTURE_ALPHA64 => "RISC Alpha x64",
SystemInformation::PROCESSOR_ARCHITECTURE_MSIL => "MSIL",
SystemInformation::PROCESSOR_ARCHITECTURE_AMD64 => "(Intel or AMD) x64",
SystemInformation::PROCESSOR_ARCHITECTURE_IA32_ON_WIN64 => "Intel Itanium-based x86",
SystemInformation::PROCESSOR_ARCHITECTURE_NEUTRAL => "unknown",
SystemInformation::PROCESSOR_ARCHITECTURE_ARM64 => "ARM x64",
SystemInformation::PROCESSOR_ARCHITECTURE_ARM32_ON_WIN64 => "ARM",
SystemInformation::PROCESSOR_ARCHITECTURE_IA32_ON_ARM64 => "Intel Itanium-based x86",
_ => "unknown",
}
.to_owned()
}
}
#[cfg(any(target_arch = "x86", target_arch = "x86_64"))]
pub(crate) fn get_vendor_id_and_brand(info: &SYSTEM_INFO) -> (String, String) {
#[cfg(target_arch = "x86")]
use std::arch::x86::__cpuid;
#[cfg(target_arch = "x86_64")]
use std::arch::x86_64::__cpuid;
unsafe fn add_u32(v: &mut Vec<u8>, i: u32) {
let i = &i as *const u32 as *const u8;
v.push(*i);
v.push(*i.offset(1));
v.push(*i.offset(2));
v.push(*i.offset(3));
}
unsafe {
// First, we try to get the complete name.
let res = __cpuid(0x80000000);
let n_ex_ids = res.eax;
let brand = if n_ex_ids >= 0x80000004 {
let mut extdata = Vec::with_capacity(5);
for i in 0x80000000..=n_ex_ids {
extdata.push(__cpuid(i));
}
// 4 * u32 * nb_entries
let mut out = Vec::with_capacity(4 * std::mem::size_of::<u32>() * 3);
for data in extdata.iter().take(5).skip(2) {
add_u32(&mut out, data.eax);
add_u32(&mut out, data.ebx);
add_u32(&mut out, data.ecx);
add_u32(&mut out, data.edx);
}
let mut pos = 0;
for e in out.iter() {
if *e == 0 {
break;
}
pos += 1;
}
match std::str::from_utf8(&out[..pos]) {
Ok(s) => s.to_owned(),
_ => String::new(),
}
} else {
String::new()
};
// Failed to get full name, let's retry for the short version!
let res = __cpuid(0);
let mut x = Vec::with_capacity(3 * std::mem::size_of::<u32>());
add_u32(&mut x, res.ebx);
add_u32(&mut x, res.edx);
add_u32(&mut x, res.ecx);
let mut pos = 0;
for e in x.iter() {
if *e == 0 {
break;
}
pos += 1;
}
let vendor_id = match std::str::from_utf8(&x[..pos]) {
Ok(s) => s.to_owned(),
Err(_) => get_vendor_id_not_great(info),
};
(vendor_id, brand)
}
}
#[cfg(all(not(target_arch = "x86_64"), not(target_arch = "x86")))]
pub(crate) fn get_vendor_id_and_brand(info: &SYSTEM_INFO) -> (String, String) {
(get_vendor_id_not_great(info), String::new())
}
pub(crate) fn get_key_used(p: &mut Cpu) -> &mut Option<KeyHandler> {
&mut p.inner.key_used
}
// From https://stackoverflow.com/a/43813138:
//
// If your PC has 64 or fewer logical cpus installed, the above code will work fine. However,
// if your PC has more than 64 logical cpus installed, use GetActiveCpuCount() or
// GetLogicalCpuInformation() to determine the total number of logical cpus installed.
pub(crate) fn get_frequencies(nb_cpus: usize) -> Vec<u64> {
let size = nb_cpus * mem::size_of::<PROCESSOR_POWER_INFORMATION>();
let mut infos: Vec<PROCESSOR_POWER_INFORMATION> = Vec::with_capacity(nb_cpus);
unsafe {
if CallNtPowerInformation(
ProcessorInformation,
None,
0,
Some(infos.as_mut_ptr() as _),
size as _,
)
.is_ok()
{
infos.set_len(nb_cpus);
// infos.Number
return infos
.into_iter()
.map(|i| i.CurrentMhz as u64)
.collect::<Vec<_>>();
}
}
sysinfo_debug!("get_frequencies: CallNtPowerInformation failed");
vec![0; nb_cpus]
}
pub(crate) fn get_physical_core_count() -> Option<usize> {
// We cannot use the number of cpus here to pre calculate the buf size.
// `GetLogicalCpuInformationEx` with `RelationProcessorCore` passed to it not only returns
// the logical cores but also numa nodes.
//
// GetLogicalCpuInformationEx: https://docs.microsoft.com/en-us/windows/win32/api/sysinfoapi/nf-sysinfoapi-getlogicalprocessorinformationex
let mut needed_size = 0;
unsafe {
// This function call will always return an error as it only returns "success" when it
// has written at least one item in the buffer (which it cannot do here).
let _err = GetLogicalProcessorInformationEx(RelationAll, None, &mut needed_size);
let mut buf: Vec<u8> = Vec::with_capacity(needed_size as _);
loop {
// Needs to be updated for `Vec::reserve` to actually add additional capacity if
// `GetLogicalProcessorInformationEx` fails because the buffer isn't big enough.
buf.set_len(needed_size as _);
if GetLogicalProcessorInformationEx(
RelationAll,
Some(buf.as_mut_ptr().cast()),
&mut needed_size,
)
.is_ok()
{
break;
} else {
let e = Error::last_os_error();
// For some reasons, the function might return a size not big enough...
match e.raw_os_error() {
Some(value) if value == ERROR_INSUFFICIENT_BUFFER.0 as i32 => {}
_ => {
sysinfo_debug!(
"get_physical_core_count: GetLogicalCpuInformationEx failed"
);
return None;
}
}
}
let reserve = if needed_size as usize > buf.capacity() {
needed_size as usize - buf.capacity()
} else {
1
};
needed_size = match needed_size.checked_add(reserve as _) {
Some(new_size) => new_size,
None => {
sysinfo_debug!(
"get_physical_core_count: buffer size is too big ({} + {})",
needed_size,
reserve,
);
return None;
}
};
buf.reserve(reserve);
}
buf.set_len(needed_size as _);
let mut i = 0;
let raw_buf = buf.as_ptr();
let mut count = 0;
while i < buf.len() {
let p = &*(raw_buf.add(i) as *const SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX);
i += p.Size as usize;
if p.Relationship == RelationProcessorCore {
// Only count the physical cores.
count += 1;
}
}
Some(count)
}
}
fn init_cpus(refresh_kind: CpuRefreshKind) -> Vec<Cpu> {
unsafe {
let mut sys_info = SYSTEM_INFO::default();
GetSystemInfo(&mut sys_info);
let (vendor_id, brand) = get_vendor_id_and_brand(&sys_info);
let nb_cpus = sys_info.dwNumberOfProcessors as usize;
let frequencies = if refresh_kind.frequency() {
get_frequencies(nb_cpus)
} else {
vec![0; nb_cpus]
};
let mut ret = Vec::with_capacity(nb_cpus + 1);
for (nb, frequency) in frequencies.iter().enumerate() {
ret.push(Cpu {
inner: CpuInner::new_with_values(
format!("CPU {}", nb + 1),
vendor_id.clone(),
brand.clone(),
*frequency,
),
});
}
ret
}
}