Struct soroban_wasmi::EnforcedLimits

pub struct EnforcedLimits {
    pub max_globals: Option<u32>,
    pub max_functions: Option<u32>,
    pub max_tables: Option<u32>,
    pub max_element_segments: Option<u32>,
    pub max_memories: Option<u32>,
    pub max_data_segments: Option<u32>,
    pub max_params: Option<usize>,
    pub max_results: Option<usize>,
    pub min_avg_bytes_per_function: Option<AvgBytesPerFunctionLimit>,
}

Stores customizable limits for the Engine when parsing or compiling Wasm modules.

By default no limits are enforced.

Fields

max_globals: Option<u32>

Number of global variables a single Wasm module can have at most.

Note

• This is checked in Module::new or Module::new_unchecked.
• None means the limit is not enforced.

max_functions: Option<u32>

Number of functions a single Wasm module can have at most.

Note

• This is checked in Module::new or Module::new_unchecked.
• None means the limit is not enforced.

max_tables: Option<u32>

Number of tables a single Wasm module can have at most.

Note

• This is checked in Module::new or Module::new_unchecked.
• This is only relevant if the Wasm reference-types proposal is enabled.
• None means the limit is not enforced.

max_element_segments: Option<u32>

Number of table element segments a single Wasm module can have at most.

Note

• This is checked in Module::new or Module::new_unchecked.
• This is only relevant if the Wasm reference-types proposal is enabled.
• None means the limit is not enforced.

max_memories: Option<u32>

Number of linear memories a single Wasm module can have.

Note

• This is checked in Module::new or Module::new_unchecked.
• This is only relevant if the Wasm multi-memories proposal is enabled which is not supported in Wasmi at the time of writing this comment.
• None means the limit is not enforced.

max_data_segments: Option<u32>

Number of linear memory data segments a single Wasm module can have at most.

Note

• This is checked in Module::new or Module::new_unchecked.
• This is only relevant if the Wasm reference-types proposal is enabled.
• None means the limit is not enforced.

max_params: Option<usize>

Limits the number of parameter of all functions and control structures.

Note

• This is checked in Module::new or Module::new_unchecked.
• None means the limit is not enforced.

max_results: Option<usize>

Limits the number of results of all functions and control structures.

Note

• This is only relevant if the Wasm multi-value proposal is enabled.
• This is checked in Module::new or Module::new_unchecked.
• None means the limit is not enforced.

min_avg_bytes_per_function: Option<AvgBytesPerFunctionLimit>

Minimum number of bytes a function must have on average.

Note

• This is checked in Module::new or Module::new_unchecked.
• This limitation might seem arbitrary but is important to defend against malicious inputs targeting lazy compilation.
• None means the limit is not enforced.

Implementations

impl EnforcedLimits

pub fn strict() -> Self

A strict set of limits that makes use of Wasmi implementation details.

This set of strict enforced rules can be used by Wasmi users in order to safeguard themselves against malicious actors trying to attack the Wasmi compilation procedures.

Trait Implementations

impl Clone for EnforcedLimits

fn clone(&self) -> EnforcedLimits

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EnforcedLimits

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

Formats the value using the given formatter.

impl Default for EnforcedLimits

fn default() -> EnforcedLimits

Returns the “default value” for a type.

impl Copy for EnforcedLimits