[LTO] Fix a crash caused by accessing an empty ValueInfo

[tejohnson]

Summary

[LTO] Fix a crash caused by accessing an empty ValueInfo

ModuleSummaryIndex::exportToDot crashes when linking the Linux kernel
under ThinLTO using LLVMgold.so. This is due to the exportToDot
function trying to get the GUID of an empty ValueInfo. The root cause
related to the fact that we attempt to get the GUID of an aliasee
via its OriginalGUID recorded in the aliasee summary, and that is not
always possible. Specifically, we cannot do this mapping when the value
is internal linkage and there were other internal linkage symbols with
the same name.

There are 2 fixes for the problem included here.

1. In all cases where we can currently print the dot file from the

command line (which is only via save-temps), we have a valid AliaseeGUID
in the AliasSummary. Use that when it is available, so that we can get
the correct aliasee GUID whenever possible.

2. However, if we were to invoke exportToDot from the debugger right

after it is built during the initial analysis step (i.e. the per-module
summary), we won't have the AliaseeGUID field populated. In that case,
we have a fallback fix that will simply print "@"+GUID when we aren't
able to get the GUID from the OriginalGUID. It simply checks if the VI
is valid or not before attempting to get the name. Additionally, since
getAliaseeGUID will assert that the AliaseeGUID is non-zero, guard the
earlier fix #1 by a new function hasAliaseeGUID().

[evgeny777]

Can you please post the *.index.bc file? It is saved before dot, so it should be there

[tmroeder]

In D53986#1284252, @evgeny777 wrote:

Can you please post the *.index.bc file? It is saved before dot, so it should be there

Yes, but I'll need to repro on an upstream kernel tree rather than the internal one I was using, since I don't want to post something that might have Google-internal information in it. That might take a little time.

[tejohnson]

lib/IR/ModuleSummaryIndex.cpp

228

Always calling the new version means that we will never print the name, even if there is a ValueInfo for this GUID. Can you call the appropriate version of getNodeVisualName based on whether the VI is empty? I.e. invoke ValueInfo::operator bool() on it.

[tmroeder]

Use the ValueInfo for the name of an external node if the ValueInfo is not empty.

[tmroeder]

lib/IR/ModuleSummaryIndex.cpp

228

Good point, thanks. I've changed this now to take the ValueInfo as an argument again and do that check before calling getNodeVisualName.

[tejohnson]

The change looks ok to me now, but we really need a test case for this. I tried unsuccessfully so far to induce the error. Was this produced when using the save-temps plugin-opt during your ThinLTO link? Can you go into the debugger and see what the value of E.Dst is?

I'm also at Google so feel free to reach out to me internally if your reproducer can't be shared upstream.

[tejohnson]

In D53986#1285573, @tejohnson wrote:

The change looks ok to me now, but we really need a test case for this. I tried unsuccessfully so far to induce the error. Was this produced when using the save-temps plugin-opt during your ThinLTO link? Can you go into the debugger and see what the value of E.Dst is?

I'm also at Google so feel free to reach out to me internally if your reproducer can't be shared upstream.

Via the test case Tom provided me, I can see what is going on. This is from an aliasee, where the aliasee is internal linkage, and because it has internal linkage and there are multiple internal symbols with the same name and internal linkage we are not able to get the GUID from the original GUID. I have a more robust fix, and can create a test case. Mind if I commandeer this patch?

[tmroeder]

In D53986#1285797, @tejohnson wrote:

In D53986#1285573, @tejohnson wrote:

The change looks ok to me now, but we really need a test case for this. I tried unsuccessfully so far to induce the error. Was this produced when using the save-temps plugin-opt during your ThinLTO link? Can you go into the debugger and see what the value of E.Dst is?

I'm also at Google so feel free to reach out to me internally if your reproducer can't be shared upstream.

Via the test case Tom provided me, I can see what is going on. This is from an aliasee, where the aliasee is internal linkage, and because it has internal linkage and there are multiple internal symbols with the same name and internal linkage we are not able to get the GUID from the original GUID. I have a more robust fix, and can create a test case. Mind if I commandeer this patch?

Sure, no problem. I don't know Phabricator well, so please let me know if there's something I need to do.

[tejohnson]

In D53986#1285818, @tmroeder wrote:

In D53986#1285797, @tejohnson wrote:

In D53986#1285573, @tejohnson wrote:

The change looks ok to me now, but we really need a test case for this. I tried unsuccessfully so far to induce the error. Was this produced when using the save-temps plugin-opt during your ThinLTO link? Can you go into the debugger and see what the value of E.Dst is?

