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/OwningPtr.h"
     15 #include "llvm/ADT/STLExtras.h"
     16 #include "llvm/ADT/Triple.h"
     17 #include "llvm/DebugInfo/DIContext.h"
     18 #include "llvm/Object/ObjectFile.h"
     19 #include "llvm/Object/RelocVisitor.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 cl::opt<DIDumpType>
     56 DumpType("debug-dump", cl::init(DIDT_All),
     57   cl::desc("Dump of debug sections:"),
     58   cl::values(
     59         clEnumValN(DIDT_All, "all", "Dump all debug sections"),
     60         clEnumValN(DIDT_Abbrev, "abbrev", ".debug_abbrev"),
     61         clEnumValN(DIDT_AbbrevDwo, "abbrev.dwo", ".debug_abbrev.dwo"),
     62         clEnumValN(DIDT_Aranges, "aranges", ".debug_aranges"),
     63         clEnumValN(DIDT_Info, "info", ".debug_info"),
     64         clEnumValN(DIDT_InfoDwo, "info.dwo", ".debug_info.dwo"),
     65         clEnumValN(DIDT_Line, "line", ".debug_line"),
     66         clEnumValN(DIDT_Frames, "frames", ".debug_frame"),
     67         clEnumValN(DIDT_Ranges, "ranges", ".debug_ranges"),
     68         clEnumValN(DIDT_Pubnames, "pubnames", ".debug_pubnames"),
     69         clEnumValN(DIDT_Str, "str", ".debug_str"),
     70         clEnumValN(DIDT_StrDwo, "str.dwo", ".debug_str.dwo"),
     71         clEnumValN(DIDT_StrOffsetsDwo, "str_offsets.dwo", ".debug_str_offsets.dwo"),
     72         clEnumValEnd));
     73 
     74 static void PrintDILineInfo(DILineInfo dli) {
     75   if (PrintFunctions)
     76     outs() << (dli.getFunctionName() ? dli.getFunctionName() : "<unknown>")
     77            << "\n";
     78   outs() << (dli.getFileName() ? dli.getFileName() : "<unknown>") << ':'
     79          << dli.getLine() << ':' << dli.getColumn() << '\n';
     80 }
     81 
     82 static void DumpInput(const StringRef &Filename) {
     83   OwningPtr<MemoryBuffer> Buff;
     84 
     85   if (error_code ec = MemoryBuffer::getFileOrSTDIN(Filename, Buff)) {
     86     errs() << Filename << ": " << ec.message() << "\n";
     87     return;
     88   }
     89 
     90   OwningPtr<ObjectFile> Obj(ObjectFile::createObjectFile(Buff.take()));
     91   if (!Obj) {
     92     errs() << Filename << ": Unknown object file format\n";
     93     return;
     94   }
     95 
     96   OwningPtr<DIContext> DICtx(DIContext::getDWARFContext(Obj.get()));
     97 
     98   if (Address == -1ULL) {
     99     outs() << Filename
    100            << ":\tfile format " << Obj->getFileFormatName() << "\n\n";
    101     // Dump the complete DWARF structure.
    102     DICtx->dump(outs(), DumpType);
    103   } else {
    104     // Print line info for the specified address.
    105     int SpecFlags = DILineInfoSpecifier::FileLineInfo |
    106                     DILineInfoSpecifier::AbsoluteFilePath;
    107     if (PrintFunctions)
    108       SpecFlags |= DILineInfoSpecifier::FunctionName;
    109     if (PrintInlining) {
    110       DIInliningInfo InliningInfo =
    111         DICtx->getInliningInfoForAddress(Address, SpecFlags);
    112       uint32_t n = InliningInfo.getNumberOfFrames();
    113       if (n == 0) {
    114         // Print one empty debug line info in any case.
    115         PrintDILineInfo(DILineInfo());
    116       } else {
    117         for (uint32_t i = 0; i < n; i++) {
    118           DILineInfo dli = InliningInfo.getFrame(i);
    119           PrintDILineInfo(dli);
    120         }
    121       }
    122     } else {
    123       DILineInfo dli = DICtx->getLineInfoForAddress(Address, SpecFlags);
    124       PrintDILineInfo(dli);
    125     }
    126   }
    127 }
    128 
    129 int main(int argc, char **argv) {
    130   // Print a stack trace if we signal out.
    131   sys::PrintStackTraceOnErrorSignal();
    132   PrettyStackTraceProgram X(argc, argv);
    133   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
    134 
    135   cl::ParseCommandLineOptions(argc, argv, "llvm dwarf dumper\n");
    136 
    137   // Defaults to a.out if no filenames specified.
    138   if (InputFilenames.size() == 0)
    139     InputFilenames.push_back("a.out");
    140 
    141   std::for_each(InputFilenames.begin(), InputFilenames.end(), DumpInput);
    142 
    143   return 0;
    144 }
    145