Use backtrace() and include execinfo.h, if they were detected by autoconf.
[oota-llvm.git] / lib / Support / Signals.cpp
1 //===- Signals.cpp - Signal Handling support ------------------------------===//
2 // 
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source 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 occuring while your program is running.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #include "Support/Signals.h"
16 #include <vector>
17 #include <algorithm>
18 #include <cstdlib>
19 #include <cstdio>
20 #include "Config/config.h"     // Get the signal handler return type
21 #ifdef HAVE_EXECINFO_H
22 # include <execinfo.h>         // For backtrace().
23 #endif
24 #include <signal.h>
25 #include <unistd.h>
26 using namespace llvm;
27
28 static std::vector<std::string> FilesToRemove;
29
30 // IntSigs - Signals that may interrupt the program at any time.
31 static const int IntSigs[] = {
32   SIGHUP, SIGINT, SIGQUIT, SIGKILL, SIGPIPE, SIGTERM, SIGUSR1, SIGUSR2
33 };
34 static const int *IntSigsEnd = IntSigs + sizeof(IntSigs)/sizeof(IntSigs[0]);
35
36 // KillSigs - Signals that are synchronous with the program that will cause it
37 // to die.
38 static const int KillSigs[] = {
39   SIGILL, SIGTRAP, SIGABRT, SIGFPE, SIGBUS, SIGSEGV, SIGSYS, SIGXCPU, SIGXFSZ
40 #ifdef SIGEMT
41   , SIGEMT
42 #endif
43 };
44 static const int *KillSigsEnd = KillSigs + sizeof(KillSigs)/sizeof(KillSigs[0]);
45
46 static void* StackTrace[256];
47
48 // SignalHandler - The signal handler that runs...
49 static RETSIGTYPE SignalHandler(int Sig) {
50   while (!FilesToRemove.empty()) {
51     std::remove(FilesToRemove.back().c_str());
52     FilesToRemove.pop_back();
53   }
54
55   if (std::find(IntSigs, IntSigsEnd, Sig) != IntSigsEnd)
56     exit(1);   // If this is an interrupt signal, exit the program
57
58   // Otherwise if it is a fault (like SEGV) output the stacktrace to
59   // STDERR (if we can) and reissue the signal to die...
60 #ifdef HAVE_BACKTRACE
61   // Use backtrace() to output a backtrace on Linux systems with glibc.
62   int depth = backtrace(StackTrace, sizeof(StackTrace)/sizeof(StackTrace[0]));
63   backtrace_symbols_fd(StackTrace, depth, STDERR_FILENO);
64 #endif
65   signal(Sig, SIG_DFL);
66 }
67
68 static void RegisterHandler(int Signal) { signal(Signal, SignalHandler); }
69
70 // RemoveFileOnSignal - The public API
71 void llvm::RemoveFileOnSignal(const std::string &Filename) {
72   FilesToRemove.push_back(Filename);
73
74   std::for_each(IntSigs, IntSigsEnd, RegisterHandler);
75   std::for_each(KillSigs, KillSigsEnd, RegisterHandler);
76 }
77
78 /// PrintStackTraceOnErrorSignal - When an error signal (such as SIBABRT or
79 /// SIGSEGV) is delivered to the process, print a stack trace and then exit.
80 void llvm::PrintStackTraceOnErrorSignal() {
81   std::for_each(KillSigs, KillSigsEnd, RegisterHandler);
82 }