wit_dylib/

lib.rs

use std::borrow::Cow;
use std::collections::{HashMap, HashSet};
use std::mem;
use wasm_encoder::{
    CodeSection, ConstExpr, CustomSection, DataSection, ElementSection, Elements, Encode,
    EntityType, ExportKind, ExportSection, Function, FunctionSection, GlobalType, ImportSection,
    MemoryType, Module, NameMap, NameSection, RefType, TableType, TypeSection, ValType,
};
use wit_parser::abi::{WasmSignature, WasmType};
use wit_parser::{
    Handle, LiftLowerAbi, LiveTypes, ManglingAndAbi, Resolve, ResourceIntrinsic, SizeAlign, Type,
    TypeDefKind, TypeId, TypeOwner, WasmExport, WasmExportKind, WasmImport, WorldId, WorldItem,
    WorldKey,
};

mod async_;
mod bindgen;
pub mod metadata;
pub use crate::async_::AsyncFilterSet;
pub use crate::metadata::Metadata;

pub const C_HEADER: &'static str = include_str!("../wit_dylib.h");

#[derive(Default, Clone, Debug)]
#[cfg_attr(feature = "clap", derive(clap::Parser))]
pub struct DylibOpts {
    /// The interpreter name to insert into the `WASM_DYLINK_NEEDED` section
    /// encoded as `dylink.0`.
    #[cfg_attr(feature = "clap", clap(long, value_name = "name"))]
    pub interpreter: Option<String>,

    #[cfg_attr(feature = "clap", clap(flatten))]
    pub async_: AsyncFilterSet,

    /// Where the stack pointer is located in the ABI of the generated dylib.
    ///
    /// For WASIp2-and-prior the `global` option should be used, and for
    /// WASIp3-and-later the `task-context` option should be used.
    #[cfg_attr(
        feature = "clap",
        clap(long, value_name = "loc", default_value = "global")
    )]
    pub stack_pointer: StackPointer,
}

#[derive(Default, Clone, Debug)]
#[cfg_attr(feature = "clap", derive(clap::ValueEnum))]
pub enum StackPointer {
    #[default]
    Global,
    TaskContext,
}

pub fn create(
    resolve: &Resolve,
    world_id: WorldId,
    opts: Option<&mut DylibOpts>,
) -> anyhow::Result<Vec<u8>> {
    Ok(create_with_metadata(resolve, world_id, opts)?.0)
}

pub fn create_with_metadata(
    resolve: &Resolve,
    world_id: WorldId,
    mut opts: Option<&mut DylibOpts>,
) -> anyhow::Result<(Vec<u8>, Metadata)> {
    let mut adapter = Adapter::default();
    if let Some(opts) = &mut opts {
        adapter.opts = opts.clone();
    }
    let result = adapter.encode(resolve, world_id)?;
    if let Some(opts) = &mut opts {
        **opts = adapter.opts;
    }
    Ok((result, adapter.metadata))
}

#[derive(Default)]
struct Adapter {
    types: TypeSection,
    wasm_type_map: HashMap<(Vec<ValType>, Vec<ValType>), u32>,
    imports: ImportSection,
    imports_done: bool,
    global_index: u32,
    table_base: Option<u32>,
    memory_base: Option<u32>,
    stack_pointer: Option<ImportedStackPointer>,
    func_index: u32,
    functions: FunctionSection,
    exports: ExportSection,
    code: CodeSection,
    global_names: NameMap,
    function_names: NameMap,
    metadata: Metadata,
    type_map: HashMap<TypeId, metadata::Type>,
    resource_map: HashMap<TypeId, usize>,
    export_resource_map: HashMap<TypeId, usize>,
    intrinsics: Option<bindgen::WitInterpreterIntrinsics>,
    sizes: SizeAlign,
    opts: DylibOpts,

    /// Contents of the element segment of this module, which will start at
    /// `__table_base`.
    ///
    /// Elements of this list are function indices in this module which will be
    /// placed into the element segment.
    elem_segment: Vec<u32>,
}

#[derive(Copy, Clone)]
enum ImportedStackPointer {
    Global(u32),
    TaskContext { get: u32, set: u32 },
}

#[derive(Default)]
struct Imports<'a> {
    wit_imports: Vec<WitImport<'a>>,
    wit_exports: Vec<WitExport<'a>>,
}

struct WitImport<'a> {
    interface: Option<&'a WorldKey>,
    func: &'a wit_parser::Function,
    import_index: u32,
}

struct WitExport<'a> {
    interface: Option<&'a WorldKey>,
    func: &'a wit_parser::Function,
    async_task_return_index: Option<u32>,
}

/// Represents data for a given `stream<T>` or `future<T>` as referenced by an
/// imported or exported function by way of its parameter list or result.
struct PayloadData {
    /// `{stream|future}.new` import
    new_elem_index: u32,
    /// `{stream|future}.read` import
    read_elem_index: u32,
    /// `{stream|future}.write` import
    write_elem_index: u32,
    /// `{stream|future}.cancel-read` import
    cancel_read_elem_index: u32,
    /// `{stream|future}.cancel-write` import
    cancel_write_elem_index: u32,
    /// `{stream|future}.drop-readable` import
    drop_readable_elem_index: u32,
    /// `{stream|future}.drop-writable` import
    drop_writable_elem_index: u32,
    /// Position of this `stream<T>` or `future<T>` in the function's signature
    /// relative to any other `stream`s or `future`s.  See
    /// `wit_parser::Function::find_futures_and_streams` for details.
    ordinal: usize,
    /// Name of the function with the signature in which this `stream<T>` or
    /// `future<T>` was found.
    function: String,
}

