synth_backend/arm_backend.rs
1//! ARM Backend — wraps the instruction selector + optimizer + encoder as a Backend
2//!
3//! This is Synth's custom ARM compiler targeting Cortex-M (Thumb-2).
4//! It's the only backend that supports per-rule formal verification (ASIL D path).
5
6use crate::ArmEncoder;
7use synth_core::backend::{
8 Backend, BackendCapabilities, BackendError, CodeRelocation, CompilationResult, CompileConfig,
9 CompiledFunction, SafetyBounds,
10};
11use synth_core::target::{IsaVariant, TargetSpec};
12use synth_core::wasm_decoder::DecodedModule;
13use synth_core::wasm_op::WasmOp;
14use synth_synthesis::{
15 ArmInstruction, ArmOp, BoundsCheckConfig, InstructionSelector, OptimizationConfig,
16 OptimizerBridge, RuleDatabase, validate_instructions,
17};
18
19/// ARM Cortex-M backend using Synth's custom compiler pipeline
20pub struct ArmBackend;
21
22impl ArmBackend {
23 pub fn new() -> Self {
24 Self
25 }
26}
27
28impl Default for ArmBackend {
29 fn default() -> Self {
30 Self::new()
31 }
32}
33
34impl Backend for ArmBackend {
35 fn name(&self) -> &str {
36 "arm"
37 }
38
39 fn capabilities(&self) -> BackendCapabilities {
40 BackendCapabilities {
41 produces_elf: false,
42 supports_rule_verification: true,
43 supports_binary_verification: true,
44 is_external: false,
45 }
46 }
47
48 fn supported_targets(&self) -> Vec<TargetSpec> {
49 vec![
50 TargetSpec::cortex_m3(),
51 TargetSpec::cortex_m4(),
52 TargetSpec::cortex_m4f(),
53 TargetSpec::cortex_m7(),
54 TargetSpec::cortex_m7dp(),
55 ]
56 }
57
58 fn compile_module(
59 &self,
60 module: &DecodedModule,
61 config: &CompileConfig,
62 ) -> Result<CompilationResult, BackendError> {
63 let exports: Vec<_> = module
64 .functions
65 .iter()
66 .filter(|f| f.export_name.is_some())
67 .collect();
68
69 if exports.is_empty() {
70 return Err(BackendError::CompilationFailed(
71 "no exported functions found".into(),
72 ));
73 }
74
75 let mut functions = Vec::new();
76 for func in &exports {
77 let name = func.export_name.clone().unwrap();
78 let compiled = self.compile_function(&name, &func.ops, config)?;
79 functions.push(compiled);
80 }
81
82 Ok(CompilationResult {
83 functions,
84 elf: None,
85 backend_name: self.name().to_string(),
86 })
87 }
88
89 fn compile_function(
90 &self,
91 name: &str,
92 ops: &[WasmOp],
93 config: &CompileConfig,
94 ) -> Result<CompiledFunction, BackendError> {
95 let (code, relocations) =
96 compile_wasm_to_arm(ops, config).map_err(BackendError::CompilationFailed)?;
97
98 Ok(CompiledFunction {
99 name: name.to_string(),
100 code,
101 wasm_ops: ops.to_vec(),
102 relocations,
103 })
104 }
105
106 fn is_available(&self) -> bool {
107 true // Always available — it's a library backend
108 }
109}
110
111/// Count the number of function parameters by analyzing LocalGet patterns
112fn count_params(wasm_ops: &[WasmOp]) -> u32 {
113 let mut first_access: std::collections::HashMap<u32, bool> = std::collections::HashMap::new();
114 for op in wasm_ops {
115 match op {
116 WasmOp::LocalGet(idx) => {
117 first_access.entry(*idx).or_insert(true);
118 }
119 WasmOp::LocalSet(idx) | WasmOp::LocalTee(idx) => {
120 first_access.entry(*idx).or_insert(false);
121 }
122 _ => {}
123 }
124 }
125
126 first_access
127 .iter()
128 .filter_map(
129 |(&idx, &is_read_first)| {
130 if is_read_first { Some(idx + 1) } else { None }
131 },
132 )
133 .max()
134 .unwrap_or(0)
135}
136
137/// Core compilation: WASM ops → ARM machine code bytes + relocations
138///
139/// Returns (code_bytes, relocations) where relocations record BL instructions
140/// that target external symbols (e.g., `__meld_dispatch_import` for import calls).
141fn compile_wasm_to_arm(
142 wasm_ops: &[WasmOp],
143 config: &CompileConfig,
144) -> Result<(Vec<u8>, Vec<CodeRelocation>), String> {
145 let num_params = count_params(wasm_ops);
146
147 let bounds_config = match config.effective_safety_bounds() {
148 SafetyBounds::None => BoundsCheckConfig::None,
149 SafetyBounds::Mpu => BoundsCheckConfig::Mpu,
150 SafetyBounds::Software => BoundsCheckConfig::Software,
151 SafetyBounds::Mask => BoundsCheckConfig::Masking,
152 };
153
154 // The non-optimized (direct) instruction-selection path. Handles f32 via
155 // VFP/FPU. Used directly when `--no-optimize` is set, and as the fallback
156 // when the optimized path declines a module (see issue #120 below).
157 //
158 // VCR-RA-001 step 3b-lite (#242): a FRESH selector per attempt, with
159 // `spill_on_exhaustion` set only on the retry — the first pass is the
160 // unmodified default, so every function that compiles today is selected by
161 // exactly the code that compiled it yesterday (bit-identity is structural,
162 // not behavioural).
163 let select_direct_attempt =
164 |spill_on_exhaustion: bool| -> Result<Vec<ArmInstruction>, synth_core::Error> {
165 let db = RuleDatabase::with_standard_rules();
166 let mut selector =
167 InstructionSelector::with_bounds_check(db.rules().to_vec(), bounds_config);
168 selector.set_target(config.target.fpu, &config.target.triple);
169 if config.num_imports > 0 {
170 selector.set_num_imports(config.num_imports);
171 }
172 // #195: plumb the callee argument-count tables so the direct selector can
173 // marshal call arguments into R0–R3 per AAPCS.
174 selector.set_func_arg_counts(
175 config.func_arg_counts.clone(),
176 config.type_arg_counts.clone(),
177 );
178 // #197: in relocatable host-link mode, emit direct `func_N` BLs for
179 // imports (rewritten to the wasm field name by build_relocatable_elf)
180 // instead of `__meld_dispatch_import`.
181 selector.set_relocatable(config.relocatable);
182 // #237: native-pointer ABI — wasm statics become __synth_wasm_data-relative.
183 selector.set_native_pointer_abi(config.native_pointer_abi, config.linear_memory_bytes);
184 // #311: i64 call results are register PAIRS — tag them.
185 selector.set_result_types(config.func_ret_i64.clone(), config.type_ret_i64.clone());
186 // Stack-pointer promotion is meaningful only under the native-pointer ABI;
187 // gating here keeps every non-native compile (all frozen fixtures) on the
188 // legacy R9 globals-table path, bit-identical.
189 if config.native_pointer_abi
190 && let Some((sp_idx, sp_init)) = config.stack_pointer_global
191 {
192 selector.set_native_pointer_stack(sp_idx, sp_init);
193 }
194 selector.set_spill_on_exhaustion(spill_on_exhaustion);
195 selector.select_with_stack(wasm_ops, num_params)
196 };
197 let select_direct = || -> Result<Vec<ArmInstruction>, String> {
198 match select_direct_attempt(false) {
199 Ok(instrs) => Ok(instrs),
200 // VCR-RA-001 step 3b-lite (#242): the i32 register-exhaustion
201 // hard-fail is recoverable — retry once with spill-on-exhaustion,
202 // which reserves the spill area and spills the deepest stack value
203 // when the pool is full. Only functions that FAILED the first pass
204 // ever reach this, so existing output is untouched by construction.
205 Err(e)
206 if e.to_string()
207 .contains("all allocatable registers are live on the stack") =>
208 {
209 select_direct_attempt(true)
210 .map_err(|e| format!("instruction selection failed: {}", e))
211 }
212 Err(e) => Err(format!("instruction selection failed: {}", e)),
213 }
214 };
215
216 // Instruction selection: optimized or direct.
217 //
218 // #197: `--relocatable` (host-link ET_REL) forces the direct selector. The
219 // optimized path materializes an absolute linmem base (0x20000100) and does
220 // not preserve caller-saved registers across calls — both wrong for a
221 // host-linked object, where the linmem base arrives via `fp` at runtime and
222 // callees follow AAPCS. `select_with_stack` (now i64-spill capable after
223 // #171) handles fp-relative memory + caller-saved preservation correctly.
224 let arm_instrs = if config.no_optimize || config.relocatable {
225 select_direct()?
226 } else {
227 let opt_config = if config.loom_compat {
228 OptimizationConfig::loom_compat()
229 } else {
230 OptimizationConfig::all()
231 };
232
233 let mut bridge = OptimizerBridge::with_config(opt_config);
234 // #188: tell the bridge how many imports there are so it declines only
235 // LOCAL calls (and leaves import calls on the optimized path, keeping
236 // the #173 field-name relocation rewrite intact).
237 bridge.set_num_imports(config.num_imports);
238 // `ir_to_arm` now returns `Result` — an `Err` means the optimized path
239 // hit an unmapped vreg (issue-#93-class). Treat it identically to an
240 // `optimize_full` failure: fall back to the direct selector rather
241 // than propagating, so the function still compiles correctly.
242 match bridge
243 .optimize_full(wasm_ops)
244 .and_then(|(opt_ir, _cfg, _stats)| bridge.ir_to_arm(&opt_ir, num_params as usize))
245 {
246 Ok(arm_ops) => arm_ops
247 .into_iter()
248 .map(|op| ArmInstruction {
249 op,
250 source_line: None,
251 })
252 .collect(),
253 // Issue #120: the optimized path declines modules it cannot lower
254 // (notably scalar f32/f64 ops — the IR has no float opcodes). Fall
255 // back to the direct instruction selector, which handles f32 via
256 // VFP/FPU. This is honest degradation: the function still compiles
257 // correctly, just without IR-level optimization.
258 Err(_) => select_direct()?,
259 }
260 };
261
262 // #257/#277: `mul`+`add`→`mla` fusion is intentionally NOT wired here.
263 // The transform is correct and ready (`synth_synthesis::liveness::fuse_mul_add`,
264 // fully tested), but it is **register-allocation-coupled**: over the current
265 // greedy single-pass selector, folding `mul rM,..; add rD,rM,rX` → `mla`
266 // extends the live ranges of the mul inputs to the mla point, and the added
267 // pressure (extra moves/spills) costs more than the single-cycle MLA saves —
268 // gale measured a +2 cyc on-target REGRESSION (flat_flight 255→257, G474RE)
269 // even though it removes 2 instructions and the seam stays 0x07FDF307. So the
270 // fusion stays unwired until the spill-aware allocator (VCR-RA-001) chooses
271 // registers, at which point it becomes net-positive (per #272's plan and the
272 // wiring design note). Lesson (#277): a register-pressure-affecting transform
273 // needs an on-target/allocator-aware gate, not a byte-count gate, before it
274 // can default on.
275
276 // VCR-RA-001 const-CSE / rematerialization-avoidance (#209), the first
277 // allocator-analysis-driven CODEGEN change. Drops `movw` re-materializations
278 // of a constant already resident in another register and retargets the reads
279 // — every rewrite proven by the liveness analysis, and it ONLY removes
280 // materializations (pressure never rises), so unlike the mla fusion (#277) it
281 // cannot regress on-target. Runs on the selected stream before branch
282 // resolution (it removes instructions, shifting byte offsets). Behind
283 // `SYNTH_CONST_CSE=1` while it is validated against the differential oracle +
284 // gale's five on-target baselines; off by default keeps every fixture
285 // bit-identical.
286 let arm_instrs = if std::env::var("SYNTH_CONST_CSE").is_ok() {
287 synth_synthesis::liveness::apply_const_cse(&arm_instrs).0
288 } else {
289 arm_instrs
290 };
291
292 // VCR-RA-001 RANGE RE-ALLOCATION (#209/#242, wiring step 3a) — the first
293 // CONSEQUENTIAL allocator pass: re-colour each maximal straight-line
294 // segment over the R0-R8 pool with value ranges as the allocation unit
295 // (segment inputs + per-register live-outs pinned to their original
296 // registers, reserved R9-R12/SP identity-assigned — each segment is
297 // independently sound, no cross-segment liveness assumed). Renames
298 // registers only: never adds, removes, or reorders instructions, so
299 // labels/branch offsets are unaffected.
300 //
301 // DEFAULT-ON since v0.11.36: gale cleared the gate on-target (G474RE,
302 // #209 2026-06-10) — flag-on output byte-identical to flag-off on
303 // flat_flight/controller/control_step, fires on the filter family with
304 // zero cycle delta and a small size win, all selfchecks green on silicon.
305 // Opt out with `SYNTH_RANGE_REALLOC=0`; per-function stats with
306 // `SYNTH_REALLOC_STATS=1`.
307 //
308 // The companion dead callee-saved-save elimination (gale's "next
309 // consequential lever", same issue comment) then shrinks the prologue
310 // `push {r4-r8,lr}` / epilogue `pop {r4-r8,pc}` to the callee-saved
311 // registers the re-allocated body still touches (leaf-only,
312 // SP-untouched, even-count-padded — see shrink_callee_saved_saves):
313 // ~12 cycles of pure save/restore overhead removed on small leaves.
314 let realloc_on = std::env::var("SYNTH_RANGE_REALLOC").map_or(true, |v| v != "0");
315 let arm_instrs = if realloc_on {
316 use synth_synthesis::rules::Reg;
317 const POOL: [Reg; 9] = [
318 Reg::R0,
319 Reg::R1,
320 Reg::R2,
321 Reg::R3,
322 Reg::R4,
323 Reg::R5,
324 Reg::R6,
325 Reg::R7,
326 Reg::R8,
327 ];
328 let (out, stats) = synth_synthesis::liveness::reallocate_function(&arm_instrs, &POOL);
329 if std::env::var("SYNTH_REALLOC_STATS").is_ok() {
330 eprintln!(
331 "[range-realloc] {} segments: {} reallocated, {} declined, {} need spill (step 4)",
332 stats.segments, stats.reallocated, stats.declined, stats.needs_spill
333 );
334 }
335 synth_synthesis::liveness::shrink_callee_saved_saves(&out).unwrap_or(out)
336 } else {
337 arm_instrs
338 };
339
340 // VCR-RA-001 SHADOW ALLOCATION (#209/#242): run the register allocator on
341 // the selected stream and LOG what it finds — without changing a single
342 // emitted byte. This is the measure-only bridge between the built analysis
343 // layer and the eventual virtual-register wiring: it shows, per real
344 // function, whether the allocator can colour it within the R0–R8 pool and
345 // how much const-CSE / rematerialization headroom exists (#209). Enable with
346 // `SYNTH_SHADOW_ALLOC=1`; off by default and side-effect-free either way.
347 if std::env::var("SYNTH_SHADOW_ALLOC").is_ok() {
348 use synth_synthesis::liveness::{
349 AllocationOutcome, allocate_function, function_peak_pressure,
350 };
351 // R9 globals / R10 mem-size / R11 mem-base / R12 IP-scratch are reserved;
352 // pin them above the 0..9 allocatable pool so the colourer keeps R0–R8.
353 let precolored = std::collections::BTreeMap::from([
354 (synth_synthesis::rules::Reg::R9, 9usize),
355 (synth_synthesis::rules::Reg::R10, 10),
356 (synth_synthesis::rules::Reg::R11, 11),
357 (synth_synthesis::rules::Reg::R12, 12),
358 ]);
359 // True VALUE pressure (one node per value, not per reused physical reg):
360 // a NeedsSpill with peak ≤ 9 is a SPURIOUS physical-register spill — the
361 // function fits once virtually allocated.
362 let peak = function_peak_pressure(&arm_instrs);
363 match allocate_function(&arm_instrs, 9, &precolored) {
364 AllocationOutcome::Allocated {
365 remat_opportunities,
366 coloring,
367 } => eprintln!(
368 "[shadow-alloc] OK: {} pregs coloured within R0-R8 pool, peak value-pressure {}, {} const-CSE/remat opportunities",
369 coloring.len(),
370 peak,
371 remat_opportunities
372 ),
373 AllocationOutcome::NeedsSpill(s) => eprintln!(
374 "[shadow-alloc] physical-graph would spill {:?}, but peak value-pressure is {} (≤9 ⇒ spurious; fits once virtually allocated)",
375 s, peak
376 ),
377 AllocationOutcome::Declined => {
378 eprintln!(
379 "[shadow-alloc] declined (unmodeled construct — calls/i64/fp/offset-branch)"
380 )
381 }
382 }
383 }
384
385 // ISA feature gate: validate that all generated instructions are supported
386 // by the target. This catches FPU instructions on no-FPU targets, double-precision
387 // instructions on single-precision targets, etc.
388 validate_instructions(&arm_instrs, config.target.fpu, &config.target.triple)
389 .map_err(|e| format!("ISA validation failed: {}", e))?;
390
391 // Encode to binary — use Thumb-2 for Cortex-M targets
392 let use_thumb2 = matches!(config.target.isa, IsaVariant::Thumb2 | IsaVariant::Thumb);
393
394 let encoder = if use_thumb2 {
395 ArmEncoder::new_thumb2_with_fpu(config.target.fpu)
396 } else {
397 ArmEncoder::new_arm32()
398 };
399
400 // #202: resolve local label branches (Bcc/B/Bhs/Blo) to byte-accurate
401 // offsets before encoding. `select_with_stack` emits them as label
402 // placeholders and never resolves them — without this they encode as
403 // `bne.n #0` and land mid-instruction whenever a 32-bit Thumb-2 instruction
404 // sits between the branch and its target (UsageFault on real hardware).
405 // Only meaningful for Thumb-2 (the offset units are halfword/PC+4).
406 let arm_instrs = if use_thumb2 {
407 resolve_label_branches(arm_instrs, &encoder)?
408 } else {
409 arm_instrs
410 };
411
412 let mut code = Vec::new();
413 let mut relocations = Vec::new();
414
415 for instr in &arm_instrs {
416 // Record a relocation for every BL: the encoder emits `bl #0` and
417 // relies on a relocation to patch the target. This covers BOTH import
418 // dispatch stubs (`__meld_*`, undefined externals) AND internal calls
419 // (`func_N`, defined in this object). Previously only `__meld_*` was
420 // recorded, so internal `BL func_N` calls were left as unpatched
421 // `bl #0` placeholders branching to a garbage address (#167).
422 if let ArmOp::Bl { label } = &instr.op {
423 relocations.push(CodeRelocation {
424 offset: code.len() as u32,
425 symbol: label.clone(),
426 kind: synth_core::backend::RelocKind::ThmCall,
427 });
428 }
429 // #237: symbol-relative MOVW/MOVT (the `--native-pointer-abi` static-data
430 // addressing). The encoder writes the addend in place; record the matching
431 // R_ARM_MOVW_ABS_NC / R_ARM_MOVT_ABS so the linker adds the symbol address.
432 if let ArmOp::MovwSym { symbol, .. } = &instr.op {
433 relocations.push(CodeRelocation {
434 offset: code.len() as u32,
435 symbol: symbol.clone(),
436 kind: synth_core::backend::RelocKind::MovwAbs,
437 });
438 }
439 if let ArmOp::MovtSym { symbol, .. } = &instr.op {
440 relocations.push(CodeRelocation {
441 offset: code.len() as u32,
442 symbol: symbol.clone(),
443 kind: synth_core::backend::RelocKind::MovtAbs,
444 });
445 }
446
447 let encoded = encoder
448 .encode(&instr.op)
449 .map_err(|e| format!("ARM encoding failed: {}", e))?;
450 code.extend_from_slice(&encoded);
451 }
452
453 Ok((code, relocations))
454}
455
456/// Resolve local label branches to byte-accurate offsets (#202).
457///
458/// `select_with_stack` emits conditional/unconditional branches as label
459/// placeholders (`Bcc`/`B`/`Bhs`/`Blo` + `Label`) and never resolves them; the
460/// encoder then emits a `0xD000`/`0xE000` placeholder with offset 0. Before #197
461/// this path only ran for `--no-optimize`/declined functions, so the latent bug
462/// stayed hidden — routing relocatable code through it surfaced branches that
463/// land mid-instruction (a Cortex-M UsageFault) whenever a 32-bit Thumb-2
464/// instruction sits between the branch and its target.
465///
466/// This pass encodes each instruction to learn its real byte length (so 16- vs
467/// 32-bit forms and multi-instruction expansions are exact), maps each `Label`
468/// to its byte position, and rewrites every label branch to the displacement
469/// the encoder consumes: `(target - branch - 4) / 2` halfwords. A bounded
470/// fixed-point handles an offset growing a branch from 16- to 32-bit (which
471/// shifts later positions). `BCondOffset`/`BOffset` already produced inline by
472/// the optimized path carry no label and are left untouched.
473fn resolve_label_branches(
474 arm_instrs: Vec<ArmInstruction>,
475 encoder: &ArmEncoder,
476) -> Result<Vec<ArmInstruction>, String> {
477 use std::collections::HashMap;
478 use synth_synthesis::Condition;
479
480 enum BKind {
481 Cond(Condition),
482 Uncond,
483 }
484 // Record each label branch ONCE — indices are stable across iterations.
485 let mut branches: Vec<(usize, BKind, String)> = Vec::new();
486 for (i, instr) in arm_instrs.iter().enumerate() {
487 match &instr.op {
488 ArmOp::Bcc { cond, label } => branches.push((i, BKind::Cond(*cond), label.clone())),
489 ArmOp::Bhs { label } => branches.push((i, BKind::Cond(Condition::HS), label.clone())),
490 ArmOp::Blo { label } => branches.push((i, BKind::Cond(Condition::LO), label.clone())),
491 ArmOp::B { label } => branches.push((i, BKind::Uncond, label.clone())),
492 _ => {}
493 }
494 }
495 if branches.is_empty() {
496 return Ok(arm_instrs);
497 }
498
499 let mut resolved = arm_instrs;
500 // Sizes only grow (16→32-bit), so this converges quickly; cap for safety.
501 for _ in 0..16 {
502 // 1. Byte position of each instruction (Label encodes to 0 bytes).
503 let mut positions = Vec::with_capacity(resolved.len());
504 let mut pos: i64 = 0;
505 for instr in &resolved {
506 positions.push(pos);
507 pos += encoder
508 .encode(&instr.op)
509 .map_err(|e| format!("branch-resolve size probe failed: {}", e))?
510 .len() as i64;
511 }
512 // 2. Label name -> byte position (owned keys so the borrow ends here).
513 let mut labels: HashMap<String, i64> = HashMap::new();
514 for (i, instr) in resolved.iter().enumerate() {
515 if let ArmOp::Label { name } = &instr.op {
516 labels.insert(name.clone(), positions[i]);
517 }
518 }
519 // 3. Rewrite each branch to its byte-accurate offset.
520 let mut changed = false;
521 for (idx, kind, label) in &branches {
522 // A label not defined locally is an EXTERNAL target (e.g.
523 // `Trap_Handler` resolved by a relocation / the vector table). Leave
524 // such branches as their placeholder for the existing relocation
525 // path — only local control-flow labels are byte-resolved here.
526 let Some(&target) = labels.get(label) else {
527 continue;
528 };
529 // Encoder consumes the field as (target - branch - 4) / 2 halfwords.
530 // Positions are always even, so this division is exact.
531 let halfword_offset = ((target - positions[*idx] - 4) / 2) as i32;
532 let new_op = match kind {
533 BKind::Cond(c) => ArmOp::BCondOffset {
534 cond: *c,
535 offset: halfword_offset,
536 },
537 BKind::Uncond => ArmOp::BOffset {
538 offset: halfword_offset,
539 },
540 };
541 if resolved[*idx].op != new_op {
542 resolved[*idx].op = new_op;
543 changed = true;
544 }
545 }
546 if !changed {
547 break;
548 }
549 }
550 Ok(resolved)
551}
552
553#[cfg(test)]
554mod tests {
555 use super::*;
556
557 #[test]
558 fn test_arm_backend_name() {
559 let backend = ArmBackend::new();
560 assert_eq!(backend.name(), "arm");
561 assert!(backend.is_available());
562 }
563
564 #[test]
565 fn test_arm_backend_capabilities() {
566 let backend = ArmBackend::new();
567 let caps = backend.capabilities();
568 assert!(!caps.produces_elf);
569 assert!(caps.supports_rule_verification);
570 assert!(!caps.is_external);
571 }
572
573 #[test]
574 fn test_compile_add_function() {
575 let backend = ArmBackend::new();
576 let ops = vec![WasmOp::LocalGet(0), WasmOp::LocalGet(1), WasmOp::I32Add];
577 let config = CompileConfig::default();
578
579 let result = backend.compile_function("add", &ops, &config);
580 assert!(result.is_ok());
581
582 let func = result.unwrap();
583 assert_eq!(func.name, "add");
584 assert!(!func.code.is_empty());
585 assert_eq!(func.wasm_ops, ops);
586 }
587
588 #[test]
589 fn test_count_params() {
590 let ops = vec![WasmOp::LocalGet(0), WasmOp::LocalGet(1), WasmOp::I32Add];
591 assert_eq!(count_params(&ops), 2);
592
593 let no_params = vec![WasmOp::I32Const(5), WasmOp::I32Const(3), WasmOp::I32Add];
594 assert_eq!(count_params(&no_params), 0);
595 }
596
597 #[test]
598 fn test_arm_backend_register() {
599 let mut registry = synth_core::BackendRegistry::new();
600 registry.register(Box::new(ArmBackend::new()));
601 assert!(registry.get("arm").is_some());
602 assert_eq!(registry.available().len(), 1);
603 }
604
605 #[test]
606 fn test_compile_import_call_produces_relocations() {
607 let backend = ArmBackend::new();
608 // Simulate a WASM module where func index 0 is an import.
609 // Call(0) should generate MOV R0, #0; BL __meld_dispatch_import
610 let ops = vec![WasmOp::Call(0)];
611 let config = CompileConfig {
612 num_imports: 1,
613 no_optimize: true, // Direct instruction selection to preserve Call semantics
614 ..CompileConfig::default()
615 };
616
617 let result = backend.compile_function("caller", &ops, &config);
618 assert!(result.is_ok());
619
620 let func = result.unwrap();
621 assert!(!func.code.is_empty());
622 assert_eq!(func.relocations.len(), 1);
623 assert_eq!(func.relocations[0].symbol, "__meld_dispatch_import");
624 // The BL is the second instruction (after MOV R0, #0), so offset should be > 0
625 assert!(func.relocations[0].offset > 0);
626 }
627
628 /// Regression test for #197: in `relocatable` mode, an import call must
629 /// relocate against the direct `func_N` symbol (rewritten to the wasm field
630 /// name by `build_relocatable_elf`), NOT `__meld_dispatch_import`. This is
631 /// the ABI half of the #197 fix — without it, a host linker cannot resolve
632 /// the call to the real kernel symbol (e.g. `k_spin_lock`).
633 #[test]
634 fn test_compile_relocatable_import_uses_direct_func_symbol_197() {
635 let backend = ArmBackend::new();
636 let ops = vec![WasmOp::Call(0)]; // func 0 is an import
637 let config = CompileConfig {
638 num_imports: 1,
639 relocatable: true,
640 ..CompileConfig::default()
641 };
642
643 let func = backend
644 .compile_function("caller", &ops, &config)
645 .expect("relocatable import call compiles");
646
647 assert_eq!(func.relocations.len(), 1);
648 assert_eq!(
649 func.relocations[0].symbol, "func_0",
650 "#197: relocatable import must relocate against func_0 (→ field name), not Meld dispatch"
651 );
652 }
653
654 #[test]
655 fn test_compile_no_imports_no_relocations() {
656 let backend = ArmBackend::new();
657 let ops = vec![WasmOp::LocalGet(0), WasmOp::LocalGet(1), WasmOp::I32Add];
658 let config = CompileConfig::default();
659
660 let func = backend.compile_function("add", &ops, &config).unwrap();
661 assert!(func.relocations.is_empty());
662 }
663
664 /// Regression test for #167: a call to an INTERNAL function
665 /// (index `>= num_imports`) must record a relocation against `func_{index}`.
666 /// Before the fix, only `__meld_*` (import) BLs were relocated, so
667 /// internal `BL func_N` was emitted as an unpatched `bl #0` branching
668 /// to a garbage address — making the object non-linkable. This test
669 /// would have caught that regression.
670 #[test]
671 fn test_compile_internal_call_produces_relocation_167() {
672 let backend = ArmBackend::new();
673 // num_imports = 1, so Call(2) is an INTERNAL call → `BL func_2`.
674 let ops = vec![WasmOp::Call(2)];
675 let config = CompileConfig {
676 num_imports: 1,
677 no_optimize: true,
678 ..CompileConfig::default()
679 };
680
681 let func = backend
682 .compile_function("caller", &ops, &config)
683 .expect("internal call compiles");
684
685 assert_eq!(
686 func.relocations.len(),
687 1,
688 "an internal call must emit exactly one relocation (#167)"
689 );
690 assert_eq!(
691 func.relocations[0].symbol, "func_2",
692 "internal call must relocate against the callee's func_{{index}} symbol (#167)"
693 );
694 }
695
696 // ─── Phase 1 safety-bounds plumbing for ARM ──────────────────────────
697
698 #[test]
699 fn arm_safety_bounds_mpu_emits_same_code_as_none() {
700 // Mpu mode must not introduce any inline check on ARM — the MPU
701 // handles faults via hardware. The encoded bytes for an i32.load
702 // should be identical between None and Mpu.
703 let backend = ArmBackend::new();
704 let ops = vec![
705 WasmOp::LocalGet(0),
706 WasmOp::I32Load {
707 offset: 0,
708 align: 2,
709 },
710 ];
711 let cfg_none = CompileConfig {
712 no_optimize: true,
713 ..Default::default()
714 };
715 let cfg_mpu = CompileConfig {
716 no_optimize: true,
717 safety_bounds: SafetyBounds::Mpu,
718 ..Default::default()
719 };
720 let n = backend.compile_function("ld", &ops, &cfg_none).unwrap();
721 let m = backend.compile_function("ld", &ops, &cfg_mpu).unwrap();
722 assert_eq!(
723 n.code, m.code,
724 "Mpu and None should produce identical ARM bytes (Mpu relies on hardware)"
725 );
726 }
727
728 #[test]
729 fn arm_legacy_bounds_check_still_emits_software_check() {
730 // Legacy CLI users with `--bounds-check` should keep getting the
731 // software path even though the new SafetyBounds field defaults to None.
732 let backend = ArmBackend::new();
733 let ops = vec![
734 WasmOp::LocalGet(0),
735 WasmOp::I32Load {
736 offset: 0,
737 align: 2,
738 },
739 ];
740 let cfg_legacy = CompileConfig {
741 no_optimize: true,
742 bounds_check: true,
743 ..Default::default()
744 };
745 let cfg_software = CompileConfig {
746 no_optimize: true,
747 safety_bounds: SafetyBounds::Software,
748 ..Default::default()
749 };
750 let l = backend.compile_function("ld", &ops, &cfg_legacy).unwrap();
751 let s = backend.compile_function("ld", &ops, &cfg_software).unwrap();
752 assert_eq!(
753 l.code, s.code,
754 "--bounds-check should produce the same bytes as --safety-bounds=software"
755 );
756 }
757
758 // ========================================================================
759 // ISA feature gate tests — ensure the compiler never emits unsupported
760 // instructions for a given target
761 // ========================================================================
762
763 #[test]
764 fn test_f32_rejected_on_cortex_m3_no_fpu() {
765 let backend = ArmBackend::new();
766 let ops = vec![WasmOp::F32Const(1.0), WasmOp::F32Const(2.0), WasmOp::F32Add];
767 let config = CompileConfig {
768 target: TargetSpec::cortex_m3(),
769 no_optimize: true,
770 ..CompileConfig::default()
771 };
772
773 let result = backend.compile_function("fadd", &ops, &config);
774 assert!(
775 result.is_err(),
776 "f32 operations should fail on Cortex-M3 (no FPU)"
777 );
778 }
779
780 #[test]
781 fn test_f32_accepted_on_cortex_m4f() {
782 let backend = ArmBackend::new();
783 let ops = vec![WasmOp::F32Const(1.0), WasmOp::F32Const(2.0), WasmOp::F32Add];
784 let config = CompileConfig {
785 target: TargetSpec::cortex_m4f(),
786 no_optimize: true,
787 ..CompileConfig::default()
788 };
789
790 let result = backend.compile_function("fadd", &ops, &config);
791 assert!(
792 result.is_ok(),
793 "f32 operations should succeed on Cortex-M4F, got: {:?}",
794 result.unwrap_err()
795 );
796 }
797
798 #[test]
799 fn test_i32_works_on_all_targets() {
800 let backend = ArmBackend::new();
801 let ops = vec![WasmOp::LocalGet(0), WasmOp::LocalGet(1), WasmOp::I32Add];
802
803 // Cortex-M3 (no FPU)
804 let config_m3 = CompileConfig {
805 target: TargetSpec::cortex_m3(),
806 no_optimize: true,
807 ..CompileConfig::default()
808 };
809 assert!(
810 backend.compile_function("add", &ops, &config_m3).is_ok(),
811 "i32 ops should work on Cortex-M3"
812 );
813
814 // Cortex-M4F (single FPU)
815 let config_m4f = CompileConfig {
816 target: TargetSpec::cortex_m4f(),
817 no_optimize: true,
818 ..CompileConfig::default()
819 };
820 assert!(
821 backend.compile_function("add", &ops, &config_m4f).is_ok(),
822 "i32 ops should work on Cortex-M4F"
823 );
824
825 // Cortex-M7DP (double FPU)
826 let config_m7dp = CompileConfig {
827 target: TargetSpec::cortex_m7dp(),
828 no_optimize: true,
829 ..CompileConfig::default()
830 };
831 assert!(
832 backend.compile_function("add", &ops, &config_m7dp).is_ok(),
833 "i32 ops should work on Cortex-M7DP"
834 );
835 }
836
837 #[test]
838 fn test_f32_rejected_on_cortex_m4_no_fpu() {
839 // Cortex-M4 (without F suffix) has no FPU
840 let backend = ArmBackend::new();
841 let ops = vec![WasmOp::F32Const(1.5), WasmOp::F32Const(2.5), WasmOp::F32Mul];
842 let config = CompileConfig {
843 target: TargetSpec::cortex_m4(),
844 no_optimize: true,
845 ..CompileConfig::default()
846 };
847
848 let result = backend.compile_function("fmul", &ops, &config);
849 assert!(
850 result.is_err(),
851 "f32 operations should fail on Cortex-M4 (no FPU)"
852 );
853 }
854
855 // ========================================================================
856 // Issue #120 — f32 ops in the optimized lowering path
857 //
858 // `OptimizerBridge::wasm_to_ir` has no handlers for f32/f64 ops, so a
859 // value-producing float op fell through to `Opcode::Nop`, leaving a
860 // downstream consumer with an unmapped vreg and tripping the PR #101
861 // defensive panic in `ir_to_arm`. Customer reproducer: `compiler_builtins
862 // float::div` and `gale_compute_ipi_mask` in the `falcon-rate-component`
863 // module.
864 //
865 // Fix: `optimize_full` declines float modules with a typed `Err`;
866 // `compile_wasm_to_arm` falls back to the non-optimized `select_with_stack`
867 // path, which handles f32 via VFP/FPU. These tests use the *default*
868 // (optimized) config — `no_optimize` is NOT set — which is the exact
869 // configuration that panicked pre-fix.
870 // ========================================================================
871
872 /// Pre-fix: this panicked with "vreg vN has no assigned ARM register and
873 /// no spill slot" inside `ir_to_arm`. Post-fix: the optimized path declines
874 /// the module and the backend falls back to direct selection, producing a
875 /// non-empty f32.div lowering on a Cortex-M4F.
876 #[test]
877 fn test_issue120_f32_div_compiles_via_optimized_default() {
878 let backend = ArmBackend::new();
879 let ops = vec![WasmOp::LocalGet(0), WasmOp::LocalGet(1), WasmOp::F32Div];
880 let config = CompileConfig {
881 target: TargetSpec::cortex_m4f(),
882 // no_optimize NOT set — this exercises the optimized path that
883 // panicked in issue #120, then the fallback to direct selection.
884 ..CompileConfig::default()
885 };
886
887 let result = backend.compile_function("fdiv", &ops, &config);
888 assert!(
889 result.is_ok(),
890 "f32.div must compile on Cortex-M4F via the optimized->direct \
891 fallback (issue #120), got: {:?}",
892 result.as_ref().err()
893 );
894 assert!(
895 !result.unwrap().code.is_empty(),
896 "f32.div must produce non-empty machine code"
897 );
898 }
899
900 /// A spread of f32 ops, all through the optimized (default) config, must
901 /// compile via the fallback on an FPU target without panicking.
902 #[test]
903 fn test_issue120_assorted_f32_ops_compile_via_optimized_default() {
904 let backend = ArmBackend::new();
905 let config = CompileConfig {
906 target: TargetSpec::cortex_m4f(),
907 ..CompileConfig::default()
908 };
909
910 let cases: Vec<(&str, Vec<WasmOp>)> = vec![
911 (
912 "fadd",
913 vec![WasmOp::LocalGet(0), WasmOp::LocalGet(1), WasmOp::F32Add],
914 ),
915 (
916 "fmul",
917 vec![WasmOp::LocalGet(0), WasmOp::LocalGet(1), WasmOp::F32Mul],
918 ),
919 (
920 "fsub",
921 vec![WasmOp::LocalGet(0), WasmOp::LocalGet(1), WasmOp::F32Sub],
922 ),
923 ];
924
925 for (name, ops) in cases {
926 let result = backend.compile_function(name, &ops, &config);
927 assert!(
928 result.is_ok(),
929 "{name} must compile via the optimized->direct fallback \
930 (issue #120), got: {:?}",
931 result.as_ref().err()
932 );
933 assert!(
934 !result.unwrap().code.is_empty(),
935 "{name} must produce non-empty machine code"
936 );
937 }
938 }
939
940 /// The fallback must still honor the ISA feature gate: f32 on a no-FPU
941 /// target must fail cleanly (not panic) even on the optimized path.
942 #[test]
943 fn test_issue120_f32_div_rejected_on_no_fpu_via_optimized() {
944 let backend = ArmBackend::new();
945 let ops = vec![WasmOp::LocalGet(0), WasmOp::LocalGet(1), WasmOp::F32Div];
946 let config = CompileConfig {
947 target: TargetSpec::cortex_m3(),
948 ..CompileConfig::default()
949 };
950
951 let result = backend.compile_function("fdiv", &ops, &config);
952 assert!(
953 result.is_err(),
954 "f32.div must be rejected on Cortex-M3 (no FPU), not panic"
955 );
956 }
957
958 /// Issue #94: end-to-end byte-size check for the canonical u64-packed
959 /// FFI-return hi32 extract pattern. Compiles two near-identical
960 /// functions — one with the optimized shift-by-32, one with a generic
961 /// shift-by-7 — and asserts the optimized form is meaningfully smaller.
962 #[test]
963 fn test_issue94_hi32_extract_is_smaller_than_generic_shift() {
964 let backend = ArmBackend::new();
965 let config = CompileConfig {
966 target: TargetSpec::cortex_m4f(),
967 ..CompileConfig::default()
968 };
969
970 // Optimized path: `(local.get 0) >>> 32; wrap_i64`
971 let ops_hi32 = vec![
972 WasmOp::LocalGet(0), // i64 param in R0:R1
973 WasmOp::I64Const(32),
974 WasmOp::I64ShrU,
975 WasmOp::I32WrapI64,
976 ];
977 let func_hi32 = backend
978 .compile_function("hi32_extract", &ops_hi32, &config)
979 .unwrap();
980
981 // Generic path: `(local.get 0) >>> 7; wrap_i64` — same shape, but the
982 // shift amount is not a multiple of 32, so it falls through to the
983 // 38-byte runtime shift.
984 let ops_generic = vec![
985 WasmOp::LocalGet(0),
986 WasmOp::I64Const(7),
987 WasmOp::I64ShrU,
988 WasmOp::I32WrapI64,
989 ];
990 let func_generic = backend
991 .compile_function("generic_shr", &ops_generic, &config)
992 .unwrap();
993
994 let bytes_hi32 = func_hi32.code.len();
995 let bytes_generic = func_generic.code.len();
996 println!(
997 "\n[issue #94] hi32 extract: {} bytes (vs generic shift: {} bytes; saved {})",
998 bytes_hi32,
999 bytes_generic,
1000 bytes_generic.saturating_sub(bytes_hi32)
1001 );
1002 let hex: String = func_hi32
1003 .code
1004 .iter()
1005 .map(|b| format!("{:02x}", b))
1006 .collect::<Vec<_>>()
1007 .join(" ");
1008 println!("[issue #94] hi32 bytes: {}", hex);
1009 // We expect the optimized form to be at least 30 bytes smaller than
1010 // the generic 64-bit shift sequence. (Empirically: 14 vs 50 bytes.)
1011 assert!(
1012 bytes_hi32 + 30 <= bytes_generic,
1013 "issue #94: hi32 extract = {} bytes, generic shift = {} bytes; \
1014 expected optimized form to be at least 30 bytes smaller",
1015 bytes_hi32,
1016 bytes_generic,
1017 );
1018 }
1019}