Home | History | Annotate | Download | only in llvm-dwarfdump
      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> DumpType(
     43     "debug-dump", cl::init(DIDT_All), cl::desc("Dump of debug sections:"),
     44     cl::values(
     45         clEnumValN(DIDT_All, "all", "Dump all debug sections"),
     46         clEnumValN(DIDT_Abbrev, "abbrev", ".debug_abbrev"),
     47         clEnumValN(DIDT_AbbrevDwo, "abbrev.dwo", ".debug_abbrev.dwo"),
     48         clEnumValN(DIDT_AppleNames, "apple_names", ".apple_names"),
     49         clEnumValN(DIDT_AppleTypes, "apple_types", ".apple_types"),
     50         clEnumValN(DIDT_AppleNamespaces, "apple_namespaces",
     51                    ".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_Macro, "macro", ".debug_macinfo"),
     64         clEnumValN(DIDT_Ranges, "ranges", ".debug_ranges"),
     65         clEnumValN(DIDT_Pubnames, "pubnames", ".debug_pubnames"),
     66         clEnumValN(DIDT_Pubtypes, "pubtypes", ".debug_pubtypes"),
     67         clEnumValN(DIDT_GnuPubnames, "gnu_pubnames", ".debug_gnu_pubnames"),
     68         clEnumValN(DIDT_GnuPubtypes, "gnu_pubtypes", ".debug_gnu_pubtypes"),
     69         clEnumValN(DIDT_Str, "str", ".debug_str"),
     70         clEnumValN(DIDT_StrDwo, "str.dwo", ".debug_str.dwo"),
     71         clEnumValN(DIDT_StrOffsetsDwo, "str_offsets.dwo",
     72                    ".debug_str_offsets.dwo"),
     73         clEnumValN(DIDT_CUIndex, "cu_index", ".debug_cu_index"),
     74         clEnumValN(DIDT_TUIndex, "tu_index", ".debug_tu_index"), clEnumValEnd));
     75 
     76 static void error(StringRef Filename, std::error_code EC) {
     77   if (!EC)
     78     return;
     79   errs() << Filename << ": " << EC.message() << "\n";
     80   exit(1);
     81 }
     82 
     83 static void DumpObjectFile(ObjectFile &Obj, Twine Filename) {
     84   std::unique_ptr<DIContext> DICtx(new DWARFContextInMemory(Obj));
     85 
     86   outs() << Filename.str() << ":\tfile format " << Obj.getFileFormatName()
     87          << "\n\n";
     88   // Dump the complete DWARF structure.
     89   DICtx->dump(outs(), DumpType);
     90 }
     91 
     92 static void DumpInput(StringRef Filename) {
     93   ErrorOr<std::unique_ptr<MemoryBuffer>> BuffOrErr =
     94       MemoryBuffer::getFileOrSTDIN(Filename);
     95   error(Filename, BuffOrErr.getError());
     96   std::unique_ptr<MemoryBuffer> Buff = std::move(BuffOrErr.get());
     97 
     98   ErrorOr<std::unique_ptr<Binary>> BinOrErr =
     99       object::createBinary(Buff->getMemBufferRef());
    100   error(Filename, BinOrErr.getError());
    101 
    102   if (auto *Obj = dyn_cast<ObjectFile>(BinOrErr->get()))
    103     DumpObjectFile(*Obj, Filename);
    104   else if (auto *Fat = dyn_cast<MachOUniversalBinary>(BinOrErr->get()))
    105     for (auto &ObjForArch : Fat->objects()) {
    106       auto MachOOrErr = ObjForArch.getAsObjectFile();
    107       error(Filename, MachOOrErr.getError());
    108       DumpObjectFile(**MachOOrErr,
    109                      Filename + " (" + ObjForArch.getArchTypeName() + ")");
    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 EXIT_SUCCESS;
    128 }
    129