src/tools/compiletest/src/header.rs

   1 use std::collections::HashSet;
   2 use std::env;
   3 use std::fs::File;
   4 use std::io::prelude::*;
   5 use std::io::BufReader;
   6 use std::path::{Path, PathBuf};
   7 use std::process::Command;
   8
   9 use tracing::*;
  10
  11 use crate::common::{CompareMode, Config, Debugger, FailMode, Mode, PassMode};
  12 use crate::util;
  13 use crate::{extract_cdb_version, extract_gdb_version};
  14
  15 #[cfg(test)]
  16 mod tests;
  17
  18 /// The result of parse_cfg_name_directive.
  19 #[derive(Clone, Copy, PartialEq, Debug)]
  20 enum ParsedNameDirective {
  21     /// No match.
  22     NoMatch,
  23     /// Match.
  24     Match,
  25 }
  26
  27 /// Properties which must be known very early, before actually running
  28 /// the test.
  29 #[derive(Default)]
  30 pub struct EarlyProps {
  31     pub aux: Vec<String>,
  32     pub aux_crate: Vec<(String, String)>,
  33     pub revisions: Vec<String>,
  34 }
  35
  36 impl EarlyProps {
  37     pub fn from_file(config: &Config, testfile: &Path) -> Self {
  38         let file = File::open(testfile).expect("open test file to parse earlyprops");
  39         Self::from_reader(config, testfile, file)
  40     }
  41
  42     pub fn from_reader<R: Read>(config: &Config, testfile: &Path, rdr: R) -> Self {
  43         let mut props = EarlyProps::default();
  44         iter_header(testfile, rdr, &mut |_, ln| {
  45             config.push_name_value_directive(ln, directives::AUX_BUILD, &mut props.aux, |r| {
  46                 r.trim().to_string()
  47             });
  48             config.push_name_value_directive(
  49                 ln,
  50                 directives::AUX_CRATE,
  51                 &mut props.aux_crate,
  52                 Config::parse_aux_crate,
  53             );
  54             config.parse_and_update_revisions(ln, &mut props.revisions);
  55         });
  56         return props;
  57     }
  58 }
  59
  60 #[derive(Clone, Debug)]
  61 pub struct TestProps {
  62     // Lines that should be expected, in order, on standard out
  63     pub error_patterns: Vec<String>,
  64     // Regexes that should be expected, in order, on standard out
  65     pub regex_error_patterns: Vec<String>,
  66     // Extra flags to pass to the compiler
  67     pub compile_flags: Vec<String>,
  68     // Extra flags to pass when the compiled code is run (such as --bench)
  69     pub run_flags: Option<String>,
  70     // If present, the name of a file that this test should match when
  71     // pretty-printed
  72     pub pp_exact: Option<PathBuf>,
  73     // Other crates that should be compiled (typically from the same
  74     // directory as the test, but for backwards compatibility reasons
  75     // we also check the auxiliary directory)
  76     pub aux_builds: Vec<String>,
  77     // Similar to `aux_builds`, but a list of NAME=somelib.rs of dependencies
  78     // to build and pass with the `--extern` flag.
  79     pub aux_crates: Vec<(String, String)>,
  80     // Environment settings to use for compiling
  81     pub rustc_env: Vec<(String, String)>,
  82     // Environment variables to unset prior to compiling.
  83     // Variables are unset before applying 'rustc_env'.
  84     pub unset_rustc_env: Vec<String>,
  85     // Environment settings to use during execution
  86     pub exec_env: Vec<(String, String)>,
  87     // Build documentation for all specified aux-builds as well
  88     pub build_aux_docs: bool,
  89     // Flag to force a crate to be built with the host architecture
  90     pub force_host: bool,
  91     // Check stdout for error-pattern output as well as stderr
  92     pub check_stdout: bool,
  93     // Check stdout & stderr for output of run-pass test
  94     pub check_run_results: bool,
  95     // For UI tests, allows compiler to generate arbitrary output to stdout
  96     pub dont_check_compiler_stdout: bool,
  97     // For UI tests, allows compiler to generate arbitrary output to stderr
  98     pub dont_check_compiler_stderr: bool,
  99     // Don't force a --crate-type=dylib flag on the command line
 100     //
 101     // Set this for example if you have an auxiliary test file that contains
 102     // a proc-macro and needs `#![crate_type = "proc-macro"]`. This ensures
 103     // that the aux file is compiled as a `proc-macro` and not as a `dylib`.
 104     pub no_prefer_dynamic: bool,
 105     // Run -Zunpretty expanded when running pretty printing tests
 106     pub pretty_expanded: bool,
 107     // Which pretty mode are we testing with, default to 'normal'
 108     pub pretty_mode: String,
 109     // Only compare pretty output and don't try compiling
 110     pub pretty_compare_only: bool,
 111     // Patterns which must not appear in the output of a cfail test.
 112     pub forbid_output: Vec<String>,
 113     // Revisions to test for incremental compilation.
 114     pub revisions: Vec<String>,
 115     // Directory (if any) to use for incremental compilation.  This is
 116     // not set by end-users; rather it is set by the incremental
 117     // testing harness and used when generating compilation
 118     // arguments. (In particular, it propagates to the aux-builds.)
 119     pub incremental_dir: Option<PathBuf>,
 120     // If `true`, this test will use incremental compilation.
 121     //
 122     // This can be set manually with the `incremental` header, or implicitly
 123     // by being a part of an incremental mode test. Using the `incremental`
 124     // header should be avoided if possible; using an incremental mode test is
 125     // preferred. Incremental mode tests support multiple passes, which can
 126     // verify that the incremental cache can be loaded properly after being
 127     // created. Just setting the header will only verify the behavior with
 128     // creating an incremental cache, but doesn't check that it is created
 129     // correctly.
 130     //
 131     // Compiletest will create the incremental directory, and ensure it is
 132     // empty before the test starts. Incremental mode tests will reuse the
 133     // incremental directory between passes in the same test.
 134     pub incremental: bool,
 135     // If `true`, this test is a known bug.
 136     //
 137     // When set, some requirements are relaxed. Currently, this only means no
 138     // error annotations are needed, but this may be updated in the future to
 139     // include other relaxations.
 140     pub known_bug: bool,
 141     // How far should the test proceed while still passing.
 142     pass_mode: Option<PassMode>,
 143     // Ignore `--pass` overrides from the command line for this test.
 144     ignore_pass: bool,
 145     // How far this test should proceed to start failing.
 146     pub fail_mode: Option<FailMode>,
 147     // rustdoc will test the output of the `--test` option
 148     pub check_test_line_numbers_match: bool,
 149     // customized normalization rules
 150     pub normalize_stdout: Vec<(String, String)>,
 151     pub normalize_stderr: Vec<(String, String)>,
 152     pub failure_status: i32,
 153     // Whether or not `rustfix` should apply the `CodeSuggestion`s of this test and compile the
 154     // resulting Rust code.
 155     pub run_rustfix: bool,
 156     // If true, `rustfix` will only apply `MachineApplicable` suggestions.
 157     pub rustfix_only_machine_applicable: bool,
 158     pub assembly_output: Option<String>,
 159     // If true, the test is expected to ICE
 160     pub should_ice: bool,
 161     // If true, the stderr is expected to be different across bit-widths.
 162     pub stderr_per_bitwidth: bool,
 163     // The MIR opt to unit test, if any
 164     pub mir_unit_test: Option<String>,
 165 }
 166
 167 mod directives {
 168     pub const ERROR_PATTERN: &'static str = "error-pattern";
 169     pub const REGEX_ERROR_PATTERN: &'static str = "regex-error-pattern";
 170     pub const COMPILE_FLAGS: &'static str = "compile-flags";
 171     pub const RUN_FLAGS: &'static str = "run-flags";
 172     pub const SHOULD_ICE: &'static str = "should-ice";
 173     pub const BUILD_AUX_DOCS: &'static str = "build-aux-docs";
 174     pub const FORCE_HOST: &'static str = "force-host";
 175     pub const CHECK_STDOUT: &'static str = "check-stdout";
 176     pub const CHECK_RUN_RESULTS: &'static str = "check-run-results";
 177     pub const DONT_CHECK_COMPILER_STDOUT: &'static str = "dont-check-compiler-stdout";
 178     pub const DONT_CHECK_COMPILER_STDERR: &'static str = "dont-check-compiler-stderr";
 179     pub const NO_PREFER_DYNAMIC: &'static str = "no-prefer-dynamic";
 180     pub const PRETTY_EXPANDED: &'static str = "pretty-expanded";
 181     pub const PRETTY_MODE: &'static str = "pretty-mode";
 182     pub const PRETTY_COMPARE_ONLY: &'static str = "pretty-compare-only";
 183     pub const AUX_BUILD: &'static str = "aux-build";
 184     pub const AUX_CRATE: &'static str = "aux-crate";
 185     pub const EXEC_ENV: &'static str = "exec-env";
 186     pub const RUSTC_ENV: &'static str = "rustc-env";
 187     pub const UNSET_RUSTC_ENV: &'static str = "unset-rustc-env";
 188     pub const FORBID_OUTPUT: &'static str = "forbid-output";
 189     pub const CHECK_TEST_LINE_NUMBERS_MATCH: &'static str = "check-test-line-numbers-match";
 190     pub const IGNORE_PASS: &'static str = "ignore-pass";
 191     pub const FAILURE_STATUS: &'static str = "failure-status";
 192     pub const RUN_RUSTFIX: &'static str = "run-rustfix";
 193     pub const RUSTFIX_ONLY_MACHINE_APPLICABLE: &'static str = "rustfix-only-machine-applicable";
 194     pub const ASSEMBLY_OUTPUT: &'static str = "assembly-output";
 195     pub const STDERR_PER_BITWIDTH: &'static str = "stderr-per-bitwidth";
 196     pub const INCREMENTAL: &'static str = "incremental";
 197     pub const KNOWN_BUG: &'static str = "known-bug";
 198     pub const MIR_UNIT_TEST: &'static str = "unit-test";
 199     // This isn't a real directive, just one that is probably mistyped often
 200     pub const INCORRECT_COMPILER_FLAGS: &'static str = "compiler-flags";
 201 }
 202
 203 impl TestProps {
 204     pub fn new() -> Self {
 205         TestProps {
 206             error_patterns: vec![],
 207             regex_error_patterns: vec![],
 208             compile_flags: vec![],
 209             run_flags: None,
 210             pp_exact: None,
 211             aux_builds: vec![],
 212             aux_crates: vec![],
 213             revisions: vec![],
 214             rustc_env: vec![],
 215             unset_rustc_env: vec![],
 216             exec_env: vec![],
 217             build_aux_docs: false,
 218             force_host: false,
 219             check_stdout: false,
 220             check_run_results: false,
 221             dont_check_compiler_stdout: false,
 222             dont_check_compiler_stderr: false,
 223             no_prefer_dynamic: false,
 224             pretty_expanded: false,
 225             pretty_mode: "normal".to_string(),
 226             pretty_compare_only: false,
 227             forbid_output: vec![],
 228             incremental_dir: None,
 229             incremental: false,
 230             known_bug: false,
 231             pass_mode: None,
 232             fail_mode: None,
 233             ignore_pass: false,
 234             check_test_line_numbers_match: false,
 235             normalize_stdout: vec![],
 236             normalize_stderr: vec![],
 237             failure_status: -1,
 238             run_rustfix: false,
 239             rustfix_only_machine_applicable: false,
 240             assembly_output: None,
 241             should_ice: false,
 242             stderr_per_bitwidth: false,
 243             mir_unit_test: None,
 244         }
 245     }
 246
 247     pub fn from_aux_file(&self, testfile: &Path, cfg: Option<&str>, config: &Config) -> Self {
 248         let mut props = TestProps::new();
 249
 250         // copy over select properties to the aux build:
 251         props.incremental_dir = self.incremental_dir.clone();
 252         props.ignore_pass = true;
 253         props.load_from(testfile, cfg, config);
 254
 255         props
 256     }
 257
 258     pub fn from_file(testfile: &Path, cfg: Option<&str>, config: &Config) -> Self {
 259         let mut props = TestProps::new();
 260         props.load_from(testfile, cfg, config);
 261
 262         match (props.pass_mode, props.fail_mode) {
 263             (None, None) if config.mode == Mode::Ui => props.fail_mode = Some(FailMode::Check),
 264             (Some(_), Some(_)) => panic!("cannot use a *-fail and *-pass mode together"),
 265             _ => {}
 266         }
 267
 268         props
 269     }
 270
 271     /// Loads properties from `testfile` into `props`. If a property is
 272     /// tied to a particular revision `foo` (indicated by writing
 273     /// `//[foo]`), then the property is ignored unless `cfg` is
 274     /// `Some("foo")`.
 275     fn load_from(&mut self, testfile: &Path, cfg: Option<&str>, config: &Config) {
 276         let mut has_edition = false;
 277         if !testfile.is_dir() {
 278             let file = File::open(testfile).unwrap();
 279
 280             iter_header(testfile, file, &mut |revision, ln| {
 281                 if revision.is_some() && revision != cfg {
 282                     return;
 283                 }
 284
 285                 use directives::*;
 286
 287                 config.push_name_value_directive(
 288                     ln,
 289                     ERROR_PATTERN,
 290                     &mut self.error_patterns,
 291                     |r| r,
 292                 );
 293                 config.push_name_value_directive(
 294                     ln,
 295                     REGEX_ERROR_PATTERN,
 296                     &mut self.regex_error_patterns,
 297                     |r| r,
 298                 );
 299
 300                 if let Some(flags) = config.parse_name_value_directive(ln, COMPILE_FLAGS) {
 301                     self.compile_flags.extend(flags.split_whitespace().map(|s| s.to_owned()));
 302                 }
 303                 if config.parse_name_value_directive(ln, INCORRECT_COMPILER_FLAGS).is_some() {
 304                     panic!("`compiler-flags` directive should be spelled `compile-flags`");
 305                 }
 306
 307                 if let Some(edition) = config.parse_edition(ln) {
 308                     self.compile_flags.push(format!("--edition={}", edition.trim()));
 309                     has_edition = true;
 310                 }
 311
 312                 config.parse_and_update_revisions(ln, &mut self.revisions);
 313
 314                 config.set_name_value_directive(ln, RUN_FLAGS, &mut self.run_flags, |r| r);
 315
 316                 if self.pp_exact.is_none() {
 317                     self.pp_exact = config.parse_pp_exact(ln, testfile);
 318                 }
 319
 320                 config.set_name_directive(ln, SHOULD_ICE, &mut self.should_ice);
 321                 config.set_name_directive(ln, BUILD_AUX_DOCS, &mut self.build_aux_docs);
 322                 config.set_name_directive(ln, FORCE_HOST, &mut self.force_host);
 323                 config.set_name_directive(ln, CHECK_STDOUT, &mut self.check_stdout);
 324                 config.set_name_directive(ln, CHECK_RUN_RESULTS, &mut self.check_run_results);
 325                 config.set_name_directive(
 326                     ln,
 327                     DONT_CHECK_COMPILER_STDOUT,
 328                     &mut self.dont_check_compiler_stdout,
 329                 );
 330                 config.set_name_directive(
 331                     ln,
 332                     DONT_CHECK_COMPILER_STDERR,
 333                     &mut self.dont_check_compiler_stderr,
 334                 );
 335                 config.set_name_directive(ln, NO_PREFER_DYNAMIC, &mut self.no_prefer_dynamic);
 336                 config.set_name_directive(ln, PRETTY_EXPANDED, &mut self.pretty_expanded);
 337
 338                 if let Some(m) = config.parse_name_value_directive(ln, PRETTY_MODE) {
 339                     self.pretty_mode = m;
 340                 }
 341
 342                 config.set_name_directive(ln, PRETTY_COMPARE_ONLY, &mut self.pretty_compare_only);
 343                 config.push_name_value_directive(ln, AUX_BUILD, &mut self.aux_builds, |r| {
 344                     r.trim().to_string()
 345                 });
 346                 config.push_name_value_directive(
 347                     ln,
 348                     AUX_CRATE,
 349                     &mut self.aux_crates,
 350                     Config::parse_aux_crate,
 351                 );
 352                 config.push_name_value_directive(
 353                     ln,
 354                     EXEC_ENV,
 355                     &mut self.exec_env,
 356                     Config::parse_env,
 357                 );
 358                 config.push_name_value_directive(
 359                     ln,
 360                     RUSTC_ENV,
 361                     &mut self.rustc_env,
 362                     Config::parse_env,
 363                 );
 364                 config.push_name_value_directive(
 365                     ln,
 366                     UNSET_RUSTC_ENV,
 367                     &mut self.unset_rustc_env,
 368                     |r| r,
 369                 );
 370                 config.push_name_value_directive(ln, FORBID_OUTPUT, &mut self.forbid_output, |r| r);
 371                 config.set_name_directive(
 372                     ln,
 373                     CHECK_TEST_LINE_NUMBERS_MATCH,
 374                     &mut self.check_test_line_numbers_match,
 375                 );
 376
 377                 self.update_pass_mode(ln, cfg, config);
 378                 self.update_fail_mode(ln, config);
 379
 380                 config.set_name_directive(ln, IGNORE_PASS, &mut self.ignore_pass);
 381
 382                 if let Some(rule) = config.parse_custom_normalization(ln, "normalize-stdout") {
 383                     self.normalize_stdout.push(rule);
 384                 }
 385                 if let Some(rule) = config.parse_custom_normalization(ln, "normalize-stderr") {
 386                     self.normalize_stderr.push(rule);
 387                 }
 388
 389                 if let Some(code) = config
 390                     .parse_name_value_directive(ln, FAILURE_STATUS)
 391                     .and_then(|code| code.trim().parse::<i32>().ok())
 392                 {
 393                     self.failure_status = code;
 394                 }
 395
 396                 config.set_name_directive(ln, RUN_RUSTFIX, &mut self.run_rustfix);
 397                 config.set_name_directive(
 398                     ln,
 399                     RUSTFIX_ONLY_MACHINE_APPLICABLE,
 400                     &mut self.rustfix_only_machine_applicable,
 401                 );
 402                 config.set_name_value_directive(
 403                     ln,
 404                     ASSEMBLY_OUTPUT,
 405                     &mut self.assembly_output,
 406                     |r| r.trim().to_string(),
 407                 );
 408                 config.set_name_directive(ln, STDERR_PER_BITWIDTH, &mut self.stderr_per_bitwidth);
 409                 config.set_name_directive(ln, INCREMENTAL, &mut self.incremental);
 410
 411                 // Unlike the other `name_value_directive`s this needs to be handled manually,
 412                 // because it sets a `bool` flag.
 413                 if let Some(known_bug) = config.parse_name_value_directive(ln, KNOWN_BUG) {
 414                     let known_bug = known_bug.trim();
 415                     if known_bug == "unknown"
 416                         || known_bug.split(',').all(|issue_ref| {
 417                             issue_ref
 418                                 .trim()
 419                                 .split_once('#')
 420                                 .filter(|(_, number)| {
 421                                     number.chars().all(|digit| digit.is_numeric())
 422                                 })
 423                                 .is_some()
 424                         })
 425                     {
 426                         self.known_bug = true;
 427                     } else {
 428                         panic!(
 429                             "Invalid known-bug value: {known_bug}\nIt requires comma-separated issue references (`#000` or `chalk#000`) or `known-bug: unknown`."
 430                         );
 431                     }
 432                 } else if config.parse_name_directive(ln, KNOWN_BUG) {
 433                     panic!(
 434                         "Invalid known-bug attribute, requires comma-separated issue references (`#000` or `chalk#000`) or `known-bug: unknown`."
 435                     );
 436                 }
 437
 438                 config.set_name_value_directive(ln, MIR_UNIT_TEST, &mut self.mir_unit_test, |s| {
 439                     s.trim().to_string()
 440                 });
 441             });
 442         }
 443
 444         if self.failure_status == -1 {
 445             self.failure_status = 1;
 446         }
 447         if self.should_ice {
 448             self.failure_status = 101;
 449         }
 450
 451         if config.mode == Mode::Incremental {
 452             self.incremental = true;
 453         }
 454
 455         for key in &["RUST_TEST_NOCAPTURE", "RUST_TEST_THREADS"] {
 456             if let Ok(val) = env::var(key) {
 457                 if self.exec_env.iter().find(|&&(ref x, _)| x == key).is_none() {
 458                     self.exec_env.push(((*key).to_owned(), val))
 459                 }
 460             }
 461         }
 462
 463         if let (Some(edition), false) = (&config.edition, has_edition) {
 464             self.compile_flags.push(format!("--edition={}", edition));
 465         }
 466     }
 467
 468     fn update_fail_mode(&mut self, ln: &str, config: &Config) {
 469         let check_ui = |mode: &str| {
 470             if config.mode != Mode::Ui {
 471                 panic!("`{}-fail` header is only supported in UI tests", mode);
 472             }
 473         };
 474         if config.mode == Mode::Ui && config.parse_name_directive(ln, "compile-fail") {
 475             panic!("`compile-fail` header is useless in UI tests");
 476         }
 477         let fail_mode = if config.parse_name_directive(ln, "check-fail") {
 478             check_ui("check");
 479             Some(FailMode::Check)
 480         } else if config.parse_name_directive(ln, "build-fail") {
 481             check_ui("build");
 482             Some(FailMode::Build)
 483         } else if config.parse_name_directive(ln, "run-fail") {
 484             check_ui("run");
 485             Some(FailMode::Run)
 486         } else {
 487             None
 488         };
 489         match (self.fail_mode, fail_mode) {
 490             (None, Some(_)) => self.fail_mode = fail_mode,
 491             (Some(_), Some(_)) => panic!("multiple `*-fail` headers in a single test"),
 492             (_, None) => {}
 493         }
 494     }
 495
 496     fn update_pass_mode(&mut self, ln: &str, revision: Option<&str>, config: &Config) {
 497         let check_no_run = |s| {
 498             if config.mode != Mode::Ui && config.mode != Mode::Incremental {
 499                 panic!("`{}` header is only supported in UI and incremental tests", s);
 500             }
 501             if config.mode == Mode::Incremental
 502                 && !revision.map_or(false, |r| r.starts_with("cfail"))
 503                 && !self.revisions.iter().all(|r| r.starts_with("cfail"))
 504             {
 505                 panic!("`{}` header is only supported in `cfail` incremental tests", s);
 506             }
 507         };
 508         let pass_mode = if config.parse_name_directive(ln, "check-pass") {
 509             check_no_run("check-pass");
 510             Some(PassMode::Check)
 511         } else if config.parse_name_directive(ln, "build-pass") {
 512             check_no_run("build-pass");
 513             Some(PassMode::Build)
 514         } else if config.parse_name_directive(ln, "run-pass") {
 515             if config.mode != Mode::Ui {
 516                 panic!("`run-pass` header is only supported in UI tests")
 517             }
 518             Some(PassMode::Run)
 519         } else {
 520             None
 521         };
 522         match (self.pass_mode, pass_mode) {
 523             (None, Some(_)) => self.pass_mode = pass_mode,
 524             (Some(_), Some(_)) => panic!("multiple `*-pass` headers in a single test"),
 525             (_, None) => {}
 526         }
 527     }
 528
 529     pub fn pass_mode(&self, config: &Config) -> Option<PassMode> {
 530         if !self.ignore_pass && self.fail_mode.is_none() {
 531             if let mode @ Some(_) = config.force_pass_mode {
 532                 return mode;
 533             }
 534         }
 535         self.pass_mode
 536     }
 537
 538     // does not consider CLI override for pass mode
 539     pub fn local_pass_mode(&self) -> Option<PassMode> {
 540         self.pass_mode
 541     }
 542 }
 543
 544 pub fn line_directive<'line>(
 545     comment: &str,
 546     ln: &'line str,
 547 ) -> Option<(Option<&'line str>, &'line str)> {
 548     if ln.starts_with(comment) {
 549         let ln = ln[comment.len()..].trim_start();
 550         if ln.starts_with('[') {
 551             // A comment like `//[foo]` is specific to revision `foo`
 552             if let Some(close_brace) = ln.find(']') {
 553                 let lncfg = &ln[1..close_brace];
 554
 555                 Some((Some(lncfg), ln[(close_brace + 1)..].trim_start()))
 556             } else {
 557                 panic!("malformed condition directive: expected `{}[foo]`, found `{}`", comment, ln)
 558             }
 559         } else {
 560             Some((None, ln))
 561         }
 562     } else {
 563         None
 564     }
 565 }
 566
 567 fn iter_header<R: Read>(testfile: &Path, rdr: R, it: &mut dyn FnMut(Option<&str>, &str)) {
 568     if testfile.is_dir() {
 569         return;
 570     }
 571
 572     let comment = if testfile.extension().map(|e| e == "rs") == Some(true) { "//" } else { "#" };
 573
 574     let mut rdr = BufReader::new(rdr);
 575     let mut ln = String::new();
 576
 577     loop {
 578         ln.clear();
 579         if rdr.read_line(&mut ln).unwrap() == 0 {
 580             break;
 581         }
 582
 583         // Assume that any directives will be found before the first
 584         // module or function. This doesn't seem to be an optimization
 585         // with a warm page cache. Maybe with a cold one.
 586         let ln = ln.trim();
 587         if ln.starts_with("fn") || ln.starts_with("mod") {
 588             return;
 589         } else if let Some((lncfg, ln)) = line_directive(comment, ln) {
 590             it(lncfg, ln);
 591         }
 592     }
 593 }
 594
 595 impl Config {
 596     fn parse_aux_crate(r: String) -> (String, String) {
 597         let mut parts = r.trim().splitn(2, '=');
 598         (
 599             parts.next().expect("missing aux-crate name (e.g. log=log.rs)").to_string(),
 600             parts.next().expect("missing aux-crate value (e.g. log=log.rs)").to_string(),
 601         )
 602     }
 603
 604     fn parse_and_update_revisions(&self, line: &str, existing: &mut Vec<String>) {
 605         if let Some(raw) = self.parse_name_value_directive(line, "revisions") {
 606             let mut duplicates: HashSet<_> = existing.iter().cloned().collect();
 607             for revision in raw.split_whitespace().map(|r| r.to_string()) {
 608                 if !duplicates.insert(revision.clone()) {
 609                     panic!("Duplicate revision: `{}` in line `{}`", revision, raw);
 610                 }
 611                 existing.push(revision);
 612             }
 613         }
 614     }
 615
 616     fn parse_env(nv: String) -> (String, String) {
 617         // nv is either FOO or FOO=BAR
 618         let mut strs: Vec<String> = nv.splitn(2, '=').map(str::to_owned).collect();
 619
 620         match strs.len() {
 621             1 => (strs.pop().unwrap(), String::new()),
 622             2 => {
 623                 let end = strs.pop().unwrap();
 624                 (strs.pop().unwrap(), end)
 625             }
 626             n => panic!("Expected 1 or 2 strings, not {}", n),
 627         }
 628     }
 629
 630     fn parse_pp_exact(&self, line: &str, testfile: &Path) -> Option<PathBuf> {
 631         if let Some(s) = self.parse_name_value_directive(line, "pp-exact") {
 632             Some(PathBuf::from(&s))
 633         } else if self.parse_name_directive(line, "pp-exact") {
 634             testfile.file_name().map(PathBuf::from)
 635         } else {
 636             None
 637         }
 638     }
 639
 640     fn parse_custom_normalization(&self, mut line: &str, prefix: &str) -> Option<(String, String)> {
 641         if self.parse_cfg_name_directive(line, prefix) == ParsedNameDirective::Match {
 642             let from = parse_normalization_string(&mut line)?;
 643             let to = parse_normalization_string(&mut line)?;
 644             Some((from, to))
 645         } else {
 646             None
 647         }
 648     }
 649
 650     fn parse_needs_matching_clang(&self, line: &str) -> bool {
 651         self.parse_name_directive(line, "needs-matching-clang")
 652     }
 653
 654     fn parse_needs_profiler_support(&self, line: &str) -> bool {
 655         self.parse_name_directive(line, "needs-profiler-support")
 656     }
 657
 658     /// Parses a name-value directive which contains config-specific information, e.g., `ignore-x86`
 659     /// or `normalize-stderr-32bit`.
 660     fn parse_cfg_name_directive(&self, line: &str, prefix: &str) -> ParsedNameDirective {
 661         if !line.as_bytes().starts_with(prefix.as_bytes()) {
 662             return ParsedNameDirective::NoMatch;
 663         }
 664         if line.as_bytes().get(prefix.len()) != Some(&b'-') {
 665             return ParsedNameDirective::NoMatch;
 666         }
 667
 668         let name = line[prefix.len() + 1..].split(&[':', ' '][..]).next().unwrap();
 669
 670         let matches_pointer_width = || {
 671             name.strip_suffix("bit")
 672                 .and_then(|width| width.parse::<u32>().ok())
 673                 .map(|width| self.get_pointer_width() == width)
 674                 .unwrap_or(false)
 675         };
 676
 677         // If something is ignored for emscripten, it likely also needs to be
 678         // ignored for wasm32-unknown-unknown.
 679         // `wasm32-bare` is an alias to refer to just wasm32-unknown-unknown
 680         // (in contrast to `wasm32` which also matches non-bare targets like
 681         // asmjs-unknown-emscripten).
 682         let matches_wasm32_alias = || {
 683             self.target == "wasm32-unknown-unknown" && matches!(name, "emscripten" | "wasm32-bare")
 684         };
 685
 686         let is_match = name == "test" ||
 687             self.target == name ||                              // triple
 688             self.matches_os(name) ||
 689             self.matches_env(name) ||
 690             self.matches_abi(name) ||
 691             self.matches_family(name) ||
 692             self.target.ends_with(name) ||                      // target and env
 693             self.matches_arch(name) ||
 694             matches_wasm32_alias() ||
 695             matches_pointer_width() ||
 696             name == self.stage_id.split('-').next().unwrap() || // stage
 697             name == self.channel ||                             // channel
 698             (self.target != self.host && name == "cross-compile") ||
 699             (name == "endian-big" && self.is_big_endian()) ||
 700             (self.remote_test_client.is_some() && name == "remote") ||
 701             match self.compare_mode {
 702                 Some(CompareMode::Polonius) => name == "compare-mode-polonius",
 703                 Some(CompareMode::Chalk) => name == "compare-mode-chalk",
 704                 Some(CompareMode::SplitDwarf) => name == "compare-mode-split-dwarf",
 705                 Some(CompareMode::SplitDwarfSingle) => name == "compare-mode-split-dwarf-single",
 706                 None => false,
 707             } ||
 708             (cfg!(debug_assertions) && name == "debug") ||
 709             match self.debugger {
 710                 Some(Debugger::Cdb) => name == "cdb",
 711                 Some(Debugger::Gdb) => name == "gdb",
 712                 Some(Debugger::Lldb) => name == "lldb",
 713                 None => false,
 714             };
 715
 716         if is_match { ParsedNameDirective::Match } else { ParsedNameDirective::NoMatch }
 717     }
 718
 719     fn has_cfg_prefix(&self, line: &str, prefix: &str) -> bool {
 720         // returns whether this line contains this prefix or not. For prefix
 721         // "ignore", returns true if line says "ignore-x86_64", "ignore-arch",
 722         // "ignore-android" etc.
 723         line.starts_with(prefix) && line.as_bytes().get(prefix.len()) == Some(&b'-')
 724     }
 725
 726     fn parse_name_directive(&self, line: &str, directive: &str) -> bool {
 727         // Ensure the directive is a whole word. Do not match "ignore-x86" when
 728         // the line says "ignore-x86_64".
 729         line.starts_with(directive)
 730             && matches!(line.as_bytes().get(directive.len()), None | Some(&b' ') | Some(&b':'))
 731     }
 732
 733     pub fn parse_name_value_directive(&self, line: &str, directive: &str) -> Option<String> {
 734         let colon = directive.len();
 735         if line.starts_with(directive) && line.as_bytes().get(colon) == Some(&b':') {
 736             let value = line[(colon + 1)..].to_owned();
 737             debug!("{}: {}", directive, value);
 738             Some(expand_variables(value, self))
 739         } else {
 740             None
 741         }
 742     }
 743
 744     pub fn find_rust_src_root(&self) -> Option<PathBuf> {
 745         let mut path = self.src_base.clone();
 746         let path_postfix = Path::new("src/etc/lldb_batchmode.py");
 747
 748         while path.pop() {
 749             if path.join(&path_postfix).is_file() {
 750                 return Some(path);
 751             }
 752         }
 753
 754         None
 755     }
 756
 757     fn parse_edition(&self, line: &str) -> Option<String> {
 758         self.parse_name_value_directive(line, "edition")
 759     }
 760
 761     fn set_name_directive(&self, line: &str, directive: &str, value: &mut bool) {
 762         if !*value {
 763             *value = self.parse_name_directive(line, directive)
 764         }
 765     }
 766
 767     fn set_name_value_directive<T>(
 768         &self,
 769         line: &str,
 770         directive: &str,
 771         value: &mut Option<T>,
 772         parse: impl FnOnce(String) -> T,
 773     ) {
 774         if value.is_none() {
 775             *value = self.parse_name_value_directive(line, directive).map(parse);
 776         }
 777     }
 778
 779     fn push_name_value_directive<T>(
 780         &self,
 781         line: &str,
 782         directive: &str,
 783         values: &mut Vec<T>,
 784         parse: impl FnOnce(String) -> T,
 785     ) {
 786         if let Some(value) = self.parse_name_value_directive(line, directive).map(parse) {
 787             values.push(value);
 788         }
 789     }
 790 }
 791
 792 fn expand_variables(mut value: String, config: &Config) -> String {
 793     const CWD: &str = "{{cwd}}";
 794     const SRC_BASE: &str = "{{src-base}}";
 795     const BUILD_BASE: &str = "{{build-base}}";
 796
 797     if value.contains(CWD) {
 798         let cwd = env::current_dir().unwrap();
 799         value = value.replace(CWD, &cwd.to_string_lossy());
 800     }
 801
 802     if value.contains(SRC_BASE) {
 803         value = value.replace(SRC_BASE, &config.src_base.to_string_lossy());
 804     }
 805
 806     if value.contains(BUILD_BASE) {
 807         value = value.replace(BUILD_BASE, &config.build_base.to_string_lossy());
 808     }
 809
 810     value
 811 }
 812
 813 /// Finds the next quoted string `"..."` in `line`, and extract the content from it. Move the `line`
 814 /// variable after the end of the quoted string.
 815 ///
 816 /// # Examples
 817 ///
 818 /// ```
 819 /// let mut s = "normalize-stderr-32bit: \"something (32 bits)\" -> \"something ($WORD bits)\".";
 820 /// let first = parse_normalization_string(&mut s);
 821 /// assert_eq!(first, Some("something (32 bits)".to_owned()));
 822 /// assert_eq!(s, " -> \"something ($WORD bits)\".");
 823 /// ```
 824 fn parse_normalization_string(line: &mut &str) -> Option<String> {
 825     // FIXME support escapes in strings.
 826     let begin = line.find('"')? + 1;
 827     let end = line[begin..].find('"')? + begin;
 828     let result = line[begin..end].to_owned();
 829     *line = &line[end + 1..];
 830     Some(result)
 831 }
 832
 833 pub fn extract_llvm_version(version: &str) -> Option<u32> {
 834     let pat = |c: char| !c.is_ascii_digit() && c != '.';
 835     let version_without_suffix = match version.find(pat) {
 836         Some(pos) => &version[..pos],
 837         None => version,
 838     };
 839     let components: Vec<u32> = version_without_suffix
 840         .split('.')
 841         .map(|s| s.parse().expect("Malformed version component"))
 842         .collect();
 843     let version = match *components {
 844         [a] => a * 10_000,
 845         [a, b] => a * 10_000 + b * 100,
 846         [a, b, c] => a * 10_000 + b * 100 + c,
 847         _ => panic!("Malformed version"),
 848     };
 849     Some(version)
 850 }
 851
 852 pub fn extract_llvm_version_from_binary(binary_path: &str) -> Option<u32> {
 853     let output = Command::new(binary_path).arg("--version").output().ok()?;
 854     if !output.status.success() {
 855         return None;
 856     }
 857     let version = String::from_utf8(output.stdout).ok()?;
 858     for line in version.lines() {
 859         if let Some(version) = line.split("LLVM version ").skip(1).next() {
 860             return extract_llvm_version(version);
 861         }
 862     }
 863     None
 864 }
 865
 866 /// Takes a directive of the form "<version1> [- <version2>]",
 867 /// returns the numeric representation of <version1> and <version2> as
 868 /// tuple: (<version1> as u32, <version2> as u32)
 869 ///
 870 /// If the <version2> part is omitted, the second component of the tuple
 871 /// is the same as <version1>.
 872 fn extract_version_range<F>(line: &str, parse: F) -> Option<(u32, u32)>
 873 where
 874     F: Fn(&str) -> Option<u32>,
 875 {
 876     let mut splits = line.splitn(2, "- ").map(str::trim);
 877     let min = splits.next().unwrap();
 878     if min.ends_with('-') {
 879         return None;
 880     }
 881
 882     let max = splits.next();
 883
 884     if min.is_empty() {
 885         return None;
 886     }
 887
 888     let min = parse(min)?;
 889     let max = match max {
 890         Some(max) if max.is_empty() => return None,
 891         Some(max) => parse(max)?,
 892         _ => min,
 893     };
 894
 895     Some((min, max))
 896 }
 897
 898 pub fn make_test_description<R: Read>(
 899     config: &Config,
 900     name: test::TestName,
 901     path: &Path,
 902     src: R,
 903     cfg: Option<&str>,
 904 ) -> test::TestDesc {
 905     let mut ignore = false;
 906     let ignore_message = None;
 907     let mut should_fail = false;
 908
 909     let rustc_has_profiler_support = env::var_os("RUSTC_PROFILER_SUPPORT").is_some();
 910     let rustc_has_sanitizer_support = env::var_os("RUSTC_SANITIZER_SUPPORT").is_some();
 911     let has_asm_support = config.has_asm_support();
 912     let has_asan = util::ASAN_SUPPORTED_TARGETS.contains(&&*config.target);
 913     let has_cfi = util::CFI_SUPPORTED_TARGETS.contains(&&*config.target);
 914     let has_kcfi = util::KCFI_SUPPORTED_TARGETS.contains(&&*config.target);
 915     let has_lsan = util::LSAN_SUPPORTED_TARGETS.contains(&&*config.target);
 916     let has_msan = util::MSAN_SUPPORTED_TARGETS.contains(&&*config.target);
 917     let has_tsan = util::TSAN_SUPPORTED_TARGETS.contains(&&*config.target);
 918     let has_hwasan = util::HWASAN_SUPPORTED_TARGETS.contains(&&*config.target);
 919     let has_memtag = util::MEMTAG_SUPPORTED_TARGETS.contains(&&*config.target);
 920     let has_shadow_call_stack = util::SHADOWCALLSTACK_SUPPORTED_TARGETS.contains(&&*config.target);
 921
 922     // For tests using the `needs-rust-lld` directive (e.g. for `-Zgcc-ld=lld`), we need to find
 923     // whether `rust-lld` is present in the compiler under test.
 924     //
 925     // The --compile-lib-path is the path to host shared libraries, but depends on the OS. For
 926     // example:
 927     // - on linux, it can be <sysroot>/lib
 928     // - on windows, it can be <sysroot>/bin
 929     //
 930     // However, `rust-lld` is only located under the lib path, so we look for it there.
 931     let has_rust_lld = config
 932         .compile_lib_path
 933         .parent()
 934         .expect("couldn't traverse to the parent of the specified --compile-lib-path")
 935         .join("lib")
 936         .join("rustlib")
 937         .join(&config.target)
 938         .join("bin")
 939         .join(if config.host.contains("windows") { "rust-lld.exe" } else { "rust-lld" })
 940         .exists();
 941
 942     iter_header(path, src, &mut |revision, ln| {
 943         if revision.is_some() && revision != cfg {
 944             return;
 945         }
 946         ignore = match config.parse_cfg_name_directive(ln, "ignore") {
 947             ParsedNameDirective::Match => true,
 948             ParsedNameDirective::NoMatch => ignore,
 949         };
 950         if config.has_cfg_prefix(ln, "only") {
 951             ignore = match config.parse_cfg_name_directive(ln, "only") {
 952                 ParsedNameDirective::Match => ignore,
 953                 ParsedNameDirective::NoMatch => true,
 954             };
 955         }
 956         ignore |= ignore_llvm(config, ln);
 957         ignore |=
 958             config.run_clang_based_tests_with.is_none() && config.parse_needs_matching_clang(ln);
 959         ignore |= !has_asm_support && config.parse_name_directive(ln, "needs-asm-support");
 960         ignore |= !rustc_has_profiler_support && config.parse_needs_profiler_support(ln);
 961         ignore |= !config.run_enabled() && config.parse_name_directive(ln, "needs-run-enabled");
 962         ignore |= !rustc_has_sanitizer_support
 963             && config.parse_name_directive(ln, "needs-sanitizer-support");
 964         ignore |= !has_asan && config.parse_name_directive(ln, "needs-sanitizer-address");
 965         ignore |= !has_cfi && config.parse_name_directive(ln, "needs-sanitizer-cfi");
 966         ignore |= !has_kcfi && config.parse_name_directive(ln, "needs-sanitizer-kcfi");
 967         ignore |= !has_lsan && config.parse_name_directive(ln, "needs-sanitizer-leak");
 968         ignore |= !has_msan && config.parse_name_directive(ln, "needs-sanitizer-memory");
 969         ignore |= !has_tsan && config.parse_name_directive(ln, "needs-sanitizer-thread");
 970         ignore |= !has_hwasan && config.parse_name_directive(ln, "needs-sanitizer-hwaddress");
 971         ignore |= !has_memtag && config.parse_name_directive(ln, "needs-sanitizer-memtag");
 972         ignore |= !has_shadow_call_stack
 973             && config.parse_name_directive(ln, "needs-sanitizer-shadow-call-stack");
 974         ignore |= !config.can_unwind() && config.parse_name_directive(ln, "needs-unwind");
 975         ignore |= config.target == "wasm32-unknown-unknown"
 976             && config.parse_name_directive(ln, directives::CHECK_RUN_RESULTS);
 977         ignore |= config.debugger == Some(Debugger::Cdb) && ignore_cdb(config, ln);
 978         ignore |= config.debugger == Some(Debugger::Gdb) && ignore_gdb(config, ln);
 979         ignore |= config.debugger == Some(Debugger::Lldb) && ignore_lldb(config, ln);
 980         ignore |= !has_rust_lld && config.parse_name_directive(ln, "needs-rust-lld");
 981         should_fail |= config.parse_name_directive(ln, "should-fail");
 982     });
 983
 984     // The `should-fail` annotation doesn't apply to pretty tests,
 985     // since we run the pretty printer across all tests by default.
 986     // If desired, we could add a `should-fail-pretty` annotation.
 987     let should_panic = match config.mode {
 988         crate::common::Pretty => test::ShouldPanic::No,
 989         _ if should_fail => test::ShouldPanic::Yes,
 990         _ => test::ShouldPanic::No,
 991     };
 992
 993     test::TestDesc {
 994         name,
 995         ignore,
 996         ignore_message,
 997         should_panic,
 998         compile_fail: false,
 999         no_run: false,
1000         test_type: test::TestType::Unknown,
1001     }
1002 }
1003
1004 fn ignore_cdb(config: &Config, line: &str) -> bool {
1005     if let Some(actual_version) = config.cdb_version {
1006         if let Some(min_version) = line.strip_prefix("min-cdb-version:").map(str::trim) {
1007             let min_version = extract_cdb_version(min_version).unwrap_or_else(|| {
1008                 panic!("couldn't parse version range: {:?}", min_version);
1009             });
1010
1011             // Ignore if actual version is smaller than the minimum
1012             // required version
1013             return actual_version < min_version;
1014         }
1015     }
1016     false
1017 }
1018
1019 fn ignore_gdb(config: &Config, line: &str) -> bool {
1020     if let Some(actual_version) = config.gdb_version {
1021         if let Some(rest) = line.strip_prefix("min-gdb-version:").map(str::trim) {
1022             let (start_ver, end_ver) = extract_version_range(rest, extract_gdb_version)
1023                 .unwrap_or_else(|| {
1024                     panic!("couldn't parse version range: {:?}", rest);
1025                 });
1026
1027             if start_ver != end_ver {
1028                 panic!("Expected single GDB version")
1029             }
1030             // Ignore if actual version is smaller than the minimum
1031             // required version
1032             return actual_version < start_ver;
1033         } else if let Some(rest) = line.strip_prefix("ignore-gdb-version:").map(str::trim) {
1034             let (min_version, max_version) = extract_version_range(rest, extract_gdb_version)
1035                 .unwrap_or_else(|| {
1036                     panic!("couldn't parse version range: {:?}", rest);
1037                 });
1038
1039             if max_version < min_version {
1040                 panic!("Malformed GDB version range: max < min")
1041             }
1042
1043             return actual_version >= min_version && actual_version <= max_version;
1044         }
1045     }
1046     false
1047 }
1048
1049 fn ignore_lldb(config: &Config, line: &str) -> bool {
1050     if let Some(actual_version) = config.lldb_version {
1051         if let Some(min_version) = line.strip_prefix("min-lldb-version:").map(str::trim) {
1052             let min_version = min_version.parse().unwrap_or_else(|e| {
1053                 panic!("Unexpected format of LLDB version string: {}\n{:?}", min_version, e);
1054             });
1055             // Ignore if actual version is smaller the minimum required
1056             // version
1057             actual_version < min_version
1058         } else {
1059             line.starts_with("rust-lldb") && !config.lldb_native_rust
1060         }
1061     } else {
1062         false
1063     }
1064 }
1065
1066 fn ignore_llvm(config: &Config, line: &str) -> bool {
1067     if config.system_llvm && line.starts_with("no-system-llvm") {
1068         return true;
1069     }
1070     if let Some(needed_components) =
1071         config.parse_name_value_directive(line, "needs-llvm-components")
1072     {
1073         let components: HashSet<_> = config.llvm_components.split_whitespace().collect();
1074         if let Some(missing_component) = needed_components
1075             .split_whitespace()
1076             .find(|needed_component| !components.contains(needed_component))
1077         {
1078             if env::var_os("COMPILETEST_NEEDS_ALL_LLVM_COMPONENTS").is_some() {
1079                 panic!("missing LLVM component: {}", missing_component);
1080             }
1081             return true;
1082         }
1083     }
1084     if let Some(actual_version) = config.llvm_version {
1085         if let Some(rest) = line.strip_prefix("min-llvm-version:").map(str::trim) {
1086             let min_version = extract_llvm_version(rest).unwrap();
1087             // Ignore if actual version is smaller the minimum required
1088             // version
1089             actual_version < min_version
1090         } else if let Some(rest) = line.strip_prefix("min-system-llvm-version:").map(str::trim) {
1091             let min_version = extract_llvm_version(rest).unwrap();
1092             // Ignore if using system LLVM and actual version
1093             // is smaller the minimum required version
1094             config.system_llvm && actual_version < min_version
1095         } else if let Some(rest) = line.strip_prefix("ignore-llvm-version:").map(str::trim) {
1096             // Syntax is: "ignore-llvm-version: <version1> [- <version2>]"
1097             let (v_min, v_max) =
1098                 extract_version_range(rest, extract_llvm_version).unwrap_or_else(|| {
1099                     panic!("couldn't parse version range: {:?}", rest);
1100                 });
1101             if v_max < v_min {
1102                 panic!("Malformed LLVM version range: max < min")
1103             }
1104             // Ignore if version lies inside of range.
1105             actual_version >= v_min && actual_version <= v_max
1106         } else {
1107             false
1108         }
1109     } else {
1110         false
1111     }
1112 }