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/Format.h"
  18 #include "llvm/Support/FileSystem.h"
  19 #include "llvm/Support/FileUtilities.h"
  20 #include "llvm/Support/ManagedStatic.h"
  21 #include "llvm/Support/MemoryBuffer.h"
  22 #include "llvm/Support/Mutex.h"
  23 #include "llvm/Support/Program.h"
  24 #include "llvm/Support/UniqueLock.h"
  25 #include "llvm/Support/raw_ostream.h"
  26 #include <algorithm>
  27 #include <string>
  28 #include <vector>
  29 #if HAVE_EXECINFO_H
  30 # include <execinfo.h>         // For backtrace().
  31 #endif
  32 #if HAVE_SIGNAL_H
  33 #include <signal.h>
  34 #endif
  35 #if HAVE_SYS_STAT_H
  36 #include <sys/stat.h>
  37 #endif
  38 #if HAVE_CXXABI_H
  39 #include <cxxabi.h>
  40 #endif
  41 #if HAVE_DLFCN_H
  42 #include <dlfcn.h>
  43 #endif
  44 #if HAVE_MACH_MACH_H
  45 #include <mach/mach.h>
  46 #endif
  47 #if HAVE_LINK_H
  48 #include <link.h>
  49 #endif
  50
  51 using namespace llvm;
  52
  53 static RETSIGTYPE SignalHandler(int Sig);  // defined below.
  54
  55 static ManagedStatic<SmartMutex<true> > SignalsMutex;
  56
  57 /// InterruptFunction - The function to call if ctrl-c is pressed.
  58 static void (*InterruptFunction)() = nullptr;
  59
  60 static ManagedStatic<std::vector<std::string>> FilesToRemove;
  61 static ManagedStatic<std::vector<std::pair<void (*)(void *), void *>>>
  62     CallBacksToRun;
  63
  64 // IntSigs - Signals that represent requested termination. There's no bug
  65 // or failure, or if there is, it's not our direct responsibility. For whatever
  66 // reason, our continued execution is no longer desirable.
  67 static const int IntSigs[] = {
  68   SIGHUP, SIGINT, SIGPIPE, SIGTERM, SIGUSR1, SIGUSR2
  69 };
  70
  71 // KillSigs - Signals that represent that we have a bug, and our prompt
  72 // termination has been ordered.
  73 static const int KillSigs[] = {
  74   SIGILL, SIGTRAP, SIGABRT, SIGFPE, SIGBUS, SIGSEGV, SIGQUIT
  75 #ifdef SIGSYS
  76   , SIGSYS
  77 #endif
  78 #ifdef SIGXCPU
  79   , SIGXCPU
  80 #endif
  81 #ifdef SIGXFSZ
  82   , SIGXFSZ
  83 #endif
  84 #ifdef SIGEMT
  85   , SIGEMT
  86 #endif
  87 };
  88
  89 static unsigned NumRegisteredSignals = 0;
  90 static struct {
  91   struct sigaction SA;
  92   int SigNo;
  93 } RegisteredSignalInfo[(sizeof(IntSigs)+sizeof(KillSigs))/sizeof(KillSigs[0])];
  94
  95
  96 static void RegisterHandler(int Signal) {
  97   assert(NumRegisteredSignals <
  98          sizeof(RegisteredSignalInfo)/sizeof(RegisteredSignalInfo[0]) &&
  99          "Out of space for signal handlers!");
 100
 101   struct sigaction NewHandler;
 102
 103   NewHandler.sa_handler = SignalHandler;
 104   NewHandler.sa_flags = SA_NODEFER|SA_RESETHAND;
 105   sigemptyset(&NewHandler.sa_mask);
 106
 107   // Install the new handler, save the old one in RegisteredSignalInfo.
 108   sigaction(Signal, &NewHandler,
 109             &RegisteredSignalInfo[NumRegisteredSignals].SA);
 110   RegisteredSignalInfo[NumRegisteredSignals].SigNo = Signal;
 111   ++NumRegisteredSignals;
 112 }
 113
 114 static void RegisterHandlers() {
 115   // We need to dereference the signals mutex during handler registration so
 116   // that we force its construction. This is to prevent the first use being
 117   // during handling an actual signal because you can't safely call new in a
 118   // signal handler.
 119   *SignalsMutex;
 120
 121   // If the handlers are already registered, we're done.
 122   if (NumRegisteredSignals != 0) return;
 123
 124   for (auto S : IntSigs) RegisterHandler(S);
 125   for (auto S : KillSigs) RegisterHandler(S);
 126 }
 127
 128 static void UnregisterHandlers() {
 129   // Restore all of the signal handlers to how they were before we showed up.
 130   for (unsigned i = 0, e = NumRegisteredSignals; i != e; ++i)
 131     sigaction(RegisteredSignalInfo[i].SigNo,
 132               &RegisteredSignalInfo[i].SA, nullptr);
 133   NumRegisteredSignals = 0;
 134 }
 135
 136
 137 /// RemoveFilesToRemove - Process the FilesToRemove list. This function
 138 /// should be called with the SignalsMutex lock held.
 139 /// NB: This must be an async signal safe function. It cannot allocate or free
 140 /// memory, even in debug builds.
 141 static void RemoveFilesToRemove() {
 142   // Avoid constructing ManagedStatic in the signal handler.
 143   // If FilesToRemove is not constructed, there are no files to remove.
 144   if (!FilesToRemove.isConstructed())
 145     return;
 146
 147   // We avoid iterators in case of debug iterators that allocate or release
 148   // memory.
 149   std::vector<std::string>& FilesToRemoveRef = *FilesToRemove;
 150   for (unsigned i = 0, e = FilesToRemoveRef.size(); i != e; ++i) {
 151     // We rely on a std::string implementation for which repeated calls to
 152     // 'c_str()' don't allocate memory. We pre-call 'c_str()' on all of these
 153     // strings to try to ensure this is safe.
 154     const char *path = FilesToRemoveRef[i].c_str();
 155
 156     // Get the status so we can determine if it's a file or directory. If we
 157     // can't stat the file, ignore it.
 158     struct stat buf;
 159     if (stat(path, &buf) != 0)
 160       continue;
 161
 162     // If this is not a regular file, ignore it. We want to prevent removal of
 163     // special files like /dev/null, even if the compiler is being run with the
 164     // super-user permissions.
 165     if (!S_ISREG(buf.st_mode))
 166       continue;
 167
 168     // Otherwise, remove the file. We ignore any errors here as there is nothing
 169     // else we can do.
 170     unlink(path);
 171   }
 172 }
 173
 174 // SignalHandler - The signal handler that runs.
 175 static RETSIGTYPE SignalHandler(int Sig) {
 176   // Restore the signal behavior to default, so that the program actually
 177   // crashes when we return and the signal reissues.  This also ensures that if
 178   // we crash in our signal handler that the program will terminate immediately
 179   // instead of recursing in the signal handler.
 180   UnregisterHandlers();
 181
 182   // Unmask all potentially blocked kill signals.
 183   sigset_t SigMask;
 184   sigfillset(&SigMask);
 185   sigprocmask(SIG_UNBLOCK, &SigMask, nullptr);
 186
 187   {
 188     unique_lock<SmartMutex<true>> Guard(*SignalsMutex);
 189     RemoveFilesToRemove();
 190
 191     if (std::find(std::begin(IntSigs), std::end(IntSigs), Sig)
 192         != std::end(IntSigs)) {
 193       if (InterruptFunction) {
 194         void (*IF)() = InterruptFunction;
 195         Guard.unlock();
 196         InterruptFunction = nullptr;
 197         IF();        // run the interrupt function.
 198         return;
 199       }
 200
 201       Guard.unlock();
 202       raise(Sig);   // Execute the default handler.
 203       return;
 204    }
 205   }
 206
 207   // Otherwise if it is a fault (like SEGV) run any handler.
 208   if (CallBacksToRun.isConstructed()) {
 209     std::vector<std::pair<void (*)(void *), void *>>& CallBacksToRunRef =
 210         *CallBacksToRun;
 211     for (unsigned i = 0, e = CallBacksToRun->size(); i != e; ++i)
 212       CallBacksToRunRef[i].first(CallBacksToRunRef[i].second);
 213   }
 214
 215 #ifdef __s390__
 216   // On S/390, certain signals are delivered with PSW Address pointing to
 217   // *after* the faulting instruction.  Simply returning from the signal
 218   // handler would continue execution after that point, instead of
 219   // re-raising the signal.  Raise the signal manually in those cases.
 220   if (Sig == SIGILL || Sig == SIGFPE || Sig == SIGTRAP)
 221     raise(Sig);
 222 #endif
 223 }
 224
 225 void llvm::sys::RunInterruptHandlers() {
 226   sys::SmartScopedLock<true> Guard(*SignalsMutex);
 227   RemoveFilesToRemove();
 228 }
 229
 230 void llvm::sys::SetInterruptFunction(void (*IF)()) {
 231   {
 232     sys::SmartScopedLock<true> Guard(*SignalsMutex);
 233     InterruptFunction = IF;
 234   }
 235   RegisterHandlers();
 236 }
 237
 238 // RemoveFileOnSignal - The public API
 239 bool llvm::sys::RemoveFileOnSignal(StringRef Filename,
 240                                    std::string* ErrMsg) {
 241   {
 242     sys::SmartScopedLock<true> Guard(*SignalsMutex);
 243     std::vector<std::string>& FilesToRemoveRef = *FilesToRemove;
 244     std::string *OldPtr =
 245         FilesToRemoveRef.empty() ? nullptr : &FilesToRemoveRef[0];
 246     FilesToRemoveRef.push_back(Filename);
 247
 248     // We want to call 'c_str()' on every std::string in this vector so that if
 249     // the underlying implementation requires a re-allocation, it happens here
 250     // rather than inside of the signal handler. If we see the vector grow, we
 251     // have to call it on every entry. If it remains in place, we only need to
 252     // call it on the latest one.
 253     if (OldPtr == &FilesToRemoveRef[0])
 254       FilesToRemoveRef.back().c_str();
 255     else
 256       for (unsigned i = 0, e = FilesToRemoveRef.size(); i != e; ++i)
 257         FilesToRemoveRef[i].c_str();
 258   }
 259
 260   RegisterHandlers();
 261   return false;
 262 }
 263
 264 // DontRemoveFileOnSignal - The public API
 265 void llvm::sys::DontRemoveFileOnSignal(StringRef Filename) {
 266   sys::SmartScopedLock<true> Guard(*SignalsMutex);
 267   std::vector<std::string>::reverse_iterator RI =
 268     std::find(FilesToRemove->rbegin(), FilesToRemove->rend(), Filename);
 269   std::vector<std::string>::iterator I = FilesToRemove->end();
 270   if (RI != FilesToRemove->rend())
 271     I = FilesToRemove->erase(RI.base()-1);
 272
 273   // We need to call c_str() on every element which would have been moved by
 274   // the erase. These elements, in a C++98 implementation where c_str()
 275   // requires a reallocation on the first call may have had the call to c_str()
 276   // made on insertion become invalid by being copied down an element.
 277   for (std::vector<std::string>::iterator E = FilesToRemove->end(); I != E; ++I)
 278     I->c_str();
 279 }
 280
 281 /// AddSignalHandler - Add a function to be called when a signal is delivered
 282 /// to the process.  The handler can have a cookie passed to it to identify
 283 /// what instance of the handler it is.
 284 void llvm::sys::AddSignalHandler(void (*FnPtr)(void *), void *Cookie) {
 285   CallBacksToRun->push_back(std::make_pair(FnPtr, Cookie));
 286   RegisterHandlers();
 287 }
 288
 289 #if defined(HAVE_BACKTRACE) && defined(ENABLE_BACKTRACES)
 290
 291 #if HAVE_LINK_H && (defined(__linux__) || defined(__FreeBSD__) ||              \
 292                     defined(__FreeBSD_kernel__) || defined(__NetBSD__))
 293 struct DlIteratePhdrData {
 294   void **StackTrace;
 295   int depth;
 296   bool first;
 297   const char **modules;
 298   intptr_t *offsets;
 299   const char *main_exec_name;
 300 };
 301
 302 static int dl_iterate_phdr_cb(dl_phdr_info *info, size_t size, void *arg) {
 303   DlIteratePhdrData *data = (DlIteratePhdrData*)arg;
 304   const char *name = data->first ? data->main_exec_name : info->dlpi_name;
 305   data->first = false;
 306   for (int i = 0; i < info->dlpi_phnum; i++) {
 307     const auto *phdr = &info->dlpi_phdr[i];
 308     if (phdr->p_type != PT_LOAD)
 309       continue;
 310     intptr_t beg = info->dlpi_addr + phdr->p_vaddr;
 311     intptr_t end = beg + phdr->p_memsz;
 312     for (int j = 0; j < data->depth; j++) {
 313       if (data->modules[j])
 314         continue;
 315       intptr_t addr = (intptr_t)data->StackTrace[j];
 316       if (beg <= addr && addr < end) {
 317         data->modules[j] = name;
 318         data->offsets[j] = addr - info->dlpi_addr;
 319       }
 320     }
 321   }
 322   return 0;
 323 }
 324
 325 static bool findModulesAndOffsets(void **StackTrace, int Depth,
 326                                   const char **Modules, intptr_t *Offsets,
 327                                   const char *MainExecutableName) {
 328   DlIteratePhdrData data = {StackTrace, Depth,   true,
 329                             Modules,    Offsets, MainExecutableName};
 330   dl_iterate_phdr(dl_iterate_phdr_cb, &data);
 331   return true;
 332 }
 333 #else
 334 static bool findModulesAndOffsets(void **StackTrace, int Depth,
 335                                   const char **Modules, intptr_t *Offsets,
 336                                   const char *MainExecutableName) {
 337   return false;
 338 }
 339 #endif
 340
 341 static bool printSymbolizedStackTrace(void **StackTrace, int Depth,
 342                                       llvm::raw_ostream &OS) {
 343   // FIXME: Subtract necessary number from StackTrace entries to turn return addresses
 344   // into actual instruction addresses.
 345   // Use llvm-symbolizer tool to symbolize the stack traces.
 346   ErrorOr<std::string> LLVMSymbolizerPathOrErr =
 347       sys::findProgramByName("llvm-symbolizer");
 348   if (!LLVMSymbolizerPathOrErr)
 349     return false;
 350   const std::string &LLVMSymbolizerPath = *LLVMSymbolizerPathOrErr;
 351   // We don't know argv0 or the address of main() at this point, but try
 352   // to guess it anyway (it's possible on some platforms).
 353   std::string MainExecutableName = sys::fs::getMainExecutable(nullptr, nullptr);
 354   if (MainExecutableName.empty() ||
 355       MainExecutableName.find("llvm-symbolizer") != std::string::npos)
 356     return false;
 357
 358   std::vector<const char *> Modules(Depth, nullptr);
 359   std::vector<intptr_t> Offsets(Depth, 0);
 360   if (!findModulesAndOffsets(StackTrace, Depth, Modules.data(), Offsets.data(),
 361                              MainExecutableName.c_str()))
 362     return false;
 363   int InputFD;
 364   SmallString<32> InputFile, OutputFile;
 365   sys::fs::createTemporaryFile("symbolizer-input", "", InputFD, InputFile);
 366   sys::fs::createTemporaryFile("symbolizer-output", "", OutputFile);
 367   FileRemover InputRemover(InputFile.c_str());
 368   FileRemover OutputRemover(OutputFile.c_str());
 369
 370   {
 371     raw_fd_ostream Input(InputFD, true);
 372     for (int i = 0; i < Depth; i++) {
 373       if (Modules[i])
 374         Input << Modules[i] << " " << (void*)Offsets[i] << "\n";
 375     }
 376   }
 377
 378   StringRef InputFileStr(InputFile);
 379   StringRef OutputFileStr(OutputFile);
 380   StringRef StderrFileStr;
 381   const StringRef *Redirects[] = {&InputFileStr, &OutputFileStr,
 382                                   &StderrFileStr};
 383   const char *Args[] = {"llvm-symbolizer", "--functions=linkage", "--inlining",
 384                         "--demangle", nullptr};
 385   int RunResult =
 386       sys::ExecuteAndWait(LLVMSymbolizerPath, Args, nullptr, Redirects);
 387   if (RunResult != 0)
 388     return false;
 389
 390   auto OutputBuf = MemoryBuffer::getFile(OutputFile.c_str());
 391   if (!OutputBuf)
 392     return false;
 393   StringRef Output = OutputBuf.get()->getBuffer();
 394   SmallVector<StringRef, 32> Lines;
 395   Output.split(Lines, "\n");
 396   auto CurLine = Lines.begin();
 397   int frame_no = 0;
 398   for (int i = 0; i < Depth; i++) {
 399     if (!Modules[i]) {
 400       OS << format("#%d %p\n", frame_no++, StackTrace[i]);
 401       continue;
 402     }
 403     // Read pairs of lines (function name and file/line info) until we
 404     // encounter empty line.
 405     for (;;) {
 406       if (CurLine == Lines.end())
 407         return false;
 408       StringRef FunctionName = *CurLine++;
 409       if (FunctionName.empty())
 410         break;
 411       OS << format("#%d %p ", frame_no++, StackTrace[i]);
 412       if (!FunctionName.startswith("??"))
 413         OS << format("%s ", FunctionName.str().c_str());
 414       if (CurLine == Lines.end())
 415         return false;
 416       StringRef FileLineInfo = *CurLine++;
 417       if (!FileLineInfo.startswith("??"))
 418         OS << format("%s", FileLineInfo.str().c_str());
 419       else
 420         OS << format("(%s+%p)", Modules[i], (void *)Offsets[i]);
 421       OS << "\n";
 422     }
 423   }
 424   return true;
 425 }
 426 #endif // defined(HAVE_BACKTRACE) && defined(ENABLE_BACKTRACES)
 427
 428 // PrintStackTrace - In the case of a program crash or fault, print out a stack
 429 // trace so that the user has an indication of why and where we died.
 430 //
 431 // On glibc systems we have the 'backtrace' function, which works nicely, but
 432 // doesn't demangle symbols.
 433 void llvm::sys::PrintStackTrace(raw_ostream &OS) {
 434 #if defined(HAVE_BACKTRACE) && defined(ENABLE_BACKTRACES)
 435   static void* StackTrace[256];
 436   // Use backtrace() to output a backtrace on Linux systems with glibc.
 437   int depth = backtrace(StackTrace,
 438                         static_cast<int>(array_lengthof(StackTrace)));
 439   if (printSymbolizedStackTrace(StackTrace, depth, OS))
 440     return;
 441 #if HAVE_DLFCN_H && __GNUG__
 442   int width = 0;
 443   for (int i = 0; i < depth; ++i) {
 444     Dl_info dlinfo;
 445     dladdr(StackTrace[i], &dlinfo);
 446     const char* name = strrchr(dlinfo.dli_fname, '/');
 447
 448     int nwidth;
 449     if (!name) nwidth = strlen(dlinfo.dli_fname);
 450     else       nwidth = strlen(name) - 1;
 451
 452     if (nwidth > width) width = nwidth;
 453   }
 454
 455   for (int i = 0; i < depth; ++i) {
 456     Dl_info dlinfo;
 457     dladdr(StackTrace[i], &dlinfo);
 458
 459     OS << format("%-2d", i);
 460
 461     const char* name = strrchr(dlinfo.dli_fname, '/');
 462     if (!name) OS << format(" %-*s", width, dlinfo.dli_fname);
 463     else       OS << format(" %-*s", width, name+1);
 464
 465     OS << format(" %#0*lx", (int)(sizeof(void*) * 2) + 2,
 466                  (unsigned long)StackTrace[i]);
 467
 468     if (dlinfo.dli_sname != nullptr) {
 469       OS << ' ';
 470 #  if HAVE_CXXABI_H
 471       int res;
 472       char* d = abi::__cxa_demangle(dlinfo.dli_sname, nullptr, nullptr, &res);
 473 #  else
 474       char* d = NULL;
 475 #  endif
 476       if (!d) OS << dlinfo.dli_sname;
 477       else    OS << d;
 478       free(d);
 479
 480       // FIXME: When we move to C++11, use %t length modifier. It's not in
 481       // C++03 and causes gcc to issue warnings. Losing the upper 32 bits of
 482       // the stack offset for a stack dump isn't likely to cause any problems.
 483       OS << format(" + %u",(unsigned)((char*)StackTrace[i]-
 484                                       (char*)dlinfo.dli_saddr));
 485     }
 486     OS << '\n';
 487   }
 488 #else
 489   backtrace_symbols_fd(StackTrace, depth, STDERR_FILENO);
 490 #endif
 491 #endif
 492 }
 493
 494 static void PrintStackTraceSignalHandler(void *) {
 495   PrintStackTrace(llvm::errs());
 496 }
 497
 498 void llvm::sys::DisableSystemDialogsOnCrash() {}
 499
 500 /// PrintStackTraceOnErrorSignal - When an error signal (such as SIGABRT or
 501 /// SIGSEGV) is delivered to the process, print a stack trace and then exit.
 502 void llvm::sys::PrintStackTraceOnErrorSignal(bool DisableCrashReporting) {
 503   AddSignalHandler(PrintStackTraceSignalHandler, nullptr);
 504
 505 #if defined(__APPLE__) && defined(ENABLE_CRASH_OVERRIDES)
 506   // Environment variable to disable any kind of crash dialog.
 507   if (DisableCrashReporting || getenv("LLVM_DISABLE_CRASH_REPORT")) {
 508     mach_port_t self = mach_task_self();
 509
 510     exception_mask_t mask = EXC_MASK_CRASH;
 511
 512     kern_return_t ret = task_set_exception_ports(self,
 513                              mask,
 514                              MACH_PORT_NULL,
 515                              EXCEPTION_STATE_IDENTITY | MACH_EXCEPTION_CODES,
 516                              THREAD_STATE_NONE);
 517     (void)ret;
 518   }
 519 #endif
 520 }
 521
 522
 523 /***/
 524
 525 // On Darwin, raise sends a signal to the main thread instead of the current
 526 // thread. This has the unfortunate effect that assert() and abort() will end up
 527 // bypassing our crash recovery attempts. We work around this for anything in
 528 // the same linkage unit by just defining our own versions of the assert handler
 529 // and abort.
 530
 531 #if defined(__APPLE__) && defined(ENABLE_CRASH_OVERRIDES)
 532
 533 #include <signal.h>
 534 #include <pthread.h>
 535
 536 int raise(int sig) {
 537   return pthread_kill(pthread_self(), sig);
 538 }
 539
 540 void __assert_rtn(const char *func,
 541                   const char *file,
 542                   int line,
 543                   const char *expr) {
 544   if (func)
 545     fprintf(stderr, "Assertion failed: (%s), function %s, file %s, line %d.\n",
 546             expr, func, file, line);
 547   else
 548     fprintf(stderr, "Assertion failed: (%s), file %s, line %d.\n",
 549             expr, file, line);
 550   abort();
 551 }
 552
 553 void abort() {
 554   raise(SIGABRT);
 555   usleep(1000);
 556   __builtin_trap();
 557 }
 558
 559 #endif