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;
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 .filter_map(|host| build.config.target_config.get(host))
82 .any(|config| config.llvm_config.is_none());
83 if building_llvm || build.config.sanitizers {
84 cmd_finder.must_have("cmake");
87 // Ninja is currently only used for LLVM itself.
89 if build.config.ninja {
90 // Some Linux distros rename `ninja` to `ninja-build`.
91 // CMake can work with either binary name.
92 if cmd_finder.maybe_have("ninja-build").is_none() {
93 cmd_finder.must_have("ninja");
97 // If ninja isn't enabled but we're building for MSVC then we try
98 // doubly hard to enable it. It was realized in #43767 that the msbuild
99 // CMake generator for MSVC doesn't respect configuration options like
100 // disabling LLVM assertions, which can often be quite important!
102 // In these cases we automatically enable Ninja if we find it in the
104 if !build.config.ninja && build.config.build.contains("msvc") {
105 if cmd_finder.maybe_have("ninja").is_some() {
106 build.config.ninja = true;
111 build.config.python = build.config.python.take().map(|p| cmd_finder.must_have(p))
112 .or_else(|| cmd_finder.maybe_have("python2.7"))
113 .or_else(|| cmd_finder.maybe_have("python2"))
114 .or_else(|| env::var_os("BOOTSTRAP_PYTHON").map(PathBuf::from)) // set by bootstrap.py
115 .or_else(|| Some(cmd_finder.must_have("python")));
117 build.config.nodejs = build.config.nodejs.take().map(|p| cmd_finder.must_have(p))
118 .or_else(|| cmd_finder.maybe_have("node"))
119 .or_else(|| cmd_finder.maybe_have("nodejs"));
121 build.config.gdb = build.config.gdb.take().map(|p| cmd_finder.must_have(p))
122 .or_else(|| cmd_finder.maybe_have("gdb"));
124 // We're gonna build some custom C code here and there, host triples
125 // also build some C++ shims for LLVM so we need a C++ compiler.
126 for target in &build.targets {
127 // On emscripten we don't actually need the C compiler to just
128 // build the target artifacts, only for testing. For the sake
129 // of easier bot configuration, just skip detection.
130 if target.contains("emscripten") {
134 if !build.config.dry_run {
135 cmd_finder.must_have(build.cc(*target));
136 if let Some(ar) = build.ar(*target) {
137 cmd_finder.must_have(ar);
142 for host in &build.hosts {
143 if !build.config.dry_run {
144 cmd_finder.must_have(build.cxx(*host).unwrap());
148 // Externally configured LLVM requires FileCheck to exist
149 let filecheck = build.llvm_filecheck(build.build);
150 if !filecheck.starts_with(&build.out) && !filecheck.exists() && build.config.codegen_tests {
151 panic!("FileCheck executable {:?} does not exist", filecheck);
154 for target in &build.targets {
155 // Can't compile for iOS unless we're on macOS
156 if target.contains("apple-ios") &&
157 !build.build.contains("apple-darwin") {
158 panic!("the iOS target is only supported on macOS");
161 if target.contains("-none-") || target.contains("nvptx") {
162 if build.no_std(*target).is_none() {
163 let target = build.config.target_config.entry(target.clone())
166 target.no_std = true;
169 if build.no_std(*target) == Some(false) {
170 panic!("All the *-none-* and nvptx* targets are no-std targets")
174 // Make sure musl-root is valid
175 if target.contains("musl") {
176 // If this is a native target (host is also musl) and no musl-root is given,
177 // fall back to the system toolchain in /usr before giving up
178 if build.musl_root(*target).is_none() && build.config.build == *target {
179 let target = build.config.target_config.entry(target.clone())
181 target.musl_root = Some("/usr".into());
183 match build.musl_root(*target) {
185 if fs::metadata(root.join("lib/libc.a")).is_err() {
186 panic!("couldn't find libc.a in musl dir: {}",
187 root.join("lib").display());
189 if fs::metadata(root.join("lib/libunwind.a")).is_err() {
190 panic!("couldn't find libunwind.a in musl dir: {}",
191 root.join("lib").display());
195 panic!("when targeting MUSL either the rust.musl-root \
196 option or the target.$TARGET.musl-root option must \
197 be specified in config.toml")
202 if target.contains("msvc") {
203 // There are three builds of cmake on windows: MSVC, MinGW, and
204 // Cygwin. The Cygwin build does not have generators for Visual
205 // Studio, so detect that here and error.
206 let out = output(Command::new("cmake").arg("--help"));
207 if !out.contains("Visual Studio") {
209 cmake does not support Visual Studio generators.
211 This is likely due to it being an msys/cygwin build of cmake,
212 rather than the required windows version, built using MinGW
215 If you are building under msys2 try installing the mingw-w64-x86_64-cmake
216 package instead of cmake:
218 $ pacman -R cmake && pacman -S mingw-w64-x86_64-cmake
224 if let Some(ref s) = build.config.ccache {
225 cmd_finder.must_have(s);
228 if build.config.channel == "stable" {
229 let stage0 = t!(fs::read_to_string(build.src.join("src/stage0.txt")));
230 if stage0.contains("\ndev:") {
231 panic!("bootstrapping from a dev compiler in a stable release, but \
232 should only be bootstrapping from a released compiler!");