Enum CallgrindMetrics

#[non_exhaustive]
pub enum CallgrindMetrics {
    Default,
    CacheMisses,
    CacheMissRates,
    CacheHits,
    CacheHitRates,
    CacheSim,
    CacheUse,
    SystemCalls,
    BranchSim,
    WriteBackBehaviour,
    All,
    None,
    SingleEvent(EventKind),
}

Available on crate feature api only.

A collection of groups of EventKinds

Callgrind supports a large amount of metrics and their collection can be enabled with various command-line flags. CallgrindMetrics groups these metrics to make it less cumbersome to specify multiple EventKinds at once if necessary.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Default

The default group contains all event kinds except the CallgrindMetrics::CacheMisses, CallgrindMetrics::CacheMissRates, CallgrindMetrics::CacheHitRates and EventKind::Dr, EventKind::Dw. More specifically, the following event kinds and groups in this order:

use iai_callgrind::{CallgrindMetrics, EventKind};

let metrics: Vec<CallgrindMetrics> = vec![
    EventKind::Ir.into(),
    CallgrindMetrics::CacheHits,
    EventKind::TotalRW.into(),
    EventKind::EstimatedCycles.into(),
    CallgrindMetrics::SystemCalls,
    EventKind::Ge.into(),
    CallgrindMetrics::BranchSim,
    CallgrindMetrics::WriteBackBehaviour,
    CallgrindMetrics::CacheUse,
];

CacheMisses

The CacheMisses produced by --cache-sim=yes contain the following EventKinds in this order:

use iai_callgrind::{CallgrindMetrics, EventKind};

let metrics: Vec<CallgrindMetrics> = vec![
    EventKind::I1mr.into(),
    EventKind::D1mr.into(),
    EventKind::D1mw.into(),
    EventKind::ILmr.into(),
    EventKind::DLmr.into(),
    EventKind::DLmw.into(),
];

CacheMissRates

The cache miss rates calculated from the CallgrindMetrics::CacheMisses produced by --cache-sim:

use iai_callgrind::{CallgrindMetrics, EventKind};

let metrics: Vec<CallgrindMetrics> = vec![
    EventKind::I1MissRate.into(),
    EventKind::D1MissRate.into(),
    EventKind::LLiMissRate.into(),
    EventKind::LLdMissRate.into(),
    EventKind::LLMissRate.into(),
];

CacheHits

CacheHits are iai-callgrind specific and calculated from the metrics produced by --cache-sim=yes in this order:

use iai_callgrind::{CallgrindMetrics, EventKind};

let metrics: Vec<CallgrindMetrics> = vec![
    EventKind::L1hits.into(),
    EventKind::LLhits.into(),
    EventKind::RamHits.into(),
];

CacheHitRates

The cache hit rates calculated from the CallgrindMetrics::CacheHits:

use iai_callgrind::{CallgrindMetrics, EventKind};

let metrics: Vec<CallgrindMetrics> = vec![
    EventKind::L1HitRate.into(),
    EventKind::LLHitRate.into(),
    EventKind::RamHitRate.into(),
];

CacheSim

All metrics produced by --cache-sim=yes including the iai-callgrind specific metrics EventKind::L1hits, EventKind::LLhits, EventKind::RamHits, EventKind::TotalRW, EventKind::EstimatedCycles and miss/hit rates in this order:

use iai_callgrind::{CallgrindMetrics, EventKind};

let metrics: Vec<CallgrindMetrics> = vec![
    EventKind::Dr.into(),
    EventKind::Dw.into(),
    CallgrindMetrics::CacheMisses,
    CallgrindMetrics::CacheMissRates,
    CallgrindMetrics::CacheHits,
    EventKind::TotalRW.into(),
    CallgrindMetrics::CacheHitRates,
    EventKind::EstimatedCycles.into(),
];

CacheUse

The metrics produced by --cacheuse=yes in this order:

use iai_callgrind::{CallgrindMetrics, EventKind};

let metrics: Vec<CallgrindMetrics> = vec![
    EventKind::AcCost1.into(),
    EventKind::AcCost2.into(),
    EventKind::SpLoss1.into(),
    EventKind::SpLoss2.into(),
];

SystemCalls

SystemCalls are events of the --collect-systime=yes option in this order:

use iai_callgrind::{CallgrindMetrics, EventKind};

let metrics: Vec<CallgrindMetrics> = vec![
    EventKind::SysCount.into(),
    EventKind::SysTime.into(),
    EventKind::SysCpuTime.into(),
];

BranchSim

The metrics produced by --branch-sim=yes in this order:

use iai_callgrind::{CallgrindMetrics, EventKind};

let metrics: Vec<CallgrindMetrics> = vec![
    EventKind::Bc.into(),
    EventKind::Bcm.into(),
    EventKind::Bi.into(),
    EventKind::Bim.into(),
];

WriteBackBehaviour

All metrics of --simulate-wb=yes in this order:

use iai_callgrind::{CallgrindMetrics, EventKind};

let metrics: Vec<CallgrindMetrics> = vec![
    EventKind::ILdmr.into(),
    EventKind::DLdmr.into(),
    EventKind::DLdmw.into(),
];

All

All possible EventKinds in this order:

use iai_callgrind::{CallgrindMetrics, EventKind};

let metrics: Vec<CallgrindMetrics> = vec![
    EventKind::Ir.into(),
    CallgrindMetrics::CacheSim,
    CallgrindMetrics::SystemCalls,
    EventKind::Ge.into(),
    CallgrindMetrics::BranchSim,
    CallgrindMetrics::WriteBackBehaviour,
    CallgrindMetrics::CacheUse,
];

None

Selection of no EventKind at all

SingleEvent(EventKind)

Specify a single EventKind.

Note that EventKind implements the necessary traits to convert to the CallgrindMetrics::SingleEvent variant which is shorter to write.

Examples

use iai_callgrind::{CallgrindMetrics, EventKind};

assert_eq!(
    CallgrindMetrics::SingleEvent(EventKind::Ir),
    EventKind::Ir.into()
);

Trait Implementations

impl Clone for CallgrindMetrics

fn clone(&self) -> CallgrindMetrics

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CallgrindMetrics

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

Formats the value using the given formatter.

impl Default for CallgrindMetrics

fn default() -> CallgrindMetrics

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CallgrindMetrics

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CallgrindMetrics> for IndexSet<EventKind>

Available on crate feature runner only.

fn from(value: CallgrindMetrics) -> Self

Converts to this type from the input type.

impl From<EventKind> for CallgrindMetrics

fn from(value: EventKind) -> Self

Converts to this type from the input type.

impl FromStr for CallgrindMetrics

Available on crate feature runner only.

type Err = Error

The associated error which can be returned from parsing.

fn from_str(string: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Ord for CallgrindMetrics

fn cmp(&self, other: &CallgrindMetrics) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CallgrindMetrics

fn eq(&self, other: &CallgrindMetrics) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for CallgrindMetrics

fn partial_cmp(&self, other: &CallgrindMetrics) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for CallgrindMetrics

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for CallgrindMetrics

impl Eq for CallgrindMetrics

impl StructuralPartialEq for CallgrindMetrics