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