[llvm] GSYM: implement non-static FunctionInfo::lookup (PR #118925)

[via llvm-commits]

https://github.com/itrofimow created https://github.com/llvm/llvm-project/pull/118925

None

>From 804b9f28e33439f6c925d68e678c1303d0b2b9de Mon Sep 17 00:00:00 2001
From: Ivan Trofimov <i.trofimow at yandex.ru>
Date: Fri, 6 Dec 2024 08:37:09 +0300
Subject: [PATCH] GSYM: implement non-static FunctionInfo::lookup

---
 .../llvm/DebugInfo/GSYM/FunctionInfo.h        |  3 +
 llvm/include/llvm/DebugInfo/GSYM/LineTable.h  |  2 +
 llvm/lib/DebugInfo/GSYM/FunctionInfo.cpp      | 71 +++++++++++++++++++
 llvm/lib/DebugInfo/GSYM/LineTable.cpp         | 20 ++++++
 4 files changed, 96 insertions(+)

diff --git a/llvm/include/llvm/DebugInfo/GSYM/FunctionInfo.h b/llvm/include/llvm/DebugInfo/GSYM/FunctionInfo.h
index fd4ac3164c686d..cd78e6077288bd 100644
--- a/llvm/include/llvm/DebugInfo/GSYM/FunctionInfo.h
+++ b/llvm/include/llvm/DebugInfo/GSYM/FunctionInfo.h
@@ -195,6 +195,9 @@ struct FunctionInfo {
                                              uint64_t FuncAddr,
                                              uint64_t Addr);
 
+  llvm::Expected<LookupResult> lookup(const GsymReader &GR,
+                                      uint64_t Addr) const;
+
   uint64_t startAddress() const { return Range.start(); }
   uint64_t endAddress() const { return Range.end(); }
   uint64_t size() const { return Range.size(); }
diff --git a/llvm/include/llvm/DebugInfo/GSYM/LineTable.h b/llvm/include/llvm/DebugInfo/GSYM/LineTable.h
index 7749e5e4fbb3b8..addb4d2085d71b 100644
--- a/llvm/include/llvm/DebugInfo/GSYM/LineTable.h
+++ b/llvm/include/llvm/DebugInfo/GSYM/LineTable.h
@@ -139,6 +139,8 @@ class LineTable {
   static Expected<LineEntry> lookup(DataExtractor &Data, uint64_t BaseAddr,
                                     uint64_t Addr);
 
+  Expected<LineEntry> lookup(uint64_t Addr) const;
+
   /// Decode an LineTable object from a binary data stream.
   ///
   /// \param Data The binary stream to read the data from. This object must
diff --git a/llvm/lib/DebugInfo/GSYM/FunctionInfo.cpp b/llvm/lib/DebugInfo/GSYM/FunctionInfo.cpp
index dd754c701f6240..bf1d3ec20460e0 100644
--- a/llvm/lib/DebugInfo/GSYM/FunctionInfo.cpp
+++ b/llvm/lib/DebugInfo/GSYM/FunctionInfo.cpp
@@ -335,3 +335,74 @@ llvm::Expected<LookupResult> FunctionInfo::lookup(DataExtractor &Data,
     return std::move(Err);
   return LR;
 }
+
+llvm::Expected<LookupResult> FunctionInfo::lookup(const GsymReader &GR,
+                                                  uint64_t Addr) const {
+  LookupResult LR;
+  LR.LookupAddr = Addr;
+  LR.FuncRange = Range;
+  LR.FuncName = GR.getString(Name);
+
+  if (!OptLineTable) {
+    // We don't have a valid line entry for our address, fill in our source
+    // location as best we can and return.
+    SourceLocation SrcLoc;
+    SrcLoc.Name = LR.FuncName;
+    // TODO : Offset
+    LR.Locations.push_back(SrcLoc);
+    return LR;
+  }
+
+  auto LineEntry = OptLineTable->lookup(Addr);
+  if (!LineEntry)
+    return LineEntry.takeError();
+
+  const std::optional<FileEntry> LineEntryFileOpt = GR.getFile(LineEntry->File);
+  if (!LineEntryFileOpt)
+    return createStringError(std::errc::invalid_argument,
+                             "failed to extract file[%" PRIu32 "]",
+                             LineEntry->File);
+  const auto &LineEntryFile = *LineEntryFileOpt;
+
+  SourceLocation SrcLoc;
+  SrcLoc.Name = LR.FuncName;
+  // TODO : Offset
+  SrcLoc.Dir = GR.getString(LineEntryFile.Dir);
+  SrcLoc.Base = GR.getString(LineEntryFile.Base);
+  SrcLoc.Line = LineEntry->Line;
+  LR.Locations.push_back(SrcLoc);
+  if (!Inline)
+    return LR;
+
+  const auto InlineStackOpt = Inline->getInlineStack(Addr);
+  if (!InlineStackOpt)
+    return LR;
+  const auto &InlineStack = *InlineStackOpt;
+
+  LR.Locations.reserve(InlineStack.size());
+  for (std::size_t i = 0; i + 1 < InlineStack.size(); ++i) {
+    const auto &Frame = *InlineStack[i];
+
+    SourceLocation InlineSrcLoc;
+    InlineSrcLoc.Name = GR.getString(Frame.Name);
+    InlineSrcLoc.Line = Frame.CallLine;
+    // TODO : Offset
+
+    const auto FileNameOpt = GR.getFile(Frame.CallFile);
+    if (FileNameOpt) {
+      const auto &FileName = *FileNameOpt;
+      InlineSrcLoc.Dir = GR.getString(FileName.Dir);
+      InlineSrcLoc.Base = GR.getString(FileName.Base);
+    }
+
+    LR.Locations.push_back(InlineSrcLoc);
+  }
+
+  const auto Name = LR.Locations[0].Name;
+  for (std::size_t i = 1; i < LR.Locations.size(); ++i) {
+    LR.Locations[i - 1].Name = LR.Locations[i].Name;
+  }
+  LR.Locations.back().Name = Name;
+
+  return LR;
+}
diff --git a/llvm/lib/DebugInfo/GSYM/LineTable.cpp b/llvm/lib/DebugInfo/GSYM/LineTable.cpp
index 666d9f15f1b43d..1c488bf1b47a8b 100644
--- a/llvm/lib/DebugInfo/GSYM/LineTable.cpp
+++ b/llvm/lib/DebugInfo/GSYM/LineTable.cpp
@@ -281,6 +281,26 @@ Expected<LineEntry> LineTable::lookup(DataExtractor &Data, uint64_t BaseAddr, ui
                            Addr);
 }
 
+Expected<LineEntry> LineTable::lookup(uint64_t Addr) const {
+  std::size_t Left = 0, Right = Lines.size();
+  while (Right - Left > 1) {
+    const auto Mid = (Left + Right) / 2;
+    if (Lines[Mid].Addr <= Addr) {
+      Left = Mid;
+    } else {
+      Right = Mid;
+    }
+  }
+
+  if (Left < Lines.size() && Lines[Left].Addr <= Addr) {
+    return Lines[Left];
+  }
+
+  return createStringError(std::errc::invalid_argument,
+                           "address 0x%" PRIx64 " is not in the line table",
+                           Addr);
+}
+
 raw_ostream &llvm::gsym::operator<<(raw_ostream &OS, const LineTable &LT) {
   for (const auto &LineEntry : LT)
     OS << LineEntry << '\n';