lib/System/Unix/Signals.inc

   1 //===- Signals.cpp - Generic Unix Signals Implementation -----*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source 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 using namespace llvm;
  29
  30 namespace {
  31
  32 bool StackTraceRequested = false;
  33
  34 /// InterruptFunction - The function to call if ctrl-c is pressed.
  35 void (*InterruptFunction)() = 0;
  36
  37 std::vector<sys::Path> *FilesToRemove = 0 ;
  38 std::vector<sys::Path> *DirectoriesToRemove = 0;
  39
  40 // IntSigs - Signals that may interrupt the program at any time.
  41 const int IntSigs[] = {
  42   SIGHUP, SIGINT, SIGQUIT, SIGPIPE, SIGTERM, SIGUSR1, SIGUSR2
  43 };
  44 const int *IntSigsEnd = array_endof(IntSigs);
  45
  46 // KillSigs - Signals that are synchronous with the program that will cause it
  47 // to die.
  48 const int KillSigs[] = {
  49   SIGILL, SIGTRAP, SIGABRT, SIGFPE, SIGBUS, SIGSEGV, SIGSYS, SIGXCPU, SIGXFSZ
  50 #ifdef SIGEMT
  51   , SIGEMT
  52 #endif
  53 };
  54 const int *KillSigsEnd = array_endof(KillSigs);
  55
  56 #ifdef HAVE_BACKTRACE
  57 void* StackTrace[256];
  58 #endif
  59
  60 // PrintStackTrace - In the case of a program crash or fault, print out a stack
  61 // trace so that the user has an indication of why and where we died.
  62 //
  63 // On glibc systems we have the 'backtrace' function, which works nicely, but
  64 // doesn't demangle symbols.  In order to backtrace symbols, we fork and exec a
  65 // 'c++filt' process to do the demangling.  This seems like the simplest and
  66 // most robust solution when we can't allocate memory (such as in a signal
  67 // handler).  If we can't find 'c++filt', we fallback to printing mangled names.
  68 //
  69 void PrintStackTrace() {
  70 #ifdef HAVE_BACKTRACE
  71   // Use backtrace() to output a backtrace on Linux systems with glibc.
  72   int depth = backtrace(StackTrace, array_lengthof(StackTrace));
  73
  74   // Create a one-way unix pipe.  The backtracing process writes to PipeFDs[1],
  75   // the c++filt process reads from PipeFDs[0].
  76   int PipeFDs[2];
  77   if (pipe(PipeFDs)) {
  78     backtrace_symbols_fd(StackTrace, depth, STDERR_FILENO);
  79     return;
  80   }
  81
  82   switch (pid_t ChildPID = fork()) {
  83   case -1:        // Error forking, print mangled stack trace
  84     close(PipeFDs[0]);
  85     close(PipeFDs[1]);
  86     backtrace_symbols_fd(StackTrace, depth, STDERR_FILENO);
  87     return;
  88   default:        // backtracing process
  89     close(PipeFDs[0]);  // Close the reader side.
  90
  91     // Print the mangled backtrace into the pipe.
  92     backtrace_symbols_fd(StackTrace, depth, PipeFDs[1]);
  93     close(PipeFDs[1]);   // We are done writing.
  94     while (waitpid(ChildPID, 0, 0) == -1)
  95       if (errno != EINTR) break;
  96     return;
  97
  98   case 0:         // c++filt process
  99     close(PipeFDs[1]);    // Close the writer side.
 100     dup2(PipeFDs[0], 0);  // Read from standard input
 101     close(PipeFDs[0]);    // Close the old descriptor
 102     dup2(2, 1);           // Revector stdout -> stderr
 103
 104     // Try to run c++filt or gc++filt.  If neither is found, call back on 'cat'
 105     // to print the mangled stack trace.  If we can't find cat, just exit.
 106     execlp("c++filt", "c++filt", (char*)NULL);
 107     execlp("gc++filt", "gc++filt", (char*)NULL);
 108     execlp("cat", "cat", (char*)NULL);
 109     execlp("/bin/cat", "cat", (char*)NULL);
 110     exit(0);
 111   }
 112 #endif
 113 }
 114
 115 // SignalHandler - The signal handler that runs...
 116 RETSIGTYPE SignalHandler(int Sig) {
 117   if (FilesToRemove != 0)
 118     while (!FilesToRemove->empty()) {
 119       FilesToRemove->back().eraseFromDisk(true);
 120       FilesToRemove->pop_back();
 121     }
 122
 123   if (DirectoriesToRemove != 0)
 124     while (!DirectoriesToRemove->empty()) {
 125       DirectoriesToRemove->back().eraseFromDisk(true);
 126       DirectoriesToRemove->pop_back();
 127     }
 128
 129   if (std::find(IntSigs, IntSigsEnd, Sig) != IntSigsEnd) {
 130     if (InterruptFunction) {
 131       void (*IF)() = InterruptFunction;
 132       InterruptFunction = 0;
 133       IF();        // run the interrupt function.
 134       return;
 135     } else {
 136       exit(1);   // If this is an interrupt signal, exit the program
 137     }
 138   }
 139
 140   // Otherwise if it is a fault (like SEGV) output the stacktrace to
 141   // STDERR (if we can) and reissue the signal to die...
 142   if (StackTraceRequested)
 143     PrintStackTrace();
 144   signal(Sig, SIG_DFL);
 145 }
 146
 147 // Just call signal
 148 void RegisterHandler(int Signal) {
 149   signal(Signal, SignalHandler);
 150 }
 151
 152 }
 153
 154
 155 void sys::SetInterruptFunction(void (*IF)()) {
 156   InterruptFunction = IF;
 157   RegisterHandler(SIGINT);
 158 }
 159
 160 // RemoveFileOnSignal - The public API
 161 bool sys::RemoveFileOnSignal(const sys::Path &Filename, std::string* ErrMsg) {
 162   if (FilesToRemove == 0)
 163     FilesToRemove = new std::vector<sys::Path>;
 164
 165   FilesToRemove->push_back(Filename);
 166
 167   std::for_each(IntSigs, IntSigsEnd, RegisterHandler);
 168   std::for_each(KillSigs, KillSigsEnd, RegisterHandler);
 169   return false;
 170 }
 171
 172 // RemoveDirectoryOnSignal - The public API
 173 bool sys::RemoveDirectoryOnSignal(const sys::Path& path, std::string* ErrMsg) {
 174   // Not a directory?
 175   struct stat buf;
 176   if (0 != stat(path.c_str(), &buf)) {
 177     MakeErrMsg(ErrMsg, path.toString() + ": can't get status of file");
 178     return true;
 179   }
 180
 181   if (!S_ISDIR(buf.st_mode)) {
 182     if (ErrMsg)
 183       *ErrMsg = path.toString() + " is not a directory";
 184     return true;
 185   }
 186
 187   if (DirectoriesToRemove == 0)
 188     DirectoriesToRemove = new std::vector<sys::Path>;
 189
 190   DirectoriesToRemove->push_back(path);
 191
 192   std::for_each(IntSigs, IntSigsEnd, RegisterHandler);
 193   std::for_each(KillSigs, KillSigsEnd, RegisterHandler);
 194   return false;
 195 }
 196
 197 /// PrintStackTraceOnErrorSignal - When an error signal (such as SIBABRT or
 198 /// SIGSEGV) is delivered to the process, print a stack trace and then exit.
 199 void sys::PrintStackTraceOnErrorSignal() {
 200   StackTraceRequested = true;
 201   std::for_each(KillSigs, KillSigsEnd, RegisterHandler);
 202 }