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::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 build_helper::{output, t};
  20
  21 use crate::builder::{Builder, RunConfig, ShouldRun, Step};
  22 use crate::config::TargetSelection;
  23 use crate::util::{self, exe};
  24 use crate::GitRepo;
  25 use build_helper::up_to_date;
  26
  27 pub struct Meta {
  28     stamp: HashStamp,
  29     build_llvm_config: PathBuf,
  30     out_dir: PathBuf,
  31     root: String,
  32 }
  33
  34 // This returns whether we've already previously built LLVM.
  35 //
  36 // It's used to avoid busting caches during x.py check -- if we've already built
  37 // LLVM, it's fine for us to not try to avoid doing so.
  38 //
  39 // This will return the llvm-config if it can get it (but it will not build it
  40 // if not).
  41 pub fn prebuilt_llvm_config(
  42     builder: &Builder<'_>,
  43     target: TargetSelection,
  44 ) -> Result<PathBuf, Meta> {
  45     // If we're using a custom LLVM bail out here, but we can only use a
  46     // custom LLVM for the build triple.
  47     if let Some(config) = builder.config.target_config.get(&target) {
  48         if let Some(ref s) = config.llvm_config {
  49             check_llvm_version(builder, s);
  50             return Ok(s.to_path_buf());
  51         }
  52     }
  53
  54     let root = "src/llvm-project/llvm";
  55     let out_dir = builder.llvm_out(target);
  56
  57     let mut llvm_config_ret_dir = builder.llvm_out(builder.config.build);
  58     if !builder.config.build.contains("msvc") || builder.ninja() {
  59         llvm_config_ret_dir.push("build");
  60     }
  61     llvm_config_ret_dir.push("bin");
  62
  63     let build_llvm_config = llvm_config_ret_dir.join(exe("llvm-config", builder.config.build));
  64
  65     let stamp = out_dir.join("llvm-finished-building");
  66     let stamp = HashStamp::new(stamp, builder.in_tree_llvm_info.sha());
  67
  68     if builder.config.llvm_skip_rebuild && stamp.path.exists() {
  69         builder.info(
  70             "Warning: \
  71                 Using a potentially stale build of LLVM; \
  72                 This may not behave well.",
  73         );
  74         return Ok(build_llvm_config);
  75     }
  76
  77     if stamp.is_done() {
  78         if stamp.hash.is_none() {
  79             builder.info(
  80                 "Could not determine the LLVM submodule commit hash. \
  81                      Assuming that an LLVM rebuild is not necessary.",
  82             );
  83             builder.info(&format!(
  84                 "To force LLVM to rebuild, remove the file `{}`",
  85                 stamp.path.display()
  86             ));
  87         }
  88         return Ok(build_llvm_config);
  89     }
  90
  91     Err(Meta { stamp, build_llvm_config, out_dir, root: root.into() })
  92 }
  93
  94 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
  95 pub struct Llvm {
  96     pub target: TargetSelection,
  97 }
  98
  99 impl Step for Llvm {
 100     type Output = PathBuf; // path to llvm-config
 101
 102     const ONLY_HOSTS: bool = true;
 103
 104     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 105         run.path("src/llvm-project").path("src/llvm-project/llvm").path("src/llvm")
 106     }
 107
 108     fn make_run(run: RunConfig<'_>) {
 109         run.builder.ensure(Llvm { target: run.target });
 110     }
 111
 112     /// Compile LLVM for `target`.
 113     fn run(self, builder: &Builder<'_>) -> PathBuf {
 114         let target = self.target;
 115         let target_native = if self.target.starts_with("riscv") {
 116             // RISC-V target triples in Rust is not named the same as C compiler target triples.
 117             // This converts Rust RISC-V target triples to C compiler triples.
 118             let idx = target.triple.find('-').unwrap();
 119
 120             format!("riscv{}{}", &target.triple[5..7], &target.triple[idx..])
 121         } else {
 122             target.to_string()
 123         };
 124
 125         let Meta { stamp, build_llvm_config, out_dir, root } =
 126             match prebuilt_llvm_config(builder, target) {
 127                 Ok(p) => return p,
 128                 Err(m) => m,
 129             };
 130
 131         if builder.config.llvm_link_shared
 132             && (target.contains("windows") || target.contains("apple-darwin"))
 133         {
 134             panic!("shared linking to LLVM is not currently supported on {}", target.triple);
 135         }
 136
 137         builder.info(&format!("Building LLVM for {}", target));
 138         t!(stamp.remove());
 139         let _time = util::timeit(&builder);
 140         t!(fs::create_dir_all(&out_dir));
 141
 142         // http://llvm.org/docs/CMake.html
 143         let mut cfg = cmake::Config::new(builder.src.join(root));
 144
 145         let profile = match (builder.config.llvm_optimize, builder.config.llvm_release_debuginfo) {
 146             (false, _) => "Debug",
 147             (true, false) => "Release",
 148             (true, true) => "RelWithDebInfo",
 149         };
 150
 151         // NOTE: remember to also update `config.toml.example` when changing the
 152         // defaults!
 153         let llvm_targets = match &builder.config.llvm_targets {
 154             Some(s) => s,
 155             None => {
 156                 "AArch64;ARM;Hexagon;MSP430;Mips;NVPTX;PowerPC;RISCV;\
 157                      Sparc;SystemZ;WebAssembly;X86"
 158             }
 159         };
 160
 161         let llvm_exp_targets = match builder.config.llvm_experimental_targets {
 162             Some(ref s) => s,
 163             None => "AVR",
 164         };
 165
 166         let assertions = if builder.config.llvm_assertions { "ON" } else { "OFF" };
 167
 168         cfg.out_dir(&out_dir)
 169             .profile(profile)
 170             .define("LLVM_ENABLE_ASSERTIONS", assertions)
 171             .define("LLVM_TARGETS_TO_BUILD", llvm_targets)
 172             .define("LLVM_EXPERIMENTAL_TARGETS_TO_BUILD", llvm_exp_targets)
 173             .define("LLVM_INCLUDE_EXAMPLES", "OFF")
 174             .define("LLVM_INCLUDE_TESTS", "OFF")
 175             .define("LLVM_INCLUDE_DOCS", "OFF")
 176             .define("LLVM_INCLUDE_BENCHMARKS", "OFF")
 177             .define("LLVM_ENABLE_TERMINFO", "OFF")
 178             .define("LLVM_ENABLE_LIBEDIT", "OFF")
 179             .define("LLVM_ENABLE_BINDINGS", "OFF")
 180             .define("LLVM_ENABLE_Z3_SOLVER", "OFF")
 181             .define("LLVM_PARALLEL_COMPILE_JOBS", builder.jobs().to_string())
 182             .define("LLVM_TARGET_ARCH", target_native.split('-').next().unwrap())
 183             .define("LLVM_DEFAULT_TARGET_TRIPLE", target_native);
 184
 185         if target != "aarch64-apple-darwin" {
 186             cfg.define("LLVM_ENABLE_ZLIB", "ON");
 187         } else {
 188             cfg.define("LLVM_ENABLE_ZLIB", "OFF");
 189         }
 190
 191         // Are we compiling for iOS/tvOS?
 192         if target.contains("apple-ios") || target.contains("apple-tvos") {
 193             // These two defines prevent CMake from automatically trying to add a MacOSX sysroot, which leads to a compiler error.
 194             cfg.define("CMAKE_OSX_SYSROOT", "/");
 195             cfg.define("CMAKE_OSX_DEPLOYMENT_TARGET", "");
 196             // Prevent cmake from adding -bundle to CFLAGS automatically, which leads to a compiler error because "-bitcode_bundle" also gets added.
 197             cfg.define("LLVM_ENABLE_PLUGINS", "OFF");
 198             // Zlib fails to link properly, leading to a compiler error.
 199             cfg.define("LLVM_ENABLE_ZLIB", "OFF");
 200         }
 201
 202         if builder.config.llvm_thin_lto {
 203             cfg.define("LLVM_ENABLE_LTO", "Thin");
 204             if !target.contains("apple") {
 205                 cfg.define("LLVM_ENABLE_LLD", "ON");
 206             }
 207         }
 208
 209         // This setting makes the LLVM tools link to the dynamic LLVM library,
 210         // which saves both memory during parallel links and overall disk space
 211         // for the tools. We don't do this on every platform as it doesn't work
 212         // equally well everywhere.
 213         //
 214         // If we're not linking rustc to a dynamic LLVM, though, then don't link
 215         // tools to it.
 216         if builder.llvm_link_tools_dynamically(target) && builder.config.llvm_link_shared {
 217             cfg.define("LLVM_LINK_LLVM_DYLIB", "ON");
 218         }
 219
 220         // For distribution we want the LLVM tools to be *statically* linked to libstdc++
 221         if builder.config.llvm_tools_enabled {
 222             if !target.contains("msvc") {
 223                 if target.contains("apple") {
 224                     cfg.define("CMAKE_EXE_LINKER_FLAGS", "-static-libstdc++");
 225                 } else {
 226                     cfg.define("CMAKE_EXE_LINKER_FLAGS", "-Wl,-Bsymbolic -static-libstdc++");
 227                 }
 228             }
 229         }
 230
 231         if target.starts_with("riscv") {
 232             // In RISC-V, using C++ atomics require linking to `libatomic` but the LLVM build
 233             // system check cannot detect this. Therefore it is set manually here.
 234             if !builder.config.llvm_tools_enabled {
 235                 cfg.define("CMAKE_EXE_LINKER_FLAGS", "-latomic");
 236             } else {
 237                 cfg.define("CMAKE_EXE_LINKER_FLAGS", "-latomic -static-libstdc++");
 238             }
 239             cfg.define("CMAKE_SHARED_LINKER_FLAGS", "-latomic");
 240         }
 241
 242         if target.contains("msvc") {
 243             cfg.define("LLVM_USE_CRT_DEBUG", "MT");
 244             cfg.define("LLVM_USE_CRT_RELEASE", "MT");
 245             cfg.define("LLVM_USE_CRT_RELWITHDEBINFO", "MT");
 246             cfg.static_crt(true);
 247         }
 248
 249         if target.starts_with("i686") {
 250             cfg.define("LLVM_BUILD_32_BITS", "ON");
 251         }
 252
 253         let mut enabled_llvm_projects = Vec::new();
 254
 255         if util::forcing_clang_based_tests() {
 256             enabled_llvm_projects.push("clang");
 257             enabled_llvm_projects.push("compiler-rt");
 258         }
 259
 260         if let Some(true) = builder.config.llvm_polly {
 261             enabled_llvm_projects.push("polly");
 262         }
 263
 264         // We want libxml to be disabled.
 265         // See https://github.com/rust-lang/rust/pull/50104
 266         cfg.define("LLVM_ENABLE_LIBXML2", "OFF");
 267
 268         if !enabled_llvm_projects.is_empty() {
 269             enabled_llvm_projects.sort();
 270             enabled_llvm_projects.dedup();
 271             cfg.define("LLVM_ENABLE_PROJECTS", enabled_llvm_projects.join(";"));
 272         }
 273
 274         if let Some(num_linkers) = builder.config.llvm_link_jobs {
 275             if num_linkers > 0 {
 276                 cfg.define("LLVM_PARALLEL_LINK_JOBS", num_linkers.to_string());
 277             }
 278         }
 279
 280         // http://llvm.org/docs/HowToCrossCompileLLVM.html
 281         if target != builder.config.build {
 282             builder.ensure(Llvm { target: builder.config.build });
 283             // FIXME: if the llvm root for the build triple is overridden then we
 284             //        should use llvm-tblgen from there, also should verify that it
 285             //        actually exists most of the time in normal installs of LLVM.
 286             let host_bin = builder.llvm_out(builder.config.build).join("bin");
 287             cfg.define("CMAKE_CROSSCOMPILING", "True");
 288             cfg.define("LLVM_TABLEGEN", host_bin.join("llvm-tblgen").with_extension(EXE_EXTENSION));
 289             cfg.define("LLVM_NM", host_bin.join("llvm-nm").with_extension(EXE_EXTENSION));
 290             cfg.define(
 291                 "LLVM_CONFIG_PATH",
 292                 host_bin.join("llvm-config").with_extension(EXE_EXTENSION),
 293             );
 294         }
 295
 296         if let Some(ref suffix) = builder.config.llvm_version_suffix {
 297             // Allow version-suffix="" to not define a version suffix at all.
 298             if !suffix.is_empty() {
 299                 cfg.define("LLVM_VERSION_SUFFIX", suffix);
 300             }
 301         } else if builder.config.channel == "dev" {
 302             // Changes to a version suffix require a complete rebuild of the LLVM.
 303             // To avoid rebuilds during a time of version bump, don't include rustc
 304             // release number on the dev channel.
 305             cfg.define("LLVM_VERSION_SUFFIX", "-rust-dev");
 306         } else {
 307             let suffix = format!("-rust-{}-{}", builder.version, builder.config.channel);
 308             cfg.define("LLVM_VERSION_SUFFIX", suffix);
 309         }
 310
 311         if let Some(ref linker) = builder.config.llvm_use_linker {
 312             cfg.define("LLVM_USE_LINKER", linker);
 313         }
 314
 315         if let Some(true) = builder.config.llvm_allow_old_toolchain {
 316             cfg.define("LLVM_TEMPORARILY_ALLOW_OLD_TOOLCHAIN", "YES");
 317         }
 318
 319         configure_cmake(builder, target, &mut cfg, true);
 320
 321         // FIXME: we don't actually need to build all LLVM tools and all LLVM
 322         //        libraries here, e.g., we just want a few components and a few
 323         //        tools. Figure out how to filter them down and only build the right
 324         //        tools and libs on all platforms.
 325
 326         if builder.config.dry_run {
 327             return build_llvm_config;
 328         }
 329
 330         cfg.build();
 331
 332         t!(stamp.write());
 333
 334         build_llvm_config
 335     }
 336 }
 337
 338 fn check_llvm_version(builder: &Builder<'_>, llvm_config: &Path) {
 339     if !builder.config.llvm_version_check {
 340         return;
 341     }
 342
 343     if builder.config.dry_run {
 344         return;
 345     }
 346
 347     let mut cmd = Command::new(llvm_config);
 348     let version = output(cmd.arg("--version"));
 349     let mut parts = version.split('.').take(2).filter_map(|s| s.parse::<u32>().ok());
 350     if let (Some(major), Some(_minor)) = (parts.next(), parts.next()) {
 351         if major >= 9 {
 352             return;
 353         }
 354     }
 355     panic!("\n\nbad LLVM version: {}, need >=9.0\n\n", version)
 356 }
 357
 358 fn configure_cmake(
 359     builder: &Builder<'_>,
 360     target: TargetSelection,
 361     cfg: &mut cmake::Config,
 362     use_compiler_launcher: bool,
 363 ) {
 364     // Do not print installation messages for up-to-date files.
 365     // LLVM and LLD builds can produce a lot of those and hit CI limits on log size.
 366     cfg.define("CMAKE_INSTALL_MESSAGE", "LAZY");
 367
 368     // Do not allow the user's value of DESTDIR to influence where
 369     // LLVM will install itself. LLVM must always be installed in our
 370     // own build directories.
 371     cfg.env("DESTDIR", "");
 372
 373     if builder.ninja() {
 374         cfg.generator("Ninja");
 375     }
 376     cfg.target(&target.triple).host(&builder.config.build.triple);
 377
 378     if target != builder.config.build {
 379         if target.contains("netbsd") {
 380             cfg.define("CMAKE_SYSTEM_NAME", "NetBSD");
 381         } else if target.contains("freebsd") {
 382             cfg.define("CMAKE_SYSTEM_NAME", "FreeBSD");
 383         } else if target.contains("windows") {
 384             cfg.define("CMAKE_SYSTEM_NAME", "Windows");
 385         } else if target.contains("haiku") {
 386             cfg.define("CMAKE_SYSTEM_NAME", "Haiku");
 387         }
 388         // When cross-compiling we should also set CMAKE_SYSTEM_VERSION, but in
 389         // that case like CMake we cannot easily determine system version either.
 390         //
 391         // Since, the LLVM itself makes rather limited use of version checks in
 392         // CMakeFiles (and then only in tests), and so far no issues have been
 393         // reported, the system version is currently left unset.
 394     }
 395
 396     let sanitize_cc = |cc: &Path| {
 397         if target.contains("msvc") {
 398             OsString::from(cc.to_str().unwrap().replace("\\", "/"))
 399         } else {
 400             cc.as_os_str().to_owned()
 401         }
 402     };
 403
 404     // MSVC with CMake uses msbuild by default which doesn't respect these
 405     // vars that we'd otherwise configure. In that case we just skip this
 406     // entirely.
 407     if target.contains("msvc") && !builder.ninja() {
 408         return;
 409     }
 410
 411     let (cc, cxx) = match builder.config.llvm_clang_cl {
 412         Some(ref cl) => (cl.as_ref(), cl.as_ref()),
 413         None => (builder.cc(target), builder.cxx(target).unwrap()),
 414     };
 415
 416     // Handle msvc + ninja + ccache specially (this is what the bots use)
 417     if target.contains("msvc") && builder.ninja() && builder.config.ccache.is_some() {
 418         let mut wrap_cc = env::current_exe().expect("failed to get cwd");
 419         wrap_cc.set_file_name("sccache-plus-cl.exe");
 420
 421         cfg.define("CMAKE_C_COMPILER", sanitize_cc(&wrap_cc))
 422             .define("CMAKE_CXX_COMPILER", sanitize_cc(&wrap_cc));
 423         cfg.env("SCCACHE_PATH", builder.config.ccache.as_ref().unwrap())
 424             .env("SCCACHE_TARGET", target.triple)
 425             .env("SCCACHE_CC", &cc)
 426             .env("SCCACHE_CXX", &cxx);
 427
 428         // Building LLVM on MSVC can be a little ludicrous at times. We're so far
 429         // off the beaten path here that I'm not really sure this is even half
 430         // supported any more. Here we're trying to:
 431         //
 432         // * Build LLVM on MSVC
 433         // * Build LLVM with `clang-cl` instead of `cl.exe`
 434         // * Build a project with `sccache`
 435         // * Build for 32-bit as well
 436         // * Build with Ninja
 437         //
 438         // For `cl.exe` there are different binaries to compile 32/64 bit which
 439         // we use but for `clang-cl` there's only one which internally
 440         // multiplexes via flags. As a result it appears that CMake's detection
 441         // of a compiler's architecture and such on MSVC **doesn't** pass any
 442         // custom flags we pass in CMAKE_CXX_FLAGS below. This means that if we
 443         // use `clang-cl.exe` it's always diagnosed as a 64-bit compiler which
 444         // definitely causes problems since all the env vars are pointing to
 445         // 32-bit libraries.
 446         //
 447         // To hack around this... again... we pass an argument that's
 448         // unconditionally passed in the sccache shim. This'll get CMake to
 449         // correctly diagnose it's doing a 32-bit compilation and LLVM will
 450         // internally configure itself appropriately.
 451         if builder.config.llvm_clang_cl.is_some() && target.contains("i686") {
 452             cfg.env("SCCACHE_EXTRA_ARGS", "-m32");
 453         }
 454     } else {
 455         // If ccache is configured we inform the build a little differently how
 456         // to invoke ccache while also invoking our compilers.
 457         if use_compiler_launcher {
 458             if let Some(ref ccache) = builder.config.ccache {
 459                 cfg.define("CMAKE_C_COMPILER_LAUNCHER", ccache)
 460                     .define("CMAKE_CXX_COMPILER_LAUNCHER", ccache);
 461             }
 462         }
 463         cfg.define("CMAKE_C_COMPILER", sanitize_cc(cc))
 464             .define("CMAKE_CXX_COMPILER", sanitize_cc(cxx))
 465             .define("CMAKE_ASM_COMPILER", sanitize_cc(cc));
 466     }
 467
 468     cfg.build_arg("-j").build_arg(builder.jobs().to_string());
 469     let mut cflags = builder.cflags(target, GitRepo::Llvm).join(" ");
 470     if let Some(ref s) = builder.config.llvm_cflags {
 471         cflags.push_str(&format!(" {}", s));
 472     }
 473     // Some compiler features used by LLVM (such as thread locals) will not work on a min version below iOS 10.
 474     if target.contains("apple-ios") {
 475         if target.contains("86-") {
 476             cflags.push_str(" -miphonesimulator-version-min=10.0");
 477         } else {
 478             cflags.push_str(" -miphoneos-version-min=10.0");
 479         }
 480     }
 481     if builder.config.llvm_clang_cl.is_some() {
 482         cflags.push_str(&format!(" --target={}", target))
 483     }
 484     cfg.define("CMAKE_C_FLAGS", cflags);
 485     let mut cxxflags = builder.cflags(target, GitRepo::Llvm).join(" ");
 486     if builder.config.llvm_static_stdcpp && !target.contains("msvc") && !target.contains("netbsd") {
 487         cxxflags.push_str(" -static-libstdc++");
 488     }
 489     if let Some(ref s) = builder.config.llvm_cxxflags {
 490         cxxflags.push_str(&format!(" {}", s));
 491     }
 492     if builder.config.llvm_clang_cl.is_some() {
 493         cxxflags.push_str(&format!(" --target={}", target))
 494     }
 495     cfg.define("CMAKE_CXX_FLAGS", cxxflags);
 496     if let Some(ar) = builder.ar(target) {
 497         if ar.is_absolute() {
 498             // LLVM build breaks if `CMAKE_AR` is a relative path, for some reason it
 499             // tries to resolve this path in the LLVM build directory.
 500             cfg.define("CMAKE_AR", sanitize_cc(ar));
 501         }
 502     }
 503
 504     if let Some(ranlib) = builder.ranlib(target) {
 505         if ranlib.is_absolute() {
 506             // LLVM build breaks if `CMAKE_RANLIB` is a relative path, for some reason it
 507             // tries to resolve this path in the LLVM build directory.
 508             cfg.define("CMAKE_RANLIB", sanitize_cc(ranlib));
 509         }
 510     }
 511
 512     if let Some(ref s) = builder.config.llvm_ldflags {
 513         cfg.define("CMAKE_SHARED_LINKER_FLAGS", s);
 514         cfg.define("CMAKE_MODULE_LINKER_FLAGS", s);
 515         cfg.define("CMAKE_EXE_LINKER_FLAGS", s);
 516     }
 517
 518     if env::var_os("SCCACHE_ERROR_LOG").is_some() {
 519         cfg.env("RUSTC_LOG", "sccache=warn");
 520     }
 521 }
 522
 523 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
 524 pub struct Lld {
 525     pub target: TargetSelection,
 526 }
 527
 528 impl Step for Lld {
 529     type Output = PathBuf;
 530     const ONLY_HOSTS: bool = true;
 531
 532     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 533         run.path("src/llvm-project/lld").path("src/tools/lld")
 534     }
 535
 536     fn make_run(run: RunConfig<'_>) {
 537         run.builder.ensure(Lld { target: run.target });
 538     }
 539
 540     /// Compile LLD for `target`.
 541     fn run(self, builder: &Builder<'_>) -> PathBuf {
 542         if builder.config.dry_run {
 543             return PathBuf::from("lld-out-dir-test-gen");
 544         }
 545         let target = self.target;
 546
 547         let llvm_config = builder.ensure(Llvm { target: self.target });
 548
 549         let out_dir = builder.lld_out(target);
 550         let done_stamp = out_dir.join("lld-finished-building");
 551         if done_stamp.exists() {
 552             return out_dir;
 553         }
 554
 555         builder.info(&format!("Building LLD for {}", target));
 556         let _time = util::timeit(&builder);
 557         t!(fs::create_dir_all(&out_dir));
 558
 559         let mut cfg = cmake::Config::new(builder.src.join("src/llvm-project/lld"));
 560         configure_cmake(builder, target, &mut cfg, true);
 561
 562         // This is an awful, awful hack. Discovered when we migrated to using
 563         // clang-cl to compile LLVM/LLD it turns out that LLD, when built out of
 564         // tree, will execute `llvm-config --cmakedir` and then tell CMake about
 565         // that directory for later processing. Unfortunately if this path has
 566         // forward slashes in it (which it basically always does on Windows)
 567         // then CMake will hit a syntax error later on as... something isn't
 568         // escaped it seems?
 569         //
 570         // Instead of attempting to fix this problem in upstream CMake and/or
 571         // LLVM/LLD we just hack around it here. This thin wrapper will take the
 572         // output from llvm-config and replace all instances of `\` with `/` to
 573         // ensure we don't hit the same bugs with escaping. It means that you
 574         // can't build on a system where your paths require `\` on Windows, but
 575         // there's probably a lot of reasons you can't do that other than this.
 576         let llvm_config_shim = env::current_exe().unwrap().with_file_name("llvm-config-wrapper");
 577
 578         cfg.out_dir(&out_dir)
 579             .profile("Release")
 580             .env("LLVM_CONFIG_REAL", &llvm_config)
 581             .define("LLVM_CONFIG_PATH", llvm_config_shim)
 582             .define("LLVM_INCLUDE_TESTS", "OFF");
 583
 584         // While we're using this horrible workaround to shim the execution of
 585         // llvm-config, let's just pile on more. I can't seem to figure out how
 586         // to build LLD as a standalone project and also cross-compile it at the
 587         // same time. It wants a natively executable `llvm-config` to learn
 588         // about LLVM, but then it learns about all the host configuration of
 589         // LLVM and tries to link to host LLVM libraries.
 590         //
 591         // To work around that we tell our shim to replace anything with the
 592         // build target with the actual target instead. This'll break parts of
 593         // LLD though which try to execute host tools, such as llvm-tblgen, so
 594         // we specifically tell it where to find those. This is likely super
 595         // brittle and will break over time. If anyone knows better how to
 596         // cross-compile LLD it would be much appreciated to fix this!
 597         if target != builder.config.build {
 598             cfg.env("LLVM_CONFIG_SHIM_REPLACE", &builder.config.build.triple)
 599                 .env("LLVM_CONFIG_SHIM_REPLACE_WITH", &target.triple)
 600                 .define(
 601                     "LLVM_TABLEGEN_EXE",
 602                     llvm_config.with_file_name("llvm-tblgen").with_extension(EXE_EXTENSION),
 603                 );
 604         }
 605
 606         // Explicitly set C++ standard, because upstream doesn't do so
 607         // for standalone builds.
 608         cfg.define("CMAKE_CXX_STANDARD", "14");
 609
 610         cfg.build();
 611
 612         t!(File::create(&done_stamp));
 613         out_dir
 614     }
 615 }
 616
 617 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 618 pub struct TestHelpers {
 619     pub target: TargetSelection,
 620 }
 621
 622 impl Step for TestHelpers {
 623     type Output = ();
 624
 625     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 626         run.path("src/test/auxiliary/rust_test_helpers.c")
 627     }
 628
 629     fn make_run(run: RunConfig<'_>) {
 630         run.builder.ensure(TestHelpers { target: run.target })
 631     }
 632
 633     /// Compiles the `rust_test_helpers.c` library which we used in various
 634     /// `run-pass` tests for ABI testing.
 635     fn run(self, builder: &Builder<'_>) {
 636         if builder.config.dry_run {
 637             return;
 638         }
 639         // The x86_64-fortanix-unknown-sgx target doesn't have a working C
 640         // toolchain. However, some x86_64 ELF objects can be linked
 641         // without issues. Use this hack to compile the test helpers.
 642         let target = if self.target == "x86_64-fortanix-unknown-sgx" {
 643             TargetSelection::from_user("x86_64-unknown-linux-gnu")
 644         } else {
 645             self.target
 646         };
 647         let dst = builder.test_helpers_out(target);
 648         let src = builder.src.join("src/test/auxiliary/rust_test_helpers.c");
 649         if up_to_date(&src, &dst.join("librust_test_helpers.a")) {
 650             return;
 651         }
 652
 653         builder.info("Building test helpers");
 654         t!(fs::create_dir_all(&dst));
 655         let mut cfg = cc::Build::new();
 656         // FIXME: Workaround for https://github.com/emscripten-core/emscripten/issues/9013
 657         if target.contains("emscripten") {
 658             cfg.pic(false);
 659         }
 660
 661         // We may have found various cross-compilers a little differently due to our
 662         // extra configuration, so inform cc of these compilers. Note, though, that
 663         // on MSVC we still need cc's detection of env vars (ugh).
 664         if !target.contains("msvc") {
 665             if let Some(ar) = builder.ar(target) {
 666                 cfg.archiver(ar);
 667             }
 668             cfg.compiler(builder.cc(target));
 669         }
 670         cfg.cargo_metadata(false)
 671             .out_dir(&dst)
 672             .target(&target.triple)
 673             .host(&builder.config.build.triple)
 674             .opt_level(0)
 675             .warnings(false)
 676             .debug(false)
 677             .file(builder.src.join("src/test/auxiliary/rust_test_helpers.c"))
 678             .compile("rust_test_helpers");
 679     }
 680 }
 681
 682 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
 683 pub struct Sanitizers {
 684     pub target: TargetSelection,
 685 }
 686
 687 impl Step for Sanitizers {
 688     type Output = Vec<SanitizerRuntime>;
 689
 690     fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
 691         run.path("src/llvm-project/compiler-rt").path("src/sanitizers")
 692     }
 693
 694     fn make_run(run: RunConfig<'_>) {
 695         run.builder.ensure(Sanitizers { target: run.target });
 696     }
 697
 698     /// Builds sanitizer runtime libraries.
 699     fn run(self, builder: &Builder<'_>) -> Self::Output {
 700         let compiler_rt_dir = builder.src.join("src/llvm-project/compiler-rt");
 701         if !compiler_rt_dir.exists() {
 702             return Vec::new();
 703         }
 704
 705         let out_dir = builder.native_dir(self.target).join("sanitizers");
 706         let runtimes = supported_sanitizers(&out_dir, self.target, &builder.config.channel);
 707         if runtimes.is_empty() {
 708             return runtimes;
 709         }
 710
 711         let llvm_config = builder.ensure(Llvm { target: builder.config.build });
 712         if builder.config.dry_run {
 713             return runtimes;
 714         }
 715
 716         let stamp = out_dir.join("sanitizers-finished-building");
 717         let stamp = HashStamp::new(stamp, builder.in_tree_llvm_info.sha());
 718
 719         if stamp.is_done() {
 720             if stamp.hash.is_none() {
 721                 builder.info(&format!(
 722                     "Rebuild sanitizers by removing the file `{}`",
 723                     stamp.path.display()
 724                 ));
 725             }
 726             return runtimes;
 727         }
 728
 729         builder.info(&format!("Building sanitizers for {}", self.target));
 730         t!(stamp.remove());
 731         let _time = util::timeit(&builder);
 732
 733         let mut cfg = cmake::Config::new(&compiler_rt_dir);
 734         cfg.profile("Release");
 735         cfg.define("CMAKE_C_COMPILER_TARGET", self.target.triple);
 736         cfg.define("COMPILER_RT_BUILD_BUILTINS", "OFF");
 737         cfg.define("COMPILER_RT_BUILD_CRT", "OFF");
 738         cfg.define("COMPILER_RT_BUILD_LIBFUZZER", "OFF");
 739         cfg.define("COMPILER_RT_BUILD_PROFILE", "OFF");
 740         cfg.define("COMPILER_RT_BUILD_SANITIZERS", "ON");
 741         cfg.define("COMPILER_RT_BUILD_XRAY", "OFF");
 742         cfg.define("COMPILER_RT_DEFAULT_TARGET_ONLY", "ON");
 743         cfg.define("COMPILER_RT_USE_LIBCXX", "OFF");
 744         cfg.define("LLVM_CONFIG_PATH", &llvm_config);
 745
 746         // On Darwin targets the sanitizer runtimes are build as universal binaries.
 747         // Unfortunately sccache currently lacks support to build them successfully.
 748         // Disable compiler launcher on Darwin targets to avoid potential issues.
 749         let use_compiler_launcher = !self.target.contains("apple-darwin");
 750         configure_cmake(builder, self.target, &mut cfg, use_compiler_launcher);
 751
 752         t!(fs::create_dir_all(&out_dir));
 753         cfg.out_dir(out_dir);
 754
 755         for runtime in &runtimes {
 756             cfg.build_target(&runtime.cmake_target);
 757             cfg.build();
 758         }
 759         t!(stamp.write());
 760
 761         runtimes
 762     }
 763 }
 764
 765 #[derive(Clone, Debug)]
 766 pub struct SanitizerRuntime {
 767     /// CMake target used to build the runtime.
 768     pub cmake_target: String,
 769     /// Path to the built runtime library.
 770     pub path: PathBuf,
 771     /// Library filename that will be used rustc.
 772     pub name: String,
 773 }
 774
 775 /// Returns sanitizers available on a given target.
 776 fn supported_sanitizers(
 777     out_dir: &Path,
 778     target: TargetSelection,
 779     channel: &str,
 780 ) -> Vec<SanitizerRuntime> {
 781     let darwin_libs = |os: &str, components: &[&str]| -> Vec<SanitizerRuntime> {
 782         components
 783             .iter()
 784             .map(move |c| SanitizerRuntime {
 785                 cmake_target: format!("clang_rt.{}_{}_dynamic", c, os),
 786                 path: out_dir
 787                     .join(&format!("build/lib/darwin/libclang_rt.{}_{}_dynamic.dylib", c, os)),
 788                 name: format!("librustc-{}_rt.{}.dylib", channel, c),
 789             })
 790             .collect()
 791     };
 792
 793     let common_libs = |os: &str, arch: &str, components: &[&str]| -> Vec<SanitizerRuntime> {
 794         components
 795             .iter()
 796             .map(move |c| SanitizerRuntime {
 797                 cmake_target: format!("clang_rt.{}-{}", c, arch),
 798                 path: out_dir.join(&format!("build/lib/{}/libclang_rt.{}-{}.a", os, c, arch)),
 799                 name: format!("librustc-{}_rt.{}.a", channel, c),
 800             })
 801             .collect()
 802     };
 803
 804     match &*target.triple {
 805         "aarch64-fuchsia" => common_libs("fuchsia", "aarch64", &["asan"]),
 806         "aarch64-unknown-linux-gnu" => {
 807             common_libs("linux", "aarch64", &["asan", "lsan", "msan", "tsan"])
 808         }
 809         "x86_64-apple-darwin" => darwin_libs("osx", &["asan", "lsan", "tsan"]),
 810         "x86_64-fuchsia" => common_libs("fuchsia", "x86_64", &["asan"]),
 811         "x86_64-unknown-freebsd" => common_libs("freebsd", "x86_64", &["asan", "msan", "tsan"]),
 812         "x86_64-unknown-linux-gnu" => {
 813             common_libs("linux", "x86_64", &["asan", "lsan", "msan", "tsan"])
 814         }
 815         _ => Vec::new(),
 816     }
 817 }
 818
 819 struct HashStamp {
 820     path: PathBuf,
 821     hash: Option<Vec<u8>>,
 822 }
 823
 824 impl HashStamp {
 825     fn new(path: PathBuf, hash: Option<&str>) -> Self {
 826         HashStamp { path, hash: hash.map(|s| s.as_bytes().to_owned()) }
 827     }
 828
 829     fn is_done(&self) -> bool {
 830         match fs::read(&self.path) {
 831             Ok(h) => self.hash.as_deref().unwrap_or(b"") == h.as_slice(),
 832             Err(e) if e.kind() == io::ErrorKind::NotFound => false,
 833             Err(e) => {
 834                 panic!("failed to read stamp file `{}`: {}", self.path.display(), e);
 835             }
 836         }
 837     }
 838
 839     fn remove(&self) -> io::Result<()> {
 840         match fs::remove_file(&self.path) {
 841             Ok(()) => Ok(()),
 842             Err(e) => {
 843                 if e.kind() == io::ErrorKind::NotFound {
 844                     Ok(())
 845                 } else {
 846                     Err(e)
 847                 }
 848             }
 849         }
 850     }
 851
 852     fn write(&self) -> io::Result<()> {
 853         fs::write(&self.path, self.hash.as_deref().unwrap_or(b""))
 854     }
 855 }