1 //===- Win32/Signals.cpp - Win32 Signals Implementation ---------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file provides the Win32 specific implementation of the Signals class.
12 //===----------------------------------------------------------------------===//
27 #pragma comment(lib, "psapi.lib")
28 #pragma comment(lib, "dbghelp.lib")
30 #if ((HAVE_LIBIMAGEHLP != 1) || (HAVE_LIBPSAPI != 1))
31 #error "libimagehlp.a & libpsapi.a should be present"
33 // The version of g++ that comes with MinGW does *not* properly understand
34 // the ll format specifier for printf. However, MinGW passes the format
35 // specifiers on to the MSVCRT entirely, and the CRT understands the ll
36 // specifier. So these warnings are spurious in this case. Since we compile
37 // with -Wall, this will generate these warnings which should be ignored. So
38 // we will turn off the warnings for this just file. However, MinGW also does
39 // not support push and pop for diagnostics, so we have to manually turn it
40 // back on at the end of the file.
41 #pragma GCC diagnostic ignored "-Wformat"
42 #pragma GCC diagnostic ignored "-Wformat-extra-args"
44 #if !defined(__MINGW64_VERSION_MAJOR)
45 // MinGW.org does not have updated support for the 64-bit versions of the
46 // DebugHlp APIs. So we will have to load them manually. The structures and
47 // method signatures were pulled from DbgHelp.h in the Windows Platform SDK,
48 // and adjusted for brevity.
49 typedef struct _IMAGEHLP_LINE64 {
55 } IMAGEHLP_LINE64, *PIMAGEHLP_LINE64;
57 typedef struct _IMAGEHLP_SYMBOL64 {
64 } IMAGEHLP_SYMBOL64, *PIMAGEHLP_SYMBOL64;
66 typedef struct _tagADDRESS64 {
70 } ADDRESS64, *LPADDRESS64;
72 typedef struct _KDHELP64 {
74 DWORD ThCallbackStack;
75 DWORD ThCallbackBStore;
78 DWORD64 KiCallUserMode;
79 DWORD64 KeUserCallbackDispatcher;
80 DWORD64 SystemRangeStart;
81 DWORD64 KiUserExceptionDispatcher;
85 } KDHELP64, *PKDHELP64;
87 typedef struct _tagSTACKFRAME64 {
99 } STACKFRAME64, *LPSTACKFRAME64;
101 typedef BOOL (__stdcall *PREAD_PROCESS_MEMORY_ROUTINE64)(HANDLE hProcess,
102 DWORD64 qwBaseAddress, PVOID lpBuffer, DWORD nSize,
103 LPDWORD lpNumberOfBytesRead);
105 typedef PVOID (__stdcall *PFUNCTION_TABLE_ACCESS_ROUTINE64)( HANDLE ahProcess,
108 typedef DWORD64 (__stdcall *PGET_MODULE_BASE_ROUTINE64)(HANDLE hProcess,
111 typedef DWORD64 (__stdcall *PTRANSLATE_ADDRESS_ROUTINE64)(HANDLE hProcess,
112 HANDLE hThread, LPADDRESS64 lpaddr);
114 typedef BOOL (WINAPI *fpStackWalk64)(DWORD, HANDLE, HANDLE, LPSTACKFRAME64,
115 PVOID, PREAD_PROCESS_MEMORY_ROUTINE64,
116 PFUNCTION_TABLE_ACCESS_ROUTINE64,
117 PGET_MODULE_BASE_ROUTINE64,
118 PTRANSLATE_ADDRESS_ROUTINE64);
119 static fpStackWalk64 StackWalk64;
121 typedef DWORD64 (WINAPI *fpSymGetModuleBase64)(HANDLE, DWORD64);
122 static fpSymGetModuleBase64 SymGetModuleBase64;
124 typedef BOOL (WINAPI *fpSymGetSymFromAddr64)(HANDLE, DWORD64,
125 PDWORD64, PIMAGEHLP_SYMBOL64);
126 static fpSymGetSymFromAddr64 SymGetSymFromAddr64;
128 typedef BOOL (WINAPI *fpSymGetLineFromAddr64)(HANDLE, DWORD64,
129 PDWORD, PIMAGEHLP_LINE64);
130 static fpSymGetLineFromAddr64 SymGetLineFromAddr64;
132 typedef PVOID (WINAPI *fpSymFunctionTableAccess64)(HANDLE, DWORD64);
133 static fpSymFunctionTableAccess64 SymFunctionTableAccess64;
135 static bool load64BitDebugHelp(void) {
136 HMODULE hLib = ::LoadLibrary("Dbghelp.dll");
138 StackWalk64 = (fpStackWalk64)
139 ::GetProcAddress(hLib, "StackWalk64");
140 SymGetModuleBase64 = (fpSymGetModuleBase64)
141 ::GetProcAddress(hLib, "SymGetModuleBase64");
142 SymGetSymFromAddr64 = (fpSymGetSymFromAddr64)
143 ::GetProcAddress(hLib, "SymGetSymFromAddr64");
144 SymGetLineFromAddr64 = (fpSymGetLineFromAddr64)
145 ::GetProcAddress(hLib, "SymGetLineFromAddr64");
146 SymFunctionTableAccess64 = (fpSymFunctionTableAccess64)
147 ::GetProcAddress(hLib, "SymFunctionTableAccess64");
149 return StackWalk64 != NULL;
151 #endif // !defined(__MINGW64_VERSION_MAJOR)
152 #endif // __MINGW32__
155 static LONG WINAPI LLVMUnhandledExceptionFilter(LPEXCEPTION_POINTERS ep);
156 static BOOL WINAPI LLVMConsoleCtrlHandler(DWORD dwCtrlType);
158 // InterruptFunction - The function to call if ctrl-c is pressed.
159 static void (*InterruptFunction)() = 0;
161 static std::vector<llvm::sys::Path> *FilesToRemove = NULL;
162 static std::vector<std::pair<void(*)(void*), void*> > *CallBacksToRun = 0;
163 static bool RegisteredUnhandledExceptionFilter = false;
164 static bool CleanupExecuted = false;
165 static bool ExitOnUnhandledExceptions = false;
166 static PTOP_LEVEL_EXCEPTION_FILTER OldFilter = NULL;
168 // Windows creates a new thread to execute the console handler when an event
169 // (such as CTRL/C) occurs. This causes concurrency issues with the above
170 // globals which this critical section addresses.
171 static CRITICAL_SECTION CriticalSection;
175 //===----------------------------------------------------------------------===//
176 //=== WARNING: Implementation here must contain only Win32 specific code
177 //=== and must not be UNIX code
178 //===----------------------------------------------------------------------===//
181 /// AvoidMessageBoxHook - Emulates hitting "retry" from an "abort, retry,
182 /// ignore" CRT debug report dialog. "retry" raises an exception which
183 /// ultimately triggers our stack dumper.
184 static int AvoidMessageBoxHook(int ReportType, char *Message, int *Return) {
185 // Set *Return to the retry code for the return value of _CrtDbgReport:
186 // http://msdn.microsoft.com/en-us/library/8hyw4sy7(v=vs.71).aspx
187 // This may also trigger just-in-time debugging via DebugBreak().
190 // Don't call _CrtDbgReport.
194 /// CRTReportHook - Function called on a CRT debugging event.
195 static int CRTReportHook(int ReportType, char *Message, int *Return) {
196 // Don't cause a DebugBreak() on return.
200 switch (ReportType) {
203 fprintf(stderr, "CRT assert: %s\n", Message);
204 // FIXME: Is there a way to just crash? Perhaps throw to the unhandled
205 // exception code? Perhaps SetErrorMode() handles this.
209 fprintf(stderr, "CRT error: %s\n", Message);
210 // FIXME: Is there a way to just crash? Perhaps throw to the unhandled
211 // exception code? Perhaps SetErrorMode() handles this.
215 fprintf(stderr, "CRT warn: %s\n", Message);
219 // Don't call _CrtDbgReport.
224 static void RegisterHandler() {
225 #if __MINGW32__ && !defined(__MINGW64_VERSION_MAJOR)
226 // On MinGW.org, we need to load up the symbols explicitly, because the
227 // Win32 framework they include does not have support for the 64-bit
228 // versions of the APIs we need. If we cannot load up the APIs (which
229 // would be unexpected as they should exist on every version of Windows
230 // we support), we will bail out since there would be nothing to report.
231 if (!load64BitDebugHelp()) {
232 assert(false && "These APIs should always be available");
237 if (RegisteredUnhandledExceptionFilter) {
238 EnterCriticalSection(&CriticalSection);
242 // Now's the time to create the critical section. This is the first time
243 // through here, and there's only one thread.
244 InitializeCriticalSection(&CriticalSection);
246 // Enter it immediately. Now if someone hits CTRL/C, the console handler
247 // can't proceed until the globals are updated.
248 EnterCriticalSection(&CriticalSection);
250 RegisteredUnhandledExceptionFilter = true;
251 OldFilter = SetUnhandledExceptionFilter(LLVMUnhandledExceptionFilter);
252 SetConsoleCtrlHandler(LLVMConsoleCtrlHandler, TRUE);
255 const char *EnableMsgbox = getenv("LLVM_ENABLE_CRT_REPORT");
256 if (!EnableMsgbox || strcmp("0", EnableMsgbox) == 0) {
257 // Setting a report hook overrides the default behavior of popping an "abort,
258 // retry, or ignore" dialog.
259 _CrtSetReportHook(AvoidMessageBoxHook);
263 // Environment variable to disable any kind of crash dialog.
264 if (getenv("LLVM_DISABLE_CRASH_REPORT")) {
266 _CrtSetReportHook(CRTReportHook);
268 SetErrorMode(SEM_FAILCRITICALERRORS |
269 SEM_NOGPFAULTERRORBOX |
270 SEM_NOOPENFILEERRORBOX);
271 ExitOnUnhandledExceptions = true;
274 // IMPORTANT NOTE: Caller must call LeaveCriticalSection(&CriticalSection) or
275 // else multi-threading problems will ensue.
278 // RemoveFileOnSignal - The public API
279 bool sys::RemoveFileOnSignal(const sys::Path &Filename, std::string* ErrMsg) {
282 if (CleanupExecuted) {
284 *ErrMsg = "Process terminating -- cannot register for removal";
288 if (FilesToRemove == NULL)
289 FilesToRemove = new std::vector<sys::Path>;
291 FilesToRemove->push_back(Filename);
293 LeaveCriticalSection(&CriticalSection);
297 // DontRemoveFileOnSignal - The public API
298 void sys::DontRemoveFileOnSignal(const sys::Path &Filename) {
299 if (FilesToRemove == NULL)
304 FilesToRemove->push_back(Filename);
305 std::vector<sys::Path>::reverse_iterator I =
306 std::find(FilesToRemove->rbegin(), FilesToRemove->rend(), Filename);
307 if (I != FilesToRemove->rend())
308 FilesToRemove->erase(I.base()-1);
310 LeaveCriticalSection(&CriticalSection);
313 /// PrintStackTraceOnErrorSignal - When an error signal (such as SIBABRT or
314 /// SIGSEGV) is delivered to the process, print a stack trace and then exit.
315 void sys::PrintStackTraceOnErrorSignal() {
317 LeaveCriticalSection(&CriticalSection);
320 void llvm::sys::PrintStackTrace(FILE *) {
325 void sys::SetInterruptFunction(void (*IF)()) {
327 InterruptFunction = IF;
328 LeaveCriticalSection(&CriticalSection);
332 /// AddSignalHandler - Add a function to be called when a signal is delivered
333 /// to the process. The handler can have a cookie passed to it to identify
334 /// what instance of the handler it is.
335 void sys::AddSignalHandler(void (*FnPtr)(void *), void *Cookie) {
336 if (CallBacksToRun == 0)
337 CallBacksToRun = new std::vector<std::pair<void(*)(void*), void*> >();
338 CallBacksToRun->push_back(std::make_pair(FnPtr, Cookie));
340 LeaveCriticalSection(&CriticalSection);
344 static void Cleanup() {
345 EnterCriticalSection(&CriticalSection);
347 // Prevent other thread from registering new files and directories for
348 // removal, should we be executing because of the console handler callback.
349 CleanupExecuted = true;
351 // FIXME: open files cannot be deleted.
353 if (FilesToRemove != NULL)
354 while (!FilesToRemove->empty()) {
355 FilesToRemove->back().eraseFromDisk();
356 FilesToRemove->pop_back();
360 for (unsigned i = 0, e = CallBacksToRun->size(); i != e; ++i)
361 (*CallBacksToRun)[i].first((*CallBacksToRun)[i].second);
363 LeaveCriticalSection(&CriticalSection);
366 void llvm::sys::RunInterruptHandlers() {
370 static LONG WINAPI LLVMUnhandledExceptionFilter(LPEXCEPTION_POINTERS ep) {
373 // Initialize the STACKFRAME structure.
374 STACKFRAME64 StackFrame;
375 memset(&StackFrame, 0, sizeof(StackFrame));
379 machineType = IMAGE_FILE_MACHINE_AMD64;
380 StackFrame.AddrPC.Offset = ep->ContextRecord->Rip;
381 StackFrame.AddrPC.Mode = AddrModeFlat;
382 StackFrame.AddrStack.Offset = ep->ContextRecord->Rsp;
383 StackFrame.AddrStack.Mode = AddrModeFlat;
384 StackFrame.AddrFrame.Offset = ep->ContextRecord->Rbp;
385 StackFrame.AddrFrame.Mode = AddrModeFlat;
386 #elif defined(_M_IX86)
387 machineType = IMAGE_FILE_MACHINE_I386;
388 StackFrame.AddrPC.Offset = ep->ContextRecord->Eip;
389 StackFrame.AddrPC.Mode = AddrModeFlat;
390 StackFrame.AddrStack.Offset = ep->ContextRecord->Esp;
391 StackFrame.AddrStack.Mode = AddrModeFlat;
392 StackFrame.AddrFrame.Offset = ep->ContextRecord->Ebp;
393 StackFrame.AddrFrame.Mode = AddrModeFlat;
396 HANDLE hProcess = GetCurrentProcess();
397 HANDLE hThread = GetCurrentThread();
399 // Initialize the symbol handler.
400 SymSetOptions(SYMOPT_DEFERRED_LOADS|SYMOPT_LOAD_LINES);
401 SymInitialize(hProcess, NULL, TRUE);
404 if (!StackWalk64(machineType, hProcess, hThread, &StackFrame,
405 ep->ContextRecord, NULL, SymFunctionTableAccess64,
406 SymGetModuleBase64, NULL)) {
410 if (StackFrame.AddrFrame.Offset == 0)
413 // Print the PC in hexadecimal.
414 DWORD64 PC = StackFrame.AddrPC.Offset;
416 fprintf(stderr, "0x%016llX", PC);
417 #elif defined(_M_IX86)
418 fprintf(stderr, "0x%08lX", static_cast<DWORD>(PC));
421 // Print the parameters. Assume there are four.
423 fprintf(stderr, " (0x%016llX 0x%016llX 0x%016llX 0x%016llX)",
424 StackFrame.Params[0],
425 StackFrame.Params[1],
426 StackFrame.Params[2],
427 StackFrame.Params[3]);
428 #elif defined(_M_IX86)
429 fprintf(stderr, " (0x%08lX 0x%08lX 0x%08lX 0x%08lX)",
430 static_cast<DWORD>(StackFrame.Params[0]),
431 static_cast<DWORD>(StackFrame.Params[1]),
432 static_cast<DWORD>(StackFrame.Params[2]),
433 static_cast<DWORD>(StackFrame.Params[3]));
435 // Verify the PC belongs to a module in this process.
436 if (!SymGetModuleBase64(hProcess, PC)) {
437 fputs(" <unknown module>\n", stderr);
441 // Print the symbol name.
443 IMAGEHLP_SYMBOL64 *symbol = reinterpret_cast<IMAGEHLP_SYMBOL64 *>(buffer);
444 memset(symbol, 0, sizeof(IMAGEHLP_SYMBOL64));
445 symbol->SizeOfStruct = sizeof(IMAGEHLP_SYMBOL64);
446 symbol->MaxNameLength = 512 - sizeof(IMAGEHLP_SYMBOL64);
449 if (!SymGetSymFromAddr64(hProcess, PC, &dwDisp, symbol)) {
456 fprintf(stderr, ", %s() + 0x%llX bytes(s)", symbol->Name, dwDisp);
458 fprintf(stderr, ", %s", symbol->Name);
460 // Print the source file and line number information.
461 IMAGEHLP_LINE64 line;
463 memset(&line, 0, sizeof(line));
464 line.SizeOfStruct = sizeof(line);
465 if (SymGetLineFromAddr64(hProcess, PC, &dwLineDisp, &line)) {
466 fprintf(stderr, ", %s, line %lu", line.FileName, line.LineNumber);
468 fprintf(stderr, " + 0x%lX byte(s)", dwLineDisp);
474 if (ExitOnUnhandledExceptions)
475 _exit(ep->ExceptionRecord->ExceptionCode);
477 // Allow dialog box to pop up allowing choice to start debugger.
479 return (*OldFilter)(ep);
481 return EXCEPTION_CONTINUE_SEARCH;
484 static BOOL WINAPI LLVMConsoleCtrlHandler(DWORD dwCtrlType) {
485 // We are running in our very own thread, courtesy of Windows.
486 EnterCriticalSection(&CriticalSection);
489 // If an interrupt function has been set, go and run one it; otherwise,
491 void (*IF)() = InterruptFunction;
492 InterruptFunction = 0; // Don't run it on another CTRL-C.
495 // Note: if the interrupt function throws an exception, there is nothing
496 // to catch it in this thread so it will kill the process.
498 LeaveCriticalSection(&CriticalSection);
499 return TRUE; // Don't kill the process.
502 // Allow normal processing to take place; i.e., the process dies.
503 LeaveCriticalSection(&CriticalSection);
508 // We turned these warnings off for this file so that MinGW-g++ doesn't
509 // complain about the ll format specifiers used. Now we are turning the
510 // warnings back on. If MinGW starts to support diagnostic stacks, we can
511 // replace this with a pop.
512 #pragma GCC diagnostic warning "-Wformat"
513 #pragma GCC diagnostic warning "-Wformat-extra-args"