tools/llvm-dwarfdump/llvm-dwarfdump.cpp

   1 //===-- llvm-dwarfdump.cpp - Debug info dumping utility for llvm -----------===//
   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 program is a utility that works like "dwarfdump".
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "llvm/ADT/OwningPtr.h"
  15 #include "llvm/ADT/Triple.h"
  16 #include "llvm/ADT/STLExtras.h"
  17 #include "llvm/Object/ObjectFile.h"
  18 #include "llvm/DebugInfo/DIContext.h"
  19 #include "llvm/Support/CommandLine.h"
  20 #include "llvm/Support/Debug.h"
  21 #include "llvm/Support/Format.h"
  22 #include "llvm/Support/ManagedStatic.h"
  23 #include "llvm/Support/MemoryBuffer.h"
  24 #include "llvm/Support/MemoryObject.h"
  25 #include "llvm/Support/PrettyStackTrace.h"
  26 #include "llvm/Support/Signals.h"
  27 #include "llvm/Support/raw_ostream.h"
  28 #include "llvm/Support/system_error.h"
  29 #include <algorithm>
  30 #include <cstring>
  31 using namespace llvm;
  32 using namespace object;
  33
  34 static cl::list<std::string>
  35 InputFilenames(cl::Positional, cl::desc("<input object files>"),
  36                cl::ZeroOrMore);
  37
  38 static cl::opt<unsigned long long>
  39 Address("address", cl::init(-1ULL),
  40         cl::desc("Print line information for a given address"));
  41
  42 static cl::opt<bool>
  43 PrintFunctions("functions", cl::init(false),
  44                cl::desc("Print function names as well as line information "
  45                         "for a given address"));
  46
  47 static void DumpInput(const StringRef &Filename) {
  48   OwningPtr<MemoryBuffer> Buff;
  49
  50   if (error_code ec = MemoryBuffer::getFileOrSTDIN(Filename, Buff)) {
  51     errs() << Filename << ": " << ec.message() << "\n";
  52     return;
  53   }
  54
  55   OwningPtr<ObjectFile> Obj(ObjectFile::createObjectFile(Buff.take()));
  56
  57   StringRef DebugInfoSection;
  58   StringRef DebugAbbrevSection;
  59   StringRef DebugLineSection;
  60   StringRef DebugArangesSection;
  61   StringRef DebugStringSection;
  62
  63   error_code ec;
  64   for (section_iterator i = Obj->begin_sections(),
  65                         e = Obj->end_sections();
  66                         i != e; i.increment(ec)) {
  67     StringRef name;
  68     i->getName(name);
  69     StringRef data;
  70     i->getContents(data);
  71
  72     if (name.startswith("__DWARF,"))
  73       name = name.substr(8); // Skip "__DWARF," prefix.
  74     name = name.substr(name.find_first_not_of("._")); // Skip . and _ prefixes.
  75     if (name == "debug_info")
  76       DebugInfoSection = data;
  77     else if (name == "debug_abbrev")
  78       DebugAbbrevSection = data;
  79     else if (name == "debug_line")
  80       DebugLineSection = data;
  81     else if (name == "debug_aranges")
  82       DebugArangesSection = data;
  83     else if (name == "debug_str")
  84       DebugStringSection = data;
  85   }
  86
  87   OwningPtr<DIContext> dictx(DIContext::getDWARFContext(/*FIXME*/true,
  88                                                         DebugInfoSection,
  89                                                         DebugAbbrevSection,
  90                                                         DebugArangesSection,
  91                                                         DebugLineSection,
  92                                                         DebugStringSection));
  93   if (Address == -1ULL) {
  94     outs() << Filename
  95            << ":\tfile format " << Obj->getFileFormatName() << "\n\n";
  96     // Dump the complete DWARF structure.
  97     dictx->dump(outs());
  98   } else {
  99     // Print line info for the specified address.
 100     int spec_flags = DILineInfoSpecifier::FileLineInfo |
 101                      DILineInfoSpecifier::AbsoluteFilePath;
 102     if (PrintFunctions)
 103       spec_flags |= DILineInfoSpecifier::FunctionName;
 104     DILineInfo dli = dictx->getLineInfoForAddress(Address, spec_flags);
 105     if (PrintFunctions)
 106       outs() << (dli.getFunctionName() ? dli.getFunctionName() : "<unknown>")
 107              << "\n";
 108     outs() << (dli.getFileName() ? dli.getFileName() : "<unknown>") << ':'
 109            << dli.getLine() << ':' << dli.getColumn() << '\n';
 110   }
 111 }
 112
 113 int main(int argc, char **argv) {
 114   // Print a stack trace if we signal out.
 115   sys::PrintStackTraceOnErrorSignal();
 116   PrettyStackTraceProgram X(argc, argv);
 117   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
 118
 119   cl::ParseCommandLineOptions(argc, argv, "llvm dwarf dumper\n");
 120
 121   // Defaults to a.out if no filenames specified.
 122   if (InputFilenames.size() == 0)
 123     InputFilenames.push_back("a.out");
 124
 125   std::for_each(InputFilenames.begin(), InputFilenames.end(), DumpInput);
 126
 127   return 0;
 128 }