bootstrap/core/build_steps/
llvm.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
11use std::env::consts::EXE_EXTENSION;
12use std::ffi::{OsStr, OsString};
13use std::path::{Path, PathBuf};
14use std::sync::OnceLock;
15use std::{env, fs};
16
17use build_helper::git::PathFreshness;
18#[cfg(feature = "tracing")]
19use tracing::instrument;
20
21use crate::core::builder::{Builder, RunConfig, ShouldRun, Step, StepMetadata};
22use crate::core::config::{Config, TargetSelection};
23use crate::utils::build_stamp::{BuildStamp, generate_smart_stamp_hash};
24use crate::utils::exec::command;
25use crate::utils::helpers::{
26    self, exe, get_clang_cl_resource_dir, t, unhashed_basename, up_to_date,
27};
28use crate::{CLang, GitRepo, Kind, trace};
29
30#[derive(Clone)]
31pub struct LlvmResult {
32    /// Path to llvm-config binary.
33    /// NB: This is always the host llvm-config!
34    pub llvm_config: PathBuf,
35    /// Path to LLVM cmake directory for the target.
36    pub llvm_cmake_dir: PathBuf,
37}
38
39pub struct Meta {
40    stamp: BuildStamp,
41    res: LlvmResult,
42    out_dir: PathBuf,
43    root: String,
44}
45
46pub enum LlvmBuildStatus {
47    AlreadyBuilt(LlvmResult),
48    ShouldBuild(Meta),
49}
50
51impl LlvmBuildStatus {
52    pub fn should_build(&self) -> bool {
53        match self {
54            LlvmBuildStatus::AlreadyBuilt(_) => false,
55            LlvmBuildStatus::ShouldBuild(_) => true,
56        }
57    }
58
59    #[cfg(test)]
60    pub fn llvm_result(&self) -> &LlvmResult {
61        match self {
62            LlvmBuildStatus::AlreadyBuilt(res) => res,
63            LlvmBuildStatus::ShouldBuild(meta) => &meta.res,
64        }
65    }
66}
67
68/// Linker flags to pass to LLVM's CMake invocation.
69#[derive(Debug, Clone, Default)]
70struct LdFlags {
71    /// CMAKE_EXE_LINKER_FLAGS
72    exe: OsString,
73    /// CMAKE_SHARED_LINKER_FLAGS
74    shared: OsString,
75    /// CMAKE_MODULE_LINKER_FLAGS
76    module: OsString,
77}
78
79impl LdFlags {
80    fn push_all(&mut self, s: impl AsRef<OsStr>) {
81        let s = s.as_ref();
82        self.exe.push(" ");
83        self.exe.push(s);
84        self.shared.push(" ");
85        self.shared.push(s);
86        self.module.push(" ");
87        self.module.push(s);
88    }
89}
90
91/// This returns whether we've already previously built LLVM.
92///
93/// It's used to avoid busting caches during x.py check -- if we've already built
94/// LLVM, it's fine for us to not try to avoid doing so.
95///
96/// This will return the llvm-config if it can get it (but it will not build it
97/// if not).
98pub fn prebuilt_llvm_config(
99    builder: &Builder<'_>,
100    target: TargetSelection,
101    // Certain commands (like `x test mir-opt --bless`) may call this function with different targets,
102    // which could bypass the CI LLVM early-return even if `builder.config.llvm_from_ci` is true.
103    // This flag should be `true` only if the caller needs the LLVM sources (e.g., if it will build LLVM).
104    handle_submodule_when_needed: bool,
105) -> LlvmBuildStatus {
106    builder.config.maybe_download_ci_llvm();
107
108    // If we're using a custom LLVM bail out here, but we can only use a
109    // custom LLVM for the build triple.
110    if let Some(config) = builder.config.target_config.get(&target)
111        && let Some(ref s) = config.llvm_config
112    {
113        check_llvm_version(builder, s);
114        let llvm_config = s.to_path_buf();
115        let mut llvm_cmake_dir = llvm_config.clone();
116        llvm_cmake_dir.pop();
117        llvm_cmake_dir.pop();
118        llvm_cmake_dir.push("lib");
119        llvm_cmake_dir.push("cmake");
120        llvm_cmake_dir.push("llvm");
121        return LlvmBuildStatus::AlreadyBuilt(LlvmResult { llvm_config, llvm_cmake_dir });
122    }
123
124    if handle_submodule_when_needed {
125        // If submodules are disabled, this does nothing.
126        builder.config.update_submodule("src/llvm-project");
127    }
128
129    let root = "src/llvm-project/llvm";
130    let out_dir = builder.llvm_out(target);
131
132    let build_llvm_config = if let Some(build_llvm_config) = builder
133        .config
134        .target_config
135        .get(&builder.config.host_target)
136        .and_then(|config| config.llvm_config.clone())
137    {
138        build_llvm_config
139    } else {
140        let mut llvm_config_ret_dir = builder.llvm_out(builder.config.host_target);
141        llvm_config_ret_dir.push("bin");
142        llvm_config_ret_dir.join(exe("llvm-config", builder.config.host_target))
143    };
144
145    let llvm_cmake_dir = out_dir.join("lib/cmake/llvm");
146    let res = LlvmResult { llvm_config: build_llvm_config, llvm_cmake_dir };
147
148    static STAMP_HASH_MEMO: OnceLock<String> = OnceLock::new();
149    let smart_stamp_hash = STAMP_HASH_MEMO.get_or_init(|| {
150        generate_smart_stamp_hash(
151            builder,
152            &builder.config.src.join("src/llvm-project"),
153            builder.in_tree_llvm_info.sha().unwrap_or_default(),
154        )
155    });
156
157    let stamp = BuildStamp::new(&out_dir).with_prefix("llvm").add_stamp(smart_stamp_hash);
158
159    if stamp.is_up_to_date() {
160        if stamp.stamp().is_empty() {
161            builder.info(
162                "Could not determine the LLVM submodule commit hash. \
163                     Assuming that an LLVM rebuild is not necessary.",
164            );
165            builder.info(&format!(
166                "To force LLVM to rebuild, remove the file `{}`",
167                stamp.path().display()
168            ));
169        }
170        return LlvmBuildStatus::AlreadyBuilt(res);
171    }
172
173    LlvmBuildStatus::ShouldBuild(Meta { stamp, res, out_dir, root: root.into() })
174}
175
176/// Paths whose changes invalidate LLVM downloads.
177pub const LLVM_INVALIDATION_PATHS: &[&str] = &[
178    "src/llvm-project",
179    "src/bootstrap/download-ci-llvm-stamp",
180    // the LLVM shared object file is named `LLVM-<LLVM-version>-rust-{version}-nightly`
181    "src/version",
182];
183
184/// Detect whether LLVM sources have been modified locally or not.
185pub(crate) fn detect_llvm_freshness(config: &Config, is_git: bool) -> PathFreshness {
186    if is_git {
187        config.check_path_modifications(LLVM_INVALIDATION_PATHS)
188    } else if let Some(info) = crate::utils::channel::read_commit_info_file(&config.src) {
189        PathFreshness::LastModifiedUpstream { upstream: info.sha.trim().to_owned() }
190    } else {
191        PathFreshness::MissingUpstream
192    }
193}
194
195/// Returns whether the CI-found LLVM is currently usable.
196///
197/// This checks the build triple platform to confirm we're usable at all, and if LLVM
198/// with/without assertions is available.
199pub(crate) fn is_ci_llvm_available_for_target(config: &Config, asserts: bool) -> bool {
200    // This is currently all tier 1 targets and tier 2 targets with host tools
201    // (since others may not have CI artifacts)
202    // https://doc.rust-lang.org/rustc/platform-support.html#tier-1
203    let supported_platforms = [
204        // tier 1
205        ("aarch64-unknown-linux-gnu", false),
206        ("aarch64-apple-darwin", false),
207        ("i686-pc-windows-gnu", false),
208        ("i686-pc-windows-msvc", false),
209        ("i686-unknown-linux-gnu", false),
210        ("x86_64-unknown-linux-gnu", true),
211        ("x86_64-apple-darwin", true),
212        ("x86_64-pc-windows-gnu", true),
213        ("x86_64-pc-windows-msvc", true),
214        // tier 2 with host tools
215        ("aarch64-pc-windows-msvc", false),
216        ("aarch64-unknown-linux-musl", false),
217        ("arm-unknown-linux-gnueabi", false),
218        ("arm-unknown-linux-gnueabihf", false),
219        ("armv7-unknown-linux-gnueabihf", false),
220        ("loongarch64-unknown-linux-gnu", false),
221        ("loongarch64-unknown-linux-musl", false),
222        ("mips-unknown-linux-gnu", false),
223        ("mips64-unknown-linux-gnuabi64", false),
224        ("mips64el-unknown-linux-gnuabi64", false),
225        ("mipsel-unknown-linux-gnu", false),
226        ("powerpc-unknown-linux-gnu", false),
227        ("powerpc64-unknown-linux-gnu", false),
228        ("powerpc64le-unknown-linux-gnu", false),
229        ("powerpc64le-unknown-linux-musl", false),
230        ("riscv64gc-unknown-linux-gnu", false),
231        ("s390x-unknown-linux-gnu", false),
232        ("x86_64-unknown-freebsd", false),
233        ("x86_64-unknown-illumos", false),
234        ("x86_64-unknown-linux-musl", false),
235        ("x86_64-unknown-netbsd", false),
236    ];
237
238    if !supported_platforms.contains(&(&*config.host_target.triple, asserts))
239        && (asserts || !supported_platforms.contains(&(&*config.host_target.triple, true)))
240    {
241        return false;
242    }
243
244    true
245}
246
247#[derive(Debug, Clone, Hash, PartialEq, Eq)]
248pub struct Llvm {
249    pub target: TargetSelection,
250}
251
252impl Step for Llvm {
253    type Output = LlvmResult;
254
255    const ONLY_HOSTS: bool = true;
256
257    fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
258        run.path("src/llvm-project").path("src/llvm-project/llvm")
259    }
260
261    fn make_run(run: RunConfig<'_>) {
262        run.builder.ensure(Llvm { target: run.target });
263    }
264
265    /// Compile LLVM for `target`.
266    fn run(self, builder: &Builder<'_>) -> LlvmResult {
267        let target = self.target;
268        let target_native = if self.target.starts_with("riscv") {
269            // RISC-V target triples in Rust is not named the same as C compiler target triples.
270            // This converts Rust RISC-V target triples to C compiler triples.
271            let idx = target.triple.find('-').unwrap();
272
273            format!("riscv{}{}", &target.triple[5..7], &target.triple[idx..])
274        } else if self.target.starts_with("powerpc") && self.target.ends_with("freebsd") {
275            // FreeBSD 13 had incompatible ABI changes on all PowerPC platforms.
276            // Set the version suffix to 13.0 so the correct target details are used.
277            format!("{}{}", self.target, "13.0")
278        } else {
279            target.to_string()
280        };
281
282        // If LLVM has already been built or been downloaded through download-ci-llvm, we avoid building it again.
283        let Meta { stamp, res, out_dir, root } = match prebuilt_llvm_config(builder, target, true) {
284            LlvmBuildStatus::AlreadyBuilt(p) => return p,
285            LlvmBuildStatus::ShouldBuild(m) => m,
286        };
287
288        if builder.llvm_link_shared() && target.is_windows() && !target.ends_with("windows-gnullvm")
289        {
290            panic!("shared linking to LLVM is not currently supported on {}", target.triple);
291        }
292
293        let _guard = builder.msg_unstaged(Kind::Build, "LLVM", target);
294        t!(stamp.remove());
295        let _time = helpers::timeit(builder);
296        t!(fs::create_dir_all(&out_dir));
297
298        // https://llvm.org/docs/CMake.html
299        let mut cfg = cmake::Config::new(builder.src.join(root));
300        let mut ldflags = LdFlags::default();
301
302        let profile = match (builder.config.llvm_optimize, builder.config.llvm_release_debuginfo) {
303            (false, _) => "Debug",
304            (true, false) => "Release",
305            (true, true) => "RelWithDebInfo",
306        };
307
308        // NOTE: remember to also update `bootstrap.example.toml` when changing the
309        // defaults!
310        let llvm_targets = match &builder.config.llvm_targets {
311            Some(s) => s,
312            None => {
313                "AArch64;AMDGPU;ARM;BPF;Hexagon;LoongArch;MSP430;Mips;NVPTX;PowerPC;RISCV;\
314                     Sparc;SystemZ;WebAssembly;X86"
315            }
316        };
317
318        let llvm_exp_targets = match builder.config.llvm_experimental_targets {
319            Some(ref s) => s,
320            None => "AVR;M68k;CSKY;Xtensa",
321        };
322
323        let assertions = if builder.config.llvm_assertions { "ON" } else { "OFF" };
324        let plugins = if builder.config.llvm_plugins { "ON" } else { "OFF" };
325        let enable_tests = if builder.config.llvm_tests { "ON" } else { "OFF" };
326        let enable_warnings = if builder.config.llvm_enable_warnings { "ON" } else { "OFF" };
327
328        cfg.out_dir(&out_dir)
329            .profile(profile)
330            .define("LLVM_ENABLE_ASSERTIONS", assertions)
331            .define("LLVM_UNREACHABLE_OPTIMIZE", "OFF")
332            .define("LLVM_ENABLE_PLUGINS", plugins)
333            .define("LLVM_TARGETS_TO_BUILD", llvm_targets)
334            .define("LLVM_EXPERIMENTAL_TARGETS_TO_BUILD", llvm_exp_targets)
335            .define("LLVM_INCLUDE_EXAMPLES", "OFF")
336            .define("LLVM_INCLUDE_DOCS", "OFF")
337            .define("LLVM_INCLUDE_BENCHMARKS", "OFF")
338            .define("LLVM_INCLUDE_TESTS", enable_tests)
339            .define("LLVM_ENABLE_LIBEDIT", "OFF")
340            .define("LLVM_ENABLE_BINDINGS", "OFF")
341            .define("LLVM_ENABLE_Z3_SOLVER", "OFF")
342            .define("LLVM_PARALLEL_COMPILE_JOBS", builder.jobs().to_string())
343            .define("LLVM_TARGET_ARCH", target_native.split('-').next().unwrap())
344            .define("LLVM_DEFAULT_TARGET_TRIPLE", target_native)
345            .define("LLVM_ENABLE_WARNINGS", enable_warnings);
346
347        // Parts of our test suite rely on the `FileCheck` tool, which is built by default in
348        // `build/$TARGET/llvm/build/bin` is but *not* then installed to `build/$TARGET/llvm/bin`.
349        // This flag makes sure `FileCheck` is copied in the final binaries directory.
350        cfg.define("LLVM_INSTALL_UTILS", "ON");
351
352        if builder.config.llvm_profile_generate {
353            cfg.define("LLVM_BUILD_INSTRUMENTED", "IR");
354            if let Ok(llvm_profile_dir) = std::env::var("LLVM_PROFILE_DIR") {
355                cfg.define("LLVM_PROFILE_DATA_DIR", llvm_profile_dir);
356            }
357            cfg.define("LLVM_BUILD_RUNTIME", "No");
358        }
359        if let Some(path) = builder.config.llvm_profile_use.as_ref() {
360            cfg.define("LLVM_PROFDATA_FILE", path);
361        }
362
363        // Libraries for ELF section compression and profraw files merging.
364        if !target.is_msvc() {
365            cfg.define("LLVM_ENABLE_ZLIB", "ON");
366        } else {
367            cfg.define("LLVM_ENABLE_ZLIB", "OFF");
368        }
369
370        // Are we compiling for iOS/tvOS/watchOS/visionOS?
371        if target.contains("apple-ios")
372            || target.contains("apple-tvos")
373            || target.contains("apple-watchos")
374            || target.contains("apple-visionos")
375        {
376            // Prevent cmake from adding -bundle to CFLAGS automatically, which leads to a compiler error because "-bitcode_bundle" also gets added.
377            cfg.define("LLVM_ENABLE_PLUGINS", "OFF");
378            // Zlib fails to link properly, leading to a compiler error.
379            cfg.define("LLVM_ENABLE_ZLIB", "OFF");
380        }
381
382        // This setting makes the LLVM tools link to the dynamic LLVM library,
383        // which saves both memory during parallel links and overall disk space
384        // for the tools. We don't do this on every platform as it doesn't work
385        // equally well everywhere.
386        if builder.llvm_link_shared() {
387            cfg.define("LLVM_LINK_LLVM_DYLIB", "ON");
388        }
389
390        if (target.starts_with("csky")
391            || target.starts_with("riscv")
392            || target.starts_with("sparc-"))
393            && !target.contains("freebsd")
394            && !target.contains("openbsd")
395            && !target.contains("netbsd")
396        {
397            // CSKY and RISC-V GCC erroneously requires linking against
398            // `libatomic` when using 1-byte and 2-byte C++
399            // atomics but the LLVM build system check cannot
400            // detect this. Therefore it is set manually here.
401            // Some BSD uses Clang as its system compiler and
402            // provides no libatomic in its base system so does
403            // not want this. 32-bit SPARC requires linking against
404            // libatomic as well.
405            ldflags.exe.push(" -latomic");
406            ldflags.shared.push(" -latomic");
407        }
408
409        if target.starts_with("mips") && target.contains("netbsd") {
410            // LLVM wants 64-bit atomics, while mipsel is 32-bit only, so needs -latomic
411            ldflags.exe.push(" -latomic");
412            ldflags.shared.push(" -latomic");
413        }
414
415        if target.is_msvc() {
416            cfg.define("CMAKE_MSVC_RUNTIME_LIBRARY", "MultiThreaded");
417            cfg.static_crt(true);
418        }
419
420        if target.starts_with("i686") {
421            cfg.define("LLVM_BUILD_32_BITS", "ON");
422        }
423
424        if target.starts_with("x86_64") && target.contains("ohos") {
425            cfg.define("LLVM_TOOL_LLVM_RTDYLD_BUILD", "OFF");
426        }
427
428        let mut enabled_llvm_projects = Vec::new();
429
430        if helpers::forcing_clang_based_tests() {
431            enabled_llvm_projects.push("clang");
432        }
433
434        if builder.config.llvm_polly {
435            enabled_llvm_projects.push("polly");
436        }
437
438        if builder.config.llvm_clang {
439            enabled_llvm_projects.push("clang");
440        }
441
442        // We want libxml to be disabled.
443        // See https://github.com/rust-lang/rust/pull/50104
444        cfg.define("LLVM_ENABLE_LIBXML2", "OFF");
445
446        let mut enabled_llvm_runtimes = Vec::new();
447
448        if helpers::forcing_clang_based_tests() {
449            enabled_llvm_runtimes.push("compiler-rt");
450        }
451
452        // This is an experimental flag, which likely builds more than necessary.
453        // We will optimize it when we get closer to releasing it on nightly.
454        if builder.config.llvm_offload {
455            enabled_llvm_runtimes.push("offload");
456            //FIXME(ZuseZ4): LLVM intends to drop the offload dependency on openmp.
457            //Remove this line once they achieved it.
458            enabled_llvm_runtimes.push("openmp");
459            enabled_llvm_projects.push("compiler-rt");
460        }
461
462        if !enabled_llvm_projects.is_empty() {
463            enabled_llvm_projects.sort();
464            enabled_llvm_projects.dedup();
465            cfg.define("LLVM_ENABLE_PROJECTS", enabled_llvm_projects.join(";"));
466        }
467
468        if !enabled_llvm_runtimes.is_empty() {
469            enabled_llvm_runtimes.sort();
470            enabled_llvm_runtimes.dedup();
471            cfg.define("LLVM_ENABLE_RUNTIMES", enabled_llvm_runtimes.join(";"));
472        }
473
474        if let Some(num_linkers) = builder.config.llvm_link_jobs
475            && num_linkers > 0
476        {
477            cfg.define("LLVM_PARALLEL_LINK_JOBS", num_linkers.to_string());
478        }
479
480        // https://llvm.org/docs/HowToCrossCompileLLVM.html
481        if !builder.config.is_host_target(target) {
482            let LlvmResult { llvm_config, .. } =
483                builder.ensure(Llvm { target: builder.config.host_target });
484            if !builder.config.dry_run() {
485                let llvm_bindir =
486                    command(&llvm_config).arg("--bindir").run_capture_stdout(builder).stdout();
487                let host_bin = Path::new(llvm_bindir.trim());
488                cfg.define(
489                    "LLVM_TABLEGEN",
490                    host_bin.join("llvm-tblgen").with_extension(EXE_EXTENSION),
491                );
492                // LLVM_NM is required for cross compiling using MSVC
493                cfg.define("LLVM_NM", host_bin.join("llvm-nm").with_extension(EXE_EXTENSION));
494            }
495            cfg.define("LLVM_CONFIG_PATH", llvm_config);
496            if builder.config.llvm_clang {
497                let build_bin =
498                    builder.llvm_out(builder.config.host_target).join("build").join("bin");
499                let clang_tblgen = build_bin.join("clang-tblgen").with_extension(EXE_EXTENSION);
500                if !builder.config.dry_run() && !clang_tblgen.exists() {
501                    panic!("unable to find {}", clang_tblgen.display());
502                }
503                cfg.define("CLANG_TABLEGEN", clang_tblgen);
504            }
505        }
506
507        let llvm_version_suffix = if let Some(ref suffix) = builder.config.llvm_version_suffix {
508            // Allow version-suffix="" to not define a version suffix at all.
509            if !suffix.is_empty() { Some(suffix.to_string()) } else { None }
510        } else if builder.config.channel == "dev" {
511            // Changes to a version suffix require a complete rebuild of the LLVM.
512            // To avoid rebuilds during a time of version bump, don't include rustc
513            // release number on the dev channel.
514            Some("-rust-dev".to_string())
515        } else {
516            Some(format!("-rust-{}-{}", builder.version, builder.config.channel))
517        };
518        if let Some(ref suffix) = llvm_version_suffix {
519            cfg.define("LLVM_VERSION_SUFFIX", suffix);
520        }
521
522        configure_cmake(builder, target, &mut cfg, true, ldflags, &[]);
523        configure_llvm(builder, target, &mut cfg);
524
525        for (key, val) in &builder.config.llvm_build_config {
526            cfg.define(key, val);
527        }
528
529        if builder.config.dry_run() {
530            return res;
531        }
532
533        cfg.build();
534
535        // Helper to find the name of LLVM's shared library on darwin and linux.
536        let find_llvm_lib_name = |extension| {
537            let major = get_llvm_version_major(builder, &res.llvm_config);
538            match &llvm_version_suffix {
539                Some(version_suffix) => format!("libLLVM-{major}{version_suffix}.{extension}"),
540                None => format!("libLLVM-{major}.{extension}"),
541            }
542        };
543
544        // FIXME(ZuseZ4): Do we need that for Enzyme too?
545        // When building LLVM with LLVM_LINK_LLVM_DYLIB for macOS, an unversioned
546        // libLLVM.dylib will be built. However, llvm-config will still look
547        // for a versioned path like libLLVM-14.dylib. Manually create a symbolic
548        // link to make llvm-config happy.
549        if builder.llvm_link_shared() && target.contains("apple-darwin") {
550            let lib_name = find_llvm_lib_name("dylib");
551            let lib_llvm = out_dir.join("build").join("lib").join(lib_name);
552            if !lib_llvm.exists() {
553                t!(builder.symlink_file("libLLVM.dylib", &lib_llvm));
554            }
555        }
556
557        // When building LLVM as a shared library on linux, it can contain unexpected debuginfo:
558        // some can come from the C++ standard library. Unless we're explicitly requesting LLVM to
559        // be built with debuginfo, strip it away after the fact, to make dist artifacts smaller.
560        if builder.llvm_link_shared()
561            && builder.config.llvm_optimize
562            && !builder.config.llvm_release_debuginfo
563        {
564            // Find the name of the LLVM shared library that we just built.
565            let lib_name = find_llvm_lib_name("so");
566
567            // If the shared library exists in LLVM's `/build/lib/` or `/lib/` folders, strip its
568            // debuginfo.
569            crate::core::build_steps::compile::strip_debug(
570                builder,
571                target,
572                &out_dir.join("lib").join(&lib_name),
573            );
574            crate::core::build_steps::compile::strip_debug(
575                builder,
576                target,
577                &out_dir.join("build").join("lib").join(&lib_name),
578            );
579        }
580
581        t!(stamp.write());
582
583        res
584    }
585
586    fn metadata(&self) -> Option<StepMetadata> {
587        Some(StepMetadata::build("llvm", self.target))
588    }
589}
590
591pub fn get_llvm_version(builder: &Builder<'_>, llvm_config: &Path) -> String {
592    command(llvm_config).arg("--version").run_capture_stdout(builder).stdout().trim().to_owned()
593}
594
595pub fn get_llvm_version_major(builder: &Builder<'_>, llvm_config: &Path) -> u8 {
596    let version = get_llvm_version(builder, llvm_config);
597    let major_str = version.split_once('.').expect("Failed to parse LLVM version").0;
598    major_str.parse().unwrap()
599}
600
601fn check_llvm_version(builder: &Builder<'_>, llvm_config: &Path) {
602    if builder.config.dry_run() {
603        return;
604    }
605
606    let version = get_llvm_version(builder, llvm_config);
607    let mut parts = version.split('.').take(2).filter_map(|s| s.parse::<u32>().ok());
608    if let (Some(major), Some(_minor)) = (parts.next(), parts.next())
609        && major >= 19
610    {
611        return;
612    }
613    panic!("\n\nbad LLVM version: {version}, need >=19\n\n")
614}
615
616fn configure_cmake(
617    builder: &Builder<'_>,
618    target: TargetSelection,
619    cfg: &mut cmake::Config,
620    use_compiler_launcher: bool,
621    mut ldflags: LdFlags,
622    suppressed_compiler_flag_prefixes: &[&str],
623) {
624    // Do not print installation messages for up-to-date files.
625    // LLVM and LLD builds can produce a lot of those and hit CI limits on log size.
626    cfg.define("CMAKE_INSTALL_MESSAGE", "LAZY");
627
628    // Do not allow the user's value of DESTDIR to influence where
629    // LLVM will install itself. LLVM must always be installed in our
630    // own build directories.
631    cfg.env("DESTDIR", "");
632
633    if builder.ninja() {
634        cfg.generator("Ninja");
635    }
636    cfg.target(&target.triple).host(&builder.config.host_target.triple);
637
638    if !builder.config.is_host_target(target) {
639        cfg.define("CMAKE_CROSSCOMPILING", "True");
640
641        // NOTE: Ideally, we wouldn't have to do this, and `cmake-rs` would just handle it for us.
642        // But it currently determines this based on the `CARGO_CFG_TARGET_OS` environment variable,
643        // which isn't set when compiling outside `build.rs` (like bootstrap is).
644        //
645        // So for now, we define `CMAKE_SYSTEM_NAME` ourselves, to panicking in `cmake-rs`.
646        if target.contains("netbsd") {
647            cfg.define("CMAKE_SYSTEM_NAME", "NetBSD");
648        } else if target.contains("dragonfly") {
649            cfg.define("CMAKE_SYSTEM_NAME", "DragonFly");
650        } else if target.contains("openbsd") {
651            cfg.define("CMAKE_SYSTEM_NAME", "OpenBSD");
652        } else if target.contains("freebsd") {
653            cfg.define("CMAKE_SYSTEM_NAME", "FreeBSD");
654        } else if target.is_windows() {
655            cfg.define("CMAKE_SYSTEM_NAME", "Windows");
656        } else if target.contains("haiku") {
657            cfg.define("CMAKE_SYSTEM_NAME", "Haiku");
658        } else if target.contains("solaris") || target.contains("illumos") {
659            cfg.define("CMAKE_SYSTEM_NAME", "SunOS");
660        } else if target.contains("linux") {
661            cfg.define("CMAKE_SYSTEM_NAME", "Linux");
662        } else if target.contains("darwin") {
663            // macOS
664            cfg.define("CMAKE_SYSTEM_NAME", "Darwin");
665        } else if target.contains("ios") {
666            cfg.define("CMAKE_SYSTEM_NAME", "iOS");
667        } else if target.contains("tvos") {
668            cfg.define("CMAKE_SYSTEM_NAME", "tvOS");
669        } else if target.contains("visionos") {
670            cfg.define("CMAKE_SYSTEM_NAME", "visionOS");
671        } else if target.contains("watchos") {
672            cfg.define("CMAKE_SYSTEM_NAME", "watchOS");
673        } else if target.contains("none") {
674            // "none" should be the last branch
675            cfg.define("CMAKE_SYSTEM_NAME", "Generic");
676        } else {
677            builder.info(&format!(
678                "could not determine CMAKE_SYSTEM_NAME from the target `{target}`, build may fail",
679            ));
680            // Fallback, set `CMAKE_SYSTEM_NAME` anyhow to avoid the logic `cmake-rs` tries, and
681            // to avoid CMAKE_SYSTEM_NAME being inferred from the host.
682            cfg.define("CMAKE_SYSTEM_NAME", "Generic");
683        }
684
685        // When cross-compiling we should also set CMAKE_SYSTEM_VERSION, but in
686        // that case like CMake we cannot easily determine system version either.
687        //
688        // Since, the LLVM itself makes rather limited use of version checks in
689        // CMakeFiles (and then only in tests), and so far no issues have been
690        // reported, the system version is currently left unset.
691
692        if target.contains("apple") {
693            if !target.contains("darwin") {
694                // FIXME(madsmtm): compiler-rt's CMake setup is kinda weird, it seems like they do
695                // version testing etc. for macOS (i.e. Darwin), even while building for iOS?
696                //
697                // So for now we set it to "Darwin" on all Apple platforms.
698                cfg.define("CMAKE_SYSTEM_NAME", "Darwin");
699
700                // These two defines prevent CMake from automatically trying to add a MacOSX sysroot, which leads to a compiler error.
701                cfg.define("CMAKE_OSX_SYSROOT", "/");
702                cfg.define("CMAKE_OSX_DEPLOYMENT_TARGET", "");
703            }
704
705            // Make sure that CMake does not build universal binaries on macOS.
706            // Explicitly specify the one single target architecture.
707            if target.starts_with("aarch64") {
708                // macOS uses a different name for building arm64
709                cfg.define("CMAKE_OSX_ARCHITECTURES", "arm64");
710            } else if target.starts_with("i686") {
711                // macOS uses a different name for building i386
712                cfg.define("CMAKE_OSX_ARCHITECTURES", "i386");
713            } else {
714                cfg.define("CMAKE_OSX_ARCHITECTURES", target.triple.split('-').next().unwrap());
715            }
716        }
717    }
718
719    let sanitize_cc = |cc: &Path| {
720        if target.is_msvc() {
721            OsString::from(cc.to_str().unwrap().replace('\\', "/"))
722        } else {
723            cc.as_os_str().to_owned()
724        }
725    };
726
727    // MSVC with CMake uses msbuild by default which doesn't respect these
728    // vars that we'd otherwise configure. In that case we just skip this
729    // entirely.
730    if target.is_msvc() && !builder.ninja() {
731        return;
732    }
733
734    let (cc, cxx) = match builder.config.llvm_clang_cl {
735        Some(ref cl) => (cl.into(), cl.into()),
736        None => (builder.cc(target), builder.cxx(target).unwrap()),
737    };
738
739    // If ccache is configured we inform the build a little differently how
740    // to invoke ccache while also invoking our compilers.
741    if use_compiler_launcher && let Some(ref ccache) = builder.config.ccache {
742        cfg.define("CMAKE_C_COMPILER_LAUNCHER", ccache)
743            .define("CMAKE_CXX_COMPILER_LAUNCHER", ccache);
744    }
745    cfg.define("CMAKE_C_COMPILER", sanitize_cc(&cc))
746        .define("CMAKE_CXX_COMPILER", sanitize_cc(&cxx))
747        .define("CMAKE_ASM_COMPILER", sanitize_cc(&cc));
748
749    cfg.build_arg("-j").build_arg(builder.jobs().to_string());
750    // FIXME(madsmtm): Allow `cmake-rs` to select flags by itself by passing
751    // our flags via `.cflag`/`.cxxflag` instead.
752    //
753    // Needs `suppressed_compiler_flag_prefixes` to be gone, and hence
754    // https://github.com/llvm/llvm-project/issues/88780 to be fixed.
755    let mut cflags: OsString = builder
756        .cc_handled_clags(target, CLang::C)
757        .into_iter()
758        .chain(builder.cc_unhandled_cflags(target, GitRepo::Llvm, CLang::C))
759        .filter(|flag| {
760            !suppressed_compiler_flag_prefixes
761                .iter()
762                .any(|suppressed_prefix| flag.starts_with(suppressed_prefix))
763        })
764        .collect::<Vec<String>>()
765        .join(" ")
766        .into();
767    if let Some(ref s) = builder.config.llvm_cflags {
768        cflags.push(" ");
769        cflags.push(s);
770    }
771    if target.contains("ohos") {
772        cflags.push(" -D_LINUX_SYSINFO_H");
773    }
774    if builder.config.llvm_clang_cl.is_some() {
775        cflags.push(format!(" --target={target}"));
776    }
777    cfg.define("CMAKE_C_FLAGS", cflags);
778    let mut cxxflags: OsString = builder
779        .cc_handled_clags(target, CLang::Cxx)
780        .into_iter()
781        .chain(builder.cc_unhandled_cflags(target, GitRepo::Llvm, CLang::Cxx))
782        .filter(|flag| {
783            !suppressed_compiler_flag_prefixes
784                .iter()
785                .any(|suppressed_prefix| flag.starts_with(suppressed_prefix))
786        })
787        .collect::<Vec<String>>()
788        .join(" ")
789        .into();
790    if let Some(ref s) = builder.config.llvm_cxxflags {
791        cxxflags.push(" ");
792        cxxflags.push(s);
793    }
794    if target.contains("ohos") {
795        cxxflags.push(" -D_LINUX_SYSINFO_H");
796    }
797    if builder.config.llvm_clang_cl.is_some() {
798        cxxflags.push(format!(" --target={target}"));
799    }
800    cfg.define("CMAKE_CXX_FLAGS", cxxflags);
801    if let Some(ar) = builder.ar(target)
802        && ar.is_absolute()
803    {
804        // LLVM build breaks if `CMAKE_AR` is a relative path, for some reason it
805        // tries to resolve this path in the LLVM build directory.
806        cfg.define("CMAKE_AR", sanitize_cc(&ar));
807    }
808
809    if let Some(ranlib) = builder.ranlib(target)
810        && ranlib.is_absolute()
811    {
812        // LLVM build breaks if `CMAKE_RANLIB` is a relative path, for some reason it
813        // tries to resolve this path in the LLVM build directory.
814        cfg.define("CMAKE_RANLIB", sanitize_cc(&ranlib));
815    }
816
817    if let Some(ref flags) = builder.config.llvm_ldflags {
818        ldflags.push_all(flags);
819    }
820
821    if let Some(flags) = get_var("LDFLAGS", &builder.config.host_target.triple, &target.triple) {
822        ldflags.push_all(&flags);
823    }
824
825    // For distribution we want the LLVM tools to be *statically* linked to libstdc++.
826    // We also do this if the user explicitly requested static libstdc++.
827    if builder.config.llvm_static_stdcpp
828        && !target.is_msvc()
829        && !target.contains("netbsd")
830        && !target.contains("solaris")
831    {
832        if target.contains("apple") || target.is_windows() {
833            ldflags.push_all("-static-libstdc++");
834        } else {
835            ldflags.push_all("-Wl,-Bsymbolic -static-libstdc++");
836        }
837    }
838
839    cfg.define("CMAKE_SHARED_LINKER_FLAGS", &ldflags.shared);
840    cfg.define("CMAKE_MODULE_LINKER_FLAGS", &ldflags.module);
841    cfg.define("CMAKE_EXE_LINKER_FLAGS", &ldflags.exe);
842
843    if env::var_os("SCCACHE_ERROR_LOG").is_some() {
844        cfg.env("RUSTC_LOG", "sccache=warn");
845    }
846}
847
848fn configure_llvm(builder: &Builder<'_>, target: TargetSelection, cfg: &mut cmake::Config) {
849    // ThinLTO is only available when building with LLVM, enabling LLD is required.
850    // Apple's linker ld64 supports ThinLTO out of the box though, so don't use LLD on Darwin.
851    if builder.config.llvm_thin_lto {
852        cfg.define("LLVM_ENABLE_LTO", "Thin");
853        if !target.contains("apple") {
854            cfg.define("LLVM_ENABLE_LLD", "ON");
855        }
856    }
857
858    // Libraries for ELF section compression.
859    if builder.config.llvm_libzstd {
860        cfg.define("LLVM_ENABLE_ZSTD", "FORCE_ON");
861        cfg.define("LLVM_USE_STATIC_ZSTD", "TRUE");
862    } else {
863        cfg.define("LLVM_ENABLE_ZSTD", "OFF");
864    }
865
866    if let Some(ref linker) = builder.config.llvm_use_linker {
867        cfg.define("LLVM_USE_LINKER", linker);
868    }
869
870    if builder.config.llvm_allow_old_toolchain {
871        cfg.define("LLVM_TEMPORARILY_ALLOW_OLD_TOOLCHAIN", "YES");
872    }
873}
874
875// Adapted from https://github.com/alexcrichton/cc-rs/blob/fba7feded71ee4f63cfe885673ead6d7b4f2f454/src/lib.rs#L2347-L2365
876fn get_var(var_base: &str, host: &str, target: &str) -> Option<OsString> {
877    let kind = if host == target { "HOST" } else { "TARGET" };
878    let target_u = target.replace('-', "_");
879    env::var_os(format!("{var_base}_{target}"))
880        .or_else(|| env::var_os(format!("{var_base}_{target_u}")))
881        .or_else(|| env::var_os(format!("{kind}_{var_base}")))
882        .or_else(|| env::var_os(var_base))
883}
884
885#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
886pub struct Enzyme {
887    pub target: TargetSelection,
888}
889
890impl Step for Enzyme {
891    type Output = PathBuf;
892    const ONLY_HOSTS: bool = true;
893
894    fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
895        run.path("src/tools/enzyme/enzyme")
896    }
897
898    fn make_run(run: RunConfig<'_>) {
899        run.builder.ensure(Enzyme { target: run.target });
900    }
901
902    /// Compile Enzyme for `target`.
903    #[cfg_attr(
904        feature = "tracing",
905        instrument(
906            level = "debug",
907            name = "Enzyme::run",
908            skip_all,
909            fields(target = ?self.target),
910        ),
911    )]
912    fn run(self, builder: &Builder<'_>) -> PathBuf {
913        builder.require_submodule(
914            "src/tools/enzyme",
915            Some("The Enzyme sources are required for autodiff."),
916        );
917        if builder.config.dry_run() {
918            let out_dir = builder.enzyme_out(self.target);
919            return out_dir;
920        }
921        let target = self.target;
922
923        let LlvmResult { llvm_config, .. } = builder.ensure(Llvm { target: self.target });
924
925        static STAMP_HASH_MEMO: OnceLock<String> = OnceLock::new();
926        let smart_stamp_hash = STAMP_HASH_MEMO.get_or_init(|| {
927            generate_smart_stamp_hash(
928                builder,
929                &builder.config.src.join("src/tools/enzyme"),
930                builder.enzyme_info.sha().unwrap_or_default(),
931            )
932        });
933
934        let out_dir = builder.enzyme_out(target);
935        let stamp = BuildStamp::new(&out_dir).with_prefix("enzyme").add_stamp(smart_stamp_hash);
936
937        trace!("checking build stamp to see if we need to rebuild enzyme artifacts");
938        if stamp.is_up_to_date() {
939            trace!(?out_dir, "enzyme build artifacts are up to date");
940            if stamp.stamp().is_empty() {
941                builder.info(
942                    "Could not determine the Enzyme submodule commit hash. \
943                     Assuming that an Enzyme rebuild is not necessary.",
944                );
945                builder.info(&format!(
946                    "To force Enzyme to rebuild, remove the file `{}`",
947                    stamp.path().display()
948                ));
949            }
950            return out_dir;
951        }
952
953        trace!(?target, "(re)building enzyme artifacts");
954        builder.info(&format!("Building Enzyme for {target}"));
955        t!(stamp.remove());
956        let _time = helpers::timeit(builder);
957        t!(fs::create_dir_all(&out_dir));
958
959        builder
960            .config
961            .update_submodule(Path::new("src").join("tools").join("enzyme").to_str().unwrap());
962        let mut cfg = cmake::Config::new(builder.src.join("src/tools/enzyme/enzyme/"));
963        configure_cmake(builder, target, &mut cfg, true, LdFlags::default(), &[]);
964
965        // Re-use the same flags as llvm to control the level of debug information
966        // generated by Enzyme.
967        // FIXME(ZuseZ4): Find a nicer way to use Enzyme Debug builds.
968        let profile = match (builder.config.llvm_optimize, builder.config.llvm_release_debuginfo) {
969            (false, _) => "Debug",
970            (true, false) => "Release",
971            (true, true) => "RelWithDebInfo",
972        };
973        trace!(?profile);
974
975        cfg.out_dir(&out_dir)
976            .profile(profile)
977            .env("LLVM_CONFIG_REAL", &llvm_config)
978            .define("LLVM_ENABLE_ASSERTIONS", "ON")
979            .define("ENZYME_EXTERNAL_SHARED_LIB", "ON")
980            .define("LLVM_DIR", builder.llvm_out(target));
981
982        cfg.build();
983
984        t!(stamp.write());
985        out_dir
986    }
987}
988
989#[derive(Debug, Clone, Hash, PartialEq, Eq)]
990pub struct Lld {
991    pub target: TargetSelection,
992}
993
994impl Step for Lld {
995    type Output = PathBuf;
996    const ONLY_HOSTS: bool = true;
997
998    fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
999        run.path("src/llvm-project/lld")
1000    }
1001
1002    fn make_run(run: RunConfig<'_>) {
1003        run.builder.ensure(Lld { target: run.target });
1004    }
1005
1006    /// Compile LLD for `target`.
1007    fn run(self, builder: &Builder<'_>) -> PathBuf {
1008        if builder.config.dry_run() {
1009            return PathBuf::from("lld-out-dir-test-gen");
1010        }
1011        let target = self.target;
1012
1013        let LlvmResult { llvm_config, llvm_cmake_dir } = builder.ensure(Llvm { target });
1014
1015        // The `dist` step packages LLD next to LLVM's binaries for download-ci-llvm. The root path
1016        // we usually expect here is `./build/$triple/ci-llvm/`, with the binaries in its `bin`
1017        // subfolder. We check if that's the case, and if LLD's binary already exists there next to
1018        // `llvm-config`: if so, we can use it instead of building LLVM/LLD from source.
1019        let ci_llvm_bin = llvm_config.parent().unwrap();
1020        if ci_llvm_bin.is_dir() && ci_llvm_bin.file_name().unwrap() == "bin" {
1021            let lld_path = ci_llvm_bin.join(exe("lld", target));
1022            if lld_path.exists() {
1023                // The following steps copying `lld` as `rust-lld` to the sysroot, expect it in the
1024                // `bin` subfolder of this step's out dir.
1025                return ci_llvm_bin.parent().unwrap().to_path_buf();
1026            }
1027        }
1028
1029        let out_dir = builder.lld_out(target);
1030
1031        let lld_stamp = BuildStamp::new(&out_dir).with_prefix("lld");
1032        if lld_stamp.path().exists() {
1033            return out_dir;
1034        }
1035
1036        let _guard = builder.msg_unstaged(Kind::Build, "LLD", target);
1037        let _time = helpers::timeit(builder);
1038        t!(fs::create_dir_all(&out_dir));
1039
1040        let mut cfg = cmake::Config::new(builder.src.join("src/llvm-project/lld"));
1041        let mut ldflags = LdFlags::default();
1042
1043        // When building LLD as part of a build with instrumentation on windows, for example
1044        // when doing PGO on CI, cmake or clang-cl don't automatically link clang's
1045        // profiler runtime in. In that case, we need to manually ask cmake to do it, to avoid
1046        // linking errors, much like LLVM's cmake setup does in that situation.
1047        if builder.config.llvm_profile_generate
1048            && target.is_msvc()
1049            && let Some(clang_cl_path) = builder.config.llvm_clang_cl.as_ref()
1050        {
1051            // Find clang's runtime library directory and push that as a search path to the
1052            // cmake linker flags.
1053            let clang_rt_dir = get_clang_cl_resource_dir(builder, clang_cl_path);
1054            ldflags.push_all(format!("/libpath:{}", clang_rt_dir.display()));
1055        }
1056
1057        // LLD is built as an LLVM tool, but is distributed outside of the `llvm-tools` component,
1058        // which impacts where it expects to find LLVM's shared library. This causes #80703.
1059        //
1060        // LLD is distributed at "$root/lib/rustlib/$host/bin/rust-lld", but the `libLLVM-*.so` it
1061        // needs is distributed at "$root/lib". The default rpath of "$ORIGIN/../lib" points at the
1062        // lib path for LLVM tools, not the one for rust binaries.
1063        //
1064        // (The `llvm-tools` component copies the .so there for the other tools, and with that
1065        // component installed, one can successfully invoke `rust-lld` directly without rustup's
1066        // `LD_LIBRARY_PATH` overrides)
1067        //
1068        if builder.config.rpath_enabled(target)
1069            && helpers::use_host_linker(target)
1070            && builder.config.llvm_link_shared()
1071            && target.contains("linux")
1072        {
1073            // So we inform LLD where it can find LLVM's libraries by adding an rpath entry to the
1074            // expected parent `lib` directory.
1075            //
1076            // Be careful when changing this path, we need to ensure it's quoted or escaped:
1077            // `$ORIGIN` would otherwise be expanded when the `LdFlags` are passed verbatim to
1078            // cmake.
1079            ldflags.push_all("-Wl,-rpath,'$ORIGIN/../../../'");
1080        }
1081
1082        configure_cmake(builder, target, &mut cfg, true, ldflags, &[]);
1083        configure_llvm(builder, target, &mut cfg);
1084
1085        // Re-use the same flags as llvm to control the level of debug information
1086        // generated for lld.
1087        let profile = match (builder.config.llvm_optimize, builder.config.llvm_release_debuginfo) {
1088            (false, _) => "Debug",
1089            (true, false) => "Release",
1090            (true, true) => "RelWithDebInfo",
1091        };
1092
1093        cfg.out_dir(&out_dir)
1094            .profile(profile)
1095            .define("LLVM_CMAKE_DIR", llvm_cmake_dir)
1096            .define("LLVM_INCLUDE_TESTS", "OFF");
1097
1098        if !builder.config.is_host_target(target) {
1099            // Use the host llvm-tblgen binary.
1100            cfg.define(
1101                "LLVM_TABLEGEN_EXE",
1102                llvm_config.with_file_name("llvm-tblgen").with_extension(EXE_EXTENSION),
1103            );
1104        }
1105
1106        cfg.build();
1107
1108        t!(lld_stamp.write());
1109        out_dir
1110    }
1111}
1112
1113#[derive(Debug, Clone, PartialEq, Eq, Hash)]
1114pub struct Sanitizers {
1115    pub target: TargetSelection,
1116}
1117
1118impl Step for Sanitizers {
1119    type Output = Vec<SanitizerRuntime>;
1120
1121    fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1122        run.alias("sanitizers")
1123    }
1124
1125    fn make_run(run: RunConfig<'_>) {
1126        run.builder.ensure(Sanitizers { target: run.target });
1127    }
1128
1129    /// Builds sanitizer runtime libraries.
1130    fn run(self, builder: &Builder<'_>) -> Self::Output {
1131        let compiler_rt_dir = builder.src.join("src/llvm-project/compiler-rt");
1132        if !compiler_rt_dir.exists() {
1133            return Vec::new();
1134        }
1135
1136        let out_dir = builder.native_dir(self.target).join("sanitizers");
1137        let runtimes = supported_sanitizers(&out_dir, self.target, &builder.config.channel);
1138
1139        if builder.config.dry_run() || runtimes.is_empty() {
1140            return runtimes;
1141        }
1142
1143        let LlvmResult { llvm_config, .. } =
1144            builder.ensure(Llvm { target: builder.config.host_target });
1145
1146        static STAMP_HASH_MEMO: OnceLock<String> = OnceLock::new();
1147        let smart_stamp_hash = STAMP_HASH_MEMO.get_or_init(|| {
1148            generate_smart_stamp_hash(
1149                builder,
1150                &builder.config.src.join("src/llvm-project/compiler-rt"),
1151                builder.in_tree_llvm_info.sha().unwrap_or_default(),
1152            )
1153        });
1154
1155        let stamp = BuildStamp::new(&out_dir).with_prefix("sanitizers").add_stamp(smart_stamp_hash);
1156
1157        if stamp.is_up_to_date() {
1158            if stamp.stamp().is_empty() {
1159                builder.info(&format!(
1160                    "Rebuild sanitizers by removing the file `{}`",
1161                    stamp.path().display()
1162                ));
1163            }
1164
1165            return runtimes;
1166        }
1167
1168        let _guard = builder.msg_unstaged(Kind::Build, "sanitizers", self.target);
1169        t!(stamp.remove());
1170        let _time = helpers::timeit(builder);
1171
1172        let mut cfg = cmake::Config::new(&compiler_rt_dir);
1173        cfg.profile("Release");
1174        cfg.define("CMAKE_C_COMPILER_TARGET", self.target.triple);
1175        cfg.define("COMPILER_RT_BUILD_BUILTINS", "OFF");
1176        cfg.define("COMPILER_RT_BUILD_CRT", "OFF");
1177        cfg.define("COMPILER_RT_BUILD_LIBFUZZER", "OFF");
1178        cfg.define("COMPILER_RT_BUILD_PROFILE", "OFF");
1179        cfg.define("COMPILER_RT_BUILD_SANITIZERS", "ON");
1180        cfg.define("COMPILER_RT_BUILD_XRAY", "OFF");
1181        cfg.define("COMPILER_RT_DEFAULT_TARGET_ONLY", "ON");
1182        cfg.define("COMPILER_RT_USE_LIBCXX", "OFF");
1183        cfg.define("LLVM_CONFIG_PATH", &llvm_config);
1184
1185        if self.target.contains("ohos") {
1186            cfg.define("COMPILER_RT_USE_BUILTINS_LIBRARY", "ON");
1187        }
1188
1189        // On Darwin targets the sanitizer runtimes are build as universal binaries.
1190        // Unfortunately sccache currently lacks support to build them successfully.
1191        // Disable compiler launcher on Darwin targets to avoid potential issues.
1192        let use_compiler_launcher = !self.target.contains("apple-darwin");
1193        // Since v1.0.86, the cc crate adds -mmacosx-version-min to the default
1194        // flags on MacOS. A long-standing bug in the CMake rules for compiler-rt
1195        // causes architecture detection to be skipped when this flag is present,
1196        // and compilation fails. https://github.com/llvm/llvm-project/issues/88780
1197        let suppressed_compiler_flag_prefixes: &[&str] =
1198            if self.target.contains("apple-darwin") { &["-mmacosx-version-min="] } else { &[] };
1199        configure_cmake(
1200            builder,
1201            self.target,
1202            &mut cfg,
1203            use_compiler_launcher,
1204            LdFlags::default(),
1205            suppressed_compiler_flag_prefixes,
1206        );
1207
1208        t!(fs::create_dir_all(&out_dir));
1209        cfg.out_dir(out_dir);
1210
1211        for runtime in &runtimes {
1212            cfg.build_target(&runtime.cmake_target);
1213            cfg.build();
1214        }
1215        t!(stamp.write());
1216
1217        runtimes
1218    }
1219}
1220
1221#[derive(Clone, Debug)]
1222pub struct SanitizerRuntime {
1223    /// CMake target used to build the runtime.
1224    pub cmake_target: String,
1225    /// Path to the built runtime library.
1226    pub path: PathBuf,
1227    /// Library filename that will be used rustc.
1228    pub name: String,
1229}
1230
1231/// Returns sanitizers available on a given target.
1232fn supported_sanitizers(
1233    out_dir: &Path,
1234    target: TargetSelection,
1235    channel: &str,
1236) -> Vec<SanitizerRuntime> {
1237    let darwin_libs = |os: &str, components: &[&str]| -> Vec<SanitizerRuntime> {
1238        components
1239            .iter()
1240            .map(move |c| SanitizerRuntime {
1241                cmake_target: format!("clang_rt.{c}_{os}_dynamic"),
1242                path: out_dir.join(format!("build/lib/darwin/libclang_rt.{c}_{os}_dynamic.dylib")),
1243                name: format!("librustc-{channel}_rt.{c}.dylib"),
1244            })
1245            .collect()
1246    };
1247
1248    let common_libs = |os: &str, arch: &str, components: &[&str]| -> Vec<SanitizerRuntime> {
1249        components
1250            .iter()
1251            .map(move |c| SanitizerRuntime {
1252                cmake_target: format!("clang_rt.{c}-{arch}"),
1253                path: out_dir.join(format!("build/lib/{os}/libclang_rt.{c}-{arch}.a")),
1254                name: format!("librustc-{channel}_rt.{c}.a"),
1255            })
1256            .collect()
1257    };
1258
1259    match &*target.triple {
1260        "aarch64-apple-darwin" => darwin_libs("osx", &["asan", "lsan", "tsan"]),
1261        "aarch64-apple-ios" => darwin_libs("ios", &["asan", "tsan"]),
1262        "aarch64-apple-ios-sim" => darwin_libs("iossim", &["asan", "tsan"]),
1263        "aarch64-apple-ios-macabi" => darwin_libs("osx", &["asan", "lsan", "tsan"]),
1264        "aarch64-unknown-fuchsia" => common_libs("fuchsia", "aarch64", &["asan"]),
1265        "aarch64-unknown-linux-gnu" => {
1266            common_libs("linux", "aarch64", &["asan", "lsan", "msan", "tsan", "hwasan"])
1267        }
1268        "aarch64-unknown-linux-ohos" => {
1269            common_libs("linux", "aarch64", &["asan", "lsan", "msan", "tsan", "hwasan"])
1270        }
1271        "loongarch64-unknown-linux-gnu" | "loongarch64-unknown-linux-musl" => {
1272            common_libs("linux", "loongarch64", &["asan", "lsan", "msan", "tsan"])
1273        }
1274        "x86_64-apple-darwin" => darwin_libs("osx", &["asan", "lsan", "tsan"]),
1275        "x86_64-unknown-fuchsia" => common_libs("fuchsia", "x86_64", &["asan"]),
1276        "x86_64-apple-ios" => darwin_libs("iossim", &["asan", "tsan"]),
1277        "x86_64-apple-ios-macabi" => darwin_libs("osx", &["asan", "lsan", "tsan"]),
1278        "x86_64-unknown-freebsd" => common_libs("freebsd", "x86_64", &["asan", "msan", "tsan"]),
1279        "x86_64-unknown-netbsd" => {
1280            common_libs("netbsd", "x86_64", &["asan", "lsan", "msan", "tsan"])
1281        }
1282        "x86_64-unknown-illumos" => common_libs("illumos", "x86_64", &["asan"]),
1283        "x86_64-pc-solaris" => common_libs("solaris", "x86_64", &["asan"]),
1284        "x86_64-unknown-linux-gnu" => {
1285            common_libs("linux", "x86_64", &["asan", "dfsan", "lsan", "msan", "safestack", "tsan"])
1286        }
1287        "x86_64-unknown-linux-musl" => {
1288            common_libs("linux", "x86_64", &["asan", "lsan", "msan", "tsan"])
1289        }
1290        "s390x-unknown-linux-gnu" => {
1291            common_libs("linux", "s390x", &["asan", "lsan", "msan", "tsan"])
1292        }
1293        "s390x-unknown-linux-musl" => {
1294            common_libs("linux", "s390x", &["asan", "lsan", "msan", "tsan"])
1295        }
1296        "x86_64-unknown-linux-ohos" => {
1297            common_libs("linux", "x86_64", &["asan", "lsan", "msan", "tsan"])
1298        }
1299        _ => Vec::new(),
1300    }
1301}
1302
1303#[derive(Debug, Clone, PartialEq, Eq, Hash)]
1304pub struct CrtBeginEnd {
1305    pub target: TargetSelection,
1306}
1307
1308impl Step for CrtBeginEnd {
1309    type Output = PathBuf;
1310
1311    fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1312        run.path("src/llvm-project/compiler-rt/lib/crt")
1313    }
1314
1315    fn make_run(run: RunConfig<'_>) {
1316        if run.target.needs_crt_begin_end() {
1317            run.builder.ensure(CrtBeginEnd { target: run.target });
1318        }
1319    }
1320
1321    /// Build crtbegin.o/crtend.o for musl target.
1322    fn run(self, builder: &Builder<'_>) -> Self::Output {
1323        builder.require_submodule(
1324            "src/llvm-project",
1325            Some("The LLVM sources are required for the CRT from `compiler-rt`."),
1326        );
1327
1328        let out_dir = builder.native_dir(self.target).join("crt");
1329
1330        if builder.config.dry_run() {
1331            return out_dir;
1332        }
1333
1334        let crtbegin_src = builder.src.join("src/llvm-project/compiler-rt/lib/builtins/crtbegin.c");
1335        let crtend_src = builder.src.join("src/llvm-project/compiler-rt/lib/builtins/crtend.c");
1336        if up_to_date(&crtbegin_src, &out_dir.join("crtbeginS.o"))
1337            && up_to_date(&crtend_src, &out_dir.join("crtendS.o"))
1338        {
1339            return out_dir;
1340        }
1341
1342        let _guard = builder.msg_unstaged(Kind::Build, "crtbegin.o and crtend.o", self.target);
1343        t!(fs::create_dir_all(&out_dir));
1344
1345        let mut cfg = cc::Build::new();
1346
1347        if let Some(ar) = builder.ar(self.target) {
1348            cfg.archiver(ar);
1349        }
1350        cfg.compiler(builder.cc(self.target));
1351        cfg.cargo_metadata(false)
1352            .out_dir(&out_dir)
1353            .target(&self.target.triple)
1354            .host(&builder.config.host_target.triple)
1355            .warnings(false)
1356            .debug(false)
1357            .opt_level(3)
1358            .file(crtbegin_src)
1359            .file(crtend_src);
1360
1361        // Those flags are defined in src/llvm-project/compiler-rt/lib/builtins/CMakeLists.txt
1362        // Currently only consumer of those objects is musl, which use .init_array/.fini_array
1363        // instead of .ctors/.dtors
1364        cfg.flag("-std=c11")
1365            .define("CRT_HAS_INITFINI_ARRAY", None)
1366            .define("EH_USE_FRAME_REGISTRY", None);
1367
1368        let objs = cfg.compile_intermediates();
1369        assert_eq!(objs.len(), 2);
1370        for obj in objs {
1371            let base_name = unhashed_basename(&obj);
1372            assert!(base_name == "crtbegin" || base_name == "crtend");
1373            t!(fs::copy(&obj, out_dir.join(format!("{base_name}S.o"))));
1374            t!(fs::rename(&obj, out_dir.join(format!("{base_name}.o"))));
1375        }
1376
1377        out_dir
1378    }
1379}
1380
1381#[derive(Debug, Clone, PartialEq, Eq, Hash)]
1382pub struct Libunwind {
1383    pub target: TargetSelection,
1384}
1385
1386impl Step for Libunwind {
1387    type Output = PathBuf;
1388
1389    fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
1390        run.path("src/llvm-project/libunwind")
1391    }
1392
1393    fn make_run(run: RunConfig<'_>) {
1394        run.builder.ensure(Libunwind { target: run.target });
1395    }
1396
1397    /// Build libunwind.a
1398    fn run(self, builder: &Builder<'_>) -> Self::Output {
1399        builder.require_submodule(
1400            "src/llvm-project",
1401            Some("The LLVM sources are required for libunwind."),
1402        );
1403
1404        if builder.config.dry_run() {
1405            return PathBuf::new();
1406        }
1407
1408        let out_dir = builder.native_dir(self.target).join("libunwind");
1409        let root = builder.src.join("src/llvm-project/libunwind");
1410
1411        if up_to_date(&root, &out_dir.join("libunwind.a")) {
1412            return out_dir;
1413        }
1414
1415        let _guard = builder.msg_unstaged(Kind::Build, "libunwind.a", self.target);
1416        t!(fs::create_dir_all(&out_dir));
1417
1418        let mut cc_cfg = cc::Build::new();
1419        let mut cpp_cfg = cc::Build::new();
1420
1421        cpp_cfg.cpp(true);
1422        cpp_cfg.cpp_set_stdlib(None);
1423        cpp_cfg.flag("-nostdinc++");
1424        cpp_cfg.flag("-fno-exceptions");
1425        cpp_cfg.flag("-fno-rtti");
1426        cpp_cfg.flag_if_supported("-fvisibility-global-new-delete-hidden");
1427
1428        for cfg in [&mut cc_cfg, &mut cpp_cfg].iter_mut() {
1429            if let Some(ar) = builder.ar(self.target) {
1430                cfg.archiver(ar);
1431            }
1432            cfg.target(&self.target.triple);
1433            cfg.host(&builder.config.host_target.triple);
1434            cfg.warnings(false);
1435            cfg.debug(false);
1436            // get_compiler() need set opt_level first.
1437            cfg.opt_level(3);
1438            cfg.flag("-fstrict-aliasing");
1439            cfg.flag("-funwind-tables");
1440            cfg.flag("-fvisibility=hidden");
1441            cfg.define("_LIBUNWIND_DISABLE_VISIBILITY_ANNOTATIONS", None);
1442            cfg.define("_LIBUNWIND_IS_NATIVE_ONLY", "1");
1443            cfg.include(root.join("include"));
1444            cfg.cargo_metadata(false);
1445            cfg.out_dir(&out_dir);
1446
1447            if self.target.contains("x86_64-fortanix-unknown-sgx") {
1448                cfg.static_flag(true);
1449                cfg.flag("-fno-stack-protector");
1450                cfg.flag("-ffreestanding");
1451                cfg.flag("-fexceptions");
1452
1453                // easiest way to undefine since no API available in cc::Build to undefine
1454                cfg.flag("-U_FORTIFY_SOURCE");
1455                cfg.define("_FORTIFY_SOURCE", "0");
1456                cfg.define("RUST_SGX", "1");
1457                cfg.define("__NO_STRING_INLINES", None);
1458                cfg.define("__NO_MATH_INLINES", None);
1459                cfg.define("_LIBUNWIND_IS_BAREMETAL", None);
1460                cfg.define("NDEBUG", None);
1461            }
1462            if self.target.is_windows() {
1463                cfg.define("_LIBUNWIND_HIDE_SYMBOLS", "1");
1464            }
1465        }
1466
1467        cc_cfg.compiler(builder.cc(self.target));
1468        if let Ok(cxx) = builder.cxx(self.target) {
1469            cpp_cfg.compiler(cxx);
1470        } else {
1471            cc_cfg.compiler(builder.cc(self.target));
1472        }
1473
1474        // Don't set this for clang
1475        // By default, Clang builds C code in GNU C17 mode.
1476        // By default, Clang builds C++ code according to the C++98 standard,
1477        // with many C++11 features accepted as extensions.
1478        if cc_cfg.get_compiler().is_like_gnu() {
1479            cc_cfg.flag("-std=c99");
1480        }
1481        if cpp_cfg.get_compiler().is_like_gnu() {
1482            cpp_cfg.flag("-std=c++11");
1483        }
1484
1485        if self.target.contains("x86_64-fortanix-unknown-sgx") || self.target.contains("musl") {
1486            // use the same GCC C compiler command to compile C++ code so we do not need to setup the
1487            // C++ compiler env variables on the builders.
1488            // Don't set this for clang++, as clang++ is able to compile this without libc++.
1489            if cpp_cfg.get_compiler().is_like_gnu() {
1490                cpp_cfg.cpp(false);
1491                cpp_cfg.compiler(builder.cc(self.target));
1492            }
1493        }
1494
1495        let mut c_sources = vec![
1496            "Unwind-sjlj.c",
1497            "UnwindLevel1-gcc-ext.c",
1498            "UnwindLevel1.c",
1499            "UnwindRegistersRestore.S",
1500            "UnwindRegistersSave.S",
1501        ];
1502
1503        let cpp_sources = vec!["Unwind-EHABI.cpp", "Unwind-seh.cpp", "libunwind.cpp"];
1504        let cpp_len = cpp_sources.len();
1505
1506        if self.target.contains("x86_64-fortanix-unknown-sgx") {
1507            c_sources.push("UnwindRustSgx.c");
1508        }
1509
1510        for src in c_sources {
1511            cc_cfg.file(root.join("src").join(src).canonicalize().unwrap());
1512        }
1513
1514        for src in &cpp_sources {
1515            cpp_cfg.file(root.join("src").join(src).canonicalize().unwrap());
1516        }
1517
1518        cpp_cfg.compile("unwind-cpp");
1519
1520        // FIXME: https://github.com/alexcrichton/cc-rs/issues/545#issuecomment-679242845
1521        let mut count = 0;
1522        for entry in fs::read_dir(&out_dir).unwrap() {
1523            let file = entry.unwrap().path().canonicalize().unwrap();
1524            if file.is_file() && file.extension() == Some(OsStr::new("o")) {
1525                // Object file name without the hash prefix is "Unwind-EHABI", "Unwind-seh" or "libunwind".
1526                let base_name = unhashed_basename(&file);
1527                if cpp_sources.iter().any(|f| *base_name == f[..f.len() - 4]) {
1528                    cc_cfg.object(&file);
1529                    count += 1;
1530                }
1531            }
1532        }
1533        assert_eq!(cpp_len, count, "Can't get object files from {out_dir:?}");
1534
1535        cc_cfg.compile("unwind");
1536        out_dir
1537    }
1538}