OpenTTD
crashlog_win.cpp
Go to the documentation of this file.
1 /* $Id: crashlog_win.cpp 27380 2015-08-10 20:21:29Z michi_cc $ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8  */
9 
12 #include "../../stdafx.h"
13 #include "../../crashlog.h"
14 #include "win32.h"
15 #include "../../core/alloc_func.hpp"
16 #include "../../core/math_func.hpp"
17 #include "../../string_func.h"
18 #include "../../fileio_func.h"
19 #include "../../strings_func.h"
20 #include "../../gamelog.h"
21 #include "../../saveload/saveload.h"
22 #include "../../video/video_driver.hpp"
23 
24 #include <windows.h>
25 #include <signal.h>
26 
27 #include "../../safeguards.h"
28 
29 static const uint MAX_SYMBOL_LEN = 512;
30 static const uint MAX_FRAMES = 64;
31 
32 /* printf format specification for 32/64-bit addresses. */
33 #ifdef _M_AMD64
34 #define PRINTF_PTR "0x%016IX"
35 #else
36 #define PRINTF_PTR "0x%08X"
37 #endif
38 
42 class CrashLogWindows : public CrashLog {
44  EXCEPTION_POINTERS *ep;
45 
46  /* virtual */ char *LogOSVersion(char *buffer, const char *last) const;
47  /* virtual */ char *LogError(char *buffer, const char *last, const char *message) const;
48  /* virtual */ char *LogStacktrace(char *buffer, const char *last) const;
49  /* virtual */ char *LogRegisters(char *buffer, const char *last) const;
50  /* virtual */ char *LogModules(char *buffer, const char *last) const;
51 public:
52 #if defined(_MSC_VER)
53  /* virtual */ int WriteCrashDump(char *filename, const char *filename_last) const;
54  char *AppendDecodedStacktrace(char *buffer, const char *last) const;
55 #else
56  char *AppendDecodedStacktrace(char *buffer, const char *last) const { return buffer; }
57 #endif /* _MSC_VER */
58 
60  char crashlog[65536];
62  char crashlog_filename[MAX_PATH];
64  char crashdump_filename[MAX_PATH];
66  char screenshot_filename[MAX_PATH];
67 
72  CrashLogWindows(EXCEPTION_POINTERS *ep = NULL) :
73  ep(ep)
74  {
75  this->crashlog[0] = '\0';
76  this->crashlog_filename[0] = '\0';
77  this->crashdump_filename[0] = '\0';
78  this->screenshot_filename[0] = '\0';
79  }
80 
85 };
86 
87 /* static */ CrashLogWindows *CrashLogWindows::current = NULL;
88 
89 /* virtual */ char *CrashLogWindows::LogOSVersion(char *buffer, const char *last) const
90 {
91  _OSVERSIONINFOA os;
92  os.dwOSVersionInfoSize = sizeof(os);
93  GetVersionExA(&os);
94 
95  return buffer + seprintf(buffer, last,
96  "Operating system:\n"
97  " Name: Windows\n"
98  " Release: %d.%d.%d (%s)\n",
99  (int)os.dwMajorVersion,
100  (int)os.dwMinorVersion,
101  (int)os.dwBuildNumber,
102  os.szCSDVersion
103  );
104 
105 }
106 
107 /* virtual */ char *CrashLogWindows::LogError(char *buffer, const char *last, const char *message) const
108 {
109  return buffer + seprintf(buffer, last,
110  "Crash reason:\n"
111  " Exception: %.8X\n"
112 #ifdef _M_AMD64
113  " Location: %.16IX\n"
114 #else
115  " Location: %.8X\n"
116 #endif
117  " Message: %s\n\n",
118  (int)ep->ExceptionRecord->ExceptionCode,
119  (size_t)ep->ExceptionRecord->ExceptionAddress,
120  message == NULL ? "<none>" : message
121  );
122 }
123 
125  uint32 size;
126  uint32 crc32;
127  SYSTEMTIME file_time;
128 };
129 
130 static uint32 *_crc_table;
131 
132 static void MakeCRCTable(uint32 *table)
133 {
134  uint32 crc, poly = 0xEDB88320L;
135  int i;
136  int j;
137 
138  _crc_table = table;
139 
140  for (i = 0; i != 256; i++) {
141  crc = i;
142  for (j = 8; j != 0; j--) {
143  crc = (crc & 1 ? (crc >> 1) ^ poly : crc >> 1);
144  }
145  table[i] = crc;
146  }
147 }
148 
149 static uint32 CalcCRC(byte *data, uint size, uint32 crc)
150 {
151  for (; size > 0; size--) {
152  crc = ((crc >> 8) & 0x00FFFFFF) ^ _crc_table[(crc ^ *data++) & 0xFF];
153  }
154  return crc;
155 }
156 
157 static void GetFileInfo(DebugFileInfo *dfi, const TCHAR *filename)
158 {
159  HANDLE file;
160  memset(dfi, 0, sizeof(*dfi));
161 
162  file = CreateFile(filename, GENERIC_READ, FILE_SHARE_READ, NULL, OPEN_EXISTING, 0, 0);
163  if (file != INVALID_HANDLE_VALUE) {
164  byte buffer[1024];
165  DWORD numread;
166  uint32 filesize = 0;
167  FILETIME write_time;
168  uint32 crc = (uint32)-1;
169 
170  for (;;) {
171  if (ReadFile(file, buffer, sizeof(buffer), &numread, NULL) == 0 || numread == 0) {
172  break;
173  }
174  filesize += numread;
175  crc = CalcCRC(buffer, numread, crc);
176  }
177  dfi->size = filesize;
178  dfi->crc32 = crc ^ (uint32)-1;
179 
180  if (GetFileTime(file, NULL, NULL, &write_time)) {
181  FileTimeToSystemTime(&write_time, &dfi->file_time);
182  }
183  CloseHandle(file);
184  }
185 }
186 
187 
188 static char *PrintModuleInfo(char *output, const char *last, HMODULE mod)
189 {
190  TCHAR buffer[MAX_PATH];
191  DebugFileInfo dfi;
192 
193  GetModuleFileName(mod, buffer, MAX_PATH);
194  GetFileInfo(&dfi, buffer);
195  output += seprintf(output, last, " %-20s handle: %p size: %d crc: %.8X date: %d-%.2d-%.2d %.2d:%.2d:%.2d\n",
196  FS2OTTD(buffer),
197  mod,
198  dfi.size,
199  dfi.crc32,
200  dfi.file_time.wYear,
201  dfi.file_time.wMonth,
202  dfi.file_time.wDay,
203  dfi.file_time.wHour,
204  dfi.file_time.wMinute,
205  dfi.file_time.wSecond
206  );
207  return output;
208 }
209 
210 /* virtual */ char *CrashLogWindows::LogModules(char *output, const char *last) const
211 {
212  MakeCRCTable(AllocaM(uint32, 256));
213  BOOL (WINAPI *EnumProcessModules)(HANDLE, HMODULE*, DWORD, LPDWORD);
214 
215  output += seprintf(output, last, "Module information:\n");
216 
217  if (LoadLibraryList((Function*)&EnumProcessModules, "psapi.dll\0EnumProcessModules\0\0")) {
218  HMODULE modules[100];
219  DWORD needed;
220  BOOL res;
221 
222  HANDLE proc = OpenProcess(PROCESS_ALL_ACCESS, FALSE, GetCurrentProcessId());
223  if (proc != NULL) {
224  res = EnumProcessModules(proc, modules, sizeof(modules), &needed);
225  CloseHandle(proc);
226  if (res) {
227  size_t count = min(needed / sizeof(HMODULE), lengthof(modules));
228 
229  for (size_t i = 0; i != count; i++) output = PrintModuleInfo(output, last, modules[i]);
230  return output + seprintf(output, last, "\n");
231  }
232  }
233  }
234  output = PrintModuleInfo(output, last, NULL);
235  return output + seprintf(output, last, "\n");
236 }
237 
238 /* virtual */ char *CrashLogWindows::LogRegisters(char *buffer, const char *last) const
239 {
240  buffer += seprintf(buffer, last, "Registers:\n");
241 #ifdef _M_AMD64
242  buffer += seprintf(buffer, last,
243  " RAX: %.16I64X RBX: %.16I64X RCX: %.16I64X RDX: %.16I64X\n"
244  " RSI: %.16I64X RDI: %.16I64X RBP: %.16I64X RSP: %.16I64X\n"
245  " R8: %.16I64X R9: %.16I64X R10: %.16I64X R11: %.16I64X\n"
246  " R12: %.16I64X R13: %.16I64X R14: %.16I64X R15: %.16I64X\n"
247  " RIP: %.16I64X EFLAGS: %.8lX\n",
248  ep->ContextRecord->Rax,
249  ep->ContextRecord->Rbx,
250  ep->ContextRecord->Rcx,
251  ep->ContextRecord->Rdx,
252  ep->ContextRecord->Rsi,
253  ep->ContextRecord->Rdi,
254  ep->ContextRecord->Rbp,
255  ep->ContextRecord->Rsp,
256  ep->ContextRecord->R8,
257  ep->ContextRecord->R9,
258  ep->ContextRecord->R10,
259  ep->ContextRecord->R11,
260  ep->ContextRecord->R12,
261  ep->ContextRecord->R13,
262  ep->ContextRecord->R14,
263  ep->ContextRecord->R15,
264  ep->ContextRecord->Rip,
265  ep->ContextRecord->EFlags
266  );
267 #else
268  buffer += seprintf(buffer, last,
269  " EAX: %.8X EBX: %.8X ECX: %.8X EDX: %.8X\n"
270  " ESI: %.8X EDI: %.8X EBP: %.8X ESP: %.8X\n"
271  " EIP: %.8X EFLAGS: %.8X\n",
272  (int)ep->ContextRecord->Eax,
273  (int)ep->ContextRecord->Ebx,
274  (int)ep->ContextRecord->Ecx,
275  (int)ep->ContextRecord->Edx,
276  (int)ep->ContextRecord->Esi,
277  (int)ep->ContextRecord->Edi,
278  (int)ep->ContextRecord->Ebp,
279  (int)ep->ContextRecord->Esp,
280  (int)ep->ContextRecord->Eip,
281  (int)ep->ContextRecord->EFlags
282  );
283 #endif
284 
285  buffer += seprintf(buffer, last, "\n Bytes at instruction pointer:\n");
286 #ifdef _M_AMD64
287  byte *b = (byte*)ep->ContextRecord->Rip;
288 #else
289  byte *b = (byte*)ep->ContextRecord->Eip;
290 #endif
291  for (int i = 0; i != 24; i++) {
292  if (IsBadReadPtr(b, 1)) {
293  buffer += seprintf(buffer, last, " ??"); // OCR: WAS: , 0);
294  } else {
295  buffer += seprintf(buffer, last, " %.2X", *b);
296  }
297  b++;
298  }
299  return buffer + seprintf(buffer, last, "\n\n");
300 }
301 
302 /* virtual */ char *CrashLogWindows::LogStacktrace(char *buffer, const char *last) const
303 {
304  buffer += seprintf(buffer, last, "Stack trace:\n");
305 #ifdef _M_AMD64
306  uint32 *b = (uint32*)ep->ContextRecord->Rsp;
307 #else
308  uint32 *b = (uint32*)ep->ContextRecord->Esp;
309 #endif
310  for (int j = 0; j != 24; j++) {
311  for (int i = 0; i != 8; i++) {
312  if (IsBadReadPtr(b, sizeof(uint32))) {
313  buffer += seprintf(buffer, last, " ????????"); // OCR: WAS - , 0);
314  } else {
315  buffer += seprintf(buffer, last, " %.8X", *b);
316  }
317  b++;
318  }
319  buffer += seprintf(buffer, last, "\n");
320  }
321  return buffer + seprintf(buffer, last, "\n");
322 }
323 
324 #if defined(_MSC_VER)
325 #pragma warning(disable:4091)
326 #include <dbghelp.h>
327 #pragma warning(default:4091)
328 
329 char *CrashLogWindows::AppendDecodedStacktrace(char *buffer, const char *last) const
330 {
331 #define M(x) x "\0"
332  static const char dbg_import[] =
333  M("dbghelp.dll")
334  M("SymInitialize")
335  M("SymSetOptions")
336  M("SymCleanup")
337  M("StackWalk64")
338  M("SymFunctionTableAccess64")
339  M("SymGetModuleBase64")
340  M("SymGetModuleInfo64")
341  M("SymGetSymFromAddr64")
342  M("SymGetLineFromAddr64")
343  M("")
344  ;
345 #undef M
346 
347  struct ProcPtrs {
348  BOOL (WINAPI * pSymInitialize)(HANDLE, PCSTR, BOOL);
349  BOOL (WINAPI * pSymSetOptions)(DWORD);
350  BOOL (WINAPI * pSymCleanup)(HANDLE);
351  BOOL (WINAPI * pStackWalk64)(DWORD, HANDLE, HANDLE, LPSTACKFRAME64, PVOID, PREAD_PROCESS_MEMORY_ROUTINE64, PFUNCTION_TABLE_ACCESS_ROUTINE64, PGET_MODULE_BASE_ROUTINE64, PTRANSLATE_ADDRESS_ROUTINE64);
352  PVOID (WINAPI * pSymFunctionTableAccess64)(HANDLE, DWORD64);
353  DWORD64 (WINAPI * pSymGetModuleBase64)(HANDLE, DWORD64);
354  BOOL (WINAPI * pSymGetModuleInfo64)(HANDLE, DWORD64, PIMAGEHLP_MODULE64);
355  BOOL (WINAPI * pSymGetSymFromAddr64)(HANDLE, DWORD64, PDWORD64, PIMAGEHLP_SYMBOL64);
356  BOOL (WINAPI * pSymGetLineFromAddr64)(HANDLE, DWORD64, PDWORD, PIMAGEHLP_LINE64);
357  } proc;
358 
359  buffer += seprintf(buffer, last, "\nDecoded stack trace:\n");
360 
361  /* Try to load the functions from the DLL, if that fails because of a too old dbghelp.dll, just skip it. */
362  if (LoadLibraryList((Function*)&proc, dbg_import)) {
363  /* Initialize symbol handler. */
364  HANDLE hCur = GetCurrentProcess();
365  proc.pSymInitialize(hCur, NULL, TRUE);
366  /* Load symbols only when needed, fail silently on errors, demangle symbol names. */
367  proc.pSymSetOptions(SYMOPT_DEFERRED_LOADS | SYMOPT_FAIL_CRITICAL_ERRORS | SYMOPT_UNDNAME);
368 
369  /* Initialize starting stack frame from context record. */
370  STACKFRAME64 frame;
371  memset(&frame, 0, sizeof(frame));
372 #ifdef _M_AMD64
373  frame.AddrPC.Offset = ep->ContextRecord->Rip;
374  frame.AddrFrame.Offset = ep->ContextRecord->Rbp;
375  frame.AddrStack.Offset = ep->ContextRecord->Rsp;
376 #else
377  frame.AddrPC.Offset = ep->ContextRecord->Eip;
378  frame.AddrFrame.Offset = ep->ContextRecord->Ebp;
379  frame.AddrStack.Offset = ep->ContextRecord->Esp;
380 #endif
381  frame.AddrPC.Mode = AddrModeFlat;
382  frame.AddrFrame.Mode = AddrModeFlat;
383  frame.AddrStack.Mode = AddrModeFlat;
384 
385  /* Copy context record as StackWalk64 may modify it. */
386  CONTEXT ctx;
387  memcpy(&ctx, ep->ContextRecord, sizeof(ctx));
388 
389  /* Allocate space for symbol info. */
390  IMAGEHLP_SYMBOL64 *sym_info = (IMAGEHLP_SYMBOL64*)alloca(sizeof(IMAGEHLP_SYMBOL64) + MAX_SYMBOL_LEN - 1);
391  sym_info->SizeOfStruct = sizeof(IMAGEHLP_SYMBOL64);
392  sym_info->MaxNameLength = MAX_SYMBOL_LEN;
393 
394  /* Walk stack at most MAX_FRAMES deep in case the stack is corrupt. */
395  for (uint num = 0; num < MAX_FRAMES; num++) {
396  if (!proc.pStackWalk64(
397 #ifdef _M_AMD64
398  IMAGE_FILE_MACHINE_AMD64,
399 #else
400  IMAGE_FILE_MACHINE_I386,
401 #endif
402  hCur, GetCurrentThread(), &frame, &ctx, NULL, proc.pSymFunctionTableAccess64, proc.pSymGetModuleBase64, NULL)) break;
403 
404  if (frame.AddrPC.Offset == frame.AddrReturn.Offset) {
405  buffer += seprintf(buffer, last, " <infinite loop>\n");
406  break;
407  }
408 
409  /* Get module name. */
410  const char *mod_name = "???";
411 
412  IMAGEHLP_MODULE64 module;
413  module.SizeOfStruct = sizeof(module);
414  if (proc.pSymGetModuleInfo64(hCur, frame.AddrPC.Offset, &module)) {
415  mod_name = module.ModuleName;
416  }
417 
418  /* Print module and instruction pointer. */
419  buffer += seprintf(buffer, last, "[%02d] %-20s " PRINTF_PTR, num, mod_name, frame.AddrPC.Offset);
420 
421  /* Get symbol name and line info if possible. */
422  DWORD64 offset;
423  if (proc.pSymGetSymFromAddr64(hCur, frame.AddrPC.Offset, &offset, sym_info)) {
424  buffer += seprintf(buffer, last, " %s + %I64u", sym_info->Name, offset);
425 
426  DWORD line_offs;
427  IMAGEHLP_LINE64 line;
428  line.SizeOfStruct = sizeof(IMAGEHLP_LINE64);
429  if (proc.pSymGetLineFromAddr64(hCur, frame.AddrPC.Offset, &line_offs, &line)) {
430  buffer += seprintf(buffer, last, " (%s:%d)", line.FileName, line.LineNumber);
431  }
432  }
433  buffer += seprintf(buffer, last, "\n");
434  }
435 
436  proc.pSymCleanup(hCur);
437  }
438 
439  return buffer + seprintf(buffer, last, "\n*** End of additional info ***\n");
440 }
441 
442 /* virtual */ int CrashLogWindows::WriteCrashDump(char *filename, const char *filename_last) const
443 {
444  int ret = 0;
445  HMODULE dbghelp = LoadLibrary(_T("dbghelp.dll"));
446  if (dbghelp != NULL) {
447  typedef BOOL (WINAPI *MiniDumpWriteDump_t)(HANDLE, DWORD, HANDLE,
448  MINIDUMP_TYPE,
449  CONST PMINIDUMP_EXCEPTION_INFORMATION,
450  CONST PMINIDUMP_USER_STREAM_INFORMATION,
451  CONST PMINIDUMP_CALLBACK_INFORMATION);
452  MiniDumpWriteDump_t funcMiniDumpWriteDump = (MiniDumpWriteDump_t)GetProcAddress(dbghelp, "MiniDumpWriteDump");
453  if (funcMiniDumpWriteDump != NULL) {
454  seprintf(filename, filename_last, "%scrash.dmp", _personal_dir);
455  HANDLE file = CreateFile(OTTD2FS(filename), GENERIC_WRITE, 0, NULL, CREATE_ALWAYS, 0, 0);
456  HANDLE proc = GetCurrentProcess();
457  DWORD procid = GetCurrentProcessId();
458  MINIDUMP_EXCEPTION_INFORMATION mdei;
459  MINIDUMP_USER_STREAM userstream;
460  MINIDUMP_USER_STREAM_INFORMATION musi;
461 
462  userstream.Type = LastReservedStream + 1;
463  userstream.Buffer = (void*)this->crashlog;
464  userstream.BufferSize = (ULONG)strlen(this->crashlog) + 1;
465 
466  musi.UserStreamCount = 1;
467  musi.UserStreamArray = &userstream;
468 
469  mdei.ThreadId = GetCurrentThreadId();
470  mdei.ExceptionPointers = ep;
471  mdei.ClientPointers = false;
472 
473  funcMiniDumpWriteDump(proc, procid, file, MiniDumpWithDataSegs, &mdei, &musi, NULL);
474  ret = 1;
475  } else {
476  ret = -1;
477  }
478  FreeLibrary(dbghelp);
479  }
480  return ret;
481 }
482 #endif /* _MSC_VER */
483 
484 extern bool CloseConsoleLogIfActive();
485 static void ShowCrashlogWindow();
486 
491 void *_safe_esp = NULL;
492 
493 static LONG WINAPI ExceptionHandler(EXCEPTION_POINTERS *ep)
494 {
495  if (CrashLogWindows::current != NULL) {
497  ExitProcess(2);
498  }
499 
500  if (GamelogTestEmergency()) {
501  static const TCHAR _emergency_crash[] =
502  _T("A serious fault condition occurred in the game. The game will shut down.\n")
503  _T("As you loaded an emergency savegame no crash information will be generated.\n");
504  MessageBox(NULL, _emergency_crash, _T("Fatal Application Failure"), MB_ICONERROR);
505  ExitProcess(3);
506  }
507 
509  static const TCHAR _saveload_crash[] =
510  _T("A serious fault condition occurred in the game. The game will shut down.\n")
511  _T("As you loaded an savegame for which you do not have the required NewGRFs\n")
512  _T("no crash information will be generated.\n");
513  MessageBox(NULL, _saveload_crash, _T("Fatal Application Failure"), MB_ICONERROR);
514  ExitProcess(3);
515  }
516 
517  CrashLogWindows *log = new CrashLogWindows(ep);
518  CrashLogWindows::current = log;
519  char *buf = log->FillCrashLog(log->crashlog, lastof(log->crashlog));
521  log->AppendDecodedStacktrace(buf, lastof(log->crashlog));
524 
525  /* Close any possible log files */
526  CloseConsoleLogIfActive();
527 
528  if ((VideoDriver::GetInstance() == NULL || VideoDriver::GetInstance()->HasGUI()) && _safe_esp != NULL) {
529 #ifdef _M_AMD64
530  ep->ContextRecord->Rip = (DWORD64)ShowCrashlogWindow;
531  ep->ContextRecord->Rsp = (DWORD64)_safe_esp;
532 #else
533  ep->ContextRecord->Eip = (DWORD)ShowCrashlogWindow;
534  ep->ContextRecord->Esp = (DWORD)_safe_esp;
535 #endif
536  return EXCEPTION_CONTINUE_EXECUTION;
537  }
538 
540  return EXCEPTION_EXECUTE_HANDLER;
541 }
542 
543 static void CDECL CustomAbort(int signal)
544 {
545  RaiseException(0xE1212012, 0, 0, NULL);
546 }
547 
548 /* static */ void CrashLog::InitialiseCrashLog()
549 {
550 #ifdef _M_AMD64
551  CONTEXT ctx;
552  RtlCaptureContext(&ctx);
553 
554  /* The stack pointer for AMD64 must always be 16-byte aligned inside a
555  * function. As we are simulating a function call with the safe ESP value,
556  * we need to subtract 8 for the imaginary return address otherwise stack
557  * alignment would be wrong in the called function. */
558  _safe_esp = (void *)(ctx.Rsp - 8);
559 #else
560 #if defined(_MSC_VER)
561  _asm {
562  mov _safe_esp, esp
563  }
564 #else
565  asm("movl %esp, __safe_esp");
566 #endif
567 #endif
568 
569  /* SIGABRT is not an unhandled exception, so we need to intercept it. */
570  signal(SIGABRT, CustomAbort);
571 #if defined(_MSC_VER)
572  /* Don't show abort message as we will get the crashlog window anyway. */
573  _set_abort_behavior(0, _WRITE_ABORT_MSG);
574 #endif
575  SetUnhandledExceptionFilter(ExceptionHandler);
576 }
577 
578 /* The crash log GUI */
579 
580 static bool _expanded;
581 
582 static const TCHAR _crash_desc[] =
583  _T("A serious fault condition occurred in the game. The game will shut down.\n")
584  _T("Please send the crash information and the crash.dmp file (if any) to the developers.\n")
585  _T("This will greatly help debugging. The correct place to do this is http://bugs.openttd.org. ")
586  _T("The information contained in the report is displayed below.\n")
587  _T("Press \"Emergency save\" to attempt saving the game. Generated file(s):\n")
588  _T("%s");
589 
590 static const TCHAR _save_succeeded[] =
591  _T("Emergency save succeeded.\nIts location is '%s'.\n")
592  _T("Be aware that critical parts of the internal game state may have become ")
593  _T("corrupted. The saved game is not guaranteed to work.");
594 
595 static const TCHAR * const _expand_texts[] = {_T("S&how report >>"), _T("&Hide report <<") };
596 
597 static void SetWndSize(HWND wnd, int mode)
598 {
599  RECT r, r2;
600 
601  GetWindowRect(wnd, &r);
602  SetDlgItemText(wnd, 15, _expand_texts[mode == 1]);
603 
604  if (mode >= 0) {
605  GetWindowRect(GetDlgItem(wnd, 11), &r2);
606  int offs = r2.bottom - r2.top + 10;
607  if (mode == 0) offs = -offs;
608  SetWindowPos(wnd, HWND_TOPMOST, 0, 0,
609  r.right - r.left, r.bottom - r.top + offs, SWP_NOMOVE | SWP_NOZORDER);
610  } else {
611  SetWindowPos(wnd, HWND_TOPMOST,
612  (GetSystemMetrics(SM_CXSCREEN) - (r.right - r.left)) / 2,
613  (GetSystemMetrics(SM_CYSCREEN) - (r.bottom - r.top)) / 2,
614  0, 0, SWP_NOSIZE);
615  }
616 }
617 
618 /* When TCHAR is char, then _sntprintf becomes snprintf. When TCHAR is wchar it doesn't. Likewise for strcat. */
619 #undef snprintf
620 #undef strcat
621 
622 static INT_PTR CALLBACK CrashDialogFunc(HWND wnd, UINT msg, WPARAM wParam, LPARAM lParam)
623 {
624  switch (msg) {
625  case WM_INITDIALOG: {
626  /* We need to put the crash-log in a separate buffer because the default
627  * buffer in MB_TO_WIDE is not large enough (512 chars) */
628  TCHAR crash_msgW[lengthof(CrashLogWindows::current->crashlog)];
629  /* Convert unix -> dos newlines because the edit box only supports that properly :( */
630  const char *unix_nl = CrashLogWindows::current->crashlog;
631  char dos_nl[lengthof(CrashLogWindows::current->crashlog)];
632  char *p = dos_nl;
633  WChar c;
634  while ((c = Utf8Consume(&unix_nl)) && p < lastof(dos_nl) - 4) { // 4 is max number of bytes per character
635  if (c == '\n') p += Utf8Encode(p, '\r');
636  p += Utf8Encode(p, c);
637  }
638  *p = '\0';
639 
640  /* Add path to crash.log and crash.dmp (if any) to the crash window text */
641  size_t len = _tcslen(_crash_desc) + 2;
642  len += _tcslen(OTTD2FS(CrashLogWindows::current->crashlog_filename)) + 2;
643  len += _tcslen(OTTD2FS(CrashLogWindows::current->crashdump_filename)) + 2;
644  len += _tcslen(OTTD2FS(CrashLogWindows::current->screenshot_filename)) + 1;
645 
646  TCHAR *text = AllocaM(TCHAR, len);
647  _sntprintf(text, len, _crash_desc, OTTD2FS(CrashLogWindows::current->crashlog_filename));
648  if (OTTD2FS(CrashLogWindows::current->crashdump_filename)[0] != _T('\0')) {
649  _tcscat(text, _T("\n"));
650  _tcscat(text, OTTD2FS(CrashLogWindows::current->crashdump_filename));
651  }
652  if (OTTD2FS(CrashLogWindows::current->screenshot_filename)[0] != _T('\0')) {
653  _tcscat(text, _T("\n"));
654  _tcscat(text, OTTD2FS(CrashLogWindows::current->screenshot_filename));
655  }
656 
657  SetDlgItemText(wnd, 10, text);
658  SetDlgItemText(wnd, 11, convert_to_fs(dos_nl, crash_msgW, lengthof(crash_msgW)));
659  SendDlgItemMessage(wnd, 11, WM_SETFONT, (WPARAM)GetStockObject(ANSI_FIXED_FONT), FALSE);
660  SetWndSize(wnd, -1);
661  } return TRUE;
662  case WM_COMMAND:
663  switch (wParam) {
664  case 12: // Close
666  ExitProcess(2);
667  case 13: // Emergency save
668  char filename[MAX_PATH];
669  if (CrashLogWindows::current->WriteSavegame(filename, lastof(filename))) {
670  size_t len = _tcslen(_save_succeeded) + _tcslen(OTTD2FS(filename)) + 1;
671  TCHAR *text = AllocaM(TCHAR, len);
672  _sntprintf(text, len, _save_succeeded, OTTD2FS(filename));
673  MessageBox(wnd, text, _T("Save successful"), MB_ICONINFORMATION);
674  } else {
675  MessageBox(wnd, _T("Save failed"), _T("Save failed"), MB_ICONINFORMATION);
676  }
677  break;
678  case 15: // Expand window to show crash-message
679  _expanded ^= 1;
680  SetWndSize(wnd, _expanded);
681  break;
682  }
683  return TRUE;
684  case WM_CLOSE:
686  ExitProcess(2);
687  }
688 
689  return FALSE;
690 }
691 
692 static void ShowCrashlogWindow()
693 {
694  ShowCursor(TRUE);
695  ShowWindow(GetActiveWindow(), FALSE);
696  DialogBox(GetModuleHandle(NULL), MAKEINTRESOURCE(100), NULL, CrashDialogFunc);
697 }
bool GamelogTestEmergency()
Finds out if current game is a loaded emergency savegame.
Definition: gamelog.cpp:392
char crashlog[65536]
Buffer for the generated crash log.
Helper class for creating crash logs.
Definition: crashlog.h:18
bool WriteCrashLog(const char *buffer, char *filename, const char *filename_last) const
Write the crash log to a file.
Definition: crashlog.cpp:351
TCHAR * convert_to_fs(const char *name, TCHAR *system_buf, size_t buflen, bool console_cp)
Convert from OpenTTD&#39;s encoding to that of the environment in UNICODE.
Definition: win32.cpp:680
const char * FS2OTTD(const TCHAR *name)
Convert to OpenTTD&#39;s encoding from that of the local environment.
Definition: win32.cpp:613
char crashlog_filename[MAX_PATH]
Buffer for the filename of the crash log.
int CDECL seprintf(char *str, const char *last, const char *format,...)
Safer implementation of snprintf; same as snprintf except:
Definition: string.cpp:398
Windows implementation for the crash logger.
#define lastof(x)
Get the last element of an fixed size array.
Definition: depend.cpp:50
static void InitialiseCrashLog()
Initialiser for crash logs; do the appropriate things so crashes are handled by our crash handler ins...
#define AllocaM(T, num_elements)
alloca() has to be called in the parent function, so define AllocaM() as a macro
Definition: alloc_func.hpp:134
virtual int WriteCrashDump(char *filename, const char *filename_last) const
Write the (crash) dump to a file.
Definition: crashlog.cpp:365
bool LoadLibraryList(Function proc[], const char *dll)
Helper function needed by dynamically loading libraries XXX: Hurray for MS only having an ANSI GetPro...
Definition: win32.cpp:58
static const char * message
Pointer to the error message.
Definition: crashlog.h:21
static void AfterCrashLogCleanup()
Try to close the sound/video stuff so it doesn&#39;t keep lingering around incorrect video states or so...
Definition: crashlog.cpp:489
const char * _personal_dir
custom directory for personal settings, saves, newgrf, etc.
Definition: fileio.cpp:1163
char * LogOSVersion(char *buffer, const char *last) const
Writes OS&#39; version to the buffer.
bool WriteScreenshot(char *filename, const char *filename_last) const
Write the (crash) screenshot to a file.
Definition: crashlog.cpp:405
char screenshot_filename[MAX_PATH]
Buffer for the filename of the crash screenshot.
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:42
static T min(const T a, const T b)
Returns the minimum of two values.
Definition: math_func.hpp:42
const TCHAR * OTTD2FS(const char *name, bool console_cp)
Convert from OpenTTD&#39;s encoding to that of the local environment.
Definition: win32.cpp:631
bool WriteSavegame(char *filename, const char *filename_last) const
Write the (crash) savegame to a file.
Definition: crashlog.cpp:379
char * LogRegisters(char *buffer, const char *last) const
Writes information about the data in the registers, if there is information about it available...
static VideoDriver * GetInstance()
Get the currently active instance of the video driver.
CrashLogWindows(EXCEPTION_POINTERS *ep=NULL)
A crash log is always generated when it&#39;s generated.
char * LogStacktrace(char *buffer, const char *last) const
Writes the stack trace to the buffer, if there is information about it available. ...
size_t Utf8Encode(char *buf, WChar c)
Encode a unicode character and place it in the buffer.
Definition: string.cpp:477
char crashdump_filename[MAX_PATH]
Buffer for the filename of the crash dump.
char * LogError(char *buffer, const char *last, const char *message) const
Writes actually encountered error to the buffer.
void * _safe_esp
Stack pointer for use when &#39;starting&#39; the crash handler.
char * LogModules(char *buffer, const char *last) const
Writes the dynamically linked libraries/modules to the buffer, if there is information about it avail...
static CrashLogWindows * current
Points to the current crash log.
bool SaveloadCrashWithMissingNewGRFs()
Did loading the savegame cause a crash? If so, were NewGRFs missing?
Definition: afterload.cpp:359
char * FillCrashLog(char *buffer, const char *last) const
Fill the crash log buffer with all data of a crash log.
Definition: crashlog.cpp:317
EXCEPTION_POINTERS * ep
Information about the encountered exception.
uint32 WChar
Type for wide characters, i.e.
Definition: string_type.h:35
declarations of functions for MS windows systems