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         if builder.llvm_link_shared() {
 427             cfg.define("LLVM_LINK_LLVM_DYLIB", "ON");
 428         }
 429
 430         if target.starts_with("riscv") && !target.contains("freebsd") && !target.contains("openbsd")
 431         {
 432             // RISC-V GCC erroneously requires linking against
 433             // `libatomic` when using 1-byte and 2-byte C++
 434             // atomics but the LLVM build system check cannot
 435             // detect this. Therefore it is set manually here.
 436             // Some BSD uses Clang as its system compiler and
 437             // provides no libatomic in its base system so does
 438             // not want this.
 439             ldflags.exe.push(" -latomic");
 440             ldflags.shared.push(" -latomic");
 441         }
 442
 443         if target.contains("msvc") {
 444             cfg.define("LLVM_USE_CRT_DEBUG", "MT");
 445             cfg.define("LLVM_USE_CRT_RELEASE", "MT");
 446             cfg.define("LLVM_USE_CRT_RELWITHDEBINFO", "MT");
 447             cfg.static_crt(true);
 448         }
 449
 450         if target.starts_with("i686") {
 451             cfg.define("LLVM_BUILD_32_BITS", "ON");
 452         }
 453
 454         let mut enabled_llvm_projects = Vec::new();
 455
 456         if util::forcing_clang_based_tests() {
 457             enabled_llvm_projects.push("clang");
 458             enabled_llvm_projects.push("compiler-rt");
 459         }
 460
 461         if builder.config.llvm_polly {
 462             enabled_llvm_projects.push("polly");
 463         }
 464
 465         if builder.config.llvm_clang {
 466             enabled_llvm_projects.push("clang");
 467         }
 468
 469         // We want libxml to be disabled.
 470         // See https://github.com/rust-lang/rust/pull/50104
 471         cfg.define("LLVM_ENABLE_LIBXML2", "OFF");
 472
 473         if !enabled_llvm_projects.is_empty() {
 474             enabled_llvm_projects.sort();
 475             enabled_llvm_projects.dedup();
 476             cfg.define("LLVM_ENABLE_PROJECTS", enabled_llvm_projects.join(";"));
 477         }
 478
 479         if let Some(num_linkers) = builder.config.llvm_link_jobs {
 480             if num_linkers > 0 {
 481                 cfg.define("LLVM_PARALLEL_LINK_JOBS", num_linkers.to_string());
 482             }
 483         }
 484
 485         // Workaround for ppc32 lld limitation
 486         if target == "powerpc-unknown-freebsd" {
 487             ldflags.exe.push(" -fuse-ld=bfd");
 488         }
 489
 490         // https://llvm.org/docs/HowToCrossCompileLLVM.html
 491         if target != builder.config.build {
 492             builder.ensure(Llvm { target: builder.config.build });
 493             // FIXME: if the llvm root for the build triple is overridden then we
 494             //        should use llvm-tblgen from there, also should verify that it
 495             //        actually exists most of the time in normal installs of LLVM.
 496             let host_bin = builder.llvm_out(builder.config.build).join("bin");
 497             cfg.define("LLVM_TABLEGEN", host_bin.join("llvm-tblgen").with_extension(EXE_EXTENSION));
 498             // LLVM_NM is required for cross compiling using MSVC
 499             cfg.define("LLVM_NM", host_bin.join("llvm-nm").with_extension(EXE_EXTENSION));
 500             cfg.define(
 501                 "LLVM_CONFIG_PATH",
 502                 host_bin.join("llvm-config").with_extension(EXE_EXTENSION),
 503             );
 504             if builder.config.llvm_clang {
 505                 let build_bin = builder.llvm_out(builder.config.build).join("build").join("bin");
 506                 let clang_tblgen = build_bin.join("clang-tblgen").with_extension(EXE_EXTENSION);
 507                 if !builder.config.dry_run && !clang_tblgen.exists() {
 508                     panic!("unable to find {}", clang_tblgen.display());
 509                 }
 510                 cfg.define("CLANG_TABLEGEN", clang_tblgen);
 511             }
 512         }
 513
 514         let llvm_version_suffix = if let Some(ref suffix) = builder.config.llvm_version_suffix {
 515             // Allow version-suffix="" to not define a version suffix at all.
 516             if !suffix.is_empty() { Some(suffix.to_string()) } else { None }
 517         } else if builder.config.channel == "dev" {
 518             // Changes to a version suffix require a complete rebuild of the LLVM.
 519             // To avoid rebuilds during a time of version bump, don't include rustc
 520             // release number on the dev channel.
 521             Some("-rust-dev".to_string())
 522         } else {
 523             Some(format!("-rust-{}-{}", builder.version, builder.config.channel))
 524         };
 525         if let Some(ref suffix) = llvm_version_suffix {
 526             cfg.define("LLVM_VERSION_SUFFIX", suffix);
 527         }
 528
 529         configure_cmake(builder, target, &mut cfg, true, ldflags);
 530         configure_llvm(builder, target, &mut cfg);
 531
 532         for (key, val) in &builder.config.llvm_build_config {
 533             cfg.define(key, val);
 534         }
 535
 536         // FIXME: we don't actually need to build all LLVM tools and all LLVM
 537         //        libraries here, e.g., we just want a few components and a few
 538         //        tools. Figure out how to filter them down and only build the right
 539         //        tools and libs on all platforms.
 540
 541         if builder.config.dry_run {
 542             return build_llvm_config;
 543         }
 544
 545         cfg.build();
 546
 547         // When building LLVM with LLVM_LINK_LLVM_DYLIB for macOS, an unversioned
 548         // libLLVM.dylib will be built. However, llvm-config will still look
 549         // for a versioned path like libLLVM-14.dylib. Manually create a symbolic
 550         // link to make llvm-config happy.
 551         if builder.llvm_link_shared() && target.contains("apple-darwin") {
 552             let mut cmd = Command::new(&build_llvm_config);
 553             let version = output(cmd.arg("--version"));
 554             let major = version.split('.').next().unwrap();
 555             let lib_name = match llvm_version_suffix {
 556                 Some(s) => format!("libLLVM-{}{}.dylib", major, s),
 557                 None => format!("libLLVM-{}.dylib", major),
 558             };
 559
 560             let lib_llvm = out_dir.join("build").join("lib").join(lib_name);
 561             if !lib_llvm.exists() {
 562                 t!(builder.symlink_file("libLLVM.dylib", &lib_llvm));
 563             }
 564         }
 565
 566         t!(stamp.write());
 567
 568         build_llvm_config
 569     }
 570 }
 571
 572 fn check_llvm_version(builder: &Builder<'_>, llvm_config: &Path) {
 573     if !builder.config.llvm_version_check {
 574         return;
 575     }
 576
 577     if builder.config.dry_run {
 578         return;
 579     }
 580
 581     let mut cmd = Command::new(llvm_config);
 582     let version = output(cmd.arg("--version"));
 583     let mut parts = version.split('.').take(2).filter_map(|s| s.parse::<u32>().ok());
 584     if let (Some(major), Some(_minor)) = (parts.next(), parts.next()) {
 585         if major >= 13 {
 586             return;
 587         }
 588     }
 589     panic!("\n\nbad LLVM version: {}, need >=13.0\n\n", version)
 590 }
 591
 592 fn configure_cmake(
 593     builder: &Builder<'_>,
 594     target: TargetSelection,
 595     cfg: &mut cmake::Config,
 596     use_compiler_launcher: bool,
 597     mut ldflags: LdFlags,
 598 ) {
 599     // Do not print installation messages for up-to-date files.
 600     // LLVM and LLD builds can produce a lot of those and hit CI limits on log size.
 601     cfg.define("CMAKE_INSTALL_MESSAGE", "LAZY");
 602
 603     // Do not allow the user's value of DESTDIR to influence where
 604     // LLVM will install itself. LLVM must always be installed in our
 605     // own build directories.
 606     cfg.env("DESTDIR", "");
 607
 608     if builder.ninja() {
 609         cfg.generator("Ninja");
 610     }
 611     cfg.target(&target.triple).host(&builder.config.build.triple);
 612
 613     if target != builder.config.build {
 614         cfg.define("CMAKE_CROSSCOMPILING", "True");
 615
 616         if target.contains("netbsd") {
 617             cfg.define("CMAKE_SYSTEM_NAME", "NetBSD");
 618         } else if target.contains("freebsd") {
 619             cfg.define("CMAKE_SYSTEM_NAME", "FreeBSD");
 620         } else if target.contains("windows") {
 621             cfg.define("CMAKE_SYSTEM_NAME", "Windows");
 622         } else if target.contains("haiku") {
 623             cfg.define("CMAKE_SYSTEM_NAME", "Haiku");
 624         } else if target.contains("solaris") || target.contains("illumos") {
 625             cfg.define("CMAKE_SYSTEM_NAME", "SunOS");
 626         }
 627         // When cross-compiling we should also set CMAKE_SYSTEM_VERSION, but in
 628         // that case like CMake we cannot easily determine system version either.
 629         //
 630         // Since, the LLVM itself makes rather limited use of version checks in
 631         // CMakeFiles (and then only in tests), and so far no issues have been
 632         // reported, the system version is currently left unset.
 633
 634         if target.contains("darwin") {
 635             // Make sure that CMake does not build universal binaries on macOS.
 636             // Explicitly specify the one single target architecture.
 637             if target.starts_with("aarch64") {
 638                 // macOS uses a different name for building arm64
 639                 cfg.define("CMAKE_OSX_ARCHITECTURES", "arm64");
 640             } else {
 641                 cfg.define("CMAKE_OSX_ARCHITECTURES", target.triple.split('-').next().unwrap());
 642             }
 643         }
 644     }
 645
 646     let sanitize_cc = |cc: &Path| {
 647         if target.contains("msvc") {
 648             OsString::from(cc.to_str().unwrap().replace("\\", "/"))
 649         } else {
 650             cc.as_os_str().to_owned()
 651         }
 652     };
 653
 654     // MSVC with CMake uses msbuild by default which doesn't respect these
 655     // vars that we'd otherwise configure. In that case we just skip this
 656     // entirely.
 657     if target.contains("msvc") && !builder.ninja() {
 658         return;
 659     }
 660
 661     let (cc, cxx) = match builder.config.llvm_clang_cl {
 662         Some(ref cl) => (cl.as_ref(), cl.as_ref()),
 663         None => (builder.cc(target), builder.cxx(target).unwrap()),
 664     };
 665
 666     // Handle msvc + ninja + ccache specially (this is what the bots use)
 667     if target.contains("msvc") && builder.ninja() && builder.config.ccache.is_some() {
 668         let mut wrap_cc = env::current_exe().expect("failed to get cwd");
 669         wrap_cc.set_file_name("sccache-plus-cl.exe");
 670
 671         cfg.define("CMAKE_C_COMPILER", sanitize_cc(&wrap_cc))
 672             .define("CMAKE_CXX_COMPILER", sanitize_cc(&wrap_cc));
 673         cfg.env("SCCACHE_PATH", builder.config.ccache.as_ref().unwrap())
 674             .env("SCCACHE_TARGET", target.triple)
 675             .env("SCCACHE_CC", &cc)
 676             .env("SCCACHE_CXX", &cxx);
 677
 678         // Building LLVM on MSVC can be a little ludicrous at times. We're so far
 679         // off the beaten path here that I'm not really sure this is even half
 680         // supported any more. Here we're trying to:
 681         //
 682         // * Build LLVM on MSVC
 683         // * Build LLVM with `clang-cl` instead of `cl.exe`
 684         // * Build a project with `sccache`
 685         // * Build for 32-bit as well
 686         // * Build with Ninja
 687         //
 688         // For `cl.exe` there are different binaries to compile 32/64 bit which
 689         // we use but for `clang-cl` there's only one which internally
 690         // multiplexes via flags. As a result it appears that CMake's detection
 691         // of a compiler's architecture and such on MSVC **doesn't** pass any
 692         // custom flags we pass in CMAKE_CXX_FLAGS below. This means that if we
 693         // use `clang-cl.exe` it's always diagnosed as a 64-bit compiler which
 694         // definitely causes problems since all the env vars are pointing to
 695         // 32-bit libraries.
 696         //
 697         // To hack around this... again... we pass an argument that's
 698         // unconditionally passed in the sccache shim. This'll get CMake to
 699         // correctly diagnose it's doing a 32-bit compilation and LLVM will
 700         // internally configure itself appropriately.
 701         if builder.config.llvm_clang_cl.is_some() && target.contains("i686") {
 702             cfg.env("SCCACHE_EXTRA_ARGS", "-m32");
 703         }
 704     } else {
 705         // If ccache is configured we inform the build a little differently how
 706         // to invoke ccache while also invoking our compilers.
 707         if use_compiler_launcher {
 708             if let Some(ref ccache) = builder.config.ccache {
 709                 cfg.define("CMAKE_C_COMPILER_LAUNCHER", ccache)
 710                     .define("CMAKE_CXX_COMPILER_LAUNCHER", ccache);
 711             }
 712         }
 713         cfg.define("CMAKE_C_COMPILER", sanitize_cc(cc))
 714             .define("CMAKE_CXX_COMPILER", sanitize_cc(cxx))
 715             .define("CMAKE_ASM_COMPILER", sanitize_cc(cc));
 716     }
 717
 718     cfg.build_arg("-j").build_arg(builder.jobs().to_string());
 719     let mut cflags: OsString = builder.cflags(target, GitRepo::Llvm, CLang::C).join(" ").into();
 720     if let Some(ref s) = builder.config.llvm_cflags {
 721         cflags.push(" ");
 722         cflags.push(s);
 723     }
 724     // Some compiler features used by LLVM (such as thread locals) will not work on a min version below iOS 10.
 725     if target.contains("apple-ios") {
 726         if target.contains("86-") {
 727             cflags.push(" -miphonesimulator-version-min=10.0");
 728         } else {
 729             cflags.push(" -miphoneos-version-min=10.0");
 730         }
 731     }
 732     if builder.config.llvm_clang_cl.is_some() {
 733         cflags.push(&format!(" --target={}", target));
 734     }
 735     cfg.define("CMAKE_C_FLAGS", cflags);
 736     let mut cxxflags: OsString = builder.cflags(target, GitRepo::Llvm, CLang::Cxx).join(" ").into();
 737     if let Some(ref s) = builder.config.llvm_cxxflags {
 738         cxxflags.push(" ");
 739         cxxflags.push(s);
 740     }
 741     if builder.config.llvm_clang_cl.is_some() {
 742         cxxflags.push(&format!(" --target={}", target));
 743     }
 744     cfg.define("CMAKE_CXX_FLAGS", cxxflags);
 745     if let Some(ar) = builder.ar(target) {
 746         if ar.is_absolute() {
 747             // LLVM build breaks if `CMAKE_AR` is a relative path, for some reason it
 748             // tries to resolve this path in the LLVM build directory.
 749             cfg.define("CMAKE_AR", sanitize_cc(ar));
 750         }
 751     }
 752
 753     if let Some(ranlib) = builder.ranlib(target) {
 754         if ranlib.is_absolute() {
 755             // LLVM build breaks if `CMAKE_RANLIB` is a relative path, for some reason it
 756             // tries to resolve this path in the LLVM build directory.
 757             cfg.define("CMAKE_RANLIB", sanitize_cc(ranlib));
 758         }
 759     }
 760
 761     if let Some(ref flags) = builder.config.llvm_ldflags {
 762         ldflags.push_all(flags);
 763     }
 764
 765     if let Some(flags) = get_var("LDFLAGS", &builder.config.build.triple, &target.triple) {
 766         ldflags.push_all(&flags);
 767     }
 768
 769     // For distribution we want the LLVM tools to be *statically* linked to libstdc++.
 770     // We also do this if the user explicitly requested static libstdc++.
 771     if builder.config.llvm_static_stdcpp {
 772         if !target.contains("msvc") && !target.contains("netbsd") && !target.contains("solaris") {
 773             if target.contains("apple") || target.contains("windows") {
 774                 ldflags.push_all("-static-libstdc++");
 775             } else {
 776                 ldflags.push_all("-Wl,-Bsymbolic -static-libstdc++");
 777             }
 778         }
 779     }
 780
 781     cfg.define("CMAKE_SHARED_LINKER_FLAGS", &ldflags.shared);
 782     cfg.define("CMAKE_MODULE_LINKER_FLAGS", &ldflags.module);
 783     cfg.define("CMAKE_EXE_LINKER_FLAGS", &ldflags.exe);
 784
 785     if env::var_os("SCCACHE_ERROR_LOG").is_some() {
 786         cfg.env("RUSTC_LOG", "sccache=warn");
 787     }
 788 }
 789
 790 fn configure_llvm(builder: &Builder<'_>, target: TargetSelection, cfg: &mut cmake::Config) {
 791     // ThinLTO is only available when building with LLVM, enabling LLD is required.
 792     // Apple's linker ld64 supports ThinLTO out of the box though, so don't use LLD on Darwin.
 793     if builder.config.llvm_thin_lto {
 794         cfg.define("LLVM_ENABLE_LTO", "Thin");
 795         if !target.contains("apple") {
 796             cfg.define("LLVM_ENABLE_LLD", "ON");
 797         }
 798     }
 799
 800     if let Some(ref linker) = builder.config.llvm_use_linker {
 801         cfg.define("LLVM_USE_LINKER", linker);
 802     }
 803
 804     if builder.config.llvm_allow_old_toolchain {
 805         cfg.define("LLVM_TEMPORARILY_ALLOW_OLD_TOOLCHAIN", "YES");
 806     }
 807 }
 808
 809 // Adapted from https://github.com/alexcrichton/cc-rs/blob/fba7feded71ee4f63cfe885673ead6d7b4f2f454/src/lib.rs#L2347-L2365
 810 fn get_var(var_base: &str, host: &str, target: &str) -> Option<OsString> {
 811     let kind = if host == target { "HOST" } else { "TARGET" };
 812     let target_u = target.replace("-", "_");
 813     env::var_os(&format!("{}_{}", var_base, target))
 814         .or_else(|| env::var_os(&format!("{}_{}", var_base, target_u)))
 815         .or_else(|| env::var_os(&format!("{}_{}", kind, var_base)))
 816         .or_else(|| env::var_os(var_base))
 817 }
 818
 819 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 820 pub struct Lld {
 821     pub target: TargetSelection,
 822 }
 823
 824 impl Step for Lld {
 825     type Output = PathBuf;
 826     const ONLY_HOSTS: bool = true;
 827
 828     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 829         run.path("src/llvm-project/lld")
 830     }
 831
 832     fn make_run(run: RunConfig<'_>) {
 833         run.builder.ensure(Lld { target: run.target });
 834     }
 835
 836     /// Compile LLD for `target`.
 837     fn run(self, builder: &Builder<'_>) -> PathBuf {
 838         if builder.config.dry_run {
 839             return PathBuf::from("lld-out-dir-test-gen");
 840         }
 841         let target = self.target;
 842
 843         let llvm_config = builder.ensure(Llvm { target: self.target });
 844
 845         let out_dir = builder.lld_out(target);
 846         let done_stamp = out_dir.join("lld-finished-building");
 847         if done_stamp.exists() {
 848             return out_dir;
 849         }
 850
 851         builder.info(&format!("Building LLD for {}", target));
 852         let _time = util::timeit(&builder);
 853         t!(fs::create_dir_all(&out_dir));
 854
 855         let mut cfg = cmake::Config::new(builder.src.join("src/llvm-project/lld"));
 856         let mut ldflags = LdFlags::default();
 857
 858         // When building LLD as part of a build with instrumentation on windows, for example
 859         // when doing PGO on CI, cmake or clang-cl don't automatically link clang's
 860         // profiler runtime in. In that case, we need to manually ask cmake to do it, to avoid
 861         // linking errors, much like LLVM's cmake setup does in that situation.
 862         if builder.config.llvm_profile_generate && target.contains("msvc") {
 863             if let Some(clang_cl_path) = builder.config.llvm_clang_cl.as_ref() {
 864                 // Find clang's runtime library directory and push that as a search path to the
 865                 // cmake linker flags.
 866                 let clang_rt_dir = get_clang_cl_resource_dir(clang_cl_path);
 867                 ldflags.push_all(&format!("/libpath:{}", clang_rt_dir.display()));
 868             }
 869         }
 870
 871         configure_cmake(builder, target, &mut cfg, true, ldflags);
 872         configure_llvm(builder, target, &mut cfg);
 873
 874         // This is an awful, awful hack. Discovered when we migrated to using
 875         // clang-cl to compile LLVM/LLD it turns out that LLD, when built out of
 876         // tree, will execute `llvm-config --cmakedir` and then tell CMake about
 877         // that directory for later processing. Unfortunately if this path has
 878         // forward slashes in it (which it basically always does on Windows)
 879         // then CMake will hit a syntax error later on as... something isn't
 880         // escaped it seems?
 881         //
 882         // Instead of attempting to fix this problem in upstream CMake and/or
 883         // LLVM/LLD we just hack around it here. This thin wrapper will take the
 884         // output from llvm-config and replace all instances of `\` with `/` to
 885         // ensure we don't hit the same bugs with escaping. It means that you
 886         // can't build on a system where your paths require `\` on Windows, but
 887         // there's probably a lot of reasons you can't do that other than this.
 888         let llvm_config_shim = env::current_exe().unwrap().with_file_name("llvm-config-wrapper");
 889
 890         // Re-use the same flags as llvm to control the level of debug information
 891         // generated for lld.
 892         let profile = match (builder.config.llvm_optimize, builder.config.llvm_release_debuginfo) {
 893             (false, _) => "Debug",
 894             (true, false) => "Release",
 895             (true, true) => "RelWithDebInfo",
 896         };
 897
 898         cfg.out_dir(&out_dir)
 899             .profile(profile)
 900             .env("LLVM_CONFIG_REAL", &llvm_config)
 901             .define("LLVM_CONFIG_PATH", llvm_config_shim)
 902             .define("LLVM_INCLUDE_TESTS", "OFF");
 903
 904         // While we're using this horrible workaround to shim the execution of
 905         // llvm-config, let's just pile on more. I can't seem to figure out how
 906         // to build LLD as a standalone project and also cross-compile it at the
 907         // same time. It wants a natively executable `llvm-config` to learn
 908         // about LLVM, but then it learns about all the host configuration of
 909         // LLVM and tries to link to host LLVM libraries.
 910         //
 911         // To work around that we tell our shim to replace anything with the
 912         // build target with the actual target instead. This'll break parts of
 913         // LLD though which try to execute host tools, such as llvm-tblgen, so
 914         // we specifically tell it where to find those. This is likely super
 915         // brittle and will break over time. If anyone knows better how to
 916         // cross-compile LLD it would be much appreciated to fix this!
 917         if target != builder.config.build {
 918             cfg.env("LLVM_CONFIG_SHIM_REPLACE", &builder.config.build.triple)
 919                 .env("LLVM_CONFIG_SHIM_REPLACE_WITH", &target.triple)
 920                 .define(
 921                     "LLVM_TABLEGEN_EXE",
 922                     llvm_config.with_file_name("llvm-tblgen").with_extension(EXE_EXTENSION),
 923                 );
 924         }
 925
 926         // Explicitly set C++ standard, because upstream doesn't do so
 927         // for standalone builds.
 928         cfg.define("CMAKE_CXX_STANDARD", "14");
 929
 930         cfg.build();
 931
 932         t!(File::create(&done_stamp));
 933         out_dir
 934     }
 935 }
 936
 937 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 938 pub struct TestHelpers {
 939     pub target: TargetSelection,
 940 }
 941
 942 impl Step for TestHelpers {
 943     type Output = ();
 944
 945     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 946         run.path("src/test/auxiliary/rust_test_helpers.c")
 947     }
 948
 949     fn make_run(run: RunConfig<'_>) {
 950         run.builder.ensure(TestHelpers { target: run.target })
 951     }
 952
 953     /// Compiles the `rust_test_helpers.c` library which we used in various
 954     /// `run-pass` tests for ABI testing.
 955     fn run(self, builder: &Builder<'_>) {
 956         if builder.config.dry_run {
 957             return;
 958         }
 959         // The x86_64-fortanix-unknown-sgx target doesn't have a working C
 960         // toolchain. However, some x86_64 ELF objects can be linked
 961         // without issues. Use this hack to compile the test helpers.
 962         let target = if self.target == "x86_64-fortanix-unknown-sgx" {
 963             TargetSelection::from_user("x86_64-unknown-linux-gnu")
 964         } else {
 965             self.target
 966         };
 967         let dst = builder.test_helpers_out(target);
 968         let src = builder.src.join("src/test/auxiliary/rust_test_helpers.c");
 969         if up_to_date(&src, &dst.join("librust_test_helpers.a")) {
 970             return;
 971         }
 972
 973         builder.info("Building test helpers");
 974         t!(fs::create_dir_all(&dst));
 975         let mut cfg = cc::Build::new();
 976         // FIXME: Workaround for https://github.com/emscripten-core/emscripten/issues/9013
 977         if target.contains("emscripten") {
 978             cfg.pic(false);
 979         }
 980
 981         // We may have found various cross-compilers a little differently due to our
 982         // extra configuration, so inform cc of these compilers. Note, though, that
 983         // on MSVC we still need cc's detection of env vars (ugh).
 984         if !target.contains("msvc") {
 985             if let Some(ar) = builder.ar(target) {
 986                 cfg.archiver(ar);
 987             }
 988             cfg.compiler(builder.cc(target));
 989         }
 990         cfg.cargo_metadata(false)
 991             .out_dir(&dst)
 992             .target(&target.triple)
 993             .host(&builder.config.build.triple)
 994             .opt_level(0)
 995             .warnings(false)
 996             .debug(false)
 997             .file(builder.src.join("src/test/auxiliary/rust_test_helpers.c"))
 998             .compile("rust_test_helpers");
 999     }
