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/STLExtras.h"
  15 #include "llvm/ADT/Triple.h"
  16 #include "llvm/DebugInfo/DIContext.h"
  17 #include "llvm/Object/ObjectFile.h"
  18 #include "llvm/Object/RelocVisitor.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 #include <list>
  32 #include <string>
  33
  34 using namespace llvm;
  35 using namespace object;
  36
  37 static cl::list<std::string>
  38 InputFilenames(cl::Positional, cl::desc("<input object files>"),
  39                cl::ZeroOrMore);
  40
  41 static cl::opt<unsigned long long>
  42 Address("address", cl::init(-1ULL),
  43         cl::desc("Print line information for a given address"));
  44
  45 static cl::opt<bool>
  46 PrintFunctions("functions", cl::init(false),
  47                cl::desc("Print function names as well as line information "
  48                         "for a given address"));
  49
  50 static cl::opt<bool>
  51 PrintInlining("inlining", cl::init(false),
  52               cl::desc("Print all inlined frames for a given address"));
  53
  54 static cl::opt<DIDumpType>
  55 DumpType("debug-dump", cl::init(DIDT_All),
  56   cl::desc("Dump of debug sections:"),
  57   cl::values(
  58         clEnumValN(DIDT_All, "all", "Dump all debug sections"),
  59         clEnumValN(DIDT_Abbrev, "abbrev", ".debug_abbrev"),
  60         clEnumValN(DIDT_AbbrevDwo, "abbrev.dwo", ".debug_abbrev.dwo"),
  61         clEnumValN(DIDT_Aranges, "aranges", ".debug_aranges"),
  62         clEnumValN(DIDT_Info, "info", ".debug_info"),
  63         clEnumValN(DIDT_InfoDwo, "info.dwo", ".debug_info.dwo"),
  64         clEnumValN(DIDT_Types, "types", ".debug_types"),
  65         clEnumValN(DIDT_TypesDwo, "types.dwo", ".debug_types.dwo"),
  66         clEnumValN(DIDT_Line, "line", ".debug_line"),
  67         clEnumValN(DIDT_LineDwo, "line.dwo", ".debug_line.dwo"),
  68         clEnumValN(DIDT_Loc, "loc", ".debug_loc"),
  69         clEnumValN(DIDT_LocDwo, "loc.dwo", ".debug_loc.dwo"),
  70         clEnumValN(DIDT_Frames, "frames", ".debug_frame"),
  71         clEnumValN(DIDT_Ranges, "ranges", ".debug_ranges"),
  72         clEnumValN(DIDT_Pubnames, "pubnames", ".debug_pubnames"),
  73         clEnumValN(DIDT_Pubtypes, "pubtypes", ".debug_pubtypes"),
  74         clEnumValN(DIDT_GnuPubnames, "gnu_pubnames", ".debug_gnu_pubnames"),
  75         clEnumValN(DIDT_GnuPubtypes, "gnu_pubtypes", ".debug_gnu_pubtypes"),
  76         clEnumValN(DIDT_Str, "str", ".debug_str"),
  77         clEnumValN(DIDT_StrDwo, "str.dwo", ".debug_str.dwo"),
  78         clEnumValN(DIDT_StrOffsetsDwo, "str_offsets.dwo", ".debug_str_offsets.dwo"),
  79         clEnumValEnd));
  80
  81 static void PrintDILineInfo(DILineInfo dli) {
  82   if (PrintFunctions)
  83     outs() << dli.FunctionName << "\n";
  84   outs() << dli.FileName << ':' << dli.Line << ':' << dli.Column << '\n';
  85 }
  86
  87 static void DumpInput(const StringRef &Filename) {
  88   std::unique_ptr<MemoryBuffer> Buff;
  89
  90   if (error_code ec = MemoryBuffer::getFileOrSTDIN(Filename, Buff)) {
  91     errs() << Filename << ": " << ec.message() << "\n";
  92     return;
  93   }
  94
  95   ErrorOr<ObjectFile*> ObjOrErr(ObjectFile::createObjectFile(Buff.release()));
  96   if (error_code EC = ObjOrErr.getError()) {
  97     errs() << Filename << ": " << EC.message() << '\n';
  98     return;
  99   }
 100   std::unique_ptr<ObjectFile> Obj(ObjOrErr.get());
 101
 102   std::unique_ptr<DIContext> DICtx(DIContext::getDWARFContext(Obj.get()));
 103
 104   if (Address == -1ULL) {
 105     outs() << Filename
 106            << ":\tfile format " << Obj->getFileFormatName() << "\n\n";
 107     // Dump the complete DWARF structure.
 108     DICtx->dump(outs(), DumpType);
 109   } else {
 110     // Print line info for the specified address.
 111     DILineInfoSpecifier Spec(
 112         DILineInfoSpecifier::FileLineInfoKind::AbsoluteFilePath,
 113         PrintFunctions ? DILineInfoSpecifier::FunctionNameKind::LinkageName
 114                        : DILineInfoSpecifier::FunctionNameKind::None);
 115     if (PrintInlining) {
 116       DIInliningInfo InliningInfo =
 117         DICtx->getInliningInfoForAddress(Address, Spec);
 118       uint32_t n = InliningInfo.getNumberOfFrames();
 119       if (n == 0) {
 120         // Print one empty debug line info in any case.
 121         PrintDILineInfo(DILineInfo());
 122       } else {
 123         for (uint32_t i = 0; i < n; i++) {
 124           DILineInfo dli = InliningInfo.getFrame(i);
 125           PrintDILineInfo(dli);
 126         }
 127       }
 128     } else {
 129       DILineInfo dli = DICtx->getLineInfoForAddress(Address, Spec);
 130       PrintDILineInfo(dli);
 131     }
 132   }
 133 }
 134
 135 int main(int argc, char **argv) {
 136   // Print a 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   cl::ParseCommandLineOptions(argc, argv, "llvm dwarf dumper\n");
 142
 143   // Defaults to a.out if no filenames specified.
 144   if (InputFilenames.size() == 0)
 145     InputFilenames.push_back("a.out");
 146
 147   std::for_each(InputFilenames.begin(), InputFilenames.end(), DumpInput);
 148
 149   return 0;
 150 }