src/bootstrap/sanity.rs

   1 //! Sanity checking performed by rustbuild before actually executing anything.
   2 //!
   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.
   7 //!
   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!
  10
  11 use std::collections::HashMap;
  12 use std::env;
  13 use std::ffi::{OsStr, OsString};
  14 use std::fs;
  15 use std::path::PathBuf;
  16 use std::process::Command;
  17
  18 use build_helper::{output, t};
  19
  20 use crate::config::Target;
  21 use crate::Build;
  22
  23 struct Finder {
  24     cache: HashMap<OsString, Option<PathBuf>>,
  25     path: OsString,
  26 }
  27
  28 impl Finder {
  29     fn new() -> Self {
  30         Self { cache: HashMap::new(), path: env::var_os("PATH").unwrap_or_default() }
  31     }
  32
  33     fn maybe_have<S: AsRef<OsStr>>(&mut self, cmd: S) -> Option<PathBuf> {
  34         let cmd: OsString = cmd.as_ref().into();
  35         let path = &self.path;
  36         self.cache
  37             .entry(cmd.clone())
  38             .or_insert_with(|| {
  39                 for path in env::split_paths(path) {
  40                     let target = path.join(&cmd);
  41                     let mut cmd_exe = cmd.clone();
  42                     cmd_exe.push(".exe");
  43
  44                     if target.is_file()                   // some/path/git
  45                     || path.join(&cmd_exe).exists()   // some/path/git.exe
  46                     || target.join(&cmd_exe).exists()
  47                     // some/path/git/git.exe
  48                     {
  49                         return Some(target);
  50                     }
  51                 }
  52                 None
  53             })
  54             .clone()
  55     }
  56
  57     fn must_have<S: AsRef<OsStr>>(&mut self, cmd: S) -> PathBuf {
  58         self.maybe_have(&cmd).unwrap_or_else(|| {
  59             panic!("\n\ncouldn't find required command: {:?}\n\n", cmd.as_ref());
  60         })
  61     }
  62 }
  63
  64 pub fn check(build: &mut Build) {
  65     let path = env::var_os("PATH").unwrap_or_default();
  66     // On Windows, quotes are invalid characters for filename paths, and if
  67     // one is present as part of the PATH then that can lead to the system
  68     // being unable to identify the files properly. See
  69     // https://github.com/rust-lang/rust/issues/34959 for more details.
  70     if cfg!(windows) && path.to_string_lossy().contains('\"') {
  71         panic!("PATH contains invalid character '\"'");
  72     }
  73
  74     let mut cmd_finder = Finder::new();
  75     // If we've got a git directory we're gonna need git to update
  76     // submodules and learn about various other aspects.
  77     if build.rust_info.is_git() {
  78         cmd_finder.must_have("git");
  79     }
  80
  81     // We need cmake, but only if we're actually building LLVM or sanitizers.
  82     let building_llvm = build
  83         .hosts
  84         .iter()
  85         .map(|host| {
  86             build
  87                 .config
  88                 .target_config
  89                 .get(host)
  90                 .map(|config| config.llvm_config.is_none())
  91                 .unwrap_or(true)
  92         })
  93         .any(|build_llvm_ourselves| build_llvm_ourselves);
  94     if building_llvm || build.config.sanitizers {
  95         cmd_finder.must_have("cmake");
  96     }
  97
  98     // Ninja is currently only used for LLVM itself.
  99     if building_llvm {
 100         if build.config.ninja {
 101             // Some Linux distros rename `ninja` to `ninja-build`.
 102             // CMake can work with either binary name.
 103             if cmd_finder.maybe_have("ninja-build").is_none() {
 104                 cmd_finder.must_have("ninja");
 105             }
 106         }
 107
 108         // If ninja isn't enabled but we're building for MSVC then we try
 109         // doubly hard to enable it. It was realized in #43767 that the msbuild
 110         // CMake generator for MSVC doesn't respect configuration options like
 111         // disabling LLVM assertions, which can often be quite important!
 112         //
 113         // In these cases we automatically enable Ninja if we find it in the
 114         // environment.
 115         if !build.config.ninja && build.config.build.contains("msvc") {
 116             if cmd_finder.maybe_have("ninja").is_some() {
 117                 build.config.ninja = true;
 118             }
 119         }
 120     }
 121
 122     build.config.python = build
 123         .config
 124         .python
 125         .take()
 126         .map(|p| cmd_finder.must_have(p))
 127         .or_else(|| env::var_os("BOOTSTRAP_PYTHON").map(PathBuf::from)) // set by bootstrap.py
 128         .or_else(|| Some(cmd_finder.must_have("python")));
 129
 130     build.config.nodejs = build
 131         .config
 132         .nodejs
 133         .take()
 134         .map(|p| cmd_finder.must_have(p))
 135         .or_else(|| cmd_finder.maybe_have("node"))
 136         .or_else(|| cmd_finder.maybe_have("nodejs"));
 137
 138     build.config.gdb = build
 139         .config
 140         .gdb
 141         .take()
 142         .map(|p| cmd_finder.must_have(p))
 143         .or_else(|| cmd_finder.maybe_have("gdb"));
 144
 145     // We're gonna build some custom C code here and there, host triples
 146     // also build some C++ shims for LLVM so we need a C++ compiler.
 147     for target in &build.targets {
 148         // On emscripten we don't actually need the C compiler to just
 149         // build the target artifacts, only for testing. For the sake
 150         // of easier bot configuration, just skip detection.
 151         if target.contains("emscripten") {
 152             continue;
 153         }
 154
 155         // We don't use a C compiler on wasm32
 156         if target.contains("wasm32") {
 157             continue;
 158         }
 159
 160         if !build.config.dry_run {
 161             cmd_finder.must_have(build.cc(*target));
 162             if let Some(ar) = build.ar(*target) {
 163                 cmd_finder.must_have(ar);
 164             }
 165         }
 166     }
 167
 168     for host in &build.hosts {
 169         if !build.config.dry_run {
 170             cmd_finder.must_have(build.cxx(*host).unwrap());
 171         }
 172     }
 173
 174     // Externally configured LLVM requires FileCheck to exist
 175     let filecheck = build.llvm_filecheck(build.build);
 176     if !filecheck.starts_with(&build.out) && !filecheck.exists() && build.config.codegen_tests {
 177         panic!("FileCheck executable {:?} does not exist", filecheck);
 178     }
 179
 180     for target in &build.targets {
 181         // Can't compile for iOS unless we're on macOS
 182         if target.contains("apple-ios") && !build.build.contains("apple-darwin") {
 183             panic!("the iOS target is only supported on macOS");
 184         }
 185
 186         build
 187             .config
 188             .target_config
 189             .entry(target.clone())
 190             .or_insert(Target::from_triple(&target.triple));
 191
 192         if target.contains("-none-") || target.contains("nvptx") {
 193             if build.no_std(*target) == Some(false) {
 194                 panic!("All the *-none-* and nvptx* targets are no-std targets")
 195             }
 196         }
 197
 198         // Make sure musl-root is valid
 199         if target.contains("musl") {
 200             // If this is a native target (host is also musl) and no musl-root is given,
 201             // fall back to the system toolchain in /usr before giving up
 202             if build.musl_root(*target).is_none() && build.config.build == *target {
 203                 let target = build.config.target_config.entry(target.clone()).or_default();
 204                 target.musl_root = Some("/usr".into());
 205             }
 206             match build.musl_libdir(*target) {
 207                 Some(libdir) => {
 208                     if fs::metadata(libdir.join("libc.a")).is_err() {
 209                         panic!("couldn't find libc.a in musl libdir: {}", libdir.display());
 210                     }
 211                 }
 212                 None => panic!(
 213                     "when targeting MUSL either the rust.musl-root \
 214                             option or the target.$TARGET.musl-root option must \
 215                             be specified in config.toml"
 216                 ),
 217             }
 218         }
 219
 220         if target.contains("msvc") {
 221             // There are three builds of cmake on windows: MSVC, MinGW, and
 222             // Cygwin. The Cygwin build does not have generators for Visual
 223             // Studio, so detect that here and error.
 224             let out = output(Command::new("cmake").arg("--help"));
 225             if !out.contains("Visual Studio") {
 226                 panic!(
 227                     "
 228 cmake does not support Visual Studio generators.
 229
 230 This is likely due to it being an msys/cygwin build of cmake,
 231 rather than the required windows version, built using MinGW
 232 or Visual Studio.
 233
 234 If you are building under msys2 try installing the mingw-w64-x86_64-cmake
 235 package instead of cmake:
 236
 237 $ pacman -R cmake && pacman -S mingw-w64-x86_64-cmake
 238 "
 239                 );
 240             }
 241         }
 242     }
 243
 244     if let Some(ref s) = build.config.ccache {
 245         cmd_finder.must_have(s);
 246     }
 247
 248     if build.config.channel == "stable" {
 249         let stage0 = t!(fs::read_to_string(build.src.join("src/stage0.txt")));
 250         if stage0.contains("\ndev:") {
 251             panic!(
 252                 "bootstrapping from a dev compiler in a stable release, but \
 253                     should only be bootstrapping from a released compiler!"
 254             );
 255         }
 256     }
 257 }