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