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