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::{OsString, OsStr};
15 use std::path::PathBuf;
16 use std::process::Command;
18 use build_helper::{output, t};
23 cache: HashMap<OsString, Option<PathBuf>>,
30 cache: HashMap::new(),
31 path: env::var_os("PATH").unwrap_or_default()
35 fn maybe_have<S: AsRef<OsStr>>(&mut self, cmd: S) -> Option<PathBuf> {
36 let cmd: OsString = cmd.as_ref().into();
37 let path = &self.path;
38 self.cache.entry(cmd.clone()).or_insert_with(|| {
39 for path in env::split_paths(path) {
40 let target = path.join(&cmd);
41 let mut cmd_exe = cmd.clone();
44 if target.is_file() // some/path/git
45 || path.join(&cmd_exe).exists() // some/path/git.exe
46 || target.join(&cmd_exe).exists() // some/path/git/git.exe
55 fn must_have<S: AsRef<OsStr>>(&mut self, cmd: S) -> PathBuf {
56 self.maybe_have(&cmd).unwrap_or_else(|| {
57 panic!("\n\ncouldn't find required command: {:?}\n\n", cmd.as_ref());
62 pub fn check(build: &mut Build) {
63 let path = env::var_os("PATH").unwrap_or_default();
64 // On Windows, quotes are invalid characters for filename paths, and if
65 // one is present as part of the PATH then that can lead to the system
66 // being unable to identify the files properly. See
67 // https://github.com/rust-lang/rust/issues/34959 for more details.
68 if cfg!(windows) && path.to_string_lossy().contains('\"') {
69 panic!("PATH contains invalid character '\"'");
72 let mut cmd_finder = Finder::new();
73 // If we've got a git directory we're gonna need git to update
74 // submodules and learn about various other aspects.
75 if build.rust_info.is_git() {
76 cmd_finder.must_have("git");
79 // We need cmake, but only if we're actually building LLVM or sanitizers.
80 let building_llvm = build.hosts.iter()
81 .map(|host| build.config.target_config
83 .map(|config| config.llvm_config.is_none())
85 .any(|build_llvm_ourselves| build_llvm_ourselves);
86 if building_llvm || build.config.sanitizers {
87 cmd_finder.must_have("cmake");
90 // Ninja is currently only used for LLVM itself.
92 if build.config.ninja {
93 // Some Linux distros rename `ninja` to `ninja-build`.
94 // CMake can work with either binary name.
95 if cmd_finder.maybe_have("ninja-build").is_none() {
96 cmd_finder.must_have("ninja");
100 // If ninja isn't enabled but we're building for MSVC then we try
101 // doubly hard to enable it. It was realized in #43767 that the msbuild
102 // CMake generator for MSVC doesn't respect configuration options like
103 // disabling LLVM assertions, which can often be quite important!
105 // In these cases we automatically enable Ninja if we find it in the
107 if !build.config.ninja && build.config.build.contains("msvc") {
108 if cmd_finder.maybe_have("ninja").is_some() {
109 build.config.ninja = true;
113 if build.config.lldb_enabled {
114 cmd_finder.must_have("swig");
115 let out = output(Command::new("swig").arg("-version"));
116 if !out.contains("SWIG Version 3") && !out.contains("SWIG Version 4") {
117 panic!("Ensure that Swig 3.x.x or 4.x.x is installed.");
122 build.config.python = build.config.python.take().map(|p| cmd_finder.must_have(p))
123 .or_else(|| cmd_finder.maybe_have("python2.7"))
124 .or_else(|| cmd_finder.maybe_have("python2"))
125 .or_else(|| env::var_os("BOOTSTRAP_PYTHON").map(PathBuf::from)) // set by bootstrap.py
126 .or_else(|| Some(cmd_finder.must_have("python")));
128 build.config.nodejs = build.config.nodejs.take().map(|p| cmd_finder.must_have(p))
129 .or_else(|| cmd_finder.maybe_have("node"))
130 .or_else(|| cmd_finder.maybe_have("nodejs"));
132 build.config.gdb = build.config.gdb.take().map(|p| cmd_finder.must_have(p))
133 .or_else(|| cmd_finder.maybe_have("gdb"));
135 // We're gonna build some custom C code here and there, host triples
136 // also build some C++ shims for LLVM so we need a C++ compiler.
137 for target in &build.targets {
138 // On emscripten we don't actually need the C compiler to just
139 // build the target artifacts, only for testing. For the sake
140 // of easier bot configuration, just skip detection.
141 if target.contains("emscripten") {
145 // We don't use a C compiler on wasm32
146 if target.contains("wasm32") {
150 if !build.config.dry_run {
151 cmd_finder.must_have(build.cc(*target));
152 if let Some(ar) = build.ar(*target) {
153 cmd_finder.must_have(ar);
158 for host in &build.hosts {
159 if !build.config.dry_run {
160 cmd_finder.must_have(build.cxx(*host).unwrap());
164 // Externally configured LLVM requires FileCheck to exist
165 let filecheck = build.llvm_filecheck(build.build);
166 if !filecheck.starts_with(&build.out) && !filecheck.exists() && build.config.codegen_tests {
167 panic!("FileCheck executable {:?} does not exist", filecheck);
170 for target in &build.targets {
171 // Can't compile for iOS unless we're on macOS
172 if target.contains("apple-ios") &&
173 !build.build.contains("apple-darwin") {
174 panic!("the iOS target is only supported on macOS");
177 if target.contains("-none-") || target.contains("nvptx") {
178 if build.no_std(*target).is_none() {
179 let target = build.config.target_config.entry(target.clone())
182 target.no_std = true;
185 if build.no_std(*target) == Some(false) {
186 panic!("All the *-none-* and nvptx* targets are no-std targets")
190 // Make sure musl-root is valid
191 if target.contains("musl") {
192 // If this is a native target (host is also musl) and no musl-root is given,
193 // fall back to the system toolchain in /usr before giving up
194 if build.musl_root(*target).is_none() && build.config.build == *target {
195 let target = build.config.target_config.entry(target.clone())
197 target.musl_root = Some("/usr".into());
199 match build.musl_root(*target) {
201 if fs::metadata(root.join("lib/libc.a")).is_err() {
202 panic!("couldn't find libc.a in musl dir: {}",
203 root.join("lib").display());
205 if fs::metadata(root.join("lib/libunwind.a")).is_err() {
206 panic!("couldn't find libunwind.a in musl dir: {}",
207 root.join("lib").display());
211 panic!("when targeting MUSL either the rust.musl-root \
212 option or the target.$TARGET.musl-root option must \
213 be specified in config.toml")
218 if target.contains("msvc") {
219 // There are three builds of cmake on windows: MSVC, MinGW, and
220 // Cygwin. The Cygwin build does not have generators for Visual
221 // Studio, so detect that here and error.
222 let out = output(Command::new("cmake").arg("--help"));
223 if !out.contains("Visual Studio") {
225 cmake does not support Visual Studio generators.
227 This is likely due to it being an msys/cygwin build of cmake,
228 rather than the required windows version, built using MinGW
231 If you are building under msys2 try installing the mingw-w64-x86_64-cmake
232 package instead of cmake:
234 $ pacman -R cmake && pacman -S mingw-w64-x86_64-cmake
240 if let Some(ref s) = build.config.ccache {
241 cmd_finder.must_have(s);
244 if build.config.channel == "stable" {
245 let stage0 = t!(fs::read_to_string(build.src.join("src/stage0.txt")));
246 if stage0.contains("\ndev:") {
247 panic!("bootstrapping from a dev compiler in a stable release, but \
248 should only be bootstrapping from a released compiler!");