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