submilli_engine/runtime/

mod.rs

//! Wasmtime engine configuration for Submilli.

use crate::runtime::durable::RunId;
pub mod agents;
pub mod approvals;
pub(crate) mod array_storage;
pub mod blocking;
pub mod call_log;
pub mod decision;
pub mod default_filesystem;
pub mod disk_quota;
pub mod durable;
pub mod effects;
mod effects_memory;
pub mod embedding;
pub mod exec;
pub mod filesystem;
pub mod finalizers;
pub mod fs;
pub mod fuel;
pub mod gc_singleton;
pub mod host;
pub mod intrinsic_types;
pub mod json;
pub(crate) mod json_text;
pub mod limits;
pub mod llm;
pub mod mcp;
pub mod metrics;
pub mod model_calls;
pub mod number;
pub mod prelude;
pub mod secrets;
pub mod security;
pub mod session_finalizers;
pub mod session_kv;
pub mod skills;
pub mod token_ledger;
pub mod tools;
pub mod vfs;
pub mod watchdog;

pub use agents::{
    AGENTS_MODULE_NAME, AgentCallError, AgentInfo, AgentOutcome, AgentProvider, AgentRequest,
    AgentUsage,
};
pub use approvals::{
    APPROVAL_OPERATION, ApprovalError, ApprovalOutcome, ApprovalProvider, ApprovalRequest,
    Approver, AskRule, Unasked,
};
pub use call_log::{BodyCopy, CallOutcome, CallRecord, ModelUsage, PayloadRecord};
pub use decision::{
    CallOrigin, CallSite, CallTicket, ConsoleLine, DecisionAction, DecisionCause,
    DecisionExplanation, DecisionLog, DecisionLogConfig, DecisionLogOutput, DecisionRecord,
    DecisionRecorder, EntryPath, FailureReasonRecord, FailureRecord, NearMissRecord, PackageLine,
    RecordObserver, RuleCitation, SourceLine,
};
pub use disk_quota::{DiskQuota, Holder, OpenFileGuard, QuotaCharge, QuotaExceeded};
pub use embedding::{
    DEFAULT_MAX_EMBEDDING_REQUESTS, DEFAULT_MAX_EXECUTION_EMBEDDING_TOKENS, EMBEDDING_MODULE_NAME,
    EmbeddingBatch, EmbeddingBoundKind, EmbeddingError, EmbeddingFailureReason, EmbeddingLimitKind,
    EmbeddingLimits, EmbeddingMalformedReason, EmbeddingModel, EmbeddingProvider,
    EmbeddingShapeError, EmbeddingTokenBudget, Purpose, SubBatchSettlement,
    estimate_embedding_tokens,
};
pub use exec::{RunResult, dispatch_main_async, instantiate_program_async};
pub use finalizers::{FinalizerCall, FinalizerError, invoke_finalizer_async};
pub use host::{
    INTERNAL_MODULE_NAME, NUMBER_MODULE_NAME, host_package_declarations,
    install_async as install_runtime_async, install_async_for as install_runtime_async_for,
    install_host_functions as install_runtime_host_functions,
    install_host_functions_for as install_runtime_host_functions_for,
    install_store_bound as install_runtime_store_bound, internal_host_package_declarations,
    stdlib_package_declarations,
};
pub use json::JSON_MODULE_NAME;
pub use limits::{
    DEFAULT_MAX_STORE_BYTES, MemoryCapExceeded, MemoryExhausted, TenantLimits,
    install_tenant_limits, is_memory_exhausted,
};
pub use llm::{
    DEFAULT_MAX_ALL_EXECUTIONS_TOKENS, DEFAULT_MAX_EXECUTION_TOKENS, ExecutionTokenBudget,
    FailureReason, LLM_MODULE_NAME, LlmCallError, LlmFailure, LlmLimitKind, LlmLimits, LlmModel,
    LlmOutcome, LlmProvider, PromptBoundKind, SharedTokenBudget,
};
pub use mcp::{
    MCP_MODULE_NAME, McpCallError, McpOutcome, McpResponse, McpTransport, install_mcp_async,
    mcp_call_package_declaration,
};
pub use metrics::{HttpMetric, MetricsSink, NoopMetricsSink};
pub use model_calls::{AttributedUsage, ModelCallUsage};
pub use prelude::bigint::ops::BIGINT_MODULE_NAME;
pub use prelude::temporal::shared::TEMPORAL_MODULE_NAME;
pub use secrets::{EncryptedSecret, NoopSecretProvider, SecretKeyId, SecretProvider};
pub use security::{AllowAllCheck, AuditDecision, CheckOutcome, SecurityCheck, denial_reason};
pub use session_kv::{
    CURSOR_KEY_ID_LEN, CursorKey, CursorKeys, InMemorySessionKv, SessionKvEntry, SessionKvError,
    SessionKvFuture, SessionKvLimitKind, SessionKvLimits, SessionKvPage, SessionKvStore,
    SessionKvUsage, entry_bytes, render_key, value_bytes,
};
pub use skills::{SKILLS_MODULE_NAME, Skill, SkillError, SkillInfo, SkillProvider};
pub use tools::{
    TOOLS_CAPABILITY, TOOLS_MODULE_NAME, TOOLS_PACKAGE, ToolCallError, ToolProvider,
    install_tools_async, tools_call_package_declaration,
};
pub use vfs::{
    Access, CopyDirError, MAX_MEASURED_DEPTH, MountError, MountSpec, Vfs, VfsMode, copy_host_dir,
    copy_host_subdir, measure_dir, measure_host_dir, measure_host_dir_skipping_vanished,
    measure_host_subdir_skipping_vanished, open_host_subdir, regular_files,
};
pub use watchdog::Watchdog;

