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        ("library/stdarch/Cargo.toml", vec![]),
28        ("src/bootstrap/Cargo.toml", vec![]),
29        ("src/tools/rustbook/Cargo.toml", SUBMODULES_FOR_RUSTBOOK.into()),
30        ("src/tools/rustc-perf/Cargo.toml", vec!["src/tools/rustc-perf"]),
31        ("src/tools/opt-dist/Cargo.toml", vec![]),
32        ("src/doc/book/packages/trpl/Cargo.toml", vec![]),
33    ]
34    .into_iter()
35    .map(|(path, submodules)| (builder.src.join(path), submodules))
36    .collect()
37}
38
39/// Defines the vendoring step in the bootstrap process.
40///
41/// This step executes `cargo vendor` to collect all dependencies
42/// and store them in the `<src>/<VENDOR_DIR>` directory.
43#[derive(Debug, Clone, Hash, PartialEq, Eq)]
44pub(crate) struct Vendor {
45    /// Additional paths to synchronize during vendoring.
46    pub(crate) sync_args: Vec<PathBuf>,
47    /// Determines whether vendored dependencies use versioned directories.
48    pub(crate) versioned_dirs: bool,
49    /// The root directory of the source code.
50    ///
51    /// Vendored dependencies will be stored in <root_dir>/vendor and
52    /// <root_dir>/library/vendor unless overridden by `output_dir`.
53    pub(crate) root_dir: PathBuf,
54    /// The root directory for storing vendored dependencies in <output_dir>/vendor
55    /// and <output_dir>/library/vendor.
56    pub(crate) output_dir: Option<PathBuf>,
57    /// Only vendor crates necessary by the library workspace.
58    pub(crate) only_library_workspace: bool,
59}
60
61impl Step for Vendor {
62    type Output = VendorOutput;
63    const IS_HOST: bool = true;
64
65    fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
66        run.alias("placeholder")
67    }
68
69    fn is_default_step(_builder: &Builder<'_>) -> bool {
70        true
71    }
72
73    fn make_run(run: RunConfig<'_>) {
74        run.builder.ensure(Vendor {
75            sync_args: run.builder.config.cmd.vendor_sync_args(),
76            versioned_dirs: run.builder.config.cmd.vendor_versioned_dirs(),
77            root_dir: run.builder.src.clone(),
78            output_dir: None,
79            only_library_workspace: false,
80        });
81    }
82
83    /// Executes the vendoring process.
84    ///
85    /// This function runs `cargo vendor` and ensures all required submodules
86    /// are initialized before vendoring begins.
87    fn run(self, builder: &Builder<'_>) -> Self::Output {
88        let _guard = builder.group(&format!("Vendoring sources to {:?}", self.root_dir));
89
90        let config = if self.only_library_workspace {
91            String::new()
92        } else {
93            let mut cmd = command(&builder.initial_cargo);
94            cmd.arg("vendor");
95
96            if self.versioned_dirs {
97                cmd.arg("--versioned-dirs");
98            }
99
100            let to_vendor = default_paths_to_vendor(builder);
101            // These submodules must be present for `x vendor` to work.
102            for (_, submodules) in &to_vendor {
103                for submodule in submodules {
104                    builder.build.require_submodule(submodule, None);
105                }
106            }
107
108            // Sync these paths by default.
109            for (p, _) in &to_vendor {
110                cmd.arg("--sync").arg(p);
111            }
112
113            // Also sync explicitly requested paths.
114            for sync_arg in self.sync_args {
115                cmd.arg("--sync").arg(sync_arg);
116            }
117
118            // Reuse vendored dependencies when building source tarball for offline support.
119            if builder.config.vendor {
120                cmd.arg("--respect-source-config")
121                    .arg("--config")
122                    .arg(builder.src.join(".cargo").join("config.toml"));
123            }
124
125            // Will read the libstd Cargo.toml
126            // which uses the unstable `public-dependency` feature.
127            cmd.env("RUSTC_BOOTSTRAP", "1");
128            cmd.env("RUSTC", &builder.initial_rustc);
129
130            cmd.current_dir(&self.root_dir);
131            match &self.output_dir {
132                None => cmd.arg(VENDOR_DIR),
133                Some(output_dir) => cmd.arg(output_dir.join(VENDOR_DIR)),
134            };
135
136            cmd.run_capture_stdout(builder).stdout()
137        };
138
139        let mut cmd = command(&builder.initial_cargo);
140        cmd.arg("vendor");
141
142        if self.versioned_dirs {
143            cmd.arg("--versioned-dirs");
144        }
145
146        // Reuse vendored dependencies when building source tarball for offline support.
147        if builder.config.vendor {
148            cmd.arg("--respect-source-config")
149                .arg("--config")
150                .arg(builder.src.join("library").join(".cargo").join("config.toml"));
151        }
152
153        // Will read the libstd Cargo.toml
154        // which uses the unstable `public-dependency` feature.
155        cmd.env("RUSTC_BOOTSTRAP", "1");
156        cmd.env("RUSTC", &builder.initial_rustc);
157
158        cmd.current_dir(self.root_dir.join("library"));
159        match &self.output_dir {
160            None => cmd.arg(VENDOR_DIR),
161            Some(output_dir) => cmd.arg(output_dir.join("library").join(VENDOR_DIR)),
162        };
163
164        let config_library = cmd.run_capture_stdout(builder).stdout();
165
166        VendorOutput { config, config_library }
167    }
168}
169
170/// Stores the result of the vendoring step.
171#[derive(Debug, Clone)]
172pub(crate) struct VendorOutput {
173    pub(crate) config: String,
174    pub(crate) config_library: String,
175}
bootstrap/core/build_steps/vendor.rs

bootstrap/core/build_steps/
vendor.rs
