llvm-symbolizer.cpp revision 261991 
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/CommandLine.h"
21#include "llvm/Support/Debug.h"
22#include "llvm/Support/ManagedStatic.h"
23#include "llvm/Support/PrettyStackTrace.h"
24#include "llvm/Support/Signals.h"
25#include "llvm/Support/raw_ostream.h"
26#include <cstdio>
27#include <cstring>
28#include <string>
29
30using namespace llvm;
31using namespace symbolize;
32
33static cl::opt<bool>
34ClUseSymbolTable("use-symbol-table", cl::init(true),
35                 cl::desc("Prefer names in symbol table to names "
36                          "in debug info"));
37
38static cl::opt<bool>
39ClPrintFunctions("functions", cl::init(true),
40                 cl::desc("Print function names as well as line "
41                          "information for a given address"));
42
43static cl::opt<bool>
44ClPrintInlining("inlining", cl::init(true),
45                cl::desc("Print all inlined frames for a given address"));
46
47static cl::opt<bool>
48ClDemangle("demangle", cl::init(true), cl::desc("Demangle function names"));
49
50static cl::opt<std::string> ClDefaultArch("default-arch", cl::init(""),
51                                          cl::desc("Default architecture "
52                                                   "(for multi-arch objects)"));
53
54static bool parseCommand(bool &IsData, std::string &ModuleName,
55                         uint64_t &ModuleOffset) {
56  const char *kDataCmd = "DATA ";
57  const char *kCodeCmd = "CODE ";
58  const int kMaxInputStringLength = 1024;
59  const char kDelimiters[] = " \n";
60  char InputString[kMaxInputStringLength];
61  if (!fgets(InputString, sizeof(InputString), stdin))
62    return false;
63  IsData = false;
64  ModuleName = "";
65  std::string ModuleOffsetStr = "";
66  char *pos = InputString;
67  if (strncmp(pos, kDataCmd, strlen(kDataCmd)) == 0) {
68    IsData = true;
69    pos += strlen(kDataCmd);
70  } else if (strncmp(pos, kCodeCmd, strlen(kCodeCmd)) == 0) {
71    IsData = false;
72    pos += strlen(kCodeCmd);
73  } else {
74    // If no cmd, assume it's CODE.
75    IsData = false;
76  }
77  // Skip delimiters and parse input filename.
78  pos += strspn(pos, kDelimiters);
79  if (*pos == '"' || *pos == '\'') {
80    char quote = *pos;
81    pos++;
82    char *end = strchr(pos, quote);
83    if (end == 0)
84      return false;
85    ModuleName = std::string(pos, end - pos);
86    pos = end + 1;
87  } else {
88    int name_length = strcspn(pos, kDelimiters);
89    ModuleName = std::string(pos, name_length);
90    pos += name_length;
91  }
92  // Skip delimiters and parse module offset.
93  pos += strspn(pos, kDelimiters);
94  int offset_length = strcspn(pos, kDelimiters);
95  ModuleOffsetStr = std::string(pos, offset_length);
96  if (StringRef(ModuleOffsetStr).getAsInteger(0, ModuleOffset))
97    return false;
98  return true;
99}
100
101int main(int argc, char **argv) {
102  // Print stack trace if we signal out.
103  sys::PrintStackTraceOnErrorSignal();
104  PrettyStackTraceProgram X(argc, argv);
105  llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
106
107  cl::ParseCommandLineOptions(argc, argv, "llvm symbolizer for compiler-rt\n");
108  LLVMSymbolizer::Options Opts(ClUseSymbolTable, ClPrintFunctions,
109                               ClPrintInlining, ClDemangle, ClDefaultArch);
110  LLVMSymbolizer Symbolizer(Opts);
111
112  bool IsData = false;
113  std::string ModuleName;
114  uint64_t ModuleOffset;
115  while (parseCommand(IsData, ModuleName, ModuleOffset)) {
116    std::string Result =
117        IsData ? Symbolizer.symbolizeData(ModuleName, ModuleOffset)
118               : Symbolizer.symbolizeCode(ModuleName, ModuleOffset);
119    outs() << Result << "\n";
120    outs().flush();
121  }
122  return 0;
123}
124