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 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733
// Copyright 2021-2023 Protocol Labs
// SPDX-License-Identifier: Apache-2.0, MIT
mod concurrency;
mod instance_pool;
use std::any::{Any, TypeId};
use std::collections::hash_map::Entry::{Occupied, Vacant};
use std::collections::HashMap;
use std::sync::{Arc, Mutex};
use anyhow::{anyhow, Context};
use cid::Cid;
use fvm_ipld_blockstore::Blockstore;
use fvm_shared::error::ExitCode;
use fvm_wasm_instrument::gas_metering::GAS_COUNTER_NAME;
use num_traits::Zero;
use wasmtime::OptLevel::Speed;
use wasmtime::{
Global, GlobalType, InstanceAllocationStrategy, Memory, MemoryType, Module, Mutability, Val,
ValType, WasmBacktraceDetails,
};
use crate::gas::{Gas, GasTimer, WasmGasPrices};
use crate::machine::limiter::MemoryLimiter;
use crate::machine::{Machine, NetworkConfig};
use crate::syscalls::error::Abort;
use crate::syscalls::{
charge_for_exec, charge_for_init, record_init_time, update_gas_available, InvocationData,
Linker,
};
use crate::Kernel;
use self::concurrency::EngineConcurrency;
use self::instance_pool::InstancePool;
/// The expected max stack depth used to determine the number of instances needed for a given
/// concurrency level.
const EXPECTED_MAX_STACK_DEPTH: u32 = 20;
/// Container managing [`Engine`]s with different consensus-affecting configurations.
pub struct MultiEngine {
engines: Mutex<HashMap<EngineConfig, EnginePool>>,
concurrency: u32,
}
/// The proper way of getting this struct is to convert from `NetworkConfig`
#[derive(Clone, Eq, PartialEq, Hash)]
pub struct EngineConfig {
pub max_call_depth: u32,
pub max_wasm_stack: u32,
pub max_inst_memory_bytes: u64,
pub concurrency: u32,
pub wasm_prices: &'static WasmGasPrices,
pub actor_redirect: Vec<(Cid, Cid)>,
}
impl EngineConfig {
fn instance_pool_size(&self) -> u32 {
std::cmp::min(
// Allocate at least one full call depth worth of stack, plus some per concurrent call
// we allow.
self.max_call_depth + EXPECTED_MAX_STACK_DEPTH * self.concurrency,
// Most machines simply can't handle any more than 48k instances (fails to allocate
// address space).
48 * 1024,
)
}
}
impl From<&NetworkConfig> for EngineConfig {
fn from(nc: &NetworkConfig) -> Self {
EngineConfig {
max_call_depth: nc.max_call_depth,
max_wasm_stack: nc.max_wasm_stack,
max_inst_memory_bytes: nc.max_inst_memory_bytes,
wasm_prices: &nc.price_list.wasm_rules,
actor_redirect: nc.actor_redirect.clone(),
concurrency: 1,
}
}
}
impl MultiEngine {
/// Create a new "multi-engine" with the given concurrency limit. The concurrency limit is
/// per-configuration, not global.
pub fn new(concurrency: u32) -> MultiEngine {
if concurrency == 0 {
panic!("concurrency must be positive");
}
MultiEngine {
engines: Mutex::new(HashMap::new()),
concurrency,
}
}
/// Get an [`EnginePool`] for the given [`NetworkConfig`], creating one if it doesn't already
/// exist.
pub fn get(&self, nc: &NetworkConfig) -> anyhow::Result<EnginePool> {
let mut engines = self
.engines
.lock()
.map_err(|_| anyhow::Error::msg("multiengine lock is poisoned"))?;
let mut ec: EngineConfig = nc.into();
ec.concurrency = self.concurrency;
let pool = match engines.entry(ec.clone()) {
Occupied(entry) => entry.into_mut(),
Vacant(entry) => entry.insert(EnginePool::new(ec)?),
};
Ok(pool.clone())
}
}
impl Default for MultiEngine {
fn default() -> Self {
Self::new(1)
}
}
/// Derive a [`wasmtime::Config`] from an [`EngineConfig`]
fn wasmtime_config(ec: &EngineConfig) -> anyhow::Result<wasmtime::Config> {
if ec.concurrency < 1 {
return Err(anyhow!("concurrency limit must not be 0"));
}
let instance_count = ec.instance_pool_size();
let instance_memory_maximum_size = ec.max_inst_memory_bytes;
if instance_memory_maximum_size % wasmtime_environ::WASM_PAGE_SIZE as u64 != 0 {
return Err(anyhow!(
"requested memory limit {} not a multiple of the WASM_PAGE_SIZE {}",
instance_memory_maximum_size,
wasmtime_environ::WASM_PAGE_SIZE
));
}
let mut c = wasmtime::Config::default();
// wasmtime default: OnDemand
// We want to pre-allocate all permissible memory to support the maximum allowed recursion limit.
let mut alloc_strat_cfg = wasmtime::PoolingAllocationConfig::default();
alloc_strat_cfg.total_core_instances(instance_count);
alloc_strat_cfg.total_memories(instance_count);
alloc_strat_cfg.max_memories_per_module(1);
alloc_strat_cfg.total_tables(instance_count);
alloc_strat_cfg.max_tables_per_module(1);
// Adjust the maximum amount of host memory that can be committed to an instance to
// match the static linear memory size we reserve for each slot.
alloc_strat_cfg
.memory_pages(instance_memory_maximum_size / (wasmtime_environ::WASM_PAGE_SIZE as u64));
c.allocation_strategy(InstanceAllocationStrategy::Pooling(alloc_strat_cfg));
// wasmtime default: true
// We disable this as we always charge for memory regardless and `memory_init_cow` can baloon compiled wasm modules.
c.memory_init_cow(false);
// wasmtime default: 4GB
c.static_memory_maximum_size(instance_memory_maximum_size);
c.static_memory_forced(true);
// wasmtime default: true
// We don't want threads, there is no way to ensure determinism
c.wasm_threads(false);
// wasmtime default: true
// simd isn't supported in wasm-instrument, but if we add support there, we can probably enable
// this.
// Note: stack limits may need adjusting after this is enabled
c.wasm_simd(false);
c.wasm_relaxed_simd(false);
c.relaxed_simd_deterministic(true);
// wasmtime default: false
// We don't support the return_call_* functions.
c.wasm_tail_call(false);
// wasmtime default: true
c.wasm_multi_memory(false);
// wasmtime default: false
c.wasm_memory64(false);
// wasmtime default: true
// Note: wasm-instrument only supports this at a basic level, for M2 we will
// need to add more advanced support
c.wasm_bulk_memory(true);
// wasmtime default: true
// we should be able to enable this for M2, just need to make sure that it's
// handled correctly in wasm-instrument
c.wasm_multi_value(false);
// wasmtime default: false
// Cool proposal to allow function references, but we don't support it yet.
#[cfg(feature = "wasmtime/gc")]
c.wasm_function_references(false);
// wasmtime default: false
// Wasmtime function reference proposal.
#[cfg(feature = "wasmtime/gc")]
c.wasm_gc(false);
// wasmtime default: false
//
// from wasmtime docs:
// > When Cranelift is used as a code generation backend this will
// > configure it to replace NaNs with a single canonical value. This
// > is useful for users requiring entirely deterministic WebAssembly
// > computation. This is not required by the WebAssembly spec, so it is
// > not enabled by default.
c.cranelift_nan_canonicalization(true);
// wasmtime default: 512KiB
// Set to something much higher than the instrumented limiter.
// Note: This is in bytes, while the instrumented limit is in stack elements
c.max_wasm_stack(4 << 20);
// Execution cost accouting is done through wasm instrumentation,
c.consume_fuel(false);
c.epoch_interruption(false);
// Disable debug-related things, wasm-instrument doesn't fix debug info
// yet, so those aren't useful, just add overhead
c.debug_info(false);
c.generate_address_map(false);
c.cranelift_debug_verifier(false);
c.native_unwind_info(false);
c.wasm_backtrace(false);
c.wasm_backtrace_details(WasmBacktraceDetails::Disable);
// Reiterate some defaults
c.guard_before_linear_memory(true);
c.parallel_compilation(true);
// Disable caching if some other crate enables it. We do our own caching.
#[cfg(feature = "wasmtime/cache")]
c.disable_cache();
#[cfg(feature = "wasmtime/async")]
c.async_support(false);
// Doesn't seem to have significant impact on the time it takes to load code
// todo(M2): make sure this is guaranteed to run in linear time.
c.cranelift_opt_level(Speed);
Ok(c)
}
#[derive(Clone)]
struct ModuleRecord {
module: Module,
/// Byte size of the original Wasm.
size: usize,
}
struct EngineInner {
concurrency_limit: EngineConcurrency,
instance_limit: InstancePool,
engine: wasmtime::Engine,
/// These two fields are used used in the store constructor to avoid resolve a chicken & egg
/// situation: We need the store before we can get the real values, but we need to create the
/// `InvocationData` before we can make the store.
///
/// Alternatively, we could use `Option`s. But then we need to unwrap everywhere.
dummy_gas_global: Global,
dummy_memory: Memory,
module_cache: Mutex<HashMap<Cid, ModuleRecord>>,
instance_cache: Mutex<HashMap<TypeId, Box<dyn Any + Send>>>,
config: EngineConfig,
actor_redirect: HashMap<Cid, Cid>,
}
/// EnginePool represents a limited pool of engines.
#[derive(Clone)]
pub struct EnginePool(Arc<EngineInner>);
impl EnginePool {
/// Acquire an [`Engine`]. This method will block until an [`Engine`] is available, and will
/// release the engine on drop.
pub fn acquire(&self) -> Engine {
Engine {
id: self.0.concurrency_limit.acquire(),
inner: self.0.clone(),
}
}
/// Create a new [`EnginePool`].
pub fn new(ec: EngineConfig) -> anyhow::Result<Self> {
let c = wasmtime_config(&ec)?;
let engine = wasmtime::Engine::new(&c)?;
let mut dummy_store = wasmtime::Store::new(&engine, ());
let gg_type = GlobalType::new(ValType::I64, Mutability::Var);
let dummy_gg = Global::new(&mut dummy_store, gg_type, Val::I64(0))
.expect("failed to create dummy gas global");
let dummy_memory = Memory::new(&mut dummy_store, MemoryType::new(0, Some(0)))
.expect("failed to create dummy memory");
let actor_redirect = ec.actor_redirect.iter().cloned().collect();
Ok(EnginePool(Arc::new(EngineInner {
concurrency_limit: EngineConcurrency::new(ec.concurrency),
instance_limit: InstancePool::new(ec.instance_pool_size(), ec.max_call_depth),
engine,
dummy_memory,
dummy_gas_global: dummy_gg,
module_cache: Default::default(),
instance_cache: Mutex::new(HashMap::new()),
config: ec,
actor_redirect,
})))
}
}
struct Cache<K> {
linker: wasmtime::Linker<InvocationData<K>>,
}
/// An `Engine` represents a single, caching wasm engine. It should not be shared between concurrent
/// call stacks.
///
/// The `Engine` will be returned to the [`EnginePool`] on drop.
pub struct Engine {
id: u64,
inner: Arc<EngineInner>,
}
/// Release the engine back into the [`EnginePool`].
impl Drop for Engine {
fn drop(&mut self) {
self.inner.concurrency_limit.release();
}
}
impl Engine {
/// Loads an actor's Wasm code from the blockstore by CID, and prepares
/// it for execution by instantiating and caching the Wasm module. This
/// method errors if the code CID is not found in the store.
///
/// Return the original byte code size.
pub fn preload(&self, code_cid: &Cid, blockstore: &impl Blockstore) -> anyhow::Result<usize> {
let code_cid = self.with_redirect(code_cid);
match self
.inner
.module_cache
.lock()
.expect("module_cache poisoned")
.entry(*code_cid)
{
Occupied(e) => Ok(e.get().size),
Vacant(e) => {
let wasm = blockstore.get(code_cid)?.ok_or_else(|| {
anyhow!(
"no wasm bytecode in blockstore for CID {}",
&code_cid.to_string()
)
})?;
Ok(e.insert(self.load_raw(&wasm)?).size)
}
}
}
/// Instantiates and caches the Wasm modules for the bytecodes addressed by
/// the supplied CIDs. Only uncached entries are actually fetched and
/// instantiated. Blockstore failures and entry inexistence shortcircuit
/// make this method return an Err immediately.
///
/// Returns the total original byte size of the modules
pub fn preload_all<'a>(
&self,
blockstore: &impl Blockstore,
cids: impl IntoIterator<Item = &'a Cid>,
) -> anyhow::Result<usize> {
let mut total_size = 0usize;
for cid in cids {
log::trace!("preloading code CID {cid}");
let size = self.preload(cid, &blockstore).with_context(|| {
anyhow!("could not prepare actor with code CID {}", &cid.to_string())
})?;
total_size += size;
}
Ok(total_size)
}
/// Translate the passed CID with a "redirected" CID in case the code has been replaced.
fn with_redirect<'a>(&'a self, k: &'a Cid) -> &'a Cid {
match &self.inner.actor_redirect.get(k) {
Some(cid) => cid,
None => k,
}
}
/// Load the specified wasm module with the internal Engine instance.
fn load_raw(&self, raw_wasm: &[u8]) -> anyhow::Result<ModuleRecord> {
// First make sure that non-instrumented wasm is valid
Module::validate(&self.inner.engine, raw_wasm)
.map_err(anyhow::Error::msg)
.with_context(|| "failed to validate actor wasm")?;
// Note: when adding debug mode support (with recorded syscall replay) don't instrument to
// avoid breaking debug info
use fvm_wasm_instrument::{gas_metering, stack_limiter};
// stack limiter adds post/pre-ambles to call instructions; We want to do that
// before injecting gas accounting calls to avoid this overhead in every single
// block of code.
let raw_wasm = stack_limiter::inject(raw_wasm, self.inner.config.max_wasm_stack)
.map_err(anyhow::Error::msg)?;
// inject gas metering based on a price list. This function will
// * add a new mutable i64 global import, gas.gas_counter
// * push a gas counter function which deduces gas from the global, and
// traps when gas.gas_counter is less than zero
// * optionally push a function which wraps memory.grow instruction
// making it charge gas based on memory requested
// * divide code into metered blocks, and add a call to the gas counter
// function before entering each metered block
// * NOTE: Currently cannot instrument and charge for `table.grow` because the instruction
// (code `0xFC 15`) uses what parity-wasm calls the `BULK_PREFIX` but it was added later in
// https://github.com/WebAssembly/reference-types/issues/29 and is not recognised by the
// parity-wasm module parser, so the contract cannot grow the tables.
let raw_wasm = gas_metering::inject(&raw_wasm, self.inner.config.wasm_prices, "gas")
.map_err(|_| anyhow::Error::msg("injecting gas counter failed"))?;
let module = Module::from_binary(&self.inner.engine, &raw_wasm)?;
Ok(ModuleRecord {
module,
size: raw_wasm.len(),
})
}
/// Load compiled wasm code into the engine.
///
/// # Safety
///
/// See [`wasmtime::Module::deserialize`] for safety information.
#[allow(dead_code)]
unsafe fn load_compiled(&self, k: &Cid, compiled: &[u8]) -> anyhow::Result<Module> {
let k = self.with_redirect(k);
let mut cache = self
.inner
.module_cache
.lock()
.expect("module_cache poisoned");
let module = match cache.get(k) {
Some(m) => m.module.clone(),
None => {
let module = Module::deserialize(&self.inner.engine, compiled)?;
cache.insert(
*k,
ModuleRecord {
module: module.clone(),
size: compiled.len(),
},
);
module
}
};
Ok(module)
}
/// Lookup and instantiate a loaded wasmtime module with the given store. This will cache the
/// linker, syscalls, etc.
///
/// This returns an `Abort` as it may need to execute initialization code, charge gas, etc.
pub(crate) fn instantiate<K: Kernel>(
&self,
store: &mut wasmtime::Store<InvocationData<K>>,
k: &Cid,
) -> Result<Option<wasmtime::Instance>, Abort> {
let k = self.with_redirect(k);
let mut instance_cache = self.inner.instance_cache.lock().expect("cache poisoned");
let type_id = TypeId::of::<K>();
let cache: &mut Cache<K> = match instance_cache.entry(type_id) {
Occupied(e) => &mut *e
.into_mut()
.downcast_mut()
.expect("invalid instance cache entry"),
Vacant(e) => &mut *e
.insert({
let mut linker = Linker(wasmtime::Linker::new(&self.inner.engine));
linker.0.allow_shadowing(true);
K::link_syscalls(&mut linker).map_err(Abort::Fatal)?;
Box::new(Cache { linker: linker.0 })
})
.downcast_mut()
.expect("invalid instance cache entry"),
};
let gas_global = store.data_mut().avail_gas_global;
cache
.linker
.define(&store, "gas", GAS_COUNTER_NAME, gas_global)
.context("failed to define gas counter")
.map_err(Abort::Fatal)?;
let mut module_cache = self
.inner
.module_cache
.lock()
.expect("module_cache poisoned");
let instantiate = |store: &mut wasmtime::Store<InvocationData<K>>, module| {
// Before we instantiate the module, we should make sure the user has sufficient gas to
// pay for the minimum memory requirements. The module instrumentation in `inject` only
// adds code to charge for _growing_ the memory, but not for the amount made accessible
// initially. The limits are checked by wasmtime during instantiation, though.
let t = charge_for_init(store, module).map_err(Abort::from_error_as_fatal)?;
// Pre-instantiate to catch any linker errors. These are considered fatal as it means
// the wasm module wasn't properly validated.
let pre_instance = cache
.linker
.instantiate_pre(module)
.context("failed to link actor module")?;
// Update the gas _just_ in case.
update_gas_available(store)?;
let res = pre_instance.instantiate(&mut *store);
charge_for_exec(store)?;
let inst = res.map_err(|e| {
// We can't really tell what type of error happened, so we have to assume that we
// either ran out of memory or trapped. Given that we've already type-checked the
// module, this is the most likely case anyways. That or there'a a bug in the FVM.
Abort::Exit(
ExitCode::SYS_ILLEGAL_INSTRUCTION,
format!("failed to instantiate module: {e}"),
0,
)
})?;
// Record the time it took for the linker to instantiate the module.
// This should also include everything that happens above in this method.
// Note that this does _not_ contain the time it took the load the Wasm file,
// which could have been cached already.
record_init_time(store, t);
Ok(Some(inst))
};
match module_cache.entry(*k) {
Occupied(v) => instantiate(store, &v.get().module),
Vacant(v) => match store
.data()
.kernel
.machine()
.blockstore()
.get(k)
.context("failed to lookup wasm module in blockstore")
.map_err(Abort::Fatal)?
{
Some(raw_wasm) => instantiate(
store,
&v.insert(self.load_raw(&raw_wasm).map_err(Abort::Fatal)?)
.module,
),
None => Ok(None),
},
}
}
/// Construct a new wasmtime "store" from the given kernel.
pub(crate) fn new_store<K: Kernel>(&self, mut kernel: K) -> wasmtime::Store<InvocationData<K>> {
// Take a new instance and put it into a drop-guard that removes the reservation when
// we're done.
#[must_use]
struct InstanceReservation(Arc<EngineInner>);
impl Drop for InstanceReservation {
fn drop(&mut self) {
self.0.instance_limit.put();
}
}
self.inner.instance_limit.take(self.id);
let reservation = InstanceReservation(self.inner.clone());
let memory_bytes = kernel.limiter_mut().memory_used();
let id = InvocationData {
kernel,
last_error: None,
avail_gas_global: self.inner.dummy_gas_global,
last_gas_available: Gas::zero(),
last_memory_bytes: memory_bytes,
last_charge_time: GasTimer::start(),
memory: self.inner.dummy_memory,
wasm_prices: self.inner.config.wasm_prices,
};
let mut store = wasmtime::Store::new(&self.inner.engine, id);
let ggtype = GlobalType::new(ValType::I64, Mutability::Var);
let gg = Global::new(&mut store, ggtype, Val::I64(0))
.expect("failed to create available_gas global");
store.data_mut().avail_gas_global = gg;
store.limiter(move |data| {
// Keep the reservation alive as long as the limiter is alive. The limiter limits the
// store to one instance and one memory, which is covered by the reservation.
let _ = &reservation;
// SAFETY: This is safe because WasmtimeLimiter is `repr(transparent)`.
// Unfortunately, we can't simply wrap the limiter as we need to return a reference.
let limiter: &mut WasmtimeLimiter<K::Limiter> = unsafe {
let limiter_ref = data.kernel.limiter_mut();
// (debug)-assert that these types have the same layout (guaranteed by
// `repr(transparent)`).
debug_assert_eq!(
std::alloc::Layout::for_value(&*limiter_ref),
std::alloc::Layout::new::<WasmtimeLimiter<K::Limiter>>()
);
// Then cast.
&mut *(limiter_ref as *mut K::Limiter as *mut WasmtimeLimiter<K::Limiter>)
};
limiter as &mut dyn wasmtime::ResourceLimiter
});
store
}
}
#[repr(transparent)]
struct WasmtimeLimiter<L>(L);
impl<L: MemoryLimiter> wasmtime::ResourceLimiter for WasmtimeLimiter<L> {
fn memory_growing(
&mut self,
current: usize,
desired: usize,
maximum: Option<usize>,
) -> anyhow::Result<bool> {
if maximum.map_or(false, |m| desired > m) {
return Ok(false);
}
Ok(self.0.grow_instance_memory(current, desired))
}
fn table_growing(
&mut self,
current: u32,
desired: u32,
maximum: Option<u32>,
) -> anyhow::Result<bool> {
if maximum.map_or(false, |m| desired > m) {
return Ok(false);
}
Ok(self.0.grow_instance_table(current, desired))
}
// The FVM allows one instance & one memory per store/kernel (for now).
fn instances(&self) -> usize {
1
}
fn memories(&self) -> usize {
1
}
}
#[cfg(test)]
mod tests {
use wasmtime::ResourceLimiter;
use crate::engine::WasmtimeLimiter;
use crate::machine::limiter::MemoryLimiter;
#[derive(Default)]
struct Limiter {
memory: usize,
}
impl MemoryLimiter for Limiter {
fn memory_used(&self) -> usize {
unimplemented!()
}
fn grow_memory(&mut self, bytes: usize) -> bool {
self.memory += bytes;
true
}
fn with_stack_frame<T, G, F, R>(_: &mut T, _: G, _: F) -> R
where
G: Fn(&mut T) -> &mut Self,
F: FnOnce(&mut T) -> R,
{
unimplemented!()
}
}
#[test]
fn memory() {
let mut limits = WasmtimeLimiter(Limiter::default());
assert!(limits.memory_growing(0, 3, None).unwrap());
assert_eq!(limits.0.memory, 3);
// The maximum in the args takes precedence.
assert!(!limits.memory_growing(3, 4, Some(2)).unwrap());
assert_eq!(limits.0.memory, 3);
// Increase by 2.
assert!(limits.memory_growing(2, 4, None).unwrap());
assert_eq!(limits.0.memory, 5);
}
#[test]
fn table() {
let mut limits = WasmtimeLimiter(Limiter::default());
assert!(limits.table_growing(0, 3, None).unwrap());
assert_eq!(limits.0.memory, 3 * 8);
// The maximum in the args takes precedence.
assert!(!limits.table_growing(3, 4, Some(2)).unwrap());
assert_eq!(limits.0.memory, 3 * 8);
// Increase by 2.
assert!(limits.table_growing(2, 4, None).unwrap());
assert_eq!(limits.0.memory, 5 * 8);
}
}