src/bootstrap/native.rs

   1 //! Compilation of native dependencies like LLVM.
   2 //!
   3 //! Native projects like LLVM unfortunately aren't suited just yet for
   4 //! compilation in build scripts that Cargo has. This is because the
   5 //! compilation takes a *very* long time but also because we don't want to
   6 //! compile LLVM 3 times as part of a normal bootstrap (we want it cached).
   7 //!
   8 //! LLVM and compiler-rt are essentially just wired up to everything else to
   9 //! ensure that they're always in place if needed.
  10
  11 use std::env;
  12 use std::env::consts::EXE_EXTENSION;
  13 use std::ffi::OsString;
  14 use std::fs::{self, File};
  15 use std::io;
  16 use std::path::{Path, PathBuf};
  17 use std::process::Command;
  18
  19 use build_helper::{output, t};
  20
  21 use crate::builder::{Builder, RunConfig, ShouldRun, Step};
  22 use crate::channel;
  23 use crate::config::TargetSelection;
  24 use crate::util::{self, exe};
  25 use crate::GitRepo;
  26 use build_helper::up_to_date;
  27
  28 pub struct Meta {
  29     stamp: HashStamp,
  30     build_llvm_config: PathBuf,
  31     out_dir: PathBuf,
  32     root: String,
  33 }
  34
  35 // This returns whether we've already previously built LLVM.
  36 //
  37 // It's used to avoid busting caches during x.py check -- if we've already built
  38 // LLVM, it's fine for us to not try to avoid doing so.
  39 //
  40 // This will return the llvm-config if it can get it (but it will not build it
  41 // if not).
  42 pub fn prebuilt_llvm_config(
  43     builder: &Builder<'_>,
  44     target: TargetSelection,
  45 ) -> Result<PathBuf, Meta> {
  46     // If we're using a custom LLVM bail out here, but we can only use a
  47     // custom LLVM for the build triple.
  48     if let Some(config) = builder.config.target_config.get(&target) {
  49         if let Some(ref s) = config.llvm_config {
  50             check_llvm_version(builder, s);
  51             return Ok(s.to_path_buf());
  52         }
  53     }
  54
  55     let root = "src/llvm-project/llvm";
  56     let out_dir = builder.llvm_out(target);
  57
  58     let mut llvm_config_ret_dir = builder.llvm_out(builder.config.build);
  59     if !builder.config.build.contains("msvc") || builder.ninja() {
  60         llvm_config_ret_dir.push("build");
  61     }
  62     llvm_config_ret_dir.push("bin");
  63
  64     let build_llvm_config = llvm_config_ret_dir.join(exe("llvm-config", builder.config.build));
  65
  66     let stamp = out_dir.join("llvm-finished-building");
  67     let stamp = HashStamp::new(stamp, builder.in_tree_llvm_info.sha());
  68
  69     if builder.config.llvm_skip_rebuild && stamp.path.exists() {
  70         builder.info(
  71             "Warning: \
  72                 Using a potentially stale build of LLVM; \
  73                 This may not behave well.",
  74         );
  75         return Ok(build_llvm_config);
  76     }
  77
  78     if stamp.is_done() {
  79         if stamp.hash.is_none() {
  80             builder.info(
  81                 "Could not determine the LLVM submodule commit hash. \
  82                      Assuming that an LLVM rebuild is not necessary.",
  83             );
  84             builder.info(&format!(
  85                 "To force LLVM to rebuild, remove the file `{}`",
  86                 stamp.path.display()
  87             ));
  88         }
  89         return Ok(build_llvm_config);
  90     }
  91
  92     Err(Meta { stamp, build_llvm_config, out_dir, root: root.into() })
  93 }
  94
  95 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
  96 pub struct Llvm {
  97     pub target: TargetSelection,
  98 }
  99
 100 impl Step for Llvm {
 101     type Output = PathBuf; // path to llvm-config
 102
 103     const ONLY_HOSTS: bool = true;
 104
 105     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 106         run.path("src/llvm-project").path("src/llvm-project/llvm").path("src/llvm")
 107     }
 108
 109     fn make_run(run: RunConfig<'_>) {
 110         run.builder.ensure(Llvm { target: run.target });
 111     }
 112
 113     /// Compile LLVM for `target`.
 114     fn run(self, builder: &Builder<'_>) -> PathBuf {
 115         let target = self.target;
 116         let target_native = if self.target.starts_with("riscv") {
 117             // RISC-V target triples in Rust is not named the same as C compiler target triples.
 118             // This converts Rust RISC-V target triples to C compiler triples.
 119             let idx = target.triple.find('-').unwrap();
 120
 121             format!("riscv{}{}", &target.triple[5..7], &target.triple[idx..])
 122         } else {
 123             target.to_string()
 124         };
 125
 126         let Meta { stamp, build_llvm_config, out_dir, root } =
 127             match prebuilt_llvm_config(builder, target) {
 128                 Ok(p) => return p,
 129                 Err(m) => m,
 130             };
 131
 132         builder.info(&format!("Building LLVM for {}", target));
 133         t!(stamp.remove());
 134         let _time = util::timeit(&builder);
 135         t!(fs::create_dir_all(&out_dir));
 136
 137         // http://llvm.org/docs/CMake.html
 138         let mut cfg = cmake::Config::new(builder.src.join(root));
 139
 140         let profile = match (builder.config.llvm_optimize, builder.config.llvm_release_debuginfo) {
 141             (false, _) => "Debug",
 142             (true, false) => "Release",
 143             (true, true) => "RelWithDebInfo",
 144         };
 145
 146         // NOTE: remember to also update `config.toml.example` when changing the
 147         // defaults!
 148         let llvm_targets = match &builder.config.llvm_targets {
 149             Some(s) => s,
 150             None => {
 151                 "AArch64;ARM;Hexagon;MSP430;Mips;NVPTX;PowerPC;RISCV;\
 152                      Sparc;SystemZ;WebAssembly;X86"
 153             }
 154         };
 155
 156         let llvm_exp_targets = match builder.config.llvm_experimental_targets {
 157             Some(ref s) => s,
 158             None => "AVR",
 159         };
 160
 161         let assertions = if builder.config.llvm_assertions { "ON" } else { "OFF" };
 162
 163         cfg.out_dir(&out_dir)
 164             .profile(profile)
 165             .define("LLVM_ENABLE_ASSERTIONS", assertions)
 166             .define("LLVM_TARGETS_TO_BUILD", llvm_targets)
 167             .define("LLVM_EXPERIMENTAL_TARGETS_TO_BUILD", llvm_exp_targets)
 168             .define("LLVM_INCLUDE_EXAMPLES", "OFF")
 169             .define("LLVM_INCLUDE_TESTS", "OFF")
 170             .define("LLVM_INCLUDE_DOCS", "OFF")
 171             .define("LLVM_INCLUDE_BENCHMARKS", "OFF")
 172             .define("WITH_POLLY", "OFF")
 173             .define("LLVM_ENABLE_TERMINFO", "OFF")
 174             .define("LLVM_ENABLE_LIBEDIT", "OFF")
 175             .define("LLVM_ENABLE_BINDINGS", "OFF")
 176             .define("LLVM_ENABLE_Z3_SOLVER", "OFF")
 177             .define("LLVM_PARALLEL_COMPILE_JOBS", builder.jobs().to_string())
 178             .define("LLVM_TARGET_ARCH", target_native.split('-').next().unwrap())
 179             .define("LLVM_DEFAULT_TARGET_TRIPLE", target_native);
 180
 181         if target != "aarch64-apple-darwin" {
 182             cfg.define("LLVM_ENABLE_ZLIB", "ON");
 183         } else {
 184             cfg.define("LLVM_ENABLE_ZLIB", "OFF");
 185         }
 186
 187         // Are we compiling for iOS/tvOS?
 188         if target.contains("apple-ios") || target.contains("apple-tvos") {
 189             // These two defines prevent CMake from automatically trying to add a MacOSX sysroot, which leads to a compiler error.
 190             cfg.define("CMAKE_OSX_SYSROOT", "/");
 191             cfg.define("CMAKE_OSX_DEPLOYMENT_TARGET", "");
 192             // Prevent cmake from adding -bundle to CFLAGS automatically, which leads to a compiler error because "-bitcode_bundle" also gets added.
 193             cfg.define("LLVM_ENABLE_PLUGINS", "OFF");
 194             // Zlib fails to link properly, leading to a compiler error.
 195             cfg.define("LLVM_ENABLE_ZLIB", "OFF");
 196         }
 197
 198         if builder.config.llvm_thin_lto {
 199             cfg.define("LLVM_ENABLE_LTO", "Thin");
 200             if !target.contains("apple") {
 201                 cfg.define("LLVM_ENABLE_LLD", "ON");
 202             }
 203         }
 204
 205         // This setting makes the LLVM tools link to the dynamic LLVM library,
 206         // which saves both memory during parallel links and overall disk space
 207         // for the tools. We don't do this on every platform as it doesn't work
 208         // equally well everywhere.
 209         if builder.llvm_link_tools_dynamically(target) {
 210             cfg.define("LLVM_LINK_LLVM_DYLIB", "ON");
 211         }
 212
 213         // For distribution we want the LLVM tools to be *statically* linked to libstdc++
 214         if builder.config.llvm_tools_enabled {
 215             if !target.contains("msvc") {
 216                 if target.contains("apple") {
 217                     cfg.define("CMAKE_EXE_LINKER_FLAGS", "-static-libstdc++");
 218                 } else {
 219                     cfg.define("CMAKE_EXE_LINKER_FLAGS", "-Wl,-Bsymbolic -static-libstdc++");
 220                 }
 221             }
 222         }
 223
 224         if target.starts_with("riscv") {
 225             // In RISC-V, using C++ atomics require linking to `libatomic` but the LLVM build
 226             // system check cannot detect this. Therefore it is set manually here.
 227             if !builder.config.llvm_tools_enabled {
 228                 cfg.define("CMAKE_EXE_LINKER_FLAGS", "-latomic");
 229             } else {
 230                 cfg.define("CMAKE_EXE_LINKER_FLAGS", "-latomic -static-libstdc++");
 231             }
 232             cfg.define("CMAKE_SHARED_LINKER_FLAGS", "-latomic");
 233         }
 234
 235         if target.contains("msvc") {
 236             cfg.define("LLVM_USE_CRT_DEBUG", "MT");
 237             cfg.define("LLVM_USE_CRT_RELEASE", "MT");
 238             cfg.define("LLVM_USE_CRT_RELWITHDEBINFO", "MT");
 239             cfg.static_crt(true);
 240         }
 241
 242         if target.starts_with("i686") {
 243             cfg.define("LLVM_BUILD_32_BITS", "ON");
 244         }
 245
 246         let mut enabled_llvm_projects = Vec::new();
 247
 248         if util::forcing_clang_based_tests() {
 249             enabled_llvm_projects.push("clang");
 250             enabled_llvm_projects.push("compiler-rt");
 251         }
 252
 253         // We want libxml to be disabled.
 254         // See https://github.com/rust-lang/rust/pull/50104
 255         cfg.define("LLVM_ENABLE_LIBXML2", "OFF");
 256
 257         if !enabled_llvm_projects.is_empty() {
 258             enabled_llvm_projects.sort();
 259             enabled_llvm_projects.dedup();
 260             cfg.define("LLVM_ENABLE_PROJECTS", enabled_llvm_projects.join(";"));
 261         }
 262
 263         if let Some(num_linkers) = builder.config.llvm_link_jobs {
 264             if num_linkers > 0 {
 265                 cfg.define("LLVM_PARALLEL_LINK_JOBS", num_linkers.to_string());
 266             }
 267         }
 268
 269         // http://llvm.org/docs/HowToCrossCompileLLVM.html
 270         if target != builder.config.build {
 271             builder.ensure(Llvm { target: builder.config.build });
 272             // FIXME: if the llvm root for the build triple is overridden then we
 273             //        should use llvm-tblgen from there, also should verify that it
 274             //        actually exists most of the time in normal installs of LLVM.
 275             let host_bin = builder.llvm_out(builder.config.build).join("bin");
 276             cfg.define("CMAKE_CROSSCOMPILING", "True");
 277             cfg.define("LLVM_TABLEGEN", host_bin.join("llvm-tblgen").with_extension(EXE_EXTENSION));
 278             cfg.define("LLVM_NM", host_bin.join("llvm-nm").with_extension(EXE_EXTENSION));
 279             cfg.define(
 280                 "LLVM_CONFIG_PATH",
 281                 host_bin.join("llvm-config").with_extension(EXE_EXTENSION),
 282             );
 283         }
 284
 285         if let Some(ref suffix) = builder.config.llvm_version_suffix {
 286             // Allow version-suffix="" to not define a version suffix at all.
 287             if !suffix.is_empty() {
 288                 cfg.define("LLVM_VERSION_SUFFIX", suffix);
 289             }
 290         } else if builder.config.channel == "dev" {
 291             // Changes to a version suffix require a complete rebuild of the LLVM.
 292             // To avoid rebuilds during a time of version bump, don't include rustc
 293             // release number on the dev channel.
 294             cfg.define("LLVM_VERSION_SUFFIX", "-rust-dev");
 295         } else {
 296             let suffix = format!("-rust-{}-{}", channel::CFG_RELEASE_NUM, builder.config.channel);
 297             cfg.define("LLVM_VERSION_SUFFIX", suffix);
 298         }
 299
 300         if let Some(ref linker) = builder.config.llvm_use_linker {
 301             cfg.define("LLVM_USE_LINKER", linker);
 302         }
 303
 304         if let Some(true) = builder.config.llvm_allow_old_toolchain {
 305             cfg.define("LLVM_TEMPORARILY_ALLOW_OLD_TOOLCHAIN", "YES");
 306         }
 307
 308         if let Some(ref python) = builder.config.python {
 309             cfg.define("PYTHON_EXECUTABLE", python);
 310         }
 311
 312         configure_cmake(builder, target, &mut cfg, true);
 313
 314         // FIXME: we don't actually need to build all LLVM tools and all LLVM
 315         //        libraries here, e.g., we just want a few components and a few
 316         //        tools. Figure out how to filter them down and only build the right
 317         //        tools and libs on all platforms.
 318
 319         if builder.config.dry_run {
 320             return build_llvm_config;
 321         }
 322
 323         cfg.build();
 324
 325         t!(stamp.write());
 326
 327         build_llvm_config
 328     }
 329 }
 330
 331 fn check_llvm_version(builder: &Builder<'_>, llvm_config: &Path) {
 332     if !builder.config.llvm_version_check {
 333         return;
 334     }
 335
 336     if builder.config.dry_run {
 337         return;
 338     }
 339
 340     let mut cmd = Command::new(llvm_config);
 341     let version = output(cmd.arg("--version"));
 342     let mut parts = version.split('.').take(2).filter_map(|s| s.parse::<u32>().ok());
 343     if let (Some(major), Some(_minor)) = (parts.next(), parts.next()) {
 344         if major >= 8 {
 345             return;
 346         }
 347     }
 348     panic!("\n\nbad LLVM version: {}, need >=8.0\n\n", version)
 349 }
 350
 351 fn configure_cmake(
 352     builder: &Builder<'_>,
 353     target: TargetSelection,
 354     cfg: &mut cmake::Config,
 355     use_compiler_launcher: bool,
 356 ) {
 357     // Do not print installation messages for up-to-date files.
 358     // LLVM and LLD builds can produce a lot of those and hit CI limits on log size.
 359     cfg.define("CMAKE_INSTALL_MESSAGE", "LAZY");
 360
 361     // Do not allow the user's value of DESTDIR to influence where
 362     // LLVM will install itself. LLVM must always be installed in our
 363     // own build directories.
 364     cfg.env("DESTDIR", "");
 365
 366     if builder.ninja() {
 367         cfg.generator("Ninja");
 368     }
 369     cfg.target(&target.triple).host(&builder.config.build.triple);
 370
 371     if target != builder.config.build {
 372         if target.contains("netbsd") {
 373             cfg.define("CMAKE_SYSTEM_NAME", "NetBSD");
 374         } else if target.contains("freebsd") {
 375             cfg.define("CMAKE_SYSTEM_NAME", "FreeBSD");
 376         } else if target.contains("windows") {
 377             cfg.define("CMAKE_SYSTEM_NAME", "Windows");
 378         }
 379         // When cross-compiling we should also set CMAKE_SYSTEM_VERSION, but in
 380         // that case like CMake we cannot easily determine system version either.
 381         //
 382         // Since, the LLVM itself makes rather limited use of version checks in
 383         // CMakeFiles (and then only in tests), and so far no issues have been
 384         // reported, the system version is currently left unset.
 385     }
 386
 387     let sanitize_cc = |cc: &Path| {
 388         if target.contains("msvc") {
 389             OsString::from(cc.to_str().unwrap().replace("\\", "/"))
 390         } else {
 391             cc.as_os_str().to_owned()
 392         }
 393     };
 394
 395     // MSVC with CMake uses msbuild by default which doesn't respect these
 396     // vars that we'd otherwise configure. In that case we just skip this
 397     // entirely.
 398     if target.contains("msvc") && !builder.ninja() {
 399         return;
 400     }
 401
 402     let (cc, cxx) = match builder.config.llvm_clang_cl {
 403         Some(ref cl) => (cl.as_ref(), cl.as_ref()),
 404         None => (builder.cc(target), builder.cxx(target).unwrap()),
 405     };
 406
 407     // Handle msvc + ninja + ccache specially (this is what the bots use)
 408     if target.contains("msvc") && builder.ninja() && builder.config.ccache.is_some() {
 409         let mut wrap_cc = env::current_exe().expect("failed to get cwd");
 410         wrap_cc.set_file_name("sccache-plus-cl.exe");
 411
 412         cfg.define("CMAKE_C_COMPILER", sanitize_cc(&wrap_cc))
 413             .define("CMAKE_CXX_COMPILER", sanitize_cc(&wrap_cc));
 414         cfg.env("SCCACHE_PATH", builder.config.ccache.as_ref().unwrap())
 415             .env("SCCACHE_TARGET", target.triple)
 416             .env("SCCACHE_CC", &cc)
 417             .env("SCCACHE_CXX", &cxx);
 418
 419         // Building LLVM on MSVC can be a little ludicrous at times. We're so far
 420         // off the beaten path here that I'm not really sure this is even half
 421         // supported any more. Here we're trying to:
 422         //
 423         // * Build LLVM on MSVC
 424         // * Build LLVM with `clang-cl` instead of `cl.exe`
 425         // * Build a project with `sccache`
 426         // * Build for 32-bit as well
 427         // * Build with Ninja
 428         //
 429         // For `cl.exe` there are different binaries to compile 32/64 bit which
 430         // we use but for `clang-cl` there's only one which internally
 431         // multiplexes via flags. As a result it appears that CMake's detection
 432         // of a compiler's architecture and such on MSVC **doesn't** pass any
 433         // custom flags we pass in CMAKE_CXX_FLAGS below. This means that if we
 434         // use `clang-cl.exe` it's always diagnosed as a 64-bit compiler which
 435         // definitely causes problems since all the env vars are pointing to
 436         // 32-bit libraries.
 437         //
 438         // To hack around this... again... we pass an argument that's
 439         // unconditionally passed in the sccache shim. This'll get CMake to
 440         // correctly diagnose it's doing a 32-bit compilation and LLVM will
 441         // internally configure itself appropriately.
 442         if builder.config.llvm_clang_cl.is_some() && target.contains("i686") {
 443             cfg.env("SCCACHE_EXTRA_ARGS", "-m32");
 444         }
 445     } else {
 446         // If ccache is configured we inform the build a little differently how
 447         // to invoke ccache while also invoking our compilers.
 448         if use_compiler_launcher {
 449             if let Some(ref ccache) = builder.config.ccache {
 450                 cfg.define("CMAKE_C_COMPILER_LAUNCHER", ccache)
 451                     .define("CMAKE_CXX_COMPILER_LAUNCHER", ccache);
 452             }
 453         }
 454         cfg.define("CMAKE_C_COMPILER", sanitize_cc(cc))
 455             .define("CMAKE_CXX_COMPILER", sanitize_cc(cxx))
 456             .define("CMAKE_ASM_COMPILER", sanitize_cc(cc));
 457     }
 458
 459     cfg.build_arg("-j").build_arg(builder.jobs().to_string());
 460     let mut cflags = builder.cflags(target, GitRepo::Llvm).join(" ");
 461     if let Some(ref s) = builder.config.llvm_cflags {
 462         cflags.push_str(&format!(" {}", s));
 463     }
 464     // Some compiler features used by LLVM (such as thread locals) will not work on a min version below iOS 10.
 465     if target.contains("apple-ios") {
 466         if target.contains("86-") {
 467             cflags.push_str(" -miphonesimulator-version-min=10.0");
 468         } else {
 469             cflags.push_str(" -miphoneos-version-min=10.0");
 470         }
 471     }
 472     if builder.config.llvm_clang_cl.is_some() {
 473         cflags.push_str(&format!(" --target={}", target))
 474     }
 475     cfg.define("CMAKE_C_FLAGS", cflags);
 476     let mut cxxflags = builder.cflags(target, GitRepo::Llvm).join(" ");
 477     if builder.config.llvm_static_stdcpp && !target.contains("msvc") && !target.contains("netbsd") {
 478         cxxflags.push_str(" -static-libstdc++");
 479     }
 480     if let Some(ref s) = builder.config.llvm_cxxflags {
 481         cxxflags.push_str(&format!(" {}", s));
 482     }
 483     if builder.config.llvm_clang_cl.is_some() {
 484         cxxflags.push_str(&format!(" --target={}", target))
 485     }
 486     cfg.define("CMAKE_CXX_FLAGS", cxxflags);
 487     if let Some(ar) = builder.ar(target) {
 488         if ar.is_absolute() {
 489             // LLVM build breaks if `CMAKE_AR` is a relative path, for some reason it
 490             // tries to resolve this path in the LLVM build directory.
 491             cfg.define("CMAKE_AR", sanitize_cc(ar));
 492         }
 493     }
 494
 495     if let Some(ranlib) = builder.ranlib(target) {
 496         if ranlib.is_absolute() {
 497             // LLVM build breaks if `CMAKE_RANLIB` is a relative path, for some reason it
 498             // tries to resolve this path in the LLVM build directory.
 499             cfg.define("CMAKE_RANLIB", sanitize_cc(ranlib));
 500         }
 501     }
 502
 503     if let Some(ref s) = builder.config.llvm_ldflags {
 504         cfg.define("CMAKE_SHARED_LINKER_FLAGS", s);
 505         cfg.define("CMAKE_MODULE_LINKER_FLAGS", s);
 506         cfg.define("CMAKE_EXE_LINKER_FLAGS", s);
 507     }
 508
 509     if env::var_os("SCCACHE_ERROR_LOG").is_some() {
 510         cfg.env("RUSTC_LOG", "sccache=warn");
 511     }
 512 }
 513
 514 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 515 pub struct Lld {
 516     pub target: TargetSelection,
 517 }
 518
 519 impl Step for Lld {
 520     type Output = PathBuf;
 521     const ONLY_HOSTS: bool = true;
 522
 523     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 524         run.path("src/llvm-project/lld").path("src/tools/lld")
 525     }
 526
 527     fn make_run(run: RunConfig<'_>) {
 528         run.builder.ensure(Lld { target: run.target });
 529     }
 530
 531     /// Compile LLD for `target`.
 532     fn run(self, builder: &Builder<'_>) -> PathBuf {
 533         if builder.config.dry_run {
 534             return PathBuf::from("lld-out-dir-test-gen");
 535         }
 536         let target = self.target;
 537
 538         let llvm_config = builder.ensure(Llvm { target: self.target });
 539
 540         let out_dir = builder.lld_out(target);
 541         let done_stamp = out_dir.join("lld-finished-building");
 542         if done_stamp.exists() {
 543             return out_dir;
 544         }
 545
 546         builder.info(&format!("Building LLD for {}", target));
 547         let _time = util::timeit(&builder);
 548         t!(fs::create_dir_all(&out_dir));
 549
 550         let mut cfg = cmake::Config::new(builder.src.join("src/llvm-project/lld"));
 551         configure_cmake(builder, target, &mut cfg, true);
 552
 553         // This is an awful, awful hack. Discovered when we migrated to using
 554         // clang-cl to compile LLVM/LLD it turns out that LLD, when built out of
 555         // tree, will execute `llvm-config --cmakedir` and then tell CMake about
 556         // that directory for later processing. Unfortunately if this path has
 557         // forward slashes in it (which it basically always does on Windows)
 558         // then CMake will hit a syntax error later on as... something isn't
 559         // escaped it seems?
 560         //
 561         // Instead of attempting to fix this problem in upstream CMake and/or
 562         // LLVM/LLD we just hack around it here. This thin wrapper will take the
 563         // output from llvm-config and replace all instances of `\` with `/` to
 564         // ensure we don't hit the same bugs with escaping. It means that you
 565         // can't build on a system where your paths require `\` on Windows, but
 566         // there's probably a lot of reasons you can't do that other than this.
 567         let llvm_config_shim = env::current_exe().unwrap().with_file_name("llvm-config-wrapper");
 568
 569         cfg.out_dir(&out_dir)
 570             .profile("Release")
 571             .env("LLVM_CONFIG_REAL", &llvm_config)
 572             .define("LLVM_CONFIG_PATH", llvm_config_shim)
 573             .define("LLVM_INCLUDE_TESTS", "OFF");
 574
 575         // While we're using this horrible workaround to shim the execution of
 576         // llvm-config, let's just pile on more. I can't seem to figure out how
 577         // to build LLD as a standalone project and also cross-compile it at the
 578         // same time. It wants a natively executable `llvm-config` to learn
 579         // about LLVM, but then it learns about all the host configuration of
 580         // LLVM and tries to link to host LLVM libraries.
 581         //
 582         // To work around that we tell our shim to replace anything with the
 583         // build target with the actual target instead. This'll break parts of
 584         // LLD though which try to execute host tools, such as llvm-tblgen, so
 585         // we specifically tell it where to find those. This is likely super
 586         // brittle and will break over time. If anyone knows better how to
 587         // cross-compile LLD it would be much appreciated to fix this!
 588         if target != builder.config.build {
 589             cfg.env("LLVM_CONFIG_SHIM_REPLACE", &builder.config.build.triple)
 590                 .env("LLVM_CONFIG_SHIM_REPLACE_WITH", &target.triple)
 591                 .define(
 592                     "LLVM_TABLEGEN_EXE",
 593                     llvm_config.with_file_name("llvm-tblgen").with_extension(EXE_EXTENSION),
 594                 );
 595         }
 596
 597         // Explicitly set C++ standard, because upstream doesn't do so
 598         // for standalone builds.
 599         cfg.define("CMAKE_CXX_STANDARD", "14");
 600
 601         cfg.build();
 602
 603         t!(File::create(&done_stamp));
 604         out_dir
 605     }
 606 }
 607
 608 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 609 pub struct TestHelpers {
 610     pub target: TargetSelection,
 611 }
 612
 613 impl Step for TestHelpers {
 614     type Output = ();
 615
 616     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 617         run.path("src/test/auxiliary/rust_test_helpers.c")
 618     }
 619
 620     fn make_run(run: RunConfig<'_>) {
 621         run.builder.ensure(TestHelpers { target: run.target })
 622     }
 623
 624     /// Compiles the `rust_test_helpers.c` library which we used in various
 625     /// `run-pass` tests for ABI testing.
 626     fn run(self, builder: &Builder<'_>) {
 627         if builder.config.dry_run {
 628             return;
 629         }
 630         let target = self.target;
 631         let dst = builder.test_helpers_out(target);
 632         let src = builder.src.join("src/test/auxiliary/rust_test_helpers.c");
 633         if up_to_date(&src, &dst.join("librust_test_helpers.a")) {
 634             return;
 635         }
 636
 637         builder.info("Building test helpers");
 638         t!(fs::create_dir_all(&dst));
 639         let mut cfg = cc::Build::new();
 640         // FIXME: Workaround for https://github.com/emscripten-core/emscripten/issues/9013
 641         if target.contains("emscripten") {
 642             cfg.pic(false);
 643         }
 644
 645         // We may have found various cross-compilers a little differently due to our
 646         // extra configuration, so inform cc of these compilers. Note, though, that
 647         // on MSVC we still need cc's detection of env vars (ugh).
 648         if !target.contains("msvc") {
 649             if let Some(ar) = builder.ar(target) {
 650                 cfg.archiver(ar);
 651             }
 652             cfg.compiler(builder.cc(target));
 653         }
 654
 655         cfg.cargo_metadata(false)
 656             .out_dir(&dst)
 657             .target(&target.triple)
 658             .host(&builder.config.build.triple)
 659             .opt_level(0)
 660             .warnings(false)
 661             .debug(false)
 662             .file(builder.src.join("src/test/auxiliary/rust_test_helpers.c"))
 663             .compile("rust_test_helpers");
 664     }
 665 }
 666
 667 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 668 pub struct Sanitizers {
 669     pub target: TargetSelection,
 670 }
 671
 672 impl Step for Sanitizers {
 673     type Output = Vec<SanitizerRuntime>;
 674
 675     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 676         run.path("src/llvm-project/compiler-rt").path("src/sanitizers")
 677     }
 678
 679     fn make_run(run: RunConfig<'_>) {
 680         run.builder.ensure(Sanitizers { target: run.target });
 681     }
 682
 683     /// Builds sanitizer runtime libraries.
 684     fn run(self, builder: &Builder<'_>) -> Self::Output {
 685         let compiler_rt_dir = builder.src.join("src/llvm-project/compiler-rt");
 686         if !compiler_rt_dir.exists() {
 687             return Vec::new();
 688         }
 689
 690         let out_dir = builder.native_dir(self.target).join("sanitizers");
 691         let runtimes = supported_sanitizers(&out_dir, self.target, &builder.config.channel);
 692         if runtimes.is_empty() {
 693             return runtimes;
 694         }
 695
 696         let llvm_config = builder.ensure(Llvm { target: builder.config.build });
 697         if builder.config.dry_run {
 698             return runtimes;
 699         }
 700
 701         let stamp = out_dir.join("sanitizers-finished-building");
 702         let stamp = HashStamp::new(stamp, builder.in_tree_llvm_info.sha());
 703
 704         if stamp.is_done() {
 705             if stamp.hash.is_none() {
 706                 builder.info(&format!(
 707                     "Rebuild sanitizers by removing the file `{}`",
 708                     stamp.path.display()
 709                 ));
 710             }
 711             return runtimes;
 712         }
 713
 714         builder.info(&format!("Building sanitizers for {}", self.target));
 715         t!(stamp.remove());
 716         let _time = util::timeit(&builder);
 717
 718         let mut cfg = cmake::Config::new(&compiler_rt_dir);
 719         cfg.profile("Release");
 720         cfg.define("CMAKE_C_COMPILER_TARGET", self.target.triple);
 721         cfg.define("COMPILER_RT_BUILD_BUILTINS", "OFF");
 722         cfg.define("COMPILER_RT_BUILD_CRT", "OFF");
 723         cfg.define("COMPILER_RT_BUILD_LIBFUZZER", "OFF");
 724         cfg.define("COMPILER_RT_BUILD_PROFILE", "OFF");
 725         cfg.define("COMPILER_RT_BUILD_SANITIZERS", "ON");
 726         cfg.define("COMPILER_RT_BUILD_XRAY", "OFF");
 727         cfg.define("COMPILER_RT_DEFAULT_TARGET_ONLY", "ON");
 728         cfg.define("COMPILER_RT_USE_LIBCXX", "OFF");
 729         cfg.define("LLVM_CONFIG_PATH", &llvm_config);
 730
 731         // On Darwin targets the sanitizer runtimes are build as universal binaries.
 732         // Unfortunately sccache currently lacks support to build them successfully.
 733         // Disable compiler launcher on Darwin targets to avoid potential issues.
 734         let use_compiler_launcher = !self.target.contains("apple-darwin");
 735         configure_cmake(builder, self.target, &mut cfg, use_compiler_launcher);
 736
 737         t!(fs::create_dir_all(&out_dir));
 738         cfg.out_dir(out_dir);
 739
 740         for runtime in &runtimes {
 741             cfg.build_target(&runtime.cmake_target);
 742             cfg.build();
 743         }
 744         t!(stamp.write());
 745
 746         runtimes
 747     }
 748 }
 749
 750 #[derive(Clone, Debug)]
 751 pub struct SanitizerRuntime {
 752     /// CMake target used to build the runtime.
 753     pub cmake_target: String,
 754     /// Path to the built runtime library.
 755     pub path: PathBuf,
 756     /// Library filename that will be used rustc.
 757     pub name: String,
 758 }
 759
 760 /// Returns sanitizers available on a given target.
 761 fn supported_sanitizers(
 762     out_dir: &Path,
 763     target: TargetSelection,
 764     channel: &str,
 765 ) -> Vec<SanitizerRuntime> {
 766     let darwin_libs = |os: &str, components: &[&str]| -> Vec<SanitizerRuntime> {
 767         components
 768             .iter()
 769             .map(move |c| SanitizerRuntime {
 770                 cmake_target: format!("clang_rt.{}_{}_dynamic", c, os),
 771                 path: out_dir
 772                     .join(&format!("build/lib/darwin/libclang_rt.{}_{}_dynamic.dylib", c, os)),
 773                 name: format!("librustc-{}_rt.{}.dylib", channel, c),
 774             })
 775             .collect()
 776     };
 777
 778     let common_libs = |os: &str, arch: &str, components: &[&str]| -> Vec<SanitizerRuntime> {
 779         components
 780             .iter()
 781             .map(move |c| SanitizerRuntime {
 782                 cmake_target: format!("clang_rt.{}-{}", c, arch),
 783                 path: out_dir.join(&format!("build/lib/{}/libclang_rt.{}-{}.a", os, c, arch)),
 784                 name: format!("librustc-{}_rt.{}.a", channel, c),
 785             })
 786             .collect()
 787     };
 788
 789     match &*target.triple {
 790         "aarch64-fuchsia" => common_libs("fuchsia", "aarch64", &["asan"]),
 791         "aarch64-unknown-linux-gnu" => {
 792             common_libs("linux", "aarch64", &["asan", "lsan", "msan", "tsan"])
 793         }
 794         "x86_64-apple-darwin" => darwin_libs("osx", &["asan", "lsan", "tsan"]),
 795         "x86_64-fuchsia" => common_libs("fuchsia", "x86_64", &["asan"]),
 796         "x86_64-unknown-freebsd" => common_libs("freebsd", "x86_64", &["asan", "msan", "tsan"]),
 797         "x86_64-unknown-linux-gnu" => {
 798             common_libs("linux", "x86_64", &["asan", "lsan", "msan", "tsan"])
 799         }
 800         _ => Vec::new(),
 801     }
 802 }
 803
 804 struct HashStamp {
 805     path: PathBuf,
 806     hash: Option<Vec<u8>>,
 807 }
 808
 809 impl HashStamp {
 810     fn new(path: PathBuf, hash: Option<&str>) -> Self {
 811         HashStamp { path, hash: hash.map(|s| s.as_bytes().to_owned()) }
 812     }
 813
 814     fn is_done(&self) -> bool {
 815         match fs::read(&self.path) {
 816             Ok(h) => self.hash.as_deref().unwrap_or(b"") == h.as_slice(),
 817             Err(e) if e.kind() == io::ErrorKind::NotFound => false,
 818             Err(e) => {
 819                 panic!("failed to read stamp file `{}`: {}", self.path.display(), e);
 820             }
 821         }
 822     }
 823
 824     fn remove(&self) -> io::Result<()> {
 825         match fs::remove_file(&self.path) {
 826             Ok(()) => Ok(()),
 827             Err(e) => {
 828                 if e.kind() == io::ErrorKind::NotFound {
 829                     Ok(())
 830                 } else {
 831                     Err(e)
 832                 }
 833             }
 834         }
 835     }
 836
 837     fn write(&self) -> io::Result<()> {
 838         fs::write(&self.path, self.hash.as_deref().unwrap_or(b""))
 839     }
 840 }