From: Taewook Oh Date: Tue, 31 Jan 2017 20:57:13 +0000 (+0000) Subject: Do not propagate DebugLoc across basic blocks X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=73b0db7269fbcd6830141c36bab390b854292078;p=llvm Do not propagate DebugLoc across basic blocks Summary: DebugLoc shouldn't be propagated across basic blocks to prevent incorrect stepping and imprecise sample profile result. rL288903 addressed the wrong DebugLoc propagation issue by limiting the copy of DebugLoc when GVN removes a fully redundant load that is dominated by some other load. However, DebugLoc is still incorrectly propagated in the following example: ``` 1: extern int g; 2: 3: void foo(int x, int y, int z) { 4: if (x) 5: g = 0; 6: else 7: g = 1; 8: 9: int i = 0; 10: for ( ; i < y ; i++) 11: if (i > z) 12: g++; 13: } ``` Below is LLVM IR representation of the program before GVN: ``` @g = external local_unnamed_addr global i32, align 4 ; Function Attrs: nounwind uwtable define void @foo(i32 %x, i32 %y, i32 %z) local_unnamed_addr #0 !dbg !4 { entry: %not.tobool = icmp eq i32 %x, 0, !dbg !8 %.sink = zext i1 %not.tobool to i32, !dbg !8 store i32 %.sink, i32* @g, align 4, !tbaa !9 %cmp8 = icmp sgt i32 %y, 0, !dbg !13 br i1 %cmp8, label %for.body.preheader, label %for.end, !dbg !17 for.body.preheader: ; preds = %entry br label %for.body, !dbg !19 for.body: ; preds = %for.body.preheader, %for.inc %i.09 = phi i32 [ %inc4, %for.inc ], [ 0, %for.body.preheader ] %cmp1 = icmp sgt i32 %i.09, %z, !dbg !19 br i1 %cmp1, label %if.then2, label %for.inc, !dbg !21 if.then2: ; preds = %for.body %0 = load i32, i32* @g, align 4, !dbg !22, !tbaa !9 %inc = add nsw i32 %0, 1, !dbg !22 store i32 %inc, i32* @g, align 4, !dbg !22, !tbaa !9 br label %for.inc, !dbg !23 for.inc: ; preds = %for.body, %if.then2 %inc4 = add nuw nsw i32 %i.09, 1, !dbg !24 %exitcond = icmp ne i32 %inc4, %y, !dbg !13 br i1 %exitcond, label %for.body, label %for.end.loopexit, !dbg !17 for.end.loopexit: ; preds = %for.inc br label %for.end, !dbg !26 for.end: ; preds = %for.end.loopexit, %entry ret void, !dbg !26 } ``` where ``` !21 = !DILocation(line: 11, column: 9, scope: !15) !22 = !DILocation(line: 12, column: 8, scope: !20) !23 = !DILocation(line: 12, column: 7, scope: !20) !24 = !DILocation(line: 10, column: 20, scope: !25) ``` And below is after GVN: ``` @g = external local_unnamed_addr global i32, align 4 define void @foo(i32 %x, i32 %y, i32 %z) local_unnamed_addr !dbg !4 { entry: %not.tobool = icmp eq i32 %x, 0, !dbg !8 %.sink = zext i1 %not.tobool to i32, !dbg !8 store i32 %.sink, i32* @g, align 4, !tbaa !9 %cmp8 = icmp sgt i32 %y, 0, !dbg !13 br i1 %cmp8, label %for.body.preheader, label %for.end, !dbg !17 for.body.preheader: ; preds = %entry br label %for.body, !dbg !19 for.body: ; preds = %for.inc, %for.body.preheader %0 = phi i32 [ %1, %for.inc ], [ %.sink, %for.body.preheader ], !dbg !21 %i.09 = phi i32 [ %inc4, %for.inc ], [ 0, %for.body.preheader ] %cmp1 = icmp sgt i32 %i.09, %z, !dbg !19 br i1 %cmp1, label %if.then2, label %for.inc, !dbg !22 if.then2: ; preds = %for.body %inc = add nsw i32 %0, 1, !dbg !21 store i32 %inc, i32* @g, align 4, !dbg !21, !tbaa !9 br label %for.inc, !dbg !23 for.inc: ; preds = %if.then2, %for.body %1 = phi i32 [ %inc, %if.then2 ], [ %0, %for.body ] %inc4 = add nuw nsw i32 %i.09, 1, !dbg !24 %exitcond = icmp ne i32 %inc4, %y, !dbg !13 br i1 %exitcond, label %for.body, label %for.end.loopexit, !dbg !17 for.end.loopexit: ; preds = %for.inc br label %for.end, !dbg !26 for.end: ; preds = %for.end.loopexit, %entry ret void, !dbg !26 } ``` As you see, GVN removes the load in if.then2 block and creates a phi instruction in for.body for it. The problem is that DebugLoc of remove load instruction is propagated to the newly created phi instruction, which is wrong. rL288903 cannot handle this case because ValuesPerBlock.size() is not 1 in this example when the load is removed. Reviewers: aprantl, andreadb, wolfgangp Reviewed By: andreadb Subscribers: davide, llvm-commits Differential Revision: https://reviews.llvm.org/D29254 git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@293688 91177308-0d34-0410-b5e6-96231b3b80d8 --- diff --git a/lib/Transforms/Scalar/GVN.cpp b/lib/Transforms/Scalar/GVN.cpp index 91b27aa7235..2f861baeb9c 100644 --- a/lib/Transforms/Scalar/GVN.cpp +++ b/lib/Transforms/Scalar/GVN.cpp @@ -1714,7 +1714,7 @@ bool GVN::processNonLocalLoad(LoadInst *LI) { // If instruction I has debug info, then we should not update it. // Also, if I has a null DebugLoc, then it is still potentially incorrect // to propagate LI's DebugLoc because LI may not post-dominate I. - if (LI->getDebugLoc() && ValuesPerBlock.size() != 1) + if (LI->getDebugLoc() && LI->getParent() == I->getParent()) I->setDebugLoc(LI->getDebugLoc()); if (V->getType()->getScalarType()->isPointerTy()) MD->invalidateCachedPointerInfo(V); @@ -1796,7 +1796,7 @@ static void patchReplacementInstruction(Instruction *I, Value *Repl) { // Patch the replacement so that it is not more restrictive than the value // being replaced. - // Note that if 'I' is a load being replaced by some operation, + // Note that if 'I' is a load being replaced by some operation, // for example, by an arithmetic operation, then andIRFlags() // would just erase all math flags from the original arithmetic // operation, which is clearly not wanted and not needed. diff --git a/test/Transforms/GVN/debugloc.ll b/test/Transforms/GVN/debugloc.ll new file mode 100644 index 00000000000..d8c1632d144 --- /dev/null +++ b/test/Transforms/GVN/debugloc.ll @@ -0,0 +1,77 @@ +; RUN: opt < %s -gvn -S | FileCheck %s +; CHECK: {{^}}for.body: +; CHECK-NEXT: [[VREG1:%[^ ]+]] = phi{{.*}}[[VREG2:%[^ ]+]],{{.*}}%.sink, +; CHECK-NOT: !dbg +; CHECK-SAME: {{$}} +; CHECK: {{^}}for.inc: +; CHECK-NEXT: [[VREG2]] = phi{{.*}}%inc,{{.*}}[[VREG1]] + +target triple = "x86_64-unknown-linux-gnu" + +@g = external local_unnamed_addr global i32, align 4 + +; Function Attrs: nounwind uwtable +define void @foo(i32 %x, i32 %y, i32 %z) local_unnamed_addr #0 !dbg !4 { +entry: + %not.tobool = icmp eq i32 %x, 0, !dbg !8 + %.sink = zext i1 %not.tobool to i32, !dbg !8 + store i32 %.sink, i32* @g, align 4, !tbaa !9 + %cmp8 = icmp sgt i32 %y, 0, !dbg !13 + br i1 %cmp8, label %for.body.preheader, label %for.end, !dbg !17 + +for.body.preheader: ; preds = %entry + br label %for.body, !dbg !19 + +for.body: ; preds = %for.body.preheader, %for.inc + %i.09 = phi i32 [ %inc4, %for.inc ], [ 0, %for.body.preheader ] + %cmp1 = icmp sgt i32 %i.09, %z, !dbg !19 + br i1 %cmp1, label %if.then2, label %for.inc, !dbg !21 + +if.then2: ; preds = %for.body + %0 = load i32, i32* @g, align 4, !dbg !22, !tbaa !9 + %inc = add nsw i32 %0, 1, !dbg !22 + store i32 %inc, i32* @g, align 4, !dbg !22, !tbaa !9 + br label %for.inc, !dbg !23 + +for.inc: ; preds = %for.body, %if.then2 + %inc4 = add nuw nsw i32 %i.09, 1, !dbg !24 + %exitcond = icmp ne i32 %inc4, %y, !dbg !13 + br i1 %exitcond, label %for.body, label %for.end.loopexit, !dbg !17 + +for.end.loopexit: ; preds = %for.inc + br label %for.end, !dbg !26 + +for.end: ; preds = %for.end.loopexit, %entry + ret void, !dbg !26 +} + +!0 = distinct !DICompileUnit(language: DW_LANG_C99, file: !1) +!1 = !DIFile(filename: "foo.c", directory: "b/") +!2 = !{i32 2, !"Dwarf Version", i32 4} +!3 = !{i32 2, !"Debug Info Version", i32 3} +!4 = distinct !DISubprogram(name: "foo", scope: !1, file: !1, line: 3, type: !5, isLocal: false, isDefinition: true, scopeLine: 3, flags: DIFlagPrototyped, isOptimized: true, unit: !0) +!5 = !DISubroutineType(types: !6) +!6 = !{null, !7, !7, !7} +!7 = !DIBasicType(name: "int", size: 32, encoding: DW_ATE_signed) +!8 = !DILocation(line: 4, column: 7, scope: !4) +!9 = !{!10, !10, i64 0} +!10 = !{!"int", !11, i64 0} +!11 = !{!"omnipotent char", !12, i64 0} +!12 = !{!"Simple C/C++ TBAA"} +!13 = !DILocation(line: 10, column: 13, scope: !14) +!14 = !DILexicalBlockFile(scope: !15, file: !1, discriminator: 1) +!15 = distinct !DILexicalBlock(scope: !16, file: !1, line: 10, column: 3) +!16 = distinct !DILexicalBlock(scope: !4, file: !1, line: 10, column: 3) +!17 = !DILocation(line: 10, column: 3, scope: !18) +!18 = !DILexicalBlockFile(scope: !16, file: !1, discriminator: 1) +!19 = !DILocation(line: 11, column: 11, scope: !20) +!20 = distinct !DILexicalBlock(scope: !15, file: !1, line: 11, column: 9) +!21 = !DILocation(line: 11, column: 9, scope: !15) +!22 = !DILocation(line: 12, column: 8, scope: !20) +!23 = !DILocation(line: 12, column: 7, scope: !20) +!24 = !DILocation(line: 10, column: 20, scope: !25) +!25 = !DILexicalBlockFile(scope: !15, file: !1, discriminator: 2) +!26 = !DILocation(line: 13, column: 1, scope: !4) + +!llvm.dbg.cu = !{!0} +!llvm.module.flags = !{!2, !3} diff --git a/test/Transforms/NewGVN/debugloc.ll b/test/Transforms/NewGVN/debugloc.ll new file mode 100644 index 00000000000..55597a078bb --- /dev/null +++ b/test/Transforms/NewGVN/debugloc.ll @@ -0,0 +1,78 @@ +; XFAIL: * +; RUN: opt < %s -newgvn -S | FileCheck %s +; CHECK: {{^}}for.body: +; CHECK-NEXT: [[VREG1:%[^ ]+]] = phi{{.*}}[[VREG2:%[^ ]+]],{{.*}}%.sink, +; CHECK-NOT: !dbg +; CHECK-SAME: {{$}} +; CHECK: {{^}}for.inc: +; CHECK-NEXT: [[VREG2]] = phi{{.*}}%inc,{{.*}}[[VREG1]] + +target triple = "x86_64-unknown-linux-gnu" + +@g = external local_unnamed_addr global i32, align 4 + +; Function Attrs: nounwind uwtable +define void @foo(i32 %x, i32 %y, i32 %z) local_unnamed_addr #0 !dbg !4 { +entry: + %not.tobool = icmp eq i32 %x, 0, !dbg !8 + %.sink = zext i1 %not.tobool to i32, !dbg !8 + store i32 %.sink, i32* @g, align 4, !tbaa !9 + %cmp8 = icmp sgt i32 %y, 0, !dbg !13 + br i1 %cmp8, label %for.body.preheader, label %for.end, !dbg !17 + +for.body.preheader: ; preds = %entry + br label %for.body, !dbg !19 + +for.body: ; preds = %for.body.preheader, %for.inc + %i.09 = phi i32 [ %inc4, %for.inc ], [ 0, %for.body.preheader ] + %cmp1 = icmp sgt i32 %i.09, %z, !dbg !19 + br i1 %cmp1, label %if.then2, label %for.inc, !dbg !21 + +if.then2: ; preds = %for.body + %0 = load i32, i32* @g, align 4, !dbg !22, !tbaa !9 + %inc = add nsw i32 %0, 1, !dbg !22 + store i32 %inc, i32* @g, align 4, !dbg !22, !tbaa !9 + br label %for.inc, !dbg !23 + +for.inc: ; preds = %for.body, %if.then2 + %inc4 = add nuw nsw i32 %i.09, 1, !dbg !24 + %exitcond = icmp ne i32 %inc4, %y, !dbg !13 + br i1 %exitcond, label %for.body, label %for.end.loopexit, !dbg !17 + +for.end.loopexit: ; preds = %for.inc + br label %for.end, !dbg !26 + +for.end: ; preds = %for.end.loopexit, %entry + ret void, !dbg !26 +} + +!0 = distinct !DICompileUnit(language: DW_LANG_C99, file: !1) +!1 = !DIFile(filename: "foo.c", directory: "b/") +!2 = !{i32 2, !"Dwarf Version", i32 4} +!3 = !{i32 2, !"Debug Info Version", i32 3} +!4 = distinct !DISubprogram(name: "foo", scope: !1, file: !1, line: 3, type: !5, isLocal: false, isDefinition: true, scopeLine: 3, flags: DIFlagPrototyped, isOptimized: true, unit: !0) +!5 = !DISubroutineType(types: !6) +!6 = !{null, !7, !7, !7} +!7 = !DIBasicType(name: "int", size: 32, encoding: DW_ATE_signed) +!8 = !DILocation(line: 4, column: 7, scope: !4) +!9 = !{!10, !10, i64 0} +!10 = !{!"int", !11, i64 0} +!11 = !{!"omnipotent char", !12, i64 0} +!12 = !{!"Simple C/C++ TBAA"} +!13 = !DILocation(line: 10, column: 13, scope: !14) +!14 = !DILexicalBlockFile(scope: !15, file: !1, discriminator: 1) +!15 = distinct !DILexicalBlock(scope: !16, file: !1, line: 10, column: 3) +!16 = distinct !DILexicalBlock(scope: !4, file: !1, line: 10, column: 3) +!17 = !DILocation(line: 10, column: 3, scope: !18) +!18 = !DILexicalBlockFile(scope: !16, file: !1, discriminator: 1) +!19 = !DILocation(line: 11, column: 11, scope: !20) +!20 = distinct !DILexicalBlock(scope: !15, file: !1, line: 11, column: 9) +!21 = !DILocation(line: 11, column: 9, scope: !15) +!22 = !DILocation(line: 12, column: 8, scope: !20) +!23 = !DILocation(line: 12, column: 7, scope: !20) +!24 = !DILocation(line: 10, column: 20, scope: !25) +!25 = !DILexicalBlockFile(scope: !15, file: !1, discriminator: 2) +!26 = !DILocation(line: 13, column: 1, scope: !4) + +!llvm.dbg.cu = !{!0} +!llvm.module.flags = !{!2, !3}