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 if (FilesToRemove != 0)
61 while (!FilesToRemove->empty()) {
62 FilesToRemove->back().eraseFromDisk(true);
63 FilesToRemove->pop_back();
66 if (std::find(IntSigs, IntSigsEnd, Sig) != IntSigsEnd) {
67 if (InterruptFunction) {
68 void (*IF)() = InterruptFunction;
69 InterruptFunction = 0;
70 IF(); // run the interrupt function.
73 exit(1); // If this is an interrupt signal, exit the program
76 // Otherwise if it is a fault (like SEGV) run any handler.
78 for (unsigned i = 0, e = CallBacksToRun->size(); i != e; ++i)
79 (*CallBacksToRun)[i].first((*CallBacksToRun)[i].second);
81 // Restore the signal behavior to default, so that the program actually
82 // crashes when we return and the signal reissues.
87 static void RegisterHandler(int Signal) {
88 signal(Signal, SignalHandler);
93 void sys::SetInterruptFunction(void (*IF)()) {
94 InterruptFunction = IF;
95 RegisterHandler(SIGINT);
98 // RemoveFileOnSignal - The public API
99 bool sys::RemoveFileOnSignal(const sys::Path &Filename, std::string* ErrMsg) {
100 if (FilesToRemove == 0)
101 FilesToRemove = new std::vector<sys::Path>();
103 FilesToRemove->push_back(Filename);
105 std::for_each(IntSigs, IntSigsEnd, RegisterHandler);
106 std::for_each(KillSigs, KillSigsEnd, RegisterHandler);
110 /// AddSignalHandler - Add a function to be called when a signal is delivered
111 /// to the process. The handler can have a cookie passed to it to identify
112 /// what instance of the handler it is.
113 void sys::AddSignalHandler(void (*FnPtr)(void *), void *Cookie) {
114 if (CallBacksToRun == 0)
115 CallBacksToRun = new std::vector<std::pair<void(*)(void*), void*> >();
116 CallBacksToRun->push_back(std::make_pair(FnPtr, Cookie));
117 std::for_each(KillSigs, KillSigsEnd, RegisterHandler);
121 // PrintStackTrace - In the case of a program crash or fault, print out a stack
122 // trace so that the user has an indication of why and where we died.
124 // On glibc systems we have the 'backtrace' function, which works nicely, but
125 // doesn't demangle symbols.
126 static void PrintStackTrace(void *) {
127 #ifdef HAVE_BACKTRACE
128 static void* StackTrace[256];
129 // Use backtrace() to output a backtrace on Linux systems with glibc.
130 int depth = backtrace(StackTrace,
131 static_cast<int>(array_lengthof(StackTrace)));
132 #if HAVE_DLFCN_H && __GNUG__
134 for (int i = 0; i < depth; ++i) {
136 dladdr(StackTrace[i], &dlinfo);
137 const char* name = strrchr(dlinfo.dli_fname, '/');
140 if (name == NULL) nwidth = strlen(dlinfo.dli_fname);
141 else nwidth = strlen(name) - 1;
143 if (nwidth > width) width = nwidth;
146 for (int i = 0; i < depth; ++i) {
148 dladdr(StackTrace[i], &dlinfo);
150 fprintf(stderr, "%-3d", i);
152 const char* name = strrchr(dlinfo.dli_fname, '/');
153 if (name == NULL) fprintf(stderr, " %-*s", width, dlinfo.dli_fname);
154 else fprintf(stderr, " %-*s", width, name+1);
156 fprintf(stderr, " %#0*lx",
157 (int)(sizeof(void*) * 2) + 2, (unsigned long)StackTrace[i]);
159 if (dlinfo.dli_sname != NULL) {
162 char* d = abi::__cxa_demangle(dlinfo.dli_sname, NULL, NULL, &res);
163 if (d == NULL) fputs(dlinfo.dli_sname, stderr);
164 else fputs(d, stderr);
167 fprintf(stderr, " + %tu",(char*)StackTrace[i]-(char*)dlinfo.dli_saddr);
172 backtrace_symbols_fd(StackTrace, depth, STDERR_FILENO);
177 /// PrintStackTraceOnErrorSignal - When an error signal (such as SIBABRT or
178 /// SIGSEGV) is delivered to the process, print a stack trace and then exit.
179 void sys::PrintStackTraceOnErrorSignal() {
180 AddSignalHandler(PrintStackTrace, 0);