pub use crate::stdlib::http::{
    AuthProxy, AuthProxyError, HttpClient, HttpError, HttpRequest, HttpResponse, NetworkPolicy,
    NoopAuthProxy, ReqwestHttpClient,
};

use std::cell::RefCell;
use std::io::Write;
use std::sync::{Arc, Mutex};
use std::time::Duration;

use wasmtime::{
    ArrayRef, AsContextMut, Config, Engine, Instance, Linker, Module, OptLevel, Rooted, Store,
    WasmBacktraceDetails,
};

use crate::{PackageDeclaration, TypeInfoTable};

/// Filesystem metadata surfaced to scripts via `submilli:fs.info()`: the
/// active mode and the byte cap the VFS enforces, so the script — and the LLM —
/// can branch on the sandbox shape. Never exposes the host path.
#[derive(Debug, Clone)]
pub struct VfsInfo {
    pub mode: VfsMode,
    pub size_limit: Option<u64>,
}

/// The JSON properties host-backed values show, by backing struct.
pub(crate) type HostViews = Vec<(wasmtime::StructType, crate::stdlib::abi::HostProperties)>;

pub struct StoreData {
    #[cfg(test)]
    pub(crate) array_growth: array_storage::GrowthStats,
    /// After cancelling a host call, the execution owner drains this before
    /// reusing or releasing the store. Blocking work may still be cleaning up.
    pub blocking_work: blocking::BlockingWork,
    pub git: Option<crate::stdlib::git::GitConfig>,
    pub(crate) git_history: Option<Arc<crate::stdlib::git::log_cache::Cache>>,
    pub console: Box<dyn Write + Send>,
    pub vfs: Vfs,
    pub filesystem: Arc<dyn filesystem::Filesystem>,
    /// Native outcome history, installed before any guest initializer runs.
    pub effects: Option<Arc<dyn effects::EffectHistory>>,
    pub vfs_info: VfsInfo,
    pub security_check: Arc<dyn SecurityCheck>,
    pub fs_max_read_size: u64,
    pub http_client: Arc<dyn HttpClient>,
    pub http_max_response_size: u64,
    /// Operator ceiling for a download, including streaming its body.
    pub http_max_download_timeout_ms: u64,
    pub auth_proxy: Arc<dyn AuthProxy>,
    /// Immutable configuration resolved by the trusted session creator.
    pub variables: Arc<std::collections::BTreeMap<String, String>>,
    pub secret_provider: Arc<dyn SecretProvider>,
    /// The outbound `@mcp/<server>` transport the `submilli:mcp.call` host fn
    /// dispatches through, present when the embedder wires one. `None` in the
    /// pure-interpreter path, where MCP calls throw "transport not configured".
    pub mcp_transport: Option<Arc<dyn McpTransport>>,
    /// The application tools `submilli:tools.call` (`@tools`) dispatches
    /// through, present only when the embedder wires one. `None` makes every
    /// call a catchable "no application tools" error.
    pub tool_provider: Option<Arc<dyn ToolProvider>>,
    /// Who decides a call a rule marks `ask-human` or `ask-admin`, present only
    /// when the embedder can put such a call to its approver. `None` refuses
    /// every asked call as a policy denial.
    pub approval_provider: Option<Arc<dyn ApprovalProvider>>,
    /// Time this execution spent waiting outside the program on a host call
    /// that must not count against its time limit (an application tool call, or an
    /// approval).
    /// An embedder's execution timeout subtracts it from the elapsed time.
    pub clock_paused: std::time::Duration,
    /// The model provider `submilli:llm` dispatches through, present only when
    /// the embedder wires one. Left `None` the runtime has no model access at
    /// all rather than silently completing against some default — the guest
    /// surface reports that as a catchable configuration error
    /// ([`LlmCallError::NotConfigured`]), the same rule `session_kv` follows.
    pub llm_provider: Option<Arc<dyn LlmProvider>>,
    /// This execution's token budget, reserving against its own ceiling and the
    /// server-wide one together. `None` in the pure-interpreter path, where
    /// there is no aggregate to protect and nothing to charge against; the
    /// prompt-count and prompt-size bounds still apply there, because they
    /// bound pathological shapes rather than spend. The embedder installs one
    /// per execution, and dropping it is what returns the reservation.
    pub llm_budget: Option<Arc<ExecutionTokenBudget>>,
    /// The provider `submilli:embedding` dispatches through, present only when
    /// the embedder wires one. `None` means the guest sees a catchable
    /// [`EmbeddingError::NotConfigured`], never a silent default.
    pub embedding_provider: Option<Arc<dyn EmbeddingProvider>>,
    /// This execution's embedding budget (tokens and outbound requests). `None`
    /// in the pure-interpreter path; dropping it returns unspent reservation.
    pub embedding_budget: Option<Arc<EmbeddingTokenBudget>>,
    /// Live `submilli:llm` and `submilli:embedding` dispatches in this attempt.
    /// The embedder reads [`Self::model_calls`] after guest code finishes.
    model_calls: Vec<ModelCallUsage>,
    /// Session-scoped key-value storage, present only when the embedder wires a
    /// provider. Left `None` the store stays absent rather than silently
    /// becoming per-execution scratch state that no later `execute` can read —
    /// the guest surface reports that as a configuration error.
    pub session_kv: Option<Arc<dyn SessionKvStore>>,
    /// Durable package-owned resource cleanup supplied by the embedder.
    pub session_finalizers: Option<Arc<dyn session_finalizers::SessionFinalizers>>,
    pub finalizing: bool,
    /// The keys `session.list` cursors are sealed with. `None` seals them with a
    /// per-process key, so they stop working when the process restarts.
    pub cursor_keys: Option<Arc<CursorKeys>>,
    /// The harness `submilli:agents` runs sub-agents through, present only when
    /// the embedder wires one. `None` makes every call a catchable
    /// [`AgentCallError::NotConfigured`].
    pub agent_provider: Option<Arc<dyn AgentProvider>>,
    /// The harness `submilli:skills` reads skills through, present only when the
    /// embedder wires one. `None` makes every call a catchable
    /// [`SkillError::NotConfigured`].
    pub skill_provider: Option<Arc<dyn SkillProvider>>,
    /// Embedder sink for host-operation metrics (HTTP transport latencies).
    /// Defaults to [`NoopMetricsSink`]; the server installs a Sentry-backed one.
    pub metrics: Arc<dyn metrics::MetricsSink>,
    pub tenant_limits: TenantLimits,
    /// Fuel charged by host functions for their own work; the rest of the fuel
    /// spent went to Wasm instructions. See [`fuel::charge_host_fuel`].
    pub host_fuel: u64,
    pub(crate) next_identity_hash: u64,
    #[cfg(test)]
    pub(crate) collection_index_reads: u64,
    #[cfg(test)]
    pub(crate) object_index_probes: u64,
    /// Host charges not yet applied to the engine's fuel (see
    /// [`fuel::HOST_FUEL_BATCH`]).
    pub host_fuel_pending: u64,
    /// The engine's fuel right after the last application of pending host
    /// charges; `None` before the first.
    pub host_fuel_applied_at: Option<u64>,
    /// Test-segment labels recorded by `submilli:test.label`, in call order.
    /// Only the test runner installs that host fn; an ordinary run leaves this
    /// empty. The runner reads it after `main()` returns to attribute the
    /// pass/fail outcome to the segment that was open at the time.
    pub test_labels: RefCell<Vec<String>>,
    /// Recovered runtime types + the prelude instance handle host functions use
    /// to build *real* `$string`/`$Array` structs (vtable + payload) instead of
    /// raw arrays. `None` until the prelude instantiates; set by
    /// `install_prelude_async`. See [`crate::runtime::host::HostAbi`].
    pub host_abi: Option<crate::runtime::host::HostAbi>,
    /// This store's intrinsic types, built on first use; see
    /// [`crate::runtime::intrinsic_types::intrinsic_types`].
    pub(crate) intrinsic_types: Option<Arc<crate::runtime::intrinsic_types::IntrinsicTypes>>,
    /// The JSON properties of each host-backed value's backing struct, built on
    /// first use; see [`crate::stdlib::abi::json_properties`].
    pub(crate) host_views: Option<HostViews>,
    /// An immutable global keeps the store's undefined value rooted across calls.
    pub(crate) undefined_value: Option<wasmtime::Global>,
    /// The bound-receiver closure environment type, built on first use for the
    /// same reason as [`Self::intrinsic_types`].
    pub(crate) closure_receiver_type: Option<wasmtime::StructType>,
    /// The call-metadata closure environment type, built on first use for the
    /// same reason as [`Self::intrinsic_types`].
    pub(crate) call_metadata_type: Option<wasmtime::StructType>,
    pub(crate) iterator_functions: [Option<wasmtime::Func>; 14],
    pub(crate) iterator_constants: [Option<wasmtime::Global>; 6],
    /// The object each static-dispatch binding is as a value, by its string
    /// form; see `prelude::object::static_value`.
    pub(crate) static_values: std::collections::BTreeMap<Vec<u16>, wasmtime::Global>,
    pub(crate) parameter_cache: prelude::arguments::ParameterCache,
    pub(crate) regex_input: Option<prelude::regex::input::InputCache>,
    /// Runtime type metadata keyed by package name.
    pub type_info: std::collections::BTreeMap<String, TypeInfoTable>,
    /// Depth of the in-flight universal-vtable walk; see
    /// [`MAX_VTABLE_WALK_DEPTH`].
    pub vtable_walk_depth: u32,
    /// Hook entries in the current outer structural walk, including repeated
    /// visits to shared children. Reset only when the outer walk finishes.
    pub(crate) vtable_walk_nodes: u32,
    /// Host-only result marshalling after an effect must not refuse for fuel.
    pub(crate) settling_host_result: bool,
    /// Denials the runtime threw, by thrown object; see [`host::ThrownDenials`].
    pub(crate) thrown_denials: host::ThrownDenials,
}

