1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
use super::stack::StackLimits;
use wasmparser::WasmFeatures;
/// The default amount of stacks kept in the cache at most.
const DEFAULT_CACHED_STACKS: usize = 2;
/// Configuration for an [`Engine`].
///
/// [`Engine`]: [`crate::Engine`]
#[derive(Debug, Copy, Clone)]
pub struct Config {
/// The limits set on the value stack and call stack.
stack_limits: StackLimits,
/// The amount of Wasm stacks to keep in cache at most.
cached_stacks: usize,
/// Is `true` if the `mutable-global` Wasm proposal is enabled.
mutable_global: bool,
/// Is `true` if the `sign-extension` Wasm proposal is enabled.
sign_extension: bool,
/// Is `true` if the `saturating-float-to-int` Wasm proposal is enabled.
saturating_float_to_int: bool,
/// Is `true` if the [`multi-value`] Wasm proposal is enabled.
multi_value: bool,
/// Is `true` if the [`bulk-memory`] Wasm proposal is enabled.
bulk_memory: bool,
/// Is `true` if the [`reference-types`] Wasm proposal is enabled.
reference_types: bool,
/// Is `true` if Wasm instructions on `f32` and `f64` types are allowed.
floats: bool,
/// Is `true` if `wasmi` executions shall consume fuel.
consume_fuel: bool,
/// The configured fuel costs of all `wasmi` bytecode instructions.
fuel_costs: FuelCosts,
}
/// Type storing all kinds of fuel costs of instructions.
#[derive(Debug, Copy, Clone)]
pub struct FuelCosts {
/// The base fuel costs for all instructions.
pub base: u64,
/// The fuel cost for instruction operating on Wasm entities.
///
/// # Note
///
/// A Wasm entitiy is one of `func`, `global`, `memory` or `table`.
/// Those instructions are usually a bit more costly since they need
/// multiplie indirect accesses through the Wasm instance and store.
pub entity: u64,
/// The fuel cost offset for `memory.load` instructions.
pub load: u64,
/// The fuel cost offset for `memory.store` instructions.
pub store: u64,
/// The fuel cost offset for `call` and `call_indirect` instructions.
pub call: u64,
/// The fuel cost offset per local variable for `call` and `call_indirect` instruction.
///
/// # Note
///
/// This is also applied to all function parameters since
/// they are translated to local variable slots.
pub call_per_local: u64,
/// The fuel cost offset per kept value for branches that need to copy values on the stack.
pub branch_per_kept: u64,
/// The fuel cost offset per byte for `bulk-memory` instructions.
pub memory_per_byte: u64,
/// The fuel cost offset per element for `bulk-table` instructions.
pub table_per_element: u64,
}
impl Default for FuelCosts {
fn default() -> Self {
Self {
base: 100,
entity: 500,
load: 650,
store: 450,
call: 1500,
call_per_local: 10,
branch_per_kept: 10,
memory_per_byte: 2,
table_per_element: 10,
}
}
}
impl Default for Config {
fn default() -> Self {
Self {
stack_limits: StackLimits::default(),
cached_stacks: DEFAULT_CACHED_STACKS,
mutable_global: true,
sign_extension: true,
saturating_float_to_int: true,
multi_value: true,
bulk_memory: true,
reference_types: true,
floats: true,
consume_fuel: false,
fuel_costs: FuelCosts::default(),
}
}
}
impl Config {
/// Sets the [`StackLimits`] for the [`Config`].
pub fn set_stack_limits(&mut self, stack_limits: StackLimits) -> &mut Self {
self.stack_limits = stack_limits;
self
}
/// Returns the [`StackLimits`] of the [`Config`].
pub(super) fn stack_limits(&self) -> StackLimits {
self.stack_limits
}
/// Sets the maximum amount of cached stacks for reuse for the [`Config`].
///
/// # Note
///
/// Defaults to 2.
pub fn set_cached_stacks(&mut self, amount: usize) -> &mut Self {
self.cached_stacks = amount;
self
}
/// Returns the maximum amount of cached stacks for reuse of the [`Config`].
pub(super) fn cached_stacks(&self) -> usize {
self.cached_stacks
}
/// Enable or disable the [`mutable-global`] Wasm proposal for the [`Config`].
///
/// # Note
///
/// Enabled by default.
///
/// [`mutable-global`]: https://github.com/WebAssembly/mutable-global
pub fn wasm_mutable_global(&mut self, enable: bool) -> &mut Self {
self.mutable_global = enable;
self
}
/// Enable or disable the [`sign-extension`] Wasm proposal for the [`Config`].
///
/// # Note
///
/// Enabled by default.
///
/// [`sign-extension`]: https://github.com/WebAssembly/sign-extension-ops
pub fn wasm_sign_extension(&mut self, enable: bool) -> &mut Self {
self.sign_extension = enable;
self
}
/// Enable or disable the [`saturating-float-to-int`] Wasm proposal for the [`Config`].
///
/// # Note
///
/// Enabled by default.
///
/// [`saturating-float-to-int`]:
/// https://github.com/WebAssembly/nontrapping-float-to-int-conversions
pub fn wasm_saturating_float_to_int(&mut self, enable: bool) -> &mut Self {
self.saturating_float_to_int = enable;
self
}
/// Enable or disable the [`multi-value`] Wasm proposal for the [`Config`].
///
/// # Note
///
/// Enabled by default.
///
/// [`multi-value`]: https://github.com/WebAssembly/multi-value
pub fn wasm_multi_value(&mut self, enable: bool) -> &mut Self {
self.multi_value = enable;
self
}
/// Enable or disable the [`bulk-memory`] Wasm proposal for the [`Config`].
///
/// # Note
///
/// Enabled by default.
///
/// [`multi-value`]: https://github.com/WebAssembly/bulk-memory-operations
pub fn wasm_bulk_memory(&mut self, enable: bool) -> &mut Self {
self.bulk_memory = enable;
self
}
/// Enable or disable the [`reference-types`] Wasm proposal for the [`Config`].
///
/// # Note
///
/// Enabled by default.
///
/// [`multi-value`]: https://github.com/WebAssembly/reference-types
pub fn wasm_reference_types(&mut self, enable: bool) -> &mut Self {
self.reference_types = enable;
self
}
/// Enable or disable Wasm instructions on `f32` and `f64` types.
///
/// # Note
///
/// This can be used to disallow floating-point operators and types.
///
/// Enabled by default.
pub fn floats(&mut self, enable: bool) -> &mut Self {
self.floats = enable;
self
}
/// Configures whether `wasmi` will consume fuel during execution to either halt execution as desired.
///
/// # Note
///
/// This configuration can be used to make `wasmi` instrument its internal bytecode
/// so that it consumes fuel as it executes. Once an execution runs out of fuel
/// a [`TrapCode::OutOfFuel`](crate::core::TrapCode::OutOfFuel) trap is raised.
/// This way users can deterministically halt or yield the execution of WebAssembly code.
///
/// - Use [`Store::add_fuel`](crate::Store::add_fuel) to pour some fuel into the [`Store`] before
/// executing some code as the [`Store`] start with no fuel.
/// - Use [`Caller::consume_fuel`](crate::Caller::consume_fuel) to charge costs for executed host functions.
///
/// Disabled by default.
///
/// [`Store`]: crate::Store
/// [`Engine`]: crate::Engine
pub fn consume_fuel(&mut self, enable: bool) -> &mut Self {
self.consume_fuel = enable;
self
}
/// Returns `true` if the [`Config`] enables fuel consumption by the [`Engine`].
///
/// [`Engine`]: crate::Engine
pub(crate) fn get_consume_fuel(&self) -> bool {
self.consume_fuel
}
/// Returns the configured [`FuelCosts`].
pub(crate) fn fuel_costs(&self) -> &FuelCosts {
&self.fuel_costs
}
/// Returns the [`WasmFeatures`] represented by the [`Config`].
pub fn wasm_features(&self) -> WasmFeatures {
WasmFeatures {
multi_value: self.multi_value,
mutable_global: self.mutable_global,
saturating_float_to_int: self.saturating_float_to_int,
sign_extension: self.sign_extension,
bulk_memory: self.bulk_memory,
reference_types: self.reference_types,
floats: self.floats,
component_model: false,
simd: false,
relaxed_simd: false,
threads: false,
tail_call: false,
multi_memory: false,
exceptions: false,
memory64: false,
extended_const: false,
memory_control: false,
}
}
}