1use 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
19pub 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 }
109}
110
111fn 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
137fn 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 let select_direct = || -> Result<Vec<ArmInstruction>, String> {
158 let db = RuleDatabase::with_standard_rules();
159 let mut selector =
160 InstructionSelector::with_bounds_check(db.rules().to_vec(), bounds_config);
161 selector.set_target(config.target.fpu, &config.target.triple);
162 if config.num_imports > 0 {
163 selector.set_num_imports(config.num_imports);
164 }
165 selector.set_func_arg_counts(
168 config.func_arg_counts.clone(),
169 config.type_arg_counts.clone(),
170 );
171 selector.set_relocatable(config.relocatable);
175 selector.set_native_pointer_abi(config.native_pointer_abi, config.linear_memory_bytes);
177 if config.native_pointer_abi
181 && let Some((sp_idx, sp_init)) = config.stack_pointer_global
182 {
183 selector.set_native_pointer_stack(sp_idx, sp_init);
184 }
185 selector
186 .select_with_stack(wasm_ops, num_params)
187 .map_err(|e| format!("instruction selection failed: {}", e))
188 };
189
190 let arm_instrs = if config.no_optimize || config.relocatable {
199 select_direct()?
200 } else {
201 let opt_config = if config.loom_compat {
202 OptimizationConfig::loom_compat()
203 } else {
204 OptimizationConfig::all()
205 };
206
207 let mut bridge = OptimizerBridge::with_config(opt_config);
208 bridge.set_num_imports(config.num_imports);
212 match bridge
217 .optimize_full(wasm_ops)
218 .and_then(|(opt_ir, _cfg, _stats)| bridge.ir_to_arm(&opt_ir, num_params as usize))
219 {
220 Ok(arm_ops) => arm_ops
221 .into_iter()
222 .map(|op| ArmInstruction {
223 op,
224 source_line: None,
225 })
226 .collect(),
227 Err(_) => select_direct()?,
233 }
234 };
235
236 validate_instructions(&arm_instrs, config.target.fpu, &config.target.triple)
240 .map_err(|e| format!("ISA validation failed: {}", e))?;
241
242 let use_thumb2 = matches!(config.target.isa, IsaVariant::Thumb2 | IsaVariant::Thumb);
244
245 let encoder = if use_thumb2 {
246 ArmEncoder::new_thumb2_with_fpu(config.target.fpu)
247 } else {
248 ArmEncoder::new_arm32()
249 };
250
251 let arm_instrs = if use_thumb2 {
258 resolve_label_branches(arm_instrs, &encoder)?
259 } else {
260 arm_instrs
261 };
262
263 let mut code = Vec::new();
264 let mut relocations = Vec::new();
265
266 for instr in &arm_instrs {
267 if let ArmOp::Bl { label } = &instr.op {
274 relocations.push(CodeRelocation {
275 offset: code.len() as u32,
276 symbol: label.clone(),
277 kind: synth_core::backend::RelocKind::ThmCall,
278 });
279 }
280 if let ArmOp::MovwSym { symbol, .. } = &instr.op {
284 relocations.push(CodeRelocation {
285 offset: code.len() as u32,
286 symbol: symbol.clone(),
287 kind: synth_core::backend::RelocKind::MovwAbs,
288 });
289 }
290 if let ArmOp::MovtSym { symbol, .. } = &instr.op {
291 relocations.push(CodeRelocation {
292 offset: code.len() as u32,
293 symbol: symbol.clone(),
294 kind: synth_core::backend::RelocKind::MovtAbs,
295 });
296 }
297
298 let encoded = encoder
299 .encode(&instr.op)
300 .map_err(|e| format!("ARM encoding failed: {}", e))?;
301 code.extend_from_slice(&encoded);
302 }
303
304 Ok((code, relocations))
305}
306
307fn resolve_label_branches(
325 arm_instrs: Vec<ArmInstruction>,
326 encoder: &ArmEncoder,
327) -> Result<Vec<ArmInstruction>, String> {
328 use std::collections::HashMap;
329 use synth_synthesis::Condition;
330
331 enum BKind {
332 Cond(Condition),
333 Uncond,
334 }
335 let mut branches: Vec<(usize, BKind, String)> = Vec::new();
337 for (i, instr) in arm_instrs.iter().enumerate() {
338 match &instr.op {
339 ArmOp::Bcc { cond, label } => branches.push((i, BKind::Cond(*cond), label.clone())),
340 ArmOp::Bhs { label } => branches.push((i, BKind::Cond(Condition::HS), label.clone())),
341 ArmOp::Blo { label } => branches.push((i, BKind::Cond(Condition::LO), label.clone())),
342 ArmOp::B { label } => branches.push((i, BKind::Uncond, label.clone())),
343 _ => {}
344 }
345 }
346 if branches.is_empty() {
347 return Ok(arm_instrs);
348 }
349
350 let mut resolved = arm_instrs;
351 for _ in 0..16 {
353 let mut positions = Vec::with_capacity(resolved.len());
355 let mut pos: i64 = 0;
356 for instr in &resolved {
357 positions.push(pos);
358 pos += encoder
359 .encode(&instr.op)
360 .map_err(|e| format!("branch-resolve size probe failed: {}", e))?
361 .len() as i64;
362 }
363 let mut labels: HashMap<String, i64> = HashMap::new();
365 for (i, instr) in resolved.iter().enumerate() {
366 if let ArmOp::Label { name } = &instr.op {
367 labels.insert(name.clone(), positions[i]);
368 }
369 }
370 let mut changed = false;
372 for (idx, kind, label) in &branches {
373 let Some(&target) = labels.get(label) else {
378 continue;
379 };
380 let halfword_offset = ((target - positions[*idx] - 4) / 2) as i32;
383 let new_op = match kind {
384 BKind::Cond(c) => ArmOp::BCondOffset {
385 cond: *c,
386 offset: halfword_offset,
387 },
388 BKind::Uncond => ArmOp::BOffset {
389 offset: halfword_offset,
390 },
391 };
392 if resolved[*idx].op != new_op {
393 resolved[*idx].op = new_op;
394 changed = true;
395 }
396 }
397 if !changed {
398 break;
399 }
400 }
401 Ok(resolved)
402}
403
404#[cfg(test)]
405mod tests {
406 use super::*;
407
408 #[test]
409 fn test_arm_backend_name() {
410 let backend = ArmBackend::new();
411 assert_eq!(backend.name(), "arm");
412 assert!(backend.is_available());
413 }
414
415 #[test]
416 fn test_arm_backend_capabilities() {
417 let backend = ArmBackend::new();
418 let caps = backend.capabilities();
419 assert!(!caps.produces_elf);
420 assert!(caps.supports_rule_verification);
421 assert!(!caps.is_external);
422 }
423
424 #[test]
425 fn test_compile_add_function() {
426 let backend = ArmBackend::new();
427 let ops = vec![WasmOp::LocalGet(0), WasmOp::LocalGet(1), WasmOp::I32Add];
428 let config = CompileConfig::default();
429
430 let result = backend.compile_function("add", &ops, &config);
431 assert!(result.is_ok());
432
433 let func = result.unwrap();
434 assert_eq!(func.name, "add");
435 assert!(!func.code.is_empty());
436 assert_eq!(func.wasm_ops, ops);
437 }
438
439 #[test]
440 fn test_count_params() {
441 let ops = vec![WasmOp::LocalGet(0), WasmOp::LocalGet(1), WasmOp::I32Add];
442 assert_eq!(count_params(&ops), 2);
443
444 let no_params = vec![WasmOp::I32Const(5), WasmOp::I32Const(3), WasmOp::I32Add];
445 assert_eq!(count_params(&no_params), 0);
446 }
447
448 #[test]
449 fn test_arm_backend_register() {
450 let mut registry = synth_core::BackendRegistry::new();
451 registry.register(Box::new(ArmBackend::new()));
452 assert!(registry.get("arm").is_some());
453 assert_eq!(registry.available().len(), 1);
454 }
455
456 #[test]
457 fn test_compile_import_call_produces_relocations() {
458 let backend = ArmBackend::new();
459 let ops = vec![WasmOp::Call(0)];
462 let config = CompileConfig {
463 num_imports: 1,
464 no_optimize: true, ..CompileConfig::default()
466 };
467
468 let result = backend.compile_function("caller", &ops, &config);
469 assert!(result.is_ok());
470
471 let func = result.unwrap();
472 assert!(!func.code.is_empty());
473 assert_eq!(func.relocations.len(), 1);
474 assert_eq!(func.relocations[0].symbol, "__meld_dispatch_import");
475 assert!(func.relocations[0].offset > 0);
477 }
478
479 #[test]
485 fn test_compile_relocatable_import_uses_direct_func_symbol_197() {
486 let backend = ArmBackend::new();
487 let ops = vec![WasmOp::Call(0)]; let config = CompileConfig {
489 num_imports: 1,
490 relocatable: true,
491 ..CompileConfig::default()
492 };
493
494 let func = backend
495 .compile_function("caller", &ops, &config)
496 .expect("relocatable import call compiles");
497
498 assert_eq!(func.relocations.len(), 1);
499 assert_eq!(
500 func.relocations[0].symbol, "func_0",
501 "#197: relocatable import must relocate against func_0 (→ field name), not Meld dispatch"
502 );
503 }
504
505 #[test]
506 fn test_compile_no_imports_no_relocations() {
507 let backend = ArmBackend::new();
508 let ops = vec![WasmOp::LocalGet(0), WasmOp::LocalGet(1), WasmOp::I32Add];
509 let config = CompileConfig::default();
510
511 let func = backend.compile_function("add", &ops, &config).unwrap();
512 assert!(func.relocations.is_empty());
513 }
514
515 #[test]
522 fn test_compile_internal_call_produces_relocation_167() {
523 let backend = ArmBackend::new();
524 let ops = vec![WasmOp::Call(2)];
526 let config = CompileConfig {
527 num_imports: 1,
528 no_optimize: true,
529 ..CompileConfig::default()
530 };
531
532 let func = backend
533 .compile_function("caller", &ops, &config)
534 .expect("internal call compiles");
535
536 assert_eq!(
537 func.relocations.len(),
538 1,
539 "an internal call must emit exactly one relocation (#167)"
540 );
541 assert_eq!(
542 func.relocations[0].symbol, "func_2",
543 "internal call must relocate against the callee's func_{{index}} symbol (#167)"
544 );
545 }
546
547 #[test]
550 fn arm_safety_bounds_mpu_emits_same_code_as_none() {
551 let backend = ArmBackend::new();
555 let ops = vec![
556 WasmOp::LocalGet(0),
557 WasmOp::I32Load {
558 offset: 0,
559 align: 2,
560 },
561 ];
562 let cfg_none = CompileConfig {
563 no_optimize: true,
564 ..Default::default()
565 };
566 let cfg_mpu = CompileConfig {
567 no_optimize: true,
568 safety_bounds: SafetyBounds::Mpu,
569 ..Default::default()
570 };
571 let n = backend.compile_function("ld", &ops, &cfg_none).unwrap();
572 let m = backend.compile_function("ld", &ops, &cfg_mpu).unwrap();
573 assert_eq!(
574 n.code, m.code,
575 "Mpu and None should produce identical ARM bytes (Mpu relies on hardware)"
576 );
577 }
578
579 #[test]
580 fn arm_legacy_bounds_check_still_emits_software_check() {
581 let backend = ArmBackend::new();
584 let ops = vec![
585 WasmOp::LocalGet(0),
586 WasmOp::I32Load {
587 offset: 0,
588 align: 2,
589 },
590 ];
591 let cfg_legacy = CompileConfig {
592 no_optimize: true,
593 bounds_check: true,
594 ..Default::default()
595 };
596 let cfg_software = CompileConfig {
597 no_optimize: true,
598 safety_bounds: SafetyBounds::Software,
599 ..Default::default()
600 };
601 let l = backend.compile_function("ld", &ops, &cfg_legacy).unwrap();
602 let s = backend.compile_function("ld", &ops, &cfg_software).unwrap();
603 assert_eq!(
604 l.code, s.code,
605 "--bounds-check should produce the same bytes as --safety-bounds=software"
606 );
607 }
608
609 #[test]
615 fn test_f32_rejected_on_cortex_m3_no_fpu() {
616 let backend = ArmBackend::new();
617 let ops = vec![WasmOp::F32Const(1.0), WasmOp::F32Const(2.0), WasmOp::F32Add];
618 let config = CompileConfig {
619 target: TargetSpec::cortex_m3(),
620 no_optimize: true,
621 ..CompileConfig::default()
622 };
623
624 let result = backend.compile_function("fadd", &ops, &config);
625 assert!(
626 result.is_err(),
627 "f32 operations should fail on Cortex-M3 (no FPU)"
628 );
629 }
630
631 #[test]
632 fn test_f32_accepted_on_cortex_m4f() {
633 let backend = ArmBackend::new();
634 let ops = vec![WasmOp::F32Const(1.0), WasmOp::F32Const(2.0), WasmOp::F32Add];
635 let config = CompileConfig {
636 target: TargetSpec::cortex_m4f(),
637 no_optimize: true,
638 ..CompileConfig::default()
639 };
640
641 let result = backend.compile_function("fadd", &ops, &config);
642 assert!(
643 result.is_ok(),
644 "f32 operations should succeed on Cortex-M4F, got: {:?}",
645 result.unwrap_err()
646 );
647 }
648
649 #[test]
650 fn test_i32_works_on_all_targets() {
651 let backend = ArmBackend::new();
652 let ops = vec![WasmOp::LocalGet(0), WasmOp::LocalGet(1), WasmOp::I32Add];
653
654 let config_m3 = CompileConfig {
656 target: TargetSpec::cortex_m3(),
657 no_optimize: true,
658 ..CompileConfig::default()
659 };
660 assert!(
661 backend.compile_function("add", &ops, &config_m3).is_ok(),
662 "i32 ops should work on Cortex-M3"
663 );
664
665 let config_m4f = CompileConfig {
667 target: TargetSpec::cortex_m4f(),
668 no_optimize: true,
669 ..CompileConfig::default()
670 };
671 assert!(
672 backend.compile_function("add", &ops, &config_m4f).is_ok(),
673 "i32 ops should work on Cortex-M4F"
674 );
675
676 let config_m7dp = CompileConfig {
678 target: TargetSpec::cortex_m7dp(),
679 no_optimize: true,
680 ..CompileConfig::default()
681 };
682 assert!(
683 backend.compile_function("add", &ops, &config_m7dp).is_ok(),
684 "i32 ops should work on Cortex-M7DP"
685 );
686 }
687
688 #[test]
689 fn test_f32_rejected_on_cortex_m4_no_fpu() {
690 let backend = ArmBackend::new();
692 let ops = vec![WasmOp::F32Const(1.5), WasmOp::F32Const(2.5), WasmOp::F32Mul];
693 let config = CompileConfig {
694 target: TargetSpec::cortex_m4(),
695 no_optimize: true,
696 ..CompileConfig::default()
697 };
698
699 let result = backend.compile_function("fmul", &ops, &config);
700 assert!(
701 result.is_err(),
702 "f32 operations should fail on Cortex-M4 (no FPU)"
703 );
704 }
705
706 #[test]
728 fn test_issue120_f32_div_compiles_via_optimized_default() {
729 let backend = ArmBackend::new();
730 let ops = vec![WasmOp::LocalGet(0), WasmOp::LocalGet(1), WasmOp::F32Div];
731 let config = CompileConfig {
732 target: TargetSpec::cortex_m4f(),
733 ..CompileConfig::default()
736 };
737
738 let result = backend.compile_function("fdiv", &ops, &config);
739 assert!(
740 result.is_ok(),
741 "f32.div must compile on Cortex-M4F via the optimized->direct \
742 fallback (issue #120), got: {:?}",
743 result.as_ref().err()
744 );
745 assert!(
746 !result.unwrap().code.is_empty(),
747 "f32.div must produce non-empty machine code"
748 );
749 }
750
751 #[test]
754 fn test_issue120_assorted_f32_ops_compile_via_optimized_default() {
755 let backend = ArmBackend::new();
756 let config = CompileConfig {
757 target: TargetSpec::cortex_m4f(),
758 ..CompileConfig::default()
759 };
760
761 let cases: Vec<(&str, Vec<WasmOp>)> = vec![
762 (
763 "fadd",
764 vec![WasmOp::LocalGet(0), WasmOp::LocalGet(1), WasmOp::F32Add],
765 ),
766 (
767 "fmul",
768 vec![WasmOp::LocalGet(0), WasmOp::LocalGet(1), WasmOp::F32Mul],
769 ),
770 (
771 "fsub",
772 vec![WasmOp::LocalGet(0), WasmOp::LocalGet(1), WasmOp::F32Sub],
773 ),
774 ];
775
776 for (name, ops) in cases {
777 let result = backend.compile_function(name, &ops, &config);
778 assert!(
779 result.is_ok(),
780 "{name} must compile via the optimized->direct fallback \
781 (issue #120), got: {:?}",
782 result.as_ref().err()
783 );
784 assert!(
785 !result.unwrap().code.is_empty(),
786 "{name} must produce non-empty machine code"
787 );
788 }
789 }
790
791 #[test]
794 fn test_issue120_f32_div_rejected_on_no_fpu_via_optimized() {
795 let backend = ArmBackend::new();
796 let ops = vec![WasmOp::LocalGet(0), WasmOp::LocalGet(1), WasmOp::F32Div];
797 let config = CompileConfig {
798 target: TargetSpec::cortex_m3(),
799 ..CompileConfig::default()
800 };
801
802 let result = backend.compile_function("fdiv", &ops, &config);
803 assert!(
804 result.is_err(),
805 "f32.div must be rejected on Cortex-M3 (no FPU), not panic"
806 );
807 }
808
809 #[test]
814 fn test_issue94_hi32_extract_is_smaller_than_generic_shift() {
815 let backend = ArmBackend::new();
816 let config = CompileConfig {
817 target: TargetSpec::cortex_m4f(),
818 ..CompileConfig::default()
819 };
820
821 let ops_hi32 = vec![
823 WasmOp::LocalGet(0), WasmOp::I64Const(32),
825 WasmOp::I64ShrU,
826 WasmOp::I32WrapI64,
827 ];
828 let func_hi32 = backend
829 .compile_function("hi32_extract", &ops_hi32, &config)
830 .unwrap();
831
832 let ops_generic = vec![
836 WasmOp::LocalGet(0),
837 WasmOp::I64Const(7),
838 WasmOp::I64ShrU,
839 WasmOp::I32WrapI64,
840 ];
841 let func_generic = backend
842 .compile_function("generic_shr", &ops_generic, &config)
843 .unwrap();
844
845 let bytes_hi32 = func_hi32.code.len();
846 let bytes_generic = func_generic.code.len();
847 println!(
848 "\n[issue #94] hi32 extract: {} bytes (vs generic shift: {} bytes; saved {})",
849 bytes_hi32,
850 bytes_generic,
851 bytes_generic.saturating_sub(bytes_hi32)
852 );
853 let hex: String = func_hi32
854 .code
855 .iter()
856 .map(|b| format!("{:02x}", b))
857 .collect::<Vec<_>>()
858 .join(" ");
859 println!("[issue #94] hi32 bytes: {}", hex);
860 assert!(
863 bytes_hi32 + 30 <= bytes_generic,
864 "issue #94: hi32 extract = {} bytes, generic shift = {} bytes; \
865 expected optimized form to be at least 30 bytes smaller",
866 bytes_hi32,
867 bytes_generic,
868 );
869 }
870}