1 //! Compilation of native dependencies like LLVM.
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).
8 //! LLVM and compiler-rt are essentially just wired up to everything else to
9 //! ensure that they're always in place if needed.
12 use std::env::consts::EXE_EXTENSION;
13 use std::ffi::{OsStr, OsString};
14 use std::fs::{self, File};
16 use std::path::{Path, PathBuf};
17 use std::process::Command;
19 use build_helper::{output, t};
21 use crate::builder::{Builder, RunConfig, ShouldRun, Step};
22 use crate::config::TargetSelection;
23 use crate::util::{self, exe};
25 use build_helper::up_to_date;
29 build_llvm_config: PathBuf,
34 // This returns whether we've already previously built LLVM.
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.
39 // This will return the llvm-config if it can get it (but it will not build it
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());
54 let root = "src/llvm-project/llvm";
55 let out_dir = builder.llvm_out(target);
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");
61 llvm_config_ret_dir.push("bin");
63 let build_llvm_config = llvm_config_ret_dir.join(exe("llvm-config", builder.config.build));
65 let stamp = out_dir.join("llvm-finished-building");
66 let stamp = HashStamp::new(stamp, builder.in_tree_llvm_info.sha());
68 if builder.config.llvm_skip_rebuild && stamp.path.exists() {
71 Using a potentially stale build of LLVM; \
72 This may not behave well.",
74 return Ok(build_llvm_config);
78 if stamp.hash.is_none() {
80 "Could not determine the LLVM submodule commit hash. \
81 Assuming that an LLVM rebuild is not necessary.",
83 builder.info(&format!(
84 "To force LLVM to rebuild, remove the file `{}`",
88 return Ok(build_llvm_config);
91 Err(Meta { stamp, build_llvm_config, out_dir, root: root.into() })
94 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
96 pub target: TargetSelection,
100 type Output = PathBuf; // path to llvm-config
102 const ONLY_HOSTS: bool = true;
104 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
105 run.path("src/llvm-project").path("src/llvm-project/llvm").path("src/llvm")
108 fn make_run(run: RunConfig<'_>) {
109 run.builder.ensure(Llvm { target: run.target });
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();
120 format!("riscv{}{}", &target.triple[5..7], &target.triple[idx..])
121 } else if self.target.starts_with("powerpc") && self.target.ends_with("freebsd") {
122 // FreeBSD 13 had incompatible ABI changes on all PowerPC platforms.
123 // Set the version suffix to 13.0 so the correct target details are used.
124 format!("{}{}", self.target, "13.0")
129 let Meta { stamp, build_llvm_config, out_dir, root } =
130 match prebuilt_llvm_config(builder, target) {
135 builder.update_submodule(&Path::new("src").join("llvm-project"));
136 if builder.config.llvm_link_shared
137 && (target.contains("windows") || target.contains("apple-darwin"))
139 panic!("shared linking to LLVM is not currently supported on {}", target.triple);
142 builder.info(&format!("Building LLVM for {}", target));
144 let _time = util::timeit(&builder);
145 t!(fs::create_dir_all(&out_dir));
147 // https://llvm.org/docs/CMake.html
148 let mut cfg = cmake::Config::new(builder.src.join(root));
150 let profile = match (builder.config.llvm_optimize, builder.config.llvm_release_debuginfo) {
151 (false, _) => "Debug",
152 (true, false) => "Release",
153 (true, true) => "RelWithDebInfo",
156 // NOTE: remember to also update `config.toml.example` when changing the
158 let llvm_targets = match &builder.config.llvm_targets {
161 "AArch64;ARM;BPF;Hexagon;MSP430;Mips;NVPTX;PowerPC;RISCV;\
162 Sparc;SystemZ;WebAssembly;X86"
166 let llvm_exp_targets = match builder.config.llvm_experimental_targets {
171 let assertions = if builder.config.llvm_assertions { "ON" } else { "OFF" };
172 let plugins = if builder.config.llvm_plugins { "ON" } else { "OFF" };
173 let enable_tests = if builder.config.llvm_tests { "ON" } else { "OFF" };
175 cfg.out_dir(&out_dir)
177 .define("LLVM_ENABLE_ASSERTIONS", assertions)
178 .define("LLVM_ENABLE_PLUGINS", plugins)
179 .define("LLVM_TARGETS_TO_BUILD", llvm_targets)
180 .define("LLVM_EXPERIMENTAL_TARGETS_TO_BUILD", llvm_exp_targets)
181 .define("LLVM_INCLUDE_EXAMPLES", "OFF")
182 .define("LLVM_INCLUDE_DOCS", "OFF")
183 .define("LLVM_INCLUDE_BENCHMARKS", "OFF")
184 .define("LLVM_INCLUDE_TESTS", enable_tests)
185 .define("LLVM_ENABLE_TERMINFO", "OFF")
186 .define("LLVM_ENABLE_LIBEDIT", "OFF")
187 .define("LLVM_ENABLE_BINDINGS", "OFF")
188 .define("LLVM_ENABLE_Z3_SOLVER", "OFF")
189 .define("LLVM_PARALLEL_COMPILE_JOBS", builder.jobs().to_string())
190 .define("LLVM_TARGET_ARCH", target_native.split('-').next().unwrap())
191 .define("LLVM_DEFAULT_TARGET_TRIPLE", target_native);
193 // Parts of our test suite rely on the `FileCheck` tool, which is built by default in
194 // `build/$TARGET/llvm/build/bin` is but *not* then installed to `build/$TARGET/llvm/bin`.
195 // This flag makes sure `FileCheck` is copied in the final binaries directory.
196 cfg.define("LLVM_INSTALL_UTILS", "ON");
198 if builder.config.llvm_profile_generate {
199 cfg.define("LLVM_BUILD_INSTRUMENTED", "IR");
200 cfg.define("LLVM_BUILD_RUNTIME", "No");
202 if let Some(path) = builder.config.llvm_profile_use.as_ref() {
203 cfg.define("LLVM_PROFDATA_FILE", &path);
206 if target != "aarch64-apple-darwin" && !target.contains("windows") {
207 cfg.define("LLVM_ENABLE_ZLIB", "ON");
209 cfg.define("LLVM_ENABLE_ZLIB", "OFF");
212 // Are we compiling for iOS/tvOS?
213 if target.contains("apple-ios") || target.contains("apple-tvos") {
214 // These two defines prevent CMake from automatically trying to add a MacOSX sysroot, which leads to a compiler error.
215 cfg.define("CMAKE_OSX_SYSROOT", "/");
216 cfg.define("CMAKE_OSX_DEPLOYMENT_TARGET", "");
217 // Prevent cmake from adding -bundle to CFLAGS automatically, which leads to a compiler error because "-bitcode_bundle" also gets added.
218 cfg.define("LLVM_ENABLE_PLUGINS", "OFF");
219 // Zlib fails to link properly, leading to a compiler error.
220 cfg.define("LLVM_ENABLE_ZLIB", "OFF");
223 if builder.config.llvm_thin_lto {
224 cfg.define("LLVM_ENABLE_LTO", "Thin");
225 if !target.contains("apple") {
226 cfg.define("LLVM_ENABLE_LLD", "ON");
230 // This setting makes the LLVM tools link to the dynamic LLVM library,
231 // which saves both memory during parallel links and overall disk space
232 // for the tools. We don't do this on every platform as it doesn't work
233 // equally well everywhere.
235 // If we're not linking rustc to a dynamic LLVM, though, then don't link
237 if builder.llvm_link_tools_dynamically(target) && builder.config.llvm_link_shared {
238 cfg.define("LLVM_LINK_LLVM_DYLIB", "ON");
241 // For distribution we want the LLVM tools to be *statically* linked to libstdc++
242 if builder.config.llvm_tools_enabled {
243 if !target.contains("msvc") {
244 if target.contains("apple") {
245 cfg.define("CMAKE_EXE_LINKER_FLAGS", "-static-libstdc++");
247 cfg.define("CMAKE_EXE_LINKER_FLAGS", "-Wl,-Bsymbolic -static-libstdc++");
252 if !target.contains("freebsd") && target.starts_with("riscv") {
253 // RISC-V GCC erroneously requires linking against
254 // `libatomic` when using 1-byte and 2-byte C++
255 // atomics but the LLVM build system check cannot
256 // detect this. Therefore it is set manually here.
257 // FreeBSD uses Clang as its system compiler and
258 // provides no libatomic in its base system so does
260 if !builder.config.llvm_tools_enabled {
261 cfg.define("CMAKE_EXE_LINKER_FLAGS", "-latomic");
263 cfg.define("CMAKE_EXE_LINKER_FLAGS", "-latomic -static-libstdc++");
265 cfg.define("CMAKE_SHARED_LINKER_FLAGS", "-latomic");
268 if target.contains("msvc") {
269 cfg.define("LLVM_USE_CRT_DEBUG", "MT");
270 cfg.define("LLVM_USE_CRT_RELEASE", "MT");
271 cfg.define("LLVM_USE_CRT_RELWITHDEBINFO", "MT");
272 cfg.static_crt(true);
275 if target.starts_with("i686") {
276 cfg.define("LLVM_BUILD_32_BITS", "ON");
279 let mut enabled_llvm_projects = Vec::new();
281 if util::forcing_clang_based_tests() {
282 enabled_llvm_projects.push("clang");
283 enabled_llvm_projects.push("compiler-rt");
286 if builder.config.llvm_polly {
287 enabled_llvm_projects.push("polly");
290 if builder.config.llvm_clang {
291 enabled_llvm_projects.push("clang");
294 // We want libxml to be disabled.
295 // See https://github.com/rust-lang/rust/pull/50104
296 cfg.define("LLVM_ENABLE_LIBXML2", "OFF");
298 if !enabled_llvm_projects.is_empty() {
299 enabled_llvm_projects.sort();
300 enabled_llvm_projects.dedup();
301 cfg.define("LLVM_ENABLE_PROJECTS", enabled_llvm_projects.join(";"));
304 if let Some(num_linkers) = builder.config.llvm_link_jobs {
306 cfg.define("LLVM_PARALLEL_LINK_JOBS", num_linkers.to_string());
310 // Workaround for ppc32 lld limitation
311 if target == "powerpc-unknown-freebsd" {
312 cfg.define("CMAKE_EXE_LINKER_FLAGS", "-fuse-ld=bfd");
315 // https://llvm.org/docs/HowToCrossCompileLLVM.html
316 if target != builder.config.build {
317 builder.ensure(Llvm { target: builder.config.build });
318 // FIXME: if the llvm root for the build triple is overridden then we
319 // should use llvm-tblgen from there, also should verify that it
320 // actually exists most of the time in normal installs of LLVM.
321 let host_bin = builder.llvm_out(builder.config.build).join("bin");
322 cfg.define("CMAKE_CROSSCOMPILING", "True");
323 cfg.define("LLVM_TABLEGEN", host_bin.join("llvm-tblgen").with_extension(EXE_EXTENSION));
324 cfg.define("LLVM_NM", host_bin.join("llvm-nm").with_extension(EXE_EXTENSION));
327 host_bin.join("llvm-config").with_extension(EXE_EXTENSION),
331 if let Some(ref suffix) = builder.config.llvm_version_suffix {
332 // Allow version-suffix="" to not define a version suffix at all.
333 if !suffix.is_empty() {
334 cfg.define("LLVM_VERSION_SUFFIX", suffix);
336 } else if builder.config.channel == "dev" {
337 // Changes to a version suffix require a complete rebuild of the LLVM.
338 // To avoid rebuilds during a time of version bump, don't include rustc
339 // release number on the dev channel.
340 cfg.define("LLVM_VERSION_SUFFIX", "-rust-dev");
342 let suffix = format!("-rust-{}-{}", builder.version, builder.config.channel);
343 cfg.define("LLVM_VERSION_SUFFIX", suffix);
346 if let Some(ref linker) = builder.config.llvm_use_linker {
347 cfg.define("LLVM_USE_LINKER", linker);
350 if builder.config.llvm_allow_old_toolchain {
351 cfg.define("LLVM_TEMPORARILY_ALLOW_OLD_TOOLCHAIN", "YES");
354 configure_cmake(builder, target, &mut cfg, true);
356 for (key, val) in &builder.config.llvm_build_config {
357 cfg.define(key, val);
360 // FIXME: we don't actually need to build all LLVM tools and all LLVM
361 // libraries here, e.g., we just want a few components and a few
362 // tools. Figure out how to filter them down and only build the right
363 // tools and libs on all platforms.
365 if builder.config.dry_run {
366 return build_llvm_config;
377 fn check_llvm_version(builder: &Builder<'_>, llvm_config: &Path) {
378 if !builder.config.llvm_version_check {
382 if builder.config.dry_run {
386 let mut cmd = Command::new(llvm_config);
387 let version = output(cmd.arg("--version"));
388 let mut parts = version.split('.').take(2).filter_map(|s| s.parse::<u32>().ok());
389 if let (Some(major), Some(_minor)) = (parts.next(), parts.next()) {
394 panic!("\n\nbad LLVM version: {}, need >=12.0\n\n", version)
398 builder: &Builder<'_>,
399 target: TargetSelection,
400 cfg: &mut cmake::Config,
401 use_compiler_launcher: bool,
403 // Do not print installation messages for up-to-date files.
404 // LLVM and LLD builds can produce a lot of those and hit CI limits on log size.
405 cfg.define("CMAKE_INSTALL_MESSAGE", "LAZY");
407 // Do not allow the user's value of DESTDIR to influence where
408 // LLVM will install itself. LLVM must always be installed in our
409 // own build directories.
410 cfg.env("DESTDIR", "");
413 cfg.generator("Ninja");
415 cfg.target(&target.triple).host(&builder.config.build.triple);
417 if target != builder.config.build {
418 if target.contains("netbsd") {
419 cfg.define("CMAKE_SYSTEM_NAME", "NetBSD");
420 } else if target.contains("freebsd") {
421 cfg.define("CMAKE_SYSTEM_NAME", "FreeBSD");
422 } else if target.contains("windows") {
423 cfg.define("CMAKE_SYSTEM_NAME", "Windows");
424 } else if target.contains("haiku") {
425 cfg.define("CMAKE_SYSTEM_NAME", "Haiku");
426 } else if target.contains("solaris") || target.contains("illumos") {
427 cfg.define("CMAKE_SYSTEM_NAME", "SunOS");
429 // When cross-compiling we should also set CMAKE_SYSTEM_VERSION, but in
430 // that case like CMake we cannot easily determine system version either.
432 // Since, the LLVM itself makes rather limited use of version checks in
433 // CMakeFiles (and then only in tests), and so far no issues have been
434 // reported, the system version is currently left unset.
437 let sanitize_cc = |cc: &Path| {
438 if target.contains("msvc") {
439 OsString::from(cc.to_str().unwrap().replace("\\", "/"))
441 cc.as_os_str().to_owned()
445 // MSVC with CMake uses msbuild by default which doesn't respect these
446 // vars that we'd otherwise configure. In that case we just skip this
448 if target.contains("msvc") && !builder.ninja() {
452 let (cc, cxx) = match builder.config.llvm_clang_cl {
453 Some(ref cl) => (cl.as_ref(), cl.as_ref()),
454 None => (builder.cc(target), builder.cxx(target).unwrap()),
457 // Handle msvc + ninja + ccache specially (this is what the bots use)
458 if target.contains("msvc") && builder.ninja() && builder.config.ccache.is_some() {
459 let mut wrap_cc = env::current_exe().expect("failed to get cwd");
460 wrap_cc.set_file_name("sccache-plus-cl.exe");
462 cfg.define("CMAKE_C_COMPILER", sanitize_cc(&wrap_cc))
463 .define("CMAKE_CXX_COMPILER", sanitize_cc(&wrap_cc));
464 cfg.env("SCCACHE_PATH", builder.config.ccache.as_ref().unwrap())
465 .env("SCCACHE_TARGET", target.triple)
466 .env("SCCACHE_CC", &cc)
467 .env("SCCACHE_CXX", &cxx);
469 // Building LLVM on MSVC can be a little ludicrous at times. We're so far
470 // off the beaten path here that I'm not really sure this is even half
471 // supported any more. Here we're trying to:
473 // * Build LLVM on MSVC
474 // * Build LLVM with `clang-cl` instead of `cl.exe`
475 // * Build a project with `sccache`
476 // * Build for 32-bit as well
477 // * Build with Ninja
479 // For `cl.exe` there are different binaries to compile 32/64 bit which
480 // we use but for `clang-cl` there's only one which internally
481 // multiplexes via flags. As a result it appears that CMake's detection
482 // of a compiler's architecture and such on MSVC **doesn't** pass any
483 // custom flags we pass in CMAKE_CXX_FLAGS below. This means that if we
484 // use `clang-cl.exe` it's always diagnosed as a 64-bit compiler which
485 // definitely causes problems since all the env vars are pointing to
488 // To hack around this... again... we pass an argument that's
489 // unconditionally passed in the sccache shim. This'll get CMake to
490 // correctly diagnose it's doing a 32-bit compilation and LLVM will
491 // internally configure itself appropriately.
492 if builder.config.llvm_clang_cl.is_some() && target.contains("i686") {
493 cfg.env("SCCACHE_EXTRA_ARGS", "-m32");
496 // If ccache is configured we inform the build a little differently how
497 // to invoke ccache while also invoking our compilers.
498 if use_compiler_launcher {
499 if let Some(ref ccache) = builder.config.ccache {
500 cfg.define("CMAKE_C_COMPILER_LAUNCHER", ccache)
501 .define("CMAKE_CXX_COMPILER_LAUNCHER", ccache);
504 cfg.define("CMAKE_C_COMPILER", sanitize_cc(cc))
505 .define("CMAKE_CXX_COMPILER", sanitize_cc(cxx))
506 .define("CMAKE_ASM_COMPILER", sanitize_cc(cc));
509 cfg.build_arg("-j").build_arg(builder.jobs().to_string());
510 let mut cflags = builder.cflags(target, GitRepo::Llvm).join(" ");
511 if let Some(ref s) = builder.config.llvm_cflags {
512 cflags.push_str(&format!(" {}", s));
514 // Some compiler features used by LLVM (such as thread locals) will not work on a min version below iOS 10.
515 if target.contains("apple-ios") {
516 if target.contains("86-") {
517 cflags.push_str(" -miphonesimulator-version-min=10.0");
519 cflags.push_str(" -miphoneos-version-min=10.0");
522 if builder.config.llvm_clang_cl.is_some() {
523 cflags.push_str(&format!(" --target={}", target))
525 cfg.define("CMAKE_C_FLAGS", cflags);
526 let mut cxxflags = builder.cflags(target, GitRepo::Llvm).join(" ");
527 if builder.config.llvm_static_stdcpp && !target.contains("msvc") && !target.contains("netbsd") {
528 cxxflags.push_str(" -static-libstdc++");
530 if let Some(ref s) = builder.config.llvm_cxxflags {
531 cxxflags.push_str(&format!(" {}", s));
533 if builder.config.llvm_clang_cl.is_some() {
534 cxxflags.push_str(&format!(" --target={}", target))
536 cfg.define("CMAKE_CXX_FLAGS", cxxflags);
537 if let Some(ar) = builder.ar(target) {
538 if ar.is_absolute() {
539 // LLVM build breaks if `CMAKE_AR` is a relative path, for some reason it
540 // tries to resolve this path in the LLVM build directory.
541 cfg.define("CMAKE_AR", sanitize_cc(ar));
545 if let Some(ranlib) = builder.ranlib(target) {
546 if ranlib.is_absolute() {
547 // LLVM build breaks if `CMAKE_RANLIB` is a relative path, for some reason it
548 // tries to resolve this path in the LLVM build directory.
549 cfg.define("CMAKE_RANLIB", sanitize_cc(ranlib));
553 if let Some(ref s) = builder.config.llvm_ldflags {
554 cfg.define("CMAKE_SHARED_LINKER_FLAGS", s);
555 cfg.define("CMAKE_MODULE_LINKER_FLAGS", s);
556 cfg.define("CMAKE_EXE_LINKER_FLAGS", s);
559 if env::var_os("SCCACHE_ERROR_LOG").is_some() {
560 cfg.env("RUSTC_LOG", "sccache=warn");
564 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
566 pub target: TargetSelection,
570 type Output = PathBuf;
571 const ONLY_HOSTS: bool = true;
573 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
574 run.path("src/llvm-project/lld").path("src/tools/lld")
577 fn make_run(run: RunConfig<'_>) {
578 run.builder.ensure(Lld { target: run.target });
581 /// Compile LLD for `target`.
582 fn run(self, builder: &Builder<'_>) -> PathBuf {
583 if builder.config.dry_run {
584 return PathBuf::from("lld-out-dir-test-gen");
586 let target = self.target;
588 let llvm_config = builder.ensure(Llvm { target: self.target });
590 let out_dir = builder.lld_out(target);
591 let done_stamp = out_dir.join("lld-finished-building");
592 if done_stamp.exists() {
596 builder.info(&format!("Building LLD for {}", target));
597 let _time = util::timeit(&builder);
598 t!(fs::create_dir_all(&out_dir));
600 let mut cfg = cmake::Config::new(builder.src.join("src/llvm-project/lld"));
601 configure_cmake(builder, target, &mut cfg, true);
603 // This is an awful, awful hack. Discovered when we migrated to using
604 // clang-cl to compile LLVM/LLD it turns out that LLD, when built out of
605 // tree, will execute `llvm-config --cmakedir` and then tell CMake about
606 // that directory for later processing. Unfortunately if this path has
607 // forward slashes in it (which it basically always does on Windows)
608 // then CMake will hit a syntax error later on as... something isn't
611 // Instead of attempting to fix this problem in upstream CMake and/or
612 // LLVM/LLD we just hack around it here. This thin wrapper will take the
613 // output from llvm-config and replace all instances of `\` with `/` to
614 // ensure we don't hit the same bugs with escaping. It means that you
615 // can't build on a system where your paths require `\` on Windows, but
616 // there's probably a lot of reasons you can't do that other than this.
617 let llvm_config_shim = env::current_exe().unwrap().with_file_name("llvm-config-wrapper");
619 cfg.out_dir(&out_dir)
621 .env("LLVM_CONFIG_REAL", &llvm_config)
622 .define("LLVM_CONFIG_PATH", llvm_config_shim)
623 .define("LLVM_INCLUDE_TESTS", "OFF");
625 // While we're using this horrible workaround to shim the execution of
626 // llvm-config, let's just pile on more. I can't seem to figure out how
627 // to build LLD as a standalone project and also cross-compile it at the
628 // same time. It wants a natively executable `llvm-config` to learn
629 // about LLVM, but then it learns about all the host configuration of
630 // LLVM and tries to link to host LLVM libraries.
632 // To work around that we tell our shim to replace anything with the
633 // build target with the actual target instead. This'll break parts of
634 // LLD though which try to execute host tools, such as llvm-tblgen, so
635 // we specifically tell it where to find those. This is likely super
636 // brittle and will break over time. If anyone knows better how to
637 // cross-compile LLD it would be much appreciated to fix this!
638 if target != builder.config.build {
639 cfg.env("LLVM_CONFIG_SHIM_REPLACE", &builder.config.build.triple)
640 .env("LLVM_CONFIG_SHIM_REPLACE_WITH", &target.triple)
643 llvm_config.with_file_name("llvm-tblgen").with_extension(EXE_EXTENSION),
647 // Explicitly set C++ standard, because upstream doesn't do so
648 // for standalone builds.
649 cfg.define("CMAKE_CXX_STANDARD", "14");
653 t!(File::create(&done_stamp));
658 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
659 pub struct TestHelpers {
660 pub target: TargetSelection,
663 impl Step for TestHelpers {
666 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
667 run.path("src/test/auxiliary/rust_test_helpers.c")
670 fn make_run(run: RunConfig<'_>) {
671 run.builder.ensure(TestHelpers { target: run.target })
674 /// Compiles the `rust_test_helpers.c` library which we used in various
675 /// `run-pass` tests for ABI testing.
676 fn run(self, builder: &Builder<'_>) {
677 if builder.config.dry_run {
680 // The x86_64-fortanix-unknown-sgx target doesn't have a working C
681 // toolchain. However, some x86_64 ELF objects can be linked
682 // without issues. Use this hack to compile the test helpers.
683 let target = if self.target == "x86_64-fortanix-unknown-sgx" {
684 TargetSelection::from_user("x86_64-unknown-linux-gnu")
688 let dst = builder.test_helpers_out(target);
689 let src = builder.src.join("src/test/auxiliary/rust_test_helpers.c");
690 if up_to_date(&src, &dst.join("librust_test_helpers.a")) {
694 builder.info("Building test helpers");
695 t!(fs::create_dir_all(&dst));
696 let mut cfg = cc::Build::new();
697 // FIXME: Workaround for https://github.com/emscripten-core/emscripten/issues/9013
698 if target.contains("emscripten") {
702 // We may have found various cross-compilers a little differently due to our
703 // extra configuration, so inform cc of these compilers. Note, though, that
704 // on MSVC we still need cc's detection of env vars (ugh).
705 if !target.contains("msvc") {
706 if let Some(ar) = builder.ar(target) {
709 cfg.compiler(builder.cc(target));
711 cfg.cargo_metadata(false)
713 .target(&target.triple)
714 .host(&builder.config.build.triple)
718 .file(builder.src.join("src/test/auxiliary/rust_test_helpers.c"))
719 .compile("rust_test_helpers");
723 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
724 pub struct Sanitizers {
725 pub target: TargetSelection,
728 impl Step for Sanitizers {
729 type Output = Vec<SanitizerRuntime>;
731 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
732 run.path("src/llvm-project/compiler-rt").path("src/sanitizers")
735 fn make_run(run: RunConfig<'_>) {
736 run.builder.ensure(Sanitizers { target: run.target });
739 /// Builds sanitizer runtime libraries.
740 fn run(self, builder: &Builder<'_>) -> Self::Output {
741 let compiler_rt_dir = builder.src.join("src/llvm-project/compiler-rt");
742 if !compiler_rt_dir.exists() {
746 let out_dir = builder.native_dir(self.target).join("sanitizers");
747 let runtimes = supported_sanitizers(&out_dir, self.target, &builder.config.channel);
748 if runtimes.is_empty() {
752 let llvm_config = builder.ensure(Llvm { target: builder.config.build });
753 if builder.config.dry_run {
757 let stamp = out_dir.join("sanitizers-finished-building");
758 let stamp = HashStamp::new(stamp, builder.in_tree_llvm_info.sha());
761 if stamp.hash.is_none() {
762 builder.info(&format!(
763 "Rebuild sanitizers by removing the file `{}`",
770 builder.info(&format!("Building sanitizers for {}", self.target));
772 let _time = util::timeit(&builder);
774 let mut cfg = cmake::Config::new(&compiler_rt_dir);
775 cfg.profile("Release");
776 cfg.define("CMAKE_C_COMPILER_TARGET", self.target.triple);
777 cfg.define("COMPILER_RT_BUILD_BUILTINS", "OFF");
778 cfg.define("COMPILER_RT_BUILD_CRT", "OFF");
779 cfg.define("COMPILER_RT_BUILD_LIBFUZZER", "OFF");
780 cfg.define("COMPILER_RT_BUILD_PROFILE", "OFF");
781 cfg.define("COMPILER_RT_BUILD_SANITIZERS", "ON");
782 cfg.define("COMPILER_RT_BUILD_XRAY", "OFF");
783 cfg.define("COMPILER_RT_DEFAULT_TARGET_ONLY", "ON");
784 cfg.define("COMPILER_RT_USE_LIBCXX", "OFF");
785 cfg.define("LLVM_CONFIG_PATH", &llvm_config);
787 // On Darwin targets the sanitizer runtimes are build as universal binaries.
788 // Unfortunately sccache currently lacks support to build them successfully.
789 // Disable compiler launcher on Darwin targets to avoid potential issues.
790 let use_compiler_launcher = !self.target.contains("apple-darwin");
791 configure_cmake(builder, self.target, &mut cfg, use_compiler_launcher);
793 t!(fs::create_dir_all(&out_dir));
794 cfg.out_dir(out_dir);
796 for runtime in &runtimes {
797 cfg.build_target(&runtime.cmake_target);
806 #[derive(Clone, Debug)]
807 pub struct SanitizerRuntime {
808 /// CMake target used to build the runtime.
809 pub cmake_target: String,
810 /// Path to the built runtime library.
812 /// Library filename that will be used rustc.
816 /// Returns sanitizers available on a given target.
817 fn supported_sanitizers(
819 target: TargetSelection,
821 ) -> Vec<SanitizerRuntime> {
822 let darwin_libs = |os: &str, components: &[&str]| -> Vec<SanitizerRuntime> {
825 .map(move |c| SanitizerRuntime {
826 cmake_target: format!("clang_rt.{}_{}_dynamic", c, os),
828 .join(&format!("build/lib/darwin/libclang_rt.{}_{}_dynamic.dylib", c, os)),
829 name: format!("librustc-{}_rt.{}.dylib", channel, c),
834 let common_libs = |os: &str, arch: &str, components: &[&str]| -> Vec<SanitizerRuntime> {
837 .map(move |c| SanitizerRuntime {
838 cmake_target: format!("clang_rt.{}-{}", c, arch),
839 path: out_dir.join(&format!("build/lib/{}/libclang_rt.{}-{}.a", os, c, arch)),
840 name: format!("librustc-{}_rt.{}.a", channel, c),
845 match &*target.triple {
846 "aarch64-apple-darwin" => darwin_libs("osx", &["asan", "lsan", "tsan"]),
847 "aarch64-fuchsia" => common_libs("fuchsia", "aarch64", &["asan"]),
848 "aarch64-unknown-linux-gnu" => {
849 common_libs("linux", "aarch64", &["asan", "lsan", "msan", "tsan", "hwasan"])
851 "x86_64-apple-darwin" => darwin_libs("osx", &["asan", "lsan", "tsan"]),
852 "x86_64-fuchsia" => common_libs("fuchsia", "x86_64", &["asan"]),
853 "x86_64-unknown-freebsd" => common_libs("freebsd", "x86_64", &["asan", "msan", "tsan"]),
854 "x86_64-unknown-netbsd" => {
855 common_libs("netbsd", "x86_64", &["asan", "lsan", "msan", "tsan"])
857 "x86_64-unknown-illumos" => common_libs("illumos", "x86_64", &["asan"]),
858 "x86_64-pc-solaris" => common_libs("solaris", "x86_64", &["asan"]),
859 "x86_64-unknown-linux-gnu" => {
860 common_libs("linux", "x86_64", &["asan", "lsan", "msan", "tsan"])
862 "x86_64-unknown-linux-musl" => {
863 common_libs("linux", "x86_64", &["asan", "lsan", "msan", "tsan"])
871 hash: Option<Vec<u8>>,
875 fn new(path: PathBuf, hash: Option<&str>) -> Self {
876 HashStamp { path, hash: hash.map(|s| s.as_bytes().to_owned()) }
879 fn is_done(&self) -> bool {
880 match fs::read(&self.path) {
881 Ok(h) => self.hash.as_deref().unwrap_or(b"") == h.as_slice(),
882 Err(e) if e.kind() == io::ErrorKind::NotFound => false,
884 panic!("failed to read stamp file `{}`: {}", self.path.display(), e);
889 fn remove(&self) -> io::Result<()> {
890 match fs::remove_file(&self.path) {
893 if e.kind() == io::ErrorKind::NotFound {
902 fn write(&self) -> io::Result<()> {
903 fs::write(&self.path, self.hash.as_deref().unwrap_or(b""))
907 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
908 pub struct CrtBeginEnd {
909 pub target: TargetSelection,
912 impl Step for CrtBeginEnd {
913 type Output = PathBuf;
915 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
916 run.path("src/llvm-project/compiler-rt/lib/crt")
919 fn make_run(run: RunConfig<'_>) {
920 run.builder.ensure(CrtBeginEnd { target: run.target });
923 /// Build crtbegin.o/crtend.o for musl target.
924 fn run(self, builder: &Builder<'_>) -> Self::Output {
925 let out_dir = builder.native_dir(self.target).join("crt");
927 if builder.config.dry_run {
931 let crtbegin_src = builder.src.join("src/llvm-project/compiler-rt/lib/crt/crtbegin.c");
932 let crtend_src = builder.src.join("src/llvm-project/compiler-rt/lib/crt/crtend.c");
933 if up_to_date(&crtbegin_src, &out_dir.join("crtbegin.o"))
934 && up_to_date(&crtend_src, &out_dir.join("crtendS.o"))
939 builder.info("Building crtbegin.o and crtend.o");
940 t!(fs::create_dir_all(&out_dir));
942 let mut cfg = cc::Build::new();
944 if let Some(ar) = builder.ar(self.target) {
947 cfg.compiler(builder.cc(self.target));
948 cfg.cargo_metadata(false)
950 .target(&self.target.triple)
951 .host(&builder.config.build.triple)
958 // Those flags are defined in src/llvm-project/compiler-rt/lib/crt/CMakeLists.txt
959 // Currently only consumer of those objects is musl, which use .init_array/.fini_array
960 // instead of .ctors/.dtors
962 .define("CRT_HAS_INITFINI_ARRAY", None)
963 .define("EH_USE_FRAME_REGISTRY", None);
967 t!(fs::copy(out_dir.join("crtbegin.o"), out_dir.join("crtbeginS.o")));
968 t!(fs::copy(out_dir.join("crtend.o"), out_dir.join("crtendS.o")));
973 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
974 pub struct Libunwind {
975 pub target: TargetSelection,
978 impl Step for Libunwind {
979 type Output = PathBuf;
981 fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
982 run.path("src/llvm-project/libunwind")
985 fn make_run(run: RunConfig<'_>) {
986 run.builder.ensure(Libunwind { target: run.target });
989 /// Build linunwind.a
990 fn run(self, builder: &Builder<'_>) -> Self::Output {
991 if builder.config.dry_run {
992 return PathBuf::new();
995 let out_dir = builder.native_dir(self.target).join("libunwind");
996 let root = builder.src.join("src/llvm-project/libunwind");
998 if up_to_date(&root, &out_dir.join("libunwind.a")) {
1002 builder.info(&format!("Building libunwind.a for {}", self.target.triple));
1003 t!(fs::create_dir_all(&out_dir));
1005 let mut cc_cfg = cc::Build::new();
1006 let mut cpp_cfg = cc::Build::new();
1009 cpp_cfg.cpp_set_stdlib(None);
1010 cpp_cfg.flag("-nostdinc++");
1011 cpp_cfg.flag("-fno-exceptions");
1012 cpp_cfg.flag("-fno-rtti");
1013 cpp_cfg.flag_if_supported("-fvisibility-global-new-delete-hidden");
1015 for cfg in [&mut cc_cfg, &mut cpp_cfg].iter_mut() {
1016 if let Some(ar) = builder.ar(self.target) {
1019 cfg.target(&self.target.triple);
1020 cfg.host(&builder.config.build.triple);
1021 cfg.warnings(false);
1023 // get_compiler() need set opt_level first.
1025 cfg.flag("-fstrict-aliasing");
1026 cfg.flag("-funwind-tables");
1027 cfg.flag("-fvisibility=hidden");
1028 cfg.define("_LIBUNWIND_DISABLE_VISIBILITY_ANNOTATIONS", None);
1029 cfg.include(root.join("include"));
1030 cfg.cargo_metadata(false);
1031 cfg.out_dir(&out_dir);
1033 if self.target.contains("x86_64-fortanix-unknown-sgx") {
1034 cfg.static_flag(true);
1035 cfg.flag("-fno-stack-protector");
1036 cfg.flag("-ffreestanding");
1037 cfg.flag("-fexceptions");
1039 // easiest way to undefine since no API available in cc::Build to undefine
1040 cfg.flag("-U_FORTIFY_SOURCE");
1041 cfg.define("_FORTIFY_SOURCE", "0");
1042 cfg.define("RUST_SGX", "1");
1043 cfg.define("__NO_STRING_INLINES", None);
1044 cfg.define("__NO_MATH_INLINES", None);
1045 cfg.define("_LIBUNWIND_IS_BAREMETAL", None);
1046 cfg.define("__LIBUNWIND_IS_NATIVE_ONLY", None);
1047 cfg.define("NDEBUG", None);
1051 cc_cfg.compiler(builder.cc(self.target));
1052 if let Ok(cxx) = builder.cxx(self.target) {
1053 cpp_cfg.compiler(cxx);
1055 cc_cfg.compiler(builder.cc(self.target));
1058 // Don't set this for clang
1059 // By default, Clang builds C code in GNU C17 mode.
1060 // By default, Clang builds C++ code according to the C++98 standard,
1061 // with many C++11 features accepted as extensions.
1062 if cc_cfg.get_compiler().is_like_gnu() {
1063 cc_cfg.flag("-std=c99");
1065 if cpp_cfg.get_compiler().is_like_gnu() {
1066 cpp_cfg.flag("-std=c++11");
1069 if self.target.contains("x86_64-fortanix-unknown-sgx") || self.target.contains("musl") {
1070 // use the same GCC C compiler command to compile C++ code so we do not need to setup the
1071 // C++ compiler env variables on the builders.
1072 // Don't set this for clang++, as clang++ is able to compile this without libc++.
1073 if cpp_cfg.get_compiler().is_like_gnu() {
1075 cpp_cfg.compiler(builder.cc(self.target));
1079 let mut c_sources = vec![
1081 "UnwindLevel1-gcc-ext.c",
1083 "UnwindRegistersRestore.S",
1084 "UnwindRegistersSave.S",
1087 let cpp_sources = vec!["Unwind-EHABI.cpp", "Unwind-seh.cpp", "libunwind.cpp"];
1088 let cpp_len = cpp_sources.len();
1090 if self.target.contains("x86_64-fortanix-unknown-sgx") {
1091 c_sources.push("UnwindRustSgx.c");
1094 for src in c_sources {
1095 cc_cfg.file(root.join("src").join(src).canonicalize().unwrap());
1098 for src in &cpp_sources {
1099 cpp_cfg.file(root.join("src").join(src).canonicalize().unwrap());
1102 cpp_cfg.compile("unwind-cpp");
1104 // FIXME: https://github.com/alexcrichton/cc-rs/issues/545#issuecomment-679242845
1106 for entry in fs::read_dir(&out_dir).unwrap() {
1107 let file = entry.unwrap().path().canonicalize().unwrap();
1108 if file.is_file() && file.extension() == Some(OsStr::new("o")) {
1109 // file name starts with "Unwind-EHABI", "Unwind-seh" or "libunwind"
1110 let file_name = file.file_name().unwrap().to_str().expect("UTF-8 file name");
1111 if cpp_sources.iter().any(|f| file_name.starts_with(&f[..f.len() - 4])) {
1112 cc_cfg.object(&file);
1117 assert_eq!(cpp_len, count, "Can't get object files from {:?}", &out_dir);
1119 cc_cfg.compile("unwind");