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