1 //! This crate hosts a selection of "unit tests" for components of the `InstrumentCoverage` MIR
5 //! ./x.py test --keep-stage 1 compiler/rustc_mir --test-args '--show-output coverage'
8 //! The tests construct a few "mock" objects, as needed, to support the `InstrumentCoverage`
9 //! functions and algorithms. Mocked objects include instances of `mir::Body`; including
10 //! `Terminator`s of various `kind`s, and `Span` objects. Some functions used by or used on
11 //! real, runtime versions of these mocked-up objects have constraints (such as cross-thread
12 //! limitations) and deep dependencies on other elements of the full Rust compiler (which is
13 //! *not* constructed or mocked for these tests).
15 //! Of particular note, attempting to simply print elements of the `mir::Body` with default
16 //! `Debug` formatting can fail because some `Debug` format implementations require the
17 //! `TyCtxt`, obtained via a static global variable that is *not* set for these tests.
18 //! Initializing the global type context is prohibitively complex for the scope and scale of these
19 //! tests (essentially requiring initializing the entire compiler).
21 //! Also note, some basic features of `Span` also rely on the `Span`s own "session globals", which
22 //! are unrelated to the `TyCtxt` global. Without initializing the `Span` session globals, some
23 //! basic, coverage-specific features would be impossible to test, but thankfully initializing these
24 //! globals is comparatively simpler. The easiest way is to wrap the test in a closure argument
25 //! to: `rustc_span::create_default_session_globals_then(|| { test_here(); })`.
32 use coverage_test_macros
::let_bcb
;
34 use itertools
::Itertools
;
35 use rustc_data_structures
::graph
::WithNumNodes
;
36 use rustc_data_structures
::graph
::WithSuccessors
;
37 use rustc_index
::vec
::{Idx, IndexVec}
;
38 use rustc_middle
::mir
::coverage
::CoverageKind
;
39 use rustc_middle
::mir
::*;
41 use rustc_span
::{self, BytePos, Pos, Span, DUMMY_SP}
;
43 // All `TEMP_BLOCK` targets should be replaced before calling `to_body() -> mir::Body`.
44 const TEMP_BLOCK
: BasicBlock
= BasicBlock
::MAX
;
46 struct MockBlocks
<'tcx
> {
47 blocks
: IndexVec
<BasicBlock
, BasicBlockData
<'tcx
>>,
48 dummy_place
: Place
<'tcx
>,
52 impl<'tcx
> MockBlocks
<'tcx
> {
55 blocks
: IndexVec
::new(),
56 dummy_place
: Place { local: RETURN_PLACE, projection: ty::List::empty() }
,
61 fn new_temp(&mut self) -> Local
{
62 let index
= self.next_local
;
67 fn push(&mut self, kind
: TerminatorKind
<'tcx
>) -> BasicBlock
{
68 let next_lo
= if let Some(last
) = self.blocks
.last() {
69 self.blocks
[last
].terminator().source_info
.span
.hi()
73 let next_hi
= next_lo
+ BytePos(1);
74 self.blocks
.push(BasicBlockData
{
76 terminator
: Some(Terminator
{
77 source_info
: SourceInfo
::outermost(Span
::with_root_ctxt(next_lo
, next_hi
)),
84 fn link(&mut self, from_block
: BasicBlock
, to_block
: BasicBlock
) {
85 match self.blocks
[from_block
].terminator_mut().kind
{
86 TerminatorKind
::Assert { ref mut target, .. }
87 | TerminatorKind
::Call { target: Some(ref mut target), .. }
88 | TerminatorKind
::Drop { ref mut target, .. }
89 | TerminatorKind
::DropAndReplace { ref mut target, .. }
90 | TerminatorKind
::FalseEdge { real_target: ref mut target, .. }
91 | TerminatorKind
::FalseUnwind { real_target: ref mut target, .. }
92 | TerminatorKind
::Goto { ref mut target }
93 | TerminatorKind
::InlineAsm { destination: Some(ref mut target), .. }
94 | TerminatorKind
::Yield { resume: ref mut target, .. }
=> *target
= to_block
,
95 ref invalid
=> bug
!("Invalid from_block: {:?}", invalid
),
101 some_from_block
: Option
<BasicBlock
>,
102 to_kind
: TerminatorKind
<'tcx
>,
104 let new_block
= self.push(to_kind
);
105 if let Some(from_block
) = some_from_block
{
106 self.link(from_block
, new_block
);
111 fn set_branch(&mut self, switchint
: BasicBlock
, branch_index
: usize, to_block
: BasicBlock
) {
112 match self.blocks
[switchint
].terminator_mut().kind
{
113 TerminatorKind
::SwitchInt { ref mut targets, .. }
=> {
114 let mut branches
= targets
.iter().collect
::<Vec
<_
>>();
115 let otherwise
= if branch_index
== branches
.len() {
118 let old_otherwise
= targets
.otherwise();
119 if branch_index
> branches
.len() {
120 branches
.push((branches
.len() as u128
, old_otherwise
));
121 while branches
.len() < branch_index
{
122 branches
.push((branches
.len() as u128
, TEMP_BLOCK
));
126 branches
[branch_index
] = (branch_index
as u128
, to_block
);
130 *targets
= SwitchTargets
::new(branches
.into_iter(), otherwise
);
132 ref invalid
=> bug
!("Invalid BasicBlock kind or no to_block: {:?}", invalid
),
136 fn call(&mut self, some_from_block
: Option
<BasicBlock
>) -> BasicBlock
{
139 TerminatorKind
::Call
{
140 func
: Operand
::Copy(self.dummy_place
.clone()),
142 destination
: self.dummy_place
.clone(),
143 target
: Some(TEMP_BLOCK
),
145 from_hir_call
: false,
151 fn goto(&mut self, some_from_block
: Option
<BasicBlock
>) -> BasicBlock
{
152 self.add_block_from(some_from_block
, TerminatorKind
::Goto { target: TEMP_BLOCK }
)
155 fn switchint(&mut self, some_from_block
: Option
<BasicBlock
>) -> BasicBlock
{
156 let switchint_kind
= TerminatorKind
::SwitchInt
{
157 discr
: Operand
::Move(Place
::from(self.new_temp())),
158 targets
: SwitchTargets
::static_if(0, TEMP_BLOCK
, TEMP_BLOCK
),
160 self.add_block_from(some_from_block
, switchint_kind
)
163 fn return_(&mut self, some_from_block
: Option
<BasicBlock
>) -> BasicBlock
{
164 self.add_block_from(some_from_block
, TerminatorKind
::Return
)
167 fn to_body(self) -> Body
<'tcx
> {
168 Body
::new_cfg_only(self.blocks
)
172 fn debug_basic_blocks(mir_body
: &Body
<'_
>) -> String
{
179 let term
= &data
.terminator();
180 let kind
= &term
.kind
;
181 let span
= term
.source_info
.span
;
182 let sp
= format
!("(span:{},{})", span
.lo().to_u32(), span
.hi().to_u32());
184 TerminatorKind
::Assert { target, .. }
185 | TerminatorKind
::Call { target: Some(target), .. }
186 | TerminatorKind
::Drop { target, .. }
187 | TerminatorKind
::DropAndReplace { target, .. }
188 | TerminatorKind
::FalseEdge { real_target: target, .. }
189 | TerminatorKind
::FalseUnwind { real_target: target, .. }
190 | TerminatorKind
::Goto { target }
191 | TerminatorKind
::InlineAsm { destination: Some(target), .. }
192 | TerminatorKind
::Yield { resume: target, .. }
=> {
193 format
!("{}{:?}:{} -> {:?}", sp
, bb
, debug
::term_type(kind
), target
)
195 TerminatorKind
::SwitchInt { targets, .. }
=> {
196 format
!("{}{:?}:{} -> {:?}", sp
, bb
, debug
::term_type(kind
), targets
)
198 _
=> format
!("{}{:?}:{}", sp
, bb
, debug
::term_type(kind
)),
205 static PRINT_GRAPHS
: bool
= false;
207 fn print_mir_graphviz(name
: &str, mir_body
: &Body
<'_
>) {
210 "digraph {} {{\n{}\n}}",
217 " {:?} [label=\"{:?}: {}\"];\n{}",
220 debug
::term_type(&data
.terminator().kind
),
224 .map(|successor
| { format!(" {:?}
-> {:?}
;", bb, successor) })
233 fn print_coverage_graphviz(
236 basic_coverage_blocks: &graph::CoverageGraph,
240 "digraph {} {{\n{}
\n}}",
242 basic_coverage_blocks
244 .map(|(bcb, bcb_data)| {
246 " {:?}
[label
=\"{:?}
: {}
\"];\n{}
",
249 debug::term_type(&bcb_data.terminator(mir_body).kind),
250 basic_coverage_blocks
252 .map(|successor| { format!(" {:?} -> {:?};", bcb
, successor
) })
261 /// Create a mock `Body` with a simple flow.
262 fn goto_switchint
<'a
>() -> Body
<'a
> {
263 let mut blocks
= MockBlocks
::new();
264 let start
= blocks
.call(None
);
265 let goto
= blocks
.goto(Some(start
));
266 let switchint
= blocks
.switchint(Some(goto
));
267 let then_call
= blocks
.call(None
);
268 let else_call
= blocks
.call(None
);
269 blocks
.set_branch(switchint
, 0, then_call
);
270 blocks
.set_branch(switchint
, 1, else_call
);
271 blocks
.return_(Some(then_call
));
272 blocks
.return_(Some(else_call
));
274 let mir_body
= blocks
.to_body();
275 print_mir_graphviz("mir_goto_switchint", &mir_body
);
276 /* Graphviz character plots created using: `graph-easy --as=boxart`:
289 ┌─────────────┐ ┌────────────────┐
290 │ bb4: Call │ ◀── │ bb2: SwitchInt │
291 └─────────────┘ └────────────────┘
295 ┌─────────────┐ ┌────────────────┐
296 │ bb6: Return │ │ bb3: Call │
297 └─────────────┘ └────────────────┘
308 macro_rules
! assert_successors
{
309 ($basic_coverage_blocks
:ident
, $i
:ident
, [$
($successor
:ident
),*]) => {
310 let mut successors
= $basic_coverage_blocks
.successors
[$i
].clone();
311 successors
.sort_unstable();
312 assert_eq
!(successors
, vec
![$
($successor
),*]);
317 fn test_covgraph_goto_switchint() {
318 let mir_body
= goto_switchint();
320 eprintln
!("basic_blocks = {}", debug_basic_blocks(&mir_body
));
322 let basic_coverage_blocks
= graph
::CoverageGraph
::from_mir(&mir_body
);
323 print_coverage_graphviz("covgraph_goto_switchint ", &mir_body
, &basic_coverage_blocks
);
325 ┌──────────────┐ ┌─────────────────┐
326 │ bcb2: Return │ ◀── │ bcb0: SwitchInt │
327 └──────────────┘ └─────────────────┘
336 basic_coverage_blocks
.num_nodes(),
338 "basic_coverage_blocks: {:?}",
339 basic_coverage_blocks
.iter_enumerated().collect
::<Vec
<_
>>()
346 assert_successors
!(basic_coverage_blocks
, bcb0
, [bcb1
, bcb2
]);
347 assert_successors
!(basic_coverage_blocks
, bcb1
, []);
348 assert_successors
!(basic_coverage_blocks
, bcb2
, []);
351 /// Create a mock `Body` with a loop.
352 fn switchint_then_loop_else_return
<'a
>() -> Body
<'a
> {
353 let mut blocks
= MockBlocks
::new();
354 let start
= blocks
.call(None
);
355 let switchint
= blocks
.switchint(Some(start
));
356 let then_call
= blocks
.call(None
);
357 blocks
.set_branch(switchint
, 0, then_call
);
358 let backedge_goto
= blocks
.goto(Some(then_call
));
359 blocks
.link(backedge_goto
, switchint
);
360 let else_return
= blocks
.return_(None
);
361 blocks
.set_branch(switchint
, 1, else_return
);
363 let mir_body
= blocks
.to_body();
364 print_mir_graphviz("mir_switchint_then_loop_else_return", &mir_body
);
372 ┌─────────────┐ ┌────────────────┐
373 │ bb4: Return │ ◀── │ bb1: SwitchInt │ ◀┐
374 └─────────────┘ └────────────────┘ │
392 fn test_covgraph_switchint_then_loop_else_return() {
393 let mir_body
= switchint_then_loop_else_return();
394 let basic_coverage_blocks
= graph
::CoverageGraph
::from_mir(&mir_body
);
395 print_coverage_graphviz(
396 "covgraph_switchint_then_loop_else_return",
398 &basic_coverage_blocks
,
407 ┌────────────┐ ┌─────────────────┐
408 │ bcb3: Goto │ ◀── │ bcb1: SwitchInt │ ◀┐
409 └────────────┘ └─────────────────┘ │
413 │ ┌─────────────────┐ │
415 │ └─────────────────┘ │
417 └─────────────────────────────────────┘
420 basic_coverage_blocks
.num_nodes(),
422 "basic_coverage_blocks: {:?}",
423 basic_coverage_blocks
.iter_enumerated().collect
::<Vec
<_
>>()
431 assert_successors
!(basic_coverage_blocks
, bcb0
, [bcb1
]);
432 assert_successors
!(basic_coverage_blocks
, bcb1
, [bcb2
, bcb3
]);
433 assert_successors
!(basic_coverage_blocks
, bcb2
, []);
434 assert_successors
!(basic_coverage_blocks
, bcb3
, [bcb1
]);
437 /// Create a mock `Body` with nested loops.
438 fn switchint_loop_then_inner_loop_else_break
<'a
>() -> Body
<'a
> {
439 let mut blocks
= MockBlocks
::new();
440 let start
= blocks
.call(None
);
441 let switchint
= blocks
.switchint(Some(start
));
442 let then_call
= blocks
.call(None
);
443 blocks
.set_branch(switchint
, 0, then_call
);
444 let else_return
= blocks
.return_(None
);
445 blocks
.set_branch(switchint
, 1, else_return
);
447 let inner_start
= blocks
.call(Some(then_call
));
448 let inner_switchint
= blocks
.switchint(Some(inner_start
));
449 let inner_then_call
= blocks
.call(None
);
450 blocks
.set_branch(inner_switchint
, 0, inner_then_call
);
451 let inner_backedge_goto
= blocks
.goto(Some(inner_then_call
));
452 blocks
.link(inner_backedge_goto
, inner_switchint
);
453 let inner_else_break_goto
= blocks
.goto(None
);
454 blocks
.set_branch(inner_switchint
, 1, inner_else_break_goto
);
456 let backedge_goto
= blocks
.goto(Some(inner_else_break_goto
));
457 blocks
.link(backedge_goto
, switchint
);
459 let mir_body
= blocks
.to_body();
460 print_mir_graphviz("mir_switchint_loop_then_inner_loop_else_break", &mir_body
);
468 ┌─────────────┐ ┌────────────────┐
469 │ bb3: Return │ ◀── │ bb1: SwitchInt │ ◀─────┐
470 └─────────────┘ └────────────────┘ │
486 ┌─────────────┐ ┌────────────────┐ │
487 │ bb8: Goto │ ◀── │ bb5: SwitchInt │ ◀┐ │
488 └─────────────┘ └────────────────┘ │ │
492 ┌─────────────┐ ┌────────────────┐ │ │
493 │ bb9: Goto │ ─┐ │ bb6: Call │ │ │
494 └─────────────┘ │ └────────────────┘ │ │
498 │ ┌────────────────┐ │ │
500 │ └────────────────┘ │
502 └───────────────────────────┘
508 fn test_covgraph_switchint_loop_then_inner_loop_else_break() {
509 let mir_body
= switchint_loop_then_inner_loop_else_break();
510 let basic_coverage_blocks
= graph
::CoverageGraph
::from_mir(&mir_body
);
511 print_coverage_graphviz(
512 "covgraph_switchint_loop_then_inner_loop_else_break",
514 &basic_coverage_blocks
,
523 ┌──────────────┐ ┌─────────────────┐
524 │ bcb2: Return │ ◀── │ bcb1: SwitchInt │ ◀┐
525 └──────────────┘ └─────────────────┘ │
529 ┌─────────────────┐ │
531 └─────────────────┘ │
535 ┌──────────────┐ ┌─────────────────┐ │
536 │ bcb6: Goto │ ◀── │ bcb4: SwitchInt │ ◀┼────┐
537 └──────────────┘ └─────────────────┘ │ │
541 │ ┌─────────────────┐ │ │
542 │ │ bcb5: Goto │ ─┘ │
543 │ └─────────────────┘ │
545 └────────────────────────────────────────────┘
548 basic_coverage_blocks
.num_nodes(),
550 "basic_coverage_blocks: {:?}",
551 basic_coverage_blocks
.iter_enumerated().collect
::<Vec
<_
>>()
562 assert_successors
!(basic_coverage_blocks
, bcb0
, [bcb1
]);
563 assert_successors
!(basic_coverage_blocks
, bcb1
, [bcb2
, bcb3
]);
564 assert_successors
!(basic_coverage_blocks
, bcb2
, []);
565 assert_successors
!(basic_coverage_blocks
, bcb3
, [bcb4
]);
566 assert_successors
!(basic_coverage_blocks
, bcb4
, [bcb5
, bcb6
]);
567 assert_successors
!(basic_coverage_blocks
, bcb5
, [bcb1
]);
568 assert_successors
!(basic_coverage_blocks
, bcb6
, [bcb4
]);
572 fn test_find_loop_backedges_none() {
573 let mir_body
= goto_switchint();
574 let basic_coverage_blocks
= graph
::CoverageGraph
::from_mir(&mir_body
);
577 "basic_coverage_blocks = {:?}",
578 basic_coverage_blocks
.iter_enumerated().collect
::<Vec
<_
>>()
580 eprintln
!("successors = {:?}", basic_coverage_blocks
.successors
);
582 let backedges
= graph
::find_loop_backedges(&basic_coverage_blocks
);
584 backedges
.iter_enumerated().map(|(_bcb
, backedges
)| backedges
.len()).sum
::<usize>(),
592 fn test_find_loop_backedges_one() {
593 let mir_body
= switchint_then_loop_else_return();
594 let basic_coverage_blocks
= graph
::CoverageGraph
::from_mir(&mir_body
);
595 let backedges
= graph
::find_loop_backedges(&basic_coverage_blocks
);
597 backedges
.iter_enumerated().map(|(_bcb
, backedges
)| backedges
.len()).sum
::<usize>(),
606 assert_eq
!(backedges
[bcb1
], vec
![bcb3
]);
610 fn test_find_loop_backedges_two() {
611 let mir_body
= switchint_loop_then_inner_loop_else_break();
612 let basic_coverage_blocks
= graph
::CoverageGraph
::from_mir(&mir_body
);
613 let backedges
= graph
::find_loop_backedges(&basic_coverage_blocks
);
615 backedges
.iter_enumerated().map(|(_bcb
, backedges
)| backedges
.len()).sum
::<usize>(),
626 assert_eq
!(backedges
[bcb1
], vec
![bcb5
]);
627 assert_eq
!(backedges
[bcb4
], vec
![bcb6
]);
631 fn test_traverse_coverage_with_loops() {
632 let mir_body
= switchint_loop_then_inner_loop_else_break();
633 let basic_coverage_blocks
= graph
::CoverageGraph
::from_mir(&mir_body
);
634 let mut traversed_in_order
= Vec
::new();
635 let mut traversal
= graph
::TraverseCoverageGraphWithLoops
::new(&basic_coverage_blocks
);
636 while let Some(bcb
) = traversal
.next(&basic_coverage_blocks
) {
637 traversed_in_order
.push(bcb
);
642 // bcb0 is visited first. Then bcb1 starts the first loop, and all remaining nodes, *except*
643 // bcb6 are inside the first loop.
645 *traversed_in_order
.last().expect("should have elements"),
647 "bcb6 should not be visited until all nodes inside the first loop have been visited"
651 fn synthesize_body_span_from_terminators(mir_body
: &Body
<'_
>) -> Span
{
652 let mut some_span
: Option
<Span
> = None
;
653 for (_
, data
) in mir_body
.basic_blocks
.iter_enumerated() {
654 let term_span
= data
.terminator().source_info
.span
;
655 if let Some(span
) = some_span
.as_mut() {
656 *span
= span
.to(term_span
);
658 some_span
= Some(term_span
)
661 some_span
.expect("body must have at least one BasicBlock")
665 fn test_make_bcb_counters() {
666 rustc_span
::create_default_session_globals_then(|| {
667 let mir_body
= goto_switchint();
668 let body_span
= synthesize_body_span_from_terminators(&mir_body
);
669 let mut basic_coverage_blocks
= graph
::CoverageGraph
::from_mir(&mir_body
);
670 let mut coverage_spans
= Vec
::new();
671 for (bcb
, data
) in basic_coverage_blocks
.iter_enumerated() {
672 if let Some(span
) = spans
::filtered_terminator_span(data
.terminator(&mir_body
)) {
673 coverage_spans
.push(spans
::CoverageSpan
::for_terminator(
674 spans
::function_source_span(span
, body_span
),
681 let mut coverage_counters
= counters
::CoverageCounters
::new(0);
682 let intermediate_expressions
= coverage_counters
683 .make_bcb_counters(&mut basic_coverage_blocks
, &coverage_spans
)
684 .expect("should be Ok");
685 assert_eq
!(intermediate_expressions
.len(), 0);
689 1, // coincidentally, bcb1 has a `Counter` with id = 1
690 match basic_coverage_blocks
[bcb1
].counter().expect("should have a counter") {
691 CoverageKind
::Counter { id, .. }
=> id
,
692 _
=> panic
!("expected a Counter"),
699 2, // coincidentally, bcb2 has a `Counter` with id = 2
700 match basic_coverage_blocks
[bcb2
].counter().expect("should have a counter") {
701 CoverageKind
::Counter { id, .. }
=> id
,
702 _
=> panic
!("expected a Counter"),