mirror of
https://github.com/kichikuou/xsystem35-sdl2.git
synced 2026-10-09 06:59:55 +03:00
Add support for Debug Adapter Protocol
If -debug_dap flag is given, xsystem35 speaks the Debug Adapter Protocol (https://microsoft.github.io/debug-adapter-protocol/) via stdin/stdout. This enables xsystem35 to work as a backend of VS Code's Debugger (and possibly other debuggers that support DAP).
This commit is contained in:
kichikuou
@@ -0,0 +1,450 @@
|
||||
/*
|
||||
* Copyright (C) 2021 kichikuou <KichikuouChrome@gmail.com>
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation; either version 2 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program; if not, write to the Free Software
|
||||
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
*
|
||||
*/
|
||||
|
||||
#include <stdio.h>
|
||||
#include <stdlib.h>
|
||||
#include <string.h>
|
||||
#include <SDL_mutex.h>
|
||||
#include <SDL_thread.h>
|
||||
#ifdef _WIN32
|
||||
#include <fcntl.h>
|
||||
#include <io.h>
|
||||
#endif
|
||||
|
||||
#include "cjson/cJSON.h"
|
||||
#include "debugger.h"
|
||||
#include "debugger_private.h"
|
||||
#include "debug_symbol.h"
|
||||
#include "system.h"
|
||||
#include "variable.h"
|
||||
|
||||
#define THREAD_ID 1
|
||||
|
||||
static boolean initialized = false;
|
||||
static char *src_dir;
|
||||
|
||||
cJSON *create_source(const char *name) {
|
||||
cJSON *source = cJSON_CreateObject();
|
||||
cJSON_AddStringToObject(source, "name", name);
|
||||
if (src_dir) {
|
||||
char *buf = alloca(strlen(src_dir) + strlen(name) + 2);
|
||||
sprintf(buf, "%s/%s", src_dir, name);
|
||||
cJSON_AddStringToObject(source, "path", buf);
|
||||
}
|
||||
cJSON_AddNumberToObject(source, "sourceReference", 0);
|
||||
return source;
|
||||
}
|
||||
|
||||
static void send_json(cJSON *json) {
|
||||
static int seq = 0;
|
||||
|
||||
cJSON_AddNumberToObject(json, "seq", seq);
|
||||
char *str = cJSON_PrintUnformatted(json);
|
||||
printf("Content-Length: %zu\r\n\r\n%s", strlen(str), str);
|
||||
fflush(stdout);
|
||||
free(str);
|
||||
cJSON_free(json);
|
||||
}
|
||||
|
||||
static void emit_initialized_event() {
|
||||
cJSON *event = cJSON_CreateObject();
|
||||
cJSON_AddStringToObject(event, "type", "event");
|
||||
cJSON_AddStringToObject(event, "event", "initialized");
|
||||
send_json(event);
|
||||
}
|
||||
|
||||
static void emit_terminated_event() {
|
||||
cJSON *event = cJSON_CreateObject();
|
||||
cJSON_AddStringToObject(event, "type", "event");
|
||||
cJSON_AddStringToObject(event, "event", "terminated");
|
||||
send_json(event);
|
||||
}
|
||||
|
||||
static void emit_stop_event() {
|
||||
const char *reason;
|
||||
switch (dbg_state) {
|
||||
case DBG_STOPPED_ENTRY: reason = "entry"; break;
|
||||
case DBG_STOPPED_STEP: reason = "step"; break;
|
||||
case DBG_STOPPED_NEXT: reason = "step"; break;
|
||||
case DBG_STOPPED_BREAKPOINT: reason = "breakpoint"; break;
|
||||
case DBG_STOPPED_INTERRUPT: reason = "pause"; break;
|
||||
default: reason = "unknown"; break;
|
||||
}
|
||||
|
||||
cJSON *event = cJSON_CreateObject(), *body;
|
||||
cJSON_AddStringToObject(event, "type", "event");
|
||||
cJSON_AddStringToObject(event, "event", "stopped");
|
||||
cJSON_AddItemToObjectCS(event, "body", body = cJSON_CreateObject());
|
||||
cJSON_AddStringToObject(body, "reason", reason);
|
||||
cJSON_AddNumberToObject(body, "threadId", THREAD_ID); // needed?
|
||||
send_json(event);
|
||||
}
|
||||
|
||||
static void cmd_initialize(cJSON *args, cJSON *resp) {
|
||||
cJSON *body;
|
||||
cJSON_AddBoolToObject(resp, "success", true);
|
||||
cJSON_AddItemToObjectCS(resp, "body", body = cJSON_CreateObject());
|
||||
cJSON_AddBoolToObject(body, "supportsConfigurationDoneRequest", true);
|
||||
cJSON_AddBoolToObject(body, "supportsEvaluateForHovers", true);
|
||||
}
|
||||
|
||||
static void cmd_launch(cJSON *args, cJSON *resp) {
|
||||
cJSON *srcDir = cJSON_GetObjectItemCaseSensitive(args, "srcDir");
|
||||
if (cJSON_IsString(srcDir))
|
||||
src_dir = strdup(srcDir->valuestring);
|
||||
cJSON_AddBoolToObject(resp, "success", true);
|
||||
|
||||
emit_initialized_event();
|
||||
initialized = true;
|
||||
}
|
||||
|
||||
static void cmd_configurationDone(cJSON *args, cJSON *resp) {
|
||||
cJSON_AddBoolToObject(resp, "success", true);
|
||||
}
|
||||
|
||||
static void cmd_stackTrace(cJSON *args, cJSON *resp) {
|
||||
StackTrace *trace = dbg_stack_trace();
|
||||
|
||||
cJSON *body, *stackFrames;
|
||||
cJSON_AddBoolToObject(resp, "success", true);
|
||||
cJSON_AddItemToObjectCS(resp, "body", body = cJSON_CreateObject());
|
||||
cJSON_AddItemToObjectCS(body, "stackFrames", stackFrames = cJSON_CreateArray());
|
||||
for (int i = 0; i < trace->nr_frame; i++) {
|
||||
StackFrame *frame = &trace->frames[i];
|
||||
cJSON *item = cJSON_CreateObject();
|
||||
cJSON_AddItemToArray(stackFrames, item);
|
||||
cJSON_AddNumberToObject(item, "id", i);
|
||||
cJSON_AddStringToObject(item, "name", frame->name);
|
||||
cJSON_AddItemToObjectCS(item, "source", create_source(frame->src));
|
||||
cJSON_AddNumberToObject(item, "line", frame->line);
|
||||
cJSON_AddNumberToObject(item, "column", 0);
|
||||
}
|
||||
cJSON_AddNumberToObject(body, "totalFrames", trace->nr_frame);
|
||||
|
||||
free(trace);
|
||||
}
|
||||
|
||||
static void cmd_setBreakpoints(cJSON *args, cJSON *resp) {
|
||||
cJSON *source = cJSON_GetObjectItemCaseSensitive(args, "source");
|
||||
cJSON *source_name = cJSON_GetObjectItemCaseSensitive(source, "name");
|
||||
cJSON *lines = cJSON_GetObjectItemCaseSensitive(args, "lines");
|
||||
if (!cJSON_IsString(source_name) || !cJSON_IsArray(lines)) {
|
||||
cJSON_AddBoolToObject(resp, "success", false);
|
||||
// TODO: add message
|
||||
return;
|
||||
}
|
||||
const char *filename = source_name->valuestring;
|
||||
int page = dsym_src2page(symbols, filename);
|
||||
|
||||
dbg_delete_breakpoints_in_page(page);
|
||||
|
||||
cJSON *body, *breakpoints;
|
||||
cJSON_AddBoolToObject(resp, "success", true);
|
||||
cJSON_AddItemToObjectCS(resp, "body", body = cJSON_CreateObject());
|
||||
cJSON_AddItemToObjectCS(body, "breakpoints", breakpoints = cJSON_CreateArray());
|
||||
|
||||
cJSON *line;
|
||||
cJSON_ArrayForEach(line, lines) {
|
||||
cJSON *item = cJSON_CreateObject();
|
||||
cJSON_AddItemToArray(breakpoints, item);
|
||||
|
||||
int line_no = line->valueint;
|
||||
int addr = dsym_line2addr(symbols, page, line_no);
|
||||
if (page < 0) {
|
||||
fprintf(stderr, "No source file named %s.\n", filename);
|
||||
cJSON_AddBoolToObject(item, "verified", false);
|
||||
continue;
|
||||
}
|
||||
if (addr < 0) {
|
||||
fprintf(stderr, "No line %d in file %s.\n", line_no, filename);
|
||||
cJSON_AddBoolToObject(item, "verified", false);
|
||||
continue;
|
||||
}
|
||||
Breakpoint *bp = dbg_set_breakpoint(page, addr, false);
|
||||
if (!bp) {
|
||||
fprintf(stderr, "Failed to set breakpoint at %d:0x%x\n", page, addr);
|
||||
cJSON_AddBoolToObject(item, "verified", false);
|
||||
continue;
|
||||
}
|
||||
line_no = dsym_addr2line(symbols, page, addr);
|
||||
cJSON_AddNumberToObject(item, "id", bp->no);
|
||||
cJSON_AddBoolToObject(item, "verified", true);
|
||||
cJSON_AddItemToObjectCS(item, "source", create_source(filename));
|
||||
cJSON_AddNumberToObject(item, "line", line_no);
|
||||
}
|
||||
}
|
||||
|
||||
static void cmd_evaluate(cJSON *args, cJSON *resp) {
|
||||
cJSON *expression = cJSON_GetObjectItemCaseSensitive(args, "expression");
|
||||
if (!cJSON_IsString(expression)) {
|
||||
cJSON_AddBoolToObject(resp, "success", false);
|
||||
// TODO: add message
|
||||
return;
|
||||
}
|
||||
const char *varname = expression->valuestring;
|
||||
int var = dbg_lookup_var(varname);
|
||||
if (var < 0) {
|
||||
fprintf(stderr, "Unrecognized variable name \"%s\".\n", varname);
|
||||
// TODO: add message
|
||||
cJSON_AddBoolToObject(resp, "success", false);
|
||||
return;
|
||||
}
|
||||
|
||||
char result[20];
|
||||
sprintf(result, "%d", sysVar[var]);
|
||||
|
||||
cJSON *body;
|
||||
cJSON_AddBoolToObject(resp, "success", true);
|
||||
cJSON_AddItemToObjectCS(resp, "body", body = cJSON_CreateObject());
|
||||
cJSON_AddStringToObject(body, "result", result);
|
||||
cJSON_AddNumberToObject(body, "variablesReference", 0);
|
||||
}
|
||||
|
||||
static void cmd_continue(cJSON *args, cJSON *resp) {
|
||||
cJSON_AddBoolToObject(resp, "success", true);
|
||||
}
|
||||
|
||||
static void cmd_pause(cJSON *args, cJSON *resp) {
|
||||
dbg_state = DBG_STOPPED_INTERRUPT;
|
||||
cJSON_AddBoolToObject(resp, "success", true);
|
||||
}
|
||||
|
||||
static void cmd_stepIn(cJSON *args, cJSON *resp) {
|
||||
dbg_step();
|
||||
cJSON_AddBoolToObject(resp, "success", true);
|
||||
}
|
||||
|
||||
static void cmd_next(cJSON *args, cJSON *resp) {
|
||||
dbg_next();
|
||||
cJSON_AddBoolToObject(resp, "success", true);
|
||||
}
|
||||
|
||||
static void cmd_threads(cJSON *args, cJSON *resp) {
|
||||
cJSON *body, *threads, *thread;
|
||||
cJSON_AddBoolToObject(resp, "success", true);
|
||||
cJSON_AddItemToObjectCS(resp, "body", body = cJSON_CreateObject());
|
||||
cJSON_AddItemToObjectCS(body, "threads", threads = cJSON_CreateArray());
|
||||
cJSON_AddItemToArray(threads, thread = cJSON_CreateObject());
|
||||
cJSON_AddNumberToObject(thread, "id", THREAD_ID);
|
||||
cJSON_AddStringToObject(thread, "name", "main thread");
|
||||
}
|
||||
|
||||
static void cmd_scopes(cJSON *args, cJSON *resp) {
|
||||
cJSON *body;
|
||||
cJSON_AddBoolToObject(resp, "success", true);
|
||||
cJSON_AddItemToObjectCS(resp, "body", body = cJSON_CreateObject());
|
||||
cJSON_AddItemToObjectCS(body, "scopes", cJSON_CreateArray());
|
||||
}
|
||||
|
||||
static void cmd_disconnect(cJSON *args, cJSON *resp) {
|
||||
cJSON_AddBoolToObject(resp, "success", true);
|
||||
send_json(resp);
|
||||
sys_exit(0);
|
||||
}
|
||||
|
||||
static boolean handle_request(cJSON *request) {
|
||||
boolean continue_repl = true;
|
||||
|
||||
cJSON *resp = cJSON_CreateObject();
|
||||
cJSON_AddStringToObject(resp, "type", "response");
|
||||
cJSON *request_seq = cJSON_DetachItemFromObjectCaseSensitive(request, "seq");
|
||||
cJSON_AddItemToObjectCS(resp, "request_seq", request_seq);
|
||||
cJSON *command = cJSON_DetachItemFromObjectCaseSensitive(request, "command");
|
||||
cJSON_AddItemToObjectCS(resp, "command", command);
|
||||
cJSON *args = cJSON_GetObjectItemCaseSensitive(request, "arguments");
|
||||
|
||||
if (!cJSON_IsString(command)) {
|
||||
fprintf(stderr, "protocol error: command is not a string\n");
|
||||
// FIXME: return an error response
|
||||
cJSON_free(resp);
|
||||
return continue_repl;
|
||||
}
|
||||
|
||||
if (!strcmp(command->valuestring, "initialize")) {
|
||||
cmd_initialize(args, resp);
|
||||
} else if (!strcmp(command->valuestring, "launch")) {
|
||||
cmd_launch(args, resp);
|
||||
} else if (!strcmp(command->valuestring, "configurationDone")) {
|
||||
cmd_configurationDone(args, resp);
|
||||
} else if (!strcmp(command->valuestring, "continue")) {
|
||||
cmd_continue(args, resp);
|
||||
continue_repl = false;
|
||||
} else if (!strcmp(command->valuestring, "stackTrace")) {
|
||||
cmd_stackTrace(args, resp);
|
||||
} else if (!strcmp(command->valuestring, "stepIn")) {
|
||||
cmd_stepIn(args, resp);
|
||||
continue_repl = false;
|
||||
} else if (!strcmp(command->valuestring, "next")) {
|
||||
cmd_next(args, resp);
|
||||
continue_repl = false;
|
||||
} else if (!strcmp(command->valuestring, "pause")) {
|
||||
cmd_pause(args, resp);
|
||||
} else if (!strcmp(command->valuestring, "evaluate")) {
|
||||
cmd_evaluate(args, resp);
|
||||
} else if (!strcmp(command->valuestring, "setBreakpoints")) {
|
||||
cmd_setBreakpoints(args, resp);
|
||||
} else if (!strcmp(command->valuestring, "threads")) {
|
||||
cmd_threads(args, resp);
|
||||
} else if (!strcmp(command->valuestring, "scopes")) {
|
||||
cmd_scopes(args, resp);
|
||||
} else if (!strcmp(command->valuestring, "disconnect")) {
|
||||
cmd_disconnect(args, resp);
|
||||
} else {
|
||||
fprintf(stderr, "unknown command \"%s\"\n", command->valuestring);
|
||||
}
|
||||
send_json(resp);
|
||||
return continue_repl;
|
||||
}
|
||||
|
||||
static boolean handle_message(char *msg) {
|
||||
cJSON *json = cJSON_Parse(msg);
|
||||
cJSON *type = cJSON_GetObjectItemCaseSensitive(json, "type");
|
||||
boolean continue_repl = true;
|
||||
if (cJSON_IsString(type) && !strcmp(type->valuestring, "request"))
|
||||
continue_repl = handle_request(json);
|
||||
cJSON_free(json);
|
||||
free(msg);
|
||||
return continue_repl;
|
||||
}
|
||||
|
||||
struct cmdq_elem {
|
||||
char *cmd;
|
||||
struct cmdq_elem *next;
|
||||
};
|
||||
|
||||
struct {
|
||||
SDL_mutex *mutex;
|
||||
SDL_cond *cond_nonempty;
|
||||
struct cmdq_elem *head;
|
||||
struct cmdq_elem *last;
|
||||
} cmd_queue;
|
||||
|
||||
static boolean cmdq_isempty(void) {
|
||||
return !cmd_queue.head;
|
||||
}
|
||||
|
||||
static void cmdq_enqueue(char *cmd) {
|
||||
struct cmdq_elem *e = malloc(sizeof(struct cmdq_elem));
|
||||
e->cmd = cmd;
|
||||
e->next = NULL;
|
||||
|
||||
SDL_LockMutex(cmd_queue.mutex);
|
||||
if (!cmd_queue.head) {
|
||||
cmd_queue.head = cmd_queue.last = e;
|
||||
} else {
|
||||
cmd_queue.last->next = e;
|
||||
cmd_queue.last = e;
|
||||
}
|
||||
SDL_UnlockMutex(cmd_queue.mutex);
|
||||
SDL_CondSignal(cmd_queue.cond_nonempty);
|
||||
}
|
||||
|
||||
static char *cmdq_dequeue(void) {
|
||||
SDL_LockMutex(cmd_queue.mutex);
|
||||
while (!cmd_queue.head)
|
||||
SDL_CondWait(cmd_queue.cond_nonempty, cmd_queue.mutex);
|
||||
|
||||
struct cmdq_elem *e = cmd_queue.head;
|
||||
cmd_queue.head = e->next;
|
||||
if (!e->next)
|
||||
cmd_queue.last = NULL;
|
||||
|
||||
SDL_UnlockMutex(cmd_queue.mutex);
|
||||
|
||||
char *cmd = e->cmd;
|
||||
free(e);
|
||||
return cmd;
|
||||
}
|
||||
|
||||
static int read_command_thread(void *data) {
|
||||
int content_length = -1;
|
||||
char header[512];
|
||||
while (fgets(header, sizeof(header), stdin)) {
|
||||
if (sscanf(header, "Content-Length: %d", &content_length) == 1) {
|
||||
continue;
|
||||
} else if ((header[0] == '\r' && header[1] == '\n') || header[0] == '\n') {
|
||||
if (content_length < 0) {
|
||||
fprintf(stderr, "Debug Adapter Protocol error: no Content-Length header\n");
|
||||
continue;
|
||||
}
|
||||
char *buf = malloc(content_length);
|
||||
fread(buf, content_length, 1, stdin);
|
||||
cmdq_enqueue(buf);
|
||||
content_length = -1;
|
||||
} else {
|
||||
fprintf(stderr, "Unknown Debug Adapter Protocol header: %s", header);
|
||||
}
|
||||
}
|
||||
cmdq_enqueue(NULL); // EOF
|
||||
return 0;
|
||||
}
|
||||
|
||||
static void dbg_dap_init(void) {
|
||||
cmd_queue.mutex = SDL_CreateMutex();
|
||||
cmd_queue.cond_nonempty = SDL_CreateCond();
|
||||
|
||||
#ifdef _WIN32
|
||||
_setmode(_fileno(stdin), _O_BINARY);
|
||||
_setmode(_fileno(stdout), _O_BINARY);
|
||||
#endif
|
||||
|
||||
SDL_CreateThread(read_command_thread, "Debugger", NULL);
|
||||
|
||||
while (!initialized) {
|
||||
char *msg = cmdq_dequeue();
|
||||
if (!msg)
|
||||
break;
|
||||
handle_message(msg);
|
||||
}
|
||||
}
|
||||
|
||||
static void dbg_dap_quit(void) {
|
||||
emit_terminated_event();
|
||||
}
|
||||
|
||||
static void dbg_dap_repl(void) {
|
||||
emit_stop_event();
|
||||
dbg_state = DBG_RUNNING;
|
||||
|
||||
boolean continue_repl = true;
|
||||
while (continue_repl) {
|
||||
char *msg = cmdq_dequeue();
|
||||
if (!msg)
|
||||
break;
|
||||
continue_repl = handle_message(msg);
|
||||
}
|
||||
}
|
||||
|
||||
static void dbg_dap_onsleep(void) {
|
||||
while (!cmdq_isempty()) {
|
||||
char *msg = cmdq_dequeue();
|
||||
if (!msg)
|
||||
break;
|
||||
handle_message(msg);
|
||||
}
|
||||
if (dbg_state == DBG_STOPPED_INTERRUPT)
|
||||
dbg_main();
|
||||
}
|
||||
|
||||
DebuggerImpl dbg_dap_impl = {
|
||||
.init = dbg_dap_init,
|
||||
.quit = dbg_dap_quit,
|
||||
.repl = dbg_dap_repl,
|
||||
.onsleep = dbg_dap_onsleep,
|
||||
};
|
||||
Reference in New Issue
Block a user