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