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