Stub of gadp server.

Author: nicolasnoble

src/core/gadp-server.cc

@@ -0,0 +1,215 @@
+/***************************************************************************
+ *   Copyright (C) 2021 PCSX-Redux authors                                 *
+ *                                                                         *
+ *   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.,                                       *
+ *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
+ ***************************************************************************/
+
+#include "core/gadp-server.h"
+
+#include <assert.h>
+
+#include "core/debug.h"
+#include "core/misc.h"
+#include "core/psxemulator.h"
+#include "core/psxmem.h"
+#include "core/r3000a.h"
+#include "core/system.h"
+#include "support/protobuf.h"
+#include "uvw.hpp"
+
+enum class ErrorCode {
+    EC_UNKNOWN = 0,
+    EC_BAD_REQUEST = 1,
+    EC_NO_VERSION = 2,
+    EC_NO_OBJECT = 3,
+    EC_NO_INTERFACE = 4,
+    EC_BAD_ARGUMENT = 5,
+    EC_BAD_ADDRESS = 6,
+    EC_NOT_SUPPORTED = 7,
+    EC_MEMORY_ACCESS = 8,
+    EC_REGISTER_ACCESS = 9,
+    EC_USER_ERROR = 10,
+    EC_MODEL_ACCESS = 11,
+};
+
+enum class StepKind {
+    SK_INTO = 0,
+    SK_ADVANCE = 1,
+    SK_FINISH = 2,
+    SK_LINE = 3,
+    SK_OVER = 4,
+    SK_OVER_LINE = 5,
+    SK_SKIP = 6,
+    SK_RETURN = 7,
+    SK_UNTIL = 8,
+};
+
+enum class AttachKind {
+    AK_BY_OBJECT_REF = 0,
+    AK_BY_ID = 1,
+};
+
+enum class ExecutionState {
+    ES_INACTIVE = 0,
+    ES_ACTIVE = 1,
+    ES_STOPPED = 2,
+    ES_RUNNING = 3,
+    ES_TERMINATED = 4,
+};
+
+enum class PrimitiveKind {
+    PK_UNDEFINED = 0,
+    PK_VOID = 1,
+    PK_UINT = 2,
+    PK_SINT = 3,
+    PK_FLOAT = 4,
+    PK_COMPLEX = 5,
+};
+
+enum class UpdateMode {
+    UM_UNSOLICITED = 0,
+    UM_SOLICITED = 1,
+    UM_FIXED = 2,
+};
+
+enum class ValueType {
+    VT_VOID = 0,
+    VT_BOOL = 1,
+    VT_INT = 2,
+    VT_LONG = 3,
+    VT_FLOAT = 4,
+    VT_DOUBLE = 5,
+    VT_BYTES = 6,
+    VT_STRING = 7,
+    VT_STRING_LIST = 8,
+    VT_ADDRESS = 9,
+    VT_RANGE = 10,
+    VT_BREAK_KIND_SET = 11,
+    VT_EXECUTION_STATE = 12,
+    VT_STEP_KIND_SET = 13,
+    VT_PRIMITIVE_KIND = 14,
+    VT_DATA_TYPE = 15,
+    VT_UPDATE_MODE = 16,
+    VT_PATH = 17,
+    VT_PATH_LIST = 18,
+    VT_TYPE = 19,
+    VT_ATTACH_KIND_SET = 20,
+};
+
+enum class TargetEventType {
+    TET_STOPPED = 0,
+    TET_RUNNING = 1,
+    TET_PROCESS_CREATED = 2,
+    TET_PROCESS_EXITED = 3,
+    TET_THREAD_CREATED = 4,
+    TET_THREAD_EXITED = 5,
+    TET_MODULE_LOADED = 6,
+    TET_MODULE_UNLOADED = 7,
+    TET_BREAKPOINT_HIT = 8,
+    TET_STEP_COMPLETED = 9,
+    TET_EXCEPTION = 10,
+    TET_SIGNAL = 11,
+};
+
+PCSX::GadpServer::GadpServer() : m_listener(g_system->m_eventBus) {
+    m_listener.listen<Events::SettingsLoaded>([this](const auto& event) {
+        if (g_emulator->settings.get<Emulator::SettingGadpServer>()) {
+            startServer(g_emulator->settings.get<Emulator::SettingGadpServerPort>());
+        }
+    });
+    m_listener.listen<Events::Quitting>([this](const auto& event) {
+        if (m_serverStatus == SERVER_STARTED) stopServer();
+    });
+}
+
+void PCSX::GadpServer::stopServer() {
+    assert(m_serverStatus == SERVER_STARTED);
+    for (auto& client : m_clients) client.close();
+    m_server->close();
+}
+
+void PCSX::GadpServer::startServer(int port) {
+    assert(m_serverStatus == SERVER_STOPPED);
+    m_server = g_emulator->m_loop->resource<uvw::TCPHandle>();
+    m_server->on<uvw::ListenEvent>([this](const uvw::ListenEvent&, uvw::TCPHandle& srv) { onNewConnection(); });
+    m_server->on<uvw::CloseEvent>(
+        [this](const uvw::CloseEvent&, uvw::TCPHandle& srv) { m_serverStatus = SERVER_STOPPED; });
+    m_server->on<uvw::ErrorEvent>(
+        [this](const uvw::ErrorEvent& event, uvw::TCPHandle& srv) { m_gotError = event.what(); });
+    m_gotError = "";
+    m_server->bind("0.0.0.0", port);
+    if (!m_gotError.empty()) {
+        g_system->printf("Error while trying to bind to port %i: %s\n", port, m_gotError.c_str());
+        m_server->close();
+        return;
+    }
+    m_server->listen();
+    if (!m_gotError.empty()) {
+        g_system->printf("Error while trying to listen to port %i: %s\n", port, m_gotError.c_str());
+        m_server->close();
+        return;
+    }
+
+    m_serverStatus = SERVER_STARTED;
+}
+
+void PCSX::GadpServer::onNewConnection() {
+    GadpClient* client = new GadpClient(m_server);
+    m_clients.push_back(client);
+    client->accept(m_server);
+}
+
+PCSX::GadpClient::GadpClient(std::shared_ptr<uvw::TCPHandle> srv)
+    : m_tcp(srv->loop().resource<uvw::TCPHandle>()), m_listener(g_system->m_eventBus) {
+    m_listener.listen<Events::ExecutionFlow::Pause>([this](const auto& event) {});
+    m_listener.listen<Events::ExecutionFlow::ShellReached>([this](const auto& event) {});
+}
+
+void PCSX::GadpClient::processData(const Slice& slice) {
+    const uint8_t* ptr = reinterpret_cast<const uint8_t*>(slice.data());
+    auto size = slice.size();
+    int v = 0;
+
+    while (size) {
+        switch (m_state) {
+            case WAIT_FOR_LEN:
+                m_lenBuffer[m_length++] = *ptr++;
+                size--;
+                if (m_length == 4) {
+                    m_length = m_lenBuffer[0] | (m_lenBuffer[1] << 8) | (m_lenBuffer[2] << 16) | (m_lenBuffer[3] << 24);
+                    m_protoBuffer.clear();
+                    if (m_length != 0) {
+                        m_state = READING_DATA;
+                    } else {
+                        // process empty proto
+                    }
+                }
+                break;
+            case READING_DATA: {
+                auto copySize = std::min(size, m_length);
+                m_protoBuffer += std::string((const char*)ptr, copySize);
+                ptr += copySize;
+                size -= copySize;
+                m_length -= copySize;
+
+                if (m_length == 0) {
+                    m_state = WAIT_FOR_LEN;
+                    // process proto
+                }
+            }
+        }
+    }
+}

