[Lldb-commits] [lldb] f7f8015 - [lldb-vscode] Add Support for Module Event
Walter Erquinigo via lldb-commits
lldb-commits at lists.llvm.org
Fri Jul 10 16:51:10 PDT 2020
Author: Yifan Shen
Date: 2020-07-10T16:50:59-07:00
New Revision: f7f80159753ba725f7e32529fcc369bc358efbb3
URL: https://github.com/llvm/llvm-project/commit/f7f80159753ba725f7e32529fcc369bc358efbb3
DIFF: https://github.com/llvm/llvm-project/commit/f7f80159753ba725f7e32529fcc369bc358efbb3.diff
LOG: [lldb-vscode] Add Support for Module Event
Summary:
Whenever a module is created, removed or changed, lldb-vscode is now sending an event that can be interpreted by the IDE so that modules can be rendered in the IDE, like the tree view in this screenshot
{F12229758}
Reviewers: wallace, clayborg, kusmour, aadsm
Reviewed By: clayborg
Subscribers: cfe-commits, labath, lldb-commits
Tags: #lldb, #clang
Differential Revision: https://reviews.llvm.org/D82477
Added:
lldb/test/API/tools/lldb-vscode/module/Makefile
lldb/test/API/tools/lldb-vscode/module/TestVSCode_module.py
lldb/test/API/tools/lldb-vscode/module/main.cpp
Modified:
lldb/packages/Python/lldbsuite/test/tools/lldb-vscode/vscode.py
lldb/tools/lldb-vscode/JSONUtils.cpp
lldb/tools/lldb-vscode/JSONUtils.h
lldb/tools/lldb-vscode/VSCode.cpp
lldb/tools/lldb-vscode/lldb-vscode.cpp
Removed:
################################################################################
diff --git a/lldb/packages/Python/lldbsuite/test/tools/lldb-vscode/vscode.py b/lldb/packages/Python/lldbsuite/test/tools/lldb-vscode/vscode.py
index 1ad168e794cf..93a44ccce215 100644
--- a/lldb/packages/Python/lldbsuite/test/tools/lldb-vscode/vscode.py
+++ b/lldb/packages/Python/lldbsuite/test/tools/lldb-vscode/vscode.py
@@ -113,6 +113,7 @@ def __init__(self, recv, send, init_commands):
self.initialize_body = None
self.thread_stop_reasons = {}
self.breakpoint_events = []
+ self.module_events = {}
self.sequence = 1
self.threads = None
self.recv_thread.start()
@@ -133,6 +134,9 @@ def validate_response(cls, command, response):
if command['seq'] != response['request_seq']:
raise ValueError('seq mismatch in response')
+ def get_active_modules(self):
+ return self.module_events
+
def get_output(self, category, timeout=0.0, clear=True):
self.output_condition.acquire()
output = None
@@ -218,6 +222,15 @@ def handle_recv_packet(self, packet):
self.breakpoint_events.append(packet)
# no need to add 'breakpoint' event packets to our packets list
return keepGoing
+ elif event == 'module':
+ reason = body['reason']
+ if (reason == 'new' or reason == 'changed'):
+ self.module_events[body['module']['name']] = body['module']
+ elif reason == 'removed':
+ if body['module']['name'] in self.module_events:
+ self.module_events.pop(body['module']['name'])
+ return keepGoing
+
elif packet_type == 'response':
if packet['command'] == 'disconnect':
keepGoing = False
diff --git a/lldb/test/API/tools/lldb-vscode/module/Makefile b/lldb/test/API/tools/lldb-vscode/module/Makefile
new file mode 100644
index 000000000000..04c9fda1c388
--- /dev/null
+++ b/lldb/test/API/tools/lldb-vscode/module/Makefile
@@ -0,0 +1,11 @@
+CXX_SOURCES := main.cpp
+
+all: a.out.stripped
+
+include Makefile.rules
+
+a.out.stripped: a.out.dSYM
+ strip -o a.out.stripped a.out
+ifneq "$(CODESIGN)" ""
+ $(CODESIGN) -fs - a.out.stripped
+endif
\ No newline at end of file
diff --git a/lldb/test/API/tools/lldb-vscode/module/TestVSCode_module.py b/lldb/test/API/tools/lldb-vscode/module/TestVSCode_module.py
new file mode 100644
index 000000000000..480826e46ef9
--- /dev/null
+++ b/lldb/test/API/tools/lldb-vscode/module/TestVSCode_module.py
@@ -0,0 +1,49 @@
+"""
+Test lldb-vscode setBreakpoints request
+"""
+
+from __future__ import print_function
+
+import unittest2
+import vscode
+from lldbsuite.test.decorators import *
+from lldbsuite.test.lldbtest import *
+from lldbsuite.test import lldbutil
+import lldbvscode_testcase
+
+
+class TestVSCode_module(lldbvscode_testcase.VSCodeTestCaseBase):
+
+ mydir = TestBase.compute_mydir(__file__)
+
+ def test_modules_event(self):
+ program_basename = "a.out.stripped"
+ program= self.getBuildArtifact(program_basename)
+ self.build_and_launch(program)
+ source = "main.cpp"
+ main_source_path = self.getSourcePath(source)
+ functions = ['main']
+ breakpoint_ids = self.set_function_breakpoints(functions)
+ self.assertEquals(len(breakpoint_ids), len(functions),
+ 'expect one breakpoint')
+ self.continue_to_breakpoints(breakpoint_ids)
+ active_modules = self.vscode.get_active_modules()
+ self.assertIn(program_basename, active_modules, '%s module is in active modules' % (program_basename))
+ program_module = active_modules[program_basename]
+ self.assertIn('name', program_module, 'make sure name is in module')
+ self.assertEqual(program_basename, program_module['name'])
+ self.assertIn('path', program_module, 'make sure path is in module')
+ self.assertEqual(program, program_module['path'])
+ self.assertTrue('symbolFilePath' not in program_module, 'Make sure a.out.stripped has no debug info')
+ self.assertEqual('Symbols not found.', program_module['symbolStatus'])
+ symbol_path = self.getBuildArtifact("a.out")
+ response = self.vscode.request_evaluate('`%s' % ('target symbols add -s "%s" "%s"' % (program, symbol_path)))
+ active_modules = self.vscode.get_active_modules()
+ program_module = active_modules[program_basename]
+ self.assertEqual(program_basename, program_module['name'])
+ self.assertEqual(program, program_module['path'])
+ self.assertEqual('Symbols loaded.', program_module['symbolStatus'])
+ self.assertIn('symbolFilePath', program_module)
+ self.assertEqual(symbol_path, program_module['symbolFilePath'])
+ self.assertIn('addressRange', program_module)
+
\ No newline at end of file
diff --git a/lldb/test/API/tools/lldb-vscode/module/main.cpp b/lldb/test/API/tools/lldb-vscode/module/main.cpp
new file mode 100644
index 000000000000..62bcb78696b0
--- /dev/null
+++ b/lldb/test/API/tools/lldb-vscode/module/main.cpp
@@ -0,0 +1,3 @@
+int main(int argc, char const *argv[]) {
+ return 0; // breakpoint 1
+}
diff --git a/lldb/tools/lldb-vscode/JSONUtils.cpp b/lldb/tools/lldb-vscode/JSONUtils.cpp
index 8fcf179b29aa..1bb9480c510a 100644
--- a/lldb/tools/lldb-vscode/JSONUtils.cpp
+++ b/lldb/tools/lldb-vscode/JSONUtils.cpp
@@ -327,6 +327,41 @@ llvm::json::Value CreateBreakpoint(lldb::SBBreakpoint &bp,
return llvm::json::Value(std::move(object));
}
+llvm::json::Value CreateModule(lldb::SBModule &module) {
+ llvm::json::Object object;
+ if (!module.IsValid())
+ return llvm::json::Value(std::move(object));
+ object.try_emplace("id", std::string(module.GetUUIDString()));
+ object.try_emplace("name", std::string(module.GetFileSpec().GetFilename()));
+ char module_path_arr[PATH_MAX];
+ module.GetFileSpec().GetPath(module_path_arr, sizeof(module_path_arr));
+ std::string module_path(module_path_arr);
+ object.try_emplace("path", module_path);
+ if (module.GetNumCompileUnits() > 0) {
+ object.try_emplace("symbolStatus", "Symbols loaded.");
+ char symbol_path_arr[PATH_MAX];
+ module.GetSymbolFileSpec().GetPath(symbol_path_arr, sizeof(symbol_path_arr));
+ std::string symbol_path(symbol_path_arr);
+ object.try_emplace("symbolFilePath", symbol_path);
+ } else {
+ object.try_emplace("symbolStatus", "Symbols not found.");
+ }
+ std::string loaded_addr = std::to_string(
+ module.GetObjectFileHeaderAddress().GetLoadAddress(g_vsc.target));
+ object.try_emplace("addressRange", loaded_addr);
+ std::string version_str;
+ uint32_t version_nums[3];
+ uint32_t num_versions = module.GetVersion(version_nums, sizeof(version_nums)/sizeof(uint32_t));
+ for (uint32_t i=0; i<num_versions; ++i) {
+ if (!version_str.empty())
+ version_str += ".";
+ version_str += std::to_string(version_nums[i]);
+ }
+ if (!version_str.empty())
+ object.try_emplace("version", version_str);
+ return llvm::json::Value(std::move(object));
+}
+
void AppendBreakpoint(lldb::SBBreakpoint &bp, llvm::json::Array &breakpoints,
llvm::Optional<llvm::StringRef> request_path,
llvm::Optional<uint32_t> request_line) {
diff --git a/lldb/tools/lldb-vscode/JSONUtils.h b/lldb/tools/lldb-vscode/JSONUtils.h
index af76683d11cc..71aa87e3d523 100644
--- a/lldb/tools/lldb-vscode/JSONUtils.h
+++ b/lldb/tools/lldb-vscode/JSONUtils.h
@@ -13,6 +13,7 @@
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/JSON.h"
#include "VSCodeForward.h"
+#include "lldb/API/SBModule.h"
namespace lldb_vscode {
@@ -237,6 +238,16 @@ CreateBreakpoint(lldb::SBBreakpoint &bp,
llvm::Optional<llvm::StringRef> request_path = llvm::None,
llvm::Optional<uint32_t> request_line = llvm::None);
+/// Converts a LLDB module to a VS Code DAP module for use in "modules" events.
+///
+/// \param[in] module
+/// A LLDB module object to convert into a JSON value
+///
+/// \return
+/// A "Module" JSON object with that follows the formal JSON
+/// definition outlined by Microsoft.
+llvm::json::Value CreateModule(lldb::SBModule &module);
+
/// Create a "Event" JSON object using \a event_name as the event name
///
/// \param[in] event_name
diff --git a/lldb/tools/lldb-vscode/VSCode.cpp b/lldb/tools/lldb-vscode/VSCode.cpp
index b2d16f96d1f2..4a30aef3a6db 100644
--- a/lldb/tools/lldb-vscode/VSCode.cpp
+++ b/lldb/tools/lldb-vscode/VSCode.cpp
@@ -358,6 +358,11 @@ void VSCode::SetTarget(const lldb::SBTarget target) {
lldb::SBTarget::eBroadcastBitBreakpointChanged);
listener.StartListeningForEvents(this->broadcaster,
eBroadcastBitStopEventThread);
+ listener.StartListeningForEvents(
+ this->target.GetBroadcaster(),
+ lldb::SBTarget::eBroadcastBitModulesLoaded |
+ lldb::SBTarget::eBroadcastBitModulesUnloaded |
+ lldb::SBTarget::eBroadcastBitSymbolsLoaded);
}
}
diff --git a/lldb/tools/lldb-vscode/lldb-vscode.cpp b/lldb/tools/lldb-vscode/lldb-vscode.cpp
index 168873f82752..cdaaa896d4fe 100644
--- a/lldb/tools/lldb-vscode/lldb-vscode.cpp
+++ b/lldb/tools/lldb-vscode/lldb-vscode.cpp
@@ -39,6 +39,7 @@
#include <set>
#include <sstream>
#include <thread>
+#include <vector>
#include "llvm/ADT/ArrayRef.h"
#include "llvm/Option/Arg.h"
@@ -434,6 +435,30 @@ void EventThreadFunction() {
g_vsc.SendJSON(llvm::json::Value(std::move(bp_event)));
}
}
+ } else if (lldb::SBTarget::EventIsTargetEvent(event)) {
+ if (event_mask & lldb::SBTarget::eBroadcastBitModulesLoaded ||
+ event_mask & lldb::SBTarget::eBroadcastBitModulesUnloaded ||
+ event_mask & lldb::SBTarget::eBroadcastBitSymbolsLoaded) {
+ int num_modules = lldb::SBTarget::GetNumModulesFromEvent(event);
+ for (int i = 0; i < num_modules; i++) {
+ auto module = lldb::SBTarget::GetModuleAtIndexFromEvent(i, event);
+ auto module_event = CreateEventObject("module");
+ llvm::json::Value module_value = CreateModule(module);
+ llvm::json::Object body;
+ if (event_mask & lldb::SBTarget::eBroadcastBitModulesLoaded) {
+ body.try_emplace("reason", "new");
+ } else if (event_mask &
+ lldb::SBTarget::eBroadcastBitModulesUnloaded) {
+ body.try_emplace("reason", "removed");
+ } else if (event_mask &
+ lldb::SBTarget::eBroadcastBitSymbolsLoaded) {
+ body.try_emplace("reason", "changed");
+ }
+ body.try_emplace("module", module_value);
+ module_event.try_emplace("body", std::move(body));
+ g_vsc.SendJSON(llvm::json::Value(std::move(module_event)));
+ }
+ }
} else if (event.BroadcasterMatchesRef(g_vsc.broadcaster)) {
if (event_mask & eBroadcastBitStopEventThread) {
done = true;
More information about the lldb-commits
mailing list