WCH RISC-V software breakpoints, and a few other bits of refactoring/tidying

2024-12-05 23:09:01 +00:00
parent 966244a01a
commit 33ed399337
55 changed files with 1530 additions and 686 deletions
--- a/src/DebugServer/Gdb/RiscVGdb/CommandPackets/SetBreakpoint.cpp
+++ b/src/DebugServer/Gdb/RiscVGdb/CommandPackets/SetBreakpoint.cpp
@@ -0,0 +1,103 @@
+#include "SetBreakpoint.hpp"
+
+#include <string>
+
+#include "src/DebugServer/Gdb/ResponsePackets/OkResponsePacket.hpp"
+#include "src/DebugServer/Gdb/ResponsePackets/EmptyResponsePacket.hpp"
+#include "src/DebugServer/Gdb/ResponsePackets/ErrorResponsePacket.hpp"
+
+#include "src/Targets/TargetBreakpoint.hpp"
+
+#include "src/Services/StringService.hpp"
+
+#include "src/Logger/Logger.hpp"
+#include "src/Exceptions/Exception.hpp"
+
+namespace DebugServer::Gdb::RiscVGdb::CommandPackets
+{
+    using Services::TargetControllerService;
+
+    using ResponsePackets::OkResponsePacket;
+    using ResponsePackets::ErrorResponsePacket;
+    using ResponsePackets::EmptyResponsePacket;
+
+    using ::Exceptions::Exception;
+
+    SetBreakpoint::SetBreakpoint(const RawPacket& rawPacket)
+        : CommandPacket(rawPacket)
+    {
+        const auto packetString = std::string{this->data.begin(), this->data.end()};
+
+        if (packetString.size() < 6) {
+            throw Exception{"Unexpected SetBreakpoint packet size"};
+        }
+
+        // Z0 = SW breakpoint, Z1 = HW breakpoint
+        this->type = (packetString[1] == '0')
+            ? BreakpointType::SOFTWARE_BREAKPOINT
+            : (packetString[1] == '1') ? BreakpointType::HARDWARE_BREAKPOINT : BreakpointType::UNKNOWN;
+
+        const auto firstCommaPos = packetString.find_first_of(',');
+        const auto secondCommaPos = packetString.find_first_of(',', firstCommaPos + 1);
+        if (firstCommaPos == std::string::npos || secondCommaPos == std::string::npos) {
+            throw Exception{"Invalid SetBreakpoint packet"};
+        }
+
+        const auto addressString = packetString.substr(firstCommaPos + 1, secondCommaPos - firstCommaPos - 1);
+        const auto sizeString = packetString.substr(
+            secondCommaPos + 1,
+            packetString.find_first_of(';', secondCommaPos) - secondCommaPos - 1
+        );
+
+        this->address = Services::StringService::toUint32(addressString, 16);
+        this->size = Services::StringService::toUint32(sizeString, 10);
+    }
+
+    void SetBreakpoint::handle(
+        DebugSession& debugSession,
+        const RiscVGdbTargetDescriptor& gdbTargetDescriptor,
+        const Targets::TargetDescriptor&,
+        TargetControllerService& targetControllerService
+    ) {
+        Logger::info("Handling SetBreakpoint packet");
+
+        try {
+            if (this->type == BreakpointType::UNKNOWN) {
+                Logger::debug(
+                    "Rejecting breakpoint at address " + std::to_string(this->address)
+                        + " - unsupported breakpoint type"
+                );
+                debugSession.connection.writePacket(EmptyResponsePacket{});
+                return;
+            }
+
+            if (this->type == BreakpointType::SOFTWARE_BREAKPOINT && this->size != 2 && this->size != 4) {
+                throw Exception{"Invalid breakpoint size - expected 2 or 4, got " + std::to_string(this->size)};
+            }
+
+            const auto memorySegmentDescriptors = gdbTargetDescriptor.systemAddressSpaceDescriptor.getIntersectingMemorySegmentDescriptors(
+                Targets::TargetMemoryAddressRange{this->address, this->address + this->size - 1}
+            );
+
+            if (memorySegmentDescriptors.size() != 1) {
+                throw Exception{
+                    memorySegmentDescriptors.empty()
+                        ? "Invalid breakpoint address - no containing memory segments found for the given address"
+                        : "Invalid breakpoint address - the address range intersects with multiple memory segments"
+                };
+            }
+
+            debugSession.setExternalBreakpoint(
+                gdbTargetDescriptor.systemAddressSpaceDescriptor,
+                *(memorySegmentDescriptors.front()),
+                this->address,
+                this->size, targetControllerService
+            );
+            debugSession.connection.writePacket(OkResponsePacket{});
+
+        } catch (const Exception& exception) {
+            Logger::error("Failed to set breakpoint on target - " + exception.getMessage());
+            debugSession.connection.writePacket(ErrorResponsePacket{});
+        }
+    }
+}