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