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