1 use rustc_hir::def_id::LOCAL_CRATE;
2 use rustc_middle::ty::query::Providers;
3 use rustc_session::Session;
4 use rustc_span::symbol::sym;
5 use rustc_span::symbol::Symbol;
7 // When adding features to the below lists
8 // check whether they're named already elsewhere in rust
9 // e.g. in stdarch and whether the given name matches LLVM's
10 // if it doesn't, to_llvm_feature in llvm_util in rustc_codegen_llvm needs to be adapted
12 const ARM_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] = &[
13 ("aclass", Some(sym::arm_target_feature)),
14 ("mclass", Some(sym::arm_target_feature)),
15 ("rclass", Some(sym::arm_target_feature)),
16 ("dsp", Some(sym::arm_target_feature)),
17 ("neon", Some(sym::arm_target_feature)),
18 ("crc", Some(sym::arm_target_feature)),
19 ("crypto", Some(sym::arm_target_feature)),
20 ("aes", Some(sym::arm_target_feature)),
21 ("sha2", Some(sym::arm_target_feature)),
22 ("i8mm", Some(sym::arm_target_feature)),
23 ("dotprod", Some(sym::arm_target_feature)),
24 ("v5te", Some(sym::arm_target_feature)),
25 ("v6", Some(sym::arm_target_feature)),
26 ("v6k", Some(sym::arm_target_feature)),
27 ("v6t2", Some(sym::arm_target_feature)),
28 ("v7", Some(sym::arm_target_feature)),
29 ("v8", Some(sym::arm_target_feature)),
30 ("vfp2", Some(sym::arm_target_feature)),
31 ("vfp3", Some(sym::arm_target_feature)),
32 ("vfp4", Some(sym::arm_target_feature)),
33 ("fp-armv8", Some(sym::arm_target_feature)),
34 // This is needed for inline assembly, but shouldn't be stabilized as-is
35 // since it should be enabled per-function using #[instruction_set], not
37 ("thumb-mode", Some(sym::arm_target_feature)),
40 const AARCH64_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] = &[
42 ("neon", Some(sym::aarch64_target_feature)),
44 ("fp", Some(sym::aarch64_target_feature)),
46 ("fp16", Some(sym::aarch64_target_feature)),
48 ("sve", Some(sym::aarch64_target_feature)),
50 ("crc", Some(sym::aarch64_target_feature)),
52 ("ras", Some(sym::aarch64_target_feature)),
54 ("lse", Some(sym::aarch64_target_feature)),
56 ("rdm", Some(sym::aarch64_target_feature)),
58 ("rcpc", Some(sym::aarch64_target_feature)),
60 ("rcpc2", Some(sym::aarch64_target_feature)),
62 ("dotprod", Some(sym::aarch64_target_feature)),
64 ("tme", Some(sym::aarch64_target_feature)),
66 ("fhm", Some(sym::aarch64_target_feature)),
68 ("dit", Some(sym::aarch64_target_feature)),
70 ("flagm", Some(sym::aarch64_target_feature)),
72 ("ssbs", Some(sym::aarch64_target_feature)),
74 ("sb", Some(sym::aarch64_target_feature)),
76 ("pauth", Some(sym::aarch64_target_feature)),
78 ("dpb", Some(sym::aarch64_target_feature)),
80 ("dpb2", Some(sym::aarch64_target_feature)),
82 ("sve2", Some(sym::aarch64_target_feature)),
84 ("sve2-aes", Some(sym::aarch64_target_feature)),
86 ("sve2-sm4", Some(sym::aarch64_target_feature)),
88 ("sve2-sha3", Some(sym::aarch64_target_feature)),
90 ("sve2-bitperm", Some(sym::aarch64_target_feature)),
92 ("frintts", Some(sym::aarch64_target_feature)),
94 ("i8mm", Some(sym::aarch64_target_feature)),
96 ("f32mm", Some(sym::aarch64_target_feature)),
98 ("f64mm", Some(sym::aarch64_target_feature)),
100 ("bf16", Some(sym::aarch64_target_feature)),
102 ("rand", Some(sym::aarch64_target_feature)),
104 ("bti", Some(sym::aarch64_target_feature)),
106 ("mte", Some(sym::aarch64_target_feature)),
108 ("jsconv", Some(sym::aarch64_target_feature)),
110 ("fcma", Some(sym::aarch64_target_feature)),
112 ("aes", Some(sym::aarch64_target_feature)),
113 // FEAT_SHA1 & FEAT_SHA256
114 ("sha2", Some(sym::aarch64_target_feature)),
115 // FEAT_SHA512 & FEAT_SHA3
116 ("sha3", Some(sym::aarch64_target_feature)),
117 // FEAT_SM3 & FEAT_SM4
118 ("sm4", Some(sym::aarch64_target_feature)),
120 ("pan", Some(sym::aarch64_target_feature)),
122 ("lor", Some(sym::aarch64_target_feature)),
124 ("vh", Some(sym::aarch64_target_feature)),
126 ("pmuv3", Some(sym::aarch64_target_feature)),
128 ("spe", Some(sym::aarch64_target_feature)),
129 ("v8.1a", Some(sym::aarch64_target_feature)),
130 ("v8.2a", Some(sym::aarch64_target_feature)),
131 ("v8.3a", Some(sym::aarch64_target_feature)),
132 ("v8.4a", Some(sym::aarch64_target_feature)),
133 ("v8.5a", Some(sym::aarch64_target_feature)),
134 ("v8.6a", Some(sym::aarch64_target_feature)),
135 ("v8.7a", Some(sym::aarch64_target_feature)),
138 const X86_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] = &[
139 ("adx", Some(sym::adx_target_feature)),
143 ("avx512bf16", Some(sym::avx512_target_feature)),
144 ("avx512bitalg", Some(sym::avx512_target_feature)),
145 ("avx512bw", Some(sym::avx512_target_feature)),
146 ("avx512cd", Some(sym::avx512_target_feature)),
147 ("avx512dq", Some(sym::avx512_target_feature)),
148 ("avx512er", Some(sym::avx512_target_feature)),
149 ("avx512f", Some(sym::avx512_target_feature)),
150 ("avx512gfni", Some(sym::avx512_target_feature)),
151 ("avx512ifma", Some(sym::avx512_target_feature)),
152 ("avx512pf", Some(sym::avx512_target_feature)),
153 ("avx512vaes", Some(sym::avx512_target_feature)),
154 ("avx512vbmi", Some(sym::avx512_target_feature)),
155 ("avx512vbmi2", Some(sym::avx512_target_feature)),
156 ("avx512vl", Some(sym::avx512_target_feature)),
157 ("avx512vnni", Some(sym::avx512_target_feature)),
158 ("avx512vp2intersect", Some(sym::avx512_target_feature)),
159 ("avx512vpclmulqdq", Some(sym::avx512_target_feature)),
160 ("avx512vpopcntdq", Some(sym::avx512_target_feature)),
163 ("cmpxchg16b", Some(sym::cmpxchg16b_target_feature)),
164 ("ermsb", Some(sym::ermsb_target_feature)),
165 ("f16c", Some(sym::f16c_target_feature)),
169 ("movbe", Some(sym::movbe_target_feature)),
174 ("rtm", Some(sym::rtm_target_feature)),
181 ("sse4a", Some(sym::sse4a_target_feature)),
183 ("tbm", Some(sym::tbm_target_feature)),
190 const HEXAGON_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] = &[
191 ("hvx", Some(sym::hexagon_target_feature)),
192 ("hvx-length128b", Some(sym::hexagon_target_feature)),
195 const POWERPC_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] = &[
196 ("altivec", Some(sym::powerpc_target_feature)),
197 ("power8-altivec", Some(sym::powerpc_target_feature)),
198 ("power9-altivec", Some(sym::powerpc_target_feature)),
199 ("power8-vector", Some(sym::powerpc_target_feature)),
200 ("power9-vector", Some(sym::powerpc_target_feature)),
201 ("vsx", Some(sym::powerpc_target_feature)),
204 const MIPS_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] =
205 &[("fp64", Some(sym::mips_target_feature)), ("msa", Some(sym::mips_target_feature))];
207 const RISCV_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] = &[
208 ("m", Some(sym::riscv_target_feature)),
209 ("a", Some(sym::riscv_target_feature)),
210 ("c", Some(sym::riscv_target_feature)),
211 ("f", Some(sym::riscv_target_feature)),
212 ("d", Some(sym::riscv_target_feature)),
213 ("e", Some(sym::riscv_target_feature)),
216 const WASM_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] = &[
218 ("atomics", Some(sym::wasm_target_feature)),
219 ("nontrapping-fptoint", Some(sym::wasm_target_feature)),
222 const BPF_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] = &[("alu32", Some(sym::bpf_target_feature))];
224 /// When rustdoc is running, provide a list of all known features so that all their respective
225 /// primitives may be documented.
227 /// IMPORTANT: If you're adding another feature list above, make sure to add it to this iterator!
228 pub fn all_known_features() -> impl Iterator<Item = (&'static str, Option<Symbol>)> {
230 .chain(ARM_ALLOWED_FEATURES.iter())
231 .chain(AARCH64_ALLOWED_FEATURES.iter())
232 .chain(X86_ALLOWED_FEATURES.iter())
233 .chain(HEXAGON_ALLOWED_FEATURES.iter())
234 .chain(POWERPC_ALLOWED_FEATURES.iter())
235 .chain(MIPS_ALLOWED_FEATURES.iter())
236 .chain(RISCV_ALLOWED_FEATURES.iter())
237 .chain(WASM_ALLOWED_FEATURES.iter())
238 .chain(BPF_ALLOWED_FEATURES.iter())
242 pub fn supported_target_features(sess: &Session) -> &'static [(&'static str, Option<Symbol>)] {
243 match &*sess.target.arch {
244 "arm" => ARM_ALLOWED_FEATURES,
245 "aarch64" => AARCH64_ALLOWED_FEATURES,
246 "x86" | "x86_64" => X86_ALLOWED_FEATURES,
247 "hexagon" => HEXAGON_ALLOWED_FEATURES,
248 "mips" | "mips64" => MIPS_ALLOWED_FEATURES,
249 "powerpc" | "powerpc64" => POWERPC_ALLOWED_FEATURES,
250 "riscv32" | "riscv64" => RISCV_ALLOWED_FEATURES,
251 "wasm32" | "wasm64" => WASM_ALLOWED_FEATURES,
252 "bpf" => BPF_ALLOWED_FEATURES,
257 pub(crate) fn provide(providers: &mut Providers) {
258 providers.supported_target_features = |tcx, cnum| {
259 assert_eq!(cnum, LOCAL_CRATE);
260 if tcx.sess.opts.actually_rustdoc {
261 // rustdoc needs to be able to document functions that use all the features, so
262 // whitelist them all
263 all_known_features().map(|(a, b)| (a.to_string(), b)).collect()
265 supported_target_features(tcx.sess).iter().map(|&(a, b)| (a.to_string(), b)).collect()