ZScript DAP Debug server (#3009)

* Add STL-standard type traits and functions to TMap to enable for loop iteration

* add third-party range-map library

I have e-mailed the author for clarifcation on the license, will update this when they respond

* vcpkg: Add cppdap and eventpp libraries, update baseline

* DAP implementation

* Add `FileSystem::FileHash()` to get the CRC32 hash

* add `starting_offset` param to `VMDisasm()` for debugger disassembly view

Defaults to `0`, should not change output if it's not set

* Add `VMFrameStack::HasFrames()` to prevent assertions when inspecting in the debugger

* Add `PC` field to VMFrame, ensure that it is updated whenever vm increments/decrements the pc

Does not change alignment, the offsets used in VMFrame still work
We need this for the debugger because we otherwise have no way to get the pc; it was a local in `ExecScriptFunc()`

* `ZCCCompiler::CreateClassTypes()`: ensure SourceLumpName is set for classes derived from non-native classes

* start debug server in d_main, add `vm_debug` cvars and `-debug` CLI arg

* Add documentation for `vm_debug` cvars

* vm_exec: Add debugger hooks for instruction execution events

* c_console: Add debugger hooks for logging events in `PrintString`

* add `.cache/` to gitignore

* vendor cppdap on main @ 6464cd7

Patches:
removed .gitmodules (submodules were thirdparty/json, thirdparty/googletest)
removed thirdparty/googletest, not needed
removed thirdparty/json/docs, thirdparty/json/test, thirdparty/json/benchmarks to prevent massive bloat

* vendor eventpp on master @ 1224dd6

* build: use internal cppdap and eventpp by default

* dap: fix Binary::GetFunctionLineRange()

* fix bug in range_map::find_ranges

* make Binary dap::Source dynamic

* cache source code upon retrieval

* refactor Binary into a class, cleanup PexCache

* fix ending session gracefully

* d_main: Stop debug server in D_Cleanup()

* Fix connecting to debugger when session already started

* cleanup unused stuff in ZScriptDebugger

* always send TerminateEvents on disconnect if initialized

* tweak color display

* Don't cache disassembly lines when scanning scripts

* Cache nodes when getting runtime state

* WIP display locals

* Fix display of static arrays

* Ensure names display in proper order

* dap: Fix struct locals display, add args display

* Support `start` parameter

* Support `filter` parameter

* remove struct unbound native data display

Practically useless for debugging zscript and didn't work properly anyway

* d_main: fix vm_jit and vm_jit not being disabled soon enough

* support breaking on abort exceptions

* dap: refactor game event emitter functions into seperate header

* dap: show native functions on stack

* dap: Remove "Native" from exception handling, simplify exception event emit

* dap: add instruction breakpoints

* dap: fix display of locals not in scope yet

* dap: Make disassembly view display invalid instructions for non-code addresses

* dap: remove dot initializers

* dap: fix local structs in scope

* dap: don't parse the non-used options in the launch/attach requests

* dap: fix local struct view

* dap: Fix displaying objects that aren't their actual types

* dap: Fix action and state handling

* dap: stack display view

* dap: fix object display view

* d_dehacked: set qualified name in addition to the printable name

* dap: fix displaying breakpoint errors when script isn't loaded

* dap: remove debug print

* dap: Display parameter names

* dap: Turn down verbosity of logging

* dap: fix disassembly view

* dap: fix performance problems with arrays

* c_console: emit event only if not PRINT_NODAPEVENT

* dap: improve logging

* dap: update upstream cppdap library to fix deadlocks on no bind

* dap: Fix ending session on client socket closed

* dap: prevent DebugServer.h from pulling in `dap` and `ZScriptDebugger.h`

* dap: fix pause event not being emitted on pause

* dap: remove eventpp emitters, way too slow

* Remove eventpp dependency

* dap: Display correct register names

* dap: Show special inits in registers

* dap: Add stack offset to VMLocalVariable

* dap: fix display of static arrays and local variables on stack vs. registers

* dap: fix displaying function pointers

* dap: tweak color display

* dap: fix scalar display < 4

* dap: add Globals display to debugger

* dap: unify methods to get vmvalue

* dap: rename free method to freeValue to avoid running afoul of macro defs

* fix windows builds

* fix compile on linux

* cleanup

* Fix display of function breakpoints

* dap: Don't send back binary files

* dap: include sbarinfo in script types (no debug support for anything but zscript yet, this is just for returning source info)

* dap: don't show ending session message unless initialized

* fix erroneous commit

* dap: handle evaluate requests

* Fix getting bitfield values

* Add CVars Scope and evaluation

* add running console commands from repl

* dap: disable commands via repl for now

* fix loading functions DECORATE scripts

* Add source information to Dehacked VM functions, add debugging support

* dap: cleanup

* fix resolving archive paths

* don't send source back on native stack frames

* handle `modules` request

* cleanup

* allow evaluating cvars on hover

* fix oob bpinfos

* fix restarting the game blowing out the debug server

* dap: process input events while paused to prevent deadlocks

* fix getting local state

* dap: fix LocalState alignment

* dap: fix DumpStateHelper

* update cppdap protocol version to 1.68.0

* remove cppdap from vcpkg deps

We can't use the upstream version anyway because the maintainers are not merging our patches

* dap: make named variable nodes derive from the same class

* dap: make cvar scope available in native stack frames

* handle local variables with conflicting names

* add I_GetWindowEvent() to win32 to only process window events when debugging is paused

* dap: fix evaluate

* dap: fix display of `out` variables
This commit is contained in:
Nikita 2025-07-17 20:01:18 -07:00 committed by GitHub
commit 45ac7c1d9e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
235 changed files with 83166 additions and 62 deletions

View file

@ -0,0 +1,625 @@
// Copyright 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#include "dap/session.h"
#include "dap/io.h"
#include "dap/protocol.h"
#include "chan.h"
#include "gmock/gmock.h"
#include "gtest/gtest.h"
#include <array>
#include <atomic>
#include <condition_variable>
#include <mutex>
#include <thread>
namespace dap {
struct TestResponse : public Response {
boolean b;
integer i;
number n;
array<integer> a;
object o;
string s;
optional<integer> o1;
optional<integer> o2;
};
DAP_STRUCT_TYPEINFO(TestResponse,
"test-response",
DAP_FIELD(b, "res_b"),
DAP_FIELD(i, "res_i"),
DAP_FIELD(n, "res_n"),
DAP_FIELD(a, "res_a"),
DAP_FIELD(o, "res_o"),
DAP_FIELD(s, "res_s"),
DAP_FIELD(o1, "res_o1"),
DAP_FIELD(o2, "res_o2"));
struct TestRequest : public Request {
using Response = TestResponse;
boolean b;
integer i;
number n;
array<integer> a;
object o;
string s;
optional<integer> o1;
optional<integer> o2;
};
DAP_STRUCT_TYPEINFO(TestRequest,
"test-request",
DAP_FIELD(b, "req_b"),
DAP_FIELD(i, "req_i"),
DAP_FIELD(n, "req_n"),
DAP_FIELD(a, "req_a"),
DAP_FIELD(o, "req_o"),
DAP_FIELD(s, "req_s"),
DAP_FIELD(o1, "req_o1"),
DAP_FIELD(o2, "req_o2"));
struct TestEvent : public Event {
boolean b;
integer i;
number n;
array<integer> a;
object o;
string s;
optional<integer> o1;
optional<integer> o2;
};
DAP_STRUCT_TYPEINFO(TestEvent,
"test-event",
DAP_FIELD(b, "evt_b"),
DAP_FIELD(i, "evt_i"),
DAP_FIELD(n, "evt_n"),
DAP_FIELD(a, "evt_a"),
DAP_FIELD(o, "evt_o"),
DAP_FIELD(s, "evt_s"),
DAP_FIELD(o1, "evt_o1"),
DAP_FIELD(o2, "evt_o2"));
}; // namespace dap
namespace {
dap::TestRequest createRequest() {
dap::TestRequest request;
request.b = false;
request.i = 72;
request.n = 9.87;
request.a = {2, 5, 7, 8};
request.o = {
std::make_pair("a", dap::integer(1)),
std::make_pair("b", dap::number(2)),
std::make_pair("c", dap::string("3")),
};
request.s = "request";
request.o2 = 42;
return request;
}
dap::TestResponse createResponse() {
dap::TestResponse response;
response.b = true;
response.i = 99;
response.n = 123.456;
response.a = {5, 4, 3, 2, 1};
response.o = {
std::make_pair("one", dap::integer(1)),
std::make_pair("two", dap::number(2)),
std::make_pair("three", dap::string("3")),
};
response.s = "ROGER";
response.o1 = 50;
return response;
}
dap::TestEvent createEvent() {
dap::TestEvent event;
event.b = false;
event.i = 72;
event.n = 9.87;
event.a = {2, 5, 7, 8};
event.o = {
std::make_pair("a", dap::integer(1)),
std::make_pair("b", dap::number(2)),
std::make_pair("c", dap::string("3")),
};
event.s = "event";
event.o2 = 42;
return event;
}
} // anonymous namespace
class SessionTest : public testing::Test {
public:
void bind() {
auto client2server = dap::pipe();
auto server2client = dap::pipe();
client->bind(server2client, client2server);
server->bind(client2server, server2client);
}
std::unique_ptr<dap::Session> client = dap::Session::create();
std::unique_ptr<dap::Session> server = dap::Session::create();
};
TEST_F(SessionTest, Request) {
dap::TestRequest received;
server->registerHandler([&](const dap::TestRequest& req) {
received = req;
return createResponse();
});
bind();
auto request = createRequest();
client->send(request).get();
// Check request was received correctly.
ASSERT_EQ(received.b, request.b);
ASSERT_EQ(received.i, request.i);
ASSERT_EQ(received.n, request.n);
ASSERT_EQ(received.a, request.a);
ASSERT_EQ(received.o.size(), 3U);
ASSERT_EQ(received.o["a"].get<dap::integer>(),
request.o["a"].get<dap::integer>());
ASSERT_EQ(received.o["b"].get<dap::number>(),
request.o["b"].get<dap::number>());
ASSERT_EQ(received.o["c"].get<dap::string>(),
request.o["c"].get<dap::string>());
ASSERT_EQ(received.s, request.s);
ASSERT_EQ(received.o1, request.o1);
ASSERT_EQ(received.o2, request.o2);
}
TEST_F(SessionTest, RequestResponseSuccess) {
server->registerHandler(
[&](const dap::TestRequest&) { return createResponse(); });
bind();
auto request = createRequest();
auto response = client->send(request);
auto got = response.get();
// Check response was received correctly.
ASSERT_EQ(got.error, false);
ASSERT_EQ(got.response.b, dap::boolean(true));
ASSERT_EQ(got.response.i, dap::integer(99));
ASSERT_EQ(got.response.n, dap::number(123.456));
ASSERT_EQ(got.response.a, dap::array<dap::integer>({5, 4, 3, 2, 1}));
ASSERT_EQ(got.response.o.size(), 3U);
ASSERT_EQ(got.response.o["one"].get<dap::integer>(), dap::integer(1));
ASSERT_EQ(got.response.o["two"].get<dap::number>(), dap::number(2));
ASSERT_EQ(got.response.o["three"].get<dap::string>(), dap::string("3"));
ASSERT_EQ(got.response.s, "ROGER");
ASSERT_EQ(got.response.o1, dap::optional<dap::integer>(50));
ASSERT_FALSE(got.response.o2.has_value());
}
TEST_F(SessionTest, BreakPointRequestResponseSuccess) {
server->registerHandler([&](const dap::SetBreakpointsRequest&) {
dap::SetBreakpointsResponse response;
dap::Breakpoint bp;
bp.line = 2;
response.breakpoints.emplace_back(std::move(bp));
return response;
});
bind();
auto got = client->send(dap::SetBreakpointsRequest{}).get();
// Check response was received correctly.
ASSERT_EQ(got.error, false);
ASSERT_EQ(got.response.breakpoints.size(), 1U);
}
TEST_F(SessionTest, RequestResponseOrError) {
server->registerHandler(
[&](const dap::TestRequest&) -> dap::ResponseOrError<dap::TestResponse> {
return dap::Error("Oh noes!");
});
bind();
auto response = client->send(createRequest());
auto got = response.get();
// Check response was received correctly.
ASSERT_EQ(got.error, true);
ASSERT_EQ(got.error.message, "Oh noes!");
}
TEST_F(SessionTest, RequestResponseError) {
server->registerHandler(
[&](const dap::TestRequest&) { return dap::Error("Oh noes!"); });
bind();
auto response = client->send(createRequest());
auto got = response.get();
// Check response was received correctly.
ASSERT_EQ(got.error, true);
ASSERT_EQ(got.error.message, "Oh noes!");
}
TEST_F(SessionTest, RequestCallbackResponse) {
using ResponseCallback = std::function<void(dap::SetBreakpointsResponse)>;
server->registerHandler(
[&](const dap::SetBreakpointsRequest&, const ResponseCallback& callback) {
dap::SetBreakpointsResponse response;
dap::Breakpoint bp;
bp.line = 2;
response.breakpoints.emplace_back(std::move(bp));
callback(response);
});
bind();
auto got = client->send(dap::SetBreakpointsRequest{}).get();
// Check response was received correctly.
ASSERT_EQ(got.error, false);
ASSERT_EQ(got.response.breakpoints.size(), 1U);
}
TEST_F(SessionTest, RequestCallbackResponseOrError) {
using ResponseCallback =
std::function<void(dap::ResponseOrError<dap::SetBreakpointsResponse>)>;
server->registerHandler(
[&](const dap::SetBreakpointsRequest&, const ResponseCallback& callback) {
dap::SetBreakpointsResponse response;
dap::Breakpoint bp;
bp.line = 2;
response.breakpoints.emplace_back(std::move(bp));
callback(response);
});
bind();
auto got = client->send(dap::SetBreakpointsRequest{}).get();
// Check response was received correctly.
ASSERT_EQ(got.error, false);
ASSERT_EQ(got.response.breakpoints.size(), 1U);
}
TEST_F(SessionTest, RequestCallbackError) {
using ResponseCallback =
std::function<void(dap::ResponseOrError<dap::SetBreakpointsResponse>)>;
server->registerHandler(
[&](const dap::SetBreakpointsRequest&, const ResponseCallback& callback) {
callback(dap::Error("Oh noes!"));
});
bind();
auto got = client->send(dap::SetBreakpointsRequest{}).get();
// Check response was received correctly.
ASSERT_EQ(got.error, true);
ASSERT_EQ(got.error.message, "Oh noes!");
}
TEST_F(SessionTest, RequestCallbackSuccessAfterReturn) {
using ResponseCallback =
std::function<void(dap::ResponseOrError<dap::SetBreakpointsResponse>)>;
ResponseCallback callback;
std::mutex mutex;
std::condition_variable cv;
server->registerHandler(
[&](const dap::SetBreakpointsRequest&, const ResponseCallback& cb) {
std::unique_lock<std::mutex> lock(mutex);
callback = cb;
cv.notify_all();
});
bind();
auto future = client->send(dap::SetBreakpointsRequest{});
{
dap::SetBreakpointsResponse response;
dap::Breakpoint bp;
bp.line = 2;
response.breakpoints.emplace_back(std::move(bp));
// Wait for the handler to be called.
std::unique_lock<std::mutex> lock(mutex);
cv.wait(lock, [&] { return static_cast<bool>(callback); });
// Issue the callback
callback(response);
}
auto got = future.get();
// Check response was received correctly.
ASSERT_EQ(got.error, false);
ASSERT_EQ(got.response.breakpoints.size(), 1U);
}
TEST_F(SessionTest, RequestCallbackErrorAfterReturn) {
using ResponseCallback =
std::function<void(dap::ResponseOrError<dap::SetBreakpointsResponse>)>;
ResponseCallback callback;
std::mutex mutex;
std::condition_variable cv;
server->registerHandler(
[&](const dap::SetBreakpointsRequest&, const ResponseCallback& cb) {
std::unique_lock<std::mutex> lock(mutex);
callback = cb;
cv.notify_all();
});
bind();
auto future = client->send(dap::SetBreakpointsRequest{});
{
// Wait for the handler to be called.
std::unique_lock<std::mutex> lock(mutex);
cv.wait(lock, [&] { return static_cast<bool>(callback); });
// Issue the callback
callback(dap::Error("Oh noes!"));
}
auto got = future.get();
// Check response was received correctly.
ASSERT_EQ(got.error, true);
ASSERT_EQ(got.error.message, "Oh noes!");
}
TEST_F(SessionTest, ResponseSentHandlerSuccess) {
const auto response = createResponse();
dap::Chan<dap::ResponseOrError<dap::TestResponse>> chan;
server->registerHandler([&](const dap::TestRequest&) { return response; });
server->registerSentHandler(
[&](const dap::ResponseOrError<dap::TestResponse> r) { chan.put(r); });
bind();
client->send(createRequest());
auto got = chan.take().value();
ASSERT_EQ(got.error, false);
ASSERT_EQ(got.response.b, dap::boolean(true));
ASSERT_EQ(got.response.i, dap::integer(99));
ASSERT_EQ(got.response.n, dap::number(123.456));
ASSERT_EQ(got.response.a, dap::array<dap::integer>({5, 4, 3, 2, 1}));
ASSERT_EQ(got.response.o.size(), 3U);
ASSERT_EQ(got.response.o["one"].get<dap::integer>(), dap::integer(1));
ASSERT_EQ(got.response.o["two"].get<dap::number>(), dap::number(2));
ASSERT_EQ(got.response.o["three"].get<dap::string>(), dap::string("3"));
ASSERT_EQ(got.response.s, "ROGER");
ASSERT_EQ(got.response.o1, dap::optional<dap::integer>(50));
ASSERT_FALSE(got.response.o2.has_value());
}
TEST_F(SessionTest, ResponseSentHandlerError) {
dap::Chan<dap::ResponseOrError<dap::TestResponse>> chan;
server->registerHandler(
[&](const dap::TestRequest&) { return dap::Error("Oh noes!"); });
server->registerSentHandler(
[&](const dap::ResponseOrError<dap::TestResponse> r) { chan.put(r); });
bind();
client->send(createRequest());
auto got = chan.take().value();
ASSERT_EQ(got.error, true);
ASSERT_EQ(got.error.message, "Oh noes!");
}
TEST_F(SessionTest, Event) {
dap::Chan<dap::TestEvent> received;
server->registerHandler([&](const dap::TestEvent& e) { received.put(e); });
bind();
auto event = createEvent();
client->send(event);
// Check event was received correctly.
auto got = received.take().value();
ASSERT_EQ(got.b, event.b);
ASSERT_EQ(got.i, event.i);
ASSERT_EQ(got.n, event.n);
ASSERT_EQ(got.a, event.a);
ASSERT_EQ(got.o.size(), 3U);
ASSERT_EQ(got.o["a"].get<dap::integer>(), event.o["a"].get<dap::integer>());
ASSERT_EQ(got.o["b"].get<dap::number>(), event.o["b"].get<dap::number>());
ASSERT_EQ(got.o["c"].get<dap::string>(), event.o["c"].get<dap::string>());
ASSERT_EQ(got.s, event.s);
ASSERT_EQ(got.o1, event.o1);
ASSERT_EQ(got.o2, event.o2);
}
TEST_F(SessionTest, RegisterHandlerFunction) {
struct S {
static dap::TestResponse requestA(const dap::TestRequest&) { return {}; }
static dap::Error requestB(const dap::TestRequest&) { return {}; }
static dap::ResponseOrError<dap::TestResponse> requestC(
const dap::TestRequest&) {
return dap::Error();
}
static void event(const dap::TestEvent&) {}
static void sent(const dap::ResponseOrError<dap::TestResponse>&) {}
};
client->registerHandler(&S::requestA);
client->registerHandler(&S::requestB);
client->registerHandler(&S::requestC);
client->registerHandler(&S::event);
client->registerSentHandler(&S::sent);
}
TEST_F(SessionTest, SendRequestNoBind) {
bool errored = false;
client->onError([&](const std::string&) { errored = true; });
auto res = client->send(createRequest()).get();
ASSERT_TRUE(errored);
ASSERT_TRUE(res.error);
}
TEST_F(SessionTest, SendEventNoBind) {
bool errored = false;
client->onError([&](const std::string&) { errored = true; });
client->send(createEvent());
ASSERT_TRUE(errored);
}
TEST_F(SessionTest, SingleThread) {
server->registerHandler(
[&](const dap::TestRequest&) { return createResponse(); });
// Explicitly connect and process request on this test thread instead of
// calling bind() which inturn starts processing messages immediately on a new
// thread.
auto client2server = dap::pipe();
auto server2client = dap::pipe();
client->connect(server2client, client2server);
server->connect(client2server, server2client);
auto request = createRequest();
auto response = client->send(request);
// Process request and response on this thread
if (auto payload = server->getPayload()) {
payload();
}
if (auto payload = client->getPayload()) {
payload();
}
auto got = response.get();
// Check response was received correctly.
ASSERT_EQ(got.error, false);
ASSERT_EQ(got.response.b, dap::boolean(true));
ASSERT_EQ(got.response.i, dap::integer(99));
ASSERT_EQ(got.response.n, dap::number(123.456));
ASSERT_EQ(got.response.a, dap::array<dap::integer>({5, 4, 3, 2, 1}));
ASSERT_EQ(got.response.o.size(), 3U);
ASSERT_EQ(got.response.o["one"].get<dap::integer>(), dap::integer(1));
ASSERT_EQ(got.response.o["two"].get<dap::number>(), dap::number(2));
ASSERT_EQ(got.response.o["three"].get<dap::string>(), dap::string("3"));
ASSERT_EQ(got.response.s, "ROGER");
ASSERT_EQ(got.response.o1, dap::optional<dap::integer>(50));
ASSERT_FALSE(got.response.o2.has_value());
}
TEST_F(SessionTest, Concurrency) {
std::atomic<int> numEventsHandled = {0};
std::atomic<bool> done = {false};
server->registerHandler(
[](const dap::TestRequest&) { return dap::TestResponse(); });
server->registerHandler([&](const dap::TestEvent&) {
if (numEventsHandled++ > 10000) {
done = true;
}
});
bind();
constexpr int numThreads = 32;
std::array<std::thread, numThreads> threads;
for (int i = 0; i < numThreads; i++) {
threads[i] = std::thread([&] {
while (!done) {
client->send(createEvent());
client->send(createRequest());
}
});
}
for (int i = 0; i < numThreads; i++) {
threads[i].join();
}
client.reset();
server.reset();
}
TEST_F(SessionTest, OnClientClosed) {
std::mutex mutex;
std::condition_variable cv;
bool clientClosed = false;
auto client2server = dap::pipe();
auto server2client = dap::pipe();
client->bind(server2client, client2server);
server->bind(client2server, server2client, [&] {
std::unique_lock<std::mutex> lock(mutex);
clientClosed = true;
cv.notify_all();
});
client.reset();
// Wait for the client closed handler to be called.
std::unique_lock<std::mutex> lock(mutex);
cv.wait(lock, [&] { return static_cast<bool>(clientClosed); });
}
TEST_F(SessionTest, OnServerClosed) {
std::mutex mutex;
std::condition_variable cv;
bool serverClosed = false;
auto client2server = dap::pipe();
auto server2client = dap::pipe();
client->bind(server2client, client2server, [&] {
std::unique_lock<std::mutex> lock(mutex);
serverClosed = true;
cv.notify_all();
});
server->bind(client2server, server2client);
server.reset();
// Wait for the client closed handler to be called.
std::unique_lock<std::mutex> lock(mutex);
cv.wait(lock, [&] { return static_cast<bool>(serverClosed); });
}