Struct wasm_smith::SwarmConfig

pub struct SwarmConfig {

    pub max_types: usize,
    pub max_imports: usize,
    pub max_tags: usize,
    pub max_funcs: usize,
    pub max_globals: usize,
    pub max_exports: usize,
    pub max_element_segments: usize,
    pub max_elements: usize,
    pub max_data_segments: usize,
    pub max_instructions: usize,
    pub max_memories: usize,
    pub min_uleb_size: u8,
    pub max_tables: usize,
    pub max_memory_pages: u64,
    pub bulk_memory_enabled: bool,
    pub reference_types_enabled: bool,
    pub module_linking_enabled: bool,
    pub max_aliases: usize,
    pub max_nesting_depth: usize,
    pub memory64_enabled: bool,
    pub min_types: usize,
    pub min_imports: usize,
    pub min_tags: usize,
    pub min_funcs: usize,
    pub min_globals: usize,
    pub min_exports: usize,
    pub min_data_segments: usize,
    pub min_element_segments: usize,
    pub min_elements: usize,
    pub min_memories: u32,
    pub min_tables: u32,
    pub max_instances: usize,
    pub max_modules: usize,
    pub memory_offset_choices: (u32, u32, u32),
    pub memory_max_size_required: bool,
    pub simd_enabled: bool,
    pub exceptions_enabled: bool,
    pub allow_start_export: bool,
    pub max_type_size: u32,
    pub canonicalize_nans: bool,
}

A module configuration that uses swarm testing.

Dynamically – but still deterministically, via its Arbitrary implementation – chooses configuration options.

Note that we pick only maximums, not minimums, here because it is more complex to describe the domain of valid configs when minima are involved (min <= max for each variable) and minima are mostly used to ensure certain elements are present, but do not widen the range of generated Wasm modules.

Fields

max_types: usize

max_imports: usize

max_tags: usize

max_funcs: usize

max_globals: usize

max_exports: usize

max_element_segments: usize

max_elements: usize

max_data_segments: usize

max_instructions: usize

max_memories: usize

min_uleb_size: u8

max_tables: usize

max_memory_pages: u64

bulk_memory_enabled: bool

reference_types_enabled: bool

module_linking_enabled: bool

max_aliases: usize

max_nesting_depth: usize

memory64_enabled: bool

min_types: usize

min_imports: usize

min_tags: usize

min_funcs: usize

min_globals: usize

min_exports: usize

min_data_segments: usize

min_element_segments: usize

min_elements: usize

min_memories: u32

min_tables: u32

max_instances: usize

max_modules: usize

memory_offset_choices: (u32, u32, u32)

memory_max_size_required: bool

simd_enabled: bool

exceptions_enabled: bool

allow_start_export: bool

max_type_size: u32

canonicalize_nans: bool

Trait Implementations

impl<'a> Arbitrary<'a> for SwarmConfig

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for SwarmConfig

fn clone(&self) -> SwarmConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Config for SwarmConfig

fn min_types(&self) -> usize

The minimum number of types to generate. Defaults to 0.

fn max_types(&self) -> usize

The maximum number of types to generate. Defaults to 100.

fn min_imports(&self) -> usize

The minimum number of imports to generate. Defaults to 0.

fn max_imports(&self) -> usize

The maximum number of imports to generate. Defaults to 100.

fn min_funcs(&self) -> usize

The minimum number of functions to generate. Defaults to 0. This includes imported functions.

fn max_funcs(&self) -> usize

The maximum number of functions to generate. Defaults to 100. This includes imported functions.

fn min_globals(&self) -> usize

The minimum number of globals to generate. Defaults to 0. This includes imported globals.

fn max_globals(&self) -> usize

The maximum number of globals to generate. Defaults to 100. This includes imported globals.

fn min_exports(&self) -> usize

The minimum number of exports to generate. Defaults to 0.

fn max_exports(&self) -> usize

The maximum number of exports to generate. Defaults to 100.

fn min_element_segments(&self) -> usize

The minimum number of element segments to generate. Defaults to 0.

fn max_element_segments(&self) -> usize

The maximum number of element segments to generate. Defaults to 100.

fn min_elements(&self) -> usize

The minimum number of elements within a segment to generate. Defaults to 0.

fn max_elements(&self) -> usize

The maximum number of elements within a segment to generate. Defaults to 100.

fn min_data_segments(&self) -> usize

The minimum number of data segments to generate. Defaults to 0.

fn max_data_segments(&self) -> usize

The maximum number of data segments to generate. Defaults to 100.

fn max_instructions(&self) -> usize

The maximum number of instructions to generate in a function body. Defaults to 100.

fn min_memories(&self) -> u32

The minimum number of memories to use. Defaults to 0. This includes imported memories.

fn max_memories(&self) -> usize

The maximum number of memories to use. Defaults to 1. This includes imported memories.

fn min_tables(&self) -> u32

The minimum number of tables to use. Defaults to 0. This includes imported tables.

fn max_tables(&self) -> usize

The maximum number of tables to use. Defaults to 1. This includes imported tables.

fn max_memory_pages(&self, is_64: bool) -> u64

The maximum, in 64k Wasm pages, of any memory’s initial or maximum size.

fn memory_max_size_required(&self) -> bool

Whether every Wasm memory must have a maximum size specified. Defaults to false.

fn max_instances(&self) -> usize

The maximum number of instances to use. Defaults to 10. This includes imported instances.

fn max_modules(&self) -> usize

The maximum number of modules to use. Defaults to 10. This includes imported modules.

fn memory_offset_choices(&self) -> (u32, u32, u32)

Control the probability of generating memory offsets that are in bounds vs. potentially out of bounds.

fn min_uleb_size(&self) -> u8

The minimum size, in bytes, of all leb-encoded integers. Defaults to 1.

fn bulk_memory_enabled(&self) -> bool

Determines whether the bulk memory proposal is enabled for generating insructions. Defaults to false.

fn reference_types_enabled(&self) -> bool

Determines whether the reference types proposal is enabled for generating insructions. Defaults to false.

fn module_linking_enabled(&self) -> bool

Determines whether the module linking proposal is enabled.

fn simd_enabled(&self) -> bool

Determines whether the SIMD proposal is enabled for generating insructions. Defaults to false.

fn exceptions_enabled(&self) -> bool

Determines whether the exception-handling proposal is enabled for generating insructions. Defaults to false.

fn allow_start_export(&self) -> bool

Determines whether a start export may be included. Defaults to true.

fn max_aliases(&self) -> usize

Returns the maximal size of the alias section.

fn max_nesting_depth(&self) -> usize

Returns the maximal nesting depth of modules with the module linking proposal.

fn memory64_enabled(&self) -> bool

Returns whether 64-bit memories are allowed.

fn canonicalize_nans(&self) -> bool

Returns whether NaN values are canonicalized after all f32/f64 operation.

fn min_tags(&self) -> usize

The minimum number of tags to generate. Defaults to 0.

fn max_tags(&self) -> usize

The maximum number of tags to generate. Defaults to 100.

fn max_type_size(&self) -> u32

Returns the maximal effective size of any type generated by wasm-smith.

impl Debug for SwarmConfig

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

Formats the value using the given formatter.