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