xref: /llvm-project/llvm/tools/llvm-readobj/llvm-readobj.cpp (revision e29e30b1397f3e50f3487491f8a77ae08e4e3471) 
1 //===- llvm-readobj.cpp - Dump contents of an Object File -----------------===//
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 is a tool similar to readelf, except it works on multiple object file
10 // formats. The main purpose of this tool is to provide detailed output suitable
11 // for FileCheck.
12 //
13 // Flags should be similar to readelf where supported, but the output format
14 // does not need to be identical. The point is to not make users learn yet
15 // another set of flags.
16 //
17 // Output should be specialized for each format where appropriate.
18 //
19 //===----------------------------------------------------------------------===//
20 
21 #include "llvm-readobj.h"
22 #include "Error.h"
23 #include "ObjDumper.h"
24 #include "WindowsResourceDumper.h"
25 #include "llvm/DebugInfo/CodeView/GlobalTypeTableBuilder.h"
26 #include "llvm/DebugInfo/CodeView/MergingTypeTableBuilder.h"
27 #include "llvm/Object/Archive.h"
28 #include "llvm/Object/COFFImportFile.h"
29 #include "llvm/Object/MachOUniversal.h"
30 #include "llvm/Object/ObjectFile.h"
31 #include "llvm/Object/WindowsResource.h"
32 #include "llvm/Support/Casting.h"
33 #include "llvm/Support/CommandLine.h"
34 #include "llvm/Support/DataTypes.h"
35 #include "llvm/Support/Debug.h"
36 #include "llvm/Support/FileSystem.h"
37 #include "llvm/Support/FormatVariadic.h"
38 #include "llvm/Support/InitLLVM.h"
39 #include "llvm/Support/Path.h"
40 #include "llvm/Support/ScopedPrinter.h"
41 #include "llvm/Support/TargetRegistry.h"
42 #include "llvm/Support/WithColor.h"
43 
44 using namespace llvm;
45 using namespace llvm::object;
46 
47 namespace opts {
48   cl::list<std::string> InputFilenames(cl::Positional,
49     cl::desc("<input object files>"),
50     cl::ZeroOrMore);
51 
52   // --all, -a
53   cl::opt<bool>
54       All("all",
55           cl::desc("Equivalent to setting: --file-headers, --program-headers, "
56                    "--section-headers, --symbols, --relocations, "
57                    "--dynamic-table, --notes, --version-info, --unwind, "
58                    "--section-groups and --elf-hash-histogram."));
59   cl::alias AllShort("a", cl::desc("Alias for --all"), cl::aliasopt(All));
60 
61   // --headers -e
62   cl::opt<bool>
63       Headers("headers",
64           cl::desc("Equivalent to setting: --file-headers, --program-headers, "
65                    "--section-headers"));
66   cl::alias HeadersShort("e", cl::desc("Alias for --headers"),
67      cl::aliasopt(Headers));
68 
69   // --wide, -W
70   cl::opt<bool>
71       WideOutput("wide", cl::desc("Ignored for compatibility with GNU readelf"),
72                  cl::Hidden);
73   cl::alias WideOutputShort("W",
74     cl::desc("Alias for --wide"),
75     cl::aliasopt(WideOutput));
76 
77   // --file-headers, --file-header, -h
78   cl::opt<bool> FileHeaders("file-headers",
79     cl::desc("Display file headers "));
80   cl::alias FileHeadersShort("h", cl::desc("Alias for --file-headers"),
81                              cl::aliasopt(FileHeaders), cl::NotHidden);
82   cl::alias FileHeadersSingular("file-header",
83                                 cl::desc("Alias for --file-headers"),
84                                 cl::aliasopt(FileHeaders));
85 
86   // --section-headers, --sections, -S
87   // Also -s in llvm-readobj mode.
88   cl::opt<bool> SectionHeaders("section-headers",
89                                cl::desc("Display all section headers."));
90   cl::alias SectionsShortUpper("S", cl::desc("Alias for --section-headers"),
91                                cl::aliasopt(SectionHeaders), cl::NotHidden);
92   cl::alias SectionHeadersAlias("sections",
93                                 cl::desc("Alias for --section-headers"),
94                                 cl::aliasopt(SectionHeaders), cl::NotHidden);
95 
96   // --section-relocations
97   // Also --sr in llvm-readobj mode.
98   cl::opt<bool> SectionRelocations("section-relocations",
99     cl::desc("Display relocations for each section shown."));
100 
101   // --section-symbols
102   // Also --st in llvm-readobj mode.
103   cl::opt<bool> SectionSymbols("section-symbols",
104     cl::desc("Display symbols for each section shown."));
105 
106   // --section-data
107   // Also --sd in llvm-readobj mode.
108   cl::opt<bool> SectionData("section-data",
109     cl::desc("Display section data for each section shown."));
110 
111   // --section-mapping
112   cl::opt<cl::boolOrDefault>
113       SectionMapping("section-mapping",
114                      cl::desc("Display the section to segment mapping."));
115 
116   // --relocations, --relocs, -r
117   cl::opt<bool> Relocations("relocations",
118     cl::desc("Display the relocation entries in the file"));
119   cl::alias RelocationsShort("r", cl::desc("Alias for --relocations"),
120                              cl::aliasopt(Relocations), cl::NotHidden);
121   cl::alias RelocationsGNU("relocs", cl::desc("Alias for --relocations"),
122                            cl::aliasopt(Relocations));
123 
124   // --notes, -n
125   cl::opt<bool> Notes("notes", cl::desc("Display the ELF notes in the file"));
126   cl::alias NotesShort("n", cl::desc("Alias for --notes"), cl::aliasopt(Notes));
127 
128   // --dyn-relocations
129   cl::opt<bool> DynRelocs("dyn-relocations",
130     cl::desc("Display the dynamic relocation entries in the file"));
131 
132   // --symbols
133   // Also -s in llvm-readelf mode, or -t in llvm-readobj mode.
134   cl::opt<bool>
135       Symbols("symbols",
136               cl::desc("Display the symbol table. Also display the dynamic "
137                        "symbol table when using GNU output style for ELF"));
138   cl::alias SymbolsGNU("syms", cl::desc("Alias for --symbols"),
139                        cl::aliasopt(Symbols));
140 
141   // --dyn-symbols, --dyn-syms
142   // Also --dt in llvm-readobj mode.
143   cl::opt<bool> DynamicSymbols("dyn-symbols",
144     cl::desc("Display the dynamic symbol table"));
145   cl::alias DynSymsGNU("dyn-syms", cl::desc("Alias for --dyn-symbols"),
146                        cl::aliasopt(DynamicSymbols));
147 
148   // --hash-symbols
149   cl::opt<bool> HashSymbols(
150       "hash-symbols",
151       cl::desc("Display the dynamic symbols derived from the hash section"));
152 
153   // --unwind, -u
154   cl::opt<bool> UnwindInfo("unwind",
155     cl::desc("Display unwind information"));
156   cl::alias UnwindInfoShort("u",
157     cl::desc("Alias for --unwind"),
158     cl::aliasopt(UnwindInfo));
159 
160   // --dynamic-table, --dynamic, -d
161   cl::opt<bool> DynamicTable("dynamic-table",
162     cl::desc("Display the ELF .dynamic section table"));
163   cl::alias DynamicTableShort("d", cl::desc("Alias for --dynamic-table"),
164                               cl::aliasopt(DynamicTable), cl::NotHidden);
165   cl::alias DynamicTableAlias("dynamic", cl::desc("Alias for --dynamic-table"),
166                               cl::aliasopt(DynamicTable));
167 
168   // --needed-libs
169   cl::opt<bool> NeededLibraries("needed-libs",
170     cl::desc("Display the needed libraries"));
171 
172   // --program-headers, --segments, -l
173   cl::opt<bool> ProgramHeaders("program-headers",
174     cl::desc("Display ELF program headers"));
175   cl::alias ProgramHeadersShort("l", cl::desc("Alias for --program-headers"),
176                                 cl::aliasopt(ProgramHeaders), cl::NotHidden);
177   cl::alias SegmentsAlias("segments", cl::desc("Alias for --program-headers"),
178                           cl::aliasopt(ProgramHeaders));
179 
180   // --string-dump, -p
181   cl::list<std::string> StringDump("string-dump", cl::desc("<number|name>"),
182                                    cl::ZeroOrMore);
183   cl::alias StringDumpShort("p", cl::desc("Alias for --string-dump"),
184                             cl::aliasopt(StringDump), cl::Prefix);
185 
186   // --hex-dump, -x
187   cl::list<std::string> HexDump("hex-dump", cl::desc("<number|name>"),
188                                 cl::ZeroOrMore);
189   cl::alias HexDumpShort("x", cl::desc("Alias for --hex-dump"),
190                          cl::aliasopt(HexDump), cl::Prefix);
191 
192   // --demangle, -C
193   cl::opt<bool> Demangle("demangle",
194                          cl::desc("Demangle symbol names in output"));
195   cl::alias DemangleShort("C", cl::desc("Alias for --demangle"),
196                           cl::aliasopt(Demangle), cl::NotHidden);
197 
198   // --hash-table
199   cl::opt<bool> HashTable("hash-table",
200     cl::desc("Display ELF hash table"));
201 
202   // --gnu-hash-table
203   cl::opt<bool> GnuHashTable("gnu-hash-table",
204     cl::desc("Display ELF .gnu.hash section"));
205 
206   // --expand-relocs
207   cl::opt<bool> ExpandRelocs("expand-relocs",
208     cl::desc("Expand each shown relocation to multiple lines"));
209 
210   // --raw-relr
211   cl::opt<bool> RawRelr("raw-relr",
212     cl::desc("Do not decode relocations in SHT_RELR section, display raw contents"));
213 
214   // --codeview
215   cl::opt<bool> CodeView("codeview",
216                          cl::desc("Display CodeView debug information"));
217 
218   // --codeview-merged-types
219   cl::opt<bool>
220       CodeViewMergedTypes("codeview-merged-types",
221                           cl::desc("Display the merged CodeView type stream"));
222 
223   // --codeview-ghash
224   cl::opt<bool> CodeViewEnableGHash(
225       "codeview-ghash",
226       cl::desc(
227           "Enable global hashing for CodeView type stream de-duplication"));
228 
229   // --codeview-subsection-bytes
230   cl::opt<bool> CodeViewSubsectionBytes(
231       "codeview-subsection-bytes",
232       cl::desc("Dump raw contents of codeview debug sections and records"));
233 
234   // --arm-attributes
235   cl::opt<bool> ARMAttributes("arm-attributes",
236                               cl::desc("Display the ARM attributes section"));
237 
238   // --mips-plt-got
239   cl::opt<bool>
240   MipsPLTGOT("mips-plt-got",
241              cl::desc("Display the MIPS GOT and PLT GOT sections"));
242 
243   // --mips-abi-flags
244   cl::opt<bool> MipsABIFlags("mips-abi-flags",
245                              cl::desc("Display the MIPS.abiflags section"));
246 
247   // --mips-reginfo
248   cl::opt<bool> MipsReginfo("mips-reginfo",
249                             cl::desc("Display the MIPS .reginfo section"));
250 
251   // --mips-options
252   cl::opt<bool> MipsOptions("mips-options",
253                             cl::desc("Display the MIPS .MIPS.options section"));
254 
255   // --coff-imports
256   cl::opt<bool>
257   COFFImports("coff-imports", cl::desc("Display the PE/COFF import table"));
258 
259   // --coff-exports
260   cl::opt<bool>
261   COFFExports("coff-exports", cl::desc("Display the PE/COFF export table"));
262 
263   // --coff-directives
264   cl::opt<bool>
265   COFFDirectives("coff-directives",
266                  cl::desc("Display the PE/COFF .drectve section"));
267 
268   // --coff-basereloc
269   cl::opt<bool>
270   COFFBaseRelocs("coff-basereloc",
271                  cl::desc("Display the PE/COFF .reloc section"));
272 
273   // --coff-debug-directory
274   cl::opt<bool>
275   COFFDebugDirectory("coff-debug-directory",
276                      cl::desc("Display the PE/COFF debug directory"));
277 
278   // --coff-resources
279   cl::opt<bool> COFFResources("coff-resources",
280                               cl::desc("Display the PE/COFF .rsrc section"));
281 
282   // --coff-load-config
283   cl::opt<bool>
284   COFFLoadConfig("coff-load-config",
285                  cl::desc("Display the PE/COFF load config"));
286 
287   // --elf-linker-options
288   cl::opt<bool>
289   ELFLinkerOptions("elf-linker-options",
290                    cl::desc("Display the ELF .linker-options section"));
291 
292   // --macho-data-in-code
293   cl::opt<bool>
294   MachODataInCode("macho-data-in-code",
295                   cl::desc("Display MachO Data in Code command"));
296 
297   // --macho-indirect-symbols
298   cl::opt<bool>
299   MachOIndirectSymbols("macho-indirect-symbols",
300                   cl::desc("Display MachO indirect symbols"));
301 
302   // --macho-linker-options
303   cl::opt<bool>
304   MachOLinkerOptions("macho-linker-options",
305                   cl::desc("Display MachO linker options"));
306 
307   // --macho-segment
308   cl::opt<bool>
309   MachOSegment("macho-segment",
310                   cl::desc("Display MachO Segment command"));
311 
312   // --macho-version-min
313   cl::opt<bool>
314   MachOVersionMin("macho-version-min",
315                   cl::desc("Display MachO version min command"));
316 
317   // --macho-dysymtab
318   cl::opt<bool>
319   MachODysymtab("macho-dysymtab",
320                   cl::desc("Display MachO Dysymtab command"));
321 
322   // --stackmap
323   cl::opt<bool>
324   PrintStackMap("stackmap",
325                 cl::desc("Display contents of stackmap section"));
326 
327   // --version-info, -V
328   cl::opt<bool>
329       VersionInfo("version-info",
330                   cl::desc("Display ELF version sections (if present)"));
331   cl::alias VersionInfoShort("V", cl::desc("Alias for -version-info"),
332                              cl::aliasopt(VersionInfo));
333 
334   // --elf-section-groups, --section-groups, -g
335   cl::opt<bool> SectionGroups("elf-section-groups",
336                               cl::desc("Display ELF section group contents"));
337   cl::alias SectionGroupsAlias("section-groups",
338                                cl::desc("Alias for -elf-sections-groups"),
339                                cl::aliasopt(SectionGroups));
340   cl::alias SectionGroupsShort("g", cl::desc("Alias for -elf-sections-groups"),
341                                cl::aliasopt(SectionGroups));
342 
343   // --elf-hash-histogram, --histogram, -I
344   cl::opt<bool> HashHistogram(
345       "elf-hash-histogram",
346       cl::desc("Display bucket list histogram for hash sections"));
347   cl::alias HashHistogramShort("I", cl::desc("Alias for -elf-hash-histogram"),
348                                cl::aliasopt(HashHistogram));
349   cl::alias HistogramAlias("histogram",
350                            cl::desc("Alias for --elf-hash-histogram"),
351                            cl::aliasopt(HashHistogram));
352 
353   // --elf-cg-profile
354   cl::opt<bool> CGProfile("elf-cg-profile", cl::desc("Display callgraph profile section"));
355 
356   // -addrsig
357   cl::opt<bool> Addrsig("addrsig",
358                         cl::desc("Display address-significance table"));
359 
360   // -elf-output-style
361   cl::opt<OutputStyleTy>
362       Output("elf-output-style", cl::desc("Specify ELF dump style"),
363              cl::values(clEnumVal(LLVM, "LLVM default style"),
364                         clEnumVal(GNU, "GNU readelf style")),
365              cl::init(LLVM));
366 } // namespace opts
367 
368 namespace llvm {
369 
370 LLVM_ATTRIBUTE_NORETURN void reportError(Twine Msg) {
371   errs() << "\n";
372   WithColor::error(errs()) << Msg << "\n";
373   exit(1);
374 }
375 
376 void error(Error EC) {
377   if (!EC)
378     return;
379   handleAllErrors(std::move(EC),
380                   [&](const ErrorInfoBase &EI) { reportError(EI.message()); });
381 }
382 
383 void error(std::error_code EC) {
384   if (!EC)
385     return;
386   reportError(EC.message());
387 }
388 
389 bool relocAddressLess(RelocationRef a, RelocationRef b) {
390   return a.getOffset() < b.getOffset();
391 }
392 
393 } // namespace llvm
394 
395 static void reportError(StringRef Input, Error Err) {
396   if (Input == "-")
397     Input = "<stdin>";
398   error(createFileError(Input, std::move(Err)));
399 }
400 
401 static void reportError(StringRef Input, std::error_code EC) {
402   reportError(Input, errorCodeToError(EC));
403 }
404 
405 static bool isMipsArch(unsigned Arch) {
406   switch (Arch) {
407   case llvm::Triple::mips:
408   case llvm::Triple::mipsel:
409   case llvm::Triple::mips64:
410   case llvm::Triple::mips64el:
411     return true;
412   default:
413     return false;
414   }
415 }
416 namespace {
417 struct ReadObjTypeTableBuilder {
418   ReadObjTypeTableBuilder()
419       : Allocator(), IDTable(Allocator), TypeTable(Allocator),
420         GlobalIDTable(Allocator), GlobalTypeTable(Allocator) {}
421 
422   llvm::BumpPtrAllocator Allocator;
423   llvm::codeview::MergingTypeTableBuilder IDTable;
424   llvm::codeview::MergingTypeTableBuilder TypeTable;
425   llvm::codeview::GlobalTypeTableBuilder GlobalIDTable;
426   llvm::codeview::GlobalTypeTableBuilder GlobalTypeTable;
427   std::vector<OwningBinary<Binary>> Binaries;
428 };
429 } // namespace
430 static ReadObjTypeTableBuilder CVTypes;
431 
432 /// Creates an format-specific object file dumper.
433 static std::error_code createDumper(const ObjectFile *Obj,
434                                     ScopedPrinter &Writer,
435                                     std::unique_ptr<ObjDumper> &Result) {
436   if (!Obj)
437     return readobj_error::unsupported_file_format;
438 
439   if (Obj->isCOFF())
440     return createCOFFDumper(Obj, Writer, Result);
441   if (Obj->isELF())
442     return createELFDumper(Obj, Writer, Result);
443   if (Obj->isMachO())
444     return createMachODumper(Obj, Writer, Result);
445   if (Obj->isWasm())
446     return createWasmDumper(Obj, Writer, Result);
447 
448   return readobj_error::unsupported_obj_file_format;
449 }
450 
451 /// Dumps the specified object file.
452 static void dumpObject(const ObjectFile *Obj, ScopedPrinter &Writer) {
453   std::unique_ptr<ObjDumper> Dumper;
454   if (std::error_code EC = createDumper(Obj, Writer, Dumper))
455     reportError(Obj->getFileName(), EC);
456 
457   if (opts::Output == opts::LLVM) {
458     Writer.startLine() << "\n";
459     Writer.printString("File", Obj->getFileName());
460     Writer.printString("Format", Obj->getFileFormatName());
461     Writer.printString("Arch", Triple::getArchTypeName(
462                                    (llvm::Triple::ArchType)Obj->getArch()));
463     Writer.printString("AddressSize",
464                        formatv("{0}bit", 8 * Obj->getBytesInAddress()));
465     Dumper->printLoadName();
466   }
467 
468   if (opts::FileHeaders)
469     Dumper->printFileHeaders();
470   if (opts::SectionHeaders)
471     Dumper->printSectionHeaders();
472   if (opts::Relocations)
473     Dumper->printRelocations();
474   if (opts::DynRelocs)
475     Dumper->printDynamicRelocations();
476   if (opts::Symbols || opts::DynamicSymbols)
477     Dumper->printSymbols(opts::Symbols, opts::DynamicSymbols);
478   if (opts::HashSymbols)
479     Dumper->printHashSymbols();
480   if (opts::UnwindInfo)
481     Dumper->printUnwindInfo();
482   if (opts::DynamicTable)
483     Dumper->printDynamicTable();
484   if (opts::NeededLibraries)
485     Dumper->printNeededLibraries();
486   if (opts::ProgramHeaders || opts::SectionMapping == cl::BOU_TRUE)
487     Dumper->printProgramHeaders(opts::ProgramHeaders, opts::SectionMapping);
488   if (!opts::StringDump.empty())
489     llvm::for_each(opts::StringDump, [&Dumper, Obj](StringRef SectionName) {
490       Dumper->printSectionAsString(Obj, SectionName);
491     });
492   if (!opts::HexDump.empty())
493     llvm::for_each(opts::HexDump, [&Dumper, Obj](StringRef SectionName) {
494       Dumper->printSectionAsHex(Obj, SectionName);
495     });
496   if (opts::HashTable)
497     Dumper->printHashTable();
498   if (opts::GnuHashTable)
499     Dumper->printGnuHashTable();
500   if (opts::VersionInfo)
501     Dumper->printVersionInfo();
502   if (Obj->isELF()) {
503     if (opts::ELFLinkerOptions)
504       Dumper->printELFLinkerOptions();
505     if (Obj->getArch() == llvm::Triple::arm)
506       if (opts::ARMAttributes)
507         Dumper->printAttributes();
508     if (isMipsArch(Obj->getArch())) {
509       if (opts::MipsPLTGOT)
510         Dumper->printMipsPLTGOT();
511       if (opts::MipsABIFlags)
512         Dumper->printMipsABIFlags();
513       if (opts::MipsReginfo)
514         Dumper->printMipsReginfo();
515       if (opts::MipsOptions)
516         Dumper->printMipsOptions();
517     }
518     if (opts::SectionGroups)
519       Dumper->printGroupSections();
520     if (opts::HashHistogram)
521       Dumper->printHashHistogram();
522     if (opts::CGProfile)
523       Dumper->printCGProfile();
524     if (opts::Addrsig)
525       Dumper->printAddrsig();
526     if (opts::Notes)
527       Dumper->printNotes();
528   }
529   if (Obj->isCOFF()) {
530     if (opts::COFFImports)
531       Dumper->printCOFFImports();
532     if (opts::COFFExports)
533       Dumper->printCOFFExports();
534     if (opts::COFFDirectives)
535       Dumper->printCOFFDirectives();
536     if (opts::COFFBaseRelocs)
537       Dumper->printCOFFBaseReloc();
538     if (opts::COFFDebugDirectory)
539       Dumper->printCOFFDebugDirectory();
540     if (opts::COFFResources)
541       Dumper->printCOFFResources();
542     if (opts::COFFLoadConfig)
543       Dumper->printCOFFLoadConfig();
544     if (opts::Addrsig)
545       Dumper->printAddrsig();
546     if (opts::CodeView)
547       Dumper->printCodeViewDebugInfo();
548     if (opts::CodeViewMergedTypes)
549       Dumper->mergeCodeViewTypes(CVTypes.IDTable, CVTypes.TypeTable,
550                                  CVTypes.GlobalIDTable, CVTypes.GlobalTypeTable,
551                                  opts::CodeViewEnableGHash);
552   }
553   if (Obj->isMachO()) {
554     if (opts::MachODataInCode)
555       Dumper->printMachODataInCode();
556     if (opts::MachOIndirectSymbols)
557       Dumper->printMachOIndirectSymbols();
558     if (opts::MachOLinkerOptions)
559       Dumper->printMachOLinkerOptions();
560     if (opts::MachOSegment)
561       Dumper->printMachOSegment();
562     if (opts::MachOVersionMin)
563       Dumper->printMachOVersionMin();
564     if (opts::MachODysymtab)
565       Dumper->printMachODysymtab();
566   }
567   if (opts::PrintStackMap)
568     Dumper->printStackMap();
569 }
570 
571 /// Dumps each object file in \a Arc;
572 static void dumpArchive(const Archive *Arc, ScopedPrinter &Writer) {
573   Error Err = Error::success();
574   for (auto &Child : Arc->children(Err)) {
575     Expected<std::unique_ptr<Binary>> ChildOrErr = Child.getAsBinary();
576     if (!ChildOrErr) {
577       if (auto E = isNotObjectErrorInvalidFileType(ChildOrErr.takeError())) {
578         reportError(Arc->getFileName(), std::move(E));
579       }
580       continue;
581     }
582     if (ObjectFile *Obj = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
583       dumpObject(Obj, Writer);
584     else if (COFFImportFile *Imp = dyn_cast<COFFImportFile>(&*ChildOrErr.get()))
585       dumpCOFFImportFile(Imp, Writer);
586     else
587       reportError(Arc->getFileName(), readobj_error::unrecognized_file_format);
588   }
589   if (Err)
590     reportError(Arc->getFileName(), std::move(Err));
591 }
592 
593 /// Dumps each object file in \a MachO Universal Binary;
594 static void dumpMachOUniversalBinary(const MachOUniversalBinary *UBinary,
595                                      ScopedPrinter &Writer) {
596   for (const MachOUniversalBinary::ObjectForArch &Obj : UBinary->objects()) {
597     Expected<std::unique_ptr<MachOObjectFile>> ObjOrErr = Obj.getAsObjectFile();
598     if (ObjOrErr)
599       dumpObject(&*ObjOrErr.get(), Writer);
600     else if (auto E = isNotObjectErrorInvalidFileType(ObjOrErr.takeError())) {
601       reportError(UBinary->getFileName(), ObjOrErr.takeError());
602     }
603     else if (Expected<std::unique_ptr<Archive>> AOrErr = Obj.getAsArchive())
604       dumpArchive(&*AOrErr.get(), Writer);
605   }
606 }
607 
608 /// Dumps \a WinRes, Windows Resource (.res) file;
609 static void dumpWindowsResourceFile(WindowsResource *WinRes) {
610   ScopedPrinter Printer{outs()};
611   WindowsRes::Dumper Dumper(WinRes, Printer);
612   if (auto Err = Dumper.printData())
613     reportError(WinRes->getFileName(), std::move(Err));
614 }
615 
616 
617 /// Opens \a File and dumps it.
618 static void dumpInput(StringRef File) {
619   ScopedPrinter Writer(outs());
620 
621   // Attempt to open the binary.
622   Expected<OwningBinary<Binary>> BinaryOrErr = createBinary(File);
623   if (!BinaryOrErr)
624     reportError(File, BinaryOrErr.takeError());
625   Binary &Binary = *BinaryOrErr.get().getBinary();
626 
627   if (Archive *Arc = dyn_cast<Archive>(&Binary))
628     dumpArchive(Arc, Writer);
629   else if (MachOUniversalBinary *UBinary =
630                dyn_cast<MachOUniversalBinary>(&Binary))
631     dumpMachOUniversalBinary(UBinary, Writer);
632   else if (ObjectFile *Obj = dyn_cast<ObjectFile>(&Binary))
633     dumpObject(Obj, Writer);
634   else if (COFFImportFile *Import = dyn_cast<COFFImportFile>(&Binary))
635     dumpCOFFImportFile(Import, Writer);
636   else if (WindowsResource *WinRes = dyn_cast<WindowsResource>(&Binary))
637     dumpWindowsResourceFile(WinRes);
638   else
639     reportError(File, readobj_error::unrecognized_file_format);
640 
641   CVTypes.Binaries.push_back(std::move(*BinaryOrErr));
642 }
643 
644 /// Registers aliases that should only be allowed by readobj.
645 static void registerReadobjAliases() {
646   // -s has meant --sections for a very long time in llvm-readobj despite
647   // meaning --symbols in readelf.
648   static cl::alias SectionsShort("s", cl::desc("Alias for --section-headers"),
649                                  cl::aliasopt(opts::SectionHeaders),
650                                  cl::NotHidden);
651 
652   // Only register -t in llvm-readobj, as readelf reserves it for
653   // --section-details (not implemented yet).
654   static cl::alias SymbolsShort("t", cl::desc("Alias for --symbols"),
655                                 cl::aliasopt(opts::Symbols), cl::NotHidden);
656 
657   // The following two-letter aliases are only provided for readobj, as readelf
658   // allows single-letter args to be grouped together.
659   static cl::alias SectionRelocationsShort(
660       "sr", cl::desc("Alias for --section-relocations"),
661       cl::aliasopt(opts::SectionRelocations));
662   static cl::alias SectionDataShort("sd", cl::desc("Alias for --section-data"),
663                                     cl::aliasopt(opts::SectionData));
664   static cl::alias SectionSymbolsShort("st",
665                                        cl::desc("Alias for --section-symbols"),
666                                        cl::aliasopt(opts::SectionSymbols));
667   static cl::alias DynamicSymbolsShort("dt",
668                                        cl::desc("Alias for --dyn-symbols"),
669                                        cl::aliasopt(opts::DynamicSymbols));
670 }
671 
672 /// Registers aliases that should only be allowed by readelf.
673 static void registerReadelfAliases() {
674   // -s is here because for readobj it means --sections.
675   static cl::alias SymbolsShort("s", cl::desc("Alias for --symbols"),
676                                 cl::aliasopt(opts::Symbols), cl::NotHidden,
677                                 cl::Grouping);
678 
679   // Allow all single letter flags to be grouped together.
680   for (auto &OptEntry : cl::getRegisteredOptions()) {
681     StringRef ArgName = OptEntry.getKey();
682     cl::Option *Option = OptEntry.getValue();
683     if (ArgName.size() == 1)
684       apply(Option, cl::Grouping);
685   }
686 }
687 
688 int main(int argc, const char *argv[]) {
689   InitLLVM X(argc, argv);
690 
691   // Register the target printer for --version.
692   cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
693 
694   if (sys::path::stem(argv[0]).contains("readelf")) {
695     opts::Output = opts::GNU;
696     registerReadelfAliases();
697   } else {
698     registerReadobjAliases();
699   }
700 
701   cl::ParseCommandLineOptions(argc, argv, "LLVM Object Reader\n");
702 
703   if (opts::All) {
704     opts::FileHeaders = true;
705     opts::ProgramHeaders = true;
706     opts::SectionHeaders = true;
707     opts::Symbols = true;
708     opts::Relocations = true;
709     opts::DynamicTable = true;
710     opts::Notes = true;
711     opts::VersionInfo = true;
712     opts::UnwindInfo = true;
713     opts::SectionGroups = true;
714     opts::HashHistogram = true;
715   }
716 
717   if (opts::Headers) {
718     opts::FileHeaders = true;
719     opts::ProgramHeaders = true;
720     opts::SectionHeaders = true;
721   }
722 
723   // Default to stdin if no filename is specified.
724   if (opts::InputFilenames.empty())
725     opts::InputFilenames.push_back("-");
726 
727   llvm::for_each(opts::InputFilenames, dumpInput);
728 
729   if (opts::CodeViewMergedTypes) {
730     ScopedPrinter W(outs());
731     if (opts::CodeViewEnableGHash)
732       dumpCodeViewMergedTypes(W, CVTypes.GlobalIDTable.records(),
733                               CVTypes.GlobalTypeTable.records());
734     else
735       dumpCodeViewMergedTypes(W, CVTypes.IDTable.records(),
736                               CVTypes.TypeTable.records());
737   }
738 
739   return 0;
740 }
741