https://github.com/JDevlieghere updated https://github.com/llvm/llvm-project/pull/128549
>From 16bb4bd6d5f100dceb139474b29cbfd3de6dce06 Mon Sep 17 00:00:00 2001 From: Jonas Devlieghere <jo...@devlieghere.com> Date: Mon, 24 Feb 2025 11:28:17 -0600 Subject: [PATCH] [lldb-dap] Refactor custom & testing related request handlers (NFC) --- lldb/tools/lldb-dap/CMakeLists.txt | 3 + .../Handler/CompileUnitsRequestHandler.cpp | 80 ++++++++++ .../Handler/ModulesRequestHandler.cpp | 58 ++++++++ lldb/tools/lldb-dap/Handler/RequestHandler.h | 27 ++++ ...TestGetTargetBreakpointsRequestHandler.cpp | 31 ++++ lldb/tools/lldb-dap/lldb-dap.cpp | 138 +----------------- 6 files changed, 206 insertions(+), 131 deletions(-) create mode 100644 lldb/tools/lldb-dap/Handler/CompileUnitsRequestHandler.cpp create mode 100644 lldb/tools/lldb-dap/Handler/ModulesRequestHandler.cpp create mode 100644 lldb/tools/lldb-dap/Handler/TestGetTargetBreakpointsRequestHandler.cpp diff --git a/lldb/tools/lldb-dap/CMakeLists.txt b/lldb/tools/lldb-dap/CMakeLists.txt index 61271e1a9f2a6..688a2e448f71d 100644 --- a/lldb/tools/lldb-dap/CMakeLists.txt +++ b/lldb/tools/lldb-dap/CMakeLists.txt @@ -39,6 +39,7 @@ add_lldb_tool(lldb-dap Handler/AttachRequestHandler.cpp Handler/BreakpointLocationsHandler.cpp + Handler/CompileUnitsRequestHandler.cpp Handler/CompletionsHandler.cpp Handler/ConfigurationDoneRequestHandler.cpp Handler/ContinueRequestHandler.cpp @@ -47,11 +48,13 @@ add_lldb_tool(lldb-dap Handler/ExceptionInfoRequestHandler.cpp Handler/InitializeRequestHandler.cpp Handler/LaunchRequestHandler.cpp + Handler/ModulesRequestHandler.cpp Handler/NextRequestHandler.cpp Handler/RequestHandler.cpp Handler/RestartRequestHandler.cpp Handler/StepInRequestHandler.cpp Handler/StepInTargetsRequestHandler.cpp + Handler/TestGetTargetBreakpointsRequestHandler.cpp Handler/StepOutRequestHandler.cpp LINK_LIBS diff --git a/lldb/tools/lldb-dap/Handler/CompileUnitsRequestHandler.cpp b/lldb/tools/lldb-dap/Handler/CompileUnitsRequestHandler.cpp new file mode 100644 index 0000000000000..c541d1cd039c8 --- /dev/null +++ b/lldb/tools/lldb-dap/Handler/CompileUnitsRequestHandler.cpp @@ -0,0 +1,80 @@ +//===-- CompileUnitsRequestHandler.cpp ------------------------------------===// +// +// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. +// See https://llvm.org/LICENSE.txt for license information. +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// +//===----------------------------------------------------------------------===// + +#include "DAP.h" +#include "EventHelper.h" +#include "JSONUtils.h" +#include "RequestHandler.h" + +namespace lldb_dap { + +// "compileUnitsRequest": { +// "allOf": [ { "$ref": "#/definitions/Request" }, { +// "type": "object", +// "description": "Compile Unit request; value of command field is +// 'compileUnits'.", +// "properties": { +// "command": { +// "type": "string", +// "enum": [ "compileUnits" ] +// }, +// "arguments": { +// "$ref": "#/definitions/compileUnitRequestArguments" +// } +// }, +// "required": [ "command", "arguments" ] +// }] +// }, +// "compileUnitsRequestArguments": { +// "type": "object", +// "description": "Arguments for 'compileUnits' request.", +// "properties": { +// "moduleId": { +// "type": "string", +// "description": "The ID of the module." +// } +// }, +// "required": [ "moduleId" ] +// }, +// "compileUnitsResponse": { +// "allOf": [ { "$ref": "#/definitions/Response" }, { +// "type": "object", +// "description": "Response to 'compileUnits' request.", +// "properties": { +// "body": { +// "description": "Response to 'compileUnits' request. Array of +// paths of compile units." +// } +// } +// }] +// } +void CompileUnitsRequestHandler::operator()(const llvm::json::Object &request) { + llvm::json::Object response; + FillResponse(request, response); + llvm::json::Object body; + llvm::json::Array units; + const auto *arguments = request.getObject("arguments"); + std::string module_id = std::string(GetString(arguments, "moduleId")); + int num_modules = dap.target.GetNumModules(); + for (int i = 0; i < num_modules; i++) { + auto curr_module = dap.target.GetModuleAtIndex(i); + if (module_id == curr_module.GetUUIDString()) { + int num_units = curr_module.GetNumCompileUnits(); + for (int j = 0; j < num_units; j++) { + auto curr_unit = curr_module.GetCompileUnitAtIndex(j); + units.emplace_back(CreateCompileUnit(curr_unit)); + } + body.try_emplace("compileUnits", std::move(units)); + break; + } + } + response.try_emplace("body", std::move(body)); + dap.SendJSON(llvm::json::Value(std::move(response))); +} + +} // namespace lldb_dap diff --git a/lldb/tools/lldb-dap/Handler/ModulesRequestHandler.cpp b/lldb/tools/lldb-dap/Handler/ModulesRequestHandler.cpp new file mode 100644 index 0000000000000..f72faa7be8963 --- /dev/null +++ b/lldb/tools/lldb-dap/Handler/ModulesRequestHandler.cpp @@ -0,0 +1,58 @@ +//===-- ModulesRequestHandler.cpp -----------------------------------------===// +// +// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. +// See https://llvm.org/LICENSE.txt for license information. +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// +//===----------------------------------------------------------------------===// + +#include "DAP.h" +#include "EventHelper.h" +#include "JSONUtils.h" +#include "RequestHandler.h" + +namespace lldb_dap { + +// "modulesRequest": { +// "allOf": [ { "$ref": "#/definitions/Request" }, { +// "type": "object", +// "description": "Modules request; value of command field is +// 'modules'.", +// "properties": { +// "command": { +// "type": "string", +// "enum": [ "modules" ] +// }, +// }, +// "required": [ "command" ] +// }] +// }, +// "modulesResponse": { +// "allOf": [ { "$ref": "#/definitions/Response" }, { +// "type": "object", +// "description": "Response to 'modules' request.", +// "properties": { +// "body": { +// "description": "Response to 'modules' request. Array of +// module objects." +// } +// } +// }] +// } +void ModulesRequestHandler::operator()(const llvm::json::Object &request) { + llvm::json::Object response; + FillResponse(request, response); + + llvm::json::Array modules; + for (size_t i = 0; i < dap.target.GetNumModules(); i++) { + lldb::SBModule module = dap.target.GetModuleAtIndex(i); + modules.emplace_back(CreateModule(dap.target, module)); + } + + llvm::json::Object body; + body.try_emplace("modules", std::move(modules)); + response.try_emplace("body", std::move(body)); + dap.SendJSON(llvm::json::Value(std::move(response))); +} + +} // namespace lldb_dap diff --git a/lldb/tools/lldb-dap/Handler/RequestHandler.h b/lldb/tools/lldb-dap/Handler/RequestHandler.h index 2610a3d21ebc4..874b600181f43 100644 --- a/lldb/tools/lldb-dap/Handler/RequestHandler.h +++ b/lldb/tools/lldb-dap/Handler/RequestHandler.h @@ -162,6 +162,33 @@ class StepOutRequestHandler : public RequestHandler { void operator()(const llvm::json::Object &request) override; }; +class CompileUnitsRequestHandler : public RequestHandler { +public: + using RequestHandler::RequestHandler; + static llvm::StringLiteral getCommand() { return "compileUnits"; } + void operator()(const llvm::json::Object &request) override; +}; + +class ModulesRequestHandler : public RequestHandler { +public: + using RequestHandler::RequestHandler; + static llvm::StringLiteral getCommand() { return "modules"; } + void operator()(const llvm::json::Object &request) override; +}; + +/// A request used in testing to get the details on all breakpoints that are +/// currently set in the target. This helps us to test "setBreakpoints" and +/// "setFunctionBreakpoints" requests to verify we have the correct set of +/// breakpoints currently set in LLDB. +class TestGetTargetBreakpointsRequestHandler : public RequestHandler { +public: + using RequestHandler::RequestHandler; + static llvm::StringLiteral getCommand() { + return "_testGetTargetBreakpoints"; + } + void operator()(const llvm::json::Object &request) override; +}; + } // namespace lldb_dap #endif diff --git a/lldb/tools/lldb-dap/Handler/TestGetTargetBreakpointsRequestHandler.cpp b/lldb/tools/lldb-dap/Handler/TestGetTargetBreakpointsRequestHandler.cpp new file mode 100644 index 0000000000000..ad012d75f9059 --- /dev/null +++ b/lldb/tools/lldb-dap/Handler/TestGetTargetBreakpointsRequestHandler.cpp @@ -0,0 +1,31 @@ +//===-- TestGetTargetBreakpointsRequestHandler.cpp ------------------------===// +// +// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. +// See https://llvm.org/LICENSE.txt for license information. +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// +//===----------------------------------------------------------------------===// + +#include "DAP.h" +#include "EventHelper.h" +#include "JSONUtils.h" +#include "RequestHandler.h" + +namespace lldb_dap { + +void TestGetTargetBreakpointsRequestHandler::operator()( + const llvm::json::Object &request) { + llvm::json::Object response; + FillResponse(request, response); + llvm::json::Array response_breakpoints; + for (uint32_t i = 0; dap.target.GetBreakpointAtIndex(i).IsValid(); ++i) { + auto bp = Breakpoint(dap, dap.target.GetBreakpointAtIndex(i)); + AppendBreakpoint(&bp, response_breakpoints); + } + llvm::json::Object body; + body.try_emplace("breakpoints", std::move(response_breakpoints)); + response.try_emplace("body", std::move(body)); + dap.SendJSON(llvm::json::Value(std::move(response))); +} + +} // namespace lldb_dap diff --git a/lldb/tools/lldb-dap/lldb-dap.cpp b/lldb/tools/lldb-dap/lldb-dap.cpp index 22fff86066659..632629d56232c 100644 --- a/lldb/tools/lldb-dap/lldb-dap.cpp +++ b/lldb/tools/lldb-dap/lldb-dap.cpp @@ -261,112 +261,6 @@ bool FillStackFrames(DAP &dap, lldb::SBThread &thread, return reached_end_of_stack; } -// "compileUnitsRequest": { -// "allOf": [ { "$ref": "#/definitions/Request" }, { -// "type": "object", -// "description": "Compile Unit request; value of command field is -// 'compileUnits'.", -// "properties": { -// "command": { -// "type": "string", -// "enum": [ "compileUnits" ] -// }, -// "arguments": { -// "$ref": "#/definitions/compileUnitRequestArguments" -// } -// }, -// "required": [ "command", "arguments" ] -// }] -// }, -// "compileUnitsRequestArguments": { -// "type": "object", -// "description": "Arguments for 'compileUnits' request.", -// "properties": { -// "moduleId": { -// "type": "string", -// "description": "The ID of the module." -// } -// }, -// "required": [ "moduleId" ] -// }, -// "compileUnitsResponse": { -// "allOf": [ { "$ref": "#/definitions/Response" }, { -// "type": "object", -// "description": "Response to 'compileUnits' request.", -// "properties": { -// "body": { -// "description": "Response to 'compileUnits' request. Array of -// paths of compile units." -// } -// } -// }] -// } -void request_compileUnits(DAP &dap, const llvm::json::Object &request) { - llvm::json::Object response; - FillResponse(request, response); - llvm::json::Object body; - llvm::json::Array units; - const auto *arguments = request.getObject("arguments"); - std::string module_id = std::string(GetString(arguments, "moduleId")); - int num_modules = dap.target.GetNumModules(); - for (int i = 0; i < num_modules; i++) { - auto curr_module = dap.target.GetModuleAtIndex(i); - if (module_id == curr_module.GetUUIDString()) { - int num_units = curr_module.GetNumCompileUnits(); - for (int j = 0; j < num_units; j++) { - auto curr_unit = curr_module.GetCompileUnitAtIndex(j); - units.emplace_back(CreateCompileUnit(curr_unit)); - } - body.try_emplace("compileUnits", std::move(units)); - break; - } - } - response.try_emplace("body", std::move(body)); - dap.SendJSON(llvm::json::Value(std::move(response))); -} - -// "modulesRequest": { -// "allOf": [ { "$ref": "#/definitions/Request" }, { -// "type": "object", -// "description": "Modules request; value of command field is -// 'modules'.", -// "properties": { -// "command": { -// "type": "string", -// "enum": [ "modules" ] -// }, -// }, -// "required": [ "command" ] -// }] -// }, -// "modulesResponse": { -// "allOf": [ { "$ref": "#/definitions/Response" }, { -// "type": "object", -// "description": "Response to 'modules' request.", -// "properties": { -// "body": { -// "description": "Response to 'modules' request. Array of -// module objects." -// } -// } -// }] -// } -void request_modules(DAP &dap, const llvm::json::Object &request) { - llvm::json::Object response; - FillResponse(request, response); - - llvm::json::Array modules; - for (size_t i = 0; i < dap.target.GetNumModules(); i++) { - lldb::SBModule module = dap.target.GetModuleAtIndex(i); - modules.emplace_back(CreateModule(dap.target, module)); - } - - llvm::json::Object body; - body.try_emplace("modules", std::move(modules)); - response.try_emplace("body", std::move(body)); - dap.SendJSON(llvm::json::Value(std::move(response))); -} - // "PauseRequest": { // "allOf": [ { "$ref": "#/definitions/Request" }, { // "type": "object", @@ -2187,25 +2081,6 @@ void request_readMemory(DAP &dap, const llvm::json::Object &request) { dap.SendJSON(llvm::json::Value(std::move(response))); } -// A request used in testing to get the details on all breakpoints that are -// currently set in the target. This helps us to test "setBreakpoints" and -// "setFunctionBreakpoints" requests to verify we have the correct set of -// breakpoints currently set in LLDB. -void request__testGetTargetBreakpoints(DAP &dap, - const llvm::json::Object &request) { - llvm::json::Object response; - FillResponse(request, response); - llvm::json::Array response_breakpoints; - for (uint32_t i = 0; dap.target.GetBreakpointAtIndex(i).IsValid(); ++i) { - auto bp = Breakpoint(dap, dap.target.GetBreakpointAtIndex(i)); - AppendBreakpoint(&bp, response_breakpoints); - } - llvm::json::Object body; - body.try_emplace("breakpoints", std::move(response_breakpoints)); - response.try_emplace("body", std::move(body)); - dap.SendJSON(llvm::json::Value(std::move(response))); -} - // "SetInstructionBreakpointsRequest": { // "allOf": [ // {"$ref": "#/definitions/Request"}, @@ -2456,6 +2331,13 @@ void RegisterRequestCallbacks(DAP &dap) { dap.RegisterRequest<StepInTargetsRequestHandler>(); dap.RegisterRequest<StepOutRequestHandler>(); + // Custom requests + dap.RegisterRequest<CompileUnitsRequestHandler>(); + dap.RegisterRequest<ModulesRequestHandler>(); + + // Testing requests + dap.RegisterRequest<TestGetTargetBreakpointsRequestHandler>(); + dap.RegisterRequestCallback("pause", request_pause); dap.RegisterRequestCallback("scopes", request_scopes); dap.RegisterRequestCallback("setBreakpoints", request_setBreakpoints); @@ -2475,12 +2357,6 @@ void RegisterRequestCallbacks(DAP &dap) { dap.RegisterRequestCallback("readMemory", request_readMemory); dap.RegisterRequestCallback("setInstructionBreakpoints", request_setInstructionBreakpoints); - // Custom requests - dap.RegisterRequestCallback("compileUnits", request_compileUnits); - dap.RegisterRequestCallback("modules", request_modules); - // Testing requests - dap.RegisterRequestCallback("_testGetTargetBreakpoints", - request__testGetTargetBreakpoints); } } // anonymous namespace _______________________________________________ lldb-commits mailing list lldb-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
