lamina-codegen 0.2.0

//! AArch64 ABI utilities for symbol naming and calling conventions.

use crate::abi::{Abi, common_call_stub, mangle_macos_name};
use crate::target_support::os_uses_macho;
use lamina_platform::TargetOperatingSystem;

/// Platform-specific ABI utilities for AArch64 code generation.
pub struct AArch64ABI {
    target_os: TargetOperatingSystem,
}

impl AArch64ABI {
    /// Creates a new ABI instance for the specified target OS.
    pub fn new(target_os: TargetOperatingSystem) -> Self {
        Self { target_os }
    }

    /// Returns the mangled function name with platform-specific prefix.
    pub fn mangle_function_name(&self, name: &str) -> String {
        match self.target_os {
            os if os_uses_macho(os) => mangle_macos_name(name),
            _ => name.to_string(),
        }
    }

    /// Returns the global declaration directive for a function.
    pub fn get_global_directive(&self, func_name: &str) -> Option<String> {
        match self.target_os {
            os if os_uses_macho(os) => Some(format!(".globl _{func_name}")),
            _ => Some(format!(".globl {func_name}")),
        }
    }

    /// Maps well-known intrinsic/runtime names to platform symbol stubs.
    pub fn call_stub(&self, name: &str) -> Option<String> {
        common_call_stub(name, self.target_os)
    }

    /// AArch64 AAPCS64 calling convention argument registers (first 8 arguments).
    pub const ARG_REGISTERS: &'static [&'static str] =
        &["x0", "x1", "x2", "x3", "x4", "x5", "x6", "x7"];

    /// Caller-saved registers that must be preserved by the caller if live across function calls.
    pub const CALLER_SAVED_REGISTERS: &'static [&'static str] = &[
        "x0", "x1", "x2", "x3", "x4", "x5", "x6", "x7", "x8", "x9", "x10", "x11", "x12", "x13",
        "x14", "x15", "x16", "x17",
    ];

    /// Callee-saved registers that are preserved by called functions.
    pub const CALLEE_SAVED_REGISTERS: &'static [&'static str] = &[
        "x19", "x20", "x21", "x22", "x23", "x24", "x25", "x26", "x27", "x28", "x29", "x30",
    ];

    /// Returns the target operating system for this ABI instance.
    pub fn target_os(&self) -> TargetOperatingSystem {
        self.target_os
    }
}

impl Abi for AArch64ABI {
    fn target_os(&self) -> TargetOperatingSystem {
        self.target_os
    }

    fn mangle_function_name(&self, name: &str) -> String {
        AArch64ABI::mangle_function_name(self, name)
    }

    fn call_stub(&self, name: &str) -> Option<String> {
        AArch64ABI::call_stub(self, name)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_aarch64_mangle_function_name() {
        let abi_linux = AArch64ABI::new(TargetOperatingSystem::Linux);
        assert_eq!(abi_linux.mangle_function_name("main"), "main");
        assert_eq!(abi_linux.mangle_function_name("foo"), "foo");
        assert_eq!(abi_linux.mangle_function_name("my_func"), "my_func");

        let abi_macos = AArch64ABI::new(TargetOperatingSystem::MacOS);
        assert_eq!(abi_macos.mangle_function_name("main"), "_main");
        assert_eq!(abi_macos.mangle_function_name("foo"), "_foo");
        assert_eq!(abi_macos.mangle_function_name("my_func"), "_my_func");
    }

    #[test]
    fn test_aarch64_call_stub() {
        let abi_linux = AArch64ABI::new(TargetOperatingSystem::Linux);
        assert_eq!(abi_linux.call_stub("malloc"), Some("malloc".to_string()));
        assert_eq!(abi_linux.call_stub("dealloc"), Some("free".to_string()));
        assert_eq!(abi_linux.call_stub("unknown"), None);

        let abi_macos = AArch64ABI::new(TargetOperatingSystem::MacOS);
        assert_eq!(abi_macos.call_stub("malloc"), Some("_malloc".to_string()));
    }

    #[test]
    fn test_aarch64_arg_registers() {
        assert_eq!(AArch64ABI::ARG_REGISTERS.len(), 8);
        assert_eq!(AArch64ABI::ARG_REGISTERS[0], "x0");
        assert_eq!(AArch64ABI::ARG_REGISTERS[7], "x7");
    }

    #[test]
    fn test_aarch64_caller_saved_registers() {
        assert_eq!(AArch64ABI::CALLER_SAVED_REGISTERS.len(), 18);
        assert!(AArch64ABI::CALLER_SAVED_REGISTERS.contains(&"x0"));
        assert!(AArch64ABI::CALLER_SAVED_REGISTERS.contains(&"x15"));
    }

    #[test]
    fn test_aarch64_callee_saved_registers() {
        assert_eq!(AArch64ABI::CALLEE_SAVED_REGISTERS.len(), 12);
        assert!(AArch64ABI::CALLEE_SAVED_REGISTERS.contains(&"x19"));
        assert!(AArch64ABI::CALLEE_SAVED_REGISTERS.contains(&"x30"));
    }

    #[test]
    fn test_aarch64_get_global_directive() {
        let abi_linux = AArch64ABI::new(TargetOperatingSystem::Linux);
        assert_eq!(
            abi_linux.get_global_directive("main"),
            Some(".globl main".to_string())
        );
        assert_eq!(
            abi_linux.get_global_directive("foo"),
            Some(".globl foo".to_string())
        );

        let abi_macos = AArch64ABI::new(TargetOperatingSystem::MacOS);
        assert_eq!(
            abi_macos.get_global_directive("main"),
            Some(".globl _main".to_string())
        );
        assert_eq!(
            abi_macos.get_global_directive("foo"),
            Some(".globl _foo".to_string())
        );

        let abi_ios = AArch64ABI::new(TargetOperatingSystem::IOS);
        assert_eq!(abi_ios.mangle_function_name("main"), "_main");
        assert_eq!(
            abi_ios.get_global_directive("main"),
            Some(".globl _main".to_string())
        );
    }
}