1 use crate::back::write::create_informational_target_machine;
2 use crate::{llvm, llvm_util};
4 use rustc_codegen_ssa::target_features::supported_target_features;
5 use rustc_data_structures::fx::FxHashSet;
6 use rustc_metadata::dynamic_lib::DynamicLibrary;
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};
22 static INIT: Once = Once::new();
24 pub(crate) fn init(sess: &Session) {
26 // Before we touch LLVM, make sure that multithreading is enabled.
27 if llvm::LLVMIsMultithreaded() != 1 {
28 bug!("LLVM compiled without support for threads");
37 if !INIT.is_completed() {
38 bug!("LLVM is not initialized");
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);
47 llvm::LLVMRustInstallFatalErrorHandler();
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("")
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);
57 let user_specified_args: FxHashSet<_> =
58 sess_args.clone().map(|s| llvm_arg_to_arg_name(s)).filter(|s| !s.is_empty()).collect();
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());
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);
75 if sess.print_llvm_passes() {
76 add("-debug-pass=Structure", false);
78 if !sess.opts.debugging_opts.no_generate_arange_section {
79 add("-generate-arange-section", false);
82 // Disable the machine outliner by default in LLVM versions 11 and LLVM
83 // version 12, where it leads to miscompilation.
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);
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);
99 if sess.target.os == "emscripten" && sess.panic_strategy() == PanicStrategy::Unwind {
100 add("-enable-emscripten-cxx-exceptions", false);
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);
107 // Use non-zero `import-instr-limit` multiplier for cold callsites.
108 add("-import-cold-multiplier=0.1", false);
110 for arg in sess_args {
115 if sess.opts.debugging_opts.llvm_time_trace {
116 llvm::LLVMTimeTraceProfilerInitialize();
119 llvm::LLVMInitializePasses();
121 for plugin in &sess.opts.debugging_opts.llvm_plugins {
122 let path = Path::new(plugin);
123 let res = DynamicLibrary::open(path);
125 Ok(_) => debug!("LLVM plugin loaded succesfully {} ({})", path.display(), plugin),
126 Err(e) => bug!("couldn't load plugin: {}", e),
131 rustc_llvm::initialize_available_targets();
133 llvm::LLVMRustSetLLVMOptions(llvm_args.len() as c_int, llvm_args.as_ptr());
136 pub fn time_trace_profiler_finish(file_name: &str) {
138 let file_name = CString::new(file_name).unwrap();
139 llvm::LLVMTimeTraceProfilerFinish(file_name.as_ptr());
143 // WARNING: the features after applying `to_llvm_feature` must be known
144 // to LLVM or the feature detection code will walk past the end of the feature
145 // array, leading to crashes.
146 // To find a list of LLVM's names, check llvm-project/llvm/include/llvm/Support/*TargetParser.def
147 // where the * matches the architecture's name
148 // Beware to not use the llvm github project for this, but check the git submodule
149 // found in src/llvm-project
150 // Though note that Rust can also be build with an external precompiled version of LLVM
151 // which might lead to failures if the oldest tested / supported LLVM version
152 // doesn't yet support the relevant intrinsics
153 pub fn to_llvm_feature<'a>(sess: &Session, s: &'a str) -> Vec<&'a str> {
154 let arch = if sess.target.arch == "x86_64" { "x86" } else { &*sess.target.arch };
156 ("x86", "sse4.2") => {
157 if get_version() >= (14, 0, 0) {
158 vec!["sse4.2", "crc32"]
163 ("x86", "pclmulqdq") => vec!["pclmul"],
164 ("x86", "rdrand") => vec!["rdrnd"],
165 ("x86", "bmi1") => vec!["bmi"],
166 ("x86", "cmpxchg16b") => vec!["cx16"],
167 ("x86", "avx512vaes") => vec!["vaes"],
168 ("x86", "avx512gfni") => vec!["gfni"],
169 ("x86", "avx512vpclmulqdq") => vec!["vpclmulqdq"],
170 ("aarch64", "fp") => vec!["fp-armv8"],
171 ("aarch64", "fp16") => vec!["fullfp16"],
172 ("aarch64", "fhm") => vec!["fp16fml"],
173 ("aarch64", "rcpc2") => vec!["rcpc-immo"],
174 ("aarch64", "dpb") => vec!["ccpp"],
175 ("aarch64", "dpb2") => vec!["ccdp"],
176 ("aarch64", "frintts") => vec!["fptoint"],
177 ("aarch64", "fcma") => vec!["complxnum"],
178 ("aarch64", "pmuv3") => vec!["perfmon"],
183 pub fn target_features(sess: &Session) -> Vec<Symbol> {
184 let target_machine = create_informational_target_machine(sess);
185 supported_target_features(sess)
189 if sess.is_nightly_build() || gate.is_none() { Some(feature) } else { None }
193 for llvm_feature in to_llvm_feature(sess, feature) {
194 let cstr = CString::new(llvm_feature).unwrap();
195 if unsafe { llvm::LLVMRustHasFeature(target_machine, cstr.as_ptr()) } {
201 .map(|feature| Symbol::intern(feature))
205 pub fn print_version() {
206 let (major, minor, patch) = get_version();
207 println!("LLVM version: {}.{}.{}", major, minor, patch);
210 pub fn get_version() -> (u32, u32, u32) {
211 // Can be called without initializing LLVM
213 (llvm::LLVMRustVersionMajor(), llvm::LLVMRustVersionMinor(), llvm::LLVMRustVersionPatch())
217 pub fn print_passes() {
218 // Can be called without initializing LLVM
220 llvm::LLVMRustPrintPasses();
224 fn llvm_target_features(tm: &llvm::TargetMachine) -> Vec<(&str, &str)> {
225 let len = unsafe { llvm::LLVMRustGetTargetFeaturesCount(tm) };
226 let mut ret = Vec::with_capacity(len);
229 let mut feature = ptr::null();
230 let mut desc = ptr::null();
231 llvm::LLVMRustGetTargetFeature(tm, i, &mut feature, &mut desc);
232 if feature.is_null() || desc.is_null() {
233 bug!("LLVM returned a `null` target feature string");
235 let feature = CStr::from_ptr(feature).to_str().unwrap_or_else(|e| {
236 bug!("LLVM returned a non-utf8 feature string: {}", e);
238 let desc = CStr::from_ptr(desc).to_str().unwrap_or_else(|e| {
239 bug!("LLVM returned a non-utf8 feature string: {}", e);
241 ret.push((feature, desc));
247 fn print_target_features(sess: &Session, tm: &llvm::TargetMachine) {
248 let mut target_features = llvm_target_features(tm);
249 let mut rustc_target_features = supported_target_features(sess)
251 .filter_map(|(feature, _gate)| {
252 for llvm_feature in to_llvm_feature(sess, *feature) {
253 // LLVM asserts that these are sorted. LLVM and Rust both use byte comparison for these strings.
254 match target_features.binary_search_by_key(&llvm_feature, |(f, _d)| (*f)).ok().map(
256 let (_f, desc) = target_features.remove(index);
260 Some(v) => return Some(v),
266 .collect::<Vec<_>>();
267 rustc_target_features.extend_from_slice(&[(
269 "Enables C Run-time Libraries to be statically linked",
271 let max_feature_len = target_features
273 .chain(rustc_target_features.iter())
274 .map(|(feature, _desc)| feature.len())
278 println!("Features supported by rustc for this target:");
279 for (feature, desc) in &rustc_target_features {
280 println!(" {1:0$} - {2}.", max_feature_len, feature, desc);
282 println!("\nCode-generation features supported by LLVM for this target:");
283 for (feature, desc) in &target_features {
284 println!(" {1:0$} - {2}.", max_feature_len, feature, desc);
286 if target_features.is_empty() {
287 println!(" Target features listing is not supported by this LLVM version.");
289 println!("\nUse +feature to enable a feature, or -feature to disable it.");
290 println!("For example, rustc -C target-cpu=mycpu -C target-feature=+feature1,-feature2\n");
291 println!("Code-generation features cannot be used in cfg or #[target_feature],");
292 println!("and may be renamed or removed in a future version of LLVM or rustc.\n");
295 pub(crate) fn print(req: PrintRequest, sess: &Session) {
297 let tm = create_informational_target_machine(sess);
299 PrintRequest::TargetCPUs => unsafe { llvm::LLVMRustPrintTargetCPUs(tm) },
300 PrintRequest::TargetFeatures => print_target_features(sess, tm),
301 _ => bug!("rustc_codegen_llvm can't handle print request: {:?}", req),
305 fn handle_native(name: &str) -> &str {
306 if name != "native" {
312 let ptr = llvm::LLVMRustGetHostCPUName(&mut len);
313 str::from_utf8(slice::from_raw_parts(ptr as *const u8, len)).unwrap()
317 pub fn target_cpu(sess: &Session) -> &str {
318 let name = sess.opts.cg.target_cpu.as_ref().unwrap_or(&sess.target.cpu);
322 /// The list of LLVM features computed from CLI flags (`-Ctarget-cpu`, `-Ctarget-feature`,
323 /// `--target` and similar).
324 // FIXME(nagisa): Cache the output of this somehow? Maybe make this a query? We're calling this
325 // for every function that has `#[target_feature]` on it. The global features won't change between
326 // the functions; only crates, maybe…
327 pub fn llvm_global_features(sess: &Session) -> Vec<String> {
328 // FIXME(nagisa): this should definitely be available more centrally and to other codegen backends.
329 /// These features control behaviour of rustc rather than llvm.
330 const RUSTC_SPECIFIC_FEATURES: &[&str] = &["crt-static"];
332 // Features that come earlier are overriden by conflicting features later in the string.
333 // Typically we'll want more explicit settings to override the implicit ones, so:
335 // * Features from -Ctarget-cpu=*; are overriden by [^1]
336 // * Features implied by --target; are overriden by
337 // * Features from -Ctarget-feature; are overriden by
338 // * function specific features.
340 // [^1]: target-cpu=native is handled here, other target-cpu values are handled implicitly
341 // through LLVM TargetMachine implementation.
343 // FIXME(nagisa): it isn't clear what's the best interaction between features implied by
344 // `-Ctarget-cpu` and `--target` are. On one hand, you'd expect CLI arguments to always
345 // override anything that's implicit, so e.g. when there's no `--target` flag, features implied
346 // the host target are overriden by `-Ctarget-cpu=*`. On the other hand, what about when both
347 // `--target` and `-Ctarget-cpu=*` are specified? Both then imply some target features and both
348 // flags are specified by the user on the CLI. It isn't as clear-cut which order of precedence
349 // should be taken in cases like these.
350 let mut features = vec![];
352 // -Ctarget-cpu=native
353 match sess.opts.cg.target_cpu {
354 Some(ref s) if s == "native" => {
355 let features_string = unsafe {
356 let ptr = llvm::LLVMGetHostCPUFeatures();
357 let features_string = if !ptr.is_null() {
360 .unwrap_or_else(|e| {
361 bug!("LLVM returned a non-utf8 features string: {}", e);
365 bug!("could not allocate host CPU features, LLVM returned a `null` string");
368 llvm::LLVMDisposeMessage(ptr);
372 features.extend(features_string.split(',').map(String::from));
377 let filter = |s: &str| {
381 let feature = if s.starts_with('+') || s.starts_with('-') {
384 return vec![s.to_string()];
386 // Rustc-specific feature requests like `+crt-static` or `-crt-static`
387 // are not passed down to LLVM.
388 if RUSTC_SPECIFIC_FEATURES.contains(&feature) {
391 // ... otherwise though we run through `to_llvm_feature` feature when
392 // passing requests down to LLVM. This means that all in-language
393 // features also work on the command line instead of having two
394 // different names when the LLVM name and the Rust name differ.
395 to_llvm_feature(sess, feature).iter().map(|f| format!("{}{}", &s[..1], f)).collect()
398 // Features implied by an implicit or explicit `--target`.
399 features.extend(sess.target.features.split(',').flat_map(&filter));
402 features.extend(sess.opts.cg.target_feature.split(',').flat_map(&filter));
407 pub fn tune_cpu(sess: &Session) -> Option<&str> {
408 let name = sess.opts.debugging_opts.tune_cpu.as_ref()?;
409 Some(handle_native(name))