lib/System/Win32/Signals.inc

   1 //===- Win32/Signals.cpp - Win32 Signals Implementation ---------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Jeff Cohen and is distributed under the
   6 // University of Illinois Open Source 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
  18 #ifdef __MINGW32__
  19  #include <imagehlp.h>
  20 #else
  21  #include <dbghelp.h>
  22 #endif
  23 #include <psapi.h>
  24
  25 #ifdef __MINGW32__
  26  #if ((HAVE_LIBIMAGEHLP != 1) || (HAVE_LIBPSAPI != 1))
  27   #error "libimagehlp.a & libpsapi.a should be present"
  28  #endif
  29 #else
  30  #pragma comment(lib, "psapi.lib")
  31  #pragma comment(lib, "dbghelp.lib")
  32 #endif
  33
  34 // Forward declare.
  35 static LONG WINAPI LLVMUnhandledExceptionFilter(LPEXCEPTION_POINTERS ep);
  36 static BOOL WINAPI LLVMConsoleCtrlHandler(DWORD dwCtrlType);
  37
  38 // InterruptFunction - The function to call if ctrl-c is pressed.
  39 static void (*InterruptFunction)() = 0;
  40
  41 static std::vector<llvm::sys::Path> *FilesToRemove = NULL;
  42 static std::vector<llvm::sys::Path> *DirectoriesToRemove = NULL;
  43 static bool RegisteredUnhandledExceptionFilter = false;
  44 static bool CleanupExecuted = false;
  45 static PTOP_LEVEL_EXCEPTION_FILTER OldFilter = NULL;
  46
  47 // Windows creates a new thread to execute the console handler when an event
  48 // (such as CTRL/C) occurs.  This causes concurrency issues with the above
  49 // globals which this critical section addresses.
  50 static CRITICAL_SECTION CriticalSection;
  51
  52 namespace llvm {
  53
  54 //===----------------------------------------------------------------------===//
  55 //=== WARNING: Implementation here must contain only Win32 specific code
  56 //===          and must not be UNIX code
  57 //===----------------------------------------------------------------------===//
  58
  59
  60 static void RegisterHandler() {
  61   if (RegisteredUnhandledExceptionFilter) {
  62     EnterCriticalSection(&CriticalSection);
  63     return;
  64   }
  65
  66   // Now's the time to create the critical section.  This is the first time
  67   // through here, and there's only one thread.
  68   InitializeCriticalSection(&CriticalSection);
  69
  70   // Enter it immediately.  Now if someone hits CTRL/C, the console handler
  71   // can't proceed until the globals are updated.
  72   EnterCriticalSection(&CriticalSection);
  73
  74   RegisteredUnhandledExceptionFilter = true;
  75   OldFilter = SetUnhandledExceptionFilter(LLVMUnhandledExceptionFilter);
  76   SetConsoleCtrlHandler(LLVMConsoleCtrlHandler, TRUE);
  77
  78   // IMPORTANT NOTE: Caller must call LeaveCriticalSection(&CriticalSection) or
  79   // else multi-threading problems will ensue.
  80 }
  81
  82 // RemoveFileOnSignal - The public API
  83 void sys::RemoveFileOnSignal(const sys::Path &Filename) {
  84   RegisterHandler();
  85
  86   if (CleanupExecuted)
  87     throw std::string("Process terminating -- cannot register for removal");
  88
  89   if (FilesToRemove == NULL)
  90     FilesToRemove = new std::vector<sys::Path>;
  91
  92   FilesToRemove->push_back(Filename);
  93
  94   LeaveCriticalSection(&CriticalSection);
  95 }
  96
  97 // RemoveDirectoryOnSignal - The public API
  98 void sys::RemoveDirectoryOnSignal(const sys::Path& path) {
  99   RegisterHandler();
 100
 101   if (CleanupExecuted)
 102     throw std::string("Process terminating -- cannot register for removal");
 103
 104   if (path.isDirectory()) {
 105     if (DirectoriesToRemove == NULL)
 106       DirectoriesToRemove = new std::vector<sys::Path>;
 107
 108     DirectoriesToRemove->push_back(path);
 109   }
 110
 111   LeaveCriticalSection(&CriticalSection);
 112 }
 113
 114 /// PrintStackTraceOnErrorSignal - When an error signal (such as SIBABRT or
 115 /// SIGSEGV) is delivered to the process, print a stack trace and then exit.
 116 void sys::PrintStackTraceOnErrorSignal() {
 117   RegisterHandler();
 118   LeaveCriticalSection(&CriticalSection);
 119 }
 120
 121
 122 void sys::SetInterruptFunction(void (*IF)()) {
 123   RegisterHandler();
 124   InterruptFunction = IF;
 125   LeaveCriticalSection(&CriticalSection);
 126 }
 127 }
 128
 129 static void Cleanup() {
 130   EnterCriticalSection(&CriticalSection);
 131
 132   // Prevent other thread from registering new files and directories for
 133   // removal, should we be executing because of the console handler callback.
 134   CleanupExecuted = true;
 135
 136   // FIXME: open files cannot be deleted.
 137
 138   if (FilesToRemove != NULL)
 139     while (!FilesToRemove->empty()) {
 140       try {
 141         FilesToRemove->back().eraseFromDisk();
 142       } catch (...) {
 143       }
 144       FilesToRemove->pop_back();
 145     }
 146
 147   if (DirectoriesToRemove != NULL)
 148     while (!DirectoriesToRemove->empty()) {
 149       try {
 150         DirectoriesToRemove->back().eraseFromDisk(true);
 151       } catch (...) {
 152       }
 153       DirectoriesToRemove->pop_back();
 154     }
 155
 156   LeaveCriticalSection(&CriticalSection);
 157 }
 158
 159 static LONG WINAPI LLVMUnhandledExceptionFilter(LPEXCEPTION_POINTERS ep) {
 160   try {
 161     Cleanup();
 162
 163     // Initialize the STACKFRAME structure.
 164     STACKFRAME StackFrame;
 165     memset(&StackFrame, 0, sizeof(StackFrame));
 166
 167     StackFrame.AddrPC.Offset = ep->ContextRecord->Eip;
 168     StackFrame.AddrPC.Mode = AddrModeFlat;
 169     StackFrame.AddrStack.Offset = ep->ContextRecord->Esp;
 170     StackFrame.AddrStack.Mode = AddrModeFlat;
 171     StackFrame.AddrFrame.Offset = ep->ContextRecord->Ebp;
 172     StackFrame.AddrFrame.Mode = AddrModeFlat;
 173
 174     HANDLE hProcess = GetCurrentProcess();
 175     HANDLE hThread = GetCurrentThread();
 176
 177     // Initialize the symbol handler.
 178     SymSetOptions(SYMOPT_DEFERRED_LOADS|SYMOPT_LOAD_LINES);
 179     SymInitialize(hProcess, NULL, TRUE);
 180
 181     while (true) {
 182       if (!StackWalk(IMAGE_FILE_MACHINE_I386, hProcess, hThread, &StackFrame,
 183                      ep->ContextRecord, NULL, SymFunctionTableAccess,
 184                      SymGetModuleBase, NULL)) {
 185         break;
 186       }
 187
 188       if (StackFrame.AddrFrame.Offset == 0)
 189         break;
 190
 191       // Print the PC in hexadecimal.
 192       DWORD PC = StackFrame.AddrPC.Offset;
 193       fprintf(stderr, "%08X", PC);
 194
 195       // Print the parameters.  Assume there are four.
 196       fprintf(stderr, " (0x%08X 0x%08X 0x%08X 0x%08X)", StackFrame.Params[0],
 197               StackFrame.Params[1], StackFrame.Params[2], StackFrame.Params[3]);
 198
 199       // Verify the PC belongs to a module in this process.
 200       if (!SymGetModuleBase(hProcess, PC)) {
 201         fputs(" <unknown module>\n", stderr);
 202         continue;
 203       }
 204
 205       // Print the symbol name.
 206       char buffer[512];
 207       IMAGEHLP_SYMBOL *symbol = reinterpret_cast<IMAGEHLP_SYMBOL *>(buffer);
 208       memset(symbol, 0, sizeof(IMAGEHLP_SYMBOL));
 209       symbol->SizeOfStruct = sizeof(IMAGEHLP_SYMBOL);
 210       symbol->MaxNameLength = 512 - sizeof(IMAGEHLP_SYMBOL);
 211
 212       DWORD dwDisp;
 213       if (!SymGetSymFromAddr(hProcess, PC, &dwDisp, symbol)) {
 214         fputc('\n', stderr);
 215         continue;
 216       }
 217
 218       buffer[511] = 0;
 219       if (dwDisp > 0)
 220         fprintf(stderr, ", %s()+%04d bytes(s)", symbol->Name, dwDisp);
 221       else
 222         fprintf(stderr, ", %s", symbol->Name);
 223
 224       // Print the source file and line number information.
 225       IMAGEHLP_LINE line;
 226       memset(&line, 0, sizeof(line));
 227       line.SizeOfStruct = sizeof(line);
 228       if (SymGetLineFromAddr(hProcess, PC, &dwDisp, &line)) {
 229         fprintf(stderr, ", %s, line %d", line.FileName, line.LineNumber);
 230         if (dwDisp > 0)
 231           fprintf(stderr, "+%04d byte(s)", dwDisp);
 232       }
 233
 234       fputc('\n', stderr);
 235     }
 236   } catch (...) {
 237       assert(!"Crashed in LLVMUnhandledExceptionFilter");
 238   }
 239
 240   // Allow dialog box to pop up allowing choice to start debugger.
 241   if (OldFilter)
 242     return (*OldFilter)(ep);
 243   else
 244     return EXCEPTION_CONTINUE_SEARCH;
 245 }
 246
 247 static BOOL WINAPI LLVMConsoleCtrlHandler(DWORD dwCtrlType) {
 248   // We are running in our very own thread, courtesy of Windows.
 249   EnterCriticalSection(&CriticalSection);
 250   Cleanup();
 251
 252   // If an interrupt function has been set, go and run one it; otherwise,
 253   // the process dies.
 254   void (*IF)() = InterruptFunction;
 255   InterruptFunction = 0;      // Don't run it on another CTRL-C.
 256
 257   if (IF) {
 258     // Note: if the interrupt function throws an exception, there is nothing
 259     // to catch it in this thread so it will kill the process.
 260     IF();                     // Run it now.
 261     LeaveCriticalSection(&CriticalSection);
 262     return TRUE;              // Don't kill the process.
 263   }
 264
 265   // Allow normal processing to take place; i.e., the process dies.
 266   LeaveCriticalSection(&CriticalSection);
 267   return FALSE;
 268 }
 269