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 //===----------------------------------------------------------------------===//
13 #include "llvm/Support/FileSystem.h"
18 #include "llvm/Support/Format.h"
19 #include "llvm/Support/raw_ostream.h"
21 // The Windows.h header must be after LLVM and standard headers.
22 #include "WindowsSupport.h"
32 #pragma comment(lib, "psapi.lib")
34 #if (HAVE_LIBPSAPI != 1)
35 #error "libpsapi.a should be present"
37 // The version of g++ that comes with MinGW does *not* properly understand
38 // the ll format specifier for printf. However, MinGW passes the format
39 // specifiers on to the MSVCRT entirely, and the CRT understands the ll
40 // specifier. So these warnings are spurious in this case. Since we compile
41 // with -Wall, this will generate these warnings which should be ignored. So
42 // we will turn off the warnings for this just file. However, MinGW also does
43 // not support push and pop for diagnostics, so we have to manually turn it
44 // back on at the end of the file.
45 #pragma GCC diagnostic ignored "-Wformat"
46 #pragma GCC diagnostic ignored "-Wformat-extra-args"
48 #if !defined(__MINGW64_VERSION_MAJOR)
49 // MinGW.org does not have updated support for the 64-bit versions of the
50 // DebugHlp APIs. So we will have to load them manually. The structures and
51 // method signatures were pulled from DbgHelp.h in the Windows Platform SDK,
52 // and adjusted for brevity.
53 typedef struct _IMAGEHLP_LINE64 {
59 } IMAGEHLP_LINE64, *PIMAGEHLP_LINE64;
61 typedef struct _IMAGEHLP_SYMBOL64 {
68 } IMAGEHLP_SYMBOL64, *PIMAGEHLP_SYMBOL64;
70 typedef struct _tagADDRESS64 {
74 } ADDRESS64, *LPADDRESS64;
76 typedef struct _KDHELP64 {
78 DWORD ThCallbackStack;
79 DWORD ThCallbackBStore;
82 DWORD64 KiCallUserMode;
83 DWORD64 KeUserCallbackDispatcher;
84 DWORD64 SystemRangeStart;
85 DWORD64 KiUserExceptionDispatcher;
89 } KDHELP64, *PKDHELP64;
91 typedef struct _tagSTACKFRAME64 {
103 } STACKFRAME64, *LPSTACKFRAME64;
104 #endif // !defined(__MINGW64_VERSION_MAJOR)
105 #endif // __MINGW32__
107 typedef BOOL (__stdcall *PREAD_PROCESS_MEMORY_ROUTINE64)(HANDLE hProcess,
108 DWORD64 qwBaseAddress, PVOID lpBuffer, DWORD nSize,
109 LPDWORD lpNumberOfBytesRead);
111 typedef PVOID (__stdcall *PFUNCTION_TABLE_ACCESS_ROUTINE64)( HANDLE ahProcess,
114 typedef DWORD64 (__stdcall *PGET_MODULE_BASE_ROUTINE64)(HANDLE hProcess,
117 typedef DWORD64 (__stdcall *PTRANSLATE_ADDRESS_ROUTINE64)(HANDLE hProcess,
118 HANDLE hThread, LPADDRESS64 lpaddr);
120 typedef BOOL (WINAPI *fpStackWalk64)(DWORD, HANDLE, HANDLE, LPSTACKFRAME64,
121 PVOID, PREAD_PROCESS_MEMORY_ROUTINE64,
122 PFUNCTION_TABLE_ACCESS_ROUTINE64,
123 PGET_MODULE_BASE_ROUTINE64,
124 PTRANSLATE_ADDRESS_ROUTINE64);
125 static fpStackWalk64 fStackWalk64;
127 typedef DWORD64 (WINAPI *fpSymGetModuleBase64)(HANDLE, DWORD64);
128 static fpSymGetModuleBase64 fSymGetModuleBase64;
130 typedef BOOL (WINAPI *fpSymGetSymFromAddr64)(HANDLE, DWORD64,
131 PDWORD64, PIMAGEHLP_SYMBOL64);
132 static fpSymGetSymFromAddr64 fSymGetSymFromAddr64;
134 typedef BOOL (WINAPI *fpSymGetLineFromAddr64)(HANDLE, DWORD64,
135 PDWORD, PIMAGEHLP_LINE64);
136 static fpSymGetLineFromAddr64 fSymGetLineFromAddr64;
138 typedef BOOL(WINAPI *fpSymGetModuleInfo64)(HANDLE hProcess, DWORD64 dwAddr,
139 PIMAGEHLP_MODULE64 ModuleInfo);
140 static fpSymGetModuleInfo64 fSymGetModuleInfo64;
142 typedef PVOID (WINAPI *fpSymFunctionTableAccess64)(HANDLE, DWORD64);
143 static fpSymFunctionTableAccess64 fSymFunctionTableAccess64;
145 typedef DWORD (WINAPI *fpSymSetOptions)(DWORD);
146 static fpSymSetOptions fSymSetOptions;
148 typedef BOOL (WINAPI *fpSymInitialize)(HANDLE, PCSTR, BOOL);
149 static fpSymInitialize fSymInitialize;
151 typedef BOOL (WINAPI *fpEnumerateLoadedModules)(HANDLE,PENUMLOADED_MODULES_CALLBACK64,PVOID);
152 static fpEnumerateLoadedModules fEnumerateLoadedModules;
154 static bool load64BitDebugHelp(void) {
155 HMODULE hLib = ::LoadLibraryW(L"Dbghelp.dll");
157 fStackWalk64 = (fpStackWalk64)
158 ::GetProcAddress(hLib, "StackWalk64");
159 fSymGetModuleBase64 = (fpSymGetModuleBase64)
160 ::GetProcAddress(hLib, "SymGetModuleBase64");
161 fSymGetSymFromAddr64 = (fpSymGetSymFromAddr64)
162 ::GetProcAddress(hLib, "SymGetSymFromAddr64");
163 fSymGetLineFromAddr64 = (fpSymGetLineFromAddr64)
164 ::GetProcAddress(hLib, "SymGetLineFromAddr64");
165 fSymGetModuleInfo64 = (fpSymGetModuleInfo64)
166 ::GetProcAddress(hLib, "SymGetModuleInfo64");
167 fSymFunctionTableAccess64 = (fpSymFunctionTableAccess64)
168 ::GetProcAddress(hLib, "SymFunctionTableAccess64");
169 fSymSetOptions = (fpSymSetOptions)::GetProcAddress(hLib, "SymSetOptions");
170 fSymInitialize = (fpSymInitialize)::GetProcAddress(hLib, "SymInitialize");
171 fEnumerateLoadedModules = (fpEnumerateLoadedModules)
172 ::GetProcAddress(hLib, "EnumerateLoadedModules64");
174 return fStackWalk64 && fSymInitialize && fSymSetOptions;
177 using namespace llvm;
180 static LONG WINAPI LLVMUnhandledExceptionFilter(LPEXCEPTION_POINTERS ep);
181 static BOOL WINAPI LLVMConsoleCtrlHandler(DWORD dwCtrlType);
183 // InterruptFunction - The function to call if ctrl-c is pressed.
184 static void (*InterruptFunction)() = 0;
186 static std::vector<std::string> *FilesToRemove = NULL;
187 static bool RegisteredUnhandledExceptionFilter = false;
188 static bool CleanupExecuted = false;
189 static PTOP_LEVEL_EXCEPTION_FILTER OldFilter = NULL;
191 // Windows creates a new thread to execute the console handler when an event
192 // (such as CTRL/C) occurs. This causes concurrency issues with the above
193 // globals which this critical section addresses.
194 static CRITICAL_SECTION CriticalSection;
195 static bool CriticalSectionInitialized = false;
199 NativeMachineType = IMAGE_FILE_MACHINE_AMD64
201 NativeMachineType = IMAGE_FILE_MACHINE_I386
205 static bool printStackTraceWithLLVMSymbolizer(llvm::raw_ostream &OS,
206 HANDLE hProcess, HANDLE hThread,
207 STACKFRAME64 &StackFrameOrig,
208 CONTEXT *ContextOrig) {
209 // StackWalk64 modifies the incoming stack frame and context, so copy them.
210 STACKFRAME64 StackFrame = StackFrameOrig;
212 // Copy the register context so that we don't modify it while we unwind. We
213 // could use InitializeContext + CopyContext, but that's only required to get
214 // at AVX registers, which typically aren't needed by StackWalk64. Reduce the
215 // flag set to indicate that there's less data.
216 CONTEXT Context = *ContextOrig;
217 Context.ContextFlags = CONTEXT_CONTROL | CONTEXT_INTEGER;
219 static void *StackTrace[256];
221 while (fStackWalk64(NativeMachineType, hProcess, hThread, &StackFrame,
222 &Context, 0, fSymFunctionTableAccess64,
223 fSymGetModuleBase64, 0)) {
224 if (StackFrame.AddrFrame.Offset == 0)
226 StackTrace[Depth++] = (void *)(uintptr_t)StackFrame.AddrPC.Offset;
227 if (Depth >= array_lengthof(StackTrace))
231 return printSymbolizedStackTrace(&StackTrace[0], Depth, OS);
235 struct FindModuleData {
238 const char **Modules;
240 StringSaver *StrPool;
244 static BOOL CALLBACK findModuleCallback(WIN32_ELMCB_PCSTR ModuleName,
245 DWORD64 ModuleBase, ULONG ModuleSize,
247 FindModuleData *Data = (FindModuleData*)VoidData;
248 intptr_t Beg = ModuleBase;
249 intptr_t End = Beg + ModuleSize;
250 for (int I = 0; I < Data->Depth; I++) {
251 if (Data->Modules[I])
253 intptr_t Addr = (intptr_t)Data->StackTrace[I];
254 if (Beg <= Addr && Addr < End) {
255 Data->Modules[I] = Data->StrPool->save(ModuleName);
256 Data->Offsets[I] = Addr - Beg;
262 static bool findModulesAndOffsets(void **StackTrace, int Depth,
263 const char **Modules, intptr_t *Offsets,
264 const char *MainExecutableName,
265 StringSaver &StrPool) {
266 if (!fEnumerateLoadedModules)
269 Data.StackTrace = StackTrace;
271 Data.Modules = Modules;
272 Data.Offsets = Offsets;
273 Data.StrPool = &StrPool;
274 fEnumerateLoadedModules(GetCurrentProcess(), findModuleCallback, &Data);
278 static void PrintStackTraceForThread(llvm::raw_ostream &OS, HANDLE hProcess,
279 HANDLE hThread, STACKFRAME64 &StackFrame,
281 // Initialize the symbol handler.
282 fSymSetOptions(SYMOPT_DEFERRED_LOADS | SYMOPT_LOAD_LINES);
283 fSymInitialize(hProcess, NULL, TRUE);
285 // Try llvm-symbolizer first. llvm-symbolizer knows how to deal with both PDBs
286 // and DWARF, so it should do a good job regardless of what debug info or
288 if (printStackTraceWithLLVMSymbolizer(OS, hProcess, hThread, StackFrame,
294 if (!fStackWalk64(NativeMachineType, hProcess, hThread, &StackFrame,
295 Context, 0, fSymFunctionTableAccess64,
296 fSymGetModuleBase64, 0)) {
300 if (StackFrame.AddrFrame.Offset == 0)
303 using namespace llvm;
304 // Print the PC in hexadecimal.
305 DWORD64 PC = StackFrame.AddrPC.Offset;
307 OS << format("0x%016llX", PC);
308 #elif defined(_M_IX86)
309 OS << format("0x%08lX", static_cast<DWORD>(PC));
312 // Print the parameters. Assume there are four.
314 OS << format(" (0x%016llX 0x%016llX 0x%016llX 0x%016llX)",
315 StackFrame.Params[0], StackFrame.Params[1], StackFrame.Params[2],
316 StackFrame.Params[3]);
317 #elif defined(_M_IX86)
318 OS << format(" (0x%08lX 0x%08lX 0x%08lX 0x%08lX)",
319 static_cast<DWORD>(StackFrame.Params[0]),
320 static_cast<DWORD>(StackFrame.Params[1]),
321 static_cast<DWORD>(StackFrame.Params[2]),
322 static_cast<DWORD>(StackFrame.Params[3]));
324 // Verify the PC belongs to a module in this process.
325 if (!fSymGetModuleBase64(hProcess, PC)) {
326 OS << " <unknown module>\n";
330 // Print the symbol name.
332 IMAGEHLP_SYMBOL64 *symbol = reinterpret_cast<IMAGEHLP_SYMBOL64 *>(buffer);
333 memset(symbol, 0, sizeof(IMAGEHLP_SYMBOL64));
334 symbol->SizeOfStruct = sizeof(IMAGEHLP_SYMBOL64);
335 symbol->MaxNameLength = 512 - sizeof(IMAGEHLP_SYMBOL64);
338 if (!fSymGetSymFromAddr64(hProcess, PC, &dwDisp, symbol)) {
345 OS << format(", %s() + 0x%llX bytes(s)", (const char*)symbol->Name,
348 OS << format(", %s", (const char*)symbol->Name);
350 // Print the source file and line number information.
351 IMAGEHLP_LINE64 line = {};
353 line.SizeOfStruct = sizeof(line);
354 if (fSymGetLineFromAddr64(hProcess, PC, &dwLineDisp, &line)) {
355 OS << format(", %s, line %lu", line.FileName, line.LineNumber);
357 OS << format(" + 0x%lX byte(s)", dwLineDisp);
366 //===----------------------------------------------------------------------===//
367 //=== WARNING: Implementation here must contain only Win32 specific code
368 //=== and must not be UNIX code
369 //===----------------------------------------------------------------------===//
372 /// AvoidMessageBoxHook - Emulates hitting "retry" from an "abort, retry,
373 /// ignore" CRT debug report dialog. "retry" raises an exception which
374 /// ultimately triggers our stack dumper.
375 static LLVM_ATTRIBUTE_UNUSED int
376 AvoidMessageBoxHook(int ReportType, char *Message, int *Return) {
377 // Set *Return to the retry code for the return value of _CrtDbgReport:
378 // http://msdn.microsoft.com/en-us/library/8hyw4sy7(v=vs.71).aspx
379 // This may also trigger just-in-time debugging via DebugBreak().
382 // Don't call _CrtDbgReport.
388 extern "C" void HandleAbort(int Sig) {
389 if (Sig == SIGABRT) {
394 static void InitializeThreading() {
395 if (CriticalSectionInitialized)
398 // Now's the time to create the critical section. This is the first time
399 // through here, and there's only one thread.
400 InitializeCriticalSection(&CriticalSection);
401 CriticalSectionInitialized = true;
404 static void RegisterHandler() {
405 // If we cannot load up the APIs (which would be unexpected as they should
406 // exist on every version of Windows we support), we will bail out since
407 // there would be nothing to report.
408 if (!load64BitDebugHelp()) {
409 assert(false && "These APIs should always be available");
413 if (RegisteredUnhandledExceptionFilter) {
414 EnterCriticalSection(&CriticalSection);
418 InitializeThreading();
420 // Enter it immediately. Now if someone hits CTRL/C, the console handler
421 // can't proceed until the globals are updated.
422 EnterCriticalSection(&CriticalSection);
424 RegisteredUnhandledExceptionFilter = true;
425 OldFilter = SetUnhandledExceptionFilter(LLVMUnhandledExceptionFilter);
426 SetConsoleCtrlHandler(LLVMConsoleCtrlHandler, TRUE);
428 // IMPORTANT NOTE: Caller must call LeaveCriticalSection(&CriticalSection) or
429 // else multi-threading problems will ensue.
432 // RemoveFileOnSignal - The public API
433 bool sys::RemoveFileOnSignal(StringRef Filename, std::string* ErrMsg) {
436 if (CleanupExecuted) {
438 *ErrMsg = "Process terminating -- cannot register for removal";
442 if (FilesToRemove == NULL)
443 FilesToRemove = new std::vector<std::string>;
445 FilesToRemove->push_back(Filename);
447 LeaveCriticalSection(&CriticalSection);
451 // DontRemoveFileOnSignal - The public API
452 void sys::DontRemoveFileOnSignal(StringRef Filename) {
453 if (FilesToRemove == NULL)
458 std::vector<std::string>::reverse_iterator I =
459 std::find(FilesToRemove->rbegin(), FilesToRemove->rend(), Filename);
460 if (I != FilesToRemove->rend())
461 FilesToRemove->erase(I.base()-1);
463 LeaveCriticalSection(&CriticalSection);
466 void sys::DisableSystemDialogsOnCrash() {
467 // Crash to stack trace handler on abort.
468 signal(SIGABRT, HandleAbort);
470 // The following functions are not reliably accessible on MinGW.
472 // We're already handling writing a "something went wrong" message.
473 _set_abort_behavior(0, _WRITE_ABORT_MSG);
474 // Disable Dr. Watson.
475 _set_abort_behavior(0, _CALL_REPORTFAULT);
476 _CrtSetReportHook(AvoidMessageBoxHook);
479 // Disable standard error dialog box.
480 SetErrorMode(SEM_FAILCRITICALERRORS | SEM_NOGPFAULTERRORBOX |
481 SEM_NOOPENFILEERRORBOX);
482 _set_error_mode(_OUT_TO_STDERR);
485 /// PrintStackTraceOnErrorSignal - When an error signal (such as SIBABRT or
486 /// SIGSEGV) is delivered to the process, print a stack trace and then exit.
487 void sys::PrintStackTraceOnErrorSignal(bool DisableCrashReporting) {
488 DisableSystemDialogsOnCrash();
490 LeaveCriticalSection(&CriticalSection);
494 #if defined(__MINGW32__) && !defined(__MINGW64_VERSION_MAJOR)
495 // Provide a prototype for RtlCaptureContext, mingw32 from mingw.org is
496 // missing it but mingw-w64 has it.
497 extern "C" VOID WINAPI RtlCaptureContext(PCONTEXT ContextRecord);
500 void llvm::sys::PrintStackTrace(raw_ostream &OS) {
501 STACKFRAME64 StackFrame = {};
502 CONTEXT Context = {};
503 ::RtlCaptureContext(&Context);
505 StackFrame.AddrPC.Offset = Context.Rip;
506 StackFrame.AddrStack.Offset = Context.Rsp;
507 StackFrame.AddrFrame.Offset = Context.Rbp;
509 StackFrame.AddrPC.Offset = Context.Eip;
510 StackFrame.AddrStack.Offset = Context.Esp;
511 StackFrame.AddrFrame.Offset = Context.Ebp;
513 StackFrame.AddrPC.Mode = AddrModeFlat;
514 StackFrame.AddrStack.Mode = AddrModeFlat;
515 StackFrame.AddrFrame.Mode = AddrModeFlat;
516 PrintStackTraceForThread(OS, GetCurrentProcess(), GetCurrentThread(),
517 StackFrame, &Context);
521 void llvm::sys::SetInterruptFunction(void (*IF)()) {
523 InterruptFunction = IF;
524 LeaveCriticalSection(&CriticalSection);
528 /// AddSignalHandler - Add a function to be called when a signal is delivered
529 /// to the process. The handler can have a cookie passed to it to identify
530 /// what instance of the handler it is.
531 void llvm::sys::AddSignalHandler(void (*FnPtr)(void *), void *Cookie) {
532 CallBacksToRun->push_back(std::make_pair(FnPtr, Cookie));
534 LeaveCriticalSection(&CriticalSection);
537 static void Cleanup() {
541 EnterCriticalSection(&CriticalSection);
543 // Prevent other thread from registering new files and directories for
544 // removal, should we be executing because of the console handler callback.
545 CleanupExecuted = true;
547 // FIXME: open files cannot be deleted.
548 if (FilesToRemove != NULL)
549 while (!FilesToRemove->empty()) {
550 llvm::sys::fs::remove(FilesToRemove->back());
551 FilesToRemove->pop_back();
553 llvm::sys::RunSignalHandlers();
554 LeaveCriticalSection(&CriticalSection);
557 void llvm::sys::RunInterruptHandlers() {
558 // The interrupt handler may be called from an interrupt, but it may also be
559 // called manually (such as the case of report_fatal_error with no registered
560 // error handler). We must ensure that the critical section is properly
562 InitializeThreading();
566 static LONG WINAPI LLVMUnhandledExceptionFilter(LPEXCEPTION_POINTERS ep) {
569 // Initialize the STACKFRAME structure.
570 STACKFRAME64 StackFrame = {};
573 StackFrame.AddrPC.Offset = ep->ContextRecord->Rip;
574 StackFrame.AddrPC.Mode = AddrModeFlat;
575 StackFrame.AddrStack.Offset = ep->ContextRecord->Rsp;
576 StackFrame.AddrStack.Mode = AddrModeFlat;
577 StackFrame.AddrFrame.Offset = ep->ContextRecord->Rbp;
578 StackFrame.AddrFrame.Mode = AddrModeFlat;
579 #elif defined(_M_IX86)
580 StackFrame.AddrPC.Offset = ep->ContextRecord->Eip;
581 StackFrame.AddrPC.Mode = AddrModeFlat;
582 StackFrame.AddrStack.Offset = ep->ContextRecord->Esp;
583 StackFrame.AddrStack.Mode = AddrModeFlat;
584 StackFrame.AddrFrame.Offset = ep->ContextRecord->Ebp;
585 StackFrame.AddrFrame.Mode = AddrModeFlat;
588 HANDLE hProcess = GetCurrentProcess();
589 HANDLE hThread = GetCurrentThread();
590 PrintStackTraceForThread(llvm::errs(), hProcess, hThread, StackFrame,
593 _exit(ep->ExceptionRecord->ExceptionCode);
596 static BOOL WINAPI LLVMConsoleCtrlHandler(DWORD dwCtrlType) {
597 // We are running in our very own thread, courtesy of Windows.
598 EnterCriticalSection(&CriticalSection);
601 // If an interrupt function has been set, go and run one it; otherwise,
603 void (*IF)() = InterruptFunction;
604 InterruptFunction = 0; // Don't run it on another CTRL-C.
607 // Note: if the interrupt function throws an exception, there is nothing
608 // to catch it in this thread so it will kill the process.
610 LeaveCriticalSection(&CriticalSection);
611 return TRUE; // Don't kill the process.
614 // Allow normal processing to take place; i.e., the process dies.
615 LeaveCriticalSection(&CriticalSection);
620 // We turned these warnings off for this file so that MinGW-g++ doesn't
621 // complain about the ll format specifiers used. Now we are turning the
622 // warnings back on. If MinGW starts to support diagnostic stacks, we can
623 // replace this with a pop.
624 #pragma GCC diagnostic warning "-Wformat"
625 #pragma GCC diagnostic warning "-Wformat-extra-args"