rustc_ast_lowering/
stability.rs

1use std::fmt;
2
3use rustc_abi::ExternAbi;
4use rustc_feature::Features;
5use rustc_session::Session;
6use rustc_session::parse::feature_err;
7use rustc_span::symbol::sym;
8use rustc_span::{Span, Symbol};
9
10pub(crate) fn enabled_names(features: &rustc_feature::Features, span: Span) -> Vec<&'static str> {
11    ExternAbi::ALL_VARIANTS
12        .into_iter()
13        .filter(|abi| extern_abi_enabled(features, span, **abi).is_ok())
14        .map(|abi| abi.as_str())
15        .collect()
16}
17
18pub(crate) fn extern_abi_enabled(
19    features: &rustc_feature::Features,
20    span: Span,
21    abi: ExternAbi,
22) -> Result<(), UnstableAbi> {
23    extern_abi_stability(abi).or_else(|unstable @ UnstableAbi { feature, .. }| {
24        if features.enabled(feature) || span.allows_unstable(feature) {
25            Ok(())
26        } else {
27            Err(unstable)
28        }
29    })
30}
31
32#[allow(rustc::untranslatable_diagnostic)]
33pub(crate) fn gate_unstable_abi(sess: &Session, features: &Features, span: Span, abi: ExternAbi) {
34    match extern_abi_enabled(features, span, abi) {
35        Ok(_) => (),
36        Err(unstable_abi) => {
37            let explain = unstable_abi.to_string();
38            feature_err(sess, unstable_abi.feature, span, explain).emit();
39        }
40    }
41}
42
43pub struct UnstableAbi {
44    abi: ExternAbi,
45    feature: Symbol,
46    explain: GateReason,
47}
48
49enum GateReason {
50    Experimental,
51    ImplDetail,
52}
53
54impl fmt::Display for UnstableAbi {
55    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
56        let Self { abi, .. } = self;
57        match self.explain {
58            GateReason::Experimental => {
59                write!(f, "the extern {abi} ABI is experimental and subject to change")
60            }
61            GateReason::ImplDetail => {
62                write!(f, "the extern {abi} ABI is an implementation detail and perma-unstable")
63            }
64        }
65    }
66}
67
68pub fn extern_abi_stability(abi: ExternAbi) -> Result<(), UnstableAbi> {
69    match abi {
70        // stable ABIs
71        ExternAbi::Rust
72        | ExternAbi::C { .. }
73        | ExternAbi::Cdecl { .. }
74        | ExternAbi::Stdcall { .. }
75        | ExternAbi::Fastcall { .. }
76        | ExternAbi::Thiscall { .. }
77        | ExternAbi::Aapcs { .. }
78        | ExternAbi::Win64 { .. }
79        | ExternAbi::SysV64 { .. }
80        | ExternAbi::System { .. }
81        | ExternAbi::EfiApi => Ok(()),
82        ExternAbi::Unadjusted => {
83            Err(UnstableAbi { abi, feature: sym::abi_unadjusted, explain: GateReason::ImplDetail })
84        }
85        // experimental
86        ExternAbi::Vectorcall { .. } => Err(UnstableAbi {
87            abi,
88            feature: sym::abi_vectorcall,
89            explain: GateReason::Experimental,
90        }),
91        ExternAbi::RustCall => Err(UnstableAbi {
92            abi,
93            feature: sym::unboxed_closures,
94            explain: GateReason::Experimental,
95        }),
96        ExternAbi::RustCold => {
97            Err(UnstableAbi { abi, feature: sym::rust_cold_cc, explain: GateReason::Experimental })
98        }
99        ExternAbi::RustInvalid => {
100            Err(UnstableAbi { abi, feature: sym::rustc_attrs, explain: GateReason::ImplDetail })
101        }
102        ExternAbi::GpuKernel => Err(UnstableAbi {
103            abi,
104            feature: sym::abi_gpu_kernel,
105            explain: GateReason::Experimental,
106        }),
107        ExternAbi::PtxKernel => {
108            Err(UnstableAbi { abi, feature: sym::abi_ptx, explain: GateReason::Experimental })
109        }
110        ExternAbi::Msp430Interrupt => Err(UnstableAbi {
111            abi,
112            feature: sym::abi_msp430_interrupt,
113            explain: GateReason::Experimental,
114        }),
115        ExternAbi::X86Interrupt => Err(UnstableAbi {
116            abi,
117            feature: sym::abi_x86_interrupt,
118            explain: GateReason::Experimental,
119        }),
120        ExternAbi::AvrInterrupt | ExternAbi::AvrNonBlockingInterrupt => Err(UnstableAbi {
121            abi,
122            feature: sym::abi_avr_interrupt,
123            explain: GateReason::Experimental,
124        }),
125        ExternAbi::RiscvInterruptM | ExternAbi::RiscvInterruptS => Err(UnstableAbi {
126            abi,
127            feature: sym::abi_riscv_interrupt,
128            explain: GateReason::Experimental,
129        }),
130        ExternAbi::CmseNonSecureCall => Err(UnstableAbi {
131            abi,
132            feature: sym::abi_cmse_nonsecure_call,
133            explain: GateReason::Experimental,
134        }),
135        ExternAbi::CmseNonSecureEntry => Err(UnstableAbi {
136            abi,
137            feature: sym::cmse_nonsecure_entry,
138            explain: GateReason::Experimental,
139        }),
140        ExternAbi::Custom => {
141            Err(UnstableAbi { abi, feature: sym::abi_custom, explain: GateReason::Experimental })
142        }
143    }
144}