src/core/gadp-server.h

@@ -0,0 +1,124 @@
+/***************************************************************************
+ *   Copyright (C) 2021 PCSX-Redux authors                                 *
+ *                                                                         *
+ *   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.,                                       *
+ *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
+ ***************************************************************************/
+
+#pragma once
+
+#include <assert.h>
+
+#include "support/eventbus.h"
+#include "support/list.h"
+#include "support/slice.h"
+#include "uvw.hpp"
+
+namespace PCSX {
+
+class GadpClient : public Intrusive::List<GadpClient>::Node {
+  public:
+    GadpClient(std::shared_ptr<uvw::TCPHandle> srv);
+    ~GadpClient() { assert(m_requests.size() == 0); }
+    typedef Intrusive::List<GadpClient> ListType;
+
+    void accept(std::shared_ptr<uvw::TCPHandle> srv) {
+        assert(m_status == CLOSED);
+        m_tcp->on<uvw::CloseEvent>([this](const uvw::CloseEvent&, uvw::TCPHandle&) { delete this; });
+        m_tcp->on<uvw::EndEvent>([this](const uvw::EndEvent&, uvw::TCPHandle&) { close(); });
+        m_tcp->on<uvw::ErrorEvent>([this](const uvw::ErrorEvent&, uvw::TCPHandle&) { close(); });
+        m_tcp->on<uvw::DataEvent>([this](const uvw::DataEvent& event, uvw::TCPHandle&) { read(event); });
+        m_tcp->on<uvw::WriteEvent>([this](const uvw::WriteEvent&, uvw::TCPHandle&) {
+            auto top = m_requests.begin();
+            if (top == m_requests.end()) return;
+            top->gotWriteEvent();
+        });
+        srv->accept(*m_tcp);
+        m_tcp->read();
+        m_status = OPEN;
+    }
+    void close() {
+        if (m_status != OPEN) return;
+        m_status = CLOSING;
+        m_tcp->close();
+        m_requests.destroyAll();
+    }
+
+  private:
+    void write(const Slice& slice) {
+        auto* req = new WriteRequest();
+        req->m_slice = slice;
+        req->enqueue(this);
+    }
+
+    struct WriteRequest : public Intrusive::List<WriteRequest>::Node {
+        void enqueue(GadpClient* client) {
+            m_outstanding = 1;
+            client->m_requests.push_back(this);
+            client->m_tcp->write(static_cast<char*>(const_cast<void*>(m_slice.data())), m_slice.size());
+        }
+        void gotWriteEvent() {
+            if (--m_outstanding == 0) delete this;
+        }
+        uv_write_t m_req;
+        Slice m_slice;
+        unsigned m_outstanding;
+    };
+    friend struct WriteRequest;
+    Intrusive::List<WriteRequest> m_requests;
+    void read(const uvw::DataEvent& event) {
+        Slice slice;
+        slice.borrow(event.data.get(), event.length);
+
+        processData(slice);
+    }
+    void processData(const Slice& slice);
+
+    std::shared_ptr<uvw::TCPHandle> m_tcp;
+    enum { CLOSED, OPEN, CLOSING } m_status = CLOSED;
+
+    EventBus::Listener m_listener;
+
+    std::string m_protoBuffer;
+    enum {
+        WAIT_FOR_LEN,
+        READING_DATA,
+    } m_state = WAIT_FOR_LEN;
+    uint8_t m_lenBuffer[4];
+    uint32_t m_length = 0;
+};
+
+class GadpServer {
+  public:
+    GadpServer();
+    enum GadpServerStatus {
+        SERVER_STOPPED,
+        SERVER_STARTED,
+    };
+    GadpServerStatus getServerStatus() { return m_serverStatus; }
+
+    void startServer(int port = 15432);
+    void stopServer();
+
+  private:
+    void onNewConnection();
+    GadpServerStatus m_serverStatus = SERVER_STOPPED;
+    std::shared_ptr<uvw::TCPHandle> m_server;
+    GadpClient::ListType m_clients;
+    EventBus::Listener m_listener;
+    std::string m_gotError;
+};
+
+}  // namespace PCSX

