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 IS_HOST: bool = true;
57
58    fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
59        run.alias("placeholder")
60    }
61
62    fn is_default_step(_builder: &Builder<'_>) -> bool {
63        true
64    }
65
66    fn make_run(run: RunConfig<'_>) {
67        run.builder.ensure(Vendor {
68            sync_args: run.builder.config.cmd.vendor_sync_args(),
69            versioned_dirs: run.builder.config.cmd.vendor_versioned_dirs(),
70            root_dir: run.builder.src.clone(),
71            output_dir: run.builder.src.join(VENDOR_DIR),
72        });
73    }
74
75    /// Executes the vendoring process.
76    ///
77    /// This function runs `cargo vendor` and ensures all required submodules
78    /// are initialized before vendoring begins.
79    fn run(self, builder: &Builder<'_>) -> Self::Output {
80        let _guard = builder.group(&format!("Vendoring sources to {:?}", self.root_dir));
81
82        let mut cmd = command(&builder.initial_cargo);
83        cmd.arg("vendor");
84
85        if self.versioned_dirs {
86            cmd.arg("--versioned-dirs");
87        }
88
89        let to_vendor = default_paths_to_vendor(builder);
90        // These submodules must be present for `x vendor` to work.
91        for (_, submodules) in &to_vendor {
92            for submodule in submodules {
93                builder.build.require_submodule(submodule, None);
94            }
95        }
96
97        // Sync these paths by default.
98        for (p, _) in &to_vendor {
99            cmd.arg("--sync").arg(p);
100        }
101
102        // Also sync explicitly requested paths.
103        for sync_arg in self.sync_args {
104            cmd.arg("--sync").arg(sync_arg);
105        }
106
107        // Will read the libstd Cargo.toml
108        // which uses the unstable `public-dependency` feature.
109        cmd.env("RUSTC_BOOTSTRAP", "1");
110        cmd.env("RUSTC", &builder.initial_rustc);
111
112        cmd.current_dir(self.root_dir).arg(&self.output_dir);
113
114        let config = cmd.run_capture_stdout(builder);
115        VendorOutput { config: config.stdout() }
116    }
117}
118
119/// Stores the result of the vendoring step.
120#[derive(Debug, Clone)]
121pub(crate) struct VendorOutput {
122    pub(crate) config: String,
123}
bootstrap/core/build_steps/vendor.rs

bootstrap/core/build_steps/
vendor.rs
