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