use load address as sourceReference

Author: eronnen

lldb/include/lldb/API/SBFileSpec.h

@@ -10,6 +10,7 @@
 #define LLDB_API_SBFILESPEC_H
 
 #include "lldb/API/SBDefines.h"
+#include "lldb/API/SBStream.h"
 
 namespace lldb {
 
@@ -53,6 +54,8 @@ class LLDB_API SBFileSpec {
 
   uint32_t GetPath(char *dst_path, size_t dst_len) const;
 
+  bool GetPath(lldb::SBStream &dst_path) const;
+
   static int ResolvePath(const char *src_path, char *dst_path, size_t dst_len);
 
   bool GetDescription(lldb::SBStream &description) const;

lldb/source/API/SBFileSpec.cpp

@@ -19,6 +19,7 @@
 
 #include <cinttypes>
 #include <climits>
+#include <string>
 
 using namespace lldb;
 using namespace lldb_private;
@@ -147,6 +148,13 @@ uint32_t SBFileSpec::GetPath(char *dst_path, size_t dst_len) const {
   return result;
 }
 
+bool SBFileSpec::GetPath(SBStream &dst_path) const {
+  LLDB_INSTRUMENT_VA(this, dst_path);
+
+  std::string path = m_opaque_up->GetPath();
+  return dst_path->PutCString(path.c_str()) > 0;
+}
+
 const lldb_private::FileSpec *SBFileSpec::operator->() const {
   return m_opaque_up.get();
 }

lldb/tools/lldb-dap/Breakpoint.cpp

@@ -79,27 +79,15 @@ protocol::Breakpoint Breakpoint::ToProtocolBreakpoint() {
       breakpoint.source = CreateSource(line_entry);
     } else {
       // Breakpoint made by assembly
-      auto symbol_context = bp_addr.GetSymbolContext(
-          lldb::eSymbolContextSymbol | lldb::eSymbolContextModule);
-      if (symbol_context.IsValid()) {
-        auto symbol = symbol_context.GetSymbol();
+      auto symbol = bp_addr.GetSymbol();
+      if (symbol.IsValid()) {
         breakpoint.line =
             m_bp.GetTarget()
                 .ReadInstructions(symbol.GetStartAddress(), bp_addr, nullptr)
                 .GetSize() +
             1;
-        protocol::Source source;
-        source.name = symbol.GetName();
 
-        auto module = symbol_context.GetModule();
-        if (module.IsValid()) {
-          std::string path = module.GetFileSpec().GetDirectory();
-          path += "/";
-          path += module.GetFileSpec().GetFilename();
-          source.path = std::move(path);
-        }
-
-        breakpoint.source = std::move(source);
+        breakpoint.source = CreateAssemblySource(m_dap.target, bp_addr);
       }
     }
   }

lldb/tools/lldb-dap/Handler/BreakpointLocationsHandler.cpp

@@ -7,7 +7,6 @@
 //===----------------------------------------------------------------------===//
 
 #include "DAP.h"
-#include "LLDBUtils.h"
 #include "RequestHandler.h"
 #include <vector>
 
@@ -108,15 +107,11 @@ template <unsigned N>
 void BreakpointLocationsRequestHandler::AddAssemblyBreakpointLocations(
     llvm::SmallVector<std::pair<uint32_t, uint32_t>, N> &locations,
     int64_t sourceReference, uint32_t start_line, uint32_t end_line) const {
-  lldb::SBProcess process = dap.target.GetProcess();
-  lldb::SBThread thread =
-      process.GetThreadByIndexID(GetLLDBThreadIndexID(sourceReference));
-  lldb::SBFrame frame = thread.GetFrameAtIndex(GetLLDBFrameID(sourceReference));
-
-  if (!frame.IsValid())
+  lldb::SBAddress address(sourceReference, dap.target);
+  if (!address.IsValid())
     return;
 
-  lldb::SBSymbol symbol = frame.GetSymbol();
+  lldb::SBSymbol symbol = address.GetSymbol();
   if (!symbol.IsValid())
     return;
 

lldb/tools/lldb-dap/Handler/SetBreakpointsRequestHandler.cpp

@@ -9,7 +9,6 @@
 #include "DAP.h"
 #include "EventHelper.h"
 #include "JSONUtils.h"
-#include "LLDBUtils.h"
 #include "Protocol/ProtocolRequests.h"
 #include "RequestHandler.h"
 #include <vector>
@@ -99,15 +98,11 @@ SetBreakpointsRequestHandler::SetAssemblyBreakpoints(
   std::vector<protocol::Breakpoint> response_breakpoints;
   int64_t sourceReference = source.sourceReference.value_or(0);
 
-  lldb::SBProcess process = dap.target.GetProcess();
-  lldb::SBThread thread =
-      process.GetThreadByIndexID(GetLLDBThreadIndexID(sourceReference));
-  lldb::SBFrame frame = thread.GetFrameAtIndex(GetLLDBFrameID(sourceReference));
-
-  if (!frame.IsValid())
+  lldb::SBAddress address(sourceReference, dap.target);
+  if (!address.IsValid())
     return response_breakpoints;
 
-  lldb::SBSymbol symbol = frame.GetSymbol();
+  lldb::SBSymbol symbol = address.GetSymbol();
   if (!symbol.IsValid())
     return response_breakpoints; // Not yet supporting breakpoints in assembly
                                  // without a valid symbol

lldb/tools/lldb-dap/Handler/SourceRequestHandler.cpp

@@ -11,6 +11,7 @@
 #include "LLDBUtils.h"
 #include "Protocol/ProtocolRequests.h"
 #include "Protocol/ProtocolTypes.h"
+#include "lldb/API/SBAddress.h"
 #include "lldb/API/SBExecutionContext.h"
 #include "lldb/API/SBFrame.h"
 #include "lldb/API/SBInstructionList.h"
@@ -19,6 +20,7 @@
 #include "lldb/API/SBSymbol.h"
 #include "lldb/API/SBTarget.h"
 #include "lldb/API/SBThread.h"
+#include "lldb/lldb-types.h"
 #include "llvm/Support/Error.h"
 
 namespace lldb_dap {
@@ -34,26 +36,22 @@ SourceRequestHandler::Run(const protocol::SourceArguments &args) const {
     return llvm::make_error<DAPError>(
         "invalid arguments, expected source.sourceReference to be set");
 
-  lldb::SBProcess process = dap.target.GetProcess();
-  // Upper 32 bits is the thread index ID
-  lldb::SBThread thread =
-      process.GetThreadByIndexID(GetLLDBThreadIndexID(source));
-  // Lower 32 bits is the frame index
-  lldb::SBFrame frame = thread.GetFrameAtIndex(GetLLDBFrameID(source));
-  if (!frame.IsValid())
+  lldb::SBAddress address(source, dap.target);
+  if (!address.IsValid())
     return llvm::make_error<DAPError>("source not found");
 
+  lldb::SBSymbol symbol = address.GetSymbol();
+
   lldb::SBStream stream;
-  lldb::SBExecutionContext exe_ctx(frame);
-  lldb::SBSymbol symbol = frame.GetSymbol();
+  lldb::SBExecutionContext exe_ctx(dap.target);
 
   if (symbol.IsValid()) {
     lldb::SBInstructionList insts = symbol.GetInstructions(dap.target);
     insts.GetDescription(stream, exe_ctx);
   } else {
     // No valid symbol, just return the disassembly.
     lldb::SBInstructionList insts = dap.target.ReadInstructions(
-        frame.GetPCAddress(), dap.number_of_assembly_lines_for_nodebug);
+        address, dap.number_of_assembly_lines_for_nodebug);
     insts.GetDescription(stream, exe_ctx);
   }
 

lldb/tools/lldb-dap/JSONUtils.cpp

@@ -490,6 +490,13 @@ CreateExceptionBreakpointFilter(const ExceptionBreakpoint &bp) {
   return filter;
 }
 
+static std::string GetLoadAddressString(const lldb::addr_t addr) {
+  std::string result;
+  llvm::raw_string_ostream os(result);
+  os << llvm::format_hex(addr, 18);
+  return result;
+}
+
 protocol::Source CreateSource(const lldb::SBFileSpec &file) {
   protocol::Source source;
   if (file.IsValid()) {
@@ -516,6 +523,43 @@ protocol::Source CreateSource(llvm::StringRef source_path) {
   return source;
 }
 
+protocol::Source CreateAssemblySource(const lldb::SBTarget &target,
+                                      lldb::SBAddress &address) {
+  protocol::Source source;
+
+  auto symbol = address.GetSymbol();
+  std::string name;
+  if (symbol.IsValid()) {
+    source.sourceReference = symbol.GetStartAddress().GetLoadAddress(target);
+    name = symbol.GetName();
+  } else {
+    const auto load_addr = address.GetLoadAddress(target);
+    source.sourceReference = load_addr;
+    name = GetLoadAddressString(load_addr);
+  }
+
+  lldb::SBModule module = address.GetModule();
+  if (module.IsValid()) {
+    lldb::SBFileSpec file_spec = module.GetFileSpec();
+    if (file_spec.IsValid()) {
+      lldb::SBStream module_path;
+      if (file_spec.GetPath(module_path)) {
+        std::string path = module_path.GetData();
+        source.path = path + '`' + name;
+      }
+    }
+  }
+
+  source.name = std::move(name);
+
+  // Mark the source as deemphasized since users will only be able to view
+  // assembly for these frames.
+  source.presentationHint =
+      protocol::Source::PresentationHint::eSourcePresentationHintDeemphasize;
+
+  return source;
+}
+
 bool ShouldDisplayAssemblySource(
     const lldb::SBLineEntry &line_entry,
     lldb::StopDisassemblyType stop_disassembly_display) {
@@ -619,12 +663,10 @@ CreateStackFrame(lldb::SBFrame &frame, lldb::SBFormat &format,
     frame_name = name;
   }
 
-  if (frame_name.empty()) {
+  if (frame_name.empty())
     // If the function name is unavailable, display the pc address as a 16-digit
     // hex string, e.g. "0x0000000000012345"
-    llvm::raw_string_ostream os(frame_name);
-    os << llvm::format_hex(frame.GetPC(), 18);
-  }
+    frame_name = GetLoadAddressString(frame.GetPC());
 
   // We only include `[opt]` if a custom frame format is not specified.
   if (!format && frame.GetFunction().GetIsOptimized())
@@ -641,17 +683,10 @@ CreateStackFrame(lldb::SBFrame &frame, lldb::SBFormat &format,
   } else if (frame.GetSymbol().IsValid()) {
     // If no source is associated with the frame, use the DAPFrameID to track
     // the 'source' and generate assembly.
-    llvm::json::Object source;
-    EmplaceSafeString(source, "name", frame_name);
-    char buf[PATH_MAX] = {0};
-    size_t size = frame.GetModule().GetFileSpec().GetPath(buf, PATH_MAX);
-    EmplaceSafeString(source, "path",
-                      std::string(buf, size) + '`' + frame_name);
-    source.try_emplace("sourceReference", MakeDAPFrameID(frame));
-    // Mark the source as deemphasized since users will only be able to view
-    // assembly for these frames.
-    EmplaceSafeString(source, "presentationHint", "deemphasize");
-    object.try_emplace("source", std::move(source));
+    auto frame_address = frame.GetPCAddress();
+    object.try_emplace("source", CreateAssemblySource(
+                                     frame.GetThread().GetProcess().GetTarget(),
+                                     frame_address));
 
     // Calculate the line of the current PC from the start of the current
     // symbol.
@@ -665,12 +700,10 @@ CreateStackFrame(lldb::SBFrame &frame, lldb::SBFormat &format,
     object.try_emplace("column", 1);
   } else {
     // No valid line entry or symbol.
-    llvm::json::Object source;
-    EmplaceSafeString(source, "name", frame_name);
-    source.try_emplace("sourceReference", MakeDAPFrameID(frame));
-    EmplaceSafeString(source, "presentationHint", "deemphasize");
-    object.try_emplace("source", std::move(source));
-
+    auto frame_address = frame.GetPCAddress();
+    object.try_emplace("source", CreateAssemblySource(
+                                     frame.GetThread().GetProcess().GetTarget(),
+                                     frame_address));
     object.try_emplace("line", 1);
     object.try_emplace("column", 1);
   }

lldb/tools/lldb-dap/JSONUtils.h

@@ -269,6 +269,20 @@ protocol::Source CreateSource(const lldb::SBLineEntry &line_entry);
 ///     definition outlined by Microsoft.
 protocol::Source CreateSource(llvm::StringRef source_path);
 
+/// Create a "Source" object for a given frame, using its assembly for source.
+///
+/// \param[in] target
+///     The relevant target.
+///
+/// \param[in] address
+///     The address to use when creating the "Source" object.
+///
+/// \return
+///     A "Source" JSON object that follows the formal JSON
+///     definition outlined by Microsoft.
+protocol::Source CreateAssemblySource(const lldb::SBTarget &target,
+                                      lldb::SBAddress &address);
+
 /// Return true if the given line entry should be displayed as assembly.
 ///
 /// \param[in] line_entry