synth_core/backend.rs
1//! Backend trait and registry for multi-backend compilation
2//!
3//! Every compiler backend (ARM, aWsm, wasker, w2c2) implements the `Backend`
4//! trait, allowing the CLI and verification framework to treat them uniformly.
5
6use crate::target::TargetSpec;
7use crate::wasm_decoder::DecodedModule;
8use crate::wasm_op::WasmOp;
9use crate::wsc_facts::WscFact;
10use std::collections::HashMap;
11use thiserror::Error;
12
13/// Errors from backend compilation
14#[derive(Debug, Error)]
15pub enum BackendError {
16 #[error("compilation failed: {0}")]
17 CompilationFailed(String),
18
19 #[error("backend not available: {0}")]
20 NotAvailable(String),
21
22 #[error("unsupported configuration: {0}")]
23 UnsupportedConfig(String),
24
25 #[error("external tool error: {0}")]
26 ExternalToolError(String),
27}
28
29/// Memory-bounds safety strategy. Phase 1 of `docs/binary-safety-design.md` §3.1.
30///
31/// - `Mpu`/PMP: rely on hardware (ARM MPU or RV32 PMP) — no inline check.
32/// - `Software`: emit a `CMP/BHS Trap_Handler` (ARM) or `bgeu addr, mem_size, ebreak` (RV32)
33/// before every load/store.
34/// - `Mask`: emit `AND addr, addr, #(mem_size - 1)` — only valid when memory size
35/// is a power of two. Wraps on OOB rather than trapping (fuzz-profile semantics).
36/// - `None`: no bounds enforcement.
37#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
38pub enum SafetyBounds {
39 /// No bounds check (caller assumes the WASM module is trusted)
40 #[default]
41 None,
42 /// ARM MPU / RV32 PMP — hardware enforcement, no inline guard
43 Mpu,
44 /// Software CMP/BHS (ARM) or BGEU+EBREAK (RV32) per access
45 Software,
46 /// AND-mask, requires power-of-two memory size
47 Mask,
48}
49
50impl SafetyBounds {
51 /// Parse the `--safety-bounds` argument value.
52 pub fn parse(s: &str) -> std::result::Result<Self, String> {
53 match s {
54 "none" => Ok(SafetyBounds::None),
55 "mpu" | "pmp" => Ok(SafetyBounds::Mpu),
56 "software" | "soft" => Ok(SafetyBounds::Software),
57 "mask" | "masking" => Ok(SafetyBounds::Mask),
58 other => Err(format!(
59 "unknown --safety-bounds value '{}'; expected one of: none, mpu, software, mask",
60 other
61 )),
62 }
63 }
64
65 /// String form used in the safety manifest.
66 pub fn as_str(self) -> &'static str {
67 match self {
68 SafetyBounds::None => "none",
69 SafetyBounds::Mpu => "mpu",
70 SafetyBounds::Software => "software",
71 SafetyBounds::Mask => "mask",
72 }
73 }
74}
75
76/// The absolute SRAM address the OPTIMIZED (non-relocatable) ARM path
77/// materializes as its linear-memory base (`MOVW/MOVT R12, #base` before each
78/// const-address access, and the #468 base-CSE R11 hoist). Historical value:
79/// 256 bytes above the SRAM start — the differential-harness contract for
80/// optimized-path fixtures maps linmem here. `CompileConfig::linmem_base`
81/// defaults to this; `--stack-layout=low` (#687) shifts it up by the reserved
82/// stack size so the moved layout reaches user code, not just the startup.
83pub const OPTIMIZED_LINMEM_BASE: u32 = 0x2000_0100;
84
85/// Configuration for a compilation run
86#[derive(Debug, Clone)]
87pub struct CompileConfig {
88 /// Optimization level (0 = none, 1 = fast, 2 = default, 3 = aggressive)
89 pub opt_level: u8,
90 /// Target specification
91 pub target: TargetSpec,
92 /// Legacy: enable software bounds checking for memory operations.
93 /// Deprecated in favor of `safety_bounds`. When set, equivalent to
94 /// `SafetyBounds::Software`. Kept for backwards compatibility with
95 /// callers that haven't migrated yet.
96 pub bounds_check: bool,
97 /// Phase-1 unified safety-bounds knob. If `bounds_check` is `true` and
98 /// this is `None`, the legacy field wins (back-compat). If both are set,
99 /// `safety_bounds` wins.
100 pub safety_bounds: SafetyBounds,
101 /// Hardware profile name (e.g. "nrf52840", "stm32f407")
102 pub hardware: String,
103 /// Skip optimization passes (direct instruction selection)
104 pub no_optimize: bool,
105 /// Use Loom-compatible optimization preset
106 pub loom_compat: bool,
107 /// Number of imported functions (calls to indices below this use Meld dispatch)
108 pub num_imports: u32,
109 /// AAPCS integer-argument count per function, indexed by full WASM function
110 /// index (imports first, then locals). Lets `Call` marshal the right number
111 /// of operand-stack values into R0–R3 (issue #195). Empty = pass no args
112 /// (pre-#195 behaviour).
113 pub func_arg_counts: Vec<u32>,
114 /// AAPCS integer-argument count per function type, indexed by type index.
115 /// Used by `call_indirect` (issue #195).
116 pub type_arg_counts: Vec<u32>,
117 /// Produce relocatable (ET_REL) host-link output. When set, the backend
118 /// uses the direct instruction selector (`select_with_stack`) rather than
119 /// the optimized path: the optimizer materializes an *absolute* linear-
120 /// memory base (0x20000100) and does not preserve caller-saved registers
121 /// across calls, both wrong for a host-linked object where the linmem base
122 /// is supplied via `fp` at runtime and callees follow AAPCS. Imports are
123 /// also emitted as direct `func_N` BLs (resolved to the wasm field name)
124 /// instead of `__meld_dispatch_import`. (#197 — follow-up to #188/#171.)
125 pub relocatable: bool,
126
127 /// #687 (`--stack-layout=low`): the absolute linear-memory base the
128 /// OPTIMIZED ARM path materializes into user code. Defaults to
129 /// [`OPTIMIZED_LINMEM_BASE`] (`0x2000_0100`, byte-identical to every
130 /// pre-#687 compile). Under the low stack layout the CLI shifts it up by
131 /// the reserved stack size so const-address loads/stores land in the moved
132 /// linear memory instead of the stack region. Only the optimized
133 /// (non-relocatable) path consumes it — the direct selector is R11/fp
134 /// - relative and follows the startup's R11 init instead.
135 pub linmem_base: u32,
136
137 /// #237: emit wasm function-static data as a base-independent `.data`
138 /// section (`__synth_wasm_data`) addressed via MOVW/MOVT symbol relocations,
139 /// so a host-pointer drop-in (linmem base = 0 for native `*ptr` derefs)
140 /// doesn't mis-resolve the statics. Off by default — only the leaves'
141 /// base-relative `[R11+const]` path is used unless explicitly requested.
142 pub native_pointer_abi: bool,
143
144 /// #237: wasm linear-memory minimum size in bytes — the full static-data
145 /// extent (initialized `(data)` segments plus the zero-init/BSS region).
146 /// Under `native_pointer_abi`, a const memory address below this is a wasm
147 /// static → symbol-relative; any address beyond it is a runtime host pointer
148 /// → `[R11=0 + addr]`.
149 pub linear_memory_bytes: u32,
150
151 /// #237: the wasm stack-pointer global as `(index, init_value)`, if the
152 /// module has one. Under `native_pointer_abi` the backend register-promotes
153 /// it: `global.get` materializes `__synth_wasm_data + init` (the real stack
154 /// top) and the init value doubles as the static-data base that separates
155 /// pointer consts (`>= init`) from frame-size scalars (`< init`).
156 pub stack_pointer_global: Option<(u32, i32)>,
157 /// #311: per-function (full index) / per-type "returns i64" — the call
158 /// lowering must tag i64 results as a register pair or the hi half is
159 /// invisible to liveness.
160 pub func_ret_i64: Vec<bool>,
161 pub type_ret_i64: Vec<bool>,
162 /// #643: byte width of each defined global's storage slot, indexed by
163 /// global index — 4 for i32/f32, 8 for i64/f64, 16 for v128 (from the
164 /// module's global section). The globals table is laid out by SUMMING
165 /// these widths: an i64 global needs a register-PAIR store/load at
166 /// `[R9, off]`/`[R9, off+4]`, and every later global's offset shifts.
167 /// Empty ⇒ every global assumed 4 bytes (the legacy `idx * 4` layout;
168 /// hand-built op streams and i32-only modules are byte-identical).
169 pub global_widths: Vec<u32>,
170 /// #359: declared parameter widths per *function* (full index, imports
171 /// first): `func_params_i64[f][k]` is true when param `k` of function `f` is
172 /// i64/f64. The AAPCS stack-argument path needs the *declared* widths
173 /// (op-stream inference can't see an unused i64 param that still shifts the
174 /// incoming-stack layout). The source of truth — a per-function driver loop
175 /// (`compile_module` / the CLI loop) indexes it by `func.index` and copies
176 /// the slice into [`current_func_params_i64`] before each `compile_function`.
177 /// Empty → every param assumed i32 (the legacy path; keeps every function
178 /// with <=4 params, or all-i32 params, byte-identical).
179 pub func_params_i64: Vec<Vec<bool>>,
180 /// #359: declared parameter widths of the function CURRENTLY being compiled
181 /// — `current_func_params_i64[k]` is true when param `k` is i64/f64. Set per
182 /// function (a cheap clone of the config) from [`func_params_i64`] by the
183 /// driver loop, because `compile_function` is shared across backends and
184 /// carries no function index. Empty → assume i32.
185 pub current_func_params_i64: Vec<bool>,
186 /// GI-FPU-002 (#619/#369): per-function declared f32-param mask (full index,
187 /// imports first). The driver copies `func_params_f32[f]` into
188 /// [`current_func_params_f32`] before each `compile_function`. Empty ⇒
189 /// all-non-f32 (byte-identical to before).
190 pub func_params_f32: Vec<Vec<bool>>,
191 /// GI-FPU-002: declared f32-param mask of the function CURRENTLY being
192 /// compiled — `current_func_params_f32[k]` is true when param `k` is f32.
193 /// Set per function from [`func_params_f32`], mirroring
194 /// [`current_func_params_i64`]. Empty ⇒ no f32 params.
195 pub current_func_params_f32: Vec<bool>,
196 /// #457: DECLARED parameter count of the function CURRENTLY being compiled,
197 /// from the module's type section (`func_arg_counts[func.index]`). Set per
198 /// function by the driver loops like [`current_func_params_i64`].
199 ///
200 /// The backends otherwise INFER the param count from local-access patterns
201 /// (`count_params`: a local whose first access is a read is assumed to be a
202 /// param) — which cannot distinguish a param from a read-before-write
203 /// non-param local. WASM zero-initializes non-param locals, so such a local
204 /// must read 0; the inference instead homed it in a parameter register and
205 /// read caller garbage (#457). The backends cap the inferred count at this
206 /// declared count when it is present, which reclassifies exactly the
207 /// read-before-write locals (an inferred count can only exceed the declared
208 /// one via a read-first index >= the declared count) and leaves every other
209 /// function's codegen byte-identical.
210 ///
211 /// `None` → declared signature unknown (hand-built op streams, direct
212 /// `compile_function` callers) → pure inference, the legacy behaviour.
213 pub current_func_param_count: Option<u32>,
214 /// #509: blocktype-arity side-table of the function CURRENTLY being compiled
215 /// — `(param_count, result_count)` of the k-th `Block`/`Loop`/`If` in its op
216 /// stream (ordinal-keyed; see [`FunctionOps::block_arity`]). Set per function
217 /// by the driver loop (like [`current_func_params_i64`]). The direct selector
218 /// uses it to land a value carried by `br`/`br_if`/`br_table` in the target
219 /// block's designated result register instead of dropping it. Empty → every
220 /// block treated as void (the legacy lowering; hand-built op streams).
221 ///
222 /// [`FunctionOps::block_arity`]: crate::wasm_decoder::FunctionOps::block_arity
223 pub current_func_block_arity: Vec<(u8, u8)>,
224
225 /// #543 Phase 1 — integrator-marked volatile linear-memory segments (the DMA
226 /// transfer window). Each range `[base, base+len)` names a region of the fused
227 /// linear memory that an EXTERNAL agent (the DMA engine, modelled by gale as a
228 /// Component-Model `own<buffer>` handoff — gale decision `DD-DMA-REGION-001`,
229 /// gale#124) rewrites out-of-band. Loads and stores whose address falls inside
230 /// a marked range must eventually be treated as VOLATILE: not cached, hoisted,
231 /// or reordered across the transfer boundary.
232 ///
233 /// PHASE-2 CONTRACT (implemented — issue #543): the optimizer's
234 /// address-caching passes HONOR these ranges. Consumption points:
235 /// - the #468 base-CSE / const-address-fold
236 /// (`optimizer_bridge::plan_base_cse`, DEFAULT-ON, opt-out
237 /// `SYNTH_BASE_CSE=0`): a const-address access whose 4-byte window
238 /// intersects a marked range is EXCLUDED from the fold set — it keeps
239 /// its verbatim per-access materialize-and-access codegen, while
240 /// accesses outside the range still fold;
241 /// - const-CSE (`liveness::apply_const_cse` wired in `arm_backend.rs`,
242 /// DEFAULT-ON, opt-out `SYNTH_CONST_CSE=0`; the former bridge-level
243 /// inline cache is retired, #242): declines WHOLESALE while any range is
244 /// marked — a cached constant cannot be classified address-vs-data at
245 /// that level, so the conservative stance for statically-unknown
246 /// addressing is to re-materialize every constant at each occurrence.
247 ///
248 /// Passes that only touch SP-relative frame slots (stack-reload forwarding,
249 /// frame-slot DCE, spill re-choice) are unaffected by design: these ranges
250 /// are LINEAR-MEMORY addresses, and frame slots are never linmem. Nothing on
251 /// the pipeline deletes, forwards, or reorders a linear-memory access (IR CSE
252 /// deliberately never CSEs `MemLoad`s; DCE removes only unreachable blocks),
253 /// so every marked access is issued verbatim, in program order.
254 ///
255 /// Empty (the default): zero behavior change by construction — every gate
256 /// reduces to the pre-#543 path, so the emitted `.text` is byte-identical
257 /// with or without this code (the frozen-codegen gate holds). See rivet
258 /// `VCR-DMA-001`.
259 pub volatile_segments: Vec<VolatileRange>,
260
261 /// VCR-PERF-002 Phase 1 (#494) — proven invariants forwarded by loom in
262 /// the `wsc.facts` custom section (encoding:
263 /// `docs/design/wsc-facts-encoding.md`; program:
264 /// `docs/design/proof-carrying-specialization.md`), whole-module table
265 /// keyed by `(func_index, value_id)`. The compile driver copies the
266 /// current function's slice into [`current_func_facts`] (the
267 /// `func_params_i64` → `current_func_params_i64` pattern), because
268 /// `compile_function` carries no function index.
269 ///
270 /// PHASE-1 CONTRACT: threaded but NOT consumed — no codegen path reads
271 /// facts, so emitted bytes are unchanged whether or not the module
272 /// carries the section (locked by `wsc_facts_ingestion_494.rs`). Phase 2
273 /// turns each fact into a premise for a flag-gated (`SYNTH_FACT_SPEC`),
274 /// per-elision ordeal-validated specialization; the facts-absent compile
275 /// stays byte-identical by construction (empty ⇒ every gate vacuous).
276 ///
277 /// [`current_func_facts`]: CompileConfig::current_func_facts
278 pub wsc_facts: Vec<WscFact>,
279 /// VCR-PERF-002 Phase 1 (#494): the `wsc.facts` invariants of the function
280 /// CURRENTLY being compiled (`fact.func_index == func.index`), set per
281 /// function by the driver loops like [`current_func_params_i64`]. This is
282 /// the field a Phase-2 selector pass will read its premises from. Empty →
283 /// no facts → no specialization may ever fire (the fail-safe default).
284 ///
285 /// [`current_func_params_i64`]: CompileConfig::current_func_params_i64
286 pub current_func_facts: Vec<WscFact>,
287 /// VCR-PERF-002 Phase 2b (#494, divisor-nonzero): op indices (into the op
288 /// stream passed to `compile_function`) of `div`/`rem` ops whose
289 /// DIVIDE-BY-ZERO trap guard is proven dead — the fact-spec pass
290 /// discharged `UNSAT(P ∧ divisor == 0)` per site through the
291 /// certificate-checked ordeal solver BEFORE the driver set this field.
292 /// Consumed by the ARM direct selector (`select_with_stack`); every other
293 /// path ignores it (guards stay — sound). Empty (the default) ⇒ every
294 /// guard is emitted, byte-identical to today.
295 pub fact_div_zero_elide: Vec<usize>,
296 /// VCR-PERF-002 Phase 2b (#494): op indices of `div_s` ops whose
297 /// `INT_MIN / -1` OVERFLOW trap guard is proven dead — a SEPARATE
298 /// obligation (`UNSAT(P ∧ dividend == INT_MIN ∧ divisor == -1)`). A
299 /// divisor-nonzero fact alone NEVER lands here: divisor ≠ 0 does not
300 /// exclude -1 (#633/#634 two-guard distinction). Empty ⇒ guard emitted.
301 pub fact_div_ovf_elide: Vec<usize>,
302 /// #642: `call_indirect` guard inputs — the compile-time table size for
303 /// the runtime bounds check and the per-expected-type closed-world type
304 /// verdicts — computed from the decoded module by
305 /// [`crate::wasm_decoder::DecodedModule::call_indirect_guards`] and set by
306 /// the driver loops. The default (`table_size: None`, empty verdicts)
307 /// DECLINES every `call_indirect` lowering: an unchecked indirect branch
308 /// is never emitted (WASM Core §4.4.8 requires OOB/type-mismatch traps).
309 pub call_indirect_guards: crate::wasm_decoder::CallIndirectGuards,
310}
311
312/// #543 — an integrator-marked volatile linear-memory segment (the DMA transfer
313/// window): the half-open byte range `[base, base + len)` of the fused linear
314/// memory that an external agent rewrites out-of-band. Parsed from the CLI
315/// `--volatile-segment <base>:<len>` flag. See [`CompileConfig::volatile_segments`]
316/// for the Phase-1/Phase-2 split.
317#[derive(Debug, Clone, Copy, PartialEq, Eq)]
318pub struct VolatileRange {
319 /// Start address of the volatile region, in linear-memory bytes.
320 pub base: u32,
321 /// Length of the volatile region, in bytes. The region is `[base, base+len)`.
322 pub len: u32,
323}
324
325impl CompileConfig {
326 /// Resolve the effective safety-bounds setting, honouring the legacy
327 /// `bounds_check` field as a fallback. Used by backends to pick the
328 /// inline-check shape.
329 pub fn effective_safety_bounds(&self) -> SafetyBounds {
330 match (self.safety_bounds, self.bounds_check) {
331 (SafetyBounds::None, true) => SafetyBounds::Software,
332 (s, _) => s,
333 }
334 }
335}
336
337impl Default for CompileConfig {
338 fn default() -> Self {
339 Self {
340 opt_level: 2,
341 target: TargetSpec::cortex_m4(),
342 bounds_check: false,
343 safety_bounds: SafetyBounds::None,
344 hardware: String::new(),
345 no_optimize: false,
346 loom_compat: false,
347 num_imports: 0,
348 func_arg_counts: Vec::new(),
349 type_arg_counts: Vec::new(),
350 relocatable: false,
351 // #687: the historical optimized-path absolute base — every
352 // default compile stays byte-identical.
353 linmem_base: OPTIMIZED_LINMEM_BASE,
354 native_pointer_abi: false,
355 linear_memory_bytes: 0,
356 stack_pointer_global: None,
357 func_ret_i64: Vec::new(),
358 type_ret_i64: Vec::new(),
359 // #643: empty ⇒ legacy all-4-byte global slots (i32-only modules).
360 global_widths: Vec::new(),
361 func_params_i64: Vec::new(),
362 current_func_params_i64: Vec::new(),
363 func_params_f32: Vec::new(),
364 current_func_params_f32: Vec::new(),
365 // #457: None ⇒ declared signature unknown ⇒ param-count inference
366 // only (unit tests / hand-built op streams); driver loops fill it.
367 current_func_param_count: None,
368 // #509: empty ⇒ legacy void-block lowering (unit tests / hand-built
369 // op streams); the driver loops fill it per function.
370 current_func_block_arity: Vec::new(),
371 // #543 Phase 1: no volatile segments unless the CLI flag names them.
372 // Empty ⇒ inert ⇒ emitted bytes unchanged.
373 volatile_segments: Vec::new(),
374 // VCR-PERF-002 Phase 1 (#494): no facts unless the module carries
375 // a parseable `wsc.facts` section. Empty ⇒ inert (and Phase 1 has
376 // no consumer anyway) ⇒ emitted bytes unchanged.
377 wsc_facts: Vec::new(),
378 current_func_facts: Vec::new(),
379 // VCR-PERF-002 Phase 2b (#494): no guard-elision marks unless the
380 // fact-spec pass discharged the per-site obligations. Empty ⇒
381 // every div/rem trap guard is emitted, byte-identical.
382 fact_div_zero_elide: Vec::new(),
383 fact_div_ovf_elide: Vec::new(),
384 // #642: no guard inputs ⇒ every call_indirect lowering declines
385 // loudly (never an unchecked indirect branch). Driver loops fill
386 // this from the decoded module.
387 call_indirect_guards: crate::wasm_decoder::CallIndirectGuards::default(),
388 }
389 }
390}
391
392/// A relocation entry produced during compilation
393///
394/// Records that a BL instruction at `offset` bytes into the function's code
395/// targets an external symbol (e.g., `__meld_dispatch_import`). The linker
396/// resolves these when combining the Synth object with the Kiln bridge.
397#[derive(Debug, Clone, Copy, PartialEq, Eq)]
398pub enum RelocKind {
399 /// R_ARM_THM_CALL — a Thumb BL call site (the default; #167).
400 ThmCall,
401 /// R_ARM_MOVW_ABS_NC — the MOVW half of a symbol-relative address (#237).
402 MovwAbs,
403 /// R_ARM_MOVT_ABS — the MOVT half of a symbol-relative address (#237).
404 MovtAbs,
405 /// R_ARM_ABS32 — a 32-bit absolute address held in a `.text` literal-pool
406 /// word, loaded via `LDR rX, [pc, #off]` (#345). The link-survivable
407 /// replacement for the inline-immediate MOVW/MOVT-ABS pair: `ld`/bfd patches
408 /// the data word at link time (`S + A`, the addend living in the word, REL
409 /// semantics), which survives placement into a large multi-object image —
410 /// whereas an inline-instruction MOVW_ABS immediate can be mangled.
411 Abs32,
412}
413
414#[derive(Debug, Clone, PartialEq, Eq)]
415pub struct CodeRelocation {
416 /// Byte offset within the function's machine code where the reloc applies
417 pub offset: u32,
418 /// Target symbol name (e.g., "__meld_dispatch_import", "__synth_wasm_data")
419 pub symbol: String,
420 /// Which ARM relocation type to emit for this site.
421 pub kind: RelocKind,
422}
423
424/// VCR-DBG-001: a per-instruction source map — `(machine_offset_within_code,
425/// wasm_op_index)` pairs, one per emitted machine instruction. A `None` op-index
426/// marks an instruction with no originating wasm op (prologue/epilogue, literal
427/// pool). Consumed by the DWARF `.debug_line` emitter; empty when no source map
428/// was produced.
429pub type LineMap = Vec<(u32, Option<usize>)>;
430
431/// A single compiled function
432#[derive(Debug, Clone)]
433pub struct CompiledFunction {
434 /// Function name (from WASM export or generated)
435 pub name: String,
436 /// Raw machine code bytes
437 pub code: Vec<u8>,
438 /// Original WASM ops (retained for verification)
439 pub wasm_ops: Vec<WasmOp>,
440 /// Relocations for external symbol references (BL to bridge functions)
441 pub relocations: Vec<CodeRelocation>,
442 /// VCR-DBG-001: per-instruction source map for DWARF `.debug_line` emission —
443 /// `(machine_offset_within_code, wasm_op_index)` captured at encode time, one
444 /// entry per emitted machine instruction. A `None` op-index marks an
445 /// instruction with no originating wasm op (prologue/epilogue, literal-pool
446 /// word). This is purely additive metadata: it is never serialized unless
447 /// `.debug_line` emission is requested, so the emitted `.text` is
448 /// byte-identical with or without it. Empty for backends/paths that do not
449 /// yet produce a source map (RISC-V, the optimized ARM path).
450 pub line_map: LineMap,
451}
452
453/// Result of compiling a full module
454#[derive(Debug)]
455pub struct CompilationResult {
456 /// Compiled functions
457 pub functions: Vec<CompiledFunction>,
458 /// Complete ELF binary (if backend produces one directly)
459 pub elf: Option<Vec<u8>>,
460 /// Name of the backend that produced this result
461 pub backend_name: String,
462}
463
464/// What a backend can and cannot do
465#[derive(Debug, Clone)]
466pub struct BackendCapabilities {
467 /// Backend produces complete ELF files (external backends like aWsm)
468 pub produces_elf: bool,
469 /// Backend supports per-rule verification (only our custom ARM backend)
470 pub supports_rule_verification: bool,
471 /// Backend supports binary-level verification (all backends via disassembly)
472 pub supports_binary_verification: bool,
473 /// Backend is an external tool (not a library)
474 pub is_external: bool,
475}
476
477/// Trait that every compilation backend implements
478pub trait Backend: Send + Sync {
479 /// Human-readable backend name
480 fn name(&self) -> &str;
481
482 /// What this backend can do
483 fn capabilities(&self) -> BackendCapabilities;
484
485 /// Which targets this backend supports
486 fn supported_targets(&self) -> Vec<TargetSpec>;
487
488 /// Compile an entire decoded WASM module
489 fn compile_module(
490 &self,
491 module: &DecodedModule,
492 config: &CompileConfig,
493 ) -> std::result::Result<CompilationResult, BackendError>;
494
495 /// Compile a single function from WASM ops to machine code
496 fn compile_function(
497 &self,
498 name: &str,
499 ops: &[WasmOp],
500 config: &CompileConfig,
501 ) -> std::result::Result<CompiledFunction, BackendError>;
502
503 /// Check if this backend is available (external tools installed, etc.)
504 fn is_available(&self) -> bool;
505}
506
507/// Registry of available backends
508pub struct BackendRegistry {
509 backends: HashMap<String, Box<dyn Backend>>,
510}
511
512impl BackendRegistry {
513 pub fn new() -> Self {
514 Self {
515 backends: HashMap::new(),
516 }
517 }
518
519 /// Register a backend under its name
520 pub fn register(&mut self, backend: Box<dyn Backend>) {
521 let name = backend.name().to_string();
522 self.backends.insert(name, backend);
523 }
524
525 /// Get a backend by name
526 pub fn get(&self, name: &str) -> Option<&dyn Backend> {
527 self.backends.get(name).map(|b| b.as_ref())
528 }
529
530 /// List all registered backends
531 pub fn list(&self) -> Vec<&dyn Backend> {
532 self.backends.values().map(|b| b.as_ref()).collect()
533 }
534
535 /// List backends that are actually available (installed and working)
536 pub fn available(&self) -> Vec<&dyn Backend> {
537 self.backends
538 .values()
539 .filter(|b| b.is_available())
540 .map(|b| b.as_ref())
541 .collect()
542 }
543}
544
545impl Default for BackendRegistry {
546 fn default() -> Self {
547 Self::new()
548 }
549}
550
551#[cfg(test)]
552mod tests {
553 use super::*;
554
555 #[test]
556 fn test_registry_empty() {
557 let reg = BackendRegistry::new();
558 assert!(reg.list().is_empty());
559 assert!(reg.available().is_empty());
560 assert!(reg.get("arm").is_none());
561 }
562
563 #[test]
564 fn test_compile_config_default() {
565 let config = CompileConfig::default();
566 assert_eq!(config.opt_level, 2);
567 assert!(!config.bounds_check);
568 assert_eq!(config.safety_bounds, SafetyBounds::None);
569 assert!(!config.no_optimize);
570 }
571
572 #[test]
573 fn safety_bounds_parse_round_trip() {
574 for s in ["none", "mpu", "software", "mask"] {
575 let sb = SafetyBounds::parse(s).unwrap();
576 assert_eq!(sb.as_str(), s);
577 }
578 assert_eq!(SafetyBounds::parse("pmp").unwrap(), SafetyBounds::Mpu);
579 assert_eq!(SafetyBounds::parse("soft").unwrap(), SafetyBounds::Software);
580 assert!(SafetyBounds::parse("nonsense").is_err());
581 }
582
583 #[test]
584 fn effective_safety_bounds_legacy_promotes_to_software() {
585 let cfg = CompileConfig {
586 bounds_check: true,
587 ..Default::default()
588 };
589 assert_eq!(cfg.effective_safety_bounds(), SafetyBounds::Software);
590 }
591
592 #[test]
593 fn effective_safety_bounds_new_field_wins() {
594 let cfg = CompileConfig {
595 bounds_check: true,
596 safety_bounds: SafetyBounds::Mpu,
597 ..Default::default()
598 };
599 assert_eq!(cfg.effective_safety_bounds(), SafetyBounds::Mpu);
600 }
601}