1 //===-- llvm-dwarfdump.cpp - Debug info dumping utility for llvm ----------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This program is a utility that works like "dwarfdump".
12 //===----------------------------------------------------------------------===//
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"
33 #include <system_error>
36 using namespace object;
38 static cl::list<std::string>
39 InputFilenames(cl::Positional, cl::desc("<input object files>"),
42 static cl::opt<DIDumpType> DumpType(
43 "debug-dump", cl::init(DIDT_All), cl::desc("Dump of debug sections:"),
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",
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",
71 ".debug_str_offsets.dwo"),
72 clEnumValN(DIDT_CUIndex, "cu_index", ".debug_cu_index"),
73 clEnumValN(DIDT_TUIndex, "tu_index", ".debug_tu_index"), clEnumValEnd));
75 static void error(StringRef Filename, std::error_code EC) {
78 errs() << Filename << ": " << EC.message() << "\n";
82 static void DumpObjectFile(ObjectFile &Obj, Twine Filename) {
83 std::unique_ptr<DIContext> DICtx(new DWARFContextInMemory(Obj));
85 outs() << Filename.str() << ":\tfile format " << Obj.getFileFormatName()
87 // Dump the complete DWARF structure.
88 DICtx->dump(outs(), DumpType);
91 static void DumpInput(StringRef Filename) {
92 ErrorOr<std::unique_ptr<MemoryBuffer>> BuffOrErr =
93 MemoryBuffer::getFileOrSTDIN(Filename);
94 error(Filename, BuffOrErr.getError());
95 std::unique_ptr<MemoryBuffer> Buff = std::move(BuffOrErr.get());
97 ErrorOr<std::unique_ptr<Binary>> BinOrErr =
98 object::createBinary(Buff->getMemBufferRef());
99 error(Filename, BinOrErr.getError());
101 if (auto *Obj = dyn_cast<ObjectFile>(BinOrErr->get()))
102 DumpObjectFile(*Obj, Filename);
103 else if (auto *Fat = dyn_cast<MachOUniversalBinary>(BinOrErr->get()))
104 for (auto &ObjForArch : Fat->objects()) {
105 auto MachOOrErr = ObjForArch.getAsObjectFile();
106 error(Filename, MachOOrErr.getError());
107 DumpObjectFile(**MachOOrErr,
108 Filename + " (" + ObjForArch.getArchTypeName() + ")");
112 int main(int argc, char **argv) {
113 // Print a stack trace if we signal out.
114 sys::PrintStackTraceOnErrorSignal();
115 PrettyStackTraceProgram X(argc, argv);
116 llvm_shutdown_obj Y; // Call llvm_shutdown() on exit.
118 cl::ParseCommandLineOptions(argc, argv, "llvm dwarf dumper\n");
120 // Defaults to a.out if no filenames specified.
121 if (InputFilenames.size() == 0)
122 InputFilenames.push_back("a.out");
124 std::for_each(InputFilenames.begin(), InputFilenames.end(), DumpInput);