* 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
258 lines
6.6 KiB
C++
258 lines
6.6 KiB
C++
// 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/io.h"
|
|
|
|
#include <atomic>
|
|
#include <condition_variable>
|
|
#include <cstdarg>
|
|
#include <cstdio>
|
|
#include <cstring> // strlen
|
|
#include <deque>
|
|
#include <mutex>
|
|
#include <string>
|
|
|
|
namespace {
|
|
|
|
class Pipe : public dap::ReaderWriter {
|
|
public:
|
|
// dap::ReaderWriter compliance
|
|
bool isOpen() override {
|
|
std::unique_lock<std::mutex> lock(mutex);
|
|
return !closed;
|
|
}
|
|
|
|
void close() override {
|
|
std::unique_lock<std::mutex> lock(mutex);
|
|
closed = true;
|
|
cv.notify_all();
|
|
}
|
|
|
|
size_t read(void* buffer, size_t bytes) override {
|
|
std::unique_lock<std::mutex> lock(mutex);
|
|
auto out = reinterpret_cast<uint8_t*>(buffer);
|
|
size_t n = 0;
|
|
while (true) {
|
|
cv.wait(lock, [&] { return closed || data.size() > 0; });
|
|
if (closed) {
|
|
return n;
|
|
}
|
|
for (; n < bytes && data.size() > 0; n++) {
|
|
out[n] = data.front();
|
|
data.pop_front();
|
|
}
|
|
if (n == bytes) {
|
|
return n;
|
|
}
|
|
}
|
|
}
|
|
|
|
bool write(const void* buffer, size_t bytes) override {
|
|
std::unique_lock<std::mutex> lock(mutex);
|
|
if (closed) {
|
|
return false;
|
|
}
|
|
if (bytes == 0) {
|
|
return true;
|
|
}
|
|
auto notify = data.size() == 0;
|
|
auto src = reinterpret_cast<const uint8_t*>(buffer);
|
|
for (size_t i = 0; i < bytes; i++) {
|
|
data.emplace_back(src[i]);
|
|
}
|
|
if (notify) {
|
|
cv.notify_all();
|
|
}
|
|
return true;
|
|
}
|
|
|
|
private:
|
|
std::mutex mutex;
|
|
std::condition_variable cv;
|
|
std::deque<uint8_t> data;
|
|
bool closed = false;
|
|
};
|
|
|
|
class RW : public dap::ReaderWriter {
|
|
public:
|
|
RW(const std::shared_ptr<Reader>& r, const std::shared_ptr<Writer>& w)
|
|
: r(r), w(w) {}
|
|
|
|
// dap::ReaderWriter compliance
|
|
bool isOpen() override { return r->isOpen() && w->isOpen(); }
|
|
void close() override {
|
|
r->close();
|
|
w->close();
|
|
}
|
|
size_t read(void* buffer, size_t n) override { return r->read(buffer, n); }
|
|
bool write(const void* buffer, size_t n) override {
|
|
return w->write(buffer, n);
|
|
}
|
|
|
|
private:
|
|
const std::shared_ptr<dap::Reader> r;
|
|
const std::shared_ptr<dap::Writer> w;
|
|
};
|
|
|
|
class File : public dap::ReaderWriter {
|
|
public:
|
|
File(FILE* f, bool closable) : f(f), closable(closable) {}
|
|
|
|
~File() { close(); }
|
|
|
|
// dap::ReaderWriter compliance
|
|
bool isOpen() override { return !closed; }
|
|
void close() override {
|
|
if (closable) {
|
|
if (!closed.exchange(true)) {
|
|
fclose(f);
|
|
}
|
|
}
|
|
}
|
|
size_t read(void* buffer, size_t n) override {
|
|
std::unique_lock<std::mutex> lock(readMutex);
|
|
auto out = reinterpret_cast<char*>(buffer);
|
|
for (size_t i = 0; i < n; i++) {
|
|
int c = fgetc(f);
|
|
if (c == EOF) {
|
|
return i;
|
|
}
|
|
out[i] = char(c);
|
|
}
|
|
return n;
|
|
}
|
|
bool write(const void* buffer, size_t n) override {
|
|
std::unique_lock<std::mutex> lock(writeMutex);
|
|
if (fwrite(buffer, 1, n, f) == n) {
|
|
fflush(f);
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
private:
|
|
FILE* const f;
|
|
const bool closable;
|
|
std::mutex readMutex;
|
|
std::mutex writeMutex;
|
|
std::atomic<bool> closed = {false};
|
|
};
|
|
|
|
class ReaderSpy : public dap::Reader {
|
|
public:
|
|
ReaderSpy(const std::shared_ptr<dap::Reader>& r,
|
|
const std::shared_ptr<dap::Writer>& s,
|
|
const std::string& prefix)
|
|
: r(r), s(s), prefix(prefix) {}
|
|
|
|
// dap::Reader compliance
|
|
bool isOpen() override { return r->isOpen(); }
|
|
void close() override { r->close(); }
|
|
size_t read(void* buffer, size_t n) override {
|
|
auto c = r->read(buffer, n);
|
|
if (c > 0) {
|
|
auto chars = reinterpret_cast<const char*>(buffer);
|
|
std::string buf = prefix;
|
|
buf.append(chars, chars + c);
|
|
s->write(buf.data(), buf.size());
|
|
}
|
|
return c;
|
|
}
|
|
|
|
private:
|
|
const std::shared_ptr<dap::Reader> r;
|
|
const std::shared_ptr<dap::Writer> s;
|
|
const std::string prefix;
|
|
};
|
|
|
|
class WriterSpy : public dap::Writer {
|
|
public:
|
|
WriterSpy(const std::shared_ptr<dap::Writer>& w,
|
|
const std::shared_ptr<dap::Writer>& s,
|
|
const std::string& prefix)
|
|
: w(w), s(s), prefix(prefix) {}
|
|
|
|
// dap::Writer compliance
|
|
bool isOpen() override { return w->isOpen(); }
|
|
void close() override { w->close(); }
|
|
bool write(const void* buffer, size_t n) override {
|
|
if (!w->write(buffer, n)) {
|
|
return false;
|
|
}
|
|
auto chars = reinterpret_cast<const char*>(buffer);
|
|
std::string buf = prefix;
|
|
buf.append(chars, chars + n);
|
|
s->write(buf.data(), buf.size());
|
|
return true;
|
|
}
|
|
|
|
private:
|
|
const std::shared_ptr<dap::Writer> w;
|
|
const std::shared_ptr<dap::Writer> s;
|
|
const std::string prefix;
|
|
};
|
|
|
|
} // anonymous namespace
|
|
|
|
namespace dap {
|
|
|
|
std::shared_ptr<ReaderWriter> ReaderWriter::create(
|
|
const std::shared_ptr<Reader>& r,
|
|
const std::shared_ptr<Writer>& w) {
|
|
return std::make_shared<RW>(r, w);
|
|
}
|
|
|
|
std::shared_ptr<ReaderWriter> pipe() {
|
|
return std::make_shared<Pipe>();
|
|
}
|
|
|
|
std::shared_ptr<ReaderWriter> file(FILE* f, bool closable /* = true */) {
|
|
return std::make_shared<File>(f, closable);
|
|
}
|
|
|
|
std::shared_ptr<ReaderWriter> file(const char* path) {
|
|
if (auto f = fopen(path, "wb")) {
|
|
return std::make_shared<File>(f, true);
|
|
}
|
|
return nullptr;
|
|
}
|
|
|
|
// spy() returns a Reader that copies all reads from the Reader r to the Writer
|
|
// s, using the given optional prefix.
|
|
std::shared_ptr<Reader> spy(const std::shared_ptr<Reader>& r,
|
|
const std::shared_ptr<Writer>& s,
|
|
const char* prefix /* = "\n<-" */) {
|
|
return std::make_shared<ReaderSpy>(r, s, prefix);
|
|
}
|
|
|
|
// spy() returns a Writer that copies all writes to the Writer w to the Writer
|
|
// s, using the given optional prefix.
|
|
std::shared_ptr<Writer> spy(const std::shared_ptr<Writer>& w,
|
|
const std::shared_ptr<Writer>& s,
|
|
const char* prefix /* = "\n->" */) {
|
|
return std::make_shared<WriterSpy>(w, s, prefix);
|
|
}
|
|
|
|
bool writef(const std::shared_ptr<Writer>& w, const char* msg, ...) {
|
|
char buf[2048];
|
|
|
|
va_list vararg;
|
|
va_start(vararg, msg);
|
|
vsnprintf(buf, sizeof(buf), msg, vararg);
|
|
va_end(vararg);
|
|
|
|
return w->write(buf, strlen(buf));
|
|
}
|
|
|
|
} // namespace dap
|