Move trap information to a section of the compiled image (#3241)

This commit moves the `traps` field of `FunctionInfo` into a section of
the compiled artifact produced by Cranelift. This section is quite large
and when previously encoded/decoded with `bincode` this can take quite
some time to process. Traps are expected to be relatively rare and it's
not necessarily the right tradeoff to spend so much time
serializing/deserializing this data, so this commit offloads the section
into a custom-encoded binary format located elsewhere in the compiled image.

This is similar to #3240 in its goal which is to move very large pieces
of metadata to their own sections to avoid decoding anything when we
load a precompiled modules. This also has a small benefit that it's
slightly more efficient storage for the trap information too, but that's
a negligible benefit.

This is part of #3230 to make loading modules fast.

crates/cranelift/src/compiler.rs

@@ -28,7 +28,7 @@ use std::sync::Mutex;
 use wasmtime_environ::{
     AddressMapSection, CompileError, FilePos, FlagValue, FunctionBodyData, FunctionInfo,
     InstructionAddressMap, Module, ModuleTranslation, StackMapInformation, TrapCode,
-    TrapInformation, Tunables, TypeTables, VMOffsets,
+    TrapEncodingBuilder, TrapInformation, Tunables, TypeTables, VMOffsets,
 };
 
 /// A compiler that compiles a WebAssembly module with Compiler, translating
@@ -208,8 +208,8 @@ impl wasmtime_environ::Compiler for Compiler {
             value_labels_ranges: ranges.unwrap_or(Default::default()),
             stack_slots: context.func.stack_slots,
             unwind_info,
-            info: FunctionInfo {
             traps: trap_sink.traps,
+            info: FunctionInfo {
                 start_srcloc: address_transform.start_srcloc,
                 stack_maps: stack_map_sink.finish(),
             },
@@ -249,10 +249,12 @@ impl wasmtime_environ::Compiler for Compiler {
 
         let mut builder = ObjectBuilder::new(obj, &translation.module);
         let mut addrs = AddressMapSection::default();
+        let mut traps = TrapEncodingBuilder::default();
 
         for (i, func) in funcs.iter() {
             let range = builder.func(i, func);
-            addrs.push(range, &func.address_map.instructions);
+            addrs.push(range.clone(), &func.address_map.instructions);
+            traps.push(range, &func.traps);
         }
         for (i, func) in trampolines.iter() {
             builder.trampoline(*i, func);
@@ -291,6 +293,7 @@ impl wasmtime_environ::Compiler for Compiler {
 
         builder.finish(&*self.isa)?;
         addrs.append_to(obj);
+        traps.append_to(obj);
 
         Ok(funcs.into_iter().map(|(_, f)| f.info).collect())
     }
@@ -533,6 +536,7 @@ impl Compiler {
             value_labels_ranges: Default::default(),
             info: Default::default(),
             address_map: Default::default(),
+            traps: Vec::new(),
         })
     }
 }

crates/cranelift/src/lib.rs

@@ -94,7 +94,9 @@ use cranelift_codegen::isa::{unwind::UnwindInfo, CallConv, TargetIsa};
 use cranelift_entity::PrimaryMap;
 use cranelift_wasm::{DefinedFuncIndex, FuncIndex, WasmFuncType, WasmType};
 use target_lexicon::CallingConvention;
-use wasmtime_environ::{FilePos, FunctionInfo, InstructionAddressMap, Module, TypeTables};
+use wasmtime_environ::{
+    FilePos, FunctionInfo, InstructionAddressMap, Module, TrapInformation, TypeTables,
+};
 
 pub use builder::builder;
 
@@ -122,6 +124,10 @@ pub struct CompiledFunction {
     /// location found in the wasm input.
     address_map: FunctionAddressMap,
 
+    /// Metadata about traps in this module, mapping code offsets to the trap
+    /// that they may cause.
+    traps: Vec<TrapInformation>,
+
     relocations: Vec<Relocation>,
     value_labels_ranges: cranelift_codegen::ValueLabelsRanges,
     stack_slots: ir::StackSlots,

crates/environ/src/compilation.rs

@@ -20,64 +20,10 @@ use thiserror::Error;
 #[derive(Serialize, Deserialize, Clone, Default)]
 #[allow(missing_docs)]
 pub struct FunctionInfo {
-    pub traps: Vec<TrapInformation>,
     pub start_srcloc: FilePos,
     pub stack_maps: Vec<StackMapInformation>,
 }
 
-/// Information about trap.
-#[derive(Serialize, Deserialize, Debug, PartialEq, Eq, Clone)]
-pub struct TrapInformation {
-    /// The offset of the trapping instruction in native code. It is relative to the beginning of the function.
-    pub code_offset: u32,
-    /// Code of the trap.
-    pub trap_code: TrapCode,
-}
-
-/// A trap code describing the reason for a trap.
-///
-/// All trap instructions have an explicit trap code.
-#[derive(Clone, Copy, PartialEq, Eq, Debug, Hash, Serialize, Deserialize)]
-pub enum TrapCode {
-    /// The current stack space was exhausted.
-    StackOverflow,
-
-    /// A `heap_addr` instruction detected an out-of-bounds error.
-    ///
-    /// Note that not all out-of-bounds heap accesses are reported this way;
-    /// some are detected by a segmentation fault on the heap unmapped or
-    /// offset-guard pages.
-    HeapOutOfBounds,
-
-    /// A wasm atomic operation was presented with a not-naturally-aligned linear-memory address.
-    HeapMisaligned,
-
-    /// A `table_addr` instruction detected an out-of-bounds error.
-    TableOutOfBounds,
-
-    /// Indirect call to a null table entry.
-    IndirectCallToNull,
-
-    /// Signature mismatch on indirect call.
-    BadSignature,
-
-    /// An integer arithmetic operation caused an overflow.
-    IntegerOverflow,
-
-    /// An integer division by zero.
-    IntegerDivisionByZero,
-
-    /// Failed float-to-int conversion.
-    BadConversionToInteger,
-
-    /// Code that was supposed to have been unreachable was reached.
-    UnreachableCodeReached,
-
-    /// Execution has potentially run too long and may be interrupted.
-    /// This trap is resumable.
-    Interrupt,
-}
-
 /// The offset within a function of a GC safepoint, and its associated stack
 /// map.
 #[derive(Serialize, Deserialize, Debug, PartialEq, Eq, Clone)]

crates/environ/src/lib.rs

@@ -30,6 +30,7 @@ mod module;
 mod module_environ;
 pub mod obj;
 mod stack_map;
+mod trap_encoding;
 mod tunables;
 mod vmoffsets;
 
@@ -39,6 +40,7 @@ pub use crate::compilation::*;
 pub use crate::module::*;
 pub use crate::module_environ::*;
 pub use crate::stack_map::StackMap;
+pub use crate::trap_encoding::*;
 pub use crate::tunables::Tunables;
 pub use crate::vmoffsets::*;
 

crates/environ/src/trap_encoding.rs

@@ -0,0 +1,215 @@
+use object::write::{Object, StandardSegment};
+use object::{Bytes, LittleEndian, SectionKind, U32Bytes};
+use std::convert::TryFrom;
+use std::ops::Range;
+
+/// A helper structure to build the custom-encoded section of a wasmtime
+/// compilation image which encodes trap information.
+///
+/// This structure is incrementally fed the results of compiling individual
+/// functions and handles all the encoding internally, allowing usage of
+/// `lookup_trap_code` below with the resulting section.
+#[derive(Default)]
+pub struct TrapEncodingBuilder {
+    offsets: Vec<U32Bytes<LittleEndian>>,
+    traps: Vec<u8>,
+    last_offset: u32,
+}
+
+/// A custom binary-encoded section of wasmtime compilation artifacts which
+/// encodes the ability to map an offset in the text section to the trap code
+/// that it corresponds to.
+///
+/// This section is used at runtime to determine what flavor fo trap happened to
+/// ensure that embedders and debuggers know the reason for the wasm trap. The
+/// encoding of this section is custom to Wasmtime and managed with helpers in
+/// the `object` crate:
+///
+/// * First the section has a 32-bit little endian integer indicating how many
+///   trap entries are in the section.
+/// * Next is an array, of the same length as read before, of 32-bit
+///   little-endian integers. These integers are offsets into the text section
+///   of the compilation image.
+/// * Finally is the same count number of bytes. Each of these bytes corresponds
+///   to a trap code.
+///
+/// This section is decoded by `lookup_trap_code` below which will read the
+/// section count, slice some bytes to get the various arrays, and then perform
+/// a binary search on the offsets array to find the an index corresponding to
+/// the pc being looked up. If found the same index in the trap array (the array
+/// of bytes) is the trap code for that offset.
+///
+/// Note that at this time this section has an alignment of 1. Additionally due
+/// to the 32-bit encodings for offsets this doesn't support images >=4gb.
+pub const ELF_WASMTIME_TRAPS: &str = ".wasmtime.traps";
+
+/// Information about trap.
+#[derive(Debug, PartialEq, Eq, Clone)]
+pub struct TrapInformation {
+    /// The offset of the trapping instruction in native code.
+    ///
+    /// This is relative to the beginning of the function.
+    pub code_offset: u32,
+
+    /// Code of the trap.
+    pub trap_code: TrapCode,
+}
+
+/// A trap code describing the reason for a trap.
+///
+/// All trap instructions have an explicit trap code.
+#[derive(Clone, Copy, PartialEq, Eq, Debug, Hash)]
+#[repr(u8)]
+pub enum TrapCode {
+    /// The current stack space was exhausted.
+    StackOverflow,
+
+    /// A `heap_addr` instruction detected an out-of-bounds error.
+    ///
+    /// Note that not all out-of-bounds heap accesses are reported this way;
+    /// some are detected by a segmentation fault on the heap unmapped or
+    /// offset-guard pages.
+    HeapOutOfBounds,
+
+    /// A wasm atomic operation was presented with a not-naturally-aligned linear-memory address.
+    HeapMisaligned,
+
+    /// A `table_addr` instruction detected an out-of-bounds error.
+    TableOutOfBounds,
+
+    /// Indirect call to a null table entry.
+    IndirectCallToNull,
+
+    /// Signature mismatch on indirect call.
+    BadSignature,
+
+    /// An integer arithmetic operation caused an overflow.
+    IntegerOverflow,
+
+    /// An integer division by zero.
+    IntegerDivisionByZero,
+
+    /// Failed float-to-int conversion.
+    BadConversionToInteger,
+
+    /// Code that was supposed to have been unreachable was reached.
+    UnreachableCodeReached,
+
+    /// Execution has potentially run too long and may be interrupted.
+    /// This trap is resumable.
+    Interrupt,
+    // if adding a variant here be sure to update the `check!` macro below
+}
+
+impl TrapEncodingBuilder {
+    /// Appends trap information about a function into this section.
+    ///
+    /// This function is called to describe traps for the `func` range
+    /// specified. The `func` offsets are specified relative to the text section
+    /// itself, and the `traps` offsets are specified relative to the start of
+    /// `func`.
+    ///
+    /// This is required to be called in-order for increasing ranges of `func`
+    /// to ensure the final array is properly sorted. Additionally `traps` must
+    /// be sorted.
+    pub fn push(&mut self, func: Range<u64>, traps: &[TrapInformation]) {
+        // NB: for now this only supports <=4GB text sections in object files.
+        // Alternative schemes will need to be created for >32-bit offsets to
+        // avoid making this section overly large.
+        let func_start = u32::try_from(func.start).unwrap();
+        let func_end = u32::try_from(func.end).unwrap();
+
+        // Sanity-check to ensure that functions are pushed in-order, otherwise
+        // the `offsets` array won't be sorted which is our goal.
+        assert!(func_start >= self.last_offset);
+
+        self.offsets.reserve(traps.len());
+        self.traps.reserve(traps.len());
+        for info in traps {
+            let pos = func_start + info.code_offset;
+            assert!(pos >= self.last_offset);
+            self.offsets.push(U32Bytes::new(LittleEndian, pos));
+            self.traps.push(info.trap_code as u8);
+            self.last_offset = pos;
+        }
+
+        self.last_offset = func_end;
+    }
+
+    /// Encodes this section into the object provided.
+    pub fn append_to(self, obj: &mut Object) {
+        let section = obj.add_section(
+            obj.segment_name(StandardSegment::Data).to_vec(),
+            ELF_WASMTIME_TRAPS.as_bytes().to_vec(),
+            SectionKind::ReadOnlyData,
+        );
+
+        // NB: this matches the encoding expected by `lookup` below.
+        let amt = u32::try_from(self.traps.len()).unwrap();
+        obj.append_section_data(section, &amt.to_le_bytes(), 1);
+        obj.append_section_data(section, object::bytes_of_slice(&self.offsets), 1);
+        obj.append_section_data(section, &self.traps, 1);
+    }
+}
+
+/// Decodes the provided trap information section and attempts to find the trap
+/// code corresponding to the `offset` specified.
+///
+/// The `section` provided is expected to have been built by
+/// `TrapEncodingBuilder` above. Additionally the `offset` should be a relative
+/// offset within the text section of the compilation image.
+pub fn lookup_trap_code(section: &[u8], offset: usize) -> Option<TrapCode> {
+    let mut section = Bytes(section);
+    // NB: this matches the encoding written by `append_to` above.
+    let count = section.read::<U32Bytes<LittleEndian>>().ok()?;
+    let count = usize::try_from(count.get(LittleEndian)).ok()?;
+    let (offsets, traps) =
+        object::slice_from_bytes::<U32Bytes<LittleEndian>>(section.0, count).ok()?;
+    debug_assert_eq!(traps.len(), count);
+
+    // The `offsets` table is sorted in the trap section so perform a binary
+    // search of the contents of this section to find whether `offset` is an
+    // entry in the section. Note that this is a precise search because trap pcs
+    // should always be precise as well as our metadata about them, which means
+    // we expect an exact match to correspond to a trap opcode.
+    //
+    // Once an index is found within the `offsets` array then that same index is
+    // used to lookup from the `traps` list of bytes to get the trap code byte
+    // corresponding to this offset.
+    let offset = u32::try_from(offset).ok()?;
+    let index = offsets
+        .binary_search_by_key(&offset, |val| val.get(LittleEndian))
+        .ok()?;
+    debug_assert!(index < traps.len());
+    let trap = *traps.get(index)?;
+
+    // FIXME: this could use some sort of derive-like thing to avoid having to
+    // deduplicate the names here.
+    //
+    // This simply converts from the `trap`, a `u8`, to the `TrapCode` enum.
+    macro_rules! check {
+        ($($name:ident)*) => ($(if trap == TrapCode::$name as u8 {
+            return Some(TrapCode::$name);
+        })*);
+    }
+
+    check! {
+        StackOverflow
+        HeapOutOfBounds
+        HeapMisaligned
+        TableOutOfBounds
+        IndirectCallToNull
+        BadSignature
+        IntegerOverflow
+        IntegerDivisionByZero
+        BadConversionToInteger
+        UnreachableCodeReached
+        Interrupt
+    }
+
+    if cfg!(debug_assertions) {
+        panic!("missing mapping for {}", trap);
+    } else {
+        None
+    }
+}

crates/jit/src/instantiate.rs

@@ -18,7 +18,7 @@ use thiserror::Error;
 use wasmtime_environ::{
     CompileError, DefinedFuncIndex, FunctionInfo, InstanceSignature, InstanceTypeIndex, Module,
     ModuleSignature, ModuleTranslation, ModuleTypeIndex, PrimaryMap, SignatureIndex,
-    StackMapInformation, Tunables, WasmFuncType, ELF_WASMTIME_ADDRMAP,
+    StackMapInformation, Tunables, WasmFuncType, ELF_WASMTIME_ADDRMAP, ELF_WASMTIME_TRAPS,
 };
 use wasmtime_runtime::{GdbJitImageRegistration, InstantiationError, VMFunctionBody, VMTrampoline};
 
@@ -269,6 +269,7 @@ impl ModuleCode {
 pub struct CompiledModule {
     wasm_data: Range<usize>,
     address_map_data: Range<usize>,
+    trap_data: Range<usize>,
     artifacts: CompilationArtifacts,
     module: Arc<Module>,
     funcs: PrimaryMap<DefinedFuncIndex, FunctionInfo>,
@@ -315,6 +316,7 @@ impl CompiledModule {
         let funcs = info.funcs;
         let wasm_data = subslice_range(section(ELF_WASM_DATA)?, &artifacts.obj);
         let address_map_data = subslice_range(section(ELF_WASMTIME_ADDRMAP)?, &artifacts.obj);
+        let trap_data = subslice_range(section(ELF_WASMTIME_TRAPS)?, &artifacts.obj);
 
         // Allocate all of the compiled functions into executable memory,
         // copying over their contents.
@@ -337,6 +339,7 @@ impl CompiledModule {
             artifacts,
             wasm_data,
             address_map_data,
+            trap_data,
             code: Arc::new(ModuleCode {
                 range: (start, end),
                 code_memory,
@@ -393,6 +396,13 @@ impl CompiledModule {
         &self.artifacts.obj[self.address_map_data.clone()]
     }
 
+    /// Returns the encoded trap information for this compiled image.
+    ///
+    /// For more information see `wasmtime_environ::trap_encoding`.
+    pub fn trap_data(&self) -> &[u8] {
+        &self.artifacts.obj[self.trap_data.clone()]
+    }
+
     /// Return a reference-counting pointer to a module.
     pub fn module(&self) -> &Arc<Module> {
         &self.module

crates/wasmtime/src/module/registry.rs

@@ -5,7 +5,7 @@ use std::{
     collections::BTreeMap,
     sync::{Arc, RwLock},
 };
-use wasmtime_environ::{EntityRef, FilePos, StackMap, TrapInformation};
+use wasmtime_environ::{EntityRef, FilePos, StackMap, TrapCode};
 use wasmtime_jit::CompiledModule;
 use wasmtime_runtime::{ModuleInfo, VMCallerCheckedAnyfunc, VMTrampoline};
 
@@ -262,9 +262,9 @@ impl GlobalModuleRegistry {
     }
 
     /// Fetches trap information about a program counter in a backtrace.
-    pub(crate) fn lookup_trap_info(&self, pc: usize) -> Option<&TrapInformation> {
+    pub(crate) fn lookup_trap_code(&self, pc: usize) -> Option<TrapCode> {
         let (module, offset) = self.module(pc)?;
-        module.lookup_trap_info(offset)
+        wasmtime_environ::lookup_trap_code(module.module.trap_data(), offset)
     }
 
     /// Registers a new region of code, described by `(start, end)` and with
@@ -371,17 +371,6 @@ impl GlobalRegisteredModule {
             symbols,
         })
     }
-
-    /// Fetches trap information about a program counter in a backtrace.
-    pub fn lookup_trap_info(&self, text_offset: usize) -> Option<&TrapInformation> {
-        let (index, func_offset) = self.module.func_by_text_offset(text_offset)?;
-        let info = self.module.func_info(index);
-        let idx = info
-            .traps
-            .binary_search_by_key(&func_offset, |info| info.code_offset)
-            .ok()?;
-        Some(&info.traps[idx])
-    }
 }
 
 /// Description of a frame in a backtrace for a [`Trap`].

crates/wasmtime/src/trap.rs

@@ -172,8 +172,7 @@ impl Trap {
             } => {
                 let mut code = GlobalModuleRegistry::with(|modules| {
                     modules
-                        .lookup_trap_info(pc)
-                        .map(|info| info.trap_code)
+                        .lookup_trap_code(pc)
                         .unwrap_or(EnvTrapCode::StackOverflow)
                 });
                 if maybe_interrupted && code == EnvTrapCode::StackOverflow {