impl Adapter {
    pub fn encode(&mut self, resolve: &Resolve, world_id: WorldId) -> anyhow::Result<Vec<u8>> {
        self.sizes.fill(resolve)?;

        // First define all imports that will go into the wasm module since
        // they're required to be first in their index spaces anyway. This will
        // import intrinsics necessary for exported resources, for example, as
        // well.
        let imports = self.add_imports(resolve, world_id);

        let mut payload_data = HashMap::new();
        self.collect_payload_data(resolve, world_id, &mut payload_data);

        self.imports_done = true;

        // Ensure that `cabi_realloc` is reexported from our module to indicate
        // that our module's allocations are routed through the same
        // `cabi_realloc` we're importing.
        let cabi_realloc = self.intrinsics().cabi_realloc;
        self.exports
            .export("cabi_realloc", ExportKind::Func, cabi_realloc);

        // Generate/add metadata for all functions that are either imported or
        // exported.
        self.bindgen_world(resolve, world_id, &imports, &payload_data);

        // Now that all functions have been learned about the metadata data
        // segment can be finalized and emitted. Here this additionally invokes
        // the interpreter initialization function as part of a ctor to ensure
        // that the interpreter is aware of where metadata ended up in linear
        // memory.
        let (metadata_offset, metadata) = self.encode_metadata();
        let mut ctor = Function::new([]);
        ctor.instructions().i32_const(metadata_offset as i32);
        ctor.instructions().global_get(self.memory_base());
        ctor.instructions().i32_add();
        ctor.instructions().call(self.intrinsics().initialize);
        ctor.instructions().end();
        let ty = self.define_ty([], []);
        self.define_func("__wasm_call_ctors", ty, ctor, true);

        Ok(self.finish(&metadata))
    }

    fn mangling(
        &mut self,
        resolve: &Resolve,
        interface: Option<&WorldKey>,
        func: &wit_parser::Function,
        is_import: bool,
    ) -> ManglingAndAbi {
        let abi = if self
            .opts
            .async_
            .is_async(resolve, interface, func, is_import)
        {
            LiftLowerAbi::AsyncCallback
        } else {
            LiftLowerAbi::Sync
        };
        ManglingAndAbi::Legacy(abi)
    }

    fn resource_intrinsic_mangling(&mut self) -> ManglingAndAbi {
        ManglingAndAbi::Legacy(LiftLowerAbi::Sync)
    }

    /// Scan the specified function for any `stream` or `future` types in the
    /// parameter list or result, importing the necessary intrinsics for each
    /// one found and inserting them into `data` for later reference.
    fn collect_payload_data_for_func(
        &mut self,
        resolve: &Resolve,
        interface: Option<&WorldKey>,
        func: &wit_parser::Function,
        prefix: &str,
        data: &mut HashMap<TypeId, PayloadData>,
    ) {
        let mut make = |arg_count, kind, ordinal| {
            let module = format!(
                "{prefix}{}",
                interface
                    .map(|name| resolve.name_world_key(name))
                    .unwrap_or_else(|| "$root".into())
            );
            let function = func.name.clone();

            let import = |me: &mut Self, prefix, name, params, results| {
                let ty = me.define_ty(params, results);
                let import = me.import_func(
                    &module,
                    &format!("{prefix}[{kind}-{name}-{ordinal}]{function}"),
                    ty,
                );
                me.push_elem(import)
            };

            let new_elem_index = import(self, "", "new", vec![], vec![ValType::I64]);
            let read_elem_index = import(
                self,
                "[async-lower]",
                "read",
                vec![ValType::I32; arg_count],
                vec![ValType::I32],
            );
            let write_elem_index = import(
                self,
                "[async-lower]",
                "write",
                vec![ValType::I32; arg_count],
                vec![ValType::I32],
            );
            let cancel_read_elem_index = import(
                self,
                "",
                "cancel-read",
                vec![ValType::I32],
                vec![ValType::I32],
            );
            let cancel_write_elem_index = import(
                self,
                "",
                "cancel-write",
                vec![ValType::I32],
                vec![ValType::I32],
            );
            let drop_readable_elem_index =
                import(self, "", "drop-readable", vec![ValType::I32], vec![]);
            let drop_writable_elem_index =
                import(self, "", "drop-writable", vec![ValType::I32], vec![]);

            PayloadData {
                new_elem_index,
                read_elem_index,
                write_elem_index,
                cancel_read_elem_index,
                cancel_write_elem_index,
                drop_readable_elem_index,
                drop_writable_elem_index,
                ordinal,
                function,
            }
        };

        for (ordinal, ty) in func
            .find_futures_and_streams(resolve)
            .into_iter()
            .enumerate()
        {
            match &resolve.types[ty].kind {
                TypeDefKind::Future(_) => {
                    data.entry(ty).or_insert_with(|| make(2, "future", ordinal))
                }
                TypeDefKind::Stream(_) => {
                    data.entry(ty).or_insert_with(|| make(3, "stream", ordinal))
                }
                _ => unreachable!(),
            };
        }
    }

    fn collect_payload_data(
        &mut self,
        resolve: &Resolve,
        world_id: WorldId,
        data: &mut HashMap<TypeId, PayloadData>,
    ) {
        let world = &resolve.worlds[world_id];

        for (key, import) in world.imports.iter() {
            match import {
                WorldItem::Interface { id, .. } => {
                    for (_, func) in resolve.interfaces[*id].functions.iter() {
                        self.collect_payload_data_for_func(resolve, Some(key), func, "", data);
                    }
                }
                WorldItem::Type { .. } => {}
                WorldItem::Function(func) => {
                    self.collect_payload_data_for_func(resolve, None, func, "", data);
                }
            }
        }

        for (key, export) in world.exports.iter() {
            match export {
                WorldItem::Interface { id, .. } => {
                    for (_, func) in resolve.interfaces[*id].functions.iter() {
                        self.collect_payload_data_for_func(
                            resolve,
                            Some(key),
                            func,
                            "[export]",
                            data,
                        );
                    }
                }
                WorldItem::Type { .. } => unreachable!(),
                WorldItem::Function(func) => {
                    self.collect_payload_data_for_func(resolve, None, func, "[export]", data);
                }
            }
        }
    }

