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 
51 static cl::opt<bool>
52     ClUseRelativeAddress("relative-address", cl::init(false),
53                          cl::desc("Interpret addresses as relative addresses"),
54                          cl::ReallyHidden);
55 
56 static cl::opt<bool>
57     ClPrintInlining("inlining", cl::init(true),
58                     cl::desc("Print all inlined frames for a given address"));
59 
60 static cl::opt<bool>
61 ClDemangle("demangle", cl::init(true), cl::desc("Demangle function names"));
62 
63 static cl::opt<std::string> ClDefaultArch("default-arch", cl::init(""),
64                                           cl::desc("Default architecture "
65                                                    "(for multi-arch objects)"));
66 
67 static cl::opt<std::string>
68 ClBinaryName("obj", cl::init(""),
69              cl::desc("Path to object file to be symbolized (if not provided, "
70                       "object file should be specified for each input line)"));
71 
72 static cl::list<std::string>
73 ClDsymHint("dsym-hint", cl::ZeroOrMore,
74            cl::desc("Path to .dSYM bundles to search for debug info for the "
75                     "object files"));
76 static cl::opt<bool>
77     ClPrintAddress("print-address", cl::init(false),
78                    cl::desc("Show address before line information"));
79 
80 static cl::opt<bool>
81     ClPrettyPrint("pretty-print", cl::init(false),
82                   cl::desc("Make the output more human friendly"));
83 
84 static cl::opt<int> ClPrintSourceContextLines(
85     "print-source-context-lines", cl::init(0),
86     cl::desc("Print N number of source file context"));
87 
88 template<typename T>
89 static bool error(Expected<T> &ResOrErr) {
90   if (ResOrErr)
91     return false;
92   logAllUnhandledErrors(ResOrErr.takeError(), errs(),
93                         "LLVMSymbolizer: error reading file: ");
94   return true;
95 }
96 
97 static bool parseCommand(StringRef InputString, bool &IsData,
98                          std::string &ModuleName, uint64_t &ModuleOffset) {
99   const char *kDataCmd = "DATA ";
100   const char *kCodeCmd = "CODE ";
101   const char kDelimiters[] = " \n\r";
102   IsData = false;
103   ModuleName = "";
104   const char *pos = InputString.data();
105   if (strncmp(pos, kDataCmd, strlen(kDataCmd)) == 0) {
106     IsData = true;
107     pos += strlen(kDataCmd);
108   } else if (strncmp(pos, kCodeCmd, strlen(kCodeCmd)) == 0) {
109     IsData = false;
110     pos += strlen(kCodeCmd);
111   } else {
112     // If no cmd, assume it's CODE.
113     IsData = false;
114   }
115   // Skip delimiters and parse input filename (if needed).
116   if (ClBinaryName == "") {
117     pos += strspn(pos, kDelimiters);
118     if (*pos == '"' || *pos == '\'') {
119       char quote = *pos;
120       pos++;
121       const char *end = strchr(pos, quote);
122       if (!end)
123         return false;
124       ModuleName = std::string(pos, end - pos);
125       pos = end + 1;
126     } else {
127       int name_length = strcspn(pos, kDelimiters);
128       ModuleName = std::string(pos, name_length);
129       pos += name_length;
130     }
131   } else {
132     ModuleName = ClBinaryName;
133   }
134   // Skip delimiters and parse module offset.
135   pos += strspn(pos, kDelimiters);
136   int offset_length = strcspn(pos, kDelimiters);
137   return !StringRef(pos, offset_length).getAsInteger(0, ModuleOffset);
138 }
139 
140 int main(int argc, char **argv) {
141   // Print stack trace if we signal out.
142   sys::PrintStackTraceOnErrorSignal(argv[0]);
143   PrettyStackTraceProgram X(argc, argv);
144   llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
145 
146   llvm::sys::InitializeCOMRAII COM(llvm::sys::COMThreadingMode::MultiThreaded);
147 
148   cl::ParseCommandLineOptions(argc, argv, "llvm-symbolizer\n");
149   LLVMSymbolizer::Options Opts(ClPrintFunctions, ClUseSymbolTable, ClDemangle,
150                                ClUseRelativeAddress, ClDefaultArch);
151 
152   for (const auto &hint : ClDsymHint) {
153     if (sys::path::extension(hint) == ".dSYM") {
154       Opts.DsymHints.push_back(hint);
155     } else {
156       errs() << "Warning: invalid dSYM hint: \"" << hint <<
157                 "\" (must have the '.dSYM' extension).\n";
158     }
159   }
160   LLVMSymbolizer Symbolizer(Opts);
161 
162   DIPrinter Printer(outs(), ClPrintFunctions != FunctionNameKind::None,
163                     ClPrettyPrint, ClPrintSourceContextLines);
164 
165   const int kMaxInputStringLength = 1024;
166   char InputString[kMaxInputStringLength];
167 
168   while (true) {
169     if (!fgets(InputString, sizeof(InputString), stdin))
170       break;
171 
172     bool IsData = false;
173     std::string ModuleName;
174     uint64_t ModuleOffset = 0;
175     if (!parseCommand(StringRef(InputString), IsData, ModuleName,
176                       ModuleOffset)) {
177       outs() << InputString;
178       continue;
179     }
180 
181     if (ClPrintAddress) {
182       outs() << "0x";
183       outs().write_hex(ModuleOffset);
184       StringRef Delimiter = (ClPrettyPrint == true) ? ": " : "\n";
185       outs() << Delimiter;
186     }
187     if (IsData) {
188       auto ResOrErr = Symbolizer.symbolizeData(ModuleName, ModuleOffset);
189       Printer << (error(ResOrErr) ? DIGlobal() : ResOrErr.get());
190     } else if (ClPrintInlining) {
191       auto ResOrErr = Symbolizer.symbolizeInlinedCode(ModuleName, ModuleOffset);
192       Printer << (error(ResOrErr) ? DIInliningInfo()
193                                              : ResOrErr.get());
194     } else {
195       auto ResOrErr = Symbolizer.symbolizeCode(ModuleName, ModuleOffset);
196       Printer << (error(ResOrErr) ? DILineInfo() : ResOrErr.get());
197     }
198     outs() << "\n";
199     outs().flush();
200   }
201 
202   return 0;
203 }
204