rustc_target/spec/
abi_map.rs

1use rustc_abi::{ArmCall, CanonAbi, ExternAbi, InterruptKind, X86Call};
2
3use crate::spec::Target;
4
5/// Mapping for ExternAbi to CanonAbi according to a Target
6///
7/// A maybe-transitional structure circa 2025 for hosting future experiments in
8/// encapsulating arch-specific ABI lowering details to make them more testable.
9#[derive(Clone, Debug)]
10pub struct AbiMap {
11    arch: Arch,
12    os: OsKind,
13}
14
15/// result from trying to map an ABI
16#[derive(Copy, Clone, Debug)]
17pub enum AbiMapping {
18    /// this ABI is exactly mapped for this platform
19    Direct(CanonAbi),
20    /// we don't yet warn on this, but we will
21    Deprecated(CanonAbi),
22    /// ABI we do not map for this platform: it must not reach codegen
23    Invalid,
24}
25
26impl AbiMapping {
27    /// optionally get a [CanonAbi], even if Deprecated
28    pub fn into_option(self) -> Option<CanonAbi> {
29        match self {
30            Self::Direct(abi) | Self::Deprecated(abi) => Some(abi),
31            Self::Invalid => None,
32        }
33    }
34
35    /// get a [CanonAbi] even if Deprecated, panicking if Invalid
36    #[track_caller]
37    pub fn unwrap(self) -> CanonAbi {
38        self.into_option().unwrap()
39    }
40
41    pub fn is_mapped(self) -> bool {
42        self.into_option().is_some()
43    }
44}
45
46impl AbiMap {
47    /// create an AbiMap according to arbitrary fields on the [Target]
48    pub fn from_target(target: &Target) -> Self {
49        // the purpose of this little exercise is to force listing what affects these mappings
50        let arch = match &*target.arch {
51            "aarch64" => Arch::Aarch64,
52            "amdgpu" => Arch::Amdgpu,
53            "arm" if target.llvm_target.starts_with("thumbv8m") => Arch::Arm(ArmVer::ThumbV8M),
54            "arm" => Arch::Arm(ArmVer::Other),
55            "avr" => Arch::Avr,
56            "msp430" => Arch::Msp430,
57            "nvptx64" => Arch::Nvptx,
58            "riscv32" | "riscv64" => Arch::Riscv,
59            "x86" => Arch::X86,
60            "x86_64" => Arch::X86_64,
61            _ => Arch::Other,
62        };
63        let os = if target.is_like_windows { OsKind::Windows } else { OsKind::Other };
64        AbiMap { arch, os }
65    }
66
67    /// lower an [ExternAbi] to a [CanonAbi] if this AbiMap allows
68    pub fn canonize_abi(&self, extern_abi: ExternAbi, has_c_varargs: bool) -> AbiMapping {
69        let AbiMap { os, arch } = *self;
70
71        let canon_abi = match (extern_abi, arch) {
72            // infallible lowerings
73            (ExternAbi::C { .. }, _) => CanonAbi::C,
74            (ExternAbi::Rust | ExternAbi::RustCall, _) => CanonAbi::Rust,
75            (ExternAbi::Unadjusted, _) => CanonAbi::C,
76
77            (ExternAbi::RustCold, _) if self.os == OsKind::Windows => CanonAbi::Rust,
78            (ExternAbi::RustCold, _) => CanonAbi::RustCold,
79
80            (ExternAbi::Custom, _) => CanonAbi::Custom,
81
82            (ExternAbi::System { .. }, Arch::X86) if os == OsKind::Windows && !has_c_varargs => {
83                CanonAbi::X86(X86Call::Stdcall)
84            }
85            (ExternAbi::System { .. }, _) => CanonAbi::C,
86
87            // fallible lowerings
88            /* multi-platform */
89            // always and forever
90            (ExternAbi::RustInvalid, _) => return AbiMapping::Invalid,
91
92            (ExternAbi::EfiApi, Arch::Arm(..)) => CanonAbi::Arm(ArmCall::Aapcs),
93            (ExternAbi::EfiApi, Arch::X86_64) => CanonAbi::X86(X86Call::Win64),
94            (ExternAbi::EfiApi, Arch::Aarch64 | Arch::Riscv | Arch::X86) => CanonAbi::C,
95            (ExternAbi::EfiApi, _) => return AbiMapping::Invalid,
96
97            /* arm */
98            (ExternAbi::Aapcs { .. }, Arch::Arm(..)) => CanonAbi::Arm(ArmCall::Aapcs),
99            (ExternAbi::Aapcs { .. }, _) => return AbiMapping::Invalid,
100
101            (ExternAbi::CmseNonSecureCall, Arch::Arm(ArmVer::ThumbV8M)) => {
102                CanonAbi::Arm(ArmCall::CCmseNonSecureCall)
103            }
104            (ExternAbi::CmseNonSecureEntry, Arch::Arm(ArmVer::ThumbV8M)) => {
105                CanonAbi::Arm(ArmCall::CCmseNonSecureEntry)
106            }
107            (ExternAbi::CmseNonSecureCall | ExternAbi::CmseNonSecureEntry, ..) => {
108                return AbiMapping::Invalid;
109            }
110
111            /* gpu */
112            (ExternAbi::PtxKernel, Arch::Nvptx) => CanonAbi::GpuKernel,
113            (ExternAbi::GpuKernel, Arch::Amdgpu | Arch::Nvptx) => CanonAbi::GpuKernel,
114            (ExternAbi::PtxKernel | ExternAbi::GpuKernel, _) => return AbiMapping::Invalid,
115
116            /* x86 */
117            (ExternAbi::Cdecl { .. }, Arch::X86) => CanonAbi::C,
118            (ExternAbi::Cdecl { .. }, _) => return AbiMapping::Deprecated(CanonAbi::C),
119
120            (ExternAbi::Fastcall { .. }, Arch::X86) => CanonAbi::X86(X86Call::Fastcall),
121            (ExternAbi::Fastcall { .. }, _) if os == OsKind::Windows => {
122                return AbiMapping::Deprecated(CanonAbi::C);
123            }
124            (ExternAbi::Fastcall { .. }, _) => return AbiMapping::Invalid,
125
126            (ExternAbi::Stdcall { .. }, Arch::X86) => CanonAbi::X86(X86Call::Stdcall),
127            (ExternAbi::Stdcall { .. }, _) if os == OsKind::Windows => {
128                return AbiMapping::Deprecated(CanonAbi::C);
129            }
130            (ExternAbi::Stdcall { .. }, _) => return AbiMapping::Invalid,
131
132            (ExternAbi::Thiscall { .. }, Arch::X86) => CanonAbi::X86(X86Call::Thiscall),
133            (ExternAbi::Thiscall { .. }, _) => return AbiMapping::Invalid,
134
135            (ExternAbi::Vectorcall { .. }, Arch::X86 | Arch::X86_64) => {
136                CanonAbi::X86(X86Call::Vectorcall)
137            }
138            (ExternAbi::Vectorcall { .. }, _) => return AbiMapping::Invalid,
139
140            (ExternAbi::SysV64 { .. }, Arch::X86_64) => CanonAbi::X86(X86Call::SysV64),
141            (ExternAbi::Win64 { .. }, Arch::X86_64) => CanonAbi::X86(X86Call::Win64),
142            (ExternAbi::SysV64 { .. } | ExternAbi::Win64 { .. }, _) => return AbiMapping::Invalid,
143
144            /* interrupts */
145            (ExternAbi::AvrInterrupt, Arch::Avr) => CanonAbi::Interrupt(InterruptKind::Avr),
146            (ExternAbi::AvrNonBlockingInterrupt, Arch::Avr) => {
147                CanonAbi::Interrupt(InterruptKind::AvrNonBlocking)
148            }
149            (ExternAbi::Msp430Interrupt, Arch::Msp430) => {
150                CanonAbi::Interrupt(InterruptKind::Msp430)
151            }
152            (ExternAbi::RiscvInterruptM, Arch::Riscv) => {
153                CanonAbi::Interrupt(InterruptKind::RiscvMachine)
154            }
155            (ExternAbi::RiscvInterruptS, Arch::Riscv) => {
156                CanonAbi::Interrupt(InterruptKind::RiscvSupervisor)
157            }
158            (ExternAbi::X86Interrupt, Arch::X86 | Arch::X86_64) => {
159                CanonAbi::Interrupt(InterruptKind::X86)
160            }
161            (
162                ExternAbi::AvrInterrupt
163                | ExternAbi::AvrNonBlockingInterrupt
164                | ExternAbi::Msp430Interrupt
165                | ExternAbi::RiscvInterruptM
166                | ExternAbi::RiscvInterruptS
167                | ExternAbi::X86Interrupt,
168                _,
169            ) => return AbiMapping::Invalid,
170        };
171
172        AbiMapping::Direct(canon_abi)
173    }
174}
175
176#[derive(Debug, PartialEq, Copy, Clone)]
177enum Arch {
178    Aarch64,
179    Amdgpu,
180    Arm(ArmVer),
181    Avr,
182    Msp430,
183    Nvptx,
184    Riscv,
185    X86,
186    X86_64,
187    /// Architectures which don't need other considerations for ABI lowering
188    Other,
189}
190
191#[derive(Debug, PartialEq, Copy, Clone)]
192enum OsKind {
193    Windows,
194    Other,
195}
196
197#[derive(Debug, PartialEq, Copy, Clone)]
198enum ArmVer {
199    ThumbV8M,
200    Other,
201}
rustc_target/spec/abi_map.rs

rustc_target/spec/
abi_map.rs
