tools/llvm-objdump/llvm-objdump.cpp

   1 //===-- llvm-objdump.cpp - Object file dumping utility for llvm -----------===//
   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 program is a utility that works like binutils "objdump", that is, it
  11 // dumps out a plethora of information about an object file depending on the
  12 // flags.
  13 //
  14 // The flags and output of this program should be near identical to those of
  15 // binutils objdump.
  16 //
  17 //===----------------------------------------------------------------------===//
  18
  19 #include "llvm-objdump.h"
  20 #include "llvm/ADT/Optional.h"
  21 #include "llvm/ADT/STLExtras.h"
  22 #include "llvm/ADT/StringExtras.h"
  23 #include "llvm/ADT/Triple.h"
  24 #include "llvm/CodeGen/FaultMaps.h"
  25 #include "llvm/MC/MCAsmInfo.h"
  26 #include "llvm/MC/MCContext.h"
  27 #include "llvm/MC/MCDisassembler.h"
  28 #include "llvm/MC/MCInst.h"
  29 #include "llvm/MC/MCInstPrinter.h"
  30 #include "llvm/MC/MCInstrAnalysis.h"
  31 #include "llvm/MC/MCInstrInfo.h"
  32 #include "llvm/MC/MCObjectFileInfo.h"
  33 #include "llvm/MC/MCRegisterInfo.h"
  34 #include "llvm/MC/MCRelocationInfo.h"
  35 #include "llvm/MC/MCSubtargetInfo.h"
  36 #include "llvm/Object/Archive.h"
  37 #include "llvm/Object/ELFObjectFile.h"
  38 #include "llvm/Object/COFF.h"
  39 #include "llvm/Object/MachO.h"
  40 #include "llvm/Object/ObjectFile.h"
  41 #include "llvm/Support/Casting.h"
  42 #include "llvm/Support/CommandLine.h"
  43 #include "llvm/Support/Debug.h"
  44 #include "llvm/Support/Errc.h"
  45 #include "llvm/Support/FileSystem.h"
  46 #include "llvm/Support/Format.h"
  47 #include "llvm/Support/GraphWriter.h"
  48 #include "llvm/Support/Host.h"
  49 #include "llvm/Support/ManagedStatic.h"
  50 #include "llvm/Support/MemoryBuffer.h"
  51 #include "llvm/Support/PrettyStackTrace.h"
  52 #include "llvm/Support/Signals.h"
  53 #include "llvm/Support/SourceMgr.h"
  54 #include "llvm/Support/TargetRegistry.h"
  55 #include "llvm/Support/TargetSelect.h"
  56 #include "llvm/Support/raw_ostream.h"
  57 #include <algorithm>
  58 #include <cctype>
  59 #include <cstring>
  60 #include <system_error>
  61
  62 using namespace llvm;
  63 using namespace object;
  64
  65 static cl::list<std::string>
  66 InputFilenames(cl::Positional, cl::desc("<input object files>"),cl::ZeroOrMore);
  67
  68 cl::opt<bool>
  69 llvm::Disassemble("disassemble",
  70   cl::desc("Display assembler mnemonics for the machine instructions"));
  71 static cl::alias
  72 Disassembled("d", cl::desc("Alias for --disassemble"),
  73              cl::aliasopt(Disassemble));
  74
  75 cl::opt<bool>
  76 llvm::Relocations("r", cl::desc("Display the relocation entries in the file"));
  77
  78 cl::opt<bool>
  79 llvm::SectionContents("s", cl::desc("Display the content of each section"));
  80
  81 cl::opt<bool>
  82 llvm::SymbolTable("t", cl::desc("Display the symbol table"));
  83
  84 cl::opt<bool>
  85 llvm::ExportsTrie("exports-trie", cl::desc("Display mach-o exported symbols"));
  86
  87 cl::opt<bool>
  88 llvm::Rebase("rebase", cl::desc("Display mach-o rebasing info"));
  89
  90 cl::opt<bool>
  91 llvm::Bind("bind", cl::desc("Display mach-o binding info"));
  92
  93 cl::opt<bool>
  94 llvm::LazyBind("lazy-bind", cl::desc("Display mach-o lazy binding info"));
  95
  96 cl::opt<bool>
  97 llvm::WeakBind("weak-bind", cl::desc("Display mach-o weak binding info"));
  98
  99 static cl::opt<bool>
 100 MachOOpt("macho", cl::desc("Use MachO specific object file parser"));
 101 static cl::alias
 102 MachOm("m", cl::desc("Alias for --macho"), cl::aliasopt(MachOOpt));
 103
 104 cl::opt<std::string>
 105 llvm::TripleName("triple", cl::desc("Target triple to disassemble for, "
 106                                     "see -version for available targets"));
 107
 108 cl::opt<std::string>
 109 llvm::MCPU("mcpu",
 110      cl::desc("Target a specific cpu type (-mcpu=help for details)"),
 111      cl::value_desc("cpu-name"),
 112      cl::init(""));
 113
 114 cl::opt<std::string>
 115 llvm::ArchName("arch-name", cl::desc("Target arch to disassemble for, "
 116                                 "see -version for available targets"));
 117
 118 cl::opt<bool>
 119 llvm::SectionHeaders("section-headers", cl::desc("Display summaries of the "
 120                                                  "headers for each section."));
 121 static cl::alias
 122 SectionHeadersShort("headers", cl::desc("Alias for --section-headers"),
 123                     cl::aliasopt(SectionHeaders));
 124 static cl::alias
 125 SectionHeadersShorter("h", cl::desc("Alias for --section-headers"),
 126                       cl::aliasopt(SectionHeaders));
 127
 128 cl::list<std::string>
 129 llvm::MAttrs("mattr",
 130   cl::CommaSeparated,
 131   cl::desc("Target specific attributes"),
 132   cl::value_desc("a1,+a2,-a3,..."));
 133
 134 cl::opt<bool>
 135 llvm::NoShowRawInsn("no-show-raw-insn", cl::desc("When disassembling "
 136                                                  "instructions, do not print "
 137                                                  "the instruction bytes."));
 138
 139 cl::opt<bool>
 140 llvm::UnwindInfo("unwind-info", cl::desc("Display unwind information"));
 141
 142 static cl::alias
 143 UnwindInfoShort("u", cl::desc("Alias for --unwind-info"),
 144                 cl::aliasopt(UnwindInfo));
 145
 146 cl::opt<bool>
 147 llvm::PrivateHeaders("private-headers",
 148                      cl::desc("Display format specific file headers"));
 149
 150 static cl::alias
 151 PrivateHeadersShort("p", cl::desc("Alias for --private-headers"),
 152                     cl::aliasopt(PrivateHeaders));
 153
 154 cl::opt<bool>
 155     llvm::PrintImmHex("print-imm-hex",
 156                       cl::desc("Use hex format for immediate values"));
 157
 158 cl::opt<bool> PrintFaultMaps("fault-map-section",
 159                              cl::desc("Display contents of faultmap section"));
 160
 161 static StringRef ToolName;
 162 static int ReturnValue = EXIT_SUCCESS;
 163
 164 bool llvm::error(std::error_code EC) {
 165   if (!EC)
 166     return false;
 167
 168   outs() << ToolName << ": error reading file: " << EC.message() << ".\n";
 169   outs().flush();
 170   ReturnValue = EXIT_FAILURE;
 171   return true;
 172 }
 173
 174 static void report_error(StringRef File, std::error_code EC) {
 175   assert(EC);
 176   errs() << ToolName << ": '" << File << "': " << EC.message() << ".\n";
 177   ReturnValue = EXIT_FAILURE;
 178 }
 179
 180 static const Target *getTarget(const ObjectFile *Obj = nullptr) {
 181   // Figure out the target triple.
 182   llvm::Triple TheTriple("unknown-unknown-unknown");
 183   if (TripleName.empty()) {
 184     if (Obj) {
 185       TheTriple.setArch(Triple::ArchType(Obj->getArch()));
 186       // TheTriple defaults to ELF, and COFF doesn't have an environment:
 187       // the best we can do here is indicate that it is mach-o.
 188       if (Obj->isMachO())
 189         TheTriple.setObjectFormat(Triple::MachO);
 190
 191       if (Obj->isCOFF()) {
 192         const auto COFFObj = dyn_cast<COFFObjectFile>(Obj);
 193         if (COFFObj->getArch() == Triple::thumb)
 194           TheTriple.setTriple("thumbv7-windows");
 195       }
 196     }
 197   } else
 198     TheTriple.setTriple(Triple::normalize(TripleName));
 199
 200   // Get the target specific parser.
 201   std::string Error;
 202   const Target *TheTarget = TargetRegistry::lookupTarget(ArchName, TheTriple,
 203                                                          Error);
 204   if (!TheTarget) {
 205     errs() << ToolName << ": " << Error;
 206     return nullptr;
 207   }
 208
 209   // Update the triple name and return the found target.
 210   TripleName = TheTriple.getTriple();
 211   return TheTarget;
 212 }
 213
 214 bool llvm::RelocAddressLess(RelocationRef a, RelocationRef b) {
 215   uint64_t a_addr = a.getOffset();
 216   uint64_t b_addr = b.getOffset();
 217   return a_addr < b_addr;
 218 }
 219
 220 namespace {
 221 class PrettyPrinter {
 222 public:
 223   virtual ~PrettyPrinter(){}
 224   virtual void printInst(MCInstPrinter &IP, const MCInst *MI,
 225                          ArrayRef<uint8_t> Bytes, uint64_t Address,
 226                          raw_ostream &OS, StringRef Annot,
 227                          MCSubtargetInfo const &STI) {
 228     outs() << format("%8" PRIx64 ":", Address);
 229     if (!NoShowRawInsn) {
 230       outs() << "\t";
 231       dumpBytes(Bytes, outs());
 232     }
 233     IP.printInst(MI, outs(), "", STI);
 234   }
 235 };
 236 PrettyPrinter PrettyPrinterInst;
 237 class HexagonPrettyPrinter : public PrettyPrinter {
 238 public:
 239   void printLead(ArrayRef<uint8_t> Bytes, uint64_t Address,
 240                  raw_ostream &OS) {
 241     uint32_t opcode =
 242       (Bytes[3] << 24) | (Bytes[2] << 16) | (Bytes[1] << 8) | Bytes[0];
 243     OS << format("%8" PRIx64 ":", Address);
 244     if (!NoShowRawInsn) {
 245       OS << "\t";
 246       dumpBytes(Bytes.slice(0, 4), OS);
 247       OS << format("%08" PRIx32, opcode);
 248     }
 249   }
 250   void printInst(MCInstPrinter &IP, const MCInst *MI,
 251                  ArrayRef<uint8_t> Bytes, uint64_t Address,
 252                  raw_ostream &OS, StringRef Annot,
 253                  MCSubtargetInfo const &STI) override {
 254     std::string Buffer;
 255     {
 256       raw_string_ostream TempStream(Buffer);
 257       IP.printInst(MI, TempStream, "", STI);
 258     }
 259     StringRef Contents(Buffer);
 260     // Split off bundle attributes
 261     auto PacketBundle = Contents.rsplit('\n');
 262     // Split off first instruction from the rest
 263     auto HeadTail = PacketBundle.first.split('\n');
 264     auto Preamble = " { ";
 265     auto Separator = "";
 266     while(!HeadTail.first.empty()) {
 267       OS << Separator;
 268       Separator = "\n";
 269       printLead(Bytes, Address, OS);
 270       OS << Preamble;
 271       Preamble = "   ";
 272       StringRef Inst;
 273       auto Duplex = HeadTail.first.split('\v');
 274       if(!Duplex.second.empty()){
 275         OS << Duplex.first;
 276         OS << "; ";
 277         Inst = Duplex.second;
 278       }
 279       else
 280         Inst = HeadTail.first;
 281       OS << Inst;
 282       Bytes = Bytes.slice(4);
 283       Address += 4;
 284       HeadTail = HeadTail.second.split('\n');
 285     }
 286     OS << " } " << PacketBundle.second;
 287   }
 288 };
 289 HexagonPrettyPrinter HexagonPrettyPrinterInst;
 290 PrettyPrinter &selectPrettyPrinter(Triple const &Triple) {
 291   switch(Triple.getArch()) {
 292   default:
 293     return PrettyPrinterInst;
 294   case Triple::hexagon:
 295     return HexagonPrettyPrinterInst;
 296   }
 297 }
 298 }
 299
 300 template <class ELFT>
 301 static std::error_code getRelocationValueString(const ELFObjectFile<ELFT> *Obj,
 302                                                 DataRefImpl Rel,
 303                                                 SmallVectorImpl<char> &Result) {
 304   typedef typename ELFObjectFile<ELFT>::Elf_Sym Elf_Sym;
 305   typedef typename ELFObjectFile<ELFT>::Elf_Shdr Elf_Shdr;
 306   typedef typename ELFObjectFile<ELFT>::Elf_Rel Elf_Rel;
 307   typedef typename ELFObjectFile<ELFT>::Elf_Rela Elf_Rela;
 308
 309   const ELFFile<ELFT> &EF = *Obj->getELFFile();
 310
 311   ErrorOr<const Elf_Shdr *> SecOrErr = EF.getSection(Rel.d.a);
 312   if (std::error_code EC = SecOrErr.getError())
 313     return EC;
 314   const Elf_Shdr *Sec = *SecOrErr;
 315   ErrorOr<const Elf_Shdr *> SymTabOrErr = EF.getSection(Sec->sh_link);
 316   if (std::error_code EC = SymTabOrErr.getError())
 317     return EC;
 318   const Elf_Shdr *SymTab = *SymTabOrErr;
 319   assert(SymTab->sh_type == ELF::SHT_SYMTAB ||
 320          SymTab->sh_type == ELF::SHT_DYNSYM);
 321   ErrorOr<const Elf_Shdr *> StrTabSec = EF.getSection(SymTab->sh_link);
 322   if (std::error_code EC = StrTabSec.getError())
 323     return EC;
 324   ErrorOr<StringRef> StrTabOrErr = EF.getStringTable(*StrTabSec);
 325   if (std::error_code EC = StrTabOrErr.getError())
 326     return EC;
 327   StringRef StrTab = *StrTabOrErr;
 328   uint8_t type;
 329   StringRef res;
 330   int64_t addend = 0;
 331   uint16_t symbol_index = 0;
 332   switch (Sec->sh_type) {
 333   default:
 334     return object_error::parse_failed;
 335   case ELF::SHT_REL: {
 336     const Elf_Rel *ERel = Obj->getRel(Rel);
 337     type = ERel->getType(EF.isMips64EL());
 338     symbol_index = ERel->getSymbol(EF.isMips64EL());
 339     // TODO: Read implicit addend from section data.
 340     break;
 341   }
 342   case ELF::SHT_RELA: {
 343     const Elf_Rela *ERela = Obj->getRela(Rel);
 344     type = ERela->getType(EF.isMips64EL());
 345     symbol_index = ERela->getSymbol(EF.isMips64EL());
 346     addend = ERela->r_addend;
 347     break;
 348   }
 349   }
 350   const Elf_Sym *symb =
 351       EF.template getEntry<Elf_Sym>(Sec->sh_link, symbol_index);
 352   StringRef Target;
 353   ErrorOr<const Elf_Shdr *> SymSec = EF.getSection(symb);
 354   if (std::error_code EC = SymSec.getError())
 355     return EC;
 356   if (symb->getType() == ELF::STT_SECTION) {
 357     ErrorOr<StringRef> SecName = EF.getSectionName(*SymSec);
 358     if (std::error_code EC = SecName.getError())
 359       return EC;
 360     Target = *SecName;
 361   } else {
 362     ErrorOr<StringRef> SymName = symb->getName(StrTab);
 363     if (!SymName)
 364       return SymName.getError();
 365     Target = *SymName;
 366   }
 367   switch (EF.getHeader()->e_machine) {
 368   case ELF::EM_X86_64:
 369     switch (type) {
 370     case ELF::R_X86_64_PC8:
 371     case ELF::R_X86_64_PC16:
 372     case ELF::R_X86_64_PC32: {
 373       std::string fmtbuf;
 374       raw_string_ostream fmt(fmtbuf);
 375       fmt << Target << (addend < 0 ? "" : "+") << addend << "-P";
 376       fmt.flush();
 377       Result.append(fmtbuf.begin(), fmtbuf.end());
 378     } break;
 379     case ELF::R_X86_64_8:
 380     case ELF::R_X86_64_16:
 381     case ELF::R_X86_64_32:
 382     case ELF::R_X86_64_32S:
 383     case ELF::R_X86_64_64: {
 384       std::string fmtbuf;
 385       raw_string_ostream fmt(fmtbuf);
 386       fmt << Target << (addend < 0 ? "" : "+") << addend;
 387       fmt.flush();
 388       Result.append(fmtbuf.begin(), fmtbuf.end());
 389     } break;
 390     default:
 391       res = "Unknown";
 392     }
 393     break;
 394   case ELF::EM_AARCH64: {
 395     std::string fmtbuf;
 396     raw_string_ostream fmt(fmtbuf);
 397     fmt << Target;
 398     if (addend != 0)
 399       fmt << (addend < 0 ? "" : "+") << addend;
 400     fmt.flush();
 401     Result.append(fmtbuf.begin(), fmtbuf.end());
 402     break;
 403   }
 404   case ELF::EM_386:
 405   case ELF::EM_ARM:
 406   case ELF::EM_HEXAGON:
 407   case ELF::EM_MIPS:
 408     res = Target;
 409     break;
 410   default:
 411     res = "Unknown";
 412   }
 413   if (Result.empty())
 414     Result.append(res.begin(), res.end());
 415   return std::error_code();
 416 }
 417
 418 static std::error_code getRelocationValueString(const ELFObjectFileBase *Obj,
 419                                                 const RelocationRef &RelRef,
 420                                                 SmallVectorImpl<char> &Result) {
 421   DataRefImpl Rel = RelRef.getRawDataRefImpl();
 422   if (auto *ELF32LE = dyn_cast<ELF32LEObjectFile>(Obj))
 423     return getRelocationValueString(ELF32LE, Rel, Result);
 424   if (auto *ELF64LE = dyn_cast<ELF64LEObjectFile>(Obj))
 425     return getRelocationValueString(ELF64LE, Rel, Result);
 426   if (auto *ELF32BE = dyn_cast<ELF32BEObjectFile>(Obj))
 427     return getRelocationValueString(ELF32BE, Rel, Result);
 428   auto *ELF64BE = cast<ELF64BEObjectFile>(Obj);
 429   return getRelocationValueString(ELF64BE, Rel, Result);
 430 }
 431
 432 static std::error_code getRelocationValueString(const COFFObjectFile *Obj,
 433                                                 const RelocationRef &Rel,
 434                                                 SmallVectorImpl<char> &Result) {
 435   symbol_iterator SymI = Rel.getSymbol();
 436   ErrorOr<StringRef> SymNameOrErr = SymI->getName();
 437   if (std::error_code EC = SymNameOrErr.getError())
 438     return EC;
 439   StringRef SymName = *SymNameOrErr;
 440   Result.append(SymName.begin(), SymName.end());
 441   return std::error_code();
 442 }
 443
 444 static void printRelocationTargetName(const MachOObjectFile *O,
 445                                       const MachO::any_relocation_info &RE,
 446                                       raw_string_ostream &fmt) {
 447   bool IsScattered = O->isRelocationScattered(RE);
 448
 449   // Target of a scattered relocation is an address.  In the interest of
 450   // generating pretty output, scan through the symbol table looking for a
 451   // symbol that aligns with that address.  If we find one, print it.
 452   // Otherwise, we just print the hex address of the target.
 453   if (IsScattered) {
 454     uint32_t Val = O->getPlainRelocationSymbolNum(RE);
 455
 456     for (const SymbolRef &Symbol : O->symbols()) {
 457       std::error_code ec;
 458       uint64_t Addr;
 459       ErrorOr<StringRef> Name = Symbol.getName();
 460
 461       if ((ec = Symbol.getAddress(Addr)))
 462         report_fatal_error(ec.message());
 463       if (Addr != Val)
 464         continue;
 465       if (std::error_code EC = Name.getError())
 466         report_fatal_error(EC.message());
 467       fmt << *Name;
 468       return;
 469     }
 470
 471     // If we couldn't find a symbol that this relocation refers to, try
 472     // to find a section beginning instead.
 473     for (const SectionRef &Section : O->sections()) {
 474       std::error_code ec;
 475
 476       StringRef Name;
 477       uint64_t Addr = Section.getAddress();
 478       if (Addr != Val)
 479         continue;
 480       if ((ec = Section.getName(Name)))
 481         report_fatal_error(ec.message());
 482       fmt << Name;
 483       return;
 484     }
 485
 486     fmt << format("0x%x", Val);
 487     return;
 488   }
 489
 490   StringRef S;
 491   bool isExtern = O->getPlainRelocationExternal(RE);
 492   uint64_t Val = O->getPlainRelocationSymbolNum(RE);
 493
 494   if (isExtern) {
 495     symbol_iterator SI = O->symbol_begin();
 496     advance(SI, Val);
 497     ErrorOr<StringRef> SOrErr = SI->getName();
 498     if (!error(SOrErr.getError()))
 499       S = *SOrErr;
 500   } else {
 501     section_iterator SI = O->section_begin();
 502     // Adjust for the fact that sections are 1-indexed.
 503     advance(SI, Val - 1);
 504     SI->getName(S);
 505   }
 506
 507   fmt << S;
 508 }
 509
 510 static std::error_code getRelocationValueString(const MachOObjectFile *Obj,
 511                                                 const RelocationRef &RelRef,
 512                                                 SmallVectorImpl<char> &Result) {
 513   DataRefImpl Rel = RelRef.getRawDataRefImpl();
 514   MachO::any_relocation_info RE = Obj->getRelocation(Rel);
 515
 516   unsigned Arch = Obj->getArch();
 517
 518   std::string fmtbuf;
 519   raw_string_ostream fmt(fmtbuf);
 520   unsigned Type = Obj->getAnyRelocationType(RE);
 521   bool IsPCRel = Obj->getAnyRelocationPCRel(RE);
 522
 523   // Determine any addends that should be displayed with the relocation.
 524   // These require decoding the relocation type, which is triple-specific.
 525
 526   // X86_64 has entirely custom relocation types.
 527   if (Arch == Triple::x86_64) {
 528     bool isPCRel = Obj->getAnyRelocationPCRel(RE);
 529
 530     switch (Type) {
 531     case MachO::X86_64_RELOC_GOT_LOAD:
 532     case MachO::X86_64_RELOC_GOT: {
 533       printRelocationTargetName(Obj, RE, fmt);
 534       fmt << "@GOT";
 535       if (isPCRel)
 536         fmt << "PCREL";
 537       break;
 538     }
 539     case MachO::X86_64_RELOC_SUBTRACTOR: {
 540       DataRefImpl RelNext = Rel;
 541       Obj->moveRelocationNext(RelNext);
 542       MachO::any_relocation_info RENext = Obj->getRelocation(RelNext);
 543
 544       // X86_64_RELOC_SUBTRACTOR must be followed by a relocation of type
 545       // X86_64_RELOC_UNSIGNED.
 546       // NOTE: Scattered relocations don't exist on x86_64.
 547       unsigned RType = Obj->getAnyRelocationType(RENext);
 548       if (RType != MachO::X86_64_RELOC_UNSIGNED)
 549         report_fatal_error("Expected X86_64_RELOC_UNSIGNED after "
 550                            "X86_64_RELOC_SUBTRACTOR.");
 551
 552       // The X86_64_RELOC_UNSIGNED contains the minuend symbol;
 553       // X86_64_RELOC_SUBTRACTOR contains the subtrahend.
 554       printRelocationTargetName(Obj, RENext, fmt);
 555       fmt << "-";
 556       printRelocationTargetName(Obj, RE, fmt);
 557       break;
 558     }
 559     case MachO::X86_64_RELOC_TLV:
 560       printRelocationTargetName(Obj, RE, fmt);
 561       fmt << "@TLV";
 562       if (isPCRel)
 563         fmt << "P";
 564       break;
 565     case MachO::X86_64_RELOC_SIGNED_1:
 566       printRelocationTargetName(Obj, RE, fmt);
 567       fmt << "-1";
 568       break;
 569     case MachO::X86_64_RELOC_SIGNED_2:
 570       printRelocationTargetName(Obj, RE, fmt);
 571       fmt << "-2";
 572       break;
 573     case MachO::X86_64_RELOC_SIGNED_4:
 574       printRelocationTargetName(Obj, RE, fmt);
 575       fmt << "-4";
 576       break;
 577     default:
 578       printRelocationTargetName(Obj, RE, fmt);
 579       break;
 580     }
 581     // X86 and ARM share some relocation types in common.
 582   } else if (Arch == Triple::x86 || Arch == Triple::arm ||
 583              Arch == Triple::ppc) {
 584     // Generic relocation types...
 585     switch (Type) {
 586     case MachO::GENERIC_RELOC_PAIR: // prints no info
 587       return std::error_code();
 588     case MachO::GENERIC_RELOC_SECTDIFF: {
 589       DataRefImpl RelNext = Rel;
 590       Obj->moveRelocationNext(RelNext);
 591       MachO::any_relocation_info RENext = Obj->getRelocation(RelNext);
 592
 593       // X86 sect diff's must be followed by a relocation of type
 594       // GENERIC_RELOC_PAIR.
 595       unsigned RType = Obj->getAnyRelocationType(RENext);
 596
 597       if (RType != MachO::GENERIC_RELOC_PAIR)
 598         report_fatal_error("Expected GENERIC_RELOC_PAIR after "
 599                            "GENERIC_RELOC_SECTDIFF.");
 600
 601       printRelocationTargetName(Obj, RE, fmt);
 602       fmt << "-";
 603       printRelocationTargetName(Obj, RENext, fmt);
 604       break;
 605     }
 606     }
 607
 608     if (Arch == Triple::x86 || Arch == Triple::ppc) {
 609       switch (Type) {
 610       case MachO::GENERIC_RELOC_LOCAL_SECTDIFF: {
 611         DataRefImpl RelNext = Rel;
 612         Obj->moveRelocationNext(RelNext);
 613         MachO::any_relocation_info RENext = Obj->getRelocation(RelNext);
 614
 615         // X86 sect diff's must be followed by a relocation of type
 616         // GENERIC_RELOC_PAIR.
 617         unsigned RType = Obj->getAnyRelocationType(RENext);
 618         if (RType != MachO::GENERIC_RELOC_PAIR)
 619           report_fatal_error("Expected GENERIC_RELOC_PAIR after "
 620                              "GENERIC_RELOC_LOCAL_SECTDIFF.");
 621
 622         printRelocationTargetName(Obj, RE, fmt);
 623         fmt << "-";
 624         printRelocationTargetName(Obj, RENext, fmt);
 625         break;
 626       }
 627       case MachO::GENERIC_RELOC_TLV: {
 628         printRelocationTargetName(Obj, RE, fmt);
 629         fmt << "@TLV";
 630         if (IsPCRel)
 631           fmt << "P";
 632         break;
 633       }
 634       default:
 635         printRelocationTargetName(Obj, RE, fmt);
 636       }
 637     } else { // ARM-specific relocations
 638       switch (Type) {
 639       case MachO::ARM_RELOC_HALF:
 640       case MachO::ARM_RELOC_HALF_SECTDIFF: {
 641         // Half relocations steal a bit from the length field to encode
 642         // whether this is an upper16 or a lower16 relocation.
 643         bool isUpper = Obj->getAnyRelocationLength(RE) >> 1;
 644
 645         if (isUpper)
 646           fmt << ":upper16:(";
 647         else
 648           fmt << ":lower16:(";
 649         printRelocationTargetName(Obj, RE, fmt);
 650
 651         DataRefImpl RelNext = Rel;
 652         Obj->moveRelocationNext(RelNext);
 653         MachO::any_relocation_info RENext = Obj->getRelocation(RelNext);
 654
 655         // ARM half relocs must be followed by a relocation of type
 656         // ARM_RELOC_PAIR.
 657         unsigned RType = Obj->getAnyRelocationType(RENext);
 658         if (RType != MachO::ARM_RELOC_PAIR)
 659           report_fatal_error("Expected ARM_RELOC_PAIR after "
 660                              "ARM_RELOC_HALF");
 661
 662         // NOTE: The half of the target virtual address is stashed in the
 663         // address field of the secondary relocation, but we can't reverse
 664         // engineer the constant offset from it without decoding the movw/movt
 665         // instruction to find the other half in its immediate field.
 666
 667         // ARM_RELOC_HALF_SECTDIFF encodes the second section in the
 668         // symbol/section pointer of the follow-on relocation.
 669         if (Type == MachO::ARM_RELOC_HALF_SECTDIFF) {
 670           fmt << "-";
 671           printRelocationTargetName(Obj, RENext, fmt);
 672         }
 673
 674         fmt << ")";
 675         break;
 676       }
 677       default: { printRelocationTargetName(Obj, RE, fmt); }
 678       }
 679     }
 680   } else
 681     printRelocationTargetName(Obj, RE, fmt);
 682
 683   fmt.flush();
 684   Result.append(fmtbuf.begin(), fmtbuf.end());
 685   return std::error_code();
 686 }
 687
 688 static std::error_code getRelocationValueString(const RelocationRef &Rel,
 689                                                 SmallVectorImpl<char> &Result) {
 690   const ObjectFile *Obj = Rel.getObject();
 691   if (auto *ELF = dyn_cast<ELFObjectFileBase>(Obj))
 692     return getRelocationValueString(ELF, Rel, Result);
 693   if (auto *COFF = dyn_cast<COFFObjectFile>(Obj))
 694     return getRelocationValueString(COFF, Rel, Result);
 695   auto *MachO = cast<MachOObjectFile>(Obj);
 696   return getRelocationValueString(MachO, Rel, Result);
 697 }
 698
 699 /// @brief Indicates whether this relocation should hidden when listing
 700 /// relocations, usually because it is the trailing part of a multipart
 701 /// relocation that will be printed as part of the leading relocation.
 702 static bool getHidden(RelocationRef RelRef) {
 703   const ObjectFile *Obj = RelRef.getObject();
 704   auto *MachO = dyn_cast<MachOObjectFile>(Obj);
 705   if (!MachO)
 706     return false;
 707
 708   unsigned Arch = MachO->getArch();
 709   DataRefImpl Rel = RelRef.getRawDataRefImpl();
 710   uint64_t Type = MachO->getRelocationType(Rel);
 711
 712   // On arches that use the generic relocations, GENERIC_RELOC_PAIR
 713   // is always hidden.
 714   if (Arch == Triple::x86 || Arch == Triple::arm || Arch == Triple::ppc) {
 715     if (Type == MachO::GENERIC_RELOC_PAIR)
 716       return true;
 717   } else if (Arch == Triple::x86_64) {
 718     // On x86_64, X86_64_RELOC_UNSIGNED is hidden only when it follows
 719     // an X86_64_RELOC_SUBTRACTOR.
 720     if (Type == MachO::X86_64_RELOC_UNSIGNED && Rel.d.a > 0) {
 721       DataRefImpl RelPrev = Rel;
 722       RelPrev.d.a--;
 723       uint64_t PrevType = MachO->getRelocationType(RelPrev);
 724       if (PrevType == MachO::X86_64_RELOC_SUBTRACTOR)
 725         return true;
 726     }
 727   }
 728
 729   return false;
 730 }
 731
 732 static void DisassembleObject(const ObjectFile *Obj, bool InlineRelocs) {
 733   const Target *TheTarget = getTarget(Obj);
 734   // getTarget() will have already issued a diagnostic if necessary, so
 735   // just bail here if it failed.
 736   if (!TheTarget)
 737     return;
 738
 739   // Package up features to be passed to target/subtarget
 740   std::string FeaturesStr;
 741   if (MAttrs.size()) {
 742     SubtargetFeatures Features;
 743     for (unsigned i = 0; i != MAttrs.size(); ++i)
 744       Features.AddFeature(MAttrs[i]);
 745     FeaturesStr = Features.getString();
 746   }
 747
 748   std::unique_ptr<const MCRegisterInfo> MRI(
 749       TheTarget->createMCRegInfo(TripleName));
 750   if (!MRI) {
 751     errs() << "error: no register info for target " << TripleName << "\n";
 752     return;
 753   }
 754
 755   // Set up disassembler.
 756   std::unique_ptr<const MCAsmInfo> AsmInfo(
 757       TheTarget->createMCAsmInfo(*MRI, TripleName));
 758   if (!AsmInfo) {
 759     errs() << "error: no assembly info for target " << TripleName << "\n";
 760     return;
 761   }
 762
 763   std::unique_ptr<const MCSubtargetInfo> STI(
 764       TheTarget->createMCSubtargetInfo(TripleName, MCPU, FeaturesStr));
 765   if (!STI) {
 766     errs() << "error: no subtarget info for target " << TripleName << "\n";
 767     return;
 768   }
 769
 770   std::unique_ptr<const MCInstrInfo> MII(TheTarget->createMCInstrInfo());
 771   if (!MII) {
 772     errs() << "error: no instruction info for target " << TripleName << "\n";
 773     return;
 774   }
 775
 776   std::unique_ptr<const MCObjectFileInfo> MOFI(new MCObjectFileInfo);
 777   MCContext Ctx(AsmInfo.get(), MRI.get(), MOFI.get());
 778
 779   std::unique_ptr<MCDisassembler> DisAsm(
 780     TheTarget->createMCDisassembler(*STI, Ctx));
 781
 782   if (!DisAsm) {
 783     errs() << "error: no disassembler for target " << TripleName << "\n";
 784     return;
 785   }
 786
 787   std::unique_ptr<const MCInstrAnalysis> MIA(
 788       TheTarget->createMCInstrAnalysis(MII.get()));
 789
 790   int AsmPrinterVariant = AsmInfo->getAssemblerDialect();
 791   std::unique_ptr<MCInstPrinter> IP(TheTarget->createMCInstPrinter(
 792       Triple(TripleName), AsmPrinterVariant, *AsmInfo, *MII, *MRI));
 793   if (!IP) {
 794     errs() << "error: no instruction printer for target " << TripleName
 795       << '\n';
 796     return;
 797   }
 798   IP->setPrintImmHex(PrintImmHex);
 799   PrettyPrinter &PIP = selectPrettyPrinter(Triple(TripleName));
 800
 801   StringRef Fmt = Obj->getBytesInAddress() > 4 ? "\t\t%016" PRIx64 ":  " :
 802                                                  "\t\t\t%08" PRIx64 ":  ";
 803
 804   // Create a mapping, RelocSecs = SectionRelocMap[S], where sections
 805   // in RelocSecs contain the relocations for section S.
 806   std::error_code EC;
 807   std::map<SectionRef, SmallVector<SectionRef, 1>> SectionRelocMap;
 808   for (const SectionRef &Section : Obj->sections()) {
 809     section_iterator Sec2 = Section.getRelocatedSection();
 810     if (Sec2 != Obj->section_end())
 811       SectionRelocMap[*Sec2].push_back(Section);
 812   }
 813
 814   for (const SectionRef &Section : Obj->sections()) {
 815     if (!Section.isText() || Section.isVirtual())
 816       continue;
 817
 818     uint64_t SectionAddr = Section.getAddress();
 819     uint64_t SectSize = Section.getSize();
 820     if (!SectSize)
 821       continue;
 822
 823     // Make a list of all the symbols in this section.
 824     std::vector<std::pair<uint64_t, StringRef>> Symbols;
 825     for (const SymbolRef &Symbol : Obj->symbols()) {
 826       if (Section.containsSymbol(Symbol)) {
 827         uint64_t Address;
 828         if (error(Symbol.getAddress(Address)))
 829           break;
 830         if (Address == UnknownAddress)
 831           continue;
 832         Address -= SectionAddr;
 833         if (Address >= SectSize)
 834           continue;
 835
 836         ErrorOr<StringRef> Name = Symbol.getName();
 837         if (error(Name.getError()))
 838           break;
 839         Symbols.push_back(std::make_pair(Address, *Name));
 840       }
 841     }
 842
 843     // Sort the symbols by address, just in case they didn't come in that way.
 844     array_pod_sort(Symbols.begin(), Symbols.end());
 845
 846     // Make a list of all the relocations for this section.
 847     std::vector<RelocationRef> Rels;
 848     if (InlineRelocs) {
 849       for (const SectionRef &RelocSec : SectionRelocMap[Section]) {
 850         for (const RelocationRef &Reloc : RelocSec.relocations()) {
 851           Rels.push_back(Reloc);
 852         }
 853       }
 854     }
 855
 856     // Sort relocations by address.
 857     std::sort(Rels.begin(), Rels.end(), RelocAddressLess);
 858
 859     StringRef SegmentName = "";
 860     if (const MachOObjectFile *MachO = dyn_cast<const MachOObjectFile>(Obj)) {
 861       DataRefImpl DR = Section.getRawDataRefImpl();
 862       SegmentName = MachO->getSectionFinalSegmentName(DR);
 863     }
 864     StringRef name;
 865     if (error(Section.getName(name)))
 866       break;
 867     outs() << "Disassembly of section ";
 868     if (!SegmentName.empty())
 869       outs() << SegmentName << ",";
 870     outs() << name << ':';
 871
 872     // If the section has no symbol at the start, just insert a dummy one.
 873     if (Symbols.empty() || Symbols[0].first != 0)
 874       Symbols.insert(Symbols.begin(), std::make_pair(0, name));
 875
 876     SmallString<40> Comments;
 877     raw_svector_ostream CommentStream(Comments);
 878
 879     StringRef BytesStr;
 880     if (error(Section.getContents(BytesStr)))
 881       break;
 882     ArrayRef<uint8_t> Bytes(reinterpret_cast<const uint8_t *>(BytesStr.data()),
 883                             BytesStr.size());
 884
 885     uint64_t Size;
 886     uint64_t Index;
 887
 888     std::vector<RelocationRef>::const_iterator rel_cur = Rels.begin();
 889     std::vector<RelocationRef>::const_iterator rel_end = Rels.end();
 890     // Disassemble symbol by symbol.
 891     for (unsigned si = 0, se = Symbols.size(); si != se; ++si) {
 892
 893       uint64_t Start = Symbols[si].first;
 894       // The end is either the section end or the beginning of the next symbol.
 895       uint64_t End = (si == se - 1) ? SectSize : Symbols[si + 1].first;
 896       // If this symbol has the same address as the next symbol, then skip it.
 897       if (Start == End)
 898         continue;
 899
 900       outs() << '\n' << Symbols[si].second << ":\n";
 901
 902 #ifndef NDEBUG
 903       raw_ostream &DebugOut = DebugFlag ? dbgs() : nulls();
 904 #else
 905       raw_ostream &DebugOut = nulls();
 906 #endif
 907
 908       for (Index = Start; Index < End; Index += Size) {
 909         MCInst Inst;
 910
 911         if (DisAsm->getInstruction(Inst, Size, Bytes.slice(Index),
 912                                    SectionAddr + Index, DebugOut,
 913                                    CommentStream)) {
 914           PIP.printInst(*IP, &Inst,
 915                         Bytes.slice(Index, Size),
 916                         SectionAddr + Index, outs(), "", *STI);
 917           outs() << CommentStream.str();
 918           Comments.clear();
 919           outs() << "\n";
 920         } else {
 921           errs() << ToolName << ": warning: invalid instruction encoding\n";
 922           if (Size == 0)
 923             Size = 1; // skip illegible bytes
 924         }
 925
 926         // Print relocation for instruction.
 927         while (rel_cur != rel_end) {
 928           bool hidden = getHidden(*rel_cur);
 929           uint64_t addr = rel_cur->getOffset();
 930           SmallString<16> name;
 931           SmallString<32> val;
 932
 933           // If this relocation is hidden, skip it.
 934           if (hidden) goto skip_print_rel;
 935
 936           // Stop when rel_cur's address is past the current instruction.
 937           if (addr >= Index + Size) break;
 938           rel_cur->getTypeName(name);
 939           if (error(getRelocationValueString(*rel_cur, val)))
 940             goto skip_print_rel;
 941           outs() << format(Fmt.data(), SectionAddr + addr) << name
 942                  << "\t" << val << "\n";
 943
 944         skip_print_rel:
 945           ++rel_cur;
 946         }
 947       }
 948     }
 949   }
 950 }
 951
 952 void llvm::PrintRelocations(const ObjectFile *Obj) {
 953   StringRef Fmt = Obj->getBytesInAddress() > 4 ? "%016" PRIx64 :
 954                                                  "%08" PRIx64;
 955   // Regular objdump doesn't print relocations in non-relocatable object
 956   // files.
 957   if (!Obj->isRelocatableObject())
 958     return;
 959
 960   for (const SectionRef &Section : Obj->sections()) {
 961     if (Section.relocation_begin() == Section.relocation_end())
 962       continue;
 963     StringRef secname;
 964     if (error(Section.getName(secname)))
 965       continue;
 966     outs() << "RELOCATION RECORDS FOR [" << secname << "]:\n";
 967     for (const RelocationRef &Reloc : Section.relocations()) {
 968       bool hidden = getHidden(Reloc);
 969       uint64_t address = Reloc.getOffset();
 970       SmallString<32> relocname;
 971       SmallString<32> valuestr;
 972       if (hidden)
 973         continue;
 974       Reloc.getTypeName(relocname);
 975       if (error(getRelocationValueString(Reloc, valuestr)))
 976         continue;
 977       outs() << format(Fmt.data(), address) << " " << relocname << " "
 978              << valuestr << "\n";
 979     }
 980     outs() << "\n";
 981   }
 982 }
 983
 984 void llvm::PrintSectionHeaders(const ObjectFile *Obj) {
 985   outs() << "Sections:\n"
 986             "Idx Name          Size      Address          Type\n";
 987   unsigned i = 0;
 988   for (const SectionRef &Section : Obj->sections()) {
 989     StringRef Name;
 990     if (error(Section.getName(Name)))
 991       return;
 992     uint64_t Address = Section.getAddress();
 993     uint64_t Size = Section.getSize();
 994     bool Text = Section.isText();
 995     bool Data = Section.isData();
 996     bool BSS = Section.isBSS();
 997     std::string Type = (std::string(Text ? "TEXT " : "") +
 998                         (Data ? "DATA " : "") + (BSS ? "BSS" : ""));
 999     outs() << format("%3d %-13s %08" PRIx64 " %016" PRIx64 " %s\n", i,
1000                      Name.str().c_str(), Size, Address, Type.c_str());
1001     ++i;
1002   }
1003 }
1004
1005 void llvm::PrintSectionContents(const ObjectFile *Obj) {
1006   std::error_code EC;
1007   for (const SectionRef &Section : Obj->sections()) {
1008     StringRef Name;
1009     StringRef Contents;
1010     if (error(Section.getName(Name)))
1011       continue;
1012     uint64_t BaseAddr = Section.getAddress();
1013     uint64_t Size = Section.getSize();
1014     if (!Size)
1015       continue;
1016
1017     outs() << "Contents of section " << Name << ":\n";
1018     if (Section.isBSS()) {
1019       outs() << format("<skipping contents of bss section at [%04" PRIx64
1020                        ", %04" PRIx64 ")>\n",
1021                        BaseAddr, BaseAddr + Size);
1022       continue;
1023     }
1024
1025     if (error(Section.getContents(Contents)))
1026       continue;
1027
1028     // Dump out the content as hex and printable ascii characters.
1029     for (std::size_t addr = 0, end = Contents.size(); addr < end; addr += 16) {
1030       outs() << format(" %04" PRIx64 " ", BaseAddr + addr);
1031       // Dump line of hex.
1032       for (std::size_t i = 0; i < 16; ++i) {
1033         if (i != 0 && i % 4 == 0)
1034           outs() << ' ';
1035         if (addr + i < end)
1036           outs() << hexdigit((Contents[addr + i] >> 4) & 0xF, true)
1037                  << hexdigit(Contents[addr + i] & 0xF, true);
1038         else
1039           outs() << "  ";
1040       }
1041       // Print ascii.
1042       outs() << "  ";
1043       for (std::size_t i = 0; i < 16 && addr + i < end; ++i) {
1044         if (std::isprint(static_cast<unsigned char>(Contents[addr + i]) & 0xFF))
1045           outs() << Contents[addr + i];
1046         else
1047           outs() << ".";
1048       }
1049       outs() << "\n";
1050     }
1051   }
1052 }
1053
1054 static void PrintCOFFSymbolTable(const COFFObjectFile *coff) {
1055   for (unsigned SI = 0, SE = coff->getNumberOfSymbols(); SI != SE; ++SI) {
1056     ErrorOr<COFFSymbolRef> Symbol = coff->getSymbol(SI);
1057     StringRef Name;
1058     if (error(Symbol.getError()))
1059       return;
1060
1061     if (error(coff->getSymbolName(*Symbol, Name)))
1062       return;
1063
1064     outs() << "[" << format("%2d", SI) << "]"
1065            << "(sec " << format("%2d", int(Symbol->getSectionNumber())) << ")"
1066            << "(fl 0x00)" // Flag bits, which COFF doesn't have.
1067            << "(ty " << format("%3x", unsigned(Symbol->getType())) << ")"
1068            << "(scl " << format("%3x", unsigned(Symbol->getStorageClass())) << ") "
1069            << "(nx " << unsigned(Symbol->getNumberOfAuxSymbols()) << ") "
1070            << "0x" << format("%08x", unsigned(Symbol->getValue())) << " "
1071            << Name << "\n";
1072
1073     for (unsigned AI = 0, AE = Symbol->getNumberOfAuxSymbols(); AI < AE; ++AI, ++SI) {
1074       if (Symbol->isSectionDefinition()) {
1075         const coff_aux_section_definition *asd;
1076         if (error(coff->getAuxSymbol<coff_aux_section_definition>(SI + 1, asd)))
1077           return;
1078
1079         int32_t AuxNumber = asd->getNumber(Symbol->isBigObj());
1080
1081         outs() << "AUX "
1082                << format("scnlen 0x%x nreloc %d nlnno %d checksum 0x%x "
1083                          , unsigned(asd->Length)
1084                          , unsigned(asd->NumberOfRelocations)
1085                          , unsigned(asd->NumberOfLinenumbers)
1086                          , unsigned(asd->CheckSum))
1087                << format("assoc %d comdat %d\n"
1088                          , unsigned(AuxNumber)
1089                          , unsigned(asd->Selection));
1090       } else if (Symbol->isFileRecord()) {
1091         const char *FileName;
1092         if (error(coff->getAuxSymbol<char>(SI + 1, FileName)))
1093           return;
1094
1095         StringRef Name(FileName, Symbol->getNumberOfAuxSymbols() *
1096                                      coff->getSymbolTableEntrySize());
1097         outs() << "AUX " << Name.rtrim(StringRef("\0", 1))  << '\n';
1098
1099         SI = SI + Symbol->getNumberOfAuxSymbols();
1100         break;
1101       } else {
1102         outs() << "AUX Unknown\n";
1103       }
1104     }
1105   }
1106 }
1107
1108 void llvm::PrintSymbolTable(const ObjectFile *o) {
1109   outs() << "SYMBOL TABLE:\n";
1110
1111   if (const COFFObjectFile *coff = dyn_cast<const COFFObjectFile>(o)) {
1112     PrintCOFFSymbolTable(coff);
1113     return;
1114   }
1115   for (const SymbolRef &Symbol : o->symbols()) {
1116     uint64_t Address;
1117     SymbolRef::Type Type = Symbol.getType();
1118     uint32_t Flags = Symbol.getFlags();
1119     section_iterator Section = o->section_end();
1120     if (error(Symbol.getAddress(Address)))
1121       continue;
1122     if (error(Symbol.getSection(Section)))
1123       continue;
1124     StringRef Name;
1125     if (Type == SymbolRef::ST_Debug && Section != o->section_end()) {
1126       Section->getName(Name);
1127     } else {
1128       ErrorOr<StringRef> NameOrErr = Symbol.getName();
1129       if (error(NameOrErr.getError()))
1130         continue;
1131       Name = *NameOrErr;
1132     }
1133
1134     bool Global = Flags & SymbolRef::SF_Global;
1135     bool Weak = Flags & SymbolRef::SF_Weak;
1136     bool Absolute = Flags & SymbolRef::SF_Absolute;
1137     bool Common = Flags & SymbolRef::SF_Common;
1138     bool Hidden = Flags & SymbolRef::SF_Hidden;
1139
1140     if (Common)
1141       Address = Symbol.getCommonSize();
1142
1143     if (Address == UnknownAddress)
1144       Address = 0;
1145     char GlobLoc = ' ';
1146     if (Type != SymbolRef::ST_Unknown)
1147       GlobLoc = Global ? 'g' : 'l';
1148     char Debug = (Type == SymbolRef::ST_Debug || Type == SymbolRef::ST_File)
1149                  ? 'd' : ' ';
1150     char FileFunc = ' ';
1151     if (Type == SymbolRef::ST_File)
1152       FileFunc = 'f';
1153     else if (Type == SymbolRef::ST_Function)
1154       FileFunc = 'F';
1155
1156     const char *Fmt = o->getBytesInAddress() > 4 ? "%016" PRIx64 :
1157                                                    "%08" PRIx64;
1158
1159     outs() << format(Fmt, Address) << " "
1160            << GlobLoc // Local -> 'l', Global -> 'g', Neither -> ' '
1161            << (Weak ? 'w' : ' ') // Weak?
1162            << ' ' // Constructor. Not supported yet.
1163            << ' ' // Warning. Not supported yet.
1164            << ' ' // Indirect reference to another symbol.
1165            << Debug // Debugging (d) or dynamic (D) symbol.
1166            << FileFunc // Name of function (F), file (f) or object (O).
1167            << ' ';
1168     if (Absolute) {
1169       outs() << "*ABS*";
1170     } else if (Common) {
1171       outs() << "*COM*";
1172     } else if (Section == o->section_end()) {
1173       outs() << "*UND*";
1174     } else {
1175       if (const MachOObjectFile *MachO =
1176           dyn_cast<const MachOObjectFile>(o)) {
1177         DataRefImpl DR = Section->getRawDataRefImpl();
1178         StringRef SegmentName = MachO->getSectionFinalSegmentName(DR);
1179         outs() << SegmentName << ",";
1180       }
1181       StringRef SectionName;
1182       if (error(Section->getName(SectionName)))
1183         SectionName = "";
1184       outs() << SectionName;
1185     }
1186
1187     outs() << '\t';
1188     if (Common || isa<ELFObjectFileBase>(o)) {
1189       uint64_t Val =
1190           Common ? Symbol.getAlignment() : ELFSymbolRef(Symbol).getSize();
1191       outs() << format("\t %08" PRIx64 " ", Val);
1192     }
1193
1194     if (Hidden) {
1195       outs() << ".hidden ";
1196     }
1197     outs() << Name
1198            << '\n';
1199   }
1200 }
1201
1202 static void PrintUnwindInfo(const ObjectFile *o) {
1203   outs() << "Unwind info:\n\n";
1204
1205   if (const COFFObjectFile *coff = dyn_cast<COFFObjectFile>(o)) {
1206     printCOFFUnwindInfo(coff);
1207   } else if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
1208     printMachOUnwindInfo(MachO);
1209   else {
1210     // TODO: Extract DWARF dump tool to objdump.
1211     errs() << "This operation is only currently supported "
1212               "for COFF and MachO object files.\n";
1213     return;
1214   }
1215 }
1216
1217 void llvm::printExportsTrie(const ObjectFile *o) {
1218   outs() << "Exports trie:\n";
1219   if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
1220     printMachOExportsTrie(MachO);
1221   else {
1222     errs() << "This operation is only currently supported "
1223               "for Mach-O executable files.\n";
1224     return;
1225   }
1226 }
1227
1228 void llvm::printRebaseTable(const ObjectFile *o) {
1229   outs() << "Rebase table:\n";
1230   if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
1231     printMachORebaseTable(MachO);
1232   else {
1233     errs() << "This operation is only currently supported "
1234               "for Mach-O executable files.\n";
1235     return;
1236   }
1237 }
1238
1239 void llvm::printBindTable(const ObjectFile *o) {
1240   outs() << "Bind table:\n";
1241   if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
1242     printMachOBindTable(MachO);
1243   else {
1244     errs() << "This operation is only currently supported "
1245               "for Mach-O executable files.\n";
1246     return;
1247   }
1248 }
1249
1250 void llvm::printLazyBindTable(const ObjectFile *o) {
1251   outs() << "Lazy bind table:\n";
1252   if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
1253     printMachOLazyBindTable(MachO);
1254   else {
1255     errs() << "This operation is only currently supported "
1256               "for Mach-O executable files.\n";
1257     return;
1258   }
1259 }
1260
1261 void llvm::printWeakBindTable(const ObjectFile *o) {
1262   outs() << "Weak bind table:\n";
1263   if (const MachOObjectFile *MachO = dyn_cast<MachOObjectFile>(o))
1264     printMachOWeakBindTable(MachO);
1265   else {
1266     errs() << "This operation is only currently supported "
1267               "for Mach-O executable files.\n";
1268     return;
1269   }
1270 }
1271
1272 static void printFaultMaps(const ObjectFile *Obj) {
1273   const char *FaultMapSectionName = nullptr;
1274
1275   if (isa<ELFObjectFileBase>(Obj)) {
1276     FaultMapSectionName = ".llvm_faultmaps";
1277   } else if (isa<MachOObjectFile>(Obj)) {
1278     FaultMapSectionName = "__llvm_faultmaps";
1279   } else {
1280     errs() << "This operation is only currently supported "
1281               "for ELF and Mach-O executable files.\n";
1282     return;
1283   }
1284
1285   Optional<object::SectionRef> FaultMapSection;
1286
1287   for (auto Sec : Obj->sections()) {
1288     StringRef Name;
1289     Sec.getName(Name);
1290     if (Name == FaultMapSectionName) {
1291       FaultMapSection = Sec;
1292       break;
1293     }
1294   }
1295
1296   outs() << "FaultMap table:\n";
1297
1298   if (!FaultMapSection.hasValue()) {
1299     outs() << "<not found>\n";
1300     return;
1301   }
1302
1303   StringRef FaultMapContents;
1304   if (error(FaultMapSection.getValue().getContents(FaultMapContents))) {
1305     errs() << "Could not read the " << FaultMapContents << " section!\n";
1306     return;
1307   }
1308
1309   FaultMapParser FMP(FaultMapContents.bytes_begin(),
1310                      FaultMapContents.bytes_end());
1311
1312   outs() << FMP;
1313 }
1314
1315 static void printPrivateFileHeader(const ObjectFile *o) {
1316   if (o->isELF()) {
1317     printELFFileHeader(o);
1318   } else if (o->isCOFF()) {
1319     printCOFFFileHeader(o);
1320   } else if (o->isMachO()) {
1321     printMachOFileHeader(o);
1322   }
1323 }
1324
1325 static void DumpObject(const ObjectFile *o) {
1326   outs() << '\n';
1327   outs() << o->getFileName()
1328          << ":\tfile format " << o->getFileFormatName() << "\n\n";
1329
1330   if (Disassemble)
1331     DisassembleObject(o, Relocations);
1332   if (Relocations && !Disassemble)
1333     PrintRelocations(o);
1334   if (SectionHeaders)
1335     PrintSectionHeaders(o);
1336   if (SectionContents)
1337     PrintSectionContents(o);
1338   if (SymbolTable)
1339     PrintSymbolTable(o);
1340   if (UnwindInfo)
1341     PrintUnwindInfo(o);
1342   if (PrivateHeaders)
1343     printPrivateFileHeader(o);
1344   if (ExportsTrie)
1345     printExportsTrie(o);
1346   if (Rebase)
1347     printRebaseTable(o);
1348   if (Bind)
1349     printBindTable(o);
1350   if (LazyBind)
1351     printLazyBindTable(o);
1352   if (WeakBind)
1353     printWeakBindTable(o);
1354   if (PrintFaultMaps)
1355     printFaultMaps(o);
1356 }
1357
1358 /// @brief Dump each object file in \a a;
1359 static void DumpArchive(const Archive *a) {
1360   for (Archive::child_iterator i = a->child_begin(), e = a->child_end(); i != e;
1361        ++i) {
1362     ErrorOr<std::unique_ptr<Binary>> ChildOrErr = i->getAsBinary();
1363     if (std::error_code EC = ChildOrErr.getError()) {
1364       // Ignore non-object files.
1365       if (EC != object_error::invalid_file_type)
1366         report_error(a->getFileName(), EC);
1367       continue;
1368     }
1369     if (ObjectFile *o = dyn_cast<ObjectFile>(&*ChildOrErr.get()))
1370       DumpObject(o);
1371     else
1372       report_error(a->getFileName(), object_error::invalid_file_type);
1373   }
1374 }
1375
1376 /// @brief Open file and figure out how to dump it.
1377 static void DumpInput(StringRef file) {
1378   // If file isn't stdin, check that it exists.
1379   if (file != "-" && !sys::fs::exists(file)) {
1380     report_error(file, errc::no_such_file_or_directory);
1381     return;
1382   }
1383
1384   // If we are using the Mach-O specific object file parser, then let it parse
1385   // the file and process the command line options.  So the -arch flags can
1386   // be used to select specific slices, etc.
1387   if (MachOOpt) {
1388     ParseInputMachO(file);
1389     return;
1390   }
1391
1392   // Attempt to open the binary.
1393   ErrorOr<OwningBinary<Binary>> BinaryOrErr = createBinary(file);
1394   if (std::error_code EC = BinaryOrErr.getError()) {
1395     report_error(file, EC);
1396     return;
1397   }
1398   Binary &Binary = *BinaryOrErr.get().getBinary();
1399
1400   if (Archive *a = dyn_cast<Archive>(&Binary))
1401     DumpArchive(a);
1402   else if (ObjectFile *o = dyn_cast<ObjectFile>(&Binary))
1403     DumpObject(o);
1404   else
1405     report_error(file, object_error::invalid_file_type);
1406 }
1407
1408 int main(int argc, char **argv) {
1409   // Print a stack trace if we signal out.
1410   sys::PrintStackTraceOnErrorSignal();
1411   PrettyStackTraceProgram X(argc, argv);
1412   llvm_shutdown_obj Y;  // Call llvm_shutdown() on exit.
1413
1414   // Initialize targets and assembly printers/parsers.
1415   llvm::InitializeAllTargetInfos();
1416   llvm::InitializeAllTargetMCs();
1417   llvm::InitializeAllAsmParsers();
1418   llvm::InitializeAllDisassemblers();
1419
1420   // Register the target printer for --version.
1421   cl::AddExtraVersionPrinter(TargetRegistry::printRegisteredTargetsForVersion);
1422
1423   cl::ParseCommandLineOptions(argc, argv, "llvm object file dumper\n");
1424   TripleName = Triple::normalize(TripleName);
1425
1426   ToolName = argv[0];
1427
1428   // Defaults to a.out if no filenames specified.
1429   if (InputFilenames.size() == 0)
1430     InputFilenames.push_back("a.out");
1431
1432   if (!Disassemble
1433       && !Relocations
1434       && !SectionHeaders
1435       && !SectionContents
1436       && !SymbolTable
1437       && !UnwindInfo
1438       && !PrivateHeaders
1439       && !ExportsTrie
1440       && !Rebase
1441       && !Bind
1442       && !LazyBind
1443       && !WeakBind
1444       && !(UniversalHeaders && MachOOpt)
1445       && !(ArchiveHeaders && MachOOpt)
1446       && !(IndirectSymbols && MachOOpt)
1447       && !(DataInCode && MachOOpt)
1448       && !(LinkOptHints && MachOOpt)
1449       && !(InfoPlist && MachOOpt)
1450       && !(DylibsUsed && MachOOpt)
1451       && !(DylibId && MachOOpt)
1452       && !(ObjcMetaData && MachOOpt)
1453       && !(DumpSections.size() != 0 && MachOOpt)
1454       && !PrintFaultMaps) {
1455     cl::PrintHelpMessage();
1456     return 2;
1457   }
1458
1459   std::for_each(InputFilenames.begin(), InputFilenames.end(),
1460                 DumpInput);
1461
1462   return ReturnValue;
1463 }