rustc_target/
target_features.rs

1//! Declares Rust's target feature names for each target.
2//! Note that these are similar to but not always identical to LLVM's feature names,
3//! and Rust adds some features that do not correspond to LLVM features at all.
4use rustc_data_structures::fx::{FxHashMap, FxHashSet};
5use rustc_data_structures::stable_hasher::{HashStable, StableHasher};
6use rustc_span::{Symbol, sym};
7
8use crate::spec::{FloatAbi, RustcAbi, Target};
9
10/// Features that control behaviour of rustc, rather than the codegen.
11/// These exist globally and are not in the target-specific lists below.
12pub const RUSTC_SPECIFIC_FEATURES: &[&str] = &["crt-static"];
13
14/// Stability information for target features.
15#[derive(Debug, Copy, Clone)]
16pub enum Stability {
17    /// This target feature is stable, it can be used in `#[target_feature]` and
18    /// `#[cfg(target_feature)]`.
19    Stable,
20    /// This target feature is unstable. It is only present in `#[cfg(target_feature)]` on
21    /// nightly and using it in `#[target_feature]` requires enabling the given nightly feature.
22    Unstable(
23        /// This must be a *language* feature, or else rustc will ICE when reporting a missing
24        /// feature gate!
25        Symbol,
26    ),
27    /// This feature can not be set via `-Ctarget-feature` or `#[target_feature]`, it can only be
28    /// set in the target spec. It is never set in `cfg(target_feature)`. Used in
29    /// particular for features are actually ABI configuration flags (not all targets are as nice as
30    /// RISC-V and have an explicit way to set the ABI separate from target features).
31    Forbidden { reason: &'static str },
32}
33use Stability::*;
34
35impl<CTX> HashStable<CTX> for Stability {
36    #[inline]
37    fn hash_stable(&self, hcx: &mut CTX, hasher: &mut StableHasher) {
38        std::mem::discriminant(self).hash_stable(hcx, hasher);
39        match self {
40            Stability::Stable => {}
41            Stability::Unstable(nightly_feature) => {
42                nightly_feature.hash_stable(hcx, hasher);
43            }
44            Stability::Forbidden { reason } => {
45                reason.hash_stable(hcx, hasher);
46            }
47        }
48    }
49}
50
51impl Stability {
52    /// Returns whether the feature can be used in `cfg(target_feature)` ever.
53    /// (It might still be nightly-only even if this returns `true`, so make sure to also check
54    /// `requires_nightly`.)
55    pub fn in_cfg(&self) -> bool {
56        matches!(self, Stability::Stable | Stability::Unstable { .. })
57    }
58
59    /// Returns the nightly feature that is required to toggle this target feature via
60    /// `#[target_feature]`/`-Ctarget-feature` or to test it via `cfg(target_feature)`.
61    /// (For `cfg` we only care whether the feature is nightly or not, we don't require
62    /// the feature gate to actually be enabled when using a nightly compiler.)
63    ///
64    /// Before calling this, ensure the feature is even permitted for this use:
65    /// - for `#[target_feature]`/`-Ctarget-feature`, check `allow_toggle()`
66    /// - for `cfg(target_feature)`, check `in_cfg`
67    pub fn requires_nightly(&self) -> Option<Symbol> {
68        match *self {
69            Stability::Unstable(nightly_feature) => Some(nightly_feature),
70            Stability::Stable { .. } => None,
71            Stability::Forbidden { .. } => panic!("forbidden features should not reach this far"),
72        }
73    }
74
75    /// Returns whether the feature may be toggled via `#[target_feature]` or `-Ctarget-feature`.
76    /// (It might still be nightly-only even if this returns `true`, so make sure to also check
77    /// `requires_nightly`.)
78    pub fn toggle_allowed(&self) -> Result<(), &'static str> {
79        match self {
80            Stability::Unstable(_) | Stability::Stable { .. } => Ok(()),
81            Stability::Forbidden { reason } => Err(reason),
82        }
83    }
84}
85
86// Here we list target features that rustc "understands": they can be used in `#[target_feature]`
87// and `#[cfg(target_feature)]`. They also do not trigger any warnings when used with
88// `-Ctarget-feature`.
89//
90// Note that even unstable (and even entirely unlisted) features can be used with `-Ctarget-feature`
91// on stable. Using a feature not on the list of Rust target features only emits a warning.
92// Only `cfg(target_feature)` and `#[target_feature]` actually do any stability gating.
93// `cfg(target_feature)` for unstable features just works on nightly without any feature gate.
94// `#[target_feature]` requires a feature gate.
95//
96// When adding features to the below lists
97// check whether they're named already elsewhere in rust
98// e.g. in stdarch and whether the given name matches LLVM's
99// if it doesn't, to_llvm_feature in llvm_util in rustc_codegen_llvm needs to be adapted.
100// Additionally, if the feature is not available in older version of LLVM supported by the current
101// rust, the same function must be updated to filter out these features to avoid triggering
102// warnings.
103//
104// Also note that all target features listed here must be purely additive: for target_feature 1.1 to
105// be sound, we can never allow features like `+soft-float` (on x86) to be controlled on a
106// per-function level, since we would then allow safe calls from functions with `+soft-float` to
107// functions without that feature!
108//
109// It is important for soundness to consider the interaction of targets features and the function
110// call ABI. For example, disabling the `x87` feature on x86 changes how scalar floats are passed as
111// arguments, so letting people toggle that feature would be unsound. To this end, the
112// `abi_required_features` function computes which target features must and must not be enabled for
113// any given target, and individual features can also be marked as `Forbidden`.
114// See https://github.com/rust-lang/rust/issues/116344 for some more context.
115//
116// The one exception to features that change the ABI is features that enable larger vector
117// registers. Those are permitted to be listed here. The `*_FOR_CORRECT_VECTOR_ABI` arrays store
118// information about which target feature is ABI-required for which vector size; this is used to
119// ensure that vectors can only be passed via `extern "C"` when the right feature is enabled. (For
120// the "Rust" ABI we generally pass vectors by-ref exactly to avoid these issues.)
121// Also see https://github.com/rust-lang/rust/issues/116558.
122//
123// Stabilizing a target feature requires t-lang approval.
124
125// If feature A "implies" feature B, then:
126// - when A gets enabled (via `-Ctarget-feature` or `#[target_feature]`), we also enable B
127// - when B gets disabled (via `-Ctarget-feature`), we also disable A
128//
129// Both of these are also applied transitively.
130type ImpliedFeatures = &'static [&'static str];
131
132static ARM_FEATURES: &[(&str, Stability, ImpliedFeatures)] = &[
133    // tidy-alphabetical-start
134    ("aclass", Unstable(sym::arm_target_feature), &[]),
135    ("aes", Unstable(sym::arm_target_feature), &["neon"]),
136    (
137        "atomics-32",
138        Stability::Forbidden { reason: "unsound because it changes the ABI of atomic operations" },
139        &[],
140    ),
141    ("crc", Unstable(sym::arm_target_feature), &[]),
142    ("d32", Unstable(sym::arm_target_feature), &[]),
143    ("dotprod", Unstable(sym::arm_target_feature), &["neon"]),
144    ("dsp", Unstable(sym::arm_target_feature), &[]),
145    ("fp-armv8", Unstable(sym::arm_target_feature), &["vfp4"]),
146    ("fp16", Unstable(sym::arm_target_feature), &["neon"]),
147    ("fpregs", Unstable(sym::arm_target_feature), &[]),
148    ("i8mm", Unstable(sym::arm_target_feature), &["neon"]),
149    ("mclass", Unstable(sym::arm_target_feature), &[]),
150    ("neon", Unstable(sym::arm_target_feature), &["vfp3"]),
151    ("rclass", Unstable(sym::arm_target_feature), &[]),
152    ("sha2", Unstable(sym::arm_target_feature), &["neon"]),
153    // This can be *disabled* on non-`hf` targets to enable the use
154    // of hardfloats while keeping the softfloat ABI.
155    // FIXME before stabilization: Should we expose this as a `hard-float` target feature instead of
156    // matching the odd negative feature LLVM uses?
157    ("soft-float", Unstable(sym::arm_target_feature), &[]),
158    // This is needed for inline assembly, but shouldn't be stabilized as-is
159    // since it should be enabled per-function using #[instruction_set], not
160    // #[target_feature].
161    ("thumb-mode", Unstable(sym::arm_target_feature), &[]),
162    ("thumb2", Unstable(sym::arm_target_feature), &[]),
163    ("trustzone", Unstable(sym::arm_target_feature), &[]),
164    ("v5te", Unstable(sym::arm_target_feature), &[]),
165    ("v6", Unstable(sym::arm_target_feature), &["v5te"]),
166    ("v6k", Unstable(sym::arm_target_feature), &["v6"]),
167    ("v6t2", Unstable(sym::arm_target_feature), &["v6k", "thumb2"]),
168    ("v7", Unstable(sym::arm_target_feature), &["v6t2"]),
169    ("v8", Unstable(sym::arm_target_feature), &["v7"]),
170    ("vfp2", Unstable(sym::arm_target_feature), &[]),
171    ("vfp3", Unstable(sym::arm_target_feature), &["vfp2", "d32"]),
172    ("vfp4", Unstable(sym::arm_target_feature), &["vfp3"]),
173    ("virtualization", Unstable(sym::arm_target_feature), &[]),
174    // tidy-alphabetical-end
175];
176
177static AARCH64_FEATURES: &[(&str, Stability, ImpliedFeatures)] = &[
178    // tidy-alphabetical-start
179    // FEAT_AES & FEAT_PMULL
180    ("aes", Stable, &["neon"]),
181    // FEAT_BF16
182    ("bf16", Stable, &[]),
183    // FEAT_BTI
184    ("bti", Stable, &[]),
185    // FEAT_CRC
186    ("crc", Stable, &[]),
187    // FEAT_CSSC
188    ("cssc", Unstable(sym::aarch64_unstable_target_feature), &[]),
189    // FEAT_DIT
190    ("dit", Stable, &[]),
191    // FEAT_DotProd
192    ("dotprod", Stable, &["neon"]),
193    // FEAT_DPB
194    ("dpb", Stable, &[]),
195    // FEAT_DPB2
196    ("dpb2", Stable, &["dpb"]),
197    // FEAT_ECV
198    ("ecv", Unstable(sym::aarch64_unstable_target_feature), &[]),
199    // FEAT_F32MM
200    ("f32mm", Stable, &["sve"]),
201    // FEAT_F64MM
202    ("f64mm", Stable, &["sve"]),
203    // FEAT_FAMINMAX
204    ("faminmax", Unstable(sym::aarch64_unstable_target_feature), &[]),
205    // FEAT_FCMA
206    ("fcma", Stable, &["neon"]),
207    // FEAT_FHM
208    ("fhm", Stable, &["fp16"]),
209    // FEAT_FLAGM
210    ("flagm", Stable, &[]),
211    // FEAT_FLAGM2
212    ("flagm2", Unstable(sym::aarch64_unstable_target_feature), &[]),
213    // We forbid directly toggling just `fp-armv8`; it must be toggled with `neon`.
214    ("fp-armv8", Stability::Forbidden { reason: "Rust ties `fp-armv8` to `neon`" }, &[]),
215    // FEAT_FP8
216    ("fp8", Unstable(sym::aarch64_unstable_target_feature), &["faminmax", "lut", "bf16"]),
217    // FEAT_FP8DOT2
218    ("fp8dot2", Unstable(sym::aarch64_unstable_target_feature), &["fp8dot4"]),
219    // FEAT_FP8DOT4
220    ("fp8dot4", Unstable(sym::aarch64_unstable_target_feature), &["fp8fma"]),
221    // FEAT_FP8FMA
222    ("fp8fma", Unstable(sym::aarch64_unstable_target_feature), &["fp8"]),
223    // FEAT_FP16
224    // Rust ties FP and Neon: https://github.com/rust-lang/rust/pull/91608
225    ("fp16", Stable, &["neon"]),
226    // FEAT_FRINTTS
227    ("frintts", Stable, &[]),
228    // FEAT_HBC
229    ("hbc", Unstable(sym::aarch64_unstable_target_feature), &[]),
230    // FEAT_I8MM
231    ("i8mm", Stable, &[]),
232    // FEAT_JSCVT
233    // Rust ties FP and Neon: https://github.com/rust-lang/rust/pull/91608
234    ("jsconv", Stable, &["neon"]),
235    // FEAT_LOR
236    ("lor", Stable, &[]),
237    // FEAT_LSE
238    ("lse", Stable, &[]),
239    // FEAT_LSE2
240    ("lse2", Unstable(sym::aarch64_unstable_target_feature), &[]),
241    // FEAT_LSE128
242    ("lse128", Unstable(sym::aarch64_unstable_target_feature), &["lse"]),
243    // FEAT_LUT
244    ("lut", Unstable(sym::aarch64_unstable_target_feature), &[]),
245    // FEAT_MOPS
246    ("mops", Unstable(sym::aarch64_unstable_target_feature), &[]),
247    // FEAT_MTE & FEAT_MTE2
248    ("mte", Stable, &[]),
249    // FEAT_AdvSimd & FEAT_FP
250    ("neon", Stable, &[]),
251    // Backend option to turn atomic operations into an intrinsic call when `lse` is not known to be
252    // available, so the intrinsic can do runtime LSE feature detection rather than unconditionally
253    // using slower non-LSE operations. Unstable since it doesn't need to user-togglable.
254    ("outline-atomics", Unstable(sym::aarch64_unstable_target_feature), &[]),
255    // FEAT_PAUTH (address authentication)
256    ("paca", Stable, &[]),
257    // FEAT_PAUTH (generic authentication)
258    ("pacg", Stable, &[]),
259    // FEAT_PAN
260    ("pan", Stable, &[]),
261    // FEAT_PAuth_LR
262    ("pauth-lr", Unstable(sym::aarch64_unstable_target_feature), &[]),
263    // FEAT_PMUv3
264    ("pmuv3", Stable, &[]),
265    // FEAT_RNG
266    ("rand", Stable, &[]),
267    // FEAT_RAS & FEAT_RASv1p1
268    ("ras", Stable, &[]),
269    // FEAT_LRCPC
270    ("rcpc", Stable, &[]),
271    // FEAT_LRCPC2
272    ("rcpc2", Stable, &["rcpc"]),
273    // FEAT_LRCPC3
274    ("rcpc3", Unstable(sym::aarch64_unstable_target_feature), &["rcpc2"]),
275    // FEAT_RDM
276    ("rdm", Stable, &["neon"]),
277    ("reserve-x18", Forbidden { reason: "use `-Zfixed-x18` compiler flag instead" }, &[]),
278    // FEAT_SB
279    ("sb", Stable, &[]),
280    // FEAT_SHA1 & FEAT_SHA256
281    ("sha2", Stable, &["neon"]),
282    // FEAT_SHA512 & FEAT_SHA3
283    ("sha3", Stable, &["sha2"]),
284    // FEAT_SM3 & FEAT_SM4
285    ("sm4", Stable, &["neon"]),
286    // FEAT_SME
287    ("sme", Unstable(sym::aarch64_unstable_target_feature), &["bf16"]),
288    // FEAT_SME_B16B16
289    ("sme-b16b16", Unstable(sym::aarch64_unstable_target_feature), &["bf16", "sme2", "sve-b16b16"]),
290    // FEAT_SME_F8F16
291    ("sme-f8f16", Unstable(sym::aarch64_unstable_target_feature), &["sme-f8f32"]),
292    // FEAT_SME_F8F32
293    ("sme-f8f32", Unstable(sym::aarch64_unstable_target_feature), &["sme2", "fp8"]),
294    // FEAT_SME_F16F16
295    ("sme-f16f16", Unstable(sym::aarch64_unstable_target_feature), &["sme2"]),
296    // FEAT_SME_F64F64
297    ("sme-f64f64", Unstable(sym::aarch64_unstable_target_feature), &["sme"]),
298    // FEAT_SME_FA64
299    ("sme-fa64", Unstable(sym::aarch64_unstable_target_feature), &["sme", "sve2"]),
300    // FEAT_SME_I16I64
301    ("sme-i16i64", Unstable(sym::aarch64_unstable_target_feature), &["sme"]),
302    // FEAT_SME_LUTv2
303    ("sme-lutv2", Unstable(sym::aarch64_unstable_target_feature), &[]),
304    // FEAT_SME2
305    ("sme2", Unstable(sym::aarch64_unstable_target_feature), &["sme"]),
306    // FEAT_SME2p1
307    ("sme2p1", Unstable(sym::aarch64_unstable_target_feature), &["sme2"]),
308    // FEAT_SPE
309    ("spe", Stable, &[]),
310    // FEAT_SSBS & FEAT_SSBS2
311    ("ssbs", Stable, &[]),
312    // FEAT_SSVE_FP8FDOT2
313    ("ssve-fp8dot2", Unstable(sym::aarch64_unstable_target_feature), &["ssve-fp8dot4"]),
314    // FEAT_SSVE_FP8FDOT4
315    ("ssve-fp8dot4", Unstable(sym::aarch64_unstable_target_feature), &["ssve-fp8fma"]),
316    // FEAT_SSVE_FP8FMA
317    ("ssve-fp8fma", Unstable(sym::aarch64_unstable_target_feature), &["sme2", "fp8"]),
318    // FEAT_SVE
319    // It was decided that SVE requires Neon: https://github.com/rust-lang/rust/pull/91608
320    //
321    // LLVM doesn't enable Neon for SVE. ARM indicates that they're separate, but probably always
322    // exist together: https://developer.arm.com/documentation/102340/0100/New-features-in-SVE2
323    //
324    // "For backwards compatibility, Neon and VFP are required in the latest architectures."
325    ("sve", Stable, &["neon"]),
326    // FEAT_SVE_B16B16 (SVE or SME Z-targeting instructions)
327    ("sve-b16b16", Unstable(sym::aarch64_unstable_target_feature), &["bf16"]),
328    // FEAT_SVE2
329    ("sve2", Stable, &["sve"]),
330    // FEAT_SVE_AES & FEAT_SVE_PMULL128
331    ("sve2-aes", Stable, &["sve2", "aes"]),
332    // FEAT_SVE2_BitPerm
333    ("sve2-bitperm", Stable, &["sve2"]),
334    // FEAT_SVE2_SHA3
335    ("sve2-sha3", Stable, &["sve2", "sha3"]),
336    // FEAT_SVE2_SM4
337    ("sve2-sm4", Stable, &["sve2", "sm4"]),
338    // FEAT_SVE2p1
339    ("sve2p1", Unstable(sym::aarch64_unstable_target_feature), &["sve2"]),
340    // FEAT_TME
341    ("tme", Stable, &[]),
342    (
343        "v8.1a",
344        Unstable(sym::aarch64_ver_target_feature),
345        &["crc", "lse", "rdm", "pan", "lor", "vh"],
346    ),
347    ("v8.2a", Unstable(sym::aarch64_ver_target_feature), &["v8.1a", "ras", "dpb"]),
348    (
349        "v8.3a",
350        Unstable(sym::aarch64_ver_target_feature),
351        &["v8.2a", "rcpc", "paca", "pacg", "jsconv"],
352    ),
353    ("v8.4a", Unstable(sym::aarch64_ver_target_feature), &["v8.3a", "dotprod", "dit", "flagm"]),
354    ("v8.5a", Unstable(sym::aarch64_ver_target_feature), &["v8.4a", "ssbs", "sb", "dpb2", "bti"]),
355    ("v8.6a", Unstable(sym::aarch64_ver_target_feature), &["v8.5a", "bf16", "i8mm"]),
356    ("v8.7a", Unstable(sym::aarch64_ver_target_feature), &["v8.6a", "wfxt"]),
357    ("v8.8a", Unstable(sym::aarch64_ver_target_feature), &["v8.7a", "hbc", "mops"]),
358    ("v8.9a", Unstable(sym::aarch64_ver_target_feature), &["v8.8a", "cssc"]),
359    ("v9.1a", Unstable(sym::aarch64_ver_target_feature), &["v9a", "v8.6a"]),
360    ("v9.2a", Unstable(sym::aarch64_ver_target_feature), &["v9.1a", "v8.7a"]),
361    ("v9.3a", Unstable(sym::aarch64_ver_target_feature), &["v9.2a", "v8.8a"]),
362    ("v9.4a", Unstable(sym::aarch64_ver_target_feature), &["v9.3a", "v8.9a"]),
363    ("v9.5a", Unstable(sym::aarch64_ver_target_feature), &["v9.4a"]),
364    ("v9a", Unstable(sym::aarch64_ver_target_feature), &["v8.5a", "sve2"]),
365    // FEAT_VHE
366    ("vh", Stable, &[]),
367    // FEAT_WFxT
368    ("wfxt", Unstable(sym::aarch64_unstable_target_feature), &[]),
369    // tidy-alphabetical-end
370];
371
372const AARCH64_TIED_FEATURES: &[&[&str]] = &[
373    &["paca", "pacg"], // Together these represent `pauth` in LLVM
374];
375
376static X86_FEATURES: &[(&str, Stability, ImpliedFeatures)] = &[
377    // tidy-alphabetical-start
378    ("adx", Stable, &[]),
379    ("aes", Stable, &["sse2"]),
380    ("amx-avx512", Unstable(sym::x86_amx_intrinsics), &["amx-tile"]),
381    ("amx-bf16", Unstable(sym::x86_amx_intrinsics), &["amx-tile"]),
382    ("amx-complex", Unstable(sym::x86_amx_intrinsics), &["amx-tile"]),
383    ("amx-fp8", Unstable(sym::x86_amx_intrinsics), &["amx-tile"]),
384    ("amx-fp16", Unstable(sym::x86_amx_intrinsics), &["amx-tile"]),
385    ("amx-int8", Unstable(sym::x86_amx_intrinsics), &["amx-tile"]),
386    ("amx-movrs", Unstable(sym::x86_amx_intrinsics), &["amx-tile"]),
387    ("amx-tf32", Unstable(sym::x86_amx_intrinsics), &["amx-tile"]),
388    ("amx-tile", Unstable(sym::x86_amx_intrinsics), &[]),
389    ("amx-transpose", Unstable(sym::x86_amx_intrinsics), &["amx-tile"]),
390    ("apxf", Unstable(sym::apx_target_feature), &[]),
391    ("avx", Stable, &["sse4.2"]),
392    ("avx2", Stable, &["avx"]),
393    (
394        "avx10.1",
395        Unstable(sym::avx10_target_feature),
396        &[
397            "avx512bf16",
398            "avx512bitalg",
399            "avx512bw",
400            "avx512cd",
401            "avx512dq",
402            "avx512f",
403            "avx512fp16",
404            "avx512ifma",
405            "avx512vbmi",
406            "avx512vbmi2",
407            "avx512vl",
408            "avx512vnni",
409            "avx512vpopcntdq",
410        ],
411    ),
412    ("avx10.2", Unstable(sym::avx10_target_feature), &["avx10.1"]),
413    ("avx512bf16", Stable, &["avx512bw"]),
414    ("avx512bitalg", Stable, &["avx512bw"]),
415    ("avx512bw", Stable, &["avx512f"]),
416    ("avx512cd", Stable, &["avx512f"]),
417    ("avx512dq", Stable, &["avx512f"]),
418    ("avx512f", Stable, &["avx2", "fma", "f16c"]),
419    ("avx512fp16", Stable, &["avx512bw"]),
420    ("avx512ifma", Stable, &["avx512f"]),
421    ("avx512vbmi", Stable, &["avx512bw"]),
422    ("avx512vbmi2", Stable, &["avx512bw"]),
423    ("avx512vl", Stable, &["avx512f"]),
424    ("avx512vnni", Stable, &["avx512f"]),
425    ("avx512vp2intersect", Stable, &["avx512f"]),
426    ("avx512vpopcntdq", Stable, &["avx512f"]),
427    ("avxifma", Stable, &["avx2"]),
428    ("avxneconvert", Stable, &["avx2"]),
429    ("avxvnni", Stable, &["avx2"]),
430    ("avxvnniint8", Stable, &["avx2"]),
431    ("avxvnniint16", Stable, &["avx2"]),
432    ("bmi1", Stable, &[]),
433    ("bmi2", Stable, &[]),
434    ("cmpxchg16b", Stable, &[]),
435    ("ermsb", Unstable(sym::ermsb_target_feature), &[]),
436    ("f16c", Stable, &["avx"]),
437    ("fma", Stable, &["avx"]),
438    ("fxsr", Stable, &[]),
439    ("gfni", Stable, &["sse2"]),
440    ("kl", Stable, &["sse2"]),
441    ("lahfsahf", Unstable(sym::lahfsahf_target_feature), &[]),
442    ("lzcnt", Stable, &[]),
443    ("movbe", Stable, &[]),
444    ("movrs", Unstable(sym::movrs_target_feature), &[]),
445    ("pclmulqdq", Stable, &["sse2"]),
446    ("popcnt", Stable, &[]),
447    ("prfchw", Unstable(sym::prfchw_target_feature), &[]),
448    ("rdrand", Stable, &[]),
449    ("rdseed", Stable, &[]),
450    (
451        "retpoline-external-thunk",
452        Stability::Forbidden { reason: "use `-Zretpoline-external-thunk` compiler flag instead" },
453        &[],
454    ),
455    (
456        "retpoline-indirect-branches",
457        Stability::Forbidden { reason: "use `-Zretpoline` compiler flag instead" },
458        &[],
459    ),
460    (
461        "retpoline-indirect-calls",
462        Stability::Forbidden { reason: "use `-Zretpoline` compiler flag instead" },
463        &[],
464    ),
465    ("rtm", Unstable(sym::rtm_target_feature), &[]),
466    ("sha", Stable, &["sse2"]),
467    ("sha512", Stable, &["avx2"]),
468    ("sm3", Stable, &["avx"]),
469    ("sm4", Stable, &["avx2"]),
470    // This cannot actually be toggled, the ABI always fixes it, so it'd make little sense to
471    // stabilize. It must be in this list for the ABI check to be able to use it.
472    ("soft-float", Stability::Unstable(sym::x87_target_feature), &[]),
473    ("sse", Stable, &[]),
474    ("sse2", Stable, &["sse"]),
475    ("sse3", Stable, &["sse2"]),
476    ("sse4.1", Stable, &["ssse3"]),
477    ("sse4.2", Stable, &["sse4.1"]),
478    ("sse4a", Stable, &["sse3"]),
479    ("ssse3", Stable, &["sse3"]),
480    ("tbm", Stable, &[]),
481    ("vaes", Stable, &["avx2", "aes"]),
482    ("vpclmulqdq", Stable, &["avx", "pclmulqdq"]),
483    ("widekl", Stable, &["kl"]),
484    ("x87", Unstable(sym::x87_target_feature), &[]),
485    ("xop", Unstable(sym::xop_target_feature), &[/*"fma4", */ "avx", "sse4a"]),
486    ("xsave", Stable, &[]),
487    ("xsavec", Stable, &["xsave"]),
488    ("xsaveopt", Stable, &["xsave"]),
489    ("xsaves", Stable, &["xsave"]),
490    // tidy-alphabetical-end
491];
492
493const HEXAGON_FEATURES: &[(&str, Stability, ImpliedFeatures)] = &[
494    // tidy-alphabetical-start
495    ("hvx", Unstable(sym::hexagon_target_feature), &[]),
496    ("hvx-length128b", Unstable(sym::hexagon_target_feature), &["hvx"]),
497    // tidy-alphabetical-end
498];
499
500static POWERPC_FEATURES: &[(&str, Stability, ImpliedFeatures)] = &[
501    // tidy-alphabetical-start
502    ("altivec", Unstable(sym::powerpc_target_feature), &[]),
503    ("msync", Unstable(sym::powerpc_target_feature), &[]),
504    ("partword-atomics", Unstable(sym::powerpc_target_feature), &[]),
505    ("power8-altivec", Unstable(sym::powerpc_target_feature), &["altivec"]),
506    ("power8-crypto", Unstable(sym::powerpc_target_feature), &["power8-altivec"]),
507    ("power8-vector", Unstable(sym::powerpc_target_feature), &["vsx", "power8-altivec"]),
508    ("power9-altivec", Unstable(sym::powerpc_target_feature), &["power8-altivec"]),
509    ("power9-vector", Unstable(sym::powerpc_target_feature), &["power8-vector", "power9-altivec"]),
510    ("power10-vector", Unstable(sym::powerpc_target_feature), &["power9-vector"]),
511    ("quadword-atomics", Unstable(sym::powerpc_target_feature), &[]),
512    ("vsx", Unstable(sym::powerpc_target_feature), &["altivec"]),
513    // tidy-alphabetical-end
514];
515
516const MIPS_FEATURES: &[(&str, Stability, ImpliedFeatures)] = &[
517    // tidy-alphabetical-start
518    ("fp64", Unstable(sym::mips_target_feature), &[]),
519    ("msa", Unstable(sym::mips_target_feature), &[]),
520    ("virt", Unstable(sym::mips_target_feature), &[]),
521    // tidy-alphabetical-end
522];
523
524const NVPTX_FEATURES: &[(&str, Stability, ImpliedFeatures)] = &[
525    // tidy-alphabetical-start
526    ("sm_20", Unstable(sym::nvptx_target_feature), &[]),
527    ("sm_21", Unstable(sym::nvptx_target_feature), &["sm_20"]),
528    ("sm_30", Unstable(sym::nvptx_target_feature), &["sm_21"]),
529    ("sm_32", Unstable(sym::nvptx_target_feature), &["sm_30"]),
530    ("sm_35", Unstable(sym::nvptx_target_feature), &["sm_32"]),
531    ("sm_37", Unstable(sym::nvptx_target_feature), &["sm_35"]),
532    ("sm_50", Unstable(sym::nvptx_target_feature), &["sm_37"]),
533    ("sm_52", Unstable(sym::nvptx_target_feature), &["sm_50"]),
534    ("sm_53", Unstable(sym::nvptx_target_feature), &["sm_52"]),
535    ("sm_60", Unstable(sym::nvptx_target_feature), &["sm_53"]),
536    ("sm_61", Unstable(sym::nvptx_target_feature), &["sm_60"]),
537    ("sm_62", Unstable(sym::nvptx_target_feature), &["sm_61"]),
538    ("sm_70", Unstable(sym::nvptx_target_feature), &["sm_62"]),
539    ("sm_72", Unstable(sym::nvptx_target_feature), &["sm_70"]),
540    ("sm_75", Unstable(sym::nvptx_target_feature), &["sm_72"]),
541    ("sm_80", Unstable(sym::nvptx_target_feature), &["sm_75"]),
542    ("sm_86", Unstable(sym::nvptx_target_feature), &["sm_80"]),
543    ("sm_87", Unstable(sym::nvptx_target_feature), &["sm_86"]),
544    ("sm_89", Unstable(sym::nvptx_target_feature), &["sm_87"]),
545    ("sm_90", Unstable(sym::nvptx_target_feature), &["sm_89"]),
546    ("sm_90a", Unstable(sym::nvptx_target_feature), &["sm_90"]),
547    // tidy-alphabetical-end
548    // tidy-alphabetical-start
549    ("sm_100", Unstable(sym::nvptx_target_feature), &["sm_90"]),
550    ("sm_100a", Unstable(sym::nvptx_target_feature), &["sm_100"]),
551    ("sm_101", Unstable(sym::nvptx_target_feature), &["sm_100"]),
552    ("sm_101a", Unstable(sym::nvptx_target_feature), &["sm_101"]),
553    ("sm_120", Unstable(sym::nvptx_target_feature), &["sm_101"]),
554    ("sm_120a", Unstable(sym::nvptx_target_feature), &["sm_120"]),
555    // tidy-alphabetical-end
556    // tidy-alphabetical-start
557    ("ptx32", Unstable(sym::nvptx_target_feature), &[]),
558    ("ptx40", Unstable(sym::nvptx_target_feature), &["ptx32"]),
559    ("ptx41", Unstable(sym::nvptx_target_feature), &["ptx40"]),
560    ("ptx42", Unstable(sym::nvptx_target_feature), &["ptx41"]),
561    ("ptx43", Unstable(sym::nvptx_target_feature), &["ptx42"]),
562    ("ptx50", Unstable(sym::nvptx_target_feature), &["ptx43"]),
563    ("ptx60", Unstable(sym::nvptx_target_feature), &["ptx50"]),
564    ("ptx61", Unstable(sym::nvptx_target_feature), &["ptx60"]),
565    ("ptx62", Unstable(sym::nvptx_target_feature), &["ptx61"]),
566    ("ptx63", Unstable(sym::nvptx_target_feature), &["ptx62"]),
567    ("ptx64", Unstable(sym::nvptx_target_feature), &["ptx63"]),
568    ("ptx65", Unstable(sym::nvptx_target_feature), &["ptx64"]),
569    ("ptx70", Unstable(sym::nvptx_target_feature), &["ptx65"]),
570    ("ptx71", Unstable(sym::nvptx_target_feature), &["ptx70"]),
571    ("ptx72", Unstable(sym::nvptx_target_feature), &["ptx71"]),
572    ("ptx73", Unstable(sym::nvptx_target_feature), &["ptx72"]),
573    ("ptx74", Unstable(sym::nvptx_target_feature), &["ptx73"]),
574    ("ptx75", Unstable(sym::nvptx_target_feature), &["ptx74"]),
575    ("ptx76", Unstable(sym::nvptx_target_feature), &["ptx75"]),
576    ("ptx77", Unstable(sym::nvptx_target_feature), &["ptx76"]),
577    ("ptx78", Unstable(sym::nvptx_target_feature), &["ptx77"]),
578    ("ptx80", Unstable(sym::nvptx_target_feature), &["ptx78"]),
579    ("ptx81", Unstable(sym::nvptx_target_feature), &["ptx80"]),
580    ("ptx82", Unstable(sym::nvptx_target_feature), &["ptx81"]),
581    ("ptx83", Unstable(sym::nvptx_target_feature), &["ptx82"]),
582    ("ptx84", Unstable(sym::nvptx_target_feature), &["ptx83"]),
583    ("ptx85", Unstable(sym::nvptx_target_feature), &["ptx84"]),
584    ("ptx86", Unstable(sym::nvptx_target_feature), &["ptx85"]),
585    ("ptx87", Unstable(sym::nvptx_target_feature), &["ptx86"]),
586    // tidy-alphabetical-end
587];
588
589static RISCV_FEATURES: &[(&str, Stability, ImpliedFeatures)] = &[
590    // tidy-alphabetical-start
591    ("a", Stable, &["zaamo", "zalrsc"]),
592    ("b", Unstable(sym::riscv_target_feature), &["zba", "zbb", "zbs"]),
593    ("c", Stable, &["zca"]),
594    ("d", Unstable(sym::riscv_target_feature), &["f"]),
595    ("e", Unstable(sym::riscv_target_feature), &[]),
596    ("f", Unstable(sym::riscv_target_feature), &["zicsr"]),
597    (
598        "forced-atomics",
599        Stability::Forbidden { reason: "unsound because it changes the ABI of atomic operations" },
600        &[],
601    ),
602    ("m", Stable, &[]),
603    ("relax", Unstable(sym::riscv_target_feature), &[]),
604    ("unaligned-scalar-mem", Unstable(sym::riscv_target_feature), &[]),
605    ("unaligned-vector-mem", Unstable(sym::riscv_target_feature), &[]),
606    ("v", Unstable(sym::riscv_target_feature), &["zvl128b", "zve64d"]),
607    ("za64rs", Unstable(sym::riscv_target_feature), &["za128rs"]), // Za64rs ⊃ Za128rs
608    ("za128rs", Unstable(sym::riscv_target_feature), &[]),
609    ("zaamo", Unstable(sym::riscv_target_feature), &[]),
610    ("zabha", Unstable(sym::riscv_target_feature), &["zaamo"]),
611    ("zacas", Unstable(sym::riscv_target_feature), &["zaamo"]),
612    ("zalrsc", Unstable(sym::riscv_target_feature), &[]),
613    ("zama16b", Unstable(sym::riscv_target_feature), &[]),
614    ("zawrs", Unstable(sym::riscv_target_feature), &[]),
615    ("zba", Stable, &[]),
616    ("zbb", Stable, &[]),
617    ("zbc", Stable, &["zbkc"]), // Zbc ⊃ Zbkc
618    ("zbkb", Stable, &[]),
619    ("zbkc", Stable, &[]),
620    ("zbkx", Stable, &[]),
621    ("zbs", Stable, &[]),
622    ("zca", Unstable(sym::riscv_target_feature), &[]),
623    ("zcb", Unstable(sym::riscv_target_feature), &["zca"]),
624    ("zcmop", Unstable(sym::riscv_target_feature), &["zca"]),
625    ("zdinx", Unstable(sym::riscv_target_feature), &["zfinx"]),
626    ("zfa", Unstable(sym::riscv_target_feature), &["f"]),
627    ("zfbfmin", Unstable(sym::riscv_target_feature), &["f"]), // and a subset of Zfhmin
628    ("zfh", Unstable(sym::riscv_target_feature), &["zfhmin"]),
629    ("zfhmin", Unstable(sym::riscv_target_feature), &["f"]),
630    ("zfinx", Unstable(sym::riscv_target_feature), &["zicsr"]),
631    ("zhinx", Unstable(sym::riscv_target_feature), &["zhinxmin"]),
632    ("zhinxmin", Unstable(sym::riscv_target_feature), &["zfinx"]),
633    ("zic64b", Unstable(sym::riscv_target_feature), &[]),
634    ("zicbom", Unstable(sym::riscv_target_feature), &[]),
635    ("zicbop", Unstable(sym::riscv_target_feature), &[]),
636    ("zicboz", Unstable(sym::riscv_target_feature), &[]),
637    ("ziccamoa", Unstable(sym::riscv_target_feature), &[]),
638    ("ziccif", Unstable(sym::riscv_target_feature), &[]),
639    ("zicclsm", Unstable(sym::riscv_target_feature), &[]),
640    ("ziccrse", Unstable(sym::riscv_target_feature), &[]),
641    ("zicntr", Unstable(sym::riscv_target_feature), &["zicsr"]),
642    ("zicond", Unstable(sym::riscv_target_feature), &[]),
643    ("zicsr", Unstable(sym::riscv_target_feature), &[]),
644    ("zifencei", Unstable(sym::riscv_target_feature), &[]),
645    ("zihintntl", Unstable(sym::riscv_target_feature), &[]),
646    ("zihintpause", Unstable(sym::riscv_target_feature), &[]),
647    ("zihpm", Unstable(sym::riscv_target_feature), &["zicsr"]),
648    ("zimop", Unstable(sym::riscv_target_feature), &[]),
649    ("zk", Stable, &["zkn", "zkr", "zkt"]),
650    ("zkn", Stable, &["zbkb", "zbkc", "zbkx", "zkne", "zknd", "zknh"]),
651    ("zknd", Stable, &[]),
652    ("zkne", Stable, &[]),
653    ("zknh", Stable, &[]),
654    ("zkr", Stable, &[]),
655    ("zks", Stable, &["zbkb", "zbkc", "zbkx", "zksed", "zksh"]),
656    ("zksed", Stable, &[]),
657    ("zksh", Stable, &[]),
658    ("zkt", Stable, &[]),
659    ("ztso", Unstable(sym::riscv_target_feature), &[]),
660    ("zvbb", Unstable(sym::riscv_target_feature), &["zvkb"]), // Zvbb ⊃ Zvkb
661    ("zvbc", Unstable(sym::riscv_target_feature), &["zve64x"]),
662    ("zve32f", Unstable(sym::riscv_target_feature), &["zve32x", "f"]),
663    ("zve32x", Unstable(sym::riscv_target_feature), &["zvl32b", "zicsr"]),
664    ("zve64d", Unstable(sym::riscv_target_feature), &["zve64f", "d"]),
665    ("zve64f", Unstable(sym::riscv_target_feature), &["zve32f", "zve64x"]),
666    ("zve64x", Unstable(sym::riscv_target_feature), &["zve32x", "zvl64b"]),
667    ("zvfbfmin", Unstable(sym::riscv_target_feature), &["zve32f"]),
668    ("zvfbfwma", Unstable(sym::riscv_target_feature), &["zfbfmin", "zvfbfmin"]),
669    ("zvfh", Unstable(sym::riscv_target_feature), &["zvfhmin", "zve32f", "zfhmin"]), // Zvfh ⊃ Zvfhmin
670    ("zvfhmin", Unstable(sym::riscv_target_feature), &["zve32f"]),
671    ("zvkb", Unstable(sym::riscv_target_feature), &["zve32x"]),
672    ("zvkg", Unstable(sym::riscv_target_feature), &["zve32x"]),
673    ("zvkn", Unstable(sym::riscv_target_feature), &["zvkned", "zvknhb", "zvkb", "zvkt"]),
674    ("zvknc", Unstable(sym::riscv_target_feature), &["zvkn", "zvbc"]),
675    ("zvkned", Unstable(sym::riscv_target_feature), &["zve32x"]),
676    ("zvkng", Unstable(sym::riscv_target_feature), &["zvkn", "zvkg"]),
677    ("zvknha", Unstable(sym::riscv_target_feature), &["zve32x"]),
678    ("zvknhb", Unstable(sym::riscv_target_feature), &["zvknha", "zve64x"]), // Zvknhb ⊃ Zvknha
679    ("zvks", Unstable(sym::riscv_target_feature), &["zvksed", "zvksh", "zvkb", "zvkt"]),
680    ("zvksc", Unstable(sym::riscv_target_feature), &["zvks", "zvbc"]),
681    ("zvksed", Unstable(sym::riscv_target_feature), &["zve32x"]),
682    ("zvksg", Unstable(sym::riscv_target_feature), &["zvks", "zvkg"]),
683    ("zvksh", Unstable(sym::riscv_target_feature), &["zve32x"]),
684    ("zvkt", Unstable(sym::riscv_target_feature), &[]),
685    ("zvl32b", Unstable(sym::riscv_target_feature), &[]),
686    ("zvl64b", Unstable(sym::riscv_target_feature), &["zvl32b"]),
687    ("zvl128b", Unstable(sym::riscv_target_feature), &["zvl64b"]),
688    ("zvl256b", Unstable(sym::riscv_target_feature), &["zvl128b"]),
689    ("zvl512b", Unstable(sym::riscv_target_feature), &["zvl256b"]),
690    ("zvl1024b", Unstable(sym::riscv_target_feature), &["zvl512b"]),
691    ("zvl2048b", Unstable(sym::riscv_target_feature), &["zvl1024b"]),
692    ("zvl4096b", Unstable(sym::riscv_target_feature), &["zvl2048b"]),
693    ("zvl8192b", Unstable(sym::riscv_target_feature), &["zvl4096b"]),
694    ("zvl16384b", Unstable(sym::riscv_target_feature), &["zvl8192b"]),
695    ("zvl32768b", Unstable(sym::riscv_target_feature), &["zvl16384b"]),
696    ("zvl65536b", Unstable(sym::riscv_target_feature), &["zvl32768b"]),
697    // tidy-alphabetical-end
698];
699
700static WASM_FEATURES: &[(&str, Stability, ImpliedFeatures)] = &[
701    // tidy-alphabetical-start
702    ("atomics", Unstable(sym::wasm_target_feature), &[]),
703    ("bulk-memory", Stable, &[]),
704    ("exception-handling", Unstable(sym::wasm_target_feature), &[]),
705    ("extended-const", Stable, &[]),
706    ("multivalue", Stable, &[]),
707    ("mutable-globals", Stable, &[]),
708    ("nontrapping-fptoint", Stable, &[]),
709    ("reference-types", Stable, &[]),
710    ("relaxed-simd", Stable, &["simd128"]),
711    ("sign-ext", Stable, &[]),
712    ("simd128", Stable, &[]),
713    ("tail-call", Stable, &[]),
714    ("wide-arithmetic", Unstable(sym::wasm_target_feature), &[]),
715    // tidy-alphabetical-end
716];
717
718const BPF_FEATURES: &[(&str, Stability, ImpliedFeatures)] =
719    &[("alu32", Unstable(sym::bpf_target_feature), &[])];
720
721static CSKY_FEATURES: &[(&str, Stability, ImpliedFeatures)] = &[
722    // tidy-alphabetical-start
723    ("2e3", Unstable(sym::csky_target_feature), &["e2"]),
724    ("3e3r1", Unstable(sym::csky_target_feature), &[]),
725    ("3e3r2", Unstable(sym::csky_target_feature), &["3e3r1", "doloop"]),
726    ("3e3r3", Unstable(sym::csky_target_feature), &["doloop"]),
727    ("3e7", Unstable(sym::csky_target_feature), &["2e3"]),
728    ("7e10", Unstable(sym::csky_target_feature), &["3e7"]),
729    ("10e60", Unstable(sym::csky_target_feature), &["7e10"]),
730    ("cache", Unstable(sym::csky_target_feature), &[]),
731    ("doloop", Unstable(sym::csky_target_feature), &[]),
732    ("dsp1e2", Unstable(sym::csky_target_feature), &[]),
733    ("dspe60", Unstable(sym::csky_target_feature), &[]),
734    ("e1", Unstable(sym::csky_target_feature), &["elrw"]),
735    ("e2", Unstable(sym::csky_target_feature), &["e2"]),
736    ("edsp", Unstable(sym::csky_target_feature), &[]),
737    ("elrw", Unstable(sym::csky_target_feature), &[]),
738    ("float1e2", Unstable(sym::csky_target_feature), &[]),
739    ("float1e3", Unstable(sym::csky_target_feature), &[]),
740    ("float3e4", Unstable(sym::csky_target_feature), &[]),
741    ("float7e60", Unstable(sym::csky_target_feature), &[]),
742    ("floate1", Unstable(sym::csky_target_feature), &[]),
743    ("hard-tp", Unstable(sym::csky_target_feature), &[]),
744    ("high-registers", Unstable(sym::csky_target_feature), &[]),
745    ("hwdiv", Unstable(sym::csky_target_feature), &[]),
746    ("mp", Unstable(sym::csky_target_feature), &["2e3"]),
747    ("mp1e2", Unstable(sym::csky_target_feature), &["3e7"]),
748    ("nvic", Unstable(sym::csky_target_feature), &[]),
749    ("trust", Unstable(sym::csky_target_feature), &[]),
750    ("vdsp2e60f", Unstable(sym::csky_target_feature), &[]),
751    ("vdspv1", Unstable(sym::csky_target_feature), &[]),
752    ("vdspv2", Unstable(sym::csky_target_feature), &[]),
753    // tidy-alphabetical-end
754    //fpu
755    // tidy-alphabetical-start
756    ("fdivdu", Unstable(sym::csky_target_feature), &[]),
757    ("fpuv2_df", Unstable(sym::csky_target_feature), &[]),
758    ("fpuv2_sf", Unstable(sym::csky_target_feature), &[]),
759    ("fpuv3_df", Unstable(sym::csky_target_feature), &[]),
760    ("fpuv3_hf", Unstable(sym::csky_target_feature), &[]),
761    ("fpuv3_hi", Unstable(sym::csky_target_feature), &[]),
762    ("fpuv3_sf", Unstable(sym::csky_target_feature), &[]),
763    ("hard-float", Unstable(sym::csky_target_feature), &[]),
764    ("hard-float-abi", Unstable(sym::csky_target_feature), &[]),
765    // tidy-alphabetical-end
766];
767
768static LOONGARCH_FEATURES: &[(&str, Stability, ImpliedFeatures)] = &[
769    // tidy-alphabetical-start
770    ("32s", Unstable(sym::loongarch_target_feature), &[]),
771    ("d", Stable, &["f"]),
772    ("div32", Unstable(sym::loongarch_target_feature), &[]),
773    ("f", Stable, &[]),
774    ("frecipe", Stable, &[]),
775    ("lam-bh", Unstable(sym::loongarch_target_feature), &[]),
776    ("lamcas", Unstable(sym::loongarch_target_feature), &[]),
777    ("lasx", Stable, &["lsx"]),
778    ("lbt", Stable, &[]),
779    ("ld-seq-sa", Unstable(sym::loongarch_target_feature), &[]),
780    ("lsx", Stable, &["d"]),
781    ("lvz", Stable, &[]),
782    ("relax", Unstable(sym::loongarch_target_feature), &[]),
783    ("scq", Unstable(sym::loongarch_target_feature), &[]),
784    ("ual", Unstable(sym::loongarch_target_feature), &[]),
785    // tidy-alphabetical-end
786];
787
788#[rustfmt::skip]
789const IBMZ_FEATURES: &[(&str, Stability, ImpliedFeatures)] = &[
790    // tidy-alphabetical-start
791    // For "backchain", https://github.com/rust-lang/rust/issues/142412 is a stabilization blocker
792    ("backchain", Unstable(sym::s390x_target_feature), &[]),
793    ("concurrent-functions", Unstable(sym::s390x_target_feature), &[]),
794    ("deflate-conversion", Unstable(sym::s390x_target_feature), &[]),
795    ("enhanced-sort", Unstable(sym::s390x_target_feature), &[]),
796    ("guarded-storage", Unstable(sym::s390x_target_feature), &[]),
797    ("high-word", Unstable(sym::s390x_target_feature), &[]),
798    // LLVM does not define message-security-assist-extension versions 1, 2, 6, 10 and 11.
799    ("message-security-assist-extension3", Unstable(sym::s390x_target_feature), &[]),
800    ("message-security-assist-extension4", Unstable(sym::s390x_target_feature), &[]),
801    ("message-security-assist-extension5", Unstable(sym::s390x_target_feature), &[]),
802    ("message-security-assist-extension8", Unstable(sym::s390x_target_feature), &["message-security-assist-extension3"]),
803    ("message-security-assist-extension9", Unstable(sym::s390x_target_feature), &["message-security-assist-extension3", "message-security-assist-extension4"]),
804    ("message-security-assist-extension12", Unstable(sym::s390x_target_feature), &[]),
805    ("miscellaneous-extensions-2", Unstable(sym::s390x_target_feature), &[]),
806    ("miscellaneous-extensions-3", Unstable(sym::s390x_target_feature), &[]),
807    ("miscellaneous-extensions-4", Unstable(sym::s390x_target_feature), &[]),
808    ("nnp-assist", Unstable(sym::s390x_target_feature), &["vector"]),
809    ("transactional-execution", Unstable(sym::s390x_target_feature), &[]),
810    ("vector", Unstable(sym::s390x_target_feature), &[]),
811    ("vector-enhancements-1", Unstable(sym::s390x_target_feature), &["vector"]),
812    ("vector-enhancements-2", Unstable(sym::s390x_target_feature), &["vector-enhancements-1"]),
813    ("vector-enhancements-3", Unstable(sym::s390x_target_feature), &["vector-enhancements-2"]),
814    ("vector-packed-decimal", Unstable(sym::s390x_target_feature), &["vector"]),
815    ("vector-packed-decimal-enhancement", Unstable(sym::s390x_target_feature), &["vector-packed-decimal"]),
816    ("vector-packed-decimal-enhancement-2", Unstable(sym::s390x_target_feature), &["vector-packed-decimal-enhancement"]),
817    ("vector-packed-decimal-enhancement-3", Unstable(sym::s390x_target_feature), &["vector-packed-decimal-enhancement-2"]),
818    // tidy-alphabetical-end
819];
820
821const SPARC_FEATURES: &[(&str, Stability, ImpliedFeatures)] = &[
822    // tidy-alphabetical-start
823    ("leoncasa", Unstable(sym::sparc_target_feature), &[]),
824    ("v8plus", Unstable(sym::sparc_target_feature), &[]),
825    ("v9", Unstable(sym::sparc_target_feature), &[]),
826    // tidy-alphabetical-end
827];
828
829static M68K_FEATURES: &[(&str, Stability, ImpliedFeatures)] = &[
830    // tidy-alphabetical-start
831    ("isa-68000", Unstable(sym::m68k_target_feature), &[]),
832    ("isa-68010", Unstable(sym::m68k_target_feature), &["isa-68000"]),
833    ("isa-68020", Unstable(sym::m68k_target_feature), &["isa-68010"]),
834    ("isa-68030", Unstable(sym::m68k_target_feature), &["isa-68020"]),
835    ("isa-68040", Unstable(sym::m68k_target_feature), &["isa-68030", "isa-68882"]),
836    ("isa-68060", Unstable(sym::m68k_target_feature), &["isa-68040"]),
837    // FPU
838    ("isa-68881", Unstable(sym::m68k_target_feature), &[]),
839    ("isa-68882", Unstable(sym::m68k_target_feature), &["isa-68881"]),
840    // tidy-alphabetical-end
841];
842
843/// When rustdoc is running, provide a list of all known features so that all their respective
844/// primitives may be documented.
845///
846/// IMPORTANT: If you're adding another feature list above, make sure to add it to this iterator!
847pub fn all_rust_features() -> impl Iterator<Item = (&'static str, Stability)> {
848    std::iter::empty()
849        .chain(ARM_FEATURES.iter())
850        .chain(AARCH64_FEATURES.iter())
851        .chain(X86_FEATURES.iter())
852        .chain(HEXAGON_FEATURES.iter())
853        .chain(POWERPC_FEATURES.iter())
854        .chain(MIPS_FEATURES.iter())
855        .chain(NVPTX_FEATURES.iter())
856        .chain(RISCV_FEATURES.iter())
857        .chain(WASM_FEATURES.iter())
858        .chain(BPF_FEATURES.iter())
859        .chain(CSKY_FEATURES)
860        .chain(LOONGARCH_FEATURES)
861        .chain(IBMZ_FEATURES)
862        .chain(SPARC_FEATURES)
863        .chain(M68K_FEATURES)
864        .cloned()
865        .map(|(f, s, _)| (f, s))
866}
867
868// These arrays represent the least-constraining feature that is required for vector types up to a
869// certain size to have their "proper" ABI on each architecture.
870// Note that they must be kept sorted by vector size.
871const X86_FEATURES_FOR_CORRECT_VECTOR_ABI: &'static [(u64, &'static str)] =
872    &[(128, "sse"), (256, "avx"), (512, "avx512f")]; // FIXME: might need changes for AVX10.
873const AARCH64_FEATURES_FOR_CORRECT_VECTOR_ABI: &'static [(u64, &'static str)] = &[(128, "neon")];
874
875// We might want to add "helium" too.
876const ARM_FEATURES_FOR_CORRECT_VECTOR_ABI: &'static [(u64, &'static str)] = &[(128, "neon")];
877
878const POWERPC_FEATURES_FOR_CORRECT_VECTOR_ABI: &'static [(u64, &'static str)] = &[(128, "altivec")];
879const WASM_FEATURES_FOR_CORRECT_VECTOR_ABI: &'static [(u64, &'static str)] = &[(128, "simd128")];
880const S390X_FEATURES_FOR_CORRECT_VECTOR_ABI: &'static [(u64, &'static str)] = &[(128, "vector")];
881const RISCV_FEATURES_FOR_CORRECT_VECTOR_ABI: &'static [(u64, &'static str)] = &[
882    (32, "zvl32b"),
883    (64, "zvl64b"),
884    (128, "zvl128b"),
885    (256, "zvl256b"),
886    (512, "zvl512b"),
887    (1024, "zvl1024b"),
888    (2048, "zvl2048b"),
889    (4096, "zvl4096b"),
890    (8192, "zvl8192b"),
891    (16384, "zvl16384b"),
892    (32768, "zvl32768b"),
893    (65536, "zvl65536b"),
894];
895// Always error on SPARC, as the necessary target features cannot be enabled in Rust at the moment.
896const SPARC_FEATURES_FOR_CORRECT_VECTOR_ABI: &'static [(u64, &'static str)] = &[/*(64, "vis")*/];
897
898const HEXAGON_FEATURES_FOR_CORRECT_VECTOR_ABI: &'static [(u64, &'static str)] =
899    &[/*(512, "hvx-length64b"),*/ (1024, "hvx-length128b")];
900const MIPS_FEATURES_FOR_CORRECT_VECTOR_ABI: &'static [(u64, &'static str)] = &[(128, "msa")];
901const CSKY_FEATURES_FOR_CORRECT_VECTOR_ABI: &'static [(u64, &'static str)] = &[(128, "vdspv1")];
902const LOONGARCH_FEATURES_FOR_CORRECT_VECTOR_ABI: &'static [(u64, &'static str)] =
903    &[(128, "lsx"), (256, "lasx")];
904
905#[derive(Copy, Clone, Debug)]
906pub struct FeatureConstraints {
907    /// Features that must be enabled.
908    pub required: &'static [&'static str],
909    /// Features that must be disabled.
910    pub incompatible: &'static [&'static str],
911}
912
913impl Target {
914    pub fn rust_target_features(&self) -> &'static [(&'static str, Stability, ImpliedFeatures)] {
915        match &*self.arch {
916            "arm" => ARM_FEATURES,
917            "aarch64" | "arm64ec" => AARCH64_FEATURES,
918            "x86" | "x86_64" => X86_FEATURES,
919            "hexagon" => HEXAGON_FEATURES,
920            "mips" | "mips32r6" | "mips64" | "mips64r6" => MIPS_FEATURES,
921            "nvptx64" => NVPTX_FEATURES,
922            "powerpc" | "powerpc64" => POWERPC_FEATURES,
923            "riscv32" | "riscv64" => RISCV_FEATURES,
924            "wasm32" | "wasm64" => WASM_FEATURES,
925            "bpf" => BPF_FEATURES,
926            "csky" => CSKY_FEATURES,
927            "loongarch32" | "loongarch64" => LOONGARCH_FEATURES,
928            "s390x" => IBMZ_FEATURES,
929            "sparc" | "sparc64" => SPARC_FEATURES,
930            "m68k" => M68K_FEATURES,
931            _ => &[],
932        }
933    }
934
935    pub fn features_for_correct_vector_abi(&self) -> &'static [(u64, &'static str)] {
936        match &*self.arch {
937            "x86" | "x86_64" => X86_FEATURES_FOR_CORRECT_VECTOR_ABI,
938            "aarch64" | "arm64ec" => AARCH64_FEATURES_FOR_CORRECT_VECTOR_ABI,
939            "arm" => ARM_FEATURES_FOR_CORRECT_VECTOR_ABI,
940            "powerpc" | "powerpc64" => POWERPC_FEATURES_FOR_CORRECT_VECTOR_ABI,
941            "loongarch32" | "loongarch64" => LOONGARCH_FEATURES_FOR_CORRECT_VECTOR_ABI,
942            "riscv32" | "riscv64" => RISCV_FEATURES_FOR_CORRECT_VECTOR_ABI,
943            "wasm32" | "wasm64" => WASM_FEATURES_FOR_CORRECT_VECTOR_ABI,
944            "s390x" => S390X_FEATURES_FOR_CORRECT_VECTOR_ABI,
945            "sparc" | "sparc64" => SPARC_FEATURES_FOR_CORRECT_VECTOR_ABI,
946            "hexagon" => HEXAGON_FEATURES_FOR_CORRECT_VECTOR_ABI,
947            "mips" | "mips32r6" | "mips64" | "mips64r6" => MIPS_FEATURES_FOR_CORRECT_VECTOR_ABI,
948            "nvptx64" | "bpf" | "m68k" => &[], // no vector ABI
949            "csky" => CSKY_FEATURES_FOR_CORRECT_VECTOR_ABI,
950            // FIXME: for some tier3 targets, we are overly cautious and always give warnings
951            // when passing args in vector registers.
952            _ => &[],
953        }
954    }
955
956    pub fn tied_target_features(&self) -> &'static [&'static [&'static str]] {
957        match &*self.arch {
958            "aarch64" | "arm64ec" => AARCH64_TIED_FEATURES,
959            _ => &[],
960        }
961    }
962
963    // Note: the returned set includes `base_feature`.
964    pub fn implied_target_features<'a>(&self, base_feature: &'a str) -> FxHashSet<&'a str> {
965        let implied_features =
966            self.rust_target_features().iter().map(|(f, _, i)| (f, i)).collect::<FxHashMap<_, _>>();
967
968        // Implied target features have their own implied target features, so we traverse the
969        // map until there are no more features to add.
970        let mut features = FxHashSet::default();
971        let mut new_features = vec![base_feature];
972        while let Some(new_feature) = new_features.pop() {
973            if features.insert(new_feature) {
974                if let Some(implied_features) = implied_features.get(&new_feature) {
975                    new_features.extend(implied_features.iter().copied())
976                }
977            }
978        }
979        features
980    }
981
982    /// Returns two lists of features:
983    /// the first list contains target features that must be enabled for ABI reasons,
984    /// and the second list contains target feature that must be disabled for ABI reasons.
985    ///
986    /// These features are automatically appended to whatever the target spec sets as default
987    /// features for the target.
988    ///
989    /// All features enabled/disabled via `-Ctarget-features` and `#[target_features]` are checked
990    /// against this. We also check any implied features, based on the information above. If LLVM
991    /// implicitly enables more implied features than we do, that could bypass this check!
992    pub fn abi_required_features(&self) -> FeatureConstraints {
993        const NOTHING: FeatureConstraints = FeatureConstraints { required: &[], incompatible: &[] };
994        // Some architectures don't have a clean explicit ABI designation; instead, the ABI is
995        // defined by target features. When that is the case, those target features must be
996        // "forbidden" in the list above to ensure that there is a consistent answer to the
997        // questions "which ABI is used".
998        match &*self.arch {
999            "x86" => {
1000                // We use our own ABI indicator here; LLVM does not have anything native.
1001                // Every case should require or forbid `soft-float`!
1002                match self.rustc_abi {
1003                    None => {
1004                        // Default hardfloat ABI.
1005                        // x87 must be enabled, soft-float must be disabled.
1006                        FeatureConstraints { required: &["x87"], incompatible: &["soft-float"] }
1007                    }
1008                    Some(RustcAbi::X86Sse2) => {
1009                        // Extended hardfloat ABI. x87 and SSE2 must be enabled, soft-float must be disabled.
1010                        FeatureConstraints {
1011                            required: &["x87", "sse2"],
1012                            incompatible: &["soft-float"],
1013                        }
1014                    }
1015                    Some(RustcAbi::X86Softfloat) => {
1016                        // Softfloat ABI, requires corresponding target feature. That feature trumps
1017                        // `x87` and all other FPU features so those do not matter.
1018                        // Note that this one requirement is the entire implementation of the ABI!
1019                        // LLVM handles the rest.
1020                        FeatureConstraints { required: &["soft-float"], incompatible: &[] }
1021                    }
1022                }
1023            }
1024            "x86_64" => {
1025                // We use our own ABI indicator here; LLVM does not have anything native.
1026                // Every case should require or forbid `soft-float`!
1027                match self.rustc_abi {
1028                    None => {
1029                        // Default hardfloat ABI. On x86-64, this always includes SSE2.
1030                        FeatureConstraints {
1031                            required: &["x87", "sse2"],
1032                            incompatible: &["soft-float"],
1033                        }
1034                    }
1035                    Some(RustcAbi::X86Softfloat) => {
1036                        // Softfloat ABI, requires corresponding target feature. That feature trumps
1037                        // `x87` and all other FPU features so those do not matter.
1038                        // Note that this one requirement is the entire implementation of the ABI!
1039                        // LLVM handles the rest.
1040                        FeatureConstraints { required: &["soft-float"], incompatible: &[] }
1041                    }
1042                    Some(r) => panic!("invalid Rust ABI for x86_64: {r:?}"),
1043                }
1044            }
1045            "arm" => {
1046                // On ARM, ABI handling is reasonably sane; we use `llvm_floatabi` to indicate
1047                // to LLVM which ABI we are going for.
1048                match self.llvm_floatabi.unwrap() {
1049                    FloatAbi::Soft => {
1050                        // Nothing special required, will use soft-float ABI throughout.
1051                        // We can even allow `-soft-float` here; in fact that is useful as it lets
1052                        // people use FPU instructions with a softfloat ABI (corresponds to
1053                        // `-mfloat-abi=softfp` in GCC/clang).
1054                        NOTHING
1055                    }
1056                    FloatAbi::Hard => {
1057                        // Must have `fpregs` and must not have `soft-float`.
1058                        FeatureConstraints { required: &["fpregs"], incompatible: &["soft-float"] }
1059                    }
1060                }
1061            }
1062            "aarch64" | "arm64ec" => {
1063                // Aarch64 has no sane ABI specifier, and LLVM doesn't even have a way to force
1064                // the use of soft-float, so all we can do here is some crude hacks.
1065                match &*self.abi {
1066                    "softfloat" => {
1067                        // LLVM will use float registers when `fp-armv8` is available, e.g. for
1068                        // calls to built-ins. The only way to ensure a consistent softfloat ABI
1069                        // on aarch64 is to never enable `fp-armv8`, so we enforce that.
1070                        // In Rust we tie `neon` and `fp-armv8` together, therefore `neon` is the
1071                        // feature we have to mark as incompatible.
1072                        FeatureConstraints { required: &[], incompatible: &["neon"] }
1073                    }
1074                    _ => {
1075                        // Everything else is assumed to use a hardfloat ABI. neon and fp-armv8 must be enabled.
1076                        // `FeatureConstraints` uses Rust feature names, hence only "neon" shows up.
1077                        FeatureConstraints { required: &["neon"], incompatible: &[] }
1078                    }
1079                }
1080            }
1081            "riscv32" | "riscv64" => {
1082                // RISC-V handles ABI in a very sane way, being fully explicit via `llvm_abiname`
1083                // about what the intended ABI is.
1084                match &*self.llvm_abiname {
1085                    "ilp32d" | "lp64d" => {
1086                        // Requires d (which implies f), incompatible with e and zfinx.
1087                        FeatureConstraints { required: &["d"], incompatible: &["e", "zfinx"] }
1088                    }
1089                    "ilp32f" | "lp64f" => {
1090                        // Requires f, incompatible with e and zfinx.
1091                        FeatureConstraints { required: &["f"], incompatible: &["e", "zfinx"] }
1092                    }
1093                    "ilp32" | "lp64" => {
1094                        // Requires nothing, incompatible with e.
1095                        FeatureConstraints { required: &[], incompatible: &["e"] }
1096                    }
1097                    "ilp32e" => {
1098                        // ilp32e is documented to be incompatible with features that need aligned
1099                        // load/stores > 32 bits, like `d`. (One could also just generate more
1100                        // complicated code to align the stack when needed, but the RISCV
1101                        // architecture manual just explicitly rules out this combination so we
1102                        // might as well.)
1103                        // Note that the `e` feature is not required: the ABI treats the extra
1104                        // registers as caller-save, so it is safe to use them only in some parts of
1105                        // a program while the rest doesn't know they even exist.
1106                        FeatureConstraints { required: &[], incompatible: &["d"] }
1107                    }
1108                    "lp64e" => {
1109                        // As above, `e` is not required.
1110                        NOTHING
1111                    }
1112                    _ => unreachable!(),
1113                }
1114            }
1115            "loongarch32" | "loongarch64" => {
1116                // LoongArch handles ABI in a very sane way, being fully explicit via `llvm_abiname`
1117                // about what the intended ABI is.
1118                match &*self.llvm_abiname {
1119                    "ilp32d" | "lp64d" => {
1120                        // Requires d (which implies f), incompatible with nothing.
1121                        FeatureConstraints { required: &["d"], incompatible: &[] }
1122                    }
1123                    "ilp32f" | "lp64f" => {
1124                        // Requires f, incompatible with nothing.
1125                        FeatureConstraints { required: &["f"], incompatible: &[] }
1126                    }
1127                    "ilp32s" | "lp64s" => {
1128                        // The soft-float ABI does not require any features and is also not
1129                        // incompatible with any features. Rust targets explicitly specify the
1130                        // LLVM ABI names, which allows for enabling hard-float support even on
1131                        // soft-float targets, and ensures that the ABI behavior is as expected.
1132                        NOTHING
1133                    }
1134                    _ => unreachable!(),
1135                }
1136            }
1137            _ => NOTHING,
1138        }
1139    }
1140}