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 bool sys::RemoveFileOnSignal(const sys::Path &Filename, std::string* ErrMsg) {
  84   RegisterHandler();
  85
  86   if (CleanupExecuted) {
  87     if (ErrMsg)
  88       *ErrMsg = "Process terminating -- cannot register for removal";
  89     return true;
  90   }
  91
  92   if (FilesToRemove == NULL)
  93     FilesToRemove = new std::vector<sys::Path>;
  94
  95   FilesToRemove->push_back(Filename);
  96
  97   LeaveCriticalSection(&CriticalSection);
  98   return false;
  99 }
 100
 101 // RemoveDirectoryOnSignal - The public API
 102 bool sys::RemoveDirectoryOnSignal(const sys::Path& path, std::string* ErrMsg) {
 103   // Not a directory?
 104   sys::FileStatus Status;
 105   if (path.getFileStatus(Status) || !Status.isDir) {
 106     if (ErrMsg)
 107       *ErrMsg = path.toString() + " is not a directory";
 108     return true;
 109   }
 110
 111   RegisterHandler();
 112
 113   if (CleanupExecuted) {
 114     if (ErrMsg)
 115       *ErrMsg = "Process terminating -- cannot register for removal";
 116     return true;
 117   }
 118
 119   if (DirectoriesToRemove == NULL)
 120     DirectoriesToRemove = new std::vector<sys::Path>;
 121   DirectoriesToRemove->push_back(path);
 122
 123   LeaveCriticalSection(&CriticalSection);
 124   return false;
 125 }
 126
 127 /// PrintStackTraceOnErrorSignal - When an error signal (such as SIBABRT or
 128 /// SIGSEGV) is delivered to the process, print a stack trace and then exit.
 129 void sys::PrintStackTraceOnErrorSignal() {
 130   RegisterHandler();
 131   LeaveCriticalSection(&CriticalSection);
 132 }
 133
 134
 135 void sys::SetInterruptFunction(void (*IF)()) {
 136   RegisterHandler();
 137   InterruptFunction = IF;
 138   LeaveCriticalSection(&CriticalSection);
 139 }
 140 }
 141
 142 static void Cleanup() {
 143   EnterCriticalSection(&CriticalSection);
 144
 145   // Prevent other thread from registering new files and directories for
 146   // removal, should we be executing because of the console handler callback.
 147   CleanupExecuted = true;
 148
 149   // FIXME: open files cannot be deleted.
 150
 151   if (FilesToRemove != NULL)
 152     while (!FilesToRemove->empty()) {
 153       try {
 154         FilesToRemove->back().eraseFromDisk();
 155       } catch (...) {
 156       }
 157       FilesToRemove->pop_back();
 158     }
 159
 160   if (DirectoriesToRemove != NULL)
 161     while (!DirectoriesToRemove->empty()) {
 162       try {
 163         DirectoriesToRemove->back().eraseFromDisk(true);
 164       } catch (...) {
 165       }
 166       DirectoriesToRemove->pop_back();
 167     }
 168
 169   LeaveCriticalSection(&CriticalSection);
 170 }
 171
 172 static LONG WINAPI LLVMUnhandledExceptionFilter(LPEXCEPTION_POINTERS ep) {
 173   try {
 174     Cleanup();
 175
 176     // Initialize the STACKFRAME structure.
 177     STACKFRAME StackFrame;
 178     memset(&StackFrame, 0, sizeof(StackFrame));
 179
 180     StackFrame.AddrPC.Offset = ep->ContextRecord->Eip;
 181     StackFrame.AddrPC.Mode = AddrModeFlat;
 182     StackFrame.AddrStack.Offset = ep->ContextRecord->Esp;
 183     StackFrame.AddrStack.Mode = AddrModeFlat;
 184     StackFrame.AddrFrame.Offset = ep->ContextRecord->Ebp;
 185     StackFrame.AddrFrame.Mode = AddrModeFlat;
 186
 187     HANDLE hProcess = GetCurrentProcess();
 188     HANDLE hThread = GetCurrentThread();
 189
 190     // Initialize the symbol handler.
 191     SymSetOptions(SYMOPT_DEFERRED_LOADS|SYMOPT_LOAD_LINES);
 192     SymInitialize(hProcess, NULL, TRUE);
 193
 194     while (true) {
 195       if (!StackWalk(IMAGE_FILE_MACHINE_I386, hProcess, hThread, &StackFrame,
 196                      ep->ContextRecord, NULL, SymFunctionTableAccess,
 197                      SymGetModuleBase, NULL)) {
 198         break;
 199       }
 200
 201       if (StackFrame.AddrFrame.Offset == 0)
 202         break;
 203
 204       // Print the PC in hexadecimal.
 205       DWORD PC = StackFrame.AddrPC.Offset;
 206       fprintf(stderr, "%08X", PC);
 207
 208       // Print the parameters.  Assume there are four.
 209       fprintf(stderr, " (0x%08X 0x%08X 0x%08X 0x%08X)", StackFrame.Params[0],
 210               StackFrame.Params[1], StackFrame.Params[2], StackFrame.Params[3]);
 211
 212       // Verify the PC belongs to a module in this process.
 213       if (!SymGetModuleBase(hProcess, PC)) {
 214         fputs(" <unknown module>\n", stderr);
 215         continue;
 216       }
 217
 218       // Print the symbol name.
 219       char buffer[512];
 220       IMAGEHLP_SYMBOL *symbol = reinterpret_cast<IMAGEHLP_SYMBOL *>(buffer);
 221       memset(symbol, 0, sizeof(IMAGEHLP_SYMBOL));
 222       symbol->SizeOfStruct = sizeof(IMAGEHLP_SYMBOL);
 223       symbol->MaxNameLength = 512 - sizeof(IMAGEHLP_SYMBOL);
 224
 225       DWORD dwDisp;
 226       if (!SymGetSymFromAddr(hProcess, PC, &dwDisp, symbol)) {
 227         fputc('\n', stderr);
 228         continue;
 229       }
 230
 231       buffer[511] = 0;
 232       if (dwDisp > 0)
 233         fprintf(stderr, ", %s()+%04d bytes(s)", symbol->Name, dwDisp);
 234       else
 235         fprintf(stderr, ", %s", symbol->Name);
 236
 237       // Print the source file and line number information.
 238       IMAGEHLP_LINE line;
 239       memset(&line, 0, sizeof(line));
 240       line.SizeOfStruct = sizeof(line);
 241       if (SymGetLineFromAddr(hProcess, PC, &dwDisp, &line)) {
 242         fprintf(stderr, ", %s, line %d", line.FileName, line.LineNumber);
 243         if (dwDisp > 0)
 244           fprintf(stderr, "+%04d byte(s)", dwDisp);
 245       }
 246
 247       fputc('\n', stderr);
 248     }
 249   } catch (...) {
 250       assert(!"Crashed in LLVMUnhandledExceptionFilter");
 251   }
 252
 253   // Allow dialog box to pop up allowing choice to start debugger.
 254   if (OldFilter)
 255     return (*OldFilter)(ep);
 256   else
 257     return EXCEPTION_CONTINUE_SEARCH;
 258 }
 259
 260 static BOOL WINAPI LLVMConsoleCtrlHandler(DWORD dwCtrlType) {
 261   // We are running in our very own thread, courtesy of Windows.
 262   EnterCriticalSection(&CriticalSection);
 263   Cleanup();
 264
 265   // If an interrupt function has been set, go and run one it; otherwise,
 266   // the process dies.
 267   void (*IF)() = InterruptFunction;
 268   InterruptFunction = 0;      // Don't run it on another CTRL-C.
 269
 270   if (IF) {
 271     // Note: if the interrupt function throws an exception, there is nothing
 272     // to catch it in this thread so it will kill the process.
 273     IF();                     // Run it now.
 274     LeaveCriticalSection(&CriticalSection);
 275     return TRUE;              // Don't kill the process.
 276   }
 277
 278   // Allow normal processing to take place; i.e., the process dies.
 279   LeaveCriticalSection(&CriticalSection);
 280   return FALSE;
 281 }
 282