[KeyInstr][JumpThreading] Remap atoms in blocks duplicated for threading

[OCHyams]

No description provided.

[OCHyams]

• [NFC][KeyInstr][Clang] Add some additional tests #134654
• [KeyInstr][Clang] Coerced store atoms #134653
• [KeyInstr][Clang] Ret atom #134652
• [KeyIntsr][Clang] Builtins alloca auto-init atom #134651
• [KeyInstr][Clang] Assign matrix element atom #134650
• [KeyInstr][Clang] Assign vector element atom #134649
• [KeyInstr][Clang] Bitfield atom #134648
• [KeyInstr][Clang] For range stmt atoms #134647
• [KeyInstr][Clang] For stmt atom #134646
• [KeyInstr][Clang] While stmt atom #134645
• [KeyInstr][Clang] Do stmt atom #134644
• [KeyInstr][Clang] Switch stmt atom #134643
• [KeyInstr][Clang] If stmt atom #134642
• [KeyInstr][Clang] Catch variable init atom #134641
• [KeyInstr][Clang] Member initalization atom #134640
• [KeyInstr][Clang] Aggregate init + copy #134639
• [KeyInstr] Complex assignment atoms #134638
• [KeyInstr][Clang] Assignment atom group #134637
• [KeyInstr][Clang] Static variable init atom #134636
• [KeyInstr][Clang] Agg init atom #134635
• [Clang][NFC] Move some static functions into CodeGenFunction #134634
• [KeyInstr][Clang] Scalar init atom #134633
• [KeyInstr][Clang] Add ApplyAtomGroup #134632
• [KeyInstr][Clang] Add Clang option -g[no-]key-instructions #134627
• [KeyInstr][DwarfDebug] Add is_stmt emission support #133495
• [KeyInstr] Add MIR parser support #133494
• [KeyInstr] Remap cloned PHIs in BreakCriticalEdges #133493
• Propagate DebugLocs on phis in BreakCriticalEdges #133492
• [KeyInstr][LoopUnswitch] Remap cloned instructions' atoms #133491
• [KeyInstr][LoopRotate] Remap atoms of duplicated instructions #133490
• [KeyInstr][LoopUnroll] Remap atoms while unrolling #133489
• [KeyInstr][JumpThreading] Remap atoms duping bb with cond br on phi into pred #133488
• [KeyInstr][JumpThreading] Remap atoms after threading #133487
• [KeyInstr][JumpThreading] Remap atoms in blocks duplicated for threading #133486 👈 (View in Graphite)
• [KeyInstr][Inline] Don't propagate atoms to inlined nodebug instructions #133485
• [KeyInstr][SimplifyCFG] Remap atoms after duplication for threading #133484
• [KeyInstr][debugify] Add --debugify-atoms to add key instructions metadata #133483
• [KeyInstr][SimplifyCFG] Remap atoms when folding br to common succ into pred #133482
• [KeyInstr] Inline atom info #133481
• [KeyInstr] Merge atoms in DILocation::getMergedLocation #133480
• [NFC][KeyInstr] Add Atom Group (re)mapping #133479
• [KeyInstr] Add Atom Group waterline to LLVMContext #133478
• [KeyInstr] Add fields to DILocation behind compile time flag #133477
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[github-actions]

✅ With the latest revision this PR passed the C/C++ code formatter.

[llvmbot]

@llvm/pr-subscribers-llvm-transforms

@llvm/pr-subscribers-debuginfo

Author: Orlando Cazalet-Hyams (OCHyams)

Changes

---

Full diff: https://github.com/llvm/llvm-project/pull/133486.diff

2 Files Affected:

• (modified) llvm/lib/Transforms/Scalar/JumpThreading.cpp (+14-1)
• (added) llvm/test/DebugInfo/KeyInstructions/Generic/jump-threading-2-bbs.ll (+68)

diff --git a/llvm/lib/Transforms/Scalar/JumpThreading.cpp b/llvm/lib/Transforms/Scalar/JumpThreading.cpp
index 18d5f201413c8..18dda2f3ad82e 100644
--- a/llvm/lib/Transforms/Scalar/JumpThreading.cpp
+++ b/llvm/lib/Transforms/Scalar/JumpThreading.cpp
@@ -1995,6 +1995,14 @@ void JumpThreadingPass::updateSSA(BasicBlock *BB, BasicBlock *NewBB,
   }
 }
 
+static void remapSourceAtoms(ValueToValueMapTy &VM, BasicBlock::iterator Begin,
+                             BasicBlock::iterator End) {
+  if (VM.AtomMap.empty())
+    return;
+  for (auto It = Begin; It != End; ++It)
+    RemapSourceAtom(&*It, VM);
+}
+
 /// Clone instructions in range [BI, BE) to NewBB.  For PHI nodes, we only clone
 /// arguments that come from PredBB.  Return the map from the variables in the
 /// source basic block to the variables in the newly created basic block.
@@ -2059,6 +2067,8 @@ void JumpThreadingPass::cloneInstructions(ValueToValueMapTy &ValueMapping,
     PHINode *NewPN = PHINode::Create(PN->getType(), 1, PN->getName(), NewBB);
     NewPN->addIncoming(PN->getIncomingValueForBlock(PredBB), PredBB);
     ValueMapping[PN] = NewPN;
+    if (const DebugLoc &DL = PN->getDebugLoc())
+      mapAtomInstance(DL, ValueMapping);
   }
 
   // Clone noalias scope declarations in the threaded block. When threading a
