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