lib/Support/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 occurring while your program is running.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #include "Unix.h"
  16 #include "llvm/ADT/STLExtras.h"
  17 #include "llvm/Support/Mutex.h"
  18 #include <algorithm>
  19 #include <string>
  20 #include <vector>
  21 #if HAVE_EXECINFO_H
  22 # include <execinfo.h>         // For backtrace().
  23 #endif
  24 #if HAVE_SIGNAL_H
  25 #include <signal.h>
  26 #endif
  27 #if HAVE_SYS_STAT_H
  28 #include <sys/stat.h>
  29 #endif
  30 #if HAVE_CXXABI_H
  31 #include cxxabi.h>
  32 #endif
  33 #if HAVE_DLFCN_H
  34 #include <dlfcn.h>
  35 #endif
  36 #if HAVE_MACH_MACH_H
  37 #include <mach/mach.h>
  38 #endif
  39
  40 using namespace llvm;
  41
  42 static RETSIGTYPE SignalHandler(int Sig);  // defined below.
  43
  44 static SmartMutex<true> SignalsMutex;
  45
  46 /// InterruptFunction - The function to call if ctrl-c is pressed.
  47 static void (*InterruptFunction)() = 0;
  48
  49 static std::vector<std::string> FilesToRemove;
  50 static std::vector<std::pair<void(*)(void*), void*> > CallBacksToRun;
  51
  52 // IntSigs - Signals that represent requested termination. There's no bug
  53 // or failure, or if there is, it's not our direct responsibility. For whatever
  54 // reason, our continued execution is no longer desirable.
  55 static const int IntSigs[] = {
  56   SIGHUP, SIGINT, SIGPIPE, SIGTERM, SIGUSR1, SIGUSR2
  57 };
  58 static const int *const IntSigsEnd =
  59   IntSigs + sizeof(IntSigs) / sizeof(IntSigs[0]);
  60
  61 // KillSigs - Signals that represent that we have a bug, and our prompt
  62 // termination has been ordered.
  63 static const int KillSigs[] = {
  64   SIGILL, SIGTRAP, SIGABRT, SIGFPE, SIGBUS, SIGSEGV, SIGQUIT
  65 #ifdef SIGSYS
  66   , SIGSYS
  67 #endif
  68 #ifdef SIGXCPU
  69   , SIGXCPU
  70 #endif
  71 #ifdef SIGXFSZ
  72   , SIGXFSZ
  73 #endif
  74 #ifdef SIGEMT
  75   , SIGEMT
  76 #endif
  77 };
  78 static const int *const KillSigsEnd =
  79   KillSigs + sizeof(KillSigs) / sizeof(KillSigs[0]);
  80
  81 static unsigned NumRegisteredSignals = 0;
  82 static struct {
  83   struct sigaction SA;
  84   int SigNo;
  85 } RegisteredSignalInfo[(sizeof(IntSigs)+sizeof(KillSigs))/sizeof(KillSigs[0])];
  86
  87
  88 static void RegisterHandler(int Signal) {
  89   assert(NumRegisteredSignals <
  90          sizeof(RegisteredSignalInfo)/sizeof(RegisteredSignalInfo[0]) &&
  91          "Out of space for signal handlers!");
  92
  93   struct sigaction NewHandler;
  94
  95   NewHandler.sa_handler = SignalHandler;
  96   NewHandler.sa_flags = SA_NODEFER|SA_RESETHAND;
  97   sigemptyset(&NewHandler.sa_mask);
  98
  99   // Install the new handler, save the old one in RegisteredSignalInfo.
 100   sigaction(Signal, &NewHandler,
 101             &RegisteredSignalInfo[NumRegisteredSignals].SA);
 102   RegisteredSignalInfo[NumRegisteredSignals].SigNo = Signal;
 103   ++NumRegisteredSignals;
 104 }
 105
 106 static void RegisterHandlers() {
 107   // If the handlers are already registered, we're done.
 108   if (NumRegisteredSignals != 0) return;
 109
 110   std::for_each(IntSigs, IntSigsEnd, RegisterHandler);
 111   std::for_each(KillSigs, KillSigsEnd, RegisterHandler);
 112 }
 113
 114 static void UnregisterHandlers() {
 115   // Restore all of the signal handlers to how they were before we showed up.
 116   for (unsigned i = 0, e = NumRegisteredSignals; i != e; ++i)
 117     sigaction(RegisteredSignalInfo[i].SigNo,
 118               &RegisteredSignalInfo[i].SA, 0);
 119   NumRegisteredSignals = 0;
 120 }
 121
 122
 123 /// RemoveFilesToRemove - Process the FilesToRemove list. This function
 124 /// should be called with the SignalsMutex lock held.
 125 /// NB: This must be an async signal safe function. It cannot allocate or free
 126 /// memory, even in debug builds.
 127 static void RemoveFilesToRemove() {
 128   // We avoid iterators in case of debug iterators that allocate or release
 129   // memory.
 130   for (unsigned i = 0, e = FilesToRemove.size(); i != e; ++i) {
 131     // We rely on a std::string implementation for which repeated calls to
 132     // 'c_str()' don't allocate memory. We pre-call 'c_str()' on all of these
 133     // strings to try to ensure this is safe.
 134     const char *path = FilesToRemove[i].c_str();
 135
 136     // Get the status so we can determine if it's a file or directory. If we
 137     // can't stat the file, ignore it.
 138     struct stat buf;
 139     if (stat(path, &buf) != 0)
 140       continue;
 141
 142     // If this is not a regular file, ignore it. We want to prevent removal of
 143     // special files like /dev/null, even if the compiler is being run with the
 144     // super-user permissions.
 145     if (!S_ISREG(buf.st_mode))
 146       continue;
 147
 148     // Otherwise, remove the file. We ignore any errors here as there is nothing
 149     // else we can do.
 150     unlink(path);
 151   }
 152 }
 153
 154 // SignalHandler - The signal handler that runs.
 155 static RETSIGTYPE SignalHandler(int Sig) {
 156   // Restore the signal behavior to default, so that the program actually
 157   // crashes when we return and the signal reissues.  This also ensures that if
 158   // we crash in our signal handler that the program will terminate immediately
 159   // instead of recursing in the signal handler.
 160   UnregisterHandlers();
 161
 162   // Unmask all potentially blocked kill signals.
 163   sigset_t SigMask;
 164   sigfillset(&SigMask);
 165   sigprocmask(SIG_UNBLOCK, &SigMask, 0);
 166
 167   SignalsMutex.acquire();
 168   RemoveFilesToRemove();
 169
 170   if (std::find(IntSigs, IntSigsEnd, Sig) != IntSigsEnd) {
 171     if (InterruptFunction) {
 172       void (*IF)() = InterruptFunction;
 173       SignalsMutex.release();
 174       InterruptFunction = 0;
 175       IF();        // run the interrupt function.
 176       return;
 177     }
 178
 179     SignalsMutex.release();
 180     raise(Sig);   // Execute the default handler.
 181     return;
 182   }
 183
 184   SignalsMutex.release();
 185
 186   // Otherwise if it is a fault (like SEGV) run any handler.
 187   for (unsigned i = 0, e = CallBacksToRun.size(); i != e; ++i)
 188     CallBacksToRun[i].first(CallBacksToRun[i].second);
 189 }
 190
 191 void llvm::sys::RunInterruptHandlers() {
 192   SignalsMutex.acquire();
 193   RemoveFilesToRemove();
 194   SignalsMutex.release();
 195 }
 196
 197 void llvm::sys::SetInterruptFunction(void (*IF)()) {
 198   SignalsMutex.acquire();
 199   InterruptFunction = IF;
 200   SignalsMutex.release();
 201   RegisterHandlers();
 202 }
 203
 204 // RemoveFileOnSignal - The public API
 205 bool llvm::sys::RemoveFileOnSignal(const sys::Path &Filename,
 206                                    std::string* ErrMsg) {
 207   SignalsMutex.acquire();
 208   std::string *OldPtr = FilesToRemove.empty() ? 0 : &FilesToRemove[0];
 209   FilesToRemove.push_back(Filename.str());
 210
 211   // We want to call 'c_str()' on every std::string in this vector so that if
 212   // the underlying implementation requires a re-allocation, it happens here
 213   // rather than inside of the signal handler. If we see the vector grow, we
 214   // have to call it on every entry. If it remains in place, we only need to
 215   // call it on the latest one.
 216   if (OldPtr == &FilesToRemove[0])
 217     FilesToRemove.back().c_str();
 218   else
 219     for (unsigned i = 0, e = FilesToRemove.size(); i != e; ++i)
 220       FilesToRemove[i].c_str();
 221
 222   SignalsMutex.release();
 223
 224   RegisterHandlers();
 225   return false;
 226 }
 227
 228 // DontRemoveFileOnSignal - The public API
 229 void llvm::sys::DontRemoveFileOnSignal(const sys::Path &Filename) {
 230   SignalsMutex.acquire();
 231   std::vector<std::string>::reverse_iterator RI =
 232     std::find(FilesToRemove.rbegin(), FilesToRemove.rend(), Filename.str());
 233   std::vector<std::string>::iterator I = FilesToRemove.end();
 234   if (RI != FilesToRemove.rend())
 235     I = FilesToRemove.erase(RI.base()-1);
 236
 237   // We need to call c_str() on every element which would have been moved by
 238   // the erase. These elements, in a C++98 implementation where c_str()
 239   // requires a reallocation on the first call may have had the call to c_str()
 240   // made on insertion become invalid by being copied down an element.
 241   for (std::vector<std::string>::iterator E = FilesToRemove.end(); I != E; ++I)
 242     I->c_str();
 243
 244   SignalsMutex.release();
 245 }
 246
 247 /// AddSignalHandler - Add a function to be called when a signal is delivered
 248 /// to the process.  The handler can have a cookie passed to it to identify
 249 /// what instance of the handler it is.
 250 void llvm::sys::AddSignalHandler(void (*FnPtr)(void *), void *Cookie) {
 251   CallBacksToRun.push_back(std::make_pair(FnPtr, Cookie));
 252   RegisterHandlers();
 253 }
 254
 255
 256 // PrintStackTrace - In the case of a program crash or fault, print out a stack
 257 // trace so that the user has an indication of why and where we died.
 258 //
 259 // On glibc systems we have the 'backtrace' function, which works nicely, but
 260 // doesn't demangle symbols.
 261 void llvm::sys::PrintStackTrace(FILE *FD) {
 262 #if defined(HAVE_BACKTRACE) && defined(ENABLE_BACKTRACES)
 263   static void* StackTrace[256];
 264   // Use backtrace() to output a backtrace on Linux systems with glibc.
 265   int depth = backtrace(StackTrace,
 266                         static_cast<int>(array_lengthof(StackTrace)));
 267 #if HAVE_DLFCN_H && __GNUG__
 268   int width = 0;
 269   for (int i = 0; i < depth; ++i) {
 270     Dl_info dlinfo;
 271     dladdr(StackTrace[i], &dlinfo);
 272     const char* name = strrchr(dlinfo.dli_fname, '/');
 273
 274     int nwidth;
 275     if (name == NULL) nwidth = strlen(dlinfo.dli_fname);
 276     else              nwidth = strlen(name) - 1;
 277
 278     if (nwidth > width) width = nwidth;
 279   }
 280
 281   for (int i = 0; i < depth; ++i) {
 282     Dl_info dlinfo;
 283     dladdr(StackTrace[i], &dlinfo);
 284
 285     fprintf(FD, "%-2d", i);
 286
 287     const char* name = strrchr(dlinfo.dli_fname, '/');
 288     if (name == NULL) fprintf(FD, " %-*s", width, dlinfo.dli_fname);
 289     else              fprintf(FD, " %-*s", width, name+1);
 290
 291     fprintf(FD, " %#0*lx",
 292             (int)(sizeof(void*) * 2) + 2, (unsigned long)StackTrace[i]);
 293
 294     if (dlinfo.dli_sname != NULL) {
 295       int res;
 296       fputc(' ', FD);
 297 #  if HAVE_CXXABI_H
 298       char* d = abi::__cxa_demangle(dlinfo.dli_sname, NULL, NULL, &res);
 299 #  else
 300       char* d = NULL;
 301 #  endif
 302       if (d == NULL) fputs(dlinfo.dli_sname, FD);
 303       else           fputs(d, FD);
 304       free(d);
 305
 306       // FIXME: When we move to C++11, use %t length modifier. It's not in
 307       // C++03 and causes gcc to issue warnings. Losing the upper 32 bits of
 308       // the stack offset for a stack dump isn't likely to cause any problems.
 309       fprintf(FD, " + %u",(unsigned)((char*)StackTrace[i]-
 310                                      (char*)dlinfo.dli_saddr));
 311     }
 312     fputc('\n', FD);
 313   }
 314 #else
 315   backtrace_symbols_fd(StackTrace, depth, STDERR_FILENO);
 316 #endif
 317 #endif
 318 }
 319
 320 static void PrintStackTraceSignalHandler(void *) {
 321   PrintStackTrace(stderr);
 322 }
 323
 324 /// PrintStackTraceOnErrorSignal - When an error signal (such as SIGABRT or
 325 /// SIGSEGV) is delivered to the process, print a stack trace and then exit.
 326 void llvm::sys::PrintStackTraceOnErrorSignal() {
 327   AddSignalHandler(PrintStackTraceSignalHandler, 0);
 328
 329 #if defined(__APPLE__)
 330   // Environment variable to disable any kind of crash dialog.
 331   if (getenv("LLVM_DISABLE_CRASH_REPORT")) {
 332     mach_port_t self = mach_task_self();
 333
 334     exception_mask_t mask = EXC_MASK_CRASH;
 335
 336     kern_return_t ret = task_set_exception_ports(self,
 337                              mask,
 338                              MACH_PORT_NULL,
 339                              EXCEPTION_STATE_IDENTITY | MACH_EXCEPTION_CODES,
 340                              THREAD_STATE_NONE);
 341     (void)ret;
 342   }
 343 #endif
 344 }
 345
 346
 347 /***/
 348
 349 // On Darwin, raise sends a signal to the main thread instead of the current
 350 // thread. This has the unfortunate effect that assert() and abort() will end up
 351 // bypassing our crash recovery attempts. We work around this for anything in
 352 // the same linkage unit by just defining our own versions of the assert handler
 353 // and abort.
 354
 355 #ifdef __APPLE__
 356
 357 #include <signal.h>
 358 #include <pthread.h>
 359
 360 int raise(int sig) {
 361   return pthread_kill(pthread_self(), sig);
 362 }
 363
 364 void __assert_rtn(const char *func,
 365                   const char *file,
 366                   int line,
 367                   const char *expr) {
 368   if (func)
 369     fprintf(stderr, "Assertion failed: (%s), function %s, file %s, line %d.\n",
 370             expr, func, file, line);
 371   else
 372     fprintf(stderr, "Assertion failed: (%s), file %s, line %d.\n",
 373             expr, file, line);
 374   abort();
 375 }
 376
 377 void abort() {
 378   raise(SIGABRT);
 379   usleep(1000);
 380   __builtin_trap();
 381 }
 382
 383 #endif