[Lldb-commits] [lldb] [lldb-dap] Creating an API for sending custom dap events from lldb-dap. (PR #112384)
John Harrison via lldb-commits
lldb-commits at lists.llvm.org
Tue Oct 15 12:18:39 PDT 2024
https://github.com/ashgti updated https://github.com/llvm/llvm-project/pull/112384
>From be42193c499f28f8b078f1b443ad09d94e7ba2c5 Mon Sep 17 00:00:00 2001
From: John Harrison <harjohn at google.com>
Date: Tue, 15 Oct 2024 09:13:49 -0700
Subject: [PATCH] [lldb-dap] Creating an API for sending custom dap events from
lldb-dap.
Custom DAP events can be detected using https://code.visualstudio.com/api/references/vscode-api#debug.onDidReceiveDebugSessionCustomEvent. This API allows an lldb python script to send custom events to the DAP client to allow extensions to handle these custom events.
---
.../test/tools/lldb-dap/dap_server.py | 2 +-
.../API/tools/lldb-dap/custom-event/Makefile | 3 ++
.../custom-event/TestDAP_customEvent.py | 46 +++++++++++++++++++
.../API/tools/lldb-dap/custom-event/main.c | 6 +++
lldb/tools/lldb-dap/DAP.cpp | 38 +++++++++++++++
lldb/tools/lldb-dap/DAP.h | 5 ++
lldb/tools/lldb-dap/README.md | 24 ++++++++++
lldb/tools/lldb-dap/lldb-dap.cpp | 2 +
8 files changed, 125 insertions(+), 1 deletion(-)
create mode 100644 lldb/test/API/tools/lldb-dap/custom-event/Makefile
create mode 100644 lldb/test/API/tools/lldb-dap/custom-event/TestDAP_customEvent.py
create mode 100644 lldb/test/API/tools/lldb-dap/custom-event/main.c
diff --git a/lldb/packages/Python/lldbsuite/test/tools/lldb-dap/dap_server.py b/lldb/packages/Python/lldbsuite/test/tools/lldb-dap/dap_server.py
index 1d5e6e0d75c7cb..63748a71f1122d 100644
--- a/lldb/packages/Python/lldbsuite/test/tools/lldb-dap/dap_server.py
+++ b/lldb/packages/Python/lldbsuite/test/tools/lldb-dap/dap_server.py
@@ -1267,7 +1267,7 @@ def run_vscode(dbg, args, options):
def main():
parser = optparse.OptionParser(
description=(
- "A testing framework for the Visual Studio Code Debug " "Adaptor protocol"
+ "A testing framework for the Visual Studio Code Debug Adaptor protocol"
)
)
diff --git a/lldb/test/API/tools/lldb-dap/custom-event/Makefile b/lldb/test/API/tools/lldb-dap/custom-event/Makefile
new file mode 100644
index 00000000000000..10495940055b63
--- /dev/null
+++ b/lldb/test/API/tools/lldb-dap/custom-event/Makefile
@@ -0,0 +1,3 @@
+C_SOURCES := main.c
+
+include Makefile.rules
diff --git a/lldb/test/API/tools/lldb-dap/custom-event/TestDAP_customEvent.py b/lldb/test/API/tools/lldb-dap/custom-event/TestDAP_customEvent.py
new file mode 100644
index 00000000000000..2ae02b09c9f0fc
--- /dev/null
+++ b/lldb/test/API/tools/lldb-dap/custom-event/TestDAP_customEvent.py
@@ -0,0 +1,46 @@
+"""
+Test lldb-dap custom-event integration.
+"""
+
+import json
+
+from lldbsuite.test.decorators import *
+from lldbsuite.test.lldbtest import *
+import lldbdap_testcase
+
+
+class TestDAP_customEvent(lldbdap_testcase.DAPTestCaseBase):
+ def test_custom_event(self):
+ """
+ Test sending a custom event.
+ """
+ program = self.getBuildArtifact("a.out")
+ source = "main.c"
+ custom_event_body = {
+ "key": 321,
+ "arr": [True],
+ }
+ self.build_and_launch(
+ program,
+ stopCommands=[
+ "lldb-dap custom-event my-custom-event-no-body",
+ "lldb-dap custom-event my-custom-event '{}'".format(
+ json.dumps(custom_event_body)
+ ),
+ ],
+ )
+
+ breakpoint_line = line_number(source, "// breakpoint")
+
+ self.set_source_breakpoints(source, [breakpoint_line])
+ self.continue_to_next_stop()
+
+ custom_event = self.dap_server.wait_for_event(
+ filter=["my-custom-event-no-body"]
+ )
+ self.assertEquals(custom_event["event"], "my-custom-event-no-body")
+ self.assertIsNone(custom_event.get("body", None))
+
+ custom_event = self.dap_server.wait_for_event(filter=["my-custom-event"])
+ self.assertEquals(custom_event["event"], "my-custom-event")
+ self.assertEquals(custom_event["body"], custom_event_body)
diff --git a/lldb/test/API/tools/lldb-dap/custom-event/main.c b/lldb/test/API/tools/lldb-dap/custom-event/main.c
new file mode 100644
index 00000000000000..27bc22b94794b6
--- /dev/null
+++ b/lldb/test/API/tools/lldb-dap/custom-event/main.c
@@ -0,0 +1,6 @@
+#include <stdio.h>
+
+int main(int argc, char const *argv[]) {
+ printf("example\n"); // breakpoint 1
+ return 0;
+}
diff --git a/lldb/tools/lldb-dap/DAP.cpp b/lldb/tools/lldb-dap/DAP.cpp
index 5e75d84cf8243e..433682b48ee857 100644
--- a/lldb/tools/lldb-dap/DAP.cpp
+++ b/lldb/tools/lldb-dap/DAP.cpp
@@ -969,6 +969,44 @@ bool ReplModeRequestHandler::DoExecute(lldb::SBDebugger debugger,
return true;
}
+// Sends a custom DAP event with an optional body.
+//
+// See
+// https://code.visualstudio.com/api/references/vscode-api#debug.onDidReceiveDebugSessionCustomEvent
+bool CustomDAPEventRequestHandler::DoExecute(
+ lldb::SBDebugger debugger, char **command,
+ lldb::SBCommandReturnObject &result) {
+ // Command format like: `custom-event <name> <body>?`
+ if (!command || !command[0] || llvm::StringRef(command[0]).empty()) {
+ result.SetError("Invalid use of custom-event, expected format "
+ "`custom-event <name> <body>?`.");
+ return false;
+ }
+
+ llvm::StringRef name{command[0]};
+ llvm::json::Object event(CreateEventObject(name));
+
+ if (command[1] && !llvm::StringRef(command[1]).empty()) {
+ llvm::StringRef raw_body{command[1]};
+
+ llvm::Expected<llvm::json::Value> body = llvm::json::parse(raw_body);
+
+ if (!body) {
+ llvm::Error err = body.takeError();
+ std::string msg = "Failed to parse custom event body: " +
+ llvm::toString(std::move(err));
+ result.SetError(msg.c_str());
+ return false;
+ }
+
+ event.try_emplace("body", std::move(*body));
+ }
+
+ g_dap.SendJSON(llvm::json::Value(std::move(event)));
+ result.SetStatus(lldb::eReturnStatusSuccessFinishNoResult);
+ return true;
+}
+
void DAP::SetFrameFormat(llvm::StringRef format) {
if (format.empty())
return;
diff --git a/lldb/tools/lldb-dap/DAP.h b/lldb/tools/lldb-dap/DAP.h
index ba6d3d80410e3d..966019fadcea34 100644
--- a/lldb/tools/lldb-dap/DAP.h
+++ b/lldb/tools/lldb-dap/DAP.h
@@ -144,6 +144,11 @@ struct ReplModeRequestHandler : public lldb::SBCommandPluginInterface {
lldb::SBCommandReturnObject &result) override;
};
+struct CustomDAPEventRequestHandler : public lldb::SBCommandPluginInterface {
+ bool DoExecute(lldb::SBDebugger debugger, char **command,
+ lldb::SBCommandReturnObject &result) override;
+};
+
struct DAP {
std::string debug_adaptor_path;
InputStream input;
diff --git a/lldb/tools/lldb-dap/README.md b/lldb/tools/lldb-dap/README.md
index 3a7d82e887cca3..3a9979c64f0d84 100644
--- a/lldb/tools/lldb-dap/README.md
+++ b/lldb/tools/lldb-dap/README.md
@@ -290,6 +290,30 @@ The initial repl-mode can be configured with the cli flag `--repl-mode=<mode>`
and may also be adjusted at runtime using the lldb command
`lldb-dap repl-mode <mode>`.
+#### `lldb-dap custom-event`
+
+lldb-dap includes a custom command to trigger a Debug Adapter Protocol event
+from a script. [See the specification](https://microsoft.github.io/debug-adapter-protocol/specification#Base_Protocol_Event)
+for more details on Debug Adapter Protocol events.
+
+This command has the format:
+
+```
+lldb-dap custom-event <name> <body>?
+```
+
+For example you can use a launch configuration hook to run the command like:
+
+```json
+{
+ "program": "exe",
+ "stopCommands": [
+ "lldb-dap custom-event MyStopEvent",
+ "lldb-dap custom-event MyStopEvent '{\"key\":321}",
+ ]
+}
+```
+
## Contributing
`lldb-dap` and `lldb` are developed under the umbrella of the [LLVM project](https://llvm.org/).
diff --git a/lldb/tools/lldb-dap/lldb-dap.cpp b/lldb/tools/lldb-dap/lldb-dap.cpp
index a167088c8901ca..3104f19aa0cf45 100644
--- a/lldb/tools/lldb-dap/lldb-dap.cpp
+++ b/lldb/tools/lldb-dap/lldb-dap.cpp
@@ -1896,6 +1896,8 @@ void request_initialize(const llvm::json::Object &request) {
cmd.AddCommand(
"repl-mode", new ReplModeRequestHandler(),
"Get or set the repl behavior of lldb-dap evaluation requests.");
+ cmd.AddCommand("custom-event", new CustomDAPEventRequestHandler(),
+ "Fires a custom lldb-dap event.");
g_dap.progress_event_thread = std::thread(ProgressEventThreadFunction);
More information about the lldb-commits
mailing list