1 //===-- llvm-symbolizer.cpp - Simple addr2line-like symbolizer ------------===//
2 //
3 // The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This utility works much like "addr2line". It is able of transforming
11 // tuples (module name, module offset) to code locations (function name,
12 // file, line number, column number). It is targeted for compiler-rt tools
13 // (especially AddressSanitizer and ThreadSanitizer) that can use it
14 // to symbolize stack traces in their error reports.
15 //
16 //===----------------------------------------------------------------------===//
17
18 #include "llvm/ADT/StringRef.h"
19 #include "llvm/DebugInfo/Symbolize/DIPrinter.h"
20 #include "llvm/DebugInfo/Symbolize/Symbolize.h"
21 #include "llvm/Support/COM.h"
22 #include "llvm/Support/CommandLine.h"
23 #include "llvm/Support/Debug.h"
24 #include "llvm/Support/FileSystem.h"
25 #include "llvm/Support/ManagedStatic.h"
26 #include "llvm/Support/Path.h"
27 #include "llvm/Support/PrettyStackTrace.h"
28 #include "llvm/Support/Signals.h"
29 #include "llvm/Support/raw_ostream.h"
30 #include <cstdio>
31 #include <cstring>
32 #include <string>
33
34 using namespace llvm;
35 using namespace symbolize;
36
37 static cl::opt<bool>
38 ClUseSymbolTable("use-symbol-table", cl::init(true),
39 cl::desc("Prefer names in symbol table to names "
40 "in debug info"));
41
42 static cl::opt<FunctionNameKind> ClPrintFunctions(
43 "functions", cl::init(FunctionNameKind::LinkageName),
44 cl::desc("Print function name for a given address:"),
45 cl::values(clEnumValN(FunctionNameKind::None, "none", "omit function name"),
46 clEnumValN(FunctionNameKind::ShortName, "short",
47 "print short function name"),
48 clEnumValN(FunctionNameKind::LinkageName, "linkage",
49 "print function linkage name"),
50 clEnumValEnd));
51
52 static cl::opt<bool>
53 ClUseRelativeAddress("relative-address", cl::init(false),
54 cl::desc("Interpret addresses as relative addresses"),
55 cl::ReallyHidden);
56
57 static cl::opt<bool>
58 ClPrintInlining("inlining", cl::init(true),
59 cl::desc("Print all inlined frames for a given address"));
60
61 static cl::opt<bool>
62 ClDemangle("demangle", cl::init(true), cl::desc("Demangle function names"));
63
64 static cl::opt<std::string> ClDefaultArch("default-arch", cl::init(""),
65 cl::desc("Default architecture "
66 "(for multi-arch objects)"));
67
68 static cl::opt<std::string>
69 ClBinaryName("obj", cl::init(""),
70 cl::desc("Path to object file to be symbolized (if not provided, "
71 "object file should be specified for each input line)"));
72
73 static cl::list<std::string>
74 ClDsymHint("dsym-hint", cl::ZeroOrMore,
75 cl::desc("Path to .dSYM bundles to search for debug info for the "
76 "object files"));
77 static cl::opt<bool>
78 ClPrintAddress("print-address", cl::init(false),
79 cl::desc("Show address before line information"));
80
81 static cl::opt<bool>
82 ClPrettyPrint("pretty-print", cl::init(false),
83 cl::desc("Make the output more human friendly"));
84
85 static cl::opt<int> ClPrintSourceContextLines(
86 "print-source-context-lines", cl::init(0),
87 cl::desc("Print N number of source file context"));
88
89 template<typename T>
error(Expected<T> & ResOrErr)90 static bool error(Expected<T> &ResOrErr) {
91 if (ResOrErr)
92 return false;
93 logAllUnhandledErrors(ResOrErr.takeError(), errs(),
94 "LLVMSymbolizer: error reading file: ");
95 return true;
96 }
97
parseCommand(StringRef InputString,bool & IsData,std::string & ModuleName,uint64_t & ModuleOffset)98 static bool parseCommand(StringRef InputString, bool &IsData,
99 std::string &ModuleName, uint64_t &ModuleOffset) {
100 const char *kDataCmd = "DATA ";
101 const char *kCodeCmd = "CODE ";
102 const char kDelimiters[] = " \n\r";
103 IsData = false;
104 ModuleName = "";
105 const char *pos = InputString.data();
106 if (strncmp(pos, kDataCmd, strlen(kDataCmd)) == 0) {
107 IsData = true;
108 pos += strlen(kDataCmd);
109 } else if (strncmp(pos, kCodeCmd, strlen(kCodeCmd)) == 0) {
110 IsData = false;
111 pos += strlen(kCodeCmd);
112 } else {
113 // If no cmd, assume it's CODE.
114 IsData = false;
115 }
116 // Skip delimiters and parse input filename (if needed).
117 if (ClBinaryName == "") {
118 pos += strspn(pos, kDelimiters);
119 if (*pos == '"' || *pos == '\'') {
120 char quote = *pos;
121 pos++;
122 const char *end = strchr(pos, quote);
123 if (!end)
124 return false;
125 ModuleName = std::string(pos, end - pos);
126 pos = end + 1;
127 } else {
128 int name_length = strcspn(pos, kDelimiters);
129 ModuleName = std::string(pos, name_length);
130 pos += name_length;
131 }
132 } else {
133 ModuleName = ClBinaryName;
134 }
135 // Skip delimiters and parse module offset.
136 pos += strspn(pos, kDelimiters);
137 int offset_length = strcspn(pos, kDelimiters);
138 return !StringRef(pos, offset_length).getAsInteger(0, ModuleOffset);
139 }
140
main(int argc,char ** argv)141 int main(int argc, char **argv) {
142 // Print stack trace if we signal out.
143 sys::PrintStackTraceOnErrorSignal(argv[0]);
144 PrettyStackTraceProgram X(argc, argv);
145 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
146
147 llvm::sys::InitializeCOMRAII COM(llvm::sys::COMThreadingMode::MultiThreaded);
148
149 cl::ParseCommandLineOptions(argc, argv, "llvm-symbolizer\n");
150 LLVMSymbolizer::Options Opts(ClPrintFunctions, ClUseSymbolTable, ClDemangle,
151 ClUseRelativeAddress, ClDefaultArch);
152
153 for (const auto &hint : ClDsymHint) {
154 if (sys::path::extension(hint) == ".dSYM") {
155 Opts.DsymHints.push_back(hint);
156 } else {
157 errs() << "Warning: invalid dSYM hint: \"" << hint <<
158 "\" (must have the '.dSYM' extension).\n";
159 }
160 }
161 LLVMSymbolizer Symbolizer(Opts);
162
163 DIPrinter Printer(outs(), ClPrintFunctions != FunctionNameKind::None,
164 ClPrettyPrint, ClPrintSourceContextLines);
165
166 const int kMaxInputStringLength = 1024;
167 char InputString[kMaxInputStringLength];
168
169 while (true) {
170 if (!fgets(InputString, sizeof(InputString), stdin))
171 break;
172
173 bool IsData = false;
174 std::string ModuleName;
175 uint64_t ModuleOffset = 0;
176 if (!parseCommand(StringRef(InputString), IsData, ModuleName,
177 ModuleOffset)) {
178 outs() << InputString;
179 continue;
180 }
181
182 if (ClPrintAddress) {
183 outs() << "0x";
184 outs().write_hex(ModuleOffset);
185 StringRef Delimiter = (ClPrettyPrint == true) ? ": " : "\n";
186 outs() << Delimiter;
187 }
188 if (IsData) {
189 auto ResOrErr = Symbolizer.symbolizeData(ModuleName, ModuleOffset);
190 Printer << (error(ResOrErr) ? DIGlobal() : ResOrErr.get());
191 } else if (ClPrintInlining) {
192 auto ResOrErr = Symbolizer.symbolizeInlinedCode(ModuleName, ModuleOffset);
193 Printer << (error(ResOrErr) ? DIInliningInfo()
194 : ResOrErr.get());
195 } else {
196 auto ResOrErr = Symbolizer.symbolizeCode(ModuleName, ModuleOffset);
197 Printer << (error(ResOrErr) ? DILineInfo() : ResOrErr.get());
198 }
199 outs() << "\n";
200 outs().flush();
201 }
202
203 return 0;
204 }
205