wasmer/lib/clif-backend/src/module_env.rs

use crate::{
    func_env::FuncEnv,
    module::{Converter, Module},
};
use cranelift_codegen::{ir, isa};
use cranelift_wasm::{self, translate_module, FuncTranslator, ModuleEnvironment};
use std::sync::Arc;
use wasmer_runtime_core::{
    error::{CompileError, CompileResult},
    module::{
        DataInitializer, ExportIndex, ImportName, NameIndex, NamespaceIndex, StringTableBuilder,
        TableInitializer,
    },
    structures::{Map, TypedIndex},
    types::{
        ElementType, GlobalDescriptor, GlobalIndex, GlobalInit, Initializer, LocalFuncIndex,
        LocalOrImport, MemoryDescriptor, SigIndex, TableDescriptor, Value,
    },
    units::Pages,
};

pub struct ModuleEnv<'module, 'isa> {
    pub module: &'module mut Module,
    isa: &'isa isa::TargetIsa,
    pub signatures: Map<SigIndex, ir::Signature>,
    globals: Map<GlobalIndex, cranelift_wasm::Global>,
    func_bodies: Map<LocalFuncIndex, ir::Function>,
    namespace_table_builder: StringTableBuilder<NamespaceIndex>,
    name_table_builder: StringTableBuilder<NameIndex>,
}

impl<'module, 'isa> ModuleEnv<'module, 'isa> {
    pub fn new(module: &'module mut Module, isa: &'isa isa::TargetIsa) -> Self {
        Self {
            module,
            isa,
            signatures: Map::new(),
            globals: Map::new(),
            func_bodies: Map::new(),
            namespace_table_builder: StringTableBuilder::new(),
            name_table_builder: StringTableBuilder::new(),
        }
    }

    pub fn translate(mut self, wasm: &[u8]) -> CompileResult<Map<LocalFuncIndex, ir::Function>> {
        translate_module(wasm, &mut self)
            .map_err(|e| CompileError::InternalError { msg: e.to_string() })?;

        self.module.info.namespace_table = self.namespace_table_builder.finish();
        self.module.info.name_table = self.name_table_builder.finish();

        Ok(self.func_bodies)
    }
}

impl<'module, 'isa, 'data> ModuleEnvironment<'data> for ModuleEnv<'module, 'isa> {
    /// Get the information needed to produce Cranelift IR for the current target.
    fn target_config(&self) -> isa::TargetFrontendConfig {
        self.isa.frontend_config()
    }

    /// Declares a function signature to the environment.
    fn declare_signature(&mut self, sig: &ir::Signature) {
        self.signatures.push(sig.clone());
        self.module
            .info
            .signatures
            .push(Arc::new(Converter(sig).into()));
    }

    /// Return the signature with the given index.
    fn get_signature(&self, clif_sig_index: cranelift_wasm::SignatureIndex) -> &ir::Signature {
        &self.signatures[Converter(clif_sig_index).into()]
    }

    /// Declares a function import to the environment.
    fn declare_func_import(
        &mut self,
        clif_sig_index: cranelift_wasm::SignatureIndex,
        namespace: &'data str,
        name: &'data str,
    ) {
        // We convert the cranelift signature index to
        // a wasmer signature index without deduplicating
        // because we'll deduplicate later.
        let sig_index = Converter(clif_sig_index).into();
        self.module.info.func_assoc.push(sig_index);

        let namespace_index = self.namespace_table_builder.register(namespace);
        let name_index = self.name_table_builder.register(name);

        // Add import names to list of imported functions
        self.module.info.imported_functions.push(ImportName {
            namespace_index,
            name_index,
        });
    }

    /// Return the number of imported funcs.
    fn get_num_func_imports(&self) -> usize {
        self.module.info.imported_functions.len()
    }

    /// Declares the type (signature) of a local function in the module.
    fn declare_func_type(&mut self, clif_sig_index: cranelift_wasm::SignatureIndex) {
        // We convert the cranelift signature index to
        // a wasmer signature index without deduplicating
        // because we'll deduplicate later.
        let sig_index = Converter(clif_sig_index).into();
        self.module.info.func_assoc.push(sig_index);
    }

    /// Return the signature index for the given function index.
    fn get_func_type(
        &self,
        func_index: cranelift_wasm::FuncIndex,
    ) -> cranelift_wasm::SignatureIndex {
        let sig_index: SigIndex = self.module.info.func_assoc[Converter(func_index).into()];
        Converter(sig_index).into()
    }

