Struct substrate_benchmark_machine::MachineCmd

pub struct MachineCmd {
    pub base_path: Option<String>,
    pub allow_fail: bool,
    pub tolerance: f64,
    pub verify_duration: f32,
    pub hash_duration: f32,
    pub memory_duration: f32,
    pub disk_duration: f32,
}

Command to benchmark the hardware.

Runs multiple benchmarks and prints their output to console. Can be used to gauge if the hardware is fast enough to keep up with a chain’s requirements. This command must be integrated by the client since the client can set compiler flags which influence the results.

You can use the --base-path flag to set a location for the disk benchmarks.

Fields

base_path: Option<String>

allow_fail: bool

Do not return an error if any check fails.

Should only be used for debugging.

tolerance: f64

Set a fault tolerance for passing a requirement.

10% means that the test would pass even when only 90% score was archived. Can be used to mitigate outliers of the benchmarks.

verify_duration: f32

Time limit for the verification benchmark.

hash_duration: f32

Time limit for the hash function benchmark.

memory_duration: f32

Time limit for the memory benchmark.

disk_duration: f32

Time limit for each disk benchmark.

Implementations

impl MachineCmd

pub fn run_benchmark( &self, requirement: &Requirement, dir: &Path ) -> Result<BenchResult>

Benchmarks a specific metric of the hardware and judges the resulting score.

pub fn print_summary( &self, requirements: Requirements, results: Vec<BenchResult> ) -> Result<()>

Prints a human-readable summary.

pub fn validate_args(&self) -> Result<()>

Validates the CLI arguments.

Trait Implementations

impl Args for MachineCmd

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can update self.

impl CommandFactory for MachineCmd

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for MachineCmd

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

Formats the value using the given formatter.

impl FromArgMatches for MachineCmd

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for MachineCmd

fn parse() -> Self

Parse from std::env::args_os(), exit on error

fn try_parse() -> Result<Self, Error<RichFormatter>>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Selfwhere I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error<RichFormatter>>where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error<RichFormatter>>where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.