iai_callgrind_runner::api

Enum EventKind

source
pub enum EventKind {
Show 29 variants Ir, SysCount, SysTime, SysCpuTime, Ge, Dr, Dw, I1mr, D1mr, D1mw, ILmr, DLmr, DLmw, L1hits, LLhits, RamHits, TotalRW, EstimatedCycles, Bc, Bcm, Bi, Bim, ILdmr, DLdmr, DLdmw, AcCost1, AcCost2, SpLoss1, SpLoss2,
}
Available on crate feature api only.
Expand description

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)

§

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)

§

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§

source§

impl EventKind

source

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::Metrics::make_summary. Currently all derived events are:

source

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

source

pub fn to_name(&self) -> String

Trait Implementations§

source§

impl Clone for EventKind

source§

fn clone(&self) -> EventKind

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for EventKind

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl Display for EventKind

source§

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

Formats the value using the given formatter. Read more
source§

impl<T> From<T> for EventKind
where T: AsRef<str>,

source§

fn from(value: T) -> Self

Converts to this type from the input type.
source§

impl Hash for EventKind

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl JsonSchema for EventKind

source§

fn schema_name() -> String

The name of the generated JSON Schema. Read more
source§

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

Returns a string that uniquely identifies the schema produced by this type. Read more
source§

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

Generates a JSON Schema for this type. Read more
source§

fn is_referenceable() -> bool

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

impl PartialEq for EventKind

source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

impl Serialize for EventKind

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl Summarize for EventKind

Available on crate feature runner only.
source§

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

source§

impl Copy for EventKind

source§

impl Eq for EventKind

source§

impl StructuralPartialEq for EventKind

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<T> DynClone for T
where T: Clone,

source§

fn __clone_box(&self, _: Private) -> *mut ()

source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,