/// The nesting the universal-vtable walk allows before it reports a runaway.
///
/// Pinned to `serde_json`'s own recursion limit, which is what bounds
/// `JSON.parse`: a document the runtime is willing to parse must still be
/// comparable and re-serializable, or `JSON.parse` would accept graphs that
/// `JSON.stringify` then refuses. Measured headroom: a debug build on a 2 MB
/// test-harness thread aborts between 160 and 200 levels, so the bound sits
/// below the point where the native stack runs out.
pub(crate) const MAX_VTABLE_WALK_DEPTH: u32 = 128;

/// Bounds shared-substructure expansion independently of available fuel.
pub(crate) const MAX_STRUCTURAL_WALK_NODES: u32 = 100_000;

pub const DEFAULT_FS_MAX_READ_SIZE: u64 = 50 * 1024 * 1024;

pub const DEFAULT_HTTP_MAX_RESPONSE_SIZE: u64 = 50 * 1024 * 1024;

#[derive(Clone, Copy)]
pub struct LinkedPackageModule<'a> {
    pub module: &'a Module,
    pub declaration: &'a PackageDeclaration,
    pub type_info: &'a TypeInfoTable,
}

impl StoreData {
    pub fn with_vfs(run_id: RunId, vfs: Vfs) -> Self {
        Self::with_vfs_and_cap(run_id, vfs, DEFAULT_MAX_STORE_BYTES)
    }

