src/tools/compiletest/src/runtest.rs

   1 // ignore-tidy-filelength
   2
   3 use crate::common::{expected_output_path, UI_EXTENSIONS, UI_FIXED, UI_STDERR, UI_STDOUT};
   4 use crate::common::{output_base_dir, output_base_name, output_testname_unique};
   5 use crate::common::{Assembly, Incremental, JsDocTest, MirOpt, RunMake, Ui};
   6 use crate::common::{Codegen, CodegenUnits, DebugInfo, Debugger, Rustdoc};
   7 use crate::common::{CompareMode, FailMode, PassMode};
   8 use crate::common::{CompileFail, Pretty, RunFail, RunPassValgrind};
   9 use crate::common::{Config, TestPaths};
  10 use crate::common::{UI_RUN_STDERR, UI_RUN_STDOUT};
  11 use crate::errors::{self, Error, ErrorKind};
  12 use crate::header::TestProps;
  13 use crate::json;
  14 use crate::util::get_pointer_width;
  15 use crate::util::{logv, PathBufExt};
  16 use regex::{Captures, Regex};
  17 use rustfix::{apply_suggestions, get_suggestions_from_json, Filter};
  18
  19 use std::collections::hash_map::DefaultHasher;
  20 use std::collections::{HashMap, HashSet, VecDeque};
  21 use std::env;
  22 use std::ffi::{OsStr, OsString};
  23 use std::fs::{self, create_dir_all, File, OpenOptions};
  24 use std::hash::{Hash, Hasher};
  25 use std::io::prelude::*;
  26 use std::io::{self, BufReader};
  27 use std::path::{Path, PathBuf};
  28 use std::process::{Child, Command, ExitStatus, Output, Stdio};
  29 use std::str;
  30
  31 use glob::glob;
  32 use lazy_static::lazy_static;
  33 use tracing::*;
  34
  35 use crate::extract_gdb_version;
  36 use crate::is_android_gdb_target;
  37
  38 #[cfg(test)]
  39 mod tests;
  40
  41 #[cfg(windows)]
  42 fn disable_error_reporting<F: FnOnce() -> R, R>(f: F) -> R {
  43     use std::sync::Mutex;
  44     use winapi::um::errhandlingapi::SetErrorMode;
  45     use winapi::um::winbase::SEM_NOGPFAULTERRORBOX;
  46
  47     lazy_static! {
  48         static ref LOCK: Mutex<()> = Mutex::new(());
  49     }
  50     // Error mode is a global variable, so lock it so only one thread will change it
  51     let _lock = LOCK.lock().unwrap();
  52
  53     // Tell Windows to not show any UI on errors (such as terminating abnormally).
  54     // This is important for running tests, since some of them use abnormal
  55     // termination by design. This mode is inherited by all child processes.
  56     unsafe {
  57         let old_mode = SetErrorMode(SEM_NOGPFAULTERRORBOX); // read inherited flags
  58         SetErrorMode(old_mode | SEM_NOGPFAULTERRORBOX);
  59         let r = f();
  60         SetErrorMode(old_mode);
  61         r
  62     }
  63 }
  64
  65 #[cfg(not(windows))]
  66 fn disable_error_reporting<F: FnOnce() -> R, R>(f: F) -> R {
  67     f()
  68 }
  69
  70 /// The name of the environment variable that holds dynamic library locations.
  71 pub fn dylib_env_var() -> &'static str {
  72     if cfg!(windows) {
  73         "PATH"
  74     } else if cfg!(target_os = "macos") {
  75         "DYLD_LIBRARY_PATH"
  76     } else if cfg!(target_os = "haiku") {
  77         "LIBRARY_PATH"
  78     } else {
  79         "LD_LIBRARY_PATH"
  80     }
  81 }
  82
  83 /// The platform-specific library name
  84 pub fn get_lib_name(lib: &str, dylib: bool) -> String {
  85     // In some casess (e.g. MUSL), we build a static
  86     // library, rather than a dynamic library.
  87     // In this case, the only path we can pass
  88     // with '--extern-meta' is the '.lib' file
  89     if !dylib {
  90         return format!("lib{}.rlib", lib);
  91     }
  92
  93     if cfg!(windows) {
  94         format!("{}.dll", lib)
  95     } else if cfg!(target_os = "macos") {
  96         format!("lib{}.dylib", lib)
  97     } else {
  98         format!("lib{}.so", lib)
  99     }
 100 }
 101
 102 #[derive(Debug, PartialEq)]
 103 pub enum DiffLine {
 104     Context(String),
 105     Expected(String),
 106     Resulting(String),
 107 }
 108
 109 #[derive(Debug, PartialEq)]
 110 pub struct Mismatch {
 111     pub line_number: u32,
 112     pub lines: Vec<DiffLine>,
 113 }
 114
 115 impl Mismatch {
 116     fn new(line_number: u32) -> Mismatch {
 117         Mismatch { line_number, lines: Vec::new() }
 118     }
 119 }
 120
 121 // Produces a diff between the expected output and actual output.
 122 pub fn make_diff(expected: &str, actual: &str, context_size: usize) -> Vec<Mismatch> {
 123     let mut line_number = 1;
 124     let mut context_queue: VecDeque<&str> = VecDeque::with_capacity(context_size);
 125     let mut lines_since_mismatch = context_size + 1;
 126     let mut results = Vec::new();
 127     let mut mismatch = Mismatch::new(0);
 128
 129     for result in diff::lines(expected, actual) {
 130         match result {
 131             diff::Result::Left(str) => {
 132                 if lines_since_mismatch >= context_size && lines_since_mismatch > 0 {
 133                     results.push(mismatch);
 134                     mismatch = Mismatch::new(line_number - context_queue.len() as u32);
 135                 }
 136
 137                 while let Some(line) = context_queue.pop_front() {
 138                     mismatch.lines.push(DiffLine::Context(line.to_owned()));
 139                 }
 140
 141                 mismatch.lines.push(DiffLine::Expected(str.to_owned()));
 142                 line_number += 1;
 143                 lines_since_mismatch = 0;
 144             }
 145             diff::Result::Right(str) => {
 146                 if lines_since_mismatch >= context_size && lines_since_mismatch > 0 {
 147                     results.push(mismatch);
 148                     mismatch = Mismatch::new(line_number - context_queue.len() as u32);
 149                 }
 150
 151                 while let Some(line) = context_queue.pop_front() {
 152                     mismatch.lines.push(DiffLine::Context(line.to_owned()));
 153                 }
 154
 155                 mismatch.lines.push(DiffLine::Resulting(str.to_owned()));
 156                 lines_since_mismatch = 0;
 157             }
 158             diff::Result::Both(str, _) => {
 159                 if context_queue.len() >= context_size {
 160                     let _ = context_queue.pop_front();
 161                 }
 162
 163                 if lines_since_mismatch < context_size {
 164                     mismatch.lines.push(DiffLine::Context(str.to_owned()));
 165                 } else if context_size > 0 {
 166                     context_queue.push_back(str);
 167                 }
 168
 169                 line_number += 1;
 170                 lines_since_mismatch += 1;
 171             }
 172         }
 173     }
 174
 175     results.push(mismatch);
 176     results.remove(0);
 177
 178     results
 179 }
 180
 181 fn write_diff(expected: &str, actual: &str, context_size: usize) -> String {
 182     use std::fmt::Write;
 183     let mut output = String::new();
 184     let diff_results = make_diff(expected, actual, context_size);
 185     for result in diff_results {
 186         let mut line_number = result.line_number;
 187         for line in result.lines {
 188             match line {
 189                 DiffLine::Expected(e) => {
 190                     writeln!(output, "-\t{}", e).unwrap();
 191                     line_number += 1;
 192                 }
 193                 DiffLine::Context(c) => {
 194                     writeln!(output, "{}\t{}", line_number, c).unwrap();
 195                     line_number += 1;
 196                 }
 197                 DiffLine::Resulting(r) => {
 198                     writeln!(output, "+\t{}", r).unwrap();
 199                 }
 200             }
 201         }
 202         writeln!(output).unwrap();
 203     }
 204     output
 205 }
 206
 207 pub fn run(config: Config, testpaths: &TestPaths, revision: Option<&str>) {
 208     match &*config.target {
 209         "arm-linux-androideabi"
 210         | "armv7-linux-androideabi"
 211         | "thumbv7neon-linux-androideabi"
 212         | "aarch64-linux-android" => {
 213             if !config.adb_device_status {
 214                 panic!("android device not available");
 215             }
 216         }
 217
 218         _ => {
 219             // android has its own gdb handling
 220             if config.debugger == Some(Debugger::Gdb) && config.gdb.is_none() {
 221                 panic!("gdb not available but debuginfo gdb debuginfo test requested");
 222             }
 223         }
 224     }
 225
 226     if config.verbose {
 227         // We're going to be dumping a lot of info. Start on a new line.
 228         print!("\n\n");
 229     }
 230     debug!("running {:?}", testpaths.file.display());
 231     let props = TestProps::from_file(&testpaths.file, revision, &config);
 232
 233     let cx = TestCx { config: &config, props: &props, testpaths, revision };
 234     create_dir_all(&cx.output_base_dir()).unwrap();
 235
 236     if config.mode == Incremental {
 237         // Incremental tests are special because they cannot be run in
 238         // parallel.
 239         assert!(!props.revisions.is_empty(), "Incremental tests require revisions.");
 240         cx.init_incremental_test();
 241         for revision in &props.revisions {
 242             let revision_props = TestProps::from_file(&testpaths.file, Some(revision), &config);
 243             let rev_cx = TestCx {
 244                 config: &config,
 245                 props: &revision_props,
 246                 testpaths,
 247                 revision: Some(revision),
 248             };
 249             rev_cx.run_revision();
 250         }
 251     } else {
 252         cx.run_revision();
 253     }
 254
 255     cx.create_stamp();
 256 }
 257
 258 pub fn compute_stamp_hash(config: &Config) -> String {
 259     let mut hash = DefaultHasher::new();
 260     config.stage_id.hash(&mut hash);
 261
 262     match config.debugger {
 263         Some(Debugger::Cdb) => {
 264             config.cdb.hash(&mut hash);
 265         }
 266
 267         Some(Debugger::Gdb) => {
 268             config.gdb.hash(&mut hash);
 269             env::var_os("PATH").hash(&mut hash);
 270             env::var_os("PYTHONPATH").hash(&mut hash);
 271         }
 272
 273         Some(Debugger::Lldb) => {
 274             config.lldb_python.hash(&mut hash);
 275             config.lldb_python_dir.hash(&mut hash);
 276             env::var_os("PATH").hash(&mut hash);
 277             env::var_os("PYTHONPATH").hash(&mut hash);
 278         }
 279
 280         None => {}
 281     }
 282
 283     if let Ui = config.mode {
 284         config.force_pass_mode.hash(&mut hash);
 285     }
 286
 287     format!("{:x}", hash.finish())
 288 }
 289
 290 struct TestCx<'test> {
 291     config: &'test Config,
 292     props: &'test TestProps,
 293     testpaths: &'test TestPaths,
 294     revision: Option<&'test str>,
 295 }
 296
 297 struct DebuggerCommands {
 298     commands: Vec<String>,
 299     check_lines: Vec<String>,
 300     breakpoint_lines: Vec<usize>,
 301 }
 302
 303 enum ReadFrom {
 304     Path,
 305     Stdin(String),
 306 }
 307
 308 enum TestOutput {
 309     Compile,
 310     Run,
 311 }
 312
 313 /// Will this test be executed? Should we use `make_exe_name`?
 314 #[derive(Copy, Clone, PartialEq)]
 315 enum WillExecute {
 316     Yes,
 317     No,
 318 }
 319
 320 /// Should `--emit metadata` be used?
 321 #[derive(Copy, Clone)]
 322 enum EmitMetadata {
 323     Yes,
 324     No,
 325 }
 326
 327 impl<'test> TestCx<'test> {
 328     /// Code executed for each revision in turn (or, if there are no
 329     /// revisions, exactly once, with revision == None).
 330     fn run_revision(&self) {
 331         if self.props.should_ice {
 332             if self.config.mode != CompileFail && self.config.mode != Incremental {
 333                 self.fatal("cannot use should-ice in a test that is not cfail");
 334             }
 335         }
 336         match self.config.mode {
 337             CompileFail => self.run_cfail_test(),
 338             RunFail => self.run_rfail_test(),
 339             RunPassValgrind => self.run_valgrind_test(),
 340             Pretty => self.run_pretty_test(),
 341             DebugInfo => self.run_debuginfo_test(),
 342             Codegen => self.run_codegen_test(),
 343             Rustdoc => self.run_rustdoc_test(),
 344             CodegenUnits => self.run_codegen_units_test(),
 345             Incremental => self.run_incremental_test(),
 346             RunMake => self.run_rmake_test(),
 347             Ui => self.run_ui_test(),
 348             MirOpt => self.run_mir_opt_test(),
 349             Assembly => self.run_assembly_test(),
 350             JsDocTest => self.run_js_doc_test(),
 351         }
 352     }
 353
 354     fn pass_mode(&self) -> Option<PassMode> {
 355         self.props.pass_mode(self.config)
 356     }
 357
 358     fn should_run(&self, pm: Option<PassMode>) -> WillExecute {
 359         match self.config.mode {
 360             Ui if pm == Some(PassMode::Run) || self.props.fail_mode == Some(FailMode::Run) => {
 361                 WillExecute::Yes
 362             }
 363             MirOpt if pm == Some(PassMode::Run) => WillExecute::Yes,
 364             Ui | MirOpt => WillExecute::No,
 365             mode => panic!("unimplemented for mode {:?}", mode),
 366         }
 367     }
 368
 369     fn should_run_successfully(&self, pm: Option<PassMode>) -> bool {
 370         match self.config.mode {
 371             Ui | MirOpt => pm == Some(PassMode::Run),
 372             mode => panic!("unimplemented for mode {:?}", mode),
 373         }
 374     }
 375
 376     fn should_compile_successfully(&self, pm: Option<PassMode>) -> bool {
 377         match self.config.mode {
 378             CompileFail => false,
 379             JsDocTest => true,
 380             Ui => pm.is_some() || self.props.fail_mode > Some(FailMode::Build),
 381             Incremental => {
 382                 let revision =
 383                     self.revision.expect("incremental tests require a list of revisions");
 384                 if revision.starts_with("rpass") || revision.starts_with("rfail") {
 385                     true
 386                 } else if revision.starts_with("cfail") {
 387                     // FIXME: would be nice if incremental revs could start with "cpass"
 388                     pm.is_some()
 389                 } else {
 390                     panic!("revision name must begin with rpass, rfail, or cfail");
 391                 }
 392             }
 393             mode => panic!("unimplemented for mode {:?}", mode),
 394         }
 395     }
 396
 397     fn check_if_test_should_compile(&self, proc_res: &ProcRes, pm: Option<PassMode>) {
 398         if self.should_compile_successfully(pm) {
 399             if !proc_res.status.success() {
 400                 self.fatal_proc_rec("test compilation failed although it shouldn't!", proc_res);
 401             }
 402         } else {
 403             if proc_res.status.success() {
 404                 self.fatal_proc_rec(
 405                     &format!("{} test compiled successfully!", self.config.mode)[..],
 406                     proc_res,
 407                 );
 408             }
 409
 410             self.check_correct_failure_status(proc_res);
 411         }
 412     }
 413
 414     fn run_cfail_test(&self) {
 415         let pm = self.pass_mode();
 416         let proc_res = self.compile_test(WillExecute::No, self.should_emit_metadata(pm));
 417         self.check_if_test_should_compile(&proc_res, pm);
 418         self.check_no_compiler_crash(&proc_res, self.props.should_ice);
 419
 420         let output_to_check = self.get_output(&proc_res);
 421         let expected_errors = errors::load_errors(&self.testpaths.file, self.revision);
 422         if !expected_errors.is_empty() {
 423             if !self.props.error_patterns.is_empty() {
 424                 self.fatal("both error pattern and expected errors specified");
 425             }
 426             self.check_expected_errors(expected_errors, &proc_res);
 427         } else {
 428             self.check_error_patterns(&output_to_check, &proc_res, pm);
 429         }
 430         if self.props.should_ice {
 431             match proc_res.status.code() {
 432                 Some(101) => (),
 433                 _ => self.fatal("expected ICE"),
 434             }
 435         }
 436
 437         self.check_forbid_output(&output_to_check, &proc_res);
 438     }
 439
 440     fn run_rfail_test(&self) {
 441         let pm = self.pass_mode();
 442         let proc_res = self.compile_test(WillExecute::Yes, self.should_emit_metadata(pm));
 443
 444         if !proc_res.status.success() {
 445             self.fatal_proc_rec("compilation failed!", &proc_res);
 446         }
 447
 448         let proc_res = self.exec_compiled_test();
 449
 450         // The value our Makefile configures valgrind to return on failure
 451         const VALGRIND_ERR: i32 = 100;
 452         if proc_res.status.code() == Some(VALGRIND_ERR) {
 453             self.fatal_proc_rec("run-fail test isn't valgrind-clean!", &proc_res);
 454         }
 455
 456         let output_to_check = self.get_output(&proc_res);
 457         self.check_correct_failure_status(&proc_res);
 458         self.check_error_patterns(&output_to_check, &proc_res, pm);
 459     }
 460
 461     fn get_output(&self, proc_res: &ProcRes) -> String {
 462         if self.props.check_stdout {
 463             format!("{}{}", proc_res.stdout, proc_res.stderr)
 464         } else {
 465             proc_res.stderr.clone()
 466         }
 467     }
 468
 469     fn check_correct_failure_status(&self, proc_res: &ProcRes) {
 470         let expected_status = Some(self.props.failure_status);
 471         let received_status = proc_res.status.code();
 472
 473         if expected_status != received_status {
 474             self.fatal_proc_rec(
 475                 &format!(
 476                     "Error: expected failure status ({:?}) but received status {:?}.",
 477                     expected_status, received_status
 478                 ),
 479                 proc_res,
 480             );
 481         }
 482     }
 483
 484     fn run_rpass_test(&self) {
 485         let emit_metadata = self.should_emit_metadata(self.pass_mode());
 486         let proc_res = self.compile_test(WillExecute::Yes, emit_metadata);
 487
 488         if !proc_res.status.success() {
 489             self.fatal_proc_rec("compilation failed!", &proc_res);
 490         }
 491
 492         // FIXME(#41968): Move this check to tidy?
 493         let expected_errors = errors::load_errors(&self.testpaths.file, self.revision);
 494         assert!(
 495             expected_errors.is_empty(),
 496             "run-pass tests with expected warnings should be moved to ui/"
 497         );
 498
 499         let proc_res = self.exec_compiled_test();
 500         if !proc_res.status.success() {
 501             self.fatal_proc_rec("test run failed!", &proc_res);
 502         }
 503     }
 504
 505     fn run_valgrind_test(&self) {
 506         assert!(self.revision.is_none(), "revisions not relevant here");
 507
 508         if self.config.valgrind_path.is_none() {
 509             assert!(!self.config.force_valgrind);
 510             return self.run_rpass_test();
 511         }
 512
 513         let mut proc_res = self.compile_test(WillExecute::Yes, EmitMetadata::No);
 514
 515         if !proc_res.status.success() {
 516             self.fatal_proc_rec("compilation failed!", &proc_res);
 517         }
 518
 519         let mut new_config = self.config.clone();
 520         new_config.runtool = new_config.valgrind_path.clone();
 521         let new_cx = TestCx { config: &new_config, ..*self };
 522         proc_res = new_cx.exec_compiled_test();
 523
 524         if !proc_res.status.success() {
 525             self.fatal_proc_rec("test run failed!", &proc_res);
 526         }
 527     }
 528
 529     fn run_pretty_test(&self) {
 530         if self.props.pp_exact.is_some() {
 531             logv(self.config, "testing for exact pretty-printing".to_owned());
 532         } else {
 533             logv(self.config, "testing for converging pretty-printing".to_owned());
 534         }
 535
 536         let rounds = match self.props.pp_exact {
 537             Some(_) => 1,
 538             None => 2,
 539         };
 540
 541         let src = fs::read_to_string(&self.testpaths.file).unwrap();
 542         let mut srcs = vec![src];
 543
 544         let mut round = 0;
 545         while round < rounds {
 546             logv(
 547                 self.config,
 548                 format!("pretty-printing round {} revision {:?}", round, self.revision),
 549             );
 550             let read_from =
 551                 if round == 0 { ReadFrom::Path } else { ReadFrom::Stdin(srcs[round].to_owned()) };
 552
 553             let proc_res = self.print_source(read_from, &self.props.pretty_mode);
 554             if !proc_res.status.success() {
 555                 self.fatal_proc_rec(
 556                     &format!(
 557                         "pretty-printing failed in round {} revision {:?}",
 558                         round, self.revision
 559                     ),
 560                     &proc_res,
 561                 );
 562             }
 563
 564             let ProcRes { stdout, .. } = proc_res;
 565             srcs.push(stdout);
 566             round += 1;
 567         }
 568
 569         let mut expected = match self.props.pp_exact {
 570             Some(ref file) => {
 571                 let filepath = self.testpaths.file.parent().unwrap().join(file);
 572                 fs::read_to_string(&filepath).unwrap()
 573             }
 574             None => srcs[srcs.len() - 2].clone(),
 575         };
 576         let mut actual = srcs[srcs.len() - 1].clone();
 577
 578         if self.props.pp_exact.is_some() {
 579             // Now we have to care about line endings
 580             let cr = "\r".to_owned();
 581             actual = actual.replace(&cr, "");
 582             expected = expected.replace(&cr, "");
 583         }
 584
 585         self.compare_source(&expected, &actual);
 586
 587         // If we're only making sure that the output matches then just stop here
 588         if self.props.pretty_compare_only {
 589             return;
 590         }
 591
 592         // Finally, let's make sure it actually appears to remain valid code
 593         let proc_res = self.typecheck_source(actual);
 594         if !proc_res.status.success() {
 595             self.fatal_proc_rec("pretty-printed source does not typecheck", &proc_res);
 596         }
 597
 598         if !self.props.pretty_expanded {
 599             return;
 600         }
 601
 602         // additionally, run `--pretty expanded` and try to build it.
 603         let proc_res = self.print_source(ReadFrom::Path, "expanded");
 604         if !proc_res.status.success() {
 605             self.fatal_proc_rec("pretty-printing (expanded) failed", &proc_res);
 606         }
 607
 608         let ProcRes { stdout: expanded_src, .. } = proc_res;
 609         let proc_res = self.typecheck_source(expanded_src);
 610         if !proc_res.status.success() {
 611             self.fatal_proc_rec("pretty-printed source (expanded) does not typecheck", &proc_res);
 612         }
 613     }
 614
 615     fn print_source(&self, read_from: ReadFrom, pretty_type: &str) -> ProcRes {
 616         let aux_dir = self.aux_output_dir_name();
 617         let input: &str = match read_from {
 618             ReadFrom::Stdin(_) => "-",
 619             ReadFrom::Path => self.testpaths.file.to_str().unwrap(),
 620         };
 621
 622         let mut rustc = Command::new(&self.config.rustc_path);
 623         rustc
 624             .arg(input)
 625             .args(&["-Z", &format!("unpretty={}", pretty_type)])
 626             .args(&["--target", &self.config.target])
 627             .arg("-L")
 628             .arg(&aux_dir)
 629             .args(&self.props.compile_flags)
 630             .envs(self.props.rustc_env.clone());
 631         self.maybe_add_external_args(
 632             &mut rustc,
 633             self.split_maybe_args(&self.config.target_rustcflags),
 634         );
 635
 636         let src = match read_from {
 637             ReadFrom::Stdin(src) => Some(src),
 638             ReadFrom::Path => None,
 639         };
 640
 641         self.compose_and_run(
 642             rustc,
 643             self.config.compile_lib_path.to_str().unwrap(),
 644             Some(aux_dir.to_str().unwrap()),
 645             src,
 646         )
 647     }
 648
 649     fn compare_source(&self, expected: &str, actual: &str) {
 650         if expected != actual {
 651             self.fatal(&format!(
 652                 "pretty-printed source does not match expected source\n\
 653                  expected:\n\
 654                  ------------------------------------------\n\
 655                  {}\n\
 656                  ------------------------------------------\n\
 657                  actual:\n\
 658                  ------------------------------------------\n\
 659                  {}\n\
 660                  ------------------------------------------\n\
 661                  diff:\n\
 662                  ------------------------------------------\n\
 663                  {}\n",
 664                 expected,
 665                 actual,
 666                 write_diff(expected, actual, 3),
 667             ));
 668         }
 669     }
 670
 671     fn set_revision_flags(&self, cmd: &mut Command) {
 672         if let Some(revision) = self.revision {
 673             // Normalize revisions to be lowercase and replace `-`s with `_`s.
 674             // Otherwise the `--cfg` flag is not valid.
 675             let normalized_revision = revision.to_lowercase().replace("-", "_");
 676             cmd.args(&["--cfg", &normalized_revision]);
 677         }
 678     }
 679
 680     fn typecheck_source(&self, src: String) -> ProcRes {
 681         let mut rustc = Command::new(&self.config.rustc_path);
 682
 683         let out_dir = self.output_base_name().with_extension("pretty-out");
 684         let _ = fs::remove_dir_all(&out_dir);
 685         create_dir_all(&out_dir).unwrap();
 686
 687         let target = if self.props.force_host { &*self.config.host } else { &*self.config.target };
 688
 689         let aux_dir = self.aux_output_dir_name();
 690
 691         rustc
 692             .arg("-")
 693             .arg("-Zno-codegen")
 694             .arg("--out-dir")
 695             .arg(&out_dir)
 696             .arg(&format!("--target={}", target))
 697             .arg("-L")
 698             .arg(&self.config.build_base)
 699             .arg("-L")
 700             .arg(aux_dir);
 701         self.set_revision_flags(&mut rustc);
 702         self.maybe_add_external_args(
 703             &mut rustc,
 704             self.split_maybe_args(&self.config.target_rustcflags),
 705         );
 706         rustc.args(&self.props.compile_flags);
 707
 708         self.compose_and_run_compiler(rustc, Some(src))
 709     }
 710
 711     fn run_debuginfo_test(&self) {
 712         match self.config.debugger.unwrap() {
 713             Debugger::Cdb => self.run_debuginfo_cdb_test(),
 714             Debugger::Gdb => self.run_debuginfo_gdb_test(),
 715             Debugger::Lldb => self.run_debuginfo_lldb_test(),
 716         }
 717     }
 718
 719     fn run_debuginfo_cdb_test(&self) {
 720         assert!(self.revision.is_none(), "revisions not relevant here");
 721
 722         let config = Config {
 723             target_rustcflags: self.cleanup_debug_info_options(&self.config.target_rustcflags),
 724             host_rustcflags: self.cleanup_debug_info_options(&self.config.host_rustcflags),
 725             ..self.config.clone()
 726         };
 727
 728         let test_cx = TestCx { config: &config, ..*self };
 729
 730         test_cx.run_debuginfo_cdb_test_no_opt();
 731     }
 732
 733     fn run_debuginfo_cdb_test_no_opt(&self) {
 734         // compile test file (it should have 'compile-flags:-g' in the header)
 735         let compile_result = self.compile_test(WillExecute::Yes, EmitMetadata::No);
 736         if !compile_result.status.success() {
 737             self.fatal_proc_rec("compilation failed!", &compile_result);
 738         }
 739
 740         let exe_file = self.make_exe_name();
 741
 742         let prefixes = {
 743             static PREFIXES: &[&str] = &["cdb", "cdbg"];
 744             // No "native rust support" variation for CDB yet.
 745             PREFIXES
 746         };
 747
 748         // Parse debugger commands etc from test files
 749         let DebuggerCommands { commands, check_lines, breakpoint_lines, .. } =
 750             self.parse_debugger_commands(prefixes);
 751
 752         // https://docs.microsoft.com/en-us/windows-hardware/drivers/debugger/debugger-commands
 753         let mut script_str = String::with_capacity(2048);
 754         script_str.push_str("version\n"); // List CDB (and more) version info in test output
 755         script_str.push_str(".nvlist\n"); // List loaded `*.natvis` files, bulk of custom MSVC debug
 756
 757         // Set breakpoints on every line that contains the string "#break"
 758         let source_file_name = self.testpaths.file.file_name().unwrap().to_string_lossy();
 759         for line in &breakpoint_lines {
 760             script_str.push_str(&format!("bp `{}:{}`\n", source_file_name, line));
 761         }
 762
 763         // Append the other `cdb-command:`s
 764         for line in &commands {
 765             script_str.push_str(line);
 766             script_str.push_str("\n");
 767         }
 768
 769         script_str.push_str("\nqq\n"); // Quit the debugger (including remote debugger, if any)
 770
 771         // Write the script into a file
 772         debug!("script_str = {}", script_str);
 773         self.dump_output_file(&script_str, "debugger.script");
 774         let debugger_script = self.make_out_name("debugger.script");
 775
 776         let cdb_path = &self.config.cdb.as_ref().unwrap();
 777         let mut cdb = Command::new(cdb_path);
 778         cdb.arg("-lines") // Enable source line debugging.
 779             .arg("-cf")
 780             .arg(&debugger_script)
 781             .arg(&exe_file);
 782
 783         let debugger_run_result = self.compose_and_run(
 784             cdb,
 785             self.config.run_lib_path.to_str().unwrap(),
 786             None, // aux_path
 787             None, // input
 788         );
 789
 790         if !debugger_run_result.status.success() {
 791             self.fatal_proc_rec("Error while running CDB", &debugger_run_result);
 792         }
 793
 794         self.check_debugger_output(&debugger_run_result, &check_lines);
 795     }
 796
 797     fn run_debuginfo_gdb_test(&self) {
 798         assert!(self.revision.is_none(), "revisions not relevant here");
 799
 800         let config = Config {
 801             target_rustcflags: self.cleanup_debug_info_options(&self.config.target_rustcflags),
 802             host_rustcflags: self.cleanup_debug_info_options(&self.config.host_rustcflags),
 803             ..self.config.clone()
 804         };
 805
 806         let test_cx = TestCx { config: &config, ..*self };
 807
 808         test_cx.run_debuginfo_gdb_test_no_opt();
 809     }
 810
 811     fn run_debuginfo_gdb_test_no_opt(&self) {
 812         let prefixes = if self.config.gdb_native_rust {
 813             // GDB with Rust
 814             static PREFIXES: &[&str] = &["gdb", "gdbr"];
 815             println!("NOTE: compiletest thinks it is using GDB with native rust support");
 816             PREFIXES
 817         } else {
 818             // Generic GDB
 819             static PREFIXES: &[&str] = &["gdb", "gdbg"];
 820             println!("NOTE: compiletest thinks it is using GDB without native rust support");
 821             PREFIXES
 822         };
 823
 824         let DebuggerCommands { commands, check_lines, breakpoint_lines } =
 825             self.parse_debugger_commands(prefixes);
 826         let mut cmds = commands.join("\n");
 827
 828         // compile test file (it should have 'compile-flags:-g' in the header)
 829         let compiler_run_result = self.compile_test(WillExecute::Yes, EmitMetadata::No);
 830         if !compiler_run_result.status.success() {
 831             self.fatal_proc_rec("compilation failed!", &compiler_run_result);
 832         }
 833
 834         let exe_file = self.make_exe_name();
 835
 836         let debugger_run_result;
 837         if is_android_gdb_target(&self.config.target) {
 838             cmds = cmds.replace("run", "continue");
 839
 840             let tool_path = match self.config.android_cross_path.to_str() {
 841                 Some(x) => x.to_owned(),
 842                 None => self.fatal("cannot find android cross path"),
 843             };
 844
 845             // write debugger script
 846             let mut script_str = String::with_capacity(2048);
 847             script_str.push_str(&format!("set charset {}\n", Self::charset()));
 848             script_str.push_str(&format!("set sysroot {}\n", tool_path));
 849             script_str.push_str(&format!("file {}\n", exe_file.to_str().unwrap()));
 850             script_str.push_str("target remote :5039\n");
 851             script_str.push_str(&format!(
 852                 "set solib-search-path \
 853                  ./{}/stage2/lib/rustlib/{}/lib/\n",
 854                 self.config.host, self.config.target
 855             ));
 856             for line in &breakpoint_lines {
 857                 script_str.push_str(
 858                     &format!(
 859                         "break {:?}:{}\n",
 860                         self.testpaths.file.file_name().unwrap().to_string_lossy(),
 861                         *line
 862                     )[..],
 863                 );
 864             }
 865             script_str.push_str(&cmds);
 866             script_str.push_str("\nquit\n");
 867
 868             debug!("script_str = {}", script_str);
 869             self.dump_output_file(&script_str, "debugger.script");
 870
 871             let adb_path = &self.config.adb_path;
 872
 873             Command::new(adb_path)
 874                 .arg("push")
 875                 .arg(&exe_file)
 876                 .arg(&self.config.adb_test_dir)
 877                 .status()
 878                 .unwrap_or_else(|_| panic!("failed to exec `{:?}`", adb_path));
 879
 880             Command::new(adb_path)
 881                 .args(&["forward", "tcp:5039", "tcp:5039"])
 882                 .status()
 883                 .unwrap_or_else(|_| panic!("failed to exec `{:?}`", adb_path));
 884
 885             let adb_arg = format!(
 886                 "export LD_LIBRARY_PATH={}; \
 887                  gdbserver{} :5039 {}/{}",
 888                 self.config.adb_test_dir.clone(),
 889                 if self.config.target.contains("aarch64") { "64" } else { "" },
 890                 self.config.adb_test_dir.clone(),
 891                 exe_file.file_name().unwrap().to_str().unwrap()
 892             );
 893
 894             debug!("adb arg: {}", adb_arg);
 895             let mut adb = Command::new(adb_path)
 896                 .args(&["shell", &adb_arg])
 897                 .stdout(Stdio::piped())
 898                 .stderr(Stdio::inherit())
 899                 .spawn()
 900                 .unwrap_or_else(|_| panic!("failed to exec `{:?}`", adb_path));
 901
 902             // Wait for the gdbserver to print out "Listening on port ..."
 903             // at which point we know that it's started and then we can
 904             // execute the debugger below.
 905             let mut stdout = BufReader::new(adb.stdout.take().unwrap());
 906             let mut line = String::new();
 907             loop {
 908                 line.truncate(0);
 909                 stdout.read_line(&mut line).unwrap();
 910                 if line.starts_with("Listening on port 5039") {
 911                     break;
 912                 }
 913             }
 914             drop(stdout);
 915
 916             let mut debugger_script = OsString::from("-command=");
 917             debugger_script.push(self.make_out_name("debugger.script"));
 918             let debugger_opts: &[&OsStr] =
 919                 &["-quiet".as_ref(), "-batch".as_ref(), "-nx".as_ref(), &debugger_script];
 920
 921             let gdb_path = self.config.gdb.as_ref().unwrap();
 922             let Output { status, stdout, stderr } = Command::new(&gdb_path)
 923                 .args(debugger_opts)
 924                 .output()
 925                 .unwrap_or_else(|_| panic!("failed to exec `{:?}`", gdb_path));
 926             let cmdline = {
 927                 let mut gdb = Command::new(&format!("{}-gdb", self.config.target));
 928                 gdb.args(debugger_opts);
 929                 let cmdline = self.make_cmdline(&gdb, "");
 930                 logv(self.config, format!("executing {}", cmdline));
 931                 cmdline
 932             };
 933
 934             debugger_run_result = ProcRes {
 935                 status,
 936                 stdout: String::from_utf8(stdout).unwrap(),
 937                 stderr: String::from_utf8(stderr).unwrap(),
 938                 cmdline,
 939             };
 940             if adb.kill().is_err() {
 941                 println!("Adb process is already finished.");
 942             }
 943         } else {
 944             let rust_src_root =
 945                 self.config.find_rust_src_root().expect("Could not find Rust source root");
 946             let rust_pp_module_rel_path = Path::new("./src/etc");
 947             let rust_pp_module_abs_path =
 948                 rust_src_root.join(rust_pp_module_rel_path).to_str().unwrap().to_owned();
 949             // write debugger script
 950             let mut script_str = String::with_capacity(2048);
 951             script_str.push_str(&format!("set charset {}\n", Self::charset()));
 952             script_str.push_str("show version\n");
 953
 954             match self.config.gdb_version {
 955                 Some(version) => {
 956                     println!("NOTE: compiletest thinks it is using GDB version {}", version);
 957
 958                     if version > extract_gdb_version("7.4").unwrap() {
 959                         // Add the directory containing the pretty printers to
 960                         // GDB's script auto loading safe path
 961                         script_str.push_str(&format!(
 962                             "add-auto-load-safe-path {}\n",
 963                             rust_pp_module_abs_path.replace(r"\", r"\\")
 964                         ));
 965                     }
 966                 }
 967                 _ => {
 968                     println!(
 969                         "NOTE: compiletest does not know which version of \
 970                          GDB it is using"
 971                     );
 972                 }
 973             }
 974
 975             // The following line actually doesn't have to do anything with
 976             // pretty printing, it just tells GDB to print values on one line:
 977             script_str.push_str("set print pretty off\n");
 978
 979             // Add the pretty printer directory to GDB's source-file search path
 980             script_str.push_str(&format!("directory {}\n", rust_pp_module_abs_path));
 981
 982             // Load the target executable
 983             script_str
 984                 .push_str(&format!("file {}\n", exe_file.to_str().unwrap().replace(r"\", r"\\")));
 985
 986             // Force GDB to print values in the Rust format.
 987             if self.config.gdb_native_rust {
 988                 script_str.push_str("set language rust\n");
 989             }
 990
 991             // Add line breakpoints
 992             for line in &breakpoint_lines {
 993                 script_str.push_str(&format!(
 994                     "break '{}':{}\n",
 995                     self.testpaths.file.file_name().unwrap().to_string_lossy(),
 996                     *line
 997                 ));
 998             }
 999
1000             script_str.push_str(&cmds);
1001             script_str.push_str("\nquit\n");
1002
1003             debug!("script_str = {}", script_str);
1004             self.dump_output_file(&script_str, "debugger.script");
1005
1006             let mut debugger_script = OsString::from("-command=");
1007             debugger_script.push(self.make_out_name("debugger.script"));
1008
1009             let debugger_opts: &[&OsStr] =
1010                 &["-quiet".as_ref(), "-batch".as_ref(), "-nx".as_ref(), &debugger_script];
1011
1012             let mut gdb = Command::new(self.config.gdb.as_ref().unwrap());
1013             gdb.args(debugger_opts).env("PYTHONPATH", rust_pp_module_abs_path);
1014
1015             debugger_run_result =
1016                 self.compose_and_run(gdb, self.config.run_lib_path.to_str().unwrap(), None, None);
1017         }
1018
1019         if !debugger_run_result.status.success() {
1020             self.fatal_proc_rec("gdb failed to execute", &debugger_run_result);
1021         }
1022
1023         self.check_debugger_output(&debugger_run_result, &check_lines);
1024     }
1025
1026     fn run_debuginfo_lldb_test(&self) {
1027         assert!(self.revision.is_none(), "revisions not relevant here");
1028
1029         if self.config.lldb_python_dir.is_none() {
1030             self.fatal("Can't run LLDB test because LLDB's python path is not set.");
1031         }
1032
1033         let config = Config {
1034             target_rustcflags: self.cleanup_debug_info_options(&self.config.target_rustcflags),
1035             host_rustcflags: self.cleanup_debug_info_options(&self.config.host_rustcflags),
1036             ..self.config.clone()
1037         };
1038
1039         let test_cx = TestCx { config: &config, ..*self };
1040
1041         test_cx.run_debuginfo_lldb_test_no_opt();
1042     }
1043
1044     fn run_debuginfo_lldb_test_no_opt(&self) {
1045         // compile test file (it should have 'compile-flags:-g' in the header)
1046         let compile_result = self.compile_test(WillExecute::Yes, EmitMetadata::No);
1047         if !compile_result.status.success() {
1048             self.fatal_proc_rec("compilation failed!", &compile_result);
1049         }
1050
1051         let exe_file = self.make_exe_name();
1052
1053         match self.config.lldb_version {
1054             Some(ref version) => {
1055                 println!("NOTE: compiletest thinks it is using LLDB version {}", version);
1056             }
1057             _ => {
1058                 println!(
1059                     "NOTE: compiletest does not know which version of \
1060                      LLDB it is using"
1061                 );
1062             }
1063         }
1064
1065         let prefixes = if self.config.lldb_native_rust {
1066             static PREFIXES: &[&str] = &["lldb", "lldbr"];
1067             println!("NOTE: compiletest thinks it is using LLDB with native rust support");
1068             PREFIXES
1069         } else {
1070             static PREFIXES: &[&str] = &["lldb", "lldbg"];
1071             println!("NOTE: compiletest thinks it is using LLDB without native rust support");
1072             PREFIXES
1073         };
1074
1075         // Parse debugger commands etc from test files
1076         let DebuggerCommands { commands, check_lines, breakpoint_lines, .. } =
1077             self.parse_debugger_commands(prefixes);
1078
1079         // Write debugger script:
1080         // We don't want to hang when calling `quit` while the process is still running
1081         let mut script_str = String::from("settings set auto-confirm true\n");
1082
1083         // Make LLDB emit its version, so we have it documented in the test output
1084         script_str.push_str("version\n");
1085
1086         // Switch LLDB into "Rust mode"
1087         let rust_src_root =
1088             self.config.find_rust_src_root().expect("Could not find Rust source root");
1089         let rust_pp_module_rel_path = Path::new("./src/etc/lldb_lookup.py");
1090         let rust_pp_module_abs_path =
1091             rust_src_root.join(rust_pp_module_rel_path).to_str().unwrap().to_owned();
1092
1093         let rust_type_regexes = vec![
1094             "^(alloc::([a-z_]+::)+)String$",
1095             "^&str$",
1096             "^&\\[.+\\]$",
1097             "^(std::ffi::([a-z_]+::)+)OsString$",
1098             "^(alloc::([a-z_]+::)+)Vec<.+>$",
1099             "^(alloc::([a-z_]+::)+)VecDeque<.+>$",
1100             "^(alloc::([a-z_]+::)+)BTreeSet<.+>$",
1101             "^(alloc::([a-z_]+::)+)BTreeMap<.+>$",
1102             "^(std::collections::([a-z_]+::)+)HashMap<.+>$",
1103             "^(std::collections::([a-z_]+::)+)HashSet<.+>$",
1104             "^(alloc::([a-z_]+::)+)Rc<.+>$",
1105             "^(alloc::([a-z_]+::)+)Arc<.+>$",
1106             "^(core::([a-z_]+::)+)Cell<.+>$",
1107             "^(core::([a-z_]+::)+)Ref<.+>$",
1108             "^(core::([a-z_]+::)+)RefMut<.+>$",
1109             "^(core::([a-z_]+::)+)RefCell<.+>$",
1110         ];
1111
1112         script_str
1113             .push_str(&format!("command script import {}\n", &rust_pp_module_abs_path[..])[..]);
1114         script_str.push_str("type synthetic add -l lldb_lookup.synthetic_lookup -x '.*' ");
1115         script_str.push_str("--category Rust\n");
1116         for type_regex in rust_type_regexes {
1117             script_str.push_str("type summary add -F lldb_lookup.summary_lookup  -e -x -h ");
1118             script_str.push_str(&format!("'{}' ", type_regex));
1119             script_str.push_str("--category Rust\n");
1120         }
1121         script_str.push_str("type category enable Rust\n");
1122
1123         // Set breakpoints on every line that contains the string "#break"
1124         let source_file_name = self.testpaths.file.file_name().unwrap().to_string_lossy();
1125         for line in &breakpoint_lines {
1126             script_str.push_str(&format!(
1127                 "breakpoint set --file '{}' --line {}\n",
1128                 source_file_name, line
1129             ));
1130         }
1131
1132         // Append the other commands
1133         for line in &commands {
1134             script_str.push_str(line);
1135             script_str.push_str("\n");
1136         }
1137
1138         // Finally, quit the debugger
1139         script_str.push_str("\nquit\n");
1140
1141         // Write the script into a file
1142         debug!("script_str = {}", script_str);
1143         self.dump_output_file(&script_str, "debugger.script");
1144         let debugger_script = self.make_out_name("debugger.script");
1145
1146         // Let LLDB execute the script via lldb_batchmode.py
1147         let debugger_run_result = self.run_lldb(&exe_file, &debugger_script, &rust_src_root);
1148
1149         if !debugger_run_result.status.success() {
1150             self.fatal_proc_rec("Error while running LLDB", &debugger_run_result);
1151         }
1152
1153         self.check_debugger_output(&debugger_run_result, &check_lines);
1154     }
1155
1156     fn run_lldb(
1157         &self,
1158         test_executable: &Path,
1159         debugger_script: &Path,
1160         rust_src_root: &Path,
1161     ) -> ProcRes {
1162         // Prepare the lldb_batchmode which executes the debugger script
1163         let lldb_script_path = rust_src_root.join("src/etc/lldb_batchmode.py");
1164         self.cmd2procres(
1165             Command::new(&self.config.lldb_python)
1166                 .arg(&lldb_script_path)
1167                 .arg(test_executable)
1168                 .arg(debugger_script)
1169                 .env("PYTHONPATH", self.config.lldb_python_dir.as_ref().unwrap()),
1170         )
1171     }
1172
1173     fn cmd2procres(&self, cmd: &mut Command) -> ProcRes {
1174         let (status, out, err) = match cmd.output() {
1175             Ok(Output { status, stdout, stderr }) => {
1176                 (status, String::from_utf8(stdout).unwrap(), String::from_utf8(stderr).unwrap())
1177             }
1178             Err(e) => self.fatal(&format!(
1179                 "Failed to setup Python process for \
1180                  LLDB script: {}",
1181                 e
1182             )),
1183         };
1184
1185         self.dump_output(&out, &err);
1186         ProcRes { status, stdout: out, stderr: err, cmdline: format!("{:?}", cmd) }
1187     }
1188
1189     fn parse_debugger_commands(&self, debugger_prefixes: &[&str]) -> DebuggerCommands {
1190         let directives = debugger_prefixes
1191             .iter()
1192             .map(|prefix| (format!("{}-command", prefix), format!("{}-check", prefix)))
1193             .collect::<Vec<_>>();
1194
1195         let mut breakpoint_lines = vec![];
1196         let mut commands = vec![];
1197         let mut check_lines = vec![];
1198         let mut counter = 1;
1199         let reader = BufReader::new(File::open(&self.testpaths.file).unwrap());
1200         for line in reader.lines() {
1201             match line {
1202                 Ok(line) => {
1203                     let line =
1204                         if line.starts_with("//") { line[2..].trim_start() } else { line.as_str() };
1205
1206                     if line.contains("#break") {
1207                         breakpoint_lines.push(counter);
1208                     }
1209
1210                     for &(ref command_directive, ref check_directive) in &directives {
1211                         self.config
1212                             .parse_name_value_directive(&line, command_directive)
1213                             .map(|cmd| commands.push(cmd));
1214
1215                         self.config
1216                             .parse_name_value_directive(&line, check_directive)
1217                             .map(|cmd| check_lines.push(cmd));
1218                     }
1219                 }
1220                 Err(e) => self.fatal(&format!("Error while parsing debugger commands: {}", e)),
1221             }
1222             counter += 1;
1223         }
1224
1225         DebuggerCommands { commands, check_lines, breakpoint_lines }
1226     }
1227
1228     fn cleanup_debug_info_options(&self, options: &Option<String>) -> Option<String> {
1229         if options.is_none() {
1230             return None;
1231         }
1232
1233         // Remove options that are either unwanted (-O) or may lead to duplicates due to RUSTFLAGS.
1234         let options_to_remove = ["-O".to_owned(), "-g".to_owned(), "--debuginfo".to_owned()];
1235         let new_options = self
1236             .split_maybe_args(options)
1237             .into_iter()
1238             .filter(|x| !options_to_remove.contains(x))
1239             .collect::<Vec<String>>();
1240
1241         Some(new_options.join(" "))
1242     }
1243
1244     fn maybe_add_external_args(&self, cmd: &mut Command, args: Vec<String>) {
1245         // Filter out the arguments that should not be added by runtest here.
1246         //
1247         // Notable use-cases are: do not add our optimisation flag if
1248         // `compile-flags: -Copt-level=x` and similar for debug-info level as well.
1249         const OPT_FLAGS: &[&str] = &["-O", "-Copt-level=", /*-C<space>*/ "opt-level="];
1250         const DEBUG_FLAGS: &[&str] = &["-g", "-Cdebuginfo=", /*-C<space>*/ "debuginfo="];
1251
1252         // FIXME: ideally we would "just" check the `cmd` itself, but it does not allow inspecting
1253         // its arguments. They need to be collected separately. For now I cannot be bothered to
1254         // implement this the "right" way.
1255         let have_opt_flag =
1256             self.props.compile_flags.iter().any(|arg| OPT_FLAGS.iter().any(|f| arg.starts_with(f)));
1257         let have_debug_flag = self
1258             .props
1259             .compile_flags
1260             .iter()
1261             .any(|arg| DEBUG_FLAGS.iter().any(|f| arg.starts_with(f)));
1262
1263         for arg in args {
1264             if OPT_FLAGS.iter().any(|f| arg.starts_with(f)) && have_opt_flag {
1265                 continue;
1266             }
1267             if DEBUG_FLAGS.iter().any(|f| arg.starts_with(f)) && have_debug_flag {
1268                 continue;
1269             }
1270             cmd.arg(arg);
1271         }
1272     }
1273
1274     fn check_debugger_output(&self, debugger_run_result: &ProcRes, check_lines: &[String]) {
1275         let num_check_lines = check_lines.len();
1276
1277         let mut check_line_index = 0;
1278         for line in debugger_run_result.stdout.lines() {
1279             if check_line_index >= num_check_lines {
1280                 break;
1281             }
1282
1283             if check_single_line(line, &(check_lines[check_line_index])[..]) {
1284                 check_line_index += 1;
1285             }
1286         }
1287         if check_line_index != num_check_lines && num_check_lines > 0 {
1288             self.fatal_proc_rec(
1289                 &format!("line not found in debugger output: {}", check_lines[check_line_index]),
1290                 debugger_run_result,
1291             );
1292         }
1293
1294         fn check_single_line(line: &str, check_line: &str) -> bool {
1295             // Allow check lines to leave parts unspecified (e.g., uninitialized
1296             // bits in the  wrong case of an enum) with the notation "[...]".
1297             let line = line.trim();
1298             let check_line = check_line.trim();
1299             let can_start_anywhere = check_line.starts_with("[...]");
1300             let can_end_anywhere = check_line.ends_with("[...]");
1301
1302             let check_fragments: Vec<&str> =
1303                 check_line.split("[...]").filter(|frag| !frag.is_empty()).collect();
1304             if check_fragments.is_empty() {
1305                 return true;
1306             }
1307
1308             let (mut rest, first_fragment) = if can_start_anywhere {
1309                 match line.find(check_fragments[0]) {
1310                     Some(pos) => (&line[pos + check_fragments[0].len()..], 1),
1311                     None => return false,
1312                 }
1313             } else {
1314                 (line, 0)
1315             };
1316
1317             for current_fragment in &check_fragments[first_fragment..] {
1318                 match rest.find(current_fragment) {
1319                     Some(pos) => {
1320                         rest = &rest[pos + current_fragment.len()..];
1321                     }
1322                     None => return false,
1323                 }
1324             }
1325
1326             if !can_end_anywhere && !rest.is_empty() {
1327                 return false;
1328             }
1329
1330             true
1331         }
1332     }
1333
1334     fn check_error_patterns(
1335         &self,
1336         output_to_check: &str,
1337         proc_res: &ProcRes,
1338         pm: Option<PassMode>,
1339     ) {
1340         debug!("check_error_patterns");
1341         if self.props.error_patterns.is_empty() {
1342             if pm.is_some() {
1343                 // FIXME(#65865)
1344                 return;
1345             } else {
1346                 self.fatal(&format!(
1347                     "no error pattern specified in {:?}",
1348                     self.testpaths.file.display()
1349                 ));
1350             }
1351         }
1352
1353         let mut missing_patterns: Vec<String> = Vec::new();
1354
1355         for pattern in &self.props.error_patterns {
1356             if output_to_check.contains(pattern.trim()) {
1357                 debug!("found error pattern {}", pattern);
1358             } else {
1359                 missing_patterns.push(pattern.to_string());
1360             }
1361         }
1362
1363         if missing_patterns.is_empty() {
1364             return;
1365         }
1366
1367         if missing_patterns.len() == 1 {
1368             self.fatal_proc_rec(
1369                 &format!("error pattern '{}' not found!", missing_patterns[0]),
1370                 proc_res,
1371             );
1372         } else {
1373             for pattern in missing_patterns {
1374                 self.error(&format!("error pattern '{}' not found!", pattern));
1375             }
1376             self.fatal_proc_rec("multiple error patterns not found", proc_res);
1377         }
1378     }
1379
1380     fn check_no_compiler_crash(&self, proc_res: &ProcRes, should_ice: bool) {
1381         match proc_res.status.code() {
1382             Some(101) if !should_ice => {
1383                 self.fatal_proc_rec("compiler encountered internal error", proc_res)
1384             }
1385             None => self.fatal_proc_rec("compiler terminated by signal", proc_res),
1386             _ => (),
1387         }
1388     }
1389
1390     fn check_forbid_output(&self, output_to_check: &str, proc_res: &ProcRes) {
1391         for pat in &self.props.forbid_output {
1392             if output_to_check.contains(pat) {
1393                 self.fatal_proc_rec("forbidden pattern found in compiler output", proc_res);
1394             }
1395         }
1396     }
1397
1398     fn check_expected_errors(&self, expected_errors: Vec<errors::Error>, proc_res: &ProcRes) {
1399         debug!(
1400             "check_expected_errors: expected_errors={:?} proc_res.status={:?}",
1401             expected_errors, proc_res.status
1402         );
1403         if proc_res.status.success()
1404             && expected_errors.iter().any(|x| x.kind == Some(ErrorKind::Error))
1405         {
1406             self.fatal_proc_rec("process did not return an error status", proc_res);
1407         }
1408
1409         // On Windows, keep all '\' path separators to match the paths reported in the JSON output
1410         // from the compiler
1411         let os_file_name = self.testpaths.file.display().to_string();
1412
1413         // on windows, translate all '\' path separators to '/'
1414         let file_name = format!("{}", self.testpaths.file.display()).replace(r"\", "/");
1415
1416         // If the testcase being checked contains at least one expected "help"
1417         // message, then we'll ensure that all "help" messages are expected.
1418         // Otherwise, all "help" messages reported by the compiler will be ignored.
1419         // This logic also applies to "note" messages.
1420         let expect_help = expected_errors.iter().any(|ee| ee.kind == Some(ErrorKind::Help));
1421         let expect_note = expected_errors.iter().any(|ee| ee.kind == Some(ErrorKind::Note));
1422
1423         // Parse the JSON output from the compiler and extract out the messages.
1424         let actual_errors = json::parse_output(&os_file_name, &proc_res.stderr, proc_res);
1425         let mut unexpected = Vec::new();
1426         let mut found = vec![false; expected_errors.len()];
1427         for actual_error in &actual_errors {
1428             let opt_index =
1429                 expected_errors.iter().enumerate().position(|(index, expected_error)| {
1430                     !found[index]
1431                         && actual_error.line_num == expected_error.line_num
1432                         && (expected_error.kind.is_none()
1433                             || actual_error.kind == expected_error.kind)
1434                         && actual_error.msg.contains(&expected_error.msg)
1435                 });
1436
1437             match opt_index {
1438                 Some(index) => {
1439                     // found a match, everybody is happy
1440                     assert!(!found[index]);
1441                     found[index] = true;
1442                 }
1443
1444                 None => {
1445                     if self.is_unexpected_compiler_message(actual_error, expect_help, expect_note) {
1446                         self.error(&format!(
1447                             "{}:{}: unexpected {}: '{}'",
1448                             file_name,
1449                             actual_error.line_num,
1450                             actual_error
1451                                 .kind
1452                                 .as_ref()
1453                                 .map_or(String::from("message"), |k| k.to_string()),
1454                             actual_error.msg
1455                         ));
1456                         unexpected.push(actual_error);
1457                     }
1458                 }
1459             }
1460         }
1461
1462         let mut not_found = Vec::new();
1463         // anything not yet found is a problem
1464         for (index, expected_error) in expected_errors.iter().enumerate() {
1465             if !found[index] {
1466                 self.error(&format!(
1467                     "{}:{}: expected {} not found: {}",
1468                     file_name,
1469                     expected_error.line_num,
1470                     expected_error.kind.as_ref().map_or("message".into(), |k| k.to_string()),
1471                     expected_error.msg
1472                 ));
1473                 not_found.push(expected_error);
1474             }
1475         }
1476
1477         if !unexpected.is_empty() || !not_found.is_empty() {
1478             self.error(&format!(
1479                 "{} unexpected errors found, {} expected errors not found",
1480                 unexpected.len(),
1481                 not_found.len()
1482             ));
1483             println!("status: {}\ncommand: {}", proc_res.status, proc_res.cmdline);
1484             if !unexpected.is_empty() {
1485                 println!("unexpected errors (from JSON output): {:#?}\n", unexpected);
1486             }
1487             if !not_found.is_empty() {
1488                 println!("not found errors (from test file): {:#?}\n", not_found);
1489             }
1490             panic!();
1491         }
1492     }
1493
1494     /// Returns `true` if we should report an error about `actual_error`,
1495     /// which did not match any of the expected error. We always require
1496     /// errors/warnings to be explicitly listed, but only require
1497     /// helps/notes if there are explicit helps/notes given.
1498     fn is_unexpected_compiler_message(
1499         &self,
1500         actual_error: &Error,
1501         expect_help: bool,
1502         expect_note: bool,
1503     ) -> bool {
1504         match actual_error.kind {
1505             Some(ErrorKind::Help) => expect_help,
1506             Some(ErrorKind::Note) => expect_note,
1507             Some(ErrorKind::Error) | Some(ErrorKind::Warning) => true,
1508             Some(ErrorKind::Suggestion) | None => false,
1509         }
1510     }
1511
1512     fn should_emit_metadata(&self, pm: Option<PassMode>) -> EmitMetadata {
1513         match (pm, self.props.fail_mode, self.config.mode) {
1514             (Some(PassMode::Check), ..) | (_, Some(FailMode::Check), Ui) => EmitMetadata::Yes,
1515             _ => EmitMetadata::No,
1516         }
1517     }
1518
1519     fn compile_test(&self, will_execute: WillExecute, emit_metadata: EmitMetadata) -> ProcRes {
1520         self.compile_test_general(will_execute, emit_metadata, self.props.local_pass_mode())
1521     }
1522
1523     fn compile_test_general(
1524         &self,
1525         will_execute: WillExecute,
1526         emit_metadata: EmitMetadata,
1527         local_pm: Option<PassMode>,
1528     ) -> ProcRes {
1529         // Only use `make_exe_name` when the test ends up being executed.
1530         let output_file = match will_execute {
1531             WillExecute::Yes => TargetLocation::ThisFile(self.make_exe_name()),
1532             WillExecute::No => TargetLocation::ThisDirectory(self.output_base_dir()),
1533         };
1534
1535         let allow_unused = match self.config.mode {
1536             CompileFail | Ui => {
1537                 // compile-fail and ui tests tend to have tons of unused code as
1538                 // it's just testing various pieces of the compile, but we don't
1539                 // want to actually assert warnings about all this code. Instead
1540                 // let's just ignore unused code warnings by defaults and tests
1541                 // can turn it back on if needed.
1542                 if !self.is_rustdoc()
1543                     // Note that we use the local pass mode here as we don't want
1544                     // to set unused to allow if we've overridden the pass mode
1545                     // via command line flags.
1546                     && local_pm != Some(PassMode::Run)
1547                 {
1548                     AllowUnused::Yes
1549                 } else {
1550                     AllowUnused::No
1551                 }
1552             }
1553             _ => AllowUnused::No,
1554         };
1555
1556         let mut rustc =
1557             self.make_compile_args(&self.testpaths.file, output_file, emit_metadata, allow_unused);
1558
1559         rustc.arg("-L").arg(&self.aux_output_dir_name());
1560
1561         self.compose_and_run_compiler(rustc, None)
1562     }
1563
1564     fn document(&self, out_dir: &Path) -> ProcRes {
1565         if self.props.build_aux_docs {
1566             for rel_ab in &self.props.aux_builds {
1567                 let aux_testpaths = self.compute_aux_test_paths(rel_ab);
1568                 let aux_props =
1569                     self.props.from_aux_file(&aux_testpaths.file, self.revision, self.config);
1570                 let aux_cx = TestCx {
1571                     config: self.config,
1572                     props: &aux_props,
1573                     testpaths: &aux_testpaths,
1574                     revision: self.revision,
1575                 };
1576                 // Create the directory for the stdout/stderr files.
1577                 create_dir_all(aux_cx.output_base_dir()).unwrap();
1578                 let auxres = aux_cx.document(out_dir);
1579                 if !auxres.status.success() {
1580                     return auxres;
1581                 }
1582             }
1583         }
1584
1585         let aux_dir = self.aux_output_dir_name();
1586
1587         let rustdoc_path = self.config.rustdoc_path.as_ref().expect("--rustdoc-path passed");
1588         let mut rustdoc = Command::new(rustdoc_path);
1589
1590         rustdoc
1591             .arg("-L")
1592             .arg(self.config.run_lib_path.to_str().unwrap())
1593             .arg("-L")
1594             .arg(aux_dir)
1595             .arg("-o")
1596             .arg(out_dir)
1597             .arg(&self.testpaths.file)
1598             .args(&self.props.compile_flags);
1599
1600         if let Some(ref linker) = self.config.linker {
1601             rustdoc.arg(format!("-Clinker={}", linker));
1602         }
1603
1604         self.compose_and_run_compiler(rustdoc, None)
1605     }
1606
1607     fn exec_compiled_test(&self) -> ProcRes {
1608         let env = &self.props.exec_env;
1609
1610         let proc_res = match &*self.config.target {
1611             // This is pretty similar to below, we're transforming:
1612             //
1613             //      program arg1 arg2
1614             //
1615             // into
1616             //
1617             //      remote-test-client run program 2 support-lib.so support-lib2.so arg1 arg2
1618             //
1619             // The test-client program will upload `program` to the emulator
1620             // along with all other support libraries listed (in this case
1621             // `support-lib.so` and `support-lib2.so`. It will then execute
1622             // the program on the emulator with the arguments specified
1623             // (in the environment we give the process) and then report back
1624             // the same result.
1625             _ if self.config.remote_test_client.is_some() => {
1626                 let aux_dir = self.aux_output_dir_name();
1627                 let ProcArgs { prog, args } = self.make_run_args();
1628                 let mut support_libs = Vec::new();
1629                 if let Ok(entries) = aux_dir.read_dir() {
1630                     for entry in entries {
1631                         let entry = entry.unwrap();
1632                         if !entry.path().is_file() {
1633                             continue;
1634                         }
1635                         support_libs.push(entry.path());
1636                     }
1637                 }
1638                 let mut test_client =
1639                     Command::new(self.config.remote_test_client.as_ref().unwrap());
1640                 test_client
1641                     .args(&["run", &support_libs.len().to_string(), &prog])
1642                     .args(support_libs)
1643                     .args(args)
1644                     .envs(env.clone());
1645                 self.compose_and_run(
1646                     test_client,
1647                     self.config.run_lib_path.to_str().unwrap(),
1648                     Some(aux_dir.to_str().unwrap()),
1649                     None,
1650                 )
1651             }
1652             _ if self.config.target.contains("vxworks") => {
1653                 let aux_dir = self.aux_output_dir_name();
1654                 let ProcArgs { prog, args } = self.make_run_args();
1655                 let mut wr_run = Command::new("wr-run");
1656                 wr_run.args(&[&prog]).args(args).envs(env.clone());
1657                 self.compose_and_run(
1658                     wr_run,
1659                     self.config.run_lib_path.to_str().unwrap(),
1660                     Some(aux_dir.to_str().unwrap()),
1661                     None,
1662                 )
1663             }
1664             _ => {
1665                 let aux_dir = self.aux_output_dir_name();
1666                 let ProcArgs { prog, args } = self.make_run_args();
1667                 let mut program = Command::new(&prog);
1668                 program.args(args).current_dir(&self.output_base_dir()).envs(env.clone());
1669                 self.compose_and_run(
1670                     program,
1671                     self.config.run_lib_path.to_str().unwrap(),
1672                     Some(aux_dir.to_str().unwrap()),
1673                     None,
1674                 )
1675             }
1676         };
1677
1678         if proc_res.status.success() {
1679             // delete the executable after running it to save space.
1680             // it is ok if the deletion failed.
1681             let _ = fs::remove_file(self.make_exe_name());
1682         }
1683
1684         proc_res
1685     }
1686
1687     /// For each `aux-build: foo/bar` annotation, we check to find the
1688     /// file in a `auxiliary` directory relative to the test itself.
1689     fn compute_aux_test_paths(&self, rel_ab: &str) -> TestPaths {
1690         let test_ab = self
1691             .testpaths
1692             .file
1693             .parent()
1694             .expect("test file path has no parent")
1695             .join("auxiliary")
1696             .join(rel_ab);
1697         if !test_ab.exists() {
1698             self.fatal(&format!("aux-build `{}` source not found", test_ab.display()))
1699         }
1700
1701         TestPaths {
1702             file: test_ab,
1703             relative_dir: self
1704                 .testpaths
1705                 .relative_dir
1706                 .join(self.output_testname_unique())
1707                 .join("auxiliary")
1708                 .join(rel_ab)
1709                 .parent()
1710                 .expect("aux-build path has no parent")
1711                 .to_path_buf(),
1712         }
1713     }
1714
1715     fn is_vxworks_pure_static(&self) -> bool {
1716         if self.config.target.contains("vxworks") {
1717             match env::var("RUST_VXWORKS_TEST_DYLINK") {
1718                 Ok(s) => s != "1",
1719                 _ => true,
1720             }
1721         } else {
1722             false
1723         }
1724     }
1725
1726     fn is_vxworks_pure_dynamic(&self) -> bool {
1727         self.config.target.contains("vxworks") && !self.is_vxworks_pure_static()
1728     }
1729
1730     fn compose_and_run_compiler(&self, mut rustc: Command, input: Option<String>) -> ProcRes {
1731         let aux_dir = self.aux_output_dir_name();
1732
1733         if !self.props.aux_builds.is_empty() {
1734             let _ = fs::remove_dir_all(&aux_dir);
1735             create_dir_all(&aux_dir).unwrap();
1736         }
1737
1738         for rel_ab in &self.props.aux_builds {
1739             self.build_auxiliary(rel_ab, &aux_dir);
1740         }
1741
1742         for (aux_name, aux_path) in &self.props.aux_crates {
1743             let is_dylib = self.build_auxiliary(&aux_path, &aux_dir);
1744             let lib_name =
1745                 get_lib_name(&aux_path.trim_end_matches(".rs").replace('-', "_"), is_dylib);
1746             rustc.arg("--extern").arg(format!("{}={}/{}", aux_name, aux_dir.display(), lib_name));
1747         }
1748
1749         self.props.unset_rustc_env.clone().iter().fold(&mut rustc, |rustc, v| rustc.env_remove(v));
1750         rustc.envs(self.props.rustc_env.clone());
1751         self.compose_and_run(
1752             rustc,
1753             self.config.compile_lib_path.to_str().unwrap(),
1754             Some(aux_dir.to_str().unwrap()),
1755             input,
1756         )
1757     }
1758
1759     /// Builds an aux dependency.
1760     ///
1761     /// Returns whether or not it is a dylib.
1762     fn build_auxiliary(&self, source_path: &str, aux_dir: &Path) -> bool {
1763         let aux_testpaths = self.compute_aux_test_paths(source_path);
1764         let aux_props = self.props.from_aux_file(&aux_testpaths.file, self.revision, self.config);
1765         let aux_output = TargetLocation::ThisDirectory(self.aux_output_dir_name());
1766         let aux_cx = TestCx {
1767             config: self.config,
1768             props: &aux_props,
1769             testpaths: &aux_testpaths,
1770             revision: self.revision,
1771         };
1772         // Create the directory for the stdout/stderr files.
1773         create_dir_all(aux_cx.output_base_dir()).unwrap();
1774         let input_file = &aux_testpaths.file;
1775         let mut aux_rustc =
1776             aux_cx.make_compile_args(input_file, aux_output, EmitMetadata::No, AllowUnused::No);
1777
1778         for key in &aux_props.unset_rustc_env {
1779             aux_rustc.env_remove(key);
1780         }
1781         aux_rustc.envs(aux_props.rustc_env.clone());
1782
1783         let (dylib, crate_type) = if aux_props.no_prefer_dynamic {
1784             (true, None)
1785         } else if self.config.target.contains("cloudabi")
1786             || self.config.target.contains("emscripten")
1787             || (self.config.target.contains("musl")
1788                 && !aux_props.force_host
1789                 && !self.config.host.contains("musl"))
1790             || self.config.target.contains("wasm32")
1791             || self.config.target.contains("nvptx")
1792             || self.is_vxworks_pure_static()
1793             || self.config.target.contains("sgx")
1794         {
1795             // We primarily compile all auxiliary libraries as dynamic libraries
1796             // to avoid code size bloat and large binaries as much as possible
1797             // for the test suite (otherwise including libstd statically in all
1798             // executables takes up quite a bit of space).
1799             //
1800             // For targets like MUSL or Emscripten, however, there is no support for
1801             // dynamic libraries so we just go back to building a normal library. Note,
1802             // however, that for MUSL if the library is built with `force_host` then
1803             // it's ok to be a dylib as the host should always support dylibs.
1804             (false, Some("lib"))
1805         } else {
1806             (true, Some("dylib"))
1807         };
1808
1809         if let Some(crate_type) = crate_type {
1810             aux_rustc.args(&["--crate-type", crate_type]);
1811         }
1812
1813         aux_rustc.arg("-L").arg(&aux_dir);
1814
1815         let auxres = aux_cx.compose_and_run(
1816             aux_rustc,
1817             aux_cx.config.compile_lib_path.to_str().unwrap(),
1818             Some(aux_dir.to_str().unwrap()),
1819             None,
1820         );
1821         if !auxres.status.success() {
1822             self.fatal_proc_rec(
1823                 &format!(
1824                     "auxiliary build of {:?} failed to compile: ",
1825                     aux_testpaths.file.display()
1826                 ),
1827                 &auxres,
1828             );
1829         }
1830         dylib
1831     }
1832
1833     fn compose_and_run(
1834         &self,
1835         mut command: Command,
1836         lib_path: &str,
1837         aux_path: Option<&str>,
1838         input: Option<String>,
1839     ) -> ProcRes {
1840         let cmdline = {
1841             let cmdline = self.make_cmdline(&command, lib_path);
1842             logv(self.config, format!("executing {}", cmdline));
1843             cmdline
1844         };
1845
1846         command.stdout(Stdio::piped()).stderr(Stdio::piped()).stdin(Stdio::piped());
1847
1848         // Need to be sure to put both the lib_path and the aux path in the dylib
1849         // search path for the child.
1850         let mut path =
1851             env::split_paths(&env::var_os(dylib_env_var()).unwrap_or_default()).collect::<Vec<_>>();
1852         if let Some(p) = aux_path {
1853             path.insert(0, PathBuf::from(p))
1854         }
1855         path.insert(0, PathBuf::from(lib_path));
1856
1857         // Add the new dylib search path var
1858         let newpath = env::join_paths(&path).unwrap();
1859         command.env(dylib_env_var(), newpath);
1860
1861         let mut child = disable_error_reporting(|| command.spawn())
1862             .unwrap_or_else(|_| panic!("failed to exec `{:?}`", &command));
1863         if let Some(input) = input {
1864             child.stdin.as_mut().unwrap().write_all(input.as_bytes()).unwrap();
1865         }
1866
1867         let Output { status, stdout, stderr } =
1868             read2_abbreviated(child).expect("failed to read output");
1869
1870         let result = ProcRes {
1871             status,
1872             stdout: String::from_utf8_lossy(&stdout).into_owned(),
1873             stderr: String::from_utf8_lossy(&stderr).into_owned(),
1874             cmdline,
1875         };
1876
1877         self.dump_output(&result.stdout, &result.stderr);
1878
1879         result
1880     }
1881
1882     fn is_rustdoc(&self) -> bool {
1883         self.config.src_base.ends_with("rustdoc-ui") || self.config.src_base.ends_with("rustdoc-js")
1884     }
1885
1886     fn make_compile_args(
1887         &self,
1888         input_file: &Path,
1889         output_file: TargetLocation,
1890         emit_metadata: EmitMetadata,
1891         allow_unused: AllowUnused,
1892     ) -> Command {
1893         let is_aux = input_file.components().map(|c| c.as_os_str()).any(|c| c == "auxiliary");
1894         let is_rustdoc = self.is_rustdoc() && !is_aux;
1895         let mut rustc = if !is_rustdoc {
1896             Command::new(&self.config.rustc_path)
1897         } else {
1898             Command::new(&self.config.rustdoc_path.clone().expect("no rustdoc built yet"))
1899         };
1900         // FIXME Why is -L here?
1901         rustc.arg(input_file); //.arg("-L").arg(&self.config.build_base);
1902
1903         // Use a single thread for efficiency and a deterministic error message order
1904         rustc.arg("-Zthreads=1");
1905
1906         // Optionally prevent default --target if specified in test compile-flags.
1907         let custom_target = self.props.compile_flags.iter().any(|x| x.starts_with("--target"));
1908
1909         if !custom_target {
1910             let target =
1911                 if self.props.force_host { &*self.config.host } else { &*self.config.target };
1912
1913             rustc.arg(&format!("--target={}", target));
1914         }
1915         self.set_revision_flags(&mut rustc);
1916
1917         if !is_rustdoc {
1918             if let Some(ref incremental_dir) = self.props.incremental_dir {
1919                 rustc.args(&["-C", &format!("incremental={}", incremental_dir.display())]);
1920                 rustc.args(&["-Z", "incremental-verify-ich"]);
1921             }
1922
1923             if self.config.mode == CodegenUnits {
1924                 rustc.args(&["-Z", "human_readable_cgu_names"]);
1925             }
1926         }
1927
1928         match self.config.mode {
1929             CompileFail | Incremental => {
1930                 // If we are extracting and matching errors in the new
1931                 // fashion, then you want JSON mode. Old-skool error
1932                 // patterns still match the raw compiler output.
1933                 if self.props.error_patterns.is_empty() {
1934                     rustc.args(&["--error-format", "json"]);
1935                 }
1936                 rustc.arg("-Zui-testing");
1937                 rustc.arg("-Zdeduplicate-diagnostics=no");
1938             }
1939             Ui => {
1940                 if !self.props.compile_flags.iter().any(|s| s.starts_with("--error-format")) {
1941                     rustc.args(&["--error-format", "json"]);
1942                 }
1943                 rustc.arg("-Zui-testing");
1944                 rustc.arg("-Zdeduplicate-diagnostics=no");
1945             }
1946             MirOpt => {
1947                 rustc.args(&[
1948                     "-Zdump-mir=all",
1949                     "-Zmir-opt-level=3",
1950                     "-Zvalidate-mir",
1951                     "-Zdump-mir-exclude-pass-number",
1952                 ]);
1953
1954                 let mir_dump_dir = self.get_mir_dump_dir();
1955                 let _ = fs::remove_dir_all(&mir_dump_dir);
1956                 create_dir_all(mir_dump_dir.as_path()).unwrap();
1957                 let mut dir_opt = "-Zdump-mir-dir=".to_string();
1958                 dir_opt.push_str(mir_dump_dir.to_str().unwrap());
1959                 debug!("dir_opt: {:?}", dir_opt);
1960
1961                 rustc.arg(dir_opt);
1962             }
1963             RunFail | RunPassValgrind | Pretty | DebugInfo | Codegen | Rustdoc | RunMake
1964             | CodegenUnits | JsDocTest | Assembly => {
1965                 // do not use JSON output
1966             }
1967         }
1968
1969         if let (false, EmitMetadata::Yes) = (is_rustdoc, emit_metadata) {
1970             rustc.args(&["--emit", "metadata"]);
1971         }
1972
1973         if !is_rustdoc {
1974             if self.config.target == "wasm32-unknown-unknown" || self.is_vxworks_pure_static() {
1975                 // rustc.arg("-g"); // get any backtrace at all on errors
1976             } else if !self.props.no_prefer_dynamic {
1977                 rustc.args(&["-C", "prefer-dynamic"]);
1978             }
1979         }
1980
1981         match output_file {
1982             TargetLocation::ThisFile(path) => {
1983                 rustc.arg("-o").arg(path);
1984             }
1985             TargetLocation::ThisDirectory(path) => {
1986                 if is_rustdoc {
1987                     // `rustdoc` uses `-o` for the output directory.
1988                     rustc.arg("-o").arg(path);
1989                 } else {
1990                     rustc.arg("--out-dir").arg(path);
1991                 }
1992             }
1993         }
1994
1995         match self.config.compare_mode {
1996             Some(CompareMode::Nll) => {
1997                 rustc.args(&["-Zborrowck=mir"]);
1998             }
1999             Some(CompareMode::Polonius) => {
2000                 rustc.args(&["-Zpolonius", "-Zborrowck=mir"]);
2001             }
2002             Some(CompareMode::Chalk) => {
2003                 rustc.args(&["-Zchalk"]);
2004             }
2005             None => {}
2006         }
2007
2008         // Add `-A unused` before `config` flags and in-test (`props`) flags, so that they can
2009         // overwrite this.
2010         if let AllowUnused::Yes = allow_unused {
2011             rustc.args(&["-A", "unused"]);
2012         }
2013
2014         if self.props.force_host {
2015             self.maybe_add_external_args(
2016                 &mut rustc,
2017                 self.split_maybe_args(&self.config.host_rustcflags),
2018             );
2019         } else {
2020             self.maybe_add_external_args(
2021                 &mut rustc,
2022                 self.split_maybe_args(&self.config.target_rustcflags),
2023             );
2024             if !is_rustdoc {
2025                 if let Some(ref linker) = self.config.linker {
2026                     rustc.arg(format!("-Clinker={}", linker));
2027                 }
2028             }
2029         }
2030
2031         // Use dynamic musl for tests because static doesn't allow creating dylibs
2032         if self.config.host.contains("musl") || self.is_vxworks_pure_dynamic() {
2033             rustc.arg("-Ctarget-feature=-crt-static");
2034         }
2035
2036         rustc.args(&self.props.compile_flags);
2037
2038         rustc
2039     }
2040
2041     fn make_exe_name(&self) -> PathBuf {
2042         // Using a single letter here to keep the path length down for
2043         // Windows.  Some test names get very long.  rustc creates `rcgu`
2044         // files with the module name appended to it which can more than
2045         // double the length.
2046         let mut f = self.output_base_dir().join("a");
2047         // FIXME: This is using the host architecture exe suffix, not target!
2048         if self.config.target.contains("emscripten") {
2049             f = f.with_extra_extension("js");
2050         } else if self.config.target.contains("wasm32") {
2051             f = f.with_extra_extension("wasm");
2052         } else if !env::consts::EXE_SUFFIX.is_empty() {
2053             f = f.with_extra_extension(env::consts::EXE_SUFFIX);
2054         }
2055         f
2056     }
2057
2058     fn make_run_args(&self) -> ProcArgs {
2059         // If we've got another tool to run under (valgrind),
2060         // then split apart its command
2061         let mut args = self.split_maybe_args(&self.config.runtool);
2062
2063         // If this is emscripten, then run tests under nodejs
2064         if self.config.target.contains("emscripten") {
2065             if let Some(ref p) = self.config.nodejs {
2066                 args.push(p.clone());
2067             } else {
2068                 self.fatal("no NodeJS binary found (--nodejs)");
2069             }
2070         // If this is otherwise wasm, then run tests under nodejs with our
2071         // shim
2072         } else if self.config.target.contains("wasm32") {
2073             if let Some(ref p) = self.config.nodejs {
2074                 args.push(p.clone());
2075             } else {
2076                 self.fatal("no NodeJS binary found (--nodejs)");
2077             }
2078
2079             let src = self
2080                 .config
2081                 .src_base
2082                 .parent()
2083                 .unwrap() // chop off `ui`
2084                 .parent()
2085                 .unwrap() // chop off `test`
2086                 .parent()
2087                 .unwrap(); // chop off `src`
2088             args.push(src.join("src/etc/wasm32-shim.js").display().to_string());
2089         }
2090
2091         let exe_file = self.make_exe_name();
2092
2093         // FIXME (#9639): This needs to handle non-utf8 paths
2094         args.push(exe_file.to_str().unwrap().to_owned());
2095
2096         // Add the arguments in the run_flags directive
2097         args.extend(self.split_maybe_args(&self.props.run_flags));
2098
2099         let prog = args.remove(0);
2100         ProcArgs { prog, args }
2101     }
2102
2103     fn split_maybe_args(&self, argstr: &Option<String>) -> Vec<String> {
2104         match *argstr {
2105             Some(ref s) => s
2106                 .split(' ')
2107                 .filter_map(|s| {
2108                     if s.chars().all(|c| c.is_whitespace()) { None } else { Some(s.to_owned()) }
2109                 })
2110                 .collect(),
2111             None => Vec::new(),
2112         }
2113     }
2114
2115     fn make_cmdline(&self, command: &Command, libpath: &str) -> String {
2116         use crate::util;
2117
2118         // Linux and mac don't require adjusting the library search path
2119         if cfg!(unix) {
2120             format!("{:?}", command)
2121         } else {
2122             // Build the LD_LIBRARY_PATH variable as it would be seen on the command line
2123             // for diagnostic purposes
2124             fn lib_path_cmd_prefix(path: &str) -> String {
2125                 format!("{}=\"{}\"", util::lib_path_env_var(), util::make_new_path(path))
2126             }
2127
2128             format!("{} {:?}", lib_path_cmd_prefix(libpath), command)
2129         }
2130     }
2131
2132     fn dump_output(&self, out: &str, err: &str) {
2133         let revision = if let Some(r) = self.revision { format!("{}.", r) } else { String::new() };
2134
2135         self.dump_output_file(out, &format!("{}out", revision));
2136         self.dump_output_file(err, &format!("{}err", revision));
2137         self.maybe_dump_to_stdout(out, err);
2138     }
2139
2140     fn dump_output_file(&self, out: &str, extension: &str) {
2141         let outfile = self.make_out_name(extension);
2142         fs::write(&outfile, out).unwrap();
2143     }
2144
2145     /// Creates a filename for output with the given extension.
2146     /// E.g., `/.../testname.revision.mode/testname.extension`.
2147     fn make_out_name(&self, extension: &str) -> PathBuf {
2148         self.output_base_name().with_extension(extension)
2149     }
2150
2151     /// Gets the directory where auxiliary files are written.
2152     /// E.g., `/.../testname.revision.mode/auxiliary/`.
2153     fn aux_output_dir_name(&self) -> PathBuf {
2154         self.output_base_dir()
2155             .join("auxiliary")
2156             .with_extra_extension(self.config.mode.disambiguator())
2157     }
2158
2159     /// Generates a unique name for the test, such as `testname.revision.mode`.
2160     fn output_testname_unique(&self) -> PathBuf {
2161         output_testname_unique(self.config, self.testpaths, self.safe_revision())
2162     }
2163
2164     /// The revision, ignored for incremental compilation since it wants all revisions in
2165     /// the same directory.
2166     fn safe_revision(&self) -> Option<&str> {
2167         if self.config.mode == Incremental { None } else { self.revision }
2168     }
2169
2170     /// Gets the absolute path to the directory where all output for the given
2171     /// test/revision should reside.
2172     /// E.g., `/path/to/build/host-triple/test/ui/relative/testname.revision.mode/`.
2173     fn output_base_dir(&self) -> PathBuf {
2174         output_base_dir(self.config, self.testpaths, self.safe_revision())
2175     }
2176
2177     /// Gets the absolute path to the base filename used as output for the given
2178     /// test/revision.
2179     /// E.g., `/.../relative/testname.revision.mode/testname`.
2180     fn output_base_name(&self) -> PathBuf {
2181         output_base_name(self.config, self.testpaths, self.safe_revision())
2182     }
2183
2184     fn maybe_dump_to_stdout(&self, out: &str, err: &str) {
2185         if self.config.verbose {
2186             println!("------{}------------------------------", "stdout");
2187             println!("{}", out);
2188             println!("------{}------------------------------", "stderr");
2189             println!("{}", err);
2190             println!("------------------------------------------");
2191         }
2192     }
2193
2194     fn error(&self, err: &str) {
2195         match self.revision {
2196             Some(rev) => println!("\nerror in revision `{}`: {}", rev, err),
2197             None => println!("\nerror: {}", err),
2198         }
2199     }
2200
2201     fn fatal(&self, err: &str) -> ! {
2202         self.error(err);
2203         error!("fatal error, panic: {:?}", err);
2204         panic!("fatal error");
2205     }
2206
2207     fn fatal_proc_rec(&self, err: &str, proc_res: &ProcRes) -> ! {
2208         self.error(err);
2209         proc_res.fatal(None);
2210     }
2211
2212     // codegen tests (using FileCheck)
2213
2214     fn compile_test_and_save_ir(&self) -> ProcRes {
2215         let aux_dir = self.aux_output_dir_name();
2216
2217         let output_file = TargetLocation::ThisDirectory(self.output_base_dir());
2218         let input_file = &self.testpaths.file;
2219         let mut rustc =
2220             self.make_compile_args(input_file, output_file, EmitMetadata::No, AllowUnused::No);
2221         rustc.arg("-L").arg(aux_dir).arg("--emit=llvm-ir");
2222
2223         self.compose_and_run_compiler(rustc, None)
2224     }
2225
2226     fn compile_test_and_save_assembly(&self) -> (ProcRes, PathBuf) {
2227         // This works with both `--emit asm` (as default output name for the assembly)
2228         // and `ptx-linker` because the latter can write output at requested location.
2229         let output_path = self.output_base_name().with_extension("s");
2230
2231         let output_file = TargetLocation::ThisFile(output_path.clone());
2232         let input_file = &self.testpaths.file;
2233         let mut rustc =
2234             self.make_compile_args(input_file, output_file, EmitMetadata::No, AllowUnused::No);
2235
2236         rustc.arg("-L").arg(self.aux_output_dir_name());
2237
2238         match self.props.assembly_output.as_ref().map(AsRef::as_ref) {
2239             Some("emit-asm") => {
2240                 rustc.arg("--emit=asm");
2241             }
2242
2243             Some("ptx-linker") => {
2244                 // No extra flags needed.
2245             }
2246
2247             Some(_) => self.fatal("unknown 'assembly-output' header"),
2248             None => self.fatal("missing 'assembly-output' header"),
2249         }
2250
2251         (self.compose_and_run_compiler(rustc, None), output_path)
2252     }
2253
2254     fn verify_with_filecheck(&self, output: &Path) -> ProcRes {
2255         let mut filecheck = Command::new(self.config.llvm_filecheck.as_ref().unwrap());
2256         filecheck.arg("--input-file").arg(output).arg(&self.testpaths.file);
2257         // It would be more appropriate to make most of the arguments configurable through
2258         // a comment-attribute similar to `compile-flags`. For example, --check-prefixes is a very
2259         // useful flag.
2260         //
2261         // For now, though…
2262         if let Some(rev) = self.revision {
2263             let prefixes = format!("CHECK,{}", rev);
2264             filecheck.args(&["--check-prefixes", &prefixes]);
2265         }
2266         self.compose_and_run(filecheck, "", None, None)
2267     }
2268
2269     fn run_codegen_test(&self) {
2270         if self.config.llvm_filecheck.is_none() {
2271             self.fatal("missing --llvm-filecheck");
2272         }
2273
2274         let proc_res = self.compile_test_and_save_ir();
2275         if !proc_res.status.success() {
2276             self.fatal_proc_rec("compilation failed!", &proc_res);
2277         }
2278
2279         let output_path = self.output_base_name().with_extension("ll");
2280         let proc_res = self.verify_with_filecheck(&output_path);
2281         if !proc_res.status.success() {
2282             self.fatal_proc_rec("verification with 'FileCheck' failed", &proc_res);
2283         }
2284     }
2285
2286     fn run_assembly_test(&self) {
2287         if self.config.llvm_filecheck.is_none() {
2288             self.fatal("missing --llvm-filecheck");
2289         }
2290
2291         let (proc_res, output_path) = self.compile_test_and_save_assembly();
2292         if !proc_res.status.success() {
2293             self.fatal_proc_rec("compilation failed!", &proc_res);
2294         }
2295
2296         let proc_res = self.verify_with_filecheck(&output_path);
2297         if !proc_res.status.success() {
2298             self.fatal_proc_rec("verification with 'FileCheck' failed", &proc_res);
2299         }
2300     }
2301
2302     fn charset() -> &'static str {
2303         // FreeBSD 10.1 defaults to GDB 6.1.1 which doesn't support "auto" charset
2304         if cfg!(target_os = "freebsd") { "ISO-8859-1" } else { "UTF-8" }
2305     }
2306
2307     fn run_rustdoc_test(&self) {
2308         assert!(self.revision.is_none(), "revisions not relevant here");
2309
2310         let out_dir = self.output_base_dir();
2311         let _ = fs::remove_dir_all(&out_dir);
2312         create_dir_all(&out_dir).unwrap();
2313
2314         let proc_res = self.document(&out_dir);
2315         if !proc_res.status.success() {
2316             self.fatal_proc_rec("rustdoc failed!", &proc_res);
2317         }
2318
2319         if self.props.check_test_line_numbers_match {
2320             self.check_rustdoc_test_option(proc_res);
2321         } else {
2322             let root = self.config.find_rust_src_root().unwrap();
2323             let res = self.cmd2procres(
2324                 Command::new(&self.config.docck_python)
2325                     .arg(root.join("src/etc/htmldocck.py"))
2326                     .arg(out_dir)
2327                     .arg(&self.testpaths.file),
2328             );
2329             if !res.status.success() {
2330                 self.fatal_proc_rec("htmldocck failed!", &res);
2331             }
2332         }
2333     }
2334
2335     fn get_lines<P: AsRef<Path>>(
2336         &self,
2337         path: &P,
2338         mut other_files: Option<&mut Vec<String>>,
2339     ) -> Vec<usize> {
2340         let content = fs::read_to_string(&path).unwrap();
2341         let mut ignore = false;
2342         content
2343             .lines()
2344             .enumerate()
2345             .filter_map(|(line_nb, line)| {
2346                 if (line.trim_start().starts_with("pub mod ")
2347                     || line.trim_start().starts_with("mod "))
2348                     && line.ends_with(';')
2349                 {
2350                     if let Some(ref mut other_files) = other_files {
2351                         other_files.push(line.rsplit("mod ").next().unwrap().replace(";", ""));
2352                     }
2353                     None
2354                 } else {
2355                     let sline = line.split("///").last().unwrap_or("");
2356                     let line = sline.trim_start();
2357                     if line.starts_with("```") {
2358                         if ignore {
2359                             ignore = false;
2360                             None
2361                         } else {
2362                             ignore = true;
2363                             Some(line_nb + 1)
2364                         }
2365                     } else {
2366                         None
2367                     }
2368                 }
2369             })
2370             .collect()
2371     }
2372
2373     fn check_rustdoc_test_option(&self, res: ProcRes) {
2374         let mut other_files = Vec::new();
2375         let mut files: HashMap<String, Vec<usize>> = HashMap::new();
2376         let cwd = env::current_dir().unwrap();
2377         files.insert(
2378             self.testpaths
2379                 .file
2380                 .strip_prefix(&cwd)
2381                 .unwrap_or(&self.testpaths.file)
2382                 .to_str()
2383                 .unwrap()
2384                 .replace('\\', "/"),
2385             self.get_lines(&self.testpaths.file, Some(&mut other_files)),
2386         );
2387         for other_file in other_files {
2388             let mut path = self.testpaths.file.clone();
2389             path.set_file_name(&format!("{}.rs", other_file));
2390             files.insert(
2391                 path.strip_prefix(&cwd).unwrap_or(&path).to_str().unwrap().replace('\\', "/"),
2392                 self.get_lines(&path, None),
2393             );
2394         }
2395
2396         let mut tested = 0;
2397         for _ in res.stdout.split('\n').filter(|s| s.starts_with("test ")).inspect(|s| {
2398             let tmp: Vec<&str> = s.split(" - ").collect();
2399             if tmp.len() == 2 {
2400                 let path = tmp[0].rsplit("test ").next().unwrap();
2401                 if let Some(ref mut v) = files.get_mut(&path.replace('\\', "/")) {
2402                     tested += 1;
2403                     let mut iter = tmp[1].split("(line ");
2404                     iter.next();
2405                     let line = iter
2406                         .next()
2407                         .unwrap_or(")")
2408                         .split(')')
2409                         .next()
2410                         .unwrap_or("0")
2411                         .parse()
2412                         .unwrap_or(0);
2413                     if let Ok(pos) = v.binary_search(&line) {
2414                         v.remove(pos);
2415                     } else {
2416                         self.fatal_proc_rec(
2417                             &format!("Not found doc test: \"{}\" in \"{}\":{:?}", s, path, v),
2418                             &res,
2419                         );
2420                     }
2421                 }
2422             }
2423         }) {}
2424         if tested == 0 {
2425             self.fatal_proc_rec(&format!("No test has been found... {:?}", files), &res);
2426         } else {
2427             for (entry, v) in &files {
2428                 if !v.is_empty() {
2429                     self.fatal_proc_rec(
2430                         &format!(
2431                             "Not found test at line{} \"{}\":{:?}",
2432                             if v.len() > 1 { "s" } else { "" },
2433                             entry,
2434                             v
2435                         ),
2436                         &res,
2437                     );
2438                 }
2439             }
2440         }
2441     }
2442
2443     fn run_codegen_units_test(&self) {
2444         assert!(self.revision.is_none(), "revisions not relevant here");
2445
2446         let proc_res = self.compile_test(WillExecute::No, EmitMetadata::No);
2447
2448         if !proc_res.status.success() {
2449             self.fatal_proc_rec("compilation failed!", &proc_res);
2450         }
2451
2452         self.check_no_compiler_crash(&proc_res, self.props.should_ice);
2453
2454         const PREFIX: &str = "MONO_ITEM ";
2455         const CGU_MARKER: &str = "@@";
2456
2457         let actual: Vec<MonoItem> = proc_res
2458             .stdout
2459             .lines()
2460             .filter(|line| line.starts_with(PREFIX))
2461             .map(|line| str_to_mono_item(line, true))
2462             .collect();
2463
2464         let expected: Vec<MonoItem> = errors::load_errors(&self.testpaths.file, None)
2465             .iter()
2466             .map(|e| str_to_mono_item(&e.msg[..], false))
2467             .collect();
2468
2469         let mut missing = Vec::new();
2470         let mut wrong_cgus = Vec::new();
2471
2472         for expected_item in &expected {
2473             let actual_item_with_same_name = actual.iter().find(|ti| ti.name == expected_item.name);
2474
2475             if let Some(actual_item) = actual_item_with_same_name {
2476                 if !expected_item.codegen_units.is_empty() &&
2477                    // Also check for codegen units
2478                    expected_item.codegen_units != actual_item.codegen_units
2479                 {
2480                     wrong_cgus.push((expected_item.clone(), actual_item.clone()));
2481                 }
2482             } else {
2483                 missing.push(expected_item.string.clone());
2484             }
2485         }
2486
2487         let unexpected: Vec<_> = actual
2488             .iter()
2489             .filter(|acgu| !expected.iter().any(|ecgu| acgu.name == ecgu.name))
2490             .map(|acgu| acgu.string.clone())
2491             .collect();
2492
2493         if !missing.is_empty() {
2494             missing.sort();
2495
2496             println!("\nThese items should have been contained but were not:\n");
2497
2498             for item in &missing {
2499                 println!("{}", item);
2500             }
2501
2502             println!("\n");
2503         }
2504
2505         if !unexpected.is_empty() {
2506             let sorted = {
2507                 let mut sorted = unexpected.clone();
2508                 sorted.sort();
2509                 sorted
2510             };
2511
2512             println!("\nThese items were contained but should not have been:\n");
2513
2514             for item in sorted {
2515                 println!("{}", item);
2516             }
2517
2518             println!("\n");
2519         }
2520
2521         if !wrong_cgus.is_empty() {
2522             wrong_cgus.sort_by_key(|pair| pair.0.name.clone());
2523             println!("\nThe following items were assigned to wrong codegen units:\n");
2524
2525             for &(ref expected_item, ref actual_item) in &wrong_cgus {
2526                 println!("{}", expected_item.name);
2527                 println!("  expected: {}", codegen_units_to_str(&expected_item.codegen_units));
2528                 println!("  actual:   {}", codegen_units_to_str(&actual_item.codegen_units));
2529                 println!();
2530             }
2531         }
2532
2533         if !(missing.is_empty() && unexpected.is_empty() && wrong_cgus.is_empty()) {
2534             panic!();
2535         }
2536
2537         #[derive(Clone, Eq, PartialEq)]
2538         struct MonoItem {
2539             name: String,
2540             codegen_units: HashSet<String>,
2541             string: String,
2542         }
2543
2544         // [MONO_ITEM] name [@@ (cgu)+]
2545         fn str_to_mono_item(s: &str, cgu_has_crate_disambiguator: bool) -> MonoItem {
2546             let s = if s.starts_with(PREFIX) { (&s[PREFIX.len()..]).trim() } else { s.trim() };
2547
2548             let full_string = format!("{}{}", PREFIX, s);
2549
2550             let parts: Vec<&str> =
2551                 s.split(CGU_MARKER).map(str::trim).filter(|s| !s.is_empty()).collect();
2552
2553             let name = parts[0].trim();
2554
2555             let cgus = if parts.len() > 1 {
2556                 let cgus_str = parts[1];
2557
2558                 cgus_str
2559                     .split(' ')
2560                     .map(str::trim)
2561                     .filter(|s| !s.is_empty())
2562                     .map(|s| {
2563                         if cgu_has_crate_disambiguator {
2564                             remove_crate_disambiguators_from_set_of_cgu_names(s)
2565                         } else {
2566                             s.to_string()
2567                         }
2568                     })
2569                     .collect()
2570             } else {
2571                 HashSet::new()
2572             };
2573
2574             MonoItem { name: name.to_owned(), codegen_units: cgus, string: full_string }
2575         }
2576
2577         fn codegen_units_to_str(cgus: &HashSet<String>) -> String {
2578             let mut cgus: Vec<_> = cgus.iter().collect();
2579             cgus.sort();
2580
2581             let mut string = String::new();
2582             for cgu in cgus {
2583                 string.push_str(&cgu[..]);
2584                 string.push_str(" ");
2585             }
2586
2587             string
2588         }
2589
2590         // Given a cgu-name-prefix of the form <crate-name>.<crate-disambiguator> or
2591         // the form <crate-name1>.<crate-disambiguator1>-in-<crate-name2>.<crate-disambiguator2>,
2592         // remove all crate-disambiguators.
2593         fn remove_crate_disambiguator_from_cgu(cgu: &str) -> String {
2594             lazy_static! {
2595                 static ref RE: Regex =
2596                     Regex::new(r"^[^\.]+(?P<d1>\.[[:alnum:]]+)(-in-[^\.]+(?P<d2>\.[[:alnum:]]+))?")
2597                         .unwrap();
2598             }
2599
2600             let captures =
2601                 RE.captures(cgu).unwrap_or_else(|| panic!("invalid cgu name encountered: {}", cgu));
2602
2603             let mut new_name = cgu.to_owned();
2604
2605             if let Some(d2) = captures.name("d2") {
2606                 new_name.replace_range(d2.start()..d2.end(), "");
2607             }
2608
2609             let d1 = captures.name("d1").unwrap();
2610             new_name.replace_range(d1.start()..d1.end(), "");
2611
2612             new_name
2613         }
2614
2615         // The name of merged CGUs is constructed as the names of the original
2616         // CGUs joined with "--". This function splits such composite CGU names
2617         // and handles each component individually.
2618         fn remove_crate_disambiguators_from_set_of_cgu_names(cgus: &str) -> String {
2619             cgus.split("--")
2620                 .map(|cgu| remove_crate_disambiguator_from_cgu(cgu))
2621                 .collect::<Vec<_>>()
2622                 .join("--")
2623         }
2624     }
2625
2626     fn init_incremental_test(&self) {
2627         // (See `run_incremental_test` for an overview of how incremental tests work.)
2628
2629         // Before any of the revisions have executed, create the
2630         // incremental workproduct directory.  Delete any old
2631         // incremental work products that may be there from prior
2632         // runs.
2633         let incremental_dir = self.incremental_dir();
2634         if incremental_dir.exists() {
2635             // Canonicalizing the path will convert it to the //?/ format
2636             // on Windows, which enables paths longer than 260 character
2637             let canonicalized = incremental_dir.canonicalize().unwrap();
2638             fs::remove_dir_all(canonicalized).unwrap();
2639         }
2640         fs::create_dir_all(&incremental_dir).unwrap();
2641
2642         if self.config.verbose {
2643             print!("init_incremental_test: incremental_dir={}", incremental_dir.display());
2644         }
2645     }
2646
2647     fn run_incremental_test(&self) {
2648         // Basic plan for a test incremental/foo/bar.rs:
2649         // - load list of revisions rpass1, cfail2, rpass3
2650         //   - each should begin with `rpass`, `cfail`, or `rfail`
2651         //   - if `rpass`, expect compile and execution to succeed
2652         //   - if `cfail`, expect compilation to fail
2653         //   - if `rfail`, expect execution to fail
2654         // - create a directory build/foo/bar.incremental
2655         // - compile foo/bar.rs with -C incremental=.../foo/bar.incremental and -C rpass1
2656         //   - because name of revision starts with "rpass", expect success
2657         // - compile foo/bar.rs with -C incremental=.../foo/bar.incremental and -C cfail2
2658         //   - because name of revision starts with "cfail", expect an error
2659         //   - load expected errors as usual, but filter for those that end in `[rfail2]`
2660         // - compile foo/bar.rs with -C incremental=.../foo/bar.incremental and -C rpass3
2661         //   - because name of revision starts with "rpass", expect success
2662         // - execute build/foo/bar.exe and save output
2663         //
2664         // FIXME -- use non-incremental mode as an oracle? That doesn't apply
2665         // to #[rustc_dirty] and clean tests I guess
2666
2667         let revision = self.revision.expect("incremental tests require a list of revisions");
2668
2669         // Incremental workproduct directory should have already been created.
2670         let incremental_dir = self.incremental_dir();
2671         assert!(incremental_dir.exists(), "init_incremental_test failed to create incremental dir");
2672
2673         // Add an extra flag pointing at the incremental directory.
2674         let mut revision_props = self.props.clone();
2675         revision_props.incremental_dir = Some(incremental_dir);
2676
2677         let revision_cx = TestCx {
2678             config: self.config,
2679             props: &revision_props,
2680             testpaths: self.testpaths,
2681             revision: self.revision,
2682         };
2683
2684         if self.config.verbose {
2685             print!("revision={:?} revision_props={:#?}", revision, revision_props);
2686         }
2687
2688         if revision.starts_with("rpass") {
2689             if revision_cx.props.should_ice {
2690                 revision_cx.fatal("can only use should-ice in cfail tests");
2691             }
2692             revision_cx.run_rpass_test();
2693         } else if revision.starts_with("rfail") {
2694             if revision_cx.props.should_ice {
2695                 revision_cx.fatal("can only use should-ice in cfail tests");
2696             }
2697             revision_cx.run_rfail_test();
2698         } else if revision.starts_with("cfail") {
2699             revision_cx.run_cfail_test();
2700         } else {
2701             revision_cx.fatal("revision name must begin with rpass, rfail, or cfail");
2702         }
2703     }
2704
2705     /// Directory where incremental work products are stored.
2706     fn incremental_dir(&self) -> PathBuf {
2707         self.output_base_name().with_extension("inc")
2708     }
2709
2710     fn run_rmake_test(&self) {
2711         let cwd = env::current_dir().unwrap();
2712         let src_root = self.config.src_base.parent().unwrap().parent().unwrap().parent().unwrap();
2713         let src_root = cwd.join(&src_root);
2714
2715         let tmpdir = cwd.join(self.output_base_name());
2716         if tmpdir.exists() {
2717             self.aggressive_rm_rf(&tmpdir).unwrap();
2718         }
2719         create_dir_all(&tmpdir).unwrap();
2720
2721         let host = &self.config.host;
2722         let make = if host.contains("dragonfly")
2723             || host.contains("freebsd")
2724             || host.contains("netbsd")
2725             || host.contains("openbsd")
2726         {
2727             "gmake"
2728         } else {
2729             "make"
2730         };
2731
2732         let mut cmd = Command::new(make);
2733         cmd.current_dir(&self.testpaths.file)
2734             .stdout(Stdio::piped())
2735             .stderr(Stdio::piped())
2736             .env("TARGET", &self.config.target)
2737             .env("PYTHON", &self.config.docck_python)
2738             .env("S", src_root)
2739             .env("RUST_BUILD_STAGE", &self.config.stage_id)
2740             .env("RUSTC", cwd.join(&self.config.rustc_path))
2741             .env("TMPDIR", &tmpdir)
2742             .env("LD_LIB_PATH_ENVVAR", dylib_env_var())
2743             .env("HOST_RPATH_DIR", cwd.join(&self.config.compile_lib_path))
2744             .env("TARGET_RPATH_DIR", cwd.join(&self.config.run_lib_path))
2745             .env("LLVM_COMPONENTS", &self.config.llvm_components)
2746             // We for sure don't want these tests to run in parallel, so make
2747             // sure they don't have access to these vars if we run via `make`
2748             // at the top level
2749             .env_remove("MAKEFLAGS")
2750             .env_remove("MFLAGS")
2751             .env_remove("CARGO_MAKEFLAGS");
2752
2753         if let Some(ref rustdoc) = self.config.rustdoc_path {
2754             cmd.env("RUSTDOC", cwd.join(rustdoc));
2755         }
2756
2757         if let Some(ref rust_demangler) = self.config.rust_demangler_path {
2758             cmd.env("RUST_DEMANGLER", cwd.join(rust_demangler));
2759         }
2760
2761         if let Some(ref node) = self.config.nodejs {
2762             cmd.env("NODE", node);
2763         }
2764
2765         if let Some(ref linker) = self.config.linker {
2766             cmd.env("RUSTC_LINKER", linker);
2767         }
2768
2769         if let Some(ref clang) = self.config.run_clang_based_tests_with {
2770             cmd.env("CLANG", clang);
2771         }
2772
2773         if let Some(ref filecheck) = self.config.llvm_filecheck {
2774             cmd.env("LLVM_FILECHECK", filecheck);
2775         }
2776
2777         if let Some(ref llvm_bin_dir) = self.config.llvm_bin_dir {
2778             cmd.env("LLVM_BIN_DIR", llvm_bin_dir);
2779         }
2780
2781         // We don't want RUSTFLAGS set from the outside to interfere with
2782         // compiler flags set in the test cases:
2783         cmd.env_remove("RUSTFLAGS");
2784
2785         // Use dynamic musl for tests because static doesn't allow creating dylibs
2786         if self.config.host.contains("musl") {
2787             cmd.env("RUSTFLAGS", "-Ctarget-feature=-crt-static").env("IS_MUSL_HOST", "1");
2788         }
2789
2790         if self.config.bless {
2791             cmd.env("RUSTC_BLESS_TEST", "--bless");
2792             // Assume this option is active if the environment variable is "defined", with _any_ value.
2793             // As an example, a `Makefile` can use this option by:
2794             //
2795             //   ifdef RUSTC_BLESS_TEST
2796             //       cp "$(TMPDIR)"/actual_something.ext expected_something.ext
2797             //   else
2798             //       $(DIFF) expected_something.ext "$(TMPDIR)"/actual_something.ext
2799             //   endif
2800         }
2801
2802         if self.config.target.contains("msvc") && self.config.cc != "" {
2803             // We need to pass a path to `lib.exe`, so assume that `cc` is `cl.exe`
2804             // and that `lib.exe` lives next to it.
2805             let lib = Path::new(&self.config.cc).parent().unwrap().join("lib.exe");
2806
2807             // MSYS doesn't like passing flags of the form `/foo` as it thinks it's
2808             // a path and instead passes `C:\msys64\foo`, so convert all
2809             // `/`-arguments to MSVC here to `-` arguments.
2810             let cflags = self
2811                 .config
2812                 .cflags
2813                 .split(' ')
2814                 .map(|s| s.replace("/", "-"))
2815                 .collect::<Vec<_>>()
2816                 .join(" ");
2817
2818             cmd.env("IS_MSVC", "1")
2819                 .env("IS_WINDOWS", "1")
2820                 .env("MSVC_LIB", format!("'{}' -nologo", lib.display()))
2821                 .env("CC", format!("'{}' {}", self.config.cc, cflags))
2822                 .env("CXX", format!("'{}'", &self.config.cxx));
2823         } else {
2824             cmd.env("CC", format!("{} {}", self.config.cc, self.config.cflags))
2825                 .env("CXX", format!("{} {}", self.config.cxx, self.config.cflags))
2826                 .env("AR", &self.config.ar);
2827
2828             if self.config.target.contains("windows") {
2829                 cmd.env("IS_WINDOWS", "1");
2830             }
2831         }
2832
2833         let output = cmd.spawn().and_then(read2_abbreviated).expect("failed to spawn `make`");
2834         if !output.status.success() {
2835             let res = ProcRes {
2836                 status: output.status,
2837                 stdout: String::from_utf8_lossy(&output.stdout).into_owned(),
2838                 stderr: String::from_utf8_lossy(&output.stderr).into_owned(),
2839                 cmdline: format!("{:?}", cmd),
2840             };
2841             self.fatal_proc_rec("make failed", &res);
2842         }
2843     }
2844
2845     fn aggressive_rm_rf(&self, path: &Path) -> io::Result<()> {
2846         for e in path.read_dir()? {
2847             let entry = e?;
2848             let path = entry.path();
2849             if entry.file_type()?.is_dir() {
2850                 self.aggressive_rm_rf(&path)?;
2851             } else {
2852                 // Remove readonly files as well on windows (by default we can't)
2853                 fs::remove_file(&path).or_else(|e| {
2854                     if cfg!(windows) && e.kind() == io::ErrorKind::PermissionDenied {
2855                         let mut meta = entry.metadata()?.permissions();
2856                         meta.set_readonly(false);
2857                         fs::set_permissions(&path, meta)?;
2858                         fs::remove_file(&path)
2859                     } else {
2860                         Err(e)
2861                     }
2862                 })?;
2863             }
2864         }
2865         fs::remove_dir(path)
2866     }
2867
2868     fn run_js_doc_test(&self) {
2869         if let Some(nodejs) = &self.config.nodejs {
2870             let out_dir = self.output_base_dir();
2871
2872             self.document(&out_dir);
2873
2874             let root = self.config.find_rust_src_root().unwrap();
2875             let file_stem =
2876                 self.testpaths.file.file_stem().and_then(|f| f.to_str()).expect("no file stem");
2877             let res = self.cmd2procres(
2878                 Command::new(&nodejs)
2879                     .arg(root.join("src/tools/rustdoc-js/tester.js"))
2880                     .arg("--doc-folder")
2881                     .arg(out_dir)
2882                     .arg("--crate-name")
2883                     .arg(file_stem.replace("-", "_"))
2884                     .arg("--test-file")
2885                     .arg(self.testpaths.file.with_extension("js")),
2886             );
2887             if !res.status.success() {
2888                 self.fatal_proc_rec("rustdoc-js test failed!", &res);
2889             }
2890         } else {
2891             self.fatal("no nodeJS");
2892         }
2893     }
2894
2895     fn load_compare_outputs(
2896         &self,
2897         proc_res: &ProcRes,
2898         output_kind: TestOutput,
2899         explicit_format: bool,
2900     ) -> usize {
2901         let (stderr_kind, stdout_kind) = match output_kind {
2902             TestOutput::Compile => (UI_STDERR, UI_STDOUT),
2903             TestOutput::Run => (UI_RUN_STDERR, UI_RUN_STDOUT),
2904         };
2905
2906         let expected_stderr = self.load_expected_output(stderr_kind);
2907         let expected_stdout = self.load_expected_output(stdout_kind);
2908
2909         let normalized_stdout = match output_kind {
2910             TestOutput::Run if self.config.remote_test_client.is_some() => {
2911                 // When tests are run using the remote-test-client, the string
2912                 // 'uploaded "$TEST_BUILD_DIR/<test_executable>, waiting for result"'
2913                 // is printed to stdout by the client and then captured in the ProcRes,
2914                 // so it needs to be removed when comparing the run-pass test execution output
2915                 lazy_static! {
2916                     static ref REMOTE_TEST_RE: Regex = Regex::new(
2917                         "^uploaded \"\\$TEST_BUILD_DIR(/[[:alnum:]_\\-]+)+\", waiting for result\n"
2918                     )
2919                     .unwrap();
2920                 }
2921                 REMOTE_TEST_RE
2922                     .replace(
2923                         &self.normalize_output(&proc_res.stdout, &self.props.normalize_stdout),
2924                         "",
2925                     )
2926                     .to_string()
2927             }
2928             _ => self.normalize_output(&proc_res.stdout, &self.props.normalize_stdout),
2929         };
2930
2931         let stderr = if explicit_format {
2932             proc_res.stderr.clone()
2933         } else {
2934             json::extract_rendered(&proc_res.stderr)
2935         };
2936
2937         let normalized_stderr = self.normalize_output(&stderr, &self.props.normalize_stderr);
2938         let mut errors = 0;
2939         match output_kind {
2940             TestOutput::Compile => {
2941                 if !self.props.dont_check_compiler_stdout {
2942                     errors += self.compare_output("stdout", &normalized_stdout, &expected_stdout);
2943                 }
2944                 if !self.props.dont_check_compiler_stderr {
2945                     errors += self.compare_output("stderr", &normalized_stderr, &expected_stderr);
2946                 }
2947             }
2948             TestOutput::Run => {
2949                 errors += self.compare_output(stdout_kind, &normalized_stdout, &expected_stdout);
2950                 errors += self.compare_output(stderr_kind, &normalized_stderr, &expected_stderr);
2951             }
2952         }
2953         errors
2954     }
2955
2956     fn run_ui_test(&self) {
2957         if let Some(FailMode::Build) = self.props.fail_mode {
2958             // Make sure a build-fail test cannot fail due to failing analysis (e.g. typeck).
2959             let pm = Some(PassMode::Check);
2960             let proc_res = self.compile_test_general(WillExecute::No, EmitMetadata::Yes, pm);
2961             self.check_if_test_should_compile(&proc_res, pm);
2962         }
2963
2964         let pm = self.pass_mode();
2965         let should_run = self.should_run(pm);
2966         let emit_metadata = self.should_emit_metadata(pm);
2967         let proc_res = self.compile_test(should_run, emit_metadata);
2968         self.check_if_test_should_compile(&proc_res, pm);
2969
2970         // if the user specified a format in the ui test
2971         // print the output to the stderr file, otherwise extract
2972         // the rendered error messages from json and print them
2973         let explicit = self.props.compile_flags.iter().any(|s| s.contains("--error-format"));
2974
2975         let expected_fixed = self.load_expected_output(UI_FIXED);
2976
2977         let modes_to_prune = vec![CompareMode::Nll];
2978         self.prune_duplicate_outputs(&modes_to_prune);
2979
2980         let mut errors = self.load_compare_outputs(&proc_res, TestOutput::Compile, explicit);
2981
2982         if self.config.compare_mode.is_some() {
2983             // don't test rustfix with nll right now
2984         } else if self.config.rustfix_coverage {
2985             // Find out which tests have `MachineApplicable` suggestions but are missing
2986             // `run-rustfix` or `run-rustfix-only-machine-applicable` headers.
2987             //
2988             // This will return an empty `Vec` in case the executed test file has a
2989             // `compile-flags: --error-format=xxxx` header with a value other than `json`.
2990             let suggestions = get_suggestions_from_json(
2991                 &proc_res.stderr,
2992                 &HashSet::new(),
2993                 Filter::MachineApplicableOnly,
2994             )
2995             .unwrap_or_default();
2996             if !suggestions.is_empty()
2997                 && !self.props.run_rustfix
2998                 && !self.props.rustfix_only_machine_applicable
2999             {
3000                 let mut coverage_file_path = self.config.build_base.clone();
3001                 coverage_file_path.push("rustfix_missing_coverage.txt");
3002                 debug!("coverage_file_path: {}", coverage_file_path.display());
3003
3004                 let mut file = OpenOptions::new()
3005                     .create(true)
3006                     .append(true)
3007                     .open(coverage_file_path.as_path())
3008                     .expect("could not create or open file");
3009
3010                 if writeln!(file, "{}", self.testpaths.file.display()).is_err() {
3011                     panic!("couldn't write to {}", coverage_file_path.display());
3012                 }
3013             }
3014         } else if self.props.run_rustfix {
3015             // Apply suggestions from rustc to the code itself
3016             let unfixed_code = self.load_expected_output_from_path(&self.testpaths.file).unwrap();
3017             let suggestions = get_suggestions_from_json(
3018                 &proc_res.stderr,
3019                 &HashSet::new(),
3020                 if self.props.rustfix_only_machine_applicable {
3021                     Filter::MachineApplicableOnly
3022                 } else {
3023                     Filter::Everything
3024                 },
3025             )
3026             .unwrap();
3027             let fixed_code = apply_suggestions(&unfixed_code, &suggestions).unwrap_or_else(|_| {
3028                 panic!("failed to apply suggestions for {:?} with rustfix", self.testpaths.file)
3029             });
3030
3031             errors += self.compare_output("fixed", &fixed_code, &expected_fixed);
3032         } else if !expected_fixed.is_empty() {
3033             panic!(
3034                 "the `// run-rustfix` directive wasn't found but a `*.fixed` \
3035                  file was found"
3036             );
3037         }
3038
3039         if errors > 0 {
3040             println!("To update references, rerun the tests and pass the `--bless` flag");
3041             let relative_path_to_file =
3042                 self.testpaths.relative_dir.join(self.testpaths.file.file_name().unwrap());
3043             println!(
3044                 "To only update this specific test, also pass `--test-args {}`",
3045                 relative_path_to_file.display(),
3046             );
3047             self.fatal_proc_rec(
3048                 &format!("{} errors occurred comparing output.", errors),
3049                 &proc_res,
3050             );
3051         }
3052
3053         let expected_errors = errors::load_errors(&self.testpaths.file, self.revision);
3054
3055         if let WillExecute::Yes = should_run {
3056             let proc_res = self.exec_compiled_test();
3057             let run_output_errors = if self.props.check_run_results {
3058                 self.load_compare_outputs(&proc_res, TestOutput::Run, explicit)
3059             } else {
3060                 0
3061             };
3062             if run_output_errors > 0 {
3063                 self.fatal_proc_rec(
3064                     &format!("{} errors occurred comparing run output.", run_output_errors),
3065                     &proc_res,
3066                 );
3067             }
3068             if self.should_run_successfully(pm) {
3069                 if !proc_res.status.success() {
3070                     self.fatal_proc_rec("test run failed!", &proc_res);
3071                 }
3072             } else {
3073                 if proc_res.status.success() {
3074                     self.fatal_proc_rec("test run succeeded!", &proc_res);
3075                 }
3076             }
3077             if !self.props.error_patterns.is_empty() {
3078                 // "// error-pattern" comments
3079                 self.check_error_patterns(&proc_res.stderr, &proc_res, pm);
3080             }
3081         }
3082
3083         debug!(
3084             "run_ui_test: explicit={:?} config.compare_mode={:?} expected_errors={:?} \
3085                proc_res.status={:?} props.error_patterns={:?}",
3086             explicit,
3087             self.config.compare_mode,
3088             expected_errors,
3089             proc_res.status,
3090             self.props.error_patterns
3091         );
3092         if !explicit && self.config.compare_mode.is_none() {
3093             let check_patterns =
3094                 should_run == WillExecute::No && !self.props.error_patterns.is_empty();
3095
3096             let check_annotations = !check_patterns || !expected_errors.is_empty();
3097
3098             if check_patterns {
3099                 // "// error-pattern" comments
3100                 self.check_error_patterns(&proc_res.stderr, &proc_res, pm);
3101             }
3102
3103             if check_annotations {
3104                 // "//~ERROR comments"
3105                 self.check_expected_errors(expected_errors, &proc_res);
3106             }
3107         }
3108
3109         if self.props.run_rustfix && self.config.compare_mode.is_none() {
3110             // And finally, compile the fixed code and make sure it both
3111             // succeeds and has no diagnostics.
3112             let mut rustc = self.make_compile_args(
3113                 &self.testpaths.file.with_extension(UI_FIXED),
3114                 TargetLocation::ThisFile(self.make_exe_name()),
3115                 emit_metadata,
3116                 AllowUnused::No,
3117             );
3118             rustc.arg("-L").arg(&self.aux_output_dir_name());
3119             let res = self.compose_and_run_compiler(rustc, None);
3120             if !res.status.success() {
3121                 self.fatal_proc_rec("failed to compile fixed code", &res);
3122             }
3123             if !res.stderr.is_empty() && !self.props.rustfix_only_machine_applicable {
3124                 self.fatal_proc_rec("fixed code is still producing diagnostics", &res);
3125             }
3126         }
3127     }
3128
3129     fn run_mir_opt_test(&self) {
3130         let pm = self.pass_mode();
3131         let should_run = self.should_run(pm);
3132         let emit_metadata = self.should_emit_metadata(pm);
3133         let proc_res = self.compile_test(should_run, emit_metadata);
3134
3135         if !proc_res.status.success() {
3136             self.fatal_proc_rec("compilation failed!", &proc_res);
3137         }
3138
3139         self.check_mir_dump();
3140
3141         if let WillExecute::Yes = should_run {
3142             let proc_res = self.exec_compiled_test();
3143
3144             if !proc_res.status.success() {
3145                 self.fatal_proc_rec("test run failed!", &proc_res);
3146             }
3147         }
3148     }
3149
3150     fn check_mir_dump(&self) {
3151         let test_file_contents = fs::read_to_string(&self.testpaths.file).unwrap();
3152
3153         let test_dir = self.testpaths.file.parent().unwrap();
3154         let test_crate =
3155             self.testpaths.file.file_stem().unwrap().to_str().unwrap().replace("-", "_");
3156
3157         let mut bit_width = String::new();
3158         if test_file_contents.lines().any(|l| l == "// EMIT_MIR_FOR_EACH_BIT_WIDTH") {
3159             bit_width = format!(".{}", get_pointer_width(&self.config.target));
3160         }
3161
3162         if self.config.bless {
3163             for e in
3164                 glob(&format!("{}/{}.*{}.mir", test_dir.display(), test_crate, bit_width)).unwrap()
3165             {
3166                 std::fs::remove_file(e.unwrap()).unwrap();
3167             }
3168             for e in
3169                 glob(&format!("{}/{}.*{}.diff", test_dir.display(), test_crate, bit_width)).unwrap()
3170             {
3171                 std::fs::remove_file(e.unwrap()).unwrap();
3172             }
3173         }
3174
3175         for l in test_file_contents.lines() {
3176             if l.starts_with("// EMIT_MIR ") {
3177                 let test_name = l.trim_start_matches("// EMIT_MIR ").trim();
3178                 let mut test_names = test_name.split(' ');
3179                 // sometimes we specify two files so that we get a diff between the two files
3180                 let test_name = test_names.next().unwrap();
3181                 let mut expected_file;
3182                 let from_file;
3183                 let to_file;
3184
3185                 if test_name.ends_with(".diff") {
3186                     let trimmed = test_name.trim_end_matches(".diff");
3187                     let test_against = format!("{}.after.mir", trimmed);
3188                     from_file = format!("{}.before.mir", trimmed);
3189                     expected_file = format!("{}{}.diff", trimmed, bit_width);
3190                     assert!(
3191                         test_names.next().is_none(),
3192                         "two mir pass names specified for MIR diff"
3193                     );
3194                     to_file = Some(test_against);
3195                 } else if let Some(first_pass) = test_names.next() {
3196                     let second_pass = test_names.next().unwrap();
3197                     assert!(
3198                         test_names.next().is_none(),
3199                         "three mir pass names specified for MIR diff"
3200                     );
3201                     expected_file =
3202                         format!("{}{}.{}-{}.diff", test_name, bit_width, first_pass, second_pass);
3203                     let second_file = format!("{}.{}.mir", test_name, second_pass);
3204                     from_file = format!("{}.{}.mir", test_name, first_pass);
3205                     to_file = Some(second_file);
3206                 } else {
3207                     let ext_re = Regex::new(r#"(\.(mir|dot|html))$"#).unwrap();
3208                     let cap = ext_re
3209                         .captures_iter(test_name)
3210                         .next()
3211                         .expect("test_name has an invalid extension");
3212                     let extension = cap.get(1).unwrap().as_str();
3213                     expected_file = format!(
3214                         "{}{}{}",
3215                         test_name.trim_end_matches(extension),
3216                         bit_width,
3217                         extension,
3218                     );
3219                     from_file = test_name.to_string();
3220                     assert!(
3221                         test_names.next().is_none(),
3222                         "two mir pass names specified for MIR dump"
3223                     );
3224                     to_file = None;
3225                 };
3226                 if !expected_file.starts_with(&test_crate) {
3227                     expected_file = format!("{}.{}", test_crate, expected_file);
3228                 }
3229                 let expected_file = test_dir.join(expected_file);
3230
3231                 let dumped_string = if let Some(after) = to_file {
3232                     self.diff_mir_files(from_file.into(), after.into())
3233                 } else {
3234                     let mut output_file = PathBuf::new();
3235                     output_file.push(self.get_mir_dump_dir());
3236                     output_file.push(&from_file);
3237                     debug!(
3238                         "comparing the contents of: {} with {}",
3239                         output_file.display(),
3240                         expected_file.display()
3241                     );
3242                     if !output_file.exists() {
3243                         panic!(
3244                             "Output file `{}` from test does not exist, available files are in `{}`",
3245                             output_file.display(),
3246                             output_file.parent().unwrap().display()
3247                         );
3248                     }
3249                     self.check_mir_test_timestamp(&from_file, &output_file);
3250                     let dumped_string = fs::read_to_string(&output_file).unwrap();
3251                     self.normalize_output(&dumped_string, &[])
3252                 };
3253
3254                 if self.config.bless {
3255                     let _ = std::fs::remove_file(&expected_file);
3256                     std::fs::write(expected_file, dumped_string.as_bytes()).unwrap();
3257                 } else {
3258                     if !expected_file.exists() {
3259                         panic!(
3260                             "Output file `{}` from test does not exist",
3261                             expected_file.display()
3262                         );
3263                     }
3264                     let expected_string = fs::read_to_string(&expected_file).unwrap();
3265                     if dumped_string != expected_string {
3266                         print!("{}", write_diff(&expected_string, &dumped_string, 3));
3267                         panic!(
3268                             "Actual MIR output differs from expected MIR output {}",
3269                             expected_file.display()
3270                         );
3271                     }
3272                 }
3273             }
3274         }
3275     }
3276
3277     fn diff_mir_files(&self, before: PathBuf, after: PathBuf) -> String {
3278         let to_full_path = |path: PathBuf| {
3279             let full = self.get_mir_dump_dir().join(&path);
3280             if !full.exists() {
3281                 panic!(
3282                     "the mir dump file for {} does not exist (requested in {})",
3283                     path.display(),
3284                     self.testpaths.file.display(),
3285                 );
3286             }
3287             full
3288         };
3289         let before = to_full_path(before);
3290         let after = to_full_path(after);
3291         debug!("comparing the contents of: {} with {}", before.display(), after.display());
3292         let before = fs::read_to_string(before).unwrap();
3293         let after = fs::read_to_string(after).unwrap();
3294         let before = self.normalize_output(&before, &[]);
3295         let after = self.normalize_output(&after, &[]);
3296         let mut dumped_string = String::new();
3297         for result in diff::lines(&before, &after) {
3298             use std::fmt::Write;
3299             match result {
3300                 diff::Result::Left(s) => writeln!(dumped_string, "- {}", s).unwrap(),
3301                 diff::Result::Right(s) => writeln!(dumped_string, "+ {}", s).unwrap(),
3302                 diff::Result::Both(s, _) => writeln!(dumped_string, "  {}", s).unwrap(),
3303             }
3304         }
3305         dumped_string
3306     }
3307
3308     fn check_mir_test_timestamp(&self, test_name: &str, output_file: &Path) {
3309         let t = |file| fs::metadata(file).unwrap().modified().unwrap();
3310         let source_file = &self.testpaths.file;
3311         let output_time = t(output_file);
3312         let source_time = t(source_file);
3313         if source_time > output_time {
3314             debug!("source file time: {:?} output file time: {:?}", source_time, output_time);
3315             panic!(
3316                 "test source file `{}` is newer than potentially stale output file `{}`.",
3317                 source_file.display(),
3318                 test_name
3319             );
3320         }
3321     }
3322
3323     fn get_mir_dump_dir(&self) -> PathBuf {
3324         let mut mir_dump_dir = PathBuf::from(self.config.build_base.as_path());
3325         debug!("input_file: {:?}", self.testpaths.file);
3326         mir_dump_dir.push(&self.testpaths.relative_dir);
3327         mir_dump_dir.push(self.testpaths.file.file_stem().unwrap());
3328         mir_dump_dir
3329     }
3330
3331     fn normalize_output(&self, output: &str, custom_rules: &[(String, String)]) -> String {
3332         let cflags = self.props.compile_flags.join(" ");
3333         let json = cflags.contains("--error-format json")
3334             || cflags.contains("--error-format pretty-json")
3335             || cflags.contains("--error-format=json")
3336             || cflags.contains("--error-format=pretty-json")
3337             || cflags.contains("--output-format json")
3338             || cflags.contains("--output-format=json");
3339
3340         let mut normalized = output.to_string();
3341
3342         let mut normalize_path = |from: &Path, to: &str| {
3343             let mut from = from.display().to_string();
3344             if json {
3345                 from = from.replace("\\", "\\\\");
3346             }
3347             normalized = normalized.replace(&from, to);
3348         };
3349
3350         let parent_dir = self.testpaths.file.parent().unwrap();
3351         normalize_path(parent_dir, "$DIR");
3352
3353         // Paths into the libstd/libcore
3354         let src_dir = self
3355             .config
3356             .src_base
3357             .parent()
3358             .unwrap()
3359             .parent()
3360             .unwrap()
3361             .parent()
3362             .unwrap()
3363             .join("library");
3364         normalize_path(&src_dir, "$SRC_DIR");
3365
3366         // Paths into the build directory
3367         let test_build_dir = &self.config.build_base;
3368         let parent_build_dir = test_build_dir.parent().unwrap().parent().unwrap().parent().unwrap();
3369
3370         // eg. /home/user/rust/build/x86_64-unknown-linux-gnu/test/ui
3371         normalize_path(test_build_dir, "$TEST_BUILD_DIR");
3372         // eg. /home/user/rust/build
3373         normalize_path(parent_build_dir, "$BUILD_DIR");
3374
3375         // Paths into lib directory.
3376         normalize_path(&parent_build_dir.parent().unwrap().join("lib"), "$LIB_DIR");
3377
3378         if json {
3379             // escaped newlines in json strings should be readable
3380             // in the stderr files. There's no point int being correct,
3381             // since only humans process the stderr files.
3382             // Thus we just turn escaped newlines back into newlines.
3383             normalized = normalized.replace("\\n", "\n");
3384         }
3385
3386         // If there are `$SRC_DIR` normalizations with line and column numbers, then replace them
3387         // with placeholders as we do not want tests needing updated when compiler source code
3388         // changes.
3389         // eg. $SRC_DIR/libcore/mem.rs:323:14 becomes $SRC_DIR/libcore/mem.rs:LL:COL
3390         normalized = Regex::new("SRC_DIR(.+):\\d+:\\d+(: \\d+:\\d+)?")
3391             .unwrap()
3392             .replace_all(&normalized, "SRC_DIR$1:LL:COL")
3393             .into_owned();
3394
3395         normalized = Self::normalize_platform_differences(&normalized);
3396         normalized = normalized.replace("\t", "\\t"); // makes tabs visible
3397
3398         // Remove test annotations like `//~ ERROR text` from the output,
3399         // since they duplicate actual errors and make the output hard to read.
3400         normalized =
3401             Regex::new("\\s*//(\\[.*\\])?~.*").unwrap().replace_all(&normalized, "").into_owned();
3402
3403         for rule in custom_rules {
3404             let re = Regex::new(&rule.0).expect("bad regex in custom normalization rule");
3405             normalized = re.replace_all(&normalized, &rule.1[..]).into_owned();
3406         }
3407         normalized
3408     }
3409
3410     /// Normalize output differences across platforms. Generally changes Windows output to be more
3411     /// Unix-like.
3412     ///
3413     /// Replaces backslashes in paths with forward slashes, and replaces CRLF line endings
3414     /// with LF.
3415     fn normalize_platform_differences(output: &str) -> String {
3416         lazy_static! {
3417             /// Used to find Windows paths.
3418             ///
3419             /// It's not possible to detect paths in the error messages generally, but this is a
3420             /// decent enough heuristic.
3421             static ref PATH_BACKSLASH_RE: Regex = Regex::new(r#"(?x)
3422                 (?:
3423                   # Match paths that don't include spaces.
3424                   (?:\\[\pL\pN\.\-_']+)+\.\pL+
3425                 |
3426                   # If the path starts with a well-known root, then allow spaces.
3427                   \$(?:DIR|SRC_DIR|TEST_BUILD_DIR|BUILD_DIR|LIB_DIR)(?:\\[\pL\pN\.\-_' ]+)+
3428                 )"#
3429             ).unwrap();
3430         }
3431
3432         let output = output.replace(r"\\", r"\");
3433
3434         PATH_BACKSLASH_RE
3435             .replace_all(&output, |caps: &Captures<'_>| {
3436                 println!("{}", &caps[0]);
3437                 caps[0].replace(r"\", "/")
3438             })
3439             .replace("\r\n", "\n")
3440     }
3441
3442     fn expected_output_path(&self, kind: &str) -> PathBuf {
3443         let mut path =
3444             expected_output_path(&self.testpaths, self.revision, &self.config.compare_mode, kind);
3445
3446         if !path.exists() {
3447             if let Some(CompareMode::Polonius) = self.config.compare_mode {
3448                 path = expected_output_path(
3449                     &self.testpaths,
3450                     self.revision,
3451                     &Some(CompareMode::Nll),
3452                     kind,
3453                 );
3454             }
3455         }
3456
3457         if !path.exists() {
3458             path = expected_output_path(&self.testpaths, self.revision, &None, kind);
3459         }
3460
3461         path
3462     }
3463
3464     fn load_expected_output(&self, kind: &str) -> String {
3465         let path = self.expected_output_path(kind);
3466         if path.exists() {
3467             match self.load_expected_output_from_path(&path) {
3468                 Ok(x) => x,
3469                 Err(x) => self.fatal(&x),
3470             }
3471         } else {
3472             String::new()
3473         }
3474     }
3475
3476     fn load_expected_output_from_path(&self, path: &Path) -> Result<String, String> {
3477         fs::read_to_string(path).map_err(|err| {
3478             format!("failed to load expected output from `{}`: {}", path.display(), err)
3479         })
3480     }
3481
3482     fn delete_file(&self, file: &PathBuf) {
3483         if !file.exists() {
3484             // Deleting a nonexistant file would error.
3485             return;
3486         }
3487         if let Err(e) = fs::remove_file(file) {
3488             self.fatal(&format!("failed to delete `{}`: {}", file.display(), e,));
3489         }
3490     }
3491
3492     fn compare_output(&self, kind: &str, actual: &str, expected: &str) -> usize {
3493         if actual == expected {
3494             return 0;
3495         }
3496
3497         if !self.config.bless {
3498             if expected.is_empty() {
3499                 println!("normalized {}:\n{}\n", kind, actual);
3500             } else {
3501                 println!("diff of {}:\n", kind);
3502                 print!("{}", write_diff(expected, actual, 3));
3503             }
3504         }
3505
3506         let mode = self.config.compare_mode.as_ref().map_or("", |m| m.to_str());
3507         let output_file = self
3508             .output_base_name()
3509             .with_extra_extension(self.revision.unwrap_or(""))
3510             .with_extra_extension(mode)
3511             .with_extra_extension(kind);
3512
3513         let mut files = vec![output_file];
3514         if self.config.bless {
3515             files.push(expected_output_path(
3516                 self.testpaths,
3517                 self.revision,
3518                 &self.config.compare_mode,
3519                 kind,
3520             ));
3521         }
3522
3523         for output_file in &files {
3524             if actual.is_empty() {
3525                 self.delete_file(output_file);
3526             } else if let Err(err) = fs::write(&output_file, &actual) {
3527                 self.fatal(&format!(
3528                     "failed to write {} to `{}`: {}",
3529                     kind,
3530                     output_file.display(),
3531                     err,
3532                 ));
3533             }
3534         }
3535
3536         println!("\nThe actual {0} differed from the expected {0}.", kind);
3537         for output_file in files {
3538             println!("Actual {} saved to {}", kind, output_file.display());
3539         }
3540         if self.config.bless { 0 } else { 1 }
3541     }
3542
3543     fn prune_duplicate_output(&self, mode: CompareMode, kind: &str, canon_content: &str) {
3544         let examined_path = expected_output_path(&self.testpaths, self.revision, &Some(mode), kind);
3545
3546         let examined_content =
3547             self.load_expected_output_from_path(&examined_path).unwrap_or_else(|_| String::new());
3548
3549         if canon_content == examined_content {
3550             self.delete_file(&examined_path);
3551         }
3552     }
3553
3554     fn prune_duplicate_outputs(&self, modes: &[CompareMode]) {
3555         if self.config.bless {
3556             for kind in UI_EXTENSIONS {
3557                 let canon_comparison_path =
3558                     expected_output_path(&self.testpaths, self.revision, &None, kind);
3559
3560                 if let Ok(canon) = self.load_expected_output_from_path(&canon_comparison_path) {
3561                     for mode in modes {
3562                         self.prune_duplicate_output(mode.clone(), kind, &canon);
3563                     }
3564                 }
3565             }
3566         }
3567     }
3568
3569     fn create_stamp(&self) {
3570         let stamp = crate::stamp(&self.config, self.testpaths, self.revision);
3571         fs::write(&stamp, compute_stamp_hash(&self.config)).unwrap();
3572     }
3573 }
3574
3575 struct ProcArgs {
3576     prog: String,
3577     args: Vec<String>,
3578 }
3579
3580 pub struct ProcRes {
3581     status: ExitStatus,
3582     stdout: String,
3583     stderr: String,
3584     cmdline: String,
3585 }
3586
3587 impl ProcRes {
3588     pub fn fatal(&self, err: Option<&str>) -> ! {
3589         if let Some(e) = err {
3590             println!("\nerror: {}", e);
3591         }
3592         print!(
3593             "\
3594              status: {}\n\
3595              command: {}\n\
3596              stdout:\n\
3597              ------------------------------------------\n\
3598              {}\n\
3599              ------------------------------------------\n\
3600              stderr:\n\
3601              ------------------------------------------\n\
3602              {}\n\
3603              ------------------------------------------\n\
3604              \n",
3605             self.status,
3606             self.cmdline,
3607             json::extract_rendered(&self.stdout),
3608             json::extract_rendered(&self.stderr),
3609         );
3610         // Use resume_unwind instead of panic!() to prevent a panic message + backtrace from
3611         // compiletest, which is unnecessary noise.
3612         std::panic::resume_unwind(Box::new(()));
3613     }
3614 }
3615
3616 #[derive(Debug)]
3617 enum TargetLocation {
3618     ThisFile(PathBuf),
3619     ThisDirectory(PathBuf),
3620 }
3621
3622 enum AllowUnused {
3623     Yes,
3624     No,
3625 }
3626
3627 fn read2_abbreviated(mut child: Child) -> io::Result<Output> {
3628     use crate::read2::read2;
3629     use std::mem::replace;
3630
3631     const HEAD_LEN: usize = 160 * 1024;
3632     const TAIL_LEN: usize = 256 * 1024;
3633
3634     enum ProcOutput {
3635         Full(Vec<u8>),
3636         Abbreviated { head: Vec<u8>, skipped: usize, tail: Box<[u8]> },
3637     }
3638
3639     impl ProcOutput {
3640         fn extend(&mut self, data: &[u8]) {
3641             let new_self = match *self {
3642                 ProcOutput::Full(ref mut bytes) => {
3643                     bytes.extend_from_slice(data);
3644                     let new_len = bytes.len();
3645                     if new_len <= HEAD_LEN + TAIL_LEN {
3646                         return;
3647                     }
3648                     let tail = bytes.split_off(new_len - TAIL_LEN).into_boxed_slice();
3649                     let head = replace(bytes, Vec::new());
3650                     let skipped = new_len - HEAD_LEN - TAIL_LEN;
3651                     ProcOutput::Abbreviated { head, skipped, tail }
3652                 }
3653                 ProcOutput::Abbreviated { ref mut skipped, ref mut tail, .. } => {
3654                     *skipped += data.len();
3655                     if data.len() <= TAIL_LEN {
3656                         tail[..data.len()].copy_from_slice(data);
3657                         tail.rotate_left(data.len());
3658                     } else {
3659                         tail.copy_from_slice(&data[(data.len() - TAIL_LEN)..]);
3660                     }
3661                     return;
3662                 }
3663             };
3664             *self = new_self;
3665         }
3666
3667         fn into_bytes(self) -> Vec<u8> {
3668             match self {
3669                 ProcOutput::Full(bytes) => bytes,
3670                 ProcOutput::Abbreviated { mut head, skipped, tail } => {
3671                     write!(&mut head, "\n\n<<<<<< SKIPPED {} BYTES >>>>>>\n\n", skipped).unwrap();
3672                     head.extend_from_slice(&tail);
3673                     head
3674                 }
3675             }
3676         }
3677     }
3678
3679     let mut stdout = ProcOutput::Full(Vec::new());
3680     let mut stderr = ProcOutput::Full(Vec::new());
3681
3682     drop(child.stdin.take());
3683     read2(
3684         child.stdout.take().unwrap(),
3685         child.stderr.take().unwrap(),
3686         &mut |is_stdout, data, _| {
3687             if is_stdout { &mut stdout } else { &mut stderr }.extend(data);
3688             data.clear();
3689         },
3690     )?;
3691     let status = child.wait()?;
3692
3693     Ok(Output { status, stdout: stdout.into_bytes(), stderr: stderr.into_bytes() })
3694 }