Enum CachegrindMetric

pub enum CachegrindMetric {
    Ir,
    Dr,
    Dw,
    I1mr,
    D1mr,
    D1mw,
    ILmr,
    DLmr,
    DLmw,
    I1MissRate,
    LLiMissRate,
    D1MissRate,
    LLdMissRate,
    LLMissRate,
    L1hits,
    LLhits,
    RamHits,
    L1HitRate,
    LLHitRate,
    RamHitRate,
    TotalRW,
    EstimatedCycles,
    Bc,
    Bcm,
    Bi,
    Bim,
}

Available on crate feature api only.

All metrics which cachegrind produces and additionally some derived events

Depending on the options passed to Cachegrind, these are the events that Cachegrind can produce. See the Cachegrind documentation for details.

Variants

Ir

The default event. I cache reads (which equals the number of instructions executed)

Dr

D Cache reads (which equals the number of memory reads) (–cache-sim=yes)

Dw

D Cache writes (which equals the number of memory writes) (–cache-sim=yes)

I1mr

I1 cache read misses (–cache-sim=yes)

D1mr

D1 cache read misses (–cache-sim=yes)

D1mw

D1 cache write misses (–cache-sim=yes)

ILmr

LL cache instruction read misses (–cache-sim=yes)

DLmr

LL cache data read misses (–cache-sim=yes)

DLmw

LL cache data write misses (–cache-sim=yes)

I1MissRate

I1 cache miss rate (–cache-sim=yes)

LLiMissRate

LL/L2 instructions cache miss rate (–cache-sim=yes)

D1MissRate

D1 cache miss rate (–cache-sim=yes)

LLdMissRate

LL/L2 data cache miss rate (–cache-sim=yes)

LLMissRate

LL/L2 cache miss rate (–cache-sim=yes)

L1hits

Derived event showing the L1 hits (–cache-sim=yes)

LLhits

Derived event showing the LL hits (–cache-sim=yes)

RamHits

Derived event showing the RAM hits (–cache-sim=yes)

L1HitRate

L1 cache hit rate (–cache-sim=yes)

LLHitRate

LL/L2 cache hit rate (–cache-sim=yes)

RamHitRate

RAM hit rate (–cache-sim=yes)

TotalRW

Derived event showing the total amount of cache reads and writes (–cache-sim=yes)

EstimatedCycles

Derived event showing estimated CPU cycles (–cache-sim=yes)

Bc

Conditional branches executed (–branch-sim=yes)

Bcm

Conditional branches mispredicted (–branch-sim=yes)

Bi

Indirect branches executed (–branch-sim=yes)

Bim

Indirect branches mispredicted (–branch-sim=yes)

Implementations

impl CachegrindMetric

pub fn is_derived(&self) -> bool

Return true if this EventKind is a derived event

Derived events are calculated from Cachegrind’s native event types the same ways as for callgrind’s EventKind

• CachegrindMetric::L1hits
• CachegrindMetric::LLhits
• CachegrindMetric::RamHits
• CachegrindMetric::TotalRW
• CachegrindMetric::EstimatedCycles
• CachegrindMetric::I1MissRate
• CachegrindMetric::D1MissRate
• CachegrindMetric::LLiMissRate
• CachegrindMetric::LLdMissRate
• CachegrindMetric::LLMissRate
• CachegrindMetric::L1HitRate
• CachegrindMetric::LLHitRate
• CachegrindMetric::RamHitRate

pub fn to_name(&self) -> String

Return the name of the metric which is the exact name of the enum variant

Trait Implementations

impl Clone for CachegrindMetric

fn clone(&self) -> CachegrindMetric

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CachegrindMetric

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CachegrindMetric

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for CachegrindMetric

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

Formats the value using the given formatter.

impl From<CachegrindMetric> for CachegrindMetrics

fn from(value: CachegrindMetric) -> Self

Converts to this type from the input type.

impl From<CachegrindMetric> for EventKind

fn from(value: CachegrindMetric) -> Self

Converts to this type from the input type.

impl FromStr for CachegrindMetric

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 Hash for CachegrindMetric

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoEnumIterator for CachegrindMetric

type Iterator = CachegrindMetricIter

fn iter() -> CachegrindMetricIter

impl JsonSchema for CachegrindMetric

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for CachegrindMetric

fn eq(&self, other: &CachegrindMetric) -> 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 RegressionConfig<CachegrindMetric> for CachegrindRegressionConfig

Available on crate feature runner only.

fn check( &self, metrics_summary: &MetricsSummary<CachegrindMetric>, ) -> Vec<ToolRegression>

Check the MetricsSummary for regressions.

fn get_soft_limits(&self) -> &[(CachegrindMetric, f64)]

Return the soft limits

fn get_hard_limits(&self) -> &[(CachegrindMetric, Metric)]

Return the hard limits

fn check_and_print( &self, metrics_summary: &MetricsSummary<T>, ) -> Vec<ToolRegression>

Check for regressions and print them if present

fn check_regressions( &self, metrics_summary: &MetricsSummary<T>, ) -> Vec<RegressionMetrics<T>>

Check for regressions and return the RegressionMetrics

impl Serialize for CachegrindMetric

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Summarize for CachegrindMetric

Available on crate feature runner only.

fn summarize(costs: &mut Cow<'_, Metrics>)

Calculate the derived metrics if any

impl TypeChecker for CachegrindMetric

Available on crate feature runner only.

fn is_int(&self) -> bool

Return true if the metric kind is a Metric::Int

fn is_float(&self) -> bool

Return true if the metric kind is a Metric::Float

fn verify_metric(&self, metric: Metric) -> bool

Return true if the Metric has the expected metric type

impl Copy for CachegrindMetric

impl Eq for CachegrindMetric

impl StructuralPartialEq for CachegrindMetric