1 //===-- llvm-symbolizer.cpp - Simple addr2line-like symbolizer ------------===//
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //===----------------------------------------------------------------------===//
9 // This utility works much like "addr2line". It is able of transforming
10 // tuples (module name, module offset) to code locations (function name,
11 // file, line number, column number). It is targeted for compiler-rt tools
12 // (especially AddressSanitizer and ThreadSanitizer) that can use it
13 // to symbolize stack traces in their error reports.
15 //===----------------------------------------------------------------------===//
17 #include "llvm/ADT/StringRef.h"
18 #include "llvm/DebugInfo/Symbolize/DIPrinter.h"
19 #include "llvm/DebugInfo/Symbolize/Symbolize.h"
20 #include "llvm/Support/COM.h"
21 #include "llvm/Support/CommandLine.h"
22 #include "llvm/Support/Debug.h"
23 #include "llvm/Support/FileSystem.h"
24 #include "llvm/Support/InitLLVM.h"
25 #include "llvm/Support/Path.h"
26 #include "llvm/Support/raw_ostream.h"
32 using namespace symbolize;
35 ClUseSymbolTable("use-symbol-table", cl::init(true),
36 cl::desc("Prefer names in symbol table to names "
39 static cl::opt<FunctionNameKind> ClPrintFunctions(
40 "functions", cl::init(FunctionNameKind::LinkageName),
41 cl::desc("Print function name for a given address"), cl::ValueOptional,
42 cl::values(clEnumValN(FunctionNameKind::None, "none", "omit function name"),
43 clEnumValN(FunctionNameKind::ShortName, "short",
44 "print short function name"),
45 clEnumValN(FunctionNameKind::LinkageName, "linkage",
46 "print function linkage name"),
47 // Sentinel value for unspecified value.
48 clEnumValN(FunctionNameKind::LinkageName, "", "")));
49 static cl::alias ClPrintFunctionsShort("f", cl::desc("Alias for -functions"),
50 cl::NotHidden, cl::Grouping,
51 cl::aliasopt(ClPrintFunctions));
54 ClUseRelativeAddress("relative-address", cl::init(false),
55 cl::desc("Interpret addresses as relative addresses"),
59 ClPrintInlining("inlining", cl::init(true),
60 cl::desc("Print all inlined frames for a given address"));
62 ClPrintInliningAliasI("i", cl::desc("Alias for -inlining"),
63 cl::NotHidden, cl::aliasopt(ClPrintInlining),
66 ClPrintInliningAliasInlines("inlines", cl::desc("Alias for -inlining"),
67 cl::NotHidden, cl::aliasopt(ClPrintInlining));
70 static cl::opt<bool> ClBasenames("basenames", cl::init(false),
71 cl::desc("Strip directory names from paths"));
72 static cl::alias ClBasenamesShort("s", cl::desc("Alias for -basenames"),
73 cl::NotHidden, cl::aliasopt(ClBasenames));
75 // -demangle, -C, -no-demangle
77 ClDemangle("demangle", cl::init(true), cl::desc("Demangle function names"));
79 ClDemangleShort("C", cl::desc("Alias for -demangle"),
80 cl::NotHidden, cl::aliasopt(ClDemangle), cl::Grouping);
82 ClNoDemangle("no-demangle", cl::init(false),
83 cl::desc("Don't demangle function names"));
85 static cl::opt<std::string> ClDefaultArch("default-arch", cl::init(""),
86 cl::desc("Default architecture "
87 "(for multi-arch objects)"));
90 static cl::opt<std::string>
91 ClBinaryName("obj", cl::init(""),
92 cl::desc("Path to object file to be symbolized (if not provided, "
93 "object file should be specified for each input line)"));
95 ClBinaryNameAliasExe("exe", cl::desc("Alias for -obj"),
96 cl::NotHidden, cl::aliasopt(ClBinaryName));
97 static cl::alias ClBinaryNameAliasE("e", cl::desc("Alias for -obj"),
98 cl::NotHidden, cl::Grouping, cl::Prefix,
99 cl::aliasopt(ClBinaryName));
101 static cl::opt<std::string>
102 ClDwpName("dwp", cl::init(""),
103 cl::desc("Path to DWP file to be use for any split CUs"));
105 static cl::list<std::string>
106 ClDsymHint("dsym-hint", cl::ZeroOrMore,
107 cl::desc("Path to .dSYM bundles to search for debug info for the "
110 // -print-address, -addresses, -a
112 ClPrintAddress("print-address", cl::init(false),
113 cl::desc("Show address before line information"));
115 ClPrintAddressAliasAddresses("addresses", cl::desc("Alias for -print-address"),
116 cl::NotHidden, cl::aliasopt(ClPrintAddress));
118 ClPrintAddressAliasA("a", cl::desc("Alias for -print-address"),
119 cl::NotHidden, cl::aliasopt(ClPrintAddress), cl::Grouping);
123 ClPrettyPrint("pretty-print", cl::init(false),
124 cl::desc("Make the output more human friendly"));
125 static cl::alias ClPrettyPrintShort("p", cl::desc("Alias for -pretty-print"),
127 cl::aliasopt(ClPrettyPrint), cl::Grouping);
129 static cl::opt<int> ClPrintSourceContextLines(
130 "print-source-context-lines", cl::init(0),
131 cl::desc("Print N number of source file context"));
133 static cl::opt<bool> ClVerbose("verbose", cl::init(false),
134 cl::desc("Print verbose line info"));
137 static cl::opt<uint64_t>
138 ClAdjustVMA("adjust-vma", cl::init(0), cl::value_desc("offset"),
139 cl::desc("Add specified offset to object file addresses"));
141 static cl::list<std::string> ClInputAddresses(cl::Positional,
142 cl::desc("<input addresses>..."),
145 static cl::opt<std::string>
146 ClFallbackDebugPath("fallback-debug-path", cl::init(""),
147 cl::desc("Fallback path for debug binaries."));
149 static cl::opt<DIPrinter::OutputStyle>
150 ClOutputStyle("output-style", cl::init(DIPrinter::OutputStyle::LLVM),
151 cl::desc("Specify print style"),
152 cl::values(clEnumValN(DIPrinter::OutputStyle::LLVM, "LLVM",
153 "LLVM default style"),
154 clEnumValN(DIPrinter::OutputStyle::GNU, "GNU",
155 "GNU addr2line style")));
158 static bool error(Expected<T> &ResOrErr) {
161 logAllUnhandledErrors(ResOrErr.takeError(), errs(),
162 "LLVMSymbolizer: error reading file: ");
166 static bool parseCommand(StringRef InputString, bool &IsData,
167 std::string &ModuleName, uint64_t &ModuleOffset) {
168 const char kDelimiters[] = " \n\r";
170 if (InputString.consume_front("CODE ")) {
172 } else if (InputString.consume_front("DATA ")) {
175 // If no cmd, assume it's CODE.
178 const char *pos = InputString.data();
179 // Skip delimiters and parse input filename (if needed).
180 if (ClBinaryName.empty()) {
181 pos += strspn(pos, kDelimiters);
182 if (*pos == '"' || *pos == '\'') {
185 const char *end = strchr(pos, quote);
188 ModuleName = std::string(pos, end - pos);
191 int name_length = strcspn(pos, kDelimiters);
192 ModuleName = std::string(pos, name_length);
196 ModuleName = ClBinaryName;
198 // Skip delimiters and parse module offset.
199 pos += strspn(pos, kDelimiters);
200 int offset_length = strcspn(pos, kDelimiters);
201 return !StringRef(pos, offset_length).getAsInteger(0, ModuleOffset);
204 static void symbolizeInput(StringRef InputString, LLVMSymbolizer &Symbolizer,
205 DIPrinter &Printer) {
207 std::string ModuleName;
209 if (!parseCommand(StringRef(InputString), IsData, ModuleName, Offset)) {
210 outs() << InputString;
214 if (ClPrintAddress) {
216 outs().write_hex(Offset);
217 StringRef Delimiter = ClPrettyPrint ? ": " : "\n";
220 Offset -= ClAdjustVMA;
222 auto ResOrErr = Symbolizer.symbolizeData(
223 ModuleName, {Offset, object::SectionedAddress::UndefSection});
224 Printer << (error(ResOrErr) ? DIGlobal() : ResOrErr.get());
225 } else if (ClPrintInlining) {
226 auto ResOrErr = Symbolizer.symbolizeInlinedCode(
227 ModuleName, {Offset, object::SectionedAddress::UndefSection});
228 Printer << (error(ResOrErr) ? DIInliningInfo() : ResOrErr.get());
229 } else if (ClOutputStyle == DIPrinter::OutputStyle::GNU) {
230 // With ClPrintFunctions == FunctionNameKind::LinkageName (default)
231 // and ClUseSymbolTable == true (also default), Symbolizer.symbolizeCode()
232 // may override the name of an inlined function with the name of the topmost
233 // caller function in the inlining chain. This contradicts the existing
234 // behavior of addr2line. Symbolizer.symbolizeInlinedCode() overrides only
235 // the topmost function, which suits our needs better.
236 auto ResOrErr = Symbolizer.symbolizeInlinedCode(
237 ModuleName, {Offset, object::SectionedAddress::UndefSection});
238 Printer << (error(ResOrErr) ? DILineInfo() : ResOrErr.get().getFrame(0));
240 auto ResOrErr = Symbolizer.symbolizeCode(
241 ModuleName, {Offset, object::SectionedAddress::UndefSection});
242 Printer << (error(ResOrErr) ? DILineInfo() : ResOrErr.get());
244 if (ClOutputStyle == DIPrinter::OutputStyle::LLVM)
248 int main(int argc, char **argv) {
249 InitLLVM X(argc, argv);
251 bool IsAddr2Line = sys::path::stem(argv[0]).contains("addr2line");
254 ClDemangle.setInitialValue(false);
255 ClPrintFunctions.setInitialValue(FunctionNameKind::None);
256 ClPrintInlining.setInitialValue(false);
257 ClOutputStyle.setInitialValue(DIPrinter::OutputStyle::GNU);
260 llvm::sys::InitializeCOMRAII COM(llvm::sys::COMThreadingMode::MultiThreaded);
261 cl::ParseCommandLineOptions(argc, argv, IsAddr2Line ? "llvm-addr2line\n"
262 : "llvm-symbolizer\n");
264 // If both --demangle and --no-demangle are specified then pick the last one.
265 if (ClNoDemangle.getPosition() > ClDemangle.getPosition())
266 ClDemangle = !ClNoDemangle;
268 LLVMSymbolizer::Options Opts;
269 Opts.PrintFunctions = ClPrintFunctions;
270 Opts.UseSymbolTable = ClUseSymbolTable;
271 Opts.Demangle = ClDemangle;
272 Opts.RelativeAddresses = ClUseRelativeAddress;
273 Opts.DefaultArch = ClDefaultArch;
274 Opts.FallbackDebugPath = ClFallbackDebugPath;
275 Opts.DWPName = ClDwpName;
277 for (const auto &hint : ClDsymHint) {
278 if (sys::path::extension(hint) == ".dSYM") {
279 Opts.DsymHints.push_back(hint);
281 errs() << "Warning: invalid dSYM hint: \"" << hint <<
282 "\" (must have the '.dSYM' extension).\n";
285 LLVMSymbolizer Symbolizer(Opts);
287 DIPrinter Printer(outs(), ClPrintFunctions != FunctionNameKind::None,
288 ClPrettyPrint, ClPrintSourceContextLines, ClVerbose,
289 ClBasenames, ClOutputStyle);
291 if (ClInputAddresses.empty()) {
292 const int kMaxInputStringLength = 1024;
293 char InputString[kMaxInputStringLength];
295 while (fgets(InputString, sizeof(InputString), stdin)) {
296 symbolizeInput(InputString, Symbolizer, Printer);
300 for (StringRef Address : ClInputAddresses)
301 symbolizeInput(Address, Symbolizer, Printer);