Struct calliper::ScenarioConfig

pub struct ScenarioConfig { /* private fields */ }

Callgrind execution settings.

ScenarioConfig defines scenario-agnostic

Implementations

impl ScenarioConfig

pub fn valgrind(self, path: impl Into<String>) -> Self

Valgrind executable path. Default value: “valgrind”

pub fn cache(self, settings: impl Into<Option<CacheOptions>>) -> Self

Configuration of cache simulation. Callgrind can collect basic metrics on CPU cache usage of your program. Calliper does not enable that behaviour by default - cache metrics collection can be enabled by passing Some(CacheOptions) object (which corresponds to passing --cache-sim=yes to Callgrind).

use calliper::{ScenarioConfig, CacheOptions, CacheParameters};

// Scenarios do not enable cache simulation by default.
let config_without_cache = ScenarioConfig::default();
// By default, cache options use current CPU's cache parameters.
let config_with_native_cache = ScenarioConfig::default().cache(CacheOptions::default());
// For best benchmark reproducability across different machines, it is recommended to set cache sizes manually.
let first_level_data = Some(CacheParameters { size: 32768, associativity: 8, line_size: 8 });
let first_level_code = first_level_data.clone();
let last_level = Some(CacheParameters { size: 12582912, associativity: 8, line_size: 8});
let config_with_handtuned_cache = ScenarioConfig::default().cache(CacheOptions { first_level_data, first_level_code, last_level});

pub fn branch_sim(self, is_enabled: bool) -> Self

Sets branch prediction simulation. Mirrors Callgrind’s --branch-sim option. Collected metrics include number of executed conditional branches and related predictor misses, executed indirect jumps and related misses of the jump address predictor. Defaults to false.

pub fn aslr(self, is_enabled: bool) -> Self

If set to true, Address Space Layout Randomization (ASLR) will be enabled. ASLR is a security measure to prevent certain classes of exploits. It can skew benchmark results by making them less deterministic. It is recommended to keep this turned off. Defaults to false.

pub fn cleanup_files(self, is_enabled: bool) -> Self

If set to true, Callgrind output for this scenario will be cleared up. Defaults to true.

pub fn collect_bus(self, is_enabled: bool) -> Self

Sets bus event collection (counts number of executed atomic instructions). Corresponds to --collect-bus Callgrind option. Defaults to false.

pub fn filters( self, filters: impl IntoIterator<Item = impl Into<String>> ) -> Self

Set filters for a particular scenario. Corresponds to --toggle-collect. Excerpt from Callgrind documentation: “Further, you can limit event collection to a specific function by using –toggle-collect=function. This will toggle the collection state on entering and leaving the specified function. … Only events happening while running inside of the given function will be collected. Recursive calls of the given function do not trigger any action. This option can be given multiple times to specify different functions of interest.”

Defaults to name of benchmarked function. Filtering can be disabled by passing in an empty vector, though be aware that then whole program will be under benchmark - including Calliper code. This is most likely not what you want.

pub fn output(self, path: impl Into<String>) -> Self

Sets callgrind file output path. Defaults to callgrind.out.{pid}, where pid is - naturally - not up to us anyhow. If you intend to process Callgrind’s results further, it is recommended to set the path manually.

pub fn get_valgrind(&self) -> &str

Returns a path to valgrind.

pub fn get_collect_bus(&self) -> bool

Returns true if event bus collection is switched on.

pub fn get_cleanup_files(&self) -> bool

Returns true if Callgrind file cleanup is switched on.

pub fn get_aslr(&self) -> bool

Returns true if Address Space Layout Randomization is switched on.

pub fn get_branch_sim(&self) -> bool

Returns true if branch predictor simulation is switched on.

pub fn get_output_file(&self) -> Option<&str>

Returns the path to Callgrind output path if it was set manually by the user beforehand.

pub fn get_filters(&self) -> &[String]

Returns filters for a given scenario.

Trait Implementations

impl Clone for ScenarioConfig

fn clone(&self) -> ScenarioConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScenarioConfig

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

Formats the value using the given formatter.

impl Default for ScenarioConfig

fn default() -> ScenarioConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ScenarioConfig

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

Deserialize this value from the given Serde deserializer.

impl Hash for ScenarioConfig

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 PartialEq<ScenarioConfig> for ScenarioConfig

fn eq(&self, other: &ScenarioConfig) -> 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 PartialOrd<ScenarioConfig> for ScenarioConfig

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for ScenarioConfig

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

Serialize this value into the given Serde serializer.

impl Eq for ScenarioConfig

impl StructuralEq for ScenarioConfig

impl StructuralPartialEq for ScenarioConfig