tools/llvm-readobj/llvm-readobj.cpp

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