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 #if ((HAVE_LIBIMAGEHLP != 1) || (HAVE_LIBPSAPI != 1))
28 #error "libimagehlp.a & libpsapi.a should be present"
31 #pragma comment(lib, "psapi.lib")
32 #pragma comment(lib, "dbghelp.lib")
36 static LONG WINAPI LLVMUnhandledExceptionFilter(LPEXCEPTION_POINTERS ep);
37 static BOOL WINAPI LLVMConsoleCtrlHandler(DWORD dwCtrlType);
39 // InterruptFunction - The function to call if ctrl-c is pressed.
40 static void (*InterruptFunction)() = 0;
42 static std::vector<llvm::sys::Path> *FilesToRemove = NULL;
43 static std::vector<std::pair<void(*)(void*), void*> > *CallBacksToRun = 0;
44 static bool RegisteredUnhandledExceptionFilter = false;
45 static bool CleanupExecuted = false;
47 static bool ExitOnUnhandledExceptions = false;
49 static PTOP_LEVEL_EXCEPTION_FILTER OldFilter = NULL;
51 // Windows creates a new thread to execute the console handler when an event
52 // (such as CTRL/C) occurs. This causes concurrency issues with the above
53 // globals which this critical section addresses.
54 static CRITICAL_SECTION CriticalSection;
58 //===----------------------------------------------------------------------===//
59 //=== WARNING: Implementation here must contain only Win32 specific code
60 //=== and must not be UNIX code
61 //===----------------------------------------------------------------------===//
64 /// CRTReportHook - Function called on a CRT debugging event.
65 static int CRTReportHook(int ReportType, char *Message, int *Return) {
66 // Don't cause a DebugBreak() on return.
73 fprintf(stderr, "CRT assert: %s\n", Message);
74 // FIXME: Is there a way to just crash? Perhaps throw to the unhandled
75 // exception code? Perhaps SetErrorMode() handles this.
79 fprintf(stderr, "CRT error: %s\n", Message);
80 // FIXME: Is there a way to just crash? Perhaps throw to the unhandled
81 // exception code? Perhaps SetErrorMode() handles this.
85 fprintf(stderr, "CRT warn: %s\n", Message);
89 // Don't call _CrtDbgReport.
94 static void RegisterHandler() {
95 if (RegisteredUnhandledExceptionFilter) {
96 EnterCriticalSection(&CriticalSection);
100 // Now's the time to create the critical section. This is the first time
101 // through here, and there's only one thread.
102 InitializeCriticalSection(&CriticalSection);
104 // Enter it immediately. Now if someone hits CTRL/C, the console handler
105 // can't proceed until the globals are updated.
106 EnterCriticalSection(&CriticalSection);
108 RegisteredUnhandledExceptionFilter = true;
109 OldFilter = SetUnhandledExceptionFilter(LLVMUnhandledExceptionFilter);
110 SetConsoleCtrlHandler(LLVMConsoleCtrlHandler, TRUE);
112 // Environment variable to disable any kind of crash dialog.
114 if (getenv("LLVM_DISABLE_CRT_DEBUG")) {
115 _CrtSetReportHook(CRTReportHook);
116 ExitOnUnhandledExceptions = true;
120 // IMPORTANT NOTE: Caller must call LeaveCriticalSection(&CriticalSection) or
121 // else multi-threading problems will ensue.
124 // RemoveFileOnSignal - The public API
125 bool sys::RemoveFileOnSignal(const sys::Path &Filename, std::string* ErrMsg) {
128 if (CleanupExecuted) {
130 *ErrMsg = "Process terminating -- cannot register for removal";
134 if (FilesToRemove == NULL)
135 FilesToRemove = new std::vector<sys::Path>;
137 FilesToRemove->push_back(Filename);
139 LeaveCriticalSection(&CriticalSection);
143 /// PrintStackTraceOnErrorSignal - When an error signal (such as SIBABRT or
144 /// SIGSEGV) is delivered to the process, print a stack trace and then exit.
145 void sys::PrintStackTraceOnErrorSignal() {
147 LeaveCriticalSection(&CriticalSection);
151 void sys::SetInterruptFunction(void (*IF)()) {
153 InterruptFunction = IF;
154 LeaveCriticalSection(&CriticalSection);
158 /// AddSignalHandler - Add a function to be called when a signal is delivered
159 /// to the process. The handler can have a cookie passed to it to identify
160 /// what instance of the handler it is.
161 void sys::AddSignalHandler(void (*FnPtr)(void *), void *Cookie) {
162 if (CallBacksToRun == 0)
163 CallBacksToRun = new std::vector<std::pair<void(*)(void*), void*> >();
164 CallBacksToRun->push_back(std::make_pair(FnPtr, Cookie));
169 static void Cleanup() {
170 EnterCriticalSection(&CriticalSection);
172 // Prevent other thread from registering new files and directories for
173 // removal, should we be executing because of the console handler callback.
174 CleanupExecuted = true;
176 // FIXME: open files cannot be deleted.
178 if (FilesToRemove != NULL)
179 while (!FilesToRemove->empty()) {
180 FilesToRemove->back().eraseFromDisk();
181 FilesToRemove->pop_back();
185 for (unsigned i = 0, e = CallBacksToRun->size(); i != e; ++i)
186 (*CallBacksToRun)[i].first((*CallBacksToRun)[i].second);
188 LeaveCriticalSection(&CriticalSection);
191 static LONG WINAPI LLVMUnhandledExceptionFilter(LPEXCEPTION_POINTERS ep) {
196 // TODO: provide a x64 friendly version of the following
199 // Initialize the STACKFRAME structure.
200 STACKFRAME StackFrame;
201 memset(&StackFrame, 0, sizeof(StackFrame));
203 StackFrame.AddrPC.Offset = ep->ContextRecord->Eip;
204 StackFrame.AddrPC.Mode = AddrModeFlat;
205 StackFrame.AddrStack.Offset = ep->ContextRecord->Esp;
206 StackFrame.AddrStack.Mode = AddrModeFlat;
207 StackFrame.AddrFrame.Offset = ep->ContextRecord->Ebp;
208 StackFrame.AddrFrame.Mode = AddrModeFlat;
210 HANDLE hProcess = GetCurrentProcess();
211 HANDLE hThread = GetCurrentThread();
213 // Initialize the symbol handler.
214 SymSetOptions(SYMOPT_DEFERRED_LOADS|SYMOPT_LOAD_LINES);
215 SymInitialize(hProcess, NULL, TRUE);
218 if (!StackWalk(IMAGE_FILE_MACHINE_I386, hProcess, hThread, &StackFrame,
219 ep->ContextRecord, NULL, SymFunctionTableAccess,
220 SymGetModuleBase, NULL)) {
224 if (StackFrame.AddrFrame.Offset == 0)
227 // Print the PC in hexadecimal.
228 DWORD PC = StackFrame.AddrPC.Offset;
229 fprintf(stderr, "%08lX", PC);
231 // Print the parameters. Assume there are four.
232 fprintf(stderr, " (0x%08lX 0x%08lX 0x%08lX 0x%08lX)", StackFrame.Params[0],
233 StackFrame.Params[1], StackFrame.Params[2], StackFrame.Params[3]);
235 // Verify the PC belongs to a module in this process.
236 if (!SymGetModuleBase(hProcess, PC)) {
237 fputs(" <unknown module>\n", stderr);
241 // Print the symbol name.
243 IMAGEHLP_SYMBOL *symbol = reinterpret_cast<IMAGEHLP_SYMBOL *>(buffer);
244 memset(symbol, 0, sizeof(IMAGEHLP_SYMBOL));
245 symbol->SizeOfStruct = sizeof(IMAGEHLP_SYMBOL);
246 symbol->MaxNameLength = 512 - sizeof(IMAGEHLP_SYMBOL);
249 if (!SymGetSymFromAddr(hProcess, PC, &dwDisp, symbol)) {
256 fprintf(stderr, ", %s()+%04lu bytes(s)", symbol->Name, dwDisp);
258 fprintf(stderr, ", %s", symbol->Name);
260 // Print the source file and line number information.
262 memset(&line, 0, sizeof(line));
263 line.SizeOfStruct = sizeof(line);
264 if (SymGetLineFromAddr(hProcess, PC, &dwDisp, &line)) {
265 fprintf(stderr, ", %s, line %lu", line.FileName, line.LineNumber);
267 fprintf(stderr, "+%04lu byte(s)", dwDisp);
276 assert(0 && "Crashed in LLVMUnhandledExceptionFilter");
280 if (ExitOnUnhandledExceptions)
284 // Allow dialog box to pop up allowing choice to start debugger.
286 return (*OldFilter)(ep);
288 return EXCEPTION_CONTINUE_SEARCH;
291 static BOOL WINAPI LLVMConsoleCtrlHandler(DWORD dwCtrlType) {
292 // We are running in our very own thread, courtesy of Windows.
293 EnterCriticalSection(&CriticalSection);
296 // If an interrupt function has been set, go and run one it; otherwise,
298 void (*IF)() = InterruptFunction;
299 InterruptFunction = 0; // Don't run it on another CTRL-C.
302 // Note: if the interrupt function throws an exception, there is nothing
303 // to catch it in this thread so it will kill the process.
305 LeaveCriticalSection(&CriticalSection);
306 return TRUE; // Don't kill the process.
309 // Allow normal processing to take place; i.e., the process dies.
310 LeaveCriticalSection(&CriticalSection);