1 //! The `InstrumentCoverage` MIR pass implementation includes debugging tools and options
2 //! to help developers understand and/or improve the analysis and instrumentation of a MIR.
4 //! To enable coverage, include the rustc command line option:
6 //! * `-Z instrument-coverage`
8 //! MIR Dump Files, with additional `CoverageGraph` graphviz and `CoverageSpan` spanview
9 //! ------------------------------------------------------------------------------------
11 //! Additional debugging options include:
13 //! * `-Z dump-mir=InstrumentCoverage` - Generate `.mir` files showing the state of the MIR,
14 //! before and after the `InstrumentCoverage` pass, for each compiled function.
16 //! * `-Z dump-mir-graphviz` - If `-Z dump-mir` is also enabled for the current MIR node path,
17 //! each MIR dump is accompanied by a before-and-after graphical view of the MIR, in Graphviz
18 //! `.dot` file format (which can be visually rendered as a graph using any of a number of free
19 //! Graphviz viewers and IDE extensions).
21 //! For the `InstrumentCoverage` pass, this option also enables generation of an additional
22 //! Graphviz `.dot` file for each function, rendering the `CoverageGraph`: the control flow
23 //! graph (CFG) of `BasicCoverageBlocks` (BCBs), as nodes, internally labeled to show the
24 //! `CoverageSpan`-based MIR elements each BCB represents (`BasicBlock`s, `Statement`s and
25 //! `Terminator`s), assigned coverage counters and/or expressions, and edge counters, as needed.
27 //! (Note the additional option, `-Z graphviz-dark-mode`, can be added, to change the rendered
28 //! output from its default black-on-white background to a dark color theme, if desired.)
30 //! * `-Z dump-mir-spanview` - If `-Z dump-mir` is also enabled for the current MIR node path,
31 //! each MIR dump is accompanied by a before-and-after `.html` document showing the function's
32 //! original source code, highlighted by it's MIR spans, at the `statement`-level (by default),
33 //! `terminator` only, or encompassing span for the `Terminator` plus all `Statement`s, in each
34 //! `block` (`BasicBlock`).
36 //! For the `InstrumentCoverage` pass, this option also enables generation of an additional
37 //! spanview `.html` file for each function, showing the aggregated `CoverageSpan`s that will
38 //! require counters (or counter expressions) for accurate coverage analysis.
43 //! The `InstrumentCoverage` pass includes debug logging messages at various phases and decision
44 //! points, which can be enabled via environment variable:
47 //! RUSTC_LOG=rustc_mir::transform::coverage=debug
50 //! Other module paths with coverage-related debug logs may also be of interest, particularly for
51 //! debugging the coverage map data, injected as global variables in the LLVM IR (during rustc's
52 //! code generation pass). For example:
55 //! RUSTC_LOG=rustc_mir::transform::coverage,rustc_codegen_ssa::coverageinfo,rustc_codegen_llvm::coverageinfo=debug
58 //! Coverage Debug Options
59 //! ---------------------------------
61 //! Additional debugging options can be enabled using the environment variable:
64 //! RUSTC_COVERAGE_DEBUG_OPTIONS=<options>
67 //! These options are comma-separated, and specified in the format `option-name=value`. For example:
70 //! $ RUSTC_COVERAGE_DEBUG_OPTIONS=counter-format=id+operation,allow-unused-expressions=yes cargo build
73 //! Coverage debug options include:
75 //! * `allow-unused-expressions=yes` or `no` (default: `no`)
77 //! The `InstrumentCoverage` algorithms _should_ only create and assign expressions to a
78 //! `BasicCoverageBlock`, or an incoming edge, if that expression is either (a) required to
79 //! count a `CoverageSpan`, or (b) a dependency of some other required counter expression.
81 //! If an expression is generated that does not map to a `CoverageSpan` or dependency, this
82 //! probably indicates there was a bug in the algorithm that creates and assigns counters
85 //! When this kind of bug is encountered, the rustc compiler will panic by default. Setting:
86 //! `allow-unused-expressions=yes` will log a warning message instead of panicking (effectively
87 //! ignoring the unused expressions), which may be helpful when debugging the root cause of
90 //! * `counter-format=<choices>`, where `<choices>` can be any plus-separated combination of `id`,
91 //! `block`, and/or `operation` (default: `block+operation`)
93 //! This option effects both the `CoverageGraph` (graphviz `.dot` files) and debug logging, when
94 //! generating labels for counters and expressions.
96 //! Depending on the values and combinations, counters can be labeled by:
98 //! * `id` - counter or expression ID (ascending counter IDs, starting at 1, or descending
99 //! expression IDs, starting at `u32:MAX`)
100 //! * `block` - the `BasicCoverageBlock` label (for example, `bcb0`) or edge label (for
101 //! example `bcb0->bcb1`), for counters or expressions assigned to count a
102 //! `BasicCoverageBlock` or edge. Intermediate expressions (not directly associated with
103 //! a BCB or edge) will be labeled by their expression ID, unless `operation` is also
105 //! * `operation` - applied to expressions only, labels include the left-hand-side counter
106 //! or expression label (lhs operand), the operator (`+` or `-`), and the right-hand-side
107 //! counter or expression (rhs operand). Expression operand labels are generated
108 //! recursively, generating labels with nested operations, enclosed in parentheses
109 //! (for example: `bcb2 + (bcb0 - bcb1)`).
111 use super::graph::{BasicCoverageBlock, BasicCoverageBlockData, CoverageGraph};
112 use super::spans::CoverageSpan;
114 use crate::util::generic_graphviz::GraphvizWriter;
115 use crate::util::pretty;
116 use crate::util::spanview::{self, SpanViewable};
118 use rustc_data_structures::fx::FxHashMap;
119 use rustc_middle::mir::coverage::*;
120 use rustc_middle::mir::{self, BasicBlock, TerminatorKind};
121 use rustc_middle::ty::TyCtxt;
122 use rustc_span::Span;
125 use std::lazy::SyncOnceCell;
127 pub const NESTED_INDENT: &str = " ";
129 const RUSTC_COVERAGE_DEBUG_OPTIONS: &str = "RUSTC_COVERAGE_DEBUG_OPTIONS";
131 pub(super) fn debug_options<'a>() -> &'a DebugOptions {
132 static DEBUG_OPTIONS: SyncOnceCell<DebugOptions> = SyncOnceCell::new();
134 &DEBUG_OPTIONS.get_or_init(DebugOptions::from_env)
137 /// Parses and maintains coverage-specific debug options captured from the environment variable
138 /// "RUSTC_COVERAGE_DEBUG_OPTIONS", if set.
139 #[derive(Debug, Clone)]
140 pub(super) struct DebugOptions {
141 pub allow_unused_expressions: bool,
142 counter_format: ExpressionFormat,
146 fn from_env() -> Self {
147 let mut allow_unused_expressions = true;
148 let mut counter_format = ExpressionFormat::default();
150 if let Ok(env_debug_options) = std::env::var(RUSTC_COVERAGE_DEBUG_OPTIONS) {
151 for setting_str in env_debug_options.replace(" ", "").replace("-", "_").split(',') {
152 let (option, value) = match setting_str.split_once('=') {
153 None => (setting_str, None),
154 Some((k, v)) => (k, Some(v)),
157 "allow_unused_expressions" => {
158 allow_unused_expressions = bool_option_val(option, value);
160 "{} env option `allow_unused_expressions` is set to {}",
161 RUSTC_COVERAGE_DEBUG_OPTIONS, allow_unused_expressions
164 "counter_format" => {
168 "`{}` option in environment variable {} requires one or more \
169 plus-separated choices (a non-empty subset of \
170 `id+block+operation`)",
172 RUSTC_COVERAGE_DEBUG_OPTIONS
176 counter_format = counter_format_option_val(val);
178 "{} env option `counter_format` is set to {:?}",
179 RUSTC_COVERAGE_DEBUG_OPTIONS, counter_format
186 "Unsupported setting `{}` in environment variable {}",
188 RUSTC_COVERAGE_DEBUG_OPTIONS
195 Self { allow_unused_expressions, counter_format }
199 fn bool_option_val(option: &str, some_strval: Option<&str>) -> bool {
200 if let Some(val) = some_strval {
201 if vec!["yes", "y", "on", "true"].contains(&val) {
203 } else if vec!["no", "n", "off", "false"].contains(&val) {
207 "Unsupported value `{}` for option `{}` in environment variable {}",
210 RUSTC_COVERAGE_DEBUG_OPTIONS
218 fn counter_format_option_val(strval: &str) -> ExpressionFormat {
219 let mut counter_format = ExpressionFormat { id: false, block: false, operation: false };
220 let components = strval.splitn(3, '+');
221 for component in components {
223 "id" => counter_format.id = true,
224 "block" => counter_format.block = true,
225 "operation" => counter_format.operation = true,
227 "Unsupported counter_format choice `{}` in environment variable {}",
229 RUSTC_COVERAGE_DEBUG_OPTIONS
236 #[derive(Debug, Clone)]
237 struct ExpressionFormat {
243 impl Default for ExpressionFormat {
244 fn default() -> Self {
245 Self { id: false, block: true, operation: true }
249 /// If enabled, this struct maintains a map from `CoverageKind` IDs (as `ExpressionOperandId`) to
250 /// the `CoverageKind` data and optional label (normally, the counter's associated
251 /// `BasicCoverageBlock` format string, if any).
253 /// Use `format_counter` to convert one of these `CoverageKind` counters to a debug output string,
254 /// as directed by the `DebugOptions`. This allows the format of counter labels in logs and dump
255 /// files (including the `CoverageGraph` graphviz file) to be changed at runtime, via environment
258 /// `DebugCounters` supports a recursive rendering of `Expression` counters, so they can be
259 /// presented as nested expressions such as `(bcb3 - (bcb0 + bcb1))`.
260 pub(super) struct DebugCounters {
261 some_counters: Option<FxHashMap<ExpressionOperandId, DebugCounter>>,
265 pub fn new() -> Self {
266 Self { some_counters: None }
269 pub fn enable(&mut self) {
270 debug_assert!(!self.is_enabled());
271 self.some_counters.replace(FxHashMap::default());
274 pub fn is_enabled(&self) -> bool {
275 self.some_counters.is_some()
278 pub fn add_counter(&mut self, counter_kind: &CoverageKind, some_block_label: Option<String>) {
279 if let Some(counters) = &mut self.some_counters {
280 let id: ExpressionOperandId = match *counter_kind {
281 CoverageKind::Counter { id, .. } => id.into(),
282 CoverageKind::Expression { id, .. } => id.into(),
284 "the given `CoverageKind` is not an counter or expression: {:?}",
289 .try_insert(id, DebugCounter::new(counter_kind.clone(), some_block_label))
290 .expect("attempt to add the same counter_kind to DebugCounters more than once");
294 pub fn some_block_label(&self, operand: ExpressionOperandId) -> Option<&String> {
295 self.some_counters.as_ref().map_or(None, |counters| {
298 .map_or(None, |debug_counter| debug_counter.some_block_label.as_ref())
302 pub fn format_counter(&self, counter_kind: &CoverageKind) -> String {
303 match *counter_kind {
304 CoverageKind::Counter { .. } => {
305 format!("Counter({})", self.format_counter_kind(counter_kind))
307 CoverageKind::Expression { .. } => {
308 format!("Expression({})", self.format_counter_kind(counter_kind))
310 CoverageKind::Unreachable { .. } => "Unreachable".to_owned(),
314 fn format_counter_kind(&self, counter_kind: &CoverageKind) -> String {
315 let counter_format = &debug_options().counter_format;
316 if let CoverageKind::Expression { id, lhs, op, rhs } = *counter_kind {
317 if counter_format.operation {
320 if counter_format.id || self.some_counters.is_none() {
321 format!("#{} = ", id.index())
325 self.format_operand(lhs),
326 if op == Op::Add { "+" } else { "-" },
327 self.format_operand(rhs),
332 let id: ExpressionOperandId = match *counter_kind {
333 CoverageKind::Counter { id, .. } => id.into(),
334 CoverageKind::Expression { id, .. } => id.into(),
336 bug!("the given `CoverageKind` is not an counter or expression: {:?}", counter_kind)
339 if self.some_counters.is_some() && (counter_format.block || !counter_format.id) {
340 let counters = self.some_counters.as_ref().unwrap();
341 if let Some(DebugCounter { some_block_label: Some(block_label), .. }) =
344 return if counter_format.id {
345 format!("{}#{}", block_label, id.index())
347 block_label.to_string()
351 format!("#{}", id.index())
354 fn format_operand(&self, operand: ExpressionOperandId) -> String {
355 if operand.index() == 0 {
356 return String::from("0");
358 if let Some(counters) = &self.some_counters {
359 if let Some(DebugCounter { counter_kind, some_block_label }) = counters.get(&operand) {
360 if let CoverageKind::Expression { .. } = counter_kind {
361 if let Some(block_label) = some_block_label {
362 if debug_options().counter_format.block {
366 self.format_counter_kind(counter_kind)
370 return format!("({})", self.format_counter_kind(counter_kind));
372 return self.format_counter_kind(counter_kind).to_string();
375 format!("#{}", operand.index().to_string())
379 /// A non-public support class to `DebugCounters`.
381 struct DebugCounter {
382 counter_kind: CoverageKind,
383 some_block_label: Option<String>,
387 fn new(counter_kind: CoverageKind, some_block_label: Option<String>) -> Self {
388 Self { counter_kind, some_block_label }
392 /// If enabled, this data structure captures additional debugging information used when generating
393 /// a Graphviz (.dot file) representation of the `CoverageGraph`, for debugging purposes.
394 pub(super) struct GraphvizData {
395 some_bcb_to_coverage_spans_with_counters:
396 Option<FxHashMap<BasicCoverageBlock, Vec<(CoverageSpan, CoverageKind)>>>,
397 some_bcb_to_dependency_counters: Option<FxHashMap<BasicCoverageBlock, Vec<CoverageKind>>>,
398 some_edge_to_counter: Option<FxHashMap<(BasicCoverageBlock, BasicBlock), CoverageKind>>,
402 pub fn new() -> Self {
404 some_bcb_to_coverage_spans_with_counters: None,
405 some_bcb_to_dependency_counters: None,
406 some_edge_to_counter: None,
410 pub fn enable(&mut self) {
411 debug_assert!(!self.is_enabled());
412 self.some_bcb_to_coverage_spans_with_counters = Some(FxHashMap::default());
413 self.some_bcb_to_dependency_counters = Some(FxHashMap::default());
414 self.some_edge_to_counter = Some(FxHashMap::default());
417 pub fn is_enabled(&self) -> bool {
418 self.some_bcb_to_coverage_spans_with_counters.is_some()
421 pub fn add_bcb_coverage_span_with_counter(
423 bcb: BasicCoverageBlock,
424 coverage_span: &CoverageSpan,
425 counter_kind: &CoverageKind,
427 if let Some(bcb_to_coverage_spans_with_counters) =
428 self.some_bcb_to_coverage_spans_with_counters.as_mut()
430 bcb_to_coverage_spans_with_counters
432 .or_insert_with(Vec::new)
433 .push((coverage_span.clone(), counter_kind.clone()));
437 pub fn get_bcb_coverage_spans_with_counters(
439 bcb: BasicCoverageBlock,
440 ) -> Option<&Vec<(CoverageSpan, CoverageKind)>> {
441 if let Some(bcb_to_coverage_spans_with_counters) =
442 self.some_bcb_to_coverage_spans_with_counters.as_ref()
444 bcb_to_coverage_spans_with_counters.get(&bcb)
450 pub fn add_bcb_dependency_counter(
452 bcb: BasicCoverageBlock,
453 counter_kind: &CoverageKind,
455 if let Some(bcb_to_dependency_counters) = self.some_bcb_to_dependency_counters.as_mut() {
456 bcb_to_dependency_counters
458 .or_insert_with(Vec::new)
459 .push(counter_kind.clone());
463 pub fn get_bcb_dependency_counters(
465 bcb: BasicCoverageBlock,
466 ) -> Option<&Vec<CoverageKind>> {
467 if let Some(bcb_to_dependency_counters) = self.some_bcb_to_dependency_counters.as_ref() {
468 bcb_to_dependency_counters.get(&bcb)
474 pub fn set_edge_counter(
476 from_bcb: BasicCoverageBlock,
478 counter_kind: &CoverageKind,
480 if let Some(edge_to_counter) = self.some_edge_to_counter.as_mut() {
482 .try_insert((from_bcb, to_bb), counter_kind.clone())
483 .expect("invalid attempt to insert more than one edge counter for the same edge");
487 pub fn get_edge_counter(
489 from_bcb: BasicCoverageBlock,
491 ) -> Option<&CoverageKind> {
492 if let Some(edge_to_counter) = self.some_edge_to_counter.as_ref() {
493 edge_to_counter.get(&(from_bcb, to_bb))
500 /// If enabled, this struct captures additional data used to track whether expressions were used,
501 /// directly or indirectly, to compute the coverage counts for all `CoverageSpan`s, and any that are
502 /// _not_ used are retained in the `unused_expressions` Vec, to be included in debug output (logs
503 /// and/or a `CoverageGraph` graphviz output).
504 pub(super) struct UsedExpressions {
505 some_used_expression_operands:
506 Option<FxHashMap<ExpressionOperandId, Vec<InjectedExpressionId>>>,
507 some_unused_expressions:
508 Option<Vec<(CoverageKind, Option<BasicCoverageBlock>, BasicCoverageBlock)>>,
511 impl UsedExpressions {
512 pub fn new() -> Self {
513 Self { some_used_expression_operands: None, some_unused_expressions: None }
516 pub fn enable(&mut self) {
517 debug_assert!(!self.is_enabled());
518 self.some_used_expression_operands = Some(FxHashMap::default());
519 self.some_unused_expressions = Some(Vec::new());
522 pub fn is_enabled(&self) -> bool {
523 self.some_used_expression_operands.is_some()
526 pub fn add_expression_operands(&mut self, expression: &CoverageKind) {
527 if let Some(used_expression_operands) = self.some_used_expression_operands.as_mut() {
528 if let CoverageKind::Expression { id, lhs, rhs, .. } = *expression {
529 used_expression_operands.entry(lhs).or_insert_with(Vec::new).push(id);
530 used_expression_operands.entry(rhs).or_insert_with(Vec::new).push(id);
535 pub fn expression_is_used(&self, expression: &CoverageKind) -> bool {
536 if let Some(used_expression_operands) = self.some_used_expression_operands.as_ref() {
537 used_expression_operands.contains_key(&expression.as_operand_id())
543 pub fn add_unused_expression_if_not_found(
545 expression: &CoverageKind,
546 edge_from_bcb: Option<BasicCoverageBlock>,
547 target_bcb: BasicCoverageBlock,
549 if let Some(used_expression_operands) = self.some_used_expression_operands.as_ref() {
550 if !used_expression_operands.contains_key(&expression.as_operand_id()) {
551 self.some_unused_expressions.as_mut().unwrap().push((
560 /// Return the list of unused counters (if any) as a tuple with the counter (`CoverageKind`),
561 /// optional `from_bcb` (if it was an edge counter), and `target_bcb`.
562 pub fn get_unused_expressions(
564 ) -> Vec<(CoverageKind, Option<BasicCoverageBlock>, BasicCoverageBlock)> {
565 if let Some(unused_expressions) = self.some_unused_expressions.as_ref() {
566 unused_expressions.clone()
572 /// If enabled, validate that every BCB or edge counter not directly associated with a coverage
573 /// span is at least indirectly associated (it is a dependency of a BCB counter that _is_
574 /// associated with a coverage span).
577 bcb_counters_without_direct_coverage_spans: &Vec<(
578 Option<BasicCoverageBlock>,
583 if self.is_enabled() {
584 let mut not_validated = bcb_counters_without_direct_coverage_spans
586 .map(|(_, _, counter_kind)| counter_kind)
587 .collect::<Vec<_>>();
588 let mut validating_count = 0;
589 while not_validated.len() != validating_count {
590 let to_validate = not_validated.split_off(0);
591 validating_count = to_validate.len();
592 for counter_kind in to_validate {
593 if self.expression_is_used(counter_kind) {
594 self.add_expression_operands(counter_kind);
596 not_validated.push(counter_kind);
603 pub fn alert_on_unused_expressions(&self, debug_counters: &DebugCounters) {
604 if let Some(unused_expressions) = self.some_unused_expressions.as_ref() {
605 for (counter_kind, edge_from_bcb, target_bcb) in unused_expressions {
606 let unused_counter_message = if let Some(from_bcb) = edge_from_bcb.as_ref() {
608 "non-coverage edge counter found without a dependent expression, in \
609 {:?}->{:?}; counter={}",
612 debug_counters.format_counter(&counter_kind),
616 "non-coverage counter found without a dependent expression, in {:?}; \
619 debug_counters.format_counter(&counter_kind),
623 if debug_options().allow_unused_expressions {
624 debug!("WARNING: {}", unused_counter_message);
626 bug!("{}", unused_counter_message);
633 /// Generates the MIR pass `CoverageSpan`-specific spanview dump file.
634 pub(super) fn dump_coverage_spanview(
636 mir_body: &mir::Body<'tcx>,
637 basic_coverage_blocks: &CoverageGraph,
640 coverage_spans: &Vec<CoverageSpan>,
642 let mir_source = mir_body.source;
643 let def_id = mir_source.def_id();
645 let span_viewables = span_viewables(tcx, mir_body, basic_coverage_blocks, &coverage_spans);
646 let mut file = pretty::create_dump_file(tcx, "html", None, pass_name, &0, mir_source)
647 .expect("Unexpected error creating MIR spanview HTML file");
648 let crate_name = tcx.crate_name(def_id.krate);
649 let item_name = tcx.def_path(def_id).to_filename_friendly_no_crate();
650 let title = format!("{}.{} - Coverage Spans", crate_name, item_name);
651 spanview::write_document(tcx, body_span, span_viewables, &title, &mut file)
652 .expect("Unexpected IO error dumping coverage spans as HTML");
655 /// Converts the computed `BasicCoverageBlockData`s into `SpanViewable`s.
658 mir_body: &mir::Body<'tcx>,
659 basic_coverage_blocks: &CoverageGraph,
660 coverage_spans: &Vec<CoverageSpan>,
661 ) -> Vec<SpanViewable> {
662 let mut span_viewables = Vec::new();
663 for coverage_span in coverage_spans {
664 let tooltip = coverage_span.format_coverage_statements(tcx, mir_body);
665 let CoverageSpan { span, bcb, .. } = coverage_span;
666 let bcb_data = &basic_coverage_blocks[*bcb];
667 let id = bcb_data.id();
668 let leader_bb = bcb_data.leader_bb();
669 span_viewables.push(SpanViewable { bb: leader_bb, span: *span, id, tooltip });
674 /// Generates the MIR pass coverage-specific graphviz dump file.
675 pub(super) fn dump_coverage_graphviz(
677 mir_body: &mir::Body<'tcx>,
679 basic_coverage_blocks: &CoverageGraph,
680 debug_counters: &DebugCounters,
681 graphviz_data: &GraphvizData,
682 intermediate_expressions: &Vec<CoverageKind>,
683 debug_used_expressions: &UsedExpressions,
685 let mir_source = mir_body.source;
686 let def_id = mir_source.def_id();
687 let node_content = |bcb| {
688 bcb_to_string_sections(
692 &basic_coverage_blocks[bcb],
693 graphviz_data.get_bcb_coverage_spans_with_counters(bcb),
694 graphviz_data.get_bcb_dependency_counters(bcb),
695 // intermediate_expressions are injected into the mir::START_BLOCK, so
696 // include them in the first BCB.
697 if bcb.index() == 0 { Some(&intermediate_expressions) } else { None },
700 let edge_labels = |from_bcb| {
701 let from_bcb_data = &basic_coverage_blocks[from_bcb];
702 let from_terminator = from_bcb_data.terminator(mir_body);
703 let mut edge_labels = from_terminator.kind.fmt_successor_labels();
704 edge_labels.retain(|label| label != "unreachable");
705 let edge_counters = from_terminator
707 .map(|&successor_bb| graphviz_data.get_edge_counter(from_bcb, successor_bb));
708 iter::zip(&edge_labels, edge_counters)
709 .map(|(label, some_counter)| {
710 if let Some(counter) = some_counter {
711 format!("{}\n{}", label, debug_counters.format_counter(counter))
718 let graphviz_name = format!("Cov_{}_{}", def_id.krate.index(), def_id.index.index());
719 let mut graphviz_writer =
720 GraphvizWriter::new(basic_coverage_blocks, &graphviz_name, node_content, edge_labels);
721 let unused_expressions = debug_used_expressions.get_unused_expressions();
722 if unused_expressions.len() > 0 {
723 graphviz_writer.set_graph_label(&format!(
724 "Unused expressions:\n {}",
728 .map(|(counter_kind, edge_from_bcb, target_bcb)| {
729 if let Some(from_bcb) = edge_from_bcb.as_ref() {
734 debug_counters.format_counter(&counter_kind),
740 debug_counters.format_counter(&counter_kind),
748 let mut file = pretty::create_dump_file(tcx, "dot", None, pass_name, &0, mir_source)
749 .expect("Unexpected error creating BasicCoverageBlock graphviz DOT file");
751 .write_graphviz(tcx, &mut file)
752 .expect("Unexpected error writing BasicCoverageBlock graphviz DOT file");
755 fn bcb_to_string_sections(
757 mir_body: &mir::Body<'tcx>,
758 debug_counters: &DebugCounters,
759 bcb_data: &BasicCoverageBlockData,
760 some_coverage_spans_with_counters: Option<&Vec<(CoverageSpan, CoverageKind)>>,
761 some_dependency_counters: Option<&Vec<CoverageKind>>,
762 some_intermediate_expressions: Option<&Vec<CoverageKind>>,
764 let len = bcb_data.basic_blocks.len();
765 let mut sections = Vec::new();
766 if let Some(collect_intermediate_expressions) = some_intermediate_expressions {
768 collect_intermediate_expressions
771 format!("Intermediate {}", debug_counters.format_counter(expression))
777 if let Some(coverage_spans_with_counters) = some_coverage_spans_with_counters {
779 coverage_spans_with_counters
781 .map(|(covspan, counter)| {
784 debug_counters.format_counter(counter),
785 covspan.format(tcx, mir_body)
792 if let Some(dependency_counters) = some_dependency_counters {
793 sections.push(format!(
794 "Non-coverage counters:\n {}",
797 .map(|counter| debug_counters.format_counter(counter))
802 if let Some(counter_kind) = &bcb_data.counter_kind {
803 sections.push(format!("{:?}", counter_kind));
805 let non_term_blocks = bcb_data.basic_blocks[0..len - 1]
807 .map(|&bb| format!("{:?}: {}", bb, term_type(&mir_body[bb].terminator().kind)))
808 .collect::<Vec<_>>();
809 if non_term_blocks.len() > 0 {
810 sections.push(non_term_blocks.join("\n"));
812 sections.push(format!(
814 bcb_data.basic_blocks.last().unwrap(),
815 term_type(&bcb_data.terminator(mir_body).kind)
820 /// Returns a simple string representation of a `TerminatorKind` variant, independent of any
821 /// values it might hold.
822 pub(super) fn term_type(kind: &TerminatorKind<'tcx>) -> &'static str {
824 TerminatorKind::Goto { .. } => "Goto",
825 TerminatorKind::SwitchInt { .. } => "SwitchInt",
826 TerminatorKind::Resume => "Resume",
827 TerminatorKind::Abort => "Abort",
828 TerminatorKind::Return => "Return",
829 TerminatorKind::Unreachable => "Unreachable",
830 TerminatorKind::Drop { .. } => "Drop",
831 TerminatorKind::DropAndReplace { .. } => "DropAndReplace",
832 TerminatorKind::Call { .. } => "Call",
833 TerminatorKind::Assert { .. } => "Assert",
834 TerminatorKind::Yield { .. } => "Yield",
835 TerminatorKind::GeneratorDrop => "GeneratorDrop",
836 TerminatorKind::FalseEdge { .. } => "FalseEdge",
837 TerminatorKind::FalseUnwind { .. } => "FalseUnwind",
838 TerminatorKind::InlineAsm { .. } => "InlineAsm",