src/librustc_llvm/build.rs

   1 use std::env;
   2 use std::path::{Path, PathBuf};
   3 use std::process::Command;
   4
   5 use build_helper::{output, tracked_env_var_os};
   6
   7 fn detect_llvm_link() -> (&'static str, &'static str) {
   8     // Force the link mode we want, preferring static by default, but
   9     // possibly overridden by `configure --enable-llvm-link-shared`.
  10     if tracked_env_var_os("LLVM_LINK_SHARED").is_some() {
  11         ("dylib", "--link-shared")
  12     } else {
  13         ("static", "--link-static")
  14     }
  15 }
  16
  17 fn main() {
  18     if tracked_env_var_os("RUST_CHECK").is_some() {
  19         // If we're just running `check`, there's no need for LLVM to be built.
  20         return;
  21     }
  22
  23     build_helper::restore_library_path();
  24
  25     let target = env::var("TARGET").expect("TARGET was not set");
  26     let llvm_config =
  27         tracked_env_var_os("LLVM_CONFIG").map(|x| Some(PathBuf::from(x))).unwrap_or_else(|| {
  28             if let Some(dir) = tracked_env_var_os("CARGO_TARGET_DIR").map(PathBuf::from) {
  29                 let to_test = dir
  30                     .parent()
  31                     .unwrap()
  32                     .parent()
  33                     .unwrap()
  34                     .join(&target)
  35                     .join("llvm/bin/llvm-config");
  36                 if Command::new(&to_test).output().is_ok() {
  37                     return Some(to_test);
  38                 }
  39             }
  40             None
  41         });
  42
  43     if let Some(llvm_config) = &llvm_config {
  44         println!("cargo:rerun-if-changed={}", llvm_config.display());
  45     }
  46     let llvm_config = llvm_config.unwrap_or_else(|| PathBuf::from("llvm-config"));
  47
  48     // Test whether we're cross-compiling LLVM. This is a pretty rare case
  49     // currently where we're producing an LLVM for a different platform than
  50     // what this build script is currently running on.
  51     //
  52     // In that case, there's no guarantee that we can actually run the target,
  53     // so the build system works around this by giving us the LLVM_CONFIG for
  54     // the host platform. This only really works if the host LLVM and target
  55     // LLVM are compiled the same way, but for us that's typically the case.
  56     //
  57     // We *want* detect this cross compiling situation by asking llvm-config
  58     // what its host-target is. If that's not the TARGET, then we're cross
  59     // compiling. Unfortunately `llvm-config` seems either be buggy, or we're
  60     // misconfiguring it, because the `i686-pc-windows-gnu` build of LLVM will
  61     // report itself with a `--host-target` of `x86_64-pc-windows-gnu`. This
  62     // tricks us into thinking we're doing a cross build when we aren't, so
  63     // havoc ensues.
  64     //
  65     // In any case, if we're cross compiling, this generally just means that we
  66     // can't trust all the output of llvm-config because it might be targeted
  67     // for the host rather than the target. As a result a bunch of blocks below
  68     // are gated on `if !is_crossed`
  69     let target = env::var("TARGET").expect("TARGET was not set");
  70     let host = env::var("HOST").expect("HOST was not set");
  71     let is_crossed = target != host;
  72
  73     let mut optional_components = vec![
  74         "x86",
  75         "arm",
  76         "aarch64",
  77         "amdgpu",
  78         "avr",
  79         "mips",
  80         "powerpc",
  81         "systemz",
  82         "jsbackend",
  83         "webassembly",
  84         "msp430",
  85         "sparc",
  86         "nvptx",
  87         "hexagon",
  88     ];
  89
  90     let mut version_cmd = Command::new(&llvm_config);
  91     version_cmd.arg("--version");
  92     let version_output = output(&mut version_cmd);
  93     let mut parts = version_output.split('.').take(2).filter_map(|s| s.parse::<u32>().ok());
  94     let (major, _minor) = if let (Some(major), Some(minor)) = (parts.next(), parts.next()) {
  95         (major, minor)
  96     } else {
  97         (6, 0)
  98     };
  99
 100     if major > 6 {
 101         optional_components.push("riscv");
 102     }
 103
 104     let required_components = &[
 105         "ipo",
 106         "bitreader",
 107         "bitwriter",
 108         "linker",
 109         "asmparser",
 110         "lto",
 111         "coverage",
 112         "instrumentation",
 113     ];
 114
 115     let components = output(Command::new(&llvm_config).arg("--components"));
 116     let mut components = components.split_whitespace().collect::<Vec<_>>();
 117     components.retain(|c| optional_components.contains(c) || required_components.contains(c));
 118
 119     for component in required_components {
 120         if !components.contains(component) {
 121             panic!("require llvm component {} but wasn't found", component);
 122         }
 123     }
 124
 125     for component in components.iter() {
 126         println!("cargo:rustc-cfg=llvm_component=\"{}\"", component);
 127     }
 128
 129     if major >= 9 {
 130         println!("cargo:rustc-cfg=llvm_has_msp430_asm_parser");
 131     }
 132
 133     // Link in our own LLVM shims, compiled with the same flags as LLVM
 134     let mut cmd = Command::new(&llvm_config);
 135     cmd.arg("--cxxflags");
 136     let cxxflags = output(&mut cmd);
 137     let mut cfg = cc::Build::new();
 138     cfg.warnings(false);
 139     for flag in cxxflags.split_whitespace() {
 140         // Ignore flags like `-m64` when we're doing a cross build
 141         if is_crossed && flag.starts_with("-m") {
 142             continue;
 143         }
 144
 145         if flag.starts_with("-flto") {
 146             continue;
 147         }
 148
 149         // -Wdate-time is not supported by the netbsd cross compiler
 150         if is_crossed && target.contains("netbsd") && flag.contains("date-time") {
 151             continue;
 152         }
 153
 154         // Include path contains host directory, replace it with target
 155         if is_crossed && flag.starts_with("-I") {
 156             cfg.flag(&flag.replace(&host, &target));
 157             continue;
 158         }
 159
 160         cfg.flag(flag);
 161     }
 162
 163     for component in &components {
 164         let mut flag = String::from("LLVM_COMPONENT_");
 165         flag.push_str(&component.to_uppercase());
 166         cfg.define(&flag, None);
 167     }
 168
 169     if tracked_env_var_os("LLVM_RUSTLLVM").is_some() {
 170         cfg.define("LLVM_RUSTLLVM", None);
 171     }
 172
 173     if tracked_env_var_os("LLVM_NDEBUG").is_some() {
 174         cfg.define("NDEBUG", None);
 175         cfg.debug(false);
 176     }
 177
 178     build_helper::rerun_if_changed_anything_in_dir(Path::new("../rustllvm"));
 179     cfg.file("../rustllvm/PassWrapper.cpp")
 180         .file("../rustllvm/RustWrapper.cpp")
 181         .file("../rustllvm/ArchiveWrapper.cpp")
 182         .file("../rustllvm/CoverageMappingWrapper.cpp")
 183         .file("../rustllvm/Linker.cpp")
 184         .cpp(true)
 185         .cpp_link_stdlib(None) // we handle this below
 186         .compile("rustllvm");
 187
 188     let (llvm_kind, llvm_link_arg) = detect_llvm_link();
 189
 190     // Link in all LLVM libraries, if we're using the "wrong" llvm-config then
 191     // we don't pick up system libs because unfortunately they're for the host
 192     // of llvm-config, not the target that we're attempting to link.
 193     let mut cmd = Command::new(&llvm_config);
 194     cmd.arg(llvm_link_arg).arg("--libs");
 195
 196     if !is_crossed {
 197         cmd.arg("--system-libs");
 198     } else if target.contains("windows-gnu") {
 199         println!("cargo:rustc-link-lib=shell32");
 200         println!("cargo:rustc-link-lib=uuid");
 201     }
 202     cmd.args(&components);
 203
 204     for lib in output(&mut cmd).split_whitespace() {
 205         let name = if lib.starts_with("-l") {
 206             &lib[2..]
 207         } else if lib.starts_with('-') {
 208             &lib[1..]
 209         } else if Path::new(lib).exists() {
 210             // On MSVC llvm-config will print the full name to libraries, but
 211             // we're only interested in the name part
 212             let name = Path::new(lib).file_name().unwrap().to_str().unwrap();
 213             name.trim_end_matches(".lib")
 214         } else if lib.ends_with(".lib") {
 215             // Some MSVC libraries just come up with `.lib` tacked on, so chop
 216             // that off
 217             lib.trim_end_matches(".lib")
 218         } else {
 219             continue;
 220         };
 221
 222         // Don't need or want this library, but LLVM's CMake build system
 223         // doesn't provide a way to disable it, so filter it here even though we
 224         // may or may not have built it. We don't reference anything from this
 225         // library and it otherwise may just pull in extra dependencies on
 226         // libedit which we don't want
 227         if name == "LLVMLineEditor" {
 228             continue;
 229         }
 230
 231         let kind = if name.starts_with("LLVM") { llvm_kind } else { "dylib" };
 232         println!("cargo:rustc-link-lib={}={}", kind, name);
 233     }
 234
 235     // LLVM ldflags
 236     //
 237     // If we're a cross-compile of LLVM then unfortunately we can't trust these
 238     // ldflags (largely where all the LLVM libs are located). Currently just
 239     // hack around this by replacing the host triple with the target and pray
 240     // that those -L directories are the same!
 241     let mut cmd = Command::new(&llvm_config);
 242     cmd.arg(llvm_link_arg).arg("--ldflags");
 243     for lib in output(&mut cmd).split_whitespace() {
 244         if is_crossed {
 245             if lib.starts_with("-LIBPATH:") {
 246                 println!("cargo:rustc-link-search=native={}", lib[9..].replace(&host, &target));
 247             } else if lib.starts_with("-L") {
 248                 println!("cargo:rustc-link-search=native={}", lib[2..].replace(&host, &target));
 249             }
 250         } else if lib.starts_with("-LIBPATH:") {
 251             println!("cargo:rustc-link-search=native={}", &lib[9..]);
 252         } else if lib.starts_with("-l") {
 253             println!("cargo:rustc-link-lib={}", &lib[2..]);
 254         } else if lib.starts_with("-L") {
 255             println!("cargo:rustc-link-search=native={}", &lib[2..]);
 256         }
 257     }
 258
 259     // Some LLVM linker flags (-L and -l) may be needed even when linking
 260     // librustc_llvm, for example when using static libc++, we may need to
 261     // manually specify the library search path and -ldl -lpthread as link
 262     // dependencies.
 263     let llvm_linker_flags = tracked_env_var_os("LLVM_LINKER_FLAGS");
 264     if let Some(s) = llvm_linker_flags {
 265         for lib in s.into_string().unwrap().split_whitespace() {
 266             if lib.starts_with("-l") {
 267                 println!("cargo:rustc-link-lib={}", &lib[2..]);
 268             } else if lib.starts_with("-L") {
 269                 println!("cargo:rustc-link-search=native={}", &lib[2..]);
 270             }
 271         }
 272     }
 273
 274     let llvm_static_stdcpp = tracked_env_var_os("LLVM_STATIC_STDCPP");
 275     let llvm_use_libcxx = tracked_env_var_os("LLVM_USE_LIBCXX");
 276
 277     let stdcppname = if target.contains("openbsd") {
 278         if target.contains("sparc64") { "estdc++" } else { "c++" }
 279     } else if target.contains("freebsd") {
 280         "c++"
 281     } else if target.contains("darwin") {
 282         "c++"
 283     } else if target.contains("netbsd") && llvm_static_stdcpp.is_some() {
 284         // NetBSD uses a separate library when relocation is required
 285         "stdc++_pic"
 286     } else if llvm_use_libcxx.is_some() {
 287         "c++"
 288     } else {
 289         "stdc++"
 290     };
 291
 292     // RISC-V requires libatomic for sub-word atomic operations
 293     if target.starts_with("riscv") {
 294         println!("cargo:rustc-link-lib=atomic");
 295     }
 296
 297     // C++ runtime library
 298     if !target.contains("msvc") {
 299         if let Some(s) = llvm_static_stdcpp {
 300             assert!(!cxxflags.contains("stdlib=libc++"));
 301             let path = PathBuf::from(s);
 302             println!("cargo:rustc-link-search=native={}", path.parent().unwrap().display());
 303             if target.contains("windows") {
 304                 println!("cargo:rustc-link-lib=static-nobundle={}", stdcppname);
 305             } else {
 306                 println!("cargo:rustc-link-lib=static={}", stdcppname);
 307             }
 308         } else if cxxflags.contains("stdlib=libc++") {
 309             println!("cargo:rustc-link-lib=c++");
 310         } else {
 311             println!("cargo:rustc-link-lib={}", stdcppname);
 312         }
 313     }
 314
 315     // Libstdc++ depends on pthread which Rust doesn't link on MinGW
 316     // since nothing else requires it.
 317     if target.contains("windows-gnu") {
 318         println!("cargo:rustc-link-lib=static-nobundle=pthread");
 319     }
 320 }