src/bootstrap/util.rs

   1 //! Various utility functions used throughout rustbuild.
   2 //!
   3 //! Simple things like testing the various filesystem operations here and there,
   4 //! not a lot of interesting happenings here unfortunately.
   5
   6 use std::env;
   7 use std::fs;
   8 use std::io;
   9 use std::path::{Path, PathBuf};
  10 use std::process::{Command, Stdio};
  11 use std::str;
  12 use std::time::{Instant, SystemTime, UNIX_EPOCH};
  13
  14 use crate::builder::Builder;
  15 use crate::config::{Config, TargetSelection};
  16
  17 /// A helper macro to `unwrap` a result except also print out details like:
  18 ///
  19 /// * The file/line of the panic
  20 /// * The expression that failed
  21 /// * The error itself
  22 ///
  23 /// This is currently used judiciously throughout the build system rather than
  24 /// using a `Result` with `try!`, but this may change one day...
  25 #[macro_export]
  26 macro_rules! t {
  27     ($e:expr) => {
  28         match $e {
  29             Ok(e) => e,
  30             Err(e) => panic!("{} failed with {}", stringify!($e), e),
  31         }
  32     };
  33     // it can show extra info in the second parameter
  34     ($e:expr, $extra:expr) => {
  35         match $e {
  36             Ok(e) => e,
  37             Err(e) => panic!("{} failed with {} ({:?})", stringify!($e), e, $extra),
  38         }
  39     };
  40 }
  41 pub use t;
  42
  43 /// Given an executable called `name`, return the filename for the
  44 /// executable for a particular target.
  45 pub fn exe(name: &str, target: TargetSelection) -> String {
  46     if target.contains("windows") { format!("{}.exe", name) } else { name.to_string() }
  47 }
  48
  49 /// Returns `true` if the file name given looks like a dynamic library.
  50 pub fn is_dylib(name: &str) -> bool {
  51     name.ends_with(".dylib") || name.ends_with(".so") || name.ends_with(".dll")
  52 }
  53
  54 /// Returns `true` if the file name given looks like a debug info file
  55 pub fn is_debug_info(name: &str) -> bool {
  56     // FIXME: consider split debug info on other platforms (e.g., Linux, macOS)
  57     name.ends_with(".pdb")
  58 }
  59
  60 /// Returns the corresponding relative library directory that the compiler's
  61 /// dylibs will be found in.
  62 pub fn libdir(target: TargetSelection) -> &'static str {
  63     if target.contains("windows") { "bin" } else { "lib" }
  64 }
  65
  66 /// Adds a list of lookup paths to `cmd`'s dynamic library lookup path.
  67 /// If the dylib_path_var is already set for this cmd, the old value will be overwritten!
  68 pub fn add_dylib_path(path: Vec<PathBuf>, cmd: &mut Command) {
  69     let mut list = dylib_path();
  70     for path in path {
  71         list.insert(0, path);
  72     }
  73     cmd.env(dylib_path_var(), t!(env::join_paths(list)));
  74 }
  75
  76 include!("dylib_util.rs");
  77
  78 /// Adds a list of lookup paths to `cmd`'s link library lookup path.
  79 pub fn add_link_lib_path(path: Vec<PathBuf>, cmd: &mut Command) {
  80     let mut list = link_lib_path();
  81     for path in path {
  82         list.insert(0, path);
  83     }
  84     cmd.env(link_lib_path_var(), t!(env::join_paths(list)));
  85 }
  86
  87 /// Returns the environment variable which the link library lookup path
  88 /// resides in for this platform.
  89 fn link_lib_path_var() -> &'static str {
  90     if cfg!(target_env = "msvc") { "LIB" } else { "LIBRARY_PATH" }
  91 }
  92
  93 /// Parses the `link_lib_path_var()` environment variable, returning a list of
  94 /// paths that are members of this lookup path.
  95 fn link_lib_path() -> Vec<PathBuf> {
  96     let var = match env::var_os(link_lib_path_var()) {
  97         Some(v) => v,
  98         None => return vec![],
  99     };
 100     env::split_paths(&var).collect()
 101 }
 102
 103 pub struct TimeIt(bool, Instant);
 104
 105 /// Returns an RAII structure that prints out how long it took to drop.
 106 pub fn timeit(builder: &Builder<'_>) -> TimeIt {
 107     TimeIt(builder.config.dry_run, Instant::now())
 108 }
 109
 110 impl Drop for TimeIt {
 111     fn drop(&mut self) {
 112         let time = self.1.elapsed();
 113         if !self.0 {
 114             println!("\tfinished in {}.{:03} seconds", time.as_secs(), time.subsec_millis());
 115         }
 116     }
 117 }
 118
 119 /// Used for download caching
 120 pub(crate) fn program_out_of_date(stamp: &Path, key: &str) -> bool {
 121     if !stamp.exists() {
 122         return true;
 123     }
 124     t!(fs::read_to_string(stamp)) != key
 125 }
 126
 127 /// Symlinks two directories, using junctions on Windows and normal symlinks on
 128 /// Unix.
 129 pub fn symlink_dir(config: &Config, src: &Path, dest: &Path) -> io::Result<()> {
 130     if config.dry_run {
 131         return Ok(());
 132     }
 133     let _ = fs::remove_dir(dest);
 134     return symlink_dir_inner(src, dest);
 135
 136     #[cfg(not(windows))]
 137     fn symlink_dir_inner(src: &Path, dest: &Path) -> io::Result<()> {
 138         use std::os::unix::fs;
 139         fs::symlink(src, dest)
 140     }
 141
 142     // Creating a directory junction on windows involves dealing with reparse
 143     // points and the DeviceIoControl function, and this code is a skeleton of
 144     // what can be found here:
 145     //
 146     // http://www.flexhex.com/docs/articles/hard-links.phtml
 147     #[cfg(windows)]
 148     fn symlink_dir_inner(target: &Path, junction: &Path) -> io::Result<()> {
 149         use std::ffi::OsStr;
 150         use std::os::windows::ffi::OsStrExt;
 151         use std::ptr;
 152
 153         use winapi::shared::minwindef::{DWORD, WORD};
 154         use winapi::um::fileapi::{CreateFileW, OPEN_EXISTING};
 155         use winapi::um::handleapi::CloseHandle;
 156         use winapi::um::ioapiset::DeviceIoControl;
 157         use winapi::um::winbase::{FILE_FLAG_BACKUP_SEMANTICS, FILE_FLAG_OPEN_REPARSE_POINT};
 158         use winapi::um::winioctl::FSCTL_SET_REPARSE_POINT;
 159         use winapi::um::winnt::{
 160             FILE_SHARE_DELETE, FILE_SHARE_READ, FILE_SHARE_WRITE, GENERIC_WRITE,
 161             IO_REPARSE_TAG_MOUNT_POINT, MAXIMUM_REPARSE_DATA_BUFFER_SIZE, WCHAR,
 162         };
 163
 164         #[allow(non_snake_case)]
 165         #[repr(C)]
 166         struct REPARSE_MOUNTPOINT_DATA_BUFFER {
 167             ReparseTag: DWORD,
 168             ReparseDataLength: DWORD,
 169             Reserved: WORD,
 170             ReparseTargetLength: WORD,
 171             ReparseTargetMaximumLength: WORD,
 172             Reserved1: WORD,
 173             ReparseTarget: WCHAR,
 174         }
 175
 176         fn to_u16s<S: AsRef<OsStr>>(s: S) -> io::Result<Vec<u16>> {
 177             Ok(s.as_ref().encode_wide().chain(Some(0)).collect())
 178         }
 179
 180         // We're using low-level APIs to create the junction, and these are more
 181         // picky about paths. For example, forward slashes cannot be used as a
 182         // path separator, so we should try to canonicalize the path first.
 183         let target = fs::canonicalize(target)?;
 184
 185         fs::create_dir(junction)?;
 186
 187         let path = to_u16s(junction)?;
 188
 189         unsafe {
 190             let h = CreateFileW(
 191                 path.as_ptr(),
 192                 GENERIC_WRITE,
 193                 FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
 194                 ptr::null_mut(),
 195                 OPEN_EXISTING,
 196                 FILE_FLAG_OPEN_REPARSE_POINT | FILE_FLAG_BACKUP_SEMANTICS,
 197                 ptr::null_mut(),
 198             );
 199
 200             let mut data = [0u8; MAXIMUM_REPARSE_DATA_BUFFER_SIZE as usize];
 201             let db = data.as_mut_ptr() as *mut REPARSE_MOUNTPOINT_DATA_BUFFER;
 202             let buf = &mut (*db).ReparseTarget as *mut u16;
 203             let mut i = 0;
 204             // FIXME: this conversion is very hacky
 205             let v = br"\??\";
 206             let v = v.iter().map(|x| *x as u16);
 207             for c in v.chain(target.as_os_str().encode_wide().skip(4)) {
 208                 *buf.offset(i) = c;
 209                 i += 1;
 210             }
 211             *buf.offset(i) = 0;
 212             i += 1;
 213             (*db).ReparseTag = IO_REPARSE_TAG_MOUNT_POINT;
 214             (*db).ReparseTargetMaximumLength = (i * 2) as WORD;
 215             (*db).ReparseTargetLength = ((i - 1) * 2) as WORD;
 216             (*db).ReparseDataLength = (*db).ReparseTargetLength as DWORD + 12;
 217
 218             let mut ret = 0;
 219             let res = DeviceIoControl(
 220                 h as *mut _,
 221                 FSCTL_SET_REPARSE_POINT,
 222                 data.as_ptr() as *mut _,
 223                 (*db).ReparseDataLength + 8,
 224                 ptr::null_mut(),
 225                 0,
 226                 &mut ret,
 227                 ptr::null_mut(),
 228             );
 229
 230             let out = if res == 0 { Err(io::Error::last_os_error()) } else { Ok(()) };
 231             CloseHandle(h);
 232             out
 233         }
 234     }
 235 }
 236
 237 /// The CI environment rustbuild is running in. This mainly affects how the logs
 238 /// are printed.
 239 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
 240 pub enum CiEnv {
 241     /// Not a CI environment.
 242     None,
 243     /// The Azure Pipelines environment, for Linux (including Docker), Windows, and macOS builds.
 244     AzurePipelines,
 245     /// The GitHub Actions environment, for Linux (including Docker), Windows and macOS builds.
 246     GitHubActions,
 247 }
 248
 249 impl CiEnv {
 250     /// Obtains the current CI environment.
 251     pub fn current() -> CiEnv {
 252         if env::var("TF_BUILD").map_or(false, |e| e == "True") {
 253             CiEnv::AzurePipelines
 254         } else if env::var("GITHUB_ACTIONS").map_or(false, |e| e == "true") {
 255             CiEnv::GitHubActions
 256         } else {
 257             CiEnv::None
 258         }
 259     }
 260
 261     /// If in a CI environment, forces the command to run with colors.
 262     pub fn force_coloring_in_ci(self, cmd: &mut Command) {
 263         if self != CiEnv::None {
 264             // Due to use of stamp/docker, the output stream of rustbuild is not
 265             // a TTY in CI, so coloring is by-default turned off.
 266             // The explicit `TERM=xterm` environment is needed for
 267             // `--color always` to actually work. This env var was lost when
 268             // compiling through the Makefile. Very strange.
 269             cmd.env("TERM", "xterm").args(&["--color", "always"]);
 270         }
 271     }
 272 }
 273
 274 pub fn forcing_clang_based_tests() -> bool {
 275     if let Some(var) = env::var_os("RUSTBUILD_FORCE_CLANG_BASED_TESTS") {
 276         match &var.to_string_lossy().to_lowercase()[..] {
 277             "1" | "yes" | "on" => true,
 278             "0" | "no" | "off" => false,
 279             other => {
 280                 // Let's make sure typos don't go unnoticed
 281                 panic!(
 282                     "Unrecognized option '{}' set in \
 283                         RUSTBUILD_FORCE_CLANG_BASED_TESTS",
 284                     other
 285                 )
 286             }
 287         }
 288     } else {
 289         false
 290     }
 291 }
 292
 293 pub fn use_host_linker(target: TargetSelection) -> bool {
 294     // FIXME: this information should be gotten by checking the linker flavor
 295     // of the rustc target
 296     !(target.contains("emscripten")
 297         || target.contains("wasm32")
 298         || target.contains("nvptx")
 299         || target.contains("fortanix")
 300         || target.contains("fuchsia")
 301         || target.contains("bpf")
 302         || target.contains("switch"))
 303 }
 304
 305 pub fn is_valid_test_suite_arg<'a, P: AsRef<Path>>(
 306     path: &'a Path,
 307     suite_path: P,
 308     builder: &Builder<'_>,
 309 ) -> Option<&'a str> {
 310     let suite_path = suite_path.as_ref();
 311     let path = match path.strip_prefix(".") {
 312         Ok(p) => p,
 313         Err(_) => path,
 314     };
 315     if !path.starts_with(suite_path) {
 316         return None;
 317     }
 318     let abs_path = builder.src.join(path);
 319     let exists = abs_path.is_dir() || abs_path.is_file();
 320     if !exists {
 321         panic!(
 322             "Invalid test suite filter \"{}\": file or directory does not exist",
 323             abs_path.display()
 324         );
 325     }
 326     // Since test suite paths are themselves directories, if we don't
 327     // specify a directory or file, we'll get an empty string here
 328     // (the result of the test suite directory without its suite prefix).
 329     // Therefore, we need to filter these out, as only the first --test-args
 330     // flag is respected, so providing an empty --test-args conflicts with
 331     // any following it.
 332     match path.strip_prefix(suite_path).ok().and_then(|p| p.to_str()) {
 333         Some(s) if !s.is_empty() => Some(s),
 334         _ => None,
 335     }
 336 }
 337
 338 pub fn run(cmd: &mut Command, print_cmd_on_fail: bool) {
 339     if !try_run(cmd, print_cmd_on_fail) {
 340         crate::detail_exit(1);
 341     }
 342 }
 343
 344 pub fn try_run(cmd: &mut Command, print_cmd_on_fail: bool) -> bool {
 345     let status = match cmd.status() {
 346         Ok(status) => status,
 347         Err(e) => fail(&format!("failed to execute command: {:?}\nerror: {}", cmd, e)),
 348     };
 349     if !status.success() && print_cmd_on_fail {
 350         println!(
 351             "\n\ncommand did not execute successfully: {:?}\n\
 352              expected success, got: {}\n\n",
 353             cmd, status
 354         );
 355     }
 356     status.success()
 357 }
 358
 359 pub fn check_run(cmd: &mut Command, print_cmd_on_fail: bool) -> bool {
 360     let status = match cmd.status() {
 361         Ok(status) => status,
 362         Err(e) => {
 363             println!("failed to execute command: {:?}\nerror: {}", cmd, e);
 364             return false;
 365         }
 366     };
 367     if !status.success() && print_cmd_on_fail {
 368         println!(
 369             "\n\ncommand did not execute successfully: {:?}\n\
 370              expected success, got: {}\n\n",
 371             cmd, status
 372         );
 373     }
 374     status.success()
 375 }
 376
 377 pub fn run_suppressed(cmd: &mut Command) {
 378     if !try_run_suppressed(cmd) {
 379         crate::detail_exit(1);
 380     }
 381 }
 382
 383 pub fn try_run_suppressed(cmd: &mut Command) -> bool {
 384     let output = match cmd.output() {
 385         Ok(status) => status,
 386         Err(e) => fail(&format!("failed to execute command: {:?}\nerror: {}", cmd, e)),
 387     };
 388     if !output.status.success() {
 389         println!(
 390             "\n\ncommand did not execute successfully: {:?}\n\
 391              expected success, got: {}\n\n\
 392              stdout ----\n{}\n\
 393              stderr ----\n{}\n\n",
 394             cmd,
 395             output.status,
 396             String::from_utf8_lossy(&output.stdout),
 397             String::from_utf8_lossy(&output.stderr)
 398         );
 399     }
 400     output.status.success()
 401 }
 402
 403 pub fn make(host: &str) -> PathBuf {
 404     if host.contains("dragonfly")
 405         || host.contains("freebsd")
 406         || host.contains("netbsd")
 407         || host.contains("openbsd")
 408     {
 409         PathBuf::from("gmake")
 410     } else {
 411         PathBuf::from("make")
 412     }
 413 }
 414
 415 #[track_caller]
 416 pub fn output(cmd: &mut Command) -> String {
 417     let output = match cmd.stderr(Stdio::inherit()).output() {
 418         Ok(status) => status,
 419         Err(e) => fail(&format!("failed to execute command: {:?}\nerror: {}", cmd, e)),
 420     };
 421     if !output.status.success() {
 422         panic!(
 423             "command did not execute successfully: {:?}\n\
 424              expected success, got: {}",
 425             cmd, output.status
 426         );
 427     }
 428     String::from_utf8(output.stdout).unwrap()
 429 }
 430
 431 /// Returns the last-modified time for `path`, or zero if it doesn't exist.
 432 pub fn mtime(path: &Path) -> SystemTime {
 433     fs::metadata(path).and_then(|f| f.modified()).unwrap_or(UNIX_EPOCH)
 434 }
 435
 436 /// Returns `true` if `dst` is up to date given that the file or files in `src`
 437 /// are used to generate it.
 438 ///
 439 /// Uses last-modified time checks to verify this.
 440 pub fn up_to_date(src: &Path, dst: &Path) -> bool {
 441     if !dst.exists() {
 442         return false;
 443     }
 444     let threshold = mtime(dst);
 445     let meta = match fs::metadata(src) {
 446         Ok(meta) => meta,
 447         Err(e) => panic!("source {:?} failed to get metadata: {}", src, e),
 448     };
 449     if meta.is_dir() {
 450         dir_up_to_date(src, threshold)
 451     } else {
 452         meta.modified().unwrap_or(UNIX_EPOCH) <= threshold
 453     }
 454 }
 455
 456 fn dir_up_to_date(src: &Path, threshold: SystemTime) -> bool {
 457     t!(fs::read_dir(src)).map(|e| t!(e)).all(|e| {
 458         let meta = t!(e.metadata());
 459         if meta.is_dir() {
 460             dir_up_to_date(&e.path(), threshold)
 461         } else {
 462             meta.modified().unwrap_or(UNIX_EPOCH) < threshold
 463         }
 464     })
 465 }
 466
 467 fn fail(s: &str) -> ! {
 468     eprintln!("\n\n{}\n\n", s);
 469     crate::detail_exit(1);
 470 }
 471
 472 /// Copied from `std::path::absolute` until it stabilizes.
 473 ///
 474 /// FIXME: this shouldn't exist.
 475 pub(crate) fn absolute(path: &Path) -> PathBuf {
 476     if path.as_os_str().is_empty() {
 477         panic!("can't make empty path absolute");
 478     }
 479     #[cfg(unix)]
 480     {
 481         t!(absolute_unix(path), format!("could not make path absolute: {}", path.display()))
 482     }
 483     #[cfg(windows)]
 484     {
 485         t!(absolute_windows(path), format!("could not make path absolute: {}", path.display()))
 486     }
 487     #[cfg(not(any(unix, windows)))]
 488     {
 489         println!("warning: bootstrap is not supported on non-unix platforms");
 490         t!(std::fs::canonicalize(t!(std::env::current_dir()))).join(path)
 491     }
 492 }
 493
 494 #[cfg(unix)]
 495 /// Make a POSIX path absolute without changing its semantics.
 496 fn absolute_unix(path: &Path) -> io::Result<PathBuf> {
 497     // This is mostly a wrapper around collecting `Path::components`, with
 498     // exceptions made where this conflicts with the POSIX specification.
 499     // See 4.13 Pathname Resolution, IEEE Std 1003.1-2017
 500     // https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap04.html#tag_04_13
 501
 502     use std::os::unix::prelude::OsStrExt;
 503     let mut components = path.components();
 504     let path_os = path.as_os_str().as_bytes();
 505
 506     let mut normalized = if path.is_absolute() {
 507         // "If a pathname begins with two successive <slash> characters, the
 508         // first component following the leading <slash> characters may be
 509         // interpreted in an implementation-defined manner, although more than
 510         // two leading <slash> characters shall be treated as a single <slash>
 511         // character."
 512         if path_os.starts_with(b"//") && !path_os.starts_with(b"///") {
 513             components.next();
 514             PathBuf::from("//")
 515         } else {
 516             PathBuf::new()
 517         }
 518     } else {
 519         env::current_dir()?
 520     };
 521     normalized.extend(components);
 522
 523     // "Interfaces using pathname resolution may specify additional constraints
 524     // when a pathname that does not name an existing directory contains at
 525     // least one non- <slash> character and contains one or more trailing
 526     // <slash> characters".
 527     // A trailing <slash> is also meaningful if "a symbolic link is
 528     // encountered during pathname resolution".
 529
 530     if path_os.ends_with(b"/") {
 531         normalized.push("");
 532     }
 533
 534     Ok(normalized)
 535 }
 536
 537 #[cfg(windows)]
 538 fn absolute_windows(path: &std::path::Path) -> std::io::Result<std::path::PathBuf> {
 539     use std::ffi::OsString;
 540     use std::io::Error;
 541     use std::os::windows::ffi::{OsStrExt, OsStringExt};
 542     use std::ptr::null_mut;
 543     #[link(name = "kernel32")]
 544     extern "system" {
 545         fn GetFullPathNameW(
 546             lpFileName: *const u16,
 547             nBufferLength: u32,
 548             lpBuffer: *mut u16,
 549             lpFilePart: *mut *const u16,
 550         ) -> u32;
 551     }
 552
 553     unsafe {
 554         // encode the path as UTF-16
 555         let path: Vec<u16> = path.as_os_str().encode_wide().chain([0]).collect();
 556         let mut buffer = Vec::new();
 557         // Loop until either success or failure.
 558         loop {
 559             // Try to get the absolute path
 560             let len = GetFullPathNameW(
 561                 path.as_ptr(),
 562                 buffer.len().try_into().unwrap(),
 563                 buffer.as_mut_ptr(),
 564                 null_mut(),
 565             );
 566             match len as usize {
 567                 // Failure
 568                 0 => return Err(Error::last_os_error()),
 569                 // Buffer is too small, resize.
 570                 len if len > buffer.len() => buffer.resize(len, 0),
 571                 // Success!
 572                 len => {
 573                     buffer.truncate(len);
 574                     return Ok(OsString::from_wide(&buffer).into());
 575                 }
 576             }
 577         }
 578     }
 579 }
 580
 581 /// Adapted from https://github.com/llvm/llvm-project/blob/782e91224601e461c019e0a4573bbccc6094fbcd/llvm/cmake/modules/HandleLLVMOptions.cmake#L1058-L1079
 582 ///
 583 /// When `clang-cl` is used with instrumentation, we need to add clang's runtime library resource
 584 /// directory to the linker flags, otherwise there will be linker errors about the profiler runtime
 585 /// missing. This function returns the path to that directory.
 586 pub fn get_clang_cl_resource_dir(clang_cl_path: &str) -> PathBuf {
 587     // Similar to how LLVM does it, to find clang's library runtime directory:
 588     // - we ask `clang-cl` to locate the `clang_rt.builtins` lib.
 589     let mut builtins_locator = Command::new(clang_cl_path);
 590     builtins_locator.args(&["/clang:-print-libgcc-file-name", "/clang:--rtlib=compiler-rt"]);
 591
 592     let clang_rt_builtins = output(&mut builtins_locator);
 593     let clang_rt_builtins = Path::new(clang_rt_builtins.trim());
 594     assert!(
 595         clang_rt_builtins.exists(),
 596         "`clang-cl` must correctly locate the library runtime directory"
 597     );
 598
 599     // - the profiler runtime will be located in the same directory as the builtins lib, like
 600     // `$LLVM_DISTRO_ROOT/lib/clang/$LLVM_VERSION/lib/windows`.
 601     let clang_rt_dir = clang_rt_builtins.parent().expect("The clang lib folder should exist");
 602     clang_rt_dir.to_path_buf()
 603 }