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-version-min
 191   cl::opt<bool>
 192   MachOVersionMin("macho-version-min",
 193                   cl::desc("Display MachO version min command"));
 194
 195   // -macho-dysymtab
 196   cl::opt<bool>
 197   MachODysymtab("macho-dysymtab",
 198                   cl::desc("Display MachO Dysymtab command"));
 199
 200   // -stackmap
 201   cl::opt<bool>
 202   PrintStackMap("stackmap",
 203                 cl::desc("Display contents of stackmap section"));
 204
 205 } // namespace opts
 206
 207 namespace llvm {
 208
 209 void reportError(Twine Msg) {
 210   outs() << "\nError reading file: " << Msg << ".\n";
 211   outs().flush();
 212   exit(1);
 213 }
 214
 215 void error(std::error_code EC) {
 216   if (!EC)
 217     return;
 218
 219   reportError(EC.message());
 220 }
 221
 222 bool relocAddressLess(RelocationRef a, RelocationRef b) {
 223   return a.getOffset() < b.getOffset();
 224 }
 225
 226 } // namespace llvm
 227
 228 static void reportError(StringRef Input, std::error_code EC) {
 229   if (Input == "-")
 230     Input = "<stdin>";
 231
 232   reportError(Twine(Input) + ": " + EC.message());
 233 }
 234
 235 static void reportError(StringRef Input, StringRef Message) {
 236   if (Input == "-")
 237     Input = "<stdin>";
 238
 239   reportError(Twine(Input) + ": " + Message);
 240 }
 241
 242 static bool isMipsArch(unsigned Arch) {
 243   switch (Arch) {
 244   case llvm::Triple::mips:
 245   case llvm::Triple::mipsel:
 246   case llvm::Triple::mips64:
 247   case llvm::Triple::mips64el:
 248     return true;
 249   default:
 250     return false;
 251   }
 252 }
 253
 254 /// @brief Creates an format-specific object file dumper.
 255 static std::error_code createDumper(const ObjectFile *Obj, StreamWriter &Writer,
 256                                     std::unique_ptr<ObjDumper> &Result) {
 257   if (!Obj)
 258     return readobj_error::unsupported_file_format;
 259
 260   if (Obj->isCOFF())
 261     return createCOFFDumper(Obj, Writer, Result);
 262   if (Obj->isELF())
 263     return createELFDumper(Obj, Writer, Result);
 264   if (Obj->isMachO())
 265     return createMachODumper(Obj, Writer, Result);
 266
 267   return readobj_error::unsupported_obj_file_format;
 268 }
 269
 270 /// @brief Dumps the specified object file.
 271 static void dumpObject(const ObjectFile *Obj) {
 272   StreamWriter Writer(outs());
 273   std::unique_ptr<ObjDumper> Dumper;
 274   if (std::error_code EC = createDumper(Obj, Writer, Dumper)) {
 275     reportError(Obj->getFileName(), EC);
 276     return;
 277   }
 278
 279   outs() << '\n';
 280   outs() << "File: " << Obj->getFileName() << "\n";
 281   outs() << "Format: " << Obj->getFileFormatName() << "\n";
 282   outs() << "Arch: "
 283          << Triple::getArchTypeName((llvm::Triple::ArchType)Obj->getArch())
 284          << "\n";
 285   outs() << "AddressSize: " << (8*Obj->getBytesInAddress()) << "bit\n";
 286   Dumper->printLoadName();
 287
 288   if (opts::FileHeaders)
 289     Dumper->printFileHeaders();
 290   if (opts::Sections)
 291     Dumper->printSections();
 292   if (opts::Relocations)
 293     Dumper->printRelocations();
 294   if (opts::DynRelocs)
 295     Dumper->printDynamicRelocations();
 296   if (opts::Symbols)
 297     Dumper->printSymbols();
 298   if (opts::DynamicSymbols)
 299     Dumper->printDynamicSymbols();
 300   if (opts::UnwindInfo)
 301     Dumper->printUnwindInfo();
 302   if (opts::DynamicTable)
 303     Dumper->printDynamicTable();
 304   if (opts::NeededLibraries)
 305     Dumper->printNeededLibraries();
 306   if (opts::ProgramHeaders)
 307     Dumper->printProgramHeaders();
 308   if (opts::HashTable)
 309     Dumper->printHashTable();
 310   if (Obj->getArch() == llvm::Triple::arm && Obj->isELF())
 311     if (opts::ARMAttributes)
 312       Dumper->printAttributes();
 313   if (isMipsArch(Obj->getArch()) && Obj->isELF()) {
 314     if (opts::MipsPLTGOT)
 315       Dumper->printMipsPLTGOT();
 316     if (opts::MipsABIFlags)
 317       Dumper->printMipsABIFlags();
 318     if (opts::MipsReginfo)
 319       Dumper->printMipsReginfo();
 320   }
 321   if (Obj->isCOFF()) {
 322     if (opts::COFFImports)
 323       Dumper->printCOFFImports();
 324     if (opts::COFFExports)
 325       Dumper->printCOFFExports();
 326     if (opts::COFFDirectives)
 327       Dumper->printCOFFDirectives();
 328     if (opts::COFFBaseRelocs)
 329       Dumper->printCOFFBaseReloc();
 330   }
 331   if (Obj->isMachO()) {
 332     if (opts::MachODataInCode)
 333       Dumper->printMachODataInCode();
 334     if (opts::MachOVersionMin)
 335       Dumper->printMachOVersionMin();
 336     if (opts::MachODysymtab)
 337       Dumper->printMachODysymtab();
 338   }
 339   if (opts::PrintStackMap)
 340     Dumper->printStackMap();
 341 }
 342
 343 /// @brief Dumps each object file in \a Arc;
 344 static void dumpArchive(const Archive *Arc) {
 345   for (const auto &Child : Arc->children()) {
 346     ErrorOr<std::unique_ptr<Binary>> ChildOrErr = Child.getAsBinary();
 347     if (std::error_code EC = ChildOrErr.getError()) {
 348       // Ignore non-object files.
 349       if (EC != object_error::invalid_file_type)
 350         reportError(Arc->getFileName(), EC.message());
 351       continue;
 352     }
 353
 354     if (ObjectFile *Obj = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
 355       dumpObject(Obj);
 356     else
 357       reportError(Arc->getFileName(), readobj_error::unrecognized_file_format);
 358   }
 359 }
 360
 361 /// @brief Dumps each object file in \a MachO Universal Binary;
 362 static void dumpMachOUniversalBinary(const MachOUniversalBinary *UBinary) {
 363   for (const MachOUniversalBinary::ObjectForArch &Obj : UBinary->objects()) {
 364     ErrorOr<std::unique_ptr<MachOObjectFile>> ObjOrErr = Obj.getAsObjectFile();
 365     if (ObjOrErr)
 366       dumpObject(&*ObjOrErr.get());
 367     else if (ErrorOr<std::unique_ptr<Archive>> AOrErr = Obj.getAsArchive())
 368       dumpArchive(&*AOrErr.get());
 369     else
 370       reportError(UBinary->getFileName(), ObjOrErr.getError().message());
 371   }
 372 }
 373
 374 /// @brief Opens \a File and dumps it.
 375 static void dumpInput(StringRef File) {
 376   // If file isn't stdin, check that it exists.
 377   if (File != "-" && !sys::fs::exists(File)) {
 378     reportError(File, readobj_error::file_not_found);
 379     return;
 380   }
 381
 382   // Attempt to open the binary.
 383   ErrorOr<OwningBinary<Binary>> BinaryOrErr = createBinary(File);
 384   if (std::error_code EC = BinaryOrErr.getError()) {
 385     reportError(File, EC);
 386     return;
 387   }
 388   Binary &Binary = *BinaryOrErr.get().getBinary();
 389
 390   if (Archive *Arc = dyn_cast<Archive>(&Binary))
 391     dumpArchive(Arc);
 392   else if (MachOUniversalBinary *UBinary =
 393                dyn_cast<MachOUniversalBinary>(&Binary))
 394     dumpMachOUniversalBinary(UBinary);
 395   else if (ObjectFile *Obj = dyn_cast<ObjectFile>(&Binary))
 396     dumpObject(Obj);
 397   else if (COFFImportFile *Import = dyn_cast<COFFImportFile>(&Binary))
 398     dumpCOFFImportFile(Import);
 399   else
 400     reportError(File, readobj_error::unrecognized_file_format);
 401 }
 402
 403 int main(int argc, const char *argv[]) {
 404   sys::PrintStackTraceOnErrorSignal();
 405   PrettyStackTraceProgram X(argc, argv);
 406   llvm_shutdown_obj Y;
 407
 408   // Register the target printer for --version.
 409   cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
 410
 411   cl::ParseCommandLineOptions(argc, argv, "LLVM Object Reader\n");
 412
 413   // Default to stdin if no filename is specified.
 414   if (opts::InputFilenames.size() == 0)
 415     opts::InputFilenames.push_back("-");
 416
 417   std::for_each(opts::InputFilenames.begin(), opts::InputFilenames.end(),
 418                 dumpInput);
 419
 420   return 0;
 421 }