    /// Declares a global to the environment.
    fn declare_global(&mut self, global: cranelift_wasm::Global) {
        let desc = GlobalDescriptor {
            mutable: global.mutability,
            ty: Converter(global.ty).into(),
        };

        let init = match global.initializer {
            cranelift_wasm::GlobalInit::I32Const(x) => Initializer::Const(Value::I32(x)),
            cranelift_wasm::GlobalInit::I64Const(x) => Initializer::Const(Value::I64(x)),
            cranelift_wasm::GlobalInit::F32Const(x) => {
                Initializer::Const(Value::F32(f32::from_bits(x)))
            }
            cranelift_wasm::GlobalInit::F64Const(x) => {
                Initializer::Const(Value::F64(f64::from_bits(x)))
            }
            cranelift_wasm::GlobalInit::GetGlobal(global_index) => {
                // assert!(!desc.mutable);
                let global_index: GlobalIndex = Converter(global_index).into();
                let imported_global_index = global_index
                    .local_or_import(&self.module.info)
                    .import()
                    .expect("invalid global initializer when declaring an imported global");
                Initializer::GetGlobal(imported_global_index)
            }
            _ => panic!("invalid global initializer when declaring a local global"),
        };

        // Add global ir to the list of globals
        self.module.info.globals.push(GlobalInit { desc, init });

        self.globals.push(global);
    }

    /// Declares a global import to the environment.
    fn declare_global_import(
        &mut self,
        global: cranelift_wasm::Global,
        namespace: &'data str,
        name: &'data str,
    ) {
        assert!(match global.initializer {
            cranelift_wasm::GlobalInit::Import => true,
            _ => false,
        });

        let namespace_index = self.namespace_table_builder.register(namespace);
        let name_index = self.name_table_builder.register(name);

        let import_name = ImportName {
            namespace_index,
            name_index,
        };

        let desc = GlobalDescriptor {
            mutable: global.mutability,
            ty: Converter(global.ty).into(),
        };

        // Add global ir to the list of globals
        self.module.info.imported_globals.push((import_name, desc));

        self.globals.push(global);
    }

    /// Return the global for the given global index.
    fn get_global(&self, global_index: cranelift_wasm::GlobalIndex) -> &cranelift_wasm::Global {
        &self.globals[Converter(global_index).into()]
    }

    /// Declares a table to the environment.
    fn declare_table(&mut self, table: cranelift_wasm::Table) {
        use cranelift_wasm::TableElementType;
        // Add table ir to the list of tables
        self.module.info.tables.push(TableDescriptor {
            element: match table.ty {
                TableElementType::Func => ElementType::Anyfunc,
                _ => unimplemented!(),
            },
            minimum: table.minimum,
            maximum: table.maximum,
        });
    }

    /// Declares a table import to the environment.
    fn declare_table_import(
        &mut self,
        table: cranelift_wasm::Table,
        namespace: &'data str,
        name: &'data str,
    ) {
        use cranelift_wasm::TableElementType;

        let namespace_index = self.namespace_table_builder.register(namespace);
        let name_index = self.name_table_builder.register(name);

        let import_name = ImportName {
            namespace_index,
            name_index,
        };

        let imported_table = TableDescriptor {
            element: match table.ty {
                TableElementType::Func => ElementType::Anyfunc,
                _ => unimplemented!(),
            },
            minimum: table.minimum,
            maximum: table.maximum,
        };

        // Add import names to list of imported tables
        self.module
            .info
            .imported_tables
            .push((import_name, imported_table));
    }

    /// Fills a declared table with references to functions in the module.
    fn declare_table_elements(
        &mut self,
        table_index: cranelift_wasm::TableIndex,
        base: Option<cranelift_wasm::GlobalIndex>,
        offset: usize,
        elements: Vec<cranelift_wasm::FuncIndex>,
    ) {
        // Convert Cranelift GlobalIndex to wamser GlobalIndex
        // let base = base.map(|index| WasmerGlobalIndex::new(index.index()));
        let base = match base {
            Some(global_index) => {
                let global_index: GlobalIndex = Converter(global_index).into();
                Initializer::GetGlobal(match global_index.local_or_import(&self.module.info) {
                    LocalOrImport::Import(imported_global_index) => imported_global_index,
                    LocalOrImport::Local(_) => {
                        panic!("invalid global initializer when declaring an imported global")
                    }
                })
            }
            None => Initializer::Const((offset as i32).into()),
        };

        // Add table initializer to list of table initializers
        self.module.info.elem_initializers.push(TableInitializer {
            table_index: Converter(table_index).into(),
            base,
            elements: elements
                .iter()
                .map(|&func_index| Converter(func_index).into())
                .collect(),
        });
    }

