1 //===- PrettyStackTrace.cpp - Pretty Crash Handling -----------------------===//
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 //===----------------------------------------------------------------------===//
15 #include "llvm/Config/config.h" // Get autoconf configuration settings
16 #include "llvm/Support/PrettyStackTrace.h"
17 #include "llvm/Support/raw_ostream.h"
18 #include "llvm/System/Signals.h"
19 #include "llvm/System/ThreadLocal.h"
20 #include "llvm/ADT/SmallString.h"
22 #ifdef HAVE_CRASHREPORTERCLIENT_H
23 #include <CrashReporterClient.h>
29 bool DisablePrettyStackTrace = false;
32 // FIXME: This should be thread local when llvm supports threads.
33 static sys::ThreadLocal<const PrettyStackTraceEntry> PrettyStackTraceHead;
35 static unsigned PrintStack(const PrettyStackTraceEntry *Entry, raw_ostream &OS){
37 if (Entry->getNextEntry())
38 NextID = PrintStack(Entry->getNextEntry(), OS);
39 OS << NextID << ".\t";
45 /// PrintCurStackTrace - Print the current stack trace to the specified stream.
46 static void PrintCurStackTrace(raw_ostream &OS) {
47 // Don't print an empty trace.
48 if (PrettyStackTraceHead.get() == 0) return;
50 // If there are pretty stack frames registered, walk and emit them.
51 OS << "Stack dump:\n";
53 PrintStack(PrettyStackTraceHead.get(), OS);
57 // Integrate with crash reporter.
58 #if defined (__APPLE__) && !defined (HAVE_CRASHREPORTERCLIENT_H)
59 static const char *__crashreporter_info__ = 0;
60 asm(".desc ___crashreporter_info__, 0x10");
64 /// CrashHandler - This callback is run if a fatal signal is delivered to the
65 /// process, it prints the pretty stack trace.
66 static void CrashHandler(void *Cookie) {
68 // On non-apple systems, just emit the crash stack trace to stderr.
69 PrintCurStackTrace(errs());
71 // Otherwise, emit to a smallvector of chars, send *that* to stderr, but also
72 // put it into __crashreporter_info__.
73 SmallString<2048> TmpStr;
75 raw_svector_ostream Stream(TmpStr);
76 PrintCurStackTrace(Stream);
79 if (!TmpStr.empty()) {
80 #ifndef HAVE_CRASHREPORTERCLIENT_H
81 __crashreporter_info__ = strdup(std::string(TmpStr.str()).c_str());
83 CRSetCrashLogMessage(std::string(TmpStr.str()).c_str());
85 errs() << TmpStr.str();
91 static bool RegisterCrashPrinter() {
92 if (!DisablePrettyStackTrace)
93 sys::AddSignalHandler(CrashHandler, 0);
97 PrettyStackTraceEntry::PrettyStackTraceEntry() {
98 // The first time this is called, we register the crash printer.
99 static bool HandlerRegistered = RegisterCrashPrinter();
100 HandlerRegistered = HandlerRegistered;
103 NextEntry = PrettyStackTraceHead.get();
104 PrettyStackTraceHead.set(this);
107 PrettyStackTraceEntry::~PrettyStackTraceEntry() {
108 assert(PrettyStackTraceHead.get() == this &&
109 "Pretty stack trace entry destruction is out of order");
110 PrettyStackTraceHead.set(getNextEntry());
113 void PrettyStackTraceString::print(raw_ostream &OS) const {
117 void PrettyStackTraceProgram::print(raw_ostream &OS) const {
118 OS << "Program arguments: ";
119 // Print the argument list.
120 for (unsigned i = 0, e = ArgC; i != e; ++i)
121 OS << ArgV[i] << ' ';