mac-sys-info 0.1.13

/*
MIT License

Copyright (c) 2020 Philipp Schuster

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
*/

//! Basic info about CPU.

use derive_more::Display as DeriveMoreDisplay;
use serde::{Serialize};
use std::collections::BTreeMap;
use crate::error::MacSysInfoError;
use crate::generated_sysctl_keys::SysctlKey;
use crate::structs::CacheInfo;
use crate::structs::CpuArchitectureInfo;
use crate::parse::{parse_sysctl_value, ParseAsType};


/// General CPU info.
#[derive(Debug, Serialize, DeriveMoreDisplay)]
#[display(fmt = "CpuInfo (\n\
\x20    phys_cores: {},\n\
\x20    logic_cores: {},\n\
\x20    num_cores: {},\n\
\x20    cache_info: <CacheInfo>,\n\
\x20    brand_string: {},\n\
\x20    frequency: {},\n\
\x20    min_frequency: {},\n\
\x20    max_frequency: {},\n\
\x20    architecture: {},\n\
)", phys_cores, logic_cores, num_cores, brand_string, frequency, min_frequency, max_frequency, architecture)]
pub struct CpuInfo {
    /// Physical cores on the CPU.
    phys_cores: usize,
    /// Logical cores on the CPU. Due to hardware multithreading (Like Intel Hyperthreading)
    /// this can be more than the physical cores.
    logic_cores: usize,
    /// Actual available cores on the system.
    num_cores: usize,
    /// Information about the CPU cache.
    cache_info: CacheInfo,
    /// For example "Intel(R) Core(TM) i5-5257U CPU @ 2.70GH"
    brand_string: String,
    /// Base frequency in Hertz.
    frequency: usize,
    /// Min frequency in Hertz.
    min_frequency: usize,
    /// Max frequency in Hertz.
    max_frequency: usize,
    /// Architecture. x86_64 or AppleSi
    architecture: CpuArchitectureInfo,
}

impl CpuInfo {

    /// Constructor.
    pub(crate) fn new(sysinfo: &BTreeMap<String, String>) -> Result<Self, MacSysInfoError> {
        let x = CpuInfo {
            phys_cores: parse_sysctl_value(
                "phys_cores",
                SysctlKey::HwPhysicalcpu,
                sysinfo,
                ParseAsType::Usize)?
                .get_usize(),
            logic_cores: parse_sysctl_value(
                "logic_cores",
                SysctlKey::HwLogicalcpu,
                sysinfo,
                ParseAsType::Usize)?
                .get_usize(),
            num_cores: parse_sysctl_value(
                "num_cores",
                SysctlKey::HwActivecpu,
                sysinfo,
                ParseAsType::Usize)?
                .get_usize(),
            brand_string: parse_sysctl_value(
                "brand_string",
                SysctlKey::MachdepCpuBrand_string,
                sysinfo,
                ParseAsType::String)?
                .get_string(),
            frequency: parse_sysctl_value(
                "frequency",
                SysctlKey::HwCpufrequency,
                sysinfo,
                ParseAsType::Usize)?
                .get_usize(),
            min_frequency: parse_sysctl_value(
                "min_frequency",
                SysctlKey::HwCpufrequency_min,
                sysinfo,
                ParseAsType::Usize)?
                .get_usize(),
            max_frequency: parse_sysctl_value(
                "max_frequency",
                SysctlKey::HwCpufrequency_max,
                sysinfo,
                ParseAsType::Usize)?
                .get_usize(),
            cache_info: CacheInfo::new(sysinfo)?,
            architecture: CpuArchitectureInfo::new(sysinfo)?,
        };
        Ok(x)
    }

    /// Getter for the field `phys_cores`.
    pub fn phys_cores(&self) -> usize {
        self.phys_cores
    }

    /// Getter for the field `logic_cores`.
    pub fn logic_cores(&self) -> usize {
        self.logic_cores
    }

    /// Getter for the field `num_cores`.
    pub fn num_cores(&self) -> usize {
        self.num_cores
    }

    /// Getter for [`crate::structs::CacheInfo`].
    pub fn cache_info(&self) -> &CacheInfo {
        &self.cache_info
    }
    /// Getter for the field `brand_string`.
    pub fn brand_string(&self) -> &str {
        &self.brand_string
    }
    /// Getter for the field `frequency`.
    pub fn frequency(&self) -> usize {
        self.frequency
    }
    /// Getter for the field `min_frequency`.
    pub fn min_frequency(&self) -> usize {
        self.min_frequency
    }
    /// Getter for the field `max_frequency`.
    pub fn max_frequency(&self) -> usize {
        self.max_frequency
    }
    /// Getter for the field `frequency` in Ghz.
    pub fn frequency_ghz(&self) -> f64 {
        self.frequency as f64 / 1E9_f64
    }
    /// Getter for the field `min_frequency` in Ghz.
    pub fn min_frequency_ghz(&self) -> f64 {
        self.min_frequency as f64 / 1E9_f64
    }
    /// Getter for the field `max_frequency` in Ghz.
    pub fn max_frequency_ghz(&self) -> f64 {
        self.max_frequency as f64 / 1E9_f64
    }

    /// Getter for the field `architecture`.
    pub fn architecture(&self) -> &CpuArchitectureInfo {
        &self.architecture
    }
}