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::{OsStr, 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 crate::builder::{Builder, RunConfig, ShouldRun, Step};
  20 use crate::config::TargetSelection;
  21 use crate::util::get_clang_cl_resource_dir;
  22 use crate::util::{self, exe, output, program_out_of_date, t, up_to_date};
  23 use crate::{CLang, GitRepo};
  24
  25 pub struct Meta {
  26     stamp: HashStamp,
  27     build_llvm_config: PathBuf,
  28     out_dir: PathBuf,
  29     root: String,
  30 }
  31
  32 // Linker flags to pass to LLVM's CMake invocation.
  33 #[derive(Debug, Clone, Default)]
  34 struct LdFlags {
  35     // CMAKE_EXE_LINKER_FLAGS
  36     exe: OsString,
  37     // CMAKE_SHARED_LINKER_FLAGS
  38     shared: OsString,
  39     // CMAKE_MODULE_LINKER_FLAGS
  40     module: OsString,
  41 }
  42
  43 impl LdFlags {
  44     fn push_all(&mut self, s: impl AsRef<OsStr>) {
  45         let s = s.as_ref();
  46         self.exe.push(" ");
  47         self.exe.push(s);
  48         self.shared.push(" ");
  49         self.shared.push(s);
  50         self.module.push(" ");
  51         self.module.push(s);
  52     }
  53 }
  54
  55 // This returns whether we've already previously built LLVM.
  56 //
  57 // It's used to avoid busting caches during x.py check -- if we've already built
  58 // LLVM, it's fine for us to not try to avoid doing so.
  59 //
  60 // This will return the llvm-config if it can get it (but it will not build it
  61 // if not).
  62 pub fn prebuilt_llvm_config(
  63     builder: &Builder<'_>,
  64     target: TargetSelection,
  65 ) -> Result<PathBuf, Meta> {
  66     maybe_download_ci_llvm(builder);
  67
  68     // If we're using a custom LLVM bail out here, but we can only use a
  69     // custom LLVM for the build triple.
  70     if let Some(config) = builder.config.target_config.get(&target) {
  71         if let Some(ref s) = config.llvm_config {
  72             check_llvm_version(builder, s);
  73             return Ok(s.to_path_buf());
  74         }
  75     }
  76
  77     let root = "src/llvm-project/llvm";
  78     let out_dir = builder.llvm_out(target);
  79
  80     let mut llvm_config_ret_dir = builder.llvm_out(builder.config.build);
  81     if !builder.config.build.contains("msvc") || builder.ninja() {
  82         llvm_config_ret_dir.push("build");
  83     }
  84     llvm_config_ret_dir.push("bin");
  85
  86     let build_llvm_config = llvm_config_ret_dir.join(exe("llvm-config", builder.config.build));
  87
  88     let stamp = out_dir.join("llvm-finished-building");
  89     let stamp = HashStamp::new(stamp, builder.in_tree_llvm_info.sha());
  90
  91     if builder.config.llvm_skip_rebuild && stamp.path.exists() {
  92         builder.info(
  93             "Warning: \
  94                 Using a potentially stale build of LLVM; \
  95                 This may not behave well.",
  96         );
  97         return Ok(build_llvm_config);
  98     }
  99
 100     if stamp.is_done() {
 101         if stamp.hash.is_none() {
 102             builder.info(
 103                 "Could not determine the LLVM submodule commit hash. \
 104                      Assuming that an LLVM rebuild is not necessary.",
 105             );
 106             builder.info(&format!(
 107                 "To force LLVM to rebuild, remove the file `{}`",
 108                 stamp.path.display()
 109             ));
 110         }
 111         return Ok(build_llvm_config);
 112     }
 113
 114     Err(Meta { stamp, build_llvm_config, out_dir, root: root.into() })
 115 }
 116
 117 /// This retrieves the LLVM sha we *want* to use, according to git history.
 118 pub(crate) fn detect_llvm_sha(config: &crate::config::Config) -> String {
 119     let mut rev_list = config.git();
 120     rev_list.args(&[
 121         PathBuf::from("rev-list"),
 122         format!("--author={}", config.stage0_metadata.config.git_merge_commit_email).into(),
 123         "-n1".into(),
 124         "--first-parent".into(),
 125         "HEAD".into(),
 126         "--".into(),
 127         config.src.join("src/llvm-project"),
 128         config.src.join("src/bootstrap/download-ci-llvm-stamp"),
 129         // the LLVM shared object file is named `LLVM-12-rust-{version}-nightly`
 130         config.src.join("src/version"),
 131     ]);
 132     let llvm_sha = output(&mut rev_list);
 133     let llvm_sha = llvm_sha.trim();
 134
 135     if llvm_sha == "" {
 136         eprintln!("error: could not find commit hash for downloading LLVM");
 137         eprintln!("help: maybe your repository history is too shallow?");
 138         eprintln!("help: consider disabling `download-ci-llvm`");
 139         eprintln!("help: or fetch enough history to include one upstream commit");
 140         panic!();
 141     }
 142
 143     llvm_sha.to_owned()
 144 }
 145
 146 /// Returns whether the CI-found LLVM is currently usable.
 147 ///
 148 /// This checks both the build triple platform to confirm we're usable at all,
 149 /// and then verifies if the current HEAD matches the detected LLVM SHA head,
 150 /// in which case LLVM is indicated as not available.
 151 pub(crate) fn is_ci_llvm_available(config: &crate::config::Config, asserts: bool) -> bool {
 152     // This is currently all tier 1 targets and tier 2 targets with host tools
 153     // (since others may not have CI artifacts)
 154     // https://doc.rust-lang.org/rustc/platform-support.html#tier-1
 155     let supported_platforms = [
 156         // tier 1
 157         "aarch64-unknown-linux-gnu",
 158         "i686-pc-windows-gnu",
 159         "i686-pc-windows-msvc",
 160         "i686-unknown-linux-gnu",
 161         "x86_64-unknown-linux-gnu",
 162         "x86_64-apple-darwin",
 163         "x86_64-pc-windows-gnu",
 164         "x86_64-pc-windows-msvc",
 165         // tier 2 with host tools
 166         "aarch64-apple-darwin",
 167         "aarch64-pc-windows-msvc",
 168         "aarch64-unknown-linux-musl",
 169         "arm-unknown-linux-gnueabi",
 170         "arm-unknown-linux-gnueabihf",
 171         "armv7-unknown-linux-gnueabihf",
 172         "mips-unknown-linux-gnu",
 173         "mips64-unknown-linux-gnuabi64",
 174         "mips64el-unknown-linux-gnuabi64",
 175         "mipsel-unknown-linux-gnu",
 176         "powerpc-unknown-linux-gnu",
 177         "powerpc64-unknown-linux-gnu",
 178         "powerpc64le-unknown-linux-gnu",
 179         "riscv64gc-unknown-linux-gnu",
 180         "s390x-unknown-linux-gnu",
 181         "x86_64-unknown-freebsd",
 182         "x86_64-unknown-illumos",
 183         "x86_64-unknown-linux-musl",
 184         "x86_64-unknown-netbsd",
 185     ];
 186     if !supported_platforms.contains(&&*config.build.triple) {
 187         return false;
 188     }
 189
 190     let triple = &*config.build.triple;
 191     if (triple == "aarch64-unknown-linux-gnu" || triple.contains("i686")) && asserts {
 192         // No alt builder for aarch64-unknown-linux-gnu today.
 193         return false;
 194     }
 195
 196     if crate::util::CiEnv::is_ci() {
 197         let llvm_sha = detect_llvm_sha(config);
 198         let head_sha = output(config.git().arg("rev-parse").arg("HEAD"));
 199         let head_sha = head_sha.trim();
 200         if llvm_sha == head_sha {
 201             eprintln!(
 202                 "Detected LLVM as non-available: running in CI and modified LLVM in this change"
 203             );
 204             return false;
 205         }
 206     }
 207
 208     true
 209 }
 210
 211 pub(crate) fn maybe_download_ci_llvm(builder: &Builder<'_>) {
 212     let config = &builder.config;
 213     if !config.llvm_from_ci {
 214         return;
 215     }
 216     let llvm_root = config.ci_llvm_root();
 217     let llvm_stamp = llvm_root.join(".llvm-stamp");
 218     let llvm_sha = detect_llvm_sha(&config);
 219     let key = format!("{}{}", llvm_sha, config.llvm_assertions);
 220     if program_out_of_date(&llvm_stamp, &key) && !config.dry_run {
 221         download_ci_llvm(builder, &llvm_sha);
 222         for entry in t!(fs::read_dir(llvm_root.join("bin"))) {
 223             builder.fix_bin_or_dylib(&t!(entry).path());
 224         }
 225
 226         // Update the timestamp of llvm-config to force rustc_llvm to be
 227         // rebuilt. This is a hacky workaround for a deficiency in Cargo where
 228         // the rerun-if-changed directive doesn't handle changes very well.
 229         // https://github.com/rust-lang/cargo/issues/10791
 230         // Cargo only compares the timestamp of the file relative to the last
 231         // time `rustc_llvm` build script ran. However, the timestamps of the
 232         // files in the tarball are in the past, so it doesn't trigger a
 233         // rebuild.
 234         let now = filetime::FileTime::from_system_time(std::time::SystemTime::now());
 235         let llvm_config = llvm_root.join("bin").join(exe("llvm-config", builder.config.build));
 236         t!(filetime::set_file_times(&llvm_config, now, now));
 237
 238         let llvm_lib = llvm_root.join("lib");
 239         for entry in t!(fs::read_dir(&llvm_lib)) {
 240             let lib = t!(entry).path();
 241             if lib.extension().map_or(false, |ext| ext == "so") {
 242                 builder.fix_bin_or_dylib(&lib);
 243             }
 244         }
 245         t!(fs::write(llvm_stamp, key));
 246     }
 247 }
 248
 249 fn download_ci_llvm(builder: &Builder<'_>, llvm_sha: &str) {
 250     let llvm_assertions = builder.config.llvm_assertions;
 251
 252     let cache_prefix = format!("llvm-{}-{}", llvm_sha, llvm_assertions);
 253     let cache_dst = builder.out.join("cache");
 254     let rustc_cache = cache_dst.join(cache_prefix);
 255     if !rustc_cache.exists() {
 256         t!(fs::create_dir_all(&rustc_cache));
 257     }
 258     let base = if llvm_assertions {
 259         &builder.config.stage0_metadata.config.artifacts_with_llvm_assertions_server
 260     } else {
 261         &builder.config.stage0_metadata.config.artifacts_server
 262     };
 263     let channel = builder.config.artifact_channel(llvm_sha);
 264     let filename = format!("rust-dev-{}-{}.tar.xz", channel, builder.build.build.triple);
 265     let tarball = rustc_cache.join(&filename);
 266     if !tarball.exists() {
 267         let help_on_error = "error: failed to download llvm from ci
 268
 269 help: old builds get deleted after a certain time
 270 help: if trying to compile an old commit of rustc, disable `download-ci-llvm` in config.toml:
 271
 272 [llvm]
 273 download-ci-llvm = false
 274 ";
 275         builder.download_component(
 276             &format!("{base}/{llvm_sha}/{filename}"),
 277             &tarball,
 278             help_on_error,
 279         );
 280     }
 281     let llvm_root = builder.config.ci_llvm_root();
 282     builder.unpack(&tarball, &llvm_root, "rust-dev");
 283 }
 284
 285 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 286 pub struct Llvm {
 287     pub target: TargetSelection,
 288 }
 289
 290 impl Step for Llvm {
 291     type Output = PathBuf; // path to llvm-config
 292
 293     const ONLY_HOSTS: bool = true;
 294
 295     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 296         run.path("src/llvm-project").path("src/llvm-project/llvm")
 297     }
 298
 299     fn make_run(run: RunConfig<'_>) {
 300         run.builder.ensure(Llvm { target: run.target });
 301     }
 302
 303     /// Compile LLVM for `target`.
 304     fn run(self, builder: &Builder<'_>) -> PathBuf {
 305         let target = self.target;
 306         let target_native = if self.target.starts_with("riscv") {
 307             // RISC-V target triples in Rust is not named the same as C compiler target triples.
 308             // This converts Rust RISC-V target triples to C compiler triples.
 309             let idx = target.triple.find('-').unwrap();
 310
 311             format!("riscv{}{}", &target.triple[5..7], &target.triple[idx..])
 312         } else if self.target.starts_with("powerpc") && self.target.ends_with("freebsd") {
 313             // FreeBSD 13 had incompatible ABI changes on all PowerPC platforms.
 314             // Set the version suffix to 13.0 so the correct target details are used.
 315             format!("{}{}", self.target, "13.0")
 316         } else {
 317             target.to_string()
 318         };
 319
 320         let Meta { stamp, build_llvm_config, out_dir, root } =
 321             match prebuilt_llvm_config(builder, target) {
 322                 Ok(p) => return p,
 323                 Err(m) => m,
 324             };
 325
 326         builder.update_submodule(&Path::new("src").join("llvm-project"));
 327         if builder.llvm_link_shared() && target.contains("windows") {
 328             panic!("shared linking to LLVM is not currently supported on {}", target.triple);
 329         }
 330
 331         builder.info(&format!("Building LLVM for {}", target));
 332         t!(stamp.remove());
 333         let _time = util::timeit(&builder);
 334         t!(fs::create_dir_all(&out_dir));
 335
 336         // https://llvm.org/docs/CMake.html
 337         let mut cfg = cmake::Config::new(builder.src.join(root));
 338         let mut ldflags = LdFlags::default();
 339
 340         let profile = match (builder.config.llvm_optimize, builder.config.llvm_release_debuginfo) {
 341             (false, _) => "Debug",
 342             (true, false) => "Release",
 343             (true, true) => "RelWithDebInfo",
 344         };
 345
 346         // NOTE: remember to also update `config.toml.example` when changing the
 347         // defaults!
 348         let llvm_targets = match &builder.config.llvm_targets {
 349             Some(s) => s,
 350             None => {
 351                 "AArch64;ARM;BPF;Hexagon;MSP430;Mips;NVPTX;PowerPC;RISCV;\
 352                      Sparc;SystemZ;WebAssembly;X86"
 353             }
 354         };
 355
 356         let llvm_exp_targets = match builder.config.llvm_experimental_targets {
 357             Some(ref s) => s,
 358             None => "AVR;M68k",
 359         };
 360
 361         let assertions = if builder.config.llvm_assertions { "ON" } else { "OFF" };
 362         let plugins = if builder.config.llvm_plugins { "ON" } else { "OFF" };
 363         let enable_tests = if builder.config.llvm_tests { "ON" } else { "OFF" };
 364
 365         cfg.out_dir(&out_dir)
 366             .profile(profile)
 367             .define("LLVM_ENABLE_ASSERTIONS", assertions)
 368             .define("LLVM_ENABLE_PLUGINS", plugins)
 369             .define("LLVM_TARGETS_TO_BUILD", llvm_targets)
 370             .define("LLVM_EXPERIMENTAL_TARGETS_TO_BUILD", llvm_exp_targets)
 371             .define("LLVM_INCLUDE_EXAMPLES", "OFF")
 372             .define("LLVM_INCLUDE_DOCS", "OFF")
 373             .define("LLVM_INCLUDE_BENCHMARKS", "OFF")
 374             .define("LLVM_INCLUDE_TESTS", enable_tests)
 375             .define("LLVM_ENABLE_TERMINFO", "OFF")
 376             .define("LLVM_ENABLE_LIBEDIT", "OFF")
 377             .define("LLVM_ENABLE_BINDINGS", "OFF")
 378             .define("LLVM_ENABLE_Z3_SOLVER", "OFF")
 379             .define("LLVM_PARALLEL_COMPILE_JOBS", builder.jobs().to_string())
 380             .define("LLVM_TARGET_ARCH", target_native.split('-').next().unwrap())
 381             .define("LLVM_DEFAULT_TARGET_TRIPLE", target_native);
 382
 383         // Parts of our test suite rely on the `FileCheck` tool, which is built by default in
 384         // `build/$TARGET/llvm/build/bin` is but *not* then installed to `build/$TARGET/llvm/bin`.
 385         // This flag makes sure `FileCheck` is copied in the final binaries directory.
 386         cfg.define("LLVM_INSTALL_UTILS", "ON");
 387
 388         if builder.config.llvm_profile_generate {
 389             cfg.define("LLVM_BUILD_INSTRUMENTED", "IR");
 390             if let Ok(llvm_profile_dir) = std::env::var("LLVM_PROFILE_DIR") {
 391                 cfg.define("LLVM_PROFILE_DATA_DIR", llvm_profile_dir);
 392             }
 393             cfg.define("LLVM_BUILD_RUNTIME", "No");
 394         }
 395         if let Some(path) = builder.config.llvm_profile_use.as_ref() {
 396             cfg.define("LLVM_PROFDATA_FILE", &path);
 397         }
 398
 399         // Disable zstd to avoid a dependency on libzstd.so.
 400         cfg.define("LLVM_ENABLE_ZSTD", "OFF");
 401
 402         if target != "aarch64-apple-darwin" && !target.contains("windows") {
 403             cfg.define("LLVM_ENABLE_ZLIB", "ON");
 404         } else {
 405             cfg.define("LLVM_ENABLE_ZLIB", "OFF");
 406         }
 407
 408         // Are we compiling for iOS/tvOS/watchOS?
 409         if target.contains("apple-ios")
 410             || target.contains("apple-tvos")
 411             || target.contains("apple-watchos")
 412         {
 413             // These two defines prevent CMake from automatically trying to add a MacOSX sysroot, which leads to a compiler error.
 414             cfg.define("CMAKE_OSX_SYSROOT", "/");
 415             cfg.define("CMAKE_OSX_DEPLOYMENT_TARGET", "");
 416             // Prevent cmake from adding -bundle to CFLAGS automatically, which leads to a compiler error because "-bitcode_bundle" also gets added.
 417             cfg.define("LLVM_ENABLE_PLUGINS", "OFF");
 418             // Zlib fails to link properly, leading to a compiler error.
 419             cfg.define("LLVM_ENABLE_ZLIB", "OFF");
 420         }
 421
 422         // This setting makes the LLVM tools link to the dynamic LLVM library,
 423         // which saves both memory during parallel links and overall disk space
 424         // for the tools. We don't do this on every platform as it doesn't work
 425         // equally well everywhere.
 426         //
 427         // If we're not linking rustc to a dynamic LLVM, though, then don't link
 428         // tools to it.
 429         let llvm_link_shared =
 430             builder.llvm_link_tools_dynamically(target) && builder.llvm_link_shared();
 431         if llvm_link_shared {
 432             cfg.define("LLVM_LINK_LLVM_DYLIB", "ON");
 433         }
 434
 435         if target.starts_with("riscv") && !target.contains("freebsd") {
 436             // RISC-V GCC erroneously requires linking against
 437             // `libatomic` when using 1-byte and 2-byte C++
 438             // atomics but the LLVM build system check cannot
 439             // detect this. Therefore it is set manually here.
 440             // FreeBSD uses Clang as its system compiler and
 441             // provides no libatomic in its base system so does
 442             // not want this.
 443             ldflags.exe.push(" -latomic");
 444             ldflags.shared.push(" -latomic");
 445         }
 446
 447         if target.contains("msvc") {
 448             cfg.define("LLVM_USE_CRT_DEBUG", "MT");
 449             cfg.define("LLVM_USE_CRT_RELEASE", "MT");
 450             cfg.define("LLVM_USE_CRT_RELWITHDEBINFO", "MT");
 451             cfg.static_crt(true);
 452         }
 453
 454         if target.starts_with("i686") {
 455             cfg.define("LLVM_BUILD_32_BITS", "ON");
 456         }
 457
 458         let mut enabled_llvm_projects = Vec::new();
 459
 460         if util::forcing_clang_based_tests() {
 461             enabled_llvm_projects.push("clang");
 462             enabled_llvm_projects.push("compiler-rt");
 463         }
 464
 465         if builder.config.llvm_polly {
 466             enabled_llvm_projects.push("polly");
 467         }
 468
 469         if builder.config.llvm_clang {
 470             enabled_llvm_projects.push("clang");
 471         }
 472
 473         // We want libxml to be disabled.
 474         // See https://github.com/rust-lang/rust/pull/50104
 475         cfg.define("LLVM_ENABLE_LIBXML2", "OFF");
 476
 477         if !enabled_llvm_projects.is_empty() {
 478             enabled_llvm_projects.sort();
 479             enabled_llvm_projects.dedup();
 480             cfg.define("LLVM_ENABLE_PROJECTS", enabled_llvm_projects.join(";"));
 481         }
 482
 483         if let Some(num_linkers) = builder.config.llvm_link_jobs {
 484             if num_linkers > 0 {
 485                 cfg.define("LLVM_PARALLEL_LINK_JOBS", num_linkers.to_string());
 486             }
 487         }
 488
 489         // Workaround for ppc32 lld limitation
 490         if target == "powerpc-unknown-freebsd" {
 491             ldflags.exe.push(" -fuse-ld=bfd");
 492         }
 493
 494         // https://llvm.org/docs/HowToCrossCompileLLVM.html
 495         if target != builder.config.build {
 496             builder.ensure(Llvm { target: builder.config.build });
 497             // FIXME: if the llvm root for the build triple is overridden then we
 498             //        should use llvm-tblgen from there, also should verify that it
 499             //        actually exists most of the time in normal installs of LLVM.
 500             let host_bin = builder.llvm_out(builder.config.build).join("bin");
 501             cfg.define("LLVM_TABLEGEN", host_bin.join("llvm-tblgen").with_extension(EXE_EXTENSION));
 502             // LLVM_NM is required for cross compiling using MSVC
 503             cfg.define("LLVM_NM", host_bin.join("llvm-nm").with_extension(EXE_EXTENSION));
 504             cfg.define(
 505                 "LLVM_CONFIG_PATH",
 506                 host_bin.join("llvm-config").with_extension(EXE_EXTENSION),
 507             );
 508             if builder.config.llvm_clang {
 509                 let build_bin = builder.llvm_out(builder.config.build).join("build").join("bin");
 510                 let clang_tblgen = build_bin.join("clang-tblgen").with_extension(EXE_EXTENSION);
 511                 if !builder.config.dry_run && !clang_tblgen.exists() {
 512                     panic!("unable to find {}", clang_tblgen.display());
 513                 }
 514                 cfg.define("CLANG_TABLEGEN", clang_tblgen);
 515             }
 516         }
 517
 518         let llvm_version_suffix = if let Some(ref suffix) = builder.config.llvm_version_suffix {
 519             // Allow version-suffix="" to not define a version suffix at all.
 520             if !suffix.is_empty() { Some(suffix.to_string()) } else { None }
 521         } else if builder.config.channel == "dev" {
 522             // Changes to a version suffix require a complete rebuild of the LLVM.
 523             // To avoid rebuilds during a time of version bump, don't include rustc
 524             // release number on the dev channel.
 525             Some("-rust-dev".to_string())
 526         } else {
 527             Some(format!("-rust-{}-{}", builder.version, builder.config.channel))
 528         };
 529         if let Some(ref suffix) = llvm_version_suffix {
 530             cfg.define("LLVM_VERSION_SUFFIX", suffix);
 531         }
 532
 533         configure_cmake(builder, target, &mut cfg, true, ldflags);
 534         configure_llvm(builder, target, &mut cfg);
 535
 536         for (key, val) in &builder.config.llvm_build_config {
 537             cfg.define(key, val);
 538         }
 539
 540         // FIXME: we don't actually need to build all LLVM tools and all LLVM
 541         //        libraries here, e.g., we just want a few components and a few
 542         //        tools. Figure out how to filter them down and only build the right
 543         //        tools and libs on all platforms.
 544
 545         if builder.config.dry_run {
 546             return build_llvm_config;
 547         }
 548
 549         cfg.build();
 550
 551         // When building LLVM with LLVM_LINK_LLVM_DYLIB for macOS, an unversioned
 552         // libLLVM.dylib will be built. However, llvm-config will still look
 553         // for a versioned path like libLLVM-14.dylib. Manually create a symbolic
 554         // link to make llvm-config happy.
 555         if llvm_link_shared && target.contains("apple-darwin") {
 556             let mut cmd = Command::new(&build_llvm_config);
 557             let version = output(cmd.arg("--version"));
 558             let major = version.split('.').next().unwrap();
 559             let lib_name = match llvm_version_suffix {
 560                 Some(s) => format!("libLLVM-{}{}.dylib", major, s),
 561                 None => format!("libLLVM-{}.dylib", major),
 562             };
 563
 564             let lib_llvm = out_dir.join("build").join("lib").join(lib_name);
 565             if !lib_llvm.exists() {
 566                 t!(builder.symlink_file("libLLVM.dylib", &lib_llvm));
 567             }
 568         }
 569
 570         t!(stamp.write());
 571
 572         build_llvm_config
 573     }
 574 }
 575
 576 fn check_llvm_version(builder: &Builder<'_>, llvm_config: &Path) {
 577     if !builder.config.llvm_version_check {
 578         return;
 579     }
 580
 581     if builder.config.dry_run {
 582         return;
 583     }
 584
 585     let mut cmd = Command::new(llvm_config);
 586     let version = output(cmd.arg("--version"));
 587     let mut parts = version.split('.').take(2).filter_map(|s| s.parse::<u32>().ok());
 588     if let (Some(major), Some(_minor)) = (parts.next(), parts.next()) {
 589         if major >= 13 {
 590             return;
 591         }
 592     }
 593     panic!("\n\nbad LLVM version: {}, need >=13.0\n\n", version)
 594 }
 595
 596 fn configure_cmake(
 597     builder: &Builder<'_>,
 598     target: TargetSelection,
 599     cfg: &mut cmake::Config,
 600     use_compiler_launcher: bool,
 601     mut ldflags: LdFlags,
 602 ) {
 603     // Do not print installation messages for up-to-date files.
 604     // LLVM and LLD builds can produce a lot of those and hit CI limits on log size.
 605     cfg.define("CMAKE_INSTALL_MESSAGE", "LAZY");
 606
 607     // Do not allow the user's value of DESTDIR to influence where
 608     // LLVM will install itself. LLVM must always be installed in our
 609     // own build directories.
 610     cfg.env("DESTDIR", "");
 611
 612     if builder.ninja() {
 613         cfg.generator("Ninja");
 614     }
 615     cfg.target(&target.triple).host(&builder.config.build.triple);
 616
 617     if target != builder.config.build {
 618         cfg.define("CMAKE_CROSSCOMPILING", "True");
 619
 620         if target.contains("netbsd") {
 621             cfg.define("CMAKE_SYSTEM_NAME", "NetBSD");
 622         } else if target.contains("freebsd") {
 623             cfg.define("CMAKE_SYSTEM_NAME", "FreeBSD");
 624         } else if target.contains("windows") {
 625             cfg.define("CMAKE_SYSTEM_NAME", "Windows");
 626         } else if target.contains("haiku") {
 627             cfg.define("CMAKE_SYSTEM_NAME", "Haiku");
 628         } else if target.contains("solaris") || target.contains("illumos") {
 629             cfg.define("CMAKE_SYSTEM_NAME", "SunOS");
 630         }
 631         // When cross-compiling we should also set CMAKE_SYSTEM_VERSION, but in
 632         // that case like CMake we cannot easily determine system version either.
 633         //
 634         // Since, the LLVM itself makes rather limited use of version checks in
 635         // CMakeFiles (and then only in tests), and so far no issues have been
 636         // reported, the system version is currently left unset.
 637
 638         if target.contains("darwin") {
 639             // Make sure that CMake does not build universal binaries on macOS.
 640             // Explicitly specifiy the one single target architecture.
 641             if target.starts_with("aarch64") {
 642                 // macOS uses a different name for building arm64
 643                 cfg.define("CMAKE_OSX_ARCHITECTURES", "arm64");
 644             } else {
 645                 cfg.define("CMAKE_OSX_ARCHITECTURES", target.triple.split('-').next().unwrap());
 646             }
 647         }
 648     }
 649
 650     let sanitize_cc = |cc: &Path| {
 651         if target.contains("msvc") {
 652             OsString::from(cc.to_str().unwrap().replace("\\", "/"))
 653         } else {
 654             cc.as_os_str().to_owned()
 655         }
 656     };
 657
 658     // MSVC with CMake uses msbuild by default which doesn't respect these
 659     // vars that we'd otherwise configure. In that case we just skip this
 660     // entirely.
 661     if target.contains("msvc") && !builder.ninja() {
 662         return;
 663     }
 664
 665     let (cc, cxx) = match builder.config.llvm_clang_cl {
 666         Some(ref cl) => (cl.as_ref(), cl.as_ref()),
 667         None => (builder.cc(target), builder.cxx(target).unwrap()),
 668     };
 669
 670     // Handle msvc + ninja + ccache specially (this is what the bots use)
 671     if target.contains("msvc") && builder.ninja() && builder.config.ccache.is_some() {
 672         let mut wrap_cc = env::current_exe().expect("failed to get cwd");
 673         wrap_cc.set_file_name("sccache-plus-cl.exe");
 674
 675         cfg.define("CMAKE_C_COMPILER", sanitize_cc(&wrap_cc))
 676             .define("CMAKE_CXX_COMPILER", sanitize_cc(&wrap_cc));
 677         cfg.env("SCCACHE_PATH", builder.config.ccache.as_ref().unwrap())
 678             .env("SCCACHE_TARGET", target.triple)
 679             .env("SCCACHE_CC", &cc)
 680             .env("SCCACHE_CXX", &cxx);
 681
 682         // Building LLVM on MSVC can be a little ludicrous at times. We're so far
 683         // off the beaten path here that I'm not really sure this is even half
 684         // supported any more. Here we're trying to:
 685         //
 686         // * Build LLVM on MSVC
 687         // * Build LLVM with `clang-cl` instead of `cl.exe`
 688         // * Build a project with `sccache`
 689         // * Build for 32-bit as well
 690         // * Build with Ninja
 691         //
 692         // For `cl.exe` there are different binaries to compile 32/64 bit which
 693         // we use but for `clang-cl` there's only one which internally
 694         // multiplexes via flags. As a result it appears that CMake's detection
 695         // of a compiler's architecture and such on MSVC **doesn't** pass any
 696         // custom flags we pass in CMAKE_CXX_FLAGS below. This means that if we
 697         // use `clang-cl.exe` it's always diagnosed as a 64-bit compiler which
 698         // definitely causes problems since all the env vars are pointing to
 699         // 32-bit libraries.
 700         //
 701         // To hack around this... again... we pass an argument that's
 702         // unconditionally passed in the sccache shim. This'll get CMake to
 703         // correctly diagnose it's doing a 32-bit compilation and LLVM will
 704         // internally configure itself appropriately.
 705         if builder.config.llvm_clang_cl.is_some() && target.contains("i686") {
 706             cfg.env("SCCACHE_EXTRA_ARGS", "-m32");
 707         }
 708     } else {
 709         // If ccache is configured we inform the build a little differently how
 710         // to invoke ccache while also invoking our compilers.
 711         if use_compiler_launcher {
 712             if let Some(ref ccache) = builder.config.ccache {
 713                 cfg.define("CMAKE_C_COMPILER_LAUNCHER", ccache)
 714                     .define("CMAKE_CXX_COMPILER_LAUNCHER", ccache);
 715             }
 716         }
 717         cfg.define("CMAKE_C_COMPILER", sanitize_cc(cc))
 718             .define("CMAKE_CXX_COMPILER", sanitize_cc(cxx))
 719             .define("CMAKE_ASM_COMPILER", sanitize_cc(cc));
 720     }
 721
 722     cfg.build_arg("-j").build_arg(builder.jobs().to_string());
 723     let mut cflags: OsString = builder.cflags(target, GitRepo::Llvm, CLang::C).join(" ").into();
 724     if let Some(ref s) = builder.config.llvm_cflags {
 725         cflags.push(" ");
 726         cflags.push(s);
 727     }
 728     // Some compiler features used by LLVM (such as thread locals) will not work on a min version below iOS 10.
 729     if target.contains("apple-ios") {
 730         if target.contains("86-") {
 731             cflags.push(" -miphonesimulator-version-min=10.0");
 732         } else {
 733             cflags.push(" -miphoneos-version-min=10.0");
 734         }
 735     }
 736     if builder.config.llvm_clang_cl.is_some() {
 737         cflags.push(&format!(" --target={}", target));
 738     }
 739     cfg.define("CMAKE_C_FLAGS", cflags);
 740     let mut cxxflags: OsString = builder.cflags(target, GitRepo::Llvm, CLang::Cxx).join(" ").into();
 741     if let Some(ref s) = builder.config.llvm_cxxflags {
 742         cxxflags.push(" ");
 743         cxxflags.push(s);
 744     }
 745     if builder.config.llvm_clang_cl.is_some() {
 746         cxxflags.push(&format!(" --target={}", target));
 747     }
 748     cfg.define("CMAKE_CXX_FLAGS", cxxflags);
 749     if let Some(ar) = builder.ar(target) {
 750         if ar.is_absolute() {
 751             // LLVM build breaks if `CMAKE_AR` is a relative path, for some reason it
 752             // tries to resolve this path in the LLVM build directory.
 753             cfg.define("CMAKE_AR", sanitize_cc(ar));
 754         }
 755     }
 756
 757     if let Some(ranlib) = builder.ranlib(target) {
 758         if ranlib.is_absolute() {
 759             // LLVM build breaks if `CMAKE_RANLIB` is a relative path, for some reason it
 760             // tries to resolve this path in the LLVM build directory.
 761             cfg.define("CMAKE_RANLIB", sanitize_cc(ranlib));
 762         }
 763     }
 764
 765     if let Some(ref flags) = builder.config.llvm_ldflags {
 766         ldflags.push_all(flags);
 767     }
 768
 769     if let Some(flags) = get_var("LDFLAGS", &builder.config.build.triple, &target.triple) {
 770         ldflags.push_all(&flags);
 771     }
 772
 773     // For distribution we want the LLVM tools to be *statically* linked to libstdc++.
 774     // We also do this if the user explicitly requested static libstdc++.
 775     if builder.config.llvm_static_stdcpp {
 776         if !target.contains("msvc") && !target.contains("netbsd") && !target.contains("solaris") {
 777             if target.contains("apple") || target.contains("windows") {
 778                 ldflags.push_all("-static-libstdc++");
 779             } else {
 780                 ldflags.push_all("-Wl,-Bsymbolic -static-libstdc++");
 781             }
 782         }
 783     }
 784
 785     cfg.define("CMAKE_SHARED_LINKER_FLAGS", &ldflags.shared);
 786     cfg.define("CMAKE_MODULE_LINKER_FLAGS", &ldflags.module);
 787     cfg.define("CMAKE_EXE_LINKER_FLAGS", &ldflags.exe);
 788
 789     if env::var_os("SCCACHE_ERROR_LOG").is_some() {
 790         cfg.env("RUSTC_LOG", "sccache=warn");
 791     }
 792 }
 793
 794 fn configure_llvm(builder: &Builder<'_>, target: TargetSelection, cfg: &mut cmake::Config) {
 795     // ThinLTO is only available when building with LLVM, enabling LLD is required.
 796     // Apple's linker ld64 supports ThinLTO out of the box though, so don't use LLD on Darwin.
 797     if builder.config.llvm_thin_lto {
 798         cfg.define("LLVM_ENABLE_LTO", "Thin");
 799         if !target.contains("apple") {
 800             cfg.define("LLVM_ENABLE_LLD", "ON");
 801         }
 802     }
 803
 804     if let Some(ref linker) = builder.config.llvm_use_linker {
 805         cfg.define("LLVM_USE_LINKER", linker);
 806     }
 807
 808     if builder.config.llvm_allow_old_toolchain {
 809         cfg.define("LLVM_TEMPORARILY_ALLOW_OLD_TOOLCHAIN", "YES");
 810     }
 811 }
 812
 813 // Adapted from https://github.com/alexcrichton/cc-rs/blob/fba7feded71ee4f63cfe885673ead6d7b4f2f454/src/lib.rs#L2347-L2365
 814 fn get_var(var_base: &str, host: &str, target: &str) -> Option<OsString> {
 815     let kind = if host == target { "HOST" } else { "TARGET" };
 816     let target_u = target.replace("-", "_");
 817     env::var_os(&format!("{}_{}", var_base, target))
 818         .or_else(|| env::var_os(&format!("{}_{}", var_base, target_u)))
 819         .or_else(|| env::var_os(&format!("{}_{}", kind, var_base)))
 820         .or_else(|| env::var_os(var_base))
 821 }
 822
 823 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 824 pub struct Lld {
 825     pub target: TargetSelection,
 826 }
 827
 828 impl Step for Lld {
 829     type Output = PathBuf;
 830     const ONLY_HOSTS: bool = true;
 831
 832     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 833         run.path("src/llvm-project/lld")
 834     }
 835
 836     fn make_run(run: RunConfig<'_>) {
 837         run.builder.ensure(Lld { target: run.target });
 838     }
 839
 840     /// Compile LLD for `target`.
 841     fn run(self, builder: &Builder<'_>) -> PathBuf {
 842         if builder.config.dry_run {
 843             return PathBuf::from("lld-out-dir-test-gen");
 844         }
 845         let target = self.target;
 846
 847         let llvm_config = builder.ensure(Llvm { target: self.target });
 848
 849         let out_dir = builder.lld_out(target);
 850         let done_stamp = out_dir.join("lld-finished-building");
 851         if done_stamp.exists() {
 852             return out_dir;
 853         }
 854
 855         builder.info(&format!("Building LLD for {}", target));
 856         let _time = util::timeit(&builder);
 857         t!(fs::create_dir_all(&out_dir));
 858
 859         let mut cfg = cmake::Config::new(builder.src.join("src/llvm-project/lld"));
 860         let mut ldflags = LdFlags::default();
 861
 862         // When building LLD as part of a build with instrumentation on windows, for example
 863         // when doing PGO on CI, cmake or clang-cl don't automatically link clang's
 864         // profiler runtime in. In that case, we need to manually ask cmake to do it, to avoid
 865         // linking errors, much like LLVM's cmake setup does in that situation.
 866         if builder.config.llvm_profile_generate && target.contains("msvc") {
 867             if let Some(clang_cl_path) = builder.config.llvm_clang_cl.as_ref() {
 868                 // Find clang's runtime library directory and push that as a search path to the
 869                 // cmake linker flags.
 870                 let clang_rt_dir = get_clang_cl_resource_dir(clang_cl_path);
 871                 ldflags.push_all(&format!("/libpath:{}", clang_rt_dir.display()));
 872             }
 873         }
 874
 875         configure_cmake(builder, target, &mut cfg, true, ldflags);
 876         configure_llvm(builder, target, &mut cfg);
 877
 878         // This is an awful, awful hack. Discovered when we migrated to using
 879         // clang-cl to compile LLVM/LLD it turns out that LLD, when built out of
 880         // tree, will execute `llvm-config --cmakedir` and then tell CMake about
 881         // that directory for later processing. Unfortunately if this path has
 882         // forward slashes in it (which it basically always does on Windows)
 883         // then CMake will hit a syntax error later on as... something isn't
 884         // escaped it seems?
 885         //
 886         // Instead of attempting to fix this problem in upstream CMake and/or
 887         // LLVM/LLD we just hack around it here. This thin wrapper will take the
 888         // output from llvm-config and replace all instances of `\` with `/` to
 889         // ensure we don't hit the same bugs with escaping. It means that you
 890         // can't build on a system where your paths require `\` on Windows, but
 891         // there's probably a lot of reasons you can't do that other than this.
 892         let llvm_config_shim = env::current_exe().unwrap().with_file_name("llvm-config-wrapper");
 893
 894         // Re-use the same flags as llvm to control the level of debug information
 895         // generated for lld.
 896         let profile = match (builder.config.llvm_optimize, builder.config.llvm_release_debuginfo) {
 897             (false, _) => "Debug",
 898             (true, false) => "Release",
 899             (true, true) => "RelWithDebInfo",
 900         };
 901
 902         cfg.out_dir(&out_dir)
 903             .profile(profile)
 904             .env("LLVM_CONFIG_REAL", &llvm_config)
 905             .define("LLVM_CONFIG_PATH", llvm_config_shim)
 906             .define("LLVM_INCLUDE_TESTS", "OFF");
 907
 908         // While we're using this horrible workaround to shim the execution of
 909         // llvm-config, let's just pile on more. I can't seem to figure out how
 910         // to build LLD as a standalone project and also cross-compile it at the
 911         // same time. It wants a natively executable `llvm-config` to learn
 912         // about LLVM, but then it learns about all the host configuration of
 913         // LLVM and tries to link to host LLVM libraries.
 914         //
 915         // To work around that we tell our shim to replace anything with the
 916         // build target with the actual target instead. This'll break parts of
 917         // LLD though which try to execute host tools, such as llvm-tblgen, so
 918         // we specifically tell it where to find those. This is likely super
 919         // brittle and will break over time. If anyone knows better how to
 920         // cross-compile LLD it would be much appreciated to fix this!
 921         if target != builder.config.build {
 922             cfg.env("LLVM_CONFIG_SHIM_REPLACE", &builder.config.build.triple)
 923                 .env("LLVM_CONFIG_SHIM_REPLACE_WITH", &target.triple)
 924                 .define(
 925                     "LLVM_TABLEGEN_EXE",
 926                     llvm_config.with_file_name("llvm-tblgen").with_extension(EXE_EXTENSION),
 927                 );
 928         }
 929
 930         // Explicitly set C++ standard, because upstream doesn't do so
 931         // for standalone builds.
 932         cfg.define("CMAKE_CXX_STANDARD", "14");
 933
 934         cfg.build();
 935
 936         t!(File::create(&done_stamp));
 937         out_dir
 938     }
 939 }
 940
 941 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 942 pub struct TestHelpers {
 943     pub target: TargetSelection,
 944 }
 945
 946 impl Step for TestHelpers {
 947     type Output = ();
 948
 949     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 950         run.path("src/test/auxiliary/rust_test_helpers.c")
 951     }
 952
 953     fn make_run(run: RunConfig<'_>) {
 954         run.builder.ensure(TestHelpers { target: run.target })
 955     }
 956
 957     /// Compiles the `rust_test_helpers.c` library which we used in various
 958     /// `run-pass` tests for ABI testing.
 959     fn run(self, builder: &Builder<'_>) {
 960         if builder.config.dry_run {
 961             return;
 962         }
 963         // The x86_64-fortanix-unknown-sgx target doesn't have a working C
 964         // toolchain. However, some x86_64 ELF objects can be linked
 965         // without issues. Use this hack to compile the test helpers.
 966         let target = if self.target == "x86_64-fortanix-unknown-sgx" {
 967             TargetSelection::from_user("x86_64-unknown-linux-gnu")
 968         } else {
 969             self.target
 970         };
 971         let dst = builder.test_helpers_out(target);
 972         let src = builder.src.join("src/test/auxiliary/rust_test_helpers.c");
 973         if up_to_date(&src, &dst.join("librust_test_helpers.a")) {
 974             return;
 975         }
 976
 977         builder.info("Building test helpers");
 978         t!(fs::create_dir_all(&dst));
 979         let mut cfg = cc::Build::new();
 980         // FIXME: Workaround for https://github.com/emscripten-core/emscripten/issues/9013
 981         if target.contains("emscripten") {
 982             cfg.pic(false);
 983         }
 984
 985         // We may have found various cross-compilers a little differently due to our
 986         // extra configuration, so inform cc of these compilers. Note, though, that
 987         // on MSVC we still need cc's detection of env vars (ugh).
 988         if !target.contains("msvc") {
 989             if let Some(ar) = builder.ar(target) {
 990                 cfg.archiver(ar);
 991             }
 992             cfg.compiler(builder.cc(target));
 993         }
 994         cfg.cargo_metadata(false)
 995             .out_dir(&dst)
 996             .target(&target.triple)
 997             .host(&builder.config.build.triple)
 998             .opt_level(0)
 999             .warnings(false)
1000             .debug(false)
1001             .file(builder.src.join("src/test/auxiliary/rust_test_helpers.c"))
1002             .compile("rust_test_helpers");
1003     }
1004 }
1005
1006 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1007 pub struct Sanitizers {
1008     pub target: TargetSelection,
1009 }
1010
1011 impl Step for Sanitizers {
1012     type Output = Vec<SanitizerRuntime>;
1013
1014     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1015         run.alias("sanitizers")
1016     }
1017
1018     fn make_run(run: RunConfig<'_>) {
1019         run.builder.ensure(Sanitizers { target: run.target });
1020     }
1021
1022     /// Builds sanitizer runtime libraries.
1023     fn run(self, builder: &Builder<'_>) -> Self::Output {
1024         let compiler_rt_dir = builder.src.join("src/llvm-project/compiler-rt");
1025         if !compiler_rt_dir.exists() {
1026             return Vec::new();
1027         }
1028
1029         let out_dir = builder.native_dir(self.target).join("sanitizers");
1030         let runtimes = supported_sanitizers(&out_dir, self.target, &builder.config.channel);
1031         if runtimes.is_empty() {
1032             return runtimes;
1033         }
1034
1035         let llvm_config = builder.ensure(Llvm { target: builder.config.build });
1036         if builder.config.dry_run {
1037             return runtimes;
1038         }
1039
1040         let stamp = out_dir.join("sanitizers-finished-building");
1041         let stamp = HashStamp::new(stamp, builder.in_tree_llvm_info.sha());
1042
1043         if stamp.is_done() {
1044             if stamp.hash.is_none() {
1045                 builder.info(&format!(
1046                     "Rebuild sanitizers by removing the file `{}`",
1047                     stamp.path.display()
1048                 ));
1049             }
1050             return runtimes;
1051         }
1052
1053         builder.info(&format!("Building sanitizers for {}", self.target));
1054         t!(stamp.remove());
1055         let _time = util::timeit(&builder);
1056
1057         let mut cfg = cmake::Config::new(&compiler_rt_dir);
1058         cfg.profile("Release");
1059         cfg.define("CMAKE_C_COMPILER_TARGET", self.target.triple);
1060         cfg.define("COMPILER_RT_BUILD_BUILTINS", "OFF");
1061         cfg.define("COMPILER_RT_BUILD_CRT", "OFF");
1062         cfg.define("COMPILER_RT_BUILD_LIBFUZZER", "OFF");
1063         cfg.define("COMPILER_RT_BUILD_PROFILE", "OFF");
1064         cfg.define("COMPILER_RT_BUILD_SANITIZERS", "ON");
1065         cfg.define("COMPILER_RT_BUILD_XRAY", "OFF");
1066         cfg.define("COMPILER_RT_DEFAULT_TARGET_ONLY", "ON");
1067         cfg.define("COMPILER_RT_USE_LIBCXX", "OFF");
1068         cfg.define("LLVM_CONFIG_PATH", &llvm_config);
1069
1070         // On Darwin targets the sanitizer runtimes are build as universal binaries.
1071         // Unfortunately sccache currently lacks support to build them successfully.
1072         // Disable compiler launcher on Darwin targets to avoid potential issues.
1073         let use_compiler_launcher = !self.target.contains("apple-darwin");
1074         configure_cmake(builder, self.target, &mut cfg, use_compiler_launcher, LdFlags::default());
1075
1076         t!(fs::create_dir_all(&out_dir));
1077         cfg.out_dir(out_dir);
1078
1079         for runtime in &runtimes {
1080             cfg.build_target(&runtime.cmake_target);
1081             cfg.build();
1082         }
1083         t!(stamp.write());
1084
1085         runtimes
1086     }
1087 }
1088
1089 #[derive(Clone, Debug)]
1090 pub struct SanitizerRuntime {
1091     /// CMake target used to build the runtime.
1092     pub cmake_target: String,
1093     /// Path to the built runtime library.
1094     pub path: PathBuf,
1095     /// Library filename that will be used rustc.
1096     pub name: String,
1097 }
1098
1099 /// Returns sanitizers available on a given target.
1100 fn supported_sanitizers(
1101     out_dir: &Path,
1102     target: TargetSelection,
1103     channel: &str,
1104 ) -> Vec<SanitizerRuntime> {
1105     let darwin_libs = |os: &str, components: &[&str]| -> Vec<SanitizerRuntime> {
1106         components
1107             .iter()
1108             .map(move |c| SanitizerRuntime {
1109                 cmake_target: format!("clang_rt.{}_{}_dynamic", c, os),
1110                 path: out_dir
1111                     .join(&format!("build/lib/darwin/libclang_rt.{}_{}_dynamic.dylib", c, os)),
1112                 name: format!("librustc-{}_rt.{}.dylib", channel, c),
1113             })
1114             .collect()
1115     };
1116
1117     let common_libs = |os: &str, arch: &str, components: &[&str]| -> Vec<SanitizerRuntime> {
1118         components
1119             .iter()
1120             .map(move |c| SanitizerRuntime {
1121                 cmake_target: format!("clang_rt.{}-{}", c, arch),
1122                 path: out_dir.join(&format!("build/lib/{}/libclang_rt.{}-{}.a", os, c, arch)),
1123                 name: format!("librustc-{}_rt.{}.a", channel, c),
1124             })
1125             .collect()
1126     };
1127
1128     match &*target.triple {
1129         "aarch64-apple-darwin" => darwin_libs("osx", &["asan", "lsan", "tsan"]),
1130         "aarch64-fuchsia" => common_libs("fuchsia", "aarch64", &["asan"]),
1131         "aarch64-unknown-linux-gnu" => {
1132             common_libs("linux", "aarch64", &["asan", "lsan", "msan", "tsan", "hwasan"])
1133         }
1134         "x86_64-apple-darwin" => darwin_libs("osx", &["asan", "lsan", "tsan"]),
1135         "x86_64-fuchsia" => common_libs("fuchsia", "x86_64", &["asan"]),
1136         "x86_64-unknown-freebsd" => common_libs("freebsd", "x86_64", &["asan", "msan", "tsan"]),
1137         "x86_64-unknown-netbsd" => {
1138             common_libs("netbsd", "x86_64", &["asan", "lsan", "msan", "tsan"])
1139         }
1140         "x86_64-unknown-illumos" => common_libs("illumos", "x86_64", &["asan"]),
1141         "x86_64-pc-solaris" => common_libs("solaris", "x86_64", &["asan"]),
1142         "x86_64-unknown-linux-gnu" => {
1143             common_libs("linux", "x86_64", &["asan", "lsan", "msan", "tsan"])
1144         }
1145         "x86_64-unknown-linux-musl" => {
1146             common_libs("linux", "x86_64", &["asan", "lsan", "msan", "tsan"])
1147         }
1148         _ => Vec::new(),
1149     }
1150 }
1151
1152 struct HashStamp {
1153     path: PathBuf,
1154     hash: Option<Vec<u8>>,
1155 }
1156
1157 impl HashStamp {
1158     fn new(path: PathBuf, hash: Option<&str>) -> Self {
1159         HashStamp { path, hash: hash.map(|s| s.as_bytes().to_owned()) }
1160     }
1161
1162     fn is_done(&self) -> bool {
1163         match fs::read(&self.path) {
1164             Ok(h) => self.hash.as_deref().unwrap_or(b"") == h.as_slice(),
1165             Err(e) if e.kind() == io::ErrorKind::NotFound => false,
1166             Err(e) => {
1167                 panic!("failed to read stamp file `{}`: {}", self.path.display(), e);
1168             }
1169         }
1170     }
1171
1172     fn remove(&self) -> io::Result<()> {
1173         match fs::remove_file(&self.path) {
1174             Ok(()) => Ok(()),
1175             Err(e) => {
1176                 if e.kind() == io::ErrorKind::NotFound {
1177                     Ok(())
1178                 } else {
1179                     Err(e)
1180                 }
1181             }
1182         }
1183     }
1184
1185     fn write(&self) -> io::Result<()> {
1186         fs::write(&self.path, self.hash.as_deref().unwrap_or(b""))
1187     }
1188 }
1189
1190 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1191 pub struct CrtBeginEnd {
1192     pub target: TargetSelection,
1193 }
1194
1195 impl Step for CrtBeginEnd {
1196     type Output = PathBuf;
1197
1198     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1199         run.path("src/llvm-project/compiler-rt/lib/crt")
1200     }
1201
1202     fn make_run(run: RunConfig<'_>) {
1203         run.builder.ensure(CrtBeginEnd { target: run.target });
1204     }
1205
1206     /// Build crtbegin.o/crtend.o for musl target.
1207     fn run(self, builder: &Builder<'_>) -> Self::Output {
1208         let out_dir = builder.native_dir(self.target).join("crt");
1209
1210         if builder.config.dry_run {
1211             return out_dir;
1212         }
1213
1214         let crtbegin_src = builder.src.join("src/llvm-project/compiler-rt/lib/crt/crtbegin.c");
1215         let crtend_src = builder.src.join("src/llvm-project/compiler-rt/lib/crt/crtend.c");
1216         if up_to_date(&crtbegin_src, &out_dir.join("crtbegin.o"))
1217             && up_to_date(&crtend_src, &out_dir.join("crtendS.o"))
1218         {
1219             return out_dir;
1220         }
1221
1222         builder.info("Building crtbegin.o and crtend.o");
1223         t!(fs::create_dir_all(&out_dir));
1224
1225         let mut cfg = cc::Build::new();
1226
1227         if let Some(ar) = builder.ar(self.target) {
1228             cfg.archiver(ar);
1229         }
1230         cfg.compiler(builder.cc(self.target));
1231         cfg.cargo_metadata(false)
1232             .out_dir(&out_dir)
1233             .target(&self.target.triple)
1234             .host(&builder.config.build.triple)
1235             .warnings(false)
1236             .debug(false)
1237             .opt_level(3)
1238             .file(crtbegin_src)
1239             .file(crtend_src);
1240
1241         // Those flags are defined in src/llvm-project/compiler-rt/lib/crt/CMakeLists.txt
1242         // Currently only consumer of those objects is musl, which use .init_array/.fini_array
1243         // instead of .ctors/.dtors
1244         cfg.flag("-std=c11")
1245             .define("CRT_HAS_INITFINI_ARRAY", None)
1246             .define("EH_USE_FRAME_REGISTRY", None);
1247
1248         cfg.compile("crt");
1249
1250         t!(fs::copy(out_dir.join("crtbegin.o"), out_dir.join("crtbeginS.o")));
1251         t!(fs::copy(out_dir.join("crtend.o"), out_dir.join("crtendS.o")));
1252         out_dir
1253     }
1254 }
1255
1256 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1257 pub struct Libunwind {
1258     pub target: TargetSelection,
1259 }
1260
1261 impl Step for Libunwind {
1262     type Output = PathBuf;
1263
1264     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1265         run.path("src/llvm-project/libunwind")
1266     }
1267
1268     fn make_run(run: RunConfig<'_>) {
1269         run.builder.ensure(Libunwind { target: run.target });
1270     }
1271
1272     /// Build linunwind.a
1273     fn run(self, builder: &Builder<'_>) -> Self::Output {
1274         if builder.config.dry_run {
1275             return PathBuf::new();
1276         }
1277
1278         let out_dir = builder.native_dir(self.target).join("libunwind");
1279         let root = builder.src.join("src/llvm-project/libunwind");
1280
1281         if up_to_date(&root, &out_dir.join("libunwind.a")) {
1282             return out_dir;
1283         }
1284
1285         builder.info(&format!("Building libunwind.a for {}", self.target.triple));
1286         t!(fs::create_dir_all(&out_dir));
1287
1288         let mut cc_cfg = cc::Build::new();
1289         let mut cpp_cfg = cc::Build::new();
1290
1291         cpp_cfg.cpp(true);
1292         cpp_cfg.cpp_set_stdlib(None);
1293         cpp_cfg.flag("-nostdinc++");
1294         cpp_cfg.flag("-fno-exceptions");
1295         cpp_cfg.flag("-fno-rtti");
1296         cpp_cfg.flag_if_supported("-fvisibility-global-new-delete-hidden");
1297
1298         for cfg in [&mut cc_cfg, &mut cpp_cfg].iter_mut() {
1299             if let Some(ar) = builder.ar(self.target) {
1300                 cfg.archiver(ar);
1301             }
1302             cfg.target(&self.target.triple);
1303             cfg.host(&builder.config.build.triple);
1304             cfg.warnings(false);
1305             cfg.debug(false);
1306             // get_compiler() need set opt_level first.
1307             cfg.opt_level(3);
1308             cfg.flag("-fstrict-aliasing");
1309             cfg.flag("-funwind-tables");
1310             cfg.flag("-fvisibility=hidden");
1311             cfg.define("_LIBUNWIND_DISABLE_VISIBILITY_ANNOTATIONS", None);
1312             cfg.include(root.join("include"));
1313             cfg.cargo_metadata(false);
1314             cfg.out_dir(&out_dir);
1315
1316             if self.target.contains("x86_64-fortanix-unknown-sgx") {
1317                 cfg.static_flag(true);
1318                 cfg.flag("-fno-stack-protector");
1319                 cfg.flag("-ffreestanding");
1320                 cfg.flag("-fexceptions");
1321
1322                 // easiest way to undefine since no API available in cc::Build to undefine
1323                 cfg.flag("-U_FORTIFY_SOURCE");
1324                 cfg.define("_FORTIFY_SOURCE", "0");
1325                 cfg.define("RUST_SGX", "1");
1326                 cfg.define("__NO_STRING_INLINES", None);
1327                 cfg.define("__NO_MATH_INLINES", None);
1328                 cfg.define("_LIBUNWIND_IS_BAREMETAL", None);
1329                 cfg.define("__LIBUNWIND_IS_NATIVE_ONLY", None);
1330                 cfg.define("NDEBUG", None);
1331             }
1332             if self.target.contains("windows") {
1333                 cfg.define("_LIBUNWIND_HIDE_SYMBOLS", "1");
1334                 cfg.define("_LIBUNWIND_IS_NATIVE_ONLY", "1");
1335             }
1336         }
1337
1338         cc_cfg.compiler(builder.cc(self.target));
1339         if let Ok(cxx) = builder.cxx(self.target) {
1340             cpp_cfg.compiler(cxx);
1341         } else {
1342             cc_cfg.compiler(builder.cc(self.target));
1343         }
1344
1345         // Don't set this for clang
1346         // By default, Clang builds C code in GNU C17 mode.
1347         // By default, Clang builds C++ code according to the C++98 standard,
1348         // with many C++11 features accepted as extensions.
1349         if cc_cfg.get_compiler().is_like_gnu() {
1350             cc_cfg.flag("-std=c99");
1351         }
1352         if cpp_cfg.get_compiler().is_like_gnu() {
1353             cpp_cfg.flag("-std=c++11");
1354         }
1355
1356         if self.target.contains("x86_64-fortanix-unknown-sgx") || self.target.contains("musl") {
1357             // use the same GCC C compiler command to compile C++ code so we do not need to setup the
1358             // C++ compiler env variables on the builders.
1359             // Don't set this for clang++, as clang++ is able to compile this without libc++.
1360             if cpp_cfg.get_compiler().is_like_gnu() {
1361                 cpp_cfg.cpp(false);
1362                 cpp_cfg.compiler(builder.cc(self.target));
1363             }
1364         }
1365
1366         let mut c_sources = vec![
1367             "Unwind-sjlj.c",
1368             "UnwindLevel1-gcc-ext.c",
1369             "UnwindLevel1.c",
1370             "UnwindRegistersRestore.S",
1371             "UnwindRegistersSave.S",
1372         ];
1373
1374         let cpp_sources = vec!["Unwind-EHABI.cpp", "Unwind-seh.cpp", "libunwind.cpp"];
1375         let cpp_len = cpp_sources.len();
1376
1377         if self.target.contains("x86_64-fortanix-unknown-sgx") {
1378             c_sources.push("UnwindRustSgx.c");
1379         }
1380
1381         for src in c_sources {
1382             cc_cfg.file(root.join("src").join(src).canonicalize().unwrap());
1383         }
1384
1385         for src in &cpp_sources {
1386             cpp_cfg.file(root.join("src").join(src).canonicalize().unwrap());
1387         }
1388
1389         cpp_cfg.compile("unwind-cpp");
1390
1391         // FIXME: https://github.com/alexcrichton/cc-rs/issues/545#issuecomment-679242845
1392         let mut count = 0;
1393         for entry in fs::read_dir(&out_dir).unwrap() {
1394             let file = entry.unwrap().path().canonicalize().unwrap();
1395             if file.is_file() && file.extension() == Some(OsStr::new("o")) {
1396                 // file name starts with "Unwind-EHABI", "Unwind-seh" or "libunwind"
1397                 let file_name = file.file_name().unwrap().to_str().expect("UTF-8 file name");
1398                 if cpp_sources.iter().any(|f| file_name.starts_with(&f[..f.len() - 4])) {
1399                     cc_cfg.object(&file);
1400                     count += 1;
1401                 }
1402             }
1403         }
1404         assert_eq!(cpp_len, count, "Can't get object files from {:?}", &out_dir);
1405
1406         cc_cfg.compile("unwind");
1407         out_dir
1408     }
1409 }