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 using namespace llvm;
  29
  30 namespace {
  31
  32 static bool StackTraceRequested = false;
  33
  34 /// InterruptFunction - The function to call if ctrl-c is pressed.
  35 static void (*InterruptFunction)() = 0;
  36
  37 static std::vector<sys::Path> *FilesToRemove = 0 ;
  38 static std::vector<sys::Path> *DirectoriesToRemove = 0;
  39
  40 // IntSigs - Signals that may interrupt the program at any time.
  41 static const int IntSigs[] = {
  42   SIGHUP, SIGINT, SIGQUIT, SIGPIPE, SIGTERM, SIGUSR1, SIGUSR2
  43 };
  44 static const int *IntSigsEnd = IntSigs + sizeof(IntSigs) / sizeof(IntSigs[0]);
  45
  46 // KillSigs - Signals that are synchronous with the program that will cause it
  47 // to die.
  48 static const int KillSigs[] = {
  49   SIGILL, SIGTRAP, SIGABRT, SIGFPE, SIGBUS, SIGSEGV, SIGSYS, SIGXCPU, SIGXFSZ
  50 #ifdef SIGEMT
  51   , SIGEMT
  52 #endif
  53 };
  54 static const int *KillSigsEnd = KillSigs + sizeof(KillSigs) / sizeof(KillSigs[0]);
  55
  56 #ifdef HAVE_BACKTRACE
  57 static 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.
  65 static void PrintStackTrace() {
  66 #ifdef HAVE_BACKTRACE
  67   // Use backtrace() to output a backtrace on Linux systems with glibc.
  68   int depth = backtrace(StackTrace, array_lengthof(StackTrace));
  69   backtrace_symbols_fd(StackTrace, depth, STDERR_FILENO);
  70 #endif
  71 }
  72
  73 // SignalHandler - The signal handler that runs...
  74 static RETSIGTYPE SignalHandler(int Sig) {
  75   if (FilesToRemove != 0)
  76     while (!FilesToRemove->empty()) {
  77       FilesToRemove->back().eraseFromDisk(true);
  78       FilesToRemove->pop_back();
  79     }
  80
  81   if (DirectoriesToRemove != 0)
  82     while (!DirectoriesToRemove->empty()) {
  83       DirectoriesToRemove->back().eraseFromDisk(true);
  84       DirectoriesToRemove->pop_back();
  85     }
  86
  87   if (std::find(IntSigs, IntSigsEnd, Sig) != IntSigsEnd) {
  88     if (InterruptFunction) {
  89       void (*IF)() = InterruptFunction;
  90       InterruptFunction = 0;
  91       IF();        // run the interrupt function.
  92       return;
  93     } else {
  94       exit(1);   // If this is an interrupt signal, exit the program
  95     }
  96   }
  97
  98   // Otherwise if it is a fault (like SEGV) output the stacktrace to
  99   // STDERR (if we can) and reissue the signal to die...
 100   if (StackTraceRequested)
 101     PrintStackTrace();
 102   signal(Sig, SIG_DFL);
 103 }
 104
 105 // Just call signal
 106 static void RegisterHandler(int Signal) {
 107   signal(Signal, SignalHandler);
 108 }
 109
 110 }
 111
 112
 113 void sys::SetInterruptFunction(void (*IF)()) {
 114   InterruptFunction = IF;
 115   RegisterHandler(SIGINT);
 116 }
 117
 118 // RemoveFileOnSignal - The public API
 119 bool sys::RemoveFileOnSignal(const sys::Path &Filename, std::string* ErrMsg) {
 120   if (FilesToRemove == 0)
 121     FilesToRemove = new std::vector<sys::Path>;
 122
 123   FilesToRemove->push_back(Filename);
 124
 125   std::for_each(IntSigs, IntSigsEnd, RegisterHandler);
 126   std::for_each(KillSigs, KillSigsEnd, RegisterHandler);
 127   return false;
 128 }
 129
 130 // RemoveDirectoryOnSignal - The public API
 131 bool sys::RemoveDirectoryOnSignal(const sys::Path& path, std::string* ErrMsg) {
 132   // Not a directory?
 133   struct stat buf;
 134   if (0 != stat(path.c_str(), &buf)) {
 135     MakeErrMsg(ErrMsg, path.toString() + ": can't get status of file");
 136     return true;
 137   }
 138
 139   if (!S_ISDIR(buf.st_mode)) {
 140     if (ErrMsg)
 141       *ErrMsg = path.toString() + " is not a directory";
 142     return true;
 143   }
 144
 145   if (DirectoriesToRemove == 0)
 146     DirectoriesToRemove = new std::vector<sys::Path>;
 147
 148   DirectoriesToRemove->push_back(path);
 149
 150   std::for_each(IntSigs, IntSigsEnd, RegisterHandler);
 151   std::for_each(KillSigs, KillSigsEnd, RegisterHandler);
 152   return false;
 153 }
 154
 155 /// PrintStackTraceOnErrorSignal - When an error signal (such as SIBABRT or
 156 /// SIGSEGV) is delivered to the process, print a stack trace and then exit.
 157 void sys::PrintStackTraceOnErrorSignal() {
 158   StackTraceRequested = true;
 159   std::for_each(KillSigs, KillSigsEnd, RegisterHandler);
 160 }