Struct CounterBuilder

pub struct CounterBuilder { /* private fields */ }

Configure event counter parameters.

Unless specified, a counter is allocated in counting mode with a system-wide scope, recording events across all CPUs.

use pmc::*;

let config = CounterBuilder::default().attach_to(vec![0]);

let instr = config.allocate("inst_retired.any")?;
let l1_hits = config.allocate("mem_load_uops_retired.l1_hit")?;

Implementations

impl CounterBuilder

pub fn set_cpu(self, cpu: i32) -> Self

Specify the CPU number that the PMC is to be allocated on.

Defaults to all CPUs (CPU_ANY).

pub fn attach_to(self, pids: impl Into<Vec<i32>>) -> Self

Attach a counter to the specified PID(s).

When set, this causes the PMC to be allocated in process-scoped counting mode ([pmc_mode_PMC_MODE_TC] - see man pmc).

PID 0

PID 0 is a magic value, attaching to it causes the counter to be attached to the current (caller’s) PID.

pub fn allocate(&self, event_spec: impl Into<String>) -> Result<Counter, Error>

Allocate a PMC with the specified configuration, and attach to the target PIDs (if any).

Trait Implementations

impl Clone for CounterBuilder

fn clone(&self) -> CounterBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CounterBuilder

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

Formats the value using the given formatter.

impl Default for CounterBuilder

fn default() -> CounterBuilder

Returns the “default value” for a type.