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/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/PrettyStackTrace.h"
26 #include "llvm/Support/Signals.h"
27 #include "llvm/Support/raw_ostream.h"
28 #include <algorithm>
29 #include <cstring>
30 #include <list>
31 #include <string>
32 #include <system_error>
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<DIDumpType>
42 DumpType("debug-dump", cl::init(DIDT_All),
43   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", ".apple_namespaces"),
51         clEnumValN(DIDT_AppleObjC, "apple_objc", ".apple_objc"),
52         clEnumValN(DIDT_Aranges, "aranges", ".debug_aranges"),
53         clEnumValN(DIDT_Info, "info", ".debug_info"),
54         clEnumValN(DIDT_InfoDwo, "info.dwo", ".debug_info.dwo"),
55         clEnumValN(DIDT_Types, "types", ".debug_types"),
56         clEnumValN(DIDT_TypesDwo, "types.dwo", ".debug_types.dwo"),
57         clEnumValN(DIDT_Line, "line", ".debug_line"),
58         clEnumValN(DIDT_LineDwo, "line.dwo", ".debug_line.dwo"),
59         clEnumValN(DIDT_Loc, "loc", ".debug_loc"),
60         clEnumValN(DIDT_LocDwo, "loc.dwo", ".debug_loc.dwo"),
61         clEnumValN(DIDT_Frames, "frames", ".debug_frame"),
62         clEnumValN(DIDT_Ranges, "ranges", ".debug_ranges"),
63         clEnumValN(DIDT_Pubnames, "pubnames", ".debug_pubnames"),
64         clEnumValN(DIDT_Pubtypes, "pubtypes", ".debug_pubtypes"),
65         clEnumValN(DIDT_GnuPubnames, "gnu_pubnames", ".debug_gnu_pubnames"),
66         clEnumValN(DIDT_GnuPubtypes, "gnu_pubtypes", ".debug_gnu_pubtypes"),
67         clEnumValN(DIDT_Str, "str", ".debug_str"),
68         clEnumValN(DIDT_StrDwo, "str.dwo", ".debug_str.dwo"),
69         clEnumValN(DIDT_StrOffsetsDwo, "str_offsets.dwo", ".debug_str_offsets.dwo"),
70         clEnumValEnd));
71 
72 static int ReturnValue = EXIT_SUCCESS;
73 
74 static bool error(StringRef Filename, std::error_code EC) {
75   if (!EC)
76     return false;
77   errs() << Filename << ": " << EC.message() << "\n";
78   ReturnValue = EXIT_FAILURE;
79   return true;
80 }
81 
82 static void DumpInput(StringRef Filename) {
83   ErrorOr<std::unique_ptr<MemoryBuffer>> BuffOrErr =
84       MemoryBuffer::getFileOrSTDIN(Filename);
85   if (error(Filename, BuffOrErr.getError()))
86     return;
87   std::unique_ptr<MemoryBuffer> Buff = std::move(BuffOrErr.get());
88 
89   ErrorOr<std::unique_ptr<ObjectFile>> ObjOrErr =
90       ObjectFile::createObjectFile(Buff->getMemBufferRef());
91   if (error(Filename, ObjOrErr.getError()))
92     return;
93   ObjectFile &Obj = *ObjOrErr.get();
94 
95   std::unique_ptr<DIContext> DICtx(new DWARFContextInMemory(Obj));
96 
97   outs() << Filename
98          << ":\tfile format " << Obj.getFileFormatName() << "\n\n";
99   // Dump the complete DWARF structure.
100   DICtx->dump(outs(), DumpType);
101 }
102 
103 int main(int argc, char **argv) {
104   // Print a stack trace if we signal out.
105   sys::PrintStackTraceOnErrorSignal();
106   PrettyStackTraceProgram X(argc, argv);
107   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
108 
109   cl::ParseCommandLineOptions(argc, argv, "llvm dwarf dumper\n");
110 
111   // Defaults to a.out if no filenames specified.
112   if (InputFilenames.size() == 0)
113     InputFilenames.push_back("a.out");
114 
115   std::for_each(InputFilenames.begin(), InputFilenames.end(), DumpInput);
116 
117   return ReturnValue;
118 }
119