compiler/rustc_codegen_ssa/src/target_features.rs

   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;
   6
   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
  11
  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
  36     // #[target_feature].
  37     ("thumb-mode", Some(sym::arm_target_feature)),
  38     ("thumb2", Some(sym::arm_target_feature)),
  39     ("reserve-r9", Some(sym::arm_target_feature)),
  40 ];
  41
  42 const AARCH64_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] = &[
  43     // FEAT_AdvSimd
  44     ("neon", Some(sym::aarch64_target_feature)),
  45     // FEAT_FP
  46     ("fp", Some(sym::aarch64_target_feature)),
  47     // FEAT_FP16
  48     ("fp16", Some(sym::aarch64_target_feature)),
  49     // FEAT_SVE
  50     ("sve", Some(sym::aarch64_target_feature)),
  51     // FEAT_CRC
  52     ("crc", Some(sym::aarch64_target_feature)),
  53     // FEAT_RAS
  54     ("ras", Some(sym::aarch64_target_feature)),
  55     // FEAT_LSE
  56     ("lse", Some(sym::aarch64_target_feature)),
  57     // FEAT_RDM
  58     ("rdm", Some(sym::aarch64_target_feature)),
  59     // FEAT_RCPC
  60     ("rcpc", Some(sym::aarch64_target_feature)),
  61     // FEAT_RCPC2
  62     ("rcpc2", Some(sym::aarch64_target_feature)),
  63     // FEAT_DotProd
  64     ("dotprod", Some(sym::aarch64_target_feature)),
  65     // FEAT_TME
  66     ("tme", Some(sym::aarch64_target_feature)),
  67     // FEAT_FHM
  68     ("fhm", Some(sym::aarch64_target_feature)),
  69     // FEAT_DIT
  70     ("dit", Some(sym::aarch64_target_feature)),
  71     // FEAT_FLAGM
  72     ("flagm", Some(sym::aarch64_target_feature)),
  73     // FEAT_SSBS
  74     ("ssbs", Some(sym::aarch64_target_feature)),
  75     // FEAT_SB
  76     ("sb", Some(sym::aarch64_target_feature)),
  77     // FEAT_PAUTH
  78     ("pauth", Some(sym::aarch64_target_feature)),
  79     // FEAT_DPB
  80     ("dpb", Some(sym::aarch64_target_feature)),
  81     // FEAT_DPB2
  82     ("dpb2", Some(sym::aarch64_target_feature)),
  83     // FEAT_SVE2
  84     ("sve2", Some(sym::aarch64_target_feature)),
  85     // FEAT_SVE2_AES
  86     ("sve2-aes", Some(sym::aarch64_target_feature)),
  87     // FEAT_SVE2_SM4
  88     ("sve2-sm4", Some(sym::aarch64_target_feature)),
  89     // FEAT_SVE2_SHA3
  90     ("sve2-sha3", Some(sym::aarch64_target_feature)),
  91     // FEAT_SVE2_BitPerm
  92     ("sve2-bitperm", Some(sym::aarch64_target_feature)),
  93     // FEAT_FRINTTS
  94     ("frintts", Some(sym::aarch64_target_feature)),
  95     // FEAT_I8MM
  96     ("i8mm", Some(sym::aarch64_target_feature)),
  97     // FEAT_F32MM
  98     ("f32mm", Some(sym::aarch64_target_feature)),
  99     // FEAT_F64MM
 100     ("f64mm", Some(sym::aarch64_target_feature)),
 101     // FEAT_BF16
 102     ("bf16", Some(sym::aarch64_target_feature)),
 103     // FEAT_RAND
 104     ("rand", Some(sym::aarch64_target_feature)),
 105     // FEAT_BTI
 106     ("bti", Some(sym::aarch64_target_feature)),
 107     // FEAT_MTE
 108     ("mte", Some(sym::aarch64_target_feature)),
 109     // FEAT_JSCVT
 110     ("jsconv", Some(sym::aarch64_target_feature)),
 111     // FEAT_FCMA
 112     ("fcma", Some(sym::aarch64_target_feature)),
 113     // FEAT_AES
 114     ("aes", Some(sym::aarch64_target_feature)),
 115     // FEAT_SHA1 & FEAT_SHA256
 116     ("sha2", Some(sym::aarch64_target_feature)),
 117     // FEAT_SHA512 & FEAT_SHA3
 118     ("sha3", Some(sym::aarch64_target_feature)),
 119     // FEAT_SM3 & FEAT_SM4
 120     ("sm4", Some(sym::aarch64_target_feature)),
 121     // FEAT_PAN
 122     ("pan", Some(sym::aarch64_target_feature)),
 123     // FEAT_LOR
 124     ("lor", Some(sym::aarch64_target_feature)),
 125     // FEAT_VHE
 126     ("vh", Some(sym::aarch64_target_feature)),
 127     // FEAT_PMUv3
 128     ("pmuv3", Some(sym::aarch64_target_feature)),
 129     // FEAT_SPE
 130     ("spe", Some(sym::aarch64_target_feature)),
 131     ("v8.1a", Some(sym::aarch64_target_feature)),
 132     ("v8.2a", Some(sym::aarch64_target_feature)),
 133     ("v8.3a", Some(sym::aarch64_target_feature)),
 134     ("v8.4a", Some(sym::aarch64_target_feature)),
 135     ("v8.5a", Some(sym::aarch64_target_feature)),
 136     ("v8.6a", Some(sym::aarch64_target_feature)),
 137     ("v8.7a", Some(sym::aarch64_target_feature)),
 138 ];
 139
 140 const X86_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] = &[
 141     ("adx", Some(sym::adx_target_feature)),
 142     ("aes", None),
 143     ("avx", None),
 144     ("avx2", None),
 145     ("avx512bf16", Some(sym::avx512_target_feature)),
 146     ("avx512bitalg", Some(sym::avx512_target_feature)),
 147     ("avx512bw", Some(sym::avx512_target_feature)),
 148     ("avx512cd", Some(sym::avx512_target_feature)),
 149     ("avx512dq", Some(sym::avx512_target_feature)),
 150     ("avx512er", Some(sym::avx512_target_feature)),
 151     ("avx512f", Some(sym::avx512_target_feature)),
 152     ("avx512gfni", Some(sym::avx512_target_feature)),
 153     ("avx512ifma", Some(sym::avx512_target_feature)),
 154     ("avx512pf", Some(sym::avx512_target_feature)),
 155     ("avx512vaes", Some(sym::avx512_target_feature)),
 156     ("avx512vbmi", Some(sym::avx512_target_feature)),
 157     ("avx512vbmi2", Some(sym::avx512_target_feature)),
 158     ("avx512vl", Some(sym::avx512_target_feature)),
 159     ("avx512vnni", Some(sym::avx512_target_feature)),
 160     ("avx512vp2intersect", Some(sym::avx512_target_feature)),
 161     ("avx512vpclmulqdq", Some(sym::avx512_target_feature)),
 162     ("avx512vpopcntdq", Some(sym::avx512_target_feature)),
 163     ("bmi1", None),
 164     ("bmi2", None),
 165     ("cmpxchg16b", Some(sym::cmpxchg16b_target_feature)),
 166     ("ermsb", Some(sym::ermsb_target_feature)),
 167     ("f16c", Some(sym::f16c_target_feature)),
 168     ("fma", None),
 169     ("fxsr", None),
 170     ("lzcnt", None),
 171     ("movbe", Some(sym::movbe_target_feature)),
 172     ("pclmulqdq", None),
 173     ("popcnt", None),
 174     ("rdrand", None),
 175     ("rdseed", None),
 176     ("rtm", Some(sym::rtm_target_feature)),
 177     ("sha", None),
 178     ("sse", None),
 179     ("sse2", None),
 180     ("sse3", None),
 181     ("sse4.1", None),
 182     ("sse4.2", None),
 183     ("sse4a", Some(sym::sse4a_target_feature)),
 184     ("ssse3", None),
 185     ("tbm", Some(sym::tbm_target_feature)),
 186     ("xsave", None),
 187     ("xsavec", None),
 188     ("xsaveopt", None),
 189     ("xsaves", None),
 190 ];
 191
 192 const HEXAGON_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] = &[
 193     ("hvx", Some(sym::hexagon_target_feature)),
 194     ("hvx-length128b", Some(sym::hexagon_target_feature)),
 195 ];
 196
 197 const POWERPC_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] = &[
 198     ("altivec", Some(sym::powerpc_target_feature)),
 199     ("power8-altivec", Some(sym::powerpc_target_feature)),
 200     ("power9-altivec", Some(sym::powerpc_target_feature)),
 201     ("power8-vector", Some(sym::powerpc_target_feature)),
 202     ("power9-vector", Some(sym::powerpc_target_feature)),
 203     ("vsx", Some(sym::powerpc_target_feature)),
 204 ];
 205
 206 const MIPS_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] =
 207     &[("fp64", Some(sym::mips_target_feature)), ("msa", Some(sym::mips_target_feature))];
 208
 209 const RISCV_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] = &[
 210     ("m", Some(sym::riscv_target_feature)),
 211     ("a", Some(sym::riscv_target_feature)),
 212     ("c", Some(sym::riscv_target_feature)),
 213     ("f", Some(sym::riscv_target_feature)),
 214     ("d", Some(sym::riscv_target_feature)),
 215     ("e", Some(sym::riscv_target_feature)),
 216 ];
 217
 218 const WASM_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] = &[
 219     ("simd128", None),
 220     ("atomics", Some(sym::wasm_target_feature)),
 221     ("nontrapping-fptoint", Some(sym::wasm_target_feature)),
 222 ];
 223
 224 const BPF_ALLOWED_FEATURES: &[(&str, Option<Symbol>)] = &[("alu32", Some(sym::bpf_target_feature))];
 225
 226 /// When rustdoc is running, provide a list of all known features so that all their respective
 227 /// primitives may be documented.
 228 ///
 229 /// IMPORTANT: If you're adding another feature list above, make sure to add it to this iterator!
 230 pub fn all_known_features() -> impl Iterator<Item = (&'static str, Option<Symbol>)> {
 231     std::iter::empty()
 232         .chain(ARM_ALLOWED_FEATURES.iter())
 233         .chain(AARCH64_ALLOWED_FEATURES.iter())
 234         .chain(X86_ALLOWED_FEATURES.iter())
 235         .chain(HEXAGON_ALLOWED_FEATURES.iter())
 236         .chain(POWERPC_ALLOWED_FEATURES.iter())
 237         .chain(MIPS_ALLOWED_FEATURES.iter())
 238         .chain(RISCV_ALLOWED_FEATURES.iter())
 239         .chain(WASM_ALLOWED_FEATURES.iter())
 240         .chain(BPF_ALLOWED_FEATURES.iter())
 241         .cloned()
 242 }
 243
 244 pub fn supported_target_features(sess: &Session) -> &'static [(&'static str, Option<Symbol>)] {
 245     match &*sess.target.arch {
 246         "arm" => ARM_ALLOWED_FEATURES,
 247         "aarch64" => AARCH64_ALLOWED_FEATURES,
 248         "x86" | "x86_64" => X86_ALLOWED_FEATURES,
 249         "hexagon" => HEXAGON_ALLOWED_FEATURES,
 250         "mips" | "mips64" => MIPS_ALLOWED_FEATURES,
 251         "powerpc" | "powerpc64" => POWERPC_ALLOWED_FEATURES,
 252         "riscv32" | "riscv64" => RISCV_ALLOWED_FEATURES,
 253         "wasm32" | "wasm64" => WASM_ALLOWED_FEATURES,
 254         "bpf" => BPF_ALLOWED_FEATURES,
 255         _ => &[],
 256     }
 257 }
 258
 259 pub(crate) fn provide(providers: &mut Providers) {
 260     providers.supported_target_features = |tcx, cnum| {
 261         assert_eq!(cnum, LOCAL_CRATE);
 262         if tcx.sess.opts.actually_rustdoc {
 263             // rustdoc needs to be able to document functions that use all the features, so
 264             // whitelist them all
 265             all_known_features().map(|(a, b)| (a.to_string(), b)).collect()
 266         } else {
 267             supported_target_features(tcx.sess).iter().map(|&(a, b)| (a.to_string(), b)).collect()
 268         }
 269     };
 270 }