Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings
This repository was archived by the owner on May 28, 2025. It is now read-only.

Commit fe4f400

Browse files
Unrolled build for rust-lang#129711
Rollup merge of rust-lang#129711 - lqd:nll-mir-dumps, r=compiler-errors Expand NLL MIR dumps This PR is a first step to clean up and expand NLL MIR dumps: - by restoring the "mir-include-spans" comments which are useful for `-Zdump-mir=nll` - by adding the list of borrows to NLL MIR dumps, where they are introduced in the CFG and in which region Comments in MIR dumps were turned off in rust-lang#112346, but as shown in rust-lang#114652 they were still useful for us working with NLL MIR dumps. So this PR pulls `-Z mir-include-spans` into its own options struct, so that passes dumping MIR can override them if need be. The rest of the compiler is not affected, only the "nll" pass dumps have these comments enabled again. The CLI still has priority when specifying the flag, so that we can explicitly turn them off in the `mir-opt` tests to keep blessed dumps easier to work with (which was one of the points of rust-lang#112346). Then, as part of a couple steps to improve NLL/polonius MIR dumps and `.dot` visualizations, I've also added the list of borrows and where they're introduced. I'm doing all this to help debug some polonius scope issues in my prototype location-sensitive analysis :3. I'll probably add member constraints soon.
2 parents 9649706 + dff3d35 commit fe4f400

File tree

12 files changed

+214
-64
lines changed

12 files changed

+214
-64
lines changed

‎compiler/rustc_borrowck/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ fn do_mir_borrowck<'tcx>(
229229

230230
// Dump MIR results into a file, if that is enabled. This let us
231231
// write unit-tests, as well as helping with debugging.
232-
nll::dump_mir_results(&infcx, body, &regioncx, &opt_closure_req);
232+
nll::dump_nll_mir(&infcx, body, &regioncx, &opt_closure_req,&borrow_set);
233233

234234
// We also have a `#[rustc_regions]` annotation that causes us to dump
235235
// information.

‎compiler/rustc_borrowck/src/nll.rs

Lines changed: 67 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ use polonius_engine::{Algorithm, Output};
99
use rustc_data_structures::fx::FxIndexMap;
1010
use rustc_hir::def_id::LocalDefId;
1111
use rustc_index::IndexSlice;
12+
use rustc_middle::mir::pretty::{dump_mir_with_options, PrettyPrintMirOptions};
1213
use rustc_middle::mir::{
1314
create_dump_file, dump_enabled, dump_mir, Body, ClosureOutlivesSubject,
1415
ClosureRegionRequirements, PassWhere, Promoted,
@@ -19,6 +20,7 @@ use rustc_mir_dataflow::impls::MaybeInitializedPlaces;
1920
use rustc_mir_dataflow::move_paths::MoveData;
2021
use rustc_mir_dataflow::points::DenseLocationMap;
2122
use rustc_mir_dataflow::ResultsCursor;
23+
use rustc_session::config::MirIncludeSpans;
2224
use rustc_span::symbol::sym;
2325

2426
use crate::borrow_set::BorrowSet;
@@ -208,52 +210,90 @@ pub(crate) fn compute_regions<'cx, 'tcx>(
208210
}
209211
}
210212

