tools/llvm-readobj/llvm-readobj.cpp

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