1 //! Sanity checking performed by rustbuild before actually executing anything.
3 //! This module contains the implementation of ensuring that the build
4 //! environment looks reasonable before progressing. This will verify that
5 //! various programs like git and python exist, along with ensuring that all C
6 //! compilers for cross-compiling are found.
8 //! In theory if we get past this phase it's a bug if a build fails, but in
9 //! practice that's likely not true!
11 use std::collections::HashMap;
13 use std::ffi::{OsStr, OsString};
15 use std::path::PathBuf;
16 use std::process::Command;
18 use build_helper::{output, t};
20 use crate::cache::INTERNER;
21 use crate::config::Target;
25 cache: HashMap<OsString, Option<PathBuf>>,
30 pub fn new() -> Self {
31 Self { cache: HashMap::new(), path: env::var_os("PATH").unwrap_or_default() }
34 pub fn maybe_have<S: Into<OsString>>(&mut self, cmd: S) -> Option<PathBuf> {
35 let cmd: OsString = cmd.into();
36 let path = &self.path;
40 for path in env::split_paths(path) {
41 let target = path.join(&cmd);
42 let mut cmd_exe = cmd.clone();
45 if target.is_file() // some/path/git
46 || path.join(&cmd_exe).exists() // some/path/git.exe
47 || target.join(&cmd_exe).exists()
48 // some/path/git/git.exe
58 pub fn must_have<S: AsRef<OsStr>>(&mut self, cmd: S) -> PathBuf {
59 self.maybe_have(&cmd).unwrap_or_else(|| {
60 panic!("\n\ncouldn't find required command: {:?}\n\n", cmd.as_ref());
65 pub fn check(build: &mut Build) {
66 let path = env::var_os("PATH").unwrap_or_default();
67 // On Windows, quotes are invalid characters for filename paths, and if
68 // one is present as part of the PATH then that can lead to the system
69 // being unable to identify the files properly. See
70 // https://github.com/rust-lang/rust/issues/34959 for more details.
71 if cfg!(windows) && path.to_string_lossy().contains('\"') {
72 panic!("PATH contains invalid character '\"'");
75 let mut cmd_finder = Finder::new();
76 // If we've got a git directory we're gonna need git to update
77 // submodules and learn about various other aspects.
78 if build.rust_info.is_git() {
79 cmd_finder.must_have("git");
82 // We need cmake, but only if we're actually building LLVM or sanitizers.
83 let building_llvm = build.config.rust_codegen_backends.contains(&INTERNER.intern_str("llvm"))
92 .map(|config| config.llvm_config.is_none())
95 .any(|build_llvm_ourselves| build_llvm_ourselves);
96 let need_cmake = building_llvm || build.config.any_sanitizers_enabled();
98 cmd_finder.must_have("cmake");
101 build.config.python = build
105 .map(|p| cmd_finder.must_have(p))
106 .or_else(|| env::var_os("BOOTSTRAP_PYTHON").map(PathBuf::from)) // set by bootstrap.py
107 .or_else(|| Some(cmd_finder.must_have("python")));
109 build.config.nodejs = build
113 .map(|p| cmd_finder.must_have(p))
114 .or_else(|| cmd_finder.maybe_have("node"))
115 .or_else(|| cmd_finder.maybe_have("nodejs"));
117 build.config.npm = build
121 .map(|p| cmd_finder.must_have(p))
122 .or_else(|| cmd_finder.maybe_have("npm"));
124 build.config.gdb = build
128 .map(|p| cmd_finder.must_have(p))
129 .or_else(|| cmd_finder.maybe_have("gdb"));
131 // We're gonna build some custom C code here and there, host triples
132 // also build some C++ shims for LLVM so we need a C++ compiler.
133 for target in &build.targets {
134 // On emscripten we don't actually need the C compiler to just
135 // build the target artifacts, only for testing. For the sake
136 // of easier bot configuration, just skip detection.
137 if target.contains("emscripten") {
141 // We don't use a C compiler on wasm32
142 if target.contains("wasm32") {
146 if !build.config.dry_run {
147 cmd_finder.must_have(build.cc(*target));
148 if let Some(ar) = build.ar(*target) {
149 cmd_finder.must_have(ar);
154 for host in &build.hosts {
155 if !build.config.dry_run {
156 cmd_finder.must_have(build.cxx(*host).unwrap());
160 if build.config.rust_codegen_backends.contains(&INTERNER.intern_str("llvm")) {
161 // Externally configured LLVM requires FileCheck to exist
162 let filecheck = build.llvm_filecheck(build.build);
163 if !filecheck.starts_with(&build.out) && !filecheck.exists() && build.config.codegen_tests {
164 panic!("FileCheck executable {:?} does not exist", filecheck);
168 for target in &build.targets {
169 // Can't compile for iOS unless we're on macOS
170 if target.contains("apple-ios") && !build.build.contains("apple-darwin") {
171 panic!("the iOS target is only supported on macOS");
178 .or_insert_with(|| Target::from_triple(&target.triple));
180 if target.contains("-none-") || target.contains("nvptx") {
181 if build.no_std(*target) == Some(false) {
182 panic!("All the *-none-* and nvptx* targets are no-std targets")
186 // Make sure musl-root is valid
187 if target.contains("musl") {
188 // If this is a native target (host is also musl) and no musl-root is given,
189 // fall back to the system toolchain in /usr before giving up
190 if build.musl_root(*target).is_none() && build.config.build == *target {
191 let target = build.config.target_config.entry(*target).or_default();
192 target.musl_root = Some("/usr".into());
194 match build.musl_libdir(*target) {
196 if fs::metadata(libdir.join("libc.a")).is_err() {
197 panic!("couldn't find libc.a in musl libdir: {}", libdir.display());
201 "when targeting MUSL either the rust.musl-root \
202 option or the target.$TARGET.musl-root option must \
203 be specified in config.toml"
208 if need_cmake && target.contains("msvc") {
209 // There are three builds of cmake on windows: MSVC, MinGW, and
210 // Cygwin. The Cygwin build does not have generators for Visual
211 // Studio, so detect that here and error.
212 let out = output(Command::new("cmake").arg("--help"));
213 if !out.contains("Visual Studio") {
216 cmake does not support Visual Studio generators.
218 This is likely due to it being an msys/cygwin build of cmake,
219 rather than the required windows version, built using MinGW
222 If you are building under msys2 try installing the mingw-w64-x86_64-cmake
223 package instead of cmake:
225 $ pacman -R cmake && pacman -S mingw-w64-x86_64-cmake
232 if let Some(ref s) = build.config.ccache {
233 cmd_finder.must_have(s);
236 if build.config.channel == "stable" {
237 let stage0 = t!(fs::read_to_string(build.src.join("src/stage0.txt")));
238 if stage0.contains("\ndev:") {
240 "bootstrapping from a dev compiler in a stable release, but \
241 should only be bootstrapping from a released compiler!"