1 //===- Signals.cpp - Generic Unix Signals Implementation -----*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines some helpful functions for dealing with the possibility of
11 // Unix signals occuring while your program is running.
13 //===----------------------------------------------------------------------===//
16 #include "llvm/ADT/STLExtras.h"
20 # include <execinfo.h> // For backtrace().
28 #if HAVE_DLFCN_H && __GNUG__
34 /// InterruptFunction - The function to call if ctrl-c is pressed.
35 static void (*InterruptFunction)() = 0;
37 static std::vector<sys::Path> *FilesToRemove = 0;
38 static std::vector<std::pair<void(*)(void*), void*> > *CallBacksToRun = 0;
40 // IntSigs - Signals that may interrupt the program at any time.
41 static const int IntSigs[] = {
42 SIGHUP, SIGINT, SIGQUIT, SIGPIPE, SIGTERM, SIGUSR1, SIGUSR2
44 static const int *const IntSigsEnd =
45 IntSigs + sizeof(IntSigs) / sizeof(IntSigs[0]);
47 // KillSigs - Signals that are synchronous with the program that will cause it
49 static const int KillSigs[] = {
50 SIGILL, SIGTRAP, SIGABRT, SIGFPE, SIGBUS, SIGSEGV, SIGSYS, SIGXCPU, SIGXFSZ
55 static const int *const KillSigsEnd =
56 KillSigs + sizeof(KillSigs) / sizeof(KillSigs[0]);
58 // SignalHandler - The signal handler that runs...
59 static RETSIGTYPE SignalHandler(int Sig) {
60 // Restore the signal behavior to default, so that the program actually
61 // crashes when we return and the signal reissues. This also ensures that if
62 // we crash in our signal handler that the program will terminate immediately
63 // instead of recursing in the signal handler.
66 if (FilesToRemove != 0)
67 while (!FilesToRemove->empty()) {
68 FilesToRemove->back().eraseFromDisk(true);
69 FilesToRemove->pop_back();
72 if (std::find(IntSigs, IntSigsEnd, Sig) != IntSigsEnd) {
73 if (InterruptFunction) {
74 void (*IF)() = InterruptFunction;
75 InterruptFunction = 0;
76 IF(); // run the interrupt function.
79 exit(1); // If this is an interrupt signal, exit the program
82 // Otherwise if it is a fault (like SEGV) run any handler.
84 for (unsigned i = 0, e = CallBacksToRun->size(); i != e; ++i)
85 (*CallBacksToRun)[i].first((*CallBacksToRun)[i].second);
89 static void RegisterHandler(int Signal) {
90 signal(Signal, SignalHandler);
95 void sys::SetInterruptFunction(void (*IF)()) {
96 InterruptFunction = IF;
97 RegisterHandler(SIGINT);
100 // RemoveFileOnSignal - The public API
101 bool sys::RemoveFileOnSignal(const sys::Path &Filename, std::string* ErrMsg) {
102 if (FilesToRemove == 0)
103 FilesToRemove = new std::vector<sys::Path>();
105 FilesToRemove->push_back(Filename);
107 std::for_each(IntSigs, IntSigsEnd, RegisterHandler);
108 std::for_each(KillSigs, KillSigsEnd, RegisterHandler);
112 /// AddSignalHandler - Add a function to be called when a signal is delivered
113 /// to the process. The handler can have a cookie passed to it to identify
114 /// what instance of the handler it is.
115 void sys::AddSignalHandler(void (*FnPtr)(void *), void *Cookie) {
116 if (CallBacksToRun == 0)
117 CallBacksToRun = new std::vector<std::pair<void(*)(void*), void*> >();
118 CallBacksToRun->push_back(std::make_pair(FnPtr, Cookie));
119 std::for_each(KillSigs, KillSigsEnd, RegisterHandler);
123 // PrintStackTrace - In the case of a program crash or fault, print out a stack
124 // trace so that the user has an indication of why and where we died.
126 // On glibc systems we have the 'backtrace' function, which works nicely, but
127 // doesn't demangle symbols.
128 static void PrintStackTrace(void *) {
129 #ifdef HAVE_BACKTRACE
130 static void* StackTrace[256];
131 // Use backtrace() to output a backtrace on Linux systems with glibc.
132 int depth = backtrace(StackTrace,
133 static_cast<int>(array_lengthof(StackTrace)));
134 #if HAVE_DLFCN_H && __GNUG__
136 for (int i = 0; i < depth; ++i) {
138 dladdr(StackTrace[i], &dlinfo);
139 const char* name = strrchr(dlinfo.dli_fname, '/');
142 if (name == NULL) nwidth = strlen(dlinfo.dli_fname);
143 else nwidth = strlen(name) - 1;
145 if (nwidth > width) width = nwidth;
148 for (int i = 0; i < depth; ++i) {
150 dladdr(StackTrace[i], &dlinfo);
152 fprintf(stderr, "%-3d", i);
154 const char* name = strrchr(dlinfo.dli_fname, '/');
155 if (name == NULL) fprintf(stderr, " %-*s", width, dlinfo.dli_fname);
156 else fprintf(stderr, " %-*s", width, name+1);
158 fprintf(stderr, " %#0*lx",
159 (int)(sizeof(void*) * 2) + 2, (unsigned long)StackTrace[i]);
161 if (dlinfo.dli_sname != NULL) {
164 char* d = abi::__cxa_demangle(dlinfo.dli_sname, NULL, NULL, &res);
165 if (d == NULL) fputs(dlinfo.dli_sname, stderr);
166 else fputs(d, stderr);
169 fprintf(stderr, " + %tu",(char*)StackTrace[i]-(char*)dlinfo.dli_saddr);
174 backtrace_symbols_fd(StackTrace, depth, STDERR_FILENO);
179 /// PrintStackTraceOnErrorSignal - When an error signal (such as SIBABRT or
180 /// SIGSEGV) is delivered to the process, print a stack trace and then exit.
181 void sys::PrintStackTraceOnErrorSignal() {
182 AddSignalHandler(PrintStackTrace, 0);