blob: d9e8e36efe5c57d602b0b74c3cf360f84b7fef55 [file] [log] [blame]
Eric Christopherd7169e92012-10-16 23:46:21 +00001//===-- llvm-dwarfdump.cpp - Debug info dumping utility for llvm ----------===//
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +00002//
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
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +000014#include "llvm/ADT/STLExtras.h"
Adrian Prantl7de891a2017-09-30 00:22:25 +000015#include "llvm/ADT/StringSet.h"
Chandler Carruthf010c462012-12-04 10:44:52 +000016#include "llvm/ADT/Triple.h"
Zachary Turner45e7e932015-04-23 17:37:47 +000017#include "llvm/DebugInfo/DIContext.h"
18#include "llvm/DebugInfo/DWARF/DWARFContext.h"
Adrian Prantl7c649ac2017-09-14 17:01:53 +000019#include "llvm/Object/Archive.h"
Frederic Riss7cd34c02015-08-03 00:10:31 +000020#include "llvm/Object/MachOUniversal.h"
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +000021#include "llvm/Object/ObjectFile.h"
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +000022#include "llvm/Support/CommandLine.h"
23#include "llvm/Support/Debug.h"
24#include "llvm/Support/Format.h"
Rui Ueyama0b9d56a2018-04-13 18:26:06 +000025#include "llvm/Support/InitLLVM.h"
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +000026#include "llvm/Support/MemoryBuffer.h"
Adrian Prantl8eb4aa52015-12-23 21:51:13 +000027#include "llvm/Support/Path.h"
Adrian Prantlffbb88f2017-10-03 22:08:22 +000028#include "llvm/Support/Regex.h"
Reid Klecknere6c9ef32017-08-29 21:41:21 +000029#include "llvm/Support/TargetSelect.h"
Jonas Devlieghere7080e062017-09-22 09:20:57 +000030#include "llvm/Support/ToolOutputFile.h"
Jonas Devlieghere2071b7a2018-05-24 11:36:57 +000031#include "llvm/Support/WithColor.h"
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +000032#include "llvm/Support/raw_ostream.h"
Eric Christopher806e03d2012-11-07 23:22:07 +000033
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +000034using namespace llvm;
35using namespace object;
36
Adrian Prantlb311e922017-09-15 23:04:04 +000037/// Parser for options that take an optional offest argument.
38/// @{
39struct OffsetOption {
40 uint64_t Val = 0;
41 bool HasValue = false;
42 bool IsRequested = false;
43};
44
45namespace llvm {
46namespace cl {
47template <>
48class parser<OffsetOption> final : public basic_parser<OffsetOption> {
49public:
50 parser(Option &O) : basic_parser(O) {}
51
52 /// Return true on error.
53 bool parse(Option &O, StringRef ArgName, StringRef Arg, OffsetOption &Val) {
54 if (Arg == "") {
55 Val.Val = 0;
56 Val.HasValue = false;
57 Val.IsRequested = true;
58 return false;
59 }
60 if (Arg.getAsInteger(0, Val.Val))
61 return O.error("'" + Arg + "' value invalid for integer argument!");
62 Val.HasValue = true;
63 Val.IsRequested = true;
64 return false;
65 }
66
67 enum ValueExpected getValueExpectedFlagDefault() const {
68 return ValueOptional;
69 }
70
71 void printOptionInfo(const Option &O, size_t GlobalWidth) const {
72 outs() << " -" << O.ArgStr;
73 Option::printHelpStr(O.HelpStr, GlobalWidth, getOptionWidth(O));
74 }
75
76 void printOptionDiff(const Option &O, OffsetOption V, OptVal Default,
77 size_t GlobalWidth) const {
78 printOptionName(O, GlobalWidth);
79 outs() << "[=offset]";
80 }
81
82 // An out-of-line virtual method to provide a 'home' for this class.
83 void anchor() override {};
84};
85} // cl
86} // llvm
87
88/// @}
89/// Command line options.
90/// @{
91
Adrian Prantl623927e2017-09-12 22:32:53 +000092namespace {
Adrian Prantlb311e922017-09-15 23:04:04 +000093using namespace cl;
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +000094
Adrian Prantl623927e2017-09-12 22:32:53 +000095OptionCategory DwarfDumpCategory("Specific Options");
96static opt<bool> Help("h", desc("Alias for -help"), Hidden,
97 cat(DwarfDumpCategory));
98static list<std::string>
99 InputFilenames(Positional, desc("<input object files or .dSYM bundles>"),
100 ZeroOrMore, cat(DwarfDumpCategory));
101
Adrian Prantlb311e922017-09-15 23:04:04 +0000102cl::OptionCategory SectionCategory("Section-specific Dump Options",
103 "These control which sections are dumped. "
104 "Where applicable these parameters take an "
105 "optional =<offset> argument to dump only "
106 "the entry at the specified offset.");
107
Adrian Prantl623927e2017-09-12 22:32:53 +0000108static opt<bool> DumpAll("all", desc("Dump all debug info sections"),
109 cat(SectionCategory));
110static alias DumpAllAlias("a", desc("Alias for -all"), aliasopt(DumpAll));
Adrian Prantl8e66c2e2017-09-11 22:59:45 +0000111
Adrian Prantlb311e922017-09-15 23:04:04 +0000112// Options for dumping specific sections.
Adrian Prantl494372f2017-09-13 22:09:01 +0000113static unsigned DumpType = DIDT_Null;
Adrian Prantlfd65d0d2017-09-19 20:58:57 +0000114static std::array<llvm::Optional<uint64_t>, (unsigned)DIDT_ID_Count>
115 DumpOffsets;
Adrian Prantl8e66c2e2017-09-11 22:59:45 +0000116#define HANDLE_DWARF_SECTION(ENUM_NAME, ELF_NAME, CMDLINE_NAME) \
Adrian Prantlb311e922017-09-15 23:04:04 +0000117 static opt<OffsetOption> Dump##ENUM_NAME( \
118 CMDLINE_NAME, desc("Dump the " ELF_NAME " section"), \
119 cat(SectionCategory));
Adrian Prantl8e66c2e2017-09-11 22:59:45 +0000120#include "llvm/BinaryFormat/Dwarf.def"
121#undef HANDLE_DWARF_SECTION
Adrian Prantlb311e922017-09-15 23:04:04 +0000122
Jonas Devlieghere6ad43562017-09-18 14:15:57 +0000123static alias DumpDebugFrameAlias("eh-frame", desc("Alias for -debug-frame"),
Adrian Prantlff00c9c2017-09-20 23:29:31 +0000124 NotHidden, cat(SectionCategory),
Jonas Devlieghere6ad43562017-09-18 14:15:57 +0000125 aliasopt(DumpDebugFrame));
Adrian Prantlab669422017-09-21 16:26:18 +0000126static list<std::string>
127 ArchFilters("arch",
128 desc("Dump debug information for the specified CPU "
129 "architecture only. Architectures may be specified by "
130 "name or by number. This option can be specified "
131 "multiple times, once for each desired architecture."),
132 cat(DwarfDumpCategory));
Adrian Prantlb5b768d2017-12-08 23:32:47 +0000133static opt<bool>
134 Diff("diff",
135 desc("Emit diff-friendly output by omitting offsets and addresses."),
136 cat(DwarfDumpCategory));
Adrian Prantl81f23862017-09-28 18:10:52 +0000137static list<std::string>
138 Find("find",
139 desc("Search for the exact match for <name> in the accelerator tables "
Adrian Prantl97212752017-09-30 00:31:15 +0000140 "and print the matching debug information entries. When no "
141 "accelerator tables are available, the slower but more complete "
142 "-name option can be used instead."),
Adrian Prantl81f23862017-09-28 18:10:52 +0000143 value_desc("name"), cat(DwarfDumpCategory));
Adrian Prantle14de922017-10-06 20:24:35 +0000144static alias FindAlias("f", desc("Alias for -find."), aliasopt(Find));
Adrian Prantl706e8dc2017-10-02 21:21:09 +0000145static opt<bool>
146 IgnoreCase("ignore-case",
147 desc("Ignore case distinctions in when searching by name."),
148 value_desc("i"), cat(DwarfDumpCategory));
Adrian Prantle14de922017-10-06 20:24:35 +0000149static alias IgnoreCaseAlias("i", desc("Alias for -ignore-case."),
Adrian Prantl706e8dc2017-10-02 21:21:09 +0000150 aliasopt(IgnoreCase));
Adrian Prantlffbb88f2017-10-03 22:08:22 +0000151static list<std::string> Name(
152 "name",
153 desc("Find and print all debug info entries whose name (DW_AT_name "
154 "attribute) matches the exact text in <pattern>. When used with the "
155 "the -regex option <pattern> is interpreted as a regular expression."),
156 value_desc("pattern"), cat(DwarfDumpCategory));
Adrian Prantl7de891a2017-09-30 00:22:25 +0000157static alias NameAlias("n", desc("Alias for -name"), aliasopt(Name));
Jonas Devlieghered900f822017-12-19 09:45:26 +0000158static opt<unsigned long long> Lookup("lookup",
Adrian Prantl0a3d7db2018-10-09 18:12:04 +0000159 desc("Lookup <address> in the debug information and print out any "
Jonas Devliegherec2c04202017-10-25 21:56:41 +0000160 "available file, function, block and line table details."),
161 value_desc("address"), cat(DwarfDumpCategory));
Jonas Devlieghere7080e062017-09-22 09:20:57 +0000162static opt<std::string>
163 OutputFilename("out-file", cl::init(""),
Adrian Prantle14de922017-10-06 20:24:35 +0000164 cl::desc("Redirect output to the specified file."),
Hans Wennborgf8a9b392017-10-03 18:39:13 +0000165 cl::value_desc("filename"));
Adrian Prantle14de922017-10-06 20:24:35 +0000166static alias OutputFilenameAlias("o", desc("Alias for -out-file."),
Hans Wennborgf8a9b392017-10-03 18:39:13 +0000167 aliasopt(OutputFilename),
168 cat(DwarfDumpCategory));
Adrian Prantl623927e2017-09-12 22:32:53 +0000169static opt<bool>
Adrian Prantlffbb88f2017-10-03 22:08:22 +0000170 UseRegex("regex",
171 desc("Treat any <pattern> strings as regular expressions when "
172 "searching instead of just as an exact string match."),
173 cat(DwarfDumpCategory));
174static alias RegexAlias("x", desc("Alias for -regex"), aliasopt(UseRegex));
175static opt<bool>
Adrian Prantld4e37532017-09-16 17:28:00 +0000176 ShowChildren("show-children",
177 desc("Show a debug info entry's children when selectively "
Adrian Prantle14de922017-10-06 20:24:35 +0000178 "printing with the =<offset> option."),
Adrian Prantlfd65d0d2017-09-19 20:58:57 +0000179 cat(DwarfDumpCategory));
Adrian Prantle14de922017-10-06 20:24:35 +0000180static alias ShowChildrenAlias("c", desc("Alias for -show-children."),
Adrian Prantld4e37532017-09-16 17:28:00 +0000181 aliasopt(ShowChildren));
182static opt<bool>
Adrian Prantl8233b302017-09-18 21:27:44 +0000183 ShowParents("show-parents",
184 desc("Show a debug info entry's parents when selectively "
Adrian Prantle14de922017-10-06 20:24:35 +0000185 "printing with the =<offset> option."),
Adrian Prantlfd65d0d2017-09-19 20:58:57 +0000186 cat(DwarfDumpCategory));
Adrian Prantle14de922017-10-06 20:24:35 +0000187static alias ShowParentsAlias("p", desc("Alias for -show-parents."),
Adrian Prantl8233b302017-09-18 21:27:44 +0000188 aliasopt(ShowParents));
Jonas Devlieghere5295aa52017-10-02 16:02:04 +0000189static opt<bool>
190 ShowForm("show-form",
191 desc("Show DWARF form types after the DWARF attribute types."),
192 cat(DwarfDumpCategory));
Adrian Prantle14de922017-10-06 20:24:35 +0000193static alias ShowFormAlias("F", desc("Alias for -show-form."),
Jonas Devlieghere5295aa52017-10-02 16:02:04 +0000194 aliasopt(ShowForm), cat(DwarfDumpCategory));
Adrian Prantlae599aa2017-09-20 17:44:00 +0000195static opt<unsigned> RecurseDepth(
196 "recurse-depth",
197 desc("Only recurse to a depth of N when displaying debug info entries."),
198 cat(DwarfDumpCategory), init(-1U), value_desc("N"));
Adrian Prantle14de922017-10-06 20:24:35 +0000199static alias RecurseDepthAlias("r", desc("Alias for -recurse-depth."),
Adrian Prantlae599aa2017-09-20 17:44:00 +0000200 aliasopt(RecurseDepth));
Jonas Devlieghere5295aa52017-10-02 16:02:04 +0000201
Adrian Prantl8233b302017-09-18 21:27:44 +0000202static opt<bool>
David Blaikie69a9e662016-10-18 21:09:48 +0000203 SummarizeTypes("summarize-types",
Adrian Prantle14de922017-10-06 20:24:35 +0000204 desc("Abbreviate the description of type unit entries."),
Adrian Prantlfd65d0d2017-09-19 20:58:57 +0000205 cat(DwarfDumpCategory));
Adrian Prantleadc3132017-10-06 20:24:34 +0000206static cl::opt<bool>
207 Statistics("statistics",
208 cl::desc("Emit JSON-formatted debug info quality metrics."),
209 cat(DwarfDumpCategory));
Adrian Prantle14de922017-10-06 20:24:35 +0000210static opt<bool> Verify("verify", desc("Verify the DWARF debug info."),
Adrian Prantl623927e2017-09-12 22:32:53 +0000211 cat(DwarfDumpCategory));
212static opt<bool> Quiet("quiet", desc("Use with -verify to not emit to STDOUT."),
213 cat(DwarfDumpCategory));
Adrian Prantle14de922017-10-06 20:24:35 +0000214static opt<bool> DumpUUID("uuid", desc("Show the UUID for each architecture."),
Adrian Prantl7de891a2017-09-30 00:22:25 +0000215 cat(DwarfDumpCategory));
Adrian Prantle14de922017-10-06 20:24:35 +0000216static alias DumpUUIDAlias("u", desc("Alias for -uuid."), aliasopt(DumpUUID));
Adrian Prantl623927e2017-09-12 22:32:53 +0000217static opt<bool> Verbose("verbose",
Adrian Prantle14de922017-10-06 20:24:35 +0000218 desc("Print more low-level encoding details."),
Adrian Prantl623927e2017-09-12 22:32:53 +0000219 cat(DwarfDumpCategory));
Adrian Prantle14de922017-10-06 20:24:35 +0000220static alias VerboseAlias("v", desc("Alias for -verbose."), aliasopt(Verbose),
Adrian Prantl623927e2017-09-12 22:32:53 +0000221 cat(DwarfDumpCategory));
222} // namespace
Adrian Prantlb311e922017-09-15 23:04:04 +0000223/// @}
224//===----------------------------------------------------------------------===//
225
Jonas Devlieghere7080e062017-09-22 09:20:57 +0000226static void error(StringRef Prefix, std::error_code EC) {
Alexey Samsonov1cf2b032015-06-25 23:40:15 +0000227 if (!EC)
Davide Italiano5e7aab02015-07-26 05:35:59 +0000228 return;
Jonas Devlieghereed9fa1a2018-10-23 21:51:44 +0000229 WithColor::error() << Prefix << ": " << EC.message() << "\n";
Davide Italiano5e7aab02015-07-26 05:35:59 +0000230 exit(1);
Alexey Samsonov1cf2b032015-06-25 23:40:15 +0000231}
232
Adrian Prantld368c61f2017-09-13 23:07:24 +0000233static DIDumpOptions getDumpOpts() {
Jonas Devlieghered2663072017-09-13 09:43:05 +0000234 DIDumpOptions DumpOpts;
235 DumpOpts.DumpType = DumpType;
Adrian Prantlae599aa2017-09-20 17:44:00 +0000236 DumpOpts.RecurseDepth = RecurseDepth;
Adrian Prantlb5b768d2017-12-08 23:32:47 +0000237 DumpOpts.ShowAddresses = !Diff;
Adrian Prantld4e37532017-09-16 17:28:00 +0000238 DumpOpts.ShowChildren = ShowChildren;
Adrian Prantl8233b302017-09-18 21:27:44 +0000239 DumpOpts.ShowParents = ShowParents;
Jonas Devlieghere5295aa52017-10-02 16:02:04 +0000240 DumpOpts.ShowForm = ShowForm;
Jonas Devlieghered2663072017-09-13 09:43:05 +0000241 DumpOpts.SummarizeTypes = SummarizeTypes;
242 DumpOpts.Verbose = Verbose;
Adrian Prantlae599aa2017-09-20 17:44:00 +0000243 // In -verify mode, print DIEs without children in error messages.
244 if (Verify)
245 return DumpOpts.noImplicitRecursion();
Jonas Devlieghered2663072017-09-13 09:43:05 +0000246 return DumpOpts;
247}
248
Adrian Prantlab669422017-09-21 16:26:18 +0000249static uint32_t getCPUType(MachOObjectFile &MachO) {
250 if (MachO.is64Bit())
251 return MachO.getHeader64().cputype;
252 else
253 return MachO.getHeader().cputype;
254}
255
256/// Return true if the object file has not been filtered by an --arch option.
257static bool filterArch(ObjectFile &Obj) {
258 if (ArchFilters.empty())
259 return true;
Adrian Prantl9fda1762017-09-30 00:22:21 +0000260
Adrian Prantlab669422017-09-21 16:26:18 +0000261 if (auto *MachO = dyn_cast<MachOObjectFile>(&Obj)) {
262 std::string ObjArch =
263 Triple::getArchTypeName(MachO->getArchTriple().getArch());
Adrian Prantl9fda1762017-09-30 00:22:21 +0000264
Adrian Prantlab669422017-09-21 16:26:18 +0000265 for (auto Arch : ArchFilters) {
Adrian Prantl9fda1762017-09-30 00:22:21 +0000266 // Match name.
Adrian Prantlab669422017-09-21 16:26:18 +0000267 if (Arch == ObjArch)
268 return true;
Adrian Prantl9fda1762017-09-30 00:22:21 +0000269
270 // Match architecture number.
Adrian Prantlab669422017-09-21 16:26:18 +0000271 unsigned Value;
272 if (!StringRef(Arch).getAsInteger(0, Value))
273 if (Value == getCPUType(*MachO))
274 return true;
275 }
276 }
277 return false;
278}
279
Jonas Devlieghere7080e062017-09-22 09:20:57 +0000280using HandlerFn = std::function<bool(ObjectFile &, DWARFContext &DICtx, Twine,
281 raw_ostream &)>;
Adrian Prantlab669422017-09-21 16:26:18 +0000282
Adrian Prantl7de891a2017-09-30 00:22:25 +0000283/// Print only DIEs that have a certain name.
Adrian Prantl0f410672018-10-09 20:51:33 +0000284static bool filterByName(const StringSet<> &Names, DWARFDie Die,
285 StringRef NameRef, raw_ostream &OS) {
286 std::string Name =
287 (IgnoreCase && !UseRegex) ? NameRef.lower() : NameRef.str();
288 if (UseRegex) {
289 // Match regular expression.
290 for (auto Pattern : Names.keys()) {
291 Regex RE(Pattern, IgnoreCase ? Regex::IgnoreCase : Regex::NoFlags);
292 std::string Error;
293 if (!RE.isValid(Error)) {
294 errs() << "error in regular expression: " << Error << "\n";
295 exit(1);
296 }
297 if (RE.match(Name)) {
298 Die.dump(OS, 0, getDumpOpts());
299 return true;
300 }
301 }
302 } else if (Names.count(Name)) {
303 // Match full text.
304 Die.dump(OS, 0, getDumpOpts());
305 return true;
306 }
307 return false;
308}
309
310/// Print only DIEs that have a certain name.
Adrian Prantl7de891a2017-09-30 00:22:25 +0000311static void filterByName(const StringSet<> &Names,
Paul Robinsonddedb752018-08-02 19:29:38 +0000312 DWARFContext::unit_iterator_range CUs,
313 raw_ostream &OS) {
Adrian Prantl7de891a2017-09-30 00:22:25 +0000314 for (const auto &CU : CUs)
315 for (const auto &Entry : CU->dies()) {
316 DWARFDie Die = {CU.get(), &Entry};
Adrian Prantl0f410672018-10-09 20:51:33 +0000317 if (const char *Name = Die.getName(DINameKind::ShortName))
318 if (filterByName(Names, Die, Name, OS))
319 continue;
320 if (const char *Name = Die.getName(DINameKind::LinkageName))
321 filterByName(Names, Die, Name, OS);
Adrian Prantl7de891a2017-09-30 00:22:25 +0000322 }
Jonas Devliegherec2c04202017-10-25 21:56:41 +0000323}
324
Pavel Labathc271b022018-06-13 08:14:27 +0000325static void getDies(DWARFContext &DICtx, const AppleAcceleratorTable &Accel,
326 StringRef Name, SmallVectorImpl<DWARFDie> &Dies) {
327 for (const auto &Entry : Accel.equal_range(Name)) {
328 if (llvm::Optional<uint64_t> Off = Entry.getDIESectionOffset()) {
329 if (DWARFDie Die = DICtx.getDIEForOffset(*Off))
330 Dies.push_back(Die);
331 }
332 }
333}
334
335static DWARFDie toDie(const DWARFDebugNames::Entry &Entry,
336 DWARFContext &DICtx) {
337 llvm::Optional<uint64_t> CUOff = Entry.getCUOffset();
338 llvm::Optional<uint64_t> Off = Entry.getDIEUnitOffset();
339 if (!CUOff || !Off)
340 return DWARFDie();
341
342 DWARFCompileUnit *CU = DICtx.getCompileUnitForOffset(*CUOff);
343 if (!CU)
344 return DWARFDie();
345
Pavel Labathde997702018-06-13 08:29:19 +0000346 if (llvm::Optional<uint64_t> DWOId = CU->getDWOId()) {
Pavel Labathc271b022018-06-13 08:14:27 +0000347 // This is a skeleton unit. Look up the DIE in the DWO unit.
348 CU = DICtx.getDWOCompileUnitForHash(*DWOId);
349 if (!CU)
350 return DWARFDie();
351 }
352
353 return CU->getDIEForOffset(CU->getOffset() + *Off);
354}
355
356static void getDies(DWARFContext &DICtx, const DWARFDebugNames &Accel,
357 StringRef Name, SmallVectorImpl<DWARFDie> &Dies) {
358 for (const auto &Entry : Accel.equal_range(Name)) {
359 if (DWARFDie Die = toDie(Entry, DICtx))
360 Dies.push_back(Die);
361 }
Pavel Labath2299c2e2018-05-31 08:47:00 +0000362}
363
364/// Print only DIEs that have a certain name.
365static void filterByAccelName(ArrayRef<std::string> Names, DWARFContext &DICtx,
366 raw_ostream &OS) {
Pavel Labathc271b022018-06-13 08:14:27 +0000367 SmallVector<DWARFDie, 4> Dies;
Pavel Labath2299c2e2018-05-31 08:47:00 +0000368 for (const auto &Name : Names) {
Pavel Labathc271b022018-06-13 08:14:27 +0000369 getDies(DICtx, DICtx.getAppleNames(), Name, Dies);
370 getDies(DICtx, DICtx.getAppleTypes(), Name, Dies);
371 getDies(DICtx, DICtx.getAppleNamespaces(), Name, Dies);
372 getDies(DICtx, DICtx.getDebugNames(), Name, Dies);
Pavel Labath2299c2e2018-05-31 08:47:00 +0000373 }
Fangrui Song3b35e172018-09-27 02:13:45 +0000374 llvm::sort(Dies);
Pavel Labathc271b022018-06-13 08:14:27 +0000375 Dies.erase(std::unique(Dies.begin(), Dies.end()), Dies.end());
Pavel Labath2299c2e2018-05-31 08:47:00 +0000376
Pavel Labathc271b022018-06-13 08:14:27 +0000377 for (DWARFDie Die : Dies)
Pavel Labath2299c2e2018-05-31 08:47:00 +0000378 Die.dump(OS, 0, getDumpOpts());
Pavel Labath2299c2e2018-05-31 08:47:00 +0000379}
380
Jonas Devliegherec2c04202017-10-25 21:56:41 +0000381/// Handle the --lookup option and dump the DIEs and line info for the given
382/// address.
383static bool lookup(DWARFContext &DICtx, uint64_t Address, raw_ostream &OS) {
384 auto DIEsForAddr = DICtx.getDIEsForAddress(Lookup);
385
386 if (!DIEsForAddr)
387 return false;
388
389 DIDumpOptions DumpOpts = getDumpOpts();
390 DumpOpts.RecurseDepth = 0;
391 DIEsForAddr.CompileUnit->dump(OS, DumpOpts);
392 if (DIEsForAddr.FunctionDIE) {
393 DIEsForAddr.FunctionDIE.dump(OS, 2, DumpOpts);
394 if (DIEsForAddr.BlockDIE)
395 DIEsForAddr.BlockDIE.dump(OS, 4, DumpOpts);
396 }
397
398 if (DILineInfo LineInfo = DICtx.getLineInfoForAddress(Lookup))
399 LineInfo.dump(OS);
400
401 return true;
Adrian Prantl7de891a2017-09-30 00:22:25 +0000402}
403
Adrian Prantleadc3132017-10-06 20:24:34 +0000404bool collectStatsForObjectFile(ObjectFile &Obj, DWARFContext &DICtx,
405 Twine Filename, raw_ostream &OS);
406
Jonas Devlieghere7080e062017-09-22 09:20:57 +0000407static bool dumpObjectFile(ObjectFile &Obj, DWARFContext &DICtx, Twine Filename,
408 raw_ostream &OS) {
Luke Cheesemanc8ecb422018-11-23 17:13:06 +0000409 logAllUnhandledErrors(DICtx.loadRegisterInfo(Obj), errs(),
410 Filename.str() + ": ");
Adrian Prantl7de891a2017-09-30 00:22:25 +0000411 // The UUID dump already contains all the same information.
412 if (!(DumpType & DIDT_UUID) || DumpType == DIDT_All)
413 OS << Filename << ":\tfile format " << Obj.getFileFormatName() << '\n';
414
Jonas Devliegherec2c04202017-10-25 21:56:41 +0000415 // Handle the --lookup option.
416 if (Lookup)
417 return lookup(DICtx, Lookup, OS);
418
Adrian Prantl7de891a2017-09-30 00:22:25 +0000419 // Handle the --name option.
420 if (!Name.empty()) {
421 StringSet<> Names;
422 for (auto name : Name)
Adrian Prantlffbb88f2017-10-03 22:08:22 +0000423 Names.insert((IgnoreCase && !UseRegex) ? StringRef(name).lower() : name);
Jonas Devlieghere5295aa52017-10-02 16:02:04 +0000424
Paul Robinsond51aaa82018-10-24 21:51:55 +0000425 filterByName(Names, DICtx.normal_units(), OS);
426 filterByName(Names, DICtx.dwo_units(), OS);
Adrian Prantl7de891a2017-09-30 00:22:25 +0000427 return true;
428 }
429
Adrian Prantl81f23862017-09-28 18:10:52 +0000430 // Handle the --find option and lower it to --debug-info=<offset>.
431 if (!Find.empty()) {
Pavel Labath2299c2e2018-05-31 08:47:00 +0000432 filterByAccelName(Find, DICtx, OS);
433 return true;
Adrian Prantl81f23862017-09-28 18:10:52 +0000434 }
Jonas Devlieghere5295aa52017-10-02 16:02:04 +0000435
Frederic Riss5733daa2015-08-03 00:10:25 +0000436 // Dump the complete DWARF structure.
Jonas Devlieghere7080e062017-09-22 09:20:57 +0000437 DICtx.dump(OS, getDumpOpts(), DumpOffsets);
Adrian Prantld368c61f2017-09-13 23:07:24 +0000438 return true;
Frederic Riss5733daa2015-08-03 00:10:25 +0000439}
440
Adrian Prantlab669422017-09-21 16:26:18 +0000441static bool verifyObjectFile(ObjectFile &Obj, DWARFContext &DICtx,
Jonas Devlieghere7080e062017-09-22 09:20:57 +0000442 Twine Filename, raw_ostream &OS) {
Greg Claytonce552652017-05-01 22:07:02 +0000443 // Verify the DWARF and exit with non-zero exit status if verification
444 // fails.
Jonas Devlieghere7080e062017-09-22 09:20:57 +0000445 raw_ostream &stream = Quiet ? nulls() : OS;
Greg Claytonce552652017-05-01 22:07:02 +0000446 stream << "Verifying " << Filename.str() << ":\tfile format "
447 << Obj.getFileFormatName() << "\n";
Adrian Prantlab669422017-09-21 16:26:18 +0000448 bool Result = DICtx.verify(stream, getDumpOpts());
Greg Claytonce552652017-05-01 22:07:02 +0000449 if (Result)
450 stream << "No errors.\n";
451 else
452 stream << "Errors detected.\n";
453 return Result;
454}
455
Adrian Prantl1c29e7f2017-09-13 23:16:13 +0000456static bool handleBuffer(StringRef Filename, MemoryBufferRef Buffer,
Jonas Devlieghere7080e062017-09-22 09:20:57 +0000457 HandlerFn HandleObj, raw_ostream &OS);
Adrian Prantl7c649ac2017-09-14 17:01:53 +0000458
459static bool handleArchive(StringRef Filename, Archive &Arch,
Jonas Devlieghere7080e062017-09-22 09:20:57 +0000460 HandlerFn HandleObj, raw_ostream &OS) {
Adrian Prantl7c649ac2017-09-14 17:01:53 +0000461 bool Result = true;
462 Error Err = Error::success();
463 for (auto Child : Arch.children(Err)) {
464 auto BuffOrErr = Child.getMemoryBufferRef();
465 error(Filename, errorToErrorCode(BuffOrErr.takeError()));
466 auto NameOrErr = Child.getName();
467 error(Filename, errorToErrorCode(NameOrErr.takeError()));
468 std::string Name = (Filename + "(" + NameOrErr.get() + ")").str();
Jonas Devlieghere7080e062017-09-22 09:20:57 +0000469 Result &= handleBuffer(Name, BuffOrErr.get(), HandleObj, OS);
Adrian Prantl7c649ac2017-09-14 17:01:53 +0000470 }
471 error(Filename, errorToErrorCode(std::move(Err)));
472
473 return Result;
474}
475
476static bool handleBuffer(StringRef Filename, MemoryBufferRef Buffer,
Jonas Devlieghere7080e062017-09-22 09:20:57 +0000477 HandlerFn HandleObj, raw_ostream &OS) {
Adrian Prantl1c29e7f2017-09-13 23:16:13 +0000478 Expected<std::unique_ptr<Binary>> BinOrErr = object::createBinary(Buffer);
Adrian Prantl7c649ac2017-09-14 17:01:53 +0000479 error(Filename, errorToErrorCode(BinOrErr.takeError()));
Jonas Devlieghere2c1824a2017-08-31 16:44:47 +0000480
Greg Claytonce552652017-05-01 22:07:02 +0000481 bool Result = true;
Adrian Prantlab669422017-09-21 16:26:18 +0000482 if (auto *Obj = dyn_cast<ObjectFile>(BinOrErr->get())) {
483 if (filterArch(*Obj)) {
484 std::unique_ptr<DWARFContext> DICtx = DWARFContext::create(*Obj);
Jonas Devlieghere7080e062017-09-22 09:20:57 +0000485 Result = HandleObj(*Obj, *DICtx, Filename, OS);
Adrian Prantlab669422017-09-21 16:26:18 +0000486 }
487 }
Greg Claytonce552652017-05-01 22:07:02 +0000488 else if (auto *Fat = dyn_cast<MachOUniversalBinary>(BinOrErr->get()))
489 for (auto &ObjForArch : Fat->objects()) {
Adrian Prantl7c649ac2017-09-14 17:01:53 +0000490 std::string ObjName =
491 (Filename + "(" + ObjForArch.getArchFlagName() + ")").str();
492 if (auto MachOOrErr = ObjForArch.getAsObjectFile()) {
Adrian Prantlab669422017-09-21 16:26:18 +0000493 auto &Obj = **MachOOrErr;
494 if (filterArch(Obj)) {
495 std::unique_ptr<DWARFContext> DICtx = DWARFContext::create(Obj);
Jonas Devlieghere7080e062017-09-22 09:20:57 +0000496 Result &= HandleObj(Obj, *DICtx, ObjName, OS);
Adrian Prantlab669422017-09-21 16:26:18 +0000497 }
Adrian Prantl7c649ac2017-09-14 17:01:53 +0000498 continue;
499 } else
500 consumeError(MachOOrErr.takeError());
501 if (auto ArchiveOrErr = ObjForArch.getAsArchive()) {
502 error(ObjName, errorToErrorCode(ArchiveOrErr.takeError()));
Jonas Devlieghere7080e062017-09-22 09:20:57 +0000503 Result &= handleArchive(ObjName, *ArchiveOrErr.get(), HandleObj, OS);
Adrian Prantl7c649ac2017-09-14 17:01:53 +0000504 continue;
505 } else
506 consumeError(ArchiveOrErr.takeError());
Greg Claytonce552652017-05-01 22:07:02 +0000507 }
Adrian Prantl7c649ac2017-09-14 17:01:53 +0000508 else if (auto *Arch = dyn_cast<Archive>(BinOrErr->get()))
Jonas Devlieghere7080e062017-09-22 09:20:57 +0000509 Result = handleArchive(Filename, *Arch, HandleObj, OS);
Greg Claytonce552652017-05-01 22:07:02 +0000510 return Result;
511}
512
Jonas Devlieghere7080e062017-09-22 09:20:57 +0000513static bool handleFile(StringRef Filename, HandlerFn HandleObj,
514 raw_ostream &OS) {
Adrian Prantld368c61f2017-09-13 23:07:24 +0000515 ErrorOr<std::unique_ptr<MemoryBuffer>> BuffOrErr =
516 MemoryBuffer::getFileOrSTDIN(Filename);
517 error(Filename, BuffOrErr.getError());
518 std::unique_ptr<MemoryBuffer> Buffer = std::move(BuffOrErr.get());
Jonas Devlieghere7080e062017-09-22 09:20:57 +0000519 return handleBuffer(Filename, *Buffer, HandleObj, OS);
Adrian Prantld368c61f2017-09-13 23:07:24 +0000520}
521
Adrian Prantl8eb4aa52015-12-23 21:51:13 +0000522/// If the input path is a .dSYM bundle (as created by the dsymutil tool),
523/// replace it with individual entries for each of the object files inside the
524/// bundle otherwise return the input path.
Benjamin Kramer36538ff2016-06-08 19:09:22 +0000525static std::vector<std::string> expandBundle(const std::string &InputPath) {
Adrian Prantl8eb4aa52015-12-23 21:51:13 +0000526 std::vector<std::string> BundlePaths;
527 SmallString<256> BundlePath(InputPath);
Jonas Devliegheref1567ab2018-02-08 16:31:01 +0000528 // Normalize input path. This is necessary to accept `bundle.dSYM/`.
529 sys::path::remove_dots(BundlePath);
Adrian Prantl8eb4aa52015-12-23 21:51:13 +0000530 // Manually open up the bundle to avoid introducing additional dependencies.
531 if (sys::fs::is_directory(BundlePath) &&
532 sys::path::extension(BundlePath) == ".dSYM") {
533 std::error_code EC;
534 sys::path::append(BundlePath, "Contents", "Resources", "DWARF");
535 for (sys::fs::directory_iterator Dir(BundlePath, EC), DirEnd;
536 Dir != DirEnd && !EC; Dir.increment(EC)) {
537 const std::string &Path = Dir->path();
538 sys::fs::file_status Status;
539 EC = sys::fs::status(Path, Status);
540 error(Path, EC);
541 switch (Status.type()) {
542 case sys::fs::file_type::regular_file:
543 case sys::fs::file_type::symlink_file:
544 case sys::fs::file_type::type_unknown:
545 BundlePaths.push_back(Path);
546 break;
547 default: /*ignore*/;
548 }
549 }
550 error(BundlePath, EC);
551 }
552 if (!BundlePaths.size())
553 BundlePaths.push_back(InputPath);
554 return BundlePaths;
555}
556
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +0000557int main(int argc, char **argv) {
Rui Ueyama0b9d56a2018-04-13 18:26:06 +0000558 InitLLVM X(argc, argv);
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +0000559
Reid Klecknere6c9ef32017-08-29 21:41:21 +0000560 llvm::InitializeAllTargetInfos();
561 llvm::InitializeAllTargetMCs();
562
Jonas Devlieghere2071b7a2018-05-24 11:36:57 +0000563 HideUnrelatedOptions({&DwarfDumpCategory, &SectionCategory, &ColorCategory});
Adrian Prantl623927e2017-09-12 22:32:53 +0000564 cl::ParseCommandLineOptions(
565 argc, argv,
566 "pretty-print DWARF debug information in object files"
567 " and debug info archives.\n");
568
569 if (Help) {
570 PrintHelpMessage(/*Hidden =*/false, /*Categorized =*/true);
571 return 0;
572 }
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +0000573
Jonas Devlieghereed9fa1a2018-10-23 21:51:44 +0000574 // FIXME: Audit interactions between these two options and make them
575 // compatible.
576 if (Diff && Verbose) {
577 WithColor::error() << "incompatible arguments: specifying both -diff and "
578 "-verbose is currently not supported";
579 return 0;
580 }
581
Reid Kleckner1fe96752017-09-23 01:04:42 +0000582 std::unique_ptr<ToolOutputFile> OutputFile;
Jonas Devlieghere7080e062017-09-22 09:20:57 +0000583 if (!OutputFilename.empty()) {
584 std::error_code EC;
Reid Kleckner1fe96752017-09-23 01:04:42 +0000585 OutputFile = llvm::make_unique<ToolOutputFile>(OutputFilename, EC,
Jonas Devliegherefe5f8bd2017-09-22 09:38:52 +0000586 sys::fs::F_None);
Jonas Devlieghere7080e062017-09-22 09:20:57 +0000587 error("Unable to open output file" + OutputFilename, EC);
588 // Don't remove output file if we exit with an error.
589 OutputFile->keep();
590 }
591
592 raw_ostream &OS = OutputFile ? OutputFile->os() : outs();
Adrian Prantlc97df232017-11-29 01:12:22 +0000593 bool OffsetRequested = false;
Jonas Devlieghere7080e062017-09-22 09:20:57 +0000594
Jonas Devlieghere2c1824a2017-08-31 16:44:47 +0000595 // Defaults to dumping all sections, unless brief mode is specified in which
596 // case only the .debug_info section in dumped.
Adrian Prantl8e66c2e2017-09-11 22:59:45 +0000597#define HANDLE_DWARF_SECTION(ENUM_NAME, ELF_NAME, CMDLINE_NAME) \
Adrian Prantlb311e922017-09-15 23:04:04 +0000598 if (Dump##ENUM_NAME.IsRequested) { \
599 DumpType |= DIDT_##ENUM_NAME; \
Adrian Prantlc97df232017-11-29 01:12:22 +0000600 if (Dump##ENUM_NAME.HasValue) { \
Adrian Prantlb311e922017-09-15 23:04:04 +0000601 DumpOffsets[DIDT_ID_##ENUM_NAME] = Dump##ENUM_NAME.Val; \
Adrian Prantlc97df232017-11-29 01:12:22 +0000602 OffsetRequested = true; \
603 } \
Adrian Prantlb311e922017-09-15 23:04:04 +0000604 }
Adrian Prantl8e66c2e2017-09-11 22:59:45 +0000605#include "llvm/BinaryFormat/Dwarf.def"
606#undef HANDLE_DWARF_SECTION
Adrian Prantl7ff141c2017-09-13 18:22:59 +0000607 if (DumpUUID)
608 DumpType |= DIDT_UUID;
Adrian Prantl8e66c2e2017-09-11 22:59:45 +0000609 if (DumpAll)
610 DumpType = DIDT_All;
Jonas Devlieghere2c1824a2017-08-31 16:44:47 +0000611 if (DumpType == DIDT_Null) {
Adrian Prantl3776c522017-09-11 23:05:20 +0000612 if (Verbose)
Jonas Devlieghere2c1824a2017-08-31 16:44:47 +0000613 DumpType = DIDT_All;
Adrian Prantl3776c522017-09-11 23:05:20 +0000614 else
615 DumpType = DIDT_DebugInfo;
Jonas Devlieghere2c1824a2017-08-31 16:44:47 +0000616 }
617
Adrian Prantlc97df232017-11-29 01:12:22 +0000618 // Unless dumping a specific DIE, default to --show-children.
619 if (!ShowChildren && !Verify && !OffsetRequested && Name.empty() && Find.empty())
620 ShowChildren = true;
621
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +0000622 // Defaults to a.out if no filenames specified.
Fangrui Songea4e5922018-05-08 06:21:12 +0000623 if (InputFilenames.empty())
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +0000624 InputFilenames.push_back("a.out");
625
Adrian Prantl8eb4aa52015-12-23 21:51:13 +0000626 // Expand any .dSYM bundles to the individual object files contained therein.
627 std::vector<std::string> Objects;
Benjamin Kramerb397ac42016-05-27 12:30:51 +0000628 for (const auto &F : InputFilenames) {
Adrian Prantl8eb4aa52015-12-23 21:51:13 +0000629 auto Objs = expandBundle(F);
630 Objects.insert(Objects.end(), Objs.begin(), Objs.end());
631 }
632
Greg Claytonce552652017-05-01 22:07:02 +0000633 if (Verify) {
634 // If we encountered errors during verify, exit with a non-zero exit status.
Fangrui Song7d3ea702018-10-19 06:12:02 +0000635 if (!all_of(Objects, [&](std::string Object) {
Jonas Devlieghere7080e062017-09-22 09:20:57 +0000636 return handleFile(Object, verifyObjectFile, OS);
Adrian Prantld368c61f2017-09-13 23:07:24 +0000637 }))
Greg Claytonce552652017-05-01 22:07:02 +0000638 exit(1);
Adrian Prantleadc3132017-10-06 20:24:34 +0000639 } else if (Statistics)
640 for (auto Object : Objects)
641 handleFile(Object, collectStatsForObjectFile, OS);
642 else
Adrian Prantl47842dc2017-09-18 22:11:33 +0000643 for (auto Object : Objects)
Jonas Devlieghere7080e062017-09-22 09:20:57 +0000644 handleFile(Object, dumpObjectFile, OS);
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +0000645
Davide Italiano5e7aab02015-07-26 05:35:59 +0000646 return EXIT_SUCCESS;
Benjamin Kramer72c0d7f2011-09-13 19:42:23 +0000647}