    fn add_imports<'a>(&mut self, resolve: &'a Resolve, world_id: WorldId) -> Imports<'a> {
        let mut ret = Imports::default();
        let world = &resolve.worlds[world_id];

        // First up import everything from the interpreter itself that we're
        // going to possibly need.
        self.intrinsics = Some(bindgen::WitInterpreterIntrinsics::new(self));

        // Generate function imports for all world imports, in addition to
        // intrinsics for all resources imported as well. This will additionally
        // populate the `Imports` return value with all functions that were
        // found.
        for (interface, import) in world.imports.iter() {
            match import {
                WorldItem::Interface { id, .. } => {
                    for (_, func) in resolve.interfaces[*id].functions.iter() {
                        self.add_imported_func(resolve, Some(interface), func, &mut ret);
                    }
                    for (_, ty) in resolve.interfaces[*id].types.iter() {
                        self.add_imported_type_intrinsics(resolve, Some(interface), *ty);
                    }
                }
                WorldItem::Type { id, .. } => {
                    self.add_imported_type_intrinsics(resolve, None, *id);
                }
                WorldItem::Function(func) => {
                    self.add_imported_func(resolve, None, func, &mut ret);
                }
            }
        }

        // Exported resources need to have intrinsics imported for manipulation,
        // so do so here.
        for (name, export) in world.exports.iter() {
            match export {
                WorldItem::Function(func) => {
                    self.add_imported_func_intrinsics_for_export(resolve, None, func, &mut ret);
                }
                WorldItem::Interface { id: export, .. } => {
                    for (_, ty) in resolve.interfaces[*export].types.iter() {
                        self.add_imported_type_intrinsics_for_export(resolve, Some(name), *ty);
                    }
                    for (_, func) in resolve.interfaces[*export].functions.iter() {
                        self.add_imported_func_intrinsics_for_export(
                            resolve,
                            Some(name),
                            func,
                            &mut ret,
                        );
                    }
                }
                WorldItem::Type { .. } => unreachable!(),
            }
        }

        let const_i32_global = GlobalType {
            val_type: ValType::I32,
            mutable: false,
            shared: false,
        };
        let mut_i32_global = GlobalType {
            val_type: ValType::I32,
            mutable: true,
            shared: false,
        };

        self.table_base = Some(self.import_global("env", "__table_base", const_i32_global));
        self.memory_base = Some(self.import_global("env", "__memory_base", const_i32_global));
        self.stack_pointer = Some(match self.opts.stack_pointer {
            StackPointer::Global => ImportedStackPointer::Global(self.import_global(
                "env",
                "__stack_pointer",
                mut_i32_global,
            )),
            StackPointer::TaskContext => {
                let get_ty = self.define_ty([], [ValType::I32]);
                let set_ty = self.define_ty([ValType::I32], []);
                ImportedStackPointer::TaskContext {
                    get: self.import_func("$root", "[context-get-0]", get_ty),
                    set: self.import_func("$root", "[context-set-0]", set_ty),
                }
            }
        });

        self.imports.import(
            "env",
            "memory",
            EntityType::Memory(MemoryType {
                minimum: 0,
                maximum: None,
                memory64: false,
                shared: false,
                page_size_log2: None,
            }),
        );

        self.imports.import(
            "env",
            "__indirect_function_table",
            EntityType::Table(TableType {
                element_type: RefType::FUNCREF,
                minimum: 0,
                maximum: None,
                table64: false,
                shared: false,
            }),
        );
        ret
    }

    fn add_imported_func<'a>(
        &mut self,
        resolve: &'a Resolve,
        interface: Option<&'a WorldKey>,
        func: &'a wit_parser::Function,
        imports: &mut Imports<'a>,
    ) {
        let mangling = self.mangling(resolve, interface, func, true);
        let (module, name) =
            resolve.wasm_import_name(mangling, WasmImport::Func { interface, func });
        let sig = resolve.wasm_signature(mangling.import_variant(), func);
        let ty = self.define_wasm_sig(sig);
        let import_index = self.import_func(&module, &name, ty);
        imports.wit_imports.push(WitImport {
            func,
            interface,
            import_index,
        });
    }

    fn add_imported_type_intrinsics<'a>(
        &mut self,
        resolve: &Resolve,
        interface: Option<&'a WorldKey>,
        id: TypeId,
    ) {
        let mangling = self.resource_intrinsic_mangling();
        let ty = &resolve.types[id];
        match ty.kind {
            TypeDefKind::Resource => {
                let (module, name) = resolve.wasm_import_name(
                    mangling,
                    WasmImport::ResourceIntrinsic {
                        interface,
                        resource: id,
                        intrinsic: ResourceIntrinsic::ImportedDrop,
                    },
                );
                let core_ty = self.define_ty([ValType::I32], []);
                let drop = self.import_func(&module, &name, core_ty);
                let drop_elem_index = self.push_elem(drop);
                let resource_index = self.metadata.resources.len();
                self.metadata.resources.push(metadata::Resource {
                    id,
                    interface: interface.map(|i| resolve.name_world_key(i)),
                    name: ty.name.clone().unwrap(),
                    drop_elem_index,
                    new_elem_index: None,
                    rep_elem_index: None,
                });
                let prev = self.resource_map.insert(id, resource_index);
                assert!(prev.is_none());
            }

            // No other types with intrinsics at this time (futures/streams are
            // relative to where they show up in function types).
            _ => {}
        }
    }

    fn add_imported_type_intrinsics_for_export<'a>(
        &mut self,
        resolve: &Resolve,
        interface: Option<&'a WorldKey>,
        id: TypeId,
    ) {
        let ty = &resolve.types[id];
        let mangling = self.resource_intrinsic_mangling();
        match ty.kind {
            TypeDefKind::Resource => {
                let drop_ty = self.define_ty([ValType::I32], []);
                let new_rep_ty = self.define_ty([ValType::I32], [ValType::I32]);

                let mut import = |ty, intrinsic| {
                    let (module, name) = resolve.wasm_import_name(
                        mangling,
                        WasmImport::ResourceIntrinsic {
                            interface,
                            resource: id,
                            intrinsic,
                        },
                    );
                    self.import_func(&module, &name, ty)
                };

                let drop = import(drop_ty, ResourceIntrinsic::ExportedDrop);
                let new = import(new_rep_ty, ResourceIntrinsic::ExportedNew);
                let rep = import(new_rep_ty, ResourceIntrinsic::ExportedRep);

                let drop_elem_index = self.push_elem(drop);
                let new_elem_index = Some(self.push_elem(new));
                let rep_elem_index = Some(self.push_elem(rep));

                let resource_index = self.metadata.resources.len();
                self.metadata.resources.push(metadata::Resource {
                    id,
                    interface: interface.map(|i| resolve.name_world_key(i)),
                    name: ty.name.clone().unwrap(),
                    drop_elem_index,
                    new_elem_index,
                    rep_elem_index,
                });

                // Note that this populates an `export_resource_map` instead of
                // `resource_map` to ensure that if an interface is both
                // imported and exported that we don't clobber the import
                // version here. The clobber here happens later when bindings
                // are generated for exports.
                let prev = self.export_resource_map.insert(id, resource_index);
                assert!(prev.is_none());
            }

            // No other types with intrinsics at this time (futures/streams
            // relative to where they are in a function).
            _ => {}
        }
    }

    /// Adds `task.return` imports for async functions, and appends all
    /// functions to `ret.wit_exports`.
    fn add_imported_func_intrinsics_for_export<'a>(
        &mut self,
        resolve: &Resolve,
        interface: Option<&'a WorldKey>,
        func: &'a wit_parser::Function,
        ret: &mut Imports<'a>,
    ) {
        let mangling = self.mangling(resolve, interface, func, false);
        let async_task_return_index = if mangling.is_async() {
            let (module, name, sig) =
                func.task_return_import(resolve, interface, mangling.mangling());
            let ty = self.define_wasm_sig(sig);
            Some(self.import_func(&module, &name, ty))
        } else {
            None
        };
        ret.wit_exports.push(WitExport {
            interface,
            func,
            async_task_return_index,
        });
    }

    fn bindgen_world(
        &mut self,
        resolve: &Resolve,
        world_id: WorldId,
        imports: &Imports<'_>,
        payload_data: &HashMap<TypeId, PayloadData>,
    ) {
        let world = &resolve.worlds[world_id];

        // Build up a map for all types of all imports. This pushes all type
        // information into the metadata section that the interpreter will end
        // up learning about.
        let mut import_types = LiveTypes::default();
        let mut interface_names = HashMap::new();
        for (interface, import) in world.imports.iter() {
            import_types.add_world_item(resolve, import);
            if let WorldItem::Interface { id, .. } = import {
                interface_names.insert(*id, interface);
            }
        }
        for (_, export) in world.exports.iter() {
            match export {
                WorldItem::Function(func) => import_types.add_func(resolve, func),
                WorldItem::Interface { .. } => {}
                WorldItem::Type { .. } => unreachable!(),
            }
        }
        for ty in import_types.iter() {
            let key = match resolve.types[ty].owner {
                TypeOwner::Interface(id) => Some(interface_names[&id]),
                _ => None,
            };
            self.register_type(resolve, key, ty, payload_data);
        }

        // Using the populated type map for imports generate functions to invoke
        // these imports. Also generate exported functions in the world since
        // they use imported types as well.
        for import in imports.wit_imports.iter() {
            self.bindgen_world_func_import(resolve, import);
        }
        for export in imports.wit_exports.iter().filter(|i| i.interface.is_none()) {
            self.bindgen_world_func_export(resolve, export);
        }

        // Next handle exported interfaces. This is a bit tricky since an
        // interface can be both exported and imported. To handle that first the
        // `type_map` set is pruned to only include imported types required, and
        // then all exported types are added. Export types skip over all
        // types present in `self.type_map`, though, since those are already
        // retained from imports.
        let to_keep = imported_types_used_by_exported_interfaces(resolve, world_id);
        self.type_map.retain(|id, _| to_keep.contains(*id));
        let mut exported_types = LiveTypes::default();
        let mut export_names = HashMap::new();
        for (interface, import) in world.exports.iter() {
            if let WorldItem::Interface { id, .. } = import {
                exported_types.add_world_item(resolve, import);
                export_names.insert(*id, interface);
            }
        }
        for (ty, index) in mem::take(&mut self.export_resource_map) {
            self.resource_map.insert(ty, index);
        }
        for ty in exported_types.iter() {
            if self.type_map.contains_key(&ty) {
                continue;
            }
            let key = match resolve.types[ty].owner {
                TypeOwner::Interface(id) => Some(export_names[&id]),
                _ => None,
            };
            self.register_type(resolve, key, ty, payload_data);

            if let Some(index) = self.resource_map.get(&ty) {
                self.bindgen_world_export_resource_dtor(resolve, key.unwrap(), ty, *index);
            }
        }

        // With export types all in place now run bindgen for all exported
        // functions.
        for export in imports.wit_exports.iter().filter(|i| i.interface.is_some()) {
            self.bindgen_world_func_export(resolve, export);
        }
    }

    /// Push WIT type information into metadata for the interpreter.
    ///
    /// This will insert `id` into metadata and build up the interpreter data
    /// structures for it. The end-result is the population of `self.type_map`
    /// here.
    fn register_type(
        &mut self,
        resolve: &Resolve,
        key: Option<&WorldKey>,
        id: TypeId,
        payload_data: &HashMap<TypeId, PayloadData>,
    ) {
        let ty = &resolve.types[id];
        let interface = key.map(|key| resolve.name_world_key(key));
        let name = ty.name.clone();
        let result = match &ty.kind {
            TypeDefKind::Record(r) => {
                let index = self.metadata.records.len();
                let fields = r
                    .fields
                    .iter()
                    .map(|field| (field.name.clone(), self.lookup_ty(&field.ty)))
                    .collect();
                self.metadata.records.push(metadata::Record {
                    id,
                    interface,
                    name: name.unwrap(),
                    fields,
                });
                metadata::Type::Record(index)
            }
            TypeDefKind::Flags(t) => {
                let index = self.metadata.flags.len();
                let names = t.flags.iter().map(|f| f.name.clone()).collect();
                self.metadata.flags.push(metadata::Flags {
                    id,
                    interface,
                    name: name.unwrap(),
                    names,
                });
                metadata::Type::Flags(index)
            }
            TypeDefKind::Tuple(t) => {
                let index = self.metadata.tuples.len();
                let types = t.types.iter().map(|t| self.lookup_ty(t)).collect();
                self.metadata.tuples.push(metadata::Tuple {
                    id,
                    interface,
                    name,
                    types,
                });
                metadata::Type::Tuple(index)
            }
            TypeDefKind::Variant(t) => {
                let index = self.metadata.variants.len();
                let cases = t
                    .cases
                    .iter()
                    .map(|c| (c.name.clone(), c.ty.map(|t| self.lookup_ty(&t))))
                    .collect();
                self.metadata.variants.push(metadata::Variant {
                    id,
                    interface,
                    name: name.unwrap(),
                    cases,
                });
                metadata::Type::Variant(index)
            }
            TypeDefKind::Enum(t) => {
                let index = self.metadata.enums.len();
                let names = t.cases.iter().map(|f| f.name.clone()).collect();
                self.metadata.enums.push(metadata::Enum {
                    id,
                    interface,
                    name: name.unwrap(),
                    names,
                });
                metadata::Type::Enum(index)
            }
            TypeDefKind::Option(t) => {
                let index = self.metadata.options.len();
                self.metadata.options.push(metadata::WitOption {
                    id,
                    interface,
                    name,
                    ty: self.lookup_ty(t),
                });
                metadata::Type::Option(index)
            }
            TypeDefKind::Result(t) => {
                let index = self.metadata.results.len();
                self.metadata.results.push(metadata::WitResult {
                    id,
                    interface,
                    name,
                    ok: t.ok.map(|t| self.lookup_ty(&t)),
                    err: t.err.map(|t| self.lookup_ty(&t)),
                });
                metadata::Type::Result(index)
            }
            TypeDefKind::List(t) => {
                let index = self.metadata.lists.len();
                self.metadata.lists.push(metadata::List {
                    id,
                    interface,
                    name,
                    ty: self.lookup_ty(t),
                });
                metadata::Type::List(index)
            }
            TypeDefKind::FixedLengthList(t, len) => {
                let index = self.metadata.fixed_length_lists.len();
                self.metadata
                    .fixed_length_lists
                    .push(metadata::FixedLengthList {
                        id,
                        interface,
                        name,
                        len: *len,
                        ty: self.lookup_ty(t),
                    });
                metadata::Type::FixedLengthList(index)
            }
            TypeDefKind::Future(t) => {
                let index = self.metadata.futures.len();

                let Some(&PayloadData {
                    new_elem_index,
                    read_elem_index,
                    write_elem_index,
                    cancel_read_elem_index,
                    cancel_write_elem_index,
                    drop_readable_elem_index,
                    drop_writable_elem_index,
                    ordinal,
                    ref function,
                }) = payload_data.get(&id)
                else {
                    // Such a type can't be used with `wit-component` currently.
                    panic!("encountered future type not used in any function")
                };

                // Compile lift and lower functions for lifting and lowering
                // items of this future's payload type, if applicable.

                let lift_elem_index = t.map(|t| {
                    let ty = self.define_ty([ValType::I32; 2], []);
                    let func = bindgen::lift_payload(self, resolve, t);
                    let func = self.define_func(
                        &format!("[future-lift-{ordinal}]{function}"),
                        ty,
                        func,
                        false,
                    );
                    self.push_elem(func)
                });

                let lower_elem_index = t.map(|t| {
                    let ty = self.define_ty([ValType::I32; 2], []);
                    let func = bindgen::lower_payload(self, resolve, t);
                    let func = self.define_func(
                        &format!("[future-lower-{ordinal}]{function}"),
                        ty,
                        func,
                        false,
                    );
                    self.push_elem(func)
                });

                self.metadata.futures.push(metadata::Future {
                    id,
                    interface,
                    name,
                    ty: t.map(|t| self.lookup_ty(&t)),
                    new_elem_index,
                    read_elem_index,
                    write_elem_index,
                    cancel_read_elem_index,
                    cancel_write_elem_index,
                    drop_readable_elem_index,
                    drop_writable_elem_index,
                    lift_elem_index,
                    lower_elem_index,
                    abi_payload_size: t.map(|t| self.sizes.size(&t).size_wasm32()).unwrap_or(0),
                    abi_payload_align: t.map(|t| self.sizes.align(&t).align_wasm32()).unwrap_or(1),
                });
                metadata::Type::Future(index)
            }
            TypeDefKind::Stream(t) => {
                let index = self.metadata.streams.len();

                let Some(&PayloadData {
                    new_elem_index,
                    read_elem_index,
                    write_elem_index,
                    cancel_read_elem_index,
                    cancel_write_elem_index,
                    drop_readable_elem_index,
                    drop_writable_elem_index,
                    ordinal,
                    ref function,
                }) = payload_data.get(&id)
                else {
                    // Such a type can't be used with `wit-component` currently.
                    panic!("encountered stream type not used in any function")
                };

                // Compile lift and lower functions for lifting and lowering
                // items of this stream's payload type, if applicable.
                //
                // Note that these functions operate on only a single item,
                // meaning they must be called in a loop when reading or writing
                // multiple items.  That saves us from having to generate a Wasm
                // loop, and allows us to reuse the same code generators for
                // `future`s and `stream`s, although the result might not be
                // quite as efficient.

                let lift_elem_index = t.map(|t| {
                    let ty = self.define_ty([ValType::I32; 2], []);
                    let func = bindgen::lift_payload(self, resolve, t);
                    let func = self.define_func(
                        &format!("[stream-lift-{ordinal}]{function}"),
                        ty,
                        func,
                        false,
                    );
                    self.push_elem(func)
                });

                let lower_elem_index = t.map(|t| {
                    let ty = self.define_ty([ValType::I32; 2], []);
                    let func = bindgen::lower_payload(self, resolve, t);
                    let func = self.define_func(
                        &format!("[stream-lower-{ordinal}]{function}"),
                        ty,
                        func,
                        false,
                    );
                    self.push_elem(func)
                });

                self.metadata.streams.push(metadata::Stream {
                    id,
                    interface,
                    name,
                    ty: t.map(|t| self.lookup_ty(&t)),
                    new_elem_index,
                    read_elem_index,
                    write_elem_index,
                    cancel_read_elem_index,
                    cancel_write_elem_index,
                    drop_readable_elem_index,
                    drop_writable_elem_index,
                    lift_elem_index,
                    lower_elem_index,
                    abi_payload_size: t.map(|t| self.sizes.size(&t).size_wasm32()).unwrap_or(0),
                    abi_payload_align: t.map(|t| self.sizes.align(&t).align_wasm32()).unwrap_or(1),
                });
                metadata::Type::Stream(index)
            }
            TypeDefKind::Type(t) => {
                let index = self.metadata.aliases.len();
                self.metadata.aliases.push(metadata::Alias {
                    id,
                    interface,
                    name: name.unwrap(),
                    ty: self.lookup_ty(t),
                });
                metadata::Type::Alias(index)
            }
            TypeDefKind::Resource => metadata::Type::Own(self.resource_map[&id]),

            // Own/Borrow handles should have already inserted the resource into
            // `self.resource_map` so this is just a simple lookup.
            TypeDefKind::Handle(Handle::Own(t)) => {
                metadata::Type::Own(self.resource_map[&dealias(resolve, *t)])
            }
            TypeDefKind::Handle(Handle::Borrow(t)) => {
                metadata::Type::Borrow(self.resource_map[&dealias(resolve, *t)])
            }
            TypeDefKind::Map(k, v) => {
                let index = self.metadata.maps.len();
                self.metadata.maps.push(metadata::Map {
                    id,
                    interface,
                    name,
                    key_type: self.lookup_ty(k),
                    value_type: self.lookup_ty(v),
                });
                metadata::Type::Map(index)
            }
            TypeDefKind::Unknown => unreachable!(),
        };
        self.type_map.insert(id, result);
    }

    fn lookup_ty(&self, ty: &Type) -> metadata::Type {
        match ty {
            Type::U8 => metadata::Type::U8,
            Type::U16 => metadata::Type::U16,
            Type::U32 => metadata::Type::U32,
            Type::U64 => metadata::Type::U64,
            Type::S8 => metadata::Type::S8,
            Type::S16 => metadata::Type::S16,
            Type::S32 => metadata::Type::S32,
            Type::S64 => metadata::Type::S64,
            Type::F32 => metadata::Type::F32,
            Type::F64 => metadata::Type::F64,
            Type::Bool => metadata::Type::Bool,
            Type::Char => metadata::Type::Char,
            Type::String => metadata::Type::String,
            Type::ErrorContext => metadata::Type::ErrorContext,
            // All id-based types should already be registered via
            // `register_type` so the hard work is already done and this is a
            // simple lookup.
            Type::Id(id) => self.type_map[id],
        }
    }

    fn bindgen_world_func_import(&mut self, resolve: &Resolve, import: &WitImport<'_>) {
        let func = import.func;
        let mangling = self.mangling(resolve, import.interface, func, true);
        let body = bindgen::import(
            self,
            resolve,
            func,
            mangling.import_variant(),
            import.import_index,
        );

        let ty = if mangling.is_async() {
            // [ cx abi_area_ptr ] -> [ status ]
            self.define_ty([ValType::I32; 2], [ValType::I32])
        } else {
            // [ cx ] -> []
            self.define_ty([ValType::I32], [])
        };

        let idx = self.define_func(&format!("adapter {}", func.name), ty, body, false);
        let elem_index = self.push_elem(idx);

        let sync_import_elem_index;
        let async_import_elem_index;
        let async_import_lift_results_elem_index;

        if mangling.is_async() {
            sync_import_elem_index = None;
            async_import_elem_index = Some(elem_index);
            let body =
                bindgen::lift_async_import_results(self, resolve, func, mangling.import_variant());
            let ty = self.define_ty([ValType::I32; 2], []);
            let idx = self.define_func(&format!("lift results {}", func.name), ty, body, false);
            async_import_lift_results_elem_index = Some(self.push_elem(idx));
        } else {
            sync_import_elem_index = Some(elem_index);
            async_import_elem_index = None;
            async_import_lift_results_elem_index = None;
        }

        self.metadata.import_funcs.push(metadata::ImportFunc {
            interface: import.interface.map(|k| resolve.name_world_key(k)),
            name: func.name.clone(),
            sync_import_elem_index,
            async_import_elem_index,
            async_import_lift_results_elem_index,
            args: func.params.iter().map(|p| self.lookup_ty(&p.ty)).collect(),
            result: func.result.map(|t| self.lookup_ty(&t)),
            async_abi_area: self.async_import_abi_area(resolve, mangling, func),
        })
    }

    /// Returns the `(size, align)` for the indirect params/results as necessary
    /// for `func` if `func` is an async function.
    fn async_import_abi_area(
        &self,
        resolve: &Resolve,
        mangling: ManglingAndAbi,
        func: &wit_parser::Function,
    ) -> Option<(usize, usize)> {
        if !mangling.is_async() {
            return None;
        }

        let info = self
            .sizes
            .record(bindgen::async_import_abi_area_types(resolve, func));
        Some((info.size.size_wasm32(), info.align.align_wasm32()))
    }

    fn bindgen_world_func_export(&mut self, resolve: &Resolve, export: &WitExport<'_>) {
        let func = export.func;
        let mangling = self.mangling(resolve, export.interface, func, false);
        let sig = resolve.wasm_signature(mangling.export_variant(), func);
        let ty = self.define_wasm_sig(sig);
        let name = resolve.wasm_export_name(
            mangling,
            WasmExport::Func {
                interface: export.interface,
                func,
                kind: WasmExportKind::Normal,
            },
        );

        let metadata_func_index = self.metadata.export_funcs.len();
        let body = bindgen::export(
            self,
            resolve,
            func,
            mangling.export_variant(),
            metadata_func_index,
        );
        self.define_func(&name, ty, body, true);

        let mut async_export_task_return_elem_index = None;
        match mangling {
            // For sync functions a post-return function is generated which
            // cleans up the `cx` argument notably but also any list allocations
            // and such as required.
            ManglingAndAbi::Standard32 | ManglingAndAbi::Legacy(LiftLowerAbi::Sync) => {
                let post_return_name = resolve.wasm_export_name(
                    mangling,
                    WasmExport::Func {
                        interface: export.interface,
                        func,
                        kind: WasmExportKind::PostReturn,
                    },
                );
                let post_return = bindgen::post_return(
                    self,
                    resolve,
                    func,
                    mangling.export_variant(),
                    metadata_func_index,
                );
                let mut sig = resolve.wasm_signature(mangling.export_variant(), func);
                sig.params = mem::take(&mut sig.results);
                let post_return_ty = self.define_wasm_sig(sig);
                self.define_func(&post_return_name, post_return_ty, post_return, true);
            }

            // For async exports in addition to the main entrypoint a
            // `[callback]` function is generated which is invoked when progress
            // is made on this function.
            //
            // Additionally a `task.return` function is generated to be invoked
            // once the async export has completed.
            ManglingAndAbi::Legacy(LiftLowerAbi::AsyncCallback) => {
                let callback_name = resolve.wasm_export_name(
                    mangling,
                    WasmExport::Func {
                        interface: export.interface,
                        func,
                        kind: WasmExportKind::Callback,
                    },
                );
                // The `[callback]` function is pretty simple, just delegate to
                // the `wit_dylib_*` implementation with one extra contextual
                // argument. It's the responsibility of the implementation to
                // call `context.{get,set}` as appropriate.
                let mut callback = Function::new([]);
                let mut ins = callback.instructions();
                ins.local_get(0);
                ins.local_get(1);
                ins.local_get(2);
                ins.i32_const(metadata_func_index.try_into().unwrap());
                let export_async_callback = self.intrinsics().export_async_callback;
                ins.call(export_async_callback);
                ins.end();
                let callback_ty = self.define_ty([ValType::I32; 3], [ValType::I32]);
                self.define_func(&callback_name, callback_ty, callback, true);

                let task_return = bindgen::task_return(
                    self,
                    resolve,
                    func,
                    mangling.export_variant(),
                    export.async_task_return_index.unwrap(),
                );
                let task_return_ty = self.define_ty([ValType::I32], []);
                let task_return = self.define_func(
                    &format!("task.return {}", func.name),
                    task_return_ty,
                    task_return,
                    false,
                );
                async_export_task_return_elem_index = Some(self.push_elem(task_return));
            }

            ManglingAndAbi::Legacy(LiftLowerAbi::AsyncStackful) => unimplemented!(),
        }

        self.metadata.export_funcs.push(metadata::ExportFunc {
            interface: export.interface.map(|k| resolve.name_world_key(k)),
            name: func.name.clone(),
            async_export_task_return_elem_index,
            args: func.params.iter().map(|p| self.lookup_ty(&p.ty)).collect(),
            result: func.result.map(|t| self.lookup_ty(&t)),
        })
    }

    fn bindgen_world_export_resource_dtor(
        &mut self,
        resolve: &Resolve,
        interface: &WorldKey,
        resource: TypeId,
        index: usize,
    ) {
        let mangling = self.resource_intrinsic_mangling();
        let name = resolve.wasm_export_name(
            mangling,
            WasmExport::ResourceDtor {
                interface,
                resource,
            },
        );
        let dtor = self.intrinsics().resource_dtor;
        let mut func = Function::new([]);
        let mut ins = func.instructions();
        ins.i32_const(index.try_into().unwrap());
        ins.local_get(0);
        ins.call(dtor);
        ins.end();
        let ty = self.define_ty([ValType::I32], []);
        self.define_func(&name, ty, func, true);
    }

    fn encode_metadata(&mut self) -> (u32, Vec<u8>) {
        let (metadata_offset, metadata, apply_relocs) =
            self.metadata.encode(self.table_base(), self.memory_base());
        if let Some(apply_relocs) = apply_relocs {
            let ty = self.define_ty([], []);
            self.define_func("__wasm_apply_data_relocs", ty, apply_relocs, true);
        }
        (metadata_offset, metadata)
    }

    fn table_base(&self) -> u32 {
        self.table_base.unwrap()
    }

    fn intrinsics(&self) -> &bindgen::WitInterpreterIntrinsics {
        self.intrinsics.as_ref().unwrap()
    }

    fn memory_base(&self) -> u32 {
        self.memory_base.unwrap()
    }

    fn push_elem(&mut self, elem: u32) -> u32 {
        let ret = self.elem_segment.len();
        self.elem_segment.push(elem);
        u32::try_from(ret).unwrap()
    }

    fn finish(&mut self, metadata: &[u8]) -> Vec<u8> {
        // Create the element segment dynamically added to the table, if necessary.
        let mut elements = ElementSection::new();
        if !self.elem_segment.is_empty() {
            elements.active(
                Some(0),
                &ConstExpr::global_get(self.table_base()),
                Elements::Functions(Cow::Borrowed(&self.elem_segment)),
            );
        }

        // Add a data segment for the interpreter metadata encoded data in-memory.
        let mut data = DataSection::new();
        data.active(
            0,
            &ConstExpr::global_get(self.memory_base()),
            metadata.iter().copied(),
        );

        let mut names = NameSection::new();
        names.functions(&self.function_names);
        names.globals(&self.global_names);

        let dylink0 = {
            struct MemInfo {
                memory_size: u32,
                memory_alignment: u32,
                table_size: u32,
                table_alignment: u32,
            }

            let mem_info = MemInfo {
                memory_size: metadata.len().try_into().unwrap(),
                memory_alignment: 2,
                table_size: self.elem_segment.len().try_into().unwrap(),
                table_alignment: 0,
            };

            let mut mem_info_subsection = Vec::new();
            mem_info.memory_size.encode(&mut mem_info_subsection);
            mem_info.memory_alignment.encode(&mut mem_info_subsection);
            mem_info.table_size.encode(&mut mem_info_subsection);
            mem_info.table_alignment.encode(&mut mem_info_subsection);

            let mut needed_subsection = Vec::new();
            if let Some(name) = &self.opts.interpreter {
                [name.as_str()].encode(&mut needed_subsection);
            }

            const WASM_DYLINK_MEM_INFO: u8 = 1;
            const WASM_DYLINK_NEEDED: u8 = 2;

            let mut dylink0 = Vec::new();
            dylink0.push(WASM_DYLINK_MEM_INFO);
            mem_info_subsection.encode(&mut dylink0);
            if self.opts.interpreter.is_some() {
                dylink0.push(WASM_DYLINK_NEEDED);
                needed_subsection.encode(&mut dylink0);
            }
            dylink0
        };

        let mut result = Module::new();
        result.section(&CustomSection {
            name: Cow::Borrowed("dylink.0"),
            data: Cow::Borrowed(&dylink0),
        });
        result.section(&self.types);
        result.section(&self.imports);
        result.section(&self.functions);
        result.section(&self.exports);
        if !elements.is_empty() {
            result.section(&elements);
        }
        result.section(&self.code);
        result.section(&data);
        result.section(&names);

        result.finish()
    }

    fn define_wasm_sig(&mut self, sig: WasmSignature) -> u32 {
        let ret = self.define_ty(
            sig.params
                .iter()
                .map(|t| self.map_wasm_type(*t))
                .collect::<Vec<_>>(),
            sig.results
                .iter()
                .map(|t| self.map_wasm_type(*t))
                .collect::<Vec<_>>(),
        );
        return ret;
    }

    fn map_wasm_type(&self, a: WasmType) -> ValType {
        match a {
            WasmType::I32 => ValType::I32,
            WasmType::I64 => ValType::I64,
            WasmType::F32 => ValType::F32,
            WasmType::F64 => ValType::F64,
            WasmType::PointerOrI64 => ValType::I64,
            WasmType::Length | WasmType::Pointer => ValType::I32,
        }
    }

    fn import_global(&mut self, module: &str, name: &str, ty: GlobalType) -> u32 {
        assert!(!self.imports_done);
        self.imports.import(module, name, ty);
        let ret = self.global_index;
        self.global_index += 1;
        self.global_names.append(ret, name);
        ret
    }

    fn import_func(&mut self, module: &str, name: &str, ty: u32) -> u32 {
        assert!(!self.imports_done);
        self.imports.import(module, name, EntityType::Function(ty));
        let ret = self.func_index;
        self.func_index += 1;
        self.function_names.append(ret, name);
        ret
    }

    fn define_func(&mut self, name: &str, ty: u32, body: Function, export: bool) -> u32 {
        assert!(self.imports_done);
        let ret = self.func_index;
        self.func_index += 1;
        self.functions.function(ty);
        self.code.function(&body);
        self.function_names.append(ret, name);
        if export {
            self.exports.export(name, ExportKind::Func, ret);
        }
        ret
    }

    fn define_ty<P, R>(&mut self, params: P, results: R) -> u32
    where
        P: IntoIterator<Item = ValType> + Clone,
        P::IntoIter: ExactSizeIterator,
        R: IntoIterator<Item = ValType> + Clone,
        R::IntoIter: ExactSizeIterator,
    {
        let param_vec = params.clone().into_iter().collect::<Vec<_>>();
        let result_vec = results.clone().into_iter().collect::<Vec<_>>();
        *self
            .wasm_type_map
            .entry((param_vec, result_vec))
            .or_insert_with(|| {
                let ret = self.types.len();
                self.types.ty().function(params, results);
                ret
            })
    }
}

