Don't iterate over the program headers in the constructor of ELFFile.
[oota-llvm.git] / tools / llvm-readobj / ELFDumper.cpp
1 //===-- ELFDumper.cpp - ELF-specific dumper ---------------------*- C++ -*-===//
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 /// \file
11 /// \brief This file implements the ELF-specific dumper for llvm-readobj.
12 ///
13 //===----------------------------------------------------------------------===//
14
15 #include "llvm-readobj.h"
16 #include "ARMAttributeParser.h"
17 #include "ARMEHABIPrinter.h"
18 #include "Error.h"
19 #include "ObjDumper.h"
20 #include "StackMapPrinter.h"
21 #include "StreamWriter.h"
22 #include "llvm/ADT/Optional.h"
23 #include "llvm/ADT/SmallString.h"
24 #include "llvm/ADT/StringExtras.h"
25 #include "llvm/Object/ELFObjectFile.h"
26 #include "llvm/Support/ARMBuildAttributes.h"
27 #include "llvm/Support/Compiler.h"
28 #include "llvm/Support/Format.h"
29 #include "llvm/Support/MathExtras.h"
30 #include "llvm/Support/MipsABIFlags.h"
31 #include "llvm/Support/raw_ostream.h"
32
33 using namespace llvm;
34 using namespace llvm::object;
35 using namespace ELF;
36
37 #define LLVM_READOBJ_ENUM_CASE(ns, enum) \
38   case ns::enum: return #enum;
39
40 namespace {
41
42 template<typename ELFT>
43 class ELFDumper : public ObjDumper {
44 public:
45   ELFDumper(const ELFFile<ELFT> *Obj, StreamWriter &Writer);
46
47   void printFileHeaders() override;
48   void printSections() override;
49   void printRelocations() override;
50   void printDynamicRelocations() override;
51   void printSymbols() override;
52   void printDynamicSymbols() override;
53   void printUnwindInfo() override;
54
55   void printDynamicTable() override;
56   void printNeededLibraries() override;
57   void printProgramHeaders() override;
58   void printHashTable() override;
59   void printLoadName() override;
60
61   void printAttributes() override;
62   void printMipsPLTGOT() override;
63   void printMipsABIFlags() override;
64   void printMipsReginfo() override;
65
66   void printStackMap() const override;
67
68 private:
69   typedef ELFFile<ELFT> ELFO;
70   typedef typename ELFO::Elf_Shdr Elf_Shdr;
71   typedef typename ELFO::Elf_Sym Elf_Sym;
72   typedef typename ELFO::Elf_Dyn Elf_Dyn;
73   typedef typename ELFO::Elf_Dyn_Range Elf_Dyn_Range;
74   typedef typename ELFO::Elf_Rela Elf_Rela;
75   typedef typename ELFO::Elf_Rela_Range Elf_Rela_Range;
76   typedef typename ELFO::Elf_Phdr Elf_Phdr;
77   typedef typename ELFO::Elf_Hash Elf_Hash;
78   typedef typename ELFO::uintX_t uintX_t;
79
80   /// \brief Represents a region described by entries in the .dynamic table.
81   struct DynRegionInfo {
82     DynRegionInfo() : Addr(nullptr), Size(0), EntSize(0) {}
83     /// \brief Address in current address space.
84     const void *Addr;
85     /// \brief Size in bytes of the region.
86     uintX_t Size;
87     /// \brief Size of each entity in the region.
88     uintX_t EntSize;
89   };
90
91   void printSymbol(const Elf_Sym *Symbol, StringRef StrTable, bool IsDynamic);
92
93   void printRelocations(const Elf_Shdr *Sec);
94   void printRelocation(const Elf_Shdr *Sec, typename ELFO::Elf_Rela Rel);
95   void printValue(uint64_t Type, uint64_t Value);
96
97   const Elf_Rela *dyn_rela_begin() const;
98   const Elf_Rela *dyn_rela_end() const;
99   Elf_Rela_Range dyn_relas() const;
100   StringRef getDynamicString(uint64_t Offset) const;
101   const Elf_Dyn *dynamic_table_begin() const;
102   const Elf_Dyn *dynamic_table_end() const;
103   Elf_Dyn_Range dynamic_table() const {
104     return make_range(dynamic_table_begin(), dynamic_table_end());
105   }
106
107   const ELFO *Obj;
108   DynRegionInfo DynRelaRegion;
109   DynRegionInfo DynamicRegion;
110   StringRef DynamicStringTable;
111   StringRef SOName;
112   const Elf_Hash *HashTable = nullptr;
113 };
114
115 template <class T> T errorOrDefault(ErrorOr<T> Val, T Default = T()) {
116   if (!Val) {
117     error(Val.getError());
118     return Default;
119   }
120
121   return *Val;
122 }
123 } // namespace
124
125 namespace llvm {
126
127 template <class ELFT>
128 static std::error_code createELFDumper(const ELFFile<ELFT> *Obj,
129                                        StreamWriter &Writer,
130                                        std::unique_ptr<ObjDumper> &Result) {
131   Result.reset(new ELFDumper<ELFT>(Obj, Writer));
132   return readobj_error::success;
133 }
134
135 std::error_code createELFDumper(const object::ObjectFile *Obj,
136                                 StreamWriter &Writer,
137                                 std::unique_ptr<ObjDumper> &Result) {
138   // Little-endian 32-bit
139   if (const ELF32LEObjectFile *ELFObj = dyn_cast<ELF32LEObjectFile>(Obj))
140     return createELFDumper(ELFObj->getELFFile(), Writer, Result);
141
142   // Big-endian 32-bit
143   if (const ELF32BEObjectFile *ELFObj = dyn_cast<ELF32BEObjectFile>(Obj))
144     return createELFDumper(ELFObj->getELFFile(), Writer, Result);
145
146   // Little-endian 64-bit
147   if (const ELF64LEObjectFile *ELFObj = dyn_cast<ELF64LEObjectFile>(Obj))
148     return createELFDumper(ELFObj->getELFFile(), Writer, Result);
149
150   // Big-endian 64-bit
151   if (const ELF64BEObjectFile *ELFObj = dyn_cast<ELF64BEObjectFile>(Obj))
152     return createELFDumper(ELFObj->getELFFile(), Writer, Result);
153
154   return readobj_error::unsupported_obj_file_format;
155 }
156
157 } // namespace llvm
158
159 template <typename ELFO>
160 static std::string getFullSymbolName(const ELFO &Obj,
161                                      const typename ELFO::Elf_Sym *Symbol,
162                                      StringRef StrTable, bool IsDynamic) {
163   StringRef SymbolName = errorOrDefault(Symbol->getName(StrTable));
164   if (!IsDynamic)
165     return SymbolName;
166
167   std::string FullSymbolName(SymbolName);
168
169   bool IsDefault;
170   ErrorOr<StringRef> Version =
171       Obj.getSymbolVersion(StrTable, &*Symbol, IsDefault);
172   if (Version) {
173     FullSymbolName += (IsDefault ? "@@" : "@");
174     FullSymbolName += *Version;
175   } else
176     error(Version.getError());
177   return FullSymbolName;
178 }
179
180 template <typename ELFO>
181 static void
182 getSectionNameIndex(const ELFO &Obj, const typename ELFO::Elf_Sym *Symbol,
183                     StringRef &SectionName, unsigned &SectionIndex) {
184   SectionIndex = Symbol->st_shndx;
185   if (Symbol->isUndefined())
186     SectionName = "Undefined";
187   else if (Symbol->isProcessorSpecific())
188     SectionName = "Processor Specific";
189   else if (Symbol->isOSSpecific())
190     SectionName = "Operating System Specific";
191   else if (Symbol->isAbsolute())
192     SectionName = "Absolute";
193   else if (Symbol->isCommon())
194     SectionName = "Common";
195   else if (Symbol->isReserved() && SectionIndex != SHN_XINDEX)
196     SectionName = "Reserved";
197   else {
198     if (SectionIndex == SHN_XINDEX)
199       SectionIndex = Obj.getExtendedSymbolTableIndex(&*Symbol);
200     ErrorOr<const typename ELFO::Elf_Shdr *> Sec = Obj.getSection(SectionIndex);
201     error(Sec.getError());
202     SectionName = errorOrDefault(Obj.getSectionName(*Sec));
203   }
204 }
205
206 template <class ELFT>
207 static const typename ELFFile<ELFT>::Elf_Shdr *
208 findSectionByAddress(const ELFFile<ELFT> *Obj, uint64_t Addr) {
209   for (const auto &Shdr : Obj->sections())
210     if (Shdr.sh_addr == Addr)
211       return &Shdr;
212   return nullptr;
213 }
214
215 template <class ELFT>
216 static const typename ELFFile<ELFT>::Elf_Shdr *
217 findSectionByName(const ELFFile<ELFT> &Obj, StringRef Name) {
218   for (const auto &Shdr : Obj.sections()) {
219     if (Name == errorOrDefault(Obj.getSectionName(&Shdr)))
220       return &Shdr;
221   }
222   return nullptr;
223 }
224
225 static const EnumEntry<unsigned> ElfClass[] = {
226   { "None",   ELF::ELFCLASSNONE },
227   { "32-bit", ELF::ELFCLASS32   },
228   { "64-bit", ELF::ELFCLASS64   },
229 };
230
231 static const EnumEntry<unsigned> ElfDataEncoding[] = {
232   { "None",         ELF::ELFDATANONE },
233   { "LittleEndian", ELF::ELFDATA2LSB },
234   { "BigEndian",    ELF::ELFDATA2MSB },
235 };
236
237 static const EnumEntry<unsigned> ElfObjectFileType[] = {
238   { "None",         ELF::ET_NONE },
239   { "Relocatable",  ELF::ET_REL  },
240   { "Executable",   ELF::ET_EXEC },
241   { "SharedObject", ELF::ET_DYN  },
242   { "Core",         ELF::ET_CORE },
243 };
244
245 static const EnumEntry<unsigned> ElfOSABI[] = {
246   { "SystemV",      ELF::ELFOSABI_NONE         },
247   { "HPUX",         ELF::ELFOSABI_HPUX         },
248   { "NetBSD",       ELF::ELFOSABI_NETBSD       },
249   { "GNU/Linux",    ELF::ELFOSABI_LINUX        },
250   { "GNU/Hurd",     ELF::ELFOSABI_HURD         },
251   { "Solaris",      ELF::ELFOSABI_SOLARIS      },
252   { "AIX",          ELF::ELFOSABI_AIX          },
253   { "IRIX",         ELF::ELFOSABI_IRIX         },
254   { "FreeBSD",      ELF::ELFOSABI_FREEBSD      },
255   { "TRU64",        ELF::ELFOSABI_TRU64        },
256   { "Modesto",      ELF::ELFOSABI_MODESTO      },
257   { "OpenBSD",      ELF::ELFOSABI_OPENBSD      },
258   { "OpenVMS",      ELF::ELFOSABI_OPENVMS      },
259   { "NSK",          ELF::ELFOSABI_NSK          },
260   { "AROS",         ELF::ELFOSABI_AROS         },
261   { "FenixOS",      ELF::ELFOSABI_FENIXOS      },
262   { "CloudABI",     ELF::ELFOSABI_CLOUDABI     },
263   { "C6000_ELFABI", ELF::ELFOSABI_C6000_ELFABI },
264   { "C6000_LINUX" , ELF::ELFOSABI_C6000_LINUX  },
265   { "ARM",          ELF::ELFOSABI_ARM          },
266   { "Standalone"  , ELF::ELFOSABI_STANDALONE   }
267 };
268
269 static const EnumEntry<unsigned> ElfMachineType[] = {
270   LLVM_READOBJ_ENUM_ENT(ELF, EM_NONE         ),
271   LLVM_READOBJ_ENUM_ENT(ELF, EM_M32          ),
272   LLVM_READOBJ_ENUM_ENT(ELF, EM_SPARC        ),
273   LLVM_READOBJ_ENUM_ENT(ELF, EM_386          ),
274   LLVM_READOBJ_ENUM_ENT(ELF, EM_68K          ),
275   LLVM_READOBJ_ENUM_ENT(ELF, EM_88K          ),
276   LLVM_READOBJ_ENUM_ENT(ELF, EM_IAMCU        ),
277   LLVM_READOBJ_ENUM_ENT(ELF, EM_860          ),
278   LLVM_READOBJ_ENUM_ENT(ELF, EM_MIPS         ),
279   LLVM_READOBJ_ENUM_ENT(ELF, EM_S370         ),
280   LLVM_READOBJ_ENUM_ENT(ELF, EM_MIPS_RS3_LE  ),
281   LLVM_READOBJ_ENUM_ENT(ELF, EM_PARISC       ),
282   LLVM_READOBJ_ENUM_ENT(ELF, EM_VPP500       ),
283   LLVM_READOBJ_ENUM_ENT(ELF, EM_SPARC32PLUS  ),
284   LLVM_READOBJ_ENUM_ENT(ELF, EM_960          ),
285   LLVM_READOBJ_ENUM_ENT(ELF, EM_PPC          ),
286   LLVM_READOBJ_ENUM_ENT(ELF, EM_PPC64        ),
287   LLVM_READOBJ_ENUM_ENT(ELF, EM_S390         ),
288   LLVM_READOBJ_ENUM_ENT(ELF, EM_SPU          ),
289   LLVM_READOBJ_ENUM_ENT(ELF, EM_V800         ),
290   LLVM_READOBJ_ENUM_ENT(ELF, EM_FR20         ),
291   LLVM_READOBJ_ENUM_ENT(ELF, EM_RH32         ),
292   LLVM_READOBJ_ENUM_ENT(ELF, EM_RCE          ),
293   LLVM_READOBJ_ENUM_ENT(ELF, EM_ARM          ),
294   LLVM_READOBJ_ENUM_ENT(ELF, EM_ALPHA        ),
295   LLVM_READOBJ_ENUM_ENT(ELF, EM_SH           ),
296   LLVM_READOBJ_ENUM_ENT(ELF, EM_SPARCV9      ),
297   LLVM_READOBJ_ENUM_ENT(ELF, EM_TRICORE      ),
298   LLVM_READOBJ_ENUM_ENT(ELF, EM_ARC          ),
299   LLVM_READOBJ_ENUM_ENT(ELF, EM_H8_300       ),
300   LLVM_READOBJ_ENUM_ENT(ELF, EM_H8_300H      ),
301   LLVM_READOBJ_ENUM_ENT(ELF, EM_H8S          ),
302   LLVM_READOBJ_ENUM_ENT(ELF, EM_H8_500       ),
303   LLVM_READOBJ_ENUM_ENT(ELF, EM_IA_64        ),
304   LLVM_READOBJ_ENUM_ENT(ELF, EM_MIPS_X       ),
305   LLVM_READOBJ_ENUM_ENT(ELF, EM_COLDFIRE     ),
306   LLVM_READOBJ_ENUM_ENT(ELF, EM_68HC12       ),
307   LLVM_READOBJ_ENUM_ENT(ELF, EM_MMA          ),
308   LLVM_READOBJ_ENUM_ENT(ELF, EM_PCP          ),
309   LLVM_READOBJ_ENUM_ENT(ELF, EM_NCPU         ),
310   LLVM_READOBJ_ENUM_ENT(ELF, EM_NDR1         ),
311   LLVM_READOBJ_ENUM_ENT(ELF, EM_STARCORE     ),
312   LLVM_READOBJ_ENUM_ENT(ELF, EM_ME16         ),
313   LLVM_READOBJ_ENUM_ENT(ELF, EM_ST100        ),
314   LLVM_READOBJ_ENUM_ENT(ELF, EM_TINYJ        ),
315   LLVM_READOBJ_ENUM_ENT(ELF, EM_X86_64       ),
316   LLVM_READOBJ_ENUM_ENT(ELF, EM_PDSP         ),
317   LLVM_READOBJ_ENUM_ENT(ELF, EM_PDP10        ),
318   LLVM_READOBJ_ENUM_ENT(ELF, EM_PDP11        ),
319   LLVM_READOBJ_ENUM_ENT(ELF, EM_FX66         ),
320   LLVM_READOBJ_ENUM_ENT(ELF, EM_ST9PLUS      ),
321   LLVM_READOBJ_ENUM_ENT(ELF, EM_ST7          ),
322   LLVM_READOBJ_ENUM_ENT(ELF, EM_68HC16       ),
323   LLVM_READOBJ_ENUM_ENT(ELF, EM_68HC11       ),
324   LLVM_READOBJ_ENUM_ENT(ELF, EM_68HC08       ),
325   LLVM_READOBJ_ENUM_ENT(ELF, EM_68HC05       ),
326   LLVM_READOBJ_ENUM_ENT(ELF, EM_SVX          ),
327   LLVM_READOBJ_ENUM_ENT(ELF, EM_ST19         ),
328   LLVM_READOBJ_ENUM_ENT(ELF, EM_VAX          ),
329   LLVM_READOBJ_ENUM_ENT(ELF, EM_CRIS         ),
330   LLVM_READOBJ_ENUM_ENT(ELF, EM_JAVELIN      ),
331   LLVM_READOBJ_ENUM_ENT(ELF, EM_FIREPATH     ),
332   LLVM_READOBJ_ENUM_ENT(ELF, EM_ZSP          ),
333   LLVM_READOBJ_ENUM_ENT(ELF, EM_MMIX         ),
334   LLVM_READOBJ_ENUM_ENT(ELF, EM_HUANY        ),
335   LLVM_READOBJ_ENUM_ENT(ELF, EM_PRISM        ),
336   LLVM_READOBJ_ENUM_ENT(ELF, EM_AVR          ),
337   LLVM_READOBJ_ENUM_ENT(ELF, EM_FR30         ),
338   LLVM_READOBJ_ENUM_ENT(ELF, EM_D10V         ),
339   LLVM_READOBJ_ENUM_ENT(ELF, EM_D30V         ),
340   LLVM_READOBJ_ENUM_ENT(ELF, EM_V850         ),
341   LLVM_READOBJ_ENUM_ENT(ELF, EM_M32R         ),
342   LLVM_READOBJ_ENUM_ENT(ELF, EM_MN10300      ),
343   LLVM_READOBJ_ENUM_ENT(ELF, EM_MN10200      ),
344   LLVM_READOBJ_ENUM_ENT(ELF, EM_PJ           ),
345   LLVM_READOBJ_ENUM_ENT(ELF, EM_OPENRISC     ),
346   LLVM_READOBJ_ENUM_ENT(ELF, EM_ARC_COMPACT  ),
347   LLVM_READOBJ_ENUM_ENT(ELF, EM_XTENSA       ),
348   LLVM_READOBJ_ENUM_ENT(ELF, EM_VIDEOCORE    ),
349   LLVM_READOBJ_ENUM_ENT(ELF, EM_TMM_GPP      ),
350   LLVM_READOBJ_ENUM_ENT(ELF, EM_NS32K        ),
351   LLVM_READOBJ_ENUM_ENT(ELF, EM_TPC          ),
352   LLVM_READOBJ_ENUM_ENT(ELF, EM_SNP1K        ),
353   LLVM_READOBJ_ENUM_ENT(ELF, EM_ST200        ),
354   LLVM_READOBJ_ENUM_ENT(ELF, EM_IP2K         ),
355   LLVM_READOBJ_ENUM_ENT(ELF, EM_MAX          ),
356   LLVM_READOBJ_ENUM_ENT(ELF, EM_CR           ),
357   LLVM_READOBJ_ENUM_ENT(ELF, EM_F2MC16       ),
358   LLVM_READOBJ_ENUM_ENT(ELF, EM_MSP430       ),
359   LLVM_READOBJ_ENUM_ENT(ELF, EM_BLACKFIN     ),
360   LLVM_READOBJ_ENUM_ENT(ELF, EM_SE_C33       ),
361   LLVM_READOBJ_ENUM_ENT(ELF, EM_SEP          ),
362   LLVM_READOBJ_ENUM_ENT(ELF, EM_ARCA         ),
363   LLVM_READOBJ_ENUM_ENT(ELF, EM_UNICORE      ),
364   LLVM_READOBJ_ENUM_ENT(ELF, EM_EXCESS       ),
365   LLVM_READOBJ_ENUM_ENT(ELF, EM_DXP          ),
366   LLVM_READOBJ_ENUM_ENT(ELF, EM_ALTERA_NIOS2 ),
367   LLVM_READOBJ_ENUM_ENT(ELF, EM_CRX          ),
368   LLVM_READOBJ_ENUM_ENT(ELF, EM_XGATE        ),
369   LLVM_READOBJ_ENUM_ENT(ELF, EM_C166         ),
370   LLVM_READOBJ_ENUM_ENT(ELF, EM_M16C         ),
371   LLVM_READOBJ_ENUM_ENT(ELF, EM_DSPIC30F     ),
372   LLVM_READOBJ_ENUM_ENT(ELF, EM_CE           ),
373   LLVM_READOBJ_ENUM_ENT(ELF, EM_M32C         ),
374   LLVM_READOBJ_ENUM_ENT(ELF, EM_TSK3000      ),
375   LLVM_READOBJ_ENUM_ENT(ELF, EM_RS08         ),
376   LLVM_READOBJ_ENUM_ENT(ELF, EM_SHARC        ),
377   LLVM_READOBJ_ENUM_ENT(ELF, EM_ECOG2        ),
378   LLVM_READOBJ_ENUM_ENT(ELF, EM_SCORE7       ),
379   LLVM_READOBJ_ENUM_ENT(ELF, EM_DSP24        ),
380   LLVM_READOBJ_ENUM_ENT(ELF, EM_VIDEOCORE3   ),
381   LLVM_READOBJ_ENUM_ENT(ELF, EM_LATTICEMICO32),
382   LLVM_READOBJ_ENUM_ENT(ELF, EM_SE_C17       ),
383   LLVM_READOBJ_ENUM_ENT(ELF, EM_TI_C6000     ),
384   LLVM_READOBJ_ENUM_ENT(ELF, EM_TI_C2000     ),
385   LLVM_READOBJ_ENUM_ENT(ELF, EM_TI_C5500     ),
386   LLVM_READOBJ_ENUM_ENT(ELF, EM_MMDSP_PLUS   ),
387   LLVM_READOBJ_ENUM_ENT(ELF, EM_CYPRESS_M8C  ),
388   LLVM_READOBJ_ENUM_ENT(ELF, EM_R32C         ),
389   LLVM_READOBJ_ENUM_ENT(ELF, EM_TRIMEDIA     ),
390   LLVM_READOBJ_ENUM_ENT(ELF, EM_HEXAGON      ),
391   LLVM_READOBJ_ENUM_ENT(ELF, EM_8051         ),
392   LLVM_READOBJ_ENUM_ENT(ELF, EM_STXP7X       ),
393   LLVM_READOBJ_ENUM_ENT(ELF, EM_NDS32        ),
394   LLVM_READOBJ_ENUM_ENT(ELF, EM_ECOG1        ),
395   LLVM_READOBJ_ENUM_ENT(ELF, EM_ECOG1X       ),
396   LLVM_READOBJ_ENUM_ENT(ELF, EM_MAXQ30       ),
397   LLVM_READOBJ_ENUM_ENT(ELF, EM_XIMO16       ),
398   LLVM_READOBJ_ENUM_ENT(ELF, EM_MANIK        ),
399   LLVM_READOBJ_ENUM_ENT(ELF, EM_CRAYNV2      ),
400   LLVM_READOBJ_ENUM_ENT(ELF, EM_RX           ),
401   LLVM_READOBJ_ENUM_ENT(ELF, EM_METAG        ),
402   LLVM_READOBJ_ENUM_ENT(ELF, EM_MCST_ELBRUS  ),
403   LLVM_READOBJ_ENUM_ENT(ELF, EM_ECOG16       ),
404   LLVM_READOBJ_ENUM_ENT(ELF, EM_CR16         ),
405   LLVM_READOBJ_ENUM_ENT(ELF, EM_ETPU         ),
406   LLVM_READOBJ_ENUM_ENT(ELF, EM_SLE9X        ),
407   LLVM_READOBJ_ENUM_ENT(ELF, EM_L10M         ),
408   LLVM_READOBJ_ENUM_ENT(ELF, EM_K10M         ),
409   LLVM_READOBJ_ENUM_ENT(ELF, EM_AARCH64      ),
410   LLVM_READOBJ_ENUM_ENT(ELF, EM_AVR32        ),
411   LLVM_READOBJ_ENUM_ENT(ELF, EM_STM8         ),
412   LLVM_READOBJ_ENUM_ENT(ELF, EM_TILE64       ),
413   LLVM_READOBJ_ENUM_ENT(ELF, EM_TILEPRO      ),
414   LLVM_READOBJ_ENUM_ENT(ELF, EM_CUDA         ),
415   LLVM_READOBJ_ENUM_ENT(ELF, EM_TILEGX       ),
416   LLVM_READOBJ_ENUM_ENT(ELF, EM_CLOUDSHIELD  ),
417   LLVM_READOBJ_ENUM_ENT(ELF, EM_COREA_1ST    ),
418   LLVM_READOBJ_ENUM_ENT(ELF, EM_COREA_2ND    ),
419   LLVM_READOBJ_ENUM_ENT(ELF, EM_ARC_COMPACT2 ),
420   LLVM_READOBJ_ENUM_ENT(ELF, EM_OPEN8        ),
421   LLVM_READOBJ_ENUM_ENT(ELF, EM_RL78         ),
422   LLVM_READOBJ_ENUM_ENT(ELF, EM_VIDEOCORE5   ),
423   LLVM_READOBJ_ENUM_ENT(ELF, EM_78KOR        ),
424   LLVM_READOBJ_ENUM_ENT(ELF, EM_56800EX      ),
425   LLVM_READOBJ_ENUM_ENT(ELF, EM_AMDGPU       )
426 };
427
428 static const EnumEntry<unsigned> ElfSymbolBindings[] = {
429   { "Local",  ELF::STB_LOCAL        },
430   { "Global", ELF::STB_GLOBAL       },
431   { "Weak",   ELF::STB_WEAK         },
432   { "Unique", ELF::STB_GNU_UNIQUE   }
433 };
434
435 static const EnumEntry<unsigned> ElfSymbolTypes[] = {
436   { "None",      ELF::STT_NOTYPE    },
437   { "Object",    ELF::STT_OBJECT    },
438   { "Function",  ELF::STT_FUNC      },
439   { "Section",   ELF::STT_SECTION   },
440   { "File",      ELF::STT_FILE      },
441   { "Common",    ELF::STT_COMMON    },
442   { "TLS",       ELF::STT_TLS       },
443   { "GNU_IFunc", ELF::STT_GNU_IFUNC }
444 };
445
446 static const char *getElfSectionType(unsigned Arch, unsigned Type) {
447   switch (Arch) {
448   case ELF::EM_ARM:
449     switch (Type) {
450     LLVM_READOBJ_ENUM_CASE(ELF, SHT_ARM_EXIDX);
451     LLVM_READOBJ_ENUM_CASE(ELF, SHT_ARM_PREEMPTMAP);
452     LLVM_READOBJ_ENUM_CASE(ELF, SHT_ARM_ATTRIBUTES);
453     LLVM_READOBJ_ENUM_CASE(ELF, SHT_ARM_DEBUGOVERLAY);
454     LLVM_READOBJ_ENUM_CASE(ELF, SHT_ARM_OVERLAYSECTION);
455     }
456   case ELF::EM_HEXAGON:
457     switch (Type) { LLVM_READOBJ_ENUM_CASE(ELF, SHT_HEX_ORDERED); }
458   case ELF::EM_X86_64:
459     switch (Type) { LLVM_READOBJ_ENUM_CASE(ELF, SHT_X86_64_UNWIND); }
460   case ELF::EM_MIPS:
461   case ELF::EM_MIPS_RS3_LE:
462     switch (Type) {
463     LLVM_READOBJ_ENUM_CASE(ELF, SHT_MIPS_REGINFO);
464     LLVM_READOBJ_ENUM_CASE(ELF, SHT_MIPS_OPTIONS);
465     LLVM_READOBJ_ENUM_CASE(ELF, SHT_MIPS_ABIFLAGS);
466     }
467   }
468
469   switch (Type) {
470   LLVM_READOBJ_ENUM_CASE(ELF, SHT_NULL              );
471   LLVM_READOBJ_ENUM_CASE(ELF, SHT_PROGBITS          );
472   LLVM_READOBJ_ENUM_CASE(ELF, SHT_SYMTAB            );
473   LLVM_READOBJ_ENUM_CASE(ELF, SHT_STRTAB            );
474   LLVM_READOBJ_ENUM_CASE(ELF, SHT_RELA              );
475   LLVM_READOBJ_ENUM_CASE(ELF, SHT_HASH              );
476   LLVM_READOBJ_ENUM_CASE(ELF, SHT_DYNAMIC           );
477   LLVM_READOBJ_ENUM_CASE(ELF, SHT_NOTE              );
478   LLVM_READOBJ_ENUM_CASE(ELF, SHT_NOBITS            );
479   LLVM_READOBJ_ENUM_CASE(ELF, SHT_REL               );
480   LLVM_READOBJ_ENUM_CASE(ELF, SHT_SHLIB             );
481   LLVM_READOBJ_ENUM_CASE(ELF, SHT_DYNSYM            );
482   LLVM_READOBJ_ENUM_CASE(ELF, SHT_INIT_ARRAY        );
483   LLVM_READOBJ_ENUM_CASE(ELF, SHT_FINI_ARRAY        );
484   LLVM_READOBJ_ENUM_CASE(ELF, SHT_PREINIT_ARRAY     );
485   LLVM_READOBJ_ENUM_CASE(ELF, SHT_GROUP             );
486   LLVM_READOBJ_ENUM_CASE(ELF, SHT_SYMTAB_SHNDX      );
487   LLVM_READOBJ_ENUM_CASE(ELF, SHT_GNU_ATTRIBUTES    );
488   LLVM_READOBJ_ENUM_CASE(ELF, SHT_GNU_HASH          );
489   LLVM_READOBJ_ENUM_CASE(ELF, SHT_GNU_verdef        );
490   LLVM_READOBJ_ENUM_CASE(ELF, SHT_GNU_verneed       );
491   LLVM_READOBJ_ENUM_CASE(ELF, SHT_GNU_versym        );
492   default: return "";
493   }
494 }
495
496 static const EnumEntry<unsigned> ElfSectionFlags[] = {
497   LLVM_READOBJ_ENUM_ENT(ELF, SHF_WRITE           ),
498   LLVM_READOBJ_ENUM_ENT(ELF, SHF_ALLOC           ),
499   LLVM_READOBJ_ENUM_ENT(ELF, SHF_EXCLUDE         ),
500   LLVM_READOBJ_ENUM_ENT(ELF, SHF_EXECINSTR       ),
501   LLVM_READOBJ_ENUM_ENT(ELF, SHF_MERGE           ),
502   LLVM_READOBJ_ENUM_ENT(ELF, SHF_STRINGS         ),
503   LLVM_READOBJ_ENUM_ENT(ELF, SHF_INFO_LINK       ),
504   LLVM_READOBJ_ENUM_ENT(ELF, SHF_LINK_ORDER      ),
505   LLVM_READOBJ_ENUM_ENT(ELF, SHF_OS_NONCONFORMING),
506   LLVM_READOBJ_ENUM_ENT(ELF, SHF_GROUP           ),
507   LLVM_READOBJ_ENUM_ENT(ELF, SHF_TLS             ),
508   LLVM_READOBJ_ENUM_ENT(ELF, XCORE_SHF_CP_SECTION),
509   LLVM_READOBJ_ENUM_ENT(ELF, XCORE_SHF_DP_SECTION),
510   LLVM_READOBJ_ENUM_ENT(ELF, SHF_MIPS_NOSTRIP    )
511 };
512
513 static const char *getElfSegmentType(unsigned Arch, unsigned Type) {
514   // Check potentially overlapped processor-specific
515   // program header type.
516   switch (Arch) {
517   case ELF::EM_ARM:
518     switch (Type) {
519     LLVM_READOBJ_ENUM_CASE(ELF, PT_ARM_EXIDX);
520     }
521   case ELF::EM_MIPS:
522   case ELF::EM_MIPS_RS3_LE:
523     switch (Type) {
524     LLVM_READOBJ_ENUM_CASE(ELF, PT_MIPS_REGINFO);
525     LLVM_READOBJ_ENUM_CASE(ELF, PT_MIPS_RTPROC);
526     LLVM_READOBJ_ENUM_CASE(ELF, PT_MIPS_OPTIONS);
527     LLVM_READOBJ_ENUM_CASE(ELF, PT_MIPS_ABIFLAGS);
528     }
529   }
530
531   switch (Type) {
532   LLVM_READOBJ_ENUM_CASE(ELF, PT_NULL   );
533   LLVM_READOBJ_ENUM_CASE(ELF, PT_LOAD   );
534   LLVM_READOBJ_ENUM_CASE(ELF, PT_DYNAMIC);
535   LLVM_READOBJ_ENUM_CASE(ELF, PT_INTERP );
536   LLVM_READOBJ_ENUM_CASE(ELF, PT_NOTE   );
537   LLVM_READOBJ_ENUM_CASE(ELF, PT_SHLIB  );
538   LLVM_READOBJ_ENUM_CASE(ELF, PT_PHDR   );
539   LLVM_READOBJ_ENUM_CASE(ELF, PT_TLS    );
540
541   LLVM_READOBJ_ENUM_CASE(ELF, PT_GNU_EH_FRAME);
542   LLVM_READOBJ_ENUM_CASE(ELF, PT_SUNW_UNWIND);
543
544   LLVM_READOBJ_ENUM_CASE(ELF, PT_GNU_STACK);
545   LLVM_READOBJ_ENUM_CASE(ELF, PT_GNU_RELRO);
546   default: return "";
547   }
548 }
549
550 static const EnumEntry<unsigned> ElfSegmentFlags[] = {
551   LLVM_READOBJ_ENUM_ENT(ELF, PF_X),
552   LLVM_READOBJ_ENUM_ENT(ELF, PF_W),
553   LLVM_READOBJ_ENUM_ENT(ELF, PF_R)
554 };
555
556 static const EnumEntry<unsigned> ElfHeaderMipsFlags[] = {
557   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_NOREORDER),
558   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_PIC),
559   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_CPIC),
560   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ABI2),
561   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_32BITMODE),
562   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_FP64),
563   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_NAN2008),
564   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ABI_O32),
565   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ABI_O64),
566   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ABI_EABI32),
567   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ABI_EABI64),
568   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_3900),
569   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_4010),
570   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_4100),
571   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_4650),
572   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_4120),
573   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_4111),
574   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_SB1),
575   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_OCTEON),
576   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_XLR),
577   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_OCTEON2),
578   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_OCTEON3),
579   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_5400),
580   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_5900),
581   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_5500),
582   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_9000),
583   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_LS2E),
584   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_LS2F),
585   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_LS3A),
586   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MICROMIPS),
587   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_ASE_M16),
588   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_ASE_MDMX),
589   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_1),
590   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_2),
591   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_3),
592   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_4),
593   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_5),
594   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_32),
595   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_64),
596   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_32R2),
597   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_64R2),
598   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_32R6),
599   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_64R6)
600 };
601
602 template <typename ELFT>
603 ELFDumper<ELFT>::ELFDumper(const ELFFile<ELFT> *Obj, StreamWriter &Writer)
604     : ObjDumper(Writer), Obj(Obj) {
605
606   SmallVector<const Elf_Phdr *, 4> LoadSegments;
607   for (const Elf_Phdr &Phdr : Obj->program_headers()) {
608     if (Phdr.p_type == ELF::PT_DYNAMIC) {
609       DynamicRegion.Addr = Obj->base() + Phdr.p_offset;
610       uint64_t Size = Phdr.p_filesz;
611       if (Size % sizeof(Elf_Dyn))
612         report_fatal_error("Invalid dynamic table size");
613       DynamicRegion.Size = Phdr.p_filesz;
614       continue;
615     }
616     if (Phdr.p_type != ELF::PT_LOAD || Phdr.p_filesz == 0)
617       continue;
618     LoadSegments.push_back(&Phdr);
619   }
620
621   auto toMappedAddr = [&](uint64_t VAddr) -> const uint8_t * {
622     const Elf_Phdr **I = std::upper_bound(
623         LoadSegments.begin(), LoadSegments.end(), VAddr, compareAddr<ELFT>);
624     if (I == LoadSegments.begin())
625       report_fatal_error("Virtual address is not in any segment");
626     --I;
627     const Elf_Phdr &Phdr = **I;
628     uint64_t Delta = VAddr - Phdr.p_vaddr;
629     if (Delta >= Phdr.p_filesz)
630       report_fatal_error("Virtual address is not in any segment");
631     return Obj->base() + Phdr.p_offset + Delta;
632   };
633
634   uint64_t SONameOffset = 0;
635   const char *StringTableBegin = nullptr;
636   uint64_t StringTableSize = 0;
637   for (const Elf_Dyn &Dyn : dynamic_table()) {
638     switch (Dyn.d_tag) {
639     case ELF::DT_HASH:
640       HashTable =
641           reinterpret_cast<const Elf_Hash *>(toMappedAddr(Dyn.getPtr()));
642       break;
643     case ELF::DT_RELA:
644       DynRelaRegion.Addr = toMappedAddr(Dyn.getPtr());
645       break;
646     case ELF::DT_RELASZ:
647       DynRelaRegion.Size = Dyn.getVal();
648       break;
649     case ELF::DT_RELAENT:
650       DynRelaRegion.EntSize = Dyn.getVal();
651       break;
652     case ELF::DT_SONAME:
653       SONameOffset = Dyn.getVal();
654       break;
655     case ELF::DT_STRTAB:
656       StringTableBegin = (const char *)toMappedAddr(Dyn.getPtr());
657       break;
658     case ELF::DT_STRSZ:
659       StringTableSize = Dyn.getVal();
660       break;
661     }
662   }
663   if (StringTableBegin)
664     DynamicStringTable = StringRef(StringTableBegin, StringTableSize);
665   if (SONameOffset)
666     SOName = getDynamicString(SONameOffset);
667 }
668
669 template <typename ELFT>
670 const typename ELFDumper<ELFT>::Elf_Rela *
671 ELFDumper<ELFT>::dyn_rela_begin() const {
672   if (DynRelaRegion.Size && DynRelaRegion.EntSize != sizeof(Elf_Rela))
673     report_fatal_error("Invalid relocation entry size");
674   return reinterpret_cast<const Elf_Rela *>(DynRelaRegion.Addr);
675 }
676
677 template <typename ELFT>
678 const typename ELFDumper<ELFT>::Elf_Rela *
679 ELFDumper<ELFT>::dyn_rela_end() const {
680   uint64_t Size = DynRelaRegion.Size;
681   if (Size % sizeof(Elf_Rela))
682     report_fatal_error("Invalid relocation table size");
683   return dyn_rela_begin() + Size / sizeof(Elf_Rela);
684 }
685
686 template <typename ELFT>
687 typename ELFDumper<ELFT>::Elf_Rela_Range ELFDumper<ELFT>::dyn_relas() const {
688   return make_range(dyn_rela_begin(), dyn_rela_end());
689 }
690
691 template <typename ELFT>
692 const typename ELFDumper<ELFT>::Elf_Dyn *
693 ELFDumper<ELFT>::dynamic_table_begin() const {
694   return reinterpret_cast<const Elf_Dyn *>(DynamicRegion.Addr);
695 }
696
697 template <typename ELFT>
698 const typename ELFDumper<ELFT>::Elf_Dyn *
699 ELFDumper<ELFT>::dynamic_table_end() const {
700   uint64_t Size = DynamicRegion.Size;
701   return dynamic_table_begin() + Size / sizeof(Elf_Dyn);
702 }
703
704 template<class ELFT>
705 void ELFDumper<ELFT>::printFileHeaders() {
706   const typename ELFO::Elf_Ehdr *Header = Obj->getHeader();
707
708   {
709     DictScope D(W, "ElfHeader");
710     {
711       DictScope D(W, "Ident");
712       W.printBinary("Magic", makeArrayRef(Header->e_ident).slice(ELF::EI_MAG0,
713                                                                  4));
714       W.printEnum  ("Class", Header->e_ident[ELF::EI_CLASS],
715                       makeArrayRef(ElfClass));
716       W.printEnum  ("DataEncoding", Header->e_ident[ELF::EI_DATA],
717                       makeArrayRef(ElfDataEncoding));
718       W.printNumber("FileVersion", Header->e_ident[ELF::EI_VERSION]);
719
720       // Handle architecture specific OS/ABI values.
721       if (Header->e_machine == ELF::EM_AMDGPU &&
722           Header->e_ident[ELF::EI_OSABI] == ELF::ELFOSABI_AMDGPU_HSA)
723         W.printHex("OS/ABI", "AMDGPU_HSA", ELF::ELFOSABI_AMDGPU_HSA);
724       else
725         W.printEnum  ("OS/ABI", Header->e_ident[ELF::EI_OSABI],
726                       makeArrayRef(ElfOSABI));
727       W.printNumber("ABIVersion", Header->e_ident[ELF::EI_ABIVERSION]);
728       W.printBinary("Unused", makeArrayRef(Header->e_ident).slice(ELF::EI_PAD));
729     }
730
731     W.printEnum  ("Type", Header->e_type, makeArrayRef(ElfObjectFileType));
732     W.printEnum  ("Machine", Header->e_machine, makeArrayRef(ElfMachineType));
733     W.printNumber("Version", Header->e_version);
734     W.printHex   ("Entry", Header->e_entry);
735     W.printHex   ("ProgramHeaderOffset", Header->e_phoff);
736     W.printHex   ("SectionHeaderOffset", Header->e_shoff);
737     if (Header->e_machine == EM_MIPS)
738       W.printFlags("Flags", Header->e_flags, makeArrayRef(ElfHeaderMipsFlags),
739                    unsigned(ELF::EF_MIPS_ARCH), unsigned(ELF::EF_MIPS_ABI),
740                    unsigned(ELF::EF_MIPS_MACH));
741     else
742       W.printFlags("Flags", Header->e_flags);
743     W.printNumber("HeaderSize", Header->e_ehsize);
744     W.printNumber("ProgramHeaderEntrySize", Header->e_phentsize);
745     W.printNumber("ProgramHeaderCount", Header->e_phnum);
746     W.printNumber("SectionHeaderEntrySize", Header->e_shentsize);
747     W.printNumber("SectionHeaderCount", Header->e_shnum);
748     W.printNumber("StringTableSectionIndex", Header->e_shstrndx);
749   }
750 }
751
752 template<class ELFT>
753 void ELFDumper<ELFT>::printSections() {
754   ListScope SectionsD(W, "Sections");
755
756   int SectionIndex = -1;
757   for (const typename ELFO::Elf_Shdr &Sec : Obj->sections()) {
758     ++SectionIndex;
759
760     StringRef Name = errorOrDefault(Obj->getSectionName(&Sec));
761
762     DictScope SectionD(W, "Section");
763     W.printNumber("Index", SectionIndex);
764     W.printNumber("Name", Name, Sec.sh_name);
765     W.printHex("Type",
766                getElfSectionType(Obj->getHeader()->e_machine, Sec.sh_type),
767                Sec.sh_type);
768     W.printFlags("Flags", Sec.sh_flags, makeArrayRef(ElfSectionFlags));
769     W.printHex("Address", Sec.sh_addr);
770     W.printHex("Offset", Sec.sh_offset);
771     W.printNumber("Size", Sec.sh_size);
772     W.printNumber("Link", Sec.sh_link);
773     W.printNumber("Info", Sec.sh_info);
774     W.printNumber("AddressAlignment", Sec.sh_addralign);
775     W.printNumber("EntrySize", Sec.sh_entsize);
776
777     if (opts::SectionRelocations) {
778       ListScope D(W, "Relocations");
779       printRelocations(&Sec);
780     }
781
782     if (opts::SectionSymbols) {
783       ListScope D(W, "Symbols");
784       const Elf_Shdr *Symtab = Obj->getDotSymtabSec();
785       ErrorOr<StringRef> StrTableOrErr = Obj->getStringTableForSymtab(*Symtab);
786       error(StrTableOrErr.getError());
787       StringRef StrTable = *StrTableOrErr;
788
789       for (const typename ELFO::Elf_Sym &Sym : Obj->symbols()) {
790         ErrorOr<const Elf_Shdr *> SymSec = Obj->getSection(&Sym);
791         if (!SymSec)
792           continue;
793         if (*SymSec == &Sec)
794           printSymbol(&Sym, StrTable, false);
795       }
796     }
797
798     if (opts::SectionData && Sec.sh_type != ELF::SHT_NOBITS) {
799       ArrayRef<uint8_t> Data = errorOrDefault(Obj->getSectionContents(&Sec));
800       W.printBinaryBlock("SectionData",
801                          StringRef((const char *)Data.data(), Data.size()));
802     }
803   }
804 }
805
806 template<class ELFT>
807 void ELFDumper<ELFT>::printRelocations() {
808   ListScope D(W, "Relocations");
809
810   int SectionNumber = -1;
811   for (const typename ELFO::Elf_Shdr &Sec : Obj->sections()) {
812     ++SectionNumber;
813
814     if (Sec.sh_type != ELF::SHT_REL && Sec.sh_type != ELF::SHT_RELA)
815       continue;
816
817     StringRef Name = errorOrDefault(Obj->getSectionName(&Sec));
818
819     W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";
820     W.indent();
821
822     printRelocations(&Sec);
823
824     W.unindent();
825     W.startLine() << "}\n";
826   }
827 }
828
829 template<class ELFT>
830 void ELFDumper<ELFT>::printDynamicRelocations() {
831   W.startLine() << "Dynamic Relocations {\n";
832   W.indent();
833   for (const typename ELFO::Elf_Rela &Rel : dyn_relas()) {
834     SmallString<32> RelocName;
835     Obj->getRelocationTypeName(Rel.getType(Obj->isMips64EL()), RelocName);
836     StringRef SymbolName;
837     uint32_t SymIndex = Rel.getSymbol(Obj->isMips64EL());
838     const typename ELFO::Elf_Sym *Sym = Obj->dynamic_symbol_begin() + SymIndex;
839     SymbolName = errorOrDefault(Sym->getName(DynamicStringTable));
840     if (opts::ExpandRelocs) {
841       DictScope Group(W, "Relocation");
842       W.printHex("Offset", Rel.r_offset);
843       W.printNumber("Type", RelocName, (int)Rel.getType(Obj->isMips64EL()));
844       W.printString("Symbol", SymbolName.size() > 0 ? SymbolName : "-");
845       W.printHex("Addend", Rel.r_addend);
846     }
847     else {
848       raw_ostream& OS = W.startLine();
849       OS << W.hex(Rel.r_offset) << " " << RelocName << " "
850          << (SymbolName.size() > 0 ? SymbolName : "-") << " "
851          << W.hex(Rel.r_addend) << "\n";
852     }
853   }
854   W.unindent();
855   W.startLine() << "}\n";
856 }
857
858 template <class ELFT>
859 void ELFDumper<ELFT>::printRelocations(const Elf_Shdr *Sec) {
860   switch (Sec->sh_type) {
861   case ELF::SHT_REL:
862     for (const typename ELFO::Elf_Rel &R : Obj->rels(Sec)) {
863       typename ELFO::Elf_Rela Rela;
864       Rela.r_offset = R.r_offset;
865       Rela.r_info = R.r_info;
866       Rela.r_addend = 0;
867       printRelocation(Sec, Rela);
868     }
869     break;
870   case ELF::SHT_RELA:
871     for (const typename ELFO::Elf_Rela &R : Obj->relas(Sec))
872       printRelocation(Sec, R);
873     break;
874   }
875 }
876
877 template <class ELFT>
878 void ELFDumper<ELFT>::printRelocation(const Elf_Shdr *Sec,
879                                       typename ELFO::Elf_Rela Rel) {
880   SmallString<32> RelocName;
881   Obj->getRelocationTypeName(Rel.getType(Obj->isMips64EL()), RelocName);
882   StringRef TargetName;
883   std::pair<const Elf_Shdr *, const Elf_Sym *> Sym =
884       Obj->getRelocationSymbol(Sec, &Rel);
885   if (Sym.second && Sym.second->getType() == ELF::STT_SECTION) {
886     ErrorOr<const Elf_Shdr *> Sec = Obj->getSection(Sym.second);
887     error(Sec.getError());
888     ErrorOr<StringRef> SecName = Obj->getSectionName(*Sec);
889     if (SecName)
890       TargetName = SecName.get();
891   } else if (Sym.first) {
892     const Elf_Shdr *SymTable = Sym.first;
893     ErrorOr<StringRef> StrTableOrErr = Obj->getStringTableForSymtab(*SymTable);
894     error(StrTableOrErr.getError());
895     TargetName = errorOrDefault(Sym.second->getName(*StrTableOrErr));
896   }
897
898   if (opts::ExpandRelocs) {
899     DictScope Group(W, "Relocation");
900     W.printHex("Offset", Rel.r_offset);
901     W.printNumber("Type", RelocName, (int)Rel.getType(Obj->isMips64EL()));
902     W.printNumber("Symbol", TargetName.size() > 0 ? TargetName : "-",
903                   Rel.getSymbol(Obj->isMips64EL()));
904     W.printHex("Addend", Rel.r_addend);
905   } else {
906     raw_ostream& OS = W.startLine();
907     OS << W.hex(Rel.r_offset) << " " << RelocName << " "
908        << (TargetName.size() > 0 ? TargetName : "-") << " "
909        << W.hex(Rel.r_addend) << "\n";
910   }
911 }
912
913 template<class ELFT>
914 void ELFDumper<ELFT>::printSymbols() {
915   ListScope Group(W, "Symbols");
916
917   const Elf_Shdr *Symtab = Obj->getDotSymtabSec();
918   ErrorOr<StringRef> StrTableOrErr = Obj->getStringTableForSymtab(*Symtab);
919   error(StrTableOrErr.getError());
920   StringRef StrTable = *StrTableOrErr;
921   for (const typename ELFO::Elf_Sym &Sym : Obj->symbols())
922     printSymbol(&Sym, StrTable, false);
923 }
924
925 template<class ELFT>
926 void ELFDumper<ELFT>::printDynamicSymbols() {
927   ListScope Group(W, "DynamicSymbols");
928
929   const Elf_Shdr *Symtab = Obj->getDotDynSymSec();
930   ErrorOr<StringRef> StrTableOrErr = Obj->getStringTableForSymtab(*Symtab);
931   error(StrTableOrErr.getError());
932   StringRef StrTable = *StrTableOrErr;
933   for (const typename ELFO::Elf_Sym &Sym : Obj->dynamic_symbols())
934     printSymbol(&Sym, StrTable, true);
935 }
936
937 template <class ELFT>
938 void ELFDumper<ELFT>::printSymbol(const typename ELFO::Elf_Sym *Symbol,
939                                   StringRef StrTable, bool IsDynamic) {
940   unsigned SectionIndex = 0;
941   StringRef SectionName;
942   getSectionNameIndex(*Obj, Symbol, SectionName, SectionIndex);
943   std::string FullSymbolName =
944       getFullSymbolName(*Obj, Symbol, StrTable, IsDynamic);
945
946   DictScope D(W, "Symbol");
947   W.printNumber("Name", FullSymbolName, Symbol->st_name);
948   W.printHex   ("Value", Symbol->st_value);
949   W.printNumber("Size", Symbol->st_size);
950   W.printEnum  ("Binding", Symbol->getBinding(),
951                   makeArrayRef(ElfSymbolBindings));
952   W.printEnum  ("Type", Symbol->getType(), makeArrayRef(ElfSymbolTypes));
953   W.printNumber("Other", Symbol->st_other);
954   W.printHex("Section", SectionName, SectionIndex);
955 }
956
957 #define LLVM_READOBJ_TYPE_CASE(name) \
958   case DT_##name: return #name
959
960 static const char *getTypeString(uint64_t Type) {
961   switch (Type) {
962   LLVM_READOBJ_TYPE_CASE(BIND_NOW);
963   LLVM_READOBJ_TYPE_CASE(DEBUG);
964   LLVM_READOBJ_TYPE_CASE(FINI);
965   LLVM_READOBJ_TYPE_CASE(FINI_ARRAY);
966   LLVM_READOBJ_TYPE_CASE(FINI_ARRAYSZ);
967   LLVM_READOBJ_TYPE_CASE(FLAGS);
968   LLVM_READOBJ_TYPE_CASE(FLAGS_1);
969   LLVM_READOBJ_TYPE_CASE(HASH);
970   LLVM_READOBJ_TYPE_CASE(INIT);
971   LLVM_READOBJ_TYPE_CASE(INIT_ARRAY);
972   LLVM_READOBJ_TYPE_CASE(INIT_ARRAYSZ);
973   LLVM_READOBJ_TYPE_CASE(PREINIT_ARRAY);
974   LLVM_READOBJ_TYPE_CASE(PREINIT_ARRAYSZ);
975   LLVM_READOBJ_TYPE_CASE(JMPREL);
976   LLVM_READOBJ_TYPE_CASE(NEEDED);
977   LLVM_READOBJ_TYPE_CASE(NULL);
978   LLVM_READOBJ_TYPE_CASE(PLTGOT);
979   LLVM_READOBJ_TYPE_CASE(PLTREL);
980   LLVM_READOBJ_TYPE_CASE(PLTRELSZ);
981   LLVM_READOBJ_TYPE_CASE(REL);
982   LLVM_READOBJ_TYPE_CASE(RELA);
983   LLVM_READOBJ_TYPE_CASE(RELENT);
984   LLVM_READOBJ_TYPE_CASE(RELSZ);
985   LLVM_READOBJ_TYPE_CASE(RELAENT);
986   LLVM_READOBJ_TYPE_CASE(RELASZ);
987   LLVM_READOBJ_TYPE_CASE(RPATH);
988   LLVM_READOBJ_TYPE_CASE(RUNPATH);
989   LLVM_READOBJ_TYPE_CASE(SONAME);
990   LLVM_READOBJ_TYPE_CASE(STRSZ);
991   LLVM_READOBJ_TYPE_CASE(STRTAB);
992   LLVM_READOBJ_TYPE_CASE(SYMBOLIC);
993   LLVM_READOBJ_TYPE_CASE(SYMENT);
994   LLVM_READOBJ_TYPE_CASE(SYMTAB);
995   LLVM_READOBJ_TYPE_CASE(TEXTREL);
996   LLVM_READOBJ_TYPE_CASE(VERNEED);
997   LLVM_READOBJ_TYPE_CASE(VERNEEDNUM);
998   LLVM_READOBJ_TYPE_CASE(VERSYM);
999   LLVM_READOBJ_TYPE_CASE(RELCOUNT);
1000   LLVM_READOBJ_TYPE_CASE(GNU_HASH);
1001   LLVM_READOBJ_TYPE_CASE(MIPS_RLD_VERSION);
1002   LLVM_READOBJ_TYPE_CASE(MIPS_FLAGS);
1003   LLVM_READOBJ_TYPE_CASE(MIPS_BASE_ADDRESS);
1004   LLVM_READOBJ_TYPE_CASE(MIPS_LOCAL_GOTNO);
1005   LLVM_READOBJ_TYPE_CASE(MIPS_SYMTABNO);
1006   LLVM_READOBJ_TYPE_CASE(MIPS_UNREFEXTNO);
1007   LLVM_READOBJ_TYPE_CASE(MIPS_GOTSYM);
1008   LLVM_READOBJ_TYPE_CASE(MIPS_RLD_MAP);
1009   LLVM_READOBJ_TYPE_CASE(MIPS_PLTGOT);
1010   LLVM_READOBJ_TYPE_CASE(MIPS_OPTIONS);
1011   default: return "unknown";
1012   }
1013 }
1014
1015 #undef LLVM_READOBJ_TYPE_CASE
1016
1017 #define LLVM_READOBJ_DT_FLAG_ENT(prefix, enum) \
1018   { #enum, prefix##_##enum }
1019
1020 static const EnumEntry<unsigned> ElfDynamicDTFlags[] = {
1021   LLVM_READOBJ_DT_FLAG_ENT(DF, ORIGIN),
1022   LLVM_READOBJ_DT_FLAG_ENT(DF, SYMBOLIC),
1023   LLVM_READOBJ_DT_FLAG_ENT(DF, TEXTREL),
1024   LLVM_READOBJ_DT_FLAG_ENT(DF, BIND_NOW),
1025   LLVM_READOBJ_DT_FLAG_ENT(DF, STATIC_TLS)
1026 };
1027
1028 static const EnumEntry<unsigned> ElfDynamicDTFlags1[] = {
1029   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NOW),
1030   LLVM_READOBJ_DT_FLAG_ENT(DF_1, GLOBAL),
1031   LLVM_READOBJ_DT_FLAG_ENT(DF_1, GROUP),
1032   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NODELETE),
1033   LLVM_READOBJ_DT_FLAG_ENT(DF_1, LOADFLTR),
1034   LLVM_READOBJ_DT_FLAG_ENT(DF_1, INITFIRST),
1035   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NOOPEN),
1036   LLVM_READOBJ_DT_FLAG_ENT(DF_1, ORIGIN),
1037   LLVM_READOBJ_DT_FLAG_ENT(DF_1, DIRECT),
1038   LLVM_READOBJ_DT_FLAG_ENT(DF_1, TRANS),
1039   LLVM_READOBJ_DT_FLAG_ENT(DF_1, INTERPOSE),
1040   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NODEFLIB),
1041   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NODUMP),
1042   LLVM_READOBJ_DT_FLAG_ENT(DF_1, CONFALT),
1043   LLVM_READOBJ_DT_FLAG_ENT(DF_1, ENDFILTEE),
1044   LLVM_READOBJ_DT_FLAG_ENT(DF_1, DISPRELDNE),
1045   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NODIRECT),
1046   LLVM_READOBJ_DT_FLAG_ENT(DF_1, IGNMULDEF),
1047   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NOKSYMS),
1048   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NOHDR),
1049   LLVM_READOBJ_DT_FLAG_ENT(DF_1, EDITED),
1050   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NORELOC),
1051   LLVM_READOBJ_DT_FLAG_ENT(DF_1, SYMINTPOSE),
1052   LLVM_READOBJ_DT_FLAG_ENT(DF_1, GLOBAUDIT),
1053   LLVM_READOBJ_DT_FLAG_ENT(DF_1, SINGLETON)
1054 };
1055
1056 static const EnumEntry<unsigned> ElfDynamicDTMipsFlags[] = {
1057   LLVM_READOBJ_DT_FLAG_ENT(RHF, NONE),
1058   LLVM_READOBJ_DT_FLAG_ENT(RHF, QUICKSTART),
1059   LLVM_READOBJ_DT_FLAG_ENT(RHF, NOTPOT),
1060   LLVM_READOBJ_DT_FLAG_ENT(RHS, NO_LIBRARY_REPLACEMENT),
1061   LLVM_READOBJ_DT_FLAG_ENT(RHF, NO_MOVE),
1062   LLVM_READOBJ_DT_FLAG_ENT(RHF, SGI_ONLY),
1063   LLVM_READOBJ_DT_FLAG_ENT(RHF, GUARANTEE_INIT),
1064   LLVM_READOBJ_DT_FLAG_ENT(RHF, DELTA_C_PLUS_PLUS),
1065   LLVM_READOBJ_DT_FLAG_ENT(RHF, GUARANTEE_START_INIT),
1066   LLVM_READOBJ_DT_FLAG_ENT(RHF, PIXIE),
1067   LLVM_READOBJ_DT_FLAG_ENT(RHF, DEFAULT_DELAY_LOAD),
1068   LLVM_READOBJ_DT_FLAG_ENT(RHF, REQUICKSTART),
1069   LLVM_READOBJ_DT_FLAG_ENT(RHF, REQUICKSTARTED),
1070   LLVM_READOBJ_DT_FLAG_ENT(RHF, CORD),
1071   LLVM_READOBJ_DT_FLAG_ENT(RHF, NO_UNRES_UNDEF),
1072   LLVM_READOBJ_DT_FLAG_ENT(RHF, RLD_ORDER_SAFE)
1073 };
1074
1075 #undef LLVM_READOBJ_DT_FLAG_ENT
1076
1077 template <typename T, typename TFlag>
1078 void printFlags(T Value, ArrayRef<EnumEntry<TFlag>> Flags, raw_ostream &OS) {
1079   typedef EnumEntry<TFlag> FlagEntry;
1080   typedef SmallVector<FlagEntry, 10> FlagVector;
1081   FlagVector SetFlags;
1082
1083   for (const auto &Flag : Flags) {
1084     if (Flag.Value == 0)
1085       continue;
1086
1087     if ((Value & Flag.Value) == Flag.Value)
1088       SetFlags.push_back(Flag);
1089   }
1090
1091   for (const auto &Flag : SetFlags) {
1092     OS << Flag.Name << " ";
1093   }
1094 }
1095
1096 template <class ELFT>
1097 StringRef ELFDumper<ELFT>::getDynamicString(uint64_t Value) const {
1098   if (Value >= DynamicStringTable.size())
1099     reportError("Invalid dynamic string table reference");
1100   return StringRef(DynamicStringTable.data() + Value);
1101 }
1102
1103 template <class ELFT>
1104 void ELFDumper<ELFT>::printValue(uint64_t Type, uint64_t Value) {
1105   raw_ostream &OS = W.getOStream();
1106   switch (Type) {
1107   case DT_PLTREL:
1108     if (Value == DT_REL) {
1109       OS << "REL";
1110       break;
1111     } else if (Value == DT_RELA) {
1112       OS << "RELA";
1113       break;
1114     }
1115   // Fallthrough.
1116   case DT_PLTGOT:
1117   case DT_HASH:
1118   case DT_STRTAB:
1119   case DT_SYMTAB:
1120   case DT_RELA:
1121   case DT_INIT:
1122   case DT_FINI:
1123   case DT_REL:
1124   case DT_JMPREL:
1125   case DT_INIT_ARRAY:
1126   case DT_FINI_ARRAY:
1127   case DT_PREINIT_ARRAY:
1128   case DT_DEBUG:
1129   case DT_VERNEED:
1130   case DT_VERSYM:
1131   case DT_GNU_HASH:
1132   case DT_NULL:
1133   case DT_MIPS_BASE_ADDRESS:
1134   case DT_MIPS_GOTSYM:
1135   case DT_MIPS_RLD_MAP:
1136   case DT_MIPS_PLTGOT:
1137   case DT_MIPS_OPTIONS:
1138     OS << format("0x%" PRIX64, Value);
1139     break;
1140   case DT_RELCOUNT:
1141   case DT_VERNEEDNUM:
1142   case DT_MIPS_RLD_VERSION:
1143   case DT_MIPS_LOCAL_GOTNO:
1144   case DT_MIPS_SYMTABNO:
1145   case DT_MIPS_UNREFEXTNO:
1146     OS << Value;
1147     break;
1148   case DT_PLTRELSZ:
1149   case DT_RELASZ:
1150   case DT_RELAENT:
1151   case DT_STRSZ:
1152   case DT_SYMENT:
1153   case DT_RELSZ:
1154   case DT_RELENT:
1155   case DT_INIT_ARRAYSZ:
1156   case DT_FINI_ARRAYSZ:
1157   case DT_PREINIT_ARRAYSZ:
1158     OS << Value << " (bytes)";
1159     break;
1160   case DT_NEEDED:
1161     OS << "SharedLibrary (" << getDynamicString(Value) << ")";
1162     break;
1163   case DT_SONAME:
1164     OS << "LibrarySoname (" << getDynamicString(Value) << ")";
1165     break;
1166   case DT_RPATH:
1167   case DT_RUNPATH:
1168     OS << getDynamicString(Value);
1169     break;
1170   case DT_MIPS_FLAGS:
1171     printFlags(Value, makeArrayRef(ElfDynamicDTMipsFlags), OS);
1172     break;
1173   case DT_FLAGS:
1174     printFlags(Value, makeArrayRef(ElfDynamicDTFlags), OS);
1175     break;
1176   case DT_FLAGS_1:
1177     printFlags(Value, makeArrayRef(ElfDynamicDTFlags1), OS);
1178     break;
1179   default:
1180     OS << format("0x%" PRIX64, Value);
1181     break;
1182   }
1183 }
1184
1185 template<class ELFT>
1186 void ELFDumper<ELFT>::printUnwindInfo() {
1187   W.startLine() << "UnwindInfo not implemented.\n";
1188 }
1189
1190 namespace {
1191 template <> void ELFDumper<ELFType<support::little, false>>::printUnwindInfo() {
1192   const unsigned Machine = Obj->getHeader()->e_machine;
1193   if (Machine == EM_ARM) {
1194     ARM::EHABI::PrinterContext<ELFType<support::little, false>> Ctx(W, Obj);
1195     return Ctx.PrintUnwindInformation();
1196   }
1197   W.startLine() << "UnwindInfo not implemented.\n";
1198 }
1199 }
1200
1201 template<class ELFT>
1202 void ELFDumper<ELFT>::printDynamicTable() {
1203   auto I = dynamic_table_begin();
1204   auto E = dynamic_table_end();
1205
1206   if (I == E)
1207     return;
1208
1209   --E;
1210   while (I != E && E->getTag() == ELF::DT_NULL)
1211     --E;
1212   if (E->getTag() != ELF::DT_NULL)
1213     ++E;
1214   ++E;
1215
1216   ptrdiff_t Total = std::distance(I, E);
1217   if (Total == 0)
1218     return;
1219
1220   raw_ostream &OS = W.getOStream();
1221   W.startLine() << "DynamicSection [ (" << Total << " entries)\n";
1222
1223   bool Is64 = ELFT::Is64Bits;
1224
1225   W.startLine()
1226      << "  Tag" << (Is64 ? "                " : "        ") << "Type"
1227      << "                 " << "Name/Value\n";
1228   while (I != E) {
1229     const typename ELFO::Elf_Dyn &Entry = *I;
1230     ++I;
1231     W.startLine()
1232        << "  "
1233        << format(Is64 ? "0x%016" PRIX64 : "0x%08" PRIX64, Entry.getTag())
1234        << " " << format("%-21s", getTypeString(Entry.getTag()));
1235     printValue(Entry.getTag(), Entry.getVal());
1236     OS << "\n";
1237   }
1238
1239   W.startLine() << "]\n";
1240 }
1241
1242 template<class ELFT>
1243 void ELFDumper<ELFT>::printNeededLibraries() {
1244   ListScope D(W, "NeededLibraries");
1245
1246   typedef std::vector<StringRef> LibsTy;
1247   LibsTy Libs;
1248
1249   for (const auto &Entry : dynamic_table())
1250     if (Entry.d_tag == ELF::DT_NEEDED)
1251       Libs.push_back(getDynamicString(Entry.d_un.d_val));
1252
1253   std::stable_sort(Libs.begin(), Libs.end());
1254
1255   for (LibsTy::const_iterator I = Libs.begin(), E = Libs.end(); I != E; ++I) {
1256     outs() << "  " << *I << "\n";
1257   }
1258 }
1259
1260 template<class ELFT>
1261 void ELFDumper<ELFT>::printProgramHeaders() {
1262   ListScope L(W, "ProgramHeaders");
1263
1264   for (const typename ELFO::Elf_Phdr &Phdr : Obj->program_headers()) {
1265     DictScope P(W, "ProgramHeader");
1266     W.printHex("Type",
1267                getElfSegmentType(Obj->getHeader()->e_machine, Phdr.p_type),
1268                Phdr.p_type);
1269     W.printHex("Offset", Phdr.p_offset);
1270     W.printHex("VirtualAddress", Phdr.p_vaddr);
1271     W.printHex("PhysicalAddress", Phdr.p_paddr);
1272     W.printNumber("FileSize", Phdr.p_filesz);
1273     W.printNumber("MemSize", Phdr.p_memsz);
1274     W.printFlags("Flags", Phdr.p_flags, makeArrayRef(ElfSegmentFlags));
1275     W.printNumber("Alignment", Phdr.p_align);
1276   }
1277 }
1278
1279 template <typename ELFT>
1280 void ELFDumper<ELFT>::printHashTable() {
1281   DictScope D(W, "HashTable");
1282   if (!HashTable)
1283     return;
1284   W.printNumber("Num Buckets", HashTable->nbucket);
1285   W.printNumber("Num Chains", HashTable->nchain);
1286   W.printList("Buckets", HashTable->buckets());
1287   W.printList("Chains", HashTable->chains());
1288 }
1289
1290 template <typename ELFT> void ELFDumper<ELFT>::printLoadName() {
1291   outs() << "LoadName: " << SOName << '\n';
1292 }
1293
1294 template <class ELFT>
1295 void ELFDumper<ELFT>::printAttributes() {
1296   W.startLine() << "Attributes not implemented.\n";
1297 }
1298
1299 namespace {
1300 template <> void ELFDumper<ELFType<support::little, false>>::printAttributes() {
1301   if (Obj->getHeader()->e_machine != EM_ARM) {
1302     W.startLine() << "Attributes not implemented.\n";
1303     return;
1304   }
1305
1306   DictScope BA(W, "BuildAttributes");
1307   for (const ELFO::Elf_Shdr &Sec : Obj->sections()) {
1308     if (Sec.sh_type != ELF::SHT_ARM_ATTRIBUTES)
1309       continue;
1310
1311     ErrorOr<ArrayRef<uint8_t>> Contents = Obj->getSectionContents(&Sec);
1312     if (!Contents)
1313       continue;
1314
1315     if ((*Contents)[0] != ARMBuildAttrs::Format_Version) {
1316       errs() << "unrecognised FormatVersion: 0x" << utohexstr((*Contents)[0])
1317              << '\n';
1318       continue;
1319     }
1320
1321     W.printHex("FormatVersion", (*Contents)[0]);
1322     if (Contents->size() == 1)
1323       continue;
1324
1325     ARMAttributeParser(W).Parse(*Contents);
1326   }
1327 }
1328 }
1329
1330 namespace {
1331 template <class ELFT> class MipsGOTParser {
1332 public:
1333   typedef object::ELFFile<ELFT> ObjectFile;
1334   typedef typename ObjectFile::Elf_Shdr Elf_Shdr;
1335   typedef typename ObjectFile::Elf_Sym Elf_Sym;
1336   typedef typename ObjectFile::Elf_Dyn_Range Elf_Dyn_Range;
1337
1338   MipsGOTParser(const ObjectFile *Obj, Elf_Dyn_Range DynTable, StreamWriter &W);
1339
1340   void parseGOT();
1341   void parsePLT();
1342
1343 private:
1344   typedef typename ObjectFile::Elf_Addr GOTEntry;
1345   typedef typename ObjectFile::template ELFEntityIterator<const GOTEntry>
1346   GOTIter;
1347
1348   const ObjectFile *Obj;
1349   StreamWriter &W;
1350   llvm::Optional<uint64_t> DtPltGot;
1351   llvm::Optional<uint64_t> DtLocalGotNum;
1352   llvm::Optional<uint64_t> DtGotSym;
1353   llvm::Optional<uint64_t> DtMipsPltGot;
1354   llvm::Optional<uint64_t> DtJmpRel;
1355
1356   std::size_t getGOTTotal(ArrayRef<uint8_t> GOT) const;
1357   GOTIter makeGOTIter(ArrayRef<uint8_t> GOT, std::size_t EntryNum);
1358
1359   void printGotEntry(uint64_t GotAddr, GOTIter BeginIt, GOTIter It);
1360   void printGlobalGotEntry(uint64_t GotAddr, GOTIter BeginIt, GOTIter It,
1361                            const Elf_Sym *Sym, StringRef StrTable,
1362                            bool IsDynamic);
1363   void printPLTEntry(uint64_t PLTAddr, GOTIter BeginIt, GOTIter It,
1364                      StringRef Purpose);
1365   void printPLTEntry(uint64_t PLTAddr, GOTIter BeginIt, GOTIter It,
1366                      StringRef StrTable, const Elf_Sym *Sym);
1367 };
1368 }
1369
1370 template <class ELFT>
1371 MipsGOTParser<ELFT>::MipsGOTParser(const ObjectFile *Obj,
1372                                    Elf_Dyn_Range DynTable, StreamWriter &W)
1373     : Obj(Obj), W(W) {
1374   for (const auto &Entry : DynTable) {
1375     switch (Entry.getTag()) {
1376     case ELF::DT_PLTGOT:
1377       DtPltGot = Entry.getVal();
1378       break;
1379     case ELF::DT_MIPS_LOCAL_GOTNO:
1380       DtLocalGotNum = Entry.getVal();
1381       break;
1382     case ELF::DT_MIPS_GOTSYM:
1383       DtGotSym = Entry.getVal();
1384       break;
1385     case ELF::DT_MIPS_PLTGOT:
1386       DtMipsPltGot = Entry.getVal();
1387       break;
1388     case ELF::DT_JMPREL:
1389       DtJmpRel = Entry.getVal();
1390       break;
1391     }
1392   }
1393 }
1394
1395 template <class ELFT> void MipsGOTParser<ELFT>::parseGOT() {
1396   // See "Global Offset Table" in Chapter 5 in the following document
1397   // for detailed GOT description.
1398   // ftp://www.linux-mips.org/pub/linux/mips/doc/ABI/mipsabi.pdf
1399   if (!DtPltGot) {
1400     W.startLine() << "Cannot find PLTGOT dynamic table tag.\n";
1401     return;
1402   }
1403   if (!DtLocalGotNum) {
1404     W.startLine() << "Cannot find MIPS_LOCAL_GOTNO dynamic table tag.\n";
1405     return;
1406   }
1407   if (!DtGotSym) {
1408     W.startLine() << "Cannot find MIPS_GOTSYM dynamic table tag.\n";
1409     return;
1410   }
1411
1412   const Elf_Shdr *GOTShdr = findSectionByAddress(Obj, *DtPltGot);
1413   if (!GOTShdr) {
1414     W.startLine() << "There is no .got section in the file.\n";
1415     return;
1416   }
1417
1418   ErrorOr<ArrayRef<uint8_t>> GOT = Obj->getSectionContents(GOTShdr);
1419   if (!GOT) {
1420     W.startLine() << "The .got section is empty.\n";
1421     return;
1422   }
1423
1424   if (*DtLocalGotNum > getGOTTotal(*GOT)) {
1425     W.startLine() << "MIPS_LOCAL_GOTNO exceeds a number of GOT entries.\n";
1426     return;
1427   }
1428
1429   const Elf_Shdr *DynSymSec = Obj->getDotDynSymSec();
1430   ErrorOr<StringRef> StrTable = Obj->getStringTableForSymtab(*DynSymSec);
1431   error(StrTable.getError());
1432   const Elf_Sym *DynSymBegin = Obj->dynamic_symbol_begin();
1433   const Elf_Sym *DynSymEnd = Obj->dynamic_symbol_end();
1434   std::size_t DynSymTotal = std::size_t(std::distance(DynSymBegin, DynSymEnd));
1435
1436   if (*DtGotSym > DynSymTotal) {
1437     W.startLine() << "MIPS_GOTSYM exceeds a number of dynamic symbols.\n";
1438     return;
1439   }
1440
1441   std::size_t GlobalGotNum = DynSymTotal - *DtGotSym;
1442
1443   if (*DtLocalGotNum + GlobalGotNum > getGOTTotal(*GOT)) {
1444     W.startLine() << "Number of global GOT entries exceeds the size of GOT.\n";
1445     return;
1446   }
1447
1448   GOTIter GotBegin = makeGOTIter(*GOT, 0);
1449   GOTIter GotLocalEnd = makeGOTIter(*GOT, *DtLocalGotNum);
1450   GOTIter It = GotBegin;
1451
1452   DictScope GS(W, "Primary GOT");
1453
1454   W.printHex("Canonical gp value", GOTShdr->sh_addr + 0x7ff0);
1455   {
1456     ListScope RS(W, "Reserved entries");
1457
1458     {
1459       DictScope D(W, "Entry");
1460       printGotEntry(GOTShdr->sh_addr, GotBegin, It++);
1461       W.printString("Purpose", StringRef("Lazy resolver"));
1462     }
1463
1464     if (It != GotLocalEnd && (*It >> (sizeof(GOTEntry) * 8 - 1)) != 0) {
1465       DictScope D(W, "Entry");
1466       printGotEntry(GOTShdr->sh_addr, GotBegin, It++);
1467       W.printString("Purpose", StringRef("Module pointer (GNU extension)"));
1468     }
1469   }
1470   {
1471     ListScope LS(W, "Local entries");
1472     for (; It != GotLocalEnd; ++It) {
1473       DictScope D(W, "Entry");
1474       printGotEntry(GOTShdr->sh_addr, GotBegin, It);
1475     }
1476   }
1477   {
1478     ListScope GS(W, "Global entries");
1479
1480     GOTIter GotGlobalEnd = makeGOTIter(*GOT, *DtLocalGotNum + GlobalGotNum);
1481     const Elf_Sym *GotDynSym = DynSymBegin + *DtGotSym;
1482     for (; It != GotGlobalEnd; ++It) {
1483       DictScope D(W, "Entry");
1484       printGlobalGotEntry(GOTShdr->sh_addr, GotBegin, It, GotDynSym++,
1485                           *StrTable, true);
1486     }
1487   }
1488
1489   std::size_t SpecGotNum = getGOTTotal(*GOT) - *DtLocalGotNum - GlobalGotNum;
1490   W.printNumber("Number of TLS and multi-GOT entries", uint64_t(SpecGotNum));
1491 }
1492
1493 template <class ELFT> void MipsGOTParser<ELFT>::parsePLT() {
1494   if (!DtMipsPltGot) {
1495     W.startLine() << "Cannot find MIPS_PLTGOT dynamic table tag.\n";
1496     return;
1497   }
1498   if (!DtJmpRel) {
1499     W.startLine() << "Cannot find JMPREL dynamic table tag.\n";
1500     return;
1501   }
1502
1503   const Elf_Shdr *PLTShdr = findSectionByAddress(Obj, *DtMipsPltGot);
1504   if (!PLTShdr) {
1505     W.startLine() << "There is no .got.plt section in the file.\n";
1506     return;
1507   }
1508   ErrorOr<ArrayRef<uint8_t>> PLT = Obj->getSectionContents(PLTShdr);
1509   if (!PLT) {
1510     W.startLine() << "The .got.plt section is empty.\n";
1511     return;
1512   }
1513
1514   const Elf_Shdr *PLTRelShdr = findSectionByAddress(Obj, *DtJmpRel);
1515   if (!PLTShdr) {
1516     W.startLine() << "There is no .rel.plt section in the file.\n";
1517     return;
1518   }
1519   ErrorOr<const Elf_Shdr *> SymTableOrErr =
1520       Obj->getSection(PLTRelShdr->sh_link);
1521   error(SymTableOrErr.getError());
1522   ErrorOr<StringRef> StrTable = Obj->getStringTableForSymtab(**SymTableOrErr);
1523   error(StrTable.getError());
1524
1525   GOTIter PLTBegin = makeGOTIter(*PLT, 0);
1526   GOTIter PLTEnd = makeGOTIter(*PLT, getGOTTotal(*PLT));
1527   GOTIter It = PLTBegin;
1528
1529   DictScope GS(W, "PLT GOT");
1530   {
1531     ListScope RS(W, "Reserved entries");
1532     printPLTEntry(PLTShdr->sh_addr, PLTBegin, It++, "PLT lazy resolver");
1533     if (It != PLTEnd)
1534       printPLTEntry(PLTShdr->sh_addr, PLTBegin, It++, "Module pointer");
1535   }
1536   {
1537     ListScope GS(W, "Entries");
1538
1539     switch (PLTRelShdr->sh_type) {
1540     case ELF::SHT_REL:
1541       for (const typename ObjectFile::Elf_Rel *RI = Obj->rel_begin(PLTRelShdr),
1542                                               *RE = Obj->rel_end(PLTRelShdr);
1543            RI != RE && It != PLTEnd; ++RI, ++It) {
1544         const Elf_Sym *Sym =
1545             Obj->getRelocationSymbol(&*PLTRelShdr, &*RI).second;
1546         printPLTEntry(PLTShdr->sh_addr, PLTBegin, It, *StrTable, Sym);
1547       }
1548       break;
1549     case ELF::SHT_RELA:
1550       for (const typename ObjectFile::Elf_Rela
1551              *RI = Obj->rela_begin(PLTRelShdr),
1552              *RE = Obj->rela_end(PLTRelShdr);
1553            RI != RE && It != PLTEnd; ++RI, ++It) {
1554         const Elf_Sym *Sym =
1555             Obj->getRelocationSymbol(&*PLTRelShdr, &*RI).second;
1556         printPLTEntry(PLTShdr->sh_addr, PLTBegin, It, *StrTable, Sym);
1557       }
1558       break;
1559     }
1560   }
1561 }
1562
1563 template <class ELFT>
1564 std::size_t MipsGOTParser<ELFT>::getGOTTotal(ArrayRef<uint8_t> GOT) const {
1565   return GOT.size() / sizeof(GOTEntry);
1566 }
1567
1568 template <class ELFT>
1569 typename MipsGOTParser<ELFT>::GOTIter
1570 MipsGOTParser<ELFT>::makeGOTIter(ArrayRef<uint8_t> GOT, std::size_t EntryNum) {
1571   const char *Data = reinterpret_cast<const char *>(GOT.data());
1572   return GOTIter(sizeof(GOTEntry), Data + EntryNum * sizeof(GOTEntry));
1573 }
1574
1575 template <class ELFT>
1576 void MipsGOTParser<ELFT>::printGotEntry(uint64_t GotAddr, GOTIter BeginIt,
1577                                         GOTIter It) {
1578   int64_t Offset = std::distance(BeginIt, It) * sizeof(GOTEntry);
1579   W.printHex("Address", GotAddr + Offset);
1580   W.printNumber("Access", Offset - 0x7ff0);
1581   W.printHex("Initial", *It);
1582 }
1583
1584 template <class ELFT>
1585 void MipsGOTParser<ELFT>::printGlobalGotEntry(uint64_t GotAddr, GOTIter BeginIt,
1586                                               GOTIter It, const Elf_Sym *Sym,
1587                                               StringRef StrTable,
1588                                               bool IsDynamic) {
1589   printGotEntry(GotAddr, BeginIt, It);
1590
1591   W.printHex("Value", Sym->st_value);
1592   W.printEnum("Type", Sym->getType(), makeArrayRef(ElfSymbolTypes));
1593
1594   unsigned SectionIndex = 0;
1595   StringRef SectionName;
1596   getSectionNameIndex(*Obj, Sym, SectionName, SectionIndex);
1597   W.printHex("Section", SectionName, SectionIndex);
1598
1599   std::string FullSymbolName =
1600       getFullSymbolName(*Obj, Sym, StrTable, IsDynamic);
1601   W.printNumber("Name", FullSymbolName, Sym->st_name);
1602 }
1603
1604 template <class ELFT>
1605 void MipsGOTParser<ELFT>::printPLTEntry(uint64_t PLTAddr, GOTIter BeginIt,
1606                                         GOTIter It, StringRef Purpose) {
1607   DictScope D(W, "Entry");
1608   int64_t Offset = std::distance(BeginIt, It) * sizeof(GOTEntry);
1609   W.printHex("Address", PLTAddr + Offset);
1610   W.printHex("Initial", *It);
1611   W.printString("Purpose", Purpose);
1612 }
1613
1614 template <class ELFT>
1615 void MipsGOTParser<ELFT>::printPLTEntry(uint64_t PLTAddr, GOTIter BeginIt,
1616                                         GOTIter It, StringRef StrTable,
1617                                         const Elf_Sym *Sym) {
1618   DictScope D(W, "Entry");
1619   int64_t Offset = std::distance(BeginIt, It) * sizeof(GOTEntry);
1620   W.printHex("Address", PLTAddr + Offset);
1621   W.printHex("Initial", *It);
1622   W.printHex("Value", Sym->st_value);
1623   W.printEnum("Type", Sym->getType(), makeArrayRef(ElfSymbolTypes));
1624
1625   unsigned SectionIndex = 0;
1626   StringRef SectionName;
1627   getSectionNameIndex(*Obj, Sym, SectionName, SectionIndex);
1628   W.printHex("Section", SectionName, SectionIndex);
1629
1630   std::string FullSymbolName = getFullSymbolName(*Obj, Sym, StrTable, true);
1631   W.printNumber("Name", FullSymbolName, Sym->st_name);
1632 }
1633
1634 template <class ELFT> void ELFDumper<ELFT>::printMipsPLTGOT() {
1635   if (Obj->getHeader()->e_machine != EM_MIPS) {
1636     W.startLine() << "MIPS PLT GOT is available for MIPS targets only.\n";
1637     return;
1638   }
1639
1640   MipsGOTParser<ELFT> GOTParser(Obj, dynamic_table(), W);
1641   GOTParser.parseGOT();
1642   GOTParser.parsePLT();
1643 }
1644
1645 static const EnumEntry<unsigned> ElfMipsISAExtType[] = {
1646   {"None",                    Mips::AFL_EXT_NONE},
1647   {"Broadcom SB-1",           Mips::AFL_EXT_SB1},
1648   {"Cavium Networks Octeon",  Mips::AFL_EXT_OCTEON},
1649   {"Cavium Networks Octeon2", Mips::AFL_EXT_OCTEON2},
1650   {"Cavium Networks OcteonP", Mips::AFL_EXT_OCTEONP},
1651   {"Cavium Networks Octeon3", Mips::AFL_EXT_OCTEON3},
1652   {"LSI R4010",               Mips::AFL_EXT_4010},
1653   {"Loongson 2E",             Mips::AFL_EXT_LOONGSON_2E},
1654   {"Loongson 2F",             Mips::AFL_EXT_LOONGSON_2F},
1655   {"Loongson 3A",             Mips::AFL_EXT_LOONGSON_3A},
1656   {"MIPS R4650",              Mips::AFL_EXT_4650},
1657   {"MIPS R5900",              Mips::AFL_EXT_5900},
1658   {"MIPS R10000",             Mips::AFL_EXT_10000},
1659   {"NEC VR4100",              Mips::AFL_EXT_4100},
1660   {"NEC VR4111/VR4181",       Mips::AFL_EXT_4111},
1661   {"NEC VR4120",              Mips::AFL_EXT_4120},
1662   {"NEC VR5400",              Mips::AFL_EXT_5400},
1663   {"NEC VR5500",              Mips::AFL_EXT_5500},
1664   {"RMI Xlr",                 Mips::AFL_EXT_XLR},
1665   {"Toshiba R3900",           Mips::AFL_EXT_3900}
1666 };
1667
1668 static const EnumEntry<unsigned> ElfMipsASEFlags[] = {
1669   {"DSP",                Mips::AFL_ASE_DSP},
1670   {"DSPR2",              Mips::AFL_ASE_DSPR2},
1671   {"Enhanced VA Scheme", Mips::AFL_ASE_EVA},
1672   {"MCU",                Mips::AFL_ASE_MCU},
1673   {"MDMX",               Mips::AFL_ASE_MDMX},
1674   {"MIPS-3D",            Mips::AFL_ASE_MIPS3D},
1675   {"MT",                 Mips::AFL_ASE_MT},
1676   {"SmartMIPS",          Mips::AFL_ASE_SMARTMIPS},
1677   {"VZ",                 Mips::AFL_ASE_VIRT},
1678   {"MSA",                Mips::AFL_ASE_MSA},
1679   {"MIPS16",             Mips::AFL_ASE_MIPS16},
1680   {"microMIPS",          Mips::AFL_ASE_MICROMIPS},
1681   {"XPA",                Mips::AFL_ASE_XPA}
1682 };
1683
1684 static const EnumEntry<unsigned> ElfMipsFpABIType[] = {
1685   {"Hard or soft float",                  Mips::Val_GNU_MIPS_ABI_FP_ANY},
1686   {"Hard float (double precision)",       Mips::Val_GNU_MIPS_ABI_FP_DOUBLE},
1687   {"Hard float (single precision)",       Mips::Val_GNU_MIPS_ABI_FP_SINGLE},
1688   {"Soft float",                          Mips::Val_GNU_MIPS_ABI_FP_SOFT},
1689   {"Hard float (MIPS32r2 64-bit FPU 12 callee-saved)",
1690    Mips::Val_GNU_MIPS_ABI_FP_OLD_64},
1691   {"Hard float (32-bit CPU, Any FPU)",    Mips::Val_GNU_MIPS_ABI_FP_XX},
1692   {"Hard float (32-bit CPU, 64-bit FPU)", Mips::Val_GNU_MIPS_ABI_FP_64},
1693   {"Hard float compat (32-bit CPU, 64-bit FPU)",
1694    Mips::Val_GNU_MIPS_ABI_FP_64A}
1695 };
1696
1697 static const EnumEntry<unsigned> ElfMipsFlags1[] {
1698   {"ODDSPREG", Mips::AFL_FLAGS1_ODDSPREG},
1699 };
1700
1701 static int getMipsRegisterSize(uint8_t Flag) {
1702   switch (Flag) {
1703   case Mips::AFL_REG_NONE:
1704     return 0;
1705   case Mips::AFL_REG_32:
1706     return 32;
1707   case Mips::AFL_REG_64:
1708     return 64;
1709   case Mips::AFL_REG_128:
1710     return 128;
1711   default:
1712     return -1;
1713   }
1714 }
1715
1716 template <class ELFT> void ELFDumper<ELFT>::printMipsABIFlags() {
1717   const Elf_Shdr *Shdr = findSectionByName(*Obj, ".MIPS.abiflags");
1718   if (!Shdr) {
1719     W.startLine() << "There is no .MIPS.abiflags section in the file.\n";
1720     return;
1721   }
1722   ErrorOr<ArrayRef<uint8_t>> Sec = Obj->getSectionContents(Shdr);
1723   if (!Sec) {
1724     W.startLine() << "The .MIPS.abiflags section is empty.\n";
1725     return;
1726   }
1727   if (Sec->size() != sizeof(Elf_Mips_ABIFlags<ELFT>)) {
1728     W.startLine() << "The .MIPS.abiflags section has a wrong size.\n";
1729     return;
1730   }
1731
1732   auto *Flags = reinterpret_cast<const Elf_Mips_ABIFlags<ELFT> *>(Sec->data());
1733
1734   raw_ostream &OS = W.getOStream();
1735   DictScope GS(W, "MIPS ABI Flags");
1736
1737   W.printNumber("Version", Flags->version);
1738   W.startLine() << "ISA: ";
1739   if (Flags->isa_rev <= 1)
1740     OS << format("MIPS%u", Flags->isa_level);
1741   else
1742     OS << format("MIPS%ur%u", Flags->isa_level, Flags->isa_rev);
1743   OS << "\n";
1744   W.printEnum("ISA Extension", Flags->isa_ext, makeArrayRef(ElfMipsISAExtType));
1745   W.printFlags("ASEs", Flags->ases, makeArrayRef(ElfMipsASEFlags));
1746   W.printEnum("FP ABI", Flags->fp_abi, makeArrayRef(ElfMipsFpABIType));
1747   W.printNumber("GPR size", getMipsRegisterSize(Flags->gpr_size));
1748   W.printNumber("CPR1 size", getMipsRegisterSize(Flags->cpr1_size));
1749   W.printNumber("CPR2 size", getMipsRegisterSize(Flags->cpr2_size));
1750   W.printFlags("Flags 1", Flags->flags1, makeArrayRef(ElfMipsFlags1));
1751   W.printHex("Flags 2", Flags->flags2);
1752 }
1753
1754 template <class ELFT> void ELFDumper<ELFT>::printMipsReginfo() {
1755   const Elf_Shdr *Shdr = findSectionByName(*Obj, ".reginfo");
1756   if (!Shdr) {
1757     W.startLine() << "There is no .reginfo section in the file.\n";
1758     return;
1759   }
1760   ErrorOr<ArrayRef<uint8_t>> Sec = Obj->getSectionContents(Shdr);
1761   if (!Sec) {
1762     W.startLine() << "The .reginfo section is empty.\n";
1763     return;
1764   }
1765   if (Sec->size() != sizeof(Elf_Mips_RegInfo<ELFT>)) {
1766     W.startLine() << "The .reginfo section has a wrong size.\n";
1767     return;
1768   }
1769
1770   auto *Reginfo = reinterpret_cast<const Elf_Mips_RegInfo<ELFT> *>(Sec->data());
1771
1772   DictScope GS(W, "MIPS RegInfo");
1773   W.printHex("GP", Reginfo->ri_gp_value);
1774   W.printHex("General Mask", Reginfo->ri_gprmask);
1775   W.printHex("Co-Proc Mask0", Reginfo->ri_cprmask[0]);
1776   W.printHex("Co-Proc Mask1", Reginfo->ri_cprmask[1]);
1777   W.printHex("Co-Proc Mask2", Reginfo->ri_cprmask[2]);
1778   W.printHex("Co-Proc Mask3", Reginfo->ri_cprmask[3]);
1779 }
1780
1781 template <class ELFT> void ELFDumper<ELFT>::printStackMap() const {
1782   const typename ELFFile<ELFT>::Elf_Shdr *StackMapSection = nullptr;
1783   for (const auto &Sec : Obj->sections()) {
1784     ErrorOr<StringRef> Name = Obj->getSectionName(&Sec);
1785     if (*Name == ".llvm_stackmaps") {
1786       StackMapSection = &Sec;
1787       break;
1788     }
1789   }
1790
1791   if (!StackMapSection)
1792     return;
1793
1794   StringRef StackMapContents;
1795   ErrorOr<ArrayRef<uint8_t>> StackMapContentsArray =
1796     Obj->getSectionContents(StackMapSection);
1797
1798   prettyPrintStackMap(
1799               llvm::outs(),
1800               StackMapV1Parser<ELFT::TargetEndianness>(*StackMapContentsArray));
1801 }