-
Notifications
You must be signed in to change notification settings - Fork 13.6k
Introduce debuginfo to statements in MIR #142771
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Conversation
This comment has been minimized.
This comment has been minimized.
15c968a
to
6b013d4
Compare
This comment has been minimized.
This comment has been minimized.
6b013d4
to
51576e7
Compare
This comment has been minimized.
This comment has been minimized.
@bors2 try @rust-timer queue |
This comment has been minimized.
This comment has been minimized.
Introduce debuginfo to statements in MIR Not ready for reviewing. Something known: - [ ] Retain debuginfo when concatenating bbs - [ ] Document about when to drop debuginfos (don't be worse than the optimized LLVM IR) - [ ] Missing tests r? ghost
This comment has been minimized.
This comment has been minimized.
Finished benchmarking commit (eb83156): comparison URL. Overall result: ❌✅ regressions and improvements - please read the text belowBenchmarking this pull request means it may be perf-sensitive – we'll automatically label it not fit for rolling up. You can override this, but we strongly advise not to, due to possible changes in compiler perf. Next Steps: If you can justify the regressions found in this try perf run, please do so in sufficient writing along with @bors rollup=never Instruction countOur most reliable metric. Used to determine the overall result above. However, even this metric can be noisy.
Max RSS (memory usage)Results (primary 2.3%, secondary 3.4%)A less reliable metric. May be of interest, but not used to determine the overall result above.
CyclesResults (primary 3.2%, secondary 2.5%)A less reliable metric. May be of interest, but not used to determine the overall result above.
Binary sizeResults (primary 0.5%, secondary 0.3%)A less reliable metric. May be of interest, but not used to determine the overall result above.
Bootstrap: 691.482s -> 692.445s (0.14%) |
51576e7
to
e72c3ae
Compare
@bors2 try @rust-timer queue |
This comment has been minimized.
This comment has been minimized.
Introduce debuginfo to statements in MIR Not ready for reviewing. Something known: - [ ] Retain debuginfo when concatenating bbs - [ ] Document about when to drop debuginfos (don't be worse than the optimized LLVM IR) - [ ] Missing tests r? ghost
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Finished benchmarking commit (77d5c6a): comparison URL. Overall result: ❌✅ regressions and improvements - please read the text belowBenchmarking this pull request means it may be perf-sensitive – we'll automatically label it not fit for rolling up. You can override this, but we strongly advise not to, due to possible changes in compiler perf. Next Steps: If you can justify the regressions found in this try perf run, please do so in sufficient writing along with @bors rollup=never Instruction countOur most reliable metric. Used to determine the overall result above. However, even this metric can be noisy.
Max RSS (memory usage)Results (primary 2.4%, secondary 3.4%)A less reliable metric. May be of interest, but not used to determine the overall result above.
CyclesResults (primary 2.1%, secondary 0.5%)A less reliable metric. May be of interest, but not used to determine the overall result above.
Binary sizeResults (primary 0.5%, secondary 0.3%)A less reliable metric. May be of interest, but not used to determine the overall result above.
Bootstrap: 690.617s -> 691.47s (0.12%) |
☔ The latest upstream changes (presumably #142870) made this pull request unmergeable. Please resolve the merge conflicts. |
@bors2 try @rust-timer queue |
This comment has been minimized.
This comment has been minimized.
Introduce debuginfo to statements in MIR
This comment has been minimized.
This comment has been minimized.
Finished benchmarking commit (61f71d4): comparison URL. Overall result: ❌✅ regressions and improvements - please read the text belowBenchmarking this pull request means it may be perf-sensitive – we'll automatically label it not fit for rolling up. You can override this, but we strongly advise not to, due to possible changes in compiler perf. Next Steps: If you can justify the regressions found in this try perf run, please do so in sufficient writing along with @bors rollup=never Instruction countOur most reliable metric. Used to determine the overall result above. However, even this metric can be noisy.
Max RSS (memory usage)Results (primary 2.0%, secondary 4.0%)A less reliable metric. May be of interest, but not used to determine the overall result above.
CyclesResults (primary -0.6%, secondary 3.9%)A less reliable metric. May be of interest, but not used to determine the overall result above.
Binary sizeResults (primary 0.5%, secondary 0.4%)A less reliable metric. May be of interest, but not used to determine the overall result above.
Bootstrap: 467.629s -> 469.243s (0.35%) |
compiler/rustc_middle/src/mir/mod.rs
Outdated
self.statements.retain_mut(|stmt| f(stmt)); | ||
return; | ||
} | ||
let mut debuginfos = Vec::new(); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you mind adding a comment saying so?
location: Location | ||
) { | ||
self.super_statement_debuginfos(stmt_debuginfo, location); | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we really need this method?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure but I removed.
compiler/rustc_middle/src/mir/mod.rs
Outdated
@@ -1342,6 +1342,10 @@ pub struct BasicBlockData<'tcx> { | |||
/// List of statements in this block. | |||
pub statements: Vec<Statement<'tcx>>, | |||
|
|||
/// All debuginfos happen before the statement. | |||
/// Put debuginfos here when the last statement is eliminated. | |||
pub after_last_stmt_debuginfos: Vec<StmtDebugInfo<'tcx>>, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it after the last statement, or before the terminator? Why isn't it inside Terminator
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have some passes that change the terminator, which means we also must hand debuginfos. I think this will make things more complicated.
I expect these debuginfos to be handled in simplifycfg as much as possible.
LocalRef::Operand(operand_ref) => match operand_ref.val { | ||
OperandValue::Immediate(v) => { | ||
Some(PlaceRef::new_sized(v, operand_ref.layout)) | ||
let assign_ref = if let Some(place) = place { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use place.and_then(|place|
to keep the previous logic?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have removed the Option
.
@@ -958,5 +969,5 @@ impl RawPtrKind { | |||
|
|||
#[derive(Clone, TyEncodable, TyDecodable, HashStable, TypeFoldable, TypeVisitable)] | |||
pub enum StmtDebugInfo<'tcx> { | |||
AssignRef(Local, Place<'tcx>), | |||
AssignRef(Local, Option<Place<'tcx>>), |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not convinced by the benefit of allowing None
here. Do you mind splitting this change from other tweaks to DSE, so we can see what it does in isolation?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is 048f7eb what you're looking for?
self.always_used.contains(local) | ||
); | ||
// To keep things simple, we don't handle debugging information here, these are in DSE. | ||
self.always_used.contains(local) || self.use_count[local] != 0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd rather keep handling debuginfo in this general SimplifyLocals
. It runs much more often than DSE.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps, but I don't want to make this PR any more complicated, and I'm concerned about the compile time.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps I could handle this in this PR.
@@ -718,6 +717,7 @@ pub(crate) fn run_optimization_passes<'tcx>(tcx: TyCtxt<'tcx>, body: &mut Body<' | |||
&strip_debuginfo::StripDebugInfo, | |||
©_prop::CopyProp, | |||
&dead_store_elimination::DeadStoreElimination::Final, | |||
&match_branches::MatchBranchSimplification, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you mind submitting this change in a separate PR?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will drop this at the next update.
94ddfe6
to
224fbe9
Compare
This comment has been minimized.
This comment has been minimized.
I'll squash the fixups during the next rebase. 🙏 |
This comment has been minimized.
This comment has been minimized.
…hain-changed, r=cjgillot simplifycfg: Mark as changed when start is modified in collapse goto chain Split from rust-lang#142771. r? cjgillot
mir: Do not modify NonUse in `super_projection_elem` Split from rust-lang#142771. r? cjgillot
5105df9
to
7a0c75b
Compare
7a0c75b
to
458ad93
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is looking very good thanks! I'm not certain I'm the best reviewer for the codegen part, so I just left a few questions.
@@ -312,8 +321,11 @@ macro_rules! make_mir_visitor { | |||
index += 1; | |||
} | |||
|
|||
let location = Location { block, statement_index: index }; | |||
for debuginfo in after_last_stmt_debuginfos as & $($mutability)? [_] { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
in &$(mutability)? after_last_stmt_debuginfos
?
) -> Option<Place<'tcx>> { | ||
// Compute the place that we are storing to, if any | ||
let destination = match stmt_kind { | ||
StatementKind::Assign(box (place, rvalue)) => (rvalue.is_safe_to_remove() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit, easier for me to understand:
StatementKind::Assign(box (_, rvalue)) if !rvalue.is_safe_to_remove() => None,
StatementKind::Assign(box (place, _)) if stmt_kind.as_debuginfo().is_some() => Some(*place),
and then proceed to reasoning according to debuginfo_locals
.
@@ -160,19 +160,23 @@ impl<'ll> DebugInfoBuilderMethods for Builder<'_, 'll, '_> { | |||
&mut self, | |||
dbg_var: &'ll DIVariable, | |||
dbg_loc: &'ll DILocation, | |||
variable_alloca: Self::Value, | |||
is_declared: bool, | |||
val: Self::Value, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we just have 2 methods? a dbg_var_addr
and a dbg_var_value
?
pub(crate) fn codegen_stmt_debuginfo(&mut self, bx: &mut Bx, debuginfo: &StmtDebugInfo<'tcx>) { | ||
match debuginfo { | ||
StmtDebugInfo::AssignRef(dest, place) => { | ||
let place_ref = match self.locals[place.local] { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This local is poorly named. It represents place.local
, not the while place
. local_ref
?
(Some(place_ref), false) => { | ||
(place_ref.val, place_ref.layout, place.projection.as_slice()) | ||
} | ||
(Some(place_ref), true) => { | ||
let projected_ty = | ||
place_ref.layout.ty.builtin_deref(true).unwrap_or_else(|| { | ||
bug!("deref of non-pointer {:?}", place_ref) | ||
}); | ||
let layout = bx.cx().layout_of(projected_ty); | ||
(place_ref.val, layout, &place.projection[1..]) | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't understand the logic here. If this is an indirect place, we change the type but we don't change the val
?
} | ||
} | ||
|
||
fn debug_new_value_to_local_as_var( |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be inlined? This should allow to compute offsets only once outside the loop.
let ref_v1 = &ref_foo.1; | ||
let ref_v2 = &ref_foo.2; | ||
ref_foo.0 | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you have an example where we take the address of an Index
projection?
terminator.successors_mut(|successor| { | ||
self.collapse_goto_chain(successor, &mut changed); | ||
}); | ||
if changed && let Some(identical_succ) = identical_succ { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we introduce a more localized chain_changed
variable?
let mut succ_debuginfos = | ||
self.basic_blocks[succ].after_last_stmt_debuginfos.clone(); | ||
self.basic_blocks[current].after_last_stmt_debuginfos.extend(&mut succ_debuginfos); | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a way to look at pred_count
to avoid a clone?
use crate::util::is_within_packed; | ||
|
||
/// Performs the optimization on the body | ||
/// | ||
/// The `borrowed` set must be a `DenseBitSet` of all the locals that are ever borrowed in this | ||
/// body. It can be generated via the [`borrowed_locals`] function. | ||
fn eliminate<'tcx>(tcx: TyCtxt<'tcx>, body: &mut Body<'tcx>) { | ||
fn eliminate<'tcx>(tcx: TyCtxt<'tcx>, body: &mut Body<'tcx>) -> bool { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you doc-comment what this bool is?
The PR introduces support for debug information within dead statements. Currently, only the reference statement is supported, which is sufficient to fix #128081.
I don't modify Stable MIR, as I don't think we need debug information when using it.
This PR represents the debug information for the dead reference statement via
#dbg_value
. For example,let _foo_b = &foo.b
becomes#dbg_value(ptr %foo, !22, !DIExpression(DW_OP_plus_uconst, 4, DW_OP_stack_value), !26)
. You can see this here: https://rust.godbolt.org/z/d43js6adv.The general principle for handling debug information is to never provide less debug information than the optimized LLVM IR.
The current rules for dropping debug information in this PR are:
For the perf result:
I expected this to introduce some regressions; however, the results mixed the effects of inlining. Looking at the doc profile, this is a clear optimization. One potential regression I'm investigating is
serde-1.0.219-debug-full
.