lib/System/Win32/Signals.inc

   1 //===- Win32/Signals.cpp - Win32 Signals Implementation ---------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file provides the Win32 specific implementation of the Signals class.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "Win32.h"
  15 #include <stdio.h>
  16 #include <vector>
  17 #include <algorithm>
  18
  19 #ifdef __MINGW32__
  20  #include <imagehlp.h>
  21 #else
  22  #include <dbghelp.h>
  23 #endif
  24 #include <psapi.h>
  25
  26 #ifdef __MINGW32__
  27  #if ((HAVE_LIBIMAGEHLP != 1) || (HAVE_LIBPSAPI != 1))
  28   #error "libimagehlp.a & libpsapi.a should be present"
  29  #endif
  30 #else
  31  #pragma comment(lib, "psapi.lib")
  32  #pragma comment(lib, "dbghelp.lib")
  33 #endif
  34
  35 // Forward declare.
  36 static LONG WINAPI LLVMUnhandledExceptionFilter(LPEXCEPTION_POINTERS ep);
  37 static BOOL WINAPI LLVMConsoleCtrlHandler(DWORD dwCtrlType);
  38
  39 // InterruptFunction - The function to call if ctrl-c is pressed.
  40 static void (*InterruptFunction)() = 0;
  41
  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;
  46 #ifdef _MSC_VER
  47 static bool ExitOnUnhandledExceptions = false;
  48 #endif
  49 static PTOP_LEVEL_EXCEPTION_FILTER OldFilter = NULL;
  50
  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;
  55
  56 namespace llvm {
  57
  58 //===----------------------------------------------------------------------===//
  59 //=== WARNING: Implementation here must contain only Win32 specific code
  60 //===          and must not be UNIX code
  61 //===----------------------------------------------------------------------===//
  62
  63 #ifdef _MSC_VER
  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.
  67   if (Return)
  68     *Return = 0;
  69
  70   switch (ReportType) {
  71   default:
  72   case _CRT_ASSERT:
  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.
  76     _exit(3);
  77     break;
  78   case _CRT_ERROR:
  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.
  82     _exit(3);
  83     break;
  84   case _CRT_WARN:
  85     fprintf(stderr, "CRT warn: %s\n", Message);
  86     break;
  87   }
  88
  89   // Don't call _CrtDbgReport.
  90   return TRUE;
  91 }
  92 #endif
  93
  94 static void RegisterHandler() {
  95   if (RegisteredUnhandledExceptionFilter) {
  96     EnterCriticalSection(&CriticalSection);
  97     return;
  98   }
  99
 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);
 103
 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);
 107
 108   RegisteredUnhandledExceptionFilter = true;
 109   OldFilter = SetUnhandledExceptionFilter(LLVMUnhandledExceptionFilter);
 110   SetConsoleCtrlHandler(LLVMConsoleCtrlHandler, TRUE);
 111
 112   // Environment variable to disable any kind of crash dialog.
 113 #ifdef _MSC_VER
 114   if (getenv("LLVM_DISABLE_CRT_DEBUG")) {
 115     _CrtSetReportHook(CRTReportHook);
 116     ExitOnUnhandledExceptions = true;
 117   }
 118 #endif
 119
 120   // IMPORTANT NOTE: Caller must call LeaveCriticalSection(&CriticalSection) or
 121   // else multi-threading problems will ensue.
 122 }
 123
 124 // RemoveFileOnSignal - The public API
 125 bool sys::RemoveFileOnSignal(const sys::Path &Filename, std::string* ErrMsg) {
 126   RegisterHandler();
 127
 128   if (CleanupExecuted) {
 129     if (ErrMsg)
 130       *ErrMsg = "Process terminating -- cannot register for removal";
 131     return true;
 132   }
 133
 134   if (FilesToRemove == NULL)
 135     FilesToRemove = new std::vector<sys::Path>;
 136
 137   FilesToRemove->push_back(Filename);
 138
 139   LeaveCriticalSection(&CriticalSection);
 140   return false;
 141 }
 142
 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() {
 146   RegisterHandler();
 147   LeaveCriticalSection(&CriticalSection);
 148 }
 149
 150
 151 void sys::SetInterruptFunction(void (*IF)()) {
 152   RegisterHandler();
 153   InterruptFunction = IF;
 154   LeaveCriticalSection(&CriticalSection);
 155 }
 156
 157
 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));
 165   RegisterHandler();
 166   LeaveCriticalSection(&CriticalSection);
 167 }
 168 }
 169
 170 static void Cleanup() {
 171   EnterCriticalSection(&CriticalSection);
 172
 173   // Prevent other thread from registering new files and directories for
 174   // removal, should we be executing because of the console handler callback.
 175   CleanupExecuted = true;
 176
 177   // FIXME: open files cannot be deleted.
 178
 179   if (FilesToRemove != NULL)
 180     while (!FilesToRemove->empty()) {
 181       FilesToRemove->back().eraseFromDisk();
 182       FilesToRemove->pop_back();
 183     }
 184
 185   if (CallBacksToRun)
 186     for (unsigned i = 0, e = CallBacksToRun->size(); i != e; ++i)
 187       (*CallBacksToRun)[i].first((*CallBacksToRun)[i].second);
 188
 189   LeaveCriticalSection(&CriticalSection);
 190 }
 191
 192 static LONG WINAPI LLVMUnhandledExceptionFilter(LPEXCEPTION_POINTERS ep) {
 193   try {
 194     Cleanup();
 195
 196 #ifdef _WIN64
 197   // TODO: provide a x64 friendly version of the following
 198 #else
 199
 200     // Initialize the STACKFRAME structure.
 201     STACKFRAME StackFrame;
 202     memset(&StackFrame, 0, sizeof(StackFrame));
 203
 204     StackFrame.AddrPC.Offset = ep->ContextRecord->Eip;
 205     StackFrame.AddrPC.Mode = AddrModeFlat;
 206     StackFrame.AddrStack.Offset = ep->ContextRecord->Esp;
 207     StackFrame.AddrStack.Mode = AddrModeFlat;
 208     StackFrame.AddrFrame.Offset = ep->ContextRecord->Ebp;
 209     StackFrame.AddrFrame.Mode = AddrModeFlat;
 210
 211     HANDLE hProcess = GetCurrentProcess();
 212     HANDLE hThread = GetCurrentThread();
 213
 214     // Initialize the symbol handler.
 215     SymSetOptions(SYMOPT_DEFERRED_LOADS|SYMOPT_LOAD_LINES);
 216     SymInitialize(hProcess, NULL, TRUE);
 217
 218     while (true) {
 219       if (!StackWalk(IMAGE_FILE_MACHINE_I386, hProcess, hThread, &StackFrame,
 220                      ep->ContextRecord, NULL, SymFunctionTableAccess,
 221                      SymGetModuleBase, NULL)) {
 222         break;
 223       }
 224
 225       if (StackFrame.AddrFrame.Offset == 0)
 226         break;
 227
 228       // Print the PC in hexadecimal.
 229       DWORD PC = StackFrame.AddrPC.Offset;
 230       fprintf(stderr, "%08lX", PC);
 231
 232       // Print the parameters.  Assume there are four.
 233       fprintf(stderr, " (0x%08lX 0x%08lX 0x%08lX 0x%08lX)", StackFrame.Params[0],
 234               StackFrame.Params[1], StackFrame.Params[2], StackFrame.Params[3]);
 235
 236       // Verify the PC belongs to a module in this process.
 237       if (!SymGetModuleBase(hProcess, PC)) {
 238         fputs(" <unknown module>\n", stderr);
 239         continue;
 240       }
 241
 242       // Print the symbol name.
 243       char buffer[512];
 244       IMAGEHLP_SYMBOL *symbol = reinterpret_cast<IMAGEHLP_SYMBOL *>(buffer);
 245       memset(symbol, 0, sizeof(IMAGEHLP_SYMBOL));
 246       symbol->SizeOfStruct = sizeof(IMAGEHLP_SYMBOL);
 247       symbol->MaxNameLength = 512 - sizeof(IMAGEHLP_SYMBOL);
 248
 249       DWORD dwDisp;
 250       if (!SymGetSymFromAddr(hProcess, PC, &dwDisp, symbol)) {
 251         fputc('\n', stderr);
 252         continue;
 253       }
 254
 255       buffer[511] = 0;
 256       if (dwDisp > 0)
 257         fprintf(stderr, ", %s()+%04lu bytes(s)", symbol->Name, dwDisp);
 258       else
 259         fprintf(stderr, ", %s", symbol->Name);
 260
 261       // Print the source file and line number information.
 262       IMAGEHLP_LINE line;
 263       memset(&line, 0, sizeof(line));
 264       line.SizeOfStruct = sizeof(line);
 265       if (SymGetLineFromAddr(hProcess, PC, &dwDisp, &line)) {
 266         fprintf(stderr, ", %s, line %lu", line.FileName, line.LineNumber);
 267         if (dwDisp > 0)
 268           fprintf(stderr, "+%04lu byte(s)", dwDisp);
 269       }
 270
 271       fputc('\n', stderr);
 272     }
 273
 274 #endif
 275
 276   } catch (...) {
 277       assert(0 && "Crashed in LLVMUnhandledExceptionFilter");
 278   }
 279
 280 #ifdef _MSC_VER
 281   if (ExitOnUnhandledExceptions)
 282         _exit(-3);
 283 #endif
 284
 285   // Allow dialog box to pop up allowing choice to start debugger.
 286   if (OldFilter)
 287     return (*OldFilter)(ep);
 288   else
 289     return EXCEPTION_CONTINUE_SEARCH;
 290 }
 291
 292 static BOOL WINAPI LLVMConsoleCtrlHandler(DWORD dwCtrlType) {
 293   // We are running in our very own thread, courtesy of Windows.
 294   EnterCriticalSection(&CriticalSection);
 295   Cleanup();
 296
 297   // If an interrupt function has been set, go and run one it; otherwise,
 298   // the process dies.
 299   void (*IF)() = InterruptFunction;
 300   InterruptFunction = 0;      // Don't run it on another CTRL-C.
 301
 302   if (IF) {
 303     // Note: if the interrupt function throws an exception, there is nothing
 304     // to catch it in this thread so it will kill the process.
 305     IF();                     // Run it now.
 306     LeaveCriticalSection(&CriticalSection);
 307     return TRUE;              // Don't kill the process.
 308   }
 309
 310   // Allow normal processing to take place; i.e., the process dies.
 311   LeaveCriticalSection(&CriticalSection);
 312   return FALSE;
 313 }
 314