sdlprocdump.c 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705
  1. #ifndef WIN32_LEAN_AND_MEAN
  2. #define WIN32_LEAN_AND_MEAN
  3. #endif
  4. #include <windows.h>
  5. #include <dbghelp.h>
  6. #ifndef STATUS_HEAP_CORRUPTION
  7. #define STATUS_HEAP_CORRUPTION ((DWORD)0xC0000374L)
  8. #endif
  9. #ifndef EXCEPTION_UNWINDING
  10. #define EXCEPTION_UNWINDING 0x2
  11. #endif
  12. #ifndef EXCEPTION_EXIT_UNWIND
  13. #define EXCEPTION_EXIT_UNWIND 0x4
  14. #endif
  15. #ifndef EXCEPTION_STACK_INVALID
  16. #define EXCEPTION_STACK_INVALID 0x8
  17. #endif
  18. #ifndef EXCEPTION_NESTED_CALL
  19. #define EXCEPTION_NESTED_CALL 0x10
  20. #endif
  21. #ifndef EXCEPTION_TARGET_UNWIND
  22. #define EXCEPTION_TARGET_UNWIND 0x20
  23. #endif
  24. #ifndef EXCEPTION_COLLIDED_UNWIND
  25. #define EXCEPTION_COLLIDED_UNWIND 0x40
  26. #endif
  27. #include <inttypes.h>
  28. #include <stdarg.h>
  29. #include <stdio.h>
  30. #include <stdlib.h>
  31. #include <string.h>
  32. #define DUMP_FOLDER "minidumps"
  33. #define APPNAME "SDLPROCDUMP"
  34. #define PRODCUMP_MIN(A,B) (((A) < (B)) ? (A) : (B))
  35. #if defined(__i386__) || defined(__i486__) || defined(__i586__) || defined(__i686__) ||defined( __i386) || defined(_M_IX86)
  36. #define SDLPROCDUMP_CPU_X86 1
  37. #elif defined(__amd64__) || defined(__amd64) || defined(__x86_64__) || defined(__x86_64) || defined(_M_X64) || defined(_M_AMD64)
  38. #define SDLPROCDUMP_CPU_X64 1
  39. #elif defined(__aarch64__) || defined(_M_ARM64)
  40. #define SDLPROCDUMP_CPU_ARM64 1
  41. #elif defined(__arm__) || defined(_M_ARM)
  42. #define SDLPROCDUMP_CPU_ARM32 1
  43. #endif
  44. #if defined(SDLPROCDUMP_CPU_X86) || defined(SDLPROCDUMP_CPU_X64) || defined(SDLPROCDUMP_CPU_ARM32) || defined(SDLPROCDUMP_CPU_ARM64)
  45. #define SDLPROCDUMP_PRINTSTACK
  46. #else
  47. #pragma message("Unsupported architecture: don't know how to StackWalk")
  48. #endif
  49. #ifndef EXCEPTION_SOFTWARE_ORIGINATE
  50. #define EXCEPTION_SOFTWARE_ORIGINATE 0x80
  51. #endif
  52. static void printf_message(const char *format, ...) {
  53. va_list ap;
  54. fprintf(stderr, "[" APPNAME "] ");
  55. va_start(ap, format);
  56. vfprintf(stderr, format, ap);
  57. va_end(ap);
  58. fprintf(stderr, "\n");
  59. }
  60. static void printf_windows_message(const char *format, ...) {
  61. va_list ap;
  62. char win_msg[512];
  63. size_t win_msg_len;
  64. FormatMessageA(
  65. FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
  66. NULL,
  67. GetLastError(),
  68. MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
  69. win_msg, sizeof(win_msg)/sizeof(*win_msg),
  70. NULL);
  71. win_msg_len = strlen(win_msg);
  72. while (win_msg[win_msg_len-1] == '\r' || win_msg[win_msg_len-1] == '\n' || win_msg[win_msg_len-1] == ' ') {
  73. win_msg[win_msg_len-1] = '\0';
  74. win_msg_len--;
  75. }
  76. fprintf(stderr, "[" APPNAME "] ");
  77. va_start(ap, format);
  78. vfprintf(stderr, format, ap);
  79. va_end(ap);
  80. fprintf(stderr, " (%s)\n", win_msg);
  81. }
  82. struct {
  83. HMODULE module;
  84. BOOL (WINAPI *pSymInitialize)(HANDLE hProcess, PCSTR UserSearchPath, BOOL fInvadeProcess);
  85. BOOL (WINAPI *pSymCleanup)(HANDLE hProcess);
  86. BOOL (WINAPI *pMiniDumpWriteDump)(
  87. HANDLE hProcess,
  88. DWORD ProcessId,
  89. HANDLE hFile,
  90. MINIDUMP_TYPE DumpType,
  91. PMINIDUMP_EXCEPTION_INFORMATION ExceptionParam,
  92. PMINIDUMP_USER_STREAM_INFORMATION UserStreamParam,
  93. PMINIDUMP_CALLBACK_INFORMATION CallbackParam);
  94. BOOL (WINAPI *pSymFromAddr)(HANDLE hProcess, DWORD64 Address, PDWORD64 Displacement, PSYMBOL_INFO Symbol);
  95. BOOL (WINAPI *pSymGetLineFromAddr64)(HANDLE hProcess, DWORD64 qwAddr, PDWORD pdwDisplacement, PIMAGEHLP_LINE64 Line);
  96. BOOL (WINAPI *pStackWalk64)(DWORD MachineType, HANDLE hProcess, HANDLE hThread, LPSTACKFRAME64 StackFrame,
  97. PVOID ContextRecord, PREAD_PROCESS_MEMORY_ROUTINE64 ReadMemoryRoutine,
  98. PFUNCTION_TABLE_ACCESS_ROUTINE64 FunctionTableAccessRoutine,
  99. PGET_MODULE_BASE_ROUTINE64 GetModuleBaseRoutine, PTRANSLATE_ADDRESS_ROUTINE64 TranslateAddress);
  100. PVOID (WINAPI *pSymFunctionTableAccess64)(HANDLE hProcess, DWORD64 AddrBase);
  101. DWORD64 (WINAPI *pSymGetModuleBase64)(HANDLE hProcess, DWORD64 qwAddr);
  102. BOOL (WINAPI *pSymGetModuleInfo64)(HANDLE hProcess, DWORD64 qwAddr, PIMAGEHLP_MODULE64 ModuleInfo);
  103. BOOL (WINAPI *pSymRefreshModuleList)(HANDLE hProcess);
  104. } dyn_dbghelp;
  105. static void load_dbghelp(void) {
  106. if (dyn_dbghelp.module) {
  107. return;
  108. }
  109. dyn_dbghelp.module = LoadLibraryA("dbghelp.dll");
  110. if (!dyn_dbghelp.module) {
  111. printf_message("Failed to load dbghelp.dll");
  112. goto failed;
  113. }
  114. dyn_dbghelp.pSymInitialize = (void *)GetProcAddress(dyn_dbghelp.module, "SymInitialize");
  115. dyn_dbghelp.pSymCleanup = (void *)GetProcAddress(dyn_dbghelp.module, "SymCleanup");
  116. dyn_dbghelp.pMiniDumpWriteDump = (void *)GetProcAddress(dyn_dbghelp.module, "MiniDumpWriteDump");
  117. dyn_dbghelp.pSymFromAddr = (void *)GetProcAddress(dyn_dbghelp.module, "SymFromAddr");
  118. dyn_dbghelp.pStackWalk64 = (void *)GetProcAddress(dyn_dbghelp.module, "StackWalk64");
  119. dyn_dbghelp.pSymGetLineFromAddr64 = (void *)GetProcAddress(dyn_dbghelp.module, "SymGetLineFromAddr64");
  120. dyn_dbghelp.pSymFunctionTableAccess64 = (void *)GetProcAddress(dyn_dbghelp.module, "SymFunctionTableAccess64");
  121. dyn_dbghelp.pSymGetModuleBase64 = (void *)GetProcAddress(dyn_dbghelp.module, "SymGetModuleBase64");
  122. dyn_dbghelp.pSymGetModuleInfo64 = (void *)GetProcAddress(dyn_dbghelp.module, "SymGetModuleInfo64");
  123. dyn_dbghelp.pSymRefreshModuleList = (void *)GetProcAddress(dyn_dbghelp.module, "SymRefreshModuleList");
  124. return;
  125. failed:
  126. if (dyn_dbghelp.module) {
  127. FreeLibrary(dyn_dbghelp.module);
  128. dyn_dbghelp.module = NULL;
  129. }
  130. }
  131. static void unload_dbghelp(void) {
  132. if (!dyn_dbghelp.module) {
  133. return;
  134. }
  135. FreeLibrary(dyn_dbghelp.module);
  136. memset(&dyn_dbghelp, 0, sizeof(dyn_dbghelp));
  137. }
  138. #define FOREACH_EXCEPTION_CODES(X) \
  139. X(EXCEPTION_ACCESS_VIOLATION) \
  140. X(EXCEPTION_DATATYPE_MISALIGNMENT) \
  141. X(EXCEPTION_BREAKPOINT) \
  142. X(EXCEPTION_SINGLE_STEP) \
  143. X(EXCEPTION_ARRAY_BOUNDS_EXCEEDED) \
  144. X(EXCEPTION_FLT_DENORMAL_OPERAND) \
  145. X(EXCEPTION_FLT_DIVIDE_BY_ZERO) \
  146. X(EXCEPTION_FLT_INEXACT_RESULT) \
  147. X(EXCEPTION_FLT_INVALID_OPERATION) \
  148. X(EXCEPTION_FLT_OVERFLOW) \
  149. X(EXCEPTION_FLT_STACK_CHECK) \
  150. X(EXCEPTION_FLT_UNDERFLOW) \
  151. X(EXCEPTION_INT_DIVIDE_BY_ZERO) \
  152. X(EXCEPTION_INT_OVERFLOW) \
  153. X(EXCEPTION_PRIV_INSTRUCTION) \
  154. X(EXCEPTION_IN_PAGE_ERROR) \
  155. X(EXCEPTION_ILLEGAL_INSTRUCTION) \
  156. X(EXCEPTION_NONCONTINUABLE_EXCEPTION) \
  157. X(EXCEPTION_STACK_OVERFLOW) \
  158. X(EXCEPTION_INVALID_DISPOSITION) \
  159. X(EXCEPTION_GUARD_PAGE) \
  160. X(EXCEPTION_INVALID_HANDLE) \
  161. X(STATUS_HEAP_CORRUPTION)
  162. #define FOREACH_EXCEPTION_FLAGS(X) \
  163. X(EXCEPTION_NONCONTINUABLE) \
  164. X(EXCEPTION_UNWINDING) \
  165. X(EXCEPTION_EXIT_UNWIND) \
  166. X(EXCEPTION_STACK_INVALID) \
  167. X(EXCEPTION_NESTED_CALL) \
  168. X(EXCEPTION_TARGET_UNWIND) \
  169. X(EXCEPTION_COLLIDED_UNWIND) \
  170. X(EXCEPTION_SOFTWARE_ORIGINATE)
  171. static const char *exceptionCode_to_string(DWORD dwCode) {
  172. #define SWITCH_CODE_STR(V) case V: return #V;
  173. switch (dwCode) {
  174. case 0xe06d7363: return "MS Visual C++ Exception";
  175. FOREACH_EXCEPTION_CODES(SWITCH_CODE_STR)
  176. default: {
  177. return "unknown";
  178. }
  179. }
  180. #undef SWITCH_CODE_STR
  181. }
  182. static const char *exceptionFlags_to_string(DWORD dwFlags, char *buffer, size_t buffer_length) {
  183. buffer[0] = '\0';
  184. #define APPEND_OR_STR(CODE) \
  185. if (dwFlags & (CODE)) { \
  186. if (buffer[0]) { \
  187. strcat_s(buffer, buffer_length, "|"); \
  188. } \
  189. strcat_s(buffer, buffer_length, #CODE); \
  190. }
  191. FOREACH_EXCEPTION_FLAGS(APPEND_OR_STR)
  192. #undef APPEND_OR_STR
  193. return buffer;
  194. }
  195. static BOOL IsCXXException(DWORD dwCode) {
  196. /* https://devblogs.microsoft.com/oldnewthing/20100730-00/?p=13273 */
  197. return dwCode == 0xe06d7363; /* FOURCC(0xe0, 'm', 's', 'c') */
  198. }
  199. static BOOL IsFatalExceptionCode(DWORD dwCode) {
  200. switch (dwCode) {
  201. case EXCEPTION_ACCESS_VIOLATION:
  202. case EXCEPTION_ARRAY_BOUNDS_EXCEEDED:
  203. case EXCEPTION_IN_PAGE_ERROR:
  204. case EXCEPTION_ILLEGAL_INSTRUCTION:
  205. case EXCEPTION_INT_DIVIDE_BY_ZERO:
  206. case EXCEPTION_STACK_OVERFLOW:
  207. case STATUS_HEAP_CORRUPTION:
  208. case STATUS_STACK_BUFFER_OVERRUN:
  209. case EXCEPTION_GUARD_PAGE:
  210. case EXCEPTION_INVALID_HANDLE:
  211. return TRUE;
  212. default:
  213. return FALSE;
  214. }
  215. }
  216. static const char *get_simple_basename(const char *path) {
  217. const char *pos = strrchr(path, '\\');
  218. if (pos) {
  219. return pos + 1;
  220. }
  221. pos = strrchr(path, '/');
  222. if (pos) {
  223. return pos + 1;
  224. }
  225. return path;
  226. }
  227. static void write_minidump(const char *child_file_path, const LPPROCESS_INFORMATION process_information, DWORD dwThreadId, PEXCEPTION_RECORD exception_record, PCONTEXT context) {
  228. BOOL success;
  229. char dump_file_path[MAX_PATH];
  230. char child_file_name[64];
  231. EXCEPTION_POINTERS exception_pointers;
  232. HANDLE hFile = INVALID_HANDLE_VALUE;
  233. MINIDUMP_EXCEPTION_INFORMATION minidump_exception_information;
  234. SYSTEMTIME system_time;
  235. if (!dyn_dbghelp.pMiniDumpWriteDump) {
  236. printf_message("Cannot find pMiniDumpWriteDump in dbghelp.dll: no minidump");
  237. return;
  238. }
  239. success = CreateDirectoryA(DUMP_FOLDER, NULL);
  240. if (!success && GetLastError() != ERROR_ALREADY_EXISTS) {
  241. printf_windows_message("Failed to create minidump directory");
  242. goto post_dump;
  243. }
  244. _splitpath_s(child_file_path, NULL, 0, NULL, 0, child_file_name, sizeof(child_file_name), NULL, 0);
  245. GetLocalTime(&system_time);
  246. snprintf(dump_file_path, sizeof(dump_file_path), "minidumps/%s_%04d-%02d-%02d_%02d-%02d-%02d.dmp",
  247. child_file_name,
  248. system_time.wYear, system_time.wMonth, system_time.wDay,
  249. system_time.wHour, system_time.wMinute, system_time.wSecond);
  250. printf_message("");
  251. printf_message("Writing minidump to \"%s\"", dump_file_path);
  252. hFile = CreateFileA(
  253. dump_file_path,
  254. GENERIC_WRITE,
  255. FILE_SHARE_WRITE,
  256. NULL,
  257. CREATE_ALWAYS,
  258. FILE_ATTRIBUTE_NORMAL,
  259. NULL);
  260. if (hFile == INVALID_HANDLE_VALUE) {
  261. printf_windows_message("Failed to open file for minidump");
  262. goto post_dump;
  263. }
  264. memset(&exception_pointers, 0, sizeof(exception_pointers));
  265. exception_pointers.ContextRecord = context;
  266. exception_pointers.ExceptionRecord = exception_record;
  267. minidump_exception_information.ClientPointers = FALSE;
  268. minidump_exception_information.ExceptionPointers = &exception_pointers;
  269. minidump_exception_information.ThreadId = dwThreadId;
  270. success = dyn_dbghelp.pMiniDumpWriteDump(
  271. process_information->hProcess, /* HANDLE hProcess */
  272. process_information->dwProcessId, /* DWORD ProcessId */
  273. hFile, /* HANDLE hFile */
  274. MiniDumpWithFullMemory, /* MINIDUMP_TYPE DumpType */
  275. &minidump_exception_information, /* PMINIDUMP_EXCEPTION_INFORMATION ExceptionParam */
  276. NULL, /* PMINIDUMP_USER_STREAM_INFORMATION UserStreamParam */
  277. NULL); /* PMINIDUMP_CALLBACK_INFORMATION CallbackParam */
  278. if (!success) {
  279. printf_windows_message("Failed to write minidump");
  280. }
  281. post_dump:
  282. if (hFile != INVALID_HANDLE_VALUE) {
  283. CloseHandle(hFile);
  284. }
  285. }
  286. static void print_stacktrace(const LPPROCESS_INFORMATION process_information, LPVOID address, PCONTEXT context) {
  287. STACKFRAME64 stack_frame;
  288. DWORD machine_type;
  289. if (!context) {
  290. printf_message("Cannot create a stacktrace without a context");
  291. return;
  292. }
  293. if (!dyn_dbghelp.pStackWalk64) {
  294. printf_message("Cannot find StackWalk64 in dbghelp.dll: no stacktrace");
  295. return;
  296. }
  297. if (!dyn_dbghelp.pSymFunctionTableAccess64) {
  298. printf_message("Cannot find SymFunctionTableAccess64 in dbghelp.dll: no stacktrace");
  299. return;
  300. }
  301. if (!dyn_dbghelp.pSymGetModuleBase64) {
  302. printf_message("Cannot find SymGetModuleBase64 in dbghelp.dll: no stacktrace");
  303. return;
  304. }
  305. if (!dyn_dbghelp.pSymFromAddr) {
  306. printf_message("Cannot find pSymFromAddr in dbghelp.dll: no stacktrace");
  307. return;
  308. }
  309. if (!dyn_dbghelp.pSymGetLineFromAddr64) {
  310. printf_message("Cannot find SymGetLineFromAddr64 in dbghelp.dll: no stacktrace");
  311. return;
  312. }
  313. if (!dyn_dbghelp.pSymGetModuleInfo64) {
  314. printf_message("Cannot find SymGetModuleInfo64 in dbghelp.dll: no stacktrace");
  315. return;
  316. }
  317. if (!dyn_dbghelp.pSymRefreshModuleList || !dyn_dbghelp.pSymRefreshModuleList(process_information->hProcess)) {
  318. printf_windows_message("SymRefreshModuleList failed: maybe no stacktrace");
  319. }
  320. memset(&stack_frame, 0, sizeof(stack_frame));
  321. stack_frame.AddrPC.Mode = AddrModeFlat;
  322. stack_frame.AddrFrame.Mode = AddrModeFlat;
  323. stack_frame.AddrStack.Mode = AddrModeFlat;
  324. #if defined(SDLPROCDUMP_CPU_X86)
  325. machine_type = IMAGE_FILE_MACHINE_I386;
  326. stack_frame.AddrFrame.Offset = context->Ebp;
  327. stack_frame.AddrStack.Offset = context->Esp;
  328. stack_frame.AddrPC.Offset = context->Eip;
  329. #elif defined(SDLPROCDUMP_CPU_X64)
  330. machine_type = IMAGE_FILE_MACHINE_AMD64;
  331. stack_frame.AddrFrame.Offset = context->Rbp;
  332. stack_frame.AddrStack.Offset = context->Rsp;
  333. stack_frame.AddrPC.Offset = context->Rip;
  334. #elif defined(SDLPROCDUMP_CPU_ARM32)
  335. machine_type = IMAGE_FILE_MACHINE_ARM;
  336. stack_frame.AddrFrame.Offset = context->Lr;
  337. stack_frame.AddrStack.Offset = context->Sp;
  338. stack_frame.AddrPC.Offset = context->Pc;
  339. #elif defined(SDLPROCDUMP_CPU_ARM64)
  340. machine_type = IMAGE_FILE_MACHINE_ARM64;
  341. stack_frame.AddrFrame.Offset = context->Fp;
  342. stack_frame.AddrStack.Offset = context->Sp;
  343. stack_frame.AddrPC.Offset = context->Pc;
  344. #endif
  345. while (dyn_dbghelp.pStackWalk64(machine_type, /* DWORD MachineType */
  346. process_information->hProcess, /* HANDLE hProcess */
  347. process_information->hThread, /* HANDLE hThread */
  348. &stack_frame, /* LPSTACKFRAME64 StackFrame */
  349. context, /* PVOID ContextRecord */
  350. NULL, /* PREAD_PROCESS_MEMORY_ROUTINE64 ReadMemoryRoutine */
  351. dyn_dbghelp.pSymFunctionTableAccess64, /* PFUNCTION_TABLE_ACCESS_ROUTINE64 FunctionTableAccessRoutine */
  352. dyn_dbghelp.pSymGetModuleBase64, /* PGET_MODULE_BASE_ROUTINE64 GetModuleBaseRoutine */
  353. NULL)) { /* PTRANSLATE_ADDRESS_ROUTINE64 TranslateAddress */
  354. IMAGEHLP_MODULE64 module_info;
  355. union {
  356. char buffer[sizeof(SYMBOL_INFO) + MAX_SYM_NAME * sizeof(CHAR)];
  357. SYMBOL_INFO symbol_info;
  358. } symbol;
  359. DWORD64 dwDisplacement;
  360. DWORD lineColumn = 0;
  361. IMAGEHLP_LINE64 line;
  362. const char *image_file_name;
  363. const char *symbol_name;
  364. const char *file_name;
  365. char line_number[16];
  366. if (stack_frame.AddrPC.Offset == stack_frame.AddrReturn.Offset) {
  367. printf_message("PC == Return Address => Possible endless callstack");
  368. break;
  369. }
  370. memset(&module_info, 0, sizeof(module_info));
  371. module_info.SizeOfStruct = sizeof(module_info);
  372. if (!dyn_dbghelp.pSymGetModuleInfo64(process_information->hProcess, stack_frame.AddrPC.Offset, &module_info)) {
  373. image_file_name = "?";
  374. } else {
  375. image_file_name = get_simple_basename(module_info.ImageName);
  376. }
  377. memset(&symbol, 0, sizeof(symbol));
  378. symbol.symbol_info.SizeOfStruct = sizeof(symbol.symbol_info);
  379. symbol.symbol_info.MaxNameLen = MAX_SYM_NAME;
  380. if (!dyn_dbghelp.pSymFromAddr(process_information->hProcess, (DWORD64)(uintptr_t)stack_frame.AddrPC.Offset, &dwDisplacement, &symbol.symbol_info)) {
  381. symbol_name = "???";
  382. dwDisplacement = 0;
  383. } else {
  384. symbol_name = symbol.symbol_info.Name;
  385. }
  386. line.SizeOfStruct = sizeof(line);
  387. if (!dyn_dbghelp.pSymGetLineFromAddr64(process_information->hProcess, (DWORD64)(uintptr_t)stack_frame.AddrPC.Offset, &lineColumn, &line)) {
  388. file_name = "";
  389. line_number[0] = '\0';
  390. } else {
  391. file_name = line.FileName;
  392. snprintf(line_number, sizeof(line_number), "Line %u", (unsigned int)line.LineNumber);
  393. }
  394. printf_message("%s!%s+0x%x %s %s", image_file_name, symbol_name, dwDisplacement, file_name, line_number);
  395. }
  396. }
  397. static PCONTEXT FillInThreadContext(LPPROCESS_INFORMATION process_information, PCONTEXT context_buffer) {
  398. HANDLE thread_handle = NULL;
  399. thread_handle = OpenThread(THREAD_ALL_ACCESS, FALSE, process_information->dwThreadId);
  400. if (!thread_handle) {
  401. printf_windows_message("OpenThread failed: no stacktrace");
  402. return NULL;
  403. }
  404. memset(context_buffer, 0, sizeof(*context_buffer));
  405. context_buffer->ContextFlags = CONTEXT_ALL;
  406. if (!GetThreadContext(thread_handle, context_buffer)) {
  407. printf_windows_message("GetThreadContext failed: no stacktrace");
  408. CloseHandle(thread_handle);
  409. return NULL;
  410. }
  411. CloseHandle(thread_handle);
  412. return context_buffer;
  413. }
  414. static void GetMSCExceptionName(HANDLE hProcess, ULONG_PTR *parameters, DWORD count_parameters, char *buffer, size_t buffer_size) {
  415. #define FIXUP_DWORD_POINTER(ADDR) ((sizeof(void *) == 8) ? (parameters[3] + (ADDR)) : (ADDR))
  416. #define CHECKED_ReadProcessMemory(PROCESS, ADDRESS, BUFFER, COUNT, WHAT) \
  417. do { \
  418. SIZE_T actual_count; \
  419. BOOL res = ReadProcessMemory((PROCESS), (ADDRESS), (BUFFER), (COUNT), &actual_count); \
  420. if (!res) { \
  421. printf_windows_message(WHAT ": ReadProcessMemory failed"); \
  422. strncpy_s(buffer, buffer_size, "<error>", buffer_size); \
  423. return; \
  424. } \
  425. if ((COUNT) != (actual_count)) { \
  426. printf_message(WHAT ": ReadProcessMemory did not read enough data actual=%lu expected=%lu", \
  427. (unsigned long) (actual_count), (unsigned long) (COUNT)); \
  428. strncpy_s(buffer, buffer_size, "<error>", buffer_size); \
  429. return; \
  430. } \
  431. } while (0)
  432. DWORD depth0;
  433. char *ptr_depth0;
  434. DWORD depth1;
  435. char *ptr_depth1;
  436. DWORD depth2;
  437. char *ptr_depth2;
  438. CHECKED_ReadProcessMemory(hProcess, (void *)(parameters[2] + 3 * sizeof(DWORD)), &depth0, sizeof(depth0), "depth 0");
  439. ptr_depth0 = (char *)FIXUP_DWORD_POINTER(depth0);
  440. CHECKED_ReadProcessMemory(hProcess, ptr_depth0 + 1 * sizeof(DWORD), &depth1, sizeof(depth1), "depth 1");
  441. ptr_depth1 = (char *)FIXUP_DWORD_POINTER(depth1);
  442. CHECKED_ReadProcessMemory(hProcess, ptr_depth1 + 1 * sizeof(DWORD), &depth2, sizeof(depth2), "depth 2");
  443. ptr_depth2 = (char *)FIXUP_DWORD_POINTER(depth2);
  444. CHECKED_ReadProcessMemory(hProcess, ptr_depth2 + 2 * sizeof(void*), buffer, buffer_size, "data");
  445. buffer[buffer_size - 1] = '\0';
  446. #undef FIXUP_DWORD_POINTER
  447. #undef CHECKED_ReadProcessMemory
  448. }
  449. static void log_usage(const char *argv0) {
  450. fprintf(stderr, "Usage: %s [--help] [--debug-stream] [--] PROGRAM [ARG1 [ARG2 [ARG3 ... ]]]\n", argv0);
  451. }
  452. int main(int argc, char *argv[]) {
  453. int i;
  454. int cmd_start;
  455. size_t command_line_len = 0;
  456. char *command_line;
  457. STARTUPINFOA startup_info;
  458. PROCESS_INFORMATION process_information;
  459. BOOL success;
  460. BOOL debugger_present;
  461. DWORD exit_code;
  462. DWORD creation_flags;
  463. BOOL log_debug_stream = FALSE;
  464. cmd_start = -1;
  465. for (i = 1; i < argc; i++) {
  466. if (strcmp(argv[i], "--") == 0) {
  467. cmd_start = i + 1;
  468. break;
  469. } else if (strcmp(argv[i], "--debug-stream") == 0) {
  470. log_debug_stream = TRUE;
  471. continue;
  472. } else if (strcmp(argv[i], "--help") == 0) {
  473. log_usage(argv[0]);
  474. return 0;
  475. } else {
  476. cmd_start = i;
  477. break;
  478. }
  479. }
  480. if (cmd_start < 0 || cmd_start >= argc) {
  481. log_usage(argv[0]);
  482. return 1;
  483. }
  484. for (i = cmd_start; i < argc; i++) {
  485. command_line_len += strlen(argv[i]) + 1;
  486. }
  487. command_line = malloc(command_line_len + 1);
  488. if (!command_line) {
  489. printf_message("Failed to allocate memory for command line");
  490. return 1;
  491. }
  492. command_line[0] = '\0';
  493. for (i = cmd_start; i < argc; i++) {
  494. strcat_s(command_line, command_line_len, argv[i]);
  495. if (i != argc - 1) {
  496. strcat_s(command_line, command_line_len, " ");
  497. }
  498. }
  499. memset(&startup_info, 0, sizeof(startup_info));
  500. startup_info.cb = sizeof(startup_info);
  501. debugger_present = IsDebuggerPresent();
  502. creation_flags = NORMAL_PRIORITY_CLASS;
  503. if (!debugger_present) {
  504. creation_flags |= DEBUG_PROCESS | DEBUG_ONLY_THIS_PROCESS;
  505. }
  506. success = CreateProcessA(
  507. argv[cmd_start], /* LPCSTR lpApplicationName, */
  508. command_line, /* LPSTR lpCommandLine, */
  509. NULL, /* LPSECURITY_ATTRIBUTES lpProcessAttributes, */
  510. NULL, /* LPSECURITY_ATTRIBUTES lpThreadAttributes, */
  511. TRUE, /* BOOL bInheritHandles, */
  512. creation_flags, /* DWORD dwCreationFlags, */
  513. NULL, /* LPVOID lpEnvironment, */
  514. NULL, /* LPCSTR lpCurrentDirectory, */
  515. &startup_info, /* LPSTARTUPINFOA lpStartupInfo, */
  516. &process_information); /* LPPROCESS_INFORMATION lpProcessInformation */
  517. if (!success) {
  518. printf_windows_message("Failed to start application \"%s\"", argv[cmd_start]);
  519. return 1;
  520. }
  521. if (debugger_present) {
  522. WaitForSingleObject(process_information.hProcess, INFINITE);
  523. } else {
  524. int process_alive = 1;
  525. DEBUG_EVENT event;
  526. while (process_alive) {
  527. DWORD continue_status = DBG_CONTINUE;
  528. success = WaitForDebugEvent(&event, INFINITE);
  529. if (!success) {
  530. printf_windows_message("Failed to get a debug event");
  531. return 1;
  532. }
  533. switch (event.dwDebugEventCode) {
  534. case OUTPUT_DEBUG_STRING_EVENT:
  535. {
  536. if (log_debug_stream) {
  537. SIZE_T bytes_read = 0;
  538. union {
  539. char char_buffer[512];
  540. WCHAR wchar_buffer[256];
  541. } buffer;
  542. if (ReadProcessMemory(process_information.hProcess, event.u.DebugString.lpDebugStringData, buffer.char_buffer, PRODCUMP_MIN(sizeof(buffer), event.u.DebugString.nDebugStringLength), &bytes_read) && bytes_read) {
  543. if (event.u.DebugString.fUnicode) {
  544. size_t len = bytes_read / 2;
  545. buffer.wchar_buffer[255] = '\0';
  546. while (len > 0 && (buffer.wchar_buffer[len - 1] == '\0' || buffer.wchar_buffer[len - 1] == '\n' || buffer.wchar_buffer[len - 1] == '\r')) {
  547. buffer.wchar_buffer[len - 1] = '\0';
  548. len -= 1;
  549. }
  550. if (len > 0) {
  551. printf("[" APPNAME "] (debug) %S\n", buffer.wchar_buffer);
  552. }
  553. } else {
  554. size_t len = bytes_read;
  555. buffer.char_buffer[511] = '\0';
  556. while (len > 0 && (buffer.char_buffer[len - 1] == '\0' || buffer.char_buffer[len - 1] == '\n' || buffer.char_buffer[len - 1] == '\r')) {
  557. buffer.char_buffer[len - 1] = '\0';
  558. len -= 1;
  559. }
  560. if (len > 0) {
  561. printf("[" APPNAME "] (debug) %s\n", buffer.char_buffer);
  562. }
  563. }
  564. }
  565. }
  566. break;
  567. }
  568. case EXCEPTION_DEBUG_EVENT:
  569. {
  570. const BOOL cxx_exception = IsCXXException(event.u.Exception.ExceptionRecord.ExceptionCode);
  571. const BOOL is_fatal = !cxx_exception && (IsFatalExceptionCode(event.u.Exception.ExceptionRecord.ExceptionCode) || (event.u.Exception.ExceptionRecord.ExceptionFlags & EXCEPTION_NONCONTINUABLE));
  572. if (cxx_exception || is_fatal) {
  573. char flag_buffer[256];
  574. printf_message("EXCEPTION_DEBUG_EVENT");
  575. printf_message(" ExceptionCode: 0x%08lx (%s)",
  576. event.u.Exception.ExceptionRecord.ExceptionCode,
  577. exceptionCode_to_string(event.u.Exception.ExceptionRecord.ExceptionCode));
  578. printf_message(" ExceptionFlags: 0x%08lx (%s)",
  579. event.u.Exception.ExceptionRecord.ExceptionFlags,
  580. exceptionFlags_to_string(event.u.Exception.ExceptionRecord.ExceptionFlags, flag_buffer, sizeof(flag_buffer)));
  581. printf_message(" FirstChance: %ld", event.u.Exception.dwFirstChance);
  582. printf_message(" ExceptionAddress: 0x%08lx",
  583. event.u.Exception.ExceptionRecord.ExceptionAddress);
  584. }
  585. if (cxx_exception) {
  586. char exception_name[256];
  587. GetMSCExceptionName(process_information.hProcess, event.u.Exception.ExceptionRecord.ExceptionInformation, event.u.Exception.ExceptionRecord.NumberParameters,
  588. exception_name, sizeof(exception_name));
  589. printf_message(" Exception name: %s", exception_name);
  590. } else if (is_fatal) {
  591. CONTEXT context_buffer;
  592. PCONTEXT context;
  593. printf_message(" (Non-continuable exception debug event)");
  594. context = FillInThreadContext(&process_information, &context_buffer);
  595. write_minidump(argv[cmd_start], &process_information, event.dwThreadId, &event.u.Exception.ExceptionRecord, context);
  596. printf_message("");
  597. #ifdef SDLPROCDUMP_PRINTSTACK
  598. print_stacktrace(&process_information, event.u.Exception.ExceptionRecord.ExceptionAddress, context);
  599. #else
  600. printf_message("No support for printing stacktrack for current architecture");
  601. #endif
  602. DebugActiveProcessStop(event.dwProcessId);
  603. process_alive = FALSE;
  604. }
  605. continue_status = DBG_EXCEPTION_NOT_HANDLED;
  606. break;
  607. }
  608. case CREATE_PROCESS_DEBUG_EVENT:
  609. load_dbghelp();
  610. if (!dyn_dbghelp.pSymInitialize) {
  611. printf_message("Cannot find pSymInitialize in dbghelp.dll: no stacktrace");
  612. break;
  613. }
  614. /* Don't invade process on CI: downloading symbols will cause test timeouts */
  615. if (!dyn_dbghelp.pSymInitialize(process_information.hProcess, NULL, FALSE)) {
  616. printf_windows_message("SymInitialize failed: no stacktrace");
  617. break;
  618. }
  619. break;
  620. case EXIT_PROCESS_DEBUG_EVENT:
  621. if (event.dwProcessId == process_information.dwProcessId) {
  622. process_alive = 0;
  623. DebugActiveProcessStop(event.dwProcessId);
  624. }
  625. break;
  626. }
  627. success = ContinueDebugEvent(event.dwProcessId, event.dwThreadId, continue_status);
  628. if (!process_alive) {
  629. DebugActiveProcessStop(event.dwProcessId);
  630. }
  631. }
  632. }
  633. if (dyn_dbghelp.pSymCleanup) {
  634. dyn_dbghelp.pSymCleanup(process_information.hProcess);
  635. }
  636. unload_dbghelp();
  637. exit_code = 1;
  638. success = GetExitCodeProcess(process_information.hProcess, &exit_code);
  639. if (!success) {
  640. printf_message("Failed to get process exit code");
  641. return 1;
  642. }
  643. CloseHandle(process_information.hThread);
  644. CloseHandle(process_information.hProcess);
  645. return exit_code;
  646. }