mirror/Shipwright
1
0
Fork 0
mirror of https://github.com/HarbourMasters/Shipwright.git synced 2024-11-29 21:02:18 -05:00
Code Issues Projects Releases Wiki Activity

Crash Handler 2.0 (#1466)

Browse Source 
* Linux side done

* Win V2. need to fix message box.

* Fix message box.
This commit is contained in:
louist103 2022-09-26 19:54:25 -04:00 committed by GitHub
parent b3c7edcf76
commit c21b2e8f00
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 465 additions and 162 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

420
libultraship/libultraship/CrashHandler.cpp
View File

@ -2,9 +2,95 @@
#include "Utils/StringHelper.h" #include "Utils/StringHelper.h"
#include "CrashHandler.h" #include "CrashHandler.h"
#include "Window.h" #include "Window.h"
#include "ResourceMgr.h"
#include "GameVersions.h"
#include "Cvar.h"
#define WRITE_VAR_LINE(buff, len, varName, varValue) \
append_str(buff, len, varName); \
append_line(buff, len, varValue);
#define WRITE_VAR(buff, len, varName, varValue) \
append_str(buff, len, varName); \
append_str(buff, len, varValue);
extern "C" void DeinitOTR(void); extern "C" void DeinitOTR(void);
static CrashHandlerCallback sCallbackFunc = nullptr;
static const char* GetGameVersionString() {
if(Ship::Window::GetInstance()->GetResourceManager()->IsRunning()) {
uint32_t version = Ship::Window::GetInstance()->GetResourceManager()->GetGameVersion();
switch (version) {
case OOT_NTSC_10:
return "NTSC 1.0";
case OOT_NTSC_11:
return "NTSC 1.1";
case OOT_NTSC_12:
return "NTSC 1.2";
case OOT_PAL_10:
return "PAL 1.0";
case OOT_PAL_11:
return "PAL 1.1";
case OOT_NTSC_JP_GC_CE:
return "NTSC JP_GC_CE";
case OOT_NTSC_JP_GC:
return "NTSC_JP_GC";
case OOT_NTSC_US_GC:
return "NTSC_US_GC";
case OOT_PAL_GC:
return "PAL_GC";
case OOT_NTSC_JP_MQ:
return "NTSC_JP_MQ";
case OOT_NTSC_US_MQ:
return "NTSC_US_MQ";
case OOT_PAL_MQ:
return "PAL_MQ";
case OOT_PAL_GC_DBG1:
return "DBG_1";
case OOT_PAL_GC_DBG2:
return "DBG_2";
case OOT_PAL_GC_MQ_DBG:
return "MQ_DBG";
case OOT_IQUE_TW:
return "IQUE_TW";
case OOT_IQUE_CN:
return "IQUE_CN";
case OOT_UNKNOWN:
return "UNKNOWN";
}
}
return "ResourceMGR not ready";
}
static void append_str(char* buf, size_t* len, const char* str) {
while (*str != '\0')
buf[(*len)++] = *str++;
}
static void append_line(char* buf, size_t* len, const char* str) {
while (*str != '\0')
buf[(*len)++] = *str++;
buf[(*len)++] = '\n';
}
/**
* @brief Prints common data relevant to the crash
*
* @param buffer
*/
static void CrashHandler_PrintCommon(char* buffer, size_t* curBufferPos) {
WRITE_VAR_LINE(buffer, curBufferPos, "OTR Generated with: ", GetGameVersionString());
if (sCallbackFunc != nullptr) {
sCallbackFunc(buffer, curBufferPos);
}
SPDLOG_CRITICAL(buffer);
}
#if defined(__linux__) #if defined(__linux__)
#include <csignal> #include <csignal>
#include <cstdio> #include <cstdio>
@ -15,98 +101,103 @@ extern "C" void DeinitOTR(void);
#include <SDL.h> #include <SDL.h>
static void PrintRegisters(ucontext_t* ctx, char* buffer, size_t* pos) {
static void PrintRegisters(ucontext_t* ctx) { char regbuffer[128];
char regbuffer[1024]; append_line(buffer, pos, "Registers:");
SPDLOG_CRITICAL("Registers:");
#if defined(__x86_64__) #if defined(__x86_64__)
snprintf(regbuffer, std::size(regbuffer), "0x%016llX", ctx->uc_mcontext.gregs[REG_RAX]); snprintf(regbuffer, std::size(regbuffer), "RAX: 0x%016llX", ctx->uc_mcontext.gregs[REG_RAX]);
SPDLOG_CRITICAL("RAX: {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer), "0x%016llX", ctx->uc_mcontext.gregs[REG_RDI]); snprintf(regbuffer, std::size(regbuffer), "RDI: 0x%016llX", ctx->uc_mcontext.gregs[REG_RDI]);
SPDLOG_CRITICAL("RDI: {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer), "0x%016llX", ctx->uc_mcontext.gregs[REG_RSI]); snprintf(regbuffer, std::size(regbuffer), "RSI: 0x%016llX", ctx->uc_mcontext.gregs[REG_RSI]);
SPDLOG_CRITICAL("RSI: {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer), "0x%016llX", ctx->uc_mcontext.gregs[REG_RDX]); snprintf(regbuffer, std::size(regbuffer), "RDX: 0x%016llX", ctx->uc_mcontext.gregs[REG_RDX]);
SPDLOG_CRITICAL("RDX: {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer), "0x%016llX", ctx->uc_mcontext.gregs[REG_RCX]); snprintf(regbuffer, std::size(regbuffer), "RCX: 0x%016llX", ctx->uc_mcontext.gregs[REG_RCX]);
SPDLOG_CRITICAL("RCX: {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer), "0x%016llX", ctx->uc_mcontext.gregs[REG_R8]); snprintf(regbuffer, std::size(regbuffer), "R8: 0x%016llX", ctx->uc_mcontext.gregs[REG_R8]);
SPDLOG_CRITICAL("R8 : {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer), "0x%016llX", ctx->uc_mcontext.gregs[REG_R9]); snprintf(regbuffer, std::size(regbuffer), "R9: 0x%016llX", ctx->uc_mcontext.gregs[REG_R9]);
SPDLOG_CRITICAL("R9 : {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer), "0x%016llX", ctx->uc_mcontext.gregs[REG_R10]); snprintf(regbuffer, std::size(regbuffer), "R10: 0x%016llX", ctx->uc_mcontext.gregs[REG_R10]);
SPDLOG_CRITICAL("R10: {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer), "0x%016llX", ctx->uc_mcontext.gregs[REG_R11]); snprintf(regbuffer, std::size(regbuffer), "R11: 0x%016llX", ctx->uc_mcontext.gregs[REG_R11]);
SPDLOG_CRITICAL("R11: {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer), "0x%016llX", ctx->uc_mcontext.gregs[REG_RSP]); snprintf(regbuffer, std::size(regbuffer), "RSP: 0x%016llX", ctx->uc_mcontext.gregs[REG_RSP]);
SPDLOG_CRITICAL("RSP: {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer), "0x%016llX", ctx->uc_mcontext.gregs[REG_RBX]); snprintf(regbuffer, std::size(regbuffer), "RBX: 0x%016llX", ctx->uc_mcontext.gregs[REG_RBX]);
SPDLOG_CRITICAL("RBX: {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer), "0x%016llX", ctx->uc_mcontext.gregs[REG_RBP]); snprintf(regbuffer, std::size(regbuffer), "RBP: 0x%016llX", ctx->uc_mcontext.gregs[REG_RBP]);
SPDLOG_CRITICAL("RBP: {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer), "0x%016llX", ctx->uc_mcontext.gregs[REG_R12]); snprintf(regbuffer, std::size(regbuffer), "R12: 0x%016llX", ctx->uc_mcontext.gregs[REG_R12]);
SPDLOG_CRITICAL("R12: {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer), "0x%016llX", ctx->uc_mcontext.gregs[REG_R13]); snprintf(regbuffer, std::size(regbuffer), "R13: 0x%016llX", ctx->uc_mcontext.gregs[REG_R13]);
SPDLOG_CRITICAL("R13: {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer), "0x%016llX", ctx->uc_mcontext.gregs[REG_R14]); snprintf(regbuffer, std::size(regbuffer), "R14: 0x%016llX", ctx->uc_mcontext.gregs[REG_R14]);
SPDLOG_CRITICAL("R14: {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer), "0x%016llX", ctx->uc_mcontext.gregs[REG_R15]); snprintf(regbuffer, std::size(regbuffer), "R15: 0x%016llX", ctx->uc_mcontext.gregs[REG_R15]);
SPDLOG_CRITICAL("R15: {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer), "0x%016llX", ctx->uc_mcontext.gregs[REG_RIP]); snprintf(regbuffer, std::size(regbuffer), "RIP: 0x%016llX", ctx->uc_mcontext.gregs[REG_RIP]);
SPDLOG_CRITICAL("RIP: {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer), "0x%016llX", ctx->uc_mcontext.gregs[REG_EFL]); snprintf(regbuffer, std::size(regbuffer), "EFL: 0x%016llX", ctx->uc_mcontext.gregs[REG_EFL]);
SPDLOG_CRITICAL("EFLAGS: {} ", regbuffer); append_line(buffer, pos, regbuffer);
#else #else
snprintf(regbuffer, std::size(regbuffer),"0x%08lX", ctx->uc_mcontext.gregs[REG_EDI]); snprintf(regbuffer, std::size(regbuffer),"EDI: 0x%08lX", ctx->uc_mcontext.gregs[REG_EDI]);
SPDLOG_CRITICAL("EDI : {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer),"0x%08lX", ctx->uc_mcontext.gregs[REG_ESI]); snprintf(regbuffer, std::size(regbuffer),"ESI: 0x%08lX", ctx->uc_mcontext.gregs[REG_ESI]);
SPDLOG_CRITICAL("ESI : {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer),"0x%08lX", ctx->uc_mcontext.gregs[REG_EBP]); snprintf(regbuffer, std::size(regbuffer),"EBP: 0x%08lX", ctx->uc_mcontext.gregs[REG_EBP]);
SPDLOG_CRITICAL("EBP : {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer),"0x%08lX", ctx->uc_mcontext.gregs[REG_ESP]); snprintf(regbuffer, std::size(regbuffer),"ESP: 0x%08lX", ctx->uc_mcontext.gregs[REG_ESP]);
SPDLOG_CRITICAL("ESP : {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer),"0x%08lX", ctx->uc_mcontext.gregs[REG_EBX]); snprintf(regbuffer, std::size(regbuffer),"EBX: 0x%08lX", ctx->uc_mcontext.gregs[REG_EBX]);
SPDLOG_CRITICAL("EBX : {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer),"0x%08lX", ctx->uc_mcontext.gregs[REG_EDX]); snprintf(regbuffer, std::size(regbuffer),"EDX: 0x%08lX", ctx->uc_mcontext.gregs[REG_EDX]);
SPDLOG_CRITICAL("EDX : {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer),"0x%08lX", ctx->uc_mcontext.gregs[REG_ECX]); snprintf(regbuffer, std::size(regbuffer),"ECX: 0x%08lX", ctx->uc_mcontext.gregs[REG_ECX]);
SPDLOG_CRITICAL("ECX : {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer),"0x%08lX", ctx->uc_mcontext.gregs[REG_EAX]); snprintf(regbuffer, std::size(regbuffer),"EAX: 0x%08lX", ctx->uc_mcontext.gregs[REG_EAX]);
SPDLOG_CRITICAL("EAX : {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer),"0x%08lX", ctx->uc_mcontext.gregs[REG_EIP]); snprintf(regbuffer, std::size(regbuffer),"EIP: 0x%08lX", ctx->uc_mcontext.gregs[REG_EIP]);
SPDLOG_CRITICAL("EIP : {} ", regbuffer); append_line(buffer, pos, regbuffer);
snprintf(regbuffer, std::size(regbuffer),"0x%08lX", ctx->uc_mcontext.gregs[REG_EFL]); snprintf(regbuffer, std::size(regbuffer),"EFL: 0x%08lX", ctx->uc_mcontext.gregs[REG_EFL]);
SPDLOG_CRITICAL("EFL : {} ", regbuffer); append_line(buffer, pos, regbuffer);
#endif #endif
} }
static void ErrorHandler(int sig, siginfo_t* sigInfo, void* data) { static void ErrorHandler(int sig, siginfo_t* sigInfo, void* data) {
constexpr size_t MAX_BUFF_SIZE = 32768;
size_t curBufferPos = 0;
char buffer[MAX_BUFF_SIZE];
char intToCharBuffer[16];
std::array<void*, 4096> arr; std::array<void*, 4096> arr;
ucontext_t* ctx = static_cast<ucontext_t*>(data); ucontext_t* ctx = static_cast<ucontext_t*>(data);
constexpr size_t nMaxFrames = arr.size(); constexpr size_t nMaxFrames = arr.size();
size_t size = backtrace(arr.data(), nMaxFrames); size_t size = backtrace(arr.data(), nMaxFrames);
char** symbols = backtrace_symbols(arr.data(), nMaxFrames); char** symbols = backtrace_symbols(arr.data(), nMaxFrames);
SPDLOG_CRITICAL("(Signal: {})", sig); snprintf(intToCharBuffer, sizeof(intToCharBuffer), "Signal: %i", sig);
append_line(buffer, &curBufferPos, intToCharBuffer);
switch (sig) { switch (sig) {
case SIGILL: case SIGILL:
SPDLOG_CRITICAL("ILLEGAL INSTRUCTION"); append_line(buffer, &curBufferPos, "ILLEGAL INSTRUCTION");
break; break;
case SIGABRT: case SIGABRT:
SPDLOG_CRITICAL("ABORT"); append_line(buffer, &curBufferPos, "ABORT");
break; break;
case SIGFPE: case SIGFPE:
SPDLOG_CRITICAL("ERRONEUS ARITHEMETIC OPERATION"); append_line(buffer, &curBufferPos, "ERRONEUS ARITHEMETIC OPERATION");
break; break;
case SIGSEGV: case SIGSEGV:
SPDLOG_CRITICAL("INVALID ACCESS TO STORAGE"); append_line(buffer, &curBufferPos, "INVALID ACCESS TO STORAGE");
break; break;
} }
PrintRegisters(ctx); PrintRegisters(ctx, buffer, &curBufferPos);
SPDLOG_CRITICAL("Traceback:"); append_line(buffer, &curBufferPos, "Traceback:");
for (size_t i = 1; i < size; i++) { for (size_t i = 1; i < size; i++) {
Dl_info info; Dl_info info;
int gotAddress = dladdr(arr[i], &info); int gotAddress = dladdr(arr[i], &info);
@ -133,11 +224,13 @@ static void ErrorHandler(int sig, siginfo_t* sigInfo, void* data) {
(char*)arr[i] - (char*)info.dli_saddr); (char*)arr[i] - (char*)info.dli_saddr);
free(demangled); free(demangled);
} }
snprintf(intToCharBuffer, sizeof(intToCharBuffer), "%i ", (int)i);
SPDLOG_CRITICAL("{} {}", i, functionName.c_str()); WRITE_VAR_LINE(buffer, &curBufferPos, intToCharBuffer, functionName.c_str());
} }
SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR, "SoH has crashed", "SoH Has crashed. Please upload the logs to the support channel in discord.", nullptr); SDL_ShowSimpleMessageBox(SDL_MESSAGEBOX_ERROR, "SoH has crashed", "SoH Has crashed. Please upload the logs to the support channel in discord.", nullptr);
free(symbols); free(symbols);
CrashHandler_PrintCommon(buffer, &curBufferPos);
DeinitOTR(); DeinitOTR();
Ship::Window::GetInstance()->GetLogger()->flush(); Ship::Window::GetInstance()->GetLogger()->flush();
spdlog::shutdown(); spdlog::shutdown();
@ -149,116 +242,97 @@ static void ShutdownHandler(int sig, siginfo_t* sigInfo, void* data) {
exit(1); exit(1);
} }
extern "C" void SetupHandlerLinux() {
struct sigaction action;
struct sigaction shutdownAction;
action.sa_flags = SA_SIGINFO;
action.sa_sigaction = ErrorHandler;
sigaction(SIGILL, &action, nullptr);
sigaction(SIGABRT, &action, nullptr);
sigaction(SIGFPE, &action, nullptr);
sigaction(SIGSEGV, &action, nullptr);
shutdownAction.sa_flags = SA_SIGINFO;
shutdownAction.sa_sigaction = ShutdownHandler;
sigaction(SIGINT, &shutdownAction, nullptr);
sigaction(SIGTERM, &shutdownAction, nullptr);
sigaction(SIGQUIT, &shutdownAction, nullptr);
sigaction(SIGKILL, &shutdownAction, nullptr);
}
#elif _WIN32 #elif _WIN32
#if defined(_WIN32) && !defined(_WIN64) #if defined(_WIN32) && !defined(_WIN64)
#define WINDOWS_32_BIT #define WINDOWS_32_BIT
#endif #endif
static void PrintRegisters(CONTEXT* ctx) { static void PrintRegisters(CONTEXT* ctx, char* buffer, size_t* pos) {
SPDLOG_CRITICAL("Register dump"); append_line(buffer, pos, "Registers: ");
char regBuff[50]; char regBuff[25];
#if defined(_M_AMD64) #if defined(_M_AMD64)
snprintf(regBuff, std::size(regBuff), "0x%016llX", ctx->Rax); sprintf_s(regBuff, std::size(regBuff), "RAX: 0x%016llX", ctx->Rax);
SPDLOG_CRITICAL("RAX: {}", regBuff); append_line(buffer, pos, regBuff);
snprintf(regBuff, std::size(regBuff), "0x%016llX", ctx->Rcx); sprintf_s(regBuff, std::size(regBuff), "RCX: 0x%016llX", ctx->Rcx);
SPDLOG_CRITICAL("RCX: {}", regBuff); append_line(buffer, pos, regBuff);
snprintf(regBuff, std::size(regBuff), "0x%016llX", ctx->Rdx); sprintf_s(regBuff, std::size(regBuff), "RDX: 0x%016llX", ctx->Rdx);
SPDLOG_CRITICAL("RDX: {}", regBuff); append_line(buffer, pos, regBuff);
snprintf(regBuff, std::size(regBuff), "0x%016llX", ctx->Rbx); sprintf_s(regBuff, std::size(regBuff), "RBX: 0x%016llX", ctx->Rbx);
SPDLOG_CRITICAL("RBX: {}", regBuff); append_line(buffer, pos, regBuff);
snprintf(regBuff, std::size(regBuff), "0x%016llX", ctx->Rsp); sprintf_s(regBuff, std::size(regBuff), "RSP: 0x%016llX", ctx->Rsp);
SPDLOG_CRITICAL("RSP: {}", regBuff); append_line(buffer, pos, regBuff);
snprintf(regBuff, std::size(regBuff), "0x%016llX", ctx->Rbp); sprintf_s(regBuff, std::size(regBuff), "RBP: 0x%016llX", ctx->Rbp);
SPDLOG_CRITICAL("RBP: {}", regBuff); append_line(buffer, pos, regBuff);
snprintf(regBuff, std::size(regBuff), "0x%016llX", ctx->Rsi); sprintf_s(regBuff, std::size(regBuff), "RSI: 0x%016llX", ctx->Rsi);
SPDLOG_CRITICAL("RSI: {}", regBuff); append_line(buffer, pos, regBuff);
snprintf(regBuff, std::size(regBuff), "0x%016llX", ctx->Rdi); sprintf_s(regBuff, std::size(regBuff), "RDI: 0x%016llX", ctx->Rdi);
SPDLOG_CRITICAL("RDI: {}", regBuff); append_line(buffer, pos, regBuff);
snprintf(regBuff, std::size(regBuff), "0x%016llX", ctx->R9); sprintf_s(regBuff, std::size(regBuff), "R9: 0x%016llX", ctx->R9);
SPDLOG_CRITICAL("R9: {}", regBuff); append_line(buffer, pos, regBuff);
snprintf(regBuff, std::size(regBuff), "0x%016llX", ctx->R10); sprintf_s(regBuff, std::size(regBuff), "R10: 0x%016llX", ctx->R10);
SPDLOG_CRITICAL("R10: {}", regBuff); append_line(buffer, pos, regBuff);
snprintf(regBuff, std::size(regBuff), "0x%016llX", ctx->R11); sprintf_s(regBuff, std::size(regBuff), "R11: 0x%016llX", ctx->R11);
SPDLOG_CRITICAL("R11: {}", regBuff); append_line(buffer, pos, regBuff);
snprintf(regBuff, std::size(regBuff), "0x%016llX", ctx->R12); sprintf_s(regBuff, std::size(regBuff), "R12: 0x%016llX", ctx->R12);
SPDLOG_CRITICAL("R12: {}", regBuff); append_line(buffer, pos, regBuff);
snprintf(regBuff, std::size(regBuff), "0x%016llX", ctx->R13); sprintf_s(regBuff, std::size(regBuff), "R13: 0x%016llX", ctx->R13);
SPDLOG_CRITICAL("R13: {}", regBuff); append_line(buffer, pos, regBuff);
snprintf(regBuff, std::size(regBuff), "0x%016llX", ctx->R14); sprintf_s(regBuff, std::size(regBuff), "R14: 0x%016llX", ctx->R14);
SPDLOG_CRITICAL("R14: {}", regBuff); append_line(buffer, pos, regBuff);
snprintf(regBuff, std::size(regBuff), "0x%016llX", ctx->R15); sprintf_s(regBuff, std::size(regBuff), "R15: 0x%016llX", ctx->R15);
SPDLOG_CRITICAL("R15: {}", regBuff); append_line(buffer, pos, regBuff);
snprintf(regBuff, std::size(regBuff), "0x%016llX", ctx->Rip); sprintf_s(regBuff, std::size(regBuff), "RIP: 0x%016llX", ctx->Rip);
SPDLOG_CRITICAL("RIP: {}", regBuff); append_line(buffer, pos, regBuff);
snprintf(regBuff, std::size(regBuff), "0x%08lX", ctx->EFlags); sprintf_s(regBuff, std::size(regBuff), "EFLAGS: 0x%08lX", ctx->EFlags);
SPDLOG_CRITICAL("EFLAGS: {}", regBuff); append_line(buffer, pos, regBuff);
#elif WINDOWS_32_BIT #elif WINDOWS_32_BIT
snprintf(regBuff, std::size(regBuff), "0x%08lX", ctx->Edi); sprintf_s(regBuff, std::size(regBuff), "EDI: 0x%08lX", ctx->Edi);
SPDLOG_CRITICAL("EDI: 0x{}", regBuff); append_line(buffer, pos, regBuff);
snprintf(regBuff, std::size(regBuff), "0x%08lX", ctx->Esi); sprintf_s(regBuff, std::size(regBuff), "ESI: 0x%08lX", ctx->Esi);
SPDLOG_CRITICAL("ESI: 0x{}", regBuff); append_line(buffer, pos, regBuff);
snprintf(regBuff, std::size(regBuff), "0x%08lX", ctx->Ebx); sprintf_s(regBuff, std::size(regBuff), "EBX: 0x%08lX", ctx->Ebx);
SPDLOG_CRITICAL("EBX: 0x{}", regBuff); append_line(buffer, pos, regBuff);
snprintf(regBuff, std::size(regBuff), "0x%08lX", ctx->Ecx); sprintf_s(regBuff, std::size(regBuff), "ECX: 0x%08lX", ctx->Ecx);
SPDLOG_CRITICAL("ECX: 0x{}", ctx->Ecx); append_line(buffer, pos, regBuff);
snprintf(regBuff, std::size(regBuff), "0x%08lX", ctx->Eax); sprintf_s(regBuff, std::size(regBuff), "EAX: 0x%08lX", ctx->Eax);
SPDLOG_CRITICAL("EAX: 0x{}", regBuff); append_line(buffer, pos, regBuff);
snprintf(regBuff, std::size(regBuff), "0x%08lX", ctx->Ebp); sprintf_s(regBuff, std::size(regBuff), "EBP: 0x%08lX", ctx->Ebp);
SPDLOG_CRITICAL("EBP: 0x{}", regBuff); append_line(buffer, pos, regBuff);
snprintf(regBuff, std::size(regBuff), "0x%08lX", ctx->Esp); sprintf_s(regBuff, std::size(regBuff), "ESP: 0x%08lX", ctx->Esp);
SPDLOG_CRITICAL("ESP: 0x{}", regBuff); append_line(buffer, pos, regBuff);
snprintf(regBuff, std::size(regBuff), "0x%08lX", ctx->EFlags); sprintf_s(regBuff, std::size(regBuff), "EFLAGS: 0x%08lX", ctx->EFlags);
SPDLOG_CRITICAL("EFLAGS: 0x{}", regBuff); append_line(buffer, pos, regBuff);
snprintf(regBuff, std::size(regBuff), "0x%08lX", ctx->Eip); sprintf_s(regBuff, std::size(regBuff), "EIP: 0x%08lX", ctx->Eip);
SPDLOG_CRITICAL("EIP: 0x{}", regBuff); append_line(buffer, pos, regBuff);
#endif #endif
} }
static void printStack(CONTEXT* ctx) { static void printStack(CONTEXT* ctx, char* logBuffer, size_t* pos) {
BOOL result; BOOL result;
HANDLE process; HANDLE process;
HANDLE thread; HANDLE thread;
@ -289,7 +363,7 @@ static void printStack(CONTEXT* ctx) {
CONTEXT ctx2; CONTEXT ctx2;
memcpy(&ctx2, ctx, sizeof(CONTEXT)); memcpy(&ctx2, ctx, sizeof(CONTEXT));
PrintRegisters(&ctx2); PrintRegisters(&ctx2, logBuffer, pos);
process = GetCurrentProcess(); process = GetCurrentProcess();
thread = GetCurrentThread(); thread = GetCurrentThread();
@ -323,12 +397,16 @@ static void printStack(CONTEXT* ctx) {
line.SizeOfStruct = sizeof(IMAGEHLP_LINE); line.SizeOfStruct = sizeof(IMAGEHLP_LINE);
#endif #endif
if (SymGetLineFromAddr(process, stack.AddrPC.Offset, &disp, &line)) { if (SymGetLineFromAddr(process, stack.AddrPC.Offset, &disp, &line)) {
SPDLOG_CRITICAL("{} in {}: line: {}: ", symbol->Name, line.FileName, line.LineNumber); char lineNumberStr[16];
sprintf_s(lineNumberStr, sizeof(lineNumberStr), "Line: %d", line.LineNumber);
append_str(logBuffer, pos, symbol->Name); append_str(logBuffer, pos, " in "); append_str(logBuffer, pos, line.FileName); append_line(logBuffer, pos, lineNumberStr);
//SPDLOG_CRITICAL("{} in {}: line: {}: ", symbol->Name, line.FileName, line.LineNumber);
} }
else { else {
char addrString[25]; char addrString[20];
snprintf(addrString, std::size(addrString), "0x%016llX", symbol->Address); sprintf_s(addrString, std::size(addrString), "0x%016llX", symbol->Address);
SPDLOG_CRITICAL("at {}, addr 0x{}", symbol->Name, addrString); WRITE_VAR(logBuffer, pos, "At ", symbol->Name); WRITE_VAR_LINE(logBuffer, pos, "Addr: ", addrString);
//SPDLOG_CRITICAL("at {}, addr 0x{}", symbol->Name, addrString);
hModule = nullptr; hModule = nullptr;
GetModuleHandleEx(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS | GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT, GetModuleHandleEx(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS | GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT,
(LPCTSTR)(stack.AddrPC.Offset), &hModule); (LPCTSTR)(stack.AddrPC.Offset), &hModule);
@ -336,9 +414,11 @@ static void printStack(CONTEXT* ctx) {
if (hModule != nullptr) { if (hModule != nullptr) {
GetModuleFileNameA(hModule, module, sizeof(module)); GetModuleFileNameA(hModule, module, sizeof(module));
} }
SPDLOG_CRITICAL("In {}", module); WRITE_VAR_LINE(logBuffer, pos, "In: ", module);
// SPDLOG_CRITICAL("In {}", module);
} }
} }
CrashHandler_PrintCommon(logBuffer, pos);
Ship::Window::GetInstance()->GetLogger()->flush(); Ship::Window::GetInstance()->GetLogger()->flush();
spdlog::shutdown(); spdlog::shutdown();
DeinitOTR(); DeinitOTR();
@ -346,15 +426,47 @@ static void printStack(CONTEXT* ctx) {
extern "C" LONG seh_filter(struct _EXCEPTION_POINTERS* ex) { extern "C" LONG seh_filter(struct _EXCEPTION_POINTERS* ex) {
char exceptionString[20]; char exceptionString[20];
constexpr size_t MAX_BUFF_SIZE = 32768;
size_t curBufferPos = 0;
char buffer[MAX_BUFF_SIZE];
snprintf(exceptionString, std::size(exceptionString), "0x%x", ex->ExceptionRecord->ExceptionCode); snprintf(exceptionString, std::size(exceptionString), "0x%x", ex->ExceptionRecord->ExceptionCode);
SPDLOG_CRITICAL("EXCEPTION {} occurred", exceptionString); WRITE_VAR_LINE(buffer, &curBufferPos, "Exception: ", exceptionString);
printStack(ex->ContextRecord); printStack(ex->ContextRecord, buffer, &curBufferPos);
MessageBox(nullptr, L"SoH Has crashed. Please upload the logs to the support channel in discord.", L"Crash", MB_OK | MB_ICONERROR); MessageBoxA(nullptr, "SoH Has crashed. Please upload the logs to the support channel in discord.", "Crash", MB_OK | MB_ICONERROR);
CrashHandler_PrintCommon(buffer, &curBufferPos);
return EXCEPTION_EXECUTE_HANDLER; return EXCEPTION_EXECUTE_HANDLER;
} }
#endif #endif
extern "C" void CrashHandler_Init(CrashHandlerCallback callback) {
#if defined(__linux__)
struct sigaction action;
struct sigaction shutdownAction;
action.sa_flags = SA_SIGINFO;
action.sa_sigaction = ErrorHandler;
sigaction(SIGILL, &action, nullptr);
sigaction(SIGABRT, &action, nullptr);
sigaction(SIGFPE, &action, nullptr);
sigaction(SIGSEGV, &action, nullptr);
shutdownAction.sa_flags = SA_SIGINFO;
shutdownAction.sa_sigaction = ShutdownHandler;
sigaction(SIGINT, &shutdownAction, nullptr);
sigaction(SIGTERM, &shutdownAction, nullptr);
sigaction(SIGQUIT, &shutdownAction, nullptr);
sigaction(SIGKILL, &shutdownAction, nullptr);
#elif _WIN32
SetUnhandledExceptionFilter(seh_filter);
#endif
sCallbackFunc = callback;
}

8
libultraship/libultraship/CrashHandler.h
View File

@ -1,19 +1,21 @@
#ifndef CRASH_HANDLER_H #ifndef CRASH_HANDLER_H
#define CRASH_HANDLER_H #define CRASH_HANDLER_H
#ifdef __linux__ #include <stddef.h>
typedef void(*CrashHandlerCallback)(char*, size_t*);
#ifdef __cplusplus #ifdef __cplusplus
extern "C" { extern "C" {
#endif #endif
void SetupHandlerLinux(void); void CrashHandler_Init(CrashHandlerCallback callback);
#ifdef __cplusplus #ifdef __cplusplus
} }
#endif #endif
#elif _WIN32 // __linux__ ^^^^ _WIN32 vvvvv #ifdef _WIN32
#include <windows.h> #include <windows.h>
#include <DbgHelp.h> #include <DbgHelp.h>

1
soh/CMakeLists.txt
View File

@ -263,6 +263,7 @@ set(Source_Files__soh
"soh/GameMenuBar.cpp" "soh/GameMenuBar.cpp"
"soh/UIWidgets.hpp" "soh/UIWidgets.hpp"
"soh/UIWidgets.cpp" "soh/UIWidgets.cpp"
"soh/CrashHandlerExt.cpp"
) )
source_group("Source Files\\soh" FILES ${Source_Files__soh}) source_group("Source Files\\soh" FILES ${Source_Files__soh})

12
soh/soh/CrashHandlerExp.h Normal file
View File

@ -0,0 +1,12 @@
#include <libultraship/CrashHandler.h>
#ifdef __cplusplus
extern "C" {
#endif
void CrashHandler_PrintSohData(char* buffer, size_t* pos);
#ifdef __cplusplus
}
#endif

179
soh/soh/CrashHandlerExt.cpp Normal file
View File

@ -0,0 +1,179 @@
#include "CrashHandlerExp.h"
#include "variables.h"
#include "z64.h"
#include "z64actor.h"
#include <string.h>
#include <stdio.h>
#include <array>
#define WRITE_VAR_LINE(buff, len, varName, varValue) \
append_str(buff, len, varName); \
append_line(buff, len, varValue);
#define WRITE_VAR(buff, len, varName, varValue) \
append_str(buff, len, varName); \
append_str(buff, len, varValue);
extern "C" GlobalContext* gGlobalCtx;
static std::array<const char*, ACTORCAT_MAX> sCatToStrArray{
"SWITCH", "BG", "PLAYER", "EXPLOSIVE", "NPC", "ENEMY", "PROP", "ITEMACTION", "MISC", "BOSS", "DOOR", "CHEST",
};
static std::array<const char*, SCENE_ID_MAX> sSceneIdToStrArray{
"SCENE_YDAN",
"SCENE_DDAN",
"SCENE_BDAN",
"SCENE_BMORI1",
"SCENE_HIDAN",
"SCENE_MIZUSIN",
"SCENE_JYASINZOU",
"SCENE_HAKADAN",
"SCENE_HAKADANCH",
"SCENE_ICE_DOUKUTO",
"SCENE_GANON",
"SCENE_MEN",
"SCENE_GERUDOWAY",
"SCENE_GANONTIKA",
"SCENE_GANON_SONOGO",
"SCENE_GANONTIKA_SONOGO",
"SCENE_TAKARAYA",
"SCENE_YDAN_BOSS",
"SCENE_DDAN_BOSS",
"SCENE_BDAN_BOSS",
"SCENE_MORIBOSSROOM",
"SCENE_FIRE_BS",
"SCENE_MIZUSIN_BS",
"SCENE_JYASINBOSS",
"SCENE_HAKADAN_BS",
"SCENE_GANON_BOSS",
"SCENE_GANON_FINAL",
"SCENE_ENTRA",
"SCENE_ENTRA_N",
"SCENE_ENRUI",
"SCENE_MARKET_ALLEY",
"SCENE_MARKET_ALLEY_N",
"SCENE_MARKET_DAY",
"SCENE_MARKET_NIGHT",
"SCENE_MARKET_RUINS",
"SCENE_SHRINE",
"SCENE_SHRINE_N",
"SCENE_SHRINE_R",
"SCENE_KOKIRI_HOME",
"SCENE_KOKIRI_HOME3",
"SCENE_KOKIRI_HOME4",
"SCENE_KOKIRI_HOME5",
"SCENE_KAKARIKO",
"SCENE_KAKARIKO3",
"SCENE_SHOP1",
"SCENE_KOKIRI_SHOP",
"SCENE_GOLON",
"SCENE_ZOORA",
"SCENE_DRAG",
"SCENE_ALLEY_SHOP",
"SCENE_NIGHT_SHOP",
"SCENE_FACE_SHOP",
"SCENE_LINK_HOME",
"SCENE_IMPA",
"SCENE_MALON_STABLE",
"SCENE_LABO",
"SCENE_HYLIA_LABO",
"SCENE_TENT",
"SCENE_HUT",
"SCENE_DAIYOUSEI_IZUMI",
"SCENE_YOUSEI_IZUMI_TATE",
"SCENE_YOUSEI_IZUMI_YOKO",
"SCENE_KAKUSIANA",
"SCENE_HAKAANA",
"SCENE_HAKAANA2",
"SCENE_HAKAANA_OUKE",
"SCENE_SYATEKIJYOU",
"SCENE_TOKINOMA",
"SCENE_KENJYANOMA",
"SCENE_HAIRAL_NIWA",
"SCENE_HAIRAL_NIWA_N",
"SCENE_HIRAL_DEMO",
"SCENE_HAKASITARELAY",
"SCENE_TURIBORI",
"SCENE_NAKANIWA",
"SCENE_BOWLING",
"SCENE_SOUKO",
"SCENE_MIHARIGOYA",
"SCENE_MAHOUYA",
"SCENE_GANON_DEMO",
"SCENE_KINSUTA",
"SCENE_SPOT00",
"SCENE_SPOT01",
"SCENE_SPOT02",
"SCENE_SPOT03",
"SCENE_SPOT04",
"SCENE_SPOT05",
"SCENE_SPOT06",
"SCENE_SPOT07",
"SCENE_SPOT08",
"SCENE_SPOT09",
"SCENE_SPOT10",
"SCENE_SPOT11",
"SCENE_SPOT12",
"SCENE_SPOT13",
"SCENE_SPOT15",
"SCENE_SPOT16",
"SCENE_SPOT17",
"SCENE_SPOT18",
"SCENE_SPOT20",
"SCENE_GANON_TOU",
};
static void append_str(char* buf, size_t* len, const char* str) {
while (*str != '\0')
buf[(*len)++] = *str++;
}
static void append_line(char* buf, size_t* len, const char* str) {
while (*str != '\0')
buf[(*len)++] = *str++;
buf[(*len)++] = '\n';
}
static void CrashHandler_WriteActorData(char* buffer, size_t* pos) {
char intCharBuffer[16];
append_line(buffer, pos, "Actor Id Params");
for (unsigned int i = 0; i < ACTORCAT_MAX; i++) {
ActorListEntry* entry = &gGlobalCtx->actorCtx.actorLists[i];
Actor* cur;
if(entry->length == 0) {
continue;
}
WRITE_VAR_LINE(buffer, pos, "Actor Cat: ", sCatToStrArray[i]);
cur = entry->head;
while (cur != nullptr) {
// Actor ID
snprintf(intCharBuffer, sizeof(intCharBuffer), "0x%03X ", cur->id);
append_str(buffer, pos, intCharBuffer);
// Actor Params
snprintf(intCharBuffer, sizeof(intCharBuffer), "0x%04X", cur->params);
append_line(buffer, pos, intCharBuffer);
cur = cur->next;
}
}
}
extern "C" void CrashHandler_PrintSohData(char* buffer, size_t* pos) {
char intCharBuffer[16];
append_line(buffer, pos, "Build Information:");
WRITE_VAR_LINE(buffer, pos, "Game Version: ", (const char*)gBuildVersion);
WRITE_VAR_LINE(buffer, pos, "Build Date: ", (const char*)gBuildDate);
if (gGlobalCtx != nullptr) {
append_line(buffer, pos, "Actors:");
CrashHandler_WriteActorData(buffer, pos);
WRITE_VAR_LINE(buffer, pos, "Scene: ", sSceneIdToStrArray[gGlobalCtx->sceneNum]);
snprintf(intCharBuffer, sizeof(intCharBuffer), "%i", gGlobalCtx->roomCtx.curRoom.num);
WRITE_VAR_LINE(buffer, pos, "Room: ", intCharBuffer);
}
}

7
soh/src/code/main.c
View File

@ -4,6 +4,7 @@
#include "soh/OTRGlobals.h" #include "soh/OTRGlobals.h"
#include <libultraship/CrashHandler.h> #include <libultraship/CrashHandler.h>
#include "soh/CrashHandlerExp.h"
s32 gScreenWidth = SCREEN_WIDTH; s32 gScreenWidth = SCREEN_WIDTH;
@ -44,11 +45,7 @@ int APIENTRY WinMain(HINSTANCE hInst, HINSTANCE hInstPrev, PSTR cmdline, int cmd
int main(int argc, char** argv) int main(int argc, char** argv)
#endif #endif
{ {
#ifdef __linux__ CrashHandler_Init(CrashHandler_PrintSohData);
SetupHandlerLinux();
#elif _WIN32
SetUnhandledExceptionFilter(seh_filter);
#endif
GameConsole_Init(); GameConsole_Init();
InitOTR(); InitOTR();