    /// Declares a memory to the environment
    fn declare_memory(&mut self, memory: cranelift_wasm::Memory) {
        self.module.info.memories.push(MemoryDescriptor {
            minimum: Pages(memory.minimum),
            maximum: memory.maximum.map(|max| Pages(max)),
            shared: memory.shared,
        });
    }

    /// Declares a memory import to the environment.
    fn declare_memory_import(
        &mut self,
        memory: cranelift_wasm::Memory,
        namespace: &'data str,
        name: &'data str,
    ) {
        let namespace_index = self.namespace_table_builder.register(namespace);
        let name_index = self.name_table_builder.register(name);

        let import_name = ImportName {
            namespace_index,
            name_index,
        };

        let memory = MemoryDescriptor {
            minimum: Pages(memory.minimum),
            maximum: memory.maximum.map(|max| Pages(max)),
            shared: memory.shared,
        };

        // Add import names to list of imported memories
        self.module
            .info
            .imported_memories
            .push((import_name, memory));
    }

    /// Fills a declared memory with bytes at module instantiation.
    fn declare_data_initialization(
        &mut self,
        memory_index: cranelift_wasm::MemoryIndex,
        base: Option<cranelift_wasm::GlobalIndex>,
        offset: usize,
        data: &'data [u8],
    ) {
        // Convert Cranelift GlobalIndex to wamser GlobalIndex
        let base = match base {
            Some(global_index) => {
                let global_index: GlobalIndex = Converter(global_index).into();
                Initializer::GetGlobal(match global_index.local_or_import(&self.module.info) {
                    LocalOrImport::Import(imported_global_index) => imported_global_index,
                    LocalOrImport::Local(_) => {
                        panic!("invalid global initializer when declaring an imported global")
                    }
                })
            }
            None => Initializer::Const((offset as i32).into()),
        };

        // Add data initializer to list of data initializers
        self.module.info.data_initializers.push(DataInitializer {
            memory_index: Converter(memory_index).into(),
            base,
            data: data.to_vec(),
        });
    }

    /// Declares a function export to the environment.
    fn declare_func_export(&mut self, func_index: cranelift_wasm::FuncIndex, name: &'data str) {
        self.module.info.exports.insert(
            name.to_string(),
            ExportIndex::Func(Converter(func_index).into()),
        );
    }
    /// Declares a table export to the environment.
    fn declare_table_export(&mut self, table_index: cranelift_wasm::TableIndex, name: &'data str) {
        self.module.info.exports.insert(
            name.to_string(),
            ExportIndex::Table(Converter(table_index).into()),
        );
    }
    /// Declares a memory export to the environment.
    fn declare_memory_export(
        &mut self,
        memory_index: cranelift_wasm::MemoryIndex,
        name: &'data str,
    ) {
        self.module.info.exports.insert(
            name.to_string(),
            ExportIndex::Memory(Converter(memory_index).into()),
        );
    }
    /// Declares a global export to the environment.
    fn declare_global_export(
        &mut self,
        global_index: cranelift_wasm::GlobalIndex,
        name: &'data str,
    ) {
        self.module.info.exports.insert(
            name.to_string(),
            ExportIndex::Global(Converter(global_index).into()),
        );
    }

    /// Declares a start function.
    fn declare_start_func(&mut self, func_index: cranelift_wasm::FuncIndex) {
        self.module.info.start_func = Some(Converter(func_index).into());
    }