I'm also at Google so feel free to reach out to me internally if your reproducer can't be shared upstream.

Via the test case Tom provided me, I can see what is going on. This is from an aliasee, where the aliasee is internal linkage, and because it has internal linkage and there are multiple internal symbols with the same name and internal linkage we are not able to get the GUID from the original GUID. I have a more robust fix, and can create a test case. Mind if I commandeer this patch?

Sure, no problem. I don't know Phabricator well, so please let me know if there's something I need to do.

Nope, I can do it. I'll do so when I have something ready to upload later today.

[tejohnson]

Uploading new patch shortly. It includes this earlier fix along with a newer one to better handle aliases, as it is needed as a fallback in certain cases as described in the updated description.

[tejohnson]

Update with broader fix and test case

[tmroeder]

I can confirm that this version of the revision also fixes the bug I observed. I patched it in and built and re-ran the build step that failed.

However, the test case fails, at least for me:

FAIL: LLVM :: ThinLTO/X86/alias_internal.ll (22171 of 28416)
******************** TEST 'LLVM :: ThinLTO/X86/alias_internal.ll' FAILED ********************
Script:
--
: 'RUN: at line 4';   /usr/local/google/home/tmroeder/src/llvm/svn-build/release/bin/opt -module-summary /usr/local/google/home/tmroeder/src/llvm/svn/test/ThinLTO/X86/alias_internal.ll -o /usr/local/google/home/tmroeder/src/llvm/svn-build/release/test/ThinLTO/X86/Output/alias_internal.ll.tmp1.bc
: 'RUN: at line 5';   /usr/local/google/home/tmroeder/src/llvm/svn-build/release/bin/opt -module-summary /usr/local/google/home/tmroeder/src/llvm/svn/test/ThinLTO/X86/Inputs/alias_internal.ll -o /usr/local/google/home/tmroeder/src/llvm/svn-build/release/test/ThinLTO/X86/Output/alias_internal.ll.tmp2.bc
: 'RUN: at line 6';   /usr/local/google/home/tmroeder/src/llvm/svn-build/release/bin/llvm-lto2 run /usr/local/google/home/tmroeder/src/llvm/svn-build/release/test/ThinLTO/X86/Output/alias_internal.ll.tmp1.bc /usr/local/google/home/tmroeder/src/llvm/svn-build/release/test/ThinLTO/X86/Output/alias_internal.ll.tmp2.bc -o /usr/local/google/home/tmroeder/src/llvm/svn-build/release/test/ThinLTO/X86/Output/alias_internal.ll.tmp.out -save-temps    -r /usr/local/google/home/tmroeder/src/llvm/svn-build/release/test/ThinLTO/X86/Output/alias_internal.ll.tmp1.bc,a1,plx    -r /usr/local/google/home/tmroeder/src/llvm/svn-build/release/test/ThinLTO/X86/Output/alias_internal.ll.tmp2.bc,a2,plx
: 'RUN: at line 10';   cat /usr/local/google/home/tmroeder/src/llvm/svn-build/release/test/ThinLTO/X86/Output/alias_internal.ll.tmp.out.index.dot | /usr/local/google/home/tmroeder/src/llvm/svn-build/release/bin/FileCheck /usr/local/google/home/tmroeder/src/llvm/svn/test/ThinLTO/X86/alias_internal.ll
--
Exit Code: 1

Command Output (stderr):
--
/usr/local/google/home/tmroeder/src/llvm/svn/test/ThinLTO/X86/alias_internal.ll:11:14: error: CHECK-DAG: expected string not found in input
; CHECK-DAG: M0_12511626713252727690 -> M0_1505494552724110632 [style=dotted]; // alias
             ^
