1//===-- llvm-dwarfdump.cpp - Debug info dumping utility for llvm ----------===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===----------------------------------------------------------------------===//
8//
9// This program is a utility that works like "dwarfdump".
10//
11//===----------------------------------------------------------------------===//
12
13#include "llvm-dwarfdump.h"
14#include "llvm/ADT/MapVector.h"
15#include "llvm/ADT/STLExtras.h"
16#include "llvm/ADT/SmallSet.h"
17#include "llvm/ADT/SmallVectorExtras.h"
18#include "llvm/ADT/StringSet.h"
19#include "llvm/DebugInfo/DIContext.h"
20#include "llvm/DebugInfo/DWARF/DWARFAcceleratorTable.h"
21#include "llvm/DebugInfo/DWARF/DWARFCompileUnit.h"
22#include "llvm/DebugInfo/DWARF/DWARFContext.h"
23#include "llvm/MC/MCRegisterInfo.h"
24#include "llvm/MC/TargetRegistry.h"
25#include "llvm/Object/Archive.h"
26#include "llvm/Object/MachOUniversal.h"
27#include "llvm/Object/ObjectFile.h"
28#include "llvm/Support/CommandLine.h"
29#include "llvm/Support/Debug.h"
30#include "llvm/Support/Format.h"
31#include "llvm/Support/FormatVariadic.h"
32#include "llvm/Support/InitLLVM.h"
33#include "llvm/Support/MemoryBuffer.h"
34#include "llvm/Support/Parallel.h"
35#include "llvm/Support/Path.h"
36#include "llvm/Support/Regex.h"
37#include "llvm/Support/TargetSelect.h"
38#include "llvm/Support/Threading.h"
39#include "llvm/Support/ToolOutputFile.h"
40#include "llvm/Support/WithColor.h"
41#include "llvm/Support/raw_ostream.h"
42#include "llvm/TargetParser/Triple.h"
43#include <cstdlib>
44
45using namespace llvm;
46using namespace llvm::dwarfdump;
47using namespace llvm::object;
48
49namespace {
50/// Parser for options that take an optional offest argument.
51/// @{
52struct OffsetOption {
53 uint64_t Val = 0;
54 bool HasValue = false;
55 bool IsRequested = false;
56};
57struct BoolOption : public OffsetOption {};
58} // namespace
59
60namespace llvm {
61namespace cl {
62template <>
63class parser<OffsetOption> final : public basic_parser<OffsetOption> {
64public:
65 parser(Option &O) : basic_parser(O) {}
66
67 /// Return true on error.
68 bool parse(Option &O, StringRef ArgName, StringRef Arg, OffsetOption &Val) {
69 if (Arg == "") {
70 Val.Val = 0;
71 Val.HasValue = false;
72 Val.IsRequested = true;
73 return false;
74 }
75 if (Arg.getAsInteger(Radix: 0, Result&: Val.Val))
76 return O.error(Message: "'" + Arg + "' value invalid for integer argument");
77 Val.HasValue = true;
78 Val.IsRequested = true;
79 return false;
80 }
81
82 enum ValueExpected getValueExpectedFlagDefault() const {
83 return ValueOptional;
84 }
85
86 StringRef getValueName() const override { return StringRef("offset"); }
87
88 void printOptionDiff(const Option &O, OffsetOption V, OptVal Default,
89 size_t GlobalWidth) const {
90 printOptionName(O, GlobalWidth);
91 outs() << "[=offset]";
92 }
93};
94
95template <> class parser<BoolOption> final : public basic_parser<BoolOption> {
96public:
97 parser(Option &O) : basic_parser(O) {}
98
99 /// Return true on error.
100 bool parse(Option &O, StringRef ArgName, StringRef Arg, BoolOption &Val) {
101 if (Arg != "")
102 return O.error(Message: "this is a flag and does not take a value");
103 Val.Val = 0;
104 Val.HasValue = false;
105 Val.IsRequested = true;
106 return false;
107 }
108
109 enum ValueExpected getValueExpectedFlagDefault() const {
110 return ValueOptional;
111 }
112
113 StringRef getValueName() const override { return StringRef(); }
114
115 void printOptionDiff(const Option &O, OffsetOption V, OptVal Default,
116 size_t GlobalWidth) const {
117 printOptionName(O, GlobalWidth);
118 }
119};
120} // namespace cl
121} // namespace llvm
122
123/// @}
124/// Command line options.
125/// @{
126
127namespace {
128using namespace cl;
129
130enum ErrorDetailLevel {
131 OnlyDetailsNoSummary,
132 NoDetailsOnlySummary,
133 NoDetailsOrSummary,
134 BothDetailsAndSummary,
135 Unspecified
136};
137
138OptionCategory DwarfDumpCategory("Specific Options");
139static list<std::string>
140 InputFilenames(Positional, desc("<input object files or .dSYM bundles>"),
141 cat(DwarfDumpCategory));
142
143cl::OptionCategory SectionCategory("Section-specific Dump Options",
144 "These control which sections are dumped. "
145 "Where applicable these parameters take an "
146 "optional =<offset> argument to dump only "
147 "the entry at the specified offset.");
148
149static opt<bool> DumpAll("all", desc("Dump all debug info sections"),
150 cat(SectionCategory));
151static alias DumpAllAlias("a", desc("Alias for --all"), aliasopt(DumpAll),
152 cl::NotHidden);
153
154// Options for dumping specific sections.
155static unsigned DumpType = DIDT_Null;
156static std::array<std::optional<uint64_t>, (unsigned)DIDT_ID_Count> DumpOffsets;
157#define HANDLE_DWARF_SECTION(ENUM_NAME, ELF_NAME, CMDLINE_NAME, OPTION) \
158 static opt<OPTION> Dump##ENUM_NAME(CMDLINE_NAME, \
159 desc("Dump the " ELF_NAME " section"), \
160 cat(SectionCategory));
161#include "llvm/BinaryFormat/Dwarf.def"
162#undef HANDLE_DWARF_SECTION
163
164// The aliased DumpDebugFrame is created by the Dwarf.def x-macro just above.
165static alias DumpDebugFrameAlias("eh-frame", desc("Alias for --debug-frame"),
166 NotHidden, cat(SectionCategory),
167 aliasopt(DumpDebugFrame));
168static list<std::string>
169 ArchFilters("arch",
170 desc("Dump debug information for the specified CPU "
171 "architecture only. Architectures may be specified by "
172 "name or by number. This option can be specified "
173 "multiple times, once for each desired architecture."),
174 cat(DwarfDumpCategory));
175static opt<bool>
176 Diff("diff",
177 desc("Emit diff-friendly output by omitting offsets and addresses."),
178 cat(DwarfDumpCategory));
179static list<std::string>
180 Find("find",
181 desc("Search for the exact match for <name> in the accelerator tables "
182 "and print the matching debug information entries. When no "
183 "accelerator tables are available, the slower but more complete "
184 "-name option can be used instead."),
185 value_desc("name"), cat(DwarfDumpCategory));
186static alias FindAlias("f", desc("Alias for --find."), aliasopt(Find),
187 cl::NotHidden);
188static opt<bool> FindAllApple(
189 "find-all-apple",
190 desc("Print every debug information entry in the accelerator tables."),
191 cat(DwarfDumpCategory));
192static opt<bool> IgnoreCase("ignore-case",
193 desc("Ignore case distinctions when using --name."),
194 value_desc("i"), cat(DwarfDumpCategory));
195static opt<bool> DumpNonSkeleton(
196 "dwo",
197 desc("Dump the non skeleton DIE in the .dwo or .dwp file after dumping the "
198 "skeleton DIE from the main executable. This allows dumping the .dwo "
199 "files with resolved addresses."),
200 value_desc("d"), cat(DwarfDumpCategory));
201
202static alias IgnoreCaseAlias("i", desc("Alias for --ignore-case."),
203 aliasopt(IgnoreCase), cl::NotHidden);
204static list<std::string> Name(
205 "name",
206 desc("Find and print all debug info entries whose name "
207 "(DW_AT_name/DW_AT_linkage_name attribute) matches the exact text "
208 "in <pattern>. When used with the the -regex option <pattern> is "
209 "interpreted as a regular expression."),
210 value_desc("pattern"), cat(DwarfDumpCategory));
211static alias NameAlias("n", desc("Alias for --name"), aliasopt(Name),
212 cl::NotHidden);
213static opt<uint64_t>
214 Lookup("lookup",
215 desc("Lookup <address> in the debug information and print out any "
216 "available file, function, block and line table details."),
217 value_desc("address"), cat(DwarfDumpCategory));
218static opt<std::string>
219 OutputFilename("o", cl::init(Val: "-"),
220 cl::desc("Redirect output to the specified file."),
221 cl::value_desc("filename"), cat(DwarfDumpCategory));
222static alias OutputFilenameAlias("out-file", desc("Alias for -o."),
223 aliasopt(OutputFilename));
224static opt<bool> UseRegex(
225 "regex",
226 desc("Treat any <pattern> strings as regular "
227 "expressions when searching with --name. If --ignore-case is also "
228 "specified, the regular expression becomes case-insensitive."),
229 cat(DwarfDumpCategory));
230static alias RegexAlias("x", desc("Alias for --regex"), aliasopt(UseRegex),
231 cl::NotHidden);
232static opt<bool>
233 ShowChildren("show-children",
234 desc("Show a debug info entry's children when selectively "
235 "printing entries."),
236 cat(DwarfDumpCategory));
237static alias ShowChildrenAlias("c", desc("Alias for --show-children."),
238 aliasopt(ShowChildren), cl::NotHidden);
239static opt<bool>
240 ShowParents("show-parents",
241 desc("Show a debug info entry's parents when selectively "
242 "printing entries."),
243 cat(DwarfDumpCategory));
244static alias ShowParentsAlias("p", desc("Alias for --show-parents."),
245 aliasopt(ShowParents), cl::NotHidden);
246
247static list<std::string> FilterChildTag(
248 "filter-child-tag",
249 desc("When --show-children is specified, show only DIEs with the "
250 "specified DWARF tags."),
251 value_desc("list of DWARF tags"), cat(DwarfDumpCategory));
252static alias FilterChildTagAlias("t", desc("Alias for --filter-child-tag."),
253 aliasopt(FilterChildTag), cl::NotHidden);
254
255static opt<bool>
256 ShowForm("show-form",
257 desc("Show DWARF form types after the DWARF attribute types."),
258 cat(DwarfDumpCategory));
259static alias ShowFormAlias("F", desc("Alias for --show-form."),
260 aliasopt(ShowForm), cat(DwarfDumpCategory),
261 cl::NotHidden);
262static opt<unsigned>
263 ChildRecurseDepth("recurse-depth",
264 desc("Only recurse to a depth of N when displaying "
265 "children of debug info entries."),
266 cat(DwarfDumpCategory), init(Val: -1U), value_desc("N"));
267static alias ChildRecurseDepthAlias("r", desc("Alias for --recurse-depth."),
268 aliasopt(ChildRecurseDepth), cl::NotHidden);
269static opt<unsigned>
270 ParentRecurseDepth("parent-recurse-depth",
271 desc("Only recurse to a depth of N when displaying "
272 "parents of debug info entries."),
273 cat(DwarfDumpCategory), init(Val: -1U), value_desc("N"));
274static opt<bool>
275 SummarizeTypes("summarize-types",
276 desc("Abbreviate the description of type unit entries."),
277 cat(DwarfDumpCategory));
278static cl::opt<bool>
279 Statistics("statistics",
280 cl::desc("Emit JSON-formatted debug info quality metrics."),
281 cat(DwarfDumpCategory));
282static cl::opt<bool>
283 ShowSectionSizes("show-section-sizes",
284 cl::desc("Show the sizes of all debug sections, "
285 "expressed in bytes."),
286 cat(DwarfDumpCategory));
287static cl::opt<bool> ManuallyGenerateUnitIndex(
288 "manually-generate-unit-index",
289 cl::desc("if the input is dwp file, parse .debug_info "
290 "section and use it to populate "
291 "DW_SECT_INFO contributions in cu-index. "
292 "For DWARF5 it also populated TU Index."),
293 cl::init(Val: false), cl::Hidden, cl::cat(DwarfDumpCategory));
294static cl::opt<bool>
295 ShowSources("show-sources",
296 cl::desc("Show the sources across all compilation units."),
297 cat(DwarfDumpCategory));
298static opt<bool> Verify("verify", desc("Verify the DWARF debug info."),
299 cat(DwarfDumpCategory));
300static opt<unsigned> VerifyNumThreads(
301 "verify-num-threads", init(Val: 1),
302 desc("Number of threads to use for --verify. Single threaded verification "
303 "is the default unless this option is specified. If 0 is specified, "
304 "maximum hardware threads will be used. This can cause the "
305 "output to be non determinisitic, but can speed up verification and "
306 "is useful when running with the summary only or JSON summary modes."),
307 cat(DwarfDumpCategory));
308static opt<ErrorDetailLevel> ErrorDetails(
309 "error-display", init(Val: Unspecified),
310 desc("Set the level of detail and summary to display when verifying "
311 "(implies --verify)"),
312 values(clEnumValN(NoDetailsOrSummary, "quiet",
313 "Only display whether errors occurred."),
314 clEnumValN(NoDetailsOnlySummary, "summary",
315 "Display only a summary of the errors found."),
316 clEnumValN(OnlyDetailsNoSummary, "details",
317 "Display each error in detail but no summary."),
318 clEnumValN(BothDetailsAndSummary, "full",
319 "Display each error as well as a summary. [default]")),
320 cat(DwarfDumpCategory));
321static opt<std::string> JsonErrSummaryFile(
322 "verify-json", init(Val: ""),
323 desc("Output JSON-formatted error summary to the specified file. "
324 "(Implies --verify)"),
325 value_desc("filename.json"), cat(DwarfDumpCategory));
326static opt<bool> Quiet("quiet", desc("Use with -verify to not emit to STDOUT."),
327 cat(DwarfDumpCategory));
328static opt<bool> DumpUUID("uuid", desc("Show the UUID for each architecture."),
329 cat(DwarfDumpCategory));
330static alias DumpUUIDAlias("u", desc("Alias for --uuid."), aliasopt(DumpUUID),
331 cl::NotHidden);
332static opt<bool> Verbose("verbose",
333 desc("Print more low-level encoding details."),
334 cat(DwarfDumpCategory));
335static alias VerboseAlias("v", desc("Alias for --verbose."), aliasopt(Verbose),
336 cat(DwarfDumpCategory), cl::NotHidden);
337static opt<bool>
338 ShowVariableCoverage("show-variable-coverage",
339 desc("Show per-variable coverage metrics."),
340 cat(DwarfDumpCategory));
341static opt<bool> CombineInstances(
342 "combine-inline-variable-instances",
343 desc(
344 "Use with --show-variable-coverage to average variable coverage across "
345 "inlined subroutine instances instead of printing them separately."),
346 cat(DwarfDumpCategory));
347static cl::extrahelp
348 HelpResponse("\nPass @FILE as argument to read options from FILE.\n");
349} // namespace
350/// @}
351//===----------------------------------------------------------------------===//
352
353static llvm::SmallVector<unsigned>
354makeTagVector(const list<std::string> &TagStrings) {
355 return llvm::map_to_vector(C: TagStrings, F: [](const std::string &Tag) {
356 return llvm::dwarf::getTag(TagString: Tag);
357 });
358}
359
360static void error(Error Err) {
361 if (!Err)
362 return;
363 WithColor::error() << toString(E: std::move(Err)) << "\n";
364 exit(status: 1);
365}
366
367static void error(StringRef Prefix, Error Err) {
368 if (!Err)
369 return;
370 WithColor::error() << Prefix << ": " << toString(E: std::move(Err)) << "\n";
371 exit(status: 1);
372}
373
374static void error(StringRef Prefix, std::error_code EC) {
375 error(Prefix, Err: errorCodeToError(EC));
376}
377
378static DIDumpOptions getDumpOpts(DWARFContext &C) {
379 DIDumpOptions DumpOpts;
380 DumpOpts.DumpType = DumpType;
381 DumpOpts.ChildRecurseDepth = ChildRecurseDepth;
382 DumpOpts.ParentRecurseDepth = ParentRecurseDepth;
383 DumpOpts.ShowAddresses = !Diff;
384 DumpOpts.ShowChildren = ShowChildren;
385 DumpOpts.ShowParents = ShowParents;
386 DumpOpts.FilterChildTag = makeTagVector(TagStrings: FilterChildTag);
387 DumpOpts.ShowForm = ShowForm;
388 DumpOpts.SummarizeTypes = SummarizeTypes;
389 DumpOpts.Verbose = Verbose;
390 DumpOpts.DumpNonSkeleton = DumpNonSkeleton;
391 DumpOpts.RecoverableErrorHandler = C.getRecoverableErrorHandler();
392 // In -verify mode, print DIEs without children in error messages.
393 if (Verify) {
394 DumpOpts.Verbose = ErrorDetails != NoDetailsOnlySummary &&
395 ErrorDetails != NoDetailsOrSummary;
396 DumpOpts.ShowAggregateErrors = ErrorDetails != OnlyDetailsNoSummary &&
397 ErrorDetails != NoDetailsOnlySummary;
398 DumpOpts.JsonErrSummaryFile = JsonErrSummaryFile;
399 return DumpOpts.noImplicitRecursion();
400 }
401 return DumpOpts;
402}
403
404static uint32_t getCPUType(MachOObjectFile &MachO) {
405 if (MachO.is64Bit())
406 return MachO.getHeader64().cputype;
407 else
408 return MachO.getHeader().cputype;
409}
410
411/// Return true if the object file has not been filtered by an --arch option.
412static bool filterArch(ObjectFile &Obj) {
413 if (ArchFilters.empty())
414 return true;
415
416 if (auto *MachO = dyn_cast<MachOObjectFile>(Val: &Obj)) {
417 for (const StringRef Arch : ArchFilters) {
418 // Match architecture number.
419 unsigned Value;
420 if (!Arch.getAsInteger(Radix: 0, Result&: Value))
421 if (Value == getCPUType(MachO&: *MachO))
422 return true;
423
424 // Match as name.
425 if (MachO->getArchTriple().getArchName() == Triple(Arch).getArchName())
426 return true;
427 }
428 }
429 return false;
430}
431
432using HandlerFn = std::function<bool(ObjectFile &, DWARFContext &DICtx,
433 const Twine &, raw_ostream &)>;
434
435/// Print only DIEs that have a certain name.
436static bool filterByName(
437 const StringSet<> &Names, DWARFDie Die, StringRef NameRef, raw_ostream &OS,
438 std::function<StringRef(uint64_t RegNum, bool IsEH)> GetNameForDWARFReg) {
439 DIDumpOptions DumpOpts = getDumpOpts(C&: Die.getDwarfUnit()->getContext());
440 DumpOpts.GetNameForDWARFReg = GetNameForDWARFReg;
441 std::string Name =
442 (IgnoreCase && !UseRegex) ? NameRef.lower() : NameRef.str();
443 if (UseRegex) {
444 // Match regular expression.
445 for (auto Pattern : Names.keys()) {
446 Regex RE(Pattern, IgnoreCase ? Regex::IgnoreCase : Regex::NoFlags);
447 std::string Error;
448 if (!RE.isValid(Error)) {
449 errs() << "error in regular expression: " << Error << "\n";
450 exit(status: 1);
451 }
452 if (RE.match(String: Name)) {
453 Die.dump(OS, indent: 0, DumpOpts);
454 return true;
455 }
456 }
457 } else if (Names.count(Key: Name)) {
458 // Match full text.
459 Die.dump(OS, indent: 0, DumpOpts);
460 return true;
461 }
462 return false;
463}
464
465/// Print only DIEs that have a certain name.
466static void filterByName(
467 const StringSet<> &Names, DWARFContext::unit_iterator_range CUs,
468 raw_ostream &OS,
469 std::function<StringRef(uint64_t RegNum, bool IsEH)> GetNameForDWARFReg) {
470 auto filterDieNames = [&](DWARFUnit *Unit) {
471 for (const auto &Entry : Unit->dies()) {
472 DWARFDie Die = {Unit, &Entry};
473 if (const char *Name = Die.getName(Kind: DINameKind::ShortName))
474 if (filterByName(Names, Die, NameRef: Name, OS, GetNameForDWARFReg))
475 continue;
476 if (const char *Name = Die.getName(Kind: DINameKind::LinkageName))
477 filterByName(Names, Die, NameRef: Name, OS, GetNameForDWARFReg);
478 }
479 };
480 for (const auto &CU : CUs) {
481 filterDieNames(CU.get());
482 if (DumpNonSkeleton) {
483 // If we have split DWARF, then recurse down into the .dwo files as well.
484 DWARFDie CUDie = CU->getUnitDIE(ExtractUnitDIEOnly: false);
485 DWARFDie CUNonSkeletonDie = CU->getNonSkeletonUnitDIE(ExtractUnitDIEOnly: false);
486 // If we have a DWO file, we need to search it as well
487 if (CUNonSkeletonDie && CUDie != CUNonSkeletonDie)
488 filterDieNames(CUNonSkeletonDie.getDwarfUnit());
489 }
490 }
491}
492
493static void getDies(DWARFContext &DICtx, const AppleAcceleratorTable &Accel,
494 StringRef Name, SmallVectorImpl<DWARFDie> &Dies) {
495 for (const auto &Entry : Accel.equal_range(Key: Name)) {
496 if (std::optional<uint64_t> Off = Entry.getDIESectionOffset()) {
497 if (DWARFDie Die = DICtx.getDIEForOffset(Offset: *Off))
498 Dies.push_back(Elt: Die);
499 }
500 }
501}
502
503static DWARFDie toDie(const DWARFDebugNames::Entry &Entry,
504 DWARFContext &DICtx) {
505 std::optional<uint64_t> CUOff = Entry.getCUOffset();
506 std::optional<uint64_t> Off = Entry.getDIEUnitOffset();
507 if (!CUOff || !Off)
508 return DWARFDie();
509
510 DWARFCompileUnit *CU = DICtx.getCompileUnitForOffset(Offset: *CUOff);
511 if (!CU)
512 return DWARFDie();
513
514 if (std::optional<uint64_t> DWOId = CU->getDWOId()) {
515 // This is a skeleton unit. Look up the DIE in the DWO unit.
516 CU = DICtx.getDWOCompileUnitForHash(Hash: *DWOId);
517 if (!CU)
518 return DWARFDie();
519 }
520
521 return CU->getDIEForOffset(Offset: CU->getOffset() + *Off);
522}
523
524static void getDies(DWARFContext &DICtx, const DWARFDebugNames &Accel,
525 StringRef Name, SmallVectorImpl<DWARFDie> &Dies) {
526 for (const auto &Entry : Accel.equal_range(Key: Name)) {
527 if (DWARFDie Die = toDie(Entry, DICtx))
528 Dies.push_back(Elt: Die);
529 }
530}
531
532/// Print only DIEs that have a certain name.
533static void filterByAccelName(
534 ArrayRef<std::string> Names, DWARFContext &DICtx, raw_ostream &OS,
535 std::function<StringRef(uint64_t RegNum, bool IsEH)> GetNameForDWARFReg) {
536 SmallVector<DWARFDie, 4> Dies;
537 for (const auto &Name : Names) {
538 getDies(DICtx, Accel: DICtx.getAppleNames(), Name, Dies);
539 getDies(DICtx, Accel: DICtx.getAppleTypes(), Name, Dies);
540 getDies(DICtx, Accel: DICtx.getAppleNamespaces(), Name, Dies);
541 getDies(DICtx, Accel: DICtx.getDebugNames(), Name, Dies);
542 }
543 llvm::sort(C&: Dies);
544 Dies.erase(CS: llvm::unique(R&: Dies), CE: Dies.end());
545
546 DIDumpOptions DumpOpts = getDumpOpts(C&: DICtx);
547 DumpOpts.GetNameForDWARFReg = GetNameForDWARFReg;
548 for (DWARFDie Die : Dies)
549 Die.dump(OS, indent: 0, DumpOpts);
550}
551
552/// Print all DIEs in apple accelerator tables
553static void findAllApple(
554 DWARFContext &DICtx, raw_ostream &OS,
555 std::function<StringRef(uint64_t RegNum, bool IsEH)> GetNameForDWARFReg) {
556 MapVector<StringRef, llvm::SmallSet<DWARFDie, 2>> NameToDies;
557
558 auto PushDIEs = [&](const AppleAcceleratorTable &Accel) {
559 for (const auto &Entry : Accel.entries()) {
560 if (std::optional<uint64_t> Off = Entry.BaseEntry.getDIESectionOffset()) {
561 std::optional<StringRef> MaybeName = Entry.readName();
562 DWARFDie Die = DICtx.getDIEForOffset(Offset: *Off);
563 if (Die && MaybeName)
564 NameToDies[*MaybeName].insert(V: Die);
565 }
566 }
567 };
568
569 PushDIEs(DICtx.getAppleNames());
570 PushDIEs(DICtx.getAppleNamespaces());
571 PushDIEs(DICtx.getAppleTypes());
572
573 DIDumpOptions DumpOpts = getDumpOpts(C&: DICtx);
574 DumpOpts.GetNameForDWARFReg = GetNameForDWARFReg;
575 for (const auto &[Name, Dies] : NameToDies) {
576 OS << llvm::formatv(Fmt: "\nApple accelerator entries with name = \"{0}\":\n",
577 Vals: Name);
578 for (DWARFDie Die : Dies)
579 Die.dump(OS, indent: 0, DumpOpts);
580 }
581}
582
583/// Handle the --lookup option and dump the DIEs and line info for the given
584/// address.
585/// TODO: specified Address for --lookup option could relate for several
586/// different sections(in case not-linked object file). llvm-dwarfdump
587/// need to do something with this: extend lookup option with section
588/// information or probably display all matched entries, or something else...
589static bool lookup(ObjectFile &Obj, DWARFContext &DICtx, uint64_t Address,
590 raw_ostream &OS) {
591 auto DIEsForAddr = DICtx.getDIEsForAddress(Address: Lookup, CheckDWO: DumpNonSkeleton);
592
593 if (!DIEsForAddr)
594 return false;
595
596 DIDumpOptions DumpOpts = getDumpOpts(C&: DICtx);
597 DumpOpts.ChildRecurseDepth = 0;
598 DIEsForAddr.CompileUnit->dump(OS, DumpOpts);
599 if (DIEsForAddr.FunctionDIE) {
600 DIEsForAddr.FunctionDIE.dump(OS, indent: 2, DumpOpts);
601 if (DIEsForAddr.BlockDIE)
602 DIEsForAddr.BlockDIE.dump(OS, indent: 4, DumpOpts);
603 }
604
605 // TODO: it is neccessary to set proper SectionIndex here.
606 // object::SectionedAddress::UndefSection works for only absolute addresses.
607 if (DILineInfo LineInfo =
608 DICtx
609 .getLineInfoForAddress(
610 Address: {.Address: Lookup, .SectionIndex: object::SectionedAddress::UndefSection})
611 .value_or(u: DILineInfo())) {
612 LineInfo.dump(OS);
613 }
614
615 return true;
616}
617
618// Collect all sources referenced from the given line table, scoped to the given
619// CU compilation directory.
620static bool collectLineTableSources(const DWARFDebugLine::LineTable &LT,
621 StringRef CompDir,
622 std::vector<std::string> &Sources) {
623 bool Result = true;
624 std::optional<uint64_t> LastIndex = LT.getLastValidFileIndex();
625 for (uint64_t I = LT.hasFileAtIndex(FileIndex: 0) ? 0 : 1,
626 E = LastIndex ? *LastIndex + 1 : 0;
627 I < E; ++I) {
628 std::string Path;
629 Result &= LT.getFileNameByIndex(
630 FileIndex: I, CompDir, Kind: DILineInfoSpecifier::FileLineInfoKind::AbsoluteFilePath,
631 Result&: Path);
632 Sources.push_back(x: std::move(Path));
633 }
634 return Result;
635}
636
637static bool collectObjectSources(ObjectFile &Obj, DWARFContext &DICtx,
638 const Twine &Filename, raw_ostream &OS) {
639 bool Result = true;
640 std::vector<std::string> Sources;
641
642 bool HasCompileUnits = false;
643 for (const auto &CU : DICtx.compile_units()) {
644 HasCompileUnits = true;
645 // Extract paths from the line table for this CU. This allows combining the
646 // compilation directory with the line information, in case both the include
647 // directory and file names in the line table are relative.
648 const DWARFDebugLine::LineTable *LT = DICtx.getLineTableForUnit(U: CU.get());
649 StringRef CompDir = CU->getCompilationDir();
650 if (LT) {
651 Result &= collectLineTableSources(LT: *LT, CompDir, Sources);
652 } else {
653 // Since there's no line table for this CU, collect the name from the CU
654 // itself.
655 const char *Name = CU->getUnitDIE().getShortName();
656 if (!Name) {
657 WithColor::warning()
658 << Filename << ": missing name for compilation unit\n";
659 continue;
660 }
661 SmallString<64> AbsName;
662 if (sys::path::is_relative(path: Name, style: sys::path::Style::posix) &&
663 sys::path::is_relative(path: Name, style: sys::path::Style::windows))
664 AbsName = CompDir;
665 sys::path::append(path&: AbsName, a: Name);
666 Sources.push_back(x: std::string(AbsName));
667 }
668 }
669
670 if (!HasCompileUnits) {
671 // Since there's no compile units available, walk the line tables and
672 // extract out any referenced paths.
673 DWARFDataExtractor LineData(DICtx.getDWARFObj(),
674 DICtx.getDWARFObj().getLineSection(),
675 DICtx.isLittleEndian(), 0);
676 DWARFDebugLine::SectionParser Parser(LineData, DICtx, DICtx.normal_units());
677 while (!Parser.done()) {
678 const auto RecoverableErrorHandler = [&](Error Err) {
679 Result = false;
680 WithColor::defaultErrorHandler(Err: std::move(Err));
681 };
682 void (*UnrecoverableErrorHandler)(Error Err) = error;
683
684 DWARFDebugLine::LineTable LT =
685 Parser.parseNext(RecoverableErrorHandler, UnrecoverableErrorHandler);
686 Result &= collectLineTableSources(LT, /*CompDir=*/"", Sources);
687 }
688 }
689
690 // Dedup and order the sources.
691 llvm::sort(C&: Sources);
692 Sources.erase(first: llvm::unique(R&: Sources), last: Sources.end());
693
694 for (StringRef Name : Sources)
695 OS << Name << "\n";
696 return Result;
697}
698
699static std::unique_ptr<MCRegisterInfo>
700createRegInfo(const object::ObjectFile &Obj) {
701 std::unique_ptr<MCRegisterInfo> MCRegInfo;
702 Triple TT;
703 TT.setArch(Kind: Triple::ArchType(Obj.getArch()));
704 TT.setVendor(Triple::UnknownVendor);
705 TT.setOS(Triple::UnknownOS);
706 std::string TargetLookupError;
707 const Target *TheTarget = TargetRegistry::lookupTarget(TheTriple: TT, Error&: TargetLookupError);
708 if (!TargetLookupError.empty())
709 return nullptr;
710 MCRegInfo.reset(p: TheTarget->createMCRegInfo(TT));
711 return MCRegInfo;
712}
713
714static bool dumpObjectFile(ObjectFile &Obj, DWARFContext &DICtx,
715 const Twine &Filename, raw_ostream &OS) {
716
717 auto MCRegInfo = createRegInfo(Obj);
718 if (!MCRegInfo)
719 logAllUnhandledErrors(E: createStringError(EC: inconvertibleErrorCode(),
720 S: "Error in creating MCRegInfo"),
721 OS&: errs(), ErrorBanner: Filename.str() + ": ");
722
723 auto GetRegName = [&MCRegInfo](uint64_t DwarfRegNum, bool IsEH) -> StringRef {
724 if (!MCRegInfo)
725 return {};
726 if (std::optional<MCRegister> LLVMRegNum =
727 MCRegInfo->getLLVMRegNum(RegNum: DwarfRegNum, isEH: IsEH))
728 if (const char *RegName = MCRegInfo->getName(RegNo: *LLVMRegNum))
729 return StringRef(RegName);
730 return {};
731 };
732
733 // The UUID dump already contains all the same information.
734 if (!(DumpType & DIDT_UUID) || DumpType == DIDT_All)
735 OS << Filename << ":\tfile format " << Obj.getFileFormatName() << '\n';
736
737 // Handle the --lookup option.
738 if (Lookup)
739 return lookup(Obj, DICtx, Address: Lookup, OS);
740
741 // Handle the --name option.
742 if (!Name.empty()) {
743 StringSet<> Names;
744 for (const auto &name : Name)
745 Names.insert(key: (IgnoreCase && !UseRegex) ? StringRef(name).lower() : name);
746
747 filterByName(Names, CUs: DICtx.normal_units(), OS, GetNameForDWARFReg: GetRegName);
748 filterByName(Names, CUs: DICtx.dwo_units(), OS, GetNameForDWARFReg: GetRegName);
749 return true;
750 }
751
752 // Handle the --find option and lower it to --debug-info=<offset>.
753 if (!Find.empty()) {
754 filterByAccelName(Names: Find, DICtx, OS, GetNameForDWARFReg: GetRegName);
755 return true;
756 }
757
758 // Handle the --find-all-apple option and lower it to --debug-info=<offset>.
759 if (FindAllApple) {
760 findAllApple(DICtx, OS, GetNameForDWARFReg: GetRegName);
761 return true;
762 }
763
764 // Dump the complete DWARF structure.
765 auto DumpOpts = getDumpOpts(C&: DICtx);
766 DumpOpts.GetNameForDWARFReg = GetRegName;
767 DICtx.dump(OS, DumpOpts, DumpOffsets);
768 return true;
769}
770
771static bool verifyObjectFile(ObjectFile &Obj, DWARFContext &DICtx,
772 const Twine &Filename, raw_ostream &OS) {
773 // Verify the DWARF and exit with non-zero exit status if verification
774 // fails.
775 raw_ostream &stream = Quiet ? nulls() : OS;
776 stream << "Verifying " << Filename.str() << ":\tfile format "
777 << Obj.getFileFormatName() << "\n";
778 bool Result = DICtx.verify(OS&: stream, DumpOpts: getDumpOpts(C&: DICtx));
779 if (Result)
780 stream << "No errors.\n";
781 else
782 stream << "Errors detected.\n";
783 return Result;
784}
785
786static bool handleBuffer(StringRef Filename, MemoryBufferRef Buffer,
787 HandlerFn HandleObj, raw_ostream &OS);
788
789static bool handleArchive(StringRef Filename, Archive &Arch,
790 HandlerFn HandleObj, raw_ostream &OS) {
791 bool Result = true;
792 Error Err = Error::success();
793 for (const auto &Child : Arch.children(Err)) {
794 auto BuffOrErr = Child.getMemoryBufferRef();
795 error(Prefix: Filename, Err: BuffOrErr.takeError());
796 auto NameOrErr = Child.getName();
797 error(Prefix: Filename, Err: NameOrErr.takeError());
798 std::string Name = (Filename + "(" + NameOrErr.get() + ")").str();
799 Result &= handleBuffer(Filename: Name, Buffer: BuffOrErr.get(), HandleObj, OS);
800 }
801 error(Prefix: Filename, Err: std::move(Err));
802
803 return Result;
804}
805
806static bool handleBuffer(StringRef Filename, MemoryBufferRef Buffer,
807 HandlerFn HandleObj, raw_ostream &OS) {
808 Expected<std::unique_ptr<Binary>> BinOrErr = object::createBinary(Source: Buffer);
809 error(Prefix: Filename, Err: BinOrErr.takeError());
810
811 bool Result = true;
812 auto RecoverableErrorHandler = [&](Error E) {
813 Result = false;
814 WithColor::defaultErrorHandler(Err: std::move(E));
815 };
816 if (auto *Obj = dyn_cast<ObjectFile>(Val: BinOrErr->get())) {
817 if (filterArch(Obj&: *Obj)) {
818 std::unique_ptr<DWARFContext> DICtx = DWARFContext::create(
819 Obj: *Obj, RelocAction: DWARFContext::ProcessDebugRelocations::Process, L: nullptr, DWPName: "",
820 RecoverableErrorHandler, WarningHandler: WithColor::defaultWarningHandler,
821 /*ThreadSafe=*/true);
822 DICtx->setParseCUTUIndexManually(ManuallyGenerateUnitIndex);
823 if (!HandleObj(*Obj, *DICtx, Filename, OS))
824 Result = false;
825 }
826 } else if (auto *Fat = dyn_cast<MachOUniversalBinary>(Val: BinOrErr->get()))
827 for (auto &ObjForArch : Fat->objects()) {
828 std::string ObjName =
829 (Filename + "(" + ObjForArch.getArchFlagName() + ")").str();
830 if (auto MachOOrErr = ObjForArch.getAsObjectFile()) {
831 auto &Obj = **MachOOrErr;
832 if (filterArch(Obj)) {
833 std::unique_ptr<DWARFContext> DICtx = DWARFContext::create(
834 Obj, RelocAction: DWARFContext::ProcessDebugRelocations::Process, L: nullptr, DWPName: "",
835 RecoverableErrorHandler);
836 if (!HandleObj(Obj, *DICtx, ObjName, OS))
837 Result = false;
838 }
839 continue;
840 } else
841 consumeError(Err: MachOOrErr.takeError());
842 if (auto ArchiveOrErr = ObjForArch.getAsArchive()) {
843 error(Prefix: ObjName, Err: ArchiveOrErr.takeError());
844 if (!handleArchive(Filename: ObjName, Arch&: *ArchiveOrErr.get(), HandleObj, OS))
845 Result = false;
846 continue;
847 } else
848 consumeError(Err: ArchiveOrErr.takeError());
849 }
850 else if (auto *Arch = dyn_cast<Archive>(Val: BinOrErr->get()))
851 Result = handleArchive(Filename, Arch&: *Arch, HandleObj, OS);
852 return Result;
853}
854
855static bool handleFile(StringRef Filename, HandlerFn HandleObj,
856 raw_ostream &OS) {
857 ErrorOr<std::unique_ptr<MemoryBuffer>> BuffOrErr =
858 MemoryBuffer::getFileOrSTDIN(Filename);
859 error(Prefix: Filename, EC: BuffOrErr.getError());
860 std::unique_ptr<MemoryBuffer> Buffer = std::move(BuffOrErr.get());
861 return handleBuffer(Filename, Buffer: *Buffer, HandleObj, OS);
862}
863
864int main(int argc, char **argv) {
865 InitLLVM X(argc, argv);
866
867 // Flush outs() when printing to errs(). This avoids interleaving output
868 // between the two.
869 errs().tie(TieTo: &outs());
870
871 llvm::InitializeAllTargetInfos();
872 llvm::InitializeAllTargetMCs();
873
874 HideUnrelatedOptions(
875 Categories: {&DwarfDumpCategory, &SectionCategory, &getColorCategory()});
876 cl::ParseCommandLineOptions(
877 argc, argv,
878 Overview: "pretty-print DWARF debug information in object files"
879 " and debug info archives.\n");
880
881 // FIXME: Audit interactions between these two options and make them
882 // compatible.
883 if (Diff && Verbose) {
884 WithColor::error() << "incompatible arguments: specifying both -diff and "
885 "-verbose is currently not supported";
886 return 1;
887 }
888 // -error-detail and -json-summary-file both imply -verify
889 if (ErrorDetails != Unspecified || !JsonErrSummaryFile.empty()) {
890 Verify = true;
891 }
892
893 std::error_code EC;
894 ToolOutputFile OutputFile(OutputFilename, EC, sys::fs::OF_TextWithCRLF);
895 error(Prefix: "unable to open output file " + OutputFilename, EC);
896 // Don't remove output file if we exit with an error.
897 OutputFile.keep();
898
899 bool OffsetRequested = false;
900
901 // Defaults to dumping only debug_info, unless: A) verbose mode is specified,
902 // in which case all sections are dumped, or B) a specific section is
903 // requested.
904#define HANDLE_DWARF_SECTION(ENUM_NAME, ELF_NAME, CMDLINE_NAME, OPTION) \
905 if (Dump##ENUM_NAME.IsRequested) { \
906 DumpType |= DIDT_##ENUM_NAME; \
907 if (Dump##ENUM_NAME.HasValue) { \
908 DumpOffsets[DIDT_ID_##ENUM_NAME] = Dump##ENUM_NAME.Val; \
909 OffsetRequested = true; \
910 } \
911 }
912#include "llvm/BinaryFormat/Dwarf.def"
913#undef HANDLE_DWARF_SECTION
914 if (DumpUUID)
915 DumpType |= DIDT_UUID;
916 if (DumpAll)
917 DumpType = DIDT_All;
918 if (DumpType == DIDT_Null && !ShowVariableCoverage) {
919 if (Verbose || Verify)
920 DumpType = DIDT_All;
921 else
922 DumpType = DIDT_DebugInfo;
923 }
924
925 // Unless dumping a specific DIE, default to --show-children.
926 if (!ShowChildren && !Verify && !OffsetRequested && Name.empty() &&
927 Find.empty() && !FindAllApple)
928 ShowChildren = true;
929
930 // Defaults to a.out if no filenames specified.
931 if (InputFilenames.empty())
932 InputFilenames.push_back(value: "a.out");
933
934 // Expand any .dSYM bundles to the individual object files contained therein.
935 std::vector<std::string> Objects;
936 for (const auto &F : InputFilenames) {
937 if (auto DsymObjectsOrErr = MachOObjectFile::findDsymObjectMembers(Path: F)) {
938 if (DsymObjectsOrErr->empty())
939 Objects.push_back(x: F);
940 else
941 llvm::append_range(C&: Objects, R&: *DsymObjectsOrErr);
942 } else {
943 error(Err: DsymObjectsOrErr.takeError());
944 }
945 }
946
947 bool Success = true;
948 if (Verify) {
949 if (!VerifyNumThreads)
950 parallel::strategy =
951 hardware_concurrency(ThreadCount: hardware_concurrency().compute_thread_count());
952 else
953 parallel::strategy = hardware_concurrency(ThreadCount: VerifyNumThreads);
954 for (StringRef Object : Objects)
955 Success &= handleFile(Filename: Object, HandleObj: verifyObjectFile, OS&: OutputFile.os());
956 } else if (Statistics) {
957 for (StringRef Object : Objects)
958 Success &= handleFile(Filename: Object, HandleObj: collectStatsForObjectFile, OS&: OutputFile.os());
959 } else if (ShowSectionSizes) {
960 for (StringRef Object : Objects)
961 Success &= handleFile(Filename: Object, HandleObj: collectObjectSectionSizes, OS&: OutputFile.os());
962 } else if (ShowSources) {
963 for (StringRef Object : Objects)
964 Success &= handleFile(Filename: Object, HandleObj: collectObjectSources, OS&: OutputFile.os());
965 } else {
966 for (StringRef Object : Objects)
967 Success &= handleFile(Filename: Object, HandleObj: dumpObjectFile, OS&: OutputFile.os());
968 }
969
970 if (ShowVariableCoverage) {
971 auto showCoverage = [&](ObjectFile &Obj, DWARFContext &DICtx,
972 const Twine &Filename, raw_ostream &OS) {
973 return showVariableCoverage(Obj, DICtx, CombineInstances, OS);
974 };
975 for (StringRef Object : Objects)
976 Success &= handleFile(Filename: Object, HandleObj: showCoverage, OS&: OutputFile.os());
977 }
978
979 return Success ? EXIT_SUCCESS : EXIT_FAILURE;
980}
981