[Symbolize] Add DIContext APIs to return std::optional<DILineInfo> to indicate if debug info is present or not for a given address.

Author: ZequanWu

llvm/include/llvm/DebugInfo/BTF/BTFContext.h

@@ -48,6 +48,12 @@ class BTFContext final : public DIContext {
   std::vector<DILocal>
   getLocalsForAddress(object::SectionedAddress Address) override;
 
+  std::optional<DILineInfo> getOptionalLineInfoForAddress(
+      object::SectionedAddress Address,
+      DILineInfoSpecifier Specifier = DILineInfoSpecifier()) override;
+  std::optional<DILineInfo>
+  getOptionalLineInfoForDataAddress(object::SectionedAddress Address) override;
+
   static std::unique_ptr<BTFContext> create(
       const object::ObjectFile &Obj,
       std::function<void(Error)> ErrorHandler = WithColor::defaultErrorHandler);

llvm/include/llvm/DebugInfo/DIContext.h

@@ -267,6 +267,12 @@ class DIContext {
   virtual std::vector<DILocal>
   getLocalsForAddress(object::SectionedAddress Address) = 0;
 
+  virtual std::optional<DILineInfo> getOptionalLineInfoForAddress(
+      object::SectionedAddress Address,
+      DILineInfoSpecifier Specifier = DILineInfoSpecifier()) = 0;
+  virtual std::optional<DILineInfo>
+  getOptionalLineInfoForDataAddress(object::SectionedAddress Address) = 0;
+
 private:
   const DIContextKind Kind;
 };

llvm/include/llvm/DebugInfo/DWARF/DWARFContext.h

@@ -401,6 +401,12 @@ class DWARFContext : public DIContext {
   std::vector<DILocal>
   getLocalsForAddress(object::SectionedAddress Address) override;
 
+  std::optional<DILineInfo> getOptionalLineInfoForAddress(
+      object::SectionedAddress Address,
+      DILineInfoSpecifier Specifier = DILineInfoSpecifier()) override;
+  std::optional<DILineInfo>
+  getOptionalLineInfoForDataAddress(object::SectionedAddress Address) override;
+
   bool isLittleEndian() const { return DObj->isLittleEndian(); }
   static unsigned getMaxSupportedVersion() { return 5; }
   static bool isSupportedVersion(unsigned version) {

llvm/include/llvm/DebugInfo/PDB/PDBContext.h

@@ -57,6 +57,12 @@ namespace pdb {
     std::vector<DILocal>
     getLocalsForAddress(object::SectionedAddress Address) override;
 
+    std::optional<DILineInfo> getOptionalLineInfoForAddress(
+        object::SectionedAddress Address,
+        DILineInfoSpecifier Specifier = DILineInfoSpecifier()) override;
+    std::optional<DILineInfo> getOptionalLineInfoForDataAddress(
+        object::SectionedAddress Address) override;
+
   private:
     std::string getFunctionName(uint64_t Address, DINameKind NameKind) const;
     std::unique_ptr<IPDBSession> Session;

llvm/lib/DebugInfo/BTF/BTFContext.cpp

@@ -20,6 +20,17 @@ using namespace llvm;
 using object::ObjectFile;
 using object::SectionedAddress;
 
+std::optional<DILineInfo>
+BTFContext::getOptionalLineInfoForAddress(object::SectionedAddress Address,
+                                          DILineInfoSpecifier Specifier) {
+  return getLineInfoForAddress(Address, Specifier);
+}
+
+std::optional<DILineInfo> BTFContext::getOptionalLineInfoForDataAddress(
+    object::SectionedAddress Address) {
+  return getLineInfoForDataAddress(Address);
+}
+
 DILineInfo BTFContext::getLineInfoForAddress(SectionedAddress Address,
                                              DILineInfoSpecifier Specifier) {
   const BTF::BPFLineInfo *LineInfo = BTF.findLineInfo(Address);

llvm/lib/DebugInfo/DWARF/DWARFContext.cpp

@@ -1732,11 +1732,21 @@ DWARFContext::getLocalsForAddress(object::SectionedAddress Address) {
 
 DILineInfo DWARFContext::getLineInfoForAddress(object::SectionedAddress Address,
                                                DILineInfoSpecifier Spec) {
-  DILineInfo Result;
+  std::optional<DILineInfo> Result =
+      getOptionalLineInfoForAddress(Address, Spec);
+  if (Result)
+    return *Result;
+  return DILineInfo();
+}
+
+std::optional<DILineInfo>
+DWARFContext::getOptionalLineInfoForAddress(object::SectionedAddress Address,
+                                            DILineInfoSpecifier Spec) {
   DWARFCompileUnit *CU = getCompileUnitForCodeAddress(Address.Address);
   if (!CU)
-    return Result;
+    return std::nullopt;
 
+  DILineInfo Result;
   getFunctionNameAndStartLineForAddress(
       CU, Address.Address, Spec.FNKind, Spec.FLIKind, Result.FunctionName,
       Result.StartFileName, Result.StartLine, Result.StartAddress);
@@ -1753,17 +1763,25 @@ DILineInfo DWARFContext::getLineInfoForAddress(object::SectionedAddress Address,
 
 DILineInfo
 DWARFContext::getLineInfoForDataAddress(object::SectionedAddress Address) {
-  DILineInfo Result;
+  std::optional<DILineInfo> Result = getOptionalLineInfoForDataAddress(Address);
+  if (Result)
+    return *Result;
+  return DILineInfo();
+}
+
+std::optional<DILineInfo> DWARFContext::getOptionalLineInfoForDataAddress(
+    object::SectionedAddress Address) {
   DWARFCompileUnit *CU = getCompileUnitForDataAddress(Address.Address);
   if (!CU)
-    return Result;
+    return std::nullopt;
 
   if (DWARFDie Die = CU->getVariableForAddress(Address.Address)) {
+    DILineInfo Result;
     Result.FileName = Die.getDeclFile(FileLineInfoKind::AbsoluteFilePath);
     Result.Line = Die.getDeclLine();
+    return Result;
   }
-
-  return Result;
+  return std::nullopt;
 }
 
 DILineInfoTable DWARFContext::getLineInfoForAddressRange(

llvm/lib/DebugInfo/PDB/PDBContext.cpp

@@ -32,6 +32,17 @@ PDBContext::PDBContext(const COFFObjectFile &Object,
 
 void PDBContext::dump(raw_ostream &OS, DIDumpOptions DumpOpts){}
 
+std::optional<DILineInfo>
+PDBContext::getOptionalLineInfoForAddress(object::SectionedAddress Address,
+                                          DILineInfoSpecifier Specifier) {
+  return getLineInfoForAddress(Address, Specifier);
+}
+
+std::optional<DILineInfo> PDBContext::getOptionalLineInfoForDataAddress(
+    object::SectionedAddress Address) {
+  return getLineInfoForDataAddress(Address);
+}
+
 DILineInfo PDBContext::getLineInfoForAddress(object::SectionedAddress Address,
                                              DILineInfoSpecifier Specifier) {
   DILineInfo Result;