<stdin>:1:1: note: scanning from here
digraph Summary {
^
<stdin>:22:2: note: possible intended match here
 M0_12511626713252727690 -> M0_12714169483090670833 [style=dotted]; // alias
 ^

--

I reran the steps by hand without the FileCheck part of the pipe, and I get the following graph:

$ cat /usr/local/google/home/tmroeder/src/llvm/svn-build/release/test/ThinLTO/X86/Output/alias_internal.ll.tmp.out.index.dot
digraph Summary {
  // Module: /usr/local/google/home/tmroeder/src/llvm/svn-build/release/test/ThinLTO/X86/Output/alias_internal.ll.tmp2.bc
  subgraph cluster_1 {
    style = filled;
    color = lightgrey;
    label = "alias_internal.ll.tmp2.bc";
    node [style=filled,fillcolor=lightblue];
    M1_5602470142352873009 [shape="record",label="f|internal (inst: 1, ffl: 0000)}"]; // function
    M1_8129049334585965161 [style="dotted,filled",shape="box",label="a2"]; // alias
    // Edges:
    M1_8129049334585965161 -> M1_5602470142352873009 [style=dotted]; // alias
  }
  // Module: /usr/local/google/home/tmroeder/src/llvm/svn-build/release/test/ThinLTO/X86/Output/alias_internal.ll.tmp1.bc
  subgraph cluster_0 {
    style = filled;
    color = lightgrey;
    label = "alias_internal.ll.tmp1.bc";
    node [style=filled,fillcolor=lightblue];
    M0_12714169483090670833 [shape="record",label="f|internal (inst: 1, ffl: 0000)}"]; // function
    M0_12511626713252727690 [style="dotted,filled",shape="box",label="a1"]; // alias
    // Edges:
    M0_12511626713252727690 -> M0_12714169483090670833 [style=dotted]; // alias
  }
  // Cross-module edges:
}

It looks like the sources match in both CHECK-DAG cases but that the destinations don't.

[tejohnson]

In D53986#1286187, @tmroeder wrote:

It looks like the sources match in both CHECK-DAG cases but that the destinations don't.

Thanks for testing! Ack, that makes sense and I should have realized earlier. For internal symbols, the path is included with the name when computing the guid, specifically so multiple locals with the same name are disambiguated. So the rhs of the -> will be different when running the test in different places! Will upload a fix with a looser matching shortly.

[tejohnson]

Fix test so that it will not try to match exact internal symbol GUIDs

[tmroeder]

LGTM. With the looser condition, the tests pass for me.

include/llvm/IR/ModuleSummaryIndex.h

const GlobalValueSummary &getAliasee() const {
     assert(AliaseeSummary && "Unexpected missing aliasee summary");
     return *AliaseeSummary;
   }
 
   GlobalValueSummary &getAliasee() {
     return const_cast<GlobalValueSummary &>(
                          static_cast<const AliasSummary *>(this)->getAliasee());
   }
+  bool hasAliaseeGUID() const { return AliaseeGUID != 0; }
   const GlobalValue::GUID &getAliaseeGUID() const {
     assert(AliaseeGUID && "Unexpected missing aliasee GUID");
     return AliaseeGUID;
   }
 };
 
 const inline GlobalValueSummary *GlobalValueSummary::getBaseObject() const {
   if (auto *AS = dyn_cast<AliasSummary>(this))

lib/IR/ModuleSummaryIndex.cpp

static std::string getSummaryAttributes(GlobalValueSummary* GVS) {
   auto *FS = dyn_cast_or_null<FunctionSummary>(GVS);
   if (!FS)
     return "";
 
   return std::string("inst: ") + std::to_string(FS->instCount()) +
          ", ffl: " + fflagsToString(FS->fflags());
 }
 
+static std::string getNodeVisualName(GlobalValue::GUID Id) {
+  return std::string("@") + std::to_string(Id);
+}
+
 static std::string getNodeVisualName(const ValueInfo &VI) {
-  return VI.name().empty() ? std::string("@") + std::to_string(VI.getGUID())
-                           : VI.name().str();
+  return VI.name().empty() ? getNodeVisualName(VI.getGUID()) : VI.name().str();
 }
 
 static std::string getNodeLabel(const ValueInfo &VI, GlobalValueSummary *GVS) {
   if (isa<AliasSummary>(GVS))
     return getNodeVisualName(VI);
 
   std::string Attrs = getSummaryAttributes(GVS);
   std::string Label =
       getNodeVisualName(VI) + "|" + linkageToString(GVS->linkage());
   if (!Attrs.empty())
     Label += std::string(" (") + Attrs + ")";
   Label += "}";
 
   return Label;
 }
 
 // Write definition of external node, which doesn't have any
 // specific module associated with it. Typically this is function
 // or variable defined in native object or library.
 static void defineExternalNode(raw_ostream &OS, const char *Pfx,
-                               const ValueInfo &VI) {
-  auto StrId = std::to_string(VI.getGUID());
-  OS << "  " << StrId << " [label=\"" << getNodeVisualName(VI)
-     << "\"]; // defined externally\n";
+                               const ValueInfo &VI, GlobalValue::GUID Id) {
+  auto StrId = std::to_string(Id);
+  OS << "  " << StrId << " [label=\"";
+
+  if (VI) {
+    OS << getNodeVisualName(VI);
+  } else {
+    OS << getNodeVisualName(Id);
+  }
+  OS << "\"]; // defined externally\n";
 }
 
-void ModuleSummaryIndex::exportToDot(raw_ostream& OS) const {
+void ModuleSummaryIndex::exportToDot(raw_ostream &OS) const {
   std::vector<Edge> CrossModuleEdges;
   DenseMap<GlobalValue::GUID, std::vector<uint64_t>> NodeMap;
   StringMap<GVSummaryMapTy> ModuleToDefinedGVS;
   collectDefinedGVSummariesPerModule(ModuleToDefinedGVS);
 
   // Get node identifier in form MXXX_<GUID>. The MXXX prefix is required,
   // because we may have multiple linkonce functions summaries.
   auto NodeId = [](uint64_t ModId, GlobalValue::GUID Id) {
for (auto &ModIt : ModuleToDefinedGVS) {
     OS << "    // Edges:\n";
 
     for (auto &SummaryIt : GVSMap) {
       auto *GVS = SummaryIt.second;
       for (auto &R : GVS->refs())
         Draw(SummaryIt.first, R.getGUID(), -1);
 
       if (auto *AS = dyn_cast_or_null<AliasSummary>(SummaryIt.second)) {
+        GlobalValue::GUID AliaseeId;
+        if (AS->hasAliaseeGUID())
+          AliaseeId = AS->getAliaseeGUID();
+        else {
           auto AliaseeOrigId = AS->getAliasee().getOriginalName();
-        auto AliaseeId = getGUIDFromOriginalID(AliaseeOrigId);
+          AliaseeId = getGUIDFromOriginalID(AliaseeOrigId);
+          if (!AliaseeId)
+            AliaseeId = AliaseeOrigId;
+        }
 
-        Draw(SummaryIt.first, AliaseeId ? AliaseeId : AliaseeOrigId, -2);
+        Draw(SummaryIt.first, AliaseeId, -2);
         continue;
       }
 
       if (auto *FS = dyn_cast_or_null<FunctionSummary>(SummaryIt.second))
         for (auto &CGEdge : FS->calls())
           Draw(SummaryIt.first, CGEdge.first.getGUID(),
                static_cast<int>(CGEdge.second.Hotness));
     }
     OS << "  }\n";
   }
 
   OS << "  // Cross-module edges:\n";
   for (auto &E : CrossModuleEdges) {
     auto &ModList = NodeMap[E.Dst];
     if (ModList.empty()) {
-      defineExternalNode(OS, "  ", getValueInfo(E.Dst));
+      defineExternalNode(OS, "  ", getValueInfo(E.Dst), E.Dst);
       // Add fake module to the list to draw an edge to an external node
       // in the loop below.
       ModList.push_back(-1);
     }
     for (auto DstMod : ModList)
       // The edge representing call or ref is drawn to every module where target
       // symbol is defined. When target is a linkonce symbol there can be
       // multiple edges representing a single call or ref, both intra-module and
       // cross-module. As we've already drawn all intra-module edges before we
       // skip it here.
       if (DstMod != E.SrcMod)
         DrawEdge("  ", E.SrcMod, E.Src, DstMod, E.Dst, E.Hotness);
   }
 
   OS << "}";
 }

test/ThinLTO/X86/Inputs/alias_internal.ll

+target datalayout = "e-m:e-i64:64-f80:128-n8:16:32:64-S128"
+target triple = "x86_64-unknown-linux-gnu"
+
+define internal i32 @f(i8*) unnamed_addr {
+    ret i32 42
+}
+
+@a2 = weak alias i32 (i8*), i32 (i8*)* @f

test/ThinLTO/X86/alias_internal.ll

+; Test to make sure dot dumper can correctly handle aliases to multiple
+; different internal aliasees with the same name.
+
+; RUN: opt -module-summary %s -o %t1.bc
+; RUN: opt -module-summary %p/Inputs/alias_internal.ll -o %t2.bc
+; RUN: llvm-lto2 run %t1.bc %t2.bc -o %t.out -save-temps \
+; RUN:   -r %t1.bc,a1,plx \
+; RUN:   -r %t2.bc,a2,plx
+
+; RUN: cat %t.out.index.dot | FileCheck %s
+; CHECK-DAG: M0_12511626713252727690 -> M0_1505494552724110632 [style=dotted]; // alias
+; CHECK-DAG: M1_8129049334585965161 -> M1_4680657618161880508 [style=dotted]; // alias
+
+target datalayout = "e-m:e-i64:64-f80:128-n8:16:32:64-S128"
+target triple = "x86_64-unknown-linux-gnu"
+
+define internal i32 @f(i8*) unnamed_addr {
+    ret i32 42
+}
+
+@a1 = weak alias i32 (i8*), i32 (i8*)* @f