1 //! Various utility functions used throughout rustbuild.
3 //! Simple things like testing the various filesystem operations here and there,
4 //! not a lot of interesting happenings here unfortunately.
9 use std::path::{Path, PathBuf};
10 use std::process::{Command, Stdio};
12 use std::time::{Instant, SystemTime, UNIX_EPOCH};
14 use crate::builder::Builder;
15 use crate::config::{Config, TargetSelection};
17 /// A helper macro to `unwrap` a result except also print out details like:
19 /// * The file/line of the panic
20 /// * The expression that failed
21 /// * The error itself
23 /// This is currently used judiciously throughout the build system rather than
24 /// using a `Result` with `try!`, but this may change one day...
29 Err(e) => panic!("{} failed with {}", stringify!($e), e),
32 // it can show extra info in the second parameter
33 ($e:expr, $extra:expr) => {
36 Err(e) => panic!("{} failed with {} ({:?})", stringify!($e), e, $extra),
42 /// Given an executable called `name`, return the filename for the
43 /// executable for a particular target.
44 pub fn exe(name: &str, target: TargetSelection) -> String {
45 if target.contains("windows") { format!("{}.exe", name) } else { name.to_string() }
48 /// Returns `true` if the file name given looks like a dynamic library.
49 pub fn is_dylib(name: &str) -> bool {
50 name.ends_with(".dylib") || name.ends_with(".so") || name.ends_with(".dll")
53 /// Returns `true` if the file name given looks like a debug info file
54 pub fn is_debug_info(name: &str) -> bool {
55 // FIXME: consider split debug info on other platforms (e.g., Linux, macOS)
56 name.ends_with(".pdb")
59 /// Returns the corresponding relative library directory that the compiler's
60 /// dylibs will be found in.
61 pub fn libdir(target: TargetSelection) -> &'static str {
62 if target.contains("windows") { "bin" } else { "lib" }
65 /// Adds a list of lookup paths to `cmd`'s dynamic library lookup path.
66 /// If The dylib_path_par is already set for this cmd, the old value will be overwritten!
67 pub fn add_dylib_path(path: Vec<PathBuf>, cmd: &mut Command) {
68 let mut list = dylib_path();
72 cmd.env(dylib_path_var(), t!(env::join_paths(list)));
75 include!("dylib_util.rs");
77 /// Adds a list of lookup paths to `cmd`'s link library lookup path.
78 pub fn add_link_lib_path(path: Vec<PathBuf>, cmd: &mut Command) {
79 let mut list = link_lib_path();
83 cmd.env(link_lib_path_var(), t!(env::join_paths(list)));
86 /// Returns the environment variable which the link library lookup path
87 /// resides in for this platform.
88 fn link_lib_path_var() -> &'static str {
89 if cfg!(target_env = "msvc") { "LIB" } else { "LIBRARY_PATH" }
92 /// Parses the `link_lib_path_var()` environment variable, returning a list of
93 /// paths that are members of this lookup path.
94 fn link_lib_path() -> Vec<PathBuf> {
95 let var = match env::var_os(link_lib_path_var()) {
97 None => return vec![],
99 env::split_paths(&var).collect()
102 pub struct TimeIt(bool, Instant);
104 /// Returns an RAII structure that prints out how long it took to drop.
105 pub fn timeit(builder: &Builder<'_>) -> TimeIt {
106 TimeIt(builder.config.dry_run, Instant::now())
109 impl Drop for TimeIt {
111 let time = self.1.elapsed();
113 println!("\tfinished in {}.{:03} seconds", time.as_secs(), time.subsec_millis());
118 /// Symlinks two directories, using junctions on Windows and normal symlinks on
120 pub fn symlink_dir(config: &Config, src: &Path, dest: &Path) -> io::Result<()> {
124 let _ = fs::remove_dir(dest);
125 return symlink_dir_inner(src, dest);
128 fn symlink_dir_inner(src: &Path, dest: &Path) -> io::Result<()> {
129 use std::os::unix::fs;
130 fs::symlink(src, dest)
133 // Creating a directory junction on windows involves dealing with reparse
134 // points and the DeviceIoControl function, and this code is a skeleton of
135 // what can be found here:
137 // http://www.flexhex.com/docs/articles/hard-links.phtml
139 fn symlink_dir_inner(target: &Path, junction: &Path) -> io::Result<()> {
141 use std::os::windows::ffi::OsStrExt;
144 use winapi::shared::minwindef::{DWORD, WORD};
145 use winapi::um::fileapi::{CreateFileW, OPEN_EXISTING};
146 use winapi::um::handleapi::CloseHandle;
147 use winapi::um::ioapiset::DeviceIoControl;
148 use winapi::um::winbase::{FILE_FLAG_BACKUP_SEMANTICS, FILE_FLAG_OPEN_REPARSE_POINT};
149 use winapi::um::winioctl::FSCTL_SET_REPARSE_POINT;
150 use winapi::um::winnt::{
151 FILE_SHARE_DELETE, FILE_SHARE_READ, FILE_SHARE_WRITE, GENERIC_WRITE,
152 IO_REPARSE_TAG_MOUNT_POINT, MAXIMUM_REPARSE_DATA_BUFFER_SIZE, WCHAR,
155 #[allow(non_snake_case)]
157 struct REPARSE_MOUNTPOINT_DATA_BUFFER {
159 ReparseDataLength: DWORD,
161 ReparseTargetLength: WORD,
162 ReparseTargetMaximumLength: WORD,
164 ReparseTarget: WCHAR,
167 fn to_u16s<S: AsRef<OsStr>>(s: S) -> io::Result<Vec<u16>> {
168 Ok(s.as_ref().encode_wide().chain(Some(0)).collect())
171 // We're using low-level APIs to create the junction, and these are more
172 // picky about paths. For example, forward slashes cannot be used as a
173 // path separator, so we should try to canonicalize the path first.
174 let target = fs::canonicalize(target)?;
176 fs::create_dir(junction)?;
178 let path = to_u16s(junction)?;
184 FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
187 FILE_FLAG_OPEN_REPARSE_POINT | FILE_FLAG_BACKUP_SEMANTICS,
191 let mut data = [0u8; MAXIMUM_REPARSE_DATA_BUFFER_SIZE as usize];
192 let db = data.as_mut_ptr() as *mut REPARSE_MOUNTPOINT_DATA_BUFFER;
193 let buf = &mut (*db).ReparseTarget as *mut u16;
195 // FIXME: this conversion is very hacky
197 let v = v.iter().map(|x| *x as u16);
198 for c in v.chain(target.as_os_str().encode_wide().skip(4)) {
204 (*db).ReparseTag = IO_REPARSE_TAG_MOUNT_POINT;
205 (*db).ReparseTargetMaximumLength = (i * 2) as WORD;
206 (*db).ReparseTargetLength = ((i - 1) * 2) as WORD;
207 (*db).ReparseDataLength = (*db).ReparseTargetLength as DWORD + 12;
210 let res = DeviceIoControl(
212 FSCTL_SET_REPARSE_POINT,
213 data.as_ptr() as *mut _,
214 (*db).ReparseDataLength + 8,
221 let out = if res == 0 { Err(io::Error::last_os_error()) } else { Ok(()) };
228 /// The CI environment rustbuild is running in. This mainly affects how the logs
230 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
232 /// Not a CI environment.
234 /// The Azure Pipelines environment, for Linux (including Docker), Windows, and macOS builds.
236 /// The GitHub Actions environment, for Linux (including Docker), Windows and macOS builds.
241 /// Obtains the current CI environment.
242 pub fn current() -> CiEnv {
243 if env::var("TF_BUILD").map_or(false, |e| e == "True") {
244 CiEnv::AzurePipelines
245 } else if env::var("GITHUB_ACTIONS").map_or(false, |e| e == "true") {
252 /// If in a CI environment, forces the command to run with colors.
253 pub fn force_coloring_in_ci(self, cmd: &mut Command) {
254 if self != CiEnv::None {
255 // Due to use of stamp/docker, the output stream of rustbuild is not
256 // a TTY in CI, so coloring is by-default turned off.
257 // The explicit `TERM=xterm` environment is needed for
258 // `--color always` to actually work. This env var was lost when
259 // compiling through the Makefile. Very strange.
260 cmd.env("TERM", "xterm").args(&["--color", "always"]);
265 pub fn forcing_clang_based_tests() -> bool {
266 if let Some(var) = env::var_os("RUSTBUILD_FORCE_CLANG_BASED_TESTS") {
267 match &var.to_string_lossy().to_lowercase()[..] {
268 "1" | "yes" | "on" => true,
269 "0" | "no" | "off" => false,
271 // Let's make sure typos don't go unnoticed
273 "Unrecognized option '{}' set in \
274 RUSTBUILD_FORCE_CLANG_BASED_TESTS",
284 pub fn use_host_linker(target: TargetSelection) -> bool {
285 // FIXME: this information should be gotten by checking the linker flavor
286 // of the rustc target
287 !(target.contains("emscripten")
288 || target.contains("wasm32")
289 || target.contains("nvptx")
290 || target.contains("fortanix")
291 || target.contains("fuchsia")
292 || target.contains("bpf"))
295 pub fn is_valid_test_suite_arg<'a, P: AsRef<Path>>(
298 builder: &Builder<'_>,
299 ) -> Option<&'a str> {
300 let suite_path = suite_path.as_ref();
301 let path = match path.strip_prefix(".") {
305 if !path.starts_with(suite_path) {
308 let abs_path = builder.src.join(path);
309 let exists = abs_path.is_dir() || abs_path.is_file();
311 if let Some(p) = abs_path.to_str() {
312 builder.info(&format!("Warning: Skipping \"{}\": not a regular file or directory", p));
316 // Since test suite paths are themselves directories, if we don't
317 // specify a directory or file, we'll get an empty string here
318 // (the result of the test suite directory without its suite prefix).
319 // Therefore, we need to filter these out, as only the first --test-args
320 // flag is respected, so providing an empty --test-args conflicts with
322 match path.strip_prefix(suite_path).ok().and_then(|p| p.to_str()) {
323 Some(s) if !s.is_empty() => Some(s),
328 pub fn run(cmd: &mut Command, print_cmd_on_fail: bool) {
329 if !try_run(cmd, print_cmd_on_fail) {
330 std::process::exit(1);
334 pub fn try_run(cmd: &mut Command, print_cmd_on_fail: bool) -> bool {
335 let status = match cmd.status() {
336 Ok(status) => status,
337 Err(e) => fail(&format!("failed to execute command: {:?}\nerror: {}", cmd, e)),
339 if !status.success() && print_cmd_on_fail {
341 "\n\ncommand did not execute successfully: {:?}\n\
342 expected success, got: {}\n\n",
349 pub fn run_suppressed(cmd: &mut Command) {
350 if !try_run_suppressed(cmd) {
351 std::process::exit(1);
355 pub fn try_run_suppressed(cmd: &mut Command) -> bool {
356 let output = match cmd.output() {
357 Ok(status) => status,
358 Err(e) => fail(&format!("failed to execute command: {:?}\nerror: {}", cmd, e)),
360 if !output.status.success() {
362 "\n\ncommand did not execute successfully: {:?}\n\
363 expected success, got: {}\n\n\
365 stderr ----\n{}\n\n",
368 String::from_utf8_lossy(&output.stdout),
369 String::from_utf8_lossy(&output.stderr)
372 output.status.success()
375 pub fn make(host: &str) -> PathBuf {
376 if host.contains("dragonfly")
377 || host.contains("freebsd")
378 || host.contains("netbsd")
379 || host.contains("openbsd")
381 PathBuf::from("gmake")
383 PathBuf::from("make")
388 pub fn output(cmd: &mut Command) -> String {
389 let output = match cmd.stderr(Stdio::inherit()).output() {
390 Ok(status) => status,
391 Err(e) => fail(&format!("failed to execute command: {:?}\nerror: {}", cmd, e)),
393 if !output.status.success() {
395 "command did not execute successfully: {:?}\n\
396 expected success, got: {}",
400 String::from_utf8(output.stdout).unwrap()
403 /// Returns the last-modified time for `path`, or zero if it doesn't exist.
404 pub fn mtime(path: &Path) -> SystemTime {
405 fs::metadata(path).and_then(|f| f.modified()).unwrap_or(UNIX_EPOCH)
408 /// Returns `true` if `dst` is up to date given that the file or files in `src`
409 /// are used to generate it.
411 /// Uses last-modified time checks to verify this.
412 pub fn up_to_date(src: &Path, dst: &Path) -> bool {
416 let threshold = mtime(dst);
417 let meta = match fs::metadata(src) {
419 Err(e) => panic!("source {:?} failed to get metadata: {}", src, e),
422 dir_up_to_date(src, threshold)
424 meta.modified().unwrap_or(UNIX_EPOCH) <= threshold
428 fn dir_up_to_date(src: &Path, threshold: SystemTime) -> bool {
429 t!(fs::read_dir(src)).map(|e| t!(e)).all(|e| {
430 let meta = t!(e.metadata());
432 dir_up_to_date(&e.path(), threshold)
434 meta.modified().unwrap_or(UNIX_EPOCH) < threshold
439 fn fail(s: &str) -> ! {
440 println!("\n\n{}\n\n", s);
441 std::process::exit(1);
444 /// Copied from `std::path::absolute` until it stabilizes.
446 /// FIXME: this shouldn't exist.
447 pub(crate) fn absolute(path: &Path) -> PathBuf {
448 if path.as_os_str().is_empty() {
449 panic!("can't make empty path absolute");
453 t!(absolute_unix(path), format!("could not make path absolute: {}", path.display()))
457 t!(absolute_windows(path), format!("could not make path absolute: {}", path.display()))
459 #[cfg(not(any(unix, windows)))]
461 println!("warning: bootstrap is not supported on non-unix platforms");
462 t!(std::fs::canonicalize(t!(std::env::current_dir()))).join(path)
467 /// Make a POSIX path absolute without changing its semantics.
468 fn absolute_unix(path: &Path) -> io::Result<PathBuf> {
469 // This is mostly a wrapper around collecting `Path::components`, with
470 // exceptions made where this conflicts with the POSIX specification.
471 // See 4.13 Pathname Resolution, IEEE Std 1003.1-2017
472 // https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap04.html#tag_04_13
474 use std::os::unix::prelude::OsStrExt;
475 let mut components = path.components();
476 let path_os = path.as_os_str().as_bytes();
478 let mut normalized = if path.is_absolute() {
479 // "If a pathname begins with two successive <slash> characters, the
480 // first component following the leading <slash> characters may be
481 // interpreted in an implementation-defined manner, although more than
482 // two leading <slash> characters shall be treated as a single <slash>
484 if path_os.starts_with(b"//") && !path_os.starts_with(b"///") {
493 normalized.extend(components);
495 // "Interfaces using pathname resolution may specify additional constraints
496 // when a pathname that does not name an existing directory contains at
497 // least one non- <slash> character and contains one or more trailing
498 // <slash> characters".
499 // A trailing <slash> is also meaningful if "a symbolic link is
500 // encountered during pathname resolution".
502 if path_os.ends_with(b"/") {
510 fn absolute_windows(path: &std::path::Path) -> std::io::Result<std::path::PathBuf> {
511 use std::ffi::OsString;
513 use std::os::windows::ffi::{OsStrExt, OsStringExt};
514 use std::ptr::null_mut;
515 #[link(name = "kernel32")]
518 lpFileName: *const u16,
521 lpFilePart: *mut *const u16,
526 // encode the path as UTF-16
527 let path: Vec<u16> = path.as_os_str().encode_wide().chain([0]).collect();
528 let mut buffer = Vec::new();
529 // Loop until either success or failure.
531 // Try to get the absolute path
532 let len = GetFullPathNameW(
534 buffer.len().try_into().unwrap(),
540 0 => return Err(Error::last_os_error()),
541 // Buffer is too small, resize.
542 len if len > buffer.len() => buffer.resize(len, 0),
545 buffer.truncate(len);
546 return Ok(OsString::from_wide(&buffer).into());