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 ("v5te", Some(sym::arm_target_feature)),
23 ("v6", Some(sym::arm_target_feature)),
24 ("v6k", Some(sym::arm_target_feature)),
25 ("v6t2", Some(sym::arm_target_feature)),
26 ("v7", Some(sym::arm_target_feature)),
27 ("v8", Some(sym::arm_target_feature)),
28 ("vfp2", Some(sym::arm_target_feature)),
29 ("vfp3", Some(sym::arm_target_feature)),
30 ("vfp4", Some(sym::arm_target_feature)),
31 ("fp-armv8", Some(sym::arm_target_feature)),
32 // This is needed for inline assembly, but shouldn't be stabilized as-is
33 // since it should be enabled per-function using #[instruction_set], not
35 ("thumb-mode", Some(sym::arm_target_feature)),
38 // Commented features are not available in LLVM 10.0, or have since been renamed
39 const AARCH64_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] = &[
41 ("neon", Some(sym::aarch64_target_feature)),
43 ("fp", Some(sym::aarch64_target_feature)),
45 ("fp16", Some(sym::aarch64_target_feature)),
47 ("sve", Some(sym::aarch64_target_feature)),
49 ("crc", Some(sym::aarch64_target_feature)),
51 ("ras", Some(sym::aarch64_target_feature)),
53 ("lse", Some(sym::aarch64_target_feature)),
55 ("rdm", Some(sym::aarch64_target_feature)),
57 ("rcpc", Some(sym::aarch64_target_feature)),
59 ("rcpc2", Some(sym::aarch64_target_feature)),
61 ("dotprod", Some(sym::aarch64_target_feature)),
63 ("tme", Some(sym::aarch64_target_feature)),
65 ("fhm", Some(sym::aarch64_target_feature)),
67 ("dit", Some(sym::aarch64_target_feature)),
69 // ("flagm", Some(sym::aarch64_target_feature)),
71 ("ssbs", Some(sym::aarch64_target_feature)),
73 ("sb", Some(sym::aarch64_target_feature)),
75 // ("pauth", Some(sym::aarch64_target_feature)),
77 ("dpb", Some(sym::aarch64_target_feature)),
79 ("dpb2", Some(sym::aarch64_target_feature)),
81 ("sve2", Some(sym::aarch64_target_feature)),
83 ("sve2-aes", Some(sym::aarch64_target_feature)),
85 ("sve2-sm4", Some(sym::aarch64_target_feature)),
87 ("sve2-sha3", Some(sym::aarch64_target_feature)),
89 ("sve2-bitperm", Some(sym::aarch64_target_feature)),
91 ("frintts", Some(sym::aarch64_target_feature)),
93 // ("i8mm", Some(sym::aarch64_target_feature)),
95 // ("f32mm", Some(sym::aarch64_target_feature)),
97 // ("f64mm", Some(sym::aarch64_target_feature)),
99 // ("bf16", Some(sym::aarch64_target_feature)),
101 ("rand", Some(sym::aarch64_target_feature)),
103 ("bti", Some(sym::aarch64_target_feature)),
105 ("mte", Some(sym::aarch64_target_feature)),
107 ("jsconv", Some(sym::aarch64_target_feature)),
109 ("fcma", Some(sym::aarch64_target_feature)),
111 ("aes", Some(sym::aarch64_target_feature)),
112 // FEAT_SHA1 & FEAT_SHA256
113 ("sha2", Some(sym::aarch64_target_feature)),
114 // FEAT_SHA512 & FEAT_SHA3
115 ("sha3", Some(sym::aarch64_target_feature)),
116 // FEAT_SM3 & FEAT_SM4
117 ("sm4", Some(sym::aarch64_target_feature)),
118 ("v8.1a", Some(sym::aarch64_target_feature)),
119 ("v8.2a", Some(sym::aarch64_target_feature)),
120 ("v8.3a", Some(sym::aarch64_target_feature)),
121 ("v8.4a", Some(sym::aarch64_target_feature)),
122 ("v8.5a", Some(sym::aarch64_target_feature)),
123 // ("v8.6a", Some(sym::aarch64_target_feature)),
124 // ("v8.7a", Some(sym::aarch64_target_feature)),
127 const X86_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] = &[
128 ("adx", Some(sym::adx_target_feature)),
132 ("avx512bf16", Some(sym::avx512_target_feature)),
133 ("avx512bitalg", Some(sym::avx512_target_feature)),
134 ("avx512bw", Some(sym::avx512_target_feature)),
135 ("avx512cd", Some(sym::avx512_target_feature)),
136 ("avx512dq", Some(sym::avx512_target_feature)),
137 ("avx512er", Some(sym::avx512_target_feature)),
138 ("avx512f", Some(sym::avx512_target_feature)),
139 ("avx512gfni", Some(sym::avx512_target_feature)),
140 ("avx512ifma", Some(sym::avx512_target_feature)),
141 ("avx512pf", Some(sym::avx512_target_feature)),
142 ("avx512vaes", Some(sym::avx512_target_feature)),
143 ("avx512vbmi", Some(sym::avx512_target_feature)),
144 ("avx512vbmi2", Some(sym::avx512_target_feature)),
145 ("avx512vl", Some(sym::avx512_target_feature)),
146 ("avx512vnni", Some(sym::avx512_target_feature)),
147 ("avx512vp2intersect", Some(sym::avx512_target_feature)),
148 ("avx512vpclmulqdq", Some(sym::avx512_target_feature)),
149 ("avx512vpopcntdq", Some(sym::avx512_target_feature)),
152 ("cmpxchg16b", Some(sym::cmpxchg16b_target_feature)),
153 ("ermsb", Some(sym::ermsb_target_feature)),
154 ("f16c", Some(sym::f16c_target_feature)),
158 ("movbe", Some(sym::movbe_target_feature)),
163 ("rtm", Some(sym::rtm_target_feature)),
170 ("sse4a", Some(sym::sse4a_target_feature)),
172 ("tbm", Some(sym::tbm_target_feature)),
179 const HEXAGON_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] = &[
180 ("hvx", Some(sym::hexagon_target_feature)),
181 ("hvx-length128b", Some(sym::hexagon_target_feature)),
184 const POWERPC_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] = &[
185 ("altivec", Some(sym::powerpc_target_feature)),
186 ("power8-altivec", Some(sym::powerpc_target_feature)),
187 ("power9-altivec", Some(sym::powerpc_target_feature)),
188 ("power8-vector", Some(sym::powerpc_target_feature)),
189 ("power9-vector", Some(sym::powerpc_target_feature)),
190 ("vsx", Some(sym::powerpc_target_feature)),
193 const MIPS_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] =
194 &[("fp64", Some(sym::mips_target_feature)), ("msa", Some(sym::mips_target_feature))];
196 const RISCV_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] = &[
197 ("m", Some(sym::riscv_target_feature)),
198 ("a", Some(sym::riscv_target_feature)),
199 ("c", Some(sym::riscv_target_feature)),
200 ("f", Some(sym::riscv_target_feature)),
201 ("d", Some(sym::riscv_target_feature)),
202 ("e", Some(sym::riscv_target_feature)),
205 const WASM_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] = &[
207 ("atomics", Some(sym::wasm_target_feature)),
208 ("nontrapping-fptoint", Some(sym::wasm_target_feature)),
211 const BPF_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] = &[("alu32", Some(sym::bpf_target_feature))];
213 /// When rustdoc is running, provide a list of all known features so that all their respective
214 /// primitives may be documented.
216 /// IMPORTANT: If you're adding another feature list above, make sure to add it to this iterator!
217 pub fn all_known_features() -> impl Iterator<Item = (&'static str, Option<Symbol>)> {
219 .chain(ARM_ALLOWED_FEATURES.iter())
220 .chain(AARCH64_ALLOWED_FEATURES.iter())
221 .chain(X86_ALLOWED_FEATURES.iter())
222 .chain(HEXAGON_ALLOWED_FEATURES.iter())
223 .chain(POWERPC_ALLOWED_FEATURES.iter())
224 .chain(MIPS_ALLOWED_FEATURES.iter())
225 .chain(RISCV_ALLOWED_FEATURES.iter())
226 .chain(WASM_ALLOWED_FEATURES.iter())
227 .chain(BPF_ALLOWED_FEATURES.iter())
231 pub fn supported_target_features(sess: &Session) -> &'static [(&'static str, Option<Symbol>)] {
232 match &*sess.target.arch {
233 "arm" => ARM_ALLOWED_FEATURES,
234 "aarch64" => AARCH64_ALLOWED_FEATURES,
235 "x86" | "x86_64" => X86_ALLOWED_FEATURES,
236 "hexagon" => HEXAGON_ALLOWED_FEATURES,
237 "mips" | "mips64" => MIPS_ALLOWED_FEATURES,
238 "powerpc" | "powerpc64" => POWERPC_ALLOWED_FEATURES,
239 "riscv32" | "riscv64" => RISCV_ALLOWED_FEATURES,
240 "wasm32" | "wasm64" => WASM_ALLOWED_FEATURES,
241 "bpf" => BPF_ALLOWED_FEATURES,
246 pub(crate) fn provide(providers: &mut Providers) {
247 providers.supported_target_features = |tcx, cnum| {
248 assert_eq!(cnum, LOCAL_CRATE);
249 if tcx.sess.opts.actually_rustdoc {
250 // rustdoc needs to be able to document functions that use all the features, so
251 // whitelist them all
252 all_known_features().map(|(a, b)| (a.to_string(), b)).collect()
254 supported_target_features(tcx.sess).iter().map(|&(a, b)| (a.to_string(), b)).collect()