From 904ab1982304f1d2fa54d45fce7621788a594c8e Mon Sep 17 00:00:00 2001 From: Michael Scire Date: Fri, 23 Jul 2021 05:29:39 -0700 Subject: [PATCH] dmnt: implement remaining basic gdbstub packets --- .../dmnt.gen2/source/dmnt2_debug_process.cpp | 9 + .../dmnt.gen2/source/dmnt2_debug_process.hpp | 2 + .../source/dmnt2_gdb_server_impl.cpp | 516 +++++++++++++++++- .../source/dmnt2_gdb_server_impl.hpp | 16 + 4 files changed, 541 insertions(+), 2 deletions(-) diff --git a/stratosphere/dmnt.gen2/source/dmnt2_debug_process.cpp b/stratosphere/dmnt.gen2/source/dmnt2_debug_process.cpp index 31efdb5cb..4ef9432ff 100644 --- a/stratosphere/dmnt.gen2/source/dmnt2_debug_process.cpp +++ b/stratosphere/dmnt.gen2/source/dmnt2_debug_process.cpp @@ -313,6 +313,15 @@ namespace ams::dmnt { } } + Result DebugProcess::Terminate() { + if (this->IsValid()) { + R_ABORT_UNLESS(svc::TerminateDebugProcess(m_debug_handle)); + this->Detach(); + } + + return ResultSuccess(); + } + void DebugProcess::GetBranchTarget(svc::ThreadContext &ctx, u64 thread_id, u64 ¤t_pc, u64 &target) { /* Save pc, in case we modify it. */ const u64 pc = current_pc; diff --git a/stratosphere/dmnt.gen2/source/dmnt2_debug_process.hpp b/stratosphere/dmnt.gen2/source/dmnt2_debug_process.hpp index 0c5acac22..8b18345ba 100644 --- a/stratosphere/dmnt.gen2/source/dmnt2_debug_process.hpp +++ b/stratosphere/dmnt.gen2/source/dmnt2_debug_process.hpp @@ -120,6 +120,8 @@ namespace ams::dmnt { Result Break(); + Result Terminate(); + Result SetBreakPoint(uintptr_t address, size_t size, bool is_step); Result ClearBreakPoint(uintptr_t address, size_t size); diff --git a/stratosphere/dmnt.gen2/source/dmnt2_gdb_server_impl.cpp b/stratosphere/dmnt.gen2/source/dmnt2_gdb_server_impl.cpp index f01b64e4c..8e5bfeba1 100644 --- a/stratosphere/dmnt.gen2/source/dmnt2_gdb_server_impl.cpp +++ b/stratosphere/dmnt.gen2/source/dmnt2_gdb_server_impl.cpp @@ -344,6 +344,17 @@ namespace ams::dmnt { *dst = 0; } + void HexToMemory(void *dst, const char *src, size_t size) { + u8 *dst_u8 = static_cast(dst); + + for (size_t i = 0; i < size; ++i) { + u8 v = DecodeHex(*(src++)) << 4; + v |= DecodeHex(*(src++)) & 0xF; + + *(dst_u8++) = v; + } + } + void ParseOffsetLength(const char *packet, u32 &offset, u32 &length) { /* Default to zero. */ offset = 0; @@ -437,7 +448,7 @@ namespace ams::dmnt { SetGdbRegister32(dst, thread_context.pstate); /* Copy FPU registers. */ - for (size_t i = 0; i < util::size(thread_context.v); ++i) { + for (size_t i = 0; i < util::size(thread_context.v) / 2; ++i) { SetGdbRegister128(dst, thread_context.v[i]); } @@ -446,6 +457,313 @@ namespace ams::dmnt { } } + void SetGdbRegisterPacket(char *dst, const svc::ThreadContext &thread_context, u64 reg_num, bool is_64_bit) { + /* Clear packet. */ + dst[0] = 0; + + union { + u32 v32; + u64 v64; + u128 v128; + } v; + size_t reg_size = 0; + + if (is_64_bit) { + if (reg_num < 29) { + v.v64 = thread_context.r[reg_num]; + reg_size = sizeof(u64); + } else if (reg_num == 29) { + v.v64 = thread_context.fp; + reg_size = sizeof(u64); + } else if (reg_num == 30) { + v.v64 = thread_context.lr; + reg_size = sizeof(u64); + } else if (reg_num == 31) { + v.v64 = thread_context.sp; + reg_size = sizeof(u64); + } else if (reg_num == 32) { + v.v64 = thread_context.pc; + reg_size = sizeof(u64); + } else if (reg_num == 33) { + v.v32 = thread_context.pstate; + reg_size = sizeof(u32); + } else if (reg_num < 66) { + v.v128 = thread_context.v[reg_num - 34]; + reg_size = sizeof(u128); + } else if (reg_num == 66) { + v.v32 = thread_context.fpsr; + reg_size = sizeof(u32); + } else if (reg_num == 67) { + v.v32 = thread_context.fpcr; + reg_size = sizeof(u32); + } + } else { + if (reg_num < 15) { + v.v32 = thread_context.r[reg_num]; + reg_size = sizeof(u32); + } else if (reg_num == 15) { + v.v32 = thread_context.pc; + reg_size = sizeof(u32); + } else if (reg_num == 25) { + v.v32 = thread_context.pstate; + reg_size = sizeof(u32); + } else if (26 <= reg_num && reg_num < 58) { + const union { + u64 v64[2]; + u128 v128; + } fpu_reg = { .v128 = thread_context.v[(reg_num - 26) / 2] }; + + v.v64 = fpu_reg.v64[(reg_num - 26) % 2]; + reg_size = sizeof(u64); + } else if (reg_num == 58) { + const u32 fpscr = (thread_context.fpsr & 0xF80000FF) | (thread_context.fpcr & 0x07FFFF00); + + v.v32 = fpscr; + reg_size = sizeof(u32); + } + } + + switch (reg_size) { + case sizeof(u32): SetGdbRegister32 (dst, v.v32 ); break; + case sizeof(u64): SetGdbRegister64 (dst, v.v64 ); break; + case sizeof(u128): SetGdbRegister128(dst, v.v128); break; + AMS_UNREACHABLE_DEFAULT_CASE(); + } + } + + u64 Aarch32RegisterToAarch64Register(u64 reg_num) { + if (reg_num < 15) { + return reg_num; + } else if (reg_num == 15) { + return 32; + } else if (reg_num == 25) { + return 33; + } else if (26 <= reg_num && reg_num <= 57) { + return 34 + (reg_num - 26); + } else if (reg_num == 58) { + return 66; + } else { + AMS_ABORT("Unknown register number %lu\n", reg_num); + } + } + + template requires std::unsigned_integral + util::optional ParseGdbRegister(const char *&src) { + union { + IntType v; + u8 bytes[sizeof(v)]; + } reg; + for (size_t i = 0; i < util::size(reg.bytes); ++i) { + const auto high = DecodeHex(*(src++)); + const auto low = DecodeHex(*(src++)); + if (high < 0 || low < 0) { + return util::nullopt; + } + reg.bytes[i] = (high << 4) | low; + } + + return reg.v; + } + + ALWAYS_INLINE util::optional ParseGdbRegister32(const char *&src) { return ParseGdbRegister(src); } + ALWAYS_INLINE util::optional ParseGdbRegister64(const char *&src) { return ParseGdbRegister(src); } + ALWAYS_INLINE util::optional ParseGdbRegister128(const char *&src) { return ParseGdbRegister(src); } + + void ParseGdbRegisterPacket(svc::ThreadContext &thread_context, const char *src, bool is_64_bit) { + if (is_64_bit) { + /* Copy general purpose registers. */ + for (size_t i = 0; i < util::size(thread_context.r); ++i) { + if (const auto v = ParseGdbRegister64(src); v.has_value()) { + thread_context.r[i] = *v; + } else { + return; + } + } + + /* Copy special registers. */ + if (const auto v = ParseGdbRegister64(src); v.has_value()) { + thread_context.fp = *v; + } else { + return; + } + + if (const auto v = ParseGdbRegister64(src); v.has_value()) { + thread_context.lr = *v; + } else { + return; + } + + if (const auto v = ParseGdbRegister64(src); v.has_value()) { + thread_context.sp = *v; + } else { + return; + } + + if (const auto v = ParseGdbRegister64(src); v.has_value()) { + thread_context.pc = *v; + } else { + return; + } + + if (const auto v = ParseGdbRegister32(src); v.has_value()) { + thread_context.pstate = *v; + } else { + return; + } + + /* Copy FPU registers. */ + for (size_t i = 0; i < util::size(thread_context.v); ++i) { + if (const auto v = ParseGdbRegister128(src); v.has_value()) { + thread_context.v[i] = *v; + } else { + return; + } + } + + if (const auto v = ParseGdbRegister32(src); v.has_value()) { + thread_context.fpsr = *v; + } else { + return; + } + + if (const auto v = ParseGdbRegister32(src); v.has_value()) { + thread_context.fpcr = *v; + } else { + return; + } + } else { + /* Copy general purpose registers. */ + for (size_t i = 0; i < 15; ++i) { + if (const auto v = ParseGdbRegister32(src); v.has_value()) { + thread_context.r[i] = *v; + } else { + return; + } + } + + /* Copy special registers. */ + if (const auto v = ParseGdbRegister32(src); v.has_value()) { + thread_context.pc = *v; + } else { + return; + } + + if (const auto v = ParseGdbRegister32(src); v.has_value()) { + thread_context.pstate = *v; + } else { + return; + } + + /* Copy FPU registers. */ + for (size_t i = 0; i < util::size(thread_context.v) / 2; ++i) { + if (const auto v = ParseGdbRegister128(src); v.has_value()) { + thread_context.v[i] = *v; + } else { + return; + } + } + + if (const auto v = ParseGdbRegister32(src); v.has_value()) { + thread_context.fpsr = *v & 0xF80000FF; + thread_context.fpcr = *v & 0x07FFFF00; + } else { + return; + } + } + } + + void ParseGdbRegisterPacket(svc::ThreadContext &thread_context, const char *src, u64 reg_num, bool is_64_bit) { + if (is_64_bit) { + if (reg_num < 29) { + if (const auto v = ParseGdbRegister64(src); v.has_value()) { + thread_context.r[reg_num] = *v; + } + } else if (reg_num == 29) { + if (const auto v = ParseGdbRegister64(src); v.has_value()) { + thread_context.fp = *v; + } + } else if (reg_num == 30) { + if (const auto v = ParseGdbRegister64(src); v.has_value()) { + thread_context.lr = *v; + } + } else if (reg_num == 31) { + if (const auto v = ParseGdbRegister64(src); v.has_value()) { + thread_context.sp = *v; + } + } else if (reg_num == 32) { + if (const auto v = ParseGdbRegister64(src); v.has_value()) { + thread_context.pc = *v; + } + } else if (reg_num == 33) { + if (const auto v = ParseGdbRegister32(src); v.has_value()) { + thread_context.pstate = *v; + } + } else if (reg_num < 66) { + if (const auto v = ParseGdbRegister128(src); v.has_value()) { + thread_context.v[reg_num - 34] = *v; + } + } else if (reg_num == 66) { + if (const auto v = ParseGdbRegister32(src); v.has_value()) { + thread_context.fpsr = *v; + } + } else if (reg_num == 67) { + if (const auto v = ParseGdbRegister32(src); v.has_value()) { + thread_context.fpcr = *v; + } + } + } else { + if (reg_num < 15) { + if (const auto v = ParseGdbRegister32(src); v.has_value()) { + thread_context.r[reg_num] = *v; + } + } else if (reg_num == 15) { + if (const auto v = ParseGdbRegister32(src); v.has_value()) { + thread_context.pc = *v; + } + } else if (reg_num == 25) { + if (const auto v = ParseGdbRegister32(src); v.has_value()) { + thread_context.pstate = *v; + } + } else if (26 <= reg_num && reg_num < 58) { + union { + u64 v64[2]; + u128 v128; + } fpu_reg = { .v128 = thread_context.v[(reg_num - 26) / 2] }; + + if (const auto v = ParseGdbRegister64(src); v.has_value()) { + fpu_reg.v64[(reg_num - 26) % 2] = *v; + thread_context.v[(reg_num - 26) / 2] = fpu_reg.v128; + } + } else if (reg_num == 58) { + if (const auto v = ParseGdbRegister32(src); v.has_value()) { + thread_context.fpsr = *v & 0xF80000FF; + thread_context.fpcr = *v & 0x07FFFF00; + } + } + } + } + + u32 RegisterToContextFlags(u64 reg_num, bool is_64_bit) { + /* Convert register number. */ + if (!is_64_bit) { + reg_num = Aarch32RegisterToAarch64Register(reg_num); + } + + /* Get flags. */ + u32 flags = 0; + if (reg_num < 29) { + flags = svc::ThreadContextFlag_General; + } else if (reg_num < 34) { + flags = svc::ThreadContextFlag_Control; + } else if (reg_num < 66) { + flags = svc::ThreadContextFlag_Fpu; + } else if (reg_num == 66) { + flags = svc::ThreadContextFlag_FpuControl; + } + + return flags; + } + constinit os::SdkMutex g_annex_buffer_lock; constinit char g_annex_buffer[0x8000]; @@ -898,15 +1216,36 @@ namespace ams::dmnt { /* Handle the received packet. */ switch (m_receive_packet[0]) { + case 'D': + this->D(); + break; + case 'G': + this->G(); + break; case 'H': this->H(); break; + case 'M': + this->M(); + break; + case 'P': + this->P(); + break; + case 'Q': + this->Q(); + break; case 'T': this->T(); break; case 'Z': this->Z(); break; + case 'c': + this->c(); + break; + case 'k': + this->k(); + break; case 'g': if (!this->g()) { m_killed = true; @@ -915,6 +1254,9 @@ namespace ams::dmnt { case 'm': this->m(); break; + case 'p': + this->p(); + break; case 'v': this->v(); break; @@ -936,6 +1278,36 @@ namespace ams::dmnt { } } + void GdbServerImpl::D() { + m_debug_process.Detach(); + SetReplyOk(m_reply_packet); + } + + void GdbServerImpl::G() { + /* Get thread id. */ + u32 thread_id = m_debug_process.GetThreadIdOverride(); + if (thread_id == 0 || thread_id == static_cast(-1)) { + thread_id = m_debug_process.GetLastThreadId(); + } + + /* Get thread context. */ + svc::ThreadContext ctx; + if (R_FAILED(m_debug_process.GetThreadContext(std::addressof(ctx), thread_id, svc::ThreadContextFlag_All))) { + SetReplyError(m_reply_packet, "E01"); + return; + } + + /* Update the thread context. */ + ParseGdbRegisterPacket(ctx, m_receive_packet, m_debug_process.Is64Bit()); + + /* Set the thread context. */ + if (R_SUCCEEDED(m_debug_process.SetThreadContext(std::addressof(ctx), thread_id, svc::ThreadContextFlag_All))) { + SetReplyOk(m_reply_packet); + } else { + SetReplyError(m_reply_packet, "E01"); + } + } + void GdbServerImpl::H() { if (this->HasDebugProcess()) { if (ParsePrefix(m_receive_packet, "Hg") || ParsePrefix(m_receive_packet, "HG")) { @@ -982,6 +1354,89 @@ namespace ams::dmnt { } } + void GdbServerImpl::M() { + ++m_receive_packet; + + /* Validate format. */ + char *comma = std::strchr(m_receive_packet, ','); + if (comma == nullptr) { + SetReplyError(m_reply_packet, "E01"); + return; + } + *comma = 0; + + char *colon = std::strchr(comma + 1, ':'); + if (colon == nullptr) { + SetReplyError(m_reply_packet, "E01"); + return; + } + *colon = 0; + + /* Parse address/length. */ + const u64 address = DecodeHex(m_receive_packet); + const u64 length = DecodeHex(comma + 1); + if (length >= sizeof(m_buffer)) { + SetReplyError(m_reply_packet, "E01"); + return; + } + + /* Decode the memory. */ + HexToMemory(m_buffer, colon + 1, length); + + /* Write the memory. */ + if (R_SUCCEEDED(m_debug_process.WriteMemory(m_buffer, address, length))) { + SetReplyOk(m_reply_packet); + } else { + SetReplyError(m_reply_packet, "E01"); + } + } + + void GdbServerImpl::P() { + ++m_receive_packet; + + /* Validate format. */ + char *equal = std::strchr(m_receive_packet, '='); + if (equal == nullptr) { + SetReplyError(m_reply_packet, "E01"); + return; + } + *equal = 0; + + /* Decode the register. */ + const u64 reg_num = DecodeHex(m_receive_packet); + + /* Get the flags. */ + const u32 flags = RegisterToContextFlags(reg_num, m_debug_process.Is64Bit()); + + /* Determine thread id. */ + u32 thread_id = m_debug_process.GetThreadIdOverride(); + if (thread_id == 0 || thread_id == static_cast(-1)) { + thread_id = m_debug_process.GetLastThreadId(); + } + + /* Update the register. */ + svc::ThreadContext ctx; + if (R_SUCCEEDED(m_debug_process.GetThreadContext(std::addressof(ctx), thread_id, flags))) { + ParseGdbRegisterPacket(ctx, equal + 1, reg_num, m_debug_process.Is64Bit()); + + if (R_SUCCEEDED(m_debug_process.SetThreadContext(std::addressof(ctx), thread_id, flags))) { + SetReplyOk(m_reply_packet); + } else { + SetReplyError(m_reply_packet, "E01"); + } + } else { + SetReplyError(m_reply_packet, "E01"); + } + } + + void GdbServerImpl::Q() { + if (false) { + /* TODO: QStartNoAckMode? */ + } else { + AMS_DMNT2_GDB_LOG_DEBUG("Not Implemented Q: %s\n", m_receive_packet); + } + } + void GdbServerImpl::T() { if (const char *dot = std::strchr(m_receive_packet, '.'); dot != nullptr) { const u64 thread_id = DecodeHex(dot + 1); @@ -1082,6 +1537,28 @@ namespace ams::dmnt { } } + void GdbServerImpl::c() { + /* Get thread id. */ + u64 thread_id = m_debug_process.GetThreadIdOverride(); + if (thread_id == 0 || thread_id == static_cast(-1)) { + thread_id = m_debug_process.GetLastThreadId(); + } + + /* Continue the thread. */ + Result result; + if (thread_id == m_debug_process.GetLastThreadId()) { + result = m_debug_process.Continue(thread_id); + } else { + result = m_debug_process.Continue(); + } + + if (R_SUCCEEDED(result)) { + SetReplyOk(m_reply_packet); + } else { + SetReplyError(m_reply_packet, "E01"); + } + } + bool GdbServerImpl::g() { /* Get thread id. */ u64 thread_id = m_debug_process.GetThreadIdOverride(); @@ -1130,6 +1607,35 @@ namespace ams::dmnt { MemoryToHex(m_reply_packet, m_buffer, length); } + void GdbServerImpl::k() { + m_debug_process.Terminate(); + m_killed = true; + } + + void GdbServerImpl::p() { + ++m_receive_packet; + + /* Decode the register. */ + const u64 reg_num = DecodeHex(m_receive_packet); + + /* Get the flags. */ + const u32 flags = RegisterToContextFlags(reg_num, m_debug_process.Is64Bit()); + + /* Determine thread id. */ + u32 thread_id = m_debug_process.GetThreadIdOverride(); + if (thread_id == 0 || thread_id == static_cast(-1)) { + thread_id = m_debug_process.GetLastThreadId(); + } + + /* Get the register. */ + svc::ThreadContext ctx; + if (R_SUCCEEDED(m_debug_process.GetThreadContext(std::addressof(ctx), thread_id, flags))) { + SetGdbRegisterPacket(m_reply_packet, ctx, reg_num, m_debug_process.Is64Bit()); + } else { + SetReplyError(m_reply_packet, "E01"); + } + } + void GdbServerImpl::v() { if (ParsePrefix(m_receive_packet, "vAttach;")) { this->vAttach(); @@ -1453,7 +1959,13 @@ namespace ams::dmnt { for (size_t i = 0; i < m_debug_process.GetModuleCount(); ++i) { AMS_DMNT2_GDB_LOG_DEBUG("Module[%zu]: %p, %s\n", i, reinterpret_cast(m_debug_process.GetBaseAddress(i)), m_debug_process.GetModuleName(i)); - AppendReply(g_annex_buffer, "", m_debug_process.GetModuleName(i), m_debug_process.GetBaseAddress(i)); + const char *module_name = m_debug_process.GetModuleName(i); + const auto name_len = std::strlen(module_name); + if (name_len > 4 && std::strcmp(module_name + name_len - 4, ".elf") != 0 && std::strcmp(module_name + name_len - 4, ".nss") != 0) { + AppendReply(g_annex_buffer, "", module_name, m_debug_process.GetBaseAddress(i)); + } else { + AppendReply(g_annex_buffer, "", module_name, m_debug_process.GetBaseAddress(i)); + } } AppendReply(g_annex_buffer, ""); diff --git a/stratosphere/dmnt.gen2/source/dmnt2_gdb_server_impl.hpp b/stratosphere/dmnt.gen2/source/dmnt2_gdb_server_impl.hpp index 95be0382b..e4cd6614a 100644 --- a/stratosphere/dmnt.gen2/source/dmnt2_gdb_server_impl.hpp +++ b/stratosphere/dmnt.gen2/source/dmnt2_gdb_server_impl.hpp @@ -62,17 +62,33 @@ namespace ams::dmnt { void ProcessDebugEvents(); void SetStopReplyPacket(GdbSignal signal); private: + void D(); + + void G(); + void H(); void Hg(); + void M(); + + void P(); + + void Q(); + void T(); void Z(); + void c(); + bool g(); + void k(); + void m(); + void p(); + void v(); void vAttach();