src/core/psxemulator.cc

@@ -22,6 +22,7 @@
 #include "core/cdrom.h"
 #include "core/cheat.h"
 #include "core/debug.h"
+#include "core/gadp-server.h"
 #include "core/gdb-server.h"
 #include "core/gpu.h"
 #include "core/gte.h"

src/core/psxemulator.h

@@ -85,6 +85,7 @@ class CDRom;
 class Cheats;
 class Counters;
 class Debug;
+class GadpServer;
 class GdbServer;
 class WebServer;
 class GPU;
@@ -141,6 +142,8 @@ class Emulator {
     typedef SettingString<TYPESTRING("Locale")> SettingLocale;
     typedef Setting<bool, TYPESTRING("Mcd1Inserted"), true> SettingMcd1Inserted;
     typedef Setting<bool, TYPESTRING("Mcd2Inserted"), true> SettingMcd2Inserted;
+    typedef Setting<bool, TYPESTRING("GadpServer"), false> SettingGadpServer;
+    typedef Setting<int, TYPESTRING("GadpServerPort"), 15432> SettingGadpServerPort;
     typedef Setting<bool, TYPESTRING("GdbServer"), false> SettingGdbServer;
     typedef Setting<bool, TYPESTRING("GdbManifest"), true> SettingGdbManifest;
     typedef Setting<int, TYPESTRING("GdbServerPort"), 3333> SettingGdbServerPort;
@@ -152,9 +155,9 @@ class Emulator {
     Settings<SettingStdout, SettingLogfile, SettingMcd1, SettingMcd2, SettingBios, SettingPpfDir, SettingPsxExe,
              SettingXa, SettingSioIrq, SettingSpuIrq, SettingBnWMdec, SettingAutoVideo, SettingVideo, SettingCDDA,
              SettingFastBoot, SettingDebug, SettingVerbose, SettingRCntFix, SettingIsoPath, SettingLocale,
-             SettingMcd1Inserted, SettingMcd2Inserted, SettingBiosOverlay, SettingGdbServer, SettingGdbManifest,
-             SettingGdbServerPort, SettingGdbServerTrace, SettingWebServer, SettingWebServerPort, SettingDynarec,
-             Setting8MB>
+             SettingMcd1Inserted, SettingMcd2Inserted, SettingBiosOverlay, SettingGadpServer, SettingGadpServerPort,
+             SettingGdbServer, SettingGdbManifest, SettingGdbServerPort, SettingGdbServerTrace, SettingWebServer,
+             SettingWebServerPort, SettingDynarec, Setting8MB>
         settings;
     class PcsxConfig {
       public:
@@ -207,6 +210,7 @@ class Emulator {
     std::unique_ptr<Cheats> m_cheats;
     std::unique_ptr<MDEC> m_mdec;
     std::unique_ptr<GPU> m_gpu;
+    std::unique_ptr<GadpServer> m_gadpServer;
     std::unique_ptr<GdbServer> m_gdbServer;
     std::unique_ptr<WebServer> m_webServer;
     std::unique_ptr<Debug> m_debug;