Skip to content

A lightweight WebAssembly runtime that is fast, secure, and standards-compliant

4.9 KB
Raw Blame
//! Generate instance limits for the pooling allocation strategy.

use arbitrary::{Arbitrary, Unstructured};
use wasmtime::Enabled;

/// Configuration for `wasmtime::PoolingAllocationStrategy`.
#[derive(Debug, Clone, Eq, PartialEq, Hash)]
#[expect(missing_docs, reason = "self-describing field names")]
pub struct PoolingAllocationConfig {
    pub total_component_instances: u32,
    pub total_core_instances: u32,
    pub total_memories: u32,
    pub total_tables: u32,
    pub total_stacks: u32,

    pub max_memory_size: usize,
    pub table_elements: usize,

    pub component_instance_size: usize,
    pub max_memories_per_component: u32,
    pub max_tables_per_component: u32,

    pub core_instance_size: usize,
    pub max_memories_per_module: u32,
    pub max_tables_per_module: u32,

    pub table_keep_resident: usize,
    pub linear_memory_keep_resident: usize,

    pub decommit_batch_size: usize,
    pub max_unused_warm_slots: u32,

    pub async_stack_keep_resident: usize,

    pub memory_protection_keys: Enabled,
    pub max_memory_protection_keys: usize,

    pub pagemap_scan: Enabled,
}

impl PoolingAllocationConfig {
    /// Convert the generated limits to Wasmtime limits.
    pub fn configure(&self, cfg: &mut wasmtime_cli_flags::CommonOptions) {
        cfg.opts.pooling_total_component_instances = Some(self.total_component_instances);
        cfg.opts.pooling_total_core_instances = Some(self.total_core_instances);
        cfg.opts.pooling_total_memories = Some(self.total_memories);
        cfg.opts.pooling_total_tables = Some(self.total_tables);
        cfg.opts.pooling_total_stacks = Some(self.total_stacks);

        cfg.opts.pooling_max_memory_size = Some(self.max_memory_size);
        cfg.opts.pooling_table_elements = Some(self.table_elements);

        cfg.opts.pooling_max_component_instance_size = Some(self.component_instance_size);
        cfg.opts.pooling_max_memories_per_component = Some(self.max_memories_per_component);
        cfg.opts.pooling_max_tables_per_component = Some(self.max_tables_per_component);

        cfg.opts.pooling_max_core_instance_size = Some(self.core_instance_size);
        cfg.opts.pooling_max_memories_per_module = Some(self.max_memories_per_module);
        cfg.opts.pooling_max_tables_per_module = Some(self.max_tables_per_module);

        cfg.opts.pooling_table_keep_resident = Some(self.table_keep_resident);
        cfg.opts.pooling_memory_keep_resident = Some(self.linear_memory_keep_resident);

        cfg.opts.pooling_decommit_batch_size = Some(self.decommit_batch_size);
        cfg.opts.pooling_max_unused_warm_slots = Some(self.max_unused_warm_slots);

        cfg.opts.pooling_async_stack_keep_resident = Some(self.async_stack_keep_resident);

        cfg.opts.pooling_memory_protection_keys = Some(self.memory_protection_keys);
        cfg.opts.pooling_max_memory_protection_keys = Some(self.max_memory_protection_keys);

        cfg.opts.pooling_pagemap_scan = Some(self.pagemap_scan);
    }
}

impl<'a> Arbitrary<'a> for PoolingAllocationConfig {
    fn arbitrary(u: &mut Unstructured<'a>) -> arbitrary::Result<Self> {
        const MAX_COUNT: u32 = 100;
        const MAX_TABLES: u32 = 100;
        const MAX_MEMORIES: u32 = 100;
        const MAX_ELEMENTS: usize = 1000;
        const MAX_MEMORY_SIZE: usize = 10 * (1 << 20); // 10 MiB
        const MAX_SIZE: usize = 1 << 20; // 1 MiB
        const MAX_INSTANCE_MEMORIES: u32 = 10;
        const MAX_INSTANCE_TABLES: u32 = 10;

        let total_memories = u.int_in_range(1..=MAX_MEMORIES)?;

        Ok(Self {
            total_component_instances: u.int_in_range(1..=MAX_COUNT)?,
            total_core_instances: u.int_in_range(1..=MAX_COUNT)?,
            total_memories,
            total_tables: u.int_in_range(1..=MAX_TABLES)?,
            total_stacks: u.int_in_range(1..=MAX_COUNT)?,

            max_memory_size: u.int_in_range(0..=MAX_MEMORY_SIZE)?,
            table_elements: u.int_in_range(0..=MAX_ELEMENTS)?,

            component_instance_size: u.int_in_range(0..=MAX_SIZE)?,
            max_memories_per_component: u.int_in_range(1..=MAX_INSTANCE_MEMORIES)?,
            max_tables_per_component: u.int_in_range(1..=MAX_INSTANCE_TABLES)?,

            core_instance_size: u.int_in_range(0..=MAX_SIZE)?,
            max_memories_per_module: u.int_in_range(1..=MAX_INSTANCE_MEMORIES)?,
            max_tables_per_module: u.int_in_range(1..=MAX_INSTANCE_TABLES)?,

            table_keep_resident: u.int_in_range(0..=1 << 20)?,
            linear_memory_keep_resident: u.int_in_range(0..=1 << 20)?,

            decommit_batch_size: u.int_in_range(1..=1000)?,
            max_unused_warm_slots: u.int_in_range(0..=total_memories + 10)?,

            async_stack_keep_resident: u.int_in_range(0..=1 << 20)?,

            memory_protection_keys: *u.choose(&[Enabled::Auto, Enabled::No])?,
            max_memory_protection_keys: u.int_in_range(1..=20)?,

            pagemap_scan: *u.choose(&[Enabled::Auto, Enabled::No])?,
        })
    }
}