1 // ignore-tidy-filelength
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
;
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}
;
19 use std
::collections
::hash_map
::DefaultHasher
;
20 use std
::collections
::{HashMap, HashSet, VecDeque}
;
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}
;
32 use lazy_static
::lazy_static
;
35 use crate::extract_gdb_version
;
36 use crate::is_android_gdb_target
;
42 fn disable_error_reporting
<F
: FnOnce() -> R
, R
>(f
: F
) -> R
{
44 use winapi
::um
::errhandlingapi
::SetErrorMode
;
45 use winapi
::um
::winbase
::SEM_NOGPFAULTERRORBOX
;
48 static ref LOCK
: Mutex
<()> = Mutex
::new(());
50 // Error mode is a global variable, so lock it so only one thread will change it
51 let _lock
= LOCK
.lock().unwrap();
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.
57 let old_mode
= SetErrorMode(SEM_NOGPFAULTERRORBOX
); // read inherited flags
58 SetErrorMode(old_mode
| SEM_NOGPFAULTERRORBOX
);
60 SetErrorMode(old_mode
);
66 fn disable_error_reporting
<F
: FnOnce() -> R
, R
>(f
: F
) -> R
{
70 /// The name of the environment variable that holds dynamic library locations.
71 pub fn dylib_env_var() -> &'
static str {
74 } else if cfg
!(target_os
= "macos") {
76 } else if cfg
!(target_os
= "haiku") {
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
90 return format
!("lib{}.rlib", lib
);
94 format
!("{}.dll", lib
)
95 } else if cfg
!(target_os
= "macos") {
96 format
!("lib{}.dylib", lib
)
98 format
!("lib{}.so", lib
)
102 #[derive(Debug, PartialEq)]
109 #[derive(Debug, PartialEq)]
110 pub struct Mismatch
{
111 pub line_number
: u32,
112 pub lines
: Vec
<DiffLine
>,
116 fn new(line_number
: u32) -> Mismatch
{
117 Mismatch { line_number, lines: Vec::new() }
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);
129 for result
in diff
::lines(expected
, actual
) {
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);
137 while let Some(line
) = context_queue
.pop_front() {
138 mismatch
.lines
.push(DiffLine
::Context(line
.to_owned()));
141 mismatch
.lines
.push(DiffLine
::Expected(str.to_owned()));
143 lines_since_mismatch
= 0;
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);
151 while let Some(line
) = context_queue
.pop_front() {
152 mismatch
.lines
.push(DiffLine
::Context(line
.to_owned()));
155 mismatch
.lines
.push(DiffLine
::Resulting(str.to_owned()));
156 lines_since_mismatch
= 0;
158 diff
::Result
::Both(str, _
) => {
159 if context_queue
.len() >= context_size
{
160 let _
= context_queue
.pop_front();
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);
170 lines_since_mismatch
+= 1;
175 results
.push(mismatch
);
181 fn write_diff(expected
: &str, actual
: &str, context_size
: usize) -> String
{
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
{
189 DiffLine
::Expected(e
) => {
190 writeln
!(output
, "-\t{}", e
).unwrap();
193 DiffLine
::Context(c
) => {
194 writeln
!(output
, "{}\t{}", line_number
, c
).unwrap();
197 DiffLine
::Resulting(r
) => {
198 writeln
!(output
, "+\t{}", r
).unwrap();
202 writeln
!(output
).unwrap();
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");
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");
227 // We're going to be dumping a lot of info. Start on a new line.
230 debug
!("running {:?}", testpaths
.file
.display());
231 let props
= TestProps
::from_file(&testpaths
.file
, revision
, &config
);
233 let cx
= TestCx { config: &config, props: &props, testpaths, revision }
;
234 create_dir_all(&cx
.output_base_dir()).unwrap();
236 if config
.mode
== Incremental
{
237 // Incremental tests are special because they cannot be run in
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
{
245 props
: &revision_props
,
247 revision
: Some(revision
),
249 rev_cx
.run_revision();
258 pub fn compute_stamp_hash(config
: &Config
) -> String
{
259 let mut hash
= DefaultHasher
::new();
260 config
.stage_id
.hash(&mut hash
);
262 match config
.debugger
{
263 Some(Debugger
::Cdb
) => {
264 config
.cdb
.hash(&mut hash
);
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
);
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
);
283 if let Ui
= config
.mode
{
284 config
.force_pass_mode
.hash(&mut hash
);
287 format
!("{:x}", hash
.finish())
290 struct TestCx
<'test
> {
291 config
: &'test Config
,
292 props
: &'test TestProps
,
293 testpaths
: &'test TestPaths
,
294 revision
: Option
<&'test
str>,
297 struct DebuggerCommands
{
298 commands
: Vec
<String
>,
299 check_lines
: Vec
<String
>,
300 breakpoint_lines
: Vec
<usize>,
313 /// Will this test be executed? Should we use `make_exe_name`?
314 #[derive(Copy, Clone, PartialEq)]
320 /// Should `--emit metadata` be used?
321 #[derive(Copy, Clone)]
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");
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(),
354 fn pass_mode(&self) -> Option
<PassMode
> {
355 self.props
.pass_mode(self.config
)
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
) => {
363 MirOpt
if pm
== Some(PassMode
::Run
) => WillExecute
::Yes
,
364 Ui
| MirOpt
=> WillExecute
::No
,
365 mode
=> panic
!("unimplemented for mode {:?}", mode
),
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
),
376 fn should_compile_successfully(&self, pm
: Option
<PassMode
>) -> bool
{
377 match self.config
.mode
{
378 CompileFail
=> false,
380 Ui
=> pm
.is_some() || self.props
.fail_mode
> Some(FailMode
::Build
),
383 self.revision
.expect("incremental tests require a list of revisions");
384 if revision
.starts_with("rpass") || revision
.starts_with("rfail") {
386 } else if revision
.starts_with("cfail") {
387 // FIXME: would be nice if incremental revs could start with "cpass"
390 panic
!("revision name must begin with rpass, rfail, or cfail");
393 mode
=> panic
!("unimplemented for mode {:?}", mode
),
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
);
403 if proc_res
.status
.success() {
405 &format
!("{} test compiled successfully!", self.config
.mode
)[..],
410 self.check_correct_failure_status(proc_res
);
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
);
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");
426 self.check_expected_errors(expected_errors
, &proc_res
);
428 self.check_error_patterns(&output_to_check
, &proc_res
, pm
);
430 if self.props
.should_ice
{
431 match proc_res
.status
.code() {
433 _
=> self.fatal("expected ICE"),
437 self.check_forbid_output(&output_to_check
, &proc_res
);
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
));
444 if !proc_res
.status
.success() {
445 self.fatal_proc_rec("compilation failed!", &proc_res
);
448 let proc_res
= self.exec_compiled_test();
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
);
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
);
461 fn get_output(&self, proc_res
: &ProcRes
) -> String
{
462 if self.props
.check_stdout
{
463 format
!("{}{}", proc_res
.stdout
, proc_res
.stderr
)
465 proc_res
.stderr
.clone()
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();
473 if expected_status
!= received_status
{
476 "Error: expected failure status ({:?}) but received status {:?}.",
477 expected_status
, received_status
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
);
488 if !proc_res
.status
.success() {
489 self.fatal_proc_rec("compilation failed!", &proc_res
);
492 // FIXME(#41968): Move this check to tidy?
493 let expected_errors
= errors
::load_errors(&self.testpaths
.file
, self.revision
);
495 expected_errors
.is_empty(),
496 "run-pass tests with expected warnings should be moved to ui/"
499 let proc_res
= self.exec_compiled_test();
500 if !proc_res
.status
.success() {
501 self.fatal_proc_rec("test run failed!", &proc_res
);
505 fn run_valgrind_test(&self) {
506 assert
!(self.revision
.is_none(), "revisions not relevant here");
508 if self.config
.valgrind_path
.is_none() {
509 assert
!(!self.config
.force_valgrind
);
510 return self.run_rpass_test();
513 let mut proc_res
= self.compile_test(WillExecute
::Yes
, EmitMetadata
::No
);
515 if !proc_res
.status
.success() {
516 self.fatal_proc_rec("compilation failed!", &proc_res
);
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();
524 if !proc_res
.status
.success() {
525 self.fatal_proc_rec("test run failed!", &proc_res
);
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());
533 logv(self.config
, "testing for converging pretty-printing".to_owned());
536 let rounds
= match self.props
.pp_exact
{
541 let src
= fs
::read_to_string(&self.testpaths
.file
).unwrap();
542 let mut srcs
= vec
![src
];
545 while round
< rounds
{
548 format
!("pretty-printing round {} revision {:?}", round
, self.revision
),
551 if round
== 0 { ReadFrom::Path }
else { ReadFrom::Stdin(srcs[round].to_owned()) }
;
553 let proc_res
= self.print_source(read_from
, &self.props
.pretty_mode
);
554 if !proc_res
.status
.success() {
557 "pretty-printing failed in round {} revision {:?}",
564 let ProcRes { stdout, .. }
= proc_res
;
569 let mut expected
= match self.props
.pp_exact
{
571 let filepath
= self.testpaths
.file
.parent().unwrap().join(file
);
572 fs
::read_to_string(&filepath
).unwrap()
574 None
=> srcs
[srcs
.len() - 2].clone(),
576 let mut actual
= srcs
[srcs
.len() - 1].clone();
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
, "");
585 self.compare_source(&expected
, &actual
);
587 // If we're only making sure that the output matches then just stop here
588 if self.props
.pretty_compare_only
{
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
);
598 if !self.props
.pretty_expanded
{
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
);
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
);
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(),
622 let mut rustc
= Command
::new(&self.config
.rustc_path
);
625 .args(&["-Z", &format
!("unpretty={}", pretty_type
)])
626 .args(&["--target", &self.config
.target
])
629 .args(&self.props
.compile_flags
)
630 .envs(self.props
.rustc_env
.clone());
631 self.maybe_add_external_args(
633 self.split_maybe_args(&self.config
.target_rustcflags
),
636 let src
= match read_from
{
637 ReadFrom
::Stdin(src
) => Some(src
),
638 ReadFrom
::Path
=> None
,
641 self.compose_and_run(
643 self.config
.compile_lib_path
.to_str().unwrap(),
644 Some(aux_dir
.to_str().unwrap()),
649 fn compare_source(&self, expected
: &str, actual
: &str) {
650 if expected
!= actual
{
652 "pretty-printed source does not match expected source\n\
654 ------------------------------------------\n\
656 ------------------------------------------\n\
658 ------------------------------------------\n\
660 ------------------------------------------\n\
662 ------------------------------------------\n\
666 write_diff(expected
, actual
, 3),
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
]);
680 fn typecheck_source(&self, src
: String
) -> ProcRes
{
681 let mut rustc
= Command
::new(&self.config
.rustc_path
);
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();
687 let target
= if self.props
.force_host { &*self.config.host }
else { &*self.config.target }
;
689 let aux_dir
= self.aux_output_dir_name();
696 .arg(&format
!("--target={}", target
))
698 .arg(&self.config
.build_base
)
701 self.set_revision_flags(&mut rustc
);
702 self.maybe_add_external_args(
704 self.split_maybe_args(&self.config
.target_rustcflags
),
706 rustc
.args(&self.props
.compile_flags
);
708 self.compose_and_run_compiler(rustc
, Some(src
))
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(),
719 fn run_debuginfo_cdb_test(&self) {
720 assert
!(self.revision
.is_none(), "revisions not relevant here");
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()
728 let test_cx
= TestCx { config: &config, ..*self }
;
730 test_cx
.run_debuginfo_cdb_test_no_opt();
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
);
740 let exe_file
= self.make_exe_name();
743 static PREFIXES
: &[&str] = &["cdb", "cdbg"];
744 // No "native rust support" variation for CDB yet.
748 // Parse debugger commands etc from test files
749 let DebuggerCommands { commands, check_lines, breakpoint_lines, .. }
=
750 self.parse_debugger_commands(prefixes
);
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
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
));
763 // Append the other `cdb-command:`s
764 for line
in &commands
{
765 script_str
.push_str(line
);
766 script_str
.push_str("\n");
769 script_str
.push_str("\nqq\n"); // Quit the debugger (including remote debugger, if any)
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");
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.
780 .arg(&debugger_script
)
783 let debugger_run_result
= self.compose_and_run(
785 self.config
.run_lib_path
.to_str().unwrap(),
790 if !debugger_run_result
.status
.success() {
791 self.fatal_proc_rec("Error while running CDB", &debugger_run_result
);
794 self.check_debugger_output(&debugger_run_result
, &check_lines
);
797 fn run_debuginfo_gdb_test(&self) {
798 assert
!(self.revision
.is_none(), "revisions not relevant here");
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()
806 let test_cx
= TestCx { config: &config, ..*self }
;
808 test_cx
.run_debuginfo_gdb_test_no_opt();
811 fn run_debuginfo_gdb_test_no_opt(&self) {
812 let prefixes
= if self.config
.gdb_native_rust
{
814 static PREFIXES
: &[&str] = &["gdb", "gdbr"];
815 println
!("NOTE: compiletest thinks it is using GDB with native rust support");
819 static PREFIXES
: &[&str] = &["gdb", "gdbg"];
820 println
!("NOTE: compiletest thinks it is using GDB without native rust support");
824 let DebuggerCommands { commands, check_lines, breakpoint_lines }
=
825 self.parse_debugger_commands(prefixes
);
826 let mut cmds
= commands
.join("\n");
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
);
834 let exe_file
= self.make_exe_name();
836 let debugger_run_result
;
837 if is_android_gdb_target(&self.config
.target
) {
838 cmds
= cmds
.replace("run", "continue");
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"),
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
856 for line
in &breakpoint_lines
{
860 self.testpaths
.file
.file_name().unwrap().to_string_lossy(),
865 script_str
.push_str(&cmds
);
866 script_str
.push_str("\nquit\n");
868 debug
!("script_str = {}", script_str
);
869 self.dump_output_file(&script_str
, "debugger.script");
871 let adb_path
= &self.config
.adb_path
;
873 Command
::new(adb_path
)
876 .arg(&self.config
.adb_test_dir
)
878 .unwrap_or_else(|_
| panic
!("failed to exec `{:?}`", adb_path
));
880 Command
::new(adb_path
)
881 .args(&["forward", "tcp:5039", "tcp:5039"])
883 .unwrap_or_else(|_
| panic
!("failed to exec `{:?}`", adb_path
));
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()
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())
900 .unwrap_or_else(|_
| panic
!("failed to exec `{:?}`", adb_path
));
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();
909 stdout
.read_line(&mut line
).unwrap();
910 if line
.starts_with("Listening on port 5039") {
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
];
921 let gdb_path
= self.config
.gdb
.as_ref().unwrap();
922 let Output { status, stdout, stderr }
= Command
::new(&gdb_path
)
925 .unwrap_or_else(|_
| panic
!("failed to exec `{:?}`", gdb_path
));
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
));
934 debugger_run_result
= ProcRes
{
936 stdout
: String
::from_utf8(stdout
).unwrap(),
937 stderr
: String
::from_utf8(stderr
).unwrap(),
940 if adb
.kill().is_err() {
941 println
!("Adb process is already finished.");
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");
954 match self.config
.gdb_version
{
956 println
!("NOTE: compiletest thinks it is using GDB version {}", version
);
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
"\\")
969 "NOTE: compiletest does not know which version of \
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");
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
));
982 // Load the target executable
984 .push_str(&format
!("file {}\n", exe_file
.to_str().unwrap().replace(r
"\", r
"\\")));
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");
991 // Add line breakpoints
992 for line
in &breakpoint_lines
{
993 script_str
.push_str(&format
!(
995 self.testpaths
.file
.file_name().unwrap().to_string_lossy(),
1000 script_str
.push_str(&cmds
);
1001 script_str
.push_str("\nquit\n");
1003 debug
!("script_str = {}", script_str
);
1004 self.dump_output_file(&script_str
, "debugger.script");
1006 let mut debugger_script
= OsString
::from("-command=");
1007 debugger_script
.push(self.make_out_name("debugger.script"));
1009 let debugger_opts
: &[&OsStr
] =
1010 &["-quiet".as_ref(), "-batch".as_ref(), "-nx".as_ref(), &debugger_script
];
1012 let mut gdb
= Command
::new(self.config
.gdb
.as_ref().unwrap());
1013 gdb
.args(debugger_opts
).env("PYTHONPATH", rust_pp_module_abs_path
);
1015 debugger_run_result
=
1016 self.compose_and_run(gdb
, self.config
.run_lib_path
.to_str().unwrap(), None
, None
);
1019 if !debugger_run_result
.status
.success() {
1020 self.fatal_proc_rec("gdb failed to execute", &debugger_run_result
);
1023 self.check_debugger_output(&debugger_run_result
, &check_lines
);
1026 fn run_debuginfo_lldb_test(&self) {
1027 assert
!(self.revision
.is_none(), "revisions not relevant here");
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.");
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()
1039 let test_cx
= TestCx { config: &config, ..*self }
;
1041 test_cx
.run_debuginfo_lldb_test_no_opt();
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
);
1051 let exe_file
= self.make_exe_name();
1053 match self.config
.lldb_version
{
1054 Some(ref version
) => {
1055 println
!("NOTE: compiletest thinks it is using LLDB version {}", version
);
1059 "NOTE: compiletest does not know which version of \
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");
1070 static PREFIXES
: &[&str] = &["lldb", "lldbg"];
1071 println
!("NOTE: compiletest thinks it is using LLDB without native rust support");
1075 // Parse debugger commands etc from test files
1076 let DebuggerCommands { commands, check_lines, breakpoint_lines, .. }
=
1077 self.parse_debugger_commands(prefixes
);
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");
1083 // Make LLDB emit its version, so we have it documented in the test output
1084 script_str
.push_str("version\n");
1086 // Switch LLDB into "Rust mode"
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();
1093 let rust_type_regexes
= vec
![
1094 "^(alloc::([a-z_]+::)+)String$",
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<.+>$",
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");
1121 script_str
.push_str("type category enable Rust\n");
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
1132 // Append the other commands
1133 for line
in &commands
{
1134 script_str
.push_str(line
);
1135 script_str
.push_str("\n");
1138 // Finally, quit the debugger
1139 script_str
.push_str("\nquit\n");
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");
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
);
1149 if !debugger_run_result
.status
.success() {
1150 self.fatal_proc_rec("Error while running LLDB", &debugger_run_result
);
1153 self.check_debugger_output(&debugger_run_result
, &check_lines
);
1158 test_executable
: &Path
,
1159 debugger_script
: &Path
,
1160 rust_src_root
: &Path
,
1162 // Prepare the lldb_batchmode which executes the debugger script
1163 let lldb_script_path
= rust_src_root
.join("src/etc/lldb_batchmode.py");
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()),
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())
1178 Err(e
) => self.fatal(&format
!(
1179 "Failed to setup Python process for \
1185 self.dump_output(&out
, &err
);
1186 ProcRes { status, stdout: out, stderr: err, cmdline: format!("{:?}
", cmd) }
1189 fn parse_debugger_commands(&self, debugger_prefixes: &[&str]) -> DebuggerCommands {
1190 let directives = debugger_prefixes
1192 .map(|prefix| (format!("{}
-command
", prefix), format!("{}
-check
", prefix)))
1193 .collect::<Vec<_>>();
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() {
1204 if line.starts_with("//") { line[2..].trim_start() } else { line.as_str() };
1206 if line
.contains("#break") {
1207 breakpoint_lines
.push(counter
);
1210 for &(ref command_directive
, ref check_directive
) in &directives
{
1212 .parse_name_value_directive(&line
, command_directive
)
1213 .map(|cmd
| commands
.push(cmd
));
1216 .parse_name_value_directive(&line
, check_directive
)
1217 .map(|cmd
| check_lines
.push(cmd
));
1220 Err(e
) => self.fatal(&format
!("Error while parsing debugger commands: {}", e
)),
1225 DebuggerCommands { commands, check_lines, breakpoint_lines }
1228 fn cleanup_debug_info_options(&self, options
: &Option
<String
>) -> Option
<String
> {
1229 if options
.is_none() {
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
)
1238 .filter(|x
| !options_to_remove
.contains(x
))
1239 .collect
::<Vec
<String
>>();
1241 Some(new_options
.join(" "))
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.
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="];
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.
1256 self.props
.compile_flags
.iter().any(|arg
| OPT_FLAGS
.iter().any(|f
| arg
.starts_with(f
)));
1257 let have_debug_flag
= self
1261 .any(|arg
| DEBUG_FLAGS
.iter().any(|f
| arg
.starts_with(f
)));
1264 if OPT_FLAGS
.iter().any(|f
| arg
.starts_with(f
)) && have_opt_flag
{
1267 if DEBUG_FLAGS
.iter().any(|f
| arg
.starts_with(f
)) && have_debug_flag
{
1274 fn check_debugger_output(&self, debugger_run_result
: &ProcRes
, check_lines
: &[String
]) {
1275 let num_check_lines
= check_lines
.len();
1277 let mut check_line_index
= 0;
1278 for line
in debugger_run_result
.stdout
.lines() {
1279 if check_line_index
>= num_check_lines
{
1283 if check_single_line(line
, &(check_lines
[check_line_index
])[..]) {
1284 check_line_index
+= 1;
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
,
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("[...]");
1302 let check_fragments
: Vec
<&str> =
1303 check_line
.split("[...]").filter(|frag
| !frag
.is_empty()).collect();
1304 if check_fragments
.is_empty() {
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,
1317 for current_fragment
in &check_fragments
[first_fragment
..] {
1318 match rest
.find(current_fragment
) {
1320 rest
= &rest
[pos
+ current_fragment
.len()..];
1322 None
=> return false,
1326 if !can_end_anywhere
&& !rest
.is_empty() {
1334 fn check_error_patterns(
1336 output_to_check
: &str,
1338 pm
: Option
<PassMode
>,
1340 debug
!("check_error_patterns");
1341 if self.props
.error_patterns
.is_empty() {
1346 self.fatal(&format
!(
1347 "no error pattern specified in {:?}",
1348 self.testpaths
.file
.display()
1353 let mut missing_patterns
: Vec
<String
> = Vec
::new();
1355 for pattern
in &self.props
.error_patterns
{
1356 if output_to_check
.contains(pattern
.trim()) {
1357 debug
!("found error pattern {}", pattern
);
1359 missing_patterns
.push(pattern
.to_string());
1363 if missing_patterns
.is_empty() {
1367 if missing_patterns
.len() == 1 {
1368 self.fatal_proc_rec(
1369 &format
!("error pattern '{}' not found!", missing_patterns
[0]),
1373 for pattern
in missing_patterns
{
1374 self.error(&format
!("error pattern '{}' not found!", pattern
));
1376 self.fatal_proc_rec("multiple error patterns not found", proc_res
);
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
)
1385 None
=> self.fatal_proc_rec("compiler terminated by signal", proc_res
),
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
);
1398 fn check_expected_errors(&self, expected_errors
: Vec
<errors
::Error
>, proc_res
: &ProcRes
) {
1400 "check_expected_errors: expected_errors={:?} proc_res.status={:?}",
1401 expected_errors
, proc_res
.status
1403 if proc_res
.status
.success()
1404 && expected_errors
.iter().any(|x
| x
.kind
== Some(ErrorKind
::Error
))
1406 self.fatal_proc_rec("process did not return an error status", proc_res
);
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();
1413 // on windows, translate all '\' path separators to '/'
1414 let file_name
= format
!("{}", self.testpaths
.file
.display()).replace(r
"\", "/");
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
));
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
{
1429 expected_errors
.iter().enumerate().position(|(index
, expected_error
)| {
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
)
1439 // found a match, everybody is happy
1440 assert
!(!found
[index
]);
1441 found
[index
] = true;
1445 if self.is_unexpected_compiler_message(actual_error
, expect_help
, expect_note
) {
1446 self.error(&format
!(
1447 "{}:{}: unexpected {}: '{}'",
1449 actual_error
.line_num
,
1453 .map_or(String
::from("message"), |k
| k
.to_string()),
1456 unexpected
.push(actual_error
);
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() {
1466 self.error(&format
!(
1467 "{}:{}: expected {} not found: {}",
1469 expected_error
.line_num
,
1470 expected_error
.kind
.as_ref().map_or("message".into(), |k
| k
.to_string()),
1473 not_found
.push(expected_error
);
1477 if !unexpected
.is_empty() || !not_found
.is_empty() {
1478 self.error(&format
!(
1479 "{} unexpected errors found, {} expected errors not found",
1483 println
!("status: {}\ncommand: {}", proc_res
.status
, proc_res
.cmdline
);
1484 if !unexpected
.is_empty() {
1485 println
!("unexpected errors (from JSON output): {:#?}\n", unexpected
);
1487 if !not_found
.is_empty() {
1488 println
!("not found errors (from test file): {:#?}\n", not_found
);
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(
1500 actual_error
: &Error
,
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,
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
,
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())
1523 fn compile_test_general(
1525 will_execute
: WillExecute
,
1526 emit_metadata
: EmitMetadata
,
1527 local_pm
: Option
<PassMode
>,
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()),
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
)
1553 _
=> AllowUnused
::No
,
1557 self.make_compile_args(&self.testpaths
.file
, output_file
, emit_metadata
, allow_unused
);
1559 rustc
.arg("-L").arg(&self.aux_output_dir_name());
1561 self.compose_and_run_compiler(rustc
, None
)
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
);
1569 self.props
.from_aux_file(&aux_testpaths
.file
, self.revision
, self.config
);
1570 let aux_cx
= TestCx
{
1571 config
: self.config
,
1573 testpaths
: &aux_testpaths
,
1574 revision
: self.revision
,
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() {
1585 let aux_dir
= self.aux_output_dir_name();
1587 let rustdoc_path
= self.config
.rustdoc_path
.as_ref().expect("--rustdoc-path passed");
1588 let mut rustdoc
= Command
::new(rustdoc_path
);
1592 .arg(self.config
.run_lib_path
.to_str().unwrap())
1597 .arg(&self.testpaths
.file
)
1598 .args(&self.props
.compile_flags
);
1600 if let Some(ref linker
) = self.config
.linker
{
1601 rustdoc
.arg(format
!("-Clinker={}", linker
));
1604 self.compose_and_run_compiler(rustdoc
, None
)
1607 fn exec_compiled_test(&self) -> ProcRes
{
1608 let env
= &self.props
.exec_env
;
1610 let proc_res
= match &*self.config
.target
{
1611 // This is pretty similar to below, we're transforming:
1613 // program arg1 arg2
1617 // remote-test-client run program 2 support-lib.so support-lib2.so arg1 arg2
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
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() {
1635 support_libs
.push(entry
.path());
1638 let mut test_client
=
1639 Command
::new(self.config
.remote_test_client
.as_ref().unwrap());
1641 .args(&["run", &support_libs
.len().to_string(), &prog
])
1645 self.compose_and_run(
1647 self.config
.run_lib_path
.to_str().unwrap(),
1648 Some(aux_dir
.to_str().unwrap()),
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(
1659 self.config
.run_lib_path
.to_str().unwrap(),
1660 Some(aux_dir
.to_str().unwrap()),
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(
1671 self.config
.run_lib_path
.to_str().unwrap(),
1672 Some(aux_dir
.to_str().unwrap()),
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());
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
{
1694 .expect("test file path has no parent")
1697 if !test_ab
.exists() {
1698 self.fatal(&format
!("aux-build `{}` source not found", test_ab
.display()))
1706 .join(self.output_testname_unique())
1710 .expect("aux-build path has no parent")
1715 fn is_vxworks_pure_static(&self) -> bool
{
1716 if self.config
.target
.contains("vxworks") {
1717 match env
::var("RUST_VXWORKS_TEST_DYLINK") {
1726 fn is_vxworks_pure_dynamic(&self) -> bool
{
1727 self.config
.target
.contains("vxworks") && !self.is_vxworks_pure_static()
1730 fn compose_and_run_compiler(&self, mut rustc
: Command
, input
: Option
<String
>) -> ProcRes
{
1731 let aux_dir
= self.aux_output_dir_name();
1733 if !self.props
.aux_builds
.is_empty() {
1734 let _
= fs
::remove_dir_all(&aux_dir
);
1735 create_dir_all(&aux_dir
).unwrap();
1738 for rel_ab
in &self.props
.aux_builds
{
1739 self.build_auxiliary(rel_ab
, &aux_dir
);
1742 for (aux_name
, aux_path
) in &self.props
.aux_crates
{
1743 let is_dylib
= self.build_auxiliary(&aux_path
, &aux_dir
);
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
));
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(
1753 self.config
.compile_lib_path
.to_str().unwrap(),
1754 Some(aux_dir
.to_str().unwrap()),
1759 /// Builds an aux dependency.
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
,
1769 testpaths
: &aux_testpaths
,
1770 revision
: self.revision
,
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
;
1776 aux_cx
.make_compile_args(input_file
, aux_output
, EmitMetadata
::No
, AllowUnused
::No
);
1778 let (dylib
, crate_type
) = if aux_props
.no_prefer_dynamic
{
1780 } else if self.config
.target
.contains("cloudabi")
1781 || self.config
.target
.contains("emscripten")
1782 || (self.config
.target
.contains("musl")
1783 && !aux_props
.force_host
1784 && !self.config
.host
.contains("musl"))
1785 || self.config
.target
.contains("wasm32")
1786 || self.config
.target
.contains("nvptx")
1787 || self.is_vxworks_pure_static()
1788 || self.config
.target
.contains("sgx")
1790 // We primarily compile all auxiliary libraries as dynamic libraries
1791 // to avoid code size bloat and large binaries as much as possible
1792 // for the test suite (otherwise including libstd statically in all
1793 // executables takes up quite a bit of space).
1795 // For targets like MUSL or Emscripten, however, there is no support for
1796 // dynamic libraries so we just go back to building a normal library. Note,
1797 // however, that for MUSL if the library is built with `force_host` then
1798 // it's ok to be a dylib as the host should always support dylibs.
1799 (false, Some("lib"))
1801 (true, Some("dylib"))
1804 if let Some(crate_type
) = crate_type
{
1805 aux_rustc
.args(&["--crate-type", crate_type
]);
1808 aux_rustc
.arg("-L").arg(&aux_dir
);
1810 let auxres
= aux_cx
.compose_and_run(
1812 aux_cx
.config
.compile_lib_path
.to_str().unwrap(),
1813 Some(aux_dir
.to_str().unwrap()),
1816 if !auxres
.status
.success() {
1817 self.fatal_proc_rec(
1819 "auxiliary build of {:?} failed to compile: ",
1820 aux_testpaths
.file
.display()
1830 mut command
: Command
,
1832 aux_path
: Option
<&str>,
1833 input
: Option
<String
>,
1836 let cmdline
= self.make_cmdline(&command
, lib_path
);
1837 logv(self.config
, format
!("executing {}", cmdline
));
1841 command
.stdout(Stdio
::piped()).stderr(Stdio
::piped()).stdin(Stdio
::piped());
1843 // Need to be sure to put both the lib_path and the aux path in the dylib
1844 // search path for the child.
1846 env
::split_paths(&env
::var_os(dylib_env_var()).unwrap_or_default()).collect
::<Vec
<_
>>();
1847 if let Some(p
) = aux_path
{
1848 path
.insert(0, PathBuf
::from(p
))
1850 path
.insert(0, PathBuf
::from(lib_path
));
1852 // Add the new dylib search path var
1853 let newpath
= env
::join_paths(&path
).unwrap();
1854 command
.env(dylib_env_var(), newpath
);
1856 let mut child
= disable_error_reporting(|| command
.spawn())
1857 .unwrap_or_else(|_
| panic
!("failed to exec `{:?}`", &command
));
1858 if let Some(input
) = input
{
1859 child
.stdin
.as_mut().unwrap().write_all(input
.as_bytes()).unwrap();
1862 let Output { status, stdout, stderr }
=
1863 read2_abbreviated(child
).expect("failed to read output");
1865 let result
= ProcRes
{
1867 stdout
: String
::from_utf8_lossy(&stdout
).into_owned(),
1868 stderr
: String
::from_utf8_lossy(&stderr
).into_owned(),
1872 self.dump_output(&result
.stdout
, &result
.stderr
);
1877 fn is_rustdoc(&self) -> bool
{
1878 self.config
.src_base
.ends_with("rustdoc-ui") || self.config
.src_base
.ends_with("rustdoc-js")
1881 fn make_compile_args(
1884 output_file
: TargetLocation
,
1885 emit_metadata
: EmitMetadata
,
1886 allow_unused
: AllowUnused
,
1888 let is_aux
= input_file
.components().map(|c
| c
.as_os_str()).any(|c
| c
== "auxiliary");
1889 let is_rustdoc
= self.is_rustdoc() && !is_aux
;
1890 let mut rustc
= if !is_rustdoc
{
1891 Command
::new(&self.config
.rustc_path
)
1893 Command
::new(&self.config
.rustdoc_path
.clone().expect("no rustdoc built yet"))
1895 // FIXME Why is -L here?
1896 rustc
.arg(input_file
); //.arg("-L").arg(&self.config.build_base);
1898 // Use a single thread for efficiency and a deterministic error message order
1899 rustc
.arg("-Zthreads=1");
1901 // Optionally prevent default --target if specified in test compile-flags.
1902 let custom_target
= self.props
.compile_flags
.iter().any(|x
| x
.starts_with("--target"));
1906 if self.props
.force_host { &*self.config.host }
else { &*self.config.target }
;
1908 rustc
.arg(&format
!("--target={}", target
));
1910 self.set_revision_flags(&mut rustc
);
1913 if let Some(ref incremental_dir
) = self.props
.incremental_dir
{
1914 rustc
.args(&["-C", &format
!("incremental={}", incremental_dir
.display())]);
1915 rustc
.args(&["-Z", "incremental-verify-ich"]);
1918 if self.config
.mode
== CodegenUnits
{
1919 rustc
.args(&["-Z", "human_readable_cgu_names"]);
1923 match self.config
.mode
{
1924 CompileFail
| Incremental
=> {
1925 // If we are extracting and matching errors in the new
1926 // fashion, then you want JSON mode. Old-skool error
1927 // patterns still match the raw compiler output.
1928 if self.props
.error_patterns
.is_empty() {
1929 rustc
.args(&["--error-format", "json"]);
1931 rustc
.arg("-Zui-testing");
1932 rustc
.arg("-Zdeduplicate-diagnostics=no");
1935 if !self.props
.compile_flags
.iter().any(|s
| s
.starts_with("--error-format")) {
1936 rustc
.args(&["--error-format", "json"]);
1938 rustc
.arg("-Zui-testing");
1939 rustc
.arg("-Zdeduplicate-diagnostics=no");
1944 "-Zmir-opt-level=3",
1946 "-Zdump-mir-exclude-pass-number",
1949 let mir_dump_dir
= self.get_mir_dump_dir();
1950 let _
= fs
::remove_dir_all(&mir_dump_dir
);
1951 create_dir_all(mir_dump_dir
.as_path()).unwrap();
1952 let mut dir_opt
= "-Zdump-mir-dir=".to_string();
1953 dir_opt
.push_str(mir_dump_dir
.to_str().unwrap());
1954 debug
!("dir_opt: {:?}", dir_opt
);
1958 RunFail
| RunPassValgrind
| Pretty
| DebugInfo
| Codegen
| Rustdoc
| RunMake
1959 | CodegenUnits
| JsDocTest
| Assembly
=> {
1960 // do not use JSON output
1964 if let (false, EmitMetadata
::Yes
) = (is_rustdoc
, emit_metadata
) {
1965 rustc
.args(&["--emit", "metadata"]);
1969 if self.config
.target
== "wasm32-unknown-unknown" || self.is_vxworks_pure_static() {
1970 // rustc.arg("-g"); // get any backtrace at all on errors
1971 } else if !self.props
.no_prefer_dynamic
{
1972 rustc
.args(&["-C", "prefer-dynamic"]);
1977 TargetLocation
::ThisFile(path
) => {
1978 rustc
.arg("-o").arg(path
);
1980 TargetLocation
::ThisDirectory(path
) => {
1982 // `rustdoc` uses `-o` for the output directory.
1983 rustc
.arg("-o").arg(path
);
1985 rustc
.arg("--out-dir").arg(path
);
1990 match self.config
.compare_mode
{
1991 Some(CompareMode
::Nll
) => {
1992 rustc
.args(&["-Zborrowck=mir"]);
1994 Some(CompareMode
::Polonius
) => {
1995 rustc
.args(&["-Zpolonius", "-Zborrowck=mir"]);
1997 Some(CompareMode
::Chalk
) => {
1998 rustc
.args(&["-Zchalk"]);
2003 // Add `-A unused` before `config` flags and in-test (`props`) flags, so that they can
2005 if let AllowUnused
::Yes
= allow_unused
{
2006 rustc
.args(&["-A", "unused"]);
2009 if self.props
.force_host
{
2010 self.maybe_add_external_args(
2012 self.split_maybe_args(&self.config
.host_rustcflags
),
2015 self.maybe_add_external_args(
2017 self.split_maybe_args(&self.config
.target_rustcflags
),
2020 if let Some(ref linker
) = self.config
.linker
{
2021 rustc
.arg(format
!("-Clinker={}", linker
));
2026 // Use dynamic musl for tests because static doesn't allow creating dylibs
2027 if self.config
.host
.contains("musl") || self.is_vxworks_pure_dynamic() {
2028 rustc
.arg("-Ctarget-feature=-crt-static");
2031 rustc
.args(&self.props
.compile_flags
);
2036 fn make_exe_name(&self) -> PathBuf
{
2037 // Using a single letter here to keep the path length down for
2038 // Windows. Some test names get very long. rustc creates `rcgu`
2039 // files with the module name appended to it which can more than
2040 // double the length.
2041 let mut f
= self.output_base_dir().join("a");
2042 // FIXME: This is using the host architecture exe suffix, not target!
2043 if self.config
.target
.contains("emscripten") {
2044 f
= f
.with_extra_extension("js");
2045 } else if self.config
.target
.contains("wasm32") {
2046 f
= f
.with_extra_extension("wasm");
2047 } else if !env
::consts
::EXE_SUFFIX
.is_empty() {
2048 f
= f
.with_extra_extension(env
::consts
::EXE_SUFFIX
);
2053 fn make_run_args(&self) -> ProcArgs
{
2054 // If we've got another tool to run under (valgrind),
2055 // then split apart its command
2056 let mut args
= self.split_maybe_args(&self.config
.runtool
);
2058 // If this is emscripten, then run tests under nodejs
2059 if self.config
.target
.contains("emscripten") {
2060 if let Some(ref p
) = self.config
.nodejs
{
2061 args
.push(p
.clone());
2063 self.fatal("no NodeJS binary found (--nodejs)");
2065 // If this is otherwise wasm, then run tests under nodejs with our
2067 } else if self.config
.target
.contains("wasm32") {
2068 if let Some(ref p
) = self.config
.nodejs
{
2069 args
.push(p
.clone());
2071 self.fatal("no NodeJS binary found (--nodejs)");
2078 .unwrap() // chop off `ui`
2080 .unwrap() // chop off `test`
2082 .unwrap(); // chop off `src`
2083 args
.push(src
.join("src/etc/wasm32-shim.js").display().to_string());
2086 let exe_file
= self.make_exe_name();
2088 // FIXME (#9639): This needs to handle non-utf8 paths
2089 args
.push(exe_file
.to_str().unwrap().to_owned());
2091 // Add the arguments in the run_flags directive
2092 args
.extend(self.split_maybe_args(&self.props
.run_flags
));
2094 let prog
= args
.remove(0);
2095 ProcArgs { prog, args }
2098 fn split_maybe_args(&self, argstr
: &Option
<String
>) -> Vec
<String
> {
2103 if s
.chars().all(|c
| c
.is_whitespace()) { None }
else { Some(s.to_owned()) }
2110 fn make_cmdline(&self, command
: &Command
, libpath
: &str) -> String
{
2113 // Linux and mac don't require adjusting the library search path
2115 format
!("{:?}", command
)
2117 // Build the LD_LIBRARY_PATH variable as it would be seen on the command line
2118 // for diagnostic purposes
2119 fn lib_path_cmd_prefix(path
: &str) -> String
{
2120 format
!("{}=\"{}\"", util
::lib_path_env_var(), util
::make_new_path(path
))
2123 format
!("{} {:?}", lib_path_cmd_prefix(libpath
), command
)
2127 fn dump_output(&self, out
: &str, err
: &str) {
2128 let revision
= if let Some(r
) = self.revision { format!("{}
.", r) } else { String::new() };
2130 self.dump_output_file(out, &format!("{}out
", revision));
2131 self.dump_output_file(err, &format!("{}err
", revision));
2132 self.maybe_dump_to_stdout(out, err);
2135 fn dump_output_file(&self, out: &str, extension: &str) {
2136 let outfile = self.make_out_name(extension);
2137 fs::write(&outfile, out).unwrap();
2140 /// Creates a filename for output with the given extension.
2141 /// E.g., `/.../testname.revision.mode/testname.extension`.
2142 fn make_out_name(&self, extension: &str) -> PathBuf {
2143 self.output_base_name().with_extension(extension)
2146 /// Gets the directory where auxiliary files are written.
2147 /// E.g., `/.../testname.revision.mode/auxiliary/`.
2148 fn aux_output_dir_name(&self) -> PathBuf {
2149 self.output_base_dir()
2151 .with_extra_extension(self.config.mode.disambiguator())
2154 /// Generates a unique name for the test, such as `testname.revision.mode`.
2155 fn output_testname_unique(&self) -> PathBuf {
2156 output_testname_unique(self.config, self.testpaths, self.safe_revision())
2159 /// The revision, ignored for incremental compilation since it wants all revisions in
2160 /// the same directory.
2161 fn safe_revision(&self) -> Option<&str> {
2162 if self.config.mode == Incremental { None } else { self.revision }
2165 /// Gets the absolute path to the directory where all output for the given
2166 /// test/revision should reside.
2167 /// E.g., `/path/to/build/host-triple/test/ui/relative/testname.revision.mode/`.
2168 fn output_base_dir(&self) -> PathBuf {
2169 output_base_dir(self.config, self.testpaths, self.safe_revision())
2172 /// Gets the absolute path to the base filename used as output for the given
2174 /// E.g., `/.../relative/testname.revision.mode/testname`.
2175 fn output_base_name(&self) -> PathBuf {
2176 output_base_name(self.config, self.testpaths, self.safe_revision())
2179 fn maybe_dump_to_stdout(&self, out: &str, err: &str) {
2180 if self.config.verbose {
2181 println!("------{}
------------------------------", "stdout
");
2182 println!("{}
", out);
2183 println!("------{}
------------------------------", "stderr
");
2184 println!("{}
", err);
2185 println!("------------------------------------------");
2189 fn error(&self, err: &str) {
2190 match self.revision {
2191 Some(rev) => println!("\nerror
in revision `{}`
: {}
", rev, err),
2192 None => println!("\nerror
: {}
", err),
2196 fn fatal(&self, err: &str) -> ! {
2198 error!("fatal error
, panic
: {:?}
", err);
2199 panic!("fatal error
");
2202 fn fatal_proc_rec(&self, err: &str, proc_res: &ProcRes) -> ! {
2204 proc_res.fatal(None);
2207 // codegen tests (using FileCheck)
2209 fn compile_test_and_save_ir(&self) -> ProcRes {
2210 let aux_dir = self.aux_output_dir_name();
2212 let output_file = TargetLocation::ThisDirectory(self.output_base_dir());
2213 let input_file = &self.testpaths.file;
2215 self.make_compile_args(input_file, output_file, EmitMetadata::No, AllowUnused::No);
2216 rustc.arg("-L
").arg(aux_dir).arg("--emit
=llvm
-ir
");
2218 self.compose_and_run_compiler(rustc, None)
2221 fn compile_test_and_save_assembly(&self) -> (ProcRes, PathBuf) {
2222 // This works with both `--emit asm` (as default output name for the assembly)
2223 // and `ptx-linker` because the latter can write output at requested location.
2224 let output_path = self.output_base_name().with_extension("s
");
2226 let output_file = TargetLocation::ThisFile(output_path.clone());
2227 let input_file = &self.testpaths.file;
2229 self.make_compile_args(input_file, output_file, EmitMetadata::No, AllowUnused::No);
2231 rustc.arg("-L
").arg(self.aux_output_dir_name());
2233 match self.props.assembly_output.as_ref().map(AsRef::as_ref) {
2234 Some("emit
-asm
") => {
2235 rustc.arg("--emit
=asm
");
2238 Some("ptx
-linker
") => {
2239 // No extra flags needed.
2242 Some(_) => self.fatal("unknown 'assembly
-output' header
"),
2243 None => self.fatal("missing 'assembly
-output' header
"),
2246 (self.compose_and_run_compiler(rustc, None), output_path)
2249 fn verify_with_filecheck(&self, output: &Path) -> ProcRes {
2250 let mut filecheck = Command::new(self.config.llvm_filecheck.as_ref().unwrap());
2251 filecheck.arg("--input
-file
").arg(output).arg(&self.testpaths.file);
2252 // It would be more appropriate to make most of the arguments configurable through
2253 // a comment-attribute similar to `compile-flags`. For example, --check-prefixes is a very
2256 // For now, though…
2257 if let Some(rev) = self.revision {
2258 let prefixes = format!("CHECK
,{}
", rev);
2259 filecheck.args(&["--check
-prefixes
", &prefixes]);
2261 self.compose_and_run(filecheck, "", None, None)
2264 fn run_codegen_test(&self) {
2265 if self.config.llvm_filecheck.is_none() {
2266 self.fatal("missing
--llvm
-filecheck
");
2269 let proc_res = self.compile_test_and_save_ir();
2270 if !proc_res.status.success() {
2271 self.fatal_proc_rec("compilation failed
!", &proc_res);
2274 let output_path = self.output_base_name().with_extension("ll
");
2275 let proc_res = self.verify_with_filecheck(&output_path);
2276 if !proc_res.status.success() {
2277 self.fatal_proc_rec("verification with 'FileCheck' failed
", &proc_res);
2281 fn run_assembly_test(&self) {
2282 if self.config.llvm_filecheck.is_none() {
2283 self.fatal("missing
--llvm
-filecheck
");
2286 let (proc_res, output_path) = self.compile_test_and_save_assembly();
2287 if !proc_res.status.success() {
2288 self.fatal_proc_rec("compilation failed
!", &proc_res);
2291 let proc_res = self.verify_with_filecheck(&output_path);
2292 if !proc_res.status.success() {
2293 self.fatal_proc_rec("verification with 'FileCheck' failed
", &proc_res);
2297 fn charset() -> &'static str {
2298 // FreeBSD 10.1 defaults to GDB 6.1.1 which doesn't support "auto" charset
2299 if cfg!(target_os = "freebsd
") { "ISO-8859-1" } else { "UTF-8" }
2302 fn run_rustdoc_test(&self) {
2303 assert!(self.revision.is_none(), "revisions not relevant here
");
2305 let out_dir = self.output_base_dir();
2306 let _ = fs::remove_dir_all(&out_dir);
2307 create_dir_all(&out_dir).unwrap();
2309 let proc_res = self.document(&out_dir);
2310 if !proc_res.status.success() {
2311 self.fatal_proc_rec("rustdoc failed
!", &proc_res);
2314 if self.props.check_test_line_numbers_match {
2315 self.check_rustdoc_test_option(proc_res);
2317 let root = self.config.find_rust_src_root().unwrap();
2318 let res = self.cmd2procres(
2319 Command::new(&self.config.docck_python)
2320 .arg(root.join("src
/etc
/htmldocck
.py
"))
2322 .arg(&self.testpaths.file),
2324 if !res.status.success() {
2325 self.fatal_proc_rec("htmldocck failed
!", &res);
2330 fn get_lines<P: AsRef<Path>>(
2333 mut other_files: Option<&mut Vec<String>>,
2335 let content = fs::read_to_string(&path).unwrap();
2336 let mut ignore = false;
2340 .filter_map(|(line_nb, line)| {
2341 if (line.trim_start().starts_with("pub mod ")
2342 || line.trim_start().starts_with("mod "))
2343 && line.ends_with(';')
2345 if let Some(ref mut other_files) = other_files {
2346 other_files.push(line.rsplit("mod ").next().unwrap().replace(";", ""));
2350 let sline = line.split("///").last().unwrap_or("");
2351 let line
= sline
.trim_start();
2352 if line
.starts_with("```") {
2368 fn check_rustdoc_test_option(&self, res
: ProcRes
) {
2369 let mut other_files
= Vec
::new();
2370 let mut files
: HashMap
<String
, Vec
<usize>> = HashMap
::new();
2371 let cwd
= env
::current_dir().unwrap();
2376 .unwrap_or(&self.testpaths
.file
)
2379 .replace('
\\'
, "/"),
2380 self.get_lines(&self.testpaths
.file
, Some(&mut other_files
)),
2382 for other_file
in other_files
{
2383 let mut path
= self.testpaths
.file
.clone();
2384 path
.set_file_name(&format
!("{}.rs", other_file
));
2386 path
.strip_prefix(&cwd
).unwrap_or(&path
).to_str().unwrap().replace('
\\'
, "/"),
2387 self.get_lines(&path
, None
),
2392 for _
in res
.stdout
.split('
\n'
).filter(|s
| s
.starts_with("test ")).inspect(|s
| {
2393 let tmp
: Vec
<&str> = s
.split(" - ").collect();
2395 let path
= tmp
[0].rsplit("test ").next().unwrap();
2396 if let Some(ref mut v
) = files
.get_mut(&path
.replace('
\\'
, "/")) {
2398 let mut iter
= tmp
[1].split("(line ");
2408 if let Ok(pos
) = v
.binary_search(&line
) {
2411 self.fatal_proc_rec(
2412 &format
!("Not found doc test: \"{}\" in \"{}\":{:?}", s
, path
, v
),
2420 self.fatal_proc_rec(&format
!("No test has been found... {:?}", files
), &res
);
2422 for (entry
, v
) in &files
{
2424 self.fatal_proc_rec(
2426 "Not found test at line{} \"{}\":{:?}",
2427 if v
.len() > 1 { "s" }
else { "" }
,
2438 fn run_codegen_units_test(&self) {
2439 assert
!(self.revision
.is_none(), "revisions not relevant here");
2441 let proc_res
= self.compile_test(WillExecute
::No
, EmitMetadata
::No
);
2443 if !proc_res
.status
.success() {
2444 self.fatal_proc_rec("compilation failed!", &proc_res
);
2447 self.check_no_compiler_crash(&proc_res
, self.props
.should_ice
);
2449 const PREFIX
: &str = "MONO_ITEM ";
2450 const CGU_MARKER
: &str = "@@";
2452 let actual
: Vec
<MonoItem
> = proc_res
2455 .filter(|line
| line
.starts_with(PREFIX
))
2456 .map(|line
| str_to_mono_item(line
, true))
2459 let expected
: Vec
<MonoItem
> = errors
::load_errors(&self.testpaths
.file
, None
)
2461 .map(|e
| str_to_mono_item(&e
.msg
[..], false))
2464 let mut missing
= Vec
::new();
2465 let mut wrong_cgus
= Vec
::new();
2467 for expected_item
in &expected
{
2468 let actual_item_with_same_name
= actual
.iter().find(|ti
| ti
.name
== expected_item
.name
);
2470 if let Some(actual_item
) = actual_item_with_same_name
{
2471 if !expected_item
.codegen_units
.is_empty() &&
2472 // Also check for codegen units
2473 expected_item
.codegen_units
!= actual_item
.codegen_units
2475 wrong_cgus
.push((expected_item
.clone(), actual_item
.clone()));
2478 missing
.push(expected_item
.string
.clone());
2482 let unexpected
: Vec
<_
> = actual
2484 .filter(|acgu
| !expected
.iter().any(|ecgu
| acgu
.name
== ecgu
.name
))
2485 .map(|acgu
| acgu
.string
.clone())
2488 if !missing
.is_empty() {
2491 println
!("\nThese items should have been contained but were not:\n");
2493 for item
in &missing
{
2494 println
!("{}", item
);
2500 if !unexpected
.is_empty() {
2502 let mut sorted
= unexpected
.clone();
2507 println
!("\nThese items were contained but should not have been:\n");
2509 for item
in sorted
{
2510 println
!("{}", item
);
2516 if !wrong_cgus
.is_empty() {
2517 wrong_cgus
.sort_by_key(|pair
| pair
.0.name
.clone());
2518 println
!("\nThe following items were assigned to wrong codegen units:\n");
2520 for &(ref expected_item
, ref actual_item
) in &wrong_cgus
{
2521 println
!("{}", expected_item
.name
);
2522 println
!(" expected: {}", codegen_units_to_str(&expected_item
.codegen_units
));
2523 println
!(" actual: {}", codegen_units_to_str(&actual_item
.codegen_units
));
2528 if !(missing
.is_empty() && unexpected
.is_empty() && wrong_cgus
.is_empty()) {
2532 #[derive(Clone, Eq, PartialEq)]
2535 codegen_units
: HashSet
<String
>,
2539 // [MONO_ITEM] name [@@ (cgu)+]
2540 fn str_to_mono_item(s
: &str, cgu_has_crate_disambiguator
: bool
) -> MonoItem
{
2541 let s
= if s
.starts_with(PREFIX
) { (&s[PREFIX.len()..]).trim() }
else { s.trim() }
;
2543 let full_string
= format
!("{}{}", PREFIX
, s
);
2545 let parts
: Vec
<&str> =
2546 s
.split(CGU_MARKER
).map(str::trim
).filter(|s
| !s
.is_empty()).collect();
2548 let name
= parts
[0].trim();
2550 let cgus
= if parts
.len() > 1 {
2551 let cgus_str
= parts
[1];
2556 .filter(|s
| !s
.is_empty())
2558 if cgu_has_crate_disambiguator
{
2559 remove_crate_disambiguators_from_set_of_cgu_names(s
)
2569 MonoItem { name: name.to_owned(), codegen_units: cgus, string: full_string }
2572 fn codegen_units_to_str(cgus
: &HashSet
<String
>) -> String
{
2573 let mut cgus
: Vec
<_
> = cgus
.iter().collect();
2576 let mut string
= String
::new();
2578 string
.push_str(&cgu
[..]);
2579 string
.push_str(" ");
2585 // Given a cgu-name-prefix of the form <crate-name>.<crate-disambiguator> or
2586 // the form <crate-name1>.<crate-disambiguator1>-in-<crate-name2>.<crate-disambiguator2>,
2587 // remove all crate-disambiguators.
2588 fn remove_crate_disambiguator_from_cgu(cgu
: &str) -> String
{
2590 static ref RE
: Regex
=
2591 Regex
::new(r
"^[^\.]+(?P<d1>\.[[:alnum:]]+)(-in-[^\.]+(?P<d2>\.[[:alnum:]]+))?")
2596 RE
.captures(cgu
).unwrap_or_else(|| panic
!("invalid cgu name encountered: {}", cgu
));
2598 let mut new_name
= cgu
.to_owned();
2600 if let Some(d2
) = captures
.name("d2") {
2601 new_name
.replace_range(d2
.start()..d2
.end(), "");
2604 let d1
= captures
.name("d1").unwrap();
2605 new_name
.replace_range(d1
.start()..d1
.end(), "");
2610 // The name of merged CGUs is constructed as the names of the original
2611 // CGUs joined with "--". This function splits such composite CGU names
2612 // and handles each component individually.
2613 fn remove_crate_disambiguators_from_set_of_cgu_names(cgus
: &str) -> String
{
2615 .map(|cgu
| remove_crate_disambiguator_from_cgu(cgu
))
2616 .collect
::<Vec
<_
>>()
2621 fn init_incremental_test(&self) {
2622 // (See `run_incremental_test` for an overview of how incremental tests work.)
2624 // Before any of the revisions have executed, create the
2625 // incremental workproduct directory. Delete any old
2626 // incremental work products that may be there from prior
2628 let incremental_dir
= self.incremental_dir();
2629 if incremental_dir
.exists() {
2630 // Canonicalizing the path will convert it to the //?/ format
2631 // on Windows, which enables paths longer than 260 character
2632 let canonicalized
= incremental_dir
.canonicalize().unwrap();
2633 fs
::remove_dir_all(canonicalized
).unwrap();
2635 fs
::create_dir_all(&incremental_dir
).unwrap();
2637 if self.config
.verbose
{
2638 print
!("init_incremental_test: incremental_dir={}", incremental_dir
.display());
2642 fn run_incremental_test(&self) {
2643 // Basic plan for a test incremental/foo/bar.rs:
2644 // - load list of revisions rpass1, cfail2, rpass3
2645 // - each should begin with `rpass`, `cfail`, or `rfail`
2646 // - if `rpass`, expect compile and execution to succeed
2647 // - if `cfail`, expect compilation to fail
2648 // - if `rfail`, expect execution to fail
2649 // - create a directory build/foo/bar.incremental
2650 // - compile foo/bar.rs with -C incremental=.../foo/bar.incremental and -C rpass1
2651 // - because name of revision starts with "rpass", expect success
2652 // - compile foo/bar.rs with -C incremental=.../foo/bar.incremental and -C cfail2
2653 // - because name of revision starts with "cfail", expect an error
2654 // - load expected errors as usual, but filter for those that end in `[rfail2]`
2655 // - compile foo/bar.rs with -C incremental=.../foo/bar.incremental and -C rpass3
2656 // - because name of revision starts with "rpass", expect success
2657 // - execute build/foo/bar.exe and save output
2659 // FIXME -- use non-incremental mode as an oracle? That doesn't apply
2660 // to #[rustc_dirty] and clean tests I guess
2662 let revision
= self.revision
.expect("incremental tests require a list of revisions");
2664 // Incremental workproduct directory should have already been created.
2665 let incremental_dir
= self.incremental_dir();
2666 assert
!(incremental_dir
.exists(), "init_incremental_test failed to create incremental dir");
2668 // Add an extra flag pointing at the incremental directory.
2669 let mut revision_props
= self.props
.clone();
2670 revision_props
.incremental_dir
= Some(incremental_dir
);
2672 let revision_cx
= TestCx
{
2673 config
: self.config
,
2674 props
: &revision_props
,
2675 testpaths
: self.testpaths
,
2676 revision
: self.revision
,
2679 if self.config
.verbose
{
2680 print
!("revision={:?} revision_props={:#?}", revision
, revision_props
);
2683 if revision
.starts_with("rpass") {
2684 if revision_cx
.props
.should_ice
{
2685 revision_cx
.fatal("can only use should-ice in cfail tests");
2687 revision_cx
.run_rpass_test();
2688 } else if revision
.starts_with("rfail") {
2689 if revision_cx
.props
.should_ice
{
2690 revision_cx
.fatal("can only use should-ice in cfail tests");
2692 revision_cx
.run_rfail_test();
2693 } else if revision
.starts_with("cfail") {
2694 revision_cx
.run_cfail_test();
2696 revision_cx
.fatal("revision name must begin with rpass, rfail, or cfail");
2700 /// Directory where incremental work products are stored.
2701 fn incremental_dir(&self) -> PathBuf
{
2702 self.output_base_name().with_extension("inc")
2705 fn run_rmake_test(&self) {
2706 let cwd
= env
::current_dir().unwrap();
2707 let src_root
= self.config
.src_base
.parent().unwrap().parent().unwrap().parent().unwrap();
2708 let src_root
= cwd
.join(&src_root
);
2710 let tmpdir
= cwd
.join(self.output_base_name());
2711 if tmpdir
.exists() {
2712 self.aggressive_rm_rf(&tmpdir
).unwrap();
2714 create_dir_all(&tmpdir
).unwrap();
2716 let host
= &self.config
.host
;
2717 let make
= if host
.contains("dragonfly")
2718 || host
.contains("freebsd")
2719 || host
.contains("netbsd")
2720 || host
.contains("openbsd")
2727 let mut cmd
= Command
::new(make
);
2728 cmd
.current_dir(&self.testpaths
.file
)
2729 .stdout(Stdio
::piped())
2730 .stderr(Stdio
::piped())
2731 .env("TARGET", &self.config
.target
)
2732 .env("PYTHON", &self.config
.docck_python
)
2734 .env("RUST_BUILD_STAGE", &self.config
.stage_id
)
2735 .env("RUSTC", cwd
.join(&self.config
.rustc_path
))
2736 .env("TMPDIR", &tmpdir
)
2737 .env("LD_LIB_PATH_ENVVAR", dylib_env_var())
2738 .env("HOST_RPATH_DIR", cwd
.join(&self.config
.compile_lib_path
))
2739 .env("TARGET_RPATH_DIR", cwd
.join(&self.config
.run_lib_path
))
2740 .env("LLVM_COMPONENTS", &self.config
.llvm_components
)
2741 // We for sure don't want these tests to run in parallel, so make
2742 // sure they don't have access to these vars if we run via `make`
2744 .env_remove("MAKEFLAGS")
2745 .env_remove("MFLAGS")
2746 .env_remove("CARGO_MAKEFLAGS");
2748 if let Some(ref rustdoc
) = self.config
.rustdoc_path
{
2749 cmd
.env("RUSTDOC", cwd
.join(rustdoc
));
2752 if let Some(ref rust_demangler
) = self.config
.rust_demangler_path
{
2753 cmd
.env("RUST_DEMANGLER", cwd
.join(rust_demangler
));
2756 if let Some(ref node
) = self.config
.nodejs
{
2757 cmd
.env("NODE", node
);
2760 if let Some(ref linker
) = self.config
.linker
{
2761 cmd
.env("RUSTC_LINKER", linker
);
2764 if let Some(ref clang
) = self.config
.run_clang_based_tests_with
{
2765 cmd
.env("CLANG", clang
);
2768 if let Some(ref filecheck
) = self.config
.llvm_filecheck
{
2769 cmd
.env("LLVM_FILECHECK", filecheck
);
2772 if let Some(ref llvm_bin_dir
) = self.config
.llvm_bin_dir
{
2773 cmd
.env("LLVM_BIN_DIR", llvm_bin_dir
);
2776 // We don't want RUSTFLAGS set from the outside to interfere with
2777 // compiler flags set in the test cases:
2778 cmd
.env_remove("RUSTFLAGS");
2780 // Use dynamic musl for tests because static doesn't allow creating dylibs
2781 if self.config
.host
.contains("musl") {
2782 cmd
.env("RUSTFLAGS", "-Ctarget-feature=-crt-static").env("IS_MUSL_HOST", "1");
2785 if self.config
.bless
{
2786 cmd
.env("RUSTC_BLESS_TEST", "--bless");
2787 // Assume this option is active if the environment variable is "defined", with _any_ value.
2788 // As an example, a `Makefile` can use this option by:
2790 // ifdef RUSTC_BLESS_TEST
2791 // cp "$(TMPDIR)"/actual_something.ext expected_something.ext
2793 // $(DIFF) expected_something.ext "$(TMPDIR)"/actual_something.ext
2797 if self.config
.target
.contains("msvc") && self.config
.cc
!= "" {
2798 // We need to pass a path to `lib.exe`, so assume that `cc` is `cl.exe`
2799 // and that `lib.exe` lives next to it.
2800 let lib
= Path
::new(&self.config
.cc
).parent().unwrap().join("lib.exe");
2802 // MSYS doesn't like passing flags of the form `/foo` as it thinks it's
2803 // a path and instead passes `C:\msys64\foo`, so convert all
2804 // `/`-arguments to MSVC here to `-` arguments.
2809 .map(|s
| s
.replace("/", "-"))
2810 .collect
::<Vec
<_
>>()
2813 cmd
.env("IS_MSVC", "1")
2814 .env("IS_WINDOWS", "1")
2815 .env("MSVC_LIB", format
!("'{}' -nologo", lib
.display()))
2816 .env("CC", format
!("'{}' {}", self.config
.cc
, cflags
))
2817 .env("CXX", format
!("'{}'", &self.config
.cxx
));
2819 cmd
.env("CC", format
!("{} {}", self.config
.cc
, self.config
.cflags
))
2820 .env("CXX", format
!("{} {}", self.config
.cxx
, self.config
.cflags
))
2821 .env("AR", &self.config
.ar
);
2823 if self.config
.target
.contains("windows") {
2824 cmd
.env("IS_WINDOWS", "1");
2828 let output
= cmd
.spawn().and_then(read2_abbreviated
).expect("failed to spawn `make`");
2829 if !output
.status
.success() {
2831 status
: output
.status
,
2832 stdout
: String
::from_utf8_lossy(&output
.stdout
).into_owned(),
2833 stderr
: String
::from_utf8_lossy(&output
.stderr
).into_owned(),
2834 cmdline
: format
!("{:?}", cmd
),
2836 self.fatal_proc_rec("make failed", &res
);
2840 fn aggressive_rm_rf(&self, path
: &Path
) -> io
::Result
<()> {
2841 for e
in path
.read_dir()?
{
2843 let path
= entry
.path();
2844 if entry
.file_type()?
.is_dir() {
2845 self.aggressive_rm_rf(&path
)?
;
2847 // Remove readonly files as well on windows (by default we can't)
2848 fs
::remove_file(&path
).or_else(|e
| {
2849 if cfg
!(windows
) && e
.kind() == io
::ErrorKind
::PermissionDenied
{
2850 let mut meta
= entry
.metadata()?
.permissions();
2851 meta
.set_readonly(false);
2852 fs
::set_permissions(&path
, meta
)?
;
2853 fs
::remove_file(&path
)
2860 fs
::remove_dir(path
)
2863 fn run_js_doc_test(&self) {
2864 if let Some(nodejs
) = &self.config
.nodejs
{
2865 let out_dir
= self.output_base_dir();
2867 self.document(&out_dir
);
2869 let root
= self.config
.find_rust_src_root().unwrap();
2871 self.testpaths
.file
.file_stem().and_then(|f
| f
.to_str()).expect("no file stem");
2872 let res
= self.cmd2procres(
2873 Command
::new(&nodejs
)
2874 .arg(root
.join("src/tools/rustdoc-js/tester.js"))
2875 .arg("--doc-folder")
2877 .arg("--crate-name")
2878 .arg(file_stem
.replace("-", "_"))
2880 .arg(self.testpaths
.file
.with_extension("js")),
2882 if !res
.status
.success() {
2883 self.fatal_proc_rec("rustdoc-js test failed!", &res
);
2886 self.fatal("no nodeJS");
2890 fn load_compare_outputs(
2893 output_kind
: TestOutput
,
2894 explicit_format
: bool
,
2896 let (stderr_kind
, stdout_kind
) = match output_kind
{
2897 TestOutput
::Compile
=> (UI_STDERR
, UI_STDOUT
),
2898 TestOutput
::Run
=> (UI_RUN_STDERR
, UI_RUN_STDOUT
),
2901 let expected_stderr
= self.load_expected_output(stderr_kind
);
2902 let expected_stdout
= self.load_expected_output(stdout_kind
);
2904 let normalized_stdout
= match output_kind
{
2905 TestOutput
::Run
if self.config
.remote_test_client
.is_some() => {
2906 // When tests are run using the remote-test-client, the string
2907 // 'uploaded "$TEST_BUILD_DIR/<test_executable>, waiting for result"'
2908 // is printed to stdout by the client and then captured in the ProcRes,
2909 // so it needs to be removed when comparing the run-pass test execution output
2911 static ref REMOTE_TEST_RE
: Regex
= Regex
::new(
2912 "^uploaded \"\\$TEST_BUILD_DIR(/[[:alnum:]_\\-]+)+\", waiting for result\n"
2918 &self.normalize_output(&proc_res
.stdout
, &self.props
.normalize_stdout
),
2923 _
=> self.normalize_output(&proc_res
.stdout
, &self.props
.normalize_stdout
),
2926 let stderr
= if explicit_format
{
2927 proc_res
.stderr
.clone()
2929 json
::extract_rendered(&proc_res
.stderr
)
2932 let normalized_stderr
= self.normalize_output(&stderr
, &self.props
.normalize_stderr
);
2935 TestOutput
::Compile
=> {
2936 if !self.props
.dont_check_compiler_stdout
{
2937 errors
+= self.compare_output("stdout", &normalized_stdout
, &expected_stdout
);
2939 if !self.props
.dont_check_compiler_stderr
{
2940 errors
+= self.compare_output("stderr", &normalized_stderr
, &expected_stderr
);
2943 TestOutput
::Run
=> {
2944 errors
+= self.compare_output(stdout_kind
, &normalized_stdout
, &expected_stdout
);
2945 errors
+= self.compare_output(stderr_kind
, &normalized_stderr
, &expected_stderr
);
2951 fn run_ui_test(&self) {
2952 if let Some(FailMode
::Build
) = self.props
.fail_mode
{
2953 // Make sure a build-fail test cannot fail due to failing analysis (e.g. typeck).
2954 let pm
= Some(PassMode
::Check
);
2955 let proc_res
= self.compile_test_general(WillExecute
::No
, EmitMetadata
::Yes
, pm
);
2956 self.check_if_test_should_compile(&proc_res
, pm
);
2959 let pm
= self.pass_mode();
2960 let should_run
= self.should_run(pm
);
2961 let emit_metadata
= self.should_emit_metadata(pm
);
2962 let proc_res
= self.compile_test(should_run
, emit_metadata
);
2963 self.check_if_test_should_compile(&proc_res
, pm
);
2965 // if the user specified a format in the ui test
2966 // print the output to the stderr file, otherwise extract
2967 // the rendered error messages from json and print them
2968 let explicit
= self.props
.compile_flags
.iter().any(|s
| s
.contains("--error-format"));
2970 let expected_fixed
= self.load_expected_output(UI_FIXED
);
2972 let modes_to_prune
= vec
![CompareMode
::Nll
];
2973 self.prune_duplicate_outputs(&modes_to_prune
);
2975 let mut errors
= self.load_compare_outputs(&proc_res
, TestOutput
::Compile
, explicit
);
2977 if self.config
.compare_mode
.is_some() {
2978 // don't test rustfix with nll right now
2979 } else if self.config
.rustfix_coverage
{
2980 // Find out which tests have `MachineApplicable` suggestions but are missing
2981 // `run-rustfix` or `run-rustfix-only-machine-applicable` headers.
2983 // This will return an empty `Vec` in case the executed test file has a
2984 // `compile-flags: --error-format=xxxx` header with a value other than `json`.
2985 let suggestions
= get_suggestions_from_json(
2988 Filter
::MachineApplicableOnly
,
2990 .unwrap_or_default();
2991 if !suggestions
.is_empty()
2992 && !self.props
.run_rustfix
2993 && !self.props
.rustfix_only_machine_applicable
2995 let mut coverage_file_path
= self.config
.build_base
.clone();
2996 coverage_file_path
.push("rustfix_missing_coverage.txt");
2997 debug
!("coverage_file_path: {}", coverage_file_path
.display());
2999 let mut file
= OpenOptions
::new()
3002 .open(coverage_file_path
.as_path())
3003 .expect("could not create or open file");
3005 if writeln
!(file
, "{}", self.testpaths
.file
.display()).is_err() {
3006 panic
!("couldn't write to {}", coverage_file_path
.display());
3009 } else if self.props
.run_rustfix
{
3010 // Apply suggestions from rustc to the code itself
3011 let unfixed_code
= self.load_expected_output_from_path(&self.testpaths
.file
).unwrap();
3012 let suggestions
= get_suggestions_from_json(
3015 if self.props
.rustfix_only_machine_applicable
{
3016 Filter
::MachineApplicableOnly
3022 let fixed_code
= apply_suggestions(&unfixed_code
, &suggestions
).unwrap_or_else(|_
| {
3023 panic
!("failed to apply suggestions for {:?} with rustfix", self.testpaths
.file
)
3026 errors
+= self.compare_output("fixed", &fixed_code
, &expected_fixed
);
3027 } else if !expected_fixed
.is_empty() {
3029 "the `// run-rustfix` directive wasn't found but a `*.fixed` \
3035 println
!("To update references, rerun the tests and pass the `--bless` flag");
3036 let relative_path_to_file
=
3037 self.testpaths
.relative_dir
.join(self.testpaths
.file
.file_name().unwrap());
3039 "To only update this specific test, also pass `--test-args {}`",
3040 relative_path_to_file
.display(),
3042 self.fatal_proc_rec(
3043 &format
!("{} errors occurred comparing output.", errors
),
3048 let expected_errors
= errors
::load_errors(&self.testpaths
.file
, self.revision
);
3050 if let WillExecute
::Yes
= should_run
{
3051 let proc_res
= self.exec_compiled_test();
3052 let run_output_errors
= if self.props
.check_run_results
{
3053 self.load_compare_outputs(&proc_res
, TestOutput
::Run
, explicit
)
3057 if run_output_errors
> 0 {
3058 self.fatal_proc_rec(
3059 &format
!("{} errors occurred comparing run output.", run_output_errors
),
3063 if self.should_run_successfully(pm
) {
3064 if !proc_res
.status
.success() {
3065 self.fatal_proc_rec("test run failed!", &proc_res
);
3068 if proc_res
.status
.success() {
3069 self.fatal_proc_rec("test run succeeded!", &proc_res
);
3072 if !self.props
.error_patterns
.is_empty() {
3073 // "// error-pattern" comments
3074 self.check_error_patterns(&proc_res
.stderr
, &proc_res
, pm
);
3079 "run_ui_test: explicit={:?} config.compare_mode={:?} expected_errors={:?} \
3080 proc_res.status={:?} props.error_patterns={:?}",
3082 self.config
.compare_mode
,
3085 self.props
.error_patterns
3087 if !explicit
&& self.config
.compare_mode
.is_none() {
3088 let check_patterns
=
3089 should_run
== WillExecute
::No
&& !self.props
.error_patterns
.is_empty();
3091 let check_annotations
= !check_patterns
|| !expected_errors
.is_empty();
3094 // "// error-pattern" comments
3095 self.check_error_patterns(&proc_res
.stderr
, &proc_res
, pm
);
3098 if check_annotations
{
3099 // "//~ERROR comments"
3100 self.check_expected_errors(expected_errors
, &proc_res
);
3104 if self.props
.run_rustfix
&& self.config
.compare_mode
.is_none() {
3105 // And finally, compile the fixed code and make sure it both
3106 // succeeds and has no diagnostics.
3107 let mut rustc
= self.make_compile_args(
3108 &self.testpaths
.file
.with_extension(UI_FIXED
),
3109 TargetLocation
::ThisFile(self.make_exe_name()),
3113 rustc
.arg("-L").arg(&self.aux_output_dir_name());
3114 let res
= self.compose_and_run_compiler(rustc
, None
);
3115 if !res
.status
.success() {
3116 self.fatal_proc_rec("failed to compile fixed code", &res
);
3118 if !res
.stderr
.is_empty() && !self.props
.rustfix_only_machine_applicable
{
3119 self.fatal_proc_rec("fixed code is still producing diagnostics", &res
);
3124 fn run_mir_opt_test(&self) {
3125 let pm
= self.pass_mode();
3126 let should_run
= self.should_run(pm
);
3127 let emit_metadata
= self.should_emit_metadata(pm
);
3128 let proc_res
= self.compile_test(should_run
, emit_metadata
);
3130 if !proc_res
.status
.success() {
3131 self.fatal_proc_rec("compilation failed!", &proc_res
);
3134 self.check_mir_dump();
3136 if let WillExecute
::Yes
= should_run
{
3137 let proc_res
= self.exec_compiled_test();
3139 if !proc_res
.status
.success() {
3140 self.fatal_proc_rec("test run failed!", &proc_res
);
3145 fn check_mir_dump(&self) {
3146 let test_file_contents
= fs
::read_to_string(&self.testpaths
.file
).unwrap();
3148 let test_dir
= self.testpaths
.file
.parent().unwrap();
3150 self.testpaths
.file
.file_stem().unwrap().to_str().unwrap().replace("-", "_");
3152 let mut bit_width
= String
::new();
3153 if test_file_contents
.lines().any(|l
| l
== "// EMIT_MIR_FOR_EACH_BIT_WIDTH") {
3154 bit_width
= format
!(".{}", get_pointer_width(&self.config
.target
));
3157 if self.config
.bless
{
3159 glob(&format
!("{}/{}.*{}.mir", test_dir
.display(), test_crate
, bit_width
)).unwrap()
3161 std
::fs
::remove_file(e
.unwrap()).unwrap();
3164 glob(&format
!("{}/{}.*{}.diff", test_dir
.display(), test_crate
, bit_width
)).unwrap()
3166 std
::fs
::remove_file(e
.unwrap()).unwrap();
3170 for l
in test_file_contents
.lines() {
3171 if l
.starts_with("// EMIT_MIR ") {
3172 let test_name
= l
.trim_start_matches("// EMIT_MIR ").trim();
3173 let mut test_names
= test_name
.split(' '
);
3174 // sometimes we specify two files so that we get a diff between the two files
3175 let test_name
= test_names
.next().unwrap();
3176 let mut expected_file
;
3180 if test_name
.ends_with(".diff") {
3181 let trimmed
= test_name
.trim_end_matches(".diff");
3182 let test_against
= format
!("{}.after.mir", trimmed
);
3183 from_file
= format
!("{}.before.mir", trimmed
);
3184 expected_file
= format
!("{}{}.diff", trimmed
, bit_width
);
3186 test_names
.next().is_none(),
3187 "two mir pass names specified for MIR diff"
3189 to_file
= Some(test_against
);
3190 } else if let Some(first_pass
) = test_names
.next() {
3191 let second_pass
= test_names
.next().unwrap();
3193 test_names
.next().is_none(),
3194 "three mir pass names specified for MIR diff"
3197 format
!("{}{}.{}-{}.diff", test_name
, bit_width
, first_pass
, second_pass
);
3198 let second_file
= format
!("{}.{}.mir", test_name
, second_pass
);
3199 from_file
= format
!("{}.{}.mir", test_name
, first_pass
);
3200 to_file
= Some(second_file
);
3203 format
!("{}{}.mir", test_name
.trim_end_matches(".mir"), bit_width
);
3204 from_file
= test_name
.to_string();
3206 test_names
.next().is_none(),
3207 "two mir pass names specified for MIR dump"
3211 if !expected_file
.starts_with(&test_crate
) {
3212 expected_file
= format
!("{}.{}", test_crate
, expected_file
);
3214 let expected_file
= test_dir
.join(expected_file
);
3216 let dumped_string
= if let Some(after
) = to_file
{
3217 self.diff_mir_files(from_file
.into(), after
.into())
3219 let mut output_file
= PathBuf
::new();
3220 output_file
.push(self.get_mir_dump_dir());
3221 output_file
.push(&from_file
);
3223 "comparing the contents of: {} with {}",
3224 output_file
.display(),
3225 expected_file
.display()
3227 if !output_file
.exists() {
3229 "Output file `{}` from test does not exist, available files are in `{}`",
3230 output_file
.display(),
3231 output_file
.parent().unwrap().display()
3234 self.check_mir_test_timestamp(&from_file
, &output_file
);
3235 let dumped_string
= fs
::read_to_string(&output_file
).unwrap();
3236 self.normalize_output(&dumped_string
, &[])
3239 if self.config
.bless
{
3240 let _
= std
::fs
::remove_file(&expected_file
);
3241 std
::fs
::write(expected_file
, dumped_string
.as_bytes()).unwrap();
3243 if !expected_file
.exists() {
3245 "Output file `{}` from test does not exist",
3246 expected_file
.display()
3249 let expected_string
= fs
::read_to_string(&expected_file
).unwrap();
3250 if dumped_string
!= expected_string
{
3251 print
!("{}", write_diff(&expected_string
, &dumped_string
, 3));
3253 "Actual MIR output differs from expected MIR output {}",
3254 expected_file
.display()
3262 fn diff_mir_files(&self, before
: PathBuf
, after
: PathBuf
) -> String
{
3263 let to_full_path
= |path
: PathBuf
| {
3264 let full
= self.get_mir_dump_dir().join(&path
);
3267 "the mir dump file for {} does not exist (requested in {})",
3269 self.testpaths
.file
.display(),
3274 let before
= to_full_path(before
);
3275 let after
= to_full_path(after
);
3276 debug
!("comparing the contents of: {} with {}", before
.display(), after
.display());
3277 let before
= fs
::read_to_string(before
).unwrap();
3278 let after
= fs
::read_to_string(after
).unwrap();
3279 let before
= self.normalize_output(&before
, &[]);
3280 let after
= self.normalize_output(&after
, &[]);
3281 let mut dumped_string
= String
::new();
3282 for result
in diff
::lines(&before
, &after
) {
3283 use std
::fmt
::Write
;
3285 diff
::Result
::Left(s
) => writeln
!(dumped_string
, "- {}", s
).unwrap(),
3286 diff
::Result
::Right(s
) => writeln
!(dumped_string
, "+ {}", s
).unwrap(),
3287 diff
::Result
::Both(s
, _
) => writeln
!(dumped_string
, " {}", s
).unwrap(),
3293 fn check_mir_test_timestamp(&self, test_name
: &str, output_file
: &Path
) {
3294 let t
= |file
| fs
::metadata(file
).unwrap().modified().unwrap();
3295 let source_file
= &self.testpaths
.file
;
3296 let output_time
= t(output_file
);
3297 let source_time
= t(source_file
);
3298 if source_time
> output_time
{
3299 debug
!("source file time: {:?} output file time: {:?}", source_time
, output_time
);
3301 "test source file `{}` is newer than potentially stale output file `{}`.",
3302 source_file
.display(),
3308 fn get_mir_dump_dir(&self) -> PathBuf
{
3309 let mut mir_dump_dir
= PathBuf
::from(self.config
.build_base
.as_path());
3310 debug
!("input_file: {:?}", self.testpaths
.file
);
3311 mir_dump_dir
.push(&self.testpaths
.relative_dir
);
3312 mir_dump_dir
.push(self.testpaths
.file
.file_stem().unwrap());
3316 fn normalize_output(&self, output
: &str, custom_rules
: &[(String
, String
)]) -> String
{
3317 let cflags
= self.props
.compile_flags
.join(" ");
3318 let json
= cflags
.contains("--error-format json")
3319 || cflags
.contains("--error-format pretty-json")
3320 || cflags
.contains("--error-format=json")
3321 || cflags
.contains("--error-format=pretty-json")
3322 || cflags
.contains("--output-format json")
3323 || cflags
.contains("--output-format=json");
3325 let mut normalized
= output
.to_string();
3327 let mut normalize_path
= |from
: &Path
, to
: &str| {
3328 let mut from
= from
.display().to_string();
3330 from
= from
.replace("\\", "\\\\");
3332 normalized
= normalized
.replace(&from
, to
);
3335 let parent_dir
= self.testpaths
.file
.parent().unwrap();
3336 normalize_path(parent_dir
, "$DIR");
3338 // Paths into the libstd/libcore
3349 normalize_path(&src_dir
, "$SRC_DIR");
3351 // Paths into the build directory
3352 let test_build_dir
= &self.config
.build_base
;
3353 let parent_build_dir
= test_build_dir
.parent().unwrap().parent().unwrap().parent().unwrap();
3355 // eg. /home/user/rust/build/x86_64-unknown-linux-gnu/test/ui
3356 normalize_path(test_build_dir
, "$TEST_BUILD_DIR");
3357 // eg. /home/user/rust/build
3358 normalize_path(parent_build_dir
, "$BUILD_DIR");
3360 // Paths into lib directory.
3361 normalize_path(&parent_build_dir
.parent().unwrap().join("lib"), "$LIB_DIR");
3364 // escaped newlines in json strings should be readable
3365 // in the stderr files. There's no point int being correct,
3366 // since only humans process the stderr files.
3367 // Thus we just turn escaped newlines back into newlines.
3368 normalized
= normalized
.replace("\\n", "\n");
3371 // If there are `$SRC_DIR` normalizations with line and column numbers, then replace them
3372 // with placeholders as we do not want tests needing updated when compiler source code
3374 // eg. $SRC_DIR/libcore/mem.rs:323:14 becomes $SRC_DIR/libcore/mem.rs:LL:COL
3375 normalized
= Regex
::new("SRC_DIR(.+):\\d+:\\d+(: \\d+:\\d+)?")
3377 .replace_all(&normalized
, "SRC_DIR$1:LL:COL")
3380 normalized
= Self::normalize_platform_differences(&normalized
);
3381 normalized
= normalized
.replace("\t", "\\t"); // makes tabs visible
3383 // Remove test annotations like `//~ ERROR text` from the output,
3384 // since they duplicate actual errors and make the output hard to read.
3386 Regex
::new("\\s*//(\\[.*\\])?~.*").unwrap().replace_all(&normalized
, "").into_owned();
3388 for rule
in custom_rules
{
3389 let re
= Regex
::new(&rule
.0).expect("bad regex in custom normalization rule");
3390 normalized
= re
.replace_all(&normalized
, &rule
.1[..]).into_owned();
3395 /// Normalize output differences across platforms. Generally changes Windows output to be more
3398 /// Replaces backslashes in paths with forward slashes, and replaces CRLF line endings
3400 fn normalize_platform_differences(output
: &str) -> String
{
3402 /// Used to find Windows paths.
3404 /// It's not possible to detect paths in the error messages generally, but this is a
3405 /// decent enough heuristic.
3406 static ref PATH_BACKSLASH_RE
: Regex
= Regex
::new(r
#"(?x)
3408 # Match paths that don't include spaces.
3409 (?:\\[\pL\pN\.\-_']+)+\.\pL+
3411 # If the path starts with a well-known root, then allow spaces.
3412 \$(?:DIR|SRC_DIR|TEST_BUILD_DIR|BUILD_DIR|LIB_DIR)(?:\\[\pL\pN\.\-_' ]+)+
3417 let output
= output
.replace(r
"\\", r
"\");
3420 .replace_all(&output
, |caps
: &Captures
<'_
>| {
3421 println
!("{}", &caps
[0]);
3422 caps
[0].replace(r
"\", "/")
3424 .replace("\r\n", "\n")
3427 fn expected_output_path(&self, kind
: &str) -> PathBuf
{
3429 expected_output_path(&self.testpaths
, self.revision
, &self.config
.compare_mode
, kind
);
3432 if let Some(CompareMode
::Polonius
) = self.config
.compare_mode
{
3433 path
= expected_output_path(
3436 &Some(CompareMode
::Nll
),
3443 path
= expected_output_path(&self.testpaths
, self.revision
, &None
, kind
);
3449 fn load_expected_output(&self, kind
: &str) -> String
{
3450 let path
= self.expected_output_path(kind
);
3452 match self.load_expected_output_from_path(&path
) {
3454 Err(x
) => self.fatal(&x
),
3461 fn load_expected_output_from_path(&self, path
: &Path
) -> Result
<String
, String
> {
3462 fs
::read_to_string(path
).map_err(|err
| {
3463 format
!("failed to load expected output from `{}`: {}", path
.display(), err
)
3467 fn delete_file(&self, file
: &PathBuf
) {
3469 // Deleting a nonexistant file would error.
3472 if let Err(e
) = fs
::remove_file(file
) {
3473 self.fatal(&format
!("failed to delete `{}`: {}", file
.display(), e
,));
3477 fn compare_output(&self, kind
: &str, actual
: &str, expected
: &str) -> usize {
3478 if actual
== expected
{
3482 if !self.config
.bless
{
3483 if expected
.is_empty() {
3484 println
!("normalized {}:\n{}\n", kind
, actual
);
3486 println
!("diff of {}:\n", kind
);
3487 print
!("{}", write_diff(expected
, actual
, 3));
3491 let mode
= self.config
.compare_mode
.as_ref().map_or("", |m
| m
.to_str());
3492 let output_file
= self
3494 .with_extra_extension(self.revision
.unwrap_or(""))
3495 .with_extra_extension(mode
)
3496 .with_extra_extension(kind
);
3498 let mut files
= vec
![output_file
];
3499 if self.config
.bless
{
3500 files
.push(expected_output_path(
3503 &self.config
.compare_mode
,
3508 for output_file
in &files
{
3509 if actual
.is_empty() {
3510 self.delete_file(output_file
);
3511 } else if let Err(err
) = fs
::write(&output_file
, &actual
) {
3512 self.fatal(&format
!(
3513 "failed to write {} to `{}`: {}",
3515 output_file
.display(),
3521 println
!("\nThe actual {0} differed from the expected {0}.", kind
);
3522 for output_file
in files
{
3523 println
!("Actual {} saved to {}", kind
, output_file
.display());
3525 if self.config
.bless { 0 }
else { 1 }
3528 fn prune_duplicate_output(&self, mode
: CompareMode
, kind
: &str, canon_content
: &str) {
3529 let examined_path
= expected_output_path(&self.testpaths
, self.revision
, &Some(mode
), kind
);
3531 let examined_content
=
3532 self.load_expected_output_from_path(&examined_path
).unwrap_or_else(|_
| String
::new());
3534 if canon_content
== examined_content
{
3535 self.delete_file(&examined_path
);
3539 fn prune_duplicate_outputs(&self, modes
: &[CompareMode
]) {
3540 if self.config
.bless
{
3541 for kind
in UI_EXTENSIONS
{
3542 let canon_comparison_path
=
3543 expected_output_path(&self.testpaths
, self.revision
, &None
, kind
);
3545 if let Ok(canon
) = self.load_expected_output_from_path(&canon_comparison_path
) {
3547 self.prune_duplicate_output(mode
.clone(), kind
, &canon
);
3554 fn create_stamp(&self) {
3555 let stamp
= crate::stamp(&self.config
, self.testpaths
, self.revision
);
3556 fs
::write(&stamp
, compute_stamp_hash(&self.config
)).unwrap();
3565 pub struct ProcRes
{
3573 pub fn fatal(&self, err
: Option
<&str>) -> ! {
3574 if let Some(e
) = err
{
3575 println
!("\nerror: {}", e
);
3582 ------------------------------------------\n\
3584 ------------------------------------------\n\
3586 ------------------------------------------\n\
3588 ------------------------------------------\n\
3592 json
::extract_rendered(&self.stdout
),
3593 json
::extract_rendered(&self.stderr
),
3595 // Use resume_unwind instead of panic!() to prevent a panic message + backtrace from
3596 // compiletest, which is unnecessary noise.
3597 std
::panic
::resume_unwind(Box
::new(()));
3602 enum TargetLocation
{
3604 ThisDirectory(PathBuf
),
3612 fn read2_abbreviated(mut child
: Child
) -> io
::Result
<Output
> {
3613 use crate::read2
::read2
;
3614 use std
::mem
::replace
;
3616 const HEAD_LEN
: usize = 160 * 1024;
3617 const TAIL_LEN
: usize = 256 * 1024;
3621 Abbreviated { head: Vec<u8>, skipped: usize, tail: Box<[u8]> }
,
3625 fn extend(&mut self, data
: &[u8]) {
3626 let new_self
= match *self {
3627 ProcOutput
::Full(ref mut bytes
) => {
3628 bytes
.extend_from_slice(data
);
3629 let new_len
= bytes
.len();
3630 if new_len
<= HEAD_LEN
+ TAIL_LEN
{
3633 let tail
= bytes
.split_off(new_len
- TAIL_LEN
).into_boxed_slice();
3634 let head
= replace(bytes
, Vec
::new());
3635 let skipped
= new_len
- HEAD_LEN
- TAIL_LEN
;
3636 ProcOutput
::Abbreviated { head, skipped, tail }
3638 ProcOutput
::Abbreviated { ref mut skipped, ref mut tail, .. }
=> {
3639 *skipped
+= data
.len();
3640 if data
.len() <= TAIL_LEN
{
3641 tail
[..data
.len()].copy_from_slice(data
);
3642 tail
.rotate_left(data
.len());
3644 tail
.copy_from_slice(&data
[(data
.len() - TAIL_LEN
)..]);
3652 fn into_bytes(self) -> Vec
<u8> {
3654 ProcOutput
::Full(bytes
) => bytes
,
3655 ProcOutput
::Abbreviated { mut head, skipped, tail }
=> {
3656 write
!(&mut head
, "\n\n<<<<<< SKIPPED {} BYTES >>>>>>\n\n", skipped
).unwrap();
3657 head
.extend_from_slice(&tail
);
3664 let mut stdout
= ProcOutput
::Full(Vec
::new());
3665 let mut stderr
= ProcOutput
::Full(Vec
::new());
3667 drop(child
.stdin
.take());
3669 child
.stdout
.take().unwrap(),
3670 child
.stderr
.take().unwrap(),
3671 &mut |is_stdout
, data
, _
| {
3672 if is_stdout { &mut stdout }
else { &mut stderr }
.extend(data
);
3676 let status
= child
.wait()?
;
3678 Ok(Output { status, stdout: stdout.into_bytes(), stderr: stderr.into_bytes() }
)