Skip to content

[lldb-dap] Support the Module Event #137380

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 27, 2025
Merged

[lldb-dap] Support the Module Event #137380

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
681beb0
[lldb-dap] Support the Module Event
JDevlieghere Apr 25, 2025
47b5695
Support changed event too
JDevlieghere Apr 25, 2025
a684174
Merge branch 'main' into lldb-dap-module-event
JDevlieghere Apr 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions lldb/packages/Python/lldbsuite/test/tools/lldb-dap/dap_server.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ def __init__(self, recv, send, init_commands, log_file=None):
self.breakpoint_events = []
self.progress_events = []
self.reverse_requests = []
self.module_events = []
self.sequence = 1
self.threads = None
self.recv_thread.start()
Expand Down Expand Up @@ -255,6 +256,11 @@ def handle_recv_packet(self, packet):
# and 'progressEnd' events. Keep these around in case test
# cases want to verify them.
self.progress_events.append(packet)
elif event == "module":
# Module events indicate that some information about a module has changed.
self.module_events.append(packet)
# no need to add 'module' event packets to our packets list
return keepGoing

elif packet_type == "response":
if packet["command"] == "disconnect":
Expand Down
11 changes: 11 additions & 0 deletions lldb/test/API/tools/lldb-dap/module/TestDAP_module.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,17 @@ def checkSymbolsLoadedWithSize():
self.assertEqual(program, program_module["path"])
self.assertIn("addressRange", program_module)

# Collect all the module names we saw as events.
module_event_names = set()
for module_event in self.dap_server.module_events:
module_event_names.add(module_event["body"]["module"]["name"])
self.assertNotEqual(len(module_event_names), 0)

# Make sure we got an event for every active module.
for module in active_modules:
# assertIn doesn't work with set.
self.assertTrue(module in module_event_names)

@skipIfWindows
def test_modules(self):
"""
Expand Down
4 changes: 3 additions & 1 deletion lldb/tools/lldb-dap/DAP.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -692,7 +692,9 @@ void DAP::SetTarget(const lldb::SBTarget target) {
lldb::SBListener listener = this->debugger.GetListener();
listener.StartListeningForEvents(
this->target.GetBroadcaster(),
lldb::SBTarget::eBroadcastBitBreakpointChanged);
lldb::SBTarget::eBroadcastBitBreakpointChanged |
lldb::SBTarget::eBroadcastBitModulesLoaded |
Copy link
Contributor

@da-viper da-viper Apr 25, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should handle when the symbols in the module changes eBroadcastBitSymbolsLoaded and eBroadcastBitSymbolsChanged since symbol changes are reported when CreateModule is called

This corresponds to the module event reason changed

lldb::SBTarget::eBroadcastBitModulesUnloaded);
listener.StartListeningForEvents(this->broadcaster,
eBroadcastBitStopEventThread);
}
Expand Down
24 changes: 24 additions & 0 deletions lldb/tools/lldb-dap/Handler/InitializeRequestHandler.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
#include "lldb/API/SBEvent.h"
#include "lldb/API/SBListener.h"
#include "lldb/API/SBStream.h"
#include "lldb/API/SBTarget.h"
#include <cstdint>

using namespace lldb;
using namespace lldb_dap::protocol;
Expand Down Expand Up @@ -193,6 +195,28 @@ static void EventThreadFunction(DAP &dap) {
(event_mask & lldb::SBProcess::eBroadcastBitSTDERR)) {
SendStdOutStdErr(dap, process);
}
} else if (lldb::SBTarget::EventIsTargetEvent(event)) {
if (event_mask & lldb::SBTarget::eBroadcastBitModulesLoaded ||
event_mask & lldb::SBTarget::eBroadcastBitModulesUnloaded) {
const llvm::StringRef reason =
event_mask & lldb::SBTarget::eBroadcastBitModulesLoaded
? "new"
: "removed";
const uint32_t num_modules = SBTarget::GetNumModulesFromEvent(event);
for (uint32_t i = 0; i < num_modules; ++i) {
lldb::SBModule module =
SBTarget::GetModuleAtIndexFromEvent(i, event);
if (!module.IsValid())
continue;

llvm::json::Object body;
body.try_emplace("reason", reason);
body.try_emplace("module", CreateModule(dap.target, module));
llvm::json::Object module_event = CreateEventObject("module");
module_event.try_emplace("body", std::move(body));
dap.SendJSON(llvm::json::Value(std::move(module_event)));
}
}
} else if (lldb::SBBreakpoint::EventIsBreakpointEvent(event)) {
if (event_mask & lldb::SBTarget::eBroadcastBitBreakpointChanged) {
auto event_type =
Expand Down
Loading