wasmtime/wasmtime-environ/src/cranelift.rs

//! Support for compiling with Cranelift.

use crate::address_map::{FunctionAddressMap, InstructionAddressMap, ModuleAddressMap};
use crate::cache::{ModuleCacheData, ModuleCacheEntry};
use crate::compilation::{
    CodeAndJTOffsets, Compilation, CompileError, Relocation, RelocationTarget, Relocations,
};
use crate::func_environ::{
    get_func_name, get_imported_memory32_grow_name, get_imported_memory32_size_name,
    get_memory32_grow_name, get_memory32_size_name, FuncEnvironment,
};
use crate::module::Module;
use crate::module_environ::FunctionBodyData;
use cranelift_codegen::binemit;
use cranelift_codegen::ir;
use cranelift_codegen::ir::ExternalName;
use cranelift_codegen::isa;
use cranelift_codegen::Context;
use cranelift_entity::PrimaryMap;
use cranelift_wasm::{DefinedFuncIndex, FuncIndex, FuncTranslator};
use rayon::prelude::{IntoParallelRefIterator, ParallelIterator};
use std::vec::Vec;

/// Implementation of a relocation sink that just saves all the information for later
pub struct RelocSink {
    /// Current function index.
    func_index: FuncIndex,

    /// Relocations recorded for the function.
    pub func_relocs: Vec<Relocation>,
}

impl binemit::RelocSink for RelocSink {
    fn reloc_ebb(
        &mut self,
        _offset: binemit::CodeOffset,
        _reloc: binemit::Reloc,
        _ebb_offset: binemit::CodeOffset,
    ) {
        // This should use the `offsets` field of `ir::Function`.
        panic!("ebb headers not yet implemented");
    }
    fn reloc_external(
        &mut self,
        offset: binemit::CodeOffset,
        reloc: binemit::Reloc,
        name: &ExternalName,
        addend: binemit::Addend,
    ) {
        let reloc_target = if *name == get_memory32_grow_name() {
            RelocationTarget::Memory32Grow
        } else if *name == get_imported_memory32_grow_name() {
            RelocationTarget::ImportedMemory32Grow
        } else if *name == get_memory32_size_name() {
            RelocationTarget::Memory32Size
        } else if *name == get_imported_memory32_size_name() {
            RelocationTarget::ImportedMemory32Size
        } else if let ExternalName::User { namespace, index } = *name {
            debug_assert!(namespace == 0);
            RelocationTarget::UserFunc(FuncIndex::from_u32(index))
        } else if let ExternalName::LibCall(libcall) = *name {
            RelocationTarget::LibCall(libcall)
        } else {
            panic!("unrecognized external name")
        };
        self.func_relocs.push(Relocation {
            reloc,
            reloc_target,
            offset,
            addend,
        });
    }
    fn reloc_jt(&mut self, offset: binemit::CodeOffset, reloc: binemit::Reloc, jt: ir::JumpTable) {
        self.func_relocs.push(Relocation {
            reloc,
            reloc_target: RelocationTarget::JumpTable(self.func_index, jt),
            offset,
            addend: 0,
        });
    }
}

impl RelocSink {
    /// Return a new `RelocSink` instance.
    pub fn new(func_index: FuncIndex) -> Self {
        Self {
            func_index,
            func_relocs: Vec::new(),
        }
    }
}

fn get_address_transform(context: &Context, isa: &isa::TargetIsa) -> Vec<InstructionAddressMap> {
    let mut result = Vec::new();

    let func = &context.func;
    let mut ebbs = func.layout.ebbs().collect::<Vec<_>>();
    ebbs.sort_by_key(|ebb| func.offsets[*ebb]); // Ensure inst offsets always increase

    let encinfo = isa.encoding_info();
    for ebb in ebbs {
        for (offset, inst, size) in func.inst_offsets(ebb, &encinfo) {
            let srcloc = func.srclocs[inst];
            result.push(InstructionAddressMap {
                srcloc,
                code_offset: offset as usize,
                code_len: size as usize,
            });
        }
    }
    result
}

/// A compiler that compiles a WebAssembly module with Cranelift, translating the Wasm to Cranelift IR,
/// optimizing it and then translating to assembly.
pub struct Cranelift;

impl crate::compilation::Compiler for Cranelift {
    /// Compile the module using Cranelift, producing a compilation result with
    /// associated relocations.
    fn compile_module<'data, 'module>(
        module: &'module Module,
        function_body_inputs: PrimaryMap<DefinedFuncIndex, FunctionBodyData<'data>>,
        isa: &dyn isa::TargetIsa,
        generate_debug_info: bool,
    ) -> Result<(Compilation, Relocations, ModuleAddressMap), CompileError> {
        let cache_entry = ModuleCacheEntry::new(
            module,
            &function_body_inputs,
            isa,
            "cranelift",
            generate_debug_info,
        );

        let data = match cache_entry.get_data() {
            Some(data) => data,
            None => {
                let mut functions = PrimaryMap::with_capacity(function_body_inputs.len());
                let mut relocations = PrimaryMap::with_capacity(function_body_inputs.len());
                let mut address_transforms = PrimaryMap::with_capacity(function_body_inputs.len());

                function_body_inputs
                    .into_iter()
                    .collect::<Vec<(DefinedFuncIndex, &FunctionBodyData<'data>)>>()
                    .par_iter()
                    .map(|(i, input)| {
                        let func_index = module.func_index(*i);
                        let mut context = Context::new();
                        context.func.name = get_func_name(func_index);
                        context.func.signature =
                            module.signatures[module.functions[func_index]].clone();

                        let mut trans = FuncTranslator::new();
                        trans
                            .translate(
                                input.data,
                                input.module_offset,
                                &mut context.func,
                                &mut FuncEnvironment::new(isa.frontend_config(), module),
                            )
                            .map_err(CompileError::Wasm)?;

                        let mut code_buf: Vec<u8> = Vec::new();
                        let mut reloc_sink = RelocSink::new(func_index);
                        let mut trap_sink = binemit::NullTrapSink {};
                        context
                            .compile_and_emit(isa, &mut code_buf, &mut reloc_sink, &mut trap_sink)
                            .map_err(CompileError::Codegen)?;

                        let jt_offsets = context.func.jt_offsets.clone();

                        let address_transform = if generate_debug_info {
                            let body_len = code_buf.len();
                            let at = get_address_transform(&context, isa);

                            Some(FunctionAddressMap {
                                instructions: at,
                                body_offset: 0,
                                body_len,
                            })
                        } else {
                            None
                        };

                        Ok((
                            code_buf,
                            jt_offsets,
                            reloc_sink.func_relocs,
                            address_transform,
                        ))
                    })
                    .collect::<Result<Vec<_>, CompileError>>()?
                    .into_iter()
                    .for_each(|(function, func_jt_offsets, relocs, address_transform)| {
                        functions.push(CodeAndJTOffsets {
                            body: function,
                            jt_offsets: func_jt_offsets,
                        });
                        relocations.push(relocs);
                        if let Some(address_transform) = address_transform {
                            address_transforms.push(address_transform);
                        }
                    });

                // TODO: Reorganize where we create the Vec for the resolved imports.

                let data = ModuleCacheData::from_tuple((
                    Compilation::new(functions),
                    relocations,
                    address_transforms,
                ));
                cache_entry.update_data(&data);
                data
            }
        };

        Ok(data.to_tuple())
    }
}