lib/System/Unix/Signals.inc

   1 //===- Signals.cpp - Generic Unix 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 defines some helpful functions for dealing with the possibility of
  11 // Unix signals occuring while your program is running.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "Unix.h"
  16 #include "llvm/ADT/STLExtras.h"
  17 #include <vector>
  18 #include <algorithm>
  19 #if HAVE_EXECINFO_H
  20 # include <execinfo.h>         // For backtrace().
  21 #endif
  22 #if HAVE_SIGNAL_H
  23 #include <signal.h>
  24 #endif
  25 #if HAVE_SYS_STAT_H
  26 #include <sys/stat.h>
  27 #endif
  28 #if HAVE_DLFCN_H && __GNUG__
  29 #include <dlfcn.h>
  30 #include <cxxabi.h>
  31 #endif
  32 using namespace llvm;
  33
  34 static RETSIGTYPE SignalHandler(int Sig);  // defined below.
  35
  36 /// InterruptFunction - The function to call if ctrl-c is pressed.
  37 static void (*InterruptFunction)() = 0;
  38
  39 static std::vector<sys::Path> *FilesToRemove = 0;
  40 static std::vector<std::pair<void(*)(void*), void*> > *CallBacksToRun = 0;
  41
  42 // IntSigs - Signals that may interrupt the program at any time.
  43 static const int IntSigs[] = {
  44   SIGHUP, SIGINT, SIGQUIT, SIGPIPE, SIGTERM, SIGUSR1, SIGUSR2
  45 };
  46 static const int *const IntSigsEnd =
  47   IntSigs + sizeof(IntSigs) / sizeof(IntSigs[0]);
  48
  49 // KillSigs - Signals that are synchronous with the program that will cause it
  50 // to die.
  51 static const int KillSigs[] = {
  52   SIGILL, SIGTRAP, SIGABRT, SIGFPE, SIGBUS, SIGSEGV, SIGSYS, SIGXCPU, SIGXFSZ
  53 #ifdef SIGEMT
  54   , SIGEMT
  55 #endif
  56 };
  57 static const int *const KillSigsEnd =
  58   KillSigs + sizeof(KillSigs) / sizeof(KillSigs[0]);
  59
  60 static unsigned NumRegisteredSignals = 0;
  61 static struct {
  62   struct sigaction SA;
  63   int SigNo;
  64 } RegisteredSignalInfo[(sizeof(IntSigs)+sizeof(KillSigs))/sizeof(KillSigs[0])];
  65
  66
  67 static void RegisterHandler(int Signal) {
  68   assert(NumRegisteredSignals <
  69          sizeof(RegisteredSignalInfo)/sizeof(RegisteredSignalInfo[0]) &&
  70          "Out of space for signal handlers!");
  71
  72   struct sigaction NewHandler;
  73
  74   NewHandler.sa_handler = SignalHandler;
  75   NewHandler.sa_flags = SA_NODEFER|SA_RESETHAND;
  76   sigemptyset(&NewHandler.sa_mask);
  77
  78   // Install the new handler, save the old one in RegisteredSignalInfo.
  79   sigaction(Signal, &NewHandler,
  80             &RegisteredSignalInfo[NumRegisteredSignals].SA);
  81   RegisteredSignalInfo[NumRegisteredSignals].SigNo = Signal;
  82   ++NumRegisteredSignals;
  83 }
  84
  85 static void RegisterHandlers() {
  86   // If the handlers are already registered, we're done.
  87   if (NumRegisteredSignals != 0) return;
  88
  89   std::for_each(IntSigs, IntSigsEnd, RegisterHandler);
  90   std::for_each(KillSigs, KillSigsEnd, RegisterHandler);
  91 }
  92
  93 static void UnregisterHandlers() {
  94   // Restore all of the signal handlers to how they were before we showed up.
  95   for (unsigned i = 0, e = NumRegisteredSignals; i != e; ++i)
  96     sigaction(RegisteredSignalInfo[i].SigNo,
  97               &RegisteredSignalInfo[i].SA, 0);
  98   NumRegisteredSignals = 0;
  99 }
 100
 101
 102
 103 // SignalHandler - The signal handler that runs.
 104 static RETSIGTYPE SignalHandler(int Sig) {
 105   // Restore the signal behavior to default, so that the program actually
 106   // crashes when we return and the signal reissues.  This also ensures that if
 107   // we crash in our signal handler that the program will terminate immediately
 108   // instead of recursing in the signal handler.
 109   UnregisterHandlers();
 110
 111   // Unmask all potentially blocked kill signals.
 112   sigset_t SigMask;
 113   sigfillset(&SigMask);
 114   sigprocmask(SIG_UNBLOCK, &SigMask, 0);
 115
 116   if (FilesToRemove != 0)
 117     while (!FilesToRemove->empty()) {
 118       FilesToRemove->back().eraseFromDisk(true);
 119       FilesToRemove->pop_back();
 120     }
 121
 122   if (std::find(IntSigs, IntSigsEnd, Sig) != IntSigsEnd) {
 123     if (InterruptFunction) {
 124       void (*IF)() = InterruptFunction;
 125       InterruptFunction = 0;
 126       IF();        // run the interrupt function.
 127       return;
 128     }
 129     raise(Sig);   // Execute the default handler.
 130     return;
 131   }
 132
 133   // Otherwise if it is a fault (like SEGV) run any handler.
 134   if (CallBacksToRun)
 135     for (unsigned i = 0, e = CallBacksToRun->size(); i != e; ++i)
 136       (*CallBacksToRun)[i].first((*CallBacksToRun)[i].second);
 137 }
 138
 139
 140
 141 void llvm::sys::SetInterruptFunction(void (*IF)()) {
 142   InterruptFunction = IF;
 143   RegisterHandlers();
 144 }
 145
 146 // RemoveFileOnSignal - The public API
 147 bool llvm::sys::RemoveFileOnSignal(const sys::Path &Filename,
 148                                    std::string* ErrMsg) {
 149   if (FilesToRemove == 0)
 150     FilesToRemove = new std::vector<sys::Path>();
 151
 152   FilesToRemove->push_back(Filename);
 153
 154   RegisterHandlers();
 155   return false;
 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 llvm::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   RegisterHandlers();
 166 }
 167
 168
 169 // PrintStackTrace - In the case of a program crash or fault, print out a stack
 170 // trace so that the user has an indication of why and where we died.
 171 //
 172 // On glibc systems we have the 'backtrace' function, which works nicely, but
 173 // doesn't demangle symbols.
 174 static void PrintStackTrace(void *) {
 175 #ifdef HAVE_BACKTRACE
 176   static void* StackTrace[256];
 177   // Use backtrace() to output a backtrace on Linux systems with glibc.
 178   int depth = backtrace(StackTrace,
 179                         static_cast<int>(array_lengthof(StackTrace)));
 180 #if HAVE_DLFCN_H && __GNUG__
 181   int width = 0;
 182   for (int i = 0; i < depth; ++i) {
 183     Dl_info dlinfo;
 184     dladdr(StackTrace[i], &dlinfo);
 185     const char* name = strrchr(dlinfo.dli_fname, '/');
 186
 187     int nwidth;
 188     if (name == NULL) nwidth = strlen(dlinfo.dli_fname);
 189     else              nwidth = strlen(name) - 1;
 190
 191     if (nwidth > width) width = nwidth;
 192   }
 193
 194   for (int i = 0; i < depth; ++i) {
 195     Dl_info dlinfo;
 196     dladdr(StackTrace[i], &dlinfo);
 197
 198     fprintf(stderr, "%-3d", i);
 199
 200     const char* name = strrchr(dlinfo.dli_fname, '/');
 201     if (name == NULL) fprintf(stderr, " %-*s", width, dlinfo.dli_fname);
 202     else              fprintf(stderr, " %-*s", width, name+1);
 203
 204     fprintf(stderr, " %#0*lx",
 205             (int)(sizeof(void*) * 2) + 2, (unsigned long)StackTrace[i]);
 206
 207     if (dlinfo.dli_sname != NULL) {
 208       int res;
 209       fputc(' ', stderr);
 210       char* d = abi::__cxa_demangle(dlinfo.dli_sname, NULL, NULL, &res);
 211       if (d == NULL) fputs(dlinfo.dli_sname, stderr);
 212       else           fputs(d, stderr);
 213       free(d);
 214
 215       fprintf(stderr, " + %tu",(char*)StackTrace[i]-(char*)dlinfo.dli_saddr);
 216     }
 217     fputc('\n', stderr);
 218   }
 219 #else
 220   backtrace_symbols_fd(StackTrace, depth, STDERR_FILENO);
 221 #endif
 222 #endif
 223 }
 224
 225 /// PrintStackTraceOnErrorSignal - When an error signal (such as SIBABRT or
 226 /// SIGSEGV) is delivered to the process, print a stack trace and then exit.
 227 void llvm::sys::PrintStackTraceOnErrorSignal() {
 228   AddSignalHandler(PrintStackTrace, 0);
 229 }
 230