llvm-project/llvm/test/DebugInfo/X86/dbg-prolog-end-backup-loc.ll
Jeremy Morse b468ed494a Reapply ccddb6ffad1, "Emit a worst-case prologue_end"
In 39b2979a4 Pavel has kindly refined the implementation of a test in such
a way that it doesn't trip up over this patch -- the test wishes to
stimulate LLDBs presentation of line0 locations, rather than wanting to
always step on line-zero on entry to artificial_location.c. As that's what
was tripping up this change, reapply.

Original commit message follows.

[DWARF] Emit a worst-case prologue_end flag for pathological inputs (#107849)

prologue_end usually indicates where the end of the function-initialization
lies, and is where debuggers usually choose to put the initial breakpoint
for a function. Our current algorithm piggy-backs it on the first available
source-location: which doesn't necessarily have anything to do with the
start of the function.

To avoid this in heavily-optimised code that lacks many useful source
locations, pick a worst-case "if all else fails" prologue_end location, of
the first instruction that appears to do meaningful computation. It'll be
given the function-scope line number, which should run-on from the start of
the function anyway. This means if your code is completely inverted by the
optimiser, you can at least put a breakpoint at the _start_ like you
expect, even if it's difficult to then step through.

This patch also attempts to preserve some good behaviour we have without
optimisations -- at O0, if the prologue immediately falls into a loop body
without any computation happening, then prologue_end lands at the start of
that loop. This is desirable; but does mean we need to do more work to
detect and support those situations.
2024-11-14 10:30:17 +00:00

87 lines
3.3 KiB
LLVM

; RUN: llc %s -o - | FileCheck %s
;; This test has had source-locations removed from the prologue, to simulate
;; heavily-optimised scenarios where a lot of debug-info gets dropped. Check
;; that we can pick a "worst-case" prologue_end position, of the first
;; instruction that does any meaningful computation (the add). It's better to
;; put the prologue_end flag here rather than deeper into the loop, past the
;; early-exit check.
;;
;; Generated from this code at -O2 -g in clang, with source locations then
;; deleted.
;;
;; int glob = 0;
;; int foo(int arg, int sum) {
;; arg += sum;
;; while (arg) {
;; glob--;
;; arg %= glob;
;; }
;; return 0;
;; }
; CHECK-LABEL: foo:
;; Scope-line location:
; CHECK: .loc 0 2 0
;; Entry block:
; CHECK: movl %edi, %edx
; CHECK-NEXT: .loc 0 2 0 prologue_end
; CHECK-NEXT: addl %esi, %edx
; CHECK-NEXT: je .LBB0_4
; CHECK-LABEL: # %bb.1:
target datalayout = "e-m:e-p270:32:32-p271:32:32-p272:64:64-i64:64-i128:128-f80:128-n8:16:32:64-S128"
target triple = "x86_64-unknown-linux-gnu"
@glob = dso_local local_unnamed_addr global i32 0, align 4, !dbg !0
define dso_local noundef i32 @foo(i32 noundef %arg, i32 noundef %sum) local_unnamed_addr !dbg !9 {
entry:
%add = add nsw i32 %sum, %arg
%tobool.not4 = icmp eq i32 %add, 0
br i1 %tobool.not4, label %while.end, label %while.body.preheader
while.body.preheader:
%glob.promoted = load i32, ptr @glob, align 4
br label %while.body, !dbg !14
while.body:
%arg.addr.06 = phi i32 [ %rem, %while.body ], [ %add, %while.body.preheader ]
%dec35 = phi i32 [ %dec, %while.body ], [ %glob.promoted, %while.body.preheader ]
%dec = add nsw i32 %dec35, -1, !dbg !15
%rem = srem i32 %arg.addr.06, %dec, !dbg !17
%tobool.not = icmp eq i32 %rem, 0, !dbg !14
br i1 %tobool.not, label %while.cond.while.end_crit_edge, label %while.body, !dbg !14
while.cond.while.end_crit_edge:
store i32 %dec, ptr @glob, align 4, !dbg !15
br label %while.end, !dbg !14
while.end:
ret i32 0, !dbg !18
}
!llvm.dbg.cu = !{!2}
!llvm.module.flags = !{!6, !7}
!llvm.ident = !{!8}
!0 = !DIGlobalVariableExpression(var: !1, expr: !DIExpression())
!1 = distinct !DIGlobalVariable(name: "glob", scope: !2, file: !3, line: 1, type: !5, isLocal: false, isDefinition: true)
!2 = distinct !DICompileUnit(language: DW_LANG_C11, file: !3, producer: "clang", isOptimized: true, runtimeVersion: 0, emissionKind: FullDebug, globals: !4, splitDebugInlining: false, nameTableKind: None)
!3 = !DIFile(filename: "foo.c", directory: "")
!4 = !{!0}
!5 = !DIBasicType(name: "int", size: 32, encoding: DW_ATE_signed)
!6 = !{i32 7, !"Dwarf Version", i32 5}
!7 = !{i32 2, !"Debug Info Version", i32 3}
!8 = !{!"clang"}
!9 = distinct !DISubprogram(name: "foo", scope: !3, file: !3, line: 2, type: !10, scopeLine: 2, flags: DIFlagPrototyped | DIFlagAllCallsDescribed, spFlags: DISPFlagDefinition | DISPFlagOptimized, unit: !2, retainedNodes: !12)
!10 = !DISubroutineType(types: !11)
!11 = !{!5, !5, !5}
!12 = !{}
!13 = !DILocation(line: 3, column: 7, scope: !9)
!14 = !DILocation(line: 4, column: 3, scope: !9)
!15 = !DILocation(line: 5, column: 9, scope: !16)
!16 = distinct !DILexicalBlock(scope: !9, file: !3, line: 4, column: 15)
!17 = !DILocation(line: 6, column: 9, scope: !16)
!18 = !DILocation(line: 8, column: 3, scope: !9)