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