bootstrap/core/build_steps/
vendor.rs

1//! Handles the vendoring process for the bootstrap system.
2//!
3//! This module ensures that all required Cargo dependencies are gathered
4//! and stored in the `<src>/<VENDOR_DIR>` directory.
5use std::path::PathBuf;
6
7use crate::core::build_steps::tool::SUBMODULES_FOR_RUSTBOOK;
8use crate::core::builder::{Builder, RunConfig, ShouldRun, Step};
9use crate::utils::exec::command;
10
11/// The name of the directory where vendored dependencies are stored.
12pub const VENDOR_DIR: &str = "vendor";
13
14/// Returns the cargo workspaces to vendor for `x vendor` and dist tarballs.
15///
16/// Returns a `Vec` of `(path_to_manifest, submodules_required)` where
17/// `path_to_manifest` is the cargo workspace, and `submodules_required` is
18/// the set of submodules that must be available.
19pub fn default_paths_to_vendor(builder: &Builder<'_>) -> Vec<(PathBuf, Vec<&'static str>)> {
20    [
21        ("src/tools/cargo/Cargo.toml", vec!["src/tools/cargo"]),
22        ("src/tools/clippy/clippy_test_deps/Cargo.toml", vec![]),
23        ("src/tools/rust-analyzer/Cargo.toml", vec![]),
24        ("compiler/rustc_codegen_cranelift/Cargo.toml", vec![]),
25        ("compiler/rustc_codegen_gcc/Cargo.toml", vec![]),
26        ("library/Cargo.toml", vec![]),
27        ("src/bootstrap/Cargo.toml", vec![]),
28        ("src/tools/rustbook/Cargo.toml", SUBMODULES_FOR_RUSTBOOK.into()),
29        ("src/tools/rustc-perf/Cargo.toml", vec!["src/tools/rustc-perf"]),
30        ("src/tools/opt-dist/Cargo.toml", vec![]),
31        ("src/doc/book/packages/trpl/Cargo.toml", vec![]),
32    ]
33    .into_iter()
34    .map(|(path, submodules)| (builder.src.join(path), submodules))
35    .collect()
36}
37
38/// Defines the vendoring step in the bootstrap process.
39///
40/// This step executes `cargo vendor` to collect all dependencies
41/// and store them in the `<src>/<VENDOR_DIR>` directory.
42#[derive(Debug, Clone, Hash, PartialEq, Eq)]
43pub(crate) struct Vendor {
44    /// Additional paths to synchronize during vendoring.
45    pub(crate) sync_args: Vec<PathBuf>,
46    /// Determines whether vendored dependencies use versioned directories.
47    pub(crate) versioned_dirs: bool,
48    /// The root directory of the source code.
49    pub(crate) root_dir: PathBuf,
50    /// The target directory for storing vendored dependencies.
51    pub(crate) output_dir: PathBuf,
52}
53
54impl Step for Vendor {
55    type Output = VendorOutput;
56    const DEFAULT: bool = true;
57    const IS_HOST: bool = true;
58
59    fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
60        run.alias("placeholder").default_condition(true)
61    }
62
63    fn make_run(run: RunConfig<'_>) {
64        run.builder.ensure(Vendor {
65            sync_args: run.builder.config.cmd.vendor_sync_args(),
66            versioned_dirs: run.builder.config.cmd.vendor_versioned_dirs(),
67            root_dir: run.builder.src.clone(),
68            output_dir: run.builder.src.join(VENDOR_DIR),
69        });
70    }
71
72    /// Executes the vendoring process.
73    ///
74    /// This function runs `cargo vendor` and ensures all required submodules
75    /// are initialized before vendoring begins.
76    fn run(self, builder: &Builder<'_>) -> Self::Output {
77        builder.info(&format!("Vendoring sources to {:?}", self.root_dir));
78
79        let mut cmd = command(&builder.initial_cargo);
80        cmd.arg("vendor");
81
82        if self.versioned_dirs {
83            cmd.arg("--versioned-dirs");
84        }
85
86        let to_vendor = default_paths_to_vendor(builder);
87        // These submodules must be present for `x vendor` to work.
88        for (_, submodules) in &to_vendor {
89            for submodule in submodules {
90                builder.build.require_submodule(submodule, None);
91            }
92        }
93
94        // Sync these paths by default.
95        for (p, _) in &to_vendor {
96            cmd.arg("--sync").arg(p);
97        }
98
99        // Also sync explicitly requested paths.
100        for sync_arg in self.sync_args {
101            cmd.arg("--sync").arg(sync_arg);
102        }
103
104        // Will read the libstd Cargo.toml
105        // which uses the unstable `public-dependency` feature.
106        cmd.env("RUSTC_BOOTSTRAP", "1");
107        cmd.env("RUSTC", &builder.initial_rustc);
108
109        cmd.current_dir(self.root_dir).arg(&self.output_dir);
110
111        let config = cmd.run_capture_stdout(builder);
112        VendorOutput { config: config.stdout() }
113    }
114}
115
116/// Stores the result of the vendoring step.
117#[derive(Debug, Clone)]
118pub(crate) struct VendorOutput {
119    pub(crate) config: String,
120}
bootstrap/core/build_steps/vendor.rs

bootstrap/core/build_steps/
vendor.rs