    /// Provides the contents of a function body.
    fn define_function_body(&mut self, body_bytes: &'data [u8]) -> cranelift_wasm::WasmResult<()> {
        let mut func_translator = FuncTranslator::new();

        let func_body = {
            let mut func_env = FuncEnv::new(self);
            let func_index = self.func_bodies.next_index();
            let name = ir::ExternalName::user(0, func_index.index() as u32);

            let sig = func_env.generate_signature(
                self.get_func_type(Converter(func_index.convert_up(&self.module.info)).into()),
            );

            let mut func = ir::Function::with_name_signature(name, sig);

            func_translator.translate(body_bytes, &mut func, &mut func_env)?;

            #[cfg(feature = "debug")]
            {
                use cranelift_codegen::cursor::{Cursor, FuncCursor};
                use cranelift_codegen::ir::InstBuilder;
                let entry_ebb = func.layout.entry_block().unwrap();
                let ebb = func.dfg.make_ebb();
                func.layout.insert_ebb(ebb, entry_ebb);
                let mut pos = FuncCursor::new(&mut func).at_first_insertion_point(ebb);
                let params = pos.func.dfg.ebb_params(entry_ebb).to_vec();

                let new_ebb_params: Vec<_> = params
                    .iter()
                    .map(|&param| {
                        pos.func
                            .dfg
                            .append_ebb_param(ebb, pos.func.dfg.value_type(param))
                    })
                    .collect();

                let start_debug = {
                    let signature = pos.func.import_signature(ir::Signature {
                        call_conv: self.target_config().default_call_conv,
                        params: vec![
                            ir::AbiParam::special(ir::types::I64, ir::ArgumentPurpose::VMContext),
                            ir::AbiParam::new(ir::types::I32),
                        ],
                        returns: vec![],
                    });

                    let name = ir::ExternalName::testcase("strtdbug");

                    pos.func.import_function(ir::ExtFuncData {
                        name,
                        signature,
                        colocated: false,
                    })
                };

                let end_debug = {
                    let signature = pos.func.import_signature(ir::Signature {
                        call_conv: self.target_config().default_call_conv,
                        params: vec![ir::AbiParam::special(
                            ir::types::I64,
                            ir::ArgumentPurpose::VMContext,
                        )],
                        returns: vec![],
                    });

                    let name = ir::ExternalName::testcase("enddbug");

                    pos.func.import_function(ir::ExtFuncData {
                        name,
                        signature,
                        colocated: false,
                    })
                };

                let i32_print = {
                    let signature = pos.func.import_signature(ir::Signature {
                        call_conv: self.target_config().default_call_conv,
                        params: vec![
                            ir::AbiParam::special(ir::types::I64, ir::ArgumentPurpose::VMContext),
                            ir::AbiParam::new(ir::types::I32),
                        ],
                        returns: vec![],
                    });

                    let name = ir::ExternalName::testcase("i32print");

                    pos.func.import_function(ir::ExtFuncData {
                        name,
                        signature,
                        colocated: false,
                    })
                };

                let i64_print = {
                    let signature = pos.func.import_signature(ir::Signature {
                        call_conv: self.target_config().default_call_conv,
                        params: vec![
                            ir::AbiParam::special(ir::types::I64, ir::ArgumentPurpose::VMContext),
                            ir::AbiParam::new(ir::types::I64),
                        ],
                        returns: vec![],
                    });

                    let name = ir::ExternalName::testcase("i64print");

                    pos.func.import_function(ir::ExtFuncData {
                        name,
                        signature,
                        colocated: false,
                    })
                };

                let f32_print = {
                    let signature = pos.func.import_signature(ir::Signature {
                        call_conv: self.target_config().default_call_conv,
                        params: vec![
                            ir::AbiParam::special(ir::types::I64, ir::ArgumentPurpose::VMContext),
                            ir::AbiParam::new(ir::types::F32),
                        ],
                        returns: vec![],
                    });

                    let name = ir::ExternalName::testcase("f32print");

                    pos.func.import_function(ir::ExtFuncData {
                        name,
                        signature,
                        colocated: false,
                    })
                };

                let f64_print = {
                    let signature = pos.func.import_signature(ir::Signature {
                        call_conv: self.target_config().default_call_conv,
                        params: vec![
                            ir::AbiParam::special(ir::types::I64, ir::ArgumentPurpose::VMContext),
                            ir::AbiParam::new(ir::types::F64),
                        ],
                        returns: vec![],
                    });

                    let name = ir::ExternalName::testcase("f64print");

                    pos.func.import_function(ir::ExtFuncData {
                        name,
                        signature,
                        colocated: false,
                    })
                };

                let vmctx = pos
                    .func
                    .special_param(ir::ArgumentPurpose::VMContext)
                    .expect("missing vmctx parameter");

                let func_index = pos.ins().iconst(ir::types::I32, func_index.index() as i64);

                pos.ins().call(start_debug, &[vmctx, func_index]);

                for param in new_ebb_params.iter().cloned() {
                    match pos.func.dfg.value_type(param) {
                        ir::types::I32 => pos.ins().call(i32_print, &[vmctx, param]),
                        ir::types::I64 => pos.ins().call(i64_print, &[vmctx, param]),
                        ir::types::F32 => pos.ins().call(f32_print, &[vmctx, param]),
                        ir::types::F64 => pos.ins().call(f64_print, &[vmctx, param]),
                        _ => unimplemented!(),
                    };
                }

                pos.ins().call(end_debug, &[vmctx]);

                pos.ins().jump(entry_ebb, new_ebb_params.as_slice());
            }

            func
        };

        // Add function body to list of function bodies.
        self.func_bodies.push(func_body);

        Ok(())
    }
}