blob: c9e0cc2b3b05cf99fe1cb553b19857ab566c5d5e [file] [log] [blame]
Alexander Potapenko8c07f552012-11-12 11:33:29 +00001//===-- 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
Alexander Potapenko8c07f552012-11-12 11:33:29 +000018#include "llvm/ADT/StringRef.h"
Alexey Samsonovd6aa8202015-11-03 22:20:52 +000019#include "llvm/DebugInfo/Symbolize/DIPrinter.h"
Alexey Samsonov57f88372015-10-26 17:56:12 +000020#include "llvm/DebugInfo/Symbolize/Symbolize.h"
Zachary Turner20dbd0d2015-04-27 17:19:51 +000021#include "llvm/Support/COM.h"
Alexander Potapenko8c07f552012-11-12 11:33:29 +000022#include "llvm/Support/CommandLine.h"
23#include "llvm/Support/Debug.h"
Alexander Potapenko7aaf5142014-10-17 00:50:19 +000024#include "llvm/Support/FileSystem.h"
Alexander Potapenko8c07f552012-11-12 11:33:29 +000025#include "llvm/Support/ManagedStatic.h"
Benjamin Kramer16132e62015-03-23 18:07:13 +000026#include "llvm/Support/Path.h"
Alexander Potapenko8c07f552012-11-12 11:33:29 +000027#include "llvm/Support/PrettyStackTrace.h"
28#include "llvm/Support/Signals.h"
29#include "llvm/Support/raw_ostream.h"
Alexander Potapenko8c07f552012-11-12 11:33:29 +000030#include <cstdio>
31#include <cstring>
Alexander Potapenko8c07f552012-11-12 11:33:29 +000032#include <string>
33
34using namespace llvm;
Alexey Samsonovea83baf2013-01-22 14:21:19 +000035using namespace symbolize;
Alexander Potapenko8c07f552012-11-12 11:33:29 +000036
37static cl::opt<bool>
Alexey Samsonovea83baf2013-01-22 14:21:19 +000038ClUseSymbolTable("use-symbol-table", cl::init(true),
Alexey Samsonovd5d7bb52013-02-15 08:54:47 +000039 cl::desc("Prefer names in symbol table to names "
40 "in debug info"));
Alexander Potapenko8c07f552012-11-12 11:33:29 +000041
Alexey Samsonovcd014722014-05-17 00:07:48 +000042static 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",
Mehdi Amini732afdd2016-10-08 19:41:06 +000049 "print function linkage name")));
Alexander Potapenko8c07f552012-11-12 11:33:29 +000050
51static cl::opt<bool>
Zachary Turnerc007aa42015-05-06 22:26:30 +000052 ClUseRelativeAddress("relative-address", cl::init(false),
53 cl::desc("Interpret addresses as relative addresses"),
54 cl::ReallyHidden);
55
56static cl::opt<bool>
57 ClPrintInlining("inlining", cl::init(true),
58 cl::desc("Print all inlined frames for a given address"));
Alexander Potapenko8c07f552012-11-12 11:33:29 +000059
60static cl::opt<bool>
Alexey Samsonovd5d7bb52013-02-15 08:54:47 +000061ClDemangle("demangle", cl::init(true), cl::desc("Demangle function names"));
Alexander Potapenko8c07f552012-11-12 11:33:29 +000062
Alexey Samsonov2ca65362013-06-28 08:15:40 +000063static cl::opt<std::string> ClDefaultArch("default-arch", cl::init(""),
64 cl::desc("Default architecture "
65 "(for multi-arch objects)"));
66
Alexey Samsonov60e59e22013-12-24 19:33:22 +000067static cl::opt<std::string>
68ClBinaryName("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
Alexander Potapenko7aaf5142014-10-17 00:50:19 +000072static cl::list<std::string>
73ClDsymHint("dsym-hint", cl::ZeroOrMore,
74 cl::desc("Path to .dSYM bundles to search for debug info for the "
75 "object files"));
Hemant Kulkarni80f82fb2015-10-12 19:26:44 +000076static cl::opt<bool>
77 ClPrintAddress("print-address", cl::init(false),
78 cl::desc("Show address before line information"));
Alexander Potapenko7aaf5142014-10-17 00:50:19 +000079
Hemant Kulkarnibdce12a2015-11-11 20:41:43 +000080static cl::opt<bool>
81 ClPrettyPrint("pretty-print", cl::init(false),
82 cl::desc("Make the output more human friendly"));
83
Mike Aizatsky17dbc282016-01-09 00:14:35 +000084static cl::opt<int> ClPrintSourceContextLines(
85 "print-source-context-lines", cl::init(0),
86 cl::desc("Print N number of source file context"));
87
David Blaikie0012dd52017-01-31 22:19:38 +000088static cl::opt<bool> ClVerbose("verbose", cl::init(false),
89 cl::desc("Print verbose line info"));
90
Reid Klecknerf27f3f82016-06-03 20:25:09 +000091template<typename T>
92static bool error(Expected<T> &ResOrErr) {
93 if (ResOrErr)
Alexey Samsonov884adda2015-11-04 00:30:24 +000094 return false;
Reid Klecknerf27f3f82016-06-03 20:25:09 +000095 logAllUnhandledErrors(ResOrErr.takeError(), errs(),
96 "LLVMSymbolizer: error reading file: ");
Alexey Samsonov884adda2015-11-04 00:30:24 +000097 return true;
98}
99
Mike Aizatsky54a7c692016-01-07 23:57:41 +0000100static bool parseCommand(StringRef InputString, bool &IsData,
101 std::string &ModuleName, uint64_t &ModuleOffset) {
Dmitry Vyukovd08bd132013-01-11 07:16:20 +0000102 const char *kDataCmd = "DATA ";
103 const char *kCodeCmd = "CODE ";
Mike Aizatsky54a7c692016-01-07 23:57:41 +0000104 const char kDelimiters[] = " \n\r";
Dmitry Vyukovd08bd132013-01-11 07:16:20 +0000105 IsData = false;
Alexander Potapenko8c07f552012-11-12 11:33:29 +0000106 ModuleName = "";
Mike Aizatsky54a7c692016-01-07 23:57:41 +0000107 const char *pos = InputString.data();
Dmitry Vyukovd08bd132013-01-11 07:16:20 +0000108 if (strncmp(pos, kDataCmd, strlen(kDataCmd)) == 0) {
109 IsData = true;
110 pos += strlen(kDataCmd);
111 } else if (strncmp(pos, kCodeCmd, strlen(kCodeCmd)) == 0) {
112 IsData = false;
113 pos += strlen(kCodeCmd);
114 } else {
115 // If no cmd, assume it's CODE.
116 IsData = false;
117 }
Alexey Samsonov60e59e22013-12-24 19:33:22 +0000118 // Skip delimiters and parse input filename (if needed).
119 if (ClBinaryName == "") {
120 pos += strspn(pos, kDelimiters);
121 if (*pos == '"' || *pos == '\'') {
122 char quote = *pos;
123 pos++;
Mike Aizatsky54a7c692016-01-07 23:57:41 +0000124 const char *end = strchr(pos, quote);
Craig Toppere6cb63e2014-04-25 04:24:47 +0000125 if (!end)
Alexey Samsonov60e59e22013-12-24 19:33:22 +0000126 return false;
127 ModuleName = std::string(pos, end - pos);
128 pos = end + 1;
129 } else {
130 int name_length = strcspn(pos, kDelimiters);
131 ModuleName = std::string(pos, name_length);
132 pos += name_length;
133 }
Alexey Samsonovd2069322013-04-05 09:22:24 +0000134 } else {
Alexey Samsonov60e59e22013-12-24 19:33:22 +0000135 ModuleName = ClBinaryName;
Alexander Potapenko8c07f552012-11-12 11:33:29 +0000136 }
Alexey Samsonovd2069322013-04-05 09:22:24 +0000137 // Skip delimiters and parse module offset.
138 pos += strspn(pos, kDelimiters);
139 int offset_length = strcspn(pos, kDelimiters);
Rafael Espindola2c5bcc52015-10-24 23:23:25 +0000140 return !StringRef(pos, offset_length).getAsInteger(0, ModuleOffset);
Alexander Potapenko8c07f552012-11-12 11:33:29 +0000141}
142
143int main(int argc, char **argv) {
144 // Print stack trace if we signal out.
Richard Smith2ad6d482016-06-09 00:53:21 +0000145 sys::PrintStackTraceOnErrorSignal(argv[0]);
Alexander Potapenko8c07f552012-11-12 11:33:29 +0000146 PrettyStackTraceProgram X(argc, argv);
Alexey Samsonovd5d7bb52013-02-15 08:54:47 +0000147 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
Alexander Potapenko8c07f552012-11-12 11:33:29 +0000148
Zachary Turner20dbd0d2015-04-27 17:19:51 +0000149 llvm::sys::InitializeCOMRAII COM(llvm::sys::COMThreadingMode::MultiThreaded);
150
Alexey Samsonov60e59e22013-12-24 19:33:22 +0000151 cl::ParseCommandLineOptions(argc, argv, "llvm-symbolizer\n");
Alexey Samsonov46c1ce62015-10-30 00:40:20 +0000152 LLVMSymbolizer::Options Opts(ClPrintFunctions, ClUseSymbolTable, ClDemangle,
Zachary Turnerc007aa42015-05-06 22:26:30 +0000153 ClUseRelativeAddress, ClDefaultArch);
Hemant Kulkarnibdce12a2015-11-11 20:41:43 +0000154
Alexander Potapenko7aaf5142014-10-17 00:50:19 +0000155 for (const auto &hint : ClDsymHint) {
156 if (sys::path::extension(hint) == ".dSYM") {
157 Opts.DsymHints.push_back(hint);
158 } else {
159 errs() << "Warning: invalid dSYM hint: \"" << hint <<
160 "\" (must have the '.dSYM' extension).\n";
161 }
162 }
Alexey Samsonovea83baf2013-01-22 14:21:19 +0000163 LLVMSymbolizer Symbolizer(Opts);
Alexander Potapenko8c07f552012-11-12 11:33:29 +0000164
Hemant Kulkarnibdce12a2015-11-11 20:41:43 +0000165 DIPrinter Printer(outs(), ClPrintFunctions != FunctionNameKind::None,
David Blaikie0012dd52017-01-31 22:19:38 +0000166 ClPrettyPrint, ClPrintSourceContextLines, ClVerbose);
Alexey Samsonovd6aa8202015-11-03 22:20:52 +0000167
Mike Aizatsky54a7c692016-01-07 23:57:41 +0000168 const int kMaxInputStringLength = 1024;
169 char InputString[kMaxInputStringLength];
170
171 while (true) {
172 if (!fgets(InputString, sizeof(InputString), stdin))
173 break;
174
175 bool IsData = false;
176 std::string ModuleName;
177 uint64_t ModuleOffset = 0;
178 if (!parseCommand(StringRef(InputString), IsData, ModuleName,
179 ModuleOffset)) {
180 outs() << InputString;
181 continue;
182 }
183
Hemant Kulkarni80f82fb2015-10-12 19:26:44 +0000184 if (ClPrintAddress) {
185 outs() << "0x";
186 outs().write_hex(ModuleOffset);
Hemant Kulkarnibdce12a2015-11-11 20:41:43 +0000187 StringRef Delimiter = (ClPrettyPrint == true) ? ": " : "\n";
188 outs() << Delimiter;
Hemant Kulkarni80f82fb2015-10-12 19:26:44 +0000189 }
Alexey Samsonovd6aa8202015-11-03 22:20:52 +0000190 if (IsData) {
Alexey Samsonov884adda2015-11-04 00:30:24 +0000191 auto ResOrErr = Symbolizer.symbolizeData(ModuleName, ModuleOffset);
Reid Klecknerf27f3f82016-06-03 20:25:09 +0000192 Printer << (error(ResOrErr) ? DIGlobal() : ResOrErr.get());
Alexey Samsonovd6aa8202015-11-03 22:20:52 +0000193 } else if (ClPrintInlining) {
Alexey Samsonov884adda2015-11-04 00:30:24 +0000194 auto ResOrErr = Symbolizer.symbolizeInlinedCode(ModuleName, ModuleOffset);
Reid Klecknerf27f3f82016-06-03 20:25:09 +0000195 Printer << (error(ResOrErr) ? DIInliningInfo()
Alexey Samsonov884adda2015-11-04 00:30:24 +0000196 : ResOrErr.get());
Alexey Samsonovd6aa8202015-11-03 22:20:52 +0000197 } else {
Alexey Samsonov884adda2015-11-04 00:30:24 +0000198 auto ResOrErr = Symbolizer.symbolizeCode(ModuleName, ModuleOffset);
Reid Klecknerf27f3f82016-06-03 20:25:09 +0000199 Printer << (error(ResOrErr) ? DILineInfo() : ResOrErr.get());
Alexey Samsonovd6aa8202015-11-03 22:20:52 +0000200 }
201 outs() << "\n";
Alexey Samsonovea83baf2013-01-22 14:21:19 +0000202 outs().flush();
Alexander Potapenko8c07f552012-11-12 11:33:29 +0000203 }
Zachary Turner20dbd0d2015-04-27 17:19:51 +0000204
Alexander Potapenko8c07f552012-11-12 11:33:29 +0000205 return 0;
206}