Struct shadow_rs::core::configuration::GeneralOptions

pub struct GeneralOptions {
    pub stop_time: Option<Time<TimePrefix>>,
    pub seed: Option<u32>,
    pub parallelism: Option<u32>,
    pub bootstrap_end_time: Option<Time<TimePrefix>>,
    pub log_level: Option<LogLevel>,
    pub heartbeat_interval: Option<NullableOption<Time<TimePrefix>>>,
    pub data_directory: Option<String>,
    pub template_directory: Option<NullableOption<String>>,
    pub progress: Option<bool>,
    pub model_unblocked_syscall_latency: Option<bool>,
}

Fields

stop_time: Option<Time<TimePrefix>>

The simulated time at which simulated processes are sent a SIGKILL signal

seed: Option<u32>

Initialize randomness using seed N

parallelism: Option<u32>

How many parallel threads to use to run the simulation. A value of 0 will allow Shadow to choose the number of threads.

bootstrap_end_time: Option<Time<TimePrefix>>

The simulated time that ends Shadow’s high network bandwidth/reliability bootstrap period

log_level: Option<LogLevel>

Log level of output written on stdout. If Shadow was built in release mode, then log messages at level ‘trace’ will always be dropped

heartbeat_interval: Option<NullableOption<Time<TimePrefix>>>

Interval at which to print heartbeat messages

data_directory: Option<String>

Path to store simulation output

template_directory: Option<NullableOption<String>>

Path to recursively copy during startup and use as the data-directory

progress: Option<bool>

Show the simulation progress on stderr

model_unblocked_syscall_latency: Option<bool>

Model syscalls and VDSO functions that don’t block as having some latency. This should have minimal effect on typical simulations, but can be helpful for programs with “busy loops” that otherwise deadlock under Shadow.

Implementations

impl GeneralOptions

pub fn with_defaults(self, default: Self) -> Self

Replace unset (None) values of base with values from default.

Trait Implementations

impl Args for GeneralOptions

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 via FromArgMatches::from_arg_matches_mut

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

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

impl Clone for GeneralOptions

fn clone(&self) -> GeneralOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for GeneralOptions

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 GeneralOptions

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GeneralOptions

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromArgMatches for GeneralOptions

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

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 Merge for GeneralOptions

fn merge(&mut self, other: Self)

Merge another object into this object.

impl Parser for GeneralOptions

fn parse() -> Self

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

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

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

fn parse_from<I, T>(itr: I) -> Self

where 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>

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>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.

impl Serialize for GeneralOptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.