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/DebugInfo/DWARF/DWARFContext.h"
  18 #include "llvm/Object/MachOUniversal.h"
  19 #include "llvm/Object/ObjectFile.h"
  20 #include "llvm/Object/RelocVisitor.h"
  21 #include "llvm/Support/CommandLine.h"
  22 #include "llvm/Support/Debug.h"
  23 #include "llvm/Support/Format.h"
  24 #include "llvm/Support/ManagedStatic.h"
  25 #include "llvm/Support/MemoryBuffer.h"
  26 #include "llvm/Support/PrettyStackTrace.h"
  27 #include "llvm/Support/Signals.h"
  28 #include "llvm/Support/raw_ostream.h"
  29 #include <algorithm>
  30 #include <cstring>
  31 #include <list>
  32 #include <string>
  33 #include <system_error>
  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<DIDumpType>
  43 DumpType("debug-dump", cl::init(DIDT_All),
  44   cl::desc("Dump of debug sections:"),
  45   cl::values(
  46         clEnumValN(DIDT_All, "all", "Dump all debug sections"),
  47         clEnumValN(DIDT_Abbrev, "abbrev", ".debug_abbrev"),
  48         clEnumValN(DIDT_AbbrevDwo, "abbrev.dwo", ".debug_abbrev.dwo"),
  49         clEnumValN(DIDT_AppleNames, "apple_names", ".apple_names"),
  50         clEnumValN(DIDT_AppleTypes, "apple_types", ".apple_types"),
  51         clEnumValN(DIDT_AppleNamespaces, "apple_namespaces", ".apple_namespaces"),
  52         clEnumValN(DIDT_AppleObjC, "apple_objc", ".apple_objc"),
  53         clEnumValN(DIDT_Aranges, "aranges", ".debug_aranges"),
  54         clEnumValN(DIDT_Info, "info", ".debug_info"),
  55         clEnumValN(DIDT_InfoDwo, "info.dwo", ".debug_info.dwo"),
  56         clEnumValN(DIDT_Types, "types", ".debug_types"),
  57         clEnumValN(DIDT_TypesDwo, "types.dwo", ".debug_types.dwo"),
  58         clEnumValN(DIDT_Line, "line", ".debug_line"),
  59         clEnumValN(DIDT_LineDwo, "line.dwo", ".debug_line.dwo"),
  60         clEnumValN(DIDT_Loc, "loc", ".debug_loc"),
  61         clEnumValN(DIDT_LocDwo, "loc.dwo", ".debug_loc.dwo"),
  62         clEnumValN(DIDT_Frames, "frames", ".debug_frame"),
  63         clEnumValN(DIDT_Ranges, "ranges", ".debug_ranges"),
  64         clEnumValN(DIDT_Pubnames, "pubnames", ".debug_pubnames"),
  65         clEnumValN(DIDT_Pubtypes, "pubtypes", ".debug_pubtypes"),
  66         clEnumValN(DIDT_GnuPubnames, "gnu_pubnames", ".debug_gnu_pubnames"),
  67         clEnumValN(DIDT_GnuPubtypes, "gnu_pubtypes", ".debug_gnu_pubtypes"),
  68         clEnumValN(DIDT_Str, "str", ".debug_str"),
  69         clEnumValN(DIDT_StrDwo, "str.dwo", ".debug_str.dwo"),
  70         clEnumValN(DIDT_StrOffsetsDwo, "str_offsets.dwo", ".debug_str_offsets.dwo"),
  71         clEnumValEnd));
  72
  73 static void error(StringRef Filename, std::error_code EC) {
  74   if (!EC)
  75     return;
  76   errs() << Filename << ": " << EC.message() << "\n";
  77   exit(1);
  78 }
  79
  80 static void DumpObjectFile(ObjectFile &Obj, Twine Filename) {
  81   std::unique_ptr<DIContext> DICtx(new DWARFContextInMemory(Obj));
  82
  83   outs() << Filename.str() << ":\tfile format " << Obj.getFileFormatName()
  84          << "\n\n";
  85   // Dump the complete DWARF structure.
  86   DICtx->dump(outs(), DumpType);
  87 }
  88
  89 static void DumpInput(StringRef Filename) {
  90   ErrorOr<std::unique_ptr<MemoryBuffer>> BuffOrErr =
  91       MemoryBuffer::getFileOrSTDIN(Filename);
  92   error(Filename, BuffOrErr.getError());
  93   std::unique_ptr<MemoryBuffer> Buff = std::move(BuffOrErr.get());
  94
  95   ErrorOr<std::unique_ptr<Binary>> BinOrErr =
  96       object::createBinary(Buff->getMemBufferRef());
  97   error(Filename, BinOrErr.getError());
  98
  99   if (auto *Obj = dyn_cast<ObjectFile>(BinOrErr->get()))
 100     DumpObjectFile(*Obj, Filename);
 101   else if (auto *Fat = dyn_cast<MachOUniversalBinary>(BinOrErr->get()))
 102     for (auto &ObjForArch : Fat->objects()) {
 103       auto MachOOrErr = ObjForArch.getAsObjectFile();
 104       error(Filename, MachOOrErr.getError());
 105       DumpObjectFile(**MachOOrErr,
 106                      Filename + " (" + ObjForArch.getArchTypeName() + ")");
 107     }
 108 }
 109
 110 int main(int argc, char **argv) {
 111   // Print a stack trace if we signal out.
 112   sys::PrintStackTraceOnErrorSignal();
 113   PrettyStackTraceProgram X(argc, argv);
 114   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
 115
 116   cl::ParseCommandLineOptions(argc, argv, "llvm dwarf dumper\n");
 117
 118   // Defaults to a.out if no filenames specified.
 119   if (InputFilenames.size() == 0)
 120     InputFilenames.push_back("a.out");
 121
 122   std::for_each(InputFilenames.begin(), InputFilenames.end(), DumpInput);
 123
 124   return EXIT_SUCCESS;
 125 }