tools/llvm-symbolizer/llvm-symbolizer.cpp

   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 "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"
  30 #include <cstdio>
  31 #include <cstring>
  32 #include <string>
  33
  34 using namespace llvm;
  35 using namespace symbolize;
  36
  37 static cl::opt<bool>
  38 ClUseSymbolTable("use-symbol-table", cl::init(true),
  39                  cl::desc("Prefer names in symbol table to names "
  40                           "in debug info"));
  41
  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"),
  50                clEnumValEnd));
  51
  52 static cl::opt<bool>
  53     ClUseRelativeAddress("relative-address", cl::init(false),
  54                          cl::desc("Interpret addresses as relative addresses"),
  55                          cl::ReallyHidden);
  56
  57 static cl::opt<bool>
  58     ClPrintInlining("inlining", cl::init(true),
  59                     cl::desc("Print all inlined frames for a given address"));
  60
  61 static cl::opt<bool>
  62 ClDemangle("demangle", cl::init(true), cl::desc("Demangle function names"));
  63
  64 static cl::opt<std::string> ClDefaultArch("default-arch", cl::init(""),
  65                                           cl::desc("Default architecture "
  66                                                    "(for multi-arch objects)"));
  67
  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)"));
  72
  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 "
  76                     "object files"));
  77 static cl::opt<bool>
  78     ClPrintAddress("print-address", cl::init(false),
  79                    cl::desc("Show address before line information"));
  80
  81 static cl::opt<bool>
  82     ClPrettyPrint("pretty-print", cl::init(false),
  83                   cl::desc("Make the output more human friendly"));
  84
  85 static bool error(std::error_code ec) {
  86   if (!ec)
  87     return false;
  88   errs() << "LLVMSymbolizer: error reading file: " << ec.message() << ".\n";
  89   return true;
  90 }
  91
  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";
  97   IsData = false;
  98   ModuleName = "";
  99   const char *pos = InputString.data();
 100   if (strncmp(pos, kDataCmd, strlen(kDataCmd)) == 0) {
 101     IsData = true;
 102     pos += strlen(kDataCmd);
 103   } else if (strncmp(pos, kCodeCmd, strlen(kCodeCmd)) == 0) {
 104     IsData = false;
 105     pos += strlen(kCodeCmd);
 106   } else {
 107     // If no cmd, assume it's CODE.
 108     IsData = false;
 109   }
 110   // Skip delimiters and parse input filename (if needed).
 111   if (ClBinaryName == "") {
 112     pos += strspn(pos, kDelimiters);
 113     if (*pos == '"' || *pos == '\'') {
 114       char quote = *pos;
 115       pos++;
 116       const char *end = strchr(pos, quote);
 117       if (!end)
 118         return false;
 119       ModuleName = std::string(pos, end - pos);
 120       pos = end + 1;
 121     } else {
 122       int name_length = strcspn(pos, kDelimiters);
 123       ModuleName = std::string(pos, name_length);
 124       pos += name_length;
 125     }
 126   } else {
 127     ModuleName = ClBinaryName;
 128   }
 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);
 133 }
 134
 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.
 140
 141   llvm::sys::InitializeCOMRAII COM(llvm::sys::COMThreadingMode::MultiThreaded);
 142
 143   cl::ParseCommandLineOptions(argc, argv, "llvm-symbolizer\n");
 144   LLVMSymbolizer::Options Opts(ClPrintFunctions, ClUseSymbolTable, ClDemangle,
 145                                ClUseRelativeAddress, ClDefaultArch);
 146
 147   for (const auto &hint : ClDsymHint) {
 148     if (sys::path::extension(hint) == ".dSYM") {
 149       Opts.DsymHints.push_back(hint);
 150     } else {
 151       errs() << "Warning: invalid dSYM hint: \"" << hint <<
 152                 "\" (must have the '.dSYM' extension).\n";
 153     }
 154   }
 155   LLVMSymbolizer Symbolizer(Opts);
 156
 157   DIPrinter Printer(outs(), ClPrintFunctions != FunctionNameKind::None,
 158                     ClPrettyPrint);
 159
 160   const int kMaxInputStringLength = 1024;
 161   char InputString[kMaxInputStringLength];
 162
 163   while (true) {
 164     if (!fgets(InputString, sizeof(InputString), stdin))
 165       break;
 166
 167     bool IsData = false;
 168     std::string ModuleName;
 169     uint64_t ModuleOffset = 0;
 170     if (!parseCommand(StringRef(InputString), IsData, ModuleName,
 171                       ModuleOffset)) {
 172       outs() << InputString;
 173       continue;
 174     }
 175
 176     if (ClPrintAddress) {
 177       outs() << "0x";
 178       outs().write_hex(ModuleOffset);
 179       StringRef Delimiter = (ClPrettyPrint == true) ? ": " : "\n";
 180       outs() << Delimiter;
 181     }
 182     if (IsData) {
 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()
 188                                              : ResOrErr.get());
 189     } else {
 190       auto ResOrErr = Symbolizer.symbolizeCode(ModuleName, ModuleOffset);
 191       Printer << (error(ResOrErr.getError()) ? DILineInfo() : ResOrErr.get());
 192     }
 193     outs() << "\n";
 194     outs().flush();
 195   }
 196
 197   return 0;
 198 }