src/librustc_llvm/build.rs

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