sdlprocdump.c 31 KB

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