Trait wasm_smith::Config

pub trait Config: Arbitrary + Default {
    pub fn min_types(&self) -> usize { ... }
    pub fn max_types(&self) -> usize { ... }
    pub fn min_imports(&self) -> usize { ... }
    pub fn max_imports(&self) -> usize { ... }
    pub fn min_funcs(&self) -> usize { ... }
    pub fn max_funcs(&self) -> usize { ... }
    pub fn min_globals(&self) -> usize { ... }
    pub fn max_globals(&self) -> usize { ... }
    pub fn min_exports(&self) -> usize { ... }
    pub fn max_exports(&self) -> usize { ... }
    pub fn min_element_segments(&self) -> usize { ... }
    pub fn max_element_segments(&self) -> usize { ... }
    pub fn min_elements(&self) -> usize { ... }
    pub fn max_elements(&self) -> usize { ... }
    pub fn min_data_segments(&self) -> usize { ... }
    pub fn max_data_segments(&self) -> usize { ... }
    pub fn max_instructions(&self) -> usize { ... }
    pub fn min_memories(&self) -> u32 { ... }
    pub fn max_memories(&self) -> u32 { ... }
    pub fn min_tables(&self) -> u32 { ... }
    pub fn max_tables(&self) -> u32 { ... }
    pub fn max_memory_pages(&self) -> u32 { ... }
    pub fn memory_max_size_required(&self) -> bool { ... }
    pub fn memory_offset_choices(&self) -> (u32, u32, u32) { ... }
    pub fn min_uleb_size(&self) -> u8 { ... }
    pub fn bulk_memory_enabled(&self) -> bool { ... }
    pub fn reference_types_enabled(&self) -> bool { ... }
    pub fn allow_start_export(&self) -> bool { ... }
}

Configuration for a generated module.

Don't care to configure your generated modules? Just use Module, which internally uses DefaultConfig.

If you want to configure generated modules, then define a MyConfig type, implement this trait for it, and use ConfiguredModule<MyConfig> instead of Module.

Every trait method has a provided default implementation, so that you only need to override the methods for things you want to change away from the default.

Provided methods

pub fn min_types(&self) -> usize

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

pub fn max_types(&self) -> usize

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

pub fn min_imports(&self) -> usize

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

Note that if the sum of the maximum function¹, table, global and memory counts is less than the minimum number of imports, then it will not be possible to satisfy all constraints (because imports count against the limits for those element kinds). In that case, we strictly follow the max-constraints, and can fail to satisfy this minimum number.

---

1. the maximum number of functions is also limited by the number of function types arbitrarily chosen; strictly speaking, then, the maximum number of imports that can be created due to max-constraints is sum(min(num_func_types, max_funcs), max_tables, max_globals, max_memories). ↩

pub fn max_imports(&self) -> usize

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

pub fn min_funcs(&self) -> usize

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

pub fn max_funcs(&self) -> usize

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

pub fn min_globals(&self) -> usize

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

pub fn max_globals(&self) -> usize

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

pub fn min_exports(&self) -> usize

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

pub fn max_exports(&self) -> usize

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

pub fn min_element_segments(&self) -> usize

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

pub fn max_element_segments(&self) -> usize

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

pub fn min_elements(&self) -> usize

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

pub fn max_elements(&self) -> usize

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

pub fn min_data_segments(&self) -> usize

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

pub fn max_data_segments(&self) -> usize

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

pub fn max_instructions(&self) -> usize

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

Note that some additional ends, elses, and unreachables may be appended to the function body to finish block scopes.

pub fn min_memories(&self) -> u32

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

pub fn max_memories(&self) -> u32

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

Note that more than one memory is in the realm of the multi-memory wasm proposal.

pub fn min_tables(&self) -> u32

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

pub fn max_tables(&self) -> u32

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

Note that more than one table is in the realm of the reference types proposal.

pub fn max_memory_pages(&self) -> u32

The maximum, in 64k Wasm pages, of any memory's initial or maximum size. Defaults to 2^16 = 65536 (the maximum possible for 32-bit Wasm).

pub fn memory_max_size_required(&self) -> bool

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

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

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

Return a tuple (a, b, c) where

• a / (a+b+c) is the probability of generating a memory offset within 0..memory.min_size, i.e. an offset that is definitely in bounds of a non-empty memory. (Note that if a memory is zero-sized, however, no offset will ever be in bounds.)

• b / (a+b+c) is the probability of generating a memory offset within memory.min_size..memory.max_size, i.e. an offset that is possibly in bounds if the memory has been grown.

• c / (a+b+c) is the probability of generating a memory offset within the range memory.max_size.., i.e. an offset that is definitely out of bounds.

At least one of a, b, and c must be non-zero.

If you want to always generate memory offsets that are definitely in bounds of a non-zero-sized memory, for example, you could return (1, 0, 0).

By default, returns (75, 24, 1).

pub fn min_uleb_size(&self) -> u8

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

This is useful for ensuring that all leb-encoded integers are decoded as such rather than as simply one byte. This will forcibly extend leb integers with an over-long encoding in some locations if the size would otherwise be smaller than number returned here.

pub fn bulk_memory_enabled(&self) -> bool

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

pub fn reference_types_enabled(&self) -> bool

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

pub fn allow_start_export(&self) -> bool

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

Loading content...

Implementors

impl Config for DefaultConfig

impl Config for SwarmConfig

pub fn max_types(&self) -> usize

pub fn max_imports(&self) -> usize

pub fn max_funcs(&self) -> usize

pub fn max_globals(&self) -> usize

pub fn max_exports(&self) -> usize

pub fn max_element_segments(&self) -> usize

pub fn max_elements(&self) -> usize

pub fn max_data_segments(&self) -> usize

pub fn max_instructions(&self) -> usize

pub fn max_memories(&self) -> u32

pub fn max_tables(&self) -> u32

pub fn max_memory_pages(&self) -> u32

pub fn min_uleb_size(&self) -> u8

pub fn bulk_memory_enabled(&self) -> bool

pub fn reference_types_enabled(&self) -> bool

Loading content...