1 //===- Signals.cpp - Signal Handling support --------------------*- 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 occurring while your program is running.
13 //===----------------------------------------------------------------------===//
15 #include "llvm/ADT/STLExtras.h"
16 #include "llvm/ADT/StringRef.h"
17 #include "llvm/Config/config.h"
18 #include "llvm/Support/ErrorOr.h"
19 #include "llvm/Support/FileSystem.h"
20 #include "llvm/Support/FileUtilities.h"
21 #include "llvm/Support/Format.h"
22 #include "llvm/Support/ManagedStatic.h"
23 #include "llvm/Support/MemoryBuffer.h"
24 #include "llvm/Support/Mutex.h"
25 #include "llvm/Support/Program.h"
26 #include "llvm/Support/Signals.h"
27 #include "llvm/Support/StringSaver.h"
28 #include "llvm/Support/raw_ostream.h"
34 //===----------------------------------------------------------------------===//
35 //=== WARNING: Implementation here must contain only TRULY operating system
36 //=== independent code.
37 //===----------------------------------------------------------------------===//
39 static ManagedStatic<std::vector<std::pair<void (*)(void *), void *>>>
41 void sys::RunSignalHandlers() {
42 if (!CallBacksToRun.isConstructed())
44 for (auto &I : *CallBacksToRun)
46 CallBacksToRun->clear();
52 static bool findModulesAndOffsets(void **StackTrace, int Depth,
53 const char **Modules, intptr_t *Offsets,
54 const char *MainExecutableName,
55 StringSaver &StrPool);
57 /// Format a pointer value as hexadecimal. Zero pad it out so its always the
59 static FormattedNumber format_ptr(void *PC) {
60 // Each byte is two hex digits plus 2 for the 0x prefix.
61 unsigned PtrWidth = 2 + 2 * sizeof(void *);
62 return format_hex((uint64_t)PC, PtrWidth);
65 static bool printSymbolizedStackTrace(void **StackTrace, int Depth,
66 llvm::raw_ostream &OS)
69 /// Helper that launches llvm-symbolizer and symbolizes a backtrace.
70 static bool printSymbolizedStackTrace(void **StackTrace, int Depth,
71 llvm::raw_ostream &OS) {
72 // FIXME: Subtract necessary number from StackTrace entries to turn return addresses
73 // into actual instruction addresses.
74 // Use llvm-symbolizer tool to symbolize the stack traces.
75 ErrorOr<std::string> LLVMSymbolizerPathOrErr =
76 sys::findProgramByName("llvm-symbolizer");
77 if (!LLVMSymbolizerPathOrErr)
79 const std::string &LLVMSymbolizerPath = *LLVMSymbolizerPathOrErr;
80 // We don't know argv0 or the address of main() at this point, but try
81 // to guess it anyway (it's possible on some platforms).
82 std::string MainExecutableName = sys::fs::getMainExecutable(nullptr, nullptr);
83 if (MainExecutableName.empty() ||
84 MainExecutableName.find("llvm-symbolizer") != std::string::npos)
87 BumpPtrAllocator Allocator;
88 StringSaver StrPool(Allocator);
89 std::vector<const char *> Modules(Depth, nullptr);
90 std::vector<intptr_t> Offsets(Depth, 0);
91 if (!findModulesAndOffsets(StackTrace, Depth, Modules.data(), Offsets.data(),
92 MainExecutableName.c_str(), StrPool))
95 SmallString<32> InputFile, OutputFile;
96 sys::fs::createTemporaryFile("symbolizer-input", "", InputFD, InputFile);
97 sys::fs::createTemporaryFile("symbolizer-output", "", OutputFile);
98 FileRemover InputRemover(InputFile.c_str());
99 FileRemover OutputRemover(OutputFile.c_str());
102 raw_fd_ostream Input(InputFD, true);
103 for (int i = 0; i < Depth; i++) {
105 Input << Modules[i] << " " << (void*)Offsets[i] << "\n";
109 StringRef InputFileStr(InputFile);
110 StringRef OutputFileStr(OutputFile);
111 StringRef StderrFileStr;
112 const StringRef *Redirects[] = {&InputFileStr, &OutputFileStr,
114 const char *Args[] = {"llvm-symbolizer", "--functions=linkage", "--inlining",
116 // Pass --relative-address on Windows so that we don't
117 // have to add ImageBase from PE file.
118 // FIXME: Make this the default for llvm-symbolizer.
119 "--relative-address",
121 "--demangle", nullptr};
123 sys::ExecuteAndWait(LLVMSymbolizerPath, Args, nullptr, Redirects);
127 // This report format is based on the sanitizer stack trace printer. See
128 // sanitizer_stacktrace_printer.cc in compiler-rt.
129 auto OutputBuf = MemoryBuffer::getFile(OutputFile.c_str());
132 StringRef Output = OutputBuf.get()->getBuffer();
133 SmallVector<StringRef, 32> Lines;
134 Output.split(Lines, "\n");
135 auto CurLine = Lines.begin();
137 for (int i = 0; i < Depth; i++) {
139 OS << '#' << frame_no++ << ' ' << format_ptr(StackTrace[i]) << '\n';
142 // Read pairs of lines (function name and file/line info) until we
143 // encounter empty line.
145 if (CurLine == Lines.end())
147 StringRef FunctionName = *CurLine++;
148 if (FunctionName.empty())
150 OS << '#' << frame_no++ << ' ' << format_ptr(StackTrace[i]) << ' ';
151 if (!FunctionName.startswith("??"))
152 OS << FunctionName << ' ';
153 if (CurLine == Lines.end())
155 StringRef FileLineInfo = *CurLine++;
156 if (!FileLineInfo.startswith("??"))
159 OS << "(" << Modules[i] << '+' << format_hex(Offsets[i], 0) << ")";
166 // Include the platform-specific parts of this class.
168 #include "Unix/Signals.inc"
171 #include "Windows/Signals.inc"