Recommit "[MS] Emit S_HEAPALLOCSITE debug info in Selection DAG"

with a fix to clear the SDNode map when SelectionDAG is cleared.

llvm-svn: 368230

include/llvm/CodeGen/SelectionDAG.h

@@ -269,7 +269,13 @@ class SelectionDAG {
 
   using CallSiteInfo = MachineFunction::CallSiteInfo;
   using CallSiteInfoImpl = MachineFunction::CallSiteInfoImpl;
-  DenseMap<const SDNode *, CallSiteInfo> SDCallSiteInfo;
+
+  struct CallSiteDbgInfo {
+    CallSiteInfo CSInfo;
+    MDNode *HeapAllocSite = nullptr;
+  };
+
+  DenseMap<const SDNode *, CallSiteDbgInfo> SDCallSiteDbgInfo;
 
   uint16_t NextPersistentId = 0;
 
@@ -1665,16 +1671,28 @@ public:
   }
 
   void addCallSiteInfo(const SDNode *CallNode, CallSiteInfoImpl &&CallInfo) {
-    SDCallSiteInfo[CallNode] = std::move(CallInfo);
+    SDCallSiteDbgInfo[CallNode].CSInfo = std::move(CallInfo);
   }
 
   CallSiteInfo getSDCallSiteInfo(const SDNode *CallNode) {
-    auto I = SDCallSiteInfo.find(CallNode);
+    auto I = SDCallSiteDbgInfo.find(CallNode);
-    if (I != SDCallSiteInfo.end())
+    if (I != SDCallSiteDbgInfo.end())
-      return std::move(I->second);
+      return std::move(I->second).CSInfo;
     return CallSiteInfo();
   }
 
+  void addHeapAllocSite(const SDNode *Node, MDNode *MD) {
+    SDCallSiteDbgInfo[Node].HeapAllocSite = MD;
+  }
+
+  /// Return the HeapAllocSite type associated with the SDNode, if it exists.
+  MDNode *getHeapAllocSite(const SDNode *Node) {
+    auto It = SDCallSiteDbgInfo.find(Node);
+    if (It == SDCallSiteDbgInfo.end())
+      return nullptr;
+    return It->second.HeapAllocSite;
+  }
+
 private:
   void InsertNode(SDNode *N);
   bool RemoveNodeFromCSEMaps(SDNode *N);

lib/CodeGen/SelectionDAG/ScheduleDAGSDNodes.cpp

@@ -909,6 +909,12 @@ EmitSchedule(MachineBasicBlock::iterator &InsertPos) {
       // Remember the source order of the inserted instruction.
       if (HasDbg)
         ProcessSourceNode(N, DAG, Emitter, VRBaseMap, Orders, Seen, NewInsn);
+
+      if (MDNode *MD = DAG->getHeapAllocSite(N)) {
+        if (NewInsn && NewInsn->isCall())
+          MF.addCodeViewHeapAllocSite(NewInsn, MD);
+      }
+
       GluedNodes.pop_back();
     }
     auto NewInsn =
@@ -917,6 +923,10 @@ EmitSchedule(MachineBasicBlock::iterator &InsertPos) {
     if (HasDbg)
       ProcessSourceNode(SU->getNode(), DAG, Emitter, VRBaseMap, Orders, Seen,
                         NewInsn);
+    if (MDNode *MD = DAG->getHeapAllocSite(SU->getNode())) {
+      if (NewInsn && NewInsn->isCall())
+        MF.addCodeViewHeapAllocSite(NewInsn, MD);
+    }
   }
 
   // Insert all the dbg_values which have not already been inserted in source

lib/CodeGen/SelectionDAG/SelectionDAG.cpp

