A lightweight WebAssembly runtime that is fast, secure, and standards-compliant
//! Support for the component model in Wasmtime.
//!
//! This module contains all of the internal type definitions used by Wasmtime
//! to process the component model. Despite everything being `pub` here this is
//! not the public interface of Wasmtime to the component model. Instead this is
//! the internal support to mirror the core wasm support that Wasmtime already
//! implements.
//!
//! Some main items contained within here are:
//!
//! * Type hierarchy information for the component model
//! * Translation of a component into Wasmtime's representation
//! * Type information about a component used at runtime
//!
//! This module also contains a lot of Serialize/Deserialize types which are
//! encoded in the final compiled image for a component.
//!
//! Note that this entire module is gated behind the `component-model` Cargo
//! feature.
/// Canonical ABI-defined constant for the maximum number of "flat" parameters
/// to a wasm function, or the maximum number of parameters a core wasm function
/// will take for just the parameters used. Over this number the heap is used
/// for transferring parameters.
pub const MAX_FLAT_PARAMS: usize = 16;
/// Similar to `MAX_FLAT_PARAMS`, but used for async-lowered imports instead of
/// sync ones.
pub const MAX_FLAT_ASYNC_PARAMS: usize = 4;
/// Canonical ABI-defined constant for the maximum number of "flat" results.
/// This number of results are returned directly from wasm and otherwise results
/// are transferred through memory.
pub const MAX_FLAT_RESULTS: usize = 1;
/// Sentinel value in `result_count_or_max_if_async` as part of the
/// `prepare_call` libcall which indicates that preparation is being done for an
/// async function that produces no result, aka there is no return pointer.
pub const PREPARE_ASYNC_NO_RESULT: u32 = u32::MAX;
/// Sentinel value in `result_count_or_max_if_async` as part of the
/// `prepare_call` libcall which indicates that preparation is being done for an
/// async function that produces at least one result, aka there is a return
/// pointer.
pub const PREPARE_ASYNC_WITH_RESULT: u32 = u32::MAX - 1;
/// Bit flag for indicating async-lifted exports
///
/// This flag may be passed to the `start-call` built-in function to indicate
/// that the callee is an async-lifted export.
pub const START_FLAG_ASYNC_CALLEE: i32 = 1 << 0;
/// Bit flag for indicating async-lowered imports
///
/// This flag may be passed to the `start-call` built-in function to indicate
/// that the caller is an async-lowered import, in which case the call's status
/// is returned rather than blocking until the callee produces its results.
pub const START_FLAG_ASYNC_CALLER: i32 = 1 << 1;
mod artifacts;
mod info;
mod intrinsic;
mod names;
mod types;
mod vmcomponent_offsets;
pub use self::artifacts::*;
pub use self::info::*;
pub use self::intrinsic::*;
pub use self::names::*;
pub use self::types::*;
pub use self::vmcomponent_offsets::*;
#[cfg(feature = "compile")]
mod compiler;
#[cfg(feature = "compile")]
pub mod dfg;
#[cfg(feature = "compile")]
mod same_vmctx;
#[cfg(feature = "compile")]
mod thread_transparency;
#[cfg(feature = "compile")]
mod translate;
#[cfg(feature = "compile")]
mod types_builder;
#[cfg(feature = "compile")]
pub use self::compiler::*;
#[cfg(feature = "compile")]
pub use self::same_vmctx::analyze_same_vmctx_imports;
#[cfg(feature = "compile")]
pub use self::thread_transparency::transparent_adapters;
#[cfg(feature = "compile")]
pub use self::translate::*;
#[cfg(feature = "compile")]
pub use self::types_builder::*;
/// Helper macro, like `foreach_transcoder`, to iterate over builtins for
/// components unrelated to transcoding.
#[macro_export]
macro_rules! foreach_builtin_component_function {
($mac:ident) => {
$mac! {
resource_new32(vmctx: vmctx, caller_instance: u32, resource: u32, rep: u32) -> u64;
resource_rep32(vmctx: vmctx, caller_instance: u32, resource: u32, idx: u32) -> u64;
// Returns an `Option<u32>` where `None` is "no destructor needed"
// and `Some(val)` is "run the destructor on this rep". The option
// is encoded as a 64-bit integer where the low bit is Some/None
// and bits 1-33 are the payload.
resource_drop(vmctx: vmctx, caller_instance: u32, resource: u32, idx: u32) -> u64;
resource_transfer_own(vmctx: vmctx, src_idx: u32, src_table: u32, dst_table: u32) -> u64;
resource_transfer_borrow(vmctx: vmctx, src_idx: u32, src_table: u32, dst_table: u32) -> u64;
// Same as `resource_transfer_borrow` but for when the destination
// instance owns the resource, in which case it receives the
// representation directly and no destination table is involved.
resource_transfer_borrow_to_owner(vmctx: vmctx, src_table: u32, src_idx: u32) -> u64;
enter_sync_call(vmctx: vmctx, callee_async: u32, callee_instance: u32) -> bool;
exit_sync_call(vmctx: vmctx) -> bool;
// Returns the store's hostcall fuel.
hostcall_fuel(vmctx: vmctx) -> u64;
#[cfg(feature = "component-model-async")]
backpressure_modify(vmctx: vmctx, caller_instance: u32, increment: u8) -> bool;
#[cfg(feature = "component-model-async")]
task_return(vmctx: vmctx, caller_instance: u32, ty: u32, options: u32, storage: ptr_u8, storage_len: size) -> bool;
#[cfg(feature = "component-model-async")]
task_cancel(vmctx: vmctx, caller_instance: u32) -> bool;
#[cfg(feature = "component-model-async")]
waitable_set_new(vmctx: vmctx, caller_instance: u32) -> u64;
// FIXME(#4311): `payload` needs to be a `u64` for memory64
#[cfg(feature = "component-model-async")]
waitable_set_wait(vmctx: vmctx, caller_instance: u32, options: u32, set: u32, payload: u32) -> u64;
// FIXME(#4311): `payload` needs to be a `u64` for memory64
#[cfg(feature = "component-model-async")]
waitable_set_poll(vmctx: vmctx, caller_instance: u32, options: u32, set: u32, payload: u32) -> u64;
#[cfg(feature = "component-model-async")]
waitable_set_drop(vmctx: vmctx, caller_instance: u32, set: u32) -> bool;
#[cfg(feature = "component-model-async")]
waitable_join(vmctx: vmctx, caller_instance: u32, set: u32, waitable: u32) -> bool;
#[cfg(feature = "component-model-async")]
subtask_drop(vmctx: vmctx, caller_instance: u32, task_id: u32) -> bool;
#[cfg(feature = "component-model-async")]
subtask_cancel(vmctx: vmctx, caller_instance: u32, async_: u8, task_id: u32) -> u64;
#[cfg(feature = "component-model-async")]
prepare_call(
vmctx: vmctx,
memory: ptr_u8,
start: ptr_u8,
return_: ptr_u8,
caller_instance: u32,
callee_instance: u32,
task_return_type: u32,
callee_async: u32,
string_encoding: u32,
result_count_or_max_if_async: u32,
storage: ptr_u8,
storage_len: size
) -> bool;
#[cfg(feature = "component-model-async")]
start_call(vmctx: vmctx, callback: ptr_u8, post_return: ptr_u8, storage: ptr_u8, storage_len: size, callee: ptr_u8, param_count: u32, result_count: u32, flags: u32) -> bool;
#[cfg(feature = "component-model-async")]
future_new(vmctx: vmctx, caller_instance: u32, ty: u32) -> u64;
// FIXME(#4311): `address` needs to be a `u64` for memory64
#[cfg(feature = "component-model-async")]
future_write(vmctx: vmctx, caller_instance: u32, ty: u32, options: u32, future: u32, address: u32) -> u64;
// FIXME(#4311): `address` needs to be a `u64` for memory64
#[cfg(feature = "component-model-async")]
future_read(vmctx: vmctx, caller_instance: u32, ty: u32, options: u32, future: u32, address: u32) -> u64;
#[cfg(feature = "component-model-async")]
future_cancel_write(vmctx: vmctx, caller_instance: u32, ty: u32, async_: u8, writer: u32) -> u64;
#[cfg(feature = "component-model-async")]
future_cancel_read(vmctx: vmctx, caller_instance: u32, ty: u32, async_: u8, reader: u32) -> u64;
#[cfg(feature = "component-model-async")]
future_drop_writable(vmctx: vmctx, caller_instance: u32, ty: u32, writer: u32) -> bool;
#[cfg(feature = "component-model-async")]
future_drop_readable(vmctx: vmctx, caller_instance: u32, ty: u32, reader: u32) -> bool;
#[cfg(feature = "component-model-async")]
stream_new(vmctx: vmctx, caller_instance: u32, ty: u32) -> u64;
// FIXME(#4311): `address` and `count` need to be `u64`s for memory64
#[cfg(feature = "component-model-async")]
stream_write(vmctx: vmctx, caller_instance: u32, ty: u32, options: u32, stream: u32, address: u32, count: u32) -> u64;
// FIXME(#4311): `address` and `count` need to be `u64`s for memory64
#[cfg(feature = "component-model-async")]
stream_read(vmctx: vmctx, caller_instance: u32, ty: u32, options: u32, stream: u32, address: u32, count: u32) -> u64;
#[cfg(feature = "component-model-async")]
stream_cancel_write(vmctx: vmctx, caller_instance: u32, ty: u32, async_: u8, writer: u32) -> u64;
#[cfg(feature = "component-model-async")]
stream_cancel_read(vmctx: vmctx, caller_instance: u32, ty: u32, async_: u8, reader: u32) -> u64;
#[cfg(feature = "component-model-async")]
stream_drop_writable(vmctx: vmctx, caller_instance: u32, ty: u32, writer: u32) -> bool;
#[cfg(feature = "component-model-async")]
stream_drop_readable(vmctx: vmctx, caller_instance: u32, ty: u32, reader: u32) -> bool;
// FIXME(#4311): `address` and `count` need to be `u64`s for memory64
#[cfg(feature = "component-model-async")]
flat_stream_write(vmctx: vmctx, caller_instance: u32, ty: u32, options:u32, payload_size: u32, payload_align: u32, stream: u32, address: u32, count: u32) -> u64;
// FIXME(#4311): `address` and `count` need to be `u64`s for memory64
#[cfg(feature = "component-model-async")]
flat_stream_read(vmctx: vmctx, caller_instance: u32, ty: u32, options: u32, payload_size: u32, payload_align: u32, stream: u32, address: u32, count: u32) -> u64;
// FIXME(#4311): `debug_msg_address` and `debug_msg_len` need to be `u64`s for memory64
#[cfg(feature = "component-model-async")]
error_context_new(vmctx: vmctx, caller_instance: u32, ty: u32, options: u32, debug_msg_address: u32, debug_msg_len: u32) -> u64;
// FIXME(#4311): `debug_msg_address` needs to be a `u64` for memory64
#[cfg(feature = "component-model-async")]
error_context_debug_message(vmctx: vmctx, caller_instance: u32, ty: u32, options: u32, err_ctx_handle: u32, debug_msg_address: u32) -> bool;
#[cfg(feature = "component-model-async")]
error_context_drop(vmctx: vmctx, caller_instance: u32, ty: u32, err_ctx_handle: u32) -> bool;
#[cfg(feature = "component-model-async")]
future_transfer(vmctx: vmctx, src_idx: u32, src_table: u32, dst_table: u32) -> u64;
#[cfg(feature = "component-model-async")]
stream_transfer(vmctx: vmctx, src_idx: u32, src_table: u32, dst_table: u32) -> u64;
#[cfg(feature = "component-model-async")]
error_context_transfer(vmctx: vmctx, src_idx: u32, src_table: u32, dst_table: u32) -> u64;
#[cfg(feature = "component-model-async")]
thread_index(vmctx: vmctx) -> u64;
// FIXME(#4311): `func_idx` and `context` need to be `u64` for
// 64-bit tables and `i64` closures
#[cfg(feature = "component-model-async")]
thread_new_indirect(vmctx: vmctx, caller_instance: u32, func_ty_id: u32, func_table_idx: u32, func_idx: u32, context: u32) -> u64;
#[cfg(feature = "component-model-async")]
thread_resume_later(vmctx: vmctx, caller_instance: u32, thread_idx: u32) -> bool;
#[cfg(feature = "component-model-async")]
thread_suspend(vmctx: vmctx, caller_instance: u32) -> u32;
#[cfg(feature = "component-model-async")]
thread_yield(vmctx: vmctx, caller_instance: u32) -> u32;
#[cfg(feature = "component-model-async")]
thread_suspend_then_resume(vmctx: vmctx, caller_instance: u32, thread_idx: u32) -> u32;
#[cfg(feature = "component-model-async")]
thread_yield_then_resume(vmctx: vmctx, caller_instance: u32, thread_idx: u32) -> u32;
#[cfg(feature = "component-model-async")]
thread_suspend_then_promote(vmctx: vmctx, caller_instance: u32, thread_idx: u32) -> u32;
#[cfg(feature = "component-model-async")]
thread_yield_then_promote(vmctx: vmctx, caller_instance: u32, thread_idx: u32) -> u32;
utf8_to_utf8(vmctx: vmctx, src: ptr_u8, len: size, dst: ptr_u8) -> bool;
utf16_to_utf16(vmctx: vmctx, src: ptr_u16, len: size, dst: ptr_u16) -> bool;
latin1_to_latin1(vmctx: vmctx, src: ptr_u8, len: size, dst: ptr_u8) -> bool;
latin1_to_utf16(vmctx: vmctx, src: ptr_u8, len: size, dst: ptr_u16) -> bool;
utf8_to_utf16(vmctx: vmctx, src: ptr_u8, len: size, dst: ptr_u16) -> size;
utf16_to_utf8(vmctx: vmctx, src: ptr_u16, src_len: size, dst: ptr_u8, dst_len: size, first_pass: u32, ret2: ptr_size) -> size;
latin1_to_utf8(vmctx: vmctx, src: ptr_u8, src_len: size, dst: ptr_u8, dst_len: size, first_pass: u32, ret2: ptr_size) -> size;
utf16_to_compact_probably_utf16(vmctx: vmctx, src: ptr_u16, len: size, dst: ptr_u16) -> size;
utf8_to_latin1(vmctx: vmctx, src: ptr_u8, len: size, dst: ptr_u8, ret2: ptr_size) -> size;
utf16_to_latin1(vmctx: vmctx, src: ptr_u16, len: size, dst: ptr_u8, ret2: ptr_size) -> size;
utf8_to_compact_utf16(vmctx: vmctx, src: ptr_u8, src_len: size, dst: ptr_u16, dst_len: size, bytes_so_far: size) -> size;
utf16_to_compact_utf16(vmctx: vmctx, src: ptr_u16, src_len: size, dst: ptr_u16, dst_len: size, bytes_so_far: size) -> size;
}
};
}
// Define `struct ComponentBuiltinFunctionIndex`
declare_builtin_index! {
/// An index type for component builtin functions.
pub struct ComponentBuiltinFunctionIndex: foreach_builtin_component_function;
}