wasmer-compiler-singlepass 7.0.1

//! ARM64 structures.

use crate::location::{CombinedRegister, Reg as AbstractReg};
use std::slice::Iter;
use wasmer_types::target::CallingConvention;
use wasmer_types::{CompileError, Type};

/*
Register definition: https://github.com/ARM-software/abi-aa/blob/main/aapcs64/aapcs64.rst#611general-purpose-registers

+------+-----------+--------------------------------------------+-------------------+
| Reg  | ABI Name  | Description                                | Saved by Callee   |
+------+-----------+--------------------------------------------+-------------------+
| x0   | a0        | argument / return value 0                  | -R                |
| x1   | a1        | argument / return value 1                  | -R                |
| x2   | a2        | argument 2                                 | -R                |
| x3   | a3        | argument 3                                 | -R                |
| x4   | a4        | argument 4                                 | -R                |
| x5   | a5        | argument 5                                 | -R                |
| x6   | a6        | argument 6                                 | -R                |
| x7   | a7        | argument 7                                 | -R                |
| x8   | x8 (IP0)  | indirect result / scratch (IP0)            | -R                |
| x9   | x9 (IP1)  | scratch / intra-proc-call temporary        | -R                |
| x10  | x10       | scratch / temporary                        | -R                |
| x11  | x11       | scratch / temporary                        | -R                |
| x12  | x12       | scratch / temporary                        | -R                |
| x13  | x13       | scratch / temporary                        | -R                |
| x14  | x14       | scratch / temporary                        | -R                |
| x15  | x15       | scratch / temporary                        | -R                |
| x16  | ip0       | intra-procedure-call scratch (IP0)         | -R                |
| x17  | ip1       | intra-procedure-call scratch (IP1)         | -R                |
| x18  | pr        | platform register (varies by OS/platform)  | -                 |
| x19  | s0        | callee-saved register 0                    | -E                |
| x20  | s1        | callee-saved register 1                    | -E                |
| x21  | s2        | callee-saved register 2                    | -E                |
| x22  | s3        | callee-saved register 3                    | -E                |
| x23  | s4        | callee-saved register 4                    | -E                |
| x24  | s5        | callee-saved register 5                    | -E                |
| x25  | s6        | callee-saved register 6                    | -E                |
| x26  | s7        | callee-saved register 7                    | -E                |
| x27  | s8        | callee-saved register 8                    | -E                |
| x28  | s9        | callee-saved register 9                    | -E                |
| x29  | fp / s10  | frame pointer / callee-saved register 10   | -E                |
| x30  | lr        | link register (return address)             | -R                |
| x31  | sp / wzr  | stack pointer (sp) or zero register (wzr)  | -                 |
+------+-----------+--------------------------------------------+-------------------+
Legend: -R = caller-saved, -E = callee-saved, - = not saved
*/

/// General-purpose registers.
#[repr(u8)]
#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
#[allow(clippy::upper_case_acronyms)]
pub enum GPR {
    X0 = 0,
    X1 = 1,
    X2 = 2,
    X3 = 3,
    X4 = 4,
    X5 = 5,
    X6 = 6,
    X7 = 7,
    X8 = 8,
    X9 = 9,
    X10 = 10,
    X11 = 11,
    X12 = 12,
    X13 = 13,
    X14 = 14,
    X15 = 15,
    X16 = 16,
    X17 = 17,
    X18 = 18,
    X19 = 19,
    X20 = 20,
    X21 = 21,
    X22 = 22,
    X23 = 23,
    X24 = 24,
    X25 = 25,
    X26 = 26,
    X27 = 27,
    X28 = 28,
    X29 = 29,
    X30 = 30,
    XzrSp = 31,
}

impl From<GPR> for u8 {
    fn from(val: GPR) -> Self {
        val as u8
    }
}

/// NEON registers.
#[repr(u8)]
#[derive(Copy, Clone, Debug, Eq, PartialEq, Ord, PartialOrd, Hash)]
#[allow(dead_code)]
#[allow(clippy::upper_case_acronyms)]
pub enum NEON {
    V0 = 0,
    V1 = 1,
    V2 = 2,
    V3 = 3,
    V4 = 4,
    V5 = 5,
    V6 = 6,
    V7 = 7,
    V8 = 8,
    V9 = 9,
    V10 = 10,
    V11 = 11,
    V12 = 12,
    V13 = 13,
    V14 = 14,
    V15 = 15,
    V16 = 16,
    V17 = 17,
    V18 = 18,
    V19 = 19,
    V20 = 20,
    V21 = 21,
    V22 = 22,
    V23 = 23,
    V24 = 24,
    V25 = 25,
    V26 = 26,
    V27 = 27,
    V28 = 28,
    V29 = 29,
    V30 = 30,
    V31 = 31,
}

