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_Types, "types", ".debug_types"),
66         clEnumValN(DIDT_TypesDwo, "types.dwo", ".debug_types.dwo"),
67         clEnumValN(DIDT_Line, "line", ".debug_line"),
68         clEnumValN(DIDT_Loc, "loc", ".debug_loc"),
69         clEnumValN(DIDT_Frames, "frames", ".debug_frame"),
70         clEnumValN(DIDT_Ranges, "ranges", ".debug_ranges"),
71         clEnumValN(DIDT_Pubnames, "pubnames", ".debug_pubnames"),
72         clEnumValN(DIDT_Pubtypes, "pubtypes", ".debug_pubtypes"),
73         clEnumValN(DIDT_GnuPubnames, "gnu_pubnames", ".debug_gnu_pubnames"),
74         clEnumValN(DIDT_GnuPubtypes, "gnu_pubtypes", ".debug_gnu_pubtypes"),
75         clEnumValN(DIDT_Str, "str", ".debug_str"),
76         clEnumValN(DIDT_StrDwo, "str.dwo", ".debug_str.dwo"),
77         clEnumValN(DIDT_StrOffsetsDwo, "str_offsets.dwo", ".debug_str_offsets.dwo"),
78         clEnumValEnd));
79 
80 static void PrintDILineInfo(DILineInfo dli) {
81   if (PrintFunctions)
82     outs() << (dli.getFunctionName() ? dli.getFunctionName() : "<unknown>")
83            << "\n";
84   outs() << (dli.getFileName() ? dli.getFileName() : "<unknown>") << ':'
85          << dli.getLine() << ':' << dli.getColumn() << '\n';
86 }
87 
88 static void DumpInput(const StringRef &Filename) {
89   OwningPtr<MemoryBuffer> Buff;
90 
91   if (error_code ec = MemoryBuffer::getFileOrSTDIN(Filename, Buff)) {
92     errs() << Filename << ": " << ec.message() << "\n";
93     return;
94   }
95 
96   ErrorOr<ObjectFile*> ObjOrErr(ObjectFile::createObjectFile(Buff.take()));
97   if (error_code EC = ObjOrErr.getError()) {
98     errs() << Filename << ": " << EC.message() << '\n';
99     return;
100   }
101   OwningPtr<ObjectFile> Obj(ObjOrErr.get());
102 
103   OwningPtr<DIContext> DICtx(DIContext::getDWARFContext(Obj.get()));
104 
105   if (Address == -1ULL) {
106     outs() << Filename
107            << ":\tfile format " << Obj->getFileFormatName() << "\n\n";
108     // Dump the complete DWARF structure.
109     DICtx->dump(outs(), DumpType);
110   } else {
111     // Print line info for the specified address.
112     int SpecFlags = DILineInfoSpecifier::FileLineInfo |
113                     DILineInfoSpecifier::AbsoluteFilePath;
114     if (PrintFunctions)
115       SpecFlags |= DILineInfoSpecifier::FunctionName;
116     if (PrintInlining) {
117       DIInliningInfo InliningInfo =
118         DICtx->getInliningInfoForAddress(Address, SpecFlags);
119       uint32_t n = InliningInfo.getNumberOfFrames();
120       if (n == 0) {
121         // Print one empty debug line info in any case.
122         PrintDILineInfo(DILineInfo());
123       } else {
124         for (uint32_t i = 0; i < n; i++) {
125           DILineInfo dli = InliningInfo.getFrame(i);
126           PrintDILineInfo(dli);
127         }
128       }
129     } else {
130       DILineInfo dli = DICtx->getLineInfoForAddress(Address, SpecFlags);
131       PrintDILineInfo(dli);
132     }
133   }
134 }
135 
136 int main(int argc, char **argv) {
137   // Print a stack trace if we signal out.
138   sys::PrintStackTraceOnErrorSignal();
139   PrettyStackTraceProgram X(argc, argv);
140   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
141 
142   cl::ParseCommandLineOptions(argc, argv, "llvm dwarf dumper\n");
143 
144   // Defaults to a.out if no filenames specified.
145   if (InputFilenames.size() == 0)
146     InputFilenames.push_back("a.out");
147 
148   std::for_each(InputFilenames.begin(), InputFilenames.end(), DumpInput);
149 
150   return 0;
151 }
152