1000 }
1001
1002 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1003 pub struct Sanitizers {
1004     pub target: TargetSelection,
1005 }
1006
1007 impl Step for Sanitizers {
1008     type Output = Vec<SanitizerRuntime>;
1009
1010     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1011         run.alias("sanitizers")
1012     }
1013
1014     fn make_run(run: RunConfig<'_>) {
1015         run.builder.ensure(Sanitizers { target: run.target });
1016     }
1017
1018     /// Builds sanitizer runtime libraries.
1019     fn run(self, builder: &Builder<'_>) -> Self::Output {
1020         let compiler_rt_dir = builder.src.join("src/llvm-project/compiler-rt");
1021         if !compiler_rt_dir.exists() {
1022             return Vec::new();
1023         }
1024
1025         let out_dir = builder.native_dir(self.target).join("sanitizers");
1026         let runtimes = supported_sanitizers(&out_dir, self.target, &builder.config.channel);
1027         if runtimes.is_empty() {
1028             return runtimes;
1029         }
1030
1031         let llvm_config = builder.ensure(Llvm { target: builder.config.build });
1032         if builder.config.dry_run {
1033             return runtimes;
1034         }
1035
1036         let stamp = out_dir.join("sanitizers-finished-building");
1037         let stamp = HashStamp::new(stamp, builder.in_tree_llvm_info.sha());
1038
1039         if stamp.is_done() {
1040             if stamp.hash.is_none() {
1041                 builder.info(&format!(
1042                     "Rebuild sanitizers by removing the file `{}`",
1043                     stamp.path.display()
1044                 ));
1045             }
1046             return runtimes;
1047         }
1048
1049         builder.info(&format!("Building sanitizers for {}", self.target));
1050         t!(stamp.remove());
1051         let _time = util::timeit(&builder);
1052
1053         let mut cfg = cmake::Config::new(&compiler_rt_dir);
1054         cfg.profile("Release");
1055         cfg.define("CMAKE_C_COMPILER_TARGET", self.target.triple);
1056         cfg.define("COMPILER_RT_BUILD_BUILTINS", "OFF");
1057         cfg.define("COMPILER_RT_BUILD_CRT", "OFF");
1058         cfg.define("COMPILER_RT_BUILD_LIBFUZZER", "OFF");
1059         cfg.define("COMPILER_RT_BUILD_PROFILE", "OFF");
1060         cfg.define("COMPILER_RT_BUILD_SANITIZERS", "ON");
1061         cfg.define("COMPILER_RT_BUILD_XRAY", "OFF");
1062         cfg.define("COMPILER_RT_DEFAULT_TARGET_ONLY", "ON");
1063         cfg.define("COMPILER_RT_USE_LIBCXX", "OFF");
1064         cfg.define("LLVM_CONFIG_PATH", &llvm_config);
1065
1066         // On Darwin targets the sanitizer runtimes are build as universal binaries.
1067         // Unfortunately sccache currently lacks support to build them successfully.
1068         // Disable compiler launcher on Darwin targets to avoid potential issues.
1069         let use_compiler_launcher = !self.target.contains("apple-darwin");
1070         configure_cmake(builder, self.target, &mut cfg, use_compiler_launcher, LdFlags::default());
1071
1072         t!(fs::create_dir_all(&out_dir));
1073         cfg.out_dir(out_dir);
1074
1075         for runtime in &runtimes {
1076             cfg.build_target(&runtime.cmake_target);
1077             cfg.build();
1078         }
1079         t!(stamp.write());
1080
1081         runtimes
1082     }
1083 }
1084
1085 #[derive(Clone, Debug)]
1086 pub struct SanitizerRuntime {
1087     /// CMake target used to build the runtime.
1088     pub cmake_target: String,
1089     /// Path to the built runtime library.
1090     pub path: PathBuf,
1091     /// Library filename that will be used rustc.
1092     pub name: String,
1093 }
1094
1095 /// Returns sanitizers available on a given target.
1096 fn supported_sanitizers(
1097     out_dir: &Path,
1098     target: TargetSelection,
1099     channel: &str,
1100 ) -> Vec<SanitizerRuntime> {
1101     let darwin_libs = |os: &str, components: &[&str]| -> Vec<SanitizerRuntime> {
1102         components
1103             .iter()
1104             .map(move |c| SanitizerRuntime {
1105                 cmake_target: format!("clang_rt.{}_{}_dynamic", c, os),
1106                 path: out_dir
1107                     .join(&format!("build/lib/darwin/libclang_rt.{}_{}_dynamic.dylib", c, os)),
1108                 name: format!("librustc-{}_rt.{}.dylib", channel, c),
1109             })
1110             .collect()
1111     };
1112
1113     let common_libs = |os: &str, arch: &str, components: &[&str]| -> Vec<SanitizerRuntime> {
1114         components
1115             .iter()
1116             .map(move |c| SanitizerRuntime {
1117                 cmake_target: format!("clang_rt.{}-{}", c, arch),
1118                 path: out_dir.join(&format!("build/lib/{}/libclang_rt.{}-{}.a", os, c, arch)),
1119                 name: format!("librustc-{}_rt.{}.a", channel, c),
1120             })
1121             .collect()
1122     };
1123
1124     match &*target.triple {
1125         "aarch64-apple-darwin" => darwin_libs("osx", &["asan", "lsan", "tsan"]),
1126         "aarch64-fuchsia" => common_libs("fuchsia", "aarch64", &["asan"]),
1127         "aarch64-unknown-linux-gnu" => {
1128             common_libs("linux", "aarch64", &["asan", "lsan", "msan", "tsan", "hwasan"])
1129         }
1130         "x86_64-apple-darwin" => darwin_libs("osx", &["asan", "lsan", "tsan"]),
1131         "x86_64-fuchsia" => common_libs("fuchsia", "x86_64", &["asan"]),
1132         "x86_64-unknown-freebsd" => common_libs("freebsd", "x86_64", &["asan", "msan", "tsan"]),
1133         "x86_64-unknown-netbsd" => {
1134             common_libs("netbsd", "x86_64", &["asan", "lsan", "msan", "tsan"])
1135         }
1136         "x86_64-unknown-illumos" => common_libs("illumos", "x86_64", &["asan"]),
1137         "x86_64-pc-solaris" => common_libs("solaris", "x86_64", &["asan"]),
1138         "x86_64-unknown-linux-gnu" => {
1139             common_libs("linux", "x86_64", &["asan", "lsan", "msan", "tsan"])
1140         }
1141         "x86_64-unknown-linux-musl" => {
1142             common_libs("linux", "x86_64", &["asan", "lsan", "msan", "tsan"])
1143         }
1144         _ => Vec::new(),
1145     }
1146 }
1147
1148 struct HashStamp {
1149     path: PathBuf,
1150     hash: Option<Vec<u8>>,
1151 }
1152
1153 impl HashStamp {
1154     fn new(path: PathBuf, hash: Option<&str>) -> Self {
1155         HashStamp { path, hash: hash.map(|s| s.as_bytes().to_owned()) }
1156     }
1157
1158     fn is_done(&self) -> bool {
1159         match fs::read(&self.path) {
1160             Ok(h) => self.hash.as_deref().unwrap_or(b"") == h.as_slice(),
1161             Err(e) if e.kind() == io::ErrorKind::NotFound => false,
1162             Err(e) => {
1163                 panic!("failed to read stamp file `{}`: {}", self.path.display(), e);
1164             }
1165         }
1166     }
1167
1168     fn remove(&self) -> io::Result<()> {
1169         match fs::remove_file(&self.path) {
1170             Ok(()) => Ok(()),
1171             Err(e) => {
1172                 if e.kind() == io::ErrorKind::NotFound {
1173                     Ok(())
1174                 } else {
1175                     Err(e)
1176                 }
1177             }
1178         }
1179     }
1180
1181     fn write(&self) -> io::Result<()> {
1182         fs::write(&self.path, self.hash.as_deref().unwrap_or(b""))
1183     }
1184 }
1185
1186 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1187 pub struct CrtBeginEnd {
1188     pub target: TargetSelection,
1189 }
1190
1191 impl Step for CrtBeginEnd {
1192     type Output = PathBuf;
1193
1194     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1195         run.path("src/llvm-project/compiler-rt/lib/crt")
1196     }
1197
1198     fn make_run(run: RunConfig<'_>) {
1199         run.builder.ensure(CrtBeginEnd { target: run.target });
1200     }
1201
1202     /// Build crtbegin.o/crtend.o for musl target.
1203     fn run(self, builder: &Builder<'_>) -> Self::Output {
1204         let out_dir = builder.native_dir(self.target).join("crt");
1205
1206         if builder.config.dry_run {
1207             return out_dir;
1208         }
1209
1210         let crtbegin_src = builder.src.join("src/llvm-project/compiler-rt/lib/crt/crtbegin.c");
1211         let crtend_src = builder.src.join("src/llvm-project/compiler-rt/lib/crt/crtend.c");
1212         if up_to_date(&crtbegin_src, &out_dir.join("crtbegin.o"))
1213             && up_to_date(&crtend_src, &out_dir.join("crtendS.o"))
1214         {
1215             return out_dir;
1216         }
1217
1218         builder.info("Building crtbegin.o and crtend.o");
1219         t!(fs::create_dir_all(&out_dir));
1220
1221         let mut cfg = cc::Build::new();
1222
1223         if let Some(ar) = builder.ar(self.target) {
1224             cfg.archiver(ar);
1225         }
1226         cfg.compiler(builder.cc(self.target));
1227         cfg.cargo_metadata(false)
1228             .out_dir(&out_dir)
1229             .target(&self.target.triple)
1230             .host(&builder.config.build.triple)
1231             .warnings(false)
1232             .debug(false)
1233             .opt_level(3)
1234             .file(crtbegin_src)
1235             .file(crtend_src);
1236
1237         // Those flags are defined in src/llvm-project/compiler-rt/lib/crt/CMakeLists.txt
1238         // Currently only consumer of those objects is musl, which use .init_array/.fini_array
1239         // instead of .ctors/.dtors
1240         cfg.flag("-std=c11")
1241             .define("CRT_HAS_INITFINI_ARRAY", None)
1242             .define("EH_USE_FRAME_REGISTRY", None);
1243
1244         cfg.compile("crt");
1245
1246         t!(fs::copy(out_dir.join("crtbegin.o"), out_dir.join("crtbeginS.o")));
1247         t!(fs::copy(out_dir.join("crtend.o"), out_dir.join("crtendS.o")));
1248         out_dir
1249     }
1250 }
1251
1252 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
1253 pub struct Libunwind {
1254     pub target: TargetSelection,
1255 }
1256
1257 impl Step for Libunwind {
1258     type Output = PathBuf;
1259
1260     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1261         run.path("src/llvm-project/libunwind")
1262     }
1263
1264     fn make_run(run: RunConfig<'_>) {
1265         run.builder.ensure(Libunwind { target: run.target });
1266     }
1267
1268     /// Build linunwind.a
1269     fn run(self, builder: &Builder<'_>) -> Self::Output {
1270         if builder.config.dry_run {
1271             return PathBuf::new();
1272         }
1273
1274         let out_dir = builder.native_dir(self.target).join("libunwind");
1275         let root = builder.src.join("src/llvm-project/libunwind");
1276
1277         if up_to_date(&root, &out_dir.join("libunwind.a")) {
1278             return out_dir;
1279         }
1280
1281         builder.info(&format!("Building libunwind.a for {}", self.target.triple));
1282         t!(fs::create_dir_all(&out_dir));
1283
1284         let mut cc_cfg = cc::Build::new();
1285         let mut cpp_cfg = cc::Build::new();
1286
1287         cpp_cfg.cpp(true);
1288         cpp_cfg.cpp_set_stdlib(None);
1289         cpp_cfg.flag("-nostdinc++");
1290         cpp_cfg.flag("-fno-exceptions");
1291         cpp_cfg.flag("-fno-rtti");
1292         cpp_cfg.flag_if_supported("-fvisibility-global-new-delete-hidden");
1293
1294         for cfg in [&mut cc_cfg, &mut cpp_cfg].iter_mut() {
1295             if let Some(ar) = builder.ar(self.target) {
1296                 cfg.archiver(ar);
1297             }
1298             cfg.target(&self.target.triple);
1299             cfg.host(&builder.config.build.triple);
1300             cfg.warnings(false);
1301             cfg.debug(false);
1302             // get_compiler() need set opt_level first.
1303             cfg.opt_level(3);
1304             cfg.flag("-fstrict-aliasing");
1305             cfg.flag("-funwind-tables");
1306             cfg.flag("-fvisibility=hidden");
1307             cfg.define("_LIBUNWIND_DISABLE_VISIBILITY_ANNOTATIONS", None);
1308             cfg.include(root.join("include"));
1309             cfg.cargo_metadata(false);
1310             cfg.out_dir(&out_dir);
1311
1312             if self.target.contains("x86_64-fortanix-unknown-sgx") {
1313                 cfg.static_flag(true);
1314                 cfg.flag("-fno-stack-protector");
1315                 cfg.flag("-ffreestanding");
1316                 cfg.flag("-fexceptions");
1317
1318                 // easiest way to undefine since no API available in cc::Build to undefine
1319                 cfg.flag("-U_FORTIFY_SOURCE");
1320                 cfg.define("_FORTIFY_SOURCE", "0");
1321                 cfg.define("RUST_SGX", "1");
1322                 cfg.define("__NO_STRING_INLINES", None);
1323                 cfg.define("__NO_MATH_INLINES", None);
1324                 cfg.define("_LIBUNWIND_IS_BAREMETAL", None);
1325                 cfg.define("__LIBUNWIND_IS_NATIVE_ONLY", None);
1326                 cfg.define("NDEBUG", None);
1327             }
1328             if self.target.contains("windows") {
1329                 cfg.define("_LIBUNWIND_HIDE_SYMBOLS", "1");
1330                 cfg.define("_LIBUNWIND_IS_NATIVE_ONLY", "1");
1331             }
1332         }
1333
1334         cc_cfg.compiler(builder.cc(self.target));
1335         if let Ok(cxx) = builder.cxx(self.target) {
1336             cpp_cfg.compiler(cxx);
1337         } else {
1338             cc_cfg.compiler(builder.cc(self.target));
1339         }
1340
1341         // Don't set this for clang
1342         // By default, Clang builds C code in GNU C17 mode.
1343         // By default, Clang builds C++ code according to the C++98 standard,
1344         // with many C++11 features accepted as extensions.
1345         if cc_cfg.get_compiler().is_like_gnu() {
1346             cc_cfg.flag("-std=c99");
1347         }
1348         if cpp_cfg.get_compiler().is_like_gnu() {
1349             cpp_cfg.flag("-std=c++11");
1350         }
1351
1352         if self.target.contains("x86_64-fortanix-unknown-sgx") || self.target.contains("musl") {
1353             // use the same GCC C compiler command to compile C++ code so we do not need to setup the
1354             // C++ compiler env variables on the builders.
1355             // Don't set this for clang++, as clang++ is able to compile this without libc++.
1356             if cpp_cfg.get_compiler().is_like_gnu() {
1357                 cpp_cfg.cpp(false);
1358                 cpp_cfg.compiler(builder.cc(self.target));
1359             }
1360         }
1361
1362         let mut c_sources = vec![
1363             "Unwind-sjlj.c",
1364             "UnwindLevel1-gcc-ext.c",
1365             "UnwindLevel1.c",
1366             "UnwindRegistersRestore.S",
1367             "UnwindRegistersSave.S",
1368         ];
1369
1370         let cpp_sources = vec!["Unwind-EHABI.cpp", "Unwind-seh.cpp", "libunwind.cpp"];
1371         let cpp_len = cpp_sources.len();
1372
1373         if self.target.contains("x86_64-fortanix-unknown-sgx") {
1374             c_sources.push("UnwindRustSgx.c");
1375         }
1376
1377         for src in c_sources {
1378             cc_cfg.file(root.join("src").join(src).canonicalize().unwrap());
1379         }
1380
1381         for src in &cpp_sources {
1382             cpp_cfg.file(root.join("src").join(src).canonicalize().unwrap());
1383         }
1384
1385         cpp_cfg.compile("unwind-cpp");
1386
1387         // FIXME: https://github.com/alexcrichton/cc-rs/issues/545#issuecomment-679242845
1388         let mut count = 0;
1389         for entry in fs::read_dir(&out_dir).unwrap() {
1390             let file = entry.unwrap().path().canonicalize().unwrap();
1391             if file.is_file() && file.extension() == Some(OsStr::new("o")) {
1392                 // file name starts with "Unwind-EHABI", "Unwind-seh" or "libunwind"
1393                 let file_name = file.file_name().unwrap().to_str().expect("UTF-8 file name");
1394                 if cpp_sources.iter().any(|f| file_name.starts_with(&f[..f.len() - 4])) {
1395                     cc_cfg.object(&file);
1396                     count += 1;
1397                 }
1398             }
1399         }
1400         assert_eq!(cpp_len, count, "Can't get object files from {:?}", &out_dir);
1401
1402         cc_cfg.compile("unwind");
1403         out_dir
1404     }
1405 }