Skip to content

Commit 281cbce

Browse files
rust-timerrust-timer
authored
Unrolled build for rust-lang#123797
Rollup merge of rust-lang#123797 - amandasystems:better-graphviz, r=oli-obk Better graphviz output for SCCs and NLL constraints This PR modifies the output for `-Z dump-mir-graphviz=yes`. Specifically, it changes the output of the files `.-------.nll.0.regioncx.all.dot` and `nll.0.regioncx.scc.dot` to be easier to read and contain some information that helped me during debugging. In particular: - SCC indices are contracted to `SCC(n)` instead of `ConstraintSccIndex(n)` to compress the nodes - SCC regions are in `{}` rather than `[]` (controversial since they are technically ordered by index, but I figured they're more sets than arrays conceptually since they're equivalence classes). - For regions in other universes than the root, also show the region universe (as ?8/U1) - For regions with external names, show the external name in parenthesis - For the region graph where edges are locations, render the All variant of the enum without the file since it's extremely long and often destroys the rendering - For region graph edge annotations for single locations, remove the wrapping around the Location variant and just add its contents since this can be unambiguously done Example output (from the function `foo()` of `tests/ui/error-codes/E0582.rs`) for an SCC graph: ![a graph showing SCCs](https://github.com/rust-lang/rust/assets/102855/0b998338-0379-4829-b99e-d8105c094897) ...and for the constraints: ![a graph showing regions and their constraints](https://github.com/rust-lang/rust/assets/102855/e984c4ca-7aa2-4db2-9878-bf38fe8208d5) This PR also gives `UniverseIndex`es the `is_root()` method since this is now an operation that happens three times in the borrowck crate.
2 parents 4e1f5d9 + 800c506 commit 281cbce

File tree

4 files changed

+43
-6
lines changed

4 files changed

+43
-6
lines changed

‎compiler/rustc_borrowck/src/region_infer/graphviz.rs

+36-4
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,38 @@ use std::borrow::Cow;
66
use std::io::{self, Write};
77

88
use super::*;
9+
use itertools::Itertools;
910
use rustc_graphviz as dot;
11+
use rustc_middle::ty::UniverseIndex;
12+
13+
fn render_outlives_constraint(constraint: &OutlivesConstraint<'_>) -> String {
14+
match constraint.locations {
15+
Locations::All(_) => "All(...)".to_string(),
16+
Locations::Single(loc) => format!("{loc:?}"),
17+
}
18+
}
19+
20+
fn render_universe(u: UniverseIndex) -> String {
21+
if u.is_root() {
22+
return "".to_string();
23+
}
24+
25+
format!("/{:?}", u)
26+
}
27+
28+
fn render_region_vid(rvid: RegionVid, regioncx: &RegionInferenceContext<'_>) -> String {
29+
let universe_str = render_universe(regioncx.region_definition(rvid).universe);
30+
31+
let external_name_str = if let Some(external_name) =
32+
regioncx.region_definition(rvid).external_name.and_then(|e| e.get_name())
33+
{
34+
format!(" ({external_name})")
35+
} else {
36+
"".to_string()
37+
};
38+
39+
format!("{:?}{universe_str}{external_name_str}", rvid)
40+
}
1041

1142
impl<'tcx> RegionInferenceContext<'tcx> {
1243
/// Write out the region constraint graph.
@@ -46,10 +77,10 @@ impl<'a, 'this, 'tcx> dot::Labeller<'this> for RawConstraints<'a, 'tcx> {
4677
Some(dot::LabelText::LabelStr(Cow::Borrowed("box")))
4778
}
4879
fn node_label(&'this self, n: &RegionVid) -> dot::LabelText<'this> {
49-
dot::LabelText::LabelStr(format!("{n:?}").into())
80+
dot::LabelText::LabelStr(render_region_vid(*n, self.regioncx).into())
5081
}
5182
fn edge_label(&'this self, e: &OutlivesConstraint<'tcx>) -> dot::LabelText<'this> {
52-
dot::LabelText::LabelStr(format!("{:?}", e.locations).into())
83+
dot::LabelText::LabelStr(render_outlives_constraint(e).into())
5384
}
5485
}
5586

@@ -96,8 +127,9 @@ impl<'a, 'this, 'tcx> dot::Labeller<'this> for SccConstraints<'a, 'tcx> {
96127
Some(dot::LabelText::LabelStr(Cow::Borrowed("box")))
97128
}
98129
fn node_label(&'this self, n: &ConstraintSccIndex) -> dot::LabelText<'this> {
99-
let nodes = &self.nodes_per_scc[*n];
100-
dot::LabelText::LabelStr(format!("{n:?} = {nodes:?}").into())
130+
let nodes_str =
131+
self.nodes_per_scc[*n].iter().map(|n| render_region_vid(*n, self.regioncx)).join(", ");
132+
dot::LabelText::LabelStr(format!("SCC({n}) = {{{nodes_str}}}", n = n.as_usize()).into())
101133
}
102134
}
103135

‎compiler/rustc_borrowck/src/region_infer/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1562,7 +1562,7 @@ impl<'tcx> RegionInferenceContext<'tcx> {
15621562

15631563
// Because this free region must be in the ROOT universe, we
15641564
// know it cannot contain any bound universes.
1565-
assert!(self.scc_universes[longer_fr_scc] == ty::UniverseIndex::ROOT);
1565+
assert!(self.scc_universes[longer_fr_scc].is_root());
15661566
debug_assert!(self.scc_values.placeholders_contained_in(longer_fr_scc).next().is_none());
15671567

15681568
// Only check all of the relations for the main representative of each

‎compiler/rustc_borrowck/src/region_infer/opaque_types.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ impl<'tcx> RegionInferenceContext<'tcx> {
213213
let scc = self.constraint_sccs.scc(vid);
214214

215215
// Special handling of higher-ranked regions.
216-
if self.scc_universes[scc] != ty::UniverseIndex::ROOT {
216+
if !self.scc_universes[scc].is_root() {
217217
match self.scc_values.placeholders_contained_in(scc).enumerate().last() {
218218
// If the region contains a single placeholder then they're equal.
219219
Some((0, placeholder)) => {

‎compiler/rustc_type_ir/src/lib.rs

+5
Original file line numberDiff line numberDiff line change
@@ -346,6 +346,11 @@ impl UniverseIndex {
346346
pub fn cannot_name(self, other: UniverseIndex) -> bool {
347347
self < other
348348
}
349+
350+
/// Returns `true` if `self` is the root universe, otherwise false.
351+
pub fn is_root(self) -> bool {
352+
self == Self::ROOT
353+
}
349354
}
350355

351356
impl Default for UniverseIndex {

0 commit comments

Comments
 (0)