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/Path.h"
27 #include "llvm/Support/PrettyStackTrace.h"
28 #include "llvm/Support/Signals.h"
29 #include "llvm/Support/raw_ostream.h"
30 #include <algorithm>
31 #include <cstring>
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 or .dSYM bundles>"),
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_GdbIndex, "gdb_index", ".gdb_index"),
75         clEnumValN(DIDT_TUIndex, "tu_index", ".debug_tu_index")));
76 
77 static cl::opt<bool>
78     SummarizeTypes("summarize-types",
79                    cl::desc("Abbreviate the description of type unit entries"));
80 
81 static void error(StringRef Filename, std::error_code EC) {
82   if (!EC)
83     return;
84   errs() << Filename << ": " << EC.message() << "\n";
85   exit(1);
86 }
87 
88 static void DumpObjectFile(ObjectFile &Obj, Twine Filename) {
89   std::unique_ptr<DIContext> DICtx(new DWARFContextInMemory(Obj));
90 
91   outs() << Filename.str() << ":\tfile format " << Obj.getFileFormatName()
92          << "\n\n";
93   // Dump the complete DWARF structure.
94   DICtx->dump(outs(), DumpType, false, SummarizeTypes);
95 }
96 
97 static void DumpInput(StringRef Filename) {
98   ErrorOr<std::unique_ptr<MemoryBuffer>> BuffOrErr =
99       MemoryBuffer::getFileOrSTDIN(Filename);
100   error(Filename, BuffOrErr.getError());
101   std::unique_ptr<MemoryBuffer> Buff = std::move(BuffOrErr.get());
102 
103   Expected<std::unique_ptr<Binary>> BinOrErr =
104       object::createBinary(Buff->getMemBufferRef());
105   if (!BinOrErr)
106     error(Filename, errorToErrorCode(BinOrErr.takeError()));
107 
108   if (auto *Obj = dyn_cast<ObjectFile>(BinOrErr->get()))
109     DumpObjectFile(*Obj, Filename);
110   else if (auto *Fat = dyn_cast<MachOUniversalBinary>(BinOrErr->get()))
111     for (auto &ObjForArch : Fat->objects()) {
112       auto MachOOrErr = ObjForArch.getAsObjectFile();
113       error(Filename, errorToErrorCode(MachOOrErr.takeError()));
114       DumpObjectFile(**MachOOrErr,
115                      Filename + " (" + ObjForArch.getArchFlagName() + ")");
116     }
117 }
118 
119 /// If the input path is a .dSYM bundle (as created by the dsymutil tool),
120 /// replace it with individual entries for each of the object files inside the
121 /// bundle otherwise return the input path.
122 static std::vector<std::string> expandBundle(const std::string &InputPath) {
123   std::vector<std::string> BundlePaths;
124   SmallString<256> BundlePath(InputPath);
125   // Manually open up the bundle to avoid introducing additional dependencies.
126   if (sys::fs::is_directory(BundlePath) &&
127       sys::path::extension(BundlePath) == ".dSYM") {
128     std::error_code EC;
129     sys::path::append(BundlePath, "Contents", "Resources", "DWARF");
130     for (sys::fs::directory_iterator Dir(BundlePath, EC), DirEnd;
131          Dir != DirEnd && !EC; Dir.increment(EC)) {
132       const std::string &Path = Dir->path();
133       sys::fs::file_status Status;
134       EC = sys::fs::status(Path, Status);
135       error(Path, EC);
136       switch (Status.type()) {
137       case sys::fs::file_type::regular_file:
138       case sys::fs::file_type::symlink_file:
139       case sys::fs::file_type::type_unknown:
140         BundlePaths.push_back(Path);
141         break;
142       default: /*ignore*/;
143       }
144     }
145     error(BundlePath, EC);
146   }
147   if (!BundlePaths.size())
148     BundlePaths.push_back(InputPath);
149   return BundlePaths;
150 }
151 
152 int main(int argc, char **argv) {
153   // Print a stack trace if we signal out.
154   sys::PrintStackTraceOnErrorSignal(argv[0]);
155   PrettyStackTraceProgram X(argc, argv);
156   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
157 
158   cl::ParseCommandLineOptions(argc, argv, "llvm dwarf dumper\n");
159 
160   // Defaults to a.out if no filenames specified.
161   if (InputFilenames.size() == 0)
162     InputFilenames.push_back("a.out");
163 
164   // Expand any .dSYM bundles to the individual object files contained therein.
165   std::vector<std::string> Objects;
166   for (const auto &F : InputFilenames) {
167     auto Objs = expandBundle(F);
168     Objects.insert(Objects.end(), Objs.begin(), Objs.end());
169   }
170 
171   std::for_each(Objects.begin(), Objects.end(), DumpInput);
172 
173   return EXIT_SUCCESS;
174 }
175