impl From<NEON> for u8 {
    fn from(val: NEON) -> Self {
        val as u8
    }
}

impl AbstractReg for GPR {
    fn into_index(self) -> usize {
        self as usize
    }
    fn from_index(n: usize) -> Result<GPR, ()> {
        match n {
            0..=31 => Ok(*GPR::iterator().nth(n).unwrap()),
            _ => Err(()),
        }
    }
    fn iterator() -> Iter<'static, GPR> {
        static GPRS: [GPR; 32] = [
            GPR::X0,
            GPR::X1,
            GPR::X2,
            GPR::X3,
            GPR::X4,
            GPR::X5,
            GPR::X6,
            GPR::X7,
            GPR::X8,
            GPR::X9,
            GPR::X10,
            GPR::X11,
            GPR::X12,
            GPR::X13,
            GPR::X14,
            GPR::X15,
            GPR::X16,
            GPR::X17,
            GPR::X18,
            GPR::X19,
            GPR::X20,
            GPR::X21,
            GPR::X22,
            GPR::X23,
            GPR::X24,
            GPR::X25,
            GPR::X26,
            GPR::X27,
            GPR::X28,
            GPR::X29,
            GPR::X30,
            GPR::XzrSp,
        ];
        GPRS.iter()
    }
    #[cfg(feature = "unwind")]
    fn to_dwarf(self) -> gimli::Register {
        use gimli::AArch64;

        match self {
            GPR::X0 => AArch64::X0,
            GPR::X1 => AArch64::X1,
            GPR::X2 => AArch64::X2,
            GPR::X3 => AArch64::X3,
            GPR::X4 => AArch64::X4,
            GPR::X5 => AArch64::X5,
            GPR::X6 => AArch64::X6,
            GPR::X7 => AArch64::X7,
            GPR::X8 => AArch64::X8,
            GPR::X9 => AArch64::X9,
            GPR::X10 => AArch64::X10,
            GPR::X11 => AArch64::X11,
            GPR::X12 => AArch64::X12,
            GPR::X13 => AArch64::X13,
            GPR::X14 => AArch64::X14,
            GPR::X15 => AArch64::X15,
            GPR::X16 => AArch64::X16,
            GPR::X17 => AArch64::X17,
            GPR::X18 => AArch64::X18,
            GPR::X19 => AArch64::X19,
            GPR::X20 => AArch64::X20,
            GPR::X21 => AArch64::X21,
            GPR::X22 => AArch64::X22,
            GPR::X23 => AArch64::X23,
            GPR::X24 => AArch64::X24,
            GPR::X25 => AArch64::X25,
            GPR::X26 => AArch64::X26,
            GPR::X27 => AArch64::X27,
            GPR::X28 => AArch64::X28,
            GPR::X29 => AArch64::X29,
            GPR::X30 => AArch64::X30,
            GPR::XzrSp => AArch64::SP,
        }
    }
}