@@ -2087,8 +2097,10 @@ void JumpThreadingPass::cloneInstructions(ValueToValueMapTy &ValueMapping,
     adaptNoAliasScopes(New, ClonedScopes, Context);
 
     CloneAndRemapDbgInfo(New, &*BI);
+    if (const DebugLoc &DL = New->getDebugLoc())
+      mapAtomInstance(DL, ValueMapping);
 
-    if (RetargetDbgValueIfPossible(New))
+      if (RetargetDbgValueIfPossible(New))
       continue;
 
     // Remap operands to patch up intra-block references.
@@ -2314,6 +2326,7 @@ void JumpThreadingPass::threadThroughTwoBasicBlocks(BasicBlock *PredPredBB,
        {DominatorTree::Insert, PredPredBB, NewBB},
        {DominatorTree::Delete, PredPredBB, PredBB}});
 
+  remapSourceAtoms(ValueMapping, NewBB->begin(), NewBB->end());
   updateSSA(PredBB, NewBB, ValueMapping);
 
   // Clean up things like PHI nodes with single operands, dead instructions,
diff --git a/llvm/test/DebugInfo/KeyInstructions/Generic/jump-threading-2-bbs.ll b/llvm/test/DebugInfo/KeyInstructions/Generic/jump-threading-2-bbs.ll
new file mode 100644
index 0000000000000..3ca81f554034f
--- /dev/null
+++ b/llvm/test/DebugInfo/KeyInstructions/Generic/jump-threading-2-bbs.ll
@@ -0,0 +1,68 @@
+; RUN: opt -S -passes=jump-threading,verify %s | FileCheck %s
+
+;; Modified from llvm/test/Transforms/JumpThreading/thread-two-bbs.ll
+;;
+;; JumpThreading duplicates bb.cond2 to thread through bb.file to bb.f2 or exit.
+;;
+;; Check the duplicated instructions get remapped atom groups.
+
+; CHECK: bb.cond2:
+; CHECK-NEXT: call void @f1()
+; CHECK-NEXT: %tobool1 = icmp eq i32 %cond2, 0, !dbg [[G1R2:!.*]]
+; CHECK-NEXT: br i1 %tobool1, label %exit, label %exit, !dbg [[G1R1:!.*]]
+
+; CHECK: bb.cond2.thread:
+; CHECK-NEXT: %tobool12 = icmp eq i32 %cond2, 0, !dbg [[G2R2:!.*]]
+; CHECK-NEXT: br i1 %tobool12, label %bb.f2, label %exit, !dbg [[G2R1:!.*]]
+
+; CHECK: [[G1R2]] = !DILocation(line: 1, column: 1, scope: ![[#]], atomGroup: 1, atomRank: 2)
+; CHECK: [[G1R1]] = !DILocation(line: 1, column: 1, scope: ![[#]], atomGroup: 1, atomRank: 1)
+; CHECK: [[G2R2]] = !DILocation(line: 1, column: 1, scope: ![[#]], atomGroup: 2, atomRank: 2)
+; CHECK: [[G2R1]] = !DILocation(line: 1, column: 1, scope: ![[#]], atomGroup: 2, atomRank: 1)
+
+@a = global i32 0, align 4
+
+define void @foo(i32 %cond1, i32 %cond2) !dbg !5 {
+entry:
+  %tobool = icmp eq i32 %cond1, 0
+  br i1 %tobool, label %bb.cond2, label %bb.f1
+
+bb.f1:                                            ; preds = %entry
+  call void @f1()
+  br label %bb.cond2
+
+bb.cond2:                                         ; preds = %bb.f1, %entry
+  %ptr = phi ptr [ null, %bb.f1 ], [ @a, %entry ]
+  %tobool1 = icmp eq i32 %cond2, 0, !dbg !9
+  br i1 %tobool1, label %bb.file, label %exit, !dbg !10
+
+bb.file:                                          ; preds = %bb.cond2
+  %cmp = icmp eq ptr %ptr, null
+  br i1 %cmp, label %exit, label %bb.f2
+
+bb.f2:                                            ; preds = %bb.file
+  call void @f2()
+  br label %exit
+
+exit:                                             ; preds = %bb.f2, %bb.file, %bb.cond2
+  ret void
+}
+
+declare void @f1()
+
+declare void @f2()
+
+!llvm.dbg.cu = !{!0}
+!llvm.debugify = !{!2, !3}
+!llvm.module.flags = !{!4}
+
+!0 = distinct !DICompileUnit(language: DW_LANG_C, file: !1, producer: "debugify", isOptimized: true, runtimeVersion: 0, emissionKind: FullDebug)
+!1 = !DIFile(filename: "<stdin>", directory: "/")
+!2 = !{i32 16}
+!3 = !{i32 0}
+!4 = !{i32 2, !"Debug Info Version", i32 3}
+!5 = distinct !DISubprogram(name: "foo", linkageName: "foo", scope: null, file: !1, line: 1, type: !6, scopeLine: 1, spFlags: DISPFlagDefinition | DISPFlagOptimized, unit: !0)
+!6 = !DISubroutineType(types: !7)
+!7 = !{}
+!9 = !DILocation(line: 1, column: 1, scope: !5, atomGroup: 1, atomRank: 2)
+!10 = !DILocation(line: 1, column: 1, scope: !5, atomGroup: 1, atomRank: 1)

[jmorse]

LGTM with nits

[jmorse]

Accidental whitespace

[jmorse]

I'd say "comment pls", but I suppose the fact there's "source" in the name gives a hint as to what's going on.

[jmorse]

CHECK-LABEL?

[pogo59]

I wouldn't. The point of CHECK-LABEL is to subdivide the checked text; here, CHECK is followed by a series of CHECK-NEXT, so the grouping effect of -LABEL isn't needed.