Struct scaphandre::sensors::Topology

pub struct Topology {
    pub sockets: Vec<CPUSocket>,
    pub proc_tracker: ProcessTracker,
    pub stat_buffer: Vec<CPUStat>,
    pub record_buffer: Vec<Record>,
    pub buffer_max_kbytes: u16,
    pub domains_names: Option<Vec<String>>,
}

Topology struct represents the whole CPUSocket architecture, from the electricity consumption point of view, including the potentially multiple CPUSocket sockets. Owns a vector of CPUSocket structs representing each socket.

Fields

sockets: Vec<CPUSocket>

The CPU sockets found on the host, represented as CPUSocket instances attached to this topology

proc_tracker: ProcessTracker

ProcessTrack instance that keeps track of processes running on the host and CPU stats associated

stat_buffer: Vec<CPUStat>

CPU usage stats buffer

record_buffer: Vec<Record>

Measurements of energy usage, stored as Record instances

buffer_max_kbytes: u16

Maximum size in memory for the recor_buffer

domains_names: Option<Vec<String>>

Sorted list of all domains names

Implementations

impl Topology

pub fn new() -> Topology

Instanciates Topology and returns the instance

pub fn generate_cpu_cores() -> Result<Vec<CPUCore>, String>

Parses /proc/cpuinfo and creates instances of CPUCore.

Examples

use scaphandre::sensors::Topology;

if let Ok(cores) = Topology::generate_cpu_cores() {
    println!("There are {} cores on this host.", cores.len());
    for c in &cores {
        println!("Here is CPU Core number {}", c.attributes.get("processor").unwrap());
    }
}

pub fn safe_add_socket(
    &mut self,
    socket_id: u16,
    domains: Vec<Domain>,
    attributes: Vec<Vec<HashMap<String, String>>>,
    counter_uj_path: String,
    buffer_max_kbytes: u16
)

Adds a Socket instance to self.sockets if and only if the socket id doesn’t exist already.

pub fn get_proc_tracker(&self) -> &ProcessTracker

Returns a immutable reference to self.proc_tracker

pub fn get_sockets(&mut self) -> &mut Vec<CPUSocket>

Returns a mutable reference to self.sockets

pub fn get_sockets_passive(&self) -> &Vec<CPUSocket>

Returns an immutable reference to self.sockets

pub fn safe_add_domain_to_socket(
    &mut self,
    socket_id: u16,
    domain_id: u16,
    name: &str,
    uj_counter: &str,
    buffer_max_kbytes: u16
)

Adds a Domain instance to a given socket, if and only if the domain id doesn’t exist already for the socket.

pub fn add_cpu_cores(&mut self)

Generates CPUCore instances for the host and adds them to appropriate CPUSocket instance from self.sockets

pub fn refresh(&mut self)

Triggers ProcessTracker refresh on process stats and power consumption, CPU stats and cores power comsumption, CPU sockets stats and power consumption.

pub fn refresh_stats(&mut self)

Gets currents stats and stores them as a CPUStat instance in self.stat_buffer

pub fn get_records_diff(&self) -> Option<Record>

Returns a Record instance containing the difference (attribute by attribute, except timestamp which will be the timestamp from the last record) between the last (in time) record from self.record_buffer and the previous one

pub fn get_records_diff_power_microwatts(&self) -> Option<Record>

Returns a Record instance containing the power consumed between last and previous measurement, in microwatts.

pub fn get_stats_diff(&self) -> Option<CPUStat>

Returns a CPUStat instance containing the difference between last and previous stats measurement (from stat_buffer), attribute by attribute.

pub fn read_stats(&self) -> Option<CPUStat>

Reads content from /proc/stat and extracts the stats of the whole CPU topology.

pub fn read_nb_process_total_count(&self) -> Option<u64>

Returns the number of processes currently available

pub fn read_nb_process_running_current(&self) -> Option<u32>

Returns the number of processes currently in a running state

pub fn read_nb_process_blocked_current(&self) -> Option<u32>

Returns the number of processes currently blocked waiting

pub fn read_nb_context_switches_total_count(&self) -> Option<u64>

Returns the current number of context switches

pub fn get_process_power_consumption_microwatts(
    &self,
    pid: i32
) -> Option<Record>

Returns the power consumed between last and previous measurement for a given process ID, in microwatts

pub fn get_process_cpu_consumption_percentage(&self, pid: i32) -> Option<Record>

Trait Implementations

impl Clone for Topology

fn clone(&self) -> Topology

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Topology

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Topology

fn default() -> Self

Returns the “default value” for a type.

impl RecordGenerator for Topology

fn refresh_record(&mut self)

Computes a new Record, stores it in the record_buffer and returns a clone of this record.

fn clean_old_records(&mut self)

Removes (and thus drops) as many Record instances from the record_buffer as needed for record_buffer to not exceed ‘buffer_max_kbytes’

fn get_records_passive(&self) -> Vec<Record>

Returns a copy of the record_buffer