llvm-symbolizer.cpp revision 288943 
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 "LLVMSymbolize.h"
19#include "llvm/ADT/StringRef.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/ManagedStatic.h"
25#include "llvm/Support/Path.h"
26#include "llvm/Support/PrettyStackTrace.h"
27#include "llvm/Support/Signals.h"
28#include "llvm/Support/raw_ostream.h"
29#include <cstdio>
30#include <cstring>
31#include <string>
32
33using namespace llvm;
34using namespace symbolize;
35
36static cl::opt<bool>
37ClUseSymbolTable("use-symbol-table", cl::init(true),
38                 cl::desc("Prefer names in symbol table to names "
39                          "in debug info"));
40
41static cl::opt<FunctionNameKind> ClPrintFunctions(
42    "functions", cl::init(FunctionNameKind::LinkageName),
43    cl::desc("Print function name for a given address:"),
44    cl::values(clEnumValN(FunctionNameKind::None, "none", "omit function name"),
45               clEnumValN(FunctionNameKind::ShortName, "short",
46                          "print short function name"),
47               clEnumValN(FunctionNameKind::LinkageName, "linkage",
48                          "print function linkage name"),
49               clEnumValEnd));
50
51static cl::opt<bool>
52    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"));
59
60static cl::opt<bool>
61ClDemangle("demangle", cl::init(true), cl::desc("Demangle function names"));
62
63static cl::opt<std::string> ClDefaultArch("default-arch", cl::init(""),
64                                          cl::desc("Default architecture "
65                                                   "(for multi-arch objects)"));
66
67static 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
72static 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"));
76
77static bool parseCommand(bool &IsData, std::string &ModuleName,
78                         uint64_t &ModuleOffset) {
79  const char *kDataCmd = "DATA ";
80  const char *kCodeCmd = "CODE ";
81  const int kMaxInputStringLength = 1024;
82  const char kDelimiters[] = " \n";
83  char InputString[kMaxInputStringLength];
84  if (!fgets(InputString, sizeof(InputString), stdin))
85    return false;
86  IsData = false;
87  ModuleName = "";
88  char *pos = InputString;
89  if (strncmp(pos, kDataCmd, strlen(kDataCmd)) == 0) {
90    IsData = true;
91    pos += strlen(kDataCmd);
92  } else if (strncmp(pos, kCodeCmd, strlen(kCodeCmd)) == 0) {
93    IsData = false;
94    pos += strlen(kCodeCmd);
95  } else {
96    // If no cmd, assume it's CODE.
97    IsData = false;
98  }
99  // Skip delimiters and parse input filename (if needed).
100  if (ClBinaryName == "") {
101    pos += strspn(pos, kDelimiters);
102    if (*pos == '"' || *pos == '\'') {
103      char quote = *pos;
104      pos++;
105      char *end = strchr(pos, quote);
106      if (!end)
107        return false;
108      ModuleName = std::string(pos, end - pos);
109      pos = end + 1;
110    } else {
111      int name_length = strcspn(pos, kDelimiters);
112      ModuleName = std::string(pos, name_length);
113      pos += name_length;
114    }
115  } else {
116    ModuleName = ClBinaryName;
117  }
118  // Skip delimiters and parse module offset.
119  pos += strspn(pos, kDelimiters);
120  int offset_length = strcspn(pos, kDelimiters);
121  if (StringRef(pos, offset_length).getAsInteger(0, ModuleOffset))
122    return false;
123  return true;
124}
125
126int main(int argc, char **argv) {
127  // Print stack trace if we signal out.
128  sys::PrintStackTraceOnErrorSignal();
129  PrettyStackTraceProgram X(argc, argv);
130  llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
131
132  llvm::sys::InitializeCOMRAII COM(llvm::sys::COMThreadingMode::MultiThreaded);
133
134  cl::ParseCommandLineOptions(argc, argv, "llvm-symbolizer\n");
135  LLVMSymbolizer::Options Opts(ClPrintFunctions, ClUseSymbolTable,
136                               ClPrintInlining, ClDemangle,
137                               ClUseRelativeAddress, ClDefaultArch);
138  for (const auto &hint : ClDsymHint) {
139    if (sys::path::extension(hint) == ".dSYM") {
140      Opts.DsymHints.push_back(hint);
141    } else {
142      errs() << "Warning: invalid dSYM hint: \"" << hint <<
143                "\" (must have the '.dSYM' extension).\n";
144    }
145  }
146  LLVMSymbolizer Symbolizer(Opts);
147
148  bool IsData = false;
149  std::string ModuleName;
150  uint64_t ModuleOffset;
151  while (parseCommand(IsData, ModuleName, ModuleOffset)) {
152    std::string Result =
153        IsData ? Symbolizer.symbolizeData(ModuleName, ModuleOffset)
154               : Symbolizer.symbolizeCode(ModuleName, ModuleOffset);
155    outs() << Result << "\n";
156    outs().flush();
157  }
158
159  return 0;
160}
161