1use std::collections::{HashMap, HashSet};
12use std::ffi::{OsStr, OsString};
13use std::path::PathBuf;
14use std::{env, fs};
15
16use crate::Build;
17#[cfg(not(test))]
18use crate::builder::Builder;
19use crate::builder::Kind;
20#[cfg(not(test))]
21use crate::core::build_steps::tool;
22use crate::core::config::Target;
23use crate::utils::exec::command;
24
25pub struct Finder {
26 cache: HashMap<OsString, Option<PathBuf>>,
27 path: OsString,
28}
29
30const STAGE0_MISSING_TARGETS: &[&str] = &[
36 "wasm32-wali-linux-musl",
38];
39
40#[cfg(not(test))]
43const LIBSTDCXX_MIN_VERSION_THRESHOLD: usize = 8;
44
45impl Finder {
46 pub fn new() -> Self {
47 Self { cache: HashMap::new(), path: env::var_os("PATH").unwrap_or_default() }
48 }
49
50 pub fn maybe_have<S: Into<OsString>>(&mut self, cmd: S) -> Option<PathBuf> {
51 let cmd: OsString = cmd.into();
52 let path = &self.path;
53 self.cache
54 .entry(cmd.clone())
55 .or_insert_with(|| {
56 for path in env::split_paths(path) {
57 let target = path.join(&cmd);
58 let mut cmd_exe = cmd.clone();
59 cmd_exe.push(".exe");
60
61 if target.is_file() || path.join(&cmd_exe).exists() || target.join(&cmd_exe).exists()
64 {
66 return Some(target);
67 }
68 }
69 None
70 })
71 .clone()
72 }
73
74 pub fn must_have<S: AsRef<OsStr>>(&mut self, cmd: S) -> PathBuf {
75 self.maybe_have(&cmd).unwrap_or_else(|| {
76 panic!("\n\ncouldn't find required command: {:?}\n\n", cmd.as_ref());
77 })
78 }
79}
80
81pub fn check(build: &mut Build) {
82 let mut skip_target_sanity =
83 env::var_os("BOOTSTRAP_SKIP_TARGET_SANITY").is_some_and(|s| s == "1" || s == "true");
84
85 skip_target_sanity |= build.config.cmd.kind() == Kind::Check;
86
87 let skipped_paths = [OsStr::new("mir-opt"), OsStr::new("miri")];
89 skip_target_sanity |= build.config.paths.iter().any(|path| {
90 path.components().any(|component| skipped_paths.contains(&component.as_os_str()))
91 });
92
93 let path = env::var_os("PATH").unwrap_or_default();
94 if cfg!(windows) && path.to_string_lossy().contains('\"') {
99 panic!("PATH contains invalid character '\"'");
100 }
101
102 let mut cmd_finder = Finder::new();
103 if build.rust_info().is_managed_git_subrepository() {
106 cmd_finder.must_have("git");
107 }
108
109 #[cfg(not(test))]
111 if !build.config.dry_run() && !build.build.is_msvc() && build.config.llvm_from_ci {
112 let builder = Builder::new(build);
113 let libcxx_version = builder.ensure(tool::LibcxxVersionTool { target: build.build });
114
115 match libcxx_version {
116 tool::LibcxxVersion::Gnu(version) => {
117 if LIBSTDCXX_MIN_VERSION_THRESHOLD > version {
118 eprintln!(
119 "\nYour system's libstdc++ version is too old for the `llvm.download-ci-llvm` option."
120 );
121 eprintln!("Current version detected: '{}'", version);
122 eprintln!("Minimum required version: '{}'", LIBSTDCXX_MIN_VERSION_THRESHOLD);
123 eprintln!(
124 "Consider upgrading libstdc++ or disabling the `llvm.download-ci-llvm` option."
125 );
126 eprintln!(
127 "If you choose to upgrade libstdc++, run `x clean` or delete `build/host/libcxx-version` manually after the upgrade."
128 );
129 }
130 }
131 tool::LibcxxVersion::Llvm(_) => {
132 }
134 }
135 }
136
137 let building_llvm = !build.config.llvm_from_ci
139 && build.hosts.iter().any(|host| {
140 build.config.llvm_enabled(*host)
141 && build
142 .config
143 .target_config
144 .get(host)
145 .map(|config| config.llvm_config.is_none())
146 .unwrap_or(true)
147 });
148
149 let need_cmake = building_llvm || build.config.any_sanitizers_to_build();
150 if need_cmake && cmd_finder.maybe_have("cmake").is_none() {
151 eprintln!(
152 "
153Couldn't find required command: cmake
154
155You should install cmake, or set `download-ci-llvm = true` in the
156`[llvm]` section of `bootstrap.toml` to download LLVM rather
157than building it.
158"
159 );
160 crate::exit!(1);
161 }
162
163 build.config.python = build
164 .config
165 .python
166 .take()
167 .map(|p| cmd_finder.must_have(p))
168 .or_else(|| env::var_os("BOOTSTRAP_PYTHON").map(PathBuf::from)) .or_else(|| cmd_finder.maybe_have("python"))
170 .or_else(|| cmd_finder.maybe_have("python3"))
171 .or_else(|| cmd_finder.maybe_have("python2"));
172
173 build.config.nodejs = build
174 .config
175 .nodejs
176 .take()
177 .map(|p| cmd_finder.must_have(p))
178 .or_else(|| cmd_finder.maybe_have("node"))
179 .or_else(|| cmd_finder.maybe_have("nodejs"));
180
181 build.config.npm = build
182 .config
183 .npm
184 .take()
185 .map(|p| cmd_finder.must_have(p))
186 .or_else(|| cmd_finder.maybe_have("npm"));
187
188 build.config.gdb = build
189 .config
190 .gdb
191 .take()
192 .map(|p| cmd_finder.must_have(p))
193 .or_else(|| cmd_finder.maybe_have("gdb"));
194
195 build.config.reuse = build
196 .config
197 .reuse
198 .take()
199 .map(|p| cmd_finder.must_have(p))
200 .or_else(|| cmd_finder.maybe_have("reuse"));
201
202 let stage0_supported_target_list: HashSet<String> = crate::utils::helpers::output(
203 command(&build.config.initial_rustc).args(["--print", "target-list"]).as_command_mut(),
204 )
205 .lines()
206 .map(|s| s.to_string())
207 .collect();
208
209 for target in &build.targets {
212 if target.contains("emscripten") {
216 continue;
217 }
218
219 if target.contains("wasm32") {
221 continue;
222 }
223
224 if skip_target_sanity && target != &build.build {
226 continue;
227 }
228
229 if cfg!(not(test)) && !skip_target_sanity && !build.local_rebuild {
231 let mut has_target = false;
232 let target_str = target.to_string();
233
234 let missing_targets_hashset: HashSet<_> =
235 STAGE0_MISSING_TARGETS.iter().map(|t| t.to_string()).collect();
236 let duplicated_targets: Vec<_> =
237 stage0_supported_target_list.intersection(&missing_targets_hashset).collect();
238
239 if !duplicated_targets.is_empty() {
240 println!(
241 "Following targets supported from the stage0 compiler, please remove them from STAGE0_MISSING_TARGETS list."
242 );
243 for duplicated_target in duplicated_targets {
244 println!(" {duplicated_target}");
245 }
246 std::process::exit(1);
247 }
248
249 has_target |= stage0_supported_target_list.contains(&target_str);
251 has_target |= STAGE0_MISSING_TARGETS.contains(&target_str.as_str());
252
253 if !has_target {
254 if target.filepath().is_some_and(|p| p.exists()) {
256 has_target = true;
257 } else if let Some(custom_target_path) = env::var_os("RUST_TARGET_PATH") {
258 let mut target_filename = OsString::from(&target_str);
259 target_filename.push(".json");
261
262 let walker = walkdir::WalkDir::new(custom_target_path).into_iter();
264 for entry in walker.filter_map(|e| e.ok()) {
265 has_target |= entry.file_name() == target_filename;
266 }
267 }
268 }
269
270 if !has_target {
271 panic!(
272 "No such target exists in the target list,\n\
273 make sure to correctly specify the location \
274 of the JSON specification file \
275 for custom targets!\n\
276 Use BOOTSTRAP_SKIP_TARGET_SANITY=1 to \
277 bypass this check."
278 );
279 }
280 }
281
282 if !build.config.dry_run() {
283 cmd_finder.must_have(build.cc(*target));
284 if let Some(ar) = build.ar(*target) {
285 cmd_finder.must_have(ar);
286 }
287 }
288 }
289
290 if !build.config.dry_run() {
291 for host in &build.hosts {
292 cmd_finder.must_have(build.cxx(*host).unwrap());
293
294 if build.config.llvm_enabled(*host) {
295 let filecheck = build.llvm_filecheck(build.build);
297 if !filecheck.starts_with(&build.out)
298 && !filecheck.exists()
299 && build.config.codegen_tests
300 {
301 panic!("FileCheck executable {filecheck:?} does not exist");
302 }
303 }
304 }
305 }
306
307 for target in &build.targets {
308 build
309 .config
310 .target_config
311 .entry(*target)
312 .or_insert_with(|| Target::from_triple(&target.triple));
313
314 if (target.contains("-none-") || target.contains("nvptx"))
315 && build.no_std(*target) == Some(false)
316 {
317 panic!("All the *-none-* and nvptx* targets are no-std targets")
318 }
319
320 if skip_target_sanity && target != &build.build {
322 continue;
323 }
324
325 if target.contains("musl") && !target.contains("unikraft") {
327 if build.musl_root(*target).is_none() && build.is_builder_target(*target) {
330 let target = build.config.target_config.entry(*target).or_default();
331 target.musl_root = Some("/usr".into());
332 }
333 match build.musl_libdir(*target) {
334 Some(libdir) => {
335 if fs::metadata(libdir.join("libc.a")).is_err() {
336 panic!("couldn't find libc.a in musl libdir: {}", libdir.display());
337 }
338 }
339 None => panic!(
340 "when targeting MUSL either the rust.musl-root \
341 option or the target.$TARGET.musl-root option must \
342 be specified in bootstrap.toml"
343 ),
344 }
345 }
346
347 if need_cmake && target.is_msvc() {
348 let out =
352 command("cmake").arg("--help").run_always().run_capture_stdout(build).stdout();
353 if !out.contains("Visual Studio") {
354 panic!(
355 "
356cmake does not support Visual Studio generators.
357
358This is likely due to it being an msys/cygwin build of cmake,
359rather than the required windows version, built using MinGW
360or Visual Studio.
361
362If you are building under msys2 try installing the mingw-w64-x86_64-cmake
363package instead of cmake:
364
365$ pacman -R cmake && pacman -S mingw-w64-x86_64-cmake
366"
367 );
368 }
369 }
370 }
371
372 if let Some(ref s) = build.config.ccache {
373 cmd_finder.must_have(s);
374 }
375}