10 #include "../../stdafx.h"
11 #include "../../crashlog.h"
13 #include "../../core/alloc_func.hpp"
14 #include "../../core/math_func.hpp"
15 #include "../../string_func.h"
16 #include "../../fileio_func.h"
17 #include "../../strings_func.h"
18 #include "../../gamelog.h"
19 #include "../../saveload/saveload.h"
20 #include "../../video/video_driver.hpp"
26 #include "../../safeguards.h"
30 #define PRINTF_PTR "0x%016IX"
32 #define PRINTF_PTR "0x%08X"
40 EXCEPTION_POINTERS *
ep;
42 char *
LogOSVersion(
char *buffer,
const char *last)
const override;
43 char *
LogError(
char *buffer,
const char *last,
const char *
message)
const override;
44 char *
LogStacktrace(
char *buffer,
const char *last)
const override;
45 char *
LogRegisters(
char *buffer,
const char *last)
const override;
46 char *
LogModules(
char *buffer,
const char *last)
const override;
49 int WriteCrashDump(
char *filename,
const char *filename_last)
const override;
50 char *AppendDecodedStacktrace(
char *buffer,
const char *last)
const;
52 char *AppendDecodedStacktrace(
char *buffer,
const char *last)
const {
return buffer; }
71 this->crashlog[0] =
'\0';
72 this->crashlog_filename[0] =
'\0';
73 this->crashdump_filename[0] =
'\0';
74 this->screenshot_filename[0] =
'\0';
88 os.dwOSVersionInfoSize =
sizeof(os);
91 return buffer +
seprintf(buffer, last,
94 " Release: %d.%d.%d (%s)\n",
95 (
int)os.dwMajorVersion,
96 (
int)os.dwMinorVersion,
97 (
int)os.dwBuildNumber,
105 return buffer +
seprintf(buffer, last,
109 " Location: %.16IX\n"
114 (
int)
ep->ExceptionRecord->ExceptionCode,
115 (
size_t)
ep->ExceptionRecord->ExceptionAddress,
123 SYSTEMTIME file_time;
126 static uint32 *_crc_table;
128 static void MakeCRCTable(uint32 *table)
130 uint32 crc, poly = 0xEDB88320L;
136 for (i = 0; i != 256; i++) {
138 for (j = 8; j != 0; j--) {
139 crc = (crc & 1 ? (crc >> 1) ^ poly : crc >> 1);
145 static uint32 CalcCRC(
byte *data, uint size, uint32 crc)
147 for (; size > 0; size--) {
148 crc = ((crc >> 8) & 0x00FFFFFF) ^ _crc_table[(crc ^ *data++) & 0xFF];
153 static void GetFileInfo(
DebugFileInfo *dfi,
const wchar_t *filename)
156 memset(dfi, 0,
sizeof(*dfi));
158 file = CreateFile(filename, GENERIC_READ, FILE_SHARE_READ,
nullptr, OPEN_EXISTING, 0, 0);
159 if (file != INVALID_HANDLE_VALUE) {
164 uint32 crc = (uint32)-1;
167 if (ReadFile(file, buffer,
sizeof(buffer), &numread,
nullptr) == 0 || numread == 0) {
171 crc = CalcCRC(buffer, numread, crc);
173 dfi->size = filesize;
174 dfi->crc32 = crc ^ (uint32)-1;
176 if (GetFileTime(file,
nullptr,
nullptr, &write_time)) {
177 FileTimeToSystemTime(&write_time, &dfi->file_time);
184 static char *PrintModuleInfo(
char *output,
const char *last, HMODULE mod)
186 wchar_t buffer[MAX_PATH];
189 GetModuleFileName(mod, buffer, MAX_PATH);
190 GetFileInfo(&dfi, buffer);
191 output +=
seprintf(output, last,
" %-20s handle: %p size: %d crc: %.8X date: %d-%.2d-%.2d %.2d:%.2d:%.2d\n",
197 dfi.file_time.wMonth,
200 dfi.file_time.wMinute,
201 dfi.file_time.wSecond
208 MakeCRCTable(
AllocaM(uint32, 256));
209 BOOL (WINAPI *EnumProcessModules)(HANDLE, HMODULE*, DWORD, LPDWORD);
211 output +=
seprintf(output, last,
"Module information:\n");
213 if (
LoadLibraryList((Function*)&EnumProcessModules,
"psapi.dll\0EnumProcessModules\0\0")) {
214 HMODULE modules[100];
218 HANDLE proc = OpenProcess(PROCESS_ALL_ACCESS, FALSE, GetCurrentProcessId());
219 if (proc !=
nullptr) {
220 res = EnumProcessModules(proc, modules,
sizeof(modules), &needed);
223 size_t count = std::min<DWORD>(needed /
sizeof(HMODULE),
lengthof(modules));
225 for (
size_t i = 0; i != count; i++) output = PrintModuleInfo(output, last, modules[i]);
226 return output +
seprintf(output, last,
"\n");
230 output = PrintModuleInfo(output, last,
nullptr);
231 return output +
seprintf(output, last,
"\n");
236 buffer +=
seprintf(buffer, last,
"Registers:\n");
239 " RAX: %.16I64X RBX: %.16I64X RCX: %.16I64X RDX: %.16I64X\n"
240 " RSI: %.16I64X RDI: %.16I64X RBP: %.16I64X RSP: %.16I64X\n"
241 " R8: %.16I64X R9: %.16I64X R10: %.16I64X R11: %.16I64X\n"
242 " R12: %.16I64X R13: %.16I64X R14: %.16I64X R15: %.16I64X\n"
243 " RIP: %.16I64X EFLAGS: %.8lX\n",
244 ep->ContextRecord->Rax,
245 ep->ContextRecord->Rbx,
246 ep->ContextRecord->Rcx,
247 ep->ContextRecord->Rdx,
248 ep->ContextRecord->Rsi,
249 ep->ContextRecord->Rdi,
250 ep->ContextRecord->Rbp,
251 ep->ContextRecord->Rsp,
252 ep->ContextRecord->R8,
253 ep->ContextRecord->R9,
254 ep->ContextRecord->R10,
255 ep->ContextRecord->R11,
256 ep->ContextRecord->R12,
257 ep->ContextRecord->R13,
258 ep->ContextRecord->R14,
259 ep->ContextRecord->R15,
260 ep->ContextRecord->Rip,
261 ep->ContextRecord->EFlags
263 #elif defined(_M_IX86)
265 " EAX: %.8X EBX: %.8X ECX: %.8X EDX: %.8X\n"
266 " ESI: %.8X EDI: %.8X EBP: %.8X ESP: %.8X\n"
267 " EIP: %.8X EFLAGS: %.8X\n",
268 (
int)
ep->ContextRecord->Eax,
269 (
int)
ep->ContextRecord->Ebx,
270 (
int)
ep->ContextRecord->Ecx,
271 (
int)
ep->ContextRecord->Edx,
272 (
int)
ep->ContextRecord->Esi,
273 (
int)
ep->ContextRecord->Edi,
274 (
int)
ep->ContextRecord->Ebp,
275 (
int)
ep->ContextRecord->Esp,
276 (
int)
ep->ContextRecord->Eip,
277 (
int)
ep->ContextRecord->EFlags
279 #elif defined(_M_ARM64)
281 " X0: %.16I64X X1: %.16I64X X2: %.16I64X X3: %.16I64X\n"
282 " X4: %.16I64X X5: %.16I64X X6: %.16I64X X7: %.16I64X\n"
283 " X8: %.16I64X X9: %.16I64X X10: %.16I64X X11: %.16I64X\n"
284 " X12: %.16I64X X13: %.16I64X X14: %.16I64X X15: %.16I64X\n"
285 " X16: %.16I64X X17: %.16I64X X18: %.16I64X X19: %.16I64X\n"
286 " X20: %.16I64X X21: %.16I64X X22: %.16I64X X23: %.16I64X\n"
287 " X24: %.16I64X X25: %.16I64X X26: %.16I64X X27: %.16I64X\n"
288 " X28: %.16I64X Fp: %.16I64X Lr: %.16I64X\n",
289 ep->ContextRecord->X0,
290 ep->ContextRecord->X1,
291 ep->ContextRecord->X2,
292 ep->ContextRecord->X3,
293 ep->ContextRecord->X4,
294 ep->ContextRecord->X5,
295 ep->ContextRecord->X6,
296 ep->ContextRecord->X7,
297 ep->ContextRecord->X8,
298 ep->ContextRecord->X9,
299 ep->ContextRecord->X10,
300 ep->ContextRecord->X11,
301 ep->ContextRecord->X12,
302 ep->ContextRecord->X13,
303 ep->ContextRecord->X14,
304 ep->ContextRecord->X15,
305 ep->ContextRecord->X16,
306 ep->ContextRecord->X17,
307 ep->ContextRecord->X18,
308 ep->ContextRecord->X19,
309 ep->ContextRecord->X20,
310 ep->ContextRecord->X21,
311 ep->ContextRecord->X22,
312 ep->ContextRecord->X23,
313 ep->ContextRecord->X24,
314 ep->ContextRecord->X25,
315 ep->ContextRecord->X26,
316 ep->ContextRecord->X27,
317 ep->ContextRecord->X28,
318 ep->ContextRecord->Fp,
319 ep->ContextRecord->Lr
323 buffer +=
seprintf(buffer, last,
"\n Bytes at instruction pointer:\n");
325 byte *b = (
byte*)
ep->ContextRecord->Rip;
326 #elif defined(_M_IX86)
327 byte *b = (
byte*)
ep->ContextRecord->Eip;
328 #elif defined(_M_ARM64)
329 byte *b = (
byte*)
ep->ContextRecord->Pc;
331 for (
int i = 0; i != 24; i++) {
332 if (IsBadReadPtr(b, 1)) {
333 buffer +=
seprintf(buffer, last,
" ??");
335 buffer +=
seprintf(buffer, last,
" %.2X", *b);
339 return buffer +
seprintf(buffer, last,
"\n\n");
344 buffer +=
seprintf(buffer, last,
"Stack trace:\n");
346 uint32 *b = (uint32*)
ep->ContextRecord->Rsp;
347 #elif defined(_M_IX86)
348 uint32 *b = (uint32*)
ep->ContextRecord->Esp;
349 #elif defined(_M_ARM64)
350 uint32 *b = (uint32*)
ep->ContextRecord->Sp;
352 for (
int j = 0; j != 24; j++) {
353 for (
int i = 0; i != 8; i++) {
354 if (IsBadReadPtr(b,
sizeof(uint32))) {
355 buffer +=
seprintf(buffer, last,
" ????????");
357 buffer +=
seprintf(buffer, last,
" %.8X", *b);
361 buffer +=
seprintf(buffer, last,
"\n");
363 return buffer +
seprintf(buffer, last,
"\n");
366 #if defined(_MSC_VER)
367 static const uint MAX_SYMBOL_LEN = 512;
368 static const uint MAX_FRAMES = 64;
370 #pragma warning(disable:4091)
372 #pragma warning(default:4091)
374 char *CrashLogWindows::AppendDecodedStacktrace(
char *buffer,
const char *last)
const
377 static const char dbg_import[] =
383 M("SymFunctionTableAccess64")
384 M("SymGetModuleBase64")
385 M("SymGetModuleInfo64")
386 M("SymGetSymFromAddr64")
387 M("SymGetLineFromAddr64")
393 BOOL (WINAPI * pSymInitialize)(HANDLE, PCSTR, BOOL);
394 BOOL (WINAPI * pSymSetOptions)(DWORD);
395 BOOL (WINAPI * pSymCleanup)(HANDLE);
396 BOOL (WINAPI * pStackWalk64)(DWORD, HANDLE, HANDLE, LPSTACKFRAME64, PVOID, PREAD_PROCESS_MEMORY_ROUTINE64, PFUNCTION_TABLE_ACCESS_ROUTINE64, PGET_MODULE_BASE_ROUTINE64, PTRANSLATE_ADDRESS_ROUTINE64);
397 PVOID (WINAPI * pSymFunctionTableAccess64)(HANDLE, DWORD64);
398 DWORD64 (WINAPI * pSymGetModuleBase64)(HANDLE, DWORD64);
399 BOOL (WINAPI * pSymGetModuleInfo64)(HANDLE, DWORD64, PIMAGEHLP_MODULE64);
400 BOOL (WINAPI * pSymGetSymFromAddr64)(HANDLE, DWORD64, PDWORD64, PIMAGEHLP_SYMBOL64);
401 BOOL (WINAPI * pSymGetLineFromAddr64)(HANDLE, DWORD64, PDWORD, PIMAGEHLP_LINE64);
404 buffer +=
seprintf(buffer, last,
"\nDecoded stack trace:\n");
409 HANDLE hCur = GetCurrentProcess();
410 proc.pSymInitialize(hCur,
nullptr, TRUE);
412 proc.pSymSetOptions(SYMOPT_DEFERRED_LOADS | SYMOPT_FAIL_CRITICAL_ERRORS | SYMOPT_UNDNAME);
416 memset(&frame, 0,
sizeof(frame));
418 frame.AddrPC.Offset =
ep->ContextRecord->Rip;
419 frame.AddrFrame.Offset =
ep->ContextRecord->Rbp;
420 frame.AddrStack.Offset =
ep->ContextRecord->Rsp;
421 #elif defined(_M_IX86)
422 frame.AddrPC.Offset =
ep->ContextRecord->Eip;
423 frame.AddrFrame.Offset =
ep->ContextRecord->Ebp;
424 frame.AddrStack.Offset =
ep->ContextRecord->Esp;
425 #elif defined(_M_ARM64)
426 frame.AddrPC.Offset =
ep->ContextRecord->Pc;
427 frame.AddrFrame.Offset =
ep->ContextRecord->Fp;
428 frame.AddrStack.Offset =
ep->ContextRecord->Sp;
430 frame.AddrPC.Mode = AddrModeFlat;
431 frame.AddrFrame.Mode = AddrModeFlat;
432 frame.AddrStack.Mode = AddrModeFlat;
436 memcpy(&ctx,
ep->ContextRecord,
sizeof(ctx));
439 IMAGEHLP_SYMBOL64 *sym_info = (IMAGEHLP_SYMBOL64*)alloca(
sizeof(IMAGEHLP_SYMBOL64) + MAX_SYMBOL_LEN - 1);
440 sym_info->SizeOfStruct =
sizeof(IMAGEHLP_SYMBOL64);
441 sym_info->MaxNameLength = MAX_SYMBOL_LEN;
444 for (uint num = 0; num < MAX_FRAMES; num++) {
445 if (!proc.pStackWalk64(
447 IMAGE_FILE_MACHINE_AMD64,
449 IMAGE_FILE_MACHINE_I386,
451 hCur, GetCurrentThread(), &frame, &ctx,
nullptr, proc.pSymFunctionTableAccess64, proc.pSymGetModuleBase64,
nullptr))
break;
453 if (frame.AddrPC.Offset == frame.AddrReturn.Offset) {
454 buffer +=
seprintf(buffer, last,
" <infinite loop>\n");
459 const char *mod_name =
"???";
461 IMAGEHLP_MODULE64 module;
462 module.SizeOfStruct =
sizeof(module);
463 if (proc.pSymGetModuleInfo64(hCur, frame.AddrPC.Offset, &module)) {
464 mod_name = module.ModuleName;
468 buffer +=
seprintf(buffer, last,
"[%02d] %-20s " PRINTF_PTR, num, mod_name, frame.AddrPC.Offset);
472 if (proc.pSymGetSymFromAddr64(hCur, frame.AddrPC.Offset, &offset, sym_info)) {
473 buffer +=
seprintf(buffer, last,
" %s + %I64u", sym_info->Name, offset);
476 IMAGEHLP_LINE64 line;
477 line.SizeOfStruct =
sizeof(IMAGEHLP_LINE64);
478 if (proc.pSymGetLineFromAddr64(hCur, frame.AddrPC.Offset, &line_offs, &line)) {
479 buffer +=
seprintf(buffer, last,
" (%s:%d)", line.FileName, line.LineNumber);
482 buffer +=
seprintf(buffer, last,
"\n");
485 proc.pSymCleanup(hCur);
488 return buffer +
seprintf(buffer, last,
"\n*** End of additional info ***\n");
494 HMODULE dbghelp = LoadLibrary(L
"dbghelp.dll");
495 if (dbghelp !=
nullptr) {
496 typedef BOOL (WINAPI *MiniDumpWriteDump_t)(HANDLE, DWORD, HANDLE,
498 CONST PMINIDUMP_EXCEPTION_INFORMATION,
499 CONST PMINIDUMP_USER_STREAM_INFORMATION,
500 CONST PMINIDUMP_CALLBACK_INFORMATION);
501 MiniDumpWriteDump_t funcMiniDumpWriteDump = (MiniDumpWriteDump_t)GetProcAddress(dbghelp,
"MiniDumpWriteDump");
502 if (funcMiniDumpWriteDump !=
nullptr) {
504 HANDLE file = CreateFile(
OTTD2FS(filename), GENERIC_WRITE, 0,
nullptr, CREATE_ALWAYS, 0, 0);
505 HANDLE proc = GetCurrentProcess();
506 DWORD procid = GetCurrentProcessId();
507 MINIDUMP_EXCEPTION_INFORMATION mdei;
508 MINIDUMP_USER_STREAM userstream;
509 MINIDUMP_USER_STREAM_INFORMATION musi;
511 userstream.Type = LastReservedStream + 1;
512 userstream.Buffer = (
void*)this->
crashlog;
513 userstream.BufferSize = (ULONG)strlen(this->
crashlog) + 1;
515 musi.UserStreamCount = 1;
516 musi.UserStreamArray = &userstream;
518 mdei.ThreadId = GetCurrentThreadId();
519 mdei.ExceptionPointers =
ep;
520 mdei.ClientPointers =
false;
522 funcMiniDumpWriteDump(proc, procid, file, MiniDumpWithDataSegs, &mdei, &musi,
nullptr);
527 FreeLibrary(dbghelp);
533 extern bool CloseConsoleLogIfActive();
534 static void ShowCrashlogWindow();
542 static LONG WINAPI ExceptionHandler(EXCEPTION_POINTERS *ep)
548 SetWindowLongPtr(GetActiveWindow(), GWLP_WNDPROC, (LONG_PTR)&DefWindowProc);
556 static const wchar_t _emergency_crash[] =
557 L
"A serious fault condition occurred in the game. The game will shut down.\n"
558 L
"As you loaded an emergency savegame no crash information will be generated.\n";
559 MessageBox(
nullptr, _emergency_crash, L
"Fatal Application Failure", MB_ICONERROR);
564 static const wchar_t _saveload_crash[] =
565 L
"A serious fault condition occurred in the game. The game will shut down.\n"
566 L
"As you loaded an savegame for which you do not have the required NewGRFs\n"
567 L
"no crash information will be generated.\n";
568 MessageBox(
nullptr, _saveload_crash, L
"Fatal Application Failure", MB_ICONERROR);
581 CloseConsoleLogIfActive();
585 ep->ContextRecord->Rip = (DWORD64)ShowCrashlogWindow;
586 ep->ContextRecord->Rsp = (DWORD64)
_safe_esp;
587 #elif defined(_M_IX86)
588 ep->ContextRecord->Eip = (DWORD)ShowCrashlogWindow;
589 ep->ContextRecord->Esp = (DWORD)
_safe_esp;
590 #elif defined(_M_ARM64)
591 ep->ContextRecord->Pc = (DWORD64)ShowCrashlogWindow;
592 ep->ContextRecord->Sp = (DWORD64)
_safe_esp;
594 return EXCEPTION_CONTINUE_EXECUTION;
598 return EXCEPTION_EXECUTE_HANDLER;
601 static void CDECL CustomAbort(
int signal)
603 RaiseException(0xE1212012, 0, 0,
nullptr);
608 #if defined(_M_AMD64) || defined(_M_ARM64)
610 RtlCaptureContext(&ctx);
616 #if defined(_M_ARM64)
622 #if defined(_MSC_VER)
627 asm(
"movl %esp, __safe_esp");
632 signal(SIGABRT, CustomAbort);
633 #if defined(_MSC_VER)
635 _set_abort_behavior(0, _WRITE_ABORT_MSG);
637 SetUnhandledExceptionFilter(ExceptionHandler);
642 static bool _expanded;
644 static const wchar_t _crash_desc[] =
645 L
"A serious fault condition occurred in the game. The game will shut down.\n"
646 L
"Please send the crash information and the crash.dmp file (if any) to the developers.\n"
647 L
"This will greatly help debugging. The correct place to do this is https://github.com/OpenTTD/OpenTTD/issues. "
648 L
"The information contained in the report is displayed below.\n"
649 L
"Press \"Emergency save\" to attempt saving the game. Generated file(s):\n"
652 static const wchar_t _save_succeeded[] =
653 L
"Emergency save succeeded.\nIts location is '%s'.\n"
654 L
"Be aware that critical parts of the internal game state may have become "
655 L
"corrupted. The saved game is not guaranteed to work.";
657 static const wchar_t *
const _expand_texts[] = {L
"S&how report >>", L
"&Hide report <<" };
659 static void SetWndSize(HWND wnd,
int mode)
663 GetWindowRect(wnd, &r);
664 SetDlgItemText(wnd, 15, _expand_texts[mode == 1]);
667 GetWindowRect(GetDlgItem(wnd, 11), &r2);
668 int offs = r2.bottom - r2.top + 10;
669 if (mode == 0) offs = -offs;
670 SetWindowPos(wnd, HWND_TOPMOST, 0, 0,
671 r.right - r.left, r.bottom - r.top + offs, SWP_NOMOVE | SWP_NOZORDER);
673 SetWindowPos(wnd, HWND_TOPMOST,
674 (GetSystemMetrics(SM_CXSCREEN) - (r.right - r.left)) / 2,
675 (GetSystemMetrics(SM_CYSCREEN) - (r.bottom - r.top)) / 2,
680 static INT_PTR CALLBACK CrashDialogFunc(HWND wnd, UINT msg, WPARAM wParam, LPARAM lParam)
683 case WM_INITDIALOG: {
692 while ((c = Utf8Consume(&unix_nl)) && p <
lastof(dos_nl) - 4) {
699 size_t len = wcslen(_crash_desc) + 2;
704 wchar_t *text =
AllocaM(
wchar_t, len);
715 SetDlgItemText(wnd, 10, text);
717 SendDlgItemMessage(wnd, 11, WM_SETFONT, (WPARAM)GetStockObject(ANSI_FIXED_FONT), FALSE);
726 char filename[MAX_PATH];
728 size_t len = wcslen(_save_succeeded) + wcslen(
OTTD2FS(filename)) + 1;
729 wchar_t *text =
AllocaM(
wchar_t, len);
730 _snwprintf(text, len, _save_succeeded,
OTTD2FS(filename));
731 MessageBox(wnd, text, L
"Save successful", MB_ICONINFORMATION);
733 MessageBox(wnd, L
"Save failed", L
"Save failed", MB_ICONINFORMATION);
738 SetWndSize(wnd, _expanded);
750 static void ShowCrashlogWindow()
753 ShowWindow(GetActiveWindow(), FALSE);
754 DialogBox(GetModuleHandle(
nullptr), MAKEINTRESOURCE(100),
nullptr, CrashDialogFunc);