compiler/rustc_codegen_llvm/src/llvm_util.rs

   1 use crate::back::write::create_informational_target_machine;
   2 use crate::{llvm, llvm_util};
   3 use libc::c_int;
   4 use rustc_codegen_ssa::target_features::supported_target_features;
   5 use rustc_data_structures::fx::FxHashSet;
   6 use rustc_metadata::dynamic_lib::DynamicLibrary;
   7 use rustc_middle::bug;
   8 use rustc_session::config::PrintRequest;
   9 use rustc_session::Session;
  10 use rustc_span::symbol::Symbol;
  11 use rustc_target::spec::{MergeFunctions, PanicStrategy};
  12 use std::ffi::{CStr, CString};
  13 use tracing::debug;
  14
  15 use std::mem;
  16 use std::path::Path;
  17 use std::ptr;
  18 use std::slice;
  19 use std::str;
  20 use std::sync::Once;
  21
  22 static INIT: Once = Once::new();
  23
  24 pub(crate) fn init(sess: &Session) {
  25     unsafe {
  26         // Before we touch LLVM, make sure that multithreading is enabled.
  27         if llvm::LLVMIsMultithreaded() != 1 {
  28             bug!("LLVM compiled without support for threads");
  29         }
  30         INIT.call_once(|| {
  31             configure_llvm(sess);
  32         });
  33     }
  34 }
  35
  36 fn require_inited() {
  37     if !INIT.is_completed() {
  38         bug!("LLVM is not initialized");
  39     }
  40 }
  41
  42 unsafe fn configure_llvm(sess: &Session) {
  43     let n_args = sess.opts.cg.llvm_args.len() + sess.target.llvm_args.len();
  44     let mut llvm_c_strs = Vec::with_capacity(n_args + 1);
  45     let mut llvm_args = Vec::with_capacity(n_args + 1);
  46
  47     llvm::LLVMRustInstallFatalErrorHandler();
  48
  49     fn llvm_arg_to_arg_name(full_arg: &str) -> &str {
  50         full_arg.trim().split(|c: char| c == '=' || c.is_whitespace()).next().unwrap_or("")
  51     }
  52
  53     let cg_opts = sess.opts.cg.llvm_args.iter();
  54     let tg_opts = sess.target.llvm_args.iter();
  55     let sess_args = cg_opts.chain(tg_opts);
  56
  57     let user_specified_args: FxHashSet<_> =
  58         sess_args.clone().map(|s| llvm_arg_to_arg_name(s)).filter(|s| !s.is_empty()).collect();
  59
  60     {
  61         // This adds the given argument to LLVM. Unless `force` is true
  62         // user specified arguments are *not* overridden.
  63         let mut add = |arg: &str, force: bool| {
  64             if force || !user_specified_args.contains(llvm_arg_to_arg_name(arg)) {
  65                 let s = CString::new(arg).unwrap();
  66                 llvm_args.push(s.as_ptr());
  67                 llvm_c_strs.push(s);
  68             }
  69         };
  70         // Set the llvm "program name" to make usage and invalid argument messages more clear.
  71         add("rustc -Cllvm-args=\"...\" with", true);
  72         if sess.time_llvm_passes() {
  73             add("-time-passes", false);
  74         }
  75         if sess.print_llvm_passes() {
  76             add("-debug-pass=Structure", false);
  77         }
  78         if sess.target.generate_arange_section
  79             && !sess.opts.debugging_opts.no_generate_arange_section
  80         {
  81             add("-generate-arange-section", false);
  82         }
  83
  84         // Disable the machine outliner by default in LLVM versions 11 and LLVM
  85         // version 12, where it leads to miscompilation.
  86         //
  87         // Ref:
  88         // - https://github.com/rust-lang/rust/issues/85351
  89         // - https://reviews.llvm.org/D103167
  90         if llvm_util::get_version() < (13, 0, 0) {
  91             add("-enable-machine-outliner=never", false);
  92         }
  93
  94         match sess.opts.debugging_opts.merge_functions.unwrap_or(sess.target.merge_functions) {
  95             MergeFunctions::Disabled | MergeFunctions::Trampolines => {}
  96             MergeFunctions::Aliases => {
  97                 add("-mergefunc-use-aliases", false);
  98             }
  99         }
 100
 101         if sess.target.os == "emscripten" && sess.panic_strategy() == PanicStrategy::Unwind {
 102             add("-enable-emscripten-cxx-exceptions", false);
 103         }
 104
 105         // HACK(eddyb) LLVM inserts `llvm.assume` calls to preserve align attributes
 106         // during inlining. Unfortunately these may block other optimizations.
 107         add("-preserve-alignment-assumptions-during-inlining=false", false);
 108
 109         // Use non-zero `import-instr-limit` multiplier for cold callsites.
 110         add("-import-cold-multiplier=0.1", false);
 111
 112         for arg in sess_args {
 113             add(&(*arg), true);
 114         }
 115     }
 116
 117     if sess.opts.debugging_opts.llvm_time_trace {
 118         llvm::LLVMTimeTraceProfilerInitialize();
 119     }
 120
 121     llvm::LLVMInitializePasses();
 122
 123     for plugin in &sess.opts.debugging_opts.llvm_plugins {
 124         let path = Path::new(plugin);
 125         let res = DynamicLibrary::open(path);
 126         match res {
 127             Ok(_) => debug!("LLVM plugin loaded succesfully {} ({})", path.display(), plugin),
 128             Err(e) => bug!("couldn't load plugin: {}", e),
 129         }
 130         mem::forget(res);
 131     }
 132
 133     rustc_llvm::initialize_available_targets();
 134
 135     llvm::LLVMRustSetLLVMOptions(llvm_args.len() as c_int, llvm_args.as_ptr());
 136 }
 137
 138 pub fn time_trace_profiler_finish(file_name: &str) {
 139     unsafe {
 140         let file_name = CString::new(file_name).unwrap();
 141         llvm::LLVMTimeTraceProfilerFinish(file_name.as_ptr());
 142     }
 143 }
 144
 145 // WARNING: the features after applying `to_llvm_feature` must be known
 146 // to LLVM or the feature detection code will walk past the end of the feature
 147 // array, leading to crashes.
 148 // To find a list of LLVM's names, check llvm-project/llvm/include/llvm/Support/*TargetParser.def
 149 // where the * matches the architecture's name
 150 // Beware to not use the llvm github project for this, but check the git submodule
 151 // found in src/llvm-project
 152 // Though note that Rust can also be build with an external precompiled version of LLVM
 153 // which might lead to failures if the oldest tested / supported LLVM version
 154 // doesn't yet support the relevant intrinsics
 155 pub fn to_llvm_feature<'a>(sess: &Session, s: &'a str) -> Vec<&'a str> {
 156     let arch = if sess.target.arch == "x86_64" { "x86" } else { &*sess.target.arch };
 157     match (arch, s) {
 158         ("x86", "sse4.2") => {
 159             if get_version() >= (14, 0, 0) {
 160                 vec!["sse4.2", "crc32"]
 161             } else {
 162                 vec!["sse4.2"]
 163             }
 164         }
 165         ("x86", "pclmulqdq") => vec!["pclmul"],
 166         ("x86", "rdrand") => vec!["rdrnd"],
 167         ("x86", "bmi1") => vec!["bmi"],
 168         ("x86", "cmpxchg16b") => vec!["cx16"],
 169         ("x86", "avx512vaes") => vec!["vaes"],
 170         ("x86", "avx512gfni") => vec!["gfni"],
 171         ("x86", "avx512vpclmulqdq") => vec!["vpclmulqdq"],
 172         ("aarch64", "fp") => vec!["fp-armv8"],
 173         ("aarch64", "fp16") => vec!["fullfp16"],
 174         ("aarch64", "fhm") => vec!["fp16fml"],
 175         ("aarch64", "rcpc2") => vec!["rcpc-immo"],
 176         ("aarch64", "dpb") => vec!["ccpp"],
 177         ("aarch64", "dpb2") => vec!["ccdp"],
 178         ("aarch64", "frintts") => vec!["fptoint"],
 179         ("aarch64", "fcma") => vec!["complxnum"],
 180         ("aarch64", "pmuv3") => vec!["perfmon"],
 181         (_, s) => vec![s],
 182     }
 183 }
 184
 185 pub fn target_features(sess: &Session) -> Vec<Symbol> {
 186     let target_machine = create_informational_target_machine(sess);
 187     supported_target_features(sess)
 188         .iter()
 189         .filter_map(
 190             |&(feature, gate)| {
 191                 if sess.is_nightly_build() || gate.is_none() { Some(feature) } else { None }
 192             },
 193         )
 194         .filter(|feature| {
 195             for llvm_feature in to_llvm_feature(sess, feature) {
 196                 let cstr = CString::new(llvm_feature).unwrap();
 197                 if unsafe { llvm::LLVMRustHasFeature(target_machine, cstr.as_ptr()) } {
 198                     return true;
 199                 }
 200             }
 201             false
 202         })
 203         .map(|feature| Symbol::intern(feature))
 204         .collect()
 205 }
 206
 207 pub fn print_version() {
 208     let (major, minor, patch) = get_version();
 209     println!("LLVM version: {}.{}.{}", major, minor, patch);
 210 }
 211
 212 pub fn get_version() -> (u32, u32, u32) {
 213     // Can be called without initializing LLVM
 214     unsafe {
 215         (llvm::LLVMRustVersionMajor(), llvm::LLVMRustVersionMinor(), llvm::LLVMRustVersionPatch())
 216     }
 217 }
 218
 219 pub fn print_passes() {
 220     // Can be called without initializing LLVM
 221     unsafe {
 222         llvm::LLVMRustPrintPasses();
 223     }
 224 }
 225
 226 fn llvm_target_features(tm: &llvm::TargetMachine) -> Vec<(&str, &str)> {
 227     let len = unsafe { llvm::LLVMRustGetTargetFeaturesCount(tm) };
 228     let mut ret = Vec::with_capacity(len);
 229     for i in 0..len {
 230         unsafe {
 231             let mut feature = ptr::null();
 232             let mut desc = ptr::null();
 233             llvm::LLVMRustGetTargetFeature(tm, i, &mut feature, &mut desc);
 234             if feature.is_null() || desc.is_null() {
 235                 bug!("LLVM returned a `null` target feature string");
 236             }
 237             let feature = CStr::from_ptr(feature).to_str().unwrap_or_else(|e| {
 238                 bug!("LLVM returned a non-utf8 feature string: {}", e);
 239             });
 240             let desc = CStr::from_ptr(desc).to_str().unwrap_or_else(|e| {
 241                 bug!("LLVM returned a non-utf8 feature string: {}", e);
 242             });
 243             ret.push((feature, desc));
 244         }
 245     }
 246     ret
 247 }
 248
 249 fn print_target_features(sess: &Session, tm: &llvm::TargetMachine) {
 250     let mut target_features = llvm_target_features(tm);
 251     let mut rustc_target_features = supported_target_features(sess)
 252         .iter()
 253         .filter_map(|(feature, _gate)| {
 254             for llvm_feature in to_llvm_feature(sess, *feature) {
 255                 // LLVM asserts that these are sorted. LLVM and Rust both use byte comparison for these strings.
 256                 match target_features.binary_search_by_key(&llvm_feature, |(f, _d)| (*f)).ok().map(
 257                     |index| {
 258                         let (_f, desc) = target_features.remove(index);
 259                         (*feature, desc)
 260                     },
 261                 ) {
 262                     Some(v) => return Some(v),
 263                     None => {}
 264                 }
 265             }
 266             None
 267         })
 268         .collect::<Vec<_>>();
 269     rustc_target_features.extend_from_slice(&[(
 270         "crt-static",
 271         "Enables C Run-time Libraries to be statically linked",
 272     )]);
 273     let max_feature_len = target_features
 274         .iter()
 275         .chain(rustc_target_features.iter())
 276         .map(|(feature, _desc)| feature.len())
 277         .max()
 278         .unwrap_or(0);
 279
 280     println!("Features supported by rustc for this target:");
 281     for (feature, desc) in &rustc_target_features {
 282         println!("    {1:0$} - {2}.", max_feature_len, feature, desc);
 283     }
 284     println!("\nCode-generation features supported by LLVM for this target:");
 285     for (feature, desc) in &target_features {
 286         println!("    {1:0$} - {2}.", max_feature_len, feature, desc);
 287     }
 288     if target_features.is_empty() {
 289         println!("    Target features listing is not supported by this LLVM version.");
 290     }
 291     println!("\nUse +feature to enable a feature, or -feature to disable it.");
 292     println!("For example, rustc -C target-cpu=mycpu -C target-feature=+feature1,-feature2\n");
 293     println!("Code-generation features cannot be used in cfg or #[target_feature],");
 294     println!("and may be renamed or removed in a future version of LLVM or rustc.\n");
 295 }
 296
 297 pub(crate) fn print(req: PrintRequest, sess: &Session) {
 298     require_inited();
 299     let tm = create_informational_target_machine(sess);
 300     match req {
 301         PrintRequest::TargetCPUs => unsafe { llvm::LLVMRustPrintTargetCPUs(tm) },
 302         PrintRequest::TargetFeatures => print_target_features(sess, tm),
 303         _ => bug!("rustc_codegen_llvm can't handle print request: {:?}", req),
 304     }
 305 }
 306
 307 fn handle_native(name: &str) -> &str {
 308     if name != "native" {
 309         return name;
 310     }
 311
 312     unsafe {
 313         let mut len = 0;
 314         let ptr = llvm::LLVMRustGetHostCPUName(&mut len);
 315         str::from_utf8(slice::from_raw_parts(ptr as *const u8, len)).unwrap()
 316     }
 317 }
 318
 319 pub fn target_cpu(sess: &Session) -> &str {
 320     let name = sess.opts.cg.target_cpu.as_ref().unwrap_or(&sess.target.cpu);
 321     handle_native(name)
 322 }
 323
 324 /// The list of LLVM features computed from CLI flags (`-Ctarget-cpu`, `-Ctarget-feature`,
 325 /// `--target` and similar).
 326 // FIXME(nagisa): Cache the output of this somehow? Maybe make this a query? We're calling this
 327 // for every function that has `#[target_feature]` on it. The global features won't change between
 328 // the functions; only crates, maybe…
 329 pub fn llvm_global_features(sess: &Session) -> Vec<String> {
 330     // FIXME(nagisa): this should definitely be available more centrally and to other codegen backends.
 331     /// These features control behaviour of rustc rather than llvm.
 332     const RUSTC_SPECIFIC_FEATURES: &[&str] = &["crt-static"];
 333
 334     // Features that come earlier are overriden by conflicting features later in the string.
 335     // Typically we'll want more explicit settings to override the implicit ones, so:
 336     //
 337     // * Features from -Ctarget-cpu=*; are overriden by [^1]
 338     // * Features implied by --target; are overriden by
 339     // * Features from -Ctarget-feature; are overriden by
 340     // * function specific features.
 341     //
 342     // [^1]: target-cpu=native is handled here, other target-cpu values are handled implicitly
 343     // through LLVM TargetMachine implementation.
 344     //
 345     // FIXME(nagisa): it isn't clear what's the best interaction between features implied by
 346     // `-Ctarget-cpu` and `--target` are. On one hand, you'd expect CLI arguments to always
 347     // override anything that's implicit, so e.g. when there's no `--target` flag, features implied
 348     // the host target are overriden by `-Ctarget-cpu=*`. On the other hand, what about when both
 349     // `--target` and `-Ctarget-cpu=*` are specified? Both then imply some target features and both
 350     // flags are specified by the user on the CLI. It isn't as clear-cut which order of precedence
 351     // should be taken in cases like these.
 352     let mut features = vec![];
 353
 354     // -Ctarget-cpu=native
 355     match sess.opts.cg.target_cpu {
 356         Some(ref s) if s == "native" => {
 357             let features_string = unsafe {
 358                 let ptr = llvm::LLVMGetHostCPUFeatures();
 359                 let features_string = if !ptr.is_null() {
 360                     CStr::from_ptr(ptr)
 361                         .to_str()
 362                         .unwrap_or_else(|e| {
 363                             bug!("LLVM returned a non-utf8 features string: {}", e);
 364                         })
 365                         .to_owned()
 366                 } else {
 367                     bug!("could not allocate host CPU features, LLVM returned a `null` string");
 368                 };
 369
 370                 llvm::LLVMDisposeMessage(ptr);
 371
 372                 features_string
 373             };
 374             features.extend(features_string.split(',').map(String::from));
 375         }
 376         Some(_) | None => {}
 377     };
 378
 379     let filter = |s: &str| {
 380         if s.is_empty() {
 381             return vec![];
 382         }
 383         let feature = if s.starts_with('+') || s.starts_with('-') {
 384             &s[1..]
 385         } else {
 386             return vec![s.to_string()];
 387         };
 388         // Rustc-specific feature requests like `+crt-static` or `-crt-static`
 389         // are not passed down to LLVM.
 390         if RUSTC_SPECIFIC_FEATURES.contains(&feature) {
 391             return vec![];
 392         }
 393         // ... otherwise though we run through `to_llvm_feature` feature when
 394         // passing requests down to LLVM. This means that all in-language
 395         // features also work on the command line instead of having two
 396         // different names when the LLVM name and the Rust name differ.
 397         to_llvm_feature(sess, feature).iter().map(|f| format!("{}{}", &s[..1], f)).collect()
 398     };
 399
 400     // Features implied by an implicit or explicit `--target`.
 401     features.extend(sess.target.features.split(',').flat_map(&filter));
 402
 403     // -Ctarget-features
 404     features.extend(sess.opts.cg.target_feature.split(',').flat_map(&filter));
 405
 406     features
 407 }
 408
 409 pub fn tune_cpu(sess: &Session) -> Option<&str> {
 410     let name = sess.opts.debugging_opts.tune_cpu.as_ref()?;
 411     Some(handle_native(name))
 412 }