]> git.lizzy.rs Git - rust.git/blob - src/tools/compiletest/src/header.rs
Rollup merge of #59911 - pnkfelix:revert-pr-59401-to-fix-emit-stack-sizes-gc-sections...
[rust.git] / src / tools / compiletest / src / header.rs
1 use std::env;
2 use std::fs::File;
3 use std::io::prelude::*;
4 use std::io::BufReader;
5 use std::path::{Path, PathBuf};
6
7 use crate::common::{self, CompareMode, Config, Mode};
8 use crate::util;
9
10 use crate::extract_gdb_version;
11
12 /// Whether to ignore the test.
13 #[derive(Clone, Copy, PartialEq, Debug)]
14 pub enum Ignore {
15     /// Runs it.
16     Run,
17     /// Ignore it totally.
18     Ignore,
19     /// Ignore only the gdb test, but run the lldb test.
20     IgnoreGdb,
21     /// Ignore only the lldb test, but run the gdb test.
22     IgnoreLldb,
23 }
24
25 impl Ignore {
26     pub fn can_run_gdb(&self) -> bool {
27         *self == Ignore::Run || *self == Ignore::IgnoreLldb
28     }
29
30     pub fn can_run_lldb(&self) -> bool {
31         *self == Ignore::Run || *self == Ignore::IgnoreGdb
32     }
33
34     pub fn no_gdb(&self) -> Ignore {
35         match *self {
36             Ignore::Run => Ignore::IgnoreGdb,
37             Ignore::IgnoreGdb => Ignore::IgnoreGdb,
38             _ => Ignore::Ignore,
39         }
40     }
41
42     pub fn no_lldb(&self) -> Ignore {
43         match *self {
44             Ignore::Run => Ignore::IgnoreLldb,
45             Ignore::IgnoreLldb => Ignore::IgnoreLldb,
46             _ => Ignore::Ignore,
47         }
48     }
49 }
50
51 /// The result of parse_cfg_name_directive.
52 #[derive(Clone, Copy, PartialEq, Debug)]
53 enum ParsedNameDirective {
54     /// No match.
55     NoMatch,
56     /// Match.
57     Match,
58     /// Mode was DebugInfoBoth and this matched gdb.
59     MatchGdb,
60     /// Mode was DebugInfoBoth and this matched lldb.
61     MatchLldb,
62 }
63
64 /// Properties which must be known very early, before actually running
65 /// the test.
66 pub struct EarlyProps {
67     pub ignore: Ignore,
68     pub should_fail: bool,
69     pub aux: Vec<String>,
70     pub revisions: Vec<String>,
71 }
72
73 impl EarlyProps {
74     pub fn from_file(config: &Config, testfile: &Path) -> Self {
75         let mut props = EarlyProps {
76             ignore: Ignore::Run,
77             should_fail: false,
78             aux: Vec::new(),
79             revisions: vec![],
80         };
81
82         if config.mode == common::DebugInfoBoth {
83             if config.lldb_python_dir.is_none() {
84                 props.ignore = props.ignore.no_lldb();
85             }
86             if config.gdb_version.is_none() {
87                 props.ignore = props.ignore.no_gdb();
88             }
89         }
90
91         iter_header(testfile, None, &mut |ln| {
92             // we should check if any only-<platform> exists and if it exists
93             // and does not matches the current platform, skip the test
94             if props.ignore != Ignore::Ignore {
95                 props.ignore = match config.parse_cfg_name_directive(ln, "ignore") {
96                     ParsedNameDirective::Match => Ignore::Ignore,
97                     ParsedNameDirective::NoMatch => props.ignore,
98                     ParsedNameDirective::MatchGdb => props.ignore.no_gdb(),
99                     ParsedNameDirective::MatchLldb => props.ignore.no_lldb(),
100                 };
101
102                 if config.has_cfg_prefix(ln, "only") {
103                     props.ignore = match config.parse_cfg_name_directive(ln, "only") {
104                         ParsedNameDirective::Match => props.ignore,
105                         ParsedNameDirective::NoMatch => Ignore::Ignore,
106                         ParsedNameDirective::MatchLldb => props.ignore.no_gdb(),
107                         ParsedNameDirective::MatchGdb => props.ignore.no_lldb(),
108                     };
109                 }
110
111                 if ignore_llvm(config, ln) {
112                     props.ignore = Ignore::Ignore;
113                 }
114
115                 if config.run_clang_based_tests_with.is_none() &&
116                    config.parse_needs_matching_clang(ln) {
117                     props.ignore = Ignore::Ignore;
118                 }
119             }
120
121             if (config.mode == common::DebugInfoGdb || config.mode == common::DebugInfoBoth) &&
122                 props.ignore.can_run_gdb() && ignore_gdb(config, ln) {
123                 props.ignore = props.ignore.no_gdb();
124             }
125
126             if (config.mode == common::DebugInfoLldb || config.mode == common::DebugInfoBoth) &&
127                 props.ignore.can_run_lldb() && ignore_lldb(config, ln) {
128                 props.ignore = props.ignore.no_lldb();
129             }
130
131             if let Some(s) = config.parse_aux_build(ln) {
132                 props.aux.push(s);
133             }
134
135             if let Some(r) = config.parse_revisions(ln) {
136                 props.revisions.extend(r);
137             }
138
139             props.should_fail = props.should_fail || config.parse_name_directive(ln, "should-fail");
140         });
141
142         return props;
143
144         fn ignore_gdb(config: &Config, line: &str) -> bool {
145             if let Some(actual_version) = config.gdb_version {
146                 if line.starts_with("min-gdb-version") {
147                     let (start_ver, end_ver) = extract_gdb_version_range(line);
148
149                     if start_ver != end_ver {
150                         panic!("Expected single GDB version")
151                     }
152                     // Ignore if actual version is smaller the minimum required
153                     // version
154                     actual_version < start_ver
155                 } else if line.starts_with("ignore-gdb-version") {
156                     let (min_version, max_version) = extract_gdb_version_range(line);
157
158                     if max_version < min_version {
159                         panic!("Malformed GDB version range: max < min")
160                     }
161
162                     actual_version >= min_version && actual_version <= max_version
163                 } else {
164                     false
165                 }
166             } else {
167                 false
168             }
169         }
170
171         // Takes a directive of the form "ignore-gdb-version <version1> [- <version2>]",
172         // returns the numeric representation of <version1> and <version2> as
173         // tuple: (<version1> as u32, <version2> as u32)
174         // If the <version2> part is omitted, the second component of the tuple
175         // is the same as <version1>.
176         fn extract_gdb_version_range(line: &str) -> (u32, u32) {
177             const ERROR_MESSAGE: &'static str = "Malformed GDB version directive";
178
179             let range_components = line.split(&[' ', '-'][..])
180                                        .filter(|word| !word.is_empty())
181                                        .map(extract_gdb_version)
182                                        .skip_while(Option::is_none)
183                                        .take(3) // 3 or more = invalid, so take at most 3.
184                                        .collect::<Vec<Option<u32>>>();
185
186             match range_components.len() {
187                 1 => {
188                     let v = range_components[0].unwrap();
189                     (v, v)
190                 }
191                 2 => {
192                     let v_min = range_components[0].unwrap();
193                     let v_max = range_components[1].expect(ERROR_MESSAGE);
194                     (v_min, v_max)
195                 }
196                 _ => panic!(ERROR_MESSAGE),
197             }
198         }
199
200         fn ignore_lldb(config: &Config, line: &str) -> bool {
201             if let Some(ref actual_version) = config.lldb_version {
202                 if line.starts_with("min-lldb-version") {
203                     let min_version = line.trim_end()
204                         .rsplit(' ')
205                         .next()
206                         .expect("Malformed lldb version directive");
207                     // Ignore if actual version is smaller the minimum required
208                     // version
209                     lldb_version_to_int(actual_version) < lldb_version_to_int(min_version)
210                 } else if line.starts_with("rust-lldb") && !config.lldb_native_rust {
211                     true
212                 } else {
213                     false
214                 }
215             } else {
216                 false
217             }
218         }
219
220         fn ignore_llvm(config: &Config, line: &str) -> bool {
221             if config.system_llvm && line.starts_with("no-system-llvm") {
222                 return true;
223             }
224             if let Some(ref actual_version) = config.llvm_version {
225                 if line.starts_with("min-llvm-version") {
226                     let min_version = line.trim_end()
227                         .rsplit(' ')
228                         .next()
229                         .expect("Malformed llvm version directive");
230                     // Ignore if actual version is smaller the minimum required
231                     // version
232                     &actual_version[..] < min_version
233                 } else if line.starts_with("min-system-llvm-version") {
234                     let min_version = line.trim_end()
235                         .rsplit(' ')
236                         .next()
237                         .expect("Malformed llvm version directive");
238                     // Ignore if using system LLVM and actual version
239                     // is smaller the minimum required version
240                     config.system_llvm && &actual_version[..] < min_version
241                 } else if line.starts_with("ignore-llvm-version") {
242                     // Syntax is: "ignore-llvm-version <version1> [- <version2>]"
243                     let range_components = line.split(' ')
244                         .skip(1) // Skip the directive.
245                         .map(|s| s.trim())
246                         .filter(|word| !word.is_empty() && word != &"-")
247                         .take(3) // 3 or more = invalid, so take at most 3.
248                         .collect::<Vec<&str>>();
249                     match range_components.len() {
250                         1 => {
251                             &actual_version[..] == range_components[0]
252                         }
253                         2 => {
254                             let v_min = range_components[0];
255                             let v_max = range_components[1];
256                             if v_max < v_min {
257                                 panic!("Malformed LLVM version range: max < min")
258                             }
259                             // Ignore if version lies inside of range.
260                             &actual_version[..] >= v_min && &actual_version[..] <= v_max
261                         }
262                         _ => panic!("Malformed LLVM version directive"),
263                     }
264                 } else {
265                     false
266                 }
267             } else {
268                 false
269             }
270         }
271     }
272 }
273
274 #[derive(Clone, Debug)]
275 pub struct TestProps {
276     // Lines that should be expected, in order, on standard out
277     pub error_patterns: Vec<String>,
278     // Extra flags to pass to the compiler
279     pub compile_flags: Vec<String>,
280     // Extra flags to pass when the compiled code is run (such as --bench)
281     pub run_flags: Option<String>,
282     // If present, the name of a file that this test should match when
283     // pretty-printed
284     pub pp_exact: Option<PathBuf>,
285     // Other crates that should be compiled (typically from the same
286     // directory as the test, but for backwards compatibility reasons
287     // we also check the auxiliary directory)
288     pub aux_builds: Vec<String>,
289     // Environment settings to use for compiling
290     pub rustc_env: Vec<(String, String)>,
291     // Environment settings to use during execution
292     pub exec_env: Vec<(String, String)>,
293     // Lines to check if they appear in the expected debugger output
294     pub check_lines: Vec<String>,
295     // Build documentation for all specified aux-builds as well
296     pub build_aux_docs: bool,
297     // Flag to force a crate to be built with the host architecture
298     pub force_host: bool,
299     // Check stdout for error-pattern output as well as stderr
300     pub check_stdout: bool,
301     // For UI tests, allows compiler to generate arbitrary output to stdout
302     pub dont_check_compiler_stdout: bool,
303     // For UI tests, allows compiler to generate arbitrary output to stderr
304     pub dont_check_compiler_stderr: bool,
305     // Don't force a --crate-type=dylib flag on the command line
306     //
307     // Set this for example if you have an auxiliary test file that contains
308     // a proc-macro and needs `#![crate_type = "proc-macro"]`. This ensures
309     // that the aux file is compiled as a `proc-macro` and not as a `dylib`.
310     pub no_prefer_dynamic: bool,
311     // Run --pretty expanded when running pretty printing tests
312     pub pretty_expanded: bool,
313     // Which pretty mode are we testing with, default to 'normal'
314     pub pretty_mode: String,
315     // Only compare pretty output and don't try compiling
316     pub pretty_compare_only: bool,
317     // Patterns which must not appear in the output of a cfail test.
318     pub forbid_output: Vec<String>,
319     // Revisions to test for incremental compilation.
320     pub revisions: Vec<String>,
321     // Directory (if any) to use for incremental compilation.  This is
322     // not set by end-users; rather it is set by the incremental
323     // testing harness and used when generating compilation
324     // arguments. (In particular, it propagates to the aux-builds.)
325     pub incremental_dir: Option<PathBuf>,
326     // Specifies that a test must actually compile without errors.
327     pub compile_pass: bool,
328     // rustdoc will test the output of the `--test` option
329     pub check_test_line_numbers_match: bool,
330     // The test must be compiled and run successfully. Only used in UI tests for now.
331     pub run_pass: bool,
332     // Skip any codegen step and running the executable. Only for run-pass.
333     pub skip_codegen: bool,
334     // Do not pass `-Z ui-testing` to UI tests
335     pub disable_ui_testing_normalization: bool,
336     // customized normalization rules
337     pub normalize_stdout: Vec<(String, String)>,
338     pub normalize_stderr: Vec<(String, String)>,
339     pub failure_status: i32,
340     // Whether or not `rustfix` should apply the `CodeSuggestion`s of this test and compile the
341     // resulting Rust code.
342     pub run_rustfix: bool,
343     // If true, `rustfix` will only apply `MachineApplicable` suggestions.
344     pub rustfix_only_machine_applicable: bool,
345     pub assembly_output: Option<String>,
346 }
347
348 impl TestProps {
349     pub fn new() -> Self {
350         TestProps {
351             error_patterns: vec![],
352             compile_flags: vec![],
353             run_flags: None,
354             pp_exact: None,
355             aux_builds: vec![],
356             revisions: vec![],
357             rustc_env: vec![],
358             exec_env: vec![],
359             check_lines: vec![],
360             build_aux_docs: false,
361             force_host: false,
362             check_stdout: false,
363             dont_check_compiler_stdout: false,
364             dont_check_compiler_stderr: false,
365             no_prefer_dynamic: false,
366             pretty_expanded: false,
367             pretty_mode: "normal".to_string(),
368             pretty_compare_only: false,
369             forbid_output: vec![],
370             incremental_dir: None,
371             compile_pass: false,
372             check_test_line_numbers_match: false,
373             run_pass: false,
374             skip_codegen: false,
375             disable_ui_testing_normalization: false,
376             normalize_stdout: vec![],
377             normalize_stderr: vec![],
378             failure_status: -1,
379             run_rustfix: false,
380             rustfix_only_machine_applicable: false,
381             assembly_output: None,
382         }
383     }
384
385     pub fn from_aux_file(&self, testfile: &Path, cfg: Option<&str>, config: &Config) -> Self {
386         let mut props = TestProps::new();
387
388         // copy over select properties to the aux build:
389         props.incremental_dir = self.incremental_dir.clone();
390         props.load_from(testfile, cfg, config);
391
392         props
393     }
394
395     pub fn from_file(testfile: &Path, cfg: Option<&str>, config: &Config) -> Self {
396         let mut props = TestProps::new();
397         props.load_from(testfile, cfg, config);
398         props
399     }
400
401     /// Loads properties from `testfile` into `props`. If a property is
402     /// tied to a particular revision `foo` (indicated by writing
403     /// `//[foo]`), then the property is ignored unless `cfg` is
404     /// `Some("foo")`.
405     fn load_from(&mut self, testfile: &Path, cfg: Option<&str>, config: &Config) {
406         iter_header(testfile, cfg, &mut |ln| {
407             if let Some(ep) = config.parse_error_pattern(ln) {
408                 self.error_patterns.push(ep);
409             }
410
411             if let Some(flags) = config.parse_compile_flags(ln) {
412                 self.compile_flags
413                     .extend(flags.split_whitespace().map(|s| s.to_owned()));
414             }
415
416             if let Some(edition) = config.parse_edition(ln) {
417                 self.compile_flags.push(format!("--edition={}", edition));
418             }
419
420             if let Some(r) = config.parse_revisions(ln) {
421                 self.revisions.extend(r);
422             }
423
424             if self.run_flags.is_none() {
425                 self.run_flags = config.parse_run_flags(ln);
426             }
427
428             if self.pp_exact.is_none() {
429                 self.pp_exact = config.parse_pp_exact(ln, testfile);
430             }
431
432             if !self.build_aux_docs {
433                 self.build_aux_docs = config.parse_build_aux_docs(ln);
434             }
435
436             if !self.force_host {
437                 self.force_host = config.parse_force_host(ln);
438             }
439
440             if !self.check_stdout {
441                 self.check_stdout = config.parse_check_stdout(ln);
442             }
443
444             if !self.dont_check_compiler_stdout {
445                 self.dont_check_compiler_stdout = config.parse_dont_check_compiler_stdout(ln);
446             }
447
448             if !self.dont_check_compiler_stderr {
449                 self.dont_check_compiler_stderr = config.parse_dont_check_compiler_stderr(ln);
450             }
451
452             if !self.no_prefer_dynamic {
453                 self.no_prefer_dynamic = config.parse_no_prefer_dynamic(ln);
454             }
455
456             if !self.pretty_expanded {
457                 self.pretty_expanded = config.parse_pretty_expanded(ln);
458             }
459
460             if let Some(m) = config.parse_pretty_mode(ln) {
461                 self.pretty_mode = m;
462             }
463
464             if !self.pretty_compare_only {
465                 self.pretty_compare_only = config.parse_pretty_compare_only(ln);
466             }
467
468             if let Some(ab) = config.parse_aux_build(ln) {
469                 self.aux_builds.push(ab);
470             }
471
472             if let Some(ee) = config.parse_env(ln, "exec-env") {
473                 self.exec_env.push(ee);
474             }
475
476             if let Some(ee) = config.parse_env(ln, "rustc-env") {
477                 self.rustc_env.push(ee);
478             }
479
480             if let Some(cl) = config.parse_check_line(ln) {
481                 self.check_lines.push(cl);
482             }
483
484             if let Some(of) = config.parse_forbid_output(ln) {
485                 self.forbid_output.push(of);
486             }
487
488             if !self.check_test_line_numbers_match {
489                 self.check_test_line_numbers_match = config.parse_check_test_line_numbers_match(ln);
490             }
491
492             if !self.run_pass {
493                 self.run_pass = config.parse_run_pass(ln);
494             }
495
496             if !self.compile_pass {
497                 // run-pass implies compile_pass
498                 self.compile_pass = config.parse_compile_pass(ln) || self.run_pass;
499             }
500
501             if !self.skip_codegen {
502                 self.skip_codegen = config.parse_skip_codegen(ln);
503             }
504
505             if !self.disable_ui_testing_normalization {
506                 self.disable_ui_testing_normalization =
507                     config.parse_disable_ui_testing_normalization(ln);
508             }
509
510             if let Some(rule) = config.parse_custom_normalization(ln, "normalize-stdout") {
511                 self.normalize_stdout.push(rule);
512             }
513             if let Some(rule) = config.parse_custom_normalization(ln, "normalize-stderr") {
514                 self.normalize_stderr.push(rule);
515             }
516
517             if let Some(code) = config.parse_failure_status(ln) {
518                 self.failure_status = code;
519             }
520
521             if !self.run_rustfix {
522                 self.run_rustfix = config.parse_run_rustfix(ln);
523             }
524
525             if !self.rustfix_only_machine_applicable {
526                 self.rustfix_only_machine_applicable =
527                     config.parse_rustfix_only_machine_applicable(ln);
528             }
529
530             if self.assembly_output.is_none() {
531                 self.assembly_output = config.parse_assembly_output(ln);
532             }
533         });
534
535         if self.failure_status == -1 {
536             self.failure_status = match config.mode {
537                 Mode::RunFail => 101,
538                 _ => 1,
539             };
540         }
541
542         for key in &["RUST_TEST_NOCAPTURE", "RUST_TEST_THREADS"] {
543             if let Ok(val) = env::var(key) {
544                 if self.exec_env.iter().find(|&&(ref x, _)| x == key).is_none() {
545                     self.exec_env.push(((*key).to_owned(), val))
546                 }
547             }
548         }
549     }
550 }
551
552 fn iter_header(testfile: &Path, cfg: Option<&str>, it: &mut dyn FnMut(&str)) {
553     if testfile.is_dir() {
554         return;
555     }
556
557     let comment = if testfile.to_string_lossy().ends_with(".rs") {
558         "//"
559     } else {
560         "#"
561     };
562
563     // FIXME: would be nice to allow some whitespace between comment and brace :)
564     // It took me like 2 days to debug why compile-flags weren’t taken into account for my test :)
565     let comment_with_brace = comment.to_string() + "[";
566
567     let rdr = BufReader::new(File::open(testfile).unwrap());
568     for ln in rdr.lines() {
569         // Assume that any directives will be found before the first
570         // module or function. This doesn't seem to be an optimization
571         // with a warm page cache. Maybe with a cold one.
572         let ln = ln.unwrap();
573         let ln = ln.trim();
574         if ln.starts_with("fn") || ln.starts_with("mod") {
575             return;
576         } else if ln.starts_with(&comment_with_brace) {
577             // A comment like `//[foo]` is specific to revision `foo`
578             if let Some(close_brace) = ln.find(']') {
579                 let open_brace = ln.find('[').unwrap();
580                 let lncfg = &ln[open_brace + 1 .. close_brace];
581                 let matches = match cfg {
582                     Some(s) => s == &lncfg[..],
583                     None => false,
584                 };
585                 if matches {
586                     it(ln[(close_brace + 1)..].trim_start());
587                 }
588             } else {
589                 panic!("malformed condition directive: expected `{}foo]`, found `{}`",
590                         comment_with_brace, ln)
591             }
592         } else if ln.starts_with(comment) {
593             it(ln[comment.len() ..].trim_start());
594         }
595     }
596     return;
597 }
598
599 impl Config {
600     fn parse_error_pattern(&self, line: &str) -> Option<String> {
601         self.parse_name_value_directive(line, "error-pattern")
602     }
603
604     fn parse_forbid_output(&self, line: &str) -> Option<String> {
605         self.parse_name_value_directive(line, "forbid-output")
606     }
607
608     fn parse_aux_build(&self, line: &str) -> Option<String> {
609         self.parse_name_value_directive(line, "aux-build")
610             .map(|r| r.trim().to_string())
611     }
612
613     fn parse_compile_flags(&self, line: &str) -> Option<String> {
614         self.parse_name_value_directive(line, "compile-flags")
615     }
616
617     fn parse_revisions(&self, line: &str) -> Option<Vec<String>> {
618         self.parse_name_value_directive(line, "revisions")
619             .map(|r| r.split_whitespace().map(|t| t.to_string()).collect())
620     }
621
622     fn parse_run_flags(&self, line: &str) -> Option<String> {
623         self.parse_name_value_directive(line, "run-flags")
624     }
625
626     fn parse_check_line(&self, line: &str) -> Option<String> {
627         self.parse_name_value_directive(line, "check")
628     }
629
630     fn parse_force_host(&self, line: &str) -> bool {
631         self.parse_name_directive(line, "force-host")
632     }
633
634     fn parse_build_aux_docs(&self, line: &str) -> bool {
635         self.parse_name_directive(line, "build-aux-docs")
636     }
637
638     fn parse_check_stdout(&self, line: &str) -> bool {
639         self.parse_name_directive(line, "check-stdout")
640     }
641
642     fn parse_dont_check_compiler_stdout(&self, line: &str) -> bool {
643         self.parse_name_directive(line, "dont-check-compiler-stdout")
644     }
645
646     fn parse_dont_check_compiler_stderr(&self, line: &str) -> bool {
647         self.parse_name_directive(line, "dont-check-compiler-stderr")
648     }
649
650     fn parse_no_prefer_dynamic(&self, line: &str) -> bool {
651         self.parse_name_directive(line, "no-prefer-dynamic")
652     }
653
654     fn parse_pretty_expanded(&self, line: &str) -> bool {
655         self.parse_name_directive(line, "pretty-expanded")
656     }
657
658     fn parse_pretty_mode(&self, line: &str) -> Option<String> {
659         self.parse_name_value_directive(line, "pretty-mode")
660     }
661
662     fn parse_pretty_compare_only(&self, line: &str) -> bool {
663         self.parse_name_directive(line, "pretty-compare-only")
664     }
665
666     fn parse_failure_status(&self, line: &str) -> Option<i32> {
667         match self.parse_name_value_directive(line, "failure-status") {
668             Some(code) => code.trim().parse::<i32>().ok(),
669             _ => None,
670         }
671     }
672
673     fn parse_compile_pass(&self, line: &str) -> bool {
674         self.parse_name_directive(line, "compile-pass")
675     }
676
677     fn parse_disable_ui_testing_normalization(&self, line: &str) -> bool {
678         self.parse_name_directive(line, "disable-ui-testing-normalization")
679     }
680
681     fn parse_check_test_line_numbers_match(&self, line: &str) -> bool {
682         self.parse_name_directive(line, "check-test-line-numbers-match")
683     }
684
685     fn parse_run_pass(&self, line: &str) -> bool {
686         self.parse_name_directive(line, "run-pass")
687     }
688
689     fn parse_skip_codegen(&self, line: &str) -> bool {
690         self.parse_name_directive(line, "skip-codegen")
691     }
692
693     fn parse_assembly_output(&self, line: &str) -> Option<String> {
694         self.parse_name_value_directive(line, "assembly-output")
695             .map(|r| r.trim().to_string())
696     }
697
698     fn parse_env(&self, line: &str, name: &str) -> Option<(String, String)> {
699         self.parse_name_value_directive(line, name).map(|nv| {
700             // nv is either FOO or FOO=BAR
701             let mut strs: Vec<String> = nv.splitn(2, '=').map(str::to_owned).collect();
702
703             match strs.len() {
704                 1 => (strs.pop().unwrap(), String::new()),
705                 2 => {
706                     let end = strs.pop().unwrap();
707                     (strs.pop().unwrap(), end)
708                 }
709                 n => panic!("Expected 1 or 2 strings, not {}", n),
710             }
711         })
712     }
713
714     fn parse_pp_exact(&self, line: &str, testfile: &Path) -> Option<PathBuf> {
715         if let Some(s) = self.parse_name_value_directive(line, "pp-exact") {
716             Some(PathBuf::from(&s))
717         } else if self.parse_name_directive(line, "pp-exact") {
718             testfile.file_name().map(PathBuf::from)
719         } else {
720             None
721         }
722     }
723
724     fn parse_custom_normalization(&self, mut line: &str, prefix: &str) -> Option<(String, String)> {
725         if self.parse_cfg_name_directive(line, prefix) == ParsedNameDirective::Match {
726             let from = parse_normalization_string(&mut line)?;
727             let to = parse_normalization_string(&mut line)?;
728             Some((from, to))
729         } else {
730             None
731         }
732     }
733
734     fn parse_needs_matching_clang(&self, line: &str) -> bool {
735         self.parse_name_directive(line, "needs-matching-clang")
736     }
737
738     /// Parses a name-value directive which contains config-specific information, e.g., `ignore-x86`
739     /// or `normalize-stderr-32bit`.
740     fn parse_cfg_name_directive(&self, line: &str, prefix: &str) -> ParsedNameDirective {
741         if line.starts_with(prefix) && line.as_bytes().get(prefix.len()) == Some(&b'-') {
742             let name = line[prefix.len() + 1..]
743                 .split(&[':', ' '][..])
744                 .next()
745                 .unwrap();
746
747             if name == "test" ||
748                 util::matches_os(&self.target, name) ||             // target
749                 name == util::get_arch(&self.target) ||             // architecture
750                 name == util::get_pointer_width(&self.target) ||    // pointer width
751                 name == self.stage_id.split('-').next().unwrap() || // stage
752                 Some(name) == util::get_env(&self.target) ||        // env
753                 (self.target != self.host && name == "cross-compile") ||
754                 match self.compare_mode {
755                     Some(CompareMode::Nll) => name == "compare-mode-nll",
756                     Some(CompareMode::Polonius) => name == "compare-mode-polonius",
757                     None => false,
758                 } ||
759                 (cfg!(debug_assertions) && name == "debug") {
760                 ParsedNameDirective::Match
761             } else {
762                 match self.mode {
763                     common::DebugInfoBoth => {
764                         if name == "gdb" {
765                             ParsedNameDirective::MatchGdb
766                         } else if name == "lldb" {
767                             ParsedNameDirective::MatchLldb
768                         } else {
769                             ParsedNameDirective::NoMatch
770                         }
771                     },
772                     common::DebugInfoGdb => if name == "gdb" {
773                         ParsedNameDirective::Match
774                     } else {
775                         ParsedNameDirective::NoMatch
776                     },
777                     common::DebugInfoLldb => if name == "lldb" {
778                         ParsedNameDirective::Match
779                     } else {
780                         ParsedNameDirective::NoMatch
781                     },
782                     common::Pretty => if name == "pretty" {
783                         ParsedNameDirective::Match
784                     } else {
785                         ParsedNameDirective::NoMatch
786                     },
787                     _ => ParsedNameDirective::NoMatch,
788                 }
789             }
790         } else {
791             ParsedNameDirective::NoMatch
792         }
793     }
794
795     fn has_cfg_prefix(&self, line: &str, prefix: &str) -> bool {
796         // returns whether this line contains this prefix or not. For prefix
797         // "ignore", returns true if line says "ignore-x86_64", "ignore-arch",
798         // "ignore-android" etc.
799         line.starts_with(prefix) && line.as_bytes().get(prefix.len()) == Some(&b'-')
800     }
801
802     fn parse_name_directive(&self, line: &str, directive: &str) -> bool {
803         // Ensure the directive is a whole word. Do not match "ignore-x86" when
804         // the line says "ignore-x86_64".
805         line.starts_with(directive) && match line.as_bytes().get(directive.len()) {
806             None | Some(&b' ') | Some(&b':') => true,
807             _ => false,
808         }
809     }
810
811     pub fn parse_name_value_directive(&self, line: &str, directive: &str) -> Option<String> {
812         let colon = directive.len();
813         if line.starts_with(directive) && line.as_bytes().get(colon) == Some(&b':') {
814             let value = line[(colon + 1)..].to_owned();
815             debug!("{}: {}", directive, value);
816             Some(expand_variables(value, self))
817         } else {
818             None
819         }
820     }
821
822     pub fn find_rust_src_root(&self) -> Option<PathBuf> {
823         let mut path = self.src_base.clone();
824         let path_postfix = Path::new("src/etc/lldb_batchmode.py");
825
826         while path.pop() {
827             if path.join(&path_postfix).is_file() {
828                 return Some(path);
829             }
830         }
831
832         None
833     }
834
835     fn parse_run_rustfix(&self, line: &str) -> bool {
836         self.parse_name_directive(line, "run-rustfix")
837     }
838
839     fn parse_rustfix_only_machine_applicable(&self, line: &str) -> bool {
840         self.parse_name_directive(line, "rustfix-only-machine-applicable")
841     }
842
843     fn parse_edition(&self, line: &str) -> Option<String> {
844         self.parse_name_value_directive(line, "edition")
845     }
846 }
847
848 pub fn lldb_version_to_int(version_string: &str) -> isize {
849     let error_string = format!(
850         "Encountered LLDB version string with unexpected format: {}",
851         version_string
852     );
853     version_string.parse().expect(&error_string)
854 }
855
856 fn expand_variables(mut value: String, config: &Config) -> String {
857     const CWD: &'static str = "{{cwd}}";
858     const SRC_BASE: &'static str = "{{src-base}}";
859     const BUILD_BASE: &'static str = "{{build-base}}";
860
861     if value.contains(CWD) {
862         let cwd = env::current_dir().unwrap();
863         value = value.replace(CWD, &cwd.to_string_lossy());
864     }
865
866     if value.contains(SRC_BASE) {
867         value = value.replace(SRC_BASE, &config.src_base.to_string_lossy());
868     }
869
870     if value.contains(BUILD_BASE) {
871         value = value.replace(BUILD_BASE, &config.build_base.to_string_lossy());
872     }
873
874     value
875 }
876
877 /// Finds the next quoted string `"..."` in `line`, and extract the content from it. Move the `line`
878 /// variable after the end of the quoted string.
879 ///
880 /// # Examples
881 ///
882 /// ```
883 /// let mut s = "normalize-stderr-32bit: \"something (32 bits)\" -> \"something ($WORD bits)\".";
884 /// let first = parse_normalization_string(&mut s);
885 /// assert_eq!(first, Some("something (32 bits)".to_owned()));
886 /// assert_eq!(s, " -> \"something ($WORD bits)\".");
887 /// ```
888 fn parse_normalization_string(line: &mut &str) -> Option<String> {
889     // FIXME support escapes in strings.
890     let begin = line.find('"')? + 1;
891     let end = line[begin..].find('"')? + begin;
892     let result = line[begin..end].to_owned();
893     *line = &line[end + 1..];
894     Some(result)
895 }
896
897 #[test]
898 fn test_parse_normalization_string() {
899     let mut s = "normalize-stderr-32bit: \"something (32 bits)\" -> \"something ($WORD bits)\".";
900     let first = parse_normalization_string(&mut s);
901     assert_eq!(first, Some("something (32 bits)".to_owned()));
902     assert_eq!(s, " -> \"something ($WORD bits)\".");
903
904     // Nothing to normalize (No quotes)
905     let mut s = "normalize-stderr-32bit: something (32 bits) -> something ($WORD bits).";
906     let first = parse_normalization_string(&mut s);
907     assert_eq!(first, None);
908     assert_eq!(s, r#"normalize-stderr-32bit: something (32 bits) -> something ($WORD bits)."#);
909
910     // Nothing to normalize (Only a single quote)
911     let mut s = "normalize-stderr-32bit: \"something (32 bits) -> something ($WORD bits).";
912     let first = parse_normalization_string(&mut s);
913     assert_eq!(first, None);
914     assert_eq!(s, "normalize-stderr-32bit: \"something (32 bits) -> something ($WORD bits).");
915
916     // Nothing to normalize (Three quotes)
917     let mut s = "normalize-stderr-32bit: \"something (32 bits)\" -> \"something ($WORD bits).";
918     let first = parse_normalization_string(&mut s);
919     assert_eq!(first, Some("something (32 bits)".to_owned()));
920     assert_eq!(s, " -> \"something ($WORD bits).");
921 }