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