//=============================================================================// // // Purpose: Crash handler (overrides the game's implementation!) // //=============================================================================// #include "core/stdafx.h" #include "core/logdef.h" #include "tier0/cpu.h" #include "tier0/crashhandler.h" #include "public/utility/binstream.h" //----------------------------------------------------------------------------- // Purpose: //----------------------------------------------------------------------------- void CCrashHandler::Start() { Lock(); m_bExceptionHandled = true; } //----------------------------------------------------------------------------- // Purpose: //----------------------------------------------------------------------------- void CCrashHandler::End() { m_bExceptionHandled = false; Unlock(); } //----------------------------------------------------------------------------- // Purpose: formats the crasher (module, address and exception) //----------------------------------------------------------------------------- void CCrashHandler::FormatCrash() { m_svBuffer.append("crash:\n{\n"); FormatExceptionAddress(); FormatExceptionCode(); m_svBuffer.append("}\n"); } //----------------------------------------------------------------------------- // Purpose: formats the captured callstack //----------------------------------------------------------------------------- void CCrashHandler::FormatCallstack() { m_svBuffer.append("callstack:\n{\n"); if (m_nCapturedFrames) { PEXCEPTION_RECORD pExceptionRecord = m_pExceptionPointers->ExceptionRecord; if (m_ppStackTrace[m_nCapturedFrames - 1] == pExceptionRecord->ExceptionAddress) { PCONTEXT pContextRecord = m_pExceptionPointers->ContextRecord; MEMORY_BASIC_INFORMATION mbi = { 0 }; SIZE_T t = VirtualQuery((LPCVOID)pContextRecord->Rsp, &mbi, sizeof(LPCVOID)); if (t >= sizeof(mbi) && !(mbi.Protect & PAGE_NOACCESS) && (mbi.Protect & PAGE_READONLY | PAGE_READWRITE) && (mbi.State & MEM_COMMIT)) { m_svBuffer.append("\t// call stack ended; possible return address?\n"); } } } for (WORD i = 0; i < m_nCapturedFrames; i++) { FormatExceptionAddress(reinterpret_cast(m_ppStackTrace[i])); } m_svBuffer.append("}\n"); } //----------------------------------------------------------------------------- // Purpose: formats all the registers and their contents //----------------------------------------------------------------------------- void CCrashHandler::FormatRegisters() { m_svBuffer.append("registers:\n{\n"); PCONTEXT pContextRecord = m_pExceptionPointers->ContextRecord; FormatALU("rax", pContextRecord->Rax); FormatALU("rbx", pContextRecord->Rbx); FormatALU("rcx", pContextRecord->Rcx); FormatALU("rdx", pContextRecord->Rdx); FormatALU("rsp", pContextRecord->Rsp); FormatALU("rbp", pContextRecord->Rbp); FormatALU("rsi", pContextRecord->Rsi); FormatALU("rdi", pContextRecord->Rdi); FormatALU("r8 ", pContextRecord->R8); FormatALU("r9 ", pContextRecord->R9); FormatALU("r10", pContextRecord->R10); FormatALU("r11", pContextRecord->R11); FormatALU("r12", pContextRecord->R12); FormatALU("r13", pContextRecord->R13); FormatALU("r14", pContextRecord->R14); FormatALU("r15", pContextRecord->R15); FormatALU("rip", pContextRecord->Rip); FormatFPU("xmm0 ", &pContextRecord->Xmm0); FormatFPU("xmm1 ", &pContextRecord->Xmm1); FormatFPU("xmm2 ", &pContextRecord->Xmm2); FormatFPU("xmm3 ", &pContextRecord->Xmm3); FormatFPU("xmm4 ", &pContextRecord->Xmm4); FormatFPU("xmm5 ", &pContextRecord->Xmm5); FormatFPU("xmm6 ", &pContextRecord->Xmm6); FormatFPU("xmm7 ", &pContextRecord->Xmm7); FormatFPU("xmm8 ", &pContextRecord->Xmm8); FormatFPU("xmm9 ", &pContextRecord->Xmm9); FormatFPU("xmm10", &pContextRecord->Xmm10); FormatFPU("xmm11", &pContextRecord->Xmm11); FormatFPU("xmm12", &pContextRecord->Xmm12); FormatFPU("xmm13", &pContextRecord->Xmm13); FormatFPU("xmm14", &pContextRecord->Xmm14); FormatFPU("xmm15", &pContextRecord->Xmm15); m_svBuffer.append("}\n"); } //----------------------------------------------------------------------------- // Purpose: formats all loaded modules (verbose) //----------------------------------------------------------------------------- void CCrashHandler::FormatModules() { m_svBuffer.append("modules:\n{\n"); std::unique_ptr hModule(new HMODULE[4096]); HANDLE hProcess = GetCurrentProcess(); DWORD cbNeeded; BOOL result = K32EnumProcessModulesEx(hProcess, &*hModule.get(), 4096, &cbNeeded, LIST_MODULES_ALL); if (result && cbNeeded <= 4096 && cbNeeded >> 3) { CHAR szModuleName[512]; LPSTR pszModuleName; MODULEINFO modInfo; for (DWORD i = 0, j = cbNeeded >> 3; j; i++, j--) { DWORD m = GetModuleFileNameA(&*hModule.get()[i], szModuleName, sizeof(szModuleName)); if ((m - 1) > (sizeof(szModuleName) - 2)) // Too small for buffer. { snprintf(szModuleName, sizeof(szModuleName), "module@%p", &*hModule.get()[i]); pszModuleName = szModuleName; } else { pszModuleName = strrchr(szModuleName, '\\') + 1; } K32GetModuleInformation(hProcess, &*hModule.get()[i], &modInfo, sizeof(modInfo)); m_svBuffer.append(fmt::format("\t{:15s}: [0x{:016X}, 0x{:016X}]\n", pszModuleName, reinterpret_cast(modInfo.lpBaseOfDll), static_cast((reinterpret_cast(modInfo.lpBaseOfDll) + modInfo.SizeOfImage)))); } } m_svBuffer.append("}\n"); } //----------------------------------------------------------------------------- // Purpose: formats the system information //----------------------------------------------------------------------------- void CCrashHandler::FormatSystemInfo() { m_svBuffer.append("system:\n{\n"); const CPUInformation& pi = GetCPUInformation(); m_svBuffer.append(fmt::format("\tcpu_model = \"{:s}\"\n", pi.m_szProcessorBrand)); m_svBuffer.append(fmt::format("\tcpu_speed = {:010d} // clock cycles\n", pi.m_Speed)); for (DWORD i = 0; ; i++) { DISPLAY_DEVICE dd = { sizeof(dd), 0 }; BOOL f = EnumDisplayDevices(NULL, i, &dd, EDD_GET_DEVICE_INTERFACE_NAME); if (!f) { break; } if (dd.StateFlags & DISPLAY_DEVICE_PRIMARY_DEVICE) // The primary device is the only relevant device. { char szDeviceName[128]; wcstombs(szDeviceName, dd.DeviceString, sizeof(szDeviceName)); m_svBuffer.append(fmt::format("\tgpu_model = \"{:s}\"\n", szDeviceName)); m_svBuffer.append(fmt::format("\tgpu_flags = 0x{:08X} // primary device\n", dd.StateFlags)); } } MEMORYSTATUSEX statex{}; statex.dwLength = sizeof(statex); if (GlobalMemoryStatusEx(&statex)) { m_svBuffer.append(fmt::format("\tram_total = [{:010d}, {:010d}] // physical/virtual (MiB)\n", (statex.ullTotalPhys / 1024) / 1024, (statex.ullTotalVirtual / 1024) / 1024)); m_svBuffer.append(fmt::format("\tram_avail = [{:010d}, {:010d}] // physical/virtual (MiB)\n", (statex.ullAvailPhys / 1024) / 1024, (statex.ullAvailVirtual / 1024) / 1024)); } m_svBuffer.append("}\n"); } //----------------------------------------------------------------------------- // Purpose: formats the build information //----------------------------------------------------------------------------- void CCrashHandler::FormatBuildInfo() { m_svBuffer.append(fmt::format("build_id: {:d}\n", g_SDKDll.m_pNTHeaders->FileHeader.TimeDateStamp)); } //----------------------------------------------------------------------------- // Purpose: formats the module, address and exception //----------------------------------------------------------------------------- void CCrashHandler::FormatExceptionAddress() { FormatExceptionAddress(static_cast(m_pExceptionPointers->ExceptionRecord->ExceptionAddress)); } //----------------------------------------------------------------------------- // Purpose: formats the module, address and exception // Input : pExceptionAddress - //----------------------------------------------------------------------------- void CCrashHandler::FormatExceptionAddress(LPCSTR pExceptionAddress) { HMODULE hCrashedModule; if (!GetModuleHandleExA(GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS | GET_MODULE_HANDLE_EX_FLAG_UNCHANGED_REFCOUNT, pExceptionAddress, &hCrashedModule)) { m_svBuffer.append(fmt::format("\t!!!unknown-module!!!: 0x{:016X}\n", reinterpret_cast(pExceptionAddress))); m_nCrashMsgFlags = 0; // Display the "unknown DLL or EXE" message. return; } LPCSTR pModuleBase = reinterpret_cast(pExceptionAddress - reinterpret_cast(hCrashedModule)); CHAR szCrashedModuleFullName[512]; if (GetModuleFileNameExA(GetCurrentProcess(), hCrashedModule, szCrashedModuleFullName, sizeof(szCrashedModuleFullName)) - 1 > 0x1FE) { m_svBuffer.append(fmt::format("\tmodule@{:016X}: 0x{:016X}\n", (void*)hCrashedModule, reinterpret_cast(pModuleBase))); m_nCrashMsgFlags = 2; // Display the "Apex crashed" message without additional information regarding the module. return; } // TODO: REMOVE EXT. const CHAR* szCrashedModuleName = strrchr(szCrashedModuleFullName, '\\') + 1; m_svBuffer.append(fmt::format("\t{:15s}: 0x{:016X}\n", szCrashedModuleName, reinterpret_cast(pModuleBase))); m_nCrashMsgFlags = 1; // Display the "Apex crashed in " message. if (m_svCrashMsgInfo.empty()) // Only set it once to the crashing module. { m_svCrashMsgInfo = szCrashedModuleName; } } //----------------------------------------------------------------------------- // Purpose: formats the exception code //----------------------------------------------------------------------------- void CCrashHandler::FormatExceptionCode() { DWORD nExceptionCode = m_pExceptionPointers->ExceptionRecord->ExceptionCode; if (nExceptionCode > EXCEPTION_IN_PAGE_ERROR) { m_svBuffer.append(fmt::format(ExceptionToString(), nExceptionCode)); } else if (nExceptionCode >= EXCEPTION_ACCESS_VIOLATION) { const CHAR* pszException = "EXCEPTION_IN_PAGE_ERROR"; if (nExceptionCode == EXCEPTION_ACCESS_VIOLATION) { pszException = "EXCEPTION_ACCESS_VIOLATION"; } ULONG_PTR uExceptionInfo0 = m_pExceptionPointers->ExceptionRecord->ExceptionInformation[0]; ULONG_PTR uExceptionInfo1 = m_pExceptionPointers->ExceptionRecord->ExceptionInformation[1]; if (uExceptionInfo0) { if (uExceptionInfo0 == 1) { m_svBuffer.append(fmt::format("\t{:s}(write): 0x{:016X}\n", pszException, uExceptionInfo1)); } else if (uExceptionInfo0 == 8) { m_svBuffer.append(fmt::format("\t{:s}(execute): 0x{:016X}\n", pszException, uExceptionInfo1)); } else { m_svBuffer.append(fmt::format("\t{:s}(unknown): 0x{:016X}\n", pszException, uExceptionInfo1)); } } else { m_svBuffer.append(fmt::format("\t{:s}(read): 0x{:016X}\n", pszException, uExceptionInfo1)); } if (uExceptionInfo0 != 8) { if (IsPageAccessible()) { FormatExceptionAddress(); } } } else { m_svBuffer.append(fmt::format(ExceptionToString(), nExceptionCode)); } } //----------------------------------------------------------------------------- // Purpose: formats the arithmetic logic register and its content // Input : *pszRegister - // nContent - //----------------------------------------------------------------------------- void CCrashHandler::FormatALU(const CHAR* pszRegister, DWORD64 nContent) { if (nContent >= 1000000) { if (nContent > UINT_MAX) { m_svBuffer.append(fmt::format("\t{:s} = 0x{:016X}\n", pszRegister, nContent)); } else { m_svBuffer.append(fmt::format("\t{:s} = 0x{:08X}\n", pszRegister, nContent)); } } else // Display as decimal. { m_svBuffer.append(fmt::format("\t{:s} = {:<15d}\n", pszRegister, nContent)); if (nContent >= 10) { const string& svDesc = fmt::format(" // 0x{:08X}\n", nContent); m_svBuffer.replace(m_svBuffer.length()-1, svDesc.size(), svDesc); } } } //----------------------------------------------------------------------------- // Purpose: formats the floating point register and its content // Input : *pszRegister - // *pxContent - //----------------------------------------------------------------------------- void CCrashHandler::FormatFPU(const CHAR* pszRegister, M128A* pxContent) { DWORD nVec[4] = { pxContent->Low & UINT_MAX, pxContent->Low >> 32, pxContent->High & UINT_MAX, pxContent->High >> 32, }; m_svBuffer.append(fmt::format("\t{:s} = [ [{:.8g}, {:.8g}, {:.8g}, {:.8g}]", pszRegister, *reinterpret_cast(&nVec[0]), *reinterpret_cast(&nVec[1]), *reinterpret_cast(&nVec[2]), *reinterpret_cast(&nVec[3]))); const CHAR* pszVectorFormat = ", [{:d}, {:d}, {:d}, {:d}] ]\n"; LONG nHighest = static_cast(*std::max_element(nVec, nVec + SDK_ARRAYSIZE(nVec))); if (nHighest <= -1000000 || nHighest >= 1000000) { pszVectorFormat = ", [0x{:08X}, 0x{:08X}, 0x{:08X}, 0x{:08X}] ]\n"; m_svBuffer.append(fmt::format(pszVectorFormat, nVec[0], nVec[1], nVec[2], nVec[3])); } else { m_svBuffer.append(fmt::format(pszVectorFormat, static_cast(nVec[0]), static_cast(nVec[1]), static_cast(nVec[2]), static_cast(nVec[3]))); } } //----------------------------------------------------------------------------- // Purpose: returns the current exception code as string // Output : exception code, "UNKNOWN_EXCEPTION" if exception code doesn't exist in this context //----------------------------------------------------------------------------- const CHAR* CCrashHandler::ExceptionToString(DWORD nExceptionCode) const { switch (nExceptionCode) { case EXCEPTION_BREAKPOINT: { return "\tEXCEPTION_BREAKPOINT" ": 0x{:08X}\n"; }; case EXCEPTION_SINGLE_STEP: { return "\tEXCEPTION_SINGLE_STEP" ": 0x{:08X}\n"; }; case EXCEPTION_ACCESS_VIOLATION: { return "\tEXCEPTION_ACCESS_VIOLATION" ": 0x{:08X}\n"; }; case EXCEPTION_IN_PAGE_ERROR: { return "\tEXCEPTION_IN_PAGE_ERROR" ": 0x{:08X}\n"; }; case EXCEPTION_ARRAY_BOUNDS_EXCEEDED: { return "\tEXCEPTION_ARRAY_BOUNDS_EXCEEDED" ": 0x{:08X}\n"; }; case EXCEPTION_ILLEGAL_INSTRUCTION: { return "\tEXCEPTION_ILLEGAL_INSTRUCTION" ": 0x{:08X}\n"; }; case EXCEPTION_INVALID_DISPOSITION: { return "\tEXCEPTION_INVALID_DISPOSITION" ": 0x{:08X}\n"; }; case EXCEPTION_NONCONTINUABLE_EXCEPTION: { return "\tEXCEPTION_NONCONTINUABLE_EXCEPTION" ": 0x{:08X}\n"; }; case EXCEPTION_PRIV_INSTRUCTION: { return "\tEXCEPTION_PRIV_INSTRUCTION" ": 0x{:08X}\n"; }; case EXCEPTION_STACK_OVERFLOW: { return "\tEXCEPTION_STACK_OVERFLOW" ": 0x{:08X}\n"; }; case EXCEPTION_DATATYPE_MISALIGNMENT: { return "\tEXCEPTION_DATATYPE_MISALIGNMENT" ": 0x{:08X}\n"; }; case EXCEPTION_FLT_DENORMAL_OPERAND: { return "\tEXCEPTION_FLT_DENORMAL_OPERAND" ": 0x{:08X}\n"; }; case EXCEPTION_FLT_DIVIDE_BY_ZERO: { return "\tEXCEPTION_FLT_DIVIDE_BY_ZERO" ": 0x{:08X}\n"; }; case EXCEPTION_FLT_INEXACT_RESULT: { return "\tEXCEPTION_FLT_INEXACT_RESULT" ": 0x{:08X}\n"; }; case EXCEPTION_FLT_INVALID_OPERATION: { return "\tEXCEPTION_FLT_INVALID_OPERATION" ": 0x{:08X}\n"; }; case EXCEPTION_FLT_OVERFLOW: { return "\tEXCEPTION_FLT_OVERFLOW" ": 0x{:08X}\n"; }; case EXCEPTION_FLT_STACK_CHECK: { return "\tEXCEPTION_FLT_STACK_CHECK" ": 0x{:08X}\n"; }; case EXCEPTION_FLT_UNDERFLOW: { return "\tEXCEPTION_FLT_UNDERFLOW" ": 0x{:08X}\n"; }; case EXCEPTION_INT_DIVIDE_BY_ZERO: { return "\tEXCEPTION_INT_DIVIDE_BY_ZERO" ": 0x{:08X}\n"; }; case EXCEPTION_INT_OVERFLOW: { return "\tEXCEPTION_INT_OVERFLOW" ": 0x{:08X}\n"; }; default: { return "\tUNKNOWN_EXCEPTION" ": 0x{:08X}\n"; }; } } //----------------------------------------------------------------------------- // Purpose: returns the current exception code as string //----------------------------------------------------------------------------- const char* CCrashHandler::ExceptionToString() const { return ExceptionToString(m_pExceptionPointers->ExceptionRecord->ExceptionCode); } //----------------------------------------------------------------------------- // Purpose: tests if memory page is accessible // Output : true if accessible, false otherwise //----------------------------------------------------------------------------- bool CCrashHandler::IsPageAccessible() const { PCONTEXT pContextRecord = m_pExceptionPointers->ContextRecord; MEMORY_BASIC_INFORMATION mbi = { 0 }; SIZE_T t = VirtualQuery((LPCVOID)pContextRecord->Rsp, &mbi, sizeof(LPCVOID)); if (t < sizeof(mbi) || (mbi.Protect & PAGE_NOACCESS) || !(mbi.Protect & PAGE_NOACCESS | PAGE_READWRITE)) { return false; } else { return !(mbi.State & MEM_COMMIT); } return false; } //----------------------------------------------------------------------------- // Purpose: captures the callstack //----------------------------------------------------------------------------- void CCrashHandler::GetCallStack() { m_nCapturedFrames = RtlCaptureStackBackTrace(2, NUM_FRAMES_TO_CAPTURE, m_ppStackTrace, NULL); } //----------------------------------------------------------------------------- // Purpose: adds a whitelist exception address //----------------------------------------------------------------------------- void CCrashHandler::AddWhitelist(void* pWhitelist) { m_WhiteList.insert(pWhitelist); } //----------------------------------------------------------------------------- // Purpose: removes a whitelist exception address //----------------------------------------------------------------------------- void CCrashHandler::RemoveWhitelist(void* pWhitelist) { m_WhiteList.erase(pWhitelist); } //----------------------------------------------------------------------------- // Purpose: checks if callstack contains whitelisted addresses up to 'MAX_IMI_SEARCH' frames. // Output : true is exist, false otherwise //----------------------------------------------------------------------------- bool CCrashHandler::HasWhitelist() { for (WORD i = 0; i < MAX_IMI_SEARCH; i++) { if (m_WhiteList.count(m_ppStackTrace[i])) { return true; } } return false; } //----------------------------------------------------------------------------- // Purpose: writes the formatted exception buffer to a file on the disk //----------------------------------------------------------------------------- void CCrashHandler::WriteFile() { string svLogDirectory = fmt::format("{:s}{:s}", g_svLogSessionDirectory, "apex_crash.txt"); CIOStream ioLogFile(svLogDirectory, CIOStream::Mode_t::WRITE); ioLogFile.WriteString(m_svBuffer); } //----------------------------------------------------------------------------- // Purpose: creates the crashmsg process displaying the error to the user // the process has to be separate as the current process is getting killed //----------------------------------------------------------------------------- void CCrashHandler::CreateMessageProcess() { if (m_bCrashMsgCreated) { return; // CrashMsg already displayed. } m_bCrashMsgCreated = true; PEXCEPTION_RECORD pExceptionRecord = m_pExceptionPointers->ExceptionRecord; PCONTEXT pContextRecord = m_pExceptionPointers->ContextRecord; if (pExceptionRecord->ExceptionCode == 0xC0000005 && pExceptionRecord->ExceptionInformation[0] == 8 && pExceptionRecord->ExceptionInformation[1] != pContextRecord->Rip) { m_svCrashMsgInfo = "bin\\crashmsg.exe overclock"; } else { m_svCrashMsgInfo = fmt::format("bin\\crashmsg.exe crash {:d} \"{:s}\"", m_nCrashMsgFlags, m_svCrashMsgInfo); } PROCESS_INFORMATION processInfo; STARTUPINFOA startupInfo = { 0 }; startupInfo.cb = sizeof(STARTUPINFOA); if (CreateProcessA(NULL, (LPSTR)m_svCrashMsgInfo.c_str(), NULL, NULL, TRUE, CREATE_NO_WINDOW, NULL, NULL, &startupInfo, &processInfo)) { CloseHandle(processInfo.hProcess); CloseHandle(processInfo.hThread); } } //----------------------------------------------------------------------------- // Purpose: // Input : // Output : //----------------------------------------------------------------------------- long __stdcall BottomLevelExceptionFilter(EXCEPTION_POINTERS* pExceptionInfo) { g_CrashHandler->Start(); g_CrashHandler->SetExceptionPointers(pExceptionInfo); // Let the higher level exception handlers deal with this particular exception. if (g_CrashHandler->ExceptionToString() == g_CrashHandler->ExceptionToString(-1)) { g_CrashHandler->End(); return EXCEPTION_CONTINUE_SEARCH; } // Don't run when a debugger is present. if (IsDebuggerPresent()) { g_CrashHandler->End(); return EXCEPTION_CONTINUE_SEARCH; } g_CrashHandler->GetCallStack(); // Don't run filter when exception return address is in whitelist. // This is useful for when we want to use a different exception handler instead. if (g_CrashHandler->HasWhitelist()) { g_CrashHandler->End(); return EXCEPTION_CONTINUE_SEARCH; } // Kill on recursive call. if (g_CrashHandler->GetState()) ExitProcess(1u); g_CrashHandler->SetState(true); g_CrashHandler->FormatCrash(); g_CrashHandler->FormatCallstack(); g_CrashHandler->FormatRegisters(); g_CrashHandler->FormatModules(); g_CrashHandler->FormatSystemInfo(); g_CrashHandler->FormatBuildInfo(); g_CrashHandler->WriteFile(); g_CrashHandler->CreateMessageProcess(); // Display the message to the user. // Don't end, just unlock the mutex so the next call kills the process. g_CrashHandler->Unlock(); return EXCEPTION_EXECUTE_HANDLER; } //----------------------------------------------------------------------------- // Purpose: //----------------------------------------------------------------------------- void CCrashHandler::Init() { m_hExceptionHandler = AddVectoredExceptionHandler(TRUE, BottomLevelExceptionFilter); } //----------------------------------------------------------------------------- // Purpose: //----------------------------------------------------------------------------- void CCrashHandler::Shutdown() { if (m_hExceptionHandler) { RemoveVectoredExceptionHandler(m_hExceptionHandler); m_hExceptionHandler = nullptr; } } //----------------------------------------------------------------------------- // Purpose: //----------------------------------------------------------------------------- CCrashHandler::CCrashHandler() : m_ppStackTrace() , m_pExceptionPointers(nullptr) , m_nCapturedFrames(0) , m_nCrashMsgFlags(0) , m_bCallState(false) , m_bExceptionHandled(false) , m_bCrashMsgCreated(false) { Init(); } //----------------------------------------------------------------------------- // Purpose: //----------------------------------------------------------------------------- CCrashHandler::~CCrashHandler() { Shutdown(); } CCrashHandler* g_CrashHandler = new CCrashHandler();