    pub fn with_vfs_and_cap(run_id: RunId, vfs: Vfs, max_store_bytes: u64) -> Self {
        let vfs_info = VfsInfo {
            mode: vfs.mode(),
            size_limit: None,
        };
        Self {
            #[cfg(test)]
            array_growth: array_storage::GrowthStats::default(),
            console: Box::new(std::io::stderr()),
            filesystem: Arc::new(default_filesystem::DefaultFilesystem::new(
                vfs.clone(),
                run_id,
            )),
            effects: None,
            vfs,
            vfs_info,
            security_check: security::default_check(),
            git: None,
            git_history: None,
            blocking_work: blocking::BlockingWork::default(),
            fs_max_read_size: DEFAULT_FS_MAX_READ_SIZE,
            http_client: crate::stdlib::http::default_http_client(),
            http_max_response_size: DEFAULT_HTTP_MAX_RESPONSE_SIZE,
            http_max_download_timeout_ms: 60_000,
            auth_proxy: crate::stdlib::http::default_auth_proxy(),
            variables: Arc::default(),
            secret_provider: Arc::new(secrets::NoopSecretProvider),
            mcp_transport: None,
            tool_provider: None,
            approval_provider: None,
            clock_paused: std::time::Duration::ZERO,
            llm_provider: None,
            llm_budget: None,
            embedding_provider: None,
            embedding_budget: None,
            model_calls: Vec::new(),
            session_kv: None,
            session_finalizers: None,
            finalizing: false,
            cursor_keys: None,
            agent_provider: None,
            skill_provider: None,
            metrics: Arc::new(metrics::NoopMetricsSink),
            tenant_limits: TenantLimits::new(max_store_bytes),
            host_fuel: 0,
            #[cfg(test)]
            collection_index_reads: 0,
            #[cfg(test)]
            object_index_probes: 0,
            next_identity_hash: 0,
            host_fuel_pending: 0,
            host_fuel_applied_at: None,
            test_labels: RefCell::new(Vec::new()),
            host_abi: None,
            intrinsic_types: None,
            host_views: None,
            undefined_value: None,
            closure_receiver_type: None,
            call_metadata_type: None,
            iterator_functions: [None; 14],
            iterator_constants: [None; 6],
            static_values: std::collections::BTreeMap::new(),
            parameter_cache: Default::default(),
            regex_input: None,
            type_info: std::collections::BTreeMap::new(),
            vtable_walk_depth: 0,
            vtable_walk_nodes: 0,
            settling_host_result: false,
            thrown_denials: host::ThrownDenials::default(),
        }
    }

