synth_backend/
elf_builder.rs

1//! ELF (Executable and Linkable Format) Builder for ARM
2//!
3//! Generates ELF32 files for ARM Cortex-M targets
4
5use synth_core::Result;
6
7/// ELF file class
8#[derive(Debug, Clone, Copy, PartialEq, Eq)]
9pub enum ElfClass {
10    /// 32-bit
11    Elf32 = 1,
12    /// 64-bit
13    Elf64 = 2,
14}
15
16/// ELF data encoding
17#[derive(Debug, Clone, Copy, PartialEq, Eq)]
18pub enum ElfData {
19    /// Little-endian
20    LittleEndian = 1,
21    /// Big-endian
22    BigEndian = 2,
23}
24
25/// ELF file type
26#[derive(Debug, Clone, Copy, PartialEq, Eq)]
27pub enum ElfType {
28    /// Relocatable file
29    Rel = 1,
30    /// Executable file
31    Exec = 2,
32    /// Shared object file
33    Dyn = 3,
34}
35
36/// ELF machine architecture
37#[derive(Debug, Clone, Copy, PartialEq, Eq)]
38pub enum ElfMachine {
39    /// ARM
40    Arm = 40,
41    /// ARM64/AArch64
42    AArch64 = 183,
43}
44
45/// Section type
46#[derive(Debug, Clone, Copy, PartialEq, Eq)]
47pub enum SectionType {
48    /// Null section
49    Null = 0,
50    /// Program data
51    ProgBits = 1,
52    /// Symbol table
53    SymTab = 2,
54    /// String table
55    StrTab = 3,
56    /// Relocation entries with addends
57    Rela = 4,
58    /// Symbol hash table
59    Hash = 5,
60    /// Dynamic linking information
61    Dynamic = 6,
62    /// Note
63    Note = 7,
64    /// No space (BSS)
65    NoBits = 8,
66    /// Relocation entries
67    Rel = 9,
68    /// ARM build attributes (`SHT_ARM_ATTRIBUTES`, #637) — the `.ARM.attributes`
69    /// section every ARM toolchain consults to auto-select the Thumb/A32 decoder.
70    ArmAttributes = 0x7000_0003,
71}
72
73/// Section flags
74#[derive(Debug, Clone, Copy)]
75pub struct SectionFlags(pub u32);
76
77impl SectionFlags {
78    /// Writable
79    pub const WRITE: u32 = 0x1;
80    /// Occupies memory during execution
81    pub const ALLOC: u32 = 0x2;
82    /// Executable
83    pub const EXEC: u32 = 0x4;
84    /// Mergeable
85    pub const MERGE: u32 = 0x10;
86    /// Contains null-terminated strings
87    pub const STRINGS: u32 = 0x20;
88}
89
90/// ELF section
91#[derive(Debug, Clone)]
92pub struct Section {
93    /// Section name (index into string table)
94    pub name: String,
95    /// Section type
96    pub section_type: SectionType,
97    /// Section flags
98    pub flags: u32,
99    /// Virtual address
100    pub addr: u32,
101    /// Section data
102    pub data: Vec<u8>,
103    /// Alignment
104    pub align: u32,
105    /// Explicit size (for NoBits sections like .bss where data is empty)
106    pub explicit_size: Option<u32>,
107}
108
109impl Section {
110    /// Create a new section
111    pub fn new(name: &str, section_type: SectionType) -> Self {
112        Self {
113            name: name.to_string(),
114            section_type,
115            flags: 0,
116            addr: 0,
117            data: Vec::new(),
118            align: 1,
119            explicit_size: None,
120        }
121    }
122
123    /// Set flags
124    pub fn with_flags(mut self, flags: u32) -> Self {
125        self.flags = flags;
126        self
127    }
128
129    /// Set address
130    pub fn with_addr(mut self, addr: u32) -> Self {
131        self.addr = addr;
132        self
133    }
134
135    /// Set alignment
136    pub fn with_align(mut self, align: u32) -> Self {
137        self.align = align;
138        self
139    }
140
141    /// Add data
142    pub fn with_data(mut self, data: Vec<u8>) -> Self {
143        self.data = data;
144        self
145    }
146
147    /// Set explicit size (for NoBits sections like .bss where data is empty)
148    pub fn with_size(mut self, size: u32) -> Self {
149        self.explicit_size = Some(size);
150        self
151    }
152
153    /// Get the effective size of the section
154    pub fn size(&self) -> u32 {
155        self.explicit_size.unwrap_or(self.data.len() as u32)
156    }
157}
158
159/// Symbol binding — the container-independent enum from `synth_core`, shared
160/// with the aarch64 object plan since #1180 (one definition of LOCAL/GLOBAL,
161/// one `locals_first` rule). Re-exported so every
162/// `synth_backend::elf_builder::SymbolBinding` path keeps working unchanged.
163pub use synth_core::backend::SymbolBinding;
164
165/// Symbol type
166#[derive(Debug, Clone, Copy, PartialEq, Eq)]
167pub enum SymbolType {
168    /// No type
169    NoType = 0,
170    /// Object (data)
171    Object = 1,
172    /// Function
173    Func = 2,
174    /// Section
175    Section = 3,
176    /// File name
177    File = 4,
178}
179
180/// ELF symbol
181#[derive(Debug, Clone)]
182pub struct Symbol {
183    /// Symbol name
184    pub name: String,
185    /// Value/address
186    pub value: u32,
187    /// Size
188    pub size: u32,
189    /// Binding
190    pub binding: SymbolBinding,
191    /// Type
192    pub symbol_type: SymbolType,
193    /// Section index
194    pub section: u16,
195}
196
197impl Symbol {
198    /// Create a new symbol
199    pub fn new(name: &str) -> Self {
200        Self {
201            name: name.to_string(),
202            value: 0,
203            size: 0,
204            binding: SymbolBinding::Local,
205            symbol_type: SymbolType::NoType,
206            section: 0,
207        }
208    }
209
210    /// Set value
211    pub fn with_value(mut self, value: u32) -> Self {
212        self.value = value;
213        self
214    }
215
216    /// Set size
217    pub fn with_size(mut self, size: u32) -> Self {
218        self.size = size;
219        self
220    }
221
222    /// Set binding
223    pub fn with_binding(mut self, binding: SymbolBinding) -> Self {
224        self.binding = binding;
225        self
226    }
227
228    /// Set type
229    pub fn with_type(mut self, symbol_type: SymbolType) -> Self {
230        self.symbol_type = symbol_type;
231        self
232    }
233
234    /// Set section
235    pub fn with_section(mut self, section: u16) -> Self {
236        self.section = section;
237        self
238    }
239}
240
241/// Program header type
242#[derive(Debug, Clone, Copy, PartialEq, Eq)]
243pub enum ProgramType {
244    /// Null entry
245    Null = 0,
246    /// Loadable segment
247    Load = 1,
248    /// Dynamic linking info
249    Dynamic = 2,
250    /// Interpreter path
251    Interp = 3,
252    /// Note section
253    Note = 4,
254}
255
256/// Program header flags
257pub struct ProgramFlags;
258
259impl ProgramFlags {
260    /// Executable
261    pub const EXEC: u32 = 0x1;
262    /// Writable
263    pub const WRITE: u32 = 0x2;
264    /// Readable
265    pub const READ: u32 = 0x4;
266}
267
268/// ELF program header (segment)
269#[derive(Debug, Clone)]
270pub struct ProgramHeader {
271    /// Segment type
272    pub p_type: ProgramType,
273    /// Offset in file
274    pub offset: u32,
275    /// Virtual address
276    pub vaddr: u32,
277    /// Physical address
278    pub paddr: u32,
279    /// Size in file
280    pub filesz: u32,
281    /// Size in memory
282    pub memsz: u32,
283    /// Flags (R/W/X)
284    pub flags: u32,
285    /// Alignment
286    pub align: u32,
287}
288
289impl ProgramHeader {
290    /// Create a new LOAD segment
291    pub fn load(vaddr: u32, offset: u32, size: u32, flags: u32) -> Self {
292        Self {
293            p_type: ProgramType::Load,
294            offset,
295            vaddr,
296            paddr: vaddr, // Physical = virtual for simple cases
297            filesz: size,
298            memsz: size,
299            flags,
300            align: 4,
301        }
302    }
303
304    /// Create a new LOAD segment for BSS-like regions (no file data, only memory)
305    /// Used for .bss, linear memory, and other zero-initialized regions
306    pub fn load_nobits(vaddr: u32, memsz: u32, flags: u32) -> Self {
307        Self {
308            p_type: ProgramType::Load,
309            offset: 0, // No file offset for NoBits
310            vaddr,
311            paddr: vaddr, // Physical = virtual
312            filesz: 0,    // No file data
313            memsz,        // Memory size to allocate
314            flags,
315            align: 4,
316        }
317    }
318}
319
320/// ARM relocation type
321#[derive(Debug, Clone, Copy, PartialEq, Eq)]
322pub enum ArmRelocationType {
323    /// R_ARM_THM_CALL (10) — Thumb BL/BLX instruction (Cortex-M). This is the
324    /// correct relocation for a Thumb-2 `bl` call site; `Call`/R_ARM_CALL below
325    /// is the ARM-mode form and is mis-resolved by `ld` for Thumb calls.
326    ThmCall = 10,
327    /// R_ARM_CALL (28) — BL/BLX instruction
328    Call = 28,
329    /// R_ARM_JUMP24 (29) — B/BL<cond> instruction
330    Jump24 = 29,
331    /// R_ARM_ABS32 (2) — Direct 32-bit reference
332    Abs32 = 2,
333    /// R_ARM_MOVW_ABS_NC (43) — MOVW instruction (low 16 bits)
334    MovwAbsNc = 43,
335    /// R_ARM_MOVT_ABS (44) — MOVT instruction (high 16 bits)
336    MovtAbs = 44,
337}
338
339/// A built `.rel.<name>` section: its name offset in `.shstrtab`, the target
340/// section index it relocates (`sh_info`), its file offset, and the encoded
341/// REL entries. Internal to [`ElfBuilder::build`].
342struct ExtraRelSection {
343    name_offset: usize,
344    target_idx: u32,
345    offset: usize,
346    data: Vec<u8>,
347}
348
349/// ELF relocation entry (REL format, no addend)
350#[derive(Debug, Clone)]
351pub struct Relocation {
352    /// Offset within the section where the relocation applies
353    pub offset: u32,
354    /// Symbol index in the symbol table
355    pub symbol_index: u32,
356    /// Relocation type
357    pub reloc_type: ArmRelocationType,
358}
359
360/// ARM EABI version 5 (soft-float)
361pub const EF_ARM_EABI_VER5: u32 = 0x05000000;
362/// ARM hard-float ABI flag
363pub const EF_ARM_ABI_FLOAT_HARD: u32 = 0x00000400;
364/// ARM soft-float ABI flag
365pub const EF_ARM_ABI_FLOAT_SOFT: u32 = 0x00000200;
366
367/// ARM EABI build-attribute tags and values (#637) — "Addenda to, and Errata
368/// in, the ABI for the Arm Architecture" (build attributes). Only the tags the
369/// synth ELF writer emits; consumers (objdump, gdb, `synth disasm`) use them to
370/// auto-select the Thumb vs A32 decoder without a manual `--triple`.
371pub mod aeabi {
372    /// Tag_CPU_arch (uleb value)
373    pub const TAG_CPU_ARCH: u32 = 6;
374    /// Tag_CPU_arch_profile (uleb value: 'M', 'R', 'A')
375    pub const TAG_CPU_ARCH_PROFILE: u32 = 7;
376    /// Tag_ARM_ISA_use (0 = no A32, 1 = A32 permitted)
377    pub const TAG_ARM_ISA_USE: u32 = 8;
378    /// Tag_THUMB_ISA_use (0 = none, 1 = Thumb-1 (16-bit), 2 = Thumb-2)
379    pub const TAG_THUMB_ISA_USE: u32 = 9;
380
381    /// Tag_CPU_arch value: ARMv7 (Cortex-M3 / Cortex-R profile base)
382    pub const CPU_ARCH_V7: u32 = 10;
383    /// Tag_CPU_arch value: ARMv6-M (Cortex-M0)
384    pub const CPU_ARCH_V6M: u32 = 11;
385    /// Tag_CPU_arch value: ARMv7E-M (Cortex-M4/M7)
386    pub const CPU_ARCH_V7EM: u32 = 13;
387    /// Tag_CPU_arch value: ARMv8.1-M.mainline (Cortex-M55)
388    pub const CPU_ARCH_V8_1M_MAIN: u32 = 21;
389
390    /// Tag_CPU_arch_profile value: microcontroller
391    pub const PROFILE_M: u32 = b'M' as u32;
392    /// Tag_CPU_arch_profile value: real-time
393    pub const PROFILE_R: u32 = b'R' as u32;
394
395    /// Tag_ABI_VFP_args (GI-FPU-002, #619): 0 = base (soft-float) variant,
396    /// 1 = FP args passed in VFP registers (AAPCS-VFP / hard-float).
397    pub const TAG_ABI_VFP_ARGS: u32 = 28;
398    /// Tag_FP_arch (GI-FPU-002, #619): the floating-point hardware the object
399    /// requires (tag 10 — NOT 36, which is Tag_FP_HP_extension). Value 0 = none
400    /// (soft-float; omitted by the writer).
401    pub const TAG_FP_ARCH: u32 = 10;
402    /// Tag_ABI_VFP_args value: FP args passed in VFP registers (hard-float).
403    pub const VFP_ARGS_VFP_REGS: u32 = 1;
404    /// Tag_FP_arch value: VFPv4-D16. synth's phase-1 f32 codegen uses only the
405    /// single-precision VADD/VMUL/VCVT subset shared by every Cortex-M FPU
406    /// (FPv4-SP through FPv5), so this conservative value describes the required
407    /// hardware without over-claiming (#619/#369).
408    pub const FP_ARCH_VFPV4_D16: u32 = 6;
409}
410
411/// Encode a u32 as ULEB128 (build-attribute value encoding).
412fn push_uleb128(out: &mut Vec<u8>, mut v: u32) {
413    loop {
414        let byte = (v & 0x7f) as u8;
415        v >>= 7;
416        if v == 0 {
417            out.push(byte);
418            break;
419        }
420        out.push(byte | 0x80);
421    }
422}
423
424/// Build the `.ARM.attributes` section (#637): format-version `'A'`, one
425/// `"aeabi"` vendor subsection carrying a single `Tag_File` (1) subsubsection
426/// with the given file-scope attributes. Tags with value 0 are omitted (0 is
427/// the spec default). Standard toolchains (objdump, gdb, ld) read this to
428/// auto-select the Thumb vs A32 decoder — synth objects become self-describing
429/// instead of requiring a manual `--triple=thumbv7m`.
430pub fn arm_attributes_section(
431    cpu_arch: u32,
432    cpu_arch_profile: u32,
433    arm_isa_use: u32,
434    thumb_isa_use: u32,
435    fp_arch: u32,
436    vfp_args: u32,
437) -> Section {
438    // File-scope attribute pairs (uleb tag, uleb value). Emitted in ascending
439    // tag order: CPU_arch(6), profile(7), ARM_ISA(8), THUMB_ISA(9),
440    // FP_arch(10), ABI_VFP_args(28). Tags with value 0 are omitted (spec
441    // default), so a soft-float (no-FPU) object is byte-identical to before
442    // GI-FPU-002.
443    let mut attrs = Vec::new();
444    for (tag, value) in [
445        (aeabi::TAG_CPU_ARCH, cpu_arch),
446        (aeabi::TAG_CPU_ARCH_PROFILE, cpu_arch_profile),
447        (aeabi::TAG_ARM_ISA_USE, arm_isa_use),
448        (aeabi::TAG_THUMB_ISA_USE, thumb_isa_use),
449        (aeabi::TAG_FP_ARCH, fp_arch),
450        (aeabi::TAG_ABI_VFP_ARGS, vfp_args),
451    ] {
452        if value != 0 {
453            push_uleb128(&mut attrs, tag);
454            push_uleb128(&mut attrs, value);
455        }
456    }
457
458    // Tag_File (1) subsubsection: tag byte + u32 length (self-inclusive) + attrs.
459    let file_len = (1 + 4 + attrs.len()) as u32;
460    let mut file_sub = vec![1u8]; // Tag_File
461    file_sub.extend_from_slice(&file_len.to_le_bytes());
462    file_sub.extend_from_slice(&attrs);
463
464    // "aeabi" vendor subsection: u32 length (self-inclusive) + NTBS name + data.
465    let vendor_name = b"aeabi\0";
466    let vendor_len = (4 + vendor_name.len() + file_sub.len()) as u32;
467    let mut blob = vec![b'A']; // format version
468    blob.extend_from_slice(&vendor_len.to_le_bytes());
469    blob.extend_from_slice(vendor_name);
470    blob.extend_from_slice(&file_sub);
471
472    Section::new(".ARM.attributes", SectionType::ArmAttributes)
473        .with_align(1)
474        .with_data(blob)
475}
476
477/// ELF file builder
478pub struct ElfBuilder {
479    /// File class (32 or 64 bit)
480    class: ElfClass,
481    /// Data encoding
482    data: ElfData,
483    /// File type
484    elf_type: ElfType,
485    /// Machine architecture
486    machine: ElfMachine,
487    /// Entry point address
488    entry: u32,
489    /// ELF e_flags (EABI version + float ABI)
490    e_flags: u32,
491    /// Sections
492    sections: Vec<Section>,
493    /// Symbols
494    symbols: Vec<Symbol>,
495    /// Program headers (segments)
496    program_headers: Vec<ProgramHeader>,
497    /// Relocations for .text section
498    relocations: Vec<Relocation>,
499    /// Extra per-section relocation tables, keyed by the target section's name
500    /// (e.g. `.debug_line`). Each produces a `.rel.<name>` section. Kept separate
501    /// from `relocations` (the `.text` set) so the existing `.rel.text` byte
502    /// layout is untouched: when this is empty the build is byte-identical to the
503    /// pre-generalization output (VCR-DBG-001 PR C, #394).
504    extra_relocations: Vec<(String, Vec<Relocation>)>,
505    /// #598: whether the object's functions are Thumb-encoded. Bit 0 of an
506    /// STT_FUNC `st_value` (and of `e_entry`) is the Thumb interworking bit —
507    /// it must be SET for Thumb code (Cortex-M) and CLEAR for A32 code
508    /// (cortex-r5 path). Defaults to `true` (every pre-#598 ARM object was
509    /// treated as Thumb, so Thumb outputs stay bit-identical).
510    thumb_funcs: bool,
511}
512
513impl ElfBuilder {
514    /// Create a new ELF builder for ARM32
515    pub fn new_arm32() -> Self {
516        Self {
517            class: ElfClass::Elf32,
518            data: ElfData::LittleEndian,
519            elf_type: ElfType::Exec,
520            machine: ElfMachine::Arm,
521            entry: 0,
522            e_flags: EF_ARM_EABI_VER5,
523            sections: Vec::new(),
524            symbols: Vec::new(),
525            program_headers: Vec::new(),
526            relocations: Vec::new(),
527            extra_relocations: Vec::new(),
528            thumb_funcs: true,
529        }
530    }
531
532    /// #598: mark the object's functions as A32-encoded (cortex-r5 path) —
533    /// suppresses the Thumb interworking bit on STT_FUNC `st_value`s and on
534    /// `e_entry`. Call BEFORE `with_entry`.
535    pub fn with_thumb_funcs(mut self, thumb: bool) -> Self {
536        self.thumb_funcs = thumb;
537        self
538    }
539
540    /// Set entry point
541    ///
542    /// For ARM Thumb targets, bit 0 is automatically set to indicate Thumb mode.
543    /// Cortex-M is Thumb-only, so function addresses in ELF must have bit 0 set.
544    /// A32 objects (`with_thumb_funcs(false)`, #598) keep bit 0 clear.
545    pub fn with_entry(mut self, entry: u32) -> Self {
546        self.entry = if self.machine == ElfMachine::Arm && self.thumb_funcs {
547            entry | 1 // Set Thumb bit for ARM Thumb targets
548        } else {
549            entry
550        };
551        self
552    }
553
554    /// Set ELF e_flags (e.g. to add hard-float ABI)
555    pub fn set_flags(&mut self, flags: u32) {
556        self.e_flags = flags;
557    }
558
559    /// Set file type
560    pub fn with_type(mut self, elf_type: ElfType) -> Self {
561        self.elf_type = elf_type;
562        self
563    }
564
565    /// Add a section
566    pub fn add_section(&mut self, section: Section) {
567        self.sections.push(section);
568    }
569
570    /// Add a symbol
571    pub fn add_symbol(&mut self, symbol: Symbol) {
572        self.symbols.push(symbol);
573    }
574
575    /// Add a symbol and return its 1-based index in `.symtab` (index 0 is the
576    /// reserved null symbol). Use when a later relocation must reference this
577    /// symbol — e.g. the `.text` base symbol the DWARF `.rel.debug_*` records
578    /// resolve against (VCR-DBG-001).
579    pub fn add_symbol_indexed(&mut self, symbol: Symbol) -> u32 {
580        let index = self.symbols.len() as u32 + 1;
581        self.symbols.push(symbol);
582        index
583    }
584
585    /// Add a program header (segment)
586    pub fn add_program_header(&mut self, ph: ProgramHeader) {
587        self.program_headers.push(ph);
588    }
589
590    /// Add a relocation entry for the .text section
591    pub fn add_relocation(&mut self, reloc: Relocation) {
592        self.relocations.push(reloc);
593    }
594
595    /// Add a relocation table targeting a non-`.text` section by name (e.g.
596    /// `.debug_line`). Produces a separate `.rel.<name>` section whose `sh_info`
597    /// points at the named section. The section must already have been added via
598    /// [`add_section`]; if no matching section exists at build time the table is
599    /// silently dropped. Used by VCR-DBG-001 to relocate the DWARF `.text`
600    /// references so a host linker fixes them up alongside `.text`.
601    pub fn add_section_relocations(&mut self, target_section: &str, relocs: Vec<Relocation>) {
602        if relocs.is_empty() {
603            return;
604        }
605        self.extra_relocations
606            .push((target_section.to_string(), relocs));
607    }
608
609    /// Add an undefined external symbol (e.g., __meld_dispatch_import)
610    /// Returns the symbol index (1-based, accounting for null symbol)
611    pub fn add_undefined_symbol(&mut self, name: &str) -> u32 {
612        let index = self.symbols.len() as u32 + 1; // +1 for null symbol
613        self.symbols.push(Symbol {
614            name: name.to_string(),
615            value: 0,
616            size: 0,
617            binding: SymbolBinding::Global,
618            symbol_type: SymbolType::Func,
619            section: 0, // SHN_UNDEF
620        });
621        index
622    }
623
624    /// Build the ELF file to bytes
625    pub fn build(&self) -> Result<Vec<u8>> {
626        let mut output = Vec::new();
627
628        // ELF header size (52 bytes for ELF32)
629        let header_size = 52;
630        // Program header size (32 bytes for ELF32)
631        let ph_entry_size = 32;
632        let ph_count = self.program_headers.len();
633        let ph_table_size = ph_entry_size * ph_count;
634
635        // Reserve space for ELF header + program headers
636        output.resize(header_size + ph_table_size, 0);
637
638        // Build string table for section names
639        let (shstrtab_data, section_name_offsets, extra_rel_name_offsets) =
640            self.build_section_string_table();
641
642        // Build symbol string table
643        let (strtab_data, symbol_name_offsets) = self.build_symbol_string_table();
644
645        // #656: ELF requires every STB_LOCAL symbol to precede all non-local
646        // symbols in `.symtab`, with the section's `sh_info` set to the index of
647        // the first non-local symbol. Callers add symbols in whatever order is
648        // convenient (and hold 1-based indices from `add_symbol_indexed` /
649        // `add_undefined_symbol` for their relocations), so the LOCAL/GLOBAL
650        // ordering is established here at build time: a stable locals-first
651        // permutation, plus an old→new index map every relocation is rewritten
652        // through. With zero local symbols (every pre-#656 object) the
653        // permutation is the identity and `sh_info` stays 1 — byte-identical.
654        //
655        // #1180: the permutation itself is `synth_core::backend::locals_first`,
656        // the ONE definition of the rule — the aarch64 object plan applies the
657        // same function, so the two backends cannot drift on it again.
658        let locals = synth_core::backend::locals_first(self.symbols.iter().map(|s| s.binding));
659        let sym_order: Vec<usize> = locals.order;
660        // old_to_new[old_1based] = new_1based; index 0 (the null symbol) maps to 0.
661        let mut old_to_new = vec![0u32; self.symbols.len() + 1];
662        for (old, &new) in locals.old_to_new.iter().enumerate() {
663            old_to_new[old + 1] = new as u32 + 1;
664        }
665        // The null symbol (index 0) counts as local, so first-global = locals + 1.
666        let symtab_sh_info = locals.local_count as u32 + 1;
667        let remap_relocs = |relocs: &[Relocation]| -> Vec<Relocation> {
668            relocs
669                .iter()
670                .map(|r| Relocation {
671                    offset: r.offset,
672                    symbol_index: old_to_new[r.symbol_index as usize],
673                    reloc_type: r.reloc_type,
674                })
675                .collect()
676        };
677
678        // Calculate section offsets (after ELF header + program headers)
679        let mut current_offset = header_size + ph_table_size;
680
681        // Section 1: .shstrtab (section name string table)
682        let shstrtab_offset = current_offset;
683        current_offset += shstrtab_data.len();
684
685        // Section 2: .strtab (symbol name string table)
686        let strtab_offset = current_offset;
687        current_offset += strtab_data.len();
688
689        // User sections
690        let mut section_offsets = Vec::new();
691        for section in &self.sections {
692            section_offsets.push(current_offset);
693            current_offset += section.data.len();
694        }
695
696        // Section 3: .symtab (symbol table), in locals-first order (#656)
697        let symtab_offset = current_offset;
698        let symtab_data = self.build_symbol_table(&symbol_name_offsets, &sym_order);
699        current_offset += symtab_data.len();
700
701        // Section 4+ (optional): .rel.text (relocations), symbol indices
702        // rewritten through the locals-first permutation (#656)
703        let rel_data = Self::encode_rel_entries(&remap_relocs(&self.relocations));
704        let rel_offset = current_offset;
705        current_offset += rel_data.len();
706
707        // Extra per-section relocation tables (.rel.<name>), laid out after
708        // .rel.text. Each entry resolves its target section index by name; a
709        // table whose target section is absent is dropped. Empty when no
710        // --debug-line ⇒ byte-identical to the pre-generalization layout.
711        let mut extra_rel: Vec<ExtraRelSection> = Vec::new();
712        for (i, (target, relocs)) in self.extra_relocations.iter().enumerate() {
713            let Some(target_idx) = self.section_index_by_name(target) else {
714                continue;
715            };
716            let data = Self::encode_rel_entries(&remap_relocs(relocs));
717            let name_offset = extra_rel_name_offsets.get(i).copied().unwrap_or(0);
718            extra_rel.push(ExtraRelSection {
719                name_offset,
720                target_idx,
721                offset: current_offset,
722                data,
723            });
724            current_offset += extra_rel.last().unwrap().data.len();
725        }
726
727        // Section header table comes at the end
728        let sh_offset = current_offset;
729
730        // Now write all the data
731        output.extend_from_slice(&shstrtab_data);
732        output.extend_from_slice(&strtab_data);
733
734        for section in &self.sections {
735            output.extend_from_slice(&section.data);
736        }
737
738        output.extend_from_slice(&symtab_data);
739        output.extend_from_slice(&rel_data);
740        for er in &extra_rel {
741            output.extend_from_slice(&er.data);
742        }
743
744        // Write section headers
745        let section_headers = self.build_section_headers_with_rel(
746            &section_name_offsets,
747            shstrtab_offset,
748            &shstrtab_data,
749            strtab_offset,
750            &strtab_data,
751            symtab_offset,
752            &symtab_data,
753            &section_offsets,
754            rel_offset,
755            &rel_data,
756            &extra_rel,
757            symtab_sh_info,
758        );
759        output.extend_from_slice(&section_headers);
760
761        // Write program headers (right after ELF header)
762        // Auto-correct p_offset for LOAD segments by matching vaddr to section addrs
763        for (i, ph) in self.program_headers.iter().enumerate() {
764            let ph_offset = header_size + i * ph_entry_size;
765            let mut corrected_ph = ph.clone();
766            if corrected_ph.filesz > 0 {
767                // Find the section whose addr matches this segment's vaddr
768                for (si, section) in self.sections.iter().enumerate() {
769                    if section.addr == corrected_ph.vaddr && si < section_offsets.len() {
770                        corrected_ph.offset = section_offsets[si] as u32;
771                        break;
772                    }
773                }
774            }
775            self.write_program_header(
776                &mut output[ph_offset..ph_offset + ph_entry_size],
777                &corrected_ph,
778            );
779        }
780
781        // Now write the actual ELF header at the beginning
782        let has_rel = !self.relocations.is_empty();
783        let num_sections = 4 + self.sections.len() + if has_rel { 1 } else { 0 } + extra_rel.len();
784        let ph_offset = if ph_count > 0 { header_size as u32 } else { 0 };
785        self.write_elf_header_with_phdrs(
786            &mut output[0..header_size],
787            ph_offset,
788            ph_count as u16,
789            sh_offset as u32,
790            num_sections as u16,
791        )?;
792
793        Ok(output)
794    }
795
796    /// Write a single program header
797    fn write_program_header(&self, output: &mut [u8], ph: &ProgramHeader) {
798        let mut cursor = 0;
799
800        // p_type (4 bytes)
801        output[cursor..cursor + 4].copy_from_slice(&(ph.p_type as u32).to_le_bytes());
802        cursor += 4;
803
804        // p_offset (4 bytes)
805        output[cursor..cursor + 4].copy_from_slice(&ph.offset.to_le_bytes());
806        cursor += 4;
807
808        // p_vaddr (4 bytes)
809        output[cursor..cursor + 4].copy_from_slice(&ph.vaddr.to_le_bytes());
810        cursor += 4;
811
812        // p_paddr (4 bytes)
813        output[cursor..cursor + 4].copy_from_slice(&ph.paddr.to_le_bytes());
814        cursor += 4;
815
816        // p_filesz (4 bytes)
817        output[cursor..cursor + 4].copy_from_slice(&ph.filesz.to_le_bytes());
818        cursor += 4;
819
820        // p_memsz (4 bytes)
821        output[cursor..cursor + 4].copy_from_slice(&ph.memsz.to_le_bytes());
822        cursor += 4;
823
824        // p_flags (4 bytes)
825        output[cursor..cursor + 4].copy_from_slice(&ph.flags.to_le_bytes());
826        cursor += 4;
827
828        // p_align (4 bytes)
829        output[cursor..cursor + 4].copy_from_slice(&ph.align.to_le_bytes());
830    }
831
832    /// Write ELF header with program header info
833    fn write_elf_header_with_phdrs(
834        &self,
835        output: &mut [u8],
836        ph_offset: u32,
837        ph_count: u16,
838        sh_offset: u32,
839        sh_count: u16,
840    ) -> Result<()> {
841        let mut cursor = 0;
842
843        // ELF magic number
844        output[cursor..cursor + 4].copy_from_slice(&[0x7f, b'E', b'L', b'F']);
845        cursor += 4;
846
847        // Class (32-bit)
848        output[cursor] = self.class as u8;
849        cursor += 1;
850
851        // Data (little-endian)
852        output[cursor] = self.data as u8;
853        cursor += 1;
854
855        // Version
856        output[cursor] = 1;
857        cursor += 1;
858
859        // OS/ABI
860        output[cursor] = 0; // System V
861        cursor += 1;
862
863        // ABI version
864        output[cursor] = 0;
865        cursor += 1;
866
867        // Padding (7 bytes)
868        output[cursor..cursor + 7].copy_from_slice(&[0; 7]);
869        cursor += 7;
870
871        // Type (little-endian u16)
872        let etype = self.elf_type as u16;
873        output[cursor..cursor + 2].copy_from_slice(&etype.to_le_bytes());
874        cursor += 2;
875
876        // Machine (little-endian u16)
877        let machine = self.machine as u16;
878        output[cursor..cursor + 2].copy_from_slice(&machine.to_le_bytes());
879        cursor += 2;
880
881        // Version (little-endian u32)
882        output[cursor..cursor + 4].copy_from_slice(&1u32.to_le_bytes());
883        cursor += 4;
884
885        // Entry point (little-endian u32)
886        output[cursor..cursor + 4].copy_from_slice(&self.entry.to_le_bytes());
887        cursor += 4;
888
889        // Program header offset (little-endian u32)
890        output[cursor..cursor + 4].copy_from_slice(&ph_offset.to_le_bytes());
891        cursor += 4;
892
893        // Section header offset (little-endian u32)
894        output[cursor..cursor + 4].copy_from_slice(&sh_offset.to_le_bytes());
895        cursor += 4;
896
897        // Flags (little-endian u32) - ARM EABI version 5 + float ABI
898        output[cursor..cursor + 4].copy_from_slice(&self.e_flags.to_le_bytes());
899        cursor += 4;
900
901        // ELF header size (little-endian u16)
902        output[cursor..cursor + 2].copy_from_slice(&52u16.to_le_bytes());
903        cursor += 2;
904
905        // Program header entry size (little-endian u16)
906        let ph_entry_size: u16 = if ph_count > 0 { 32 } else { 0 };
907        output[cursor..cursor + 2].copy_from_slice(&ph_entry_size.to_le_bytes());
908        cursor += 2;
909
910        // Program header count (little-endian u16)
911        output[cursor..cursor + 2].copy_from_slice(&ph_count.to_le_bytes());
912        cursor += 2;
913
914        // Section header entry size (little-endian u16)
915        output[cursor..cursor + 2].copy_from_slice(&40u16.to_le_bytes());
916        cursor += 2;
917
918        // Section header count (little-endian u16)
919        output[cursor..cursor + 2].copy_from_slice(&sh_count.to_le_bytes());
920        cursor += 2;
921
922        // Section header string table index (little-endian u16) - .shstrtab is section 1
923        output[cursor..cursor + 2].copy_from_slice(&1u16.to_le_bytes());
924
925        Ok(())
926    }
927
928    /// Build section name string table. Returns the bytes, the per-user-section
929    /// name offsets, and the per-extra-relocation `.rel.<name>` name offsets
930    /// (parallel to `self.extra_relocations`). The extra-rel names are appended
931    /// AFTER `.rel.text`, so when `extra_relocations` is empty the table is
932    /// byte-identical to the pre-generalization layout.
933    fn build_section_string_table(&self) -> (Vec<u8>, Vec<usize>, Vec<usize>) {
934        let mut strtab = vec![0]; // null string at offset 0
935        let mut offsets = Vec::new();
936
937        // Standard sections
938        strtab.extend_from_slice(b".shstrtab\0");
939        strtab.extend_from_slice(b".strtab\0");
940        strtab.extend_from_slice(b".symtab\0");
941
942        // User sections
943        for section in &self.sections {
944            let offset = strtab.len();
945            offsets.push(offset);
946            strtab.extend_from_slice(section.name.as_bytes());
947            strtab.push(0);
948        }
949
950        // .rel.text (if relocations exist)
951        if !self.relocations.is_empty() {
952            strtab.extend_from_slice(b".rel.text\0");
953        }
954
955        // .rel.<name> for each extra per-section relocation table.
956        let mut extra_rel_offsets = Vec::new();
957        for (target, _) in &self.extra_relocations {
958            let offset = strtab.len();
959            extra_rel_offsets.push(offset);
960            strtab.extend_from_slice(format!(".rel{target}\0").as_bytes());
961        }
962
963        (strtab, offsets, extra_rel_offsets)
964    }
965
966    /// Build symbol name string table
967    fn build_symbol_string_table(&self) -> (Vec<u8>, Vec<usize>) {
968        let mut strtab = vec![0]; // null string at offset 0
969        let mut offsets = Vec::new();
970
971        for symbol in &self.symbols {
972            let offset = strtab.len();
973            offsets.push(offset);
974            strtab.extend_from_slice(symbol.name.as_bytes());
975            strtab.push(0);
976        }
977
978        (strtab, offsets)
979    }
980
981    /// Encode a slice of relocations as ELF32 REL entries (8 bytes each). Shared
982    /// by `.rel.text` and the per-section `.rel.<name>` tables.
983    fn encode_rel_entries(relocs: &[Relocation]) -> Vec<u8> {
984        let mut rel_data = Vec::new();
985        for reloc in relocs {
986            // r_offset (4 bytes)
987            rel_data.extend_from_slice(&reloc.offset.to_le_bytes());
988            // r_info (4 bytes) = (sym_index << 8) | type
989            let r_info = (reloc.symbol_index << 8) | (reloc.reloc_type as u32);
990            rel_data.extend_from_slice(&r_info.to_le_bytes());
991        }
992        rel_data
993    }
994
995    /// Resolve a target section name to its ELF section index. User sections
996    /// begin at index 4 (null=0, shstrtab=1, strtab=2, symtab=3). Returns `None`
997    /// if no user section has that name.
998    fn section_index_by_name(&self, name: &str) -> Option<u32> {
999        self.sections
1000            .iter()
1001            .position(|s| s.name == name)
1002            .map(|pos| 4 + pos as u32)
1003    }
1004
1005    /// Build symbol table. `order` is the locals-first permutation of
1006    /// `self.symbols` computed in [`build`] (#656): entry `k` of the emitted
1007    /// table (after the null symbol) is `self.symbols[order[k]]`.
1008    fn build_symbol_table(&self, name_offsets: &[usize], order: &[usize]) -> Vec<u8> {
1009        let mut symtab = Vec::new();
1010
1011        // First entry is always null symbol
1012        symtab.extend_from_slice(&[0u8; 16]); // 16 bytes per symbol in ELF32
1013
1014        // User symbols, locals first (#656)
1015        for &i in order {
1016            let symbol = &self.symbols[i];
1017            let name_offset = if i < name_offsets.len() {
1018                name_offsets[i] as u32
1019            } else {
1020                0
1021            };
1022
1023            // st_name (4 bytes)
1024            symtab.extend_from_slice(&name_offset.to_le_bytes());
1025
1026            // st_value (4 bytes)
1027            // For ARM THUMB targets, STT_FUNC symbols must have bit 0 set (Thumb
1028            // interworking). #598: A32 objects (cortex-r5 path) must NOT set it —
1029            // bit 0 on an A32 function address is wrong metadata (harnesses had
1030            // to mask it; an interworking-aware consumer would mis-classify the
1031            // function as Thumb).
1032            let value = if self.machine == ElfMachine::Arm
1033                && self.thumb_funcs
1034                && symbol.symbol_type == SymbolType::Func
1035            {
1036                symbol.value | 1
1037            } else {
1038                symbol.value
1039            };
1040            symtab.extend_from_slice(&value.to_le_bytes());
1041
1042            // st_size (4 bytes)
1043            symtab.extend_from_slice(&symbol.size.to_le_bytes());
1044
1045            // st_info (1 byte) = (binding << 4) | (type & 0xf)
1046            let info = ((symbol.binding as u8) << 4) | (symbol.symbol_type as u8 & 0xf);
1047            symtab.push(info);
1048
1049            // st_other (1 byte)
1050            symtab.push(0);
1051
1052            // st_shndx (2 bytes)
1053            symtab.extend_from_slice(&symbol.section.to_le_bytes());
1054        }
1055
1056        symtab
1057    }
1058
1059    /// Build section headers (with optional .rel.text)
1060    #[allow(clippy::too_many_arguments)]
1061    fn build_section_headers_with_rel(
1062        &self,
1063        section_name_offsets: &[usize],
1064        shstrtab_offset: usize,
1065        shstrtab_data: &[u8],
1066        strtab_offset: usize,
1067        strtab_data: &[u8],
1068        symtab_offset: usize,
1069        symtab_data: &[u8],
1070        section_offsets: &[usize],
1071        rel_offset: usize,
1072        rel_data: &[u8],
1073        extra_rel: &[ExtraRelSection],
1074        // #656: `.symtab` sh_info = index of the first non-LOCAL symbol
1075        // (1 + number of local symbols; the null symbol counts as local).
1076        symtab_sh_info: u32,
1077    ) -> Vec<u8> {
1078        let mut headers = Vec::new();
1079
1080        // Section header size is 40 bytes for ELF32
1081
1082        // Section 0: null section
1083        headers.extend_from_slice(&[0u8; 40]);
1084
1085        // Section 1: .shstrtab
1086        self.write_section_header(
1087            &mut headers,
1088            1,
1089            SectionType::StrTab as u32,
1090            0,
1091            0,
1092            shstrtab_offset as u32,
1093            shstrtab_data.len() as u32,
1094            0,
1095            0,
1096            1,
1097            0,
1098        );
1099
1100        // Section 2: .strtab
1101        let strtab_name_offset = ".shstrtab\0".len();
1102        self.write_section_header(
1103            &mut headers,
1104            strtab_name_offset as u32,
1105            SectionType::StrTab as u32,
1106            0,
1107            0,
1108            strtab_offset as u32,
1109            strtab_data.len() as u32,
1110            0,
1111            0,
1112            1,
1113            0,
1114        );
1115
1116        // Section 3: .symtab (links to .strtab which is section 2)
1117        let symtab_name_offset = ".shstrtab\0.strtab\0".len();
1118        self.write_section_header(
1119            &mut headers,
1120            symtab_name_offset as u32,
1121            SectionType::SymTab as u32,
1122            0,
1123            0,
1124            symtab_offset as u32,
1125            symtab_data.len() as u32,
1126            2,
1127            // #656: was hardcoded 1 (the #430 blocker) — with local symbols
1128            // present that under-reports, and `ld` then treats every local as
1129            // global-bindable. Now the real first-non-local index.
1130            symtab_sh_info,
1131            4,
1132            16,
1133        );
1134
1135        // User sections
1136        for (i, section) in self.sections.iter().enumerate() {
1137            let name_offset = if i < section_name_offsets.len() {
1138                section_name_offsets[i] as u32
1139            } else {
1140                0
1141            };
1142            let offset = if i < section_offsets.len() {
1143                section_offsets[i] as u32
1144            } else {
1145                0
1146            };
1147
1148            self.write_section_header(
1149                &mut headers,
1150                name_offset,
1151                section.section_type as u32,
1152                section.flags,
1153                section.addr,
1154                offset,
1155                section.size(),
1156                0,
1157                0,
1158                section.align,
1159                0,
1160            );
1161        }
1162
1163        // .rel.text section (if relocations exist)
1164        if !rel_data.is_empty() {
1165            let rel_name_offset = self.rel_text_shstrtab_offset();
1166            // sh_link = symtab section index (3), sh_info = .text section index (4, first user section)
1167            let text_section_idx = 4u32; // null(0) + shstrtab(1) + strtab(2) + symtab(3) + .text(4)
1168            self.write_section_header(
1169                &mut headers,
1170                rel_name_offset as u32,
1171                SectionType::Rel as u32,
1172                0,
1173                0,
1174                rel_offset as u32,
1175                rel_data.len() as u32,
1176                3,                // sh_link = .symtab section index
1177                text_section_idx, // sh_info = section to which relocations apply
1178                4,
1179                8, // Each REL entry is 8 bytes
1180            );
1181        }
1182
1183        // Extra .rel.<name> sections (e.g. .rel.debug_line). Same shape as
1184        // .rel.text but sh_info points at the named target section.
1185        for er in extra_rel {
1186            self.write_section_header(
1187                &mut headers,
1188                er.name_offset as u32,
1189                SectionType::Rel as u32,
1190                0,
1191                0,
1192                er.offset as u32,
1193                er.data.len() as u32,
1194                3,             // sh_link = .symtab section index
1195                er.target_idx, // sh_info = relocated section
1196                4,
1197                8, // Each REL entry is 8 bytes
1198            );
1199        }
1200
1201        headers
1202    }
1203
1204    /// Compute the shstrtab offset where .rel.text name begins
1205    fn rel_text_shstrtab_offset(&self) -> usize {
1206        // Layout: \0 .shstrtab\0 .strtab\0 .symtab\0 [user sections...] .rel.text\0
1207        let mut offset = 1 + ".shstrtab\0".len() + ".strtab\0".len() + ".symtab\0".len();
1208        for section in &self.sections {
1209            offset += section.name.len() + 1;
1210        }
1211        offset
1212    }
1213
1214    /// Write a single section header
1215    #[allow(clippy::too_many_arguments)]
1216    fn write_section_header(
1217        &self,
1218        output: &mut Vec<u8>,
1219        name: u32,
1220        sh_type: u32,
1221        flags: u32,
1222        addr: u32,
1223        offset: u32,
1224        size: u32,
1225        link: u32,
1226        info: u32,
1227        align: u32,
1228        entsize: u32,
1229    ) {
1230        output.extend_from_slice(&name.to_le_bytes());
1231        output.extend_from_slice(&sh_type.to_le_bytes());
1232        output.extend_from_slice(&flags.to_le_bytes());
1233        output.extend_from_slice(&addr.to_le_bytes());
1234        output.extend_from_slice(&offset.to_le_bytes());
1235        output.extend_from_slice(&size.to_le_bytes());
1236        output.extend_from_slice(&link.to_le_bytes());
1237        output.extend_from_slice(&info.to_le_bytes());
1238        output.extend_from_slice(&align.to_le_bytes());
1239        output.extend_from_slice(&entsize.to_le_bytes());
1240    }
1241
1242    /// Write ELF header (legacy method for tests)
1243    #[allow(dead_code)]
1244    fn write_elf_header(&self, output: &mut Vec<u8>) -> Result<()> {
1245        // ELF magic number
1246        output.extend_from_slice(&[0x7f, b'E', b'L', b'F']);
1247
1248        // Class (32-bit)
1249        output.push(self.class as u8);
1250
1251        // Data (little-endian)
1252        output.push(self.data as u8);
1253
1254        // Version
1255        output.push(1);
1256
1257        // OS/ABI
1258        output.push(0); // System V
1259
1260        // ABI version
1261        output.push(0);
1262
1263        // Padding
1264        output.extend_from_slice(&[0; 7]);
1265
1266        // Type (little-endian u16)
1267        let etype = self.elf_type as u16;
1268        output.extend_from_slice(&etype.to_le_bytes());
1269
1270        // Machine (little-endian u16)
1271        let machine = self.machine as u16;
1272        output.extend_from_slice(&machine.to_le_bytes());
1273
1274        // Version (little-endian u32)
1275        output.extend_from_slice(&1u32.to_le_bytes());
1276
1277        // Entry point (little-endian u32)
1278        output.extend_from_slice(&self.entry.to_le_bytes());
1279
1280        // Program header offset (little-endian u32)
1281        output.extend_from_slice(&0u32.to_le_bytes());
1282
1283        // Section header offset (little-endian u32)
1284        output.extend_from_slice(&0u32.to_le_bytes());
1285
1286        // Flags (little-endian u32)
1287        output.extend_from_slice(&0u32.to_le_bytes());
1288
1289        // ELF header size (little-endian u16)
1290        output.extend_from_slice(&52u16.to_le_bytes());
1291
1292        // Program header entry size (little-endian u16)
1293        output.extend_from_slice(&0u16.to_le_bytes());
1294
1295        // Program header count (little-endian u16)
1296        output.extend_from_slice(&0u16.to_le_bytes());
1297
1298        // Section header entry size (little-endian u16)
1299        output.extend_from_slice(&40u16.to_le_bytes());
1300
1301        // Section header count (little-endian u16)
1302        output.extend_from_slice(&0u16.to_le_bytes());
1303
1304        // Section header string table index (little-endian u16)
1305        output.extend_from_slice(&0u16.to_le_bytes());
1306
1307        Ok(())
1308    }
1309}
1310
1311#[cfg(test)]
1312mod tests {
1313    use super::*;
1314
1315    #[test]
1316    fn test_elf_builder_creation() {
1317        let builder = ElfBuilder::new_arm32();
1318        assert_eq!(builder.class, ElfClass::Elf32);
1319        assert_eq!(builder.data, ElfData::LittleEndian);
1320        assert_eq!(builder.machine, ElfMachine::Arm);
1321    }
1322
1323    #[test]
1324    fn test_section_creation() {
1325        let section = Section::new(".text", SectionType::ProgBits)
1326            .with_flags(SectionFlags::ALLOC | SectionFlags::EXEC)
1327            .with_addr(0x8000)
1328            .with_align(4);
1329
1330        assert_eq!(section.name, ".text");
1331        assert_eq!(section.section_type, SectionType::ProgBits);
1332        assert_eq!(section.addr, 0x8000);
1333        assert_eq!(section.align, 4);
1334    }
1335
1336    #[test]
1337    fn test_symbol_creation() {
1338        let symbol = Symbol::new("main")
1339            .with_value(0x8000)
1340            .with_size(128)
1341            .with_binding(SymbolBinding::Global)
1342            .with_type(SymbolType::Func)
1343            .with_section(1);
1344
1345        assert_eq!(symbol.name, "main");
1346        assert_eq!(symbol.value, 0x8000);
1347        assert_eq!(symbol.size, 128);
1348        assert_eq!(symbol.binding, SymbolBinding::Global);
1349        assert_eq!(symbol.symbol_type, SymbolType::Func);
1350    }
1351
1352    #[test]
1353    fn test_elf_header_generation() {
1354        let builder = ElfBuilder::new_arm32().with_entry(0x8000);
1355        let elf = builder.build().unwrap();
1356
1357        // Check magic number
1358        assert_eq!(&elf[0..4], &[0x7f, b'E', b'L', b'F']);
1359
1360        // Check class (32-bit)
1361        assert_eq!(elf[4], 1);
1362
1363        // Check data (little-endian)
1364        assert_eq!(elf[5], 1);
1365
1366        // Check version
1367        assert_eq!(elf[6], 1);
1368    }
1369
1370    #[test]
1371    fn test_add_sections() {
1372        let mut builder = ElfBuilder::new_arm32();
1373
1374        let text = Section::new(".text", SectionType::ProgBits)
1375            .with_flags(SectionFlags::ALLOC | SectionFlags::EXEC);
1376
1377        let data = Section::new(".data", SectionType::ProgBits)
1378            .with_flags(SectionFlags::ALLOC | SectionFlags::WRITE);
1379
1380        builder.add_section(text);
1381        builder.add_section(data);
1382
1383        assert_eq!(builder.sections.len(), 2);
1384    }
1385
1386    #[test]
1387    fn test_add_symbols() {
1388        let mut builder = ElfBuilder::new_arm32();
1389
1390        let main_sym = Symbol::new("main")
1391            .with_binding(SymbolBinding::Global)
1392            .with_type(SymbolType::Func);
1393
1394        let data_sym = Symbol::new("data")
1395            .with_binding(SymbolBinding::Local)
1396            .with_type(SymbolType::Object);
1397
1398        builder.add_symbol(main_sym);
1399        builder.add_symbol(data_sym);
1400
1401        assert_eq!(builder.symbols.len(), 2);
1402    }
1403
1404    #[test]
1405    fn test_complete_elf_generation() {
1406        // Create a complete ELF file with sections and symbols
1407        let mut builder = ElfBuilder::new_arm32()
1408            .with_entry(0x8000)
1409            .with_type(ElfType::Exec);
1410
1411        // Add .text section with some ARM code
1412        let text_code = vec![
1413            0x00, 0x48, 0x2d, 0xe9, // push {fp, lr}
1414            0x04, 0xb0, 0x8d, 0xe2, // add fp, sp, #4
1415            0x00, 0x00, 0xa0, 0xe3, // mov r0, #0
1416            0x00, 0x88, 0xbd, 0xe8, // pop {fp, pc}
1417        ];
1418        let text = Section::new(".text", SectionType::ProgBits)
1419            .with_flags(SectionFlags::ALLOC | SectionFlags::EXEC)
1420            .with_addr(0x8000)
1421            .with_align(4)
1422            .with_data(text_code);
1423
1424        builder.add_section(text);
1425
1426        // Add .data section
1427        let data_content = vec![0x01, 0x02, 0x03, 0x04];
1428        let data = Section::new(".data", SectionType::ProgBits)
1429            .with_flags(SectionFlags::ALLOC | SectionFlags::WRITE)
1430            .with_addr(0x8100)
1431            .with_align(4)
1432            .with_data(data_content);
1433
1434        builder.add_section(data);
1435
1436        // Add .bss section (no data)
1437        let bss = Section::new(".bss", SectionType::NoBits)
1438            .with_flags(SectionFlags::ALLOC | SectionFlags::WRITE)
1439            .with_addr(0x8200)
1440            .with_align(4);
1441
1442        builder.add_section(bss);
1443
1444        // Add symbols
1445        let main_sym = Symbol::new("main")
1446            .with_value(0x8000)
1447            .with_size(16)
1448            .with_binding(SymbolBinding::Global)
1449            .with_type(SymbolType::Func)
1450            .with_section(4); // .text is section 4 (0=null, 1=shstrtab, 2=strtab, 3=symtab, 4=.text)
1451
1452        builder.add_symbol(main_sym);
1453
1454        let data_var = Symbol::new("global_var")
1455            .with_value(0x8100)
1456            .with_size(4)
1457            .with_binding(SymbolBinding::Global)
1458            .with_type(SymbolType::Object)
1459            .with_section(5); // .data is section 5
1460
1461        builder.add_symbol(data_var);
1462
1463        // Build the ELF file
1464        let elf = builder.build().unwrap();
1465
1466        // Validate ELF header
1467        assert_eq!(&elf[0..4], &[0x7f, b'E', b'L', b'F']);
1468        assert_eq!(elf[4], 1); // 32-bit
1469        assert_eq!(elf[5], 1); // little-endian
1470        assert_eq!(elf[6], 1); // version
1471
1472        // Check that we have a reasonable file size
1473        assert!(elf.len() > 52); // At least header size
1474        assert!(elf.len() < 10000); // Reasonable upper bound
1475
1476        // Validate entry point is set correctly (Thumb bit set for ARM)
1477        let entry_bytes = &elf[24..28];
1478        let entry = u32::from_le_bytes([
1479            entry_bytes[0],
1480            entry_bytes[1],
1481            entry_bytes[2],
1482            entry_bytes[3],
1483        ]);
1484        assert_eq!(entry, 0x8001); // 0x8000 | 1 (Thumb bit)
1485
1486        // Validate section header offset is non-zero
1487        let sh_off_bytes = &elf[32..36];
1488        let sh_off = u32::from_le_bytes([
1489            sh_off_bytes[0],
1490            sh_off_bytes[1],
1491            sh_off_bytes[2],
1492            sh_off_bytes[3],
1493        ]);
1494        assert!(sh_off > 0);
1495
1496        // Validate section count (null + shstrtab + strtab + symtab + .text + .data + .bss = 7)
1497        let sh_num_bytes = &elf[48..50];
1498        let sh_num = u16::from_le_bytes([sh_num_bytes[0], sh_num_bytes[1]]);
1499        assert_eq!(sh_num, 7);
1500
1501        // Validate string table index points to .shstrtab (section 1)
1502        let shstrndx_bytes = &elf[50..52];
1503        let shstrndx = u16::from_le_bytes([shstrndx_bytes[0], shstrndx_bytes[1]]);
1504        assert_eq!(shstrndx, 1);
1505    }
1506
1507    #[test]
1508    fn test_string_table_generation() {
1509        let mut builder = ElfBuilder::new_arm32();
1510
1511        builder.add_section(Section::new(".text", SectionType::ProgBits));
1512        builder.add_section(Section::new(".data", SectionType::ProgBits));
1513
1514        let (strtab, offsets, _extra_rel_offsets) = builder.build_section_string_table();
1515
1516        // Should have null byte at start
1517        assert_eq!(strtab[0], 0);
1518
1519        // Should contain .shstrtab, .strtab, .symtab, .text, .data
1520        let strtab_str = String::from_utf8_lossy(&strtab);
1521        assert!(strtab_str.contains(".shstrtab"));
1522        assert!(strtab_str.contains(".strtab"));
1523        assert!(strtab_str.contains(".symtab"));
1524        assert!(strtab_str.contains(".text"));
1525        assert!(strtab_str.contains(".data"));
1526
1527        // Should have offsets for user sections
1528        assert_eq!(offsets.len(), 2);
1529    }
1530
1531    #[test]
1532    fn test_relocation_support() {
1533        let mut builder = ElfBuilder::new_arm32()
1534            .with_entry(0x8000)
1535            .with_type(ElfType::Rel);
1536
1537        // Add .text section with a BL placeholder
1538        let text_code = vec![0x00u8; 16]; // 4 instructions of placeholder
1539        let text = Section::new(".text", SectionType::ProgBits)
1540            .with_flags(SectionFlags::ALLOC | SectionFlags::EXEC)
1541            .with_addr(0x8000)
1542            .with_align(4)
1543            .with_data(text_code);
1544        builder.add_section(text);
1545
1546        // Add undefined external symbol
1547        let sym_idx = builder.add_undefined_symbol("__meld_dispatch_import");
1548        assert!(sym_idx > 0);
1549
1550        // Add relocation for the BL at offset 4
1551        builder.add_relocation(Relocation {
1552            offset: 4,
1553            symbol_index: sym_idx,
1554            reloc_type: ArmRelocationType::Call,
1555        });
1556
1557        let elf = builder.build().unwrap();
1558
1559        // Verify ELF is valid
1560        assert_eq!(&elf[0..4], &[0x7f, b'E', b'L', b'F']);
1561
1562        // Section count should include .rel.text
1563        // null(1) + shstrtab(1) + strtab(1) + symtab(1) + .text(1) + .rel.text(1) = 6
1564        let sh_num = u16::from_le_bytes([elf[48], elf[49]]);
1565        assert_eq!(sh_num, 6);
1566
1567        // Verify the symbol table contains the undefined symbol
1568        // (section = 0 for SHN_UNDEF)
1569        let has_undef = elf
1570            .windows(b"__meld_dispatch_import".len())
1571            .any(|w| w == b"__meld_dispatch_import");
1572        assert!(
1573            has_undef,
1574            "ELF should contain __meld_dispatch_import symbol name"
1575        );
1576    }
1577
1578    #[test]
1579    fn test_symbol_table_encoding() {
1580        let mut builder = ElfBuilder::new_arm32();
1581
1582        let sym = Symbol::new("test_func")
1583            .with_value(0x1000)
1584            .with_size(64)
1585            .with_binding(SymbolBinding::Global)
1586            .with_type(SymbolType::Func)
1587            .with_section(1);
1588
1589        builder.add_symbol(sym);
1590
1591        let (_strtab, offsets) = builder.build_symbol_string_table();
1592        let symtab = builder.build_symbol_table(&offsets, &[0]);
1593
1594        // Should have null symbol (16 bytes) + 1 symbol (16 bytes) = 32 bytes
1595        assert_eq!(symtab.len(), 32);
1596
1597        // First symbol should be all zeros
1598        assert!(symtab[0..16].iter().all(|&b| b == 0));
1599
1600        // Second symbol should have correct encoding
1601        // Check st_value (bytes 4-7 of second entry)
1602        // For ARM STT_FUNC symbols, bit 0 is set for Thumb interworking
1603        let value_bytes = &symtab[20..24];
1604        let value = u32::from_le_bytes([
1605            value_bytes[0],
1606            value_bytes[1],
1607            value_bytes[2],
1608            value_bytes[3],
1609        ]);
1610        assert_eq!(value, 0x1001); // 0x1000 | 1 (Thumb bit)
1611
1612        // Check st_size (bytes 8-11 of second entry)
1613        let size_bytes = &symtab[24..28];
1614        let size = u32::from_le_bytes([size_bytes[0], size_bytes[1], size_bytes[2], size_bytes[3]]);
1615        assert_eq!(size, 64);
1616
1617        // Check st_info (byte 12 of second entry)
1618        let info = symtab[28];
1619        let binding = info >> 4;
1620        let sym_type = info & 0xf;
1621        assert_eq!(binding, SymbolBinding::Global as u8);
1622        assert_eq!(sym_type, SymbolType::Func as u8);
1623    }
1624
1625    /// #598: an A32 object (`with_thumb_funcs(false)`, cortex-r5 path) must
1626    /// NOT set the Thumb interworking bit on STT_FUNC symbols or `e_entry` —
1627    /// bit 0 on an A32 code address is wrong metadata (harnesses had to mask
1628    /// it). Non-func symbols never carried the bit; that stays true.
1629    #[test]
1630    fn test_a32_symbols_have_no_thumb_bit_598() {
1631        let mut builder = ElfBuilder::new_arm32().with_thumb_funcs(false);
1632
1633        let func_sym = Symbol::new("a32_func")
1634            .with_value(0x1000)
1635            .with_size(64)
1636            .with_binding(SymbolBinding::Global)
1637            .with_type(SymbolType::Func)
1638            .with_section(1);
1639        builder.add_symbol(func_sym);
1640
1641        let (_strtab, offsets) = builder.build_symbol_string_table();
1642        let symtab = builder.build_symbol_table(&offsets, &[0]);
1643        let value = u32::from_le_bytes(symtab[20..24].try_into().unwrap());
1644        assert_eq!(value, 0x1000, "A32 STT_FUNC st_value must keep bit 0 clear");
1645
1646        // e_entry stays clear too (was `0 | 1` on the A32 relocatable path).
1647        let builder = ElfBuilder::new_arm32()
1648            .with_thumb_funcs(false)
1649            .with_entry(0x8000);
1650        assert_eq!(builder.entry, 0x8000, "A32 e_entry must keep bit 0 clear");
1651
1652        // The default (Thumb) behavior is unchanged: bit 0 set on both.
1653        let builder = ElfBuilder::new_arm32().with_entry(0x8000);
1654        assert_eq!(builder.entry, 0x8001, "Thumb e_entry keeps the bit");
1655    }
1656
1657    /// Minimal ELF32 section-header reader for the tests below:
1658    /// (sh_type, sh_offset, sh_size, sh_link, sh_info) per section.
1659    fn read_section_headers(elf: &[u8]) -> Vec<(u32, u32, u32, u32, u32)> {
1660        let e_shoff = u32::from_le_bytes(elf[32..36].try_into().unwrap()) as usize;
1661        let e_shnum = u16::from_le_bytes(elf[48..50].try_into().unwrap()) as usize;
1662        (0..e_shnum)
1663            .map(|i| {
1664                let base = e_shoff + i * 40;
1665                let f = |off: usize| {
1666                    u32::from_le_bytes(elf[base + off..base + off + 4].try_into().unwrap())
1667                };
1668                (f(4), f(16), f(20), f(24), f(28))
1669            })
1670            .collect()
1671    }
1672
1673    /// Read symtab entries as (st_value, st_info, st_shndx).
1674    fn read_symtab(elf: &[u8]) -> (Vec<(u32, u8, u16)>, u32) {
1675        let headers = read_section_headers(elf);
1676        let &(_, off, size, _, sh_info) = headers
1677            .iter()
1678            .find(|h| h.0 == SectionType::SymTab as u32)
1679            .expect("symtab present");
1680        let syms = (0..size as usize / 16)
1681            .map(|i| {
1682                let base = off as usize + i * 16;
1683                (
1684                    u32::from_le_bytes(elf[base + 4..base + 8].try_into().unwrap()),
1685                    elf[base + 12],
1686                    u16::from_le_bytes(elf[base + 14..base + 16].try_into().unwrap()),
1687                )
1688            })
1689            .collect();
1690        (syms, sh_info)
1691    }
1692
1693    /// #656: local symbols must be emitted BEFORE globals (stable within each
1694    /// class), `.symtab` `sh_info` must be the first-non-local index, and every
1695    /// relocation's symbol index must be rewritten through the permutation.
1696    #[test]
1697    fn test_locals_sorted_first_sh_info_and_reloc_reindex_656() {
1698        let mut builder = ElfBuilder::new_arm32()
1699            .with_entry(0)
1700            .with_type(ElfType::Rel);
1701        let text = Section::new(".text", SectionType::ProgBits)
1702            .with_flags(SectionFlags::ALLOC | SectionFlags::EXEC)
1703            .with_align(4)
1704            .with_data(vec![0u8; 16]);
1705        builder.add_section(text);
1706
1707        // Added out of ELF order: global export first, then a LOCAL internal
1708        // helper, then a global undefined external.
1709        builder.add_symbol(
1710            Symbol::new("exported")
1711                .with_value(0)
1712                .with_binding(SymbolBinding::Global)
1713                .with_type(SymbolType::Func)
1714                .with_section(4),
1715        ); // pre-build index 1
1716        builder.add_symbol(
1717            Symbol::new("func_2")
1718                .with_value(8)
1719                .with_binding(SymbolBinding::Local)
1720                .with_type(SymbolType::Func)
1721                .with_section(4),
1722        ); // pre-build index 2
1723        let undef_idx = builder.add_undefined_symbol("external"); // pre-build index 3
1724        assert_eq!(undef_idx, 3);
1725
1726        // BL at offset 0 → the LOCAL func_2 (pre-build index 2);
1727        // BL at offset 4 → the undefined external (pre-build index 3).
1728        builder.add_relocation(Relocation {
1729            offset: 0,
1730            symbol_index: 2,
1731            reloc_type: ArmRelocationType::ThmCall,
1732        });
1733        builder.add_relocation(Relocation {
1734            offset: 4,
1735            symbol_index: undef_idx,
1736            reloc_type: ArmRelocationType::ThmCall,
1737        });
1738
1739        let elf = builder.build().unwrap();
1740        let (syms, sh_info) = read_symtab(&elf);
1741
1742        // Order: null, func_2 (LOCAL), exported (GLOBAL), external (GLOBAL undef).
1743        assert_eq!(syms.len(), 4);
1744        assert_eq!(syms[0], (0, 0, 0), "null symbol first");
1745        let bind = |info: u8| info >> 4;
1746        assert_eq!(bind(syms[1].1), SymbolBinding::Local as u8, "local first");
1747        assert_eq!(syms[1].0, 8 | 1, "func_2 st_value (thumb bit)");
1748        assert_eq!(bind(syms[2].1), SymbolBinding::Global as u8);
1749        assert_eq!(syms[2].0, 1, "exported st_value 0 | thumb bit");
1750        assert_eq!(bind(syms[3].1), SymbolBinding::Global as u8);
1751        assert_eq!(syms[3].2, 0, "external is SHN_UNDEF");
1752        assert_eq!(sh_info, 2, "sh_info = index of first non-local symbol");
1753
1754        // Relocations rewritten: func_2 is now index 1, external index 3.
1755        let headers = read_section_headers(&elf);
1756        let &(_, rel_off, rel_size, _, rel_info) = headers
1757            .iter()
1758            .find(|h| h.0 == SectionType::Rel as u32)
1759            .expect(".rel.text present");
1760        assert_eq!(rel_info, 4, ".rel.text still targets .text");
1761        assert_eq!(rel_size, 16);
1762        let r_info = |i: usize| {
1763            u32::from_le_bytes(
1764                elf[rel_off as usize + i * 8 + 4..rel_off as usize + i * 8 + 8]
1765                    .try_into()
1766                    .unwrap(),
1767            )
1768        };
1769        assert_eq!(r_info(0) >> 8, 1, "BL func_2 reloc remapped to new index 1");
1770        assert_eq!(r_info(0) & 0xff, ArmRelocationType::ThmCall as u32);
1771        assert_eq!(r_info(1) >> 8, 3, "BL external reloc keeps index 3");
1772    }
1773
1774    /// #656 freeze guard: with zero LOCAL symbols the permutation is the
1775    /// identity and `sh_info` stays 1 — the pre-#656 layout, byte-identical.
1776    #[test]
1777    fn test_all_global_symtab_unchanged_sh_info_1_656() {
1778        let mut builder = ElfBuilder::new_arm32()
1779            .with_entry(0)
1780            .with_type(ElfType::Rel);
1781        builder.add_section(
1782            Section::new(".text", SectionType::ProgBits)
1783                .with_flags(SectionFlags::ALLOC | SectionFlags::EXEC)
1784                .with_data(vec![0u8; 8]),
1785        );
1786        for (name, val) in [("a", 0u32), ("b", 4u32)] {
1787            builder.add_symbol(
1788                Symbol::new(name)
1789                    .with_value(val)
1790                    .with_binding(SymbolBinding::Global)
1791                    .with_type(SymbolType::Func)
1792                    .with_section(4),
1793            );
1794        }
1795        let elf = builder.build().unwrap();
1796        let (syms, sh_info) = read_symtab(&elf);
1797        assert_eq!(sh_info, 1, "no locals ⇒ sh_info stays 1 (pre-#656 layout)");
1798        assert_eq!(syms[1].0, 1, "a first (insertion order preserved)");
1799        assert_eq!(syms[2].0, 5, "b second");
1800    }
1801
1802    /// #637: `.ARM.attributes` blob structure — format version 'A', "aeabi"
1803    /// vendor subsection, Tag_File subsubsection with the uleb tag pairs, and
1804    /// zero-valued tags omitted (spec default).
1805    #[test]
1806    fn test_arm_attributes_section_bytes_637() {
1807        // Cortex-M3: v7, profile M, no A32, Thumb-2.
1808        let sec = arm_attributes_section(aeabi::CPU_ARCH_V7, aeabi::PROFILE_M, 0, 2, 0, 0);
1809        assert_eq!(sec.name, ".ARM.attributes");
1810        assert_eq!(sec.section_type, SectionType::ArmAttributes);
1811        let d = &sec.data;
1812        assert_eq!(d[0], b'A', "format version");
1813        let vendor_len = u32::from_le_bytes(d[1..5].try_into().unwrap()) as usize;
1814        assert_eq!(vendor_len, d.len() - 1, "vendor subsection length");
1815        assert_eq!(&d[5..11], b"aeabi\0");
1816        assert_eq!(d[11], 1, "Tag_File");
1817        let file_len = u32::from_le_bytes(d[12..16].try_into().unwrap()) as usize;
1818        assert_eq!(file_len, d.len() - 11, "Tag_File length");
1819        // Attribute pairs (all values < 128 ⇒ one uleb byte each).
1820        let attrs = &d[16..];
1821        assert_eq!(
1822            attrs,
1823            &[
1824                6, 10, // Tag_CPU_arch = v7
1825                7, b'M', // Tag_CPU_arch_profile = M
1826                9, 2, // Tag_THUMB_ISA_use = Thumb-2 (Tag_ARM_ISA_use=0 omitted)
1827            ],
1828        );
1829
1830        // Cortex-R5: v7, profile R, A32 permitted, Thumb-2 permitted.
1831        let sec = arm_attributes_section(aeabi::CPU_ARCH_V7, aeabi::PROFILE_R, 1, 2, 0, 0);
1832        assert_eq!(&sec.data[16..], &[6, 10, 7, b'R', 8, 1, 9, 2]);
1833
1834        // GI-FPU-002: a hard-float FPU target adds Tag_FP_arch(10)=VFPv4-D16(6)
1835        // and Tag_ABI_VFP_args(28)=1, in ascending tag order.
1836        let sec = arm_attributes_section(
1837            aeabi::CPU_ARCH_V7EM,
1838            aeabi::PROFILE_M,
1839            0,
1840            2,
1841            aeabi::FP_ARCH_VFPV4_D16,
1842            aeabi::VFP_ARGS_VFP_REGS,
1843        );
1844        assert_eq!(&sec.data[16..], &[6, 13, 7, b'M', 9, 2, 10, 6, 28, 1]);
1845    }
1846}
synth_backend/elf_builder.rs

synth_backend/
elf_builder.rs
