src/bootstrap/util.rs

   1 // Copyright 2015 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! Various utility functions used throughout rustbuild.
  12 //!
  13 //! Simple things like testing the various filesystem operations here and there,
  14 //! not a lot of interesting happenings here unfortunately.
  15
  16 use std::env;
  17 use std::str;
  18 use std::fs;
  19 use std::io::{self, Write};
  20 use std::path::{Path, PathBuf};
  21 use std::process::Command;
  22 use std::time::{SystemTime, Instant};
  23
  24 use config::Config;
  25 use builder::Builder;
  26
  27 /// Returns the `name` as the filename of a static library for `target`.
  28 pub fn staticlib(name: &str, target: &str) -> String {
  29     if target.contains("windows") {
  30         format!("{}.lib", name)
  31     } else {
  32         format!("lib{}.a", name)
  33     }
  34 }
  35
  36 /// Given an executable called `name`, return the filename for the
  37 /// executable for a particular target.
  38 pub fn exe(name: &str, target: &str) -> String {
  39     if target.contains("windows") {
  40         format!("{}.exe", name)
  41     } else {
  42         name.to_string()
  43     }
  44 }
  45
  46 /// Returns whether the file name given looks like a dynamic library.
  47 pub fn is_dylib(name: &str) -> bool {
  48     name.ends_with(".dylib") || name.ends_with(".so") || name.ends_with(".dll")
  49 }
  50
  51 /// Returns the corresponding relative library directory that the compiler's
  52 /// dylibs will be found in.
  53 pub fn libdir(target: &str) -> &'static str {
  54     if target.contains("windows") {"bin"} else {"lib"}
  55 }
  56
  57 /// Adds a list of lookup paths to `cmd`'s dynamic library lookup path.
  58 pub fn add_lib_path(path: Vec<PathBuf>, cmd: &mut Command) {
  59     let mut list = dylib_path();
  60     for path in path {
  61         list.insert(0, path);
  62     }
  63     cmd.env(dylib_path_var(), t!(env::join_paths(list)));
  64 }
  65
  66 /// Returns the environment variable which the dynamic library lookup path
  67 /// resides in for this platform.
  68 pub fn dylib_path_var() -> &'static str {
  69     if cfg!(target_os = "windows") {
  70         "PATH"
  71     } else if cfg!(target_os = "macos") {
  72         "DYLD_LIBRARY_PATH"
  73     } else if cfg!(target_os = "haiku") {
  74         "LIBRARY_PATH"
  75     } else {
  76         "LD_LIBRARY_PATH"
  77     }
  78 }
  79
  80 /// Parses the `dylib_path_var()` environment variable, returning a list of
  81 /// paths that are members of this lookup path.
  82 pub fn dylib_path() -> Vec<PathBuf> {
  83     env::split_paths(&env::var_os(dylib_path_var()).unwrap_or_default()).collect()
  84 }
  85
  86 /// `push` all components to `buf`. On windows, append `.exe` to the last component.
  87 pub fn push_exe_path(mut buf: PathBuf, components: &[&str]) -> PathBuf {
  88     let (&file, components) = components.split_last().expect("at least one component required");
  89     let mut file = file.to_owned();
  90
  91     if cfg!(windows) {
  92         file.push_str(".exe");
  93     }
  94
  95     buf.extend(components);
  96     buf.push(file);
  97
  98     buf
  99 }
 100
 101 pub struct TimeIt(bool, Instant);
 102
 103 /// Returns an RAII structure that prints out how long it took to drop.
 104 pub fn timeit(builder: &Builder) -> TimeIt {
 105     TimeIt(builder.config.dry_run, Instant::now())
 106 }
 107
 108 impl Drop for TimeIt {
 109     fn drop(&mut self) {
 110         let time = self.1.elapsed();
 111         if !self.0 {
 112             println!("\tfinished in {}.{:03}",
 113                     time.as_secs(),
 114                     time.subsec_nanos() / 1_000_000);
 115         }
 116     }
 117 }
 118
 119 /// Symlinks two directories, using junctions on Windows and normal symlinks on
 120 /// Unix.
 121 pub fn symlink_dir(config: &Config, src: &Path, dest: &Path) -> io::Result<()> {
 122     if config.dry_run { return Ok(()); }
 123     let _ = fs::remove_dir(dest);
 124     return symlink_dir_inner(src, dest);
 125
 126     #[cfg(not(windows))]
 127     fn symlink_dir_inner(src: &Path, dest: &Path) -> io::Result<()> {
 128         use std::os::unix::fs;
 129         fs::symlink(src, dest)
 130     }
 131
 132     // Creating a directory junction on windows involves dealing with reparse
 133     // points and the DeviceIoControl function, and this code is a skeleton of
 134     // what can be found here:
 135     //
 136     // http://www.flexhex.com/docs/articles/hard-links.phtml
 137     //
 138     // Copied from std
 139     #[cfg(windows)]
 140     #[allow(bad_style)]
 141     fn symlink_dir_inner(target: &Path, junction: &Path) -> io::Result<()> {
 142         use std::ptr;
 143         use std::ffi::OsStr;
 144         use std::os::windows::ffi::OsStrExt;
 145
 146         const MAXIMUM_REPARSE_DATA_BUFFER_SIZE: usize = 16 * 1024;
 147         const GENERIC_WRITE: DWORD = 0x40000000;
 148         const OPEN_EXISTING: DWORD = 3;
 149         const FILE_FLAG_OPEN_REPARSE_POINT: DWORD = 0x00200000;
 150         const FILE_FLAG_BACKUP_SEMANTICS: DWORD = 0x02000000;
 151         const FSCTL_SET_REPARSE_POINT: DWORD = 0x900a4;
 152         const IO_REPARSE_TAG_MOUNT_POINT: DWORD = 0xa0000003;
 153         const FILE_SHARE_DELETE: DWORD = 0x4;
 154         const FILE_SHARE_READ: DWORD = 0x1;
 155         const FILE_SHARE_WRITE: DWORD = 0x2;
 156
 157         type BOOL = i32;
 158         type DWORD = u32;
 159         type HANDLE = *mut u8;
 160         type LPCWSTR = *const u16;
 161         type LPDWORD = *mut DWORD;
 162         type LPOVERLAPPED = *mut u8;
 163         type LPSECURITY_ATTRIBUTES = *mut u8;
 164         type LPVOID = *mut u8;
 165         type WCHAR = u16;
 166         type WORD = u16;
 167
 168         #[repr(C)]
 169         struct REPARSE_MOUNTPOINT_DATA_BUFFER {
 170             ReparseTag: DWORD,
 171             ReparseDataLength: DWORD,
 172             Reserved: WORD,
 173             ReparseTargetLength: WORD,
 174             ReparseTargetMaximumLength: WORD,
 175             Reserved1: WORD,
 176             ReparseTarget: WCHAR,
 177         }
 178
 179         extern "system" {
 180             fn CreateFileW(lpFileName: LPCWSTR,
 181                            dwDesiredAccess: DWORD,
 182                            dwShareMode: DWORD,
 183                            lpSecurityAttributes: LPSECURITY_ATTRIBUTES,
 184                            dwCreationDisposition: DWORD,
 185                            dwFlagsAndAttributes: DWORD,
 186                            hTemplateFile: HANDLE)
 187                            -> HANDLE;
 188             fn DeviceIoControl(hDevice: HANDLE,
 189                                dwIoControlCode: DWORD,
 190                                lpInBuffer: LPVOID,
 191                                nInBufferSize: DWORD,
 192                                lpOutBuffer: LPVOID,
 193                                nOutBufferSize: DWORD,
 194                                lpBytesReturned: LPDWORD,
 195                                lpOverlapped: LPOVERLAPPED) -> BOOL;
 196             fn CloseHandle(hObject: HANDLE) -> BOOL;
 197         }
 198
 199         fn to_u16s<S: AsRef<OsStr>>(s: S) -> io::Result<Vec<u16>> {
 200             Ok(s.as_ref().encode_wide().chain(Some(0)).collect())
 201         }
 202
 203         // We're using low-level APIs to create the junction, and these are more
 204         // picky about paths. For example, forward slashes cannot be used as a
 205         // path separator, so we should try to canonicalize the path first.
 206         let target = try!(fs::canonicalize(target));
 207
 208         try!(fs::create_dir(junction));
 209
 210         let path = try!(to_u16s(junction));
 211
 212         unsafe {
 213             let h = CreateFileW(path.as_ptr(),
 214                                 GENERIC_WRITE,
 215                                 FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
 216                                 0 as *mut _,
 217                                 OPEN_EXISTING,
 218                                 FILE_FLAG_OPEN_REPARSE_POINT | FILE_FLAG_BACKUP_SEMANTICS,
 219                                 ptr::null_mut());
 220
 221             let mut data = [0u8; MAXIMUM_REPARSE_DATA_BUFFER_SIZE];
 222             let db = data.as_mut_ptr()
 223                             as *mut REPARSE_MOUNTPOINT_DATA_BUFFER;
 224             let buf = &mut (*db).ReparseTarget as *mut u16;
 225             let mut i = 0;
 226             // FIXME: this conversion is very hacky
 227             let v = br"\??\";
 228             let v = v.iter().map(|x| *x as u16);
 229             for c in v.chain(target.as_os_str().encode_wide().skip(4)) {
 230                 *buf.offset(i) = c;
 231                 i += 1;
 232             }
 233             *buf.offset(i) = 0;
 234             i += 1;
 235             (*db).ReparseTag = IO_REPARSE_TAG_MOUNT_POINT;
 236             (*db).ReparseTargetMaximumLength = (i * 2) as WORD;
 237             (*db).ReparseTargetLength = ((i - 1) * 2) as WORD;
 238             (*db).ReparseDataLength =
 239                     (*db).ReparseTargetLength as DWORD + 12;
 240
 241             let mut ret = 0;
 242             let res = DeviceIoControl(h as *mut _,
 243                                       FSCTL_SET_REPARSE_POINT,
 244                                       data.as_ptr() as *mut _,
 245                                       (*db).ReparseDataLength + 8,
 246                                       ptr::null_mut(), 0,
 247                                       &mut ret,
 248                                       ptr::null_mut());
 249
 250             let out = if res == 0 {
 251                 Err(io::Error::last_os_error())
 252             } else {
 253                 Ok(())
 254             };
 255             CloseHandle(h);
 256             out
 257         }
 258     }
 259 }
 260
 261 /// An RAII structure that indicates all output until this instance is dropped
 262 /// is part of the same group.
 263 ///
 264 /// On Travis CI, these output will be folded by default, together with the
 265 /// elapsed time in this block. This reduces noise from unnecessary logs,
 266 /// allowing developers to quickly identify the error.
 267 ///
 268 /// Travis CI supports folding by printing `travis_fold:start:<name>` and
 269 /// `travis_fold:end:<name>` around the block. Time elapsed is recognized
 270 /// similarly with `travis_time:[start|end]:<name>`. These are undocumented, but
 271 /// can easily be deduced from source code of the [Travis build commands].
 272 ///
 273 /// [Travis build commands]:
 274 /// https://github.com/travis-ci/travis-build/blob/f603c0089/lib/travis/build/templates/header.sh
 275 pub struct OutputFolder {
 276     name: String,
 277     start_time: SystemTime, // we need SystemTime to get the UNIX timestamp.
 278 }
 279
 280 impl OutputFolder {
 281     /// Creates a new output folder with the given group name.
 282     pub fn new(name: String) -> OutputFolder {
 283         // "\r" moves the cursor to the beginning of the line, and "\x1b[0K" is
 284         // the ANSI escape code to clear from the cursor to end of line.
 285         // Travis seems to have trouble when _not_ using "\r\x1b[0K", that will
 286         // randomly put lines to the top of the webpage.
 287         print!("travis_fold:start:{0}\r\x1b[0Ktravis_time:start:{0}\r\x1b[0K", name);
 288         OutputFolder {
 289             name,
 290             start_time: SystemTime::now(),
 291         }
 292     }
 293 }
 294
 295 impl Drop for OutputFolder {
 296     fn drop(&mut self) {
 297         use std::time::*;
 298         use std::u64;
 299
 300         fn to_nanos(duration: Result<Duration, SystemTimeError>) -> u64 {
 301             match duration {
 302                 Ok(d) => d.as_secs() * 1_000_000_000 + d.subsec_nanos() as u64,
 303                 Err(_) => u64::MAX,
 304             }
 305         }
 306
 307         let end_time = SystemTime::now();
 308         let duration = end_time.duration_since(self.start_time);
 309         let start = self.start_time.duration_since(UNIX_EPOCH);
 310         let finish = end_time.duration_since(UNIX_EPOCH);
 311         println!(
 312             "travis_fold:end:{0}\r\x1b[0K\n\
 313                 travis_time:end:{0}:start={1},finish={2},duration={3}\r\x1b[0K",
 314             self.name,
 315             to_nanos(start),
 316             to_nanos(finish),
 317             to_nanos(duration)
 318         );
 319         io::stdout().flush().unwrap();
 320     }
 321 }
 322
 323 /// The CI environment rustbuild is running in. This mainly affects how the logs
 324 /// are printed.
 325 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
 326 pub enum CiEnv {
 327     /// Not a CI environment.
 328     None,
 329     /// The Travis CI environment, for Linux (including Docker) and macOS builds.
 330     Travis,
 331     /// The AppVeyor environment, for Windows builds.
 332     AppVeyor,
 333 }
 334
 335 impl CiEnv {
 336     /// Obtains the current CI environment.
 337     pub fn current() -> CiEnv {
 338         if env::var("TRAVIS").ok().map_or(false, |e| &*e == "true") {
 339             CiEnv::Travis
 340         } else if env::var("APPVEYOR").ok().map_or(false, |e| &*e == "True") {
 341             CiEnv::AppVeyor
 342         } else {
 343             CiEnv::None
 344         }
 345     }
 346
 347     /// If in a CI environment, forces the command to run with colors.
 348     pub fn force_coloring_in_ci(self, cmd: &mut Command) {
 349         if self != CiEnv::None {
 350             // Due to use of stamp/docker, the output stream of rustbuild is not
 351             // a TTY in CI, so coloring is by-default turned off.
 352             // The explicit `TERM=xterm` environment is needed for
 353             // `--color always` to actually work. This env var was lost when
 354             // compiling through the Makefile. Very strange.
 355             cmd.env("TERM", "xterm").args(&["--color", "always"]);
 356         }
 357     }
 358 }