1 //===-- llvm-symbolizer.cpp - Simple addr2line-like symbolizer ------------===//
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 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.
16 //===----------------------------------------------------------------------===//
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"
35 using namespace symbolize;
38 ClUseSymbolTable("use-symbol-table", cl::init(true),
39 cl::desc("Prefer names in symbol table to names "
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"),
53 ClUseRelativeAddress("relative-address", cl::init(false),
54 cl::desc("Interpret addresses as relative addresses"),
58 ClPrintInlining("inlining", cl::init(true),
59 cl::desc("Print all inlined frames for a given address"));
62 ClDemangle("demangle", cl::init(true), cl::desc("Demangle function names"));
64 static cl::opt<std::string> ClDefaultArch("default-arch", cl::init(""),
65 cl::desc("Default architecture "
66 "(for multi-arch objects)"));
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)"));
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 "
78 ClPrintAddress("print-address", cl::init(false),
79 cl::desc("Show address before line information"));
82 ClPrettyPrint("pretty-print", cl::init(false),
83 cl::desc("Make the output more human friendly"));
85 static bool error(std::error_code ec) {
88 errs() << "LLVMSymbolizer: error reading file: " << ec.message() << ".\n";
92 static bool parseCommand(StringRef InputString, bool &IsData,
93 std::string &ModuleName, uint64_t &ModuleOffset) {
94 const char *kDataCmd = "DATA ";
95 const char *kCodeCmd = "CODE ";
96 const char kDelimiters[] = " \n\r";
99 const char *pos = InputString.data();
100 if (strncmp(pos, kDataCmd, strlen(kDataCmd)) == 0) {
102 pos += strlen(kDataCmd);
103 } else if (strncmp(pos, kCodeCmd, strlen(kCodeCmd)) == 0) {
105 pos += strlen(kCodeCmd);
107 // If no cmd, assume it's CODE.
110 // Skip delimiters and parse input filename (if needed).
111 if (ClBinaryName == "") {
112 pos += strspn(pos, kDelimiters);
113 if (*pos == '"' || *pos == '\'') {
116 const char *end = strchr(pos, quote);
119 ModuleName = std::string(pos, end - pos);
122 int name_length = strcspn(pos, kDelimiters);
123 ModuleName = std::string(pos, name_length);
127 ModuleName = ClBinaryName;
129 // Skip delimiters and parse module offset.
130 pos += strspn(pos, kDelimiters);
131 int offset_length = strcspn(pos, kDelimiters);
132 return !StringRef(pos, offset_length).getAsInteger(0, ModuleOffset);
135 int main(int argc, char **argv) {
136 // Print stack trace if we signal out.
137 sys::PrintStackTraceOnErrorSignal();
138 PrettyStackTraceProgram X(argc, argv);
139 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
141 llvm::sys::InitializeCOMRAII COM(llvm::sys::COMThreadingMode::MultiThreaded);
143 cl::ParseCommandLineOptions(argc, argv, "llvm-symbolizer\n");
144 LLVMSymbolizer::Options Opts(ClPrintFunctions, ClUseSymbolTable, ClDemangle,
145 ClUseRelativeAddress, ClDefaultArch);
147 for (const auto &hint : ClDsymHint) {
148 if (sys::path::extension(hint) == ".dSYM") {
149 Opts.DsymHints.push_back(hint);
151 errs() << "Warning: invalid dSYM hint: \"" << hint <<
152 "\" (must have the '.dSYM' extension).\n";
155 LLVMSymbolizer Symbolizer(Opts);
157 DIPrinter Printer(outs(), ClPrintFunctions != FunctionNameKind::None,
160 const int kMaxInputStringLength = 1024;
161 char InputString[kMaxInputStringLength];
164 if (!fgets(InputString, sizeof(InputString), stdin))
168 std::string ModuleName;
169 uint64_t ModuleOffset = 0;
170 if (!parseCommand(StringRef(InputString), IsData, ModuleName,
172 outs() << InputString;
176 if (ClPrintAddress) {
178 outs().write_hex(ModuleOffset);
179 StringRef Delimiter = (ClPrettyPrint == true) ? ": " : "\n";
183 auto ResOrErr = Symbolizer.symbolizeData(ModuleName, ModuleOffset);
184 Printer << (error(ResOrErr.getError()) ? DIGlobal() : ResOrErr.get());
185 } else if (ClPrintInlining) {
186 auto ResOrErr = Symbolizer.symbolizeInlinedCode(ModuleName, ModuleOffset);
187 Printer << (error(ResOrErr.getError()) ? DIInliningInfo()
190 auto ResOrErr = Symbolizer.symbolizeCode(ModuleName, ModuleOffset);
191 Printer << (error(ResOrErr.getError()) ? DILineInfo() : ResOrErr.get());