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 "StreamWriter.h"
  26 #include "llvm/Object/Archive.h"
  27 #include "llvm/Object/COFFImportFile.h"
  28 #include "llvm/Object/ELFObjectFile.h"
  29 #include "llvm/Object/MachOUniversal.h"
  30 #include "llvm/Object/ObjectFile.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/ManagedStatic.h"
  37 #include "llvm/Support/PrettyStackTrace.h"
  38 #include "llvm/Support/Signals.h"
  39 #include "llvm/Support/TargetRegistry.h"
  40 #include "llvm/Support/TargetSelect.h"
  41 #include <string>
  42 #include <system_error>
  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   // -file-headers, -h
  53   cl::opt<bool> FileHeaders("file-headers",
  54     cl::desc("Display file headers "));
  55   cl::alias FileHeadersShort("h",
  56     cl::desc("Alias for --file-headers"),
  57     cl::aliasopt(FileHeaders));
  58
  59   // -sections, -s
  60   cl::opt<bool> Sections("sections",
  61     cl::desc("Display all sections."));
  62   cl::alias SectionsShort("s",
  63     cl::desc("Alias for --sections"),
  64     cl::aliasopt(Sections));
  65
  66   // -section-relocations, -sr
  67   cl::opt<bool> SectionRelocations("section-relocations",
  68     cl::desc("Display relocations for each section shown."));
  69   cl::alias SectionRelocationsShort("sr",
  70     cl::desc("Alias for --section-relocations"),
  71     cl::aliasopt(SectionRelocations));
  72
  73   // -section-symbols, -st
  74   cl::opt<bool> SectionSymbols("section-symbols",
  75     cl::desc("Display symbols for each section shown."));
  76   cl::alias SectionSymbolsShort("st",
  77     cl::desc("Alias for --section-symbols"),
  78     cl::aliasopt(SectionSymbols));
  79
  80   // -section-data, -sd
  81   cl::opt<bool> SectionData("section-data",
  82     cl::desc("Display section data for each section shown."));
  83   cl::alias SectionDataShort("sd",
  84     cl::desc("Alias for --section-data"),
  85     cl::aliasopt(SectionData));
  86
  87   // -relocations, -r
  88   cl::opt<bool> Relocations("relocations",
  89     cl::desc("Display the relocation entries in the file"));
  90   cl::alias RelocationsShort("r",
  91     cl::desc("Alias for --relocations"),
  92     cl::aliasopt(Relocations));
  93
  94   // -dyn-relocations
  95   cl::opt<bool> DynRelocs("dyn-relocations",
  96     cl::desc("Display the dynamic relocation entries in the file"));
  97
  98   // -symbols, -t
  99   cl::opt<bool> Symbols("symbols",
 100     cl::desc("Display the symbol table"));
 101   cl::alias SymbolsShort("t",
 102     cl::desc("Alias for --symbols"),
 103     cl::aliasopt(Symbols));
 104
 105   // -dyn-symbols, -dt
 106   cl::opt<bool> DynamicSymbols("dyn-symbols",
 107     cl::desc("Display the dynamic symbol table"));
 108   cl::alias DynamicSymbolsShort("dt",
 109     cl::desc("Alias for --dyn-symbols"),
 110     cl::aliasopt(DynamicSymbols));
 111
 112   // -unwind, -u
 113   cl::opt<bool> UnwindInfo("unwind",
 114     cl::desc("Display unwind information"));
 115   cl::alias UnwindInfoShort("u",
 116     cl::desc("Alias for --unwind"),
 117     cl::aliasopt(UnwindInfo));
 118
 119   // -dynamic-table
 120   cl::opt<bool> DynamicTable("dynamic-table",
 121     cl::desc("Display the ELF .dynamic section table"));
 122
 123   // -needed-libs
 124   cl::opt<bool> NeededLibraries("needed-libs",
 125     cl::desc("Display the needed libraries"));
 126
 127   // -program-headers
 128   cl::opt<bool> ProgramHeaders("program-headers",
 129     cl::desc("Display ELF program headers"));
 130
 131   // -hash-table
 132   cl::opt<bool> HashTable("hash-table",
 133     cl::desc("Display ELF hash table"));
 134
 135   // -expand-relocs
 136   cl::opt<bool> ExpandRelocs("expand-relocs",
 137     cl::desc("Expand each shown relocation to multiple lines"));
 138
 139   // -codeview
 140   cl::opt<bool> CodeView("codeview",
 141                          cl::desc("Display CodeView debug information"));
 142
 143   // -codeview-subsection-bytes
 144   cl::opt<bool> CodeViewSubsectionBytes(
 145       "codeview-subsection-bytes",
 146       cl::desc("Dump raw contents of codeview debug sections and records"));
 147
 148   // -arm-attributes, -a
 149   cl::opt<bool> ARMAttributes("arm-attributes",
 150                               cl::desc("Display the ARM attributes section"));
 151   cl::alias ARMAttributesShort("-a", cl::desc("Alias for --arm-attributes"),
 152                                cl::aliasopt(ARMAttributes));
 153
 154   // -mips-plt-got
 155   cl::opt<bool>
 156   MipsPLTGOT("mips-plt-got",
 157              cl::desc("Display the MIPS GOT and PLT GOT sections"));
 158
 159   // -mips-abi-flags
 160   cl::opt<bool> MipsABIFlags("mips-abi-flags",
 161                              cl::desc("Display the MIPS.abiflags section"));
 162
 163   // -mips-reginfo
 164   cl::opt<bool> MipsReginfo("mips-reginfo",
 165                             cl::desc("Display the MIPS .reginfo section"));
 166
 167   // -coff-imports
 168   cl::opt<bool>
 169   COFFImports("coff-imports", cl::desc("Display the PE/COFF import table"));
 170
 171   // -coff-exports
 172   cl::opt<bool>
 173   COFFExports("coff-exports", cl::desc("Display the PE/COFF export table"));
 174
 175   // -coff-directives
 176   cl::opt<bool>
 177   COFFDirectives("coff-directives",
 178                  cl::desc("Display the PE/COFF .drectve section"));
 179
 180   // -coff-basereloc
 181   cl::opt<bool>
 182   COFFBaseRelocs("coff-basereloc",
 183                  cl::desc("Display the PE/COFF .reloc section"));
 184
 185   // -macho-data-in-code
 186   cl::opt<bool>
 187   MachODataInCode("macho-data-in-code",
 188                   cl::desc("Display MachO Data in Code command"));
 189
 190   // -macho-indirect-symbols
 191   cl::opt<bool>
 192   MachOIndirectSymbols("macho-indirect-symbols",
 193                   cl::desc("Display MachO indirect symbols"));
 194
 195   // -macho-segment
 196   cl::opt<bool>
 197   MachOSegment("macho-segment",
 198                   cl::desc("Display MachO Segment command"));
 199
 200   // -macho-version-min
 201   cl::opt<bool>
 202   MachOVersionMin("macho-version-min",
 203                   cl::desc("Display MachO version min command"));
 204
 205   // -macho-dysymtab
 206   cl::opt<bool>
 207   MachODysymtab("macho-dysymtab",
 208                   cl::desc("Display MachO Dysymtab command"));
 209
 210   // -stackmap
 211   cl::opt<bool>
 212   PrintStackMap("stackmap",
 213                 cl::desc("Display contents of stackmap section"));
 214
 215 } // namespace opts
 216
 217 namespace llvm {
 218
 219 void reportError(Twine Msg) {
 220   outs() << "\nError reading file: " << Msg << ".\n";
 221   outs().flush();
 222   exit(1);
 223 }
 224
 225 void error(std::error_code EC) {
 226   if (!EC)
 227     return;
 228
 229   reportError(EC.message());
 230 }
 231
 232 bool relocAddressLess(RelocationRef a, RelocationRef b) {
 233   return a.getOffset() < b.getOffset();
 234 }
 235
 236 } // namespace llvm
 237
 238 static void reportError(StringRef Input, std::error_code EC) {
 239   if (Input == "-")
 240     Input = "<stdin>";
 241
 242   reportError(Twine(Input) + ": " + EC.message());
 243 }
 244
 245 static void reportError(StringRef Input, StringRef Message) {
 246   if (Input == "-")
 247     Input = "<stdin>";
 248
 249   reportError(Twine(Input) + ": " + Message);
 250 }
 251
 252 static bool isMipsArch(unsigned Arch) {
 253   switch (Arch) {
 254   case llvm::Triple::mips:
 255   case llvm::Triple::mipsel:
 256   case llvm::Triple::mips64:
 257   case llvm::Triple::mips64el:
 258     return true;
 259   default:
 260     return false;
 261   }
 262 }
 263
 264 /// @brief Creates an format-specific object file dumper.
 265 static std::error_code createDumper(const ObjectFile *Obj, StreamWriter &Writer,
 266                                     std::unique_ptr<ObjDumper> &Result) {
 267   if (!Obj)
 268     return readobj_error::unsupported_file_format;
 269
 270   if (Obj->isCOFF())
 271     return createCOFFDumper(Obj, Writer, Result);
 272   if (Obj->isELF())
 273     return createELFDumper(Obj, Writer, Result);
 274   if (Obj->isMachO())
 275     return createMachODumper(Obj, Writer, Result);
 276
 277   return readobj_error::unsupported_obj_file_format;
 278 }
 279
 280 /// @brief Dumps the specified object file.
 281 static void dumpObject(const ObjectFile *Obj) {
 282   StreamWriter Writer(outs());
 283   std::unique_ptr<ObjDumper> Dumper;
 284   if (std::error_code EC = createDumper(Obj, Writer, Dumper)) {
 285     reportError(Obj->getFileName(), EC);
 286     return;
 287   }
 288
 289   outs() << '\n';
 290   outs() << "File: " << Obj->getFileName() << "\n";
 291   outs() << "Format: " << Obj->getFileFormatName() << "\n";
 292   outs() << "Arch: "
 293          << Triple::getArchTypeName((llvm::Triple::ArchType)Obj->getArch())
 294          << "\n";
 295   outs() << "AddressSize: " << (8*Obj->getBytesInAddress()) << "bit\n";
 296   Dumper->printLoadName();
 297
 298   if (opts::FileHeaders)
 299     Dumper->printFileHeaders();
 300   if (opts::Sections)
 301     Dumper->printSections();
 302   if (opts::Relocations)
 303     Dumper->printRelocations();
 304   if (opts::DynRelocs)
 305     Dumper->printDynamicRelocations();
 306   if (opts::Symbols)
 307     Dumper->printSymbols();
 308   if (opts::DynamicSymbols)
 309     Dumper->printDynamicSymbols();
 310   if (opts::UnwindInfo)
 311     Dumper->printUnwindInfo();
 312   if (opts::DynamicTable)
 313     Dumper->printDynamicTable();
 314   if (opts::NeededLibraries)
 315     Dumper->printNeededLibraries();
 316   if (opts::ProgramHeaders)
 317     Dumper->printProgramHeaders();
 318   if (opts::HashTable)
 319     Dumper->printHashTable();
 320   if (Obj->getArch() == llvm::Triple::arm && Obj->isELF())
 321     if (opts::ARMAttributes)
 322       Dumper->printAttributes();
 323   if (isMipsArch(Obj->getArch()) && Obj->isELF()) {
 324     if (opts::MipsPLTGOT)
 325       Dumper->printMipsPLTGOT();
 326     if (opts::MipsABIFlags)
 327       Dumper->printMipsABIFlags();
 328     if (opts::MipsReginfo)
 329       Dumper->printMipsReginfo();
 330   }
 331   if (Obj->isCOFF()) {
 332     if (opts::COFFImports)
 333       Dumper->printCOFFImports();
 334     if (opts::COFFExports)
 335       Dumper->printCOFFExports();
 336     if (opts::COFFDirectives)
 337       Dumper->printCOFFDirectives();
 338     if (opts::COFFBaseRelocs)
 339       Dumper->printCOFFBaseReloc();
 340   }
 341   if (Obj->isMachO()) {
 342     if (opts::MachODataInCode)
 343       Dumper->printMachODataInCode();
 344     if (opts::MachOIndirectSymbols)
 345       Dumper->printMachOIndirectSymbols();
 346     if (opts::MachOSegment)
 347       Dumper->printMachOSegment();
 348     if (opts::MachOVersionMin)
 349       Dumper->printMachOVersionMin();
 350     if (opts::MachODysymtab)
 351       Dumper->printMachODysymtab();
 352   }
 353   if (opts::PrintStackMap)
 354     Dumper->printStackMap();
 355 }
 356
 357 /// @brief Dumps each object file in \a Arc;
 358 static void dumpArchive(const Archive *Arc) {
 359   for (const auto &Child : Arc->children()) {
 360     ErrorOr<std::unique_ptr<Binary>> ChildOrErr = Child.getAsBinary();
 361     if (std::error_code EC = ChildOrErr.getError()) {
 362       // Ignore non-object files.
 363       if (EC != object_error::invalid_file_type)
 364         reportError(Arc->getFileName(), EC.message());
 365       continue;
 366     }
 367
 368     if (ObjectFile *Obj = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
 369       dumpObject(Obj);
 370     else
 371       reportError(Arc->getFileName(), readobj_error::unrecognized_file_format);
 372   }
 373 }
 374
 375 /// @brief Dumps each object file in \a MachO Universal Binary;
 376 static void dumpMachOUniversalBinary(const MachOUniversalBinary *UBinary) {
 377   for (const MachOUniversalBinary::ObjectForArch &Obj : UBinary->objects()) {
 378     ErrorOr<std::unique_ptr<MachOObjectFile>> ObjOrErr = Obj.getAsObjectFile();
 379     if (ObjOrErr)
 380       dumpObject(&*ObjOrErr.get());
 381     else if (ErrorOr<std::unique_ptr<Archive>> AOrErr = Obj.getAsArchive())
 382       dumpArchive(&*AOrErr.get());
 383     else
 384       reportError(UBinary->getFileName(), ObjOrErr.getError().message());
 385   }
 386 }
 387
 388 /// @brief Opens \a File and dumps it.
 389 static void dumpInput(StringRef File) {
 390   // If file isn't stdin, check that it exists.
 391   if (File != "-" && !sys::fs::exists(File)) {
 392     reportError(File, readobj_error::file_not_found);
 393     return;
 394   }
 395
 396   // Attempt to open the binary.
 397   ErrorOr<OwningBinary<Binary>> BinaryOrErr = createBinary(File);
 398   if (std::error_code EC = BinaryOrErr.getError()) {
 399     reportError(File, EC);
 400     return;
 401   }
 402   Binary &Binary = *BinaryOrErr.get().getBinary();
 403
 404   if (Archive *Arc = dyn_cast<Archive>(&Binary))
 405     dumpArchive(Arc);
 406   else if (MachOUniversalBinary *UBinary =
 407                dyn_cast<MachOUniversalBinary>(&Binary))
 408     dumpMachOUniversalBinary(UBinary);
 409   else if (ObjectFile *Obj = dyn_cast<ObjectFile>(&Binary))
 410     dumpObject(Obj);
 411   else if (COFFImportFile *Import = dyn_cast<COFFImportFile>(&Binary))
 412     dumpCOFFImportFile(Import);
 413   else
 414     reportError(File, readobj_error::unrecognized_file_format);
 415 }
 416
 417 int main(int argc, const char *argv[]) {
 418   sys::PrintStackTraceOnErrorSignal();
 419   PrettyStackTraceProgram X(argc, argv);
 420   llvm_shutdown_obj Y;
 421
 422   // Register the target printer for --version.
 423   cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
 424
 425   cl::ParseCommandLineOptions(argc, argv, "LLVM Object Reader\n");
 426
 427   // Default to stdin if no filename is specified.
 428   if (opts::InputFilenames.size() == 0)
 429     opts::InputFilenames.push_back("-");
 430
 431   std::for_each(opts::InputFilenames.begin(), opts::InputFilenames.end(),
 432                 dumpInput);
 433
 434   return 0;
 435 }