fn imported_types_used_by_exported_interfaces(resolve: &Resolve, world: WorldId) -> LiveTypes {
    // First build up a set of all types used by exported interfaces which
    // define their own types.
    let mut live_export_types = LiveTypes::default();
    let mut exported_interfaces = HashSet::new();
    for (_, export) in resolve.worlds[world].exports.iter() {
        match export {
            WorldItem::Function(_) => {}
            WorldItem::Interface { id, .. } => {
                exported_interfaces.insert(*id);
                live_export_types.add_interface(resolve, *id)
            }
            WorldItem::Type { .. } => unreachable!(),
        }
    }

    // Using the above sets a new set is built of all types that aren't
    // reexported. All types used by exports, which are defined by an interface
    // that is NOT an export, is an imported type used by an export.
    let mut live_import_types = LiveTypes::default();
    for ty in live_export_types.iter() {
        if let TypeOwner::Interface(id) = resolve.types[ty].owner {
            if !exported_interfaces.contains(&id) {
                live_import_types.add_interface(resolve, id);
            }
        }
    }

    live_import_types
}

fn dealias(resolve: &Resolve, mut id: TypeId) -> TypeId {
    loop {
        match resolve.types[id].kind {
            TypeDefKind::Type(Type::Id(other)) => id = other,
            _ => break id,
        }
    }
}