    pub fn install_type_info(&mut self, table: TypeInfoTable) {
        self.type_info.insert(table.package_name.clone(), table);
    }

    /// Live model dispatches in this attempt, in call order.
    ///
    /// Empty when none ran. A guest trap does not clear it: a call that already
    /// returned was billed. Read this after `dispatch_main_async`, before
    /// dropping the store. [`ModelCallUsage::summed_by_model`] folds it per model.
    pub fn model_calls(&self) -> &[ModelCallUsage] {
        &self.model_calls
    }

    /// Append one live dispatch. Only the provider action may call this.
    ///
    /// Replay restores the recorded outcome without running that action.
    /// Recording after `effects::execute` returns would bill the call again.
    pub(crate) fn note_model_call(&mut self, call: ModelCallUsage) {
        self.model_calls.push(call);
    }

    pub fn with_tempdir() -> std::io::Result<Self> {
        Ok(Self::with_vfs(RunId::generate()?, Vfs::tempdir()?))
    }
}

/// Instantiates each linked package module, running its module-level initializers.
///
/// Every thread polling this future must meet
/// [`RuntimeConfig::native_stack_size`]'s caller contract.
pub async fn install_package_modules_async(
    linker: &mut Linker<StoreData>,
    store: &mut Store<StoreData>,
    packages: &[LinkedPackageModule<'_>],
) -> wasmtime::Result<()> {
    for package in packages {
        let name = package.declaration.package_name.as_str();
        if store.data().git.is_none()
            && package
                .module
                .imports()
                .any(|import| import.module() == "submilli:git")
        {
            wasmtime::bail!(
                "package `{name}` imports submilli:git; configure the blueprint git block"
            );
        }
        // The module's declared name *is* its principal at every gated call, so bind it to the
        // name the package is being linked under. Without this, a prebuilt `pkg.wasm` naming
        // itself `main` — or naming another package — would be granted that principal's
        // permissions and, for `main`, the operator's injected credentials. The bytes are not
        // necessarily ones this compiler produced: `submilli run` and the server both
        // instantiate artifacts straight from the package store.
        match package.module.name() {
            Some(declared) if declared == name => {}
            Some(declared) => wasmtime::bail!(
                "package `{name}`: its module declares the name `{declared}`, which would give \
                 it that principal's permissions. Rebuild the package."
            ),
            None => wasmtime::bail!(
                "package `{name}`: its module declares no name, so its gated calls cannot be \
                 attributed. Rebuild the package."
            ),
        }
        store
            .data_mut()
            .install_type_info(package.type_info.clone());
        // Instantiation runs the package's module-level initializers. They are the
        // package's own code, executing in the package's own module, so identity read
        // off the running frame names them without any bracketing here.
        let instance = {
            let outcome = linker.instantiate_async(&mut *store, package.module).await;
            name_the_failing_initializer(&mut *store, name, outcome)?
        };
        linker.instance(&mut *store, name, instance)?;
    }
    Ok(())
}

/// Initializers run inside the Wasm start function, so anything they throw —
/// a denial most of all — escapes instantiation as the engine's opaque
/// `ThrownException`, whose Display is "wasm exception thrown". The thrown
/// value is still on the store, so recover its text the way an uncaught throw
/// from `main` is recovered and say which package it came from. Without this an
/// operator who granted a capability under `main:` rather than the package's own
/// block — the mistake this attribution makes easy — gets no package, no
/// capability, and no reason.
fn name_the_failing_initializer(
    store: &mut Store<StoreData>,
    package: &str,
    outcome: wasmtime::Result<Instance>,
) -> wasmtime::Result<Instance> {
    let err = match outcome {
        Ok(instance) => return Ok(instance),
        Err(err) => err,
    };
    let recovered = exec::uncaught_error(store, err);
    let Some(thrown) = recovered.downcast_ref::<crate::backtrace::ThrownError>() else {
        return Err(recovered);
    };
    Err(wasmtime::Error::new(crate::backtrace::ThrownError {
        message: format!(
            "package `{package}` failed to initialize: {}",
            thrown.message
        ),
        backtrace: thrown.backtrace.clone(),
        denial: thrown.denial.clone(),
    }))
}

/// Native stack bytes per byte of `max_wasm_stack`; see
/// [`RuntimeConfig::native_stack_size`].
const NATIVE_STACK_PER_WASM_BYTE: usize = 32;
const MIN_NATIVE_STACK: usize = 8 * 1024 * 1024;

#[derive(Clone, Debug)]
pub struct RuntimeConfig {
    pub fuel: u64,
    pub max_wasm_stack: usize,
    pub memory_reservation: u64,
    pub memory_guard_size: u64,
    pub memory_reservation_for_growth: u64,
    pub max_store_bytes: u64,
    pub timeout: Option<Duration>,
    pub async_yield_fuel: Option<u64>,
}

impl Default for RuntimeConfig {
    fn default() -> Self {
        Self {
            // Temporarily very high: large structural JSON.stringify and other
            // per-code-unit Wasm work still burns fuel, and exhausting it mid-run
            // is a worse failure than the loose runaway-loop bound this gives up.
            // The real CPU cap belongs in a wall-clock timeout; revisit once the
            // hot encoding paths are off the meter.
            fuel: 1_000_000_000_000,
            max_wasm_stack: 512 * 1024,
            memory_reservation: 3 * 1024 * 1024,
            memory_guard_size: 64 * 1024,
            memory_reservation_for_growth: 16 * 1024 * 1024,
            max_store_bytes: DEFAULT_MAX_STORE_BYTES,
            timeout: None,
            // 10K fuel ≈ ~10K wasm instructions. At the default fuel budget a
            // CPU-bound full-budget call yields thousands of times before
            // exhaustion — fine-grained enough for fair scheduling, coarse enough
            // that yield overhead stays negligible.
            async_yield_fuel: Some(10_000),
        }
    }
}

impl RuntimeConfig {
    /// The native stack a thread running programs under this config needs.
    ///
    /// `max_wasm_stack` is an interpreter budget, but a host call that re-enters
    /// Wasm (a callback passed to `map`, say) nests interpreter frames on the
    /// thread's own stack. The engine charges each crossing 4 KiB of the budget;
    /// this bounds re-entry depth, not the thread's available native stack. Debug
    /// builds have measured about 64 KiB per crossing, so this reservation allows
    /// 128 KiB per crossing, with an 8 MiB minimum for setup and shallow calls.
    ///
    /// Embedders must provide this stack on every thread that polls execution,
    /// including after an async task migrates between workers. The runners do not
    /// create a thread or inspect remaining stack space. Poll them near the root
    /// of the thread, rather than underneath deep native recursion. Undersized
    /// stacks can overflow and abort the process instead of returning a trap.
    /// Custom host functions must also bound their own native recursion.
    ///
    /// Set a Tokio runtime's `thread_stack_size` for worker threads. Its
    /// `block_on` caller runs on the calling thread, so size that thread separately
    /// (also for a current-thread runtime or `pollster::block_on`). Compilation
    /// separately requires [`crate::compiler_limits::COMPILER_STACK_BYTES`]; use
    /// the larger requirement when a thread performs both operations.
    pub fn native_stack_size(&self) -> usize {
        self.max_wasm_stack
            .saturating_mul(NATIVE_STACK_PER_WASM_BYTE)
            .max(MIN_NATIVE_STACK)
    }

    pub fn engine(&self) -> wasmtime::Result<Engine> {
        Engine::new(&self.wasmtime_config())
    }

    /// Same as [`engine`](Self::engine). `Config::async_support` is a no-op in
    /// wasmtime 44+; this entry point exists so async embedders have a distinct
    /// call site to evolve independently.
    pub fn engine_async(&self) -> wasmtime::Result<Engine> {
        Engine::new(&self.wasmtime_config())
    }

    pub fn wasmtime_config(&self) -> Config {
        let mut config = Config::new();
        // Winch lacks `wasm_gc` + `wasm_function_references`; Pulley is ~10× slower.
        // Strategy::Auto → Cranelift JIT.
        //
        // No optimization passes: the per-request user script is compiled fresh by
        // `Module::new` (it can't be AOT-cached — it's LLM-generated), and for
        // short-lived scripts that compile cost dominates the run. The trade is
        // global, though: precompiled prelude/stdlib share this engine, so they run
        // unoptimized too. TODO: precompile stdlib + curated packages on a separate
        // high-opt engine and `deserialize` the optimized artifacts here, so only the
        // user script pays the unoptimized-codegen tax.
        config.cranelift_opt_level(OptLevel::None);
        config.consume_fuel(true);
        config.max_wasm_stack(self.max_wasm_stack);

        config.epoch_interruption(true);

        config.memory_reservation(self.memory_reservation);
        config.memory_guard_size(self.memory_guard_size);
        config.memory_reservation_for_growth(self.memory_reservation_for_growth);
        config.memory_may_move(true);
        config.memory_init_cow(true);

        // The engine grants this reservation without consulting the store limiter.
        // Start at zero so every GC byte is charged to the tenant's aggregate cap,
        // including stores whose cap differs from this engine's RuntimeConfig.
        config.gc_heap_reservation(0);
        config.gc_heap_guard_size(self.memory_guard_size);
        config.gc_heap_reservation_for_growth(self.memory_reservation_for_growth);
        config.gc_heap_may_move(true);

        config.wasm_gc(true);
        config.wasm_function_references(true);
        config.wasm_exceptions(true);

        config.wasm_backtrace_details(WasmBacktraceDetails::Enable);

        config
    }

    pub fn store<T>(&self, engine: &Engine, data: T) -> wasmtime::Result<Store<T>> {
        let mut store = Store::new(engine, data);
        store.set_fuel(self.fuel)?;
        // With epoch_interruption(true), an unset deadline traps immediately.
        // Use 1 for watchdog-tripped timeouts, MAX to effectively disable.
        let delta = if self.timeout.is_some() { 1 } else { u64::MAX };
        store.set_epoch_deadline(delta);
        store.epoch_deadline_trap();
        Ok(store)
    }

    pub fn store_async<T>(&self, engine: &Engine, data: T) -> wasmtime::Result<Store<T>> {
        let mut store = self.store(engine, data)?;
        store.fuel_async_yield_interval(self.async_yield_fuel)?;
        Ok(store)
    }

    /// Arm the configured timeout, failing setup if its thread cannot be created.
    /// Keep the returned guard alive until guest execution finishes.
    pub fn arm_timeout(&self, engine: &Engine) -> wasmtime::Result<Option<Watchdog>> {
        self.timeout
            .map(|duration| watchdog::arm(engine, duration))
            .transpose()
            .map_err(|error| {
                wasmtime::Error::from(error).context("starting execution timeout watchdog")
            })
    }

    /// One-shot runner: load compiled Wasm, instantiate, call `main`, return typed result
    /// and captured console. Async like the rest of the runtime — a caller that
    /// isn't on a runtime bridges it itself (`pollster::block_on` for pure
    /// computation, a Tokio runtime for filesystem or HTTP operations). For
    /// live console streaming, build a custom `Store<StoreData>` and call
    /// [`dispatch_main_async`] directly.
    ///
    /// # Native stack
    ///
    /// Every thread polling this future must meet [`Self::native_stack_size`]'s
    /// caller contract. This method does not provision a stack. Compilation
    /// separately requires [`crate::compiler_limits::COMPILER_STACK_BYTES`].
    pub async fn run(&self, wasm_bytes: &[u8]) -> wasmtime::Result<RunResult> {
        self.run_with_type_info(wasm_bytes, None).await
    }

    /// Runs a compiled script with its result type information and captured console.
    ///
    /// # Native stack
    ///
    /// Every thread polling this future must meet [`Self::native_stack_size`]'s
    /// caller contract, just as for [`Self::run`]. Compiling the script separately
    /// requires [`crate::compiler_limits::COMPILER_STACK_BYTES`].
    pub async fn run_compiled(
        &self,
        compiled: &crate::compile::CompiledScript,
    ) -> wasmtime::Result<RunResult> {
        self.run_with_type_info(&compiled.wasm, Some(compiled.type_info.clone()))
            .await
    }

    async fn run_with_type_info(
        &self,
        wasm_bytes: &[u8],
        type_info: Option<TypeInfoTable>,
    ) -> wasmtime::Result<RunResult> {
        let buf = Arc::new(Mutex::new(Vec::new()));
        let mut data =
            StoreData::with_vfs_and_cap(RunId::generate()?, Vfs::tempdir()?, self.max_store_bytes);
        data.console = Box::new(ConsoleSink(Arc::clone(&buf)));
        if let Some(type_info) = type_info {
            data.install_type_info(type_info);
        }
        let engine = self.engine()?;
        let mut store = self.store_async(&engine, data)?;
        install_tenant_limits(&mut store);
        let module = Module::new(&engine, wasm_bytes)?;
        let mut linker = Linker::<StoreData>::new(&engine);
        install_runtime_async(&mut linker, &mut store).await?;
        let _watchdog = self.arm_timeout(&engine)?;
        let inst = instantiate_program_async(&linker, &mut store, &module).await?;
        let value = dispatch_main_async(&mut store, &inst).await?;
        // A poisoned ConsoleSink may contain output from an interrupted write.
        // AGENTS.md permits this poisoned-lock panic instead of recovering partial
        // output; it does not permit the panic that caused poisoning.
        let captured = buf.lock().expect("console buffer lock poisoned").clone();
        let console = String::from_utf8(captured)
            .map_err(|e| wasmtime::Error::msg(format!("console output not utf-8: {e}")))?;
        Ok(RunResult { value, console })
    }
}

// A panic during writing may leave partial console output. AGENTS.md permits
// panicking on poisoned access instead of recovering it; the panic that caused
// poisoning is still subject to the no-panic policy.
struct ConsoleSink(Arc<Mutex<Vec<u8>>>);

impl Write for ConsoleSink {
    fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
        self.0
            .lock()
            .expect("console buffer lock poisoned")
            .write(buf)
    }

    fn flush(&mut self) -> std::io::Result<()> {
        Ok(())
    }
}

/// Decode a Submilli `(ref $string)` (packed UTF-16) into a Rust `String`.
pub(crate) fn read_submilli_string(
    mut ctx: impl AsContextMut<Data = StoreData>,
    msg: Rooted<ArrayRef>,
) -> wasmtime::Result<String> {
    let units = host::read_code_units(&mut ctx, msg, "string")?;
    fuel::charge(ctx, fuel::SCAN, units.len() as u64)?;
    Ok(String::from_utf16_lossy(&units))
}