Enum iai_callgrind_runner::api::EventKind

pub enum EventKind {
    Ir,
    SysCount,
    SysTime,
    SysCpuTime,
    Ge,
    Dr,
    Dw,
    I1mr,
    ILmr,
    D1mr,
    DLmr,
    D1mw,
    DLmw,
    L1hits,
    LLhits,
    RamHits,
    TotalRW,
    EstimatedCycles,
    Bc,
    Bcm,
    Bi,
    Bim,
    ILdmr,
    DLdmr,
    DLdmw,
    AcCost1,
    AcCost2,
    SpLoss1,
    SpLoss2,
}

Available on crate feature api only.

All EventKinds callgrind produces and additionally some derived events

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

Variants

Ir

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

SysCount

The number of system calls done (–collect-systime=yes)

SysTime

The elapsed time spent in system calls (–collect-systime=yes)

SysCpuTime

The cpu time spent during system calls (–collect-systime=nsec)

Ge

The number of global bus events (–collect-bus=yes)

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)

ILmr

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

D1mr

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

DLmr

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

D1mw

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

DLmw

LL cache data write misses (–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)

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)

ILdmr

Dirty miss because of instruction read (–simulate-wb=yes)

DLdmr

Dirty miss because of data read (–simulate-wb=yes)

DLdmw

Dirty miss because of data write (–simulate-wb=yes)

AcCost1

Counter showing bad temporal locality for L1 caches (–cachuse=yes)

AcCost2

Counter showing bad temporal locality for LL caches (–cachuse=yes)

SpLoss1

Counter showing bad spatial locality for L1 caches (–cachuse=yes)

SpLoss2

Counter showing bad spatial locality for LL caches (–cachuse=yes)

Implementations

impl EventKind

pub fn is_derived(&self) -> bool

Return true if this EventKind is a derived event

Derived events are calculated from Callgrind’s native event types. See also crate::runner::callgrind::model::Costs::make_summary. Currently all derived events are:

• EventKind::L1hits
• EventKind::LLhits
• EventKind::RamHits
• EventKind::TotalRW
• EventKind::EstimatedCycles

pub fn from_str_ignore_case(value: &str) -> Option<Self>

Trait Implementations

impl Clone for EventKind

fn clone(&self) -> EventKind

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EventKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EventKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for EventKind

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

Formats the value using the given formatter.

impl<T> From<T> for EventKind

where T: AsRef<str>,

fn from(value: T) -> Self

Converts to this type from the input type.

impl Hash for EventKind

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 JsonSchema for EventKind

fn schema_name() -> String

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(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for EventKind

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for EventKind

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 EventKind

impl Eq for EventKind

impl StructuralEq for EventKind

impl StructuralPartialEq for EventKind