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
GitHub
parent
fcf529590f
commit
45ac7c1d9e
235 changed files with 83166 additions and 62 deletions
198
libraries/cppdap/src/content_stream.cpp
Normal file
198
libraries/cppdap/src/content_stream.cpp
Normal file
|
|
@ -0,0 +1,198 @@
|
|||
// 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 "content_stream.h"
|
||||
|
||||
#include "dap/io.h"
|
||||
|
||||
#include <string.h> // strlen
|
||||
#include <algorithm> // std::min
|
||||
|
||||
namespace dap {
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
// ContentReader
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
ContentReader::ContentReader(
|
||||
const std::shared_ptr<Reader>& reader,
|
||||
OnInvalidData on_invalid_data /* = OnInvalidData::kIgnore */)
|
||||
: reader(reader), on_invalid_data(on_invalid_data) {}
|
||||
|
||||
ContentReader& ContentReader::operator=(ContentReader&& rhs) noexcept {
|
||||
buf = std::move(rhs.buf);
|
||||
reader = std::move(rhs.reader);
|
||||
on_invalid_data = std::move(rhs.on_invalid_data);
|
||||
return *this;
|
||||
}
|
||||
|
||||
bool ContentReader::isOpen() {
|
||||
return reader ? reader->isOpen() : false;
|
||||
}
|
||||
|
||||
void ContentReader::close() {
|
||||
if (reader) {
|
||||
reader->close();
|
||||
}
|
||||
}
|
||||
|
||||
std::string ContentReader::read() {
|
||||
// Find Content-Length header prefix
|
||||
if (on_invalid_data == kClose) {
|
||||
if (!match("Content-Length:")) {
|
||||
return badHeader();
|
||||
}
|
||||
} else {
|
||||
if (!scan("Content-Length:")) {
|
||||
return "";
|
||||
}
|
||||
}
|
||||
// Skip whitespace and tabs
|
||||
while (matchAny(" \t")) {
|
||||
}
|
||||
// Parse length
|
||||
size_t len = 0;
|
||||
while (true) {
|
||||
auto c = matchAny("0123456789");
|
||||
if (c == 0) {
|
||||
break;
|
||||
}
|
||||
len *= 10;
|
||||
len += size_t(c) - size_t('0');
|
||||
}
|
||||
if (len == 0) {
|
||||
return "";
|
||||
}
|
||||
|
||||
// Expect \r\n\r\n
|
||||
if (!match("\r\n\r\n")) {
|
||||
return badHeader();
|
||||
}
|
||||
|
||||
// Read message
|
||||
if (!buffer(len)) {
|
||||
return "";
|
||||
}
|
||||
std::string out;
|
||||
out.reserve(len);
|
||||
for (size_t i = 0; i < len; i++) {
|
||||
out.push_back(static_cast<char>(buf.front()));
|
||||
buf.pop_front();
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
bool ContentReader::scan(const uint8_t* seq, size_t len) {
|
||||
while (buffer(len)) {
|
||||
if (match(seq, len)) {
|
||||
return true;
|
||||
}
|
||||
buf.pop_front();
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
bool ContentReader::scan(const char* str) {
|
||||
auto len = strlen(str);
|
||||
return scan(reinterpret_cast<const uint8_t*>(str), len);
|
||||
}
|
||||
|
||||
bool ContentReader::match(const uint8_t* seq, size_t len) {
|
||||
if (!buffer(len)) {
|
||||
return false;
|
||||
}
|
||||
auto it = buf.begin();
|
||||
for (size_t i = 0; i < len; i++, it++) {
|
||||
if (*it != seq[i]) {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
for (size_t i = 0; i < len; i++) {
|
||||
buf.pop_front();
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
bool ContentReader::match(const char* str) {
|
||||
auto len = strlen(str);
|
||||
return match(reinterpret_cast<const uint8_t*>(str), len);
|
||||
}
|
||||
|
||||
char ContentReader::matchAny(const char* chars) {
|
||||
if (!buffer(1)) {
|
||||
return false;
|
||||
}
|
||||
int c = buf.front();
|
||||
if (auto p = strchr(chars, c)) {
|
||||
buf.pop_front();
|
||||
return *p;
|
||||
}
|
||||
return 0;
|
||||
}
|
||||
|
||||
bool ContentReader::buffer(size_t bytes) {
|
||||
if (bytes < buf.size()) {
|
||||
return true;
|
||||
}
|
||||
bytes -= buf.size();
|
||||
while (bytes > 0) {
|
||||
uint8_t chunk[256];
|
||||
auto numWant = std::min(sizeof(chunk), bytes);
|
||||
auto numGot = reader->read(chunk, numWant);
|
||||
if (numGot == 0) {
|
||||
return false;
|
||||
}
|
||||
for (size_t i = 0; i < numGot; i++) {
|
||||
buf.push_back(chunk[i]);
|
||||
}
|
||||
bytes -= numGot;
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
std::string ContentReader::badHeader() {
|
||||
if (on_invalid_data == kClose) {
|
||||
close();
|
||||
}
|
||||
return "";
|
||||
}
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
// ContentWriter
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
ContentWriter::ContentWriter(const std::shared_ptr<Writer>& rhs)
|
||||
: writer(rhs) {}
|
||||
|
||||
ContentWriter& ContentWriter::operator=(ContentWriter&& rhs) noexcept {
|
||||
writer = std::move(rhs.writer);
|
||||
return *this;
|
||||
}
|
||||
|
||||
bool ContentWriter::isOpen() {
|
||||
return writer ? writer->isOpen() : false;
|
||||
}
|
||||
|
||||
void ContentWriter::close() {
|
||||
if (writer) {
|
||||
writer->close();
|
||||
}
|
||||
}
|
||||
|
||||
bool ContentWriter::write(const std::string& msg) const {
|
||||
auto header =
|
||||
std::string("Content-Length: ") + std::to_string(msg.size()) + "\r\n\r\n";
|
||||
return writer->write(header.data(), header.size()) &&
|
||||
writer->write(msg.data(), msg.size());
|
||||
}
|
||||
|
||||
} // namespace dap
|
||||
Loading…
Add table
Add a link
Reference in a new issue