#[cfg(test)]
mod tests {
    use wasmparser::{Operator, Parser, Payload};
    use wit_parser::Resolve;

    #[derive(Copy, Clone)]
    enum Which {
        S8,
        S16,
    }

    #[test]
    fn s8_uses_signed_load() {
        assert!(find_signed_load(Which::S8));
    }

    #[test]
    fn s16_uses_signed_load() {
        assert!(find_signed_load(Which::S16));
    }

    fn find_signed_load(which: Which) -> bool {
        let mut resolve = Resolve::default();
        let ty = match which {
            Which::S8 => "s8",
            Which::S16 => "s16",
        };
        let package = resolve
            .push_str(
                "wit",
                &format!(
                    "package test:test;
world w {{
  export foo: func(v: list<{ty}>);
}}
"
                ),
            )
            .unwrap();
        let world = resolve.select_world(&[package], None).unwrap();
        let adapter = super::create(&resolve, world, None).unwrap();
        for payload in Parser::new(0).parse_all(&adapter) {
            match payload.unwrap() {
                Payload::CodeSectionEntry(body) => {
                    for operator in body.get_operators_reader().unwrap() {
                        match (operator.unwrap(), which) {
                            (Operator::I32Load16S { .. }, Which::S16)
                            | (Operator::I32Load8S { .. }, Which::S8) => return true,
                            _ => {}
                        }
                    }
                }
                _ => {}
            }
        }
        false
    }
}