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/Object/RelocVisitor.h"
  19 #include "llvm/DebugInfo/DIContext.h"
  20 #include "llvm/Support/CommandLine.h"
  21 #include "llvm/Support/Debug.h"
  22 #include "llvm/Support/Format.h"
  23 #include "llvm/Support/ManagedStatic.h"
  24 #include "llvm/Support/MemoryBuffer.h"
  25 #include "llvm/Support/MemoryObject.h"
  26 #include "llvm/Support/PrettyStackTrace.h"
  27 #include "llvm/Support/Signals.h"
  28 #include "llvm/Support/raw_ostream.h"
  29 #include "llvm/Support/system_error.h"
  30 #include <algorithm>
  31 #include <cstring>
  32 #include <list>
  33 #include <string>
  34
  35 using namespace llvm;
  36 using namespace object;
  37
  38 static cl::list<std::string>
  39 InputFilenames(cl::Positional, cl::desc("<input object files>"),
  40                cl::ZeroOrMore);
  41
  42 static cl::opt<unsigned long long>
  43 Address("address", cl::init(-1ULL),
  44         cl::desc("Print line information for a given address"));
  45
  46 static cl::opt<bool>
  47 PrintFunctions("functions", cl::init(false),
  48                cl::desc("Print function names as well as line information "
  49                         "for a given address"));
  50
  51 static cl::opt<bool>
  52 PrintInlining("inlining", cl::init(false),
  53               cl::desc("Print all inlined frames for a given address"));
  54
  55 static void PrintDILineInfo(DILineInfo dli) {
  56   if (PrintFunctions)
  57     outs() << (dli.getFunctionName() ? dli.getFunctionName() : "<unknown>")
  58            << "\n";
  59   outs() << (dli.getFileName() ? dli.getFileName() : "<unknown>") << ':'
  60          << dli.getLine() << ':' << dli.getColumn() << '\n';
  61 }
  62
  63 static void DumpInput(const StringRef &Filename) {
  64   OwningPtr<MemoryBuffer> Buff;
  65
  66   if (error_code ec = MemoryBuffer::getFileOrSTDIN(Filename, Buff)) {
  67     errs() << Filename << ": " << ec.message() << "\n";
  68     return;
  69   }
  70
  71   OwningPtr<ObjectFile> Obj(ObjectFile::createObjectFile(Buff.take()));
  72   OwningPtr<DIContext> dictx(DIContext::getDWARFContext(Obj.get()));
  73
  74   if (Address == -1ULL) {
  75     outs() << Filename
  76            << ":\tfile format " << Obj->getFileFormatName() << "\n\n";
  77     // Dump the complete DWARF structure.
  78     dictx->dump(outs());
  79   } else {
  80     // Print line info for the specified address.
  81     int SpecFlags = DILineInfoSpecifier::FileLineInfo |
  82                     DILineInfoSpecifier::AbsoluteFilePath;
  83     if (PrintFunctions)
  84       SpecFlags |= DILineInfoSpecifier::FunctionName;
  85     if (PrintInlining) {
  86       DIInliningInfo InliningInfo =
  87         dictx->getInliningInfoForAddress(Address, SpecFlags);
  88       uint32_t n = InliningInfo.getNumberOfFrames();
  89       if (n == 0) {
  90         // Print one empty debug line info in any case.
  91         PrintDILineInfo(DILineInfo());
  92       } else {
  93         for (uint32_t i = 0; i < n; i++) {
  94           DILineInfo dli = InliningInfo.getFrame(i);
  95           PrintDILineInfo(dli);
  96         }
  97       }
  98     } else {
  99       DILineInfo dli = dictx->getLineInfoForAddress(Address, SpecFlags);
 100       PrintDILineInfo(dli);
 101     }
 102   }
 103 }
 104
 105 int main(int argc, char **argv) {
 106   // Print a stack trace if we signal out.
 107   sys::PrintStackTraceOnErrorSignal();
 108   PrettyStackTraceProgram X(argc, argv);
 109   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
 110
 111   cl::ParseCommandLineOptions(argc, argv, "llvm dwarf dumper\n");
 112
 113   // Defaults to a.out if no filenames specified.
 114   if (InputFilenames.size() == 0)
 115     InputFilenames.push_back("a.out");
 116
 117   std::for_each(InputFilenames.begin(), InputFilenames.end(), DumpInput);
 118
 119   return 0;
 120 }