@@ -1083,6 +1083,7 @@ void SelectionDAG::clear() {
   ExternalSymbols.clear();
   TargetExternalSymbols.clear();
   MCSymbols.clear();
+  SDCallSiteDbgInfo.clear();
   std::fill(CondCodeNodes.begin(), CondCodeNodes.end(),
             static_cast<CondCodeSDNode*>(nullptr));
   std::fill(ValueTypeNodes.begin(), ValueTypeNodes.end(),

lib/Target/X86/X86ISelLowering.cpp

@@ -4069,6 +4069,11 @@ X86TargetLowering::LowerCall(TargetLowering::CallLoweringInfo &CLI,
   InFlag = Chain.getValue(1);
   DAG.addCallSiteInfo(Chain.getNode(), std::move(CSInfo));
 
+  // Save heapallocsite metadata.
+  if (CLI.CS)
+    if (MDNode *HeapAlloc = CLI.CS->getMetadata("heapallocsite"))
+      DAG.addHeapAllocSite(Chain.getNode(), HeapAlloc);
+
   // Create the CALLSEQ_END node.
   unsigned NumBytesForCalleeToPop;
   if (X86::isCalleePop(CallConv, Is64Bit, isVarArg,

test/CodeGen/X86/label-heapallocsite.ll

@@ -1,80 +1,96 @@
-; RUN: llc -O0 < %s | FileCheck %s
+; RUN: llc < %s | FileCheck --check-prefixes=DAG,CHECK %s
-; FIXME: Add test for llc with optimizations once it is implemented.
+; RUN: llc -O0 < %s | FileCheck --check-prefixes=FAST,CHECK %s
 
 ; Source to regenerate:
-; $ clang --target=x86_64-windows-msvc -S heapallocsite.cpp -g -gcodeview -o t.ll \
+; $ clang -cc1 -triple x86_64-windows-msvc t.cpp -debug-info-kind=limited \
-;      -emit-llvm -O0 -Xclang -disable-llvm-passes -fms-extensions
+;      -gcodeview -O2 -fms-extensions -emit-llvm -o t.ll
 ;
-; struct Foo {
+; extern "C" struct Foo {
 ;   __declspec(allocator) virtual void *alloc();
 ; };
-;
 ; extern "C" __declspec(allocator) Foo *alloc_foo();
-;
+; extern "C" void use_result(void *);
-; extern "C" void use_alloc(void*);
+; extern "C" Foo *call_tail() {
-; extern "C" void call_virtual(Foo *p) {
+;   return alloc_foo();
-;   use_alloc(p->alloc());
 ; }
-;
+; extern "C" int call_virtual(Foo *p) {
-; extern "C" void call_multiple() {
+;   use_result(p->alloc());
-;   use_alloc(alloc_foo());
+;   return 0;
-;   use_alloc(alloc_foo());
+; }
+; extern "C" int call_multiple() {
+;   use_result(alloc_foo());
+;   use_result(alloc_foo());
+;   return 0;
 ; }
 
+; ModuleID = 't.cpp'
+source_filename = "t.cpp"
 target datalayout = "e-m:w-i64:64-f80:128-n8:16:32:64-S128"
 target triple = "x86_64-unknown-windows-msvc"
 
 %struct.Foo = type { i32 (...)** }
 
-; Function Attrs: noinline optnone uwtable
+; Function Attrs: nounwind
-define dso_local void @call_virtual(%struct.Foo* %p) #0 !dbg !8 {
+define dso_local %struct.Foo* @call_tail() local_unnamed_addr #0 !dbg !7 {
 entry:
-  %p.addr = alloca %struct.Foo*, align 8
+  %call = tail call %struct.Foo* @alloc_foo() #3, !dbg !13, !heapallocsite !12
-  store %struct.Foo* %p, %struct.Foo** %p.addr, align 8
+  ret %struct.Foo* %call, !dbg !13
-  call void @llvm.dbg.declare(metadata %struct.Foo** %p.addr, metadata !13, metadata !DIExpression()), !dbg !14
-  %0 = load %struct.Foo*, %struct.Foo** %p.addr, align 8, !dbg !15
-  %1 = bitcast %struct.Foo* %0 to i8* (%struct.Foo*)***, !dbg !15
-  %vtable = load i8* (%struct.Foo*)**, i8* (%struct.Foo*)*** %1, align 8, !dbg !15
-  %vfn = getelementptr inbounds i8* (%struct.Foo*)*, i8* (%struct.Foo*)** %vtable, i64 0, !dbg !15
-  %2 = load i8* (%struct.Foo*)*, i8* (%struct.Foo*)** %vfn, align 8, !dbg !15
-  %call = call i8* %2(%struct.Foo* %0), !dbg !15, !heapallocsite !2
-  call void @use_alloc(i8* %call), !dbg !15
-  ret void, !dbg !16
 }
 
-; Function Attrs: nounwind readnone speculatable
+declare dso_local %struct.Foo* @alloc_foo() local_unnamed_addr #1
-declare void @llvm.dbg.declare(metadata, metadata, metadata) #1
 
-declare dso_local void @use_alloc(i8*) #2
+; Function Attrs: nounwind
-
+define dso_local i32 @call_virtual(%struct.Foo* %p) local_unnamed_addr #0 !dbg !14 {
-; Function Attrs: noinline optnone uwtable
-define dso_local void @call_multiple() #0 !dbg !17 {
 entry:
-  %call = call %struct.Foo* @alloc_foo(), !dbg !20, !heapallocsite !12
+  call void @llvm.dbg.value(metadata %struct.Foo* %p, metadata !19, metadata !DIExpression()), !dbg !20
-  %0 = bitcast %struct.Foo* %call to i8*, !dbg !20
+  %0 = bitcast %struct.Foo* %p to i8* (%struct.Foo*)***, !dbg !21
-  call void @use_alloc(i8* %0), !dbg !20
+  %vtable = load i8* (%struct.Foo*)**, i8* (%struct.Foo*)*** %0, align 8, !dbg !21, !tbaa !22
-  %call1 = call %struct.Foo* @alloc_foo(), !dbg !21, !heapallocsite !12
+  %1 = load i8* (%struct.Foo*)*, i8* (%struct.Foo*)** %vtable, align 8, !dbg !21
-  %1 = bitcast %struct.Foo* %call1 to i8*, !dbg !21
+  %call = tail call i8* %1(%struct.Foo* %p) #3, !dbg !21, !heapallocsite !2
-  call void @use_alloc(i8* %1), !dbg !21
+  tail call void @use_result(i8* %call) #3, !dbg !21
-  ret void, !dbg !22
+  ret i32 0, !dbg !25
 }
 
-declare dso_local %struct.Foo* @alloc_foo() #2
+declare dso_local void @use_result(i8*) local_unnamed_addr #1
 
-; CHECK-LABEL: call_virtual: # @call_virtual
+; Function Attrs: nounwind
+define dso_local i32 @call_multiple() local_unnamed_addr #0 !dbg !26 {
+entry:
+  %call = tail call %struct.Foo* @alloc_foo() #3, !dbg !29, !heapallocsite !12
+  %0 = bitcast %struct.Foo* %call to i8*, !dbg !29
+  tail call void @use_result(i8* %0) #3, !dbg !29
+  %call1 = tail call %struct.Foo* @alloc_foo() #3, !dbg !30, !heapallocsite !12
+  %1 = bitcast %struct.Foo* %call1 to i8*, !dbg !30
+  tail call void @use_result(i8* %1) #3, !dbg !30
+  ret i32 0, !dbg !31
+}
+
+; Function Attrs: nounwind readnone speculatable willreturn
+declare void @llvm.dbg.value(metadata, metadata, metadata) #2
+
+
+; Don't emit metadata for tail calls.
+; CHECK-LABEL: call_tail:         # @call_tail
+; CHECK-NOT: .Lheapallocsite
+; CHECK: jmp alloc_foo
+
+; CHECK-LABEL: call_virtual:      # @call_virtual
 ; CHECK: .Lheapallocsite0:
-; CHECK: callq *(%rax)
+; CHECK: callq *{{.*}}%rax{{.*}}
 ; CHECK: .Lheapallocsite1:
-; CHECK: retq
 
-; CHECK-LABEL: call_multiple: # @call_multiple
+; CHECK-LABEL: call_multiple:     # @call_multiple
-; CHECK: .Lheapallocsite4:
+; FastISel emits instructions in a different order.
+; DAG:   .Lheapallocsite2:
+; FAST:  .Lheapallocsite4:
 ; CHECK: callq alloc_foo
-; CHECK: .Lheapallocsite5:
+; DAG:   .Lheapallocsite3:
-; CHECK: .Lheapallocsite2:
+; FAST:  .Lheapallocsite5:
+; DAG:   .Lheapallocsite4:
+; FAST:  .Lheapallocsite2:
 ; CHECK: callq alloc_foo
-; CHECK: .Lheapallocsite3:
+; DAG:   .Lheapallocsite5:
-; CHECK: retq
+; FAST:  .Lheapallocsite3:
 
 ; CHECK-LABEL: .short  4423                    # Record kind: S_GPROC32_ID
 ; CHECK:       .short  4446                    # Record kind: S_HEAPALLOCSITE
@@ -82,48 +98,55 @@ declare dso_local %struct.Foo* @alloc_foo() #2
 ; CHECK-NEXT:  .secidx .Lheapallocsite0
 ; CHECK-NEXT:  .short .Lheapallocsite1-.Lheapallocsite0
 ; CHECK-NEXT:  .long 3
-; CHECK-NEXT:  .p2align 2
-; CHECK-LABEL: .short  4431                    # Record kind: S_PROC_ID_END
-
-; CHECK-LABEL: .short  4423                    # Record kind: S_GPROC32_ID
 ; CHECK:       .short  4446                    # Record kind: S_HEAPALLOCSITE
 ; CHECK-NEXT:  .secrel32 .Lheapallocsite2
 ; CHECK-NEXT:  .secidx .Lheapallocsite2
 ; CHECK-NEXT:  .short .Lheapallocsite3-.Lheapallocsite2
 ; CHECK-NEXT:  .long 4096
-; CHECK-NEXT:  .p2align 2
-
 ; CHECK:       .short  4446                    # Record kind: S_HEAPALLOCSITE
 ; CHECK-NEXT:  .secrel32 .Lheapallocsite4
 ; CHECK-NEXT:  .secidx .Lheapallocsite4
 ; CHECK-NEXT:  .short .Lheapallocsite5-.Lheapallocsite4
 ; CHECK-NEXT:  .long 4096
-; CHECK-NEXT:  .p2align 2
+
-; CHECK-LABEL: .short  4431                    # Record kind: S_PROC_ID_END
+attributes #0 = { nounwind "correctly-rounded-divide-sqrt-fp-math"="false" "disable-tail-calls"="false" "frame-pointer"="none" "less-precise-fpmad"="false" "min-legal-vector-width"="0" "no-infs-fp-math"="false" "no-jump-tables"="false" "no-nans-fp-math"="false" "no-signed-zeros-fp-math"="false" "no-trapping-math"="false" "stack-protector-buffer-size"="8" "target-features"="+cx8,+mmx,+sse,+sse2,+x87" "unsafe-fp-math"="false" "use-soft-float"="false" }
+attributes #1 = { "correctly-rounded-divide-sqrt-fp-math"="false" "disable-tail-calls"="false" "frame-pointer"="none" "less-precise-fpmad"="false" "no-infs-fp-math"="false" "no-nans-fp-math"="false" "no-signed-zeros-fp-math"="false" "no-trapping-math"="false" "stack-protector-buffer-size"="8" "target-features"="+cx8,+mmx,+sse,+sse2,+x87" "unsafe-fp-math"="false" "use-soft-float"="false" }
+attributes #2 = { nounwind readnone speculatable willreturn }
+attributes #3 = { nounwind }
 
 !llvm.dbg.cu = !{!0}
-!llvm.module.flags = !{!3, !4, !5, !6}
+!llvm.module.flags = !{!3, !4, !5}
-!llvm.ident = !{!7}
+!llvm.ident = !{!6}
 
-!0 = distinct !DICompileUnit(language: DW_LANG_C_plus_plus, file: !1, producer: "clang version 9.0.0 (https://github.com/llvm/llvm-project.git 9c8073f44f786fbf47335e53f20abe64429e8e47)", isOptimized: false, runtimeVersion: 0, emissionKind: FullDebug, enums: !2, nameTableKind: None)!1 = !DIFile(filename: "filename", directory: "directory", checksumkind: CSK_MD5, checksum: "096443b661a0af36da9006330c08f97e")
+!0 = distinct !DICompileUnit(language: DW_LANG_C_plus_plus, file: !1, producer: "clang version 10.0.0 (https://github.com/llvm/llvm-project.git fa686ea7650235c6dff988cc8cba49e130b3d5f8)", isOptimized: true, runtimeVersion: 0, emissionKind: FullDebug, enums: !2, nameTableKind: None)
+!1 = !DIFile(filename: "<stdin>", directory: "/usr/local/google/home/akhuang/testing/heapallocsite", checksumkind: CSK_MD5, checksum: "e0a04508b4229fc4aee0baa364e25987")
 !2 = !{}
 !3 = !{i32 2, !"CodeView", i32 1}
 !4 = !{i32 2, !"Debug Info Version", i32 3}
 !5 = !{i32 1, !"wchar_size", i32 2}
-!6 = !{i32 7, !"PIC Level", i32 2}
+!6 = !{!"clang version 10.0.0 (https://github.com/llvm/llvm-project.git fa686ea7650235c6dff988cc8cba49e130b3d5f8)"}
-!7 = !{!"clang version 9.0.0 (https://github.com/llvm/llvm-project.git 9c8073f44f786fbf47335e53f20abe64429e8e47)"}
+!7 = distinct !DISubprogram(name: "call_tail", scope: !8, file: !8, line: 6, type: !9, scopeLine: 6, flags: DIFlagPrototyped, spFlags: DISPFlagDefinition | DISPFlagOptimized, unit: !0, retainedNodes: !2)
-!8 = distinct !DISubprogram(name: "call_virtual", scope: !1, file: !1, line: 8, type: !9, scopeLine: 8, flags: DIFlagPrototyped, spFlags: DISPFlagDefinition, unit: !0, retainedNodes: !2)
+!8 = !DIFile(filename: "t.cpp", directory: "/usr/local/google/home/akhuang/testing/heapallocsite", checksumkind: CSK_MD5, checksum: "e0a04508b4229fc4aee0baa364e25987")
 !9 = !DISubroutineType(types: !10)
-!10 = !{null, !11}
+!10 = !{!11}
 !11 = !DIDerivedType(tag: DW_TAG_pointer_type, baseType: !12, size: 64)
-!12 = !DICompositeType(tag: DW_TAG_structure_type, name: "Foo", file: !1, line: 1, flags: DIFlagFwdDecl, identifier: ".?AUFoo@@")
+!12 = !DICompositeType(tag: DW_TAG_structure_type, name: "Foo", file: !8, line: 1, flags: DIFlagFwdDecl, identifier: ".?AUFoo@@")
-!13 = !DILocalVariable(name: "p", arg: 1, scope: !8, file: !1, line: 8, type: !11)
+!13 = !DILocation(line: 7, scope: !7)
-!14 = !DILocation(line: 8, scope: !8)
+!14 = distinct !DISubprogram(name: "call_virtual", scope: !8, file: !8, line: 9, type: !15, scopeLine: 9, flags: DIFlagPrototyped, spFlags: DISPFlagDefinition | DISPFlagOptimized, unit: !0, retainedNodes: !18)
-!15 = !DILocation(line: 9, scope: !8)
+!15 = !DISubroutineType(types: !16)
-!16 = !DILocation(line: 10, scope: !8)
+!16 = !{!17, !11}
-!17 = distinct !DISubprogram(name: "call_multiple", scope: !1, file: !1, line: 12, type: !18, scopeLine: 12, flags: DIFlagPrototyped, spFlags: DISPFlagDefinition, unit: !0, retainedNodes: !2)
+!17 = !DIBasicType(name: "int", size: 32, encoding: DW_ATE_signed)
-!18 = !DISubroutineType(types: !19)
+!18 = !{!19}
-!19 = !{null}
+!19 = !DILocalVariable(name: "p", arg: 1, scope: !14, file: !8, line: 9, type: !11)
-!20 = !DILocation(line: 13, scope: !17)
+!20 = !DILocation(line: 0, scope: !14)
-!21 = !DILocation(line: 14, scope: !17)
+!21 = !DILocation(line: 10, scope: !14)
-!22 = !DILocation(line: 15, scope: !17)
+!22 = !{!23, !23, i64 0}
+!23 = !{!"vtable pointer", !24, i64 0}
+!24 = !{!"Simple C++ TBAA"}
+!25 = !DILocation(line: 11, scope: !14)
+!26 = distinct !DISubprogram(name: "call_multiple", scope: !8, file: !8, line: 13, type: !27, scopeLine: 13, flags: DIFlagPrototyped, spFlags: DISPFlagDefinition | DISPFlagOptimized, unit: !0, retainedNodes: !2)
+!27 = !DISubroutineType(types: !28)
+!28 = !{!17}
+!29 = !DILocation(line: 14, scope: !26)
+!30 = !DILocation(line: 15, scope: !26)
+!31 = !DILocation(line: 16, scope: !26)