impl AbstractReg for NEON {
    fn into_index(self) -> usize {
        self as usize
    }
    fn from_index(n: usize) -> Result<NEON, ()> {
        match n {
            0..=31 => Ok(*NEON::iterator().nth(n).unwrap()),
            _ => Err(()),
        }
    }
    fn iterator() -> Iter<'static, NEON> {
        const NEONS: [NEON; 32] = [
            NEON::V0,
            NEON::V1,
            NEON::V2,
            NEON::V3,
            NEON::V4,
            NEON::V5,
            NEON::V6,
            NEON::V7,
            NEON::V8,
            NEON::V9,
            NEON::V10,
            NEON::V11,
            NEON::V12,
            NEON::V13,
            NEON::V14,
            NEON::V15,
            NEON::V16,
            NEON::V17,
            NEON::V18,
            NEON::V19,
            NEON::V20,
            NEON::V21,
            NEON::V22,
            NEON::V23,
            NEON::V24,
            NEON::V25,
            NEON::V26,
            NEON::V27,
            NEON::V28,
            NEON::V29,
            NEON::V30,
            NEON::V31,
        ];
        NEONS.iter()
    }
    #[cfg(feature = "unwind")]
    fn to_dwarf(self) -> gimli::Register {
        use gimli::AArch64;

        match self {
            NEON::V0 => AArch64::V0,
            NEON::V1 => AArch64::V1,
            NEON::V2 => AArch64::V2,
            NEON::V3 => AArch64::V3,
            NEON::V4 => AArch64::V4,
            NEON::V5 => AArch64::V5,
            NEON::V6 => AArch64::V6,
            NEON::V7 => AArch64::V7,
            NEON::V8 => AArch64::V8,
            NEON::V9 => AArch64::V9,
            NEON::V10 => AArch64::V10,
            NEON::V11 => AArch64::V11,
            NEON::V12 => AArch64::V12,
            NEON::V13 => AArch64::V13,
            NEON::V14 => AArch64::V14,
            NEON::V15 => AArch64::V15,
            NEON::V16 => AArch64::V16,
            NEON::V17 => AArch64::V17,
            NEON::V18 => AArch64::V18,
            NEON::V19 => AArch64::V19,
            NEON::V20 => AArch64::V20,
            NEON::V21 => AArch64::V21,
            NEON::V22 => AArch64::V22,
            NEON::V23 => AArch64::V23,
            NEON::V24 => AArch64::V24,
            NEON::V25 => AArch64::V25,
            NEON::V26 => AArch64::V26,
            NEON::V27 => AArch64::V27,
            NEON::V28 => AArch64::V28,
            NEON::V29 => AArch64::V29,
            NEON::V30 => AArch64::V30,
            NEON::V31 => AArch64::V31,
        }
    }
}

/// A machine register under the x86-64 architecture.
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
#[allow(clippy::upper_case_acronyms)]
pub enum ARM64Register {
    /// General-purpose registers.
    GPR(GPR),
    /// NEON (floating point/SIMD) registers.
    NEON(NEON),
}

impl CombinedRegister for ARM64Register {
    /// Convert from a GPR register
    fn from_gpr(x: u16) -> Self {
        ARM64Register::GPR(GPR::from_index(x as usize).unwrap())
    }
    /// Convert from an SIMD register
    fn from_simd(x: u16) -> Self {
        ARM64Register::NEON(NEON::from_index(x as usize).unwrap())
    }
}

/// An allocator that allocates registers for function arguments according to the System V ABI.
#[derive(Default)]
pub struct ArgumentRegisterAllocator {
    n_gprs: usize,
    n_neons: usize,
}

impl ArgumentRegisterAllocator {
    /// Allocates a register for argument type `ty`. Returns `None` if no register is available for this type.
    pub fn next(
        &mut self,
        ty: Type,
        calling_convention: CallingConvention,
    ) -> Result<Option<ARM64Register>, CompileError> {
        let ret = match calling_convention {
            CallingConvention::SystemV | CallingConvention::AppleAarch64 => {
                static GPR_SEQ: &[GPR] = &[
                    GPR::X0,
                    GPR::X1,
                    GPR::X2,
                    GPR::X3,
                    GPR::X4,
                    GPR::X5,
                    GPR::X6,
                    GPR::X7,
                ];
                static NEON_SEQ: &[NEON] = &[
                    NEON::V0,
                    NEON::V1,
                    NEON::V2,
                    NEON::V3,
                    NEON::V4,
                    NEON::V5,
                    NEON::V6,
                    NEON::V7,
                ];
                match ty {
                    Type::I32 | Type::I64 => {
                        if self.n_gprs < GPR_SEQ.len() {
                            let gpr = GPR_SEQ[self.n_gprs];
                            self.n_gprs += 1;
                            Some(ARM64Register::GPR(gpr))
                        } else {
                            None
                        }
                    }
                    Type::F32 | Type::F64 => {
                        if self.n_neons < NEON_SEQ.len() {
                            let neon = NEON_SEQ[self.n_neons];
                            self.n_neons += 1;
                            Some(ARM64Register::NEON(neon))
                        } else {
                            None
                        }
                    }
                    _ => {
                        return Err(CompileError::Codegen(format!(
                            "No register available for {calling_convention:?} and type {ty}"
                        )));
                    }
                }
            }
            _ => {
                return Err(CompileError::Codegen(format!(
                    "No register available for {calling_convention:?} and type {ty}"
                )));
            }
        };

        Ok(ret)
    }
}