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