Magic-Mirror/llvm-capstone
1
0
Fork 0
mirror of https://github.com/capstone-engine/llvm-capstone.git synced 2024-12-12 01:18:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[SimplifyCFG] Keep !dgb metadata of moved instruction, if they match.

Browse Source 
Currently SimplifyCFG drops the debug locations of 'bonus' instructions.
Such instructions are moved before the first branch. The reason for the
current behavior is that this could lead to surprising debug stepping,
if the block that's folded is dead.

In case the first branch and the instructions to be folded have the same
debug location, this shouldn't be an issue and we can keep the debug
location.

Reviewed By: vsk

Differential Revision: https://reviews.llvm.org/D93662
This commit is contained in:
Florian Hahn 2021-01-09 17:02:58 +00:00
parent 87d4ea2433
commit d98fc62ae6
3 changed files with 49 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
llvm/docs/HowToUpdateDebugInfo.rst
View File

@ -59,6 +59,17 @@ Examples of transformations for which this rule *does not* apply include:
* LICM. E.g., if an instruction is moved from the loop body to the preheader,
the rule for :ref:`dropping locations<WhenToDropLocation>` applies.
In addition to the rule above, a transformation should also preserve the debug
location of an instruction that is moved between basic blocks, if the
destination block already contains an instruction with an identical debug
location.
Examples of transformations that should follow this rule include:
* Moving instructions between basic blocks. For example, if instruction ``I1``
in ``BB1`` is moved before ``I2`` in ``BB2``, the source location of ``I1``
can be preserved if it has the same source location as ``I2``.
.. _WhenToMergeLocation:
When to merge instruction locations

11
llvm/lib/Transforms/Utils/SimplifyCFG.cpp
View File

@ -3037,10 +3037,13 @@ bool llvm::FoldBranchToCommonDest(BranchInst *BI, DomTreeUpdater *DTU,
if (&BonusInst == Cond)
CondInPred = NewBonusInst;
// When we fold the bonus instructions we want to make sure we
// reset their debug locations in order to avoid stepping on dead
// code caused by folding dead branches.
NewBonusInst->setDebugLoc(DebugLoc());
if (PBI->getDebugLoc() != NewBonusInst->getDebugLoc()) {
// Unless the instruction has the same !dbg location as the original
// branch, drop it. When we fold the bonus instructions we want to make
// sure we reset their debug locations in order to avoid stepping on
// dead code caused by folding dead branches.
NewBonusInst->setDebugLoc(DebugLoc());
}
RemapInstruction(NewBonusInst, VMap,
RF_NoModuleLevelChanges | RF_IgnoreMissingLocals);

31
llvm/test/Transforms/SimplifyCFG/fold-debug-location.ll
View File

@ -1,6 +1,7 @@
; RUN: opt -S -simplifycfg -simplifycfg-require-and-preserve-domtree=1 < %s | FileCheck %s --match-full-lines
; Make sure we reset the debug location when folding instructions.
; CHECK-LABEL: define {{.+}} @patatino({{.+}}
; CHECK: [[VAL:%.*]] = and i32 %c2, %k
; CHECK-NEXT: [[VAL2:%.*]] icmp eq i32 [[VAL]], 0
@ -24,6 +25,34 @@ define i32 @patatino(i32 %k, i32 %c1, i32 %c2) !dbg !6 {
ret i32 undef, !dbg !16
}
; All instructions involved in folding have the same !dbg location. Make sure
; they are preserved.
define void @dbg_all_equal(i32 %k, i32 %c1, i32 %c2) !dbg !17 {
; CHECK-LABEL: define {{.+}} @dbg_all_equal({{.+}}
; CHECK-NEXT: [[A1:%[a-z0-9]+]] = and i32 %c1, %k, !dbg [[DBG:![0-9]+]]
; CHECK-NEXT: [[C1:%[a-z0-9]+]] = icmp eq i32 [[A1]], 0, !dbg [[DBG]]
; CHECK-NEXT: [[A2:%[a-z0-9]+]] = and i32 %c2, %k, !dbg [[DBG]]
; CHECK-NEXT: [[C2:%[a-z0-9]+]] = icmp eq i32 [[A2]], 0, !dbg [[DBG]]
; CHECK-NEXT: [[OR:%[.a-z0-9]+]] = or i1 [[C1]], [[C2]], !dbg [[DBG]]
; CHECK-NEXT: br i1 [[OR]], label {{.+}}, label {{.+}}, !dbg [[DBG]]
;
%1 = and i32 %c1, %k, !dbg !18
%2 = icmp eq i32 %1, 0, !dbg !18
br i1 %2, label %8, label %3, !dbg !18
3:
%4 = and i32 %c2, %k, !dbg !18
%5 = icmp eq i32 %4, 0, !dbg !18
br i1 %5, label %8, label %6, !dbg !18
6:
%7 = tail call i32 (...) @bar(), !dbg !18
br label %8, !dbg !18
8:
ret void
}
!llvm.dbg.cu = !{!0}
!llvm.debugify = !{!3, !4}
!llvm.module.flags = !{!5}
@ -45,3 +74,5 @@ define i32 @patatino(i32 %k, i32 %c1, i32 %c2) !dbg !6 {
!14 = !DILocation(line: 7, column: 1, scope: !6)
!15 = !DILocation(line: 8, column: 1, scope: !6)
!16 = !DILocation(line: 9, column: 1, scope: !6)
!17 = distinct !DISubprogram(name: "dbg_all_equal", linkageName: "dbg_all_equal", scope: null, file: !1, line: 1, type: !7, scopeLine: 1, spFlags: DISPFlagDefinition | DISPFlagOptimized, unit: !0, retainedNodes: !2)
!18 = !DILocation(line: 10, column: 10, scope: !17)