sdlprocdump.c 29 KB

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