211-
pub(super) fn dump_mir_results<'tcx>(
213+
/// `-Zdump-mir=nll` dumps MIR annotated with NLL specific information:
214+
/// - free regions
215+
/// - inferred region values
216+
/// - region liveness
217+
/// - inference constraints and their causes
218+
///
219+
/// As well as graphviz `.dot` visualizations of:
220+
/// - the region constraints graph
221+
/// - the region SCC graph
222+
pub(super) fn dump_nll_mir<'tcx>(
212223
infcx: &BorrowckInferCtxt<'tcx>,
213224
body: &Body<'tcx>,
214225
regioncx: &RegionInferenceContext<'tcx>,
215226
closure_region_requirements: &Option<ClosureRegionRequirements<'tcx>>,
227+
borrow_set: &BorrowSet<'tcx>,
216228
) {
217-
if !dump_enabled(infcx.tcx, "nll", body.source.def_id()) {
229+
let tcx = infcx.tcx;
230+
if !dump_enabled(tcx, "nll", body.source.def_id()) {
218231
return;
219232
}
220233

221-
dump_mir(infcx.tcx, false, "nll", &0, body, |pass_where, out| {
222-
match pass_where {
223-
// Before the CFG, dump out the values for each region variable.
224-
PassWhere::BeforeCFG => {
225-
regioncx.dump_mir(infcx.tcx, out)?;
226-
writeln!(out, "|")?;
227-
228-
if let Some(closure_region_requirements) = closure_region_requirements {
229-
writeln!(out, "| Free Region Constraints")?;
230-
for_each_region_constraint(
231-
infcx.tcx,
232-
closure_region_requirements,
233-
&mut |msg| writeln!(out, "| {msg}"),
234-
)?;
234+
// We want the NLL extra comments printed by default in NLL MIR dumps (they were removed in
235+
// #112346). Specifying `-Z mir-include-spans` on the CLI still has priority: for example,
236+
// they're always disabled in mir-opt tests to make working with blessed dumps easier.
237+
let options = PrettyPrintMirOptions {
238+
include_extra_comments: matches!(
239+
infcx.tcx.sess.opts.unstable_opts.mir_include_spans,
240+
MirIncludeSpans::On | MirIncludeSpans::Nll
241+
),
242+
};
243+
dump_mir_with_options(
244+
tcx,
245+
false,
246+
"nll",
247+
&0,
248+
body,
249+
|pass_where, out| {
250+
match pass_where {
251+
// Before the CFG, dump out the values for each region variable.
252+
PassWhere::BeforeCFG => {
253+
regioncx.dump_mir(tcx, out)?;
235254
writeln!(out, "|")?;
255+
256+
if let Some(closure_region_requirements) = closure_region_requirements {
257+
writeln!(out, "| Free Region Constraints")?;
258+
for_each_region_constraint(tcx, closure_region_requirements, &mut |msg| {
259+
writeln!(out, "| {msg}")
260+
})?;
261+
writeln!(out, "|")?;
262+
}
263+
264+
if borrow_set.len() > 0 {
265+
writeln!(out, "| Borrows")?;
266+
for (borrow_idx, borrow_data) in borrow_set.iter_enumerated() {
267+
writeln!(
268+
out,
269+
"| {:?}: issued at {:?} in {:?}",
270+
borrow_idx, borrow_data.reserve_location, borrow_data.region
271+
)?;
272+
}
273+
writeln!(out, "|")?;
274+
}
236275
}
237-
}
238276

239-
PassWhere::BeforeLocation(_) => {}
277+
PassWhere::BeforeLocation(_) => {}
240278

241-
PassWhere::AfterTerminator(_) => {}
279+
PassWhere::AfterTerminator(_) => {}
242280

243-
PassWhere::BeforeBlock(_) | PassWhere::AfterLocation(_) | PassWhere::AfterCFG => {}
244-
}
245-
Ok(())
246-
});
281+
PassWhere::BeforeBlock(_) | PassWhere::AfterLocation(_) | PassWhere::AfterCFG => {}
282+
}
283+
Ok(())
284+
},
285+
options,
286+
);
247287

248-
// Also dump the inference graph constraints as a graphviz file.
288+
// Also dump the region constraint graph as a graphviz file.
249289
let _: io::Result<()> = try {
250-
let mut file = create_dump_file(infcx.tcx, "regioncx.all.dot", false, "nll", &0, body)?;
290+
let mut file = create_dump_file(tcx, "regioncx.all.dot", false, "nll", &0, body)?;
251291
regioncx.dump_graphviz_raw_constraints(&mut file)?;
252292
};
253293

254-
// Also dump the inference graph constraints as a graphviz file.
294+
// Also dump the region constraint SCC graph as a graphviz file.
255295
let _: io::Result<()> = try {
256-
let mut file = create_dump_file(infcx.tcx, "regioncx.scc.dot", false, "nll", &0, body)?;
296+
let mut file = create_dump_file(tcx, "regioncx.scc.dot", false, "nll", &0, body)?;
257297
regioncx.dump_graphviz_scc_constraints(&mut file)?;
258298
};
259299
}

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ impl<'tcx> RegionInferenceContext<'tcx> {
4646
dot::render(&RawConstraints { regioncx: self }, &mut w)
4747
}
4848

49-
/// Write out the region constraint graph.
49+
/// Write out the region constraint SCC graph.
5050
pub(crate) fn dump_graphviz_scc_constraints(&self, mut w: &mut dyn Write) -> io::Result<()> {
5151
let mut nodes_per_scc: IndexVec<ConstraintSccIndex, _> =
5252
self.constraint_sccs.all_sccs().map(|_| Vec::new()).collect();

‎compiler/rustc_codegen_cranelift/src/base.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,9 @@ pub(crate) fn codegen_fn<'tcx>(
4444
let _mir_guard = crate::PrintOnPanic(|| {
4545
let mut buf = Vec::new();
4646
with_no_trimmed_paths!({
47-
rustc_middle::mir::pretty::write_mir_fn(tcx, mir, &mut |_, _| Ok(()), &mut buf)
48-
.unwrap();
47+
use rustc_middle::mir::pretty;
48+
let options = pretty::PrettyPrintMirOptions::from_cli(tcx);
49+
pretty::write_mir_fn(tcx, mir, &mut |_, _| Ok(()), &mut buf, options).unwrap();
4950
});
5051
String::from_utf8_lossy(&buf).into_owned()
5152
});

‎compiler/rustc_interface/src/tests.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,10 @@ use rustc_session::config::{
1212
CollapseMacroDebuginfo, CoverageLevel, CoverageOptions, DebugInfo, DumpMonoStatsFormat,
1313
ErrorOutputType, ExternEntry, ExternLocation, Externs, FmtDebug, FunctionReturn,
1414
InliningThreshold, Input, InstrumentCoverage, InstrumentXRay, LinkSelfContained,
15-
LinkerPluginLto, LocationDetail, LtoCli, NextSolverConfig, OomStrategy, Options, OutFileName,
16-
OutputType, OutputTypes, PAuthKey, PacRet, Passes, PatchableFunctionEntry, Polonius,
17-
ProcMacroExecutionStrategy, Strip, SwitchWithOptPath, SymbolManglingVersion, WasiExecModel,
15+
LinkerPluginLto, LocationDetail, LtoCli, MirIncludeSpans, NextSolverConfig, OomStrategy,
16+
Options, OutFileName, OutputType, OutputTypes, PAuthKey, PacRet, Passes,
17+
PatchableFunctionEntry, Polonius, ProcMacroExecutionStrategy, Strip, SwitchWithOptPath,
18+
SymbolManglingVersion, WasiExecModel,
1819
};
1920
use rustc_session::lint::Level;
2021
use rustc_session::search_paths::SearchPath;
@@ -705,7 +706,7 @@ fn test_unstable_options_tracking_hash() {
705706
untracked!(ls, vec!["all".to_owned()]);
706707
untracked!(macro_backtrace, true);
707708
untracked!(meta_stats, true);
708-
untracked!(mir_include_spans, true);
709+
untracked!(mir_include_spans, MirIncludeSpans::On);
709710
untracked!(nll_facts, true);
710711
untracked!(no_analysis, true);
711712
untracked!(no_leak_check, true);

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /