Skip to main content

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
32pub(crate) fn gate_unstable_abi(sess: &Session, features: &Features, span: Span, abi: ExternAbi) {
33    match extern_abi_enabled(features, span, abi) {
34        Ok(_) => (),
35        Err(unstable_abi) => {
36            let explain = unstable_abi.to_string();
37            feature_err(sess, unstable_abi.feature, span, explain).emit();
38        }
39    }
40}
41
42pub struct UnstableAbi {
43    abi: ExternAbi,
44    feature: Symbol,
45    explain: GateReason,
46}
47
48enum GateReason {
49    Experimental,
50    ImplDetail,
51}
52
53impl fmt::Display for UnstableAbi {
54    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
55        let Self { abi, .. } = self;
56        match self.explain {
57            GateReason::Experimental => {
58                f.write_fmt(format_args!("the extern {0} ABI is experimental and subject to change",
        abi))write!(f, "the extern {abi} ABI is experimental and subject to change")
59            }
60            GateReason::ImplDetail => {
61                f.write_fmt(format_args!("the extern {0} ABI is an implementation detail and perma-unstable",
        abi))write!(f, "the extern {abi} ABI is an implementation detail and perma-unstable")
62            }
63        }
64    }
65}
66
67pub fn extern_abi_stability(abi: ExternAbi) -> Result<(), UnstableAbi> {
68    match abi {
69        // stable ABIs
70        ExternAbi::Rust
71        | ExternAbi::C { .. }
72        | ExternAbi::Cdecl { .. }
73        | ExternAbi::Stdcall { .. }
74        | ExternAbi::Fastcall { .. }
75        | ExternAbi::Thiscall { .. }
76        | ExternAbi::Aapcs { .. }
77        | ExternAbi::Win64 { .. }
78        | ExternAbi::SysV64 { .. }
79        | ExternAbi::System { .. }
80        | ExternAbi::EfiApi => Ok(()),
81        ExternAbi::Unadjusted => {
82            Err(UnstableAbi { abi, feature: sym::abi_unadjusted, explain: GateReason::ImplDetail })
83        }
84        // experimental
85        ExternAbi::Vectorcall { .. } => Err(UnstableAbi {
86            abi,
87            feature: sym::abi_vectorcall,
88            explain: GateReason::Experimental,
89        }),
90        ExternAbi::RustCall => Err(UnstableAbi {
91            abi,
92            feature: sym::unboxed_closures,
93            explain: GateReason::Experimental,
94        }),
95        ExternAbi::RustCold => {
96            Err(UnstableAbi { abi, feature: sym::rust_cold_cc, explain: GateReason::Experimental })
97        }
98        ExternAbi::RustPreserveNone => Err(UnstableAbi {
99            abi,
100            feature: sym::rust_preserve_none_cc,
101            explain: GateReason::Experimental,
102        }),
103        ExternAbi::RustInvalid => {
104            Err(UnstableAbi { abi, feature: sym::rustc_attrs, explain: GateReason::ImplDetail })
105        }
106        ExternAbi::GpuKernel => Err(UnstableAbi {
107            abi,
108            feature: sym::abi_gpu_kernel,
109            explain: GateReason::Experimental,
110        }),
111        ExternAbi::PtxKernel => {
112            Err(UnstableAbi { abi, feature: sym::abi_ptx, explain: GateReason::Experimental })
113        }
114        ExternAbi::Msp430Interrupt => Err(UnstableAbi {
115            abi,
116            feature: sym::abi_msp430_interrupt,
117            explain: GateReason::Experimental,
118        }),
119        ExternAbi::X86Interrupt => Err(UnstableAbi {
120            abi,
121            feature: sym::abi_x86_interrupt,
122            explain: GateReason::Experimental,
123        }),
124        ExternAbi::AvrInterrupt | ExternAbi::AvrNonBlockingInterrupt => Err(UnstableAbi {
125            abi,
126            feature: sym::abi_avr_interrupt,
127            explain: GateReason::Experimental,
128        }),
129        ExternAbi::RiscvInterruptM | ExternAbi::RiscvInterruptS => Err(UnstableAbi {
130            abi,
131            feature: sym::abi_riscv_interrupt,
132            explain: GateReason::Experimental,
133        }),
134        ExternAbi::CmseNonSecureCall => Err(UnstableAbi {
135            abi,
136            feature: sym::abi_cmse_nonsecure_call,
137            explain: GateReason::Experimental,
138        }),
139        ExternAbi::CmseNonSecureEntry => Err(UnstableAbi {
140            abi,
141            feature: sym::cmse_nonsecure_entry,
142            explain: GateReason::Experimental,
143        }),
144        ExternAbi::Custom => {
145            Err(UnstableAbi { abi, feature: sym::abi_custom, explain: GateReason::Experimental })
146        }
147    }
148}