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   // --stack-sizes
 328   cl::opt<bool>
 329       PrintStackSizes("stack-sizes",
 330                       cl::desc("Display contents of all stack sizes sections"));
 331
 332   // --version-info, -V
 333   cl::opt<bool>
 334       VersionInfo("version-info",
 335                   cl::desc("Display ELF version sections (if present)"));
 336   cl::alias VersionInfoShort("V", cl::desc("Alias for -version-info"),
 337                              cl::aliasopt(VersionInfo));
 338
 339   // --elf-section-groups, --section-groups, -g
 340   cl::opt<bool> SectionGroups("elf-section-groups",
 341                               cl::desc("Display ELF section group contents"));
 342   cl::alias SectionGroupsAlias("section-groups",
 343                                cl::desc("Alias for -elf-sections-groups"),
 344                                cl::aliasopt(SectionGroups));
 345   cl::alias SectionGroupsShort("g", cl::desc("Alias for -elf-sections-groups"),
 346                                cl::aliasopt(SectionGroups));
 347
 348   // --elf-hash-histogram, --histogram, -I
 349   cl::opt<bool> HashHistogram(
 350       "elf-hash-histogram",
 351       cl::desc("Display bucket list histogram for hash sections"));
 352   cl::alias HashHistogramShort("I", cl::desc("Alias for -elf-hash-histogram"),
 353                                cl::aliasopt(HashHistogram));
 354   cl::alias HistogramAlias("histogram",
 355                            cl::desc("Alias for --elf-hash-histogram"),
 356                            cl::aliasopt(HashHistogram));
 357
 358   // --elf-cg-profile
 359   cl::opt<bool> CGProfile("elf-cg-profile", cl::desc("Display callgraph profile section"));
 360
 361   // -addrsig
 362   cl::opt<bool> Addrsig("addrsig",
 363                         cl::desc("Display address-significance table"));
 364
 365   // -elf-output-style
 366   cl::opt<OutputStyleTy>
 367       Output("elf-output-style", cl::desc("Specify ELF dump style"),
 368              cl::values(clEnumVal(LLVM, "LLVM default style"),
 369                         clEnumVal(GNU, "GNU readelf style")),
 370              cl::init(LLVM));
 371
 372   cl::extrahelp
 373       HelpResponse("\nPass @FILE as argument to read options from FILE.\n");
 374 } // namespace opts
 375
 376 static StringRef ToolName;
 377
 378 namespace llvm {
 379
 380 LLVM_ATTRIBUTE_NORETURN static void error(Twine Msg) {
 381   // Flush the standard output to print the error at a
 382   // proper place.
 383   fouts().flush();
 384   errs() << "\n";
 385   WithColor::error(errs(), ToolName) << Msg << "\n";
 386   exit(1);
 387 }
 388
 389 LLVM_ATTRIBUTE_NORETURN void reportError(Error Err, StringRef Input) {
 390   assert(Err);
 391   if (Input == "-")
 392     Input = "<stdin>";
 393   handleAllErrors(createFileError(Input, std::move(Err)),
 394                   [&](const ErrorInfoBase &EI) { error(EI.message()); });
 395   llvm_unreachable("error() call should never return");
 396 }
 397
 398 void reportWarning(Error Err, StringRef Input) {
 399   assert(Err);
 400   if (Input == "-")
 401     Input = "<stdin>";
 402
 403   // Flush the standard output to print the warning at a
 404   // proper place.
 405   fouts().flush();
 406   handleAllErrors(
 407       createFileError(Input, std::move(Err)), [&](const ErrorInfoBase &EI) {
 408         errs() << "\n";
 409         WithColor::warning(errs(), ToolName) << EI.message() << "\n";
 410       });
 411 }
 412
 413 } // namespace llvm
 414
 415 static bool isMipsArch(unsigned Arch) {
 416   switch (Arch) {
 417   case llvm::Triple::mips:
 418   case llvm::Triple::mipsel:
 419   case llvm::Triple::mips64:
 420   case llvm::Triple::mips64el:
 421     return true;
 422   default:
 423     return false;
 424   }
 425 }
 426 namespace {
 427 struct ReadObjTypeTableBuilder {
 428   ReadObjTypeTableBuilder()
 429       : Allocator(), IDTable(Allocator), TypeTable(Allocator),
 430         GlobalIDTable(Allocator), GlobalTypeTable(Allocator) {}
 431
 432   llvm::BumpPtrAllocator Allocator;
 433   llvm::codeview::MergingTypeTableBuilder IDTable;
 434   llvm::codeview::MergingTypeTableBuilder TypeTable;
 435   llvm::codeview::GlobalTypeTableBuilder GlobalIDTable;
 436   llvm::codeview::GlobalTypeTableBuilder GlobalTypeTable;
 437   std::vector<OwningBinary<Binary>> Binaries;
 438 };
 439 } // namespace
 440 static ReadObjTypeTableBuilder CVTypes;
 441
 442 /// Creates an format-specific object file dumper.
 443 static std::error_code createDumper(const ObjectFile *Obj,
 444                                     ScopedPrinter &Writer,
 445                                     std::unique_ptr<ObjDumper> &Result) {
 446   if (!Obj)
 447     return readobj_error::unsupported_file_format;
 448
 449   if (Obj->isCOFF())
 450     return createCOFFDumper(Obj, Writer, Result);
 451   if (Obj->isELF())
 452     return createELFDumper(Obj, Writer, Result);
 453   if (Obj->isMachO())
 454     return createMachODumper(Obj, Writer, Result);
 455   if (Obj->isWasm())
 456     return createWasmDumper(Obj, Writer, Result);
 457   if (Obj->isXCOFF())
 458     return createXCOFFDumper(Obj, Writer, Result);
 459
 460   return readobj_error::unsupported_obj_file_format;
 461 }
 462
 463 /// Dumps the specified object file.
 464 static void dumpObject(const ObjectFile *Obj, ScopedPrinter &Writer,
 465                        const Archive *A = nullptr) {
 466   std::string FileStr =
 467           A ? Twine(A->getFileName() + "(" + Obj->getFileName() + ")").str()
 468             : Obj->getFileName().str();
 469
 470   std::unique_ptr<ObjDumper> Dumper;
 471   if (std::error_code EC = createDumper(Obj, Writer, Dumper))
 472     reportError(errorCodeToError(EC), FileStr);
 473
 474   if (opts::Output == opts::LLVM || opts::InputFilenames.size() > 1 || A) {
 475     Writer.startLine() << "\n";
 476     Writer.printString("File", FileStr);
 477   }
 478   if (opts::Output == opts::LLVM) {
 479     Writer.printString("Format", Obj->getFileFormatName());
 480     Writer.printString("Arch", Triple::getArchTypeName(
 481                                    (llvm::Triple::ArchType)Obj->getArch()));
 482     Writer.printString("AddressSize",
 483                        formatv("{0}bit", 8 * Obj->getBytesInAddress()));
 484     Dumper->printLoadName();
 485   }
 486
 487   if (opts::FileHeaders)
 488     Dumper->printFileHeaders();
 489   if (opts::SectionHeaders)
 490     Dumper->printSectionHeaders();
 491   if (opts::Relocations)
 492     Dumper->printRelocations();
 493   if (opts::DynRelocs)
 494     Dumper->printDynamicRelocations();
 495   if (opts::Symbols || opts::DynamicSymbols)
 496     Dumper->printSymbols(opts::Symbols, opts::DynamicSymbols);
 497   if (opts::HashSymbols)
 498     Dumper->printHashSymbols();
 499   if (opts::UnwindInfo)
 500     Dumper->printUnwindInfo();
 501   if (opts::DynamicTable)
 502     Dumper->printDynamicTable();
 503   if (opts::NeededLibraries)
 504     Dumper->printNeededLibraries();
 505   if (opts::ProgramHeaders || opts::SectionMapping == cl::BOU_TRUE)
 506     Dumper->printProgramHeaders(opts::ProgramHeaders, opts::SectionMapping);
 507   if (!opts::StringDump.empty())
 508     Dumper->printSectionsAsString(Obj, opts::StringDump);
 509   if (!opts::HexDump.empty())
 510     Dumper->printSectionsAsHex(Obj, opts::HexDump);
 511   if (opts::HashTable)
 512     Dumper->printHashTable();
 513   if (opts::GnuHashTable)
 514     Dumper->printGnuHashTable();
 515   if (opts::VersionInfo)
 516     Dumper->printVersionInfo();
 517   if (Obj->isELF()) {
 518     if (opts::ELFLinkerOptions)
 519       Dumper->printELFLinkerOptions();
 520     if (Obj->getArch() == llvm::Triple::arm)
 521       if (opts::ARMAttributes)
 522         Dumper->printAttributes();
 523     if (isMipsArch(Obj->getArch())) {
 524       if (opts::MipsPLTGOT)
 525         Dumper->printMipsPLTGOT();
 526       if (opts::MipsABIFlags)
 527         Dumper->printMipsABIFlags();
 528       if (opts::MipsReginfo)
 529         Dumper->printMipsReginfo();
 530       if (opts::MipsOptions)
 531         Dumper->printMipsOptions();
 532     }
 533     if (opts::SectionGroups)
 534       Dumper->printGroupSections();
 535     if (opts::HashHistogram)
 536       Dumper->printHashHistogram();
 537     if (opts::CGProfile)
 538       Dumper->printCGProfile();
 539     if (opts::Addrsig)
 540       Dumper->printAddrsig();
 541     if (opts::Notes)
 542       Dumper->printNotes();
 543   }
 544   if (Obj->isCOFF()) {
 545     if (opts::COFFImports)
 546       Dumper->printCOFFImports();
 547     if (opts::COFFExports)
 548       Dumper->printCOFFExports();
 549     if (opts::COFFDirectives)
 550       Dumper->printCOFFDirectives();
 551     if (opts::COFFBaseRelocs)
 552       Dumper->printCOFFBaseReloc();
 553     if (opts::COFFDebugDirectory)
 554       Dumper->printCOFFDebugDirectory();
 555     if (opts::COFFResources)
 556       Dumper->printCOFFResources();
 557     if (opts::COFFLoadConfig)
 558       Dumper->printCOFFLoadConfig();
 559     if (opts::Addrsig)
 560       Dumper->printAddrsig();
 561     if (opts::CodeView)
 562       Dumper->printCodeViewDebugInfo();
 563     if (opts::CodeViewMergedTypes)
 564       Dumper->mergeCodeViewTypes(CVTypes.IDTable, CVTypes.TypeTable,
 565                                  CVTypes.GlobalIDTable, CVTypes.GlobalTypeTable,
 566                                  opts::CodeViewEnableGHash);
 567   }
 568   if (Obj->isMachO()) {
 569     if (opts::MachODataInCode)
 570       Dumper->printMachODataInCode();
 571     if (opts::MachOIndirectSymbols)
 572       Dumper->printMachOIndirectSymbols();
 573     if (opts::MachOLinkerOptions)
 574       Dumper->printMachOLinkerOptions();
 575     if (opts::MachOSegment)
 576       Dumper->printMachOSegment();
 577     if (opts::MachOVersionMin)
 578       Dumper->printMachOVersionMin();
 579     if (opts::MachODysymtab)
 580       Dumper->printMachODysymtab();
 581   }
 582   if (opts::PrintStackMap)
 583     Dumper->printStackMap();
 584   if (opts::PrintStackSizes)
 585     Dumper->printStackSizes();
 586 }
 587
 588 /// Dumps each object file in \a Arc;
 589 static void dumpArchive(const Archive *Arc, ScopedPrinter &Writer) {
 590   Error Err = Error::success();
 591   for (auto &Child : Arc->children(Err)) {
 592     Expected<std::unique_ptr<Binary>> ChildOrErr = Child.getAsBinary();
 593     if (!ChildOrErr) {
 594       if (auto E = isNotObjectErrorInvalidFileType(ChildOrErr.takeError()))
 595         reportError(std::move(E), Arc->getFileName());
 596       continue;
 597     }
 598     if (ObjectFile *Obj = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
 599       dumpObject(Obj, Writer, Arc);
 600     else if (COFFImportFile *Imp = dyn_cast<COFFImportFile>(&*ChildOrErr.get()))
 601       dumpCOFFImportFile(Imp, Writer);
 602     else
 603       reportError(errorCodeToError(readobj_error::unrecognized_file_format),
 604                   Arc->getFileName());
 605   }
 606   if (Err)
 607     reportError(std::move(Err), Arc->getFileName());
 608 }
 609
 610 /// Dumps each object file in \a MachO Universal Binary;
 611 static void dumpMachOUniversalBinary(const MachOUniversalBinary *UBinary,
 612                                      ScopedPrinter &Writer) {
 613   for (const MachOUniversalBinary::ObjectForArch &Obj : UBinary->objects()) {
 614     Expected<std::unique_ptr<MachOObjectFile>> ObjOrErr = Obj.getAsObjectFile();
 615     if (ObjOrErr)
 616       dumpObject(&*ObjOrErr.get(), Writer);
 617     else if (auto E = isNotObjectErrorInvalidFileType(ObjOrErr.takeError()))
 618       reportError(ObjOrErr.takeError(), UBinary->getFileName());
 619     else if (Expected<std::unique_ptr<Archive>> AOrErr = Obj.getAsArchive())
 620       dumpArchive(&*AOrErr.get(), Writer);
 621   }
 622 }
 623
 624 /// Dumps \a WinRes, Windows Resource (.res) file;
 625 static void dumpWindowsResourceFile(WindowsResource *WinRes,
 626                                     ScopedPrinter &Printer) {
 627   WindowsRes::Dumper Dumper(WinRes, Printer);
 628   if (auto Err = Dumper.printData())
 629     reportError(std::move(Err), WinRes->getFileName());
 630 }
 631
 632
 633 /// Opens \a File and dumps it.
 634 static void dumpInput(StringRef File, ScopedPrinter &Writer) {
 635   // Attempt to open the binary.
 636   Expected<OwningBinary<Binary>> BinaryOrErr = createBinary(File);
 637   if (!BinaryOrErr)
 638     reportError(BinaryOrErr.takeError(), File);
 639   Binary &Binary = *BinaryOrErr.get().getBinary();
 640
 641   if (Archive *Arc = dyn_cast<Archive>(&Binary))
 642     dumpArchive(Arc, Writer);
 643   else if (MachOUniversalBinary *UBinary =
 644                dyn_cast<MachOUniversalBinary>(&Binary))
 645     dumpMachOUniversalBinary(UBinary, Writer);
 646   else if (ObjectFile *Obj = dyn_cast<ObjectFile>(&Binary))
 647     dumpObject(Obj, Writer);
 648   else if (COFFImportFile *Import = dyn_cast<COFFImportFile>(&Binary))
 649     dumpCOFFImportFile(Import, Writer);
 650   else if (WindowsResource *WinRes = dyn_cast<WindowsResource>(&Binary))
 651     dumpWindowsResourceFile(WinRes, Writer);
 652   else
 653     reportError(errorCodeToError(readobj_error::unrecognized_file_format),
 654                 File);
 655
 656   CVTypes.Binaries.push_back(std::move(*BinaryOrErr));
 657 }
 658
 659 /// Registers aliases that should only be allowed by readobj.
 660 static void registerReadobjAliases() {
 661   // -s has meant --sections for a very long time in llvm-readobj despite
 662   // meaning --symbols in readelf.
 663   static cl::alias SectionsShort("s", cl::desc("Alias for --section-headers"),
 664                                  cl::aliasopt(opts::SectionHeaders),
 665                                  cl::NotHidden);
 666
 667   // Only register -t in llvm-readobj, as readelf reserves it for
 668   // --section-details (not implemented yet).
 669   static cl::alias SymbolsShort("t", cl::desc("Alias for --symbols"),
 670                                 cl::aliasopt(opts::Symbols), cl::NotHidden);
 671
 672   // The following two-letter aliases are only provided for readobj, as readelf
 673   // allows single-letter args to be grouped together.
 674   static cl::alias SectionRelocationsShort(
 675       "sr", cl::desc("Alias for --section-relocations"),
 676       cl::aliasopt(opts::SectionRelocations));
 677   static cl::alias SectionDataShort("sd", cl::desc("Alias for --section-data"),
 678                                     cl::aliasopt(opts::SectionData));
 679   static cl::alias SectionSymbolsShort("st",
 680                                        cl::desc("Alias for --section-symbols"),
 681                                        cl::aliasopt(opts::SectionSymbols));
 682   static cl::alias DynamicSymbolsShort("dt",
 683                                        cl::desc("Alias for --dyn-symbols"),
 684                                        cl::aliasopt(opts::DynamicSymbols));
 685 }
 686
 687 /// Registers aliases that should only be allowed by readelf.
 688 static void registerReadelfAliases() {
 689   // -s is here because for readobj it means --sections.
 690   static cl::alias SymbolsShort("s", cl::desc("Alias for --symbols"),
 691                                 cl::aliasopt(opts::Symbols), cl::NotHidden,
 692                                 cl::Grouping);
 693
 694   // Allow all single letter flags to be grouped together.
 695   for (auto &OptEntry : cl::getRegisteredOptions()) {
 696     StringRef ArgName = OptEntry.getKey();
 697     cl::Option *Option = OptEntry.getValue();
 698     if (ArgName.size() == 1)
 699       apply(Option, cl::Grouping);
 700   }
 701 }
 702
 703 int main(int argc, const char *argv[]) {
 704   InitLLVM X(argc, argv);
 705   ToolName = argv[0];
 706
 707   // Register the target printer for --version.
 708   cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
 709
 710   if (sys::path::stem(argv[0]).contains("readelf")) {
 711     opts::Output = opts::GNU;
 712     registerReadelfAliases();
 713   } else {
 714     registerReadobjAliases();
 715   }
 716
 717   cl::ParseCommandLineOptions(argc, argv, "LLVM Object Reader\n");
 718
 719   if (opts::All) {
 720     opts::FileHeaders = true;
 721     opts::ProgramHeaders = true;
 722     opts::SectionHeaders = true;
 723     opts::Symbols = true;
 724     opts::Relocations = true;
 725     opts::DynamicTable = true;
 726     opts::Notes = true;
 727     opts::VersionInfo = true;
 728     opts::UnwindInfo = true;
 729     opts::SectionGroups = true;
 730     opts::HashHistogram = true;
 731     // FIXME: As soon as we implement LLVM-style printing of the .stack_size
 732     // section, we will enable it with --all (only for LLVM-style).
 733     if (opts::Output == opts::LLVM)
 734       opts::PrintStackSizes = false;
 735   }
 736
 737   if (opts::Headers) {
 738     opts::FileHeaders = true;
 739     opts::ProgramHeaders = true;
 740     opts::SectionHeaders = true;
 741   }
 742
 743   // Default to stdin if no filename is specified.
 744   if (opts::InputFilenames.empty())
 745     opts::InputFilenames.push_back("-");
 746
 747   ScopedPrinter Writer(fouts());
 748   for (const std::string &I : opts::InputFilenames)
 749     dumpInput(I, Writer);
 750
 751   if (opts::CodeViewMergedTypes) {
 752     if (opts::CodeViewEnableGHash)
 753       dumpCodeViewMergedTypes(Writer, CVTypes.GlobalIDTable.records(),
 754                               CVTypes.GlobalTypeTable.records());
 755     else
 756       dumpCodeViewMergedTypes(Writer, CVTypes.IDTable.records(),
 757                               CVTypes.TypeTable.records());
 758   }
 759
 760   return 0;
 761 }