| //! Implementation of compiling the compiler and standard library, in "check"-based modes. |
| |
| use crate::builder::{Builder, Kind, RunConfig, ShouldRun, Step}; |
| use crate::cache::Interned; |
| use crate::compile::{add_to_sysroot, run_cargo, rustc_cargo, rustc_cargo_env, std_cargo}; |
| use crate::config::TargetSelection; |
| use crate::tool::{prepare_tool_cargo, SourceType}; |
| use crate::INTERNER; |
| use crate::{Compiler, Mode, Subcommand}; |
| use std::path::PathBuf; |
| |
| #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)] |
| pub struct Std { |
| pub target: TargetSelection, |
| } |
| |
| /// Returns args for the subcommand itself (not for cargo) |
| fn args(builder: &Builder<'_>) -> Vec<String> { |
| fn strings<'a>(arr: &'a [&str]) -> impl Iterator<Item = String> + 'a { |
| arr.iter().copied().map(String::from) |
| } |
| |
| if let Subcommand::Clippy { fix, .. } = builder.config.cmd { |
| // disable the most spammy clippy lints |
| let ignored_lints = vec![ |
| "many_single_char_names", // there are a lot in stdarch |
| "collapsible_if", |
| "type_complexity", |
| "missing_safety_doc", // almost 3K warnings |
| "too_many_arguments", |
| "needless_lifetimes", // people want to keep the lifetimes |
| "wrong_self_convention", |
| ]; |
| let mut args = vec![]; |
| if fix { |
| #[rustfmt::skip] |
| args.extend(strings(&[ |
| "--fix", "-Zunstable-options", |
| // FIXME: currently, `--fix` gives an error while checking tests for libtest, |
| // possibly because libtest is not yet built in the sysroot. |
| // As a workaround, avoid checking tests and benches when passed --fix. |
| "--lib", "--bins", "--examples", |
| ])); |
| } |
| args.extend(strings(&["--", "--cap-lints", "warn"])); |
| args.extend(ignored_lints.iter().map(|lint| format!("-Aclippy::{}", lint))); |
| args |
| } else { |
| vec![] |
| } |
| } |
| |
| fn cargo_subcommand(kind: Kind) -> &'static str { |
| match kind { |
| Kind::Check => "check", |
| Kind::Clippy => "clippy", |
| Kind::Fix => "fix", |
| _ => unreachable!(), |
| } |
| } |
| |
| impl Step for Std { |
| type Output = (); |
| const DEFAULT: bool = true; |
| |
| fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> { |
| run.all_krates("test") |
| } |
| |
| fn make_run(run: RunConfig<'_>) { |
| run.builder.ensure(Std { target: run.target }); |
| } |
| |
| fn run(self, builder: &Builder<'_>) { |
| let target = self.target; |
| let compiler = builder.compiler(builder.top_stage, builder.config.build); |
| |
| let mut cargo = builder.cargo( |
| compiler, |
| Mode::Std, |
| SourceType::InTree, |
| target, |
| cargo_subcommand(builder.kind), |
| ); |
| std_cargo(builder, target, compiler.stage, &mut cargo); |
| |
| builder.info(&format!( |
| "Checking stage{} std artifacts ({} -> {})", |
| builder.top_stage, &compiler.host, target |
| )); |
| run_cargo( |
| builder, |
| cargo, |
| args(builder), |
| &libstd_stamp(builder, compiler, target), |
| vec![], |
| true, |
| ); |
| |
| // We skip populating the sysroot in non-zero stage because that'll lead |
| // to rlib/rmeta conflicts if std gets built during this session. |
| if compiler.stage == 0 { |
| let libdir = builder.sysroot_libdir(compiler, target); |
| let hostdir = builder.sysroot_libdir(compiler, compiler.host); |
| add_to_sysroot(&builder, &libdir, &hostdir, &libstd_stamp(builder, compiler, target)); |
| } |
| |
| // Then run cargo again, once we've put the rmeta files for the library |
| // crates into the sysroot. This is needed because e.g., core's tests |
| // depend on `libtest` -- Cargo presumes it will exist, but it doesn't |
| // since we initialize with an empty sysroot. |
| // |
| // Currently only the "libtest" tree of crates does this. |
| |
| if let Subcommand::Check { all_targets: true, .. } = builder.config.cmd { |
| let mut cargo = builder.cargo( |
| compiler, |
| Mode::Std, |
| SourceType::InTree, |
| target, |
| cargo_subcommand(builder.kind), |
| ); |
| std_cargo(builder, target, compiler.stage, &mut cargo); |
| cargo.arg("--all-targets"); |
| |
| // Explicitly pass -p for all dependencies krates -- this will force cargo |
| // to also check the tests/benches/examples for these crates, rather |
| // than just the leaf crate. |
| for krate in builder.in_tree_crates("test", Some(target)) { |
| cargo.arg("-p").arg(krate.name); |
| } |
| |
| builder.info(&format!( |
| "Checking stage{} std test/bench/example targets ({} -> {})", |
| builder.top_stage, &compiler.host, target |
| )); |
| run_cargo( |
| builder, |
| cargo, |
| args(builder), |
| &libstd_test_stamp(builder, compiler, target), |
| vec![], |
| true, |
| ); |
| } |
| } |
| } |
| |
| #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)] |
| pub struct Rustc { |
| pub target: TargetSelection, |
| } |
| |
| impl Step for Rustc { |
| type Output = (); |
| const ONLY_HOSTS: bool = true; |
| const DEFAULT: bool = true; |
| |
| fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> { |
| run.all_krates("rustc-main") |
| } |
| |
| fn make_run(run: RunConfig<'_>) { |
| run.builder.ensure(Rustc { target: run.target }); |
| } |
| |
| /// Builds the compiler. |
| /// |
| /// This will build the compiler for a particular stage of the build using |
| /// the `compiler` targeting the `target` architecture. The artifacts |
| /// created will also be linked into the sysroot directory. |
| fn run(self, builder: &Builder<'_>) { |
| let compiler = builder.compiler(builder.top_stage, builder.config.build); |
| let target = self.target; |
| |
| if compiler.stage != 0 { |
| // If we're not in stage 0, then we won't have a std from the beta |
| // compiler around. That means we need to make sure there's one in |
| // the sysroot for the compiler to find. Otherwise, we're going to |
| // fail when building crates that need to generate code (e.g., build |
| // scripts and their dependencies). |
| builder.ensure(crate::compile::Std { target: compiler.host, compiler }); |
| builder.ensure(crate::compile::Std { target, compiler }); |
| } else { |
| builder.ensure(Std { target }); |
| } |
| |
| let mut cargo = builder.cargo( |
| compiler, |
| Mode::Rustc, |
| SourceType::InTree, |
| target, |
| cargo_subcommand(builder.kind), |
| ); |
| rustc_cargo(builder, &mut cargo, target); |
| if let Subcommand::Check { all_targets: true, .. } = builder.config.cmd { |
| cargo.arg("--all-targets"); |
| } |
| |
| // Explicitly pass -p for all compiler krates -- this will force cargo |
| // to also check the tests/benches/examples for these crates, rather |
| // than just the leaf crate. |
| for krate in builder.in_tree_crates("rustc-main", Some(target)) { |
| cargo.arg("-p").arg(krate.name); |
| } |
| |
| builder.info(&format!( |
| "Checking stage{} compiler artifacts ({} -> {})", |
| builder.top_stage, &compiler.host, target |
| )); |
| run_cargo( |
| builder, |
| cargo, |
| args(builder), |
| &librustc_stamp(builder, compiler, target), |
| vec![], |
| true, |
| ); |
| |
| let libdir = builder.sysroot_libdir(compiler, target); |
| let hostdir = builder.sysroot_libdir(compiler, compiler.host); |
| add_to_sysroot(&builder, &libdir, &hostdir, &librustc_stamp(builder, compiler, target)); |
| } |
| } |
| |
| #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)] |
| pub struct CodegenBackend { |
| pub target: TargetSelection, |
| pub backend: Interned<String>, |
| } |
| |
| impl Step for CodegenBackend { |
| type Output = (); |
| const ONLY_HOSTS: bool = true; |
| const DEFAULT: bool = true; |
| |
| fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> { |
| run.paths(&["compiler/rustc_codegen_cranelift", "rustc_codegen_cranelift"]) |
| } |
| |
| fn make_run(run: RunConfig<'_>) { |
| for &backend in &[INTERNER.intern_str("cranelift")] { |
| run.builder.ensure(CodegenBackend { target: run.target, backend }); |
| } |
| } |
| |
| fn run(self, builder: &Builder<'_>) { |
| let compiler = builder.compiler(builder.top_stage, builder.config.build); |
| let target = self.target; |
| let backend = self.backend; |
| |
| builder.ensure(Rustc { target }); |
| |
| let mut cargo = builder.cargo( |
| compiler, |
| Mode::Codegen, |
| SourceType::Submodule, |
| target, |
| cargo_subcommand(builder.kind), |
| ); |
| cargo |
| .arg("--manifest-path") |
| .arg(builder.src.join(format!("compiler/rustc_codegen_{}/Cargo.toml", backend))); |
| rustc_cargo_env(builder, &mut cargo, target); |
| |
| builder.info(&format!( |
| "Checking stage{} {} artifacts ({} -> {})", |
| builder.top_stage, backend, &compiler.host.triple, target.triple |
| )); |
| |
| run_cargo( |
| builder, |
| cargo, |
| args(builder), |
| &codegen_backend_stamp(builder, compiler, target, backend), |
| vec![], |
| true, |
| ); |
| } |
| } |
| |
| macro_rules! tool_check_step { |
| ($name:ident, $path:expr, $source_type:expr) => { |
| #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)] |
| pub struct $name { |
| pub target: TargetSelection, |
| } |
| |
| impl Step for $name { |
| type Output = (); |
| const ONLY_HOSTS: bool = true; |
| const DEFAULT: bool = true; |
| |
| fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> { |
| run.path($path) |
| } |
| |
| fn make_run(run: RunConfig<'_>) { |
| run.builder.ensure($name { target: run.target }); |
| } |
| |
| fn run(self, builder: &Builder<'_>) { |
| let compiler = builder.compiler(builder.top_stage, builder.config.build); |
| let target = self.target; |
| |
| builder.ensure(Rustc { target }); |
| |
| let mut cargo = prepare_tool_cargo( |
| builder, |
| compiler, |
| Mode::ToolRustc, |
| target, |
| cargo_subcommand(builder.kind), |
| $path, |
| $source_type, |
| &[], |
| ); |
| |
| if let Subcommand::Check { all_targets: true, .. } = builder.config.cmd { |
| cargo.arg("--all-targets"); |
| } |
| |
| // Enable internal lints for clippy and rustdoc |
| // NOTE: this intentionally doesn't enable lints for any other tools, |
| // see https://github.com/rust-lang/rust/pull/80573#issuecomment-754010776 |
| if $path == "src/tools/rustdoc" || $path == "src/tools/clippy" { |
| cargo.rustflag("-Zunstable-options"); |
| } |
| |
| builder.info(&format!( |
| "Checking stage{} {} artifacts ({} -> {})", |
| builder.top_stage, |
| stringify!($name).to_lowercase(), |
| &compiler.host.triple, |
| target.triple |
| )); |
| run_cargo( |
| builder, |
| cargo, |
| args(builder), |
| &stamp(builder, compiler, target), |
| vec![], |
| true, |
| ); |
| |
| let libdir = builder.sysroot_libdir(compiler, target); |
| let hostdir = builder.sysroot_libdir(compiler, compiler.host); |
| add_to_sysroot(&builder, &libdir, &hostdir, &stamp(builder, compiler, target)); |
| |
| /// Cargo's output path in a given stage, compiled by a particular |
| /// compiler for the specified target. |
| fn stamp( |
| builder: &Builder<'_>, |
| compiler: Compiler, |
| target: TargetSelection, |
| ) -> PathBuf { |
| builder |
| .cargo_out(compiler, Mode::ToolRustc, target) |
| .join(format!(".{}-check.stamp", stringify!($name).to_lowercase())) |
| } |
| } |
| } |
| }; |
| } |
| |
| tool_check_step!(Rustdoc, "src/tools/rustdoc", SourceType::InTree); |
| // Clippy is a hybrid. It is an external tool, but uses a git subtree instead |
| // of a submodule. Since the SourceType only drives the deny-warnings |
| // behavior, treat it as in-tree so that any new warnings in clippy will be |
| // rejected. |
| tool_check_step!(Clippy, "src/tools/clippy", SourceType::InTree); |
| |
| tool_check_step!(Bootstrap, "src/bootstrap", SourceType::InTree); |
| |
| /// Cargo's output path for the standard library in a given stage, compiled |
| /// by a particular compiler for the specified target. |
| fn libstd_stamp(builder: &Builder<'_>, compiler: Compiler, target: TargetSelection) -> PathBuf { |
| builder.cargo_out(compiler, Mode::Std, target).join(".libstd-check.stamp") |
| } |
| |
| /// Cargo's output path for the standard library in a given stage, compiled |
| /// by a particular compiler for the specified target. |
| fn libstd_test_stamp( |
| builder: &Builder<'_>, |
| compiler: Compiler, |
| target: TargetSelection, |
| ) -> PathBuf { |
| builder.cargo_out(compiler, Mode::Std, target).join(".libstd-check-test.stamp") |
| } |
| |
| /// Cargo's output path for librustc in a given stage, compiled by a particular |
| /// compiler for the specified target. |
| fn librustc_stamp(builder: &Builder<'_>, compiler: Compiler, target: TargetSelection) -> PathBuf { |
| builder.cargo_out(compiler, Mode::Rustc, target).join(".librustc-check.stamp") |
| } |
| |
| /// Cargo's output path for librustc_codegen_llvm in a given stage, compiled by a particular |
| /// compiler for the specified target and backend. |
| fn codegen_backend_stamp( |
| builder: &Builder<'_>, |
| compiler: Compiler, |
| target: TargetSelection, |
| backend: Interned<String>, |
| ) -> PathBuf { |
| builder |
| .cargo_out(compiler, Mode::Codegen, target) |
| .join(format!(".librustc_codegen_{}-check.stamp", backend)) |
| } |