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 "ARMAttributeParser.h"
16 #include "ARMEHABIPrinter.h"
17 #include "Error.h"
18 #include "ObjDumper.h"
19 #include "StackMapPrinter.h"
20 #include "llvm-readobj.h"
21 #include "llvm/ADT/Optional.h"
22 #include "llvm/ADT/SmallString.h"
23 #include "llvm/ADT/StringExtras.h"
24 #include "llvm/Object/ELFObjectFile.h"
25 #include "llvm/Support/ARMBuildAttributes.h"
26 #include "llvm/Support/Compiler.h"
27 #include "llvm/Support/Format.h"
28 #include "llvm/Support/FormattedStream.h"
29 #include "llvm/Support/MathExtras.h"
30 #include "llvm/Support/MipsABIFlags.h"
31 #include "llvm/Support/ScopedPrinter.h"
32 #include "llvm/Support/raw_ostream.h"
33 
34 using namespace llvm;
35 using namespace llvm::object;
36 using namespace ELF;
37 
38 #define LLVM_READOBJ_ENUM_CASE(ns, enum) \
39   case ns::enum: return #enum;
40 
41 #define ENUM_ENT(enum, altName) \
42   { #enum, altName, ELF::enum }
43 
44 #define ENUM_ENT_1(enum) \
45   { #enum, #enum, ELF::enum }
46 
47 #define LLVM_READOBJ_PHDR_ENUM(ns, enum)                                       \
48   case ns::enum:                                                               \
49     return std::string(#enum).substr(3);
50 
51 #define TYPEDEF_ELF_TYPES(ELFT)                                                \
52   typedef ELFFile<ELFT> ELFO;                                                  \
53   typedef typename ELFO::Elf_Shdr Elf_Shdr;                                    \
54   typedef typename ELFO::Elf_Sym Elf_Sym;                                      \
55   typedef typename ELFO::Elf_Dyn Elf_Dyn;                                      \
56   typedef typename ELFO::Elf_Dyn_Range Elf_Dyn_Range;                          \
57   typedef typename ELFO::Elf_Rel Elf_Rel;                                      \
58   typedef typename ELFO::Elf_Rela Elf_Rela;                                    \
59   typedef typename ELFO::Elf_Rela_Range Elf_Rela_Range;                        \
60   typedef typename ELFO::Elf_Phdr Elf_Phdr;                                    \
61   typedef typename ELFO::Elf_Half Elf_Half;                                    \
62   typedef typename ELFO::Elf_Ehdr Elf_Ehdr;                                    \
63   typedef typename ELFO::Elf_Word Elf_Word;                                    \
64   typedef typename ELFO::Elf_Hash Elf_Hash;                                    \
65   typedef typename ELFO::Elf_GnuHash Elf_GnuHash;                              \
66   typedef typename ELFO::uintX_t uintX_t;
67 
68 namespace {
69 
70 template <class ELFT> class DumpStyle;
71 
72 /// Represents a contiguous uniform range in the file. We cannot just create a
73 /// range directly because when creating one of these from the .dynamic table
74 /// the size, entity size and virtual address are different entries in arbitrary
75 /// order (DT_REL, DT_RELSZ, DT_RELENT for example).
76 struct DynRegionInfo {
77   DynRegionInfo() : Addr(nullptr), Size(0), EntSize(0) {}
78   DynRegionInfo(const void *A, uint64_t S, uint64_t ES)
79       : Addr(A), Size(S), EntSize(ES) {}
80   /// \brief Address in current address space.
81   const void *Addr;
82   /// \brief Size in bytes of the region.
83   uint64_t Size;
84   /// \brief Size of each entity in the region.
85   uint64_t EntSize;
86 
87   template <typename Type> ArrayRef<Type> getAsArrayRef() const {
88     const Type *Start = reinterpret_cast<const Type *>(Addr);
89     if (!Start)
90       return {Start, Start};
91     if (EntSize != sizeof(Type) || Size % EntSize)
92       reportError("Invalid entity size");
93     return {Start, Start + (Size / EntSize)};
94   }
95 };
96 
97 template<typename ELFT>
98 class ELFDumper : public ObjDumper {
99 public:
100   ELFDumper(const ELFFile<ELFT> *Obj, ScopedPrinter &Writer);
101 
102   void printFileHeaders() override;
103   void printSections() override;
104   void printRelocations() override;
105   void printDynamicRelocations() override;
106   void printSymbols() override;
107   void printDynamicSymbols() override;
108   void printUnwindInfo() override;
109 
110   void printDynamicTable() override;
111   void printNeededLibraries() override;
112   void printProgramHeaders() override;
113   void printHashTable() override;
114   void printGnuHashTable() override;
115   void printLoadName() override;
116   void printVersionInfo() override;
117   void printGroupSections() override;
118 
119   void printAttributes() override;
120   void printMipsPLTGOT() override;
121   void printMipsABIFlags() override;
122   void printMipsReginfo() override;
123   void printMipsOptions() override;
124 
125   void printStackMap() const override;
126 
127   void printHashHistogram() override;
128 
129 private:
130   std::unique_ptr<DumpStyle<ELFT>> ELFDumperStyle;
131   typedef ELFFile<ELFT> ELFO;
132   typedef typename ELFO::Elf_Shdr Elf_Shdr;
133   typedef typename ELFO::Elf_Sym Elf_Sym;
134   typedef typename ELFO::Elf_Sym_Range Elf_Sym_Range;
135   typedef typename ELFO::Elf_Dyn Elf_Dyn;
136   typedef typename ELFO::Elf_Dyn_Range Elf_Dyn_Range;
137   typedef typename ELFO::Elf_Rel Elf_Rel;
138   typedef typename ELFO::Elf_Rela Elf_Rela;
139   typedef typename ELFO::Elf_Rel_Range Elf_Rel_Range;
140   typedef typename ELFO::Elf_Rela_Range Elf_Rela_Range;
141   typedef typename ELFO::Elf_Phdr Elf_Phdr;
142   typedef typename ELFO::Elf_Half Elf_Half;
143   typedef typename ELFO::Elf_Hash Elf_Hash;
144   typedef typename ELFO::Elf_GnuHash Elf_GnuHash;
145   typedef typename ELFO::Elf_Ehdr Elf_Ehdr;
146   typedef typename ELFO::Elf_Word Elf_Word;
147   typedef typename ELFO::uintX_t uintX_t;
148   typedef typename ELFO::Elf_Versym Elf_Versym;
149   typedef typename ELFO::Elf_Verneed Elf_Verneed;
150   typedef typename ELFO::Elf_Vernaux Elf_Vernaux;
151   typedef typename ELFO::Elf_Verdef Elf_Verdef;
152   typedef typename ELFO::Elf_Verdaux Elf_Verdaux;
153 
154   DynRegionInfo checkDRI(DynRegionInfo DRI) {
155     if (DRI.Addr < Obj->base() ||
156         (const uint8_t *)DRI.Addr + DRI.Size > Obj->base() + Obj->getBufSize())
157       error(llvm::object::object_error::parse_failed);
158     return DRI;
159   }
160 
161   DynRegionInfo createDRIFrom(const Elf_Phdr *P, uintX_t EntSize) {
162     return checkDRI({Obj->base() + P->p_offset, P->p_filesz, EntSize});
163   }
164 
165   DynRegionInfo createDRIFrom(const Elf_Shdr *S) {
166     return checkDRI({Obj->base() + S->sh_offset, S->sh_size, S->sh_entsize});
167   }
168 
169   void parseDynamicTable(ArrayRef<const Elf_Phdr *> LoadSegments);
170 
171   void printValue(uint64_t Type, uint64_t Value);
172 
173   StringRef getDynamicString(uint64_t Offset) const;
174   StringRef getSymbolVersion(StringRef StrTab, const Elf_Sym *symb,
175                              bool &IsDefault) const;
176   void LoadVersionMap() const;
177   void LoadVersionNeeds(const Elf_Shdr *ec) const;
178   void LoadVersionDefs(const Elf_Shdr *sec) const;
179 
180   const ELFO *Obj;
181   DynRegionInfo DynRelRegion;
182   DynRegionInfo DynRelaRegion;
183   DynRegionInfo DynPLTRelRegion;
184   DynRegionInfo DynSymRegion;
185   DynRegionInfo DynamicTable;
186   StringRef DynamicStringTable;
187   StringRef SOName;
188   const Elf_Hash *HashTable = nullptr;
189   const Elf_GnuHash *GnuHashTable = nullptr;
190   const Elf_Shdr *DotSymtabSec = nullptr;
191   StringRef DynSymtabName;
192   ArrayRef<Elf_Word> ShndxTable;
193 
194   const Elf_Shdr *dot_gnu_version_sec = nullptr;   // .gnu.version
195   const Elf_Shdr *dot_gnu_version_r_sec = nullptr; // .gnu.version_r
196   const Elf_Shdr *dot_gnu_version_d_sec = nullptr; // .gnu.version_d
197 
198   // Records for each version index the corresponding Verdef or Vernaux entry.
199   // This is filled the first time LoadVersionMap() is called.
200   class VersionMapEntry : public PointerIntPair<const void *, 1> {
201   public:
202     // If the integer is 0, this is an Elf_Verdef*.
203     // If the integer is 1, this is an Elf_Vernaux*.
204     VersionMapEntry() : PointerIntPair<const void *, 1>(nullptr, 0) {}
205     VersionMapEntry(const Elf_Verdef *verdef)
206         : PointerIntPair<const void *, 1>(verdef, 0) {}
207     VersionMapEntry(const Elf_Vernaux *vernaux)
208         : PointerIntPair<const void *, 1>(vernaux, 1) {}
209     bool isNull() const { return getPointer() == nullptr; }
210     bool isVerdef() const { return !isNull() && getInt() == 0; }
211     bool isVernaux() const { return !isNull() && getInt() == 1; }
212     const Elf_Verdef *getVerdef() const {
213       return isVerdef() ? (const Elf_Verdef *)getPointer() : nullptr;
214     }
215     const Elf_Vernaux *getVernaux() const {
216       return isVernaux() ? (const Elf_Vernaux *)getPointer() : nullptr;
217     }
218   };
219   mutable SmallVector<VersionMapEntry, 16> VersionMap;
220 
221 public:
222   Elf_Dyn_Range dynamic_table() const {
223     return DynamicTable.getAsArrayRef<Elf_Dyn>();
224   }
225 
226   Elf_Sym_Range dynamic_symbols() const {
227     return DynSymRegion.getAsArrayRef<Elf_Sym>();
228   }
229 
230   Elf_Rel_Range dyn_rels() const;
231   Elf_Rela_Range dyn_relas() const;
232   std::string getFullSymbolName(const Elf_Sym *Symbol, StringRef StrTable,
233                                 bool IsDynamic) const;
234 
235   void printSymbolsHelper(bool IsDynamic) const;
236   const Elf_Shdr *getDotSymtabSec() const { return DotSymtabSec; }
237   ArrayRef<Elf_Word> getShndxTable() const { return ShndxTable; }
238   StringRef getDynamicStringTable() const { return DynamicStringTable; }
239   const DynRegionInfo &getDynRelRegion() const { return DynRelRegion; }
240   const DynRegionInfo &getDynRelaRegion() const { return DynRelaRegion; }
241   const DynRegionInfo &getDynPLTRelRegion() const { return DynPLTRelRegion; }
242   const Elf_Hash *getHashTable() const { return HashTable; }
243   const Elf_GnuHash *getGnuHashTable() const { return GnuHashTable; }
244 };
245 
246 template <class ELFT>
247 void ELFDumper<ELFT>::printSymbolsHelper(bool IsDynamic) const {
248   StringRef StrTable, SymtabName;
249   size_t Entries = 0;
250   Elf_Sym_Range Syms(nullptr, nullptr);
251   if (IsDynamic) {
252     StrTable = DynamicStringTable;
253     Syms = dynamic_symbols();
254     SymtabName = DynSymtabName;
255     if (DynSymRegion.Addr)
256       Entries = DynSymRegion.Size / DynSymRegion.EntSize;
257   } else {
258     if (!DotSymtabSec)
259       return;
260     StrTable = unwrapOrError(Obj->getStringTableForSymtab(*DotSymtabSec));
261     Syms = Obj->symbols(DotSymtabSec);
262     SymtabName = unwrapOrError(Obj->getSectionName(DotSymtabSec));
263     Entries = DotSymtabSec->getEntityCount();
264   }
265   if (Syms.begin() == Syms.end())
266     return;
267   ELFDumperStyle->printSymtabMessage(Obj, SymtabName, Entries);
268   for (const auto &Sym : Syms)
269     ELFDumperStyle->printSymbol(Obj, &Sym, Syms.begin(), StrTable, IsDynamic);
270 }
271 
272 template <typename ELFT> class DumpStyle {
273 public:
274   using Elf_Shdr = typename ELFFile<ELFT>::Elf_Shdr;
275   using Elf_Sym =  typename ELFFile<ELFT>::Elf_Sym;
276 
277   DumpStyle(ELFDumper<ELFT> *Dumper) : Dumper(Dumper) {}
278   virtual ~DumpStyle() {}
279   virtual void printFileHeaders(const ELFFile<ELFT> *Obj) = 0;
280   virtual void printGroupSections(const ELFFile<ELFT> *Obj) = 0;
281   virtual void printRelocations(const ELFFile<ELFT> *Obj) = 0;
282   virtual void printSections(const ELFFile<ELFT> *Obj) = 0;
283   virtual void printSymbols(const ELFFile<ELFT> *Obj) = 0;
284   virtual void printDynamicSymbols(const ELFFile<ELFT> *Obj) = 0;
285   virtual void printDynamicRelocations(const ELFFile<ELFT> *Obj) = 0;
286   virtual void printSymtabMessage(const ELFFile<ELFT> *obj, StringRef Name,
287                                   size_t Offset) {
288     return;
289   }
290   virtual void printSymbol(const ELFFile<ELFT> *Obj, const Elf_Sym *Symbol,
291                            const Elf_Sym *FirstSym, StringRef StrTable,
292                            bool IsDynamic) = 0;
293   virtual void printProgramHeaders(const ELFFile<ELFT> *Obj) = 0;
294   virtual void printHashHistogram(const ELFFile<ELFT> *Obj) = 0;
295   const ELFDumper<ELFT> *dumper() const { return Dumper; }
296 private:
297   const ELFDumper<ELFT> *Dumper;
298 };
299 
300 template <typename ELFT> class GNUStyle : public DumpStyle<ELFT> {
301   formatted_raw_ostream OS;
302 public:
303   TYPEDEF_ELF_TYPES(ELFT)
304   GNUStyle(ScopedPrinter &W, ELFDumper<ELFT> *Dumper)
305       : DumpStyle<ELFT>(Dumper), OS(W.getOStream()) {}
306   void printFileHeaders(const ELFO *Obj) override;
307   void printGroupSections(const ELFFile<ELFT> *Obj) override;
308   void printRelocations(const ELFO *Obj) override;
309   void printSections(const ELFO *Obj) override;
310   void printSymbols(const ELFO *Obj) override;
311   void printDynamicSymbols(const ELFO *Obj) override;
312   void printDynamicRelocations(const ELFO *Obj) override;
313   virtual void printSymtabMessage(const ELFO *Obj, StringRef Name,
314                                   size_t Offset) override;
315   void printProgramHeaders(const ELFO *Obj) override;
316   void printHashHistogram(const ELFFile<ELFT> *Obj) override;
317 
318 private:
319   struct Field {
320     StringRef Str;
321     unsigned Column;
322     Field(StringRef S, unsigned Col) : Str(S), Column(Col) {}
323     Field(unsigned Col) : Str(""), Column(Col) {}
324   };
325 
326   template <typename T, typename TEnum>
327   std::string printEnum(T Value, ArrayRef<EnumEntry<TEnum>> EnumValues) {
328     for (const auto &EnumItem : EnumValues)
329       if (EnumItem.Value == Value)
330         return EnumItem.AltName;
331     return to_hexString(Value, false);
332   }
333 
334   formatted_raw_ostream &printField(struct Field F) {
335     if (F.Column != 0)
336       OS.PadToColumn(F.Column);
337     OS << F.Str;
338     OS.flush();
339     return OS;
340   }
341   void printRelocation(const ELFO *Obj, const Elf_Shdr *SymTab,
342                        const Elf_Rela &R, bool IsRela);
343   void printSymbol(const ELFO *Obj, const Elf_Sym *Symbol, const Elf_Sym *First,
344                    StringRef StrTable, bool IsDynamic) override;
345   std::string getSymbolSectionNdx(const ELFO *Obj, const Elf_Sym *Symbol,
346                                   const Elf_Sym *FirstSym);
347   void printDynamicRelocation(const ELFO *Obj, Elf_Rela R, bool IsRela);
348   bool checkTLSSections(const Elf_Phdr &Phdr, const Elf_Shdr &Sec);
349   bool checkoffsets(const Elf_Phdr &Phdr, const Elf_Shdr &Sec);
350   bool checkVMA(const Elf_Phdr &Phdr, const Elf_Shdr &Sec);
351   bool checkPTDynamic(const Elf_Phdr &Phdr, const Elf_Shdr &Sec);
352 };
353 
354 template <typename ELFT> class LLVMStyle : public DumpStyle<ELFT> {
355 public:
356   TYPEDEF_ELF_TYPES(ELFT)
357   LLVMStyle(ScopedPrinter &W, ELFDumper<ELFT> *Dumper)
358       : DumpStyle<ELFT>(Dumper), W(W) {}
359 
360   void printFileHeaders(const ELFO *Obj) override;
361   void printGroupSections(const ELFFile<ELFT> *Obj) override;
362   void printRelocations(const ELFO *Obj) override;
363   void printRelocations(const Elf_Shdr *Sec, const ELFO *Obj);
364   void printSections(const ELFO *Obj) override;
365   void printSymbols(const ELFO *Obj) override;
366   void printDynamicSymbols(const ELFO *Obj) override;
367   void printDynamicRelocations(const ELFO *Obj) override;
368   void printProgramHeaders(const ELFO *Obj) override;
369   void printHashHistogram(const ELFFile<ELFT> *Obj) override;
370 
371 private:
372   void printRelocation(const ELFO *Obj, Elf_Rela Rel, const Elf_Shdr *SymTab);
373   void printDynamicRelocation(const ELFO *Obj, Elf_Rela Rel);
374   void printSymbol(const ELFO *Obj, const Elf_Sym *Symbol, const Elf_Sym *First,
375                    StringRef StrTable, bool IsDynamic) override;
376   ScopedPrinter &W;
377 };
378 
379 } // namespace
380 
381 namespace llvm {
382 
383 template <class ELFT>
384 static std::error_code createELFDumper(const ELFFile<ELFT> *Obj,
385                                        ScopedPrinter &Writer,
386                                        std::unique_ptr<ObjDumper> &Result) {
387   Result.reset(new ELFDumper<ELFT>(Obj, Writer));
388   return readobj_error::success;
389 }
390 
391 std::error_code createELFDumper(const object::ObjectFile *Obj,
392                                 ScopedPrinter &Writer,
393                                 std::unique_ptr<ObjDumper> &Result) {
394   // Little-endian 32-bit
395   if (const ELF32LEObjectFile *ELFObj = dyn_cast<ELF32LEObjectFile>(Obj))
396     return createELFDumper(ELFObj->getELFFile(), Writer, Result);
397 
398   // Big-endian 32-bit
399   if (const ELF32BEObjectFile *ELFObj = dyn_cast<ELF32BEObjectFile>(Obj))
400     return createELFDumper(ELFObj->getELFFile(), Writer, Result);
401 
402   // Little-endian 64-bit
403   if (const ELF64LEObjectFile *ELFObj = dyn_cast<ELF64LEObjectFile>(Obj))
404     return createELFDumper(ELFObj->getELFFile(), Writer, Result);
405 
406   // Big-endian 64-bit
407   if (const ELF64BEObjectFile *ELFObj = dyn_cast<ELF64BEObjectFile>(Obj))
408     return createELFDumper(ELFObj->getELFFile(), Writer, Result);
409 
410   return readobj_error::unsupported_obj_file_format;
411 }
412 
413 } // namespace llvm
414 
415 // Iterate through the versions needed section, and place each Elf_Vernaux
416 // in the VersionMap according to its index.
417 template <class ELFT>
418 void ELFDumper<ELFT>::LoadVersionNeeds(const Elf_Shdr *sec) const {
419   unsigned vn_size = sec->sh_size;  // Size of section in bytes
420   unsigned vn_count = sec->sh_info; // Number of Verneed entries
421   const char *sec_start = (const char *)Obj->base() + sec->sh_offset;
422   const char *sec_end = sec_start + vn_size;
423   // The first Verneed entry is at the start of the section.
424   const char *p = sec_start;
425   for (unsigned i = 0; i < vn_count; i++) {
426     if (p + sizeof(Elf_Verneed) > sec_end)
427       report_fatal_error("Section ended unexpectedly while scanning "
428                          "version needed records.");
429     const Elf_Verneed *vn = reinterpret_cast<const Elf_Verneed *>(p);
430     if (vn->vn_version != ELF::VER_NEED_CURRENT)
431       report_fatal_error("Unexpected verneed version");
432     // Iterate through the Vernaux entries
433     const char *paux = p + vn->vn_aux;
434     for (unsigned j = 0; j < vn->vn_cnt; j++) {
435       if (paux + sizeof(Elf_Vernaux) > sec_end)
436         report_fatal_error("Section ended unexpected while scanning auxiliary "
437                            "version needed records.");
438       const Elf_Vernaux *vna = reinterpret_cast<const Elf_Vernaux *>(paux);
439       size_t index = vna->vna_other & ELF::VERSYM_VERSION;
440       if (index >= VersionMap.size())
441         VersionMap.resize(index + 1);
442       VersionMap[index] = VersionMapEntry(vna);
443       paux += vna->vna_next;
444     }
445     p += vn->vn_next;
446   }
447 }
448 
449 // Iterate through the version definitions, and place each Elf_Verdef
450 // in the VersionMap according to its index.
451 template <class ELFT>
452 void ELFDumper<ELFT>::LoadVersionDefs(const Elf_Shdr *sec) const {
453   unsigned vd_size = sec->sh_size;  // Size of section in bytes
454   unsigned vd_count = sec->sh_info; // Number of Verdef entries
455   const char *sec_start = (const char *)Obj->base() + sec->sh_offset;
456   const char *sec_end = sec_start + vd_size;
457   // The first Verdef entry is at the start of the section.
458   const char *p = sec_start;
459   for (unsigned i = 0; i < vd_count; i++) {
460     if (p + sizeof(Elf_Verdef) > sec_end)
461       report_fatal_error("Section ended unexpectedly while scanning "
462                          "version definitions.");
463     const Elf_Verdef *vd = reinterpret_cast<const Elf_Verdef *>(p);
464     if (vd->vd_version != ELF::VER_DEF_CURRENT)
465       report_fatal_error("Unexpected verdef version");
466     size_t index = vd->vd_ndx & ELF::VERSYM_VERSION;
467     if (index >= VersionMap.size())
468       VersionMap.resize(index + 1);
469     VersionMap[index] = VersionMapEntry(vd);
470     p += vd->vd_next;
471   }
472 }
473 
474 template <class ELFT> void ELFDumper<ELFT>::LoadVersionMap() const {
475   // If there is no dynamic symtab or version table, there is nothing to do.
476   if (!DynSymRegion.Addr || !dot_gnu_version_sec)
477     return;
478 
479   // Has the VersionMap already been loaded?
480   if (VersionMap.size() > 0)
481     return;
482 
483   // The first two version indexes are reserved.
484   // Index 0 is LOCAL, index 1 is GLOBAL.
485   VersionMap.push_back(VersionMapEntry());
486   VersionMap.push_back(VersionMapEntry());
487 
488   if (dot_gnu_version_d_sec)
489     LoadVersionDefs(dot_gnu_version_d_sec);
490 
491   if (dot_gnu_version_r_sec)
492     LoadVersionNeeds(dot_gnu_version_r_sec);
493 }
494 
495 template <typename ELFO, class ELFT>
496 static void printVersionSymbolSection(ELFDumper<ELFT> *Dumper, const ELFO *Obj,
497                                       const typename ELFO::Elf_Shdr *Sec,
498                                       ScopedPrinter &W) {
499   DictScope SS(W, "Version symbols");
500   if (!Sec)
501     return;
502   StringRef Name = unwrapOrError(Obj->getSectionName(Sec));
503   W.printNumber("Section Name", Name, Sec->sh_name);
504   W.printHex("Address", Sec->sh_addr);
505   W.printHex("Offset", Sec->sh_offset);
506   W.printNumber("Link", Sec->sh_link);
507 
508   const uint8_t *P = (const uint8_t *)Obj->base() + Sec->sh_offset;
509   StringRef StrTable = Dumper->getDynamicStringTable();
510 
511   // Same number of entries in the dynamic symbol table (DT_SYMTAB).
512   ListScope Syms(W, "Symbols");
513   for (const typename ELFO::Elf_Sym &Sym : Dumper->dynamic_symbols()) {
514     DictScope S(W, "Symbol");
515     std::string FullSymbolName =
516         Dumper->getFullSymbolName(&Sym, StrTable, true /* IsDynamic */);
517     W.printNumber("Version", *P);
518     W.printString("Name", FullSymbolName);
519     P += sizeof(typename ELFO::Elf_Half);
520   }
521 }
522 
523 static const EnumEntry<unsigned> SymVersionFlags[] = {
524     {"Base", "BASE", VER_FLG_BASE},
525     {"Weak", "WEAK", VER_FLG_WEAK},
526     {"Info", "INFO", VER_FLG_INFO}};
527 
528 template <typename ELFO, class ELFT>
529 static void printVersionDefinitionSection(ELFDumper<ELFT> *Dumper,
530                                           const ELFO *Obj,
531                                           const typename ELFO::Elf_Shdr *Sec,
532                                           ScopedPrinter &W) {
533   DictScope SD(W, "Version definition");
534   if (!Sec)
535     return;
536   StringRef Name = unwrapOrError(Obj->getSectionName(Sec));
537   W.printNumber("Section Name", Name, Sec->sh_name);
538   W.printHex("Address", Sec->sh_addr);
539   W.printHex("Offset", Sec->sh_offset);
540   W.printNumber("Link", Sec->sh_link);
541 
542   unsigned verdef_entries = 0;
543   // The number of entries in the section SHT_GNU_verdef
544   // is determined by DT_VERDEFNUM tag.
545   for (const typename ELFO::Elf_Dyn &Dyn : Dumper->dynamic_table()) {
546     if (Dyn.d_tag == DT_VERDEFNUM)
547       verdef_entries = Dyn.d_un.d_val;
548   }
549   const uint8_t *SecStartAddress =
550       (const uint8_t *)Obj->base() + Sec->sh_offset;
551   const uint8_t *SecEndAddress = SecStartAddress + Sec->sh_size;
552   const uint8_t *P = SecStartAddress;
553   const typename ELFO::Elf_Shdr *StrTab =
554       unwrapOrError(Obj->getSection(Sec->sh_link));
555 
556   ListScope Entries(W, "Entries");
557   for (unsigned i = 0; i < verdef_entries; ++i) {
558     if (P + sizeof(typename ELFO::Elf_Verdef) > SecEndAddress)
559       report_fatal_error("invalid offset in the section");
560     auto *VD = reinterpret_cast<const typename ELFO::Elf_Verdef *>(P);
561     DictScope Entry(W, "Entry");
562     W.printHex("Offset", (uintptr_t)P - (uintptr_t)SecStartAddress);
563     W.printNumber("Rev", VD->vd_version);
564     // FIXME: print something more readable.
565     W.printNumber("Flags", VD->vd_flags);
566     W.printNumber("Index", VD->vd_ndx);
567     W.printNumber("Cnt", VD->vd_cnt);
568     W.printNumber("Hash", VD->vd_hash);
569     W.printString("Name",
570                   StringRef((const char *)(Obj->base() + StrTab->sh_offset +
571                                            VD->getAux()->vda_name)));
572     P += VD->vd_next;
573   }
574 }
575 
576 template <typename ELFO, class ELFT>
577 static void printVersionDependencySection(ELFDumper<ELFT> *Dumper,
578                                           const ELFO *Obj,
579                                           const typename ELFO::Elf_Shdr *Sec,
580                                           ScopedPrinter &W) {
581   typedef typename ELFO::Elf_Verneed VerNeed;
582   typedef typename ELFO::Elf_Vernaux VernAux;
583 
584   DictScope SD(W, "SHT_GNU_verneed");
585   if (!Sec)
586     return;
587 
588   unsigned VerNeedNum = 0;
589   for (const typename ELFO::Elf_Dyn &Dyn : Dumper->dynamic_table())
590     if (Dyn.d_tag == DT_VERNEEDNUM)
591       VerNeedNum = Dyn.d_un.d_val;
592 
593   const uint8_t *SecData = (const uint8_t *)Obj->base() + Sec->sh_offset;
594   const typename ELFO::Elf_Shdr *StrTab =
595       unwrapOrError(Obj->getSection(Sec->sh_link));
596 
597   const uint8_t *P = SecData;
598   for (unsigned I = 0; I < VerNeedNum; ++I) {
599     const VerNeed *Need = reinterpret_cast<const VerNeed *>(P);
600     DictScope Entry(W, "Dependency");
601     W.printNumber("Version", Need->vn_version);
602     W.printNumber("Count", Need->vn_cnt);
603     W.printString("FileName",
604                   StringRef((const char *)(Obj->base() + StrTab->sh_offset +
605                                            Need->vn_file)));
606 
607     const uint8_t *PAux = P + Need->vn_aux;
608     for (unsigned J = 0; J < Need->vn_cnt; ++J) {
609       const VernAux *Aux = reinterpret_cast<const VernAux *>(PAux);
610       DictScope Entry(W, "Entry");
611       W.printNumber("Hash", Aux->vna_hash);
612       W.printEnum("Flags", Aux->vna_flags, makeArrayRef(SymVersionFlags));
613       W.printNumber("Index", Aux->vna_other);
614       W.printString("Name",
615                     StringRef((const char *)(Obj->base() + StrTab->sh_offset +
616                                              Aux->vna_name)));
617       PAux += Aux->vna_next;
618     }
619     P += Need->vn_next;
620   }
621 }
622 
623 template <typename ELFT> void ELFDumper<ELFT>::printVersionInfo() {
624   // Dump version symbol section.
625   printVersionSymbolSection(this, Obj, dot_gnu_version_sec, W);
626 
627   // Dump version definition section.
628   printVersionDefinitionSection(this, Obj, dot_gnu_version_d_sec, W);
629 
630   // Dump version dependency section.
631   printVersionDependencySection(this, Obj, dot_gnu_version_r_sec, W);
632 }
633 
634 template <typename ELFT>
635 StringRef ELFDumper<ELFT>::getSymbolVersion(StringRef StrTab,
636                                             const Elf_Sym *symb,
637                                             bool &IsDefault) const {
638   // This is a dynamic symbol. Look in the GNU symbol version table.
639   if (!dot_gnu_version_sec) {
640     // No version table.
641     IsDefault = false;
642     return StringRef("");
643   }
644 
645   // Determine the position in the symbol table of this entry.
646   size_t entry_index = (reinterpret_cast<uintptr_t>(symb) -
647                         reinterpret_cast<uintptr_t>(DynSymRegion.Addr)) /
648                        sizeof(Elf_Sym);
649 
650   // Get the corresponding version index entry
651   const Elf_Versym *vs =
652       Obj->template getEntry<Elf_Versym>(dot_gnu_version_sec, entry_index);
653   size_t version_index = vs->vs_index & ELF::VERSYM_VERSION;
654 
655   // Special markers for unversioned symbols.
656   if (version_index == ELF::VER_NDX_LOCAL ||
657       version_index == ELF::VER_NDX_GLOBAL) {
658     IsDefault = false;
659     return StringRef("");
660   }
661 
662   // Lookup this symbol in the version table
663   LoadVersionMap();
664   if (version_index >= VersionMap.size() || VersionMap[version_index].isNull())
665     reportError("Invalid version entry");
666   const VersionMapEntry &entry = VersionMap[version_index];
667 
668   // Get the version name string
669   size_t name_offset;
670   if (entry.isVerdef()) {
671     // The first Verdaux entry holds the name.
672     name_offset = entry.getVerdef()->getAux()->vda_name;
673     IsDefault = !(vs->vs_index & ELF::VERSYM_HIDDEN);
674   } else {
675     name_offset = entry.getVernaux()->vna_name;
676     IsDefault = false;
677   }
678   if (name_offset >= StrTab.size())
679     reportError("Invalid string offset");
680   return StringRef(StrTab.data() + name_offset);
681 }
682 
683 template <typename ELFT>
684 std::string ELFDumper<ELFT>::getFullSymbolName(const Elf_Sym *Symbol,
685                                                StringRef StrTable,
686                                                bool IsDynamic) const {
687   StringRef SymbolName = unwrapOrError(Symbol->getName(StrTable));
688   if (!IsDynamic)
689     return SymbolName;
690 
691   std::string FullSymbolName(SymbolName);
692 
693   bool IsDefault;
694   StringRef Version = getSymbolVersion(StrTable, &*Symbol, IsDefault);
695   FullSymbolName += (IsDefault ? "@@" : "@");
696   FullSymbolName += Version;
697   return FullSymbolName;
698 }
699 
700 template <typename ELFO>
701 static void
702 getSectionNameIndex(const ELFO &Obj, const typename ELFO::Elf_Sym *Symbol,
703                     const typename ELFO::Elf_Sym *FirstSym,
704                     ArrayRef<typename ELFO::Elf_Word> ShndxTable,
705                     StringRef &SectionName, unsigned &SectionIndex) {
706   SectionIndex = Symbol->st_shndx;
707   if (Symbol->isUndefined())
708     SectionName = "Undefined";
709   else if (Symbol->isProcessorSpecific())
710     SectionName = "Processor Specific";
711   else if (Symbol->isOSSpecific())
712     SectionName = "Operating System Specific";
713   else if (Symbol->isAbsolute())
714     SectionName = "Absolute";
715   else if (Symbol->isCommon())
716     SectionName = "Common";
717   else if (Symbol->isReserved() && SectionIndex != SHN_XINDEX)
718     SectionName = "Reserved";
719   else {
720     if (SectionIndex == SHN_XINDEX)
721       SectionIndex =
722           Obj.getExtendedSymbolTableIndex(Symbol, FirstSym, ShndxTable);
723     const typename ELFO::Elf_Shdr *Sec =
724         unwrapOrError(Obj.getSection(SectionIndex));
725     SectionName = unwrapOrError(Obj.getSectionName(Sec));
726   }
727 }
728 
729 template <class ELFO>
730 static const typename ELFO::Elf_Shdr *
731 findNotEmptySectionByAddress(const ELFO *Obj, uint64_t Addr) {
732   for (const auto &Shdr : Obj->sections())
733     if (Shdr.sh_addr == Addr && Shdr.sh_size > 0)
734       return &Shdr;
735   return nullptr;
736 }
737 
738 template <class ELFO>
739 static const typename ELFO::Elf_Shdr *findSectionByName(const ELFO &Obj,
740                                                         StringRef Name) {
741   for (const auto &Shdr : Obj.sections()) {
742     if (Name == unwrapOrError(Obj.getSectionName(&Shdr)))
743       return &Shdr;
744   }
745   return nullptr;
746 }
747 
748 static const EnumEntry<unsigned> ElfClass[] = {
749   {"None",   "none",   ELF::ELFCLASSNONE},
750   {"32-bit", "ELF32",  ELF::ELFCLASS32},
751   {"64-bit", "ELF64",  ELF::ELFCLASS64},
752 };
753 
754 static const EnumEntry<unsigned> ElfDataEncoding[] = {
755   {"None",         "none",                          ELF::ELFDATANONE},
756   {"LittleEndian", "2's complement, little endian", ELF::ELFDATA2LSB},
757   {"BigEndian",    "2's complement, big endian",    ELF::ELFDATA2MSB},
758 };
759 
760 static const EnumEntry<unsigned> ElfObjectFileType[] = {
761   {"None",         "NONE (none)",              ELF::ET_NONE},
762   {"Relocatable",  "REL (Relocatable file)",   ELF::ET_REL},
763   {"Executable",   "EXEC (Executable file)",   ELF::ET_EXEC},
764   {"SharedObject", "DYN (Shared object file)", ELF::ET_DYN},
765   {"Core",         "CORE (Core file)",         ELF::ET_CORE},
766 };
767 
768 static const EnumEntry<unsigned> ElfOSABI[] = {
769   {"SystemV",      "UNIX - System V",      ELF::ELFOSABI_NONE},
770   {"HPUX",         "UNIX - HP-UX",         ELF::ELFOSABI_HPUX},
771   {"NetBSD",       "UNIX - NetBSD",        ELF::ELFOSABI_NETBSD},
772   {"GNU/Linux",    "UNIX - GNU",           ELF::ELFOSABI_LINUX},
773   {"GNU/Hurd",     "GNU/Hurd",             ELF::ELFOSABI_HURD},
774   {"Solaris",      "UNIX - Solaris",       ELF::ELFOSABI_SOLARIS},
775   {"AIX",          "UNIX - AIX",           ELF::ELFOSABI_AIX},
776   {"IRIX",         "UNIX - IRIX",          ELF::ELFOSABI_IRIX},
777   {"FreeBSD",      "UNIX - FreeBSD",       ELF::ELFOSABI_FREEBSD},
778   {"TRU64",        "UNIX - TRU64",         ELF::ELFOSABI_TRU64},
779   {"Modesto",      "Novell - Modesto",     ELF::ELFOSABI_MODESTO},
780   {"OpenBSD",      "UNIX - OpenBSD",       ELF::ELFOSABI_OPENBSD},
781   {"OpenVMS",      "VMS - OpenVMS",        ELF::ELFOSABI_OPENVMS},
782   {"NSK",          "HP - Non-Stop Kernel", ELF::ELFOSABI_NSK},
783   {"AROS",         "AROS",                 ELF::ELFOSABI_AROS},
784   {"FenixOS",      "FenixOS",              ELF::ELFOSABI_FENIXOS},
785   {"CloudABI",     "CloudABI",             ELF::ELFOSABI_CLOUDABI},
786   {"C6000_ELFABI", "Bare-metal C6000",     ELF::ELFOSABI_C6000_ELFABI},
787   {"C6000_LINUX",  "Linux C6000",          ELF::ELFOSABI_C6000_LINUX},
788   {"ARM",          "ARM",                  ELF::ELFOSABI_ARM},
789   {"Standalone",   "Standalone App",       ELF::ELFOSABI_STANDALONE}
790 };
791 
792 static const EnumEntry<unsigned> ElfMachineType[] = {
793   ENUM_ENT(EM_NONE,          "None"),
794   ENUM_ENT(EM_M32,           "WE32100"),
795   ENUM_ENT(EM_SPARC,         "Sparc"),
796   ENUM_ENT(EM_386,           "Intel 80386"),
797   ENUM_ENT(EM_68K,           "MC68000"),
798   ENUM_ENT(EM_88K,           "MC88000"),
799   ENUM_ENT(EM_IAMCU,         "EM_IAMCU"),
800   ENUM_ENT(EM_860,           "Intel 80860"),
801   ENUM_ENT(EM_MIPS,          "MIPS R3000"),
802   ENUM_ENT(EM_S370,          "IBM System/370"),
803   ENUM_ENT(EM_MIPS_RS3_LE,   "MIPS R3000 little-endian"),
804   ENUM_ENT(EM_PARISC,        "HPPA"),
805   ENUM_ENT(EM_VPP500,        "Fujitsu VPP500"),
806   ENUM_ENT(EM_SPARC32PLUS,   "Sparc v8+"),
807   ENUM_ENT(EM_960,           "Intel 80960"),
808   ENUM_ENT(EM_PPC,           "PowerPC"),
809   ENUM_ENT(EM_PPC64,         "PowerPC64"),
810   ENUM_ENT(EM_S390,          "IBM S/390"),
811   ENUM_ENT(EM_SPU,           "SPU"),
812   ENUM_ENT(EM_V800,          "NEC V800 series"),
813   ENUM_ENT(EM_FR20,          "Fujistsu FR20"),
814   ENUM_ENT(EM_RH32,          "TRW RH-32"),
815   ENUM_ENT(EM_RCE,           "Motorola RCE"),
816   ENUM_ENT(EM_ARM,           "ARM"),
817   ENUM_ENT(EM_ALPHA,         "EM_ALPHA"),
818   ENUM_ENT(EM_SH,            "Hitachi SH"),
819   ENUM_ENT(EM_SPARCV9,       "Sparc v9"),
820   ENUM_ENT(EM_TRICORE,       "Siemens Tricore"),
821   ENUM_ENT(EM_ARC,           "ARC"),
822   ENUM_ENT(EM_H8_300,        "Hitachi H8/300"),
823   ENUM_ENT(EM_H8_300H,       "Hitachi H8/300H"),
824   ENUM_ENT(EM_H8S,           "Hitachi H8S"),
825   ENUM_ENT(EM_H8_500,        "Hitachi H8/500"),
826   ENUM_ENT(EM_IA_64,         "Intel IA-64"),
827   ENUM_ENT(EM_MIPS_X,        "Stanford MIPS-X"),
828   ENUM_ENT(EM_COLDFIRE,      "Motorola Coldfire"),
829   ENUM_ENT(EM_68HC12,        "Motorola MC68HC12 Microcontroller"),
830   ENUM_ENT(EM_MMA,           "Fujitsu Multimedia Accelerator"),
831   ENUM_ENT(EM_PCP,           "Siemens PCP"),
832   ENUM_ENT(EM_NCPU,          "Sony nCPU embedded RISC processor"),
833   ENUM_ENT(EM_NDR1,          "Denso NDR1 microprocesspr"),
834   ENUM_ENT(EM_STARCORE,      "Motorola Star*Core processor"),
835   ENUM_ENT(EM_ME16,          "Toyota ME16 processor"),
836   ENUM_ENT(EM_ST100,         "STMicroelectronics ST100 processor"),
837   ENUM_ENT(EM_TINYJ,         "Advanced Logic Corp. TinyJ embedded processor"),
838   ENUM_ENT(EM_X86_64,        "Advanced Micro Devices X86-64"),
839   ENUM_ENT(EM_PDSP,          "Sony DSP processor"),
840   ENUM_ENT(EM_PDP10,         "Digital Equipment Corp. PDP-10"),
841   ENUM_ENT(EM_PDP11,         "Digital Equipment Corp. PDP-11"),
842   ENUM_ENT(EM_FX66,          "Siemens FX66 microcontroller"),
843   ENUM_ENT(EM_ST9PLUS,       "STMicroelectronics ST9+ 8/16 bit microcontroller"),
844   ENUM_ENT(EM_ST7,           "STMicroelectronics ST7 8-bit microcontroller"),
845   ENUM_ENT(EM_68HC16,        "Motorola MC68HC16 Microcontroller"),
846   ENUM_ENT(EM_68HC11,        "Motorola MC68HC11 Microcontroller"),
847   ENUM_ENT(EM_68HC08,        "Motorola MC68HC08 Microcontroller"),
848   ENUM_ENT(EM_68HC05,        "Motorola MC68HC05 Microcontroller"),
849   ENUM_ENT(EM_SVX,           "Silicon Graphics SVx"),
850   ENUM_ENT(EM_ST19,          "STMicroelectronics ST19 8-bit microcontroller"),
851   ENUM_ENT(EM_VAX,           "Digital VAX"),
852   ENUM_ENT(EM_CRIS,          "Axis Communications 32-bit embedded processor"),
853   ENUM_ENT(EM_JAVELIN,       "Infineon Technologies 32-bit embedded cpu"),
854   ENUM_ENT(EM_FIREPATH,      "Element 14 64-bit DSP processor"),
855   ENUM_ENT(EM_ZSP,           "LSI Logic's 16-bit DSP processor"),
856   ENUM_ENT(EM_MMIX,          "Donald Knuth's educational 64-bit processor"),
857   ENUM_ENT(EM_HUANY,         "Harvard Universitys's machine-independent object format"),
858   ENUM_ENT(EM_PRISM,         "Vitesse Prism"),
859   ENUM_ENT(EM_AVR,           "Atmel AVR 8-bit microcontroller"),
860   ENUM_ENT(EM_FR30,          "Fujitsu FR30"),
861   ENUM_ENT(EM_D10V,          "Mitsubishi D10V"),
862   ENUM_ENT(EM_D30V,          "Mitsubishi D30V"),
863   ENUM_ENT(EM_V850,          "NEC v850"),
864   ENUM_ENT(EM_M32R,          "Renesas M32R (formerly Mitsubishi M32r)"),
865   ENUM_ENT(EM_MN10300,       "Matsushita MN10300"),
866   ENUM_ENT(EM_MN10200,       "Matsushita MN10200"),
867   ENUM_ENT(EM_PJ,            "picoJava"),
868   ENUM_ENT(EM_OPENRISC,      "OpenRISC 32-bit embedded processor"),
869   ENUM_ENT(EM_ARC_COMPACT,   "EM_ARC_COMPACT"),
870   ENUM_ENT(EM_XTENSA,        "Tensilica Xtensa Processor"),
871   ENUM_ENT(EM_VIDEOCORE,     "Alphamosaic VideoCore processor"),
872   ENUM_ENT(EM_TMM_GPP,       "Thompson Multimedia General Purpose Processor"),
873   ENUM_ENT(EM_NS32K,         "National Semiconductor 32000 series"),
874   ENUM_ENT(EM_TPC,           "Tenor Network TPC processor"),
875   ENUM_ENT(EM_SNP1K,         "EM_SNP1K"),
876   ENUM_ENT(EM_ST200,         "STMicroelectronics ST200 microcontroller"),
877   ENUM_ENT(EM_IP2K,          "Ubicom IP2xxx 8-bit microcontrollers"),
878   ENUM_ENT(EM_MAX,           "MAX Processor"),
879   ENUM_ENT(EM_CR,            "National Semiconductor CompactRISC"),
880   ENUM_ENT(EM_F2MC16,        "Fujitsu F2MC16"),
881   ENUM_ENT(EM_MSP430,        "Texas Instruments msp430 microcontroller"),
882   ENUM_ENT(EM_BLACKFIN,      "Analog Devices Blackfin"),
883   ENUM_ENT(EM_SE_C33,        "S1C33 Family of Seiko Epson processors"),
884   ENUM_ENT(EM_SEP,           "Sharp embedded microprocessor"),
885   ENUM_ENT(EM_ARCA,          "Arca RISC microprocessor"),
886   ENUM_ENT(EM_UNICORE,       "Unicore"),
887   ENUM_ENT(EM_EXCESS,        "eXcess 16/32/64-bit configurable embedded CPU"),
888   ENUM_ENT(EM_DXP,           "Icera Semiconductor Inc. Deep Execution Processor"),
889   ENUM_ENT(EM_ALTERA_NIOS2,  "Altera Nios"),
890   ENUM_ENT(EM_CRX,           "National Semiconductor CRX microprocessor"),
891   ENUM_ENT(EM_XGATE,         "Motorola XGATE embedded processor"),
892   ENUM_ENT(EM_C166,          "Infineon Technologies xc16x"),
893   ENUM_ENT(EM_M16C,          "Renesas M16C"),
894   ENUM_ENT(EM_DSPIC30F,      "Microchip Technology dsPIC30F Digital Signal Controller"),
895   ENUM_ENT(EM_CE,            "Freescale Communication Engine RISC core"),
896   ENUM_ENT(EM_M32C,          "Renesas M32C"),
897   ENUM_ENT(EM_TSK3000,       "Altium TSK3000 core"),
898   ENUM_ENT(EM_RS08,          "Freescale RS08 embedded processor"),
899   ENUM_ENT(EM_SHARC,         "EM_SHARC"),
900   ENUM_ENT(EM_ECOG2,         "Cyan Technology eCOG2 microprocessor"),
901   ENUM_ENT(EM_SCORE7,        "SUNPLUS S+Core"),
902   ENUM_ENT(EM_DSP24,         "New Japan Radio (NJR) 24-bit DSP Processor"),
903   ENUM_ENT(EM_VIDEOCORE3,    "Broadcom VideoCore III processor"),
904   ENUM_ENT(EM_LATTICEMICO32, "Lattice Mico32"),
905   ENUM_ENT(EM_SE_C17,        "Seiko Epson C17 family"),
906   ENUM_ENT(EM_TI_C6000,      "Texas Instruments TMS320C6000 DSP family"),
907   ENUM_ENT(EM_TI_C2000,      "Texas Instruments TMS320C2000 DSP family"),
908   ENUM_ENT(EM_TI_C5500,      "Texas Instruments TMS320C55x DSP family"),
909   ENUM_ENT(EM_MMDSP_PLUS,    "STMicroelectronics 64bit VLIW Data Signal Processor"),
910   ENUM_ENT(EM_CYPRESS_M8C,   "Cypress M8C microprocessor"),
911   ENUM_ENT(EM_R32C,          "Renesas R32C series microprocessors"),
912   ENUM_ENT(EM_TRIMEDIA,      "NXP Semiconductors TriMedia architecture family"),
913   ENUM_ENT(EM_HEXAGON,       "Qualcomm Hexagon"),
914   ENUM_ENT(EM_8051,          "Intel 8051 and variants"),
915   ENUM_ENT(EM_STXP7X,        "STMicroelectronics STxP7x family"),
916   ENUM_ENT(EM_NDS32,         "Andes Technology compact code size embedded RISC processor family"),
917   ENUM_ENT(EM_ECOG1,         "Cyan Technology eCOG1 microprocessor"),
918   ENUM_ENT(EM_ECOG1X,        "Cyan Technology eCOG1X family"),
919   ENUM_ENT(EM_MAXQ30,        "Dallas Semiconductor MAXQ30 Core microcontrollers"),
920   ENUM_ENT(EM_XIMO16,        "New Japan Radio (NJR) 16-bit DSP Processor"),
921   ENUM_ENT(EM_MANIK,         "M2000 Reconfigurable RISC Microprocessor"),
922   ENUM_ENT(EM_CRAYNV2,       "Cray Inc. NV2 vector architecture"),
923   ENUM_ENT(EM_RX,            "Renesas RX"),
924   ENUM_ENT(EM_METAG,         "Imagination Technologies Meta processor architecture"),
925   ENUM_ENT(EM_MCST_ELBRUS,   "MCST Elbrus general purpose hardware architecture"),
926   ENUM_ENT(EM_ECOG16,        "Cyan Technology eCOG16 family"),
927   ENUM_ENT(EM_CR16,          "Xilinx MicroBlaze"),
928   ENUM_ENT(EM_ETPU,          "Freescale Extended Time Processing Unit"),
929   ENUM_ENT(EM_SLE9X,         "Infineon Technologies SLE9X core"),
930   ENUM_ENT(EM_L10M,          "EM_L10M"),
931   ENUM_ENT(EM_K10M,          "EM_K10M"),
932   ENUM_ENT(EM_AARCH64,       "AArch64"),
933   ENUM_ENT(EM_AVR32,         "Atmel AVR 8-bit microcontroller"),
934   ENUM_ENT(EM_STM8,          "STMicroeletronics STM8 8-bit microcontroller"),
935   ENUM_ENT(EM_TILE64,        "Tilera TILE64 multicore architecture family"),
936   ENUM_ENT(EM_TILEPRO,       "Tilera TILEPro multicore architecture family"),
937   ENUM_ENT(EM_CUDA,          "NVIDIA CUDA architecture"),
938   ENUM_ENT(EM_TILEGX,        "Tilera TILE-Gx multicore architecture family"),
939   ENUM_ENT(EM_CLOUDSHIELD,   "EM_CLOUDSHIELD"),
940   ENUM_ENT(EM_COREA_1ST,     "EM_COREA_1ST"),
941   ENUM_ENT(EM_COREA_2ND,     "EM_COREA_2ND"),
942   ENUM_ENT(EM_ARC_COMPACT2,  "EM_ARC_COMPACT2"),
943   ENUM_ENT(EM_OPEN8,         "EM_OPEN8"),
944   ENUM_ENT(EM_RL78,          "Renesas RL78"),
945   ENUM_ENT(EM_VIDEOCORE5,    "Broadcom VideoCore V processor"),
946   ENUM_ENT(EM_78KOR,         "EM_78KOR"),
947   ENUM_ENT(EM_56800EX,       "EM_56800EX"),
948   ENUM_ENT(EM_AMDGPU,        "EM_AMDGPU"),
949   ENUM_ENT(EM_WEBASSEMBLY,   "EM_WEBASSEMBLY"),
950   ENUM_ENT(EM_LANAI,         "EM_LANAI"),
951 };
952 
953 static const EnumEntry<unsigned> ElfSymbolBindings[] = {
954     {"Local",  "LOCAL",  ELF::STB_LOCAL},
955     {"Global", "GLOBAL", ELF::STB_GLOBAL},
956     {"Weak",   "WEAK",   ELF::STB_WEAK},
957     {"Unique", "UNIQUE", ELF::STB_GNU_UNIQUE}};
958 
959 static const EnumEntry<unsigned> ElfSymbolVisibilities[] = {
960     {"DEFAULT",   "DEFAULT",   ELF::STV_DEFAULT},
961     {"INTERNAL",  "INTERNAL",  ELF::STV_INTERNAL},
962     {"HIDDEN",    "HIDDEN",    ELF::STV_HIDDEN},
963     {"PROTECTED", "PROTECTED", ELF::STV_PROTECTED}};
964 
965 static const EnumEntry<unsigned> ElfSymbolTypes[] = {
966     {"None",      "NOTYPE",  ELF::STT_NOTYPE},
967     {"Object",    "OBJECT",  ELF::STT_OBJECT},
968     {"Function",  "FUNC",    ELF::STT_FUNC},
969     {"Section",   "SECTION", ELF::STT_SECTION},
970     {"File",      "FILE",    ELF::STT_FILE},
971     {"Common",    "COMMON",  ELF::STT_COMMON},
972     {"TLS",       "TLS",     ELF::STT_TLS},
973     {"GNU_IFunc", "IFUNC",   ELF::STT_GNU_IFUNC}};
974 
975 static const EnumEntry<unsigned> AMDGPUSymbolTypes[] = {
976   { "AMDGPU_HSA_KERNEL",            ELF::STT_AMDGPU_HSA_KERNEL },
977   { "AMDGPU_HSA_INDIRECT_FUNCTION", ELF::STT_AMDGPU_HSA_INDIRECT_FUNCTION },
978   { "AMDGPU_HSA_METADATA",          ELF::STT_AMDGPU_HSA_METADATA }
979 };
980 
981 static const char *getElfSectionType(unsigned Arch, unsigned Type) {
982   switch (Arch) {
983   case ELF::EM_ARM:
984     switch (Type) {
985     LLVM_READOBJ_ENUM_CASE(ELF, SHT_ARM_EXIDX);
986     LLVM_READOBJ_ENUM_CASE(ELF, SHT_ARM_PREEMPTMAP);
987     LLVM_READOBJ_ENUM_CASE(ELF, SHT_ARM_ATTRIBUTES);
988     LLVM_READOBJ_ENUM_CASE(ELF, SHT_ARM_DEBUGOVERLAY);
989     LLVM_READOBJ_ENUM_CASE(ELF, SHT_ARM_OVERLAYSECTION);
990     }
991   case ELF::EM_HEXAGON:
992     switch (Type) { LLVM_READOBJ_ENUM_CASE(ELF, SHT_HEX_ORDERED); }
993   case ELF::EM_X86_64:
994     switch (Type) { LLVM_READOBJ_ENUM_CASE(ELF, SHT_X86_64_UNWIND); }
995   case ELF::EM_MIPS:
996   case ELF::EM_MIPS_RS3_LE:
997     switch (Type) {
998     LLVM_READOBJ_ENUM_CASE(ELF, SHT_MIPS_REGINFO);
999     LLVM_READOBJ_ENUM_CASE(ELF, SHT_MIPS_OPTIONS);
1000     LLVM_READOBJ_ENUM_CASE(ELF, SHT_MIPS_ABIFLAGS);
1001     }
1002   }
1003 
1004   switch (Type) {
1005   LLVM_READOBJ_ENUM_CASE(ELF, SHT_NULL              );
1006   LLVM_READOBJ_ENUM_CASE(ELF, SHT_PROGBITS          );
1007   LLVM_READOBJ_ENUM_CASE(ELF, SHT_SYMTAB            );
1008   LLVM_READOBJ_ENUM_CASE(ELF, SHT_STRTAB            );
1009   LLVM_READOBJ_ENUM_CASE(ELF, SHT_RELA              );
1010   LLVM_READOBJ_ENUM_CASE(ELF, SHT_HASH              );
1011   LLVM_READOBJ_ENUM_CASE(ELF, SHT_DYNAMIC           );
1012   LLVM_READOBJ_ENUM_CASE(ELF, SHT_NOTE              );
1013   LLVM_READOBJ_ENUM_CASE(ELF, SHT_NOBITS            );
1014   LLVM_READOBJ_ENUM_CASE(ELF, SHT_REL               );
1015   LLVM_READOBJ_ENUM_CASE(ELF, SHT_SHLIB             );
1016   LLVM_READOBJ_ENUM_CASE(ELF, SHT_DYNSYM            );
1017   LLVM_READOBJ_ENUM_CASE(ELF, SHT_INIT_ARRAY        );
1018   LLVM_READOBJ_ENUM_CASE(ELF, SHT_FINI_ARRAY        );
1019   LLVM_READOBJ_ENUM_CASE(ELF, SHT_PREINIT_ARRAY     );
1020   LLVM_READOBJ_ENUM_CASE(ELF, SHT_GROUP             );
1021   LLVM_READOBJ_ENUM_CASE(ELF, SHT_SYMTAB_SHNDX      );
1022   LLVM_READOBJ_ENUM_CASE(ELF, SHT_GNU_ATTRIBUTES    );
1023   LLVM_READOBJ_ENUM_CASE(ELF, SHT_GNU_HASH          );
1024   LLVM_READOBJ_ENUM_CASE(ELF, SHT_GNU_verdef        );
1025   LLVM_READOBJ_ENUM_CASE(ELF, SHT_GNU_verneed       );
1026   LLVM_READOBJ_ENUM_CASE(ELF, SHT_GNU_versym        );
1027   default: return "";
1028   }
1029 }
1030 
1031 static const char *getGroupType(uint32_t Flag) {
1032   if (Flag & ELF::GRP_COMDAT)
1033     return "COMDAT";
1034   else
1035     return "(unknown)";
1036 }
1037 
1038 static const EnumEntry<unsigned> ElfSectionFlags[] = {
1039   ENUM_ENT(SHF_WRITE,            "W"),
1040   ENUM_ENT(SHF_ALLOC,            "A"),
1041   ENUM_ENT(SHF_EXCLUDE,          "E"),
1042   ENUM_ENT(SHF_EXECINSTR,        "X"),
1043   ENUM_ENT(SHF_MERGE,            "M"),
1044   ENUM_ENT(SHF_STRINGS,          "S"),
1045   ENUM_ENT(SHF_INFO_LINK,        "I"),
1046   ENUM_ENT(SHF_LINK_ORDER,       "L"),
1047   ENUM_ENT(SHF_OS_NONCONFORMING, "o"),
1048   ENUM_ENT(SHF_GROUP,            "G"),
1049   ENUM_ENT(SHF_TLS,              "T"),
1050   ENUM_ENT(SHF_MASKOS,           "o"),
1051   ENUM_ENT(SHF_MASKPROC,         "p"),
1052   ENUM_ENT_1(SHF_COMPRESSED),
1053 };
1054 
1055 static const EnumEntry<unsigned> ElfXCoreSectionFlags[] = {
1056   LLVM_READOBJ_ENUM_ENT(ELF, XCORE_SHF_CP_SECTION),
1057   LLVM_READOBJ_ENUM_ENT(ELF, XCORE_SHF_DP_SECTION)
1058 };
1059 
1060 static const EnumEntry<unsigned> ElfAMDGPUSectionFlags[] = {
1061   LLVM_READOBJ_ENUM_ENT(ELF, SHF_AMDGPU_HSA_GLOBAL),
1062   LLVM_READOBJ_ENUM_ENT(ELF, SHF_AMDGPU_HSA_READONLY),
1063   LLVM_READOBJ_ENUM_ENT(ELF, SHF_AMDGPU_HSA_CODE),
1064   LLVM_READOBJ_ENUM_ENT(ELF, SHF_AMDGPU_HSA_AGENT)
1065 };
1066 
1067 static const EnumEntry<unsigned> ElfHexagonSectionFlags[] = {
1068   LLVM_READOBJ_ENUM_ENT(ELF, SHF_HEX_GPREL)
1069 };
1070 
1071 static const EnumEntry<unsigned> ElfMipsSectionFlags[] = {
1072   LLVM_READOBJ_ENUM_ENT(ELF, SHF_MIPS_NODUPES),
1073   LLVM_READOBJ_ENUM_ENT(ELF, SHF_MIPS_NAMES  ),
1074   LLVM_READOBJ_ENUM_ENT(ELF, SHF_MIPS_LOCAL  ),
1075   LLVM_READOBJ_ENUM_ENT(ELF, SHF_MIPS_NOSTRIP),
1076   LLVM_READOBJ_ENUM_ENT(ELF, SHF_MIPS_GPREL  ),
1077   LLVM_READOBJ_ENUM_ENT(ELF, SHF_MIPS_MERGE  ),
1078   LLVM_READOBJ_ENUM_ENT(ELF, SHF_MIPS_ADDR   ),
1079   LLVM_READOBJ_ENUM_ENT(ELF, SHF_MIPS_STRING )
1080 };
1081 
1082 static const EnumEntry<unsigned> ElfX86_64SectionFlags[] = {
1083   LLVM_READOBJ_ENUM_ENT(ELF, SHF_X86_64_LARGE)
1084 };
1085 
1086 static std::string getGNUFlags(uint64_t Flags) {
1087   std::string Str;
1088   for (auto Entry : ElfSectionFlags) {
1089     uint64_t Flag = Entry.Value & Flags;
1090     Flags &= ~Entry.Value;
1091     switch (Flag) {
1092     case ELF::SHF_WRITE:
1093     case ELF::SHF_ALLOC:
1094     case ELF::SHF_EXECINSTR:
1095     case ELF::SHF_MERGE:
1096     case ELF::SHF_STRINGS:
1097     case ELF::SHF_INFO_LINK:
1098     case ELF::SHF_LINK_ORDER:
1099     case ELF::SHF_OS_NONCONFORMING:
1100     case ELF::SHF_GROUP:
1101     case ELF::SHF_TLS:
1102     case ELF::SHF_EXCLUDE:
1103       Str += Entry.AltName;
1104       break;
1105     default:
1106       if (Flag & ELF::SHF_MASKOS)
1107         Str += "o";
1108       else if (Flag & ELF::SHF_MASKPROC)
1109         Str += "p";
1110       else if (Flag)
1111         Str += "x";
1112     }
1113   }
1114   return Str;
1115 }
1116 
1117 static const char *getElfSegmentType(unsigned Arch, unsigned Type) {
1118   // Check potentially overlapped processor-specific
1119   // program header type.
1120   switch (Arch) {
1121   case ELF::EM_AMDGPU:
1122     switch (Type) {
1123     LLVM_READOBJ_ENUM_CASE(ELF, PT_AMDGPU_HSA_LOAD_GLOBAL_PROGRAM);
1124     LLVM_READOBJ_ENUM_CASE(ELF, PT_AMDGPU_HSA_LOAD_GLOBAL_AGENT);
1125     LLVM_READOBJ_ENUM_CASE(ELF, PT_AMDGPU_HSA_LOAD_READONLY_AGENT);
1126     LLVM_READOBJ_ENUM_CASE(ELF, PT_AMDGPU_HSA_LOAD_CODE_AGENT);
1127     }
1128   case ELF::EM_ARM:
1129     switch (Type) {
1130     LLVM_READOBJ_ENUM_CASE(ELF, PT_ARM_EXIDX);
1131     }
1132   case ELF::EM_MIPS:
1133   case ELF::EM_MIPS_RS3_LE:
1134     switch (Type) {
1135     LLVM_READOBJ_ENUM_CASE(ELF, PT_MIPS_REGINFO);
1136     LLVM_READOBJ_ENUM_CASE(ELF, PT_MIPS_RTPROC);
1137     LLVM_READOBJ_ENUM_CASE(ELF, PT_MIPS_OPTIONS);
1138     LLVM_READOBJ_ENUM_CASE(ELF, PT_MIPS_ABIFLAGS);
1139     }
1140   }
1141 
1142   switch (Type) {
1143   LLVM_READOBJ_ENUM_CASE(ELF, PT_NULL   );
1144   LLVM_READOBJ_ENUM_CASE(ELF, PT_LOAD   );
1145   LLVM_READOBJ_ENUM_CASE(ELF, PT_DYNAMIC);
1146   LLVM_READOBJ_ENUM_CASE(ELF, PT_INTERP );
1147   LLVM_READOBJ_ENUM_CASE(ELF, PT_NOTE   );
1148   LLVM_READOBJ_ENUM_CASE(ELF, PT_SHLIB  );
1149   LLVM_READOBJ_ENUM_CASE(ELF, PT_PHDR   );
1150   LLVM_READOBJ_ENUM_CASE(ELF, PT_TLS    );
1151 
1152   LLVM_READOBJ_ENUM_CASE(ELF, PT_GNU_EH_FRAME);
1153   LLVM_READOBJ_ENUM_CASE(ELF, PT_SUNW_UNWIND);
1154 
1155   LLVM_READOBJ_ENUM_CASE(ELF, PT_GNU_STACK);
1156   LLVM_READOBJ_ENUM_CASE(ELF, PT_GNU_RELRO);
1157   default: return "";
1158   }
1159 }
1160 
1161 static std::string getElfPtType(unsigned Arch, unsigned Type) {
1162   switch (Type) {
1163     LLVM_READOBJ_PHDR_ENUM(ELF, PT_NULL)
1164     LLVM_READOBJ_PHDR_ENUM(ELF, PT_LOAD)
1165     LLVM_READOBJ_PHDR_ENUM(ELF, PT_DYNAMIC)
1166     LLVM_READOBJ_PHDR_ENUM(ELF, PT_INTERP)
1167     LLVM_READOBJ_PHDR_ENUM(ELF, PT_NOTE)
1168     LLVM_READOBJ_PHDR_ENUM(ELF, PT_SHLIB)
1169     LLVM_READOBJ_PHDR_ENUM(ELF, PT_PHDR)
1170     LLVM_READOBJ_PHDR_ENUM(ELF, PT_TLS)
1171     LLVM_READOBJ_PHDR_ENUM(ELF, PT_GNU_EH_FRAME)
1172     LLVM_READOBJ_PHDR_ENUM(ELF, PT_SUNW_UNWIND)
1173     LLVM_READOBJ_PHDR_ENUM(ELF, PT_GNU_STACK)
1174     LLVM_READOBJ_PHDR_ENUM(ELF, PT_GNU_RELRO)
1175   default:
1176     // All machine specific PT_* types
1177     switch (Arch) {
1178     case ELF::EM_AMDGPU:
1179       switch (Type) {
1180         LLVM_READOBJ_ENUM_CASE(ELF, PT_AMDGPU_HSA_LOAD_GLOBAL_PROGRAM);
1181         LLVM_READOBJ_ENUM_CASE(ELF, PT_AMDGPU_HSA_LOAD_GLOBAL_AGENT);
1182         LLVM_READOBJ_ENUM_CASE(ELF, PT_AMDGPU_HSA_LOAD_READONLY_AGENT);
1183         LLVM_READOBJ_ENUM_CASE(ELF, PT_AMDGPU_HSA_LOAD_CODE_AGENT);
1184       }
1185       return "";
1186     case ELF::EM_ARM:
1187       if (Type == ELF::PT_ARM_EXIDX)
1188         return "EXIDX";
1189       return "";
1190     case ELF::EM_MIPS:
1191     case ELF::EM_MIPS_RS3_LE:
1192       switch (Type) {
1193       case PT_MIPS_REGINFO:
1194         return "REGINFO";
1195       case PT_MIPS_RTPROC:
1196         return "RTPROC";
1197       case PT_MIPS_OPTIONS:
1198         return "OPTIONS";
1199       case PT_MIPS_ABIFLAGS:
1200         return "ABIFLAGS";
1201       }
1202       return "";
1203     }
1204   }
1205   return std::string("<unknown>: ") + to_string(format_hex(Type, 1));
1206 }
1207 
1208 static const EnumEntry<unsigned> ElfSegmentFlags[] = {
1209   LLVM_READOBJ_ENUM_ENT(ELF, PF_X),
1210   LLVM_READOBJ_ENUM_ENT(ELF, PF_W),
1211   LLVM_READOBJ_ENUM_ENT(ELF, PF_R)
1212 };
1213 
1214 static const EnumEntry<unsigned> ElfHeaderMipsFlags[] = {
1215   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_NOREORDER),
1216   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_PIC),
1217   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_CPIC),
1218   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ABI2),
1219   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_32BITMODE),
1220   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_FP64),
1221   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_NAN2008),
1222   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ABI_O32),
1223   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ABI_O64),
1224   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ABI_EABI32),
1225   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ABI_EABI64),
1226   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_3900),
1227   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_4010),
1228   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_4100),
1229   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_4650),
1230   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_4120),
1231   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_4111),
1232   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_SB1),
1233   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_OCTEON),
1234   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_XLR),
1235   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_OCTEON2),
1236   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_OCTEON3),
1237   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_5400),
1238   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_5900),
1239   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_5500),
1240   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_9000),
1241   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_LS2E),
1242   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_LS2F),
1243   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MACH_LS3A),
1244   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_MICROMIPS),
1245   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_ASE_M16),
1246   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_ASE_MDMX),
1247   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_1),
1248   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_2),
1249   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_3),
1250   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_4),
1251   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_5),
1252   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_32),
1253   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_64),
1254   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_32R2),
1255   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_64R2),
1256   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_32R6),
1257   LLVM_READOBJ_ENUM_ENT(ELF, EF_MIPS_ARCH_64R6)
1258 };
1259 
1260 static const EnumEntry<unsigned> ElfSymOtherFlags[] = {
1261   LLVM_READOBJ_ENUM_ENT(ELF, STV_INTERNAL),
1262   LLVM_READOBJ_ENUM_ENT(ELF, STV_HIDDEN),
1263   LLVM_READOBJ_ENUM_ENT(ELF, STV_PROTECTED)
1264 };
1265 
1266 static const EnumEntry<unsigned> ElfMipsSymOtherFlags[] = {
1267   LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_OPTIONAL),
1268   LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_PLT),
1269   LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_PIC),
1270   LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_MICROMIPS)
1271 };
1272 
1273 static const EnumEntry<unsigned> ElfMips16SymOtherFlags[] = {
1274   LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_OPTIONAL),
1275   LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_PLT),
1276   LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_MIPS16)
1277 };
1278 
1279 static const char *getElfMipsOptionsOdkType(unsigned Odk) {
1280   switch (Odk) {
1281   LLVM_READOBJ_ENUM_CASE(ELF, ODK_NULL);
1282   LLVM_READOBJ_ENUM_CASE(ELF, ODK_REGINFO);
1283   LLVM_READOBJ_ENUM_CASE(ELF, ODK_EXCEPTIONS);
1284   LLVM_READOBJ_ENUM_CASE(ELF, ODK_PAD);
1285   LLVM_READOBJ_ENUM_CASE(ELF, ODK_HWPATCH);
1286   LLVM_READOBJ_ENUM_CASE(ELF, ODK_FILL);
1287   LLVM_READOBJ_ENUM_CASE(ELF, ODK_TAGS);
1288   LLVM_READOBJ_ENUM_CASE(ELF, ODK_HWAND);
1289   LLVM_READOBJ_ENUM_CASE(ELF, ODK_HWOR);
1290   LLVM_READOBJ_ENUM_CASE(ELF, ODK_GP_GROUP);
1291   LLVM_READOBJ_ENUM_CASE(ELF, ODK_IDENT);
1292   LLVM_READOBJ_ENUM_CASE(ELF, ODK_PAGESIZE);
1293   default:
1294     return "Unknown";
1295   }
1296 }
1297 
1298 template <typename ELFT>
1299 ELFDumper<ELFT>::ELFDumper(const ELFFile<ELFT> *Obj, ScopedPrinter &Writer)
1300     : ObjDumper(Writer), Obj(Obj) {
1301 
1302   SmallVector<const Elf_Phdr *, 4> LoadSegments;
1303   for (const Elf_Phdr &Phdr : Obj->program_headers()) {
1304     if (Phdr.p_type == ELF::PT_DYNAMIC) {
1305       DynamicTable = createDRIFrom(&Phdr, sizeof(Elf_Dyn));
1306       continue;
1307     }
1308     if (Phdr.p_type != ELF::PT_LOAD || Phdr.p_filesz == 0)
1309       continue;
1310     LoadSegments.push_back(&Phdr);
1311   }
1312 
1313   for (const Elf_Shdr &Sec : Obj->sections()) {
1314     switch (Sec.sh_type) {
1315     case ELF::SHT_SYMTAB:
1316       if (DotSymtabSec != nullptr)
1317         reportError("Multilpe SHT_SYMTAB");
1318       DotSymtabSec = &Sec;
1319       break;
1320     case ELF::SHT_DYNSYM:
1321       if (DynSymRegion.Size)
1322         reportError("Multilpe SHT_DYNSYM");
1323       DynSymRegion = createDRIFrom(&Sec);
1324       // This is only used (if Elf_Shdr present)for naming section in GNU style
1325       DynSymtabName = unwrapOrError(Obj->getSectionName(&Sec));
1326       break;
1327     case ELF::SHT_SYMTAB_SHNDX:
1328       ShndxTable = unwrapOrError(Obj->getSHNDXTable(Sec));
1329       break;
1330     case ELF::SHT_GNU_versym:
1331       if (dot_gnu_version_sec != nullptr)
1332         reportError("Multiple SHT_GNU_versym");
1333       dot_gnu_version_sec = &Sec;
1334       break;
1335     case ELF::SHT_GNU_verdef:
1336       if (dot_gnu_version_d_sec != nullptr)
1337         reportError("Multiple SHT_GNU_verdef");
1338       dot_gnu_version_d_sec = &Sec;
1339       break;
1340     case ELF::SHT_GNU_verneed:
1341       if (dot_gnu_version_r_sec != nullptr)
1342         reportError("Multilpe SHT_GNU_verneed");
1343       dot_gnu_version_r_sec = &Sec;
1344       break;
1345     }
1346   }
1347 
1348   parseDynamicTable(LoadSegments);
1349 
1350   if (opts::Output == opts::GNU)
1351     ELFDumperStyle.reset(new GNUStyle<ELFT>(Writer, this));
1352   else
1353     ELFDumperStyle.reset(new LLVMStyle<ELFT>(Writer, this));
1354 }
1355 
1356 template <typename ELFT>
1357 void ELFDumper<ELFT>::parseDynamicTable(
1358     ArrayRef<const Elf_Phdr *> LoadSegments) {
1359   auto toMappedAddr = [&](uint64_t VAddr) -> const uint8_t * {
1360     const Elf_Phdr *const *I = std::upper_bound(
1361         LoadSegments.begin(), LoadSegments.end(), VAddr, compareAddr<ELFT>);
1362     if (I == LoadSegments.begin())
1363       report_fatal_error("Virtual address is not in any segment");
1364     --I;
1365     const Elf_Phdr &Phdr = **I;
1366     uint64_t Delta = VAddr - Phdr.p_vaddr;
1367     if (Delta >= Phdr.p_filesz)
1368       report_fatal_error("Virtual address is not in any segment");
1369     return Obj->base() + Phdr.p_offset + Delta;
1370   };
1371 
1372   uint64_t SONameOffset = 0;
1373   const char *StringTableBegin = nullptr;
1374   uint64_t StringTableSize = 0;
1375   for (const Elf_Dyn &Dyn : dynamic_table()) {
1376     switch (Dyn.d_tag) {
1377     case ELF::DT_HASH:
1378       HashTable =
1379           reinterpret_cast<const Elf_Hash *>(toMappedAddr(Dyn.getPtr()));
1380       break;
1381     case ELF::DT_GNU_HASH:
1382       GnuHashTable =
1383           reinterpret_cast<const Elf_GnuHash *>(toMappedAddr(Dyn.getPtr()));
1384       break;
1385     case ELF::DT_STRTAB:
1386       StringTableBegin = (const char *)toMappedAddr(Dyn.getPtr());
1387       break;
1388     case ELF::DT_STRSZ:
1389       StringTableSize = Dyn.getVal();
1390       break;
1391     case ELF::DT_SYMTAB:
1392       DynSymRegion.Addr = toMappedAddr(Dyn.getPtr());
1393       DynSymRegion.EntSize = sizeof(Elf_Sym);
1394       break;
1395     case ELF::DT_RELA:
1396       DynRelaRegion.Addr = toMappedAddr(Dyn.getPtr());
1397       break;
1398     case ELF::DT_RELASZ:
1399       DynRelaRegion.Size = Dyn.getVal();
1400       break;
1401     case ELF::DT_RELAENT:
1402       DynRelaRegion.EntSize = Dyn.getVal();
1403       break;
1404     case ELF::DT_SONAME:
1405       SONameOffset = Dyn.getVal();
1406       break;
1407     case ELF::DT_REL:
1408       DynRelRegion.Addr = toMappedAddr(Dyn.getPtr());
1409       break;
1410     case ELF::DT_RELSZ:
1411       DynRelRegion.Size = Dyn.getVal();
1412       break;
1413     case ELF::DT_RELENT:
1414       DynRelRegion.EntSize = Dyn.getVal();
1415       break;
1416     case ELF::DT_PLTREL:
1417       if (Dyn.getVal() == DT_REL)
1418         DynPLTRelRegion.EntSize = sizeof(Elf_Rel);
1419       else if (Dyn.getVal() == DT_RELA)
1420         DynPLTRelRegion.EntSize = sizeof(Elf_Rela);
1421       else
1422         reportError(Twine("unknown DT_PLTREL value of ") +
1423                     Twine((uint64_t)Dyn.getVal()));
1424       break;
1425     case ELF::DT_JMPREL:
1426       DynPLTRelRegion.Addr = toMappedAddr(Dyn.getPtr());
1427       break;
1428     case ELF::DT_PLTRELSZ:
1429       DynPLTRelRegion.Size = Dyn.getVal();
1430       break;
1431     }
1432   }
1433   if (StringTableBegin)
1434     DynamicStringTable = StringRef(StringTableBegin, StringTableSize);
1435   if (SONameOffset)
1436     SOName = getDynamicString(SONameOffset);
1437 }
1438 
1439 template <typename ELFT>
1440 typename ELFDumper<ELFT>::Elf_Rel_Range ELFDumper<ELFT>::dyn_rels() const {
1441   return DynRelRegion.getAsArrayRef<Elf_Rel>();
1442 }
1443 
1444 template <typename ELFT>
1445 typename ELFDumper<ELFT>::Elf_Rela_Range ELFDumper<ELFT>::dyn_relas() const {
1446   return DynRelaRegion.getAsArrayRef<Elf_Rela>();
1447 }
1448 
1449 template<class ELFT>
1450 void ELFDumper<ELFT>::printFileHeaders() {
1451   ELFDumperStyle->printFileHeaders(Obj);
1452 }
1453 
1454 template<class ELFT>
1455 void ELFDumper<ELFT>::printSections() {
1456   ELFDumperStyle->printSections(Obj);
1457 }
1458 
1459 template<class ELFT>
1460 void ELFDumper<ELFT>::printRelocations() {
1461   ELFDumperStyle->printRelocations(Obj);
1462 }
1463 
1464 template <class ELFT> void ELFDumper<ELFT>::printProgramHeaders() {
1465   ELFDumperStyle->printProgramHeaders(Obj);
1466 }
1467 
1468 template <class ELFT> void ELFDumper<ELFT>::printDynamicRelocations() {
1469   ELFDumperStyle->printDynamicRelocations(Obj);
1470 }
1471 
1472 template<class ELFT>
1473 void ELFDumper<ELFT>::printSymbols() {
1474   ELFDumperStyle->printSymbols(Obj);
1475 }
1476 
1477 template<class ELFT>
1478 void ELFDumper<ELFT>::printDynamicSymbols() {
1479   ELFDumperStyle->printDynamicSymbols(Obj);
1480 }
1481 
1482 template <class ELFT> void ELFDumper<ELFT>::printHashHistogram() {
1483   ELFDumperStyle->printHashHistogram(Obj);
1484 }
1485 #define LLVM_READOBJ_TYPE_CASE(name) \
1486   case DT_##name: return #name
1487 
1488 static const char *getTypeString(uint64_t Type) {
1489   switch (Type) {
1490   LLVM_READOBJ_TYPE_CASE(BIND_NOW);
1491   LLVM_READOBJ_TYPE_CASE(DEBUG);
1492   LLVM_READOBJ_TYPE_CASE(FINI);
1493   LLVM_READOBJ_TYPE_CASE(FINI_ARRAY);
1494   LLVM_READOBJ_TYPE_CASE(FINI_ARRAYSZ);
1495   LLVM_READOBJ_TYPE_CASE(FLAGS);
1496   LLVM_READOBJ_TYPE_CASE(FLAGS_1);
1497   LLVM_READOBJ_TYPE_CASE(HASH);
1498   LLVM_READOBJ_TYPE_CASE(INIT);
1499   LLVM_READOBJ_TYPE_CASE(INIT_ARRAY);
1500   LLVM_READOBJ_TYPE_CASE(INIT_ARRAYSZ);
1501   LLVM_READOBJ_TYPE_CASE(PREINIT_ARRAY);
1502   LLVM_READOBJ_TYPE_CASE(PREINIT_ARRAYSZ);
1503   LLVM_READOBJ_TYPE_CASE(JMPREL);
1504   LLVM_READOBJ_TYPE_CASE(NEEDED);
1505   LLVM_READOBJ_TYPE_CASE(NULL);
1506   LLVM_READOBJ_TYPE_CASE(PLTGOT);
1507   LLVM_READOBJ_TYPE_CASE(PLTREL);
1508   LLVM_READOBJ_TYPE_CASE(PLTRELSZ);
1509   LLVM_READOBJ_TYPE_CASE(REL);
1510   LLVM_READOBJ_TYPE_CASE(RELA);
1511   LLVM_READOBJ_TYPE_CASE(RELENT);
1512   LLVM_READOBJ_TYPE_CASE(RELSZ);
1513   LLVM_READOBJ_TYPE_CASE(RELAENT);
1514   LLVM_READOBJ_TYPE_CASE(RELASZ);
1515   LLVM_READOBJ_TYPE_CASE(RPATH);
1516   LLVM_READOBJ_TYPE_CASE(RUNPATH);
1517   LLVM_READOBJ_TYPE_CASE(SONAME);
1518   LLVM_READOBJ_TYPE_CASE(STRSZ);
1519   LLVM_READOBJ_TYPE_CASE(STRTAB);
1520   LLVM_READOBJ_TYPE_CASE(SYMBOLIC);
1521   LLVM_READOBJ_TYPE_CASE(SYMENT);
1522   LLVM_READOBJ_TYPE_CASE(SYMTAB);
1523   LLVM_READOBJ_TYPE_CASE(TEXTREL);
1524   LLVM_READOBJ_TYPE_CASE(VERDEF);
1525   LLVM_READOBJ_TYPE_CASE(VERDEFNUM);
1526   LLVM_READOBJ_TYPE_CASE(VERNEED);
1527   LLVM_READOBJ_TYPE_CASE(VERNEEDNUM);
1528   LLVM_READOBJ_TYPE_CASE(VERSYM);
1529   LLVM_READOBJ_TYPE_CASE(RELACOUNT);
1530   LLVM_READOBJ_TYPE_CASE(RELCOUNT);
1531   LLVM_READOBJ_TYPE_CASE(GNU_HASH);
1532   LLVM_READOBJ_TYPE_CASE(TLSDESC_PLT);
1533   LLVM_READOBJ_TYPE_CASE(TLSDESC_GOT);
1534   LLVM_READOBJ_TYPE_CASE(MIPS_RLD_VERSION);
1535   LLVM_READOBJ_TYPE_CASE(MIPS_RLD_MAP_REL);
1536   LLVM_READOBJ_TYPE_CASE(MIPS_FLAGS);
1537   LLVM_READOBJ_TYPE_CASE(MIPS_BASE_ADDRESS);
1538   LLVM_READOBJ_TYPE_CASE(MIPS_LOCAL_GOTNO);
1539   LLVM_READOBJ_TYPE_CASE(MIPS_SYMTABNO);
1540   LLVM_READOBJ_TYPE_CASE(MIPS_UNREFEXTNO);
1541   LLVM_READOBJ_TYPE_CASE(MIPS_GOTSYM);
1542   LLVM_READOBJ_TYPE_CASE(MIPS_RLD_MAP);
1543   LLVM_READOBJ_TYPE_CASE(MIPS_PLTGOT);
1544   LLVM_READOBJ_TYPE_CASE(MIPS_OPTIONS);
1545   default: return "unknown";
1546   }
1547 }
1548 
1549 #undef LLVM_READOBJ_TYPE_CASE
1550 
1551 #define LLVM_READOBJ_DT_FLAG_ENT(prefix, enum) \
1552   { #enum, prefix##_##enum }
1553 
1554 static const EnumEntry<unsigned> ElfDynamicDTFlags[] = {
1555   LLVM_READOBJ_DT_FLAG_ENT(DF, ORIGIN),
1556   LLVM_READOBJ_DT_FLAG_ENT(DF, SYMBOLIC),
1557   LLVM_READOBJ_DT_FLAG_ENT(DF, TEXTREL),
1558   LLVM_READOBJ_DT_FLAG_ENT(DF, BIND_NOW),
1559   LLVM_READOBJ_DT_FLAG_ENT(DF, STATIC_TLS)
1560 };
1561 
1562 static const EnumEntry<unsigned> ElfDynamicDTFlags1[] = {
1563   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NOW),
1564   LLVM_READOBJ_DT_FLAG_ENT(DF_1, GLOBAL),
1565   LLVM_READOBJ_DT_FLAG_ENT(DF_1, GROUP),
1566   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NODELETE),
1567   LLVM_READOBJ_DT_FLAG_ENT(DF_1, LOADFLTR),
1568   LLVM_READOBJ_DT_FLAG_ENT(DF_1, INITFIRST),
1569   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NOOPEN),
1570   LLVM_READOBJ_DT_FLAG_ENT(DF_1, ORIGIN),
1571   LLVM_READOBJ_DT_FLAG_ENT(DF_1, DIRECT),
1572   LLVM_READOBJ_DT_FLAG_ENT(DF_1, TRANS),
1573   LLVM_READOBJ_DT_FLAG_ENT(DF_1, INTERPOSE),
1574   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NODEFLIB),
1575   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NODUMP),
1576   LLVM_READOBJ_DT_FLAG_ENT(DF_1, CONFALT),
1577   LLVM_READOBJ_DT_FLAG_ENT(DF_1, ENDFILTEE),
1578   LLVM_READOBJ_DT_FLAG_ENT(DF_1, DISPRELDNE),
1579   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NODIRECT),
1580   LLVM_READOBJ_DT_FLAG_ENT(DF_1, IGNMULDEF),
1581   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NOKSYMS),
1582   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NOHDR),
1583   LLVM_READOBJ_DT_FLAG_ENT(DF_1, EDITED),
1584   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NORELOC),
1585   LLVM_READOBJ_DT_FLAG_ENT(DF_1, SYMINTPOSE),
1586   LLVM_READOBJ_DT_FLAG_ENT(DF_1, GLOBAUDIT),
1587   LLVM_READOBJ_DT_FLAG_ENT(DF_1, SINGLETON)
1588 };
1589 
1590 static const EnumEntry<unsigned> ElfDynamicDTMipsFlags[] = {
1591   LLVM_READOBJ_DT_FLAG_ENT(RHF, NONE),
1592   LLVM_READOBJ_DT_FLAG_ENT(RHF, QUICKSTART),
1593   LLVM_READOBJ_DT_FLAG_ENT(RHF, NOTPOT),
1594   LLVM_READOBJ_DT_FLAG_ENT(RHS, NO_LIBRARY_REPLACEMENT),
1595   LLVM_READOBJ_DT_FLAG_ENT(RHF, NO_MOVE),
1596   LLVM_READOBJ_DT_FLAG_ENT(RHF, SGI_ONLY),
1597   LLVM_READOBJ_DT_FLAG_ENT(RHF, GUARANTEE_INIT),
1598   LLVM_READOBJ_DT_FLAG_ENT(RHF, DELTA_C_PLUS_PLUS),
1599   LLVM_READOBJ_DT_FLAG_ENT(RHF, GUARANTEE_START_INIT),
1600   LLVM_READOBJ_DT_FLAG_ENT(RHF, PIXIE),
1601   LLVM_READOBJ_DT_FLAG_ENT(RHF, DEFAULT_DELAY_LOAD),
1602   LLVM_READOBJ_DT_FLAG_ENT(RHF, REQUICKSTART),
1603   LLVM_READOBJ_DT_FLAG_ENT(RHF, REQUICKSTARTED),
1604   LLVM_READOBJ_DT_FLAG_ENT(RHF, CORD),
1605   LLVM_READOBJ_DT_FLAG_ENT(RHF, NO_UNRES_UNDEF),
1606   LLVM_READOBJ_DT_FLAG_ENT(RHF, RLD_ORDER_SAFE)
1607 };
1608 
1609 #undef LLVM_READOBJ_DT_FLAG_ENT
1610 
1611 template <typename T, typename TFlag>
1612 void printFlags(T Value, ArrayRef<EnumEntry<TFlag>> Flags, raw_ostream &OS) {
1613   typedef EnumEntry<TFlag> FlagEntry;
1614   typedef SmallVector<FlagEntry, 10> FlagVector;
1615   FlagVector SetFlags;
1616 
1617   for (const auto &Flag : Flags) {
1618     if (Flag.Value == 0)
1619       continue;
1620 
1621     if ((Value & Flag.Value) == Flag.Value)
1622       SetFlags.push_back(Flag);
1623   }
1624 
1625   for (const auto &Flag : SetFlags) {
1626     OS << Flag.Name << " ";
1627   }
1628 }
1629 
1630 template <class ELFT>
1631 StringRef ELFDumper<ELFT>::getDynamicString(uint64_t Value) const {
1632   if (Value >= DynamicStringTable.size())
1633     reportError("Invalid dynamic string table reference");
1634   return StringRef(DynamicStringTable.data() + Value);
1635 }
1636 
1637 template <class ELFT>
1638 void ELFDumper<ELFT>::printValue(uint64_t Type, uint64_t Value) {
1639   raw_ostream &OS = W.getOStream();
1640   const char* ConvChar = (opts::Output == opts::GNU) ? "0x%" PRIx64 : "0x%" PRIX64;
1641   switch (Type) {
1642   case DT_PLTREL:
1643     if (Value == DT_REL) {
1644       OS << "REL";
1645       break;
1646     } else if (Value == DT_RELA) {
1647       OS << "RELA";
1648       break;
1649     }
1650   // Fallthrough.
1651   case DT_PLTGOT:
1652   case DT_HASH:
1653   case DT_STRTAB:
1654   case DT_SYMTAB:
1655   case DT_RELA:
1656   case DT_INIT:
1657   case DT_FINI:
1658   case DT_REL:
1659   case DT_JMPREL:
1660   case DT_INIT_ARRAY:
1661   case DT_FINI_ARRAY:
1662   case DT_PREINIT_ARRAY:
1663   case DT_DEBUG:
1664   case DT_VERDEF:
1665   case DT_VERNEED:
1666   case DT_VERSYM:
1667   case DT_GNU_HASH:
1668   case DT_NULL:
1669   case DT_MIPS_BASE_ADDRESS:
1670   case DT_MIPS_GOTSYM:
1671   case DT_MIPS_RLD_MAP:
1672   case DT_MIPS_RLD_MAP_REL:
1673   case DT_MIPS_PLTGOT:
1674   case DT_MIPS_OPTIONS:
1675     OS << format(ConvChar, Value);
1676     break;
1677   case DT_RELACOUNT:
1678   case DT_RELCOUNT:
1679   case DT_VERDEFNUM:
1680   case DT_VERNEEDNUM:
1681   case DT_MIPS_RLD_VERSION:
1682   case DT_MIPS_LOCAL_GOTNO:
1683   case DT_MIPS_SYMTABNO:
1684   case DT_MIPS_UNREFEXTNO:
1685     OS << Value;
1686     break;
1687   case DT_PLTRELSZ:
1688   case DT_RELASZ:
1689   case DT_RELAENT:
1690   case DT_STRSZ:
1691   case DT_SYMENT:
1692   case DT_RELSZ:
1693   case DT_RELENT:
1694   case DT_INIT_ARRAYSZ:
1695   case DT_FINI_ARRAYSZ:
1696   case DT_PREINIT_ARRAYSZ:
1697     OS << Value << " (bytes)";
1698     break;
1699   case DT_NEEDED:
1700     OS << "SharedLibrary (" << getDynamicString(Value) << ")";
1701     break;
1702   case DT_SONAME:
1703     OS << "LibrarySoname (" << getDynamicString(Value) << ")";
1704     break;
1705   case DT_RPATH:
1706   case DT_RUNPATH:
1707     OS << getDynamicString(Value);
1708     break;
1709   case DT_MIPS_FLAGS:
1710     printFlags(Value, makeArrayRef(ElfDynamicDTMipsFlags), OS);
1711     break;
1712   case DT_FLAGS:
1713     printFlags(Value, makeArrayRef(ElfDynamicDTFlags), OS);
1714     break;
1715   case DT_FLAGS_1:
1716     printFlags(Value, makeArrayRef(ElfDynamicDTFlags1), OS);
1717     break;
1718   default:
1719     OS << format(ConvChar, Value);
1720     break;
1721   }
1722 }
1723 
1724 template<class ELFT>
1725 void ELFDumper<ELFT>::printUnwindInfo() {
1726   W.startLine() << "UnwindInfo not implemented.\n";
1727 }
1728 
1729 namespace {
1730 template <> void ELFDumper<ELFType<support::little, false>>::printUnwindInfo() {
1731   const unsigned Machine = Obj->getHeader()->e_machine;
1732   if (Machine == EM_ARM) {
1733     ARM::EHABI::PrinterContext<ELFType<support::little, false>> Ctx(
1734         W, Obj, DotSymtabSec);
1735     return Ctx.PrintUnwindInformation();
1736   }
1737   W.startLine() << "UnwindInfo not implemented.\n";
1738 }
1739 }
1740 
1741 template<class ELFT>
1742 void ELFDumper<ELFT>::printDynamicTable() {
1743   auto I = dynamic_table().begin();
1744   auto E = dynamic_table().end();
1745 
1746   if (I == E)
1747     return;
1748 
1749   --E;
1750   while (I != E && E->getTag() == ELF::DT_NULL)
1751     --E;
1752   if (E->getTag() != ELF::DT_NULL)
1753     ++E;
1754   ++E;
1755 
1756   ptrdiff_t Total = std::distance(I, E);
1757   if (Total == 0)
1758     return;
1759 
1760   raw_ostream &OS = W.getOStream();
1761   W.startLine() << "DynamicSection [ (" << Total << " entries)\n";
1762 
1763   bool Is64 = ELFT::Is64Bits;
1764 
1765   W.startLine()
1766      << "  Tag" << (Is64 ? "                " : "        ") << "Type"
1767      << "                 " << "Name/Value\n";
1768   while (I != E) {
1769     const Elf_Dyn &Entry = *I;
1770     uintX_t Tag = Entry.getTag();
1771     ++I;
1772     W.startLine() << "  " << format_hex(Tag, Is64 ? 18 : 10, opts::Output != opts::GNU) << " "
1773                   << format("%-21s", getTypeString(Tag));
1774     printValue(Tag, Entry.getVal());
1775     OS << "\n";
1776   }
1777 
1778   W.startLine() << "]\n";
1779 }
1780 
1781 template<class ELFT>
1782 void ELFDumper<ELFT>::printNeededLibraries() {
1783   ListScope D(W, "NeededLibraries");
1784 
1785   typedef std::vector<StringRef> LibsTy;
1786   LibsTy Libs;
1787 
1788   for (const auto &Entry : dynamic_table())
1789     if (Entry.d_tag == ELF::DT_NEEDED)
1790       Libs.push_back(getDynamicString(Entry.d_un.d_val));
1791 
1792   std::stable_sort(Libs.begin(), Libs.end());
1793 
1794   for (const auto &L : Libs) {
1795     outs() << "  " << L << "\n";
1796   }
1797 }
1798 
1799 
1800 template <typename ELFT>
1801 void ELFDumper<ELFT>::printHashTable() {
1802   DictScope D(W, "HashTable");
1803   if (!HashTable)
1804     return;
1805   W.printNumber("Num Buckets", HashTable->nbucket);
1806   W.printNumber("Num Chains", HashTable->nchain);
1807   W.printList("Buckets", HashTable->buckets());
1808   W.printList("Chains", HashTable->chains());
1809 }
1810 
1811 template <typename ELFT>
1812 void ELFDumper<ELFT>::printGnuHashTable() {
1813   DictScope D(W, "GnuHashTable");
1814   if (!GnuHashTable)
1815     return;
1816   W.printNumber("Num Buckets", GnuHashTable->nbuckets);
1817   W.printNumber("First Hashed Symbol Index", GnuHashTable->symndx);
1818   W.printNumber("Num Mask Words", GnuHashTable->maskwords);
1819   W.printNumber("Shift Count", GnuHashTable->shift2);
1820   W.printHexList("Bloom Filter", GnuHashTable->filter());
1821   W.printList("Buckets", GnuHashTable->buckets());
1822   Elf_Sym_Range Syms = dynamic_symbols();
1823   unsigned NumSyms = std::distance(Syms.begin(), Syms.end());
1824   if (!NumSyms)
1825     reportError("No dynamic symbol section");
1826   W.printHexList("Values", GnuHashTable->values(NumSyms));
1827 }
1828 
1829 template <typename ELFT> void ELFDumper<ELFT>::printLoadName() {
1830   outs() << "LoadName: " << SOName << '\n';
1831 }
1832 
1833 template <class ELFT>
1834 void ELFDumper<ELFT>::printAttributes() {
1835   W.startLine() << "Attributes not implemented.\n";
1836 }
1837 
1838 namespace {
1839 template <> void ELFDumper<ELFType<support::little, false>>::printAttributes() {
1840   if (Obj->getHeader()->e_machine != EM_ARM) {
1841     W.startLine() << "Attributes not implemented.\n";
1842     return;
1843   }
1844 
1845   DictScope BA(W, "BuildAttributes");
1846   for (const ELFO::Elf_Shdr &Sec : Obj->sections()) {
1847     if (Sec.sh_type != ELF::SHT_ARM_ATTRIBUTES)
1848       continue;
1849 
1850     ArrayRef<uint8_t> Contents = unwrapOrError(Obj->getSectionContents(&Sec));
1851     if (Contents[0] != ARMBuildAttrs::Format_Version) {
1852       errs() << "unrecognised FormatVersion: 0x" << utohexstr(Contents[0])
1853              << '\n';
1854       continue;
1855     }
1856 
1857     W.printHex("FormatVersion", Contents[0]);
1858     if (Contents.size() == 1)
1859       continue;
1860 
1861     ARMAttributeParser(W).Parse(Contents);
1862   }
1863 }
1864 }
1865 
1866 namespace {
1867 template <class ELFT> class MipsGOTParser {
1868 public:
1869   typedef object::ELFFile<ELFT> ELFO;
1870   typedef typename ELFO::Elf_Shdr Elf_Shdr;
1871   typedef typename ELFO::Elf_Sym Elf_Sym;
1872   typedef typename ELFO::Elf_Dyn_Range Elf_Dyn_Range;
1873   typedef typename ELFO::Elf_Addr GOTEntry;
1874   typedef typename ELFO::Elf_Rel Elf_Rel;
1875   typedef typename ELFO::Elf_Rela Elf_Rela;
1876 
1877   MipsGOTParser(ELFDumper<ELFT> *Dumper, const ELFO *Obj,
1878                 Elf_Dyn_Range DynTable, ScopedPrinter &W);
1879 
1880   void parseGOT();
1881   void parsePLT();
1882 
1883 private:
1884   ELFDumper<ELFT> *Dumper;
1885   const ELFO *Obj;
1886   ScopedPrinter &W;
1887   llvm::Optional<uint64_t> DtPltGot;
1888   llvm::Optional<uint64_t> DtLocalGotNum;
1889   llvm::Optional<uint64_t> DtGotSym;
1890   llvm::Optional<uint64_t> DtMipsPltGot;
1891   llvm::Optional<uint64_t> DtJmpRel;
1892 
1893   std::size_t getGOTTotal(ArrayRef<uint8_t> GOT) const;
1894   const GOTEntry *makeGOTIter(ArrayRef<uint8_t> GOT, std::size_t EntryNum);
1895 
1896   void printGotEntry(uint64_t GotAddr, const GOTEntry *BeginIt,
1897                      const GOTEntry *It);
1898   void printGlobalGotEntry(uint64_t GotAddr, const GOTEntry *BeginIt,
1899                            const GOTEntry *It, const Elf_Sym *Sym,
1900                            StringRef StrTable, bool IsDynamic);
1901   void printPLTEntry(uint64_t PLTAddr, const GOTEntry *BeginIt,
1902                      const GOTEntry *It, StringRef Purpose);
1903   void printPLTEntry(uint64_t PLTAddr, const GOTEntry *BeginIt,
1904                      const GOTEntry *It, StringRef StrTable,
1905                      const Elf_Sym *Sym);
1906 };
1907 }
1908 
1909 template <class ELFT>
1910 MipsGOTParser<ELFT>::MipsGOTParser(ELFDumper<ELFT> *Dumper, const ELFO *Obj,
1911                                    Elf_Dyn_Range DynTable, ScopedPrinter &W)
1912     : Dumper(Dumper), Obj(Obj), W(W) {
1913   for (const auto &Entry : DynTable) {
1914     switch (Entry.getTag()) {
1915     case ELF::DT_PLTGOT:
1916       DtPltGot = Entry.getVal();
1917       break;
1918     case ELF::DT_MIPS_LOCAL_GOTNO:
1919       DtLocalGotNum = Entry.getVal();
1920       break;
1921     case ELF::DT_MIPS_GOTSYM:
1922       DtGotSym = Entry.getVal();
1923       break;
1924     case ELF::DT_MIPS_PLTGOT:
1925       DtMipsPltGot = Entry.getVal();
1926       break;
1927     case ELF::DT_JMPREL:
1928       DtJmpRel = Entry.getVal();
1929       break;
1930     }
1931   }
1932 }
1933 
1934 template <class ELFT> void MipsGOTParser<ELFT>::parseGOT() {
1935   // See "Global Offset Table" in Chapter 5 in the following document
1936   // for detailed GOT description.
1937   // ftp://www.linux-mips.org/pub/linux/mips/doc/ABI/mipsabi.pdf
1938   if (!DtPltGot) {
1939     W.startLine() << "Cannot find PLTGOT dynamic table tag.\n";
1940     return;
1941   }
1942   if (!DtLocalGotNum) {
1943     W.startLine() << "Cannot find MIPS_LOCAL_GOTNO dynamic table tag.\n";
1944     return;
1945   }
1946   if (!DtGotSym) {
1947     W.startLine() << "Cannot find MIPS_GOTSYM dynamic table tag.\n";
1948     return;
1949   }
1950 
1951   StringRef StrTable = Dumper->getDynamicStringTable();
1952   const Elf_Sym *DynSymBegin = Dumper->dynamic_symbols().begin();
1953   const Elf_Sym *DynSymEnd = Dumper->dynamic_symbols().end();
1954   std::size_t DynSymTotal = std::size_t(std::distance(DynSymBegin, DynSymEnd));
1955 
1956   if (*DtGotSym > DynSymTotal)
1957     report_fatal_error("MIPS_GOTSYM exceeds a number of dynamic symbols");
1958 
1959   std::size_t GlobalGotNum = DynSymTotal - *DtGotSym;
1960 
1961   if (*DtLocalGotNum + GlobalGotNum == 0) {
1962     W.startLine() << "GOT is empty.\n";
1963     return;
1964   }
1965 
1966   const Elf_Shdr *GOTShdr = findNotEmptySectionByAddress(Obj, *DtPltGot);
1967   if (!GOTShdr)
1968     report_fatal_error("There is no not empty GOT section at 0x" +
1969                        Twine::utohexstr(*DtPltGot));
1970 
1971   ArrayRef<uint8_t> GOT = unwrapOrError(Obj->getSectionContents(GOTShdr));
1972 
1973   if (*DtLocalGotNum + GlobalGotNum > getGOTTotal(GOT))
1974     report_fatal_error("Number of GOT entries exceeds the size of GOT section");
1975 
1976   const GOTEntry *GotBegin = makeGOTIter(GOT, 0);
1977   const GOTEntry *GotLocalEnd = makeGOTIter(GOT, *DtLocalGotNum);
1978   const GOTEntry *It = GotBegin;
1979 
1980   DictScope GS(W, "Primary GOT");
1981 
1982   W.printHex("Canonical gp value", GOTShdr->sh_addr + 0x7ff0);
1983   {
1984     ListScope RS(W, "Reserved entries");
1985 
1986     {
1987       DictScope D(W, "Entry");
1988       printGotEntry(GOTShdr->sh_addr, GotBegin, It++);
1989       W.printString("Purpose", StringRef("Lazy resolver"));
1990     }
1991 
1992     if (It != GotLocalEnd && (*It >> (sizeof(GOTEntry) * 8 - 1)) != 0) {
1993       DictScope D(W, "Entry");
1994       printGotEntry(GOTShdr->sh_addr, GotBegin, It++);
1995       W.printString("Purpose", StringRef("Module pointer (GNU extension)"));
1996     }
1997   }
1998   {
1999     ListScope LS(W, "Local entries");
2000     for (; It != GotLocalEnd; ++It) {
2001       DictScope D(W, "Entry");
2002       printGotEntry(GOTShdr->sh_addr, GotBegin, It);
2003     }
2004   }
2005   {
2006     ListScope GS(W, "Global entries");
2007 
2008     const GOTEntry *GotGlobalEnd =
2009         makeGOTIter(GOT, *DtLocalGotNum + GlobalGotNum);
2010     const Elf_Sym *GotDynSym = DynSymBegin + *DtGotSym;
2011     for (; It != GotGlobalEnd; ++It) {
2012       DictScope D(W, "Entry");
2013       printGlobalGotEntry(GOTShdr->sh_addr, GotBegin, It, GotDynSym++, StrTable,
2014                           true);
2015     }
2016   }
2017 
2018   std::size_t SpecGotNum = getGOTTotal(GOT) - *DtLocalGotNum - GlobalGotNum;
2019   W.printNumber("Number of TLS and multi-GOT entries", uint64_t(SpecGotNum));
2020 }
2021 
2022 template <class ELFT> void MipsGOTParser<ELFT>::parsePLT() {
2023   if (!DtMipsPltGot) {
2024     W.startLine() << "Cannot find MIPS_PLTGOT dynamic table tag.\n";
2025     return;
2026   }
2027   if (!DtJmpRel) {
2028     W.startLine() << "Cannot find JMPREL dynamic table tag.\n";
2029     return;
2030   }
2031 
2032   const Elf_Shdr *PLTShdr = findNotEmptySectionByAddress(Obj, *DtMipsPltGot);
2033   if (!PLTShdr)
2034     report_fatal_error("There is no not empty PLTGOT section at 0x " +
2035                        Twine::utohexstr(*DtMipsPltGot));
2036   ArrayRef<uint8_t> PLT = unwrapOrError(Obj->getSectionContents(PLTShdr));
2037 
2038   const Elf_Shdr *PLTRelShdr = findNotEmptySectionByAddress(Obj, *DtJmpRel);
2039   if (!PLTRelShdr)
2040     report_fatal_error("There is no not empty RELPLT section at 0x" +
2041                        Twine::utohexstr(*DtJmpRel));
2042   const Elf_Shdr *SymTable =
2043       unwrapOrError(Obj->getSection(PLTRelShdr->sh_link));
2044   StringRef StrTable = unwrapOrError(Obj->getStringTableForSymtab(*SymTable));
2045 
2046   const GOTEntry *PLTBegin = makeGOTIter(PLT, 0);
2047   const GOTEntry *PLTEnd = makeGOTIter(PLT, getGOTTotal(PLT));
2048   const GOTEntry *It = PLTBegin;
2049 
2050   DictScope GS(W, "PLT GOT");
2051   {
2052     ListScope RS(W, "Reserved entries");
2053     printPLTEntry(PLTShdr->sh_addr, PLTBegin, It++, "PLT lazy resolver");
2054     if (It != PLTEnd)
2055       printPLTEntry(PLTShdr->sh_addr, PLTBegin, It++, "Module pointer");
2056   }
2057   {
2058     ListScope GS(W, "Entries");
2059 
2060     switch (PLTRelShdr->sh_type) {
2061     case ELF::SHT_REL:
2062       for (const Elf_Rel *RI = Obj->rel_begin(PLTRelShdr),
2063                          *RE = Obj->rel_end(PLTRelShdr);
2064            RI != RE && It != PLTEnd; ++RI, ++It) {
2065         const Elf_Sym *Sym = Obj->getRelocationSymbol(&*RI, SymTable);
2066         printPLTEntry(PLTShdr->sh_addr, PLTBegin, It, StrTable, Sym);
2067       }
2068       break;
2069     case ELF::SHT_RELA:
2070       for (const Elf_Rela *RI = Obj->rela_begin(PLTRelShdr),
2071                           *RE = Obj->rela_end(PLTRelShdr);
2072            RI != RE && It != PLTEnd; ++RI, ++It) {
2073         const Elf_Sym *Sym = Obj->getRelocationSymbol(&*RI, SymTable);
2074         printPLTEntry(PLTShdr->sh_addr, PLTBegin, It, StrTable, Sym);
2075       }
2076       break;
2077     }
2078   }
2079 }
2080 
2081 template <class ELFT>
2082 std::size_t MipsGOTParser<ELFT>::getGOTTotal(ArrayRef<uint8_t> GOT) const {
2083   return GOT.size() / sizeof(GOTEntry);
2084 }
2085 
2086 template <class ELFT>
2087 const typename MipsGOTParser<ELFT>::GOTEntry *
2088 MipsGOTParser<ELFT>::makeGOTIter(ArrayRef<uint8_t> GOT, std::size_t EntryNum) {
2089   const char *Data = reinterpret_cast<const char *>(GOT.data());
2090   return reinterpret_cast<const GOTEntry *>(Data + EntryNum * sizeof(GOTEntry));
2091 }
2092 
2093 template <class ELFT>
2094 void MipsGOTParser<ELFT>::printGotEntry(uint64_t GotAddr,
2095                                         const GOTEntry *BeginIt,
2096                                         const GOTEntry *It) {
2097   int64_t Offset = std::distance(BeginIt, It) * sizeof(GOTEntry);
2098   W.printHex("Address", GotAddr + Offset);
2099   W.printNumber("Access", Offset - 0x7ff0);
2100   W.printHex("Initial", *It);
2101 }
2102 
2103 template <class ELFT>
2104 void MipsGOTParser<ELFT>::printGlobalGotEntry(
2105     uint64_t GotAddr, const GOTEntry *BeginIt, const GOTEntry *It,
2106     const Elf_Sym *Sym, StringRef StrTable, bool IsDynamic) {
2107   printGotEntry(GotAddr, BeginIt, It);
2108 
2109   W.printHex("Value", Sym->st_value);
2110   W.printEnum("Type", Sym->getType(), makeArrayRef(ElfSymbolTypes));
2111 
2112   unsigned SectionIndex = 0;
2113   StringRef SectionName;
2114   getSectionNameIndex(*Obj, Sym, Dumper->dynamic_symbols().begin(),
2115                       Dumper->getShndxTable(), SectionName, SectionIndex);
2116   W.printHex("Section", SectionName, SectionIndex);
2117 
2118   std::string FullSymbolName =
2119       Dumper->getFullSymbolName(Sym, StrTable, IsDynamic);
2120   W.printNumber("Name", FullSymbolName, Sym->st_name);
2121 }
2122 
2123 template <class ELFT>
2124 void MipsGOTParser<ELFT>::printPLTEntry(uint64_t PLTAddr,
2125                                         const GOTEntry *BeginIt,
2126                                         const GOTEntry *It, StringRef Purpose) {
2127   DictScope D(W, "Entry");
2128   int64_t Offset = std::distance(BeginIt, It) * sizeof(GOTEntry);
2129   W.printHex("Address", PLTAddr + Offset);
2130   W.printHex("Initial", *It);
2131   W.printString("Purpose", Purpose);
2132 }
2133 
2134 template <class ELFT>
2135 void MipsGOTParser<ELFT>::printPLTEntry(uint64_t PLTAddr,
2136                                         const GOTEntry *BeginIt,
2137                                         const GOTEntry *It, StringRef StrTable,
2138                                         const Elf_Sym *Sym) {
2139   DictScope D(W, "Entry");
2140   int64_t Offset = std::distance(BeginIt, It) * sizeof(GOTEntry);
2141   W.printHex("Address", PLTAddr + Offset);
2142   W.printHex("Initial", *It);
2143   W.printHex("Value", Sym->st_value);
2144   W.printEnum("Type", Sym->getType(), makeArrayRef(ElfSymbolTypes));
2145 
2146   unsigned SectionIndex = 0;
2147   StringRef SectionName;
2148   getSectionNameIndex(*Obj, Sym, Dumper->dynamic_symbols().begin(),
2149                       Dumper->getShndxTable(), SectionName, SectionIndex);
2150   W.printHex("Section", SectionName, SectionIndex);
2151 
2152   std::string FullSymbolName = Dumper->getFullSymbolName(Sym, StrTable, true);
2153   W.printNumber("Name", FullSymbolName, Sym->st_name);
2154 }
2155 
2156 template <class ELFT> void ELFDumper<ELFT>::printMipsPLTGOT() {
2157   if (Obj->getHeader()->e_machine != EM_MIPS) {
2158     W.startLine() << "MIPS PLT GOT is available for MIPS targets only.\n";
2159     return;
2160   }
2161 
2162   MipsGOTParser<ELFT> GOTParser(this, Obj, dynamic_table(), W);
2163   GOTParser.parseGOT();
2164   GOTParser.parsePLT();
2165 }
2166 
2167 static const EnumEntry<unsigned> ElfMipsISAExtType[] = {
2168   {"None",                    Mips::AFL_EXT_NONE},
2169   {"Broadcom SB-1",           Mips::AFL_EXT_SB1},
2170   {"Cavium Networks Octeon",  Mips::AFL_EXT_OCTEON},
2171   {"Cavium Networks Octeon2", Mips::AFL_EXT_OCTEON2},
2172   {"Cavium Networks OcteonP", Mips::AFL_EXT_OCTEONP},
2173   {"Cavium Networks Octeon3", Mips::AFL_EXT_OCTEON3},
2174   {"LSI R4010",               Mips::AFL_EXT_4010},
2175   {"Loongson 2E",             Mips::AFL_EXT_LOONGSON_2E},
2176   {"Loongson 2F",             Mips::AFL_EXT_LOONGSON_2F},
2177   {"Loongson 3A",             Mips::AFL_EXT_LOONGSON_3A},
2178   {"MIPS R4650",              Mips::AFL_EXT_4650},
2179   {"MIPS R5900",              Mips::AFL_EXT_5900},
2180   {"MIPS R10000",             Mips::AFL_EXT_10000},
2181   {"NEC VR4100",              Mips::AFL_EXT_4100},
2182   {"NEC VR4111/VR4181",       Mips::AFL_EXT_4111},
2183   {"NEC VR4120",              Mips::AFL_EXT_4120},
2184   {"NEC VR5400",              Mips::AFL_EXT_5400},
2185   {"NEC VR5500",              Mips::AFL_EXT_5500},
2186   {"RMI Xlr",                 Mips::AFL_EXT_XLR},
2187   {"Toshiba R3900",           Mips::AFL_EXT_3900}
2188 };
2189 
2190 static const EnumEntry<unsigned> ElfMipsASEFlags[] = {
2191   {"DSP",                Mips::AFL_ASE_DSP},
2192   {"DSPR2",              Mips::AFL_ASE_DSPR2},
2193   {"Enhanced VA Scheme", Mips::AFL_ASE_EVA},
2194   {"MCU",                Mips::AFL_ASE_MCU},
2195   {"MDMX",               Mips::AFL_ASE_MDMX},
2196   {"MIPS-3D",            Mips::AFL_ASE_MIPS3D},
2197   {"MT",                 Mips::AFL_ASE_MT},
2198   {"SmartMIPS",          Mips::AFL_ASE_SMARTMIPS},
2199   {"VZ",                 Mips::AFL_ASE_VIRT},
2200   {"MSA",                Mips::AFL_ASE_MSA},
2201   {"MIPS16",             Mips::AFL_ASE_MIPS16},
2202   {"microMIPS",          Mips::AFL_ASE_MICROMIPS},
2203   {"XPA",                Mips::AFL_ASE_XPA}
2204 };
2205 
2206 static const EnumEntry<unsigned> ElfMipsFpABIType[] = {
2207   {"Hard or soft float",                  Mips::Val_GNU_MIPS_ABI_FP_ANY},
2208   {"Hard float (double precision)",       Mips::Val_GNU_MIPS_ABI_FP_DOUBLE},
2209   {"Hard float (single precision)",       Mips::Val_GNU_MIPS_ABI_FP_SINGLE},
2210   {"Soft float",                          Mips::Val_GNU_MIPS_ABI_FP_SOFT},
2211   {"Hard float (MIPS32r2 64-bit FPU 12 callee-saved)",
2212    Mips::Val_GNU_MIPS_ABI_FP_OLD_64},
2213   {"Hard float (32-bit CPU, Any FPU)",    Mips::Val_GNU_MIPS_ABI_FP_XX},
2214   {"Hard float (32-bit CPU, 64-bit FPU)", Mips::Val_GNU_MIPS_ABI_FP_64},
2215   {"Hard float compat (32-bit CPU, 64-bit FPU)",
2216    Mips::Val_GNU_MIPS_ABI_FP_64A}
2217 };
2218 
2219 static const EnumEntry<unsigned> ElfMipsFlags1[] {
2220   {"ODDSPREG", Mips::AFL_FLAGS1_ODDSPREG},
2221 };
2222 
2223 static int getMipsRegisterSize(uint8_t Flag) {
2224   switch (Flag) {
2225   case Mips::AFL_REG_NONE:
2226     return 0;
2227   case Mips::AFL_REG_32:
2228     return 32;
2229   case Mips::AFL_REG_64:
2230     return 64;
2231   case Mips::AFL_REG_128:
2232     return 128;
2233   default:
2234     return -1;
2235   }
2236 }
2237 
2238 template <class ELFT> void ELFDumper<ELFT>::printMipsABIFlags() {
2239   const Elf_Shdr *Shdr = findSectionByName(*Obj, ".MIPS.abiflags");
2240   if (!Shdr) {
2241     W.startLine() << "There is no .MIPS.abiflags section in the file.\n";
2242     return;
2243   }
2244   ArrayRef<uint8_t> Sec = unwrapOrError(Obj->getSectionContents(Shdr));
2245   if (Sec.size() != sizeof(Elf_Mips_ABIFlags<ELFT>)) {
2246     W.startLine() << "The .MIPS.abiflags section has a wrong size.\n";
2247     return;
2248   }
2249 
2250   auto *Flags = reinterpret_cast<const Elf_Mips_ABIFlags<ELFT> *>(Sec.data());
2251 
2252   raw_ostream &OS = W.getOStream();
2253   DictScope GS(W, "MIPS ABI Flags");
2254 
2255   W.printNumber("Version", Flags->version);
2256   W.startLine() << "ISA: ";
2257   if (Flags->isa_rev <= 1)
2258     OS << format("MIPS%u", Flags->isa_level);
2259   else
2260     OS << format("MIPS%ur%u", Flags->isa_level, Flags->isa_rev);
2261   OS << "\n";
2262   W.printEnum("ISA Extension", Flags->isa_ext, makeArrayRef(ElfMipsISAExtType));
2263   W.printFlags("ASEs", Flags->ases, makeArrayRef(ElfMipsASEFlags));
2264   W.printEnum("FP ABI", Flags->fp_abi, makeArrayRef(ElfMipsFpABIType));
2265   W.printNumber("GPR size", getMipsRegisterSize(Flags->gpr_size));
2266   W.printNumber("CPR1 size", getMipsRegisterSize(Flags->cpr1_size));
2267   W.printNumber("CPR2 size", getMipsRegisterSize(Flags->cpr2_size));
2268   W.printFlags("Flags 1", Flags->flags1, makeArrayRef(ElfMipsFlags1));
2269   W.printHex("Flags 2", Flags->flags2);
2270 }
2271 
2272 template <class ELFT>
2273 static void printMipsReginfoData(ScopedPrinter &W,
2274                                  const Elf_Mips_RegInfo<ELFT> &Reginfo) {
2275   W.printHex("GP", Reginfo.ri_gp_value);
2276   W.printHex("General Mask", Reginfo.ri_gprmask);
2277   W.printHex("Co-Proc Mask0", Reginfo.ri_cprmask[0]);
2278   W.printHex("Co-Proc Mask1", Reginfo.ri_cprmask[1]);
2279   W.printHex("Co-Proc Mask2", Reginfo.ri_cprmask[2]);
2280   W.printHex("Co-Proc Mask3", Reginfo.ri_cprmask[3]);
2281 }
2282 
2283 template <class ELFT> void ELFDumper<ELFT>::printMipsReginfo() {
2284   const Elf_Shdr *Shdr = findSectionByName(*Obj, ".reginfo");
2285   if (!Shdr) {
2286     W.startLine() << "There is no .reginfo section in the file.\n";
2287     return;
2288   }
2289   ArrayRef<uint8_t> Sec = unwrapOrError(Obj->getSectionContents(Shdr));
2290   if (Sec.size() != sizeof(Elf_Mips_RegInfo<ELFT>)) {
2291     W.startLine() << "The .reginfo section has a wrong size.\n";
2292     return;
2293   }
2294 
2295   DictScope GS(W, "MIPS RegInfo");
2296   auto *Reginfo = reinterpret_cast<const Elf_Mips_RegInfo<ELFT> *>(Sec.data());
2297   printMipsReginfoData(W, *Reginfo);
2298 }
2299 
2300 template <class ELFT> void ELFDumper<ELFT>::printMipsOptions() {
2301   const Elf_Shdr *Shdr = findSectionByName(*Obj, ".MIPS.options");
2302   if (!Shdr) {
2303     W.startLine() << "There is no .MIPS.options section in the file.\n";
2304     return;
2305   }
2306 
2307   DictScope GS(W, "MIPS Options");
2308 
2309   ArrayRef<uint8_t> Sec = unwrapOrError(Obj->getSectionContents(Shdr));
2310   while (!Sec.empty()) {
2311     if (Sec.size() < sizeof(Elf_Mips_Options<ELFT>)) {
2312       W.startLine() << "The .MIPS.options section has a wrong size.\n";
2313       return;
2314     }
2315     auto *O = reinterpret_cast<const Elf_Mips_Options<ELFT> *>(Sec.data());
2316     DictScope GS(W, getElfMipsOptionsOdkType(O->kind));
2317     switch (O->kind) {
2318     case ODK_REGINFO:
2319       printMipsReginfoData(W, O->getRegInfo());
2320       break;
2321     default:
2322       W.startLine() << "Unsupported MIPS options tag.\n";
2323       break;
2324     }
2325     Sec = Sec.slice(O->size);
2326   }
2327 }
2328 
2329 template <class ELFT> void ELFDumper<ELFT>::printStackMap() const {
2330   const Elf_Shdr *StackMapSection = nullptr;
2331   for (const auto &Sec : Obj->sections()) {
2332     StringRef Name = unwrapOrError(Obj->getSectionName(&Sec));
2333     if (Name == ".llvm_stackmaps") {
2334       StackMapSection = &Sec;
2335       break;
2336     }
2337   }
2338 
2339   if (!StackMapSection)
2340     return;
2341 
2342   StringRef StackMapContents;
2343   ArrayRef<uint8_t> StackMapContentsArray =
2344       unwrapOrError(Obj->getSectionContents(StackMapSection));
2345 
2346   prettyPrintStackMap(llvm::outs(), StackMapV1Parser<ELFT::TargetEndianness>(
2347                                         StackMapContentsArray));
2348 }
2349 
2350 template <class ELFT> void ELFDumper<ELFT>::printGroupSections() {
2351   ELFDumperStyle->printGroupSections(Obj);
2352 }
2353 
2354 static inline void printFields(formatted_raw_ostream &OS, StringRef Str1,
2355                                StringRef Str2) {
2356   OS.PadToColumn(2u);
2357   OS << Str1;
2358   OS.PadToColumn(37u);
2359   OS << Str2 << "\n";
2360   OS.flush();
2361 }
2362 
2363 template <class ELFT> void GNUStyle<ELFT>::printFileHeaders(const ELFO *Obj) {
2364   const Elf_Ehdr *e = Obj->getHeader();
2365   OS << "ELF Header:\n";
2366   OS << "  Magic:  ";
2367   std::string Str;
2368   for (int i = 0; i < ELF::EI_NIDENT; i++)
2369     OS << format(" %02x", static_cast<int>(e->e_ident[i]));
2370   OS << "\n";
2371   Str = printEnum(e->e_ident[ELF::EI_CLASS], makeArrayRef(ElfClass));
2372   printFields(OS, "Class:", Str);
2373   Str = printEnum(e->e_ident[ELF::EI_DATA], makeArrayRef(ElfDataEncoding));
2374   printFields(OS, "Data:", Str);
2375   OS.PadToColumn(2u);
2376   OS << "Version:";
2377   OS.PadToColumn(37u);
2378   OS << to_hexString(e->e_ident[ELF::EI_VERSION]);
2379   if (e->e_version == ELF::EV_CURRENT)
2380     OS << " (current)";
2381   OS << "\n";
2382   Str = printEnum(e->e_ident[ELF::EI_OSABI], makeArrayRef(ElfOSABI));
2383   printFields(OS, "OS/ABI:", Str);
2384   Str = "0x" + to_hexString(e->e_version);
2385   Str = to_hexString(e->e_ident[ELF::EI_ABIVERSION]);
2386   printFields(OS, "ABI Version:", Str);
2387   Str = printEnum(e->e_type, makeArrayRef(ElfObjectFileType));
2388   printFields(OS, "Type:", Str);
2389   Str = printEnum(e->e_machine, makeArrayRef(ElfMachineType));
2390   printFields(OS, "Machine:", Str);
2391   Str = "0x" + to_hexString(e->e_version);
2392   printFields(OS, "Version:", Str);
2393   Str = "0x" + to_hexString(e->e_entry);
2394   printFields(OS, "Entry point address:", Str);
2395   Str = to_string(e->e_phoff) + " (bytes into file)";
2396   printFields(OS, "Start of program headers:", Str);
2397   Str = to_string(e->e_shoff) + " (bytes into file)";
2398   printFields(OS, "Start of section headers:", Str);
2399   Str = "0x" + to_hexString(e->e_flags);
2400   printFields(OS, "Flags:", Str);
2401   Str = to_string(e->e_ehsize) + " (bytes)";
2402   printFields(OS, "Size of this header:", Str);
2403   Str = to_string(e->e_phentsize) + " (bytes)";
2404   printFields(OS, "Size of program headers:", Str);
2405   Str = to_string(e->e_phnum);
2406   printFields(OS, "Number of program headers:", Str);
2407   Str = to_string(e->e_shentsize) + " (bytes)";
2408   printFields(OS, "Size of section headers:", Str);
2409   Str = to_string(e->e_shnum);
2410   printFields(OS, "Number of section headers:", Str);
2411   Str = to_string(e->e_shstrndx);
2412   printFields(OS, "Section header string table index:", Str);
2413 }
2414 
2415 template <class ELFT> void GNUStyle<ELFT>::printGroupSections(const ELFO *Obj) {
2416   uint32_t SectionIndex = 0;
2417   bool HasGroups = false;
2418   for (const Elf_Shdr &Sec : Obj->sections()) {
2419     if (Sec.sh_type == ELF::SHT_GROUP) {
2420       HasGroups = true;
2421       const Elf_Shdr *Symtab = unwrapOrError(Obj->getSection(Sec.sh_link));
2422       StringRef StrTable = unwrapOrError(Obj->getStringTableForSymtab(*Symtab));
2423       const Elf_Sym *Signature =
2424           Obj->template getEntry<Elf_Sym>(Symtab, Sec.sh_info);
2425       ArrayRef<Elf_Word> Data = unwrapOrError(
2426           Obj->template getSectionContentsAsArray<Elf_Word>(&Sec));
2427       StringRef Name = unwrapOrError(Obj->getSectionName(&Sec));
2428       OS << "\n" << getGroupType(Data[0]) << " group section ["
2429          << format_decimal(SectionIndex, 5) << "] `" << Name << "' ["
2430          << StrTable.data() + Signature->st_name << "] contains "
2431          << (Data.size() - 1) << " sections:\n"
2432          << "   [Index]    Name\n";
2433       for (auto &Ndx : Data.slice(1)) {
2434         auto Sec = unwrapOrError(Obj->getSection(Ndx));
2435         const StringRef Name = unwrapOrError(Obj->getSectionName(Sec));
2436         OS << "   [" << format_decimal(Ndx, 5) << "]   " << Name
2437            << "\n";
2438       }
2439     }
2440     ++SectionIndex;
2441   }
2442   if (!HasGroups)
2443     OS << "There are no section groups in this file.\n";
2444 }
2445 
2446 template <class ELFT>
2447 void GNUStyle<ELFT>::printRelocation(const ELFO *Obj, const Elf_Shdr *SymTab,
2448                                      const Elf_Rela &R, bool IsRela) {
2449   std::string Offset, Info, Addend = "", Value;
2450   SmallString<32> RelocName;
2451   StringRef StrTable = unwrapOrError(Obj->getStringTableForSymtab(*SymTab));
2452   StringRef TargetName;
2453   const Elf_Sym *Sym = nullptr;
2454   unsigned Width = ELFT::Is64Bits ? 16 : 8;
2455   unsigned Bias = ELFT::Is64Bits ? 8 : 0;
2456 
2457   // First two fields are bit width dependent. The rest of them are after are
2458   // fixed width.
2459   Field Fields[5] = {0, 10 + Bias, 19 + 2 * Bias, 42 + 2 * Bias, 53 + 2 * Bias};
2460   Obj->getRelocationTypeName(R.getType(Obj->isMips64EL()), RelocName);
2461   Sym = Obj->getRelocationSymbol(&R, SymTab);
2462   if (Sym && Sym->getType() == ELF::STT_SECTION) {
2463     const Elf_Shdr *Sec = unwrapOrError(
2464         Obj->getSection(Sym, SymTab, this->dumper()->getShndxTable()));
2465     TargetName = unwrapOrError(Obj->getSectionName(Sec));
2466   } else if (Sym) {
2467     TargetName = unwrapOrError(Sym->getName(StrTable));
2468   }
2469 
2470   if (Sym && IsRela) {
2471     if (R.r_addend < 0)
2472       Addend = " - ";
2473     else
2474       Addend = " + ";
2475   }
2476 
2477   Offset = to_string(format_hex_no_prefix(R.r_offset, Width));
2478   Info = to_string(format_hex_no_prefix(R.r_info, Width));
2479 
2480   int64_t RelAddend = R.r_addend;
2481   if (IsRela)
2482     Addend += to_hexString(std::abs(RelAddend), false);
2483 
2484   if (Sym)
2485     Value = to_string(format_hex_no_prefix(Sym->getValue(), Width));
2486 
2487   Fields[0].Str = Offset;
2488   Fields[1].Str = Info;
2489   Fields[2].Str = RelocName;
2490   Fields[3].Str = Value;
2491   Fields[4].Str = TargetName;
2492   for (auto &field : Fields)
2493     printField(field);
2494   OS << Addend;
2495   OS << "\n";
2496 }
2497 
2498 static inline void printRelocHeader(raw_ostream &OS, bool Is64, bool IsRela) {
2499   if (Is64)
2500     OS << "    Offset             Info             Type"
2501        << "               Symbol's Value  Symbol's Name";
2502   else
2503     OS << " Offset     Info    Type                Sym. Value  "
2504        << "Symbol's Name";
2505   if (IsRela)
2506     OS << (IsRela ? " + Addend" : "");
2507   OS << "\n";
2508 }
2509 
2510 template <class ELFT> void GNUStyle<ELFT>::printRelocations(const ELFO *Obj) {
2511   bool HasRelocSections = false;
2512   for (const Elf_Shdr &Sec : Obj->sections()) {
2513     if (Sec.sh_type != ELF::SHT_REL && Sec.sh_type != ELF::SHT_RELA)
2514       continue;
2515     HasRelocSections = true;
2516     StringRef Name = unwrapOrError(Obj->getSectionName(&Sec));
2517     unsigned Entries = Sec.getEntityCount();
2518     uintX_t Offset = Sec.sh_offset;
2519     OS << "\nRelocation section '" << Name << "' at offset 0x"
2520        << to_hexString(Offset, false) << " contains " << Entries
2521        << " entries:\n";
2522     printRelocHeader(OS,  ELFT::Is64Bits, (Sec.sh_type == ELF::SHT_RELA));
2523     const Elf_Shdr *SymTab = unwrapOrError(Obj->getSection(Sec.sh_link));
2524     if (Sec.sh_type == ELF::SHT_REL) {
2525       for (const auto &R : Obj->rels(&Sec)) {
2526         Elf_Rela Rela;
2527         Rela.r_offset = R.r_offset;
2528         Rela.r_info = R.r_info;
2529         Rela.r_addend = 0;
2530         printRelocation(Obj, SymTab, Rela, false);
2531       }
2532     } else {
2533       for (const auto &R : Obj->relas(&Sec))
2534         printRelocation(Obj, SymTab, R, true);
2535     }
2536   }
2537   if (!HasRelocSections)
2538     OS << "\nThere are no relocations in this file.\n";
2539 }
2540 
2541 std::string getSectionTypeString(unsigned Arch, unsigned Type) {
2542   using namespace ELF;
2543   switch (Arch) {
2544   case EM_ARM:
2545     switch (Type) {
2546     case SHT_ARM_EXIDX:
2547       return "ARM_EXIDX";
2548     case SHT_ARM_PREEMPTMAP:
2549       return "ARM_PREEMPTMAP";
2550     case SHT_ARM_ATTRIBUTES:
2551       return "ARM_ATTRIBUTES";
2552     case SHT_ARM_DEBUGOVERLAY:
2553       return "ARM_DEBUGOVERLAY";
2554     case SHT_ARM_OVERLAYSECTION:
2555       return "ARM_OVERLAYSECTION";
2556     }
2557   case EM_X86_64:
2558     switch (Type) {
2559     case SHT_X86_64_UNWIND:
2560       return "X86_64_UNWIND";
2561     }
2562   case EM_MIPS:
2563   case EM_MIPS_RS3_LE:
2564     switch (Type) {
2565     case SHT_MIPS_REGINFO:
2566       return "MIPS_REGINFO";
2567     case SHT_MIPS_OPTIONS:
2568       return "MIPS_OPTIONS";
2569     case SHT_MIPS_ABIFLAGS:
2570       return "MIPS_ABIFLAGS";
2571     }
2572   }
2573   switch (Type) {
2574   case SHT_NULL:
2575     return "NULL";
2576   case SHT_PROGBITS:
2577     return "PROGBITS";
2578   case SHT_SYMTAB:
2579     return "SYMTAB";
2580   case SHT_STRTAB:
2581     return "STRTAB";
2582   case SHT_RELA:
2583     return "RELA";
2584   case SHT_HASH:
2585     return "HASH";
2586   case SHT_DYNAMIC:
2587     return "DYNAMIC";
2588   case SHT_NOTE:
2589     return "NOTE";
2590   case SHT_NOBITS:
2591     return "NOBITS";
2592   case SHT_REL:
2593     return "REL";
2594   case SHT_SHLIB:
2595     return "SHLIB";
2596   case SHT_DYNSYM:
2597     return "DYNSYM";
2598   case SHT_INIT_ARRAY:
2599     return "INIT_ARRAY";
2600   case SHT_FINI_ARRAY:
2601     return "FINI_ARRAY";
2602   case SHT_PREINIT_ARRAY:
2603     return "PREINIT_ARRAY";
2604   case SHT_GROUP:
2605     return "GROUP";
2606   case SHT_SYMTAB_SHNDX:
2607     return "SYMTAB SECTION INDICES";
2608   // FIXME: Parse processor specific GNU attributes
2609   case SHT_GNU_ATTRIBUTES:
2610     return "ATTRIBUTES";
2611   case SHT_GNU_HASH:
2612     return "GNU_HASH";
2613   case SHT_GNU_verdef:
2614     return "VERDEF";
2615   case SHT_GNU_verneed:
2616     return "VERNEED";
2617   case SHT_GNU_versym:
2618     return "VERSYM";
2619   default:
2620     return "";
2621   }
2622   return "";
2623 }
2624 
2625 template <class ELFT> void GNUStyle<ELFT>::printSections(const ELFO *Obj) {
2626   size_t SectionIndex = 0;
2627   std::string Number, Type, Size, Address, Offset, Flags, Link, Info, EntrySize,
2628       Alignment;
2629   unsigned Bias;
2630   unsigned Width;
2631 
2632   if (ELFT::Is64Bits) {
2633     Bias = 0;
2634     Width = 16;
2635   } else {
2636     Bias = 8;
2637     Width = 8;
2638   }
2639   OS << "There are " << to_string(Obj->getHeader()->e_shnum)
2640      << " section headers, starting at offset "
2641      << "0x" << to_hexString(Obj->getHeader()->e_shoff, false) << ":\n\n";
2642   OS << "Section Headers:\n";
2643   Field Fields[11] = {{"[Nr]", 2},
2644                       {"Name", 7},
2645                       {"Type", 25},
2646                       {"Address", 41},
2647                       {"Off", 58 - Bias},
2648                       {"Size", 65 - Bias},
2649                       {"ES", 72 - Bias},
2650                       {"Flg", 75 - Bias},
2651                       {"Lk", 79 - Bias},
2652                       {"Inf", 82 - Bias},
2653                       {"Al", 86 - Bias}};
2654   for (auto &f : Fields)
2655     printField(f);
2656   OS << "\n";
2657 
2658   for (const Elf_Shdr &Sec : Obj->sections()) {
2659     Number = to_string(SectionIndex);
2660     Fields[0].Str = Number;
2661     Fields[1].Str = unwrapOrError(Obj->getSectionName(&Sec));
2662     Type = getSectionTypeString(Obj->getHeader()->e_machine, Sec.sh_type);
2663     Fields[2].Str = Type;
2664     Address = to_string(format_hex_no_prefix(Sec.sh_addr, Width));
2665     Fields[3].Str = Address;
2666     Offset = to_string(format_hex_no_prefix(Sec.sh_offset, 6));
2667     Fields[4].Str = Offset;
2668     Size = to_string(format_hex_no_prefix(Sec.sh_size, 6));
2669     Fields[5].Str = Size;
2670     EntrySize = to_string(format_hex_no_prefix(Sec.sh_entsize, 2));
2671     Fields[6].Str = EntrySize;
2672     Flags = getGNUFlags(Sec.sh_flags);
2673     Fields[7].Str = Flags;
2674     Link = to_string(Sec.sh_link);
2675     Fields[8].Str = Link;
2676     Info = to_string(Sec.sh_info);
2677     Fields[9].Str = Info;
2678     Alignment = to_string(Sec.sh_addralign);
2679     Fields[10].Str = Alignment;
2680     OS.PadToColumn(Fields[0].Column);
2681     OS << "[" << right_justify(Fields[0].Str, 2) << "]";
2682     for (int i = 1; i < 7; i++)
2683       printField(Fields[i]);
2684     OS.PadToColumn(Fields[7].Column);
2685     OS << right_justify(Fields[7].Str, 3);
2686     OS.PadToColumn(Fields[8].Column);
2687     OS << right_justify(Fields[8].Str, 2);
2688     OS.PadToColumn(Fields[9].Column);
2689     OS << right_justify(Fields[9].Str, 3);
2690     OS.PadToColumn(Fields[10].Column);
2691     OS << right_justify(Fields[10].Str, 2);
2692     OS << "\n";
2693     ++SectionIndex;
2694   }
2695   OS << "Key to Flags:\n"
2696      << "  W (write), A (alloc), X (execute), M (merge), S (strings), l "
2697         "(large)\n"
2698      << "  I (info), L (link order), G (group), T (TLS), E (exclude),\
2699  x (unknown)\n"
2700      << "  O (extra OS processing required) o (OS specific),\
2701  p (processor specific)\n";
2702 }
2703 
2704 template <class ELFT>
2705 void GNUStyle<ELFT>::printSymtabMessage(const ELFO *Obj, StringRef Name,
2706                                         size_t Entries) {
2707   if (Name.size())
2708     OS << "\nSymbol table '" << Name << "' contains " << Entries
2709        << " entries:\n";
2710   else
2711     OS << "\n Symbol table for image:\n";
2712 
2713   if (ELFT::Is64Bits)
2714     OS << "   Num:    Value          Size Type    Bind   Vis      Ndx Name\n";
2715   else
2716     OS << "   Num:    Value  Size Type    Bind   Vis      Ndx Name\n";
2717 }
2718 
2719 template <class ELFT>
2720 std::string GNUStyle<ELFT>::getSymbolSectionNdx(const ELFO *Obj,
2721                                                 const Elf_Sym *Symbol,
2722                                                 const Elf_Sym *FirstSym) {
2723   unsigned SectionIndex = Symbol->st_shndx;
2724   switch (SectionIndex) {
2725   case ELF::SHN_UNDEF:
2726     return "UND";
2727   case ELF::SHN_ABS:
2728     return "ABS";
2729   case ELF::SHN_COMMON:
2730     return "COM";
2731   case ELF::SHN_XINDEX:
2732     SectionIndex = Obj->getExtendedSymbolTableIndex(
2733         Symbol, FirstSym, this->dumper()->getShndxTable());
2734   default:
2735     // Find if:
2736     // Processor specific
2737     if (SectionIndex >= ELF::SHN_LOPROC && SectionIndex <= ELF::SHN_HIPROC)
2738       return std::string("PRC[0x") +
2739              to_string(format_hex_no_prefix(SectionIndex, 4)) + "]";
2740     // OS specific
2741     if (SectionIndex >= ELF::SHN_LOOS && SectionIndex <= ELF::SHN_HIOS)
2742       return std::string("OS[0x") +
2743              to_string(format_hex_no_prefix(SectionIndex, 4)) + "]";
2744     // Architecture reserved:
2745     if (SectionIndex >= ELF::SHN_LORESERVE &&
2746         SectionIndex <= ELF::SHN_HIRESERVE)
2747       return std::string("RSV[0x") +
2748              to_string(format_hex_no_prefix(SectionIndex, 4)) + "]";
2749     // A normal section with an index
2750     return to_string(format_decimal(SectionIndex, 3));
2751   }
2752 }
2753 
2754 template <class ELFT>
2755 void GNUStyle<ELFT>::printSymbol(const ELFO *Obj, const Elf_Sym *Symbol,
2756                                  const Elf_Sym *FirstSym, StringRef StrTable,
2757                                  bool IsDynamic) {
2758   static int Idx = 0;
2759   static bool Dynamic = true;
2760   size_t Width;
2761 
2762   // If this function was called with a different value from IsDynamic
2763   // from last call, happens when we move from dynamic to static symbol
2764   // table, "Num" field should be reset.
2765   if (!Dynamic != !IsDynamic) {
2766     Idx = 0;
2767     Dynamic = false;
2768   }
2769   std::string Num, Name, Value, Size, Binding, Type, Visibility, Section;
2770   unsigned Bias = 0;
2771   if (ELFT::Is64Bits) {
2772     Bias = 8;
2773     Width = 16;
2774   } else {
2775     Bias = 0;
2776     Width = 8;
2777   }
2778   Field Fields[8] = {0,         8,         17 + Bias, 23 + Bias,
2779                      31 + Bias, 38 + Bias, 47 + Bias, 51 + Bias};
2780   Num = to_string(format_decimal(Idx++, 6)) + ":";
2781   Value = to_string(format_hex_no_prefix(Symbol->st_value, Width));
2782   Size = to_string(format_decimal(Symbol->st_size, 5));
2783   unsigned char SymbolType = Symbol->getType();
2784   if (Obj->getHeader()->e_machine == ELF::EM_AMDGPU &&
2785       SymbolType >= ELF::STT_LOOS && SymbolType < ELF::STT_HIOS)
2786     Type = printEnum(SymbolType, makeArrayRef(AMDGPUSymbolTypes));
2787   else
2788     Type = printEnum(SymbolType, makeArrayRef(ElfSymbolTypes));
2789   unsigned Vis = Symbol->getVisibility();
2790   Binding = printEnum(Symbol->getBinding(), makeArrayRef(ElfSymbolBindings));
2791   Visibility = printEnum(Vis, makeArrayRef(ElfSymbolVisibilities));
2792   Section = getSymbolSectionNdx(Obj, Symbol, FirstSym);
2793   Name = this->dumper()->getFullSymbolName(Symbol, StrTable, IsDynamic);
2794   Fields[0].Str = Num;
2795   Fields[1].Str = Value;
2796   Fields[2].Str = Size;
2797   Fields[3].Str = Type;
2798   Fields[4].Str = Binding;
2799   Fields[5].Str = Visibility;
2800   Fields[6].Str = Section;
2801   Fields[7].Str = Name;
2802   for (auto &Entry : Fields)
2803     printField(Entry);
2804   OS << "\n";
2805 }
2806 
2807 template <class ELFT> void GNUStyle<ELFT>::printSymbols(const ELFO *Obj) {
2808   this->dumper()->printSymbolsHelper(true);
2809   this->dumper()->printSymbolsHelper(false);
2810 }
2811 
2812 template <class ELFT>
2813 void GNUStyle<ELFT>::printDynamicSymbols(const ELFO *Obj) {
2814   this->dumper()->printSymbolsHelper(true);
2815 }
2816 
2817 static inline std::string printPhdrFlags(unsigned Flag) {
2818   std::string Str;
2819   Str = (Flag & PF_R) ? "R" : " ";
2820   Str += (Flag & PF_W) ? "W" : " ";
2821   Str += (Flag & PF_X) ? "E" : " ";
2822   return Str;
2823 }
2824 
2825 // SHF_TLS sections are only in PT_TLS, PT_LOAD or PT_GNU_RELRO
2826 // PT_TLS must only have SHF_TLS sections
2827 template <class ELFT>
2828 bool GNUStyle<ELFT>::checkTLSSections(const Elf_Phdr &Phdr,
2829                                       const Elf_Shdr &Sec) {
2830   return (((Sec.sh_flags & ELF::SHF_TLS) &&
2831            ((Phdr.p_type == ELF::PT_TLS) || (Phdr.p_type == ELF::PT_LOAD) ||
2832             (Phdr.p_type == ELF::PT_GNU_RELRO))) ||
2833           (!(Sec.sh_flags & ELF::SHF_TLS) && Phdr.p_type != ELF::PT_TLS));
2834 }
2835 
2836 // Non-SHT_NOBITS must have its offset inside the segment
2837 // Only non-zero section can be at end of segment
2838 template <class ELFT>
2839 bool GNUStyle<ELFT>::checkoffsets(const Elf_Phdr &Phdr, const Elf_Shdr &Sec) {
2840   if (Sec.sh_type == ELF::SHT_NOBITS)
2841     return true;
2842   bool IsSpecial =
2843       (Sec.sh_type == ELF::SHT_NOBITS) && ((Sec.sh_flags & ELF::SHF_TLS) != 0);
2844   // .tbss is special, it only has memory in PT_TLS and has NOBITS properties
2845   auto SectionSize =
2846       (IsSpecial && Phdr.p_type != ELF::PT_TLS) ? 0 : Sec.sh_size;
2847   if (Sec.sh_offset >= Phdr.p_offset)
2848     return ((Sec.sh_offset + SectionSize <= Phdr.p_filesz + Phdr.p_offset)
2849             /*only non-zero sized sections at end*/ &&
2850             (Sec.sh_offset + 1 <= Phdr.p_offset + Phdr.p_filesz));
2851   return false;
2852 }
2853 
2854 // SHF_ALLOC must have VMA inside segment
2855 // Only non-zero section can be at end of segment
2856 template <class ELFT>
2857 bool GNUStyle<ELFT>::checkVMA(const Elf_Phdr &Phdr, const Elf_Shdr &Sec) {
2858   if (!(Sec.sh_flags & ELF::SHF_ALLOC))
2859     return true;
2860   bool IsSpecial =
2861       (Sec.sh_type == ELF::SHT_NOBITS) && ((Sec.sh_flags & ELF::SHF_TLS) != 0);
2862   // .tbss is special, it only has memory in PT_TLS and has NOBITS properties
2863   auto SectionSize =
2864       (IsSpecial && Phdr.p_type != ELF::PT_TLS) ? 0 : Sec.sh_size;
2865   if (Sec.sh_addr >= Phdr.p_vaddr)
2866     return ((Sec.sh_addr + SectionSize <= Phdr.p_vaddr + Phdr.p_memsz) &&
2867             (Sec.sh_addr + 1 <= Phdr.p_vaddr + Phdr.p_memsz));
2868   return false;
2869 }
2870 
2871 // No section with zero size must be at start or end of PT_DYNAMIC
2872 template <class ELFT>
2873 bool GNUStyle<ELFT>::checkPTDynamic(const Elf_Phdr &Phdr, const Elf_Shdr &Sec) {
2874   if (Phdr.p_type != ELF::PT_DYNAMIC || Sec.sh_size != 0 || Phdr.p_memsz == 0)
2875     return true;
2876   // Is section within the phdr both based on offset and VMA ?
2877   return ((Sec.sh_type == ELF::SHT_NOBITS) ||
2878           (Sec.sh_offset > Phdr.p_offset &&
2879            Sec.sh_offset < Phdr.p_offset + Phdr.p_filesz)) &&
2880          (!(Sec.sh_flags & ELF::SHF_ALLOC) ||
2881           (Sec.sh_addr > Phdr.p_vaddr && Sec.sh_addr < Phdr.p_memsz));
2882 }
2883 
2884 template <class ELFT>
2885 void GNUStyle<ELFT>::printProgramHeaders(const ELFO *Obj) {
2886   unsigned Bias = ELFT::Is64Bits ? 8 : 0;
2887   unsigned Width = ELFT::Is64Bits ? 18 : 10;
2888   unsigned SizeWidth = ELFT::Is64Bits ? 8 : 7;
2889   std::string Type, Offset, VMA, LMA, FileSz, MemSz, Flag, Align;
2890 
2891   const Elf_Ehdr *Header = Obj->getHeader();
2892   Field Fields[8] = {2,         17,        26,        37 + Bias,
2893                      48 + Bias, 56 + Bias, 64 + Bias, 68 + Bias};
2894   OS << "\nElf file type is "
2895      << printEnum(Header->e_type, makeArrayRef(ElfObjectFileType)) << "\n"
2896      << "Entry point " << format_hex(Header->e_entry, 3) << "\n"
2897      << "There are " << Header->e_phnum << " program headers,"
2898      << " starting at offset " << Header->e_phoff << "\n\n"
2899      << "Program Headers:\n";
2900   if (ELFT::Is64Bits)
2901     OS << "  Type           Offset   VirtAddr           PhysAddr         "
2902        << "  FileSiz  MemSiz   Flg Align\n";
2903   else
2904     OS << "  Type           Offset   VirtAddr   PhysAddr   FileSiz "
2905        << "MemSiz  Flg Align\n";
2906   for (const auto &Phdr : Obj->program_headers()) {
2907     Type = getElfPtType(Header->e_machine, Phdr.p_type);
2908     Offset = to_string(format_hex(Phdr.p_offset, 8));
2909     VMA = to_string(format_hex(Phdr.p_vaddr, Width));
2910     LMA = to_string(format_hex(Phdr.p_paddr, Width));
2911     FileSz = to_string(format_hex(Phdr.p_filesz, SizeWidth));
2912     MemSz = to_string(format_hex(Phdr.p_memsz, SizeWidth));
2913     Flag = printPhdrFlags(Phdr.p_flags);
2914     Align = to_string(format_hex(Phdr.p_align, 1));
2915     Fields[0].Str = Type;
2916     Fields[1].Str = Offset;
2917     Fields[2].Str = VMA;
2918     Fields[3].Str = LMA;
2919     Fields[4].Str = FileSz;
2920     Fields[5].Str = MemSz;
2921     Fields[6].Str = Flag;
2922     Fields[7].Str = Align;
2923     for (auto Field : Fields)
2924       printField(Field);
2925     if (Phdr.p_type == ELF::PT_INTERP) {
2926       OS << "\n      [Requesting program interpreter: ";
2927       OS << reinterpret_cast<const char *>(Obj->base()) + Phdr.p_offset << "]";
2928     }
2929     OS << "\n";
2930   }
2931   OS << "\n Section to Segment mapping:\n  Segment Sections...\n";
2932   int Phnum = 0;
2933   for (const Elf_Phdr &Phdr : Obj->program_headers()) {
2934     std::string Sections;
2935     OS << format("   %2.2d     ", Phnum++);
2936     for (const Elf_Shdr &Sec : Obj->sections()) {
2937       // Check if each section is in a segment and then print mapping.
2938       // readelf additionally makes sure it does not print zero sized sections
2939       // at end of segments and for PT_DYNAMIC both start and end of section
2940       // .tbss must only be shown in PT_TLS section.
2941       bool TbssInNonTLS = (Sec.sh_type == ELF::SHT_NOBITS) &&
2942                           ((Sec.sh_flags & ELF::SHF_TLS) != 0) &&
2943                           Phdr.p_type != ELF::PT_TLS;
2944       if (!TbssInNonTLS && checkTLSSections(Phdr, Sec) &&
2945           checkoffsets(Phdr, Sec) && checkVMA(Phdr, Sec) &&
2946           checkPTDynamic(Phdr, Sec) && (Sec.sh_type != ELF::SHT_NULL))
2947         Sections += unwrapOrError(Obj->getSectionName(&Sec)).str() + " ";
2948     }
2949     OS << Sections << "\n";
2950     OS.flush();
2951   }
2952 }
2953 
2954 template <class ELFT>
2955 void GNUStyle<ELFT>::printDynamicRelocation(const ELFO *Obj, Elf_Rela R,
2956                                             bool IsRela) {
2957   SmallString<32> RelocName;
2958   StringRef SymbolName;
2959   unsigned Width = ELFT::Is64Bits ? 16 : 8;
2960   unsigned Bias = ELFT::Is64Bits ? 8 : 0;
2961   // First two fields are bit width dependent. The rest of them are after are
2962   // fixed width.
2963   Field Fields[5] = {0, 10 + Bias, 19 + 2 * Bias, 42 + 2 * Bias, 53 + 2 * Bias};
2964 
2965   uint32_t SymIndex = R.getSymbol(Obj->isMips64EL());
2966   const Elf_Sym *Sym = this->dumper()->dynamic_symbols().begin() + SymIndex;
2967   Obj->getRelocationTypeName(R.getType(Obj->isMips64EL()), RelocName);
2968   SymbolName =
2969       unwrapOrError(Sym->getName(this->dumper()->getDynamicStringTable()));
2970   std::string Addend = "", Info, Offset, Value;
2971   Offset = to_string(format_hex_no_prefix(R.r_offset, Width));
2972   Info = to_string(format_hex_no_prefix(R.r_info, Width));
2973   Value = to_string(format_hex_no_prefix(Sym->getValue(), Width));
2974   int64_t RelAddend = R.r_addend;
2975   if (SymbolName.size() && IsRela) {
2976     if (R.r_addend < 0)
2977       Addend = " - ";
2978     else
2979       Addend = " + ";
2980   }
2981 
2982   if (!SymbolName.size() && Sym->getValue() == 0)
2983     Value = "";
2984 
2985   if (IsRela)
2986     Addend += to_string(format_hex_no_prefix(std::abs(RelAddend), 1));
2987 
2988 
2989   Fields[0].Str = Offset;
2990   Fields[1].Str = Info;
2991   Fields[2].Str = RelocName.c_str();
2992   Fields[3].Str = Value;
2993   Fields[4].Str = SymbolName;
2994   for (auto &Field : Fields)
2995     printField(Field);
2996   OS << Addend;
2997   OS << "\n";
2998 }
2999 
3000 template <class ELFT>
3001 void GNUStyle<ELFT>::printDynamicRelocations(const ELFO *Obj) {
3002   const DynRegionInfo &DynRelRegion = this->dumper()->getDynRelRegion();
3003   const DynRegionInfo &DynRelaRegion = this->dumper()->getDynRelaRegion();
3004   const DynRegionInfo &DynPLTRelRegion = this->dumper()->getDynPLTRelRegion();
3005   if (DynRelaRegion.Size > 0) {
3006     OS << "\n'RELA' relocation section at offset "
3007        << format_hex(reinterpret_cast<const uint8_t *>(DynRelaRegion.Addr) -
3008                          Obj->base(),
3009                      1) << " contains " << DynRelaRegion.Size << " bytes:\n";
3010     printRelocHeader(OS, ELFT::Is64Bits, true);
3011     for (const Elf_Rela &Rela : this->dumper()->dyn_relas())
3012       printDynamicRelocation(Obj, Rela, true);
3013   }
3014   if (DynRelRegion.Size > 0) {
3015     OS << "\n'REL' relocation section at offset "
3016        << format_hex(reinterpret_cast<const uint8_t *>(DynRelRegion.Addr) -
3017                          Obj->base(),
3018                      1) << " contains " << DynRelRegion.Size << " bytes:\n";
3019     printRelocHeader(OS, ELFT::Is64Bits, false);
3020     for (const Elf_Rel &Rel : this->dumper()->dyn_rels()) {
3021       Elf_Rela Rela;
3022       Rela.r_offset = Rel.r_offset;
3023       Rela.r_info = Rel.r_info;
3024       Rela.r_addend = 0;
3025       printDynamicRelocation(Obj, Rela, false);
3026     }
3027   }
3028   if (DynPLTRelRegion.Size) {
3029     OS << "\n'PLT' relocation section at offset "
3030        << format_hex(reinterpret_cast<const uint8_t *>(DynPLTRelRegion.Addr) -
3031                          Obj->base(),
3032                      1) << " contains " << DynPLTRelRegion.Size << " bytes:\n";
3033   }
3034   if (DynPLTRelRegion.EntSize == sizeof(Elf_Rela)) {
3035     printRelocHeader(OS, ELFT::Is64Bits, true);
3036     for (const Elf_Rela &Rela : DynPLTRelRegion.getAsArrayRef<Elf_Rela>())
3037       printDynamicRelocation(Obj, Rela, true);
3038   } else {
3039     printRelocHeader(OS, ELFT::Is64Bits, false);
3040     for (const Elf_Rel &Rel : DynPLTRelRegion.getAsArrayRef<Elf_Rel>()) {
3041       Elf_Rela Rela;
3042       Rela.r_offset = Rel.r_offset;
3043       Rela.r_info = Rel.r_info;
3044       Rela.r_addend = 0;
3045       printDynamicRelocation(Obj, Rela, false);
3046     }
3047   }
3048 }
3049 
3050 // Hash histogram shows  statistics of how efficient the hash was for the
3051 // dynamic symbol table. The table shows number of hash buckets for different
3052 // lengths of chains as absolute number and percentage of the total buckets.
3053 // Additionally cumulative coverage of symbols for each set of buckets.
3054 template <class ELFT>
3055 void GNUStyle<ELFT>::printHashHistogram(const ELFFile<ELFT> *Obj) {
3056 
3057   const Elf_Hash *HashTable = this->dumper()->getHashTable();
3058   const Elf_GnuHash *GnuHashTable = this->dumper()->getGnuHashTable();
3059 
3060   // Print histogram for .hash section
3061   if (HashTable) {
3062     size_t NBucket = HashTable->nbucket;
3063     size_t NChain = HashTable->nchain;
3064     ArrayRef<Elf_Word> Buckets = HashTable->buckets();
3065     ArrayRef<Elf_Word> Chains = HashTable->chains();
3066     size_t TotalSyms = 0;
3067     // If hash table is correct, we have at least chains with 0 length
3068     size_t MaxChain = 1;
3069     size_t CumulativeNonZero = 0;
3070 
3071     if (NChain == 0 || NBucket == 0)
3072       return;
3073 
3074     std::vector<size_t> ChainLen(NBucket, 0);
3075     // Go over all buckets and and note chain lengths of each bucket (total
3076     // unique chain lengths).
3077     for (size_t B = 0; B < NBucket; B++) {
3078       for (size_t C = Buckets[B]; C > 0 && C < NChain; C = Chains[C])
3079         if (MaxChain <= ++ChainLen[B])
3080           MaxChain++;
3081       TotalSyms += ChainLen[B];
3082     }
3083 
3084     if (!TotalSyms)
3085       return;
3086 
3087     std::vector<size_t> Count(MaxChain, 0) ;
3088     // Count how long is the chain for each bucket
3089     for (size_t B = 0; B < NBucket; B++)
3090       ++Count[ChainLen[B]];
3091     // Print Number of buckets with each chain lengths and their cumulative
3092     // coverage of the symbols
3093     OS << "Histogram for bucket list length (total of " << NBucket
3094        << " buckets)\n"
3095        << " Length  Number     % of total  Coverage\n";
3096     for (size_t I = 0; I < MaxChain; I++) {
3097       CumulativeNonZero += Count[I] * I;
3098       OS << format("%7lu  %-10lu (%5.1f%%)     %5.1f%%\n", I, Count[I],
3099                    (Count[I] * 100.0) / NBucket,
3100                    (CumulativeNonZero * 100.0) / TotalSyms);
3101     }
3102   }
3103 
3104   // Print histogram for .gnu.hash section
3105   if (GnuHashTable) {
3106     size_t NBucket = GnuHashTable->nbuckets;
3107     ArrayRef<Elf_Word> Buckets = GnuHashTable->buckets();
3108     unsigned NumSyms = this->dumper()->dynamic_symbols().size();
3109     if (!NumSyms)
3110       return;
3111     ArrayRef<Elf_Word> Chains = GnuHashTable->values(NumSyms);
3112     size_t Symndx = GnuHashTable->symndx;
3113     size_t TotalSyms = 0;
3114     size_t MaxChain = 1;
3115     size_t CumulativeNonZero = 0;
3116 
3117     if (Chains.size() == 0 || NBucket == 0)
3118       return;
3119 
3120     std::vector<size_t> ChainLen(NBucket, 0);
3121 
3122     for (size_t B = 0; B < NBucket; B++) {
3123       if (!Buckets[B])
3124         continue;
3125       size_t Len = 1;
3126       for (size_t C = Buckets[B] - Symndx;
3127            C < Chains.size() && (Chains[C] & 1) == 0; C++)
3128         if (MaxChain < ++Len)
3129           MaxChain++;
3130       ChainLen[B] = Len;
3131       TotalSyms += Len;
3132     }
3133     MaxChain++;
3134 
3135     if (!TotalSyms)
3136       return;
3137 
3138     std::vector<size_t> Count(MaxChain, 0) ;
3139     for (size_t B = 0; B < NBucket; B++)
3140       ++Count[ChainLen[B]];
3141     // Print Number of buckets with each chain lengths and their cumulative
3142     // coverage of the symbols
3143     OS << "Histogram for `.gnu.hash' bucket list length (total of " << NBucket
3144        << " buckets)\n"
3145        << " Length  Number     % of total  Coverage\n";
3146     for (size_t I = 0; I <MaxChain; I++) {
3147       CumulativeNonZero += Count[I] * I;
3148       OS << format("%7lu  %-10lu (%5.1f%%)     %5.1f%%\n", I, Count[I],
3149                    (Count[I] * 100.0) / NBucket,
3150                    (CumulativeNonZero * 100.0) / TotalSyms);
3151     }
3152   }
3153 }
3154 
3155 template <class ELFT> void LLVMStyle<ELFT>::printFileHeaders(const ELFO *Obj) {
3156   const Elf_Ehdr *e = Obj->getHeader();
3157   {
3158     DictScope D(W, "ElfHeader");
3159     {
3160       DictScope D(W, "Ident");
3161       W.printBinary("Magic", makeArrayRef(e->e_ident).slice(ELF::EI_MAG0, 4));
3162       W.printEnum("Class", e->e_ident[ELF::EI_CLASS], makeArrayRef(ElfClass));
3163       W.printEnum("DataEncoding", e->e_ident[ELF::EI_DATA],
3164                   makeArrayRef(ElfDataEncoding));
3165       W.printNumber("FileVersion", e->e_ident[ELF::EI_VERSION]);
3166 
3167       // Handle architecture specific OS/ABI values.
3168       if (e->e_machine == ELF::EM_AMDGPU &&
3169           e->e_ident[ELF::EI_OSABI] == ELF::ELFOSABI_AMDGPU_HSA)
3170         W.printHex("OS/ABI", "AMDGPU_HSA", ELF::ELFOSABI_AMDGPU_HSA);
3171       else
3172         W.printEnum("OS/ABI", e->e_ident[ELF::EI_OSABI],
3173                     makeArrayRef(ElfOSABI));
3174       W.printNumber("ABIVersion", e->e_ident[ELF::EI_ABIVERSION]);
3175       W.printBinary("Unused", makeArrayRef(e->e_ident).slice(ELF::EI_PAD));
3176     }
3177 
3178     W.printEnum("Type", e->e_type, makeArrayRef(ElfObjectFileType));
3179     W.printEnum("Machine", e->e_machine, makeArrayRef(ElfMachineType));
3180     W.printNumber("Version", e->e_version);
3181     W.printHex("Entry", e->e_entry);
3182     W.printHex("ProgramHeaderOffset", e->e_phoff);
3183     W.printHex("SectionHeaderOffset", e->e_shoff);
3184     if (e->e_machine == EM_MIPS)
3185       W.printFlags("Flags", e->e_flags, makeArrayRef(ElfHeaderMipsFlags),
3186                    unsigned(ELF::EF_MIPS_ARCH), unsigned(ELF::EF_MIPS_ABI),
3187                    unsigned(ELF::EF_MIPS_MACH));
3188     else
3189       W.printFlags("Flags", e->e_flags);
3190     W.printNumber("HeaderSize", e->e_ehsize);
3191     W.printNumber("ProgramHeaderEntrySize", e->e_phentsize);
3192     W.printNumber("ProgramHeaderCount", e->e_phnum);
3193     W.printNumber("SectionHeaderEntrySize", e->e_shentsize);
3194     W.printNumber("SectionHeaderCount", e->e_shnum);
3195     W.printNumber("StringTableSectionIndex", e->e_shstrndx);
3196   }
3197 }
3198 
3199 template <class ELFT>
3200 void LLVMStyle<ELFT>::printGroupSections(const ELFO *Obj) {
3201   DictScope Lists(W, "Groups");
3202   uint32_t SectionIndex = 0;
3203   bool HasGroups = false;
3204   for (const Elf_Shdr &Sec : Obj->sections()) {
3205     if (Sec.sh_type == ELF::SHT_GROUP) {
3206       HasGroups = true;
3207       const Elf_Shdr *Symtab = unwrapOrError(Obj->getSection(Sec.sh_link));
3208       StringRef StrTable = unwrapOrError(Obj->getStringTableForSymtab(*Symtab));
3209       const Elf_Sym *Sym = Obj->template getEntry<Elf_Sym>(Symtab, Sec.sh_info);
3210       auto Data = unwrapOrError(
3211           Obj->template getSectionContentsAsArray<Elf_Word>(&Sec));
3212       DictScope D(W, "Group");
3213       StringRef Name = unwrapOrError(Obj->getSectionName(&Sec));
3214       W.printNumber("Name", Name, Sec.sh_name);
3215       W.printNumber("Index", SectionIndex);
3216       W.printHex("Type", getGroupType(Data[0]), Data[0]);
3217       W.startLine() << "Signature: " << StrTable.data() + Sym->st_name << "\n";
3218       {
3219         ListScope L(W, "Section(s) in group");
3220         size_t Member = 1;
3221         while (Member < Data.size()) {
3222           auto Sec = unwrapOrError(Obj->getSection(Data[Member]));
3223           const StringRef Name = unwrapOrError(Obj->getSectionName(Sec));
3224           W.startLine() << Name << " (" << Data[Member++] << ")\n";
3225         }
3226       }
3227     }
3228     ++SectionIndex;
3229   }
3230   if (!HasGroups)
3231     W.startLine() << "There are no group sections in the file.\n";
3232 }
3233 
3234 template <class ELFT> void LLVMStyle<ELFT>::printRelocations(const ELFO *Obj) {
3235   ListScope D(W, "Relocations");
3236 
3237   int SectionNumber = -1;
3238   for (const Elf_Shdr &Sec : Obj->sections()) {
3239     ++SectionNumber;
3240 
3241     if (Sec.sh_type != ELF::SHT_REL && Sec.sh_type != ELF::SHT_RELA)
3242       continue;
3243 
3244     StringRef Name = unwrapOrError(Obj->getSectionName(&Sec));
3245 
3246     W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";
3247     W.indent();
3248 
3249     printRelocations(&Sec, Obj);
3250 
3251     W.unindent();
3252     W.startLine() << "}\n";
3253   }
3254 }
3255 
3256 template <class ELFT>
3257 void LLVMStyle<ELFT>::printRelocations(const Elf_Shdr *Sec, const ELFO *Obj) {
3258   const Elf_Shdr *SymTab = unwrapOrError(Obj->getSection(Sec->sh_link));
3259 
3260   switch (Sec->sh_type) {
3261   case ELF::SHT_REL:
3262     for (const Elf_Rel &R : Obj->rels(Sec)) {
3263       Elf_Rela Rela;
3264       Rela.r_offset = R.r_offset;
3265       Rela.r_info = R.r_info;
3266       Rela.r_addend = 0;
3267       printRelocation(Obj, Rela, SymTab);
3268     }
3269     break;
3270   case ELF::SHT_RELA:
3271     for (const Elf_Rela &R : Obj->relas(Sec))
3272       printRelocation(Obj, R, SymTab);
3273     break;
3274   }
3275 }
3276 
3277 template <class ELFT>
3278 void LLVMStyle<ELFT>::printRelocation(const ELFO *Obj, Elf_Rela Rel,
3279                                       const Elf_Shdr *SymTab) {
3280   SmallString<32> RelocName;
3281   Obj->getRelocationTypeName(Rel.getType(Obj->isMips64EL()), RelocName);
3282   StringRef TargetName;
3283   const Elf_Sym *Sym = Obj->getRelocationSymbol(&Rel, SymTab);
3284   if (Sym && Sym->getType() == ELF::STT_SECTION) {
3285     const Elf_Shdr *Sec = unwrapOrError(
3286         Obj->getSection(Sym, SymTab, this->dumper()->getShndxTable()));
3287     TargetName = unwrapOrError(Obj->getSectionName(Sec));
3288   } else if (Sym) {
3289     StringRef StrTable = unwrapOrError(Obj->getStringTableForSymtab(*SymTab));
3290     TargetName = unwrapOrError(Sym->getName(StrTable));
3291   }
3292 
3293   if (opts::ExpandRelocs) {
3294     DictScope Group(W, "Relocation");
3295     W.printHex("Offset", Rel.r_offset);
3296     W.printNumber("Type", RelocName, (int)Rel.getType(Obj->isMips64EL()));
3297     W.printNumber("Symbol", TargetName.size() > 0 ? TargetName : "-",
3298                   Rel.getSymbol(Obj->isMips64EL()));
3299     W.printHex("Addend", Rel.r_addend);
3300   } else {
3301     raw_ostream &OS = W.startLine();
3302     OS << W.hex(Rel.r_offset) << " " << RelocName << " "
3303        << (TargetName.size() > 0 ? TargetName : "-") << " "
3304        << W.hex(Rel.r_addend) << "\n";
3305   }
3306 }
3307 
3308 template <class ELFT> void LLVMStyle<ELFT>::printSections(const ELFO *Obj) {
3309   ListScope SectionsD(W, "Sections");
3310 
3311   int SectionIndex = -1;
3312   for (const Elf_Shdr &Sec : Obj->sections()) {
3313     ++SectionIndex;
3314 
3315     StringRef Name = unwrapOrError(Obj->getSectionName(&Sec));
3316 
3317     DictScope SectionD(W, "Section");
3318     W.printNumber("Index", SectionIndex);
3319     W.printNumber("Name", Name, Sec.sh_name);
3320     W.printHex("Type",
3321                getElfSectionType(Obj->getHeader()->e_machine, Sec.sh_type),
3322                Sec.sh_type);
3323     std::vector<EnumEntry<unsigned>> SectionFlags(std::begin(ElfSectionFlags),
3324                                                   std::end(ElfSectionFlags));
3325     switch (Obj->getHeader()->e_machine) {
3326     case EM_AMDGPU:
3327       SectionFlags.insert(SectionFlags.end(), std::begin(ElfAMDGPUSectionFlags),
3328                           std::end(ElfAMDGPUSectionFlags));
3329       break;
3330     case EM_HEXAGON:
3331       SectionFlags.insert(SectionFlags.end(),
3332                           std::begin(ElfHexagonSectionFlags),
3333                           std::end(ElfHexagonSectionFlags));
3334       break;
3335     case EM_MIPS:
3336       SectionFlags.insert(SectionFlags.end(), std::begin(ElfMipsSectionFlags),
3337                           std::end(ElfMipsSectionFlags));
3338       break;
3339     case EM_X86_64:
3340       SectionFlags.insert(SectionFlags.end(), std::begin(ElfX86_64SectionFlags),
3341                           std::end(ElfX86_64SectionFlags));
3342       break;
3343     case EM_XCORE:
3344       SectionFlags.insert(SectionFlags.end(), std::begin(ElfXCoreSectionFlags),
3345                           std::end(ElfXCoreSectionFlags));
3346       break;
3347     default:
3348       // Nothing to do.
3349       break;
3350     }
3351     W.printFlags("Flags", Sec.sh_flags, makeArrayRef(SectionFlags));
3352     W.printHex("Address", Sec.sh_addr);
3353     W.printHex("Offset", Sec.sh_offset);
3354     W.printNumber("Size", Sec.sh_size);
3355     W.printNumber("Link", Sec.sh_link);
3356     W.printNumber("Info", Sec.sh_info);
3357     W.printNumber("AddressAlignment", Sec.sh_addralign);
3358     W.printNumber("EntrySize", Sec.sh_entsize);
3359 
3360     if (opts::SectionRelocations) {
3361       ListScope D(W, "Relocations");
3362       printRelocations(&Sec, Obj);
3363     }
3364 
3365     if (opts::SectionSymbols) {
3366       ListScope D(W, "Symbols");
3367       const Elf_Shdr *Symtab = this->dumper()->getDotSymtabSec();
3368       StringRef StrTable = unwrapOrError(Obj->getStringTableForSymtab(*Symtab));
3369 
3370       for (const Elf_Sym &Sym : Obj->symbols(Symtab)) {
3371         const Elf_Shdr *SymSec = unwrapOrError(
3372             Obj->getSection(&Sym, Symtab, this->dumper()->getShndxTable()));
3373         if (SymSec == &Sec)
3374           printSymbol(Obj, &Sym, Obj->symbol_begin(Symtab), StrTable, false);
3375       }
3376     }
3377 
3378     if (opts::SectionData && Sec.sh_type != ELF::SHT_NOBITS) {
3379       ArrayRef<uint8_t> Data = unwrapOrError(Obj->getSectionContents(&Sec));
3380       W.printBinaryBlock("SectionData",
3381                          StringRef((const char *)Data.data(), Data.size()));
3382     }
3383   }
3384 }
3385 
3386 template <class ELFT>
3387 void LLVMStyle<ELFT>::printSymbol(const ELFO *Obj, const Elf_Sym *Symbol,
3388                                   const Elf_Sym *First, StringRef StrTable,
3389                                   bool IsDynamic) {
3390   unsigned SectionIndex = 0;
3391   StringRef SectionName;
3392   getSectionNameIndex(*Obj, Symbol, First, this->dumper()->getShndxTable(),
3393                       SectionName, SectionIndex);
3394   std::string FullSymbolName =
3395       this->dumper()->getFullSymbolName(Symbol, StrTable, IsDynamic);
3396   unsigned char SymbolType = Symbol->getType();
3397 
3398   DictScope D(W, "Symbol");
3399   W.printNumber("Name", FullSymbolName, Symbol->st_name);
3400   W.printHex("Value", Symbol->st_value);
3401   W.printNumber("Size", Symbol->st_size);
3402   W.printEnum("Binding", Symbol->getBinding(), makeArrayRef(ElfSymbolBindings));
3403   if (Obj->getHeader()->e_machine == ELF::EM_AMDGPU &&
3404       SymbolType >= ELF::STT_LOOS && SymbolType < ELF::STT_HIOS)
3405     W.printEnum("Type", SymbolType, makeArrayRef(AMDGPUSymbolTypes));
3406   else
3407     W.printEnum("Type", SymbolType, makeArrayRef(ElfSymbolTypes));
3408   if (Symbol->st_other == 0)
3409     // Usually st_other flag is zero. Do not pollute the output
3410     // by flags enumeration in that case.
3411     W.printNumber("Other", 0);
3412   else {
3413     std::vector<EnumEntry<unsigned>> SymOtherFlags(std::begin(ElfSymOtherFlags),
3414                                                    std::end(ElfSymOtherFlags));
3415     if (Obj->getHeader()->e_machine == EM_MIPS) {
3416       // Someones in their infinite wisdom decided to make STO_MIPS_MIPS16
3417       // flag overlapped with other ST_MIPS_xxx flags. So consider both
3418       // cases separately.
3419       if ((Symbol->st_other & STO_MIPS_MIPS16) == STO_MIPS_MIPS16)
3420         SymOtherFlags.insert(SymOtherFlags.end(),
3421                              std::begin(ElfMips16SymOtherFlags),
3422                              std::end(ElfMips16SymOtherFlags));
3423       else
3424         SymOtherFlags.insert(SymOtherFlags.end(),
3425                              std::begin(ElfMipsSymOtherFlags),
3426                              std::end(ElfMipsSymOtherFlags));
3427     }
3428     W.printFlags("Other", Symbol->st_other, makeArrayRef(SymOtherFlags), 0x3u);
3429   }
3430   W.printHex("Section", SectionName, SectionIndex);
3431 }
3432 
3433 template <class ELFT> void LLVMStyle<ELFT>::printSymbols(const ELFO *Obj) {
3434   ListScope Group(W, "Symbols");
3435   this->dumper()->printSymbolsHelper(false);
3436 }
3437 
3438 template <class ELFT>
3439 void LLVMStyle<ELFT>::printDynamicSymbols(const ELFO *Obj) {
3440   ListScope Group(W, "DynamicSymbols");
3441   this->dumper()->printSymbolsHelper(true);
3442 }
3443 
3444 template <class ELFT>
3445 void LLVMStyle<ELFT>::printDynamicRelocations(const ELFO *Obj) {
3446   const DynRegionInfo &DynRelRegion = this->dumper()->getDynRelRegion();
3447   const DynRegionInfo &DynRelaRegion = this->dumper()->getDynRelaRegion();
3448   const DynRegionInfo &DynPLTRelRegion = this->dumper()->getDynPLTRelRegion();
3449   if (DynRelRegion.Size && DynRelaRegion.Size)
3450     report_fatal_error("There are both REL and RELA dynamic relocations");
3451   W.startLine() << "Dynamic Relocations {\n";
3452   W.indent();
3453   if (DynRelaRegion.Size > 0)
3454     for (const Elf_Rela &Rela : this->dumper()->dyn_relas())
3455       printDynamicRelocation(Obj, Rela);
3456   else
3457     for (const Elf_Rel &Rel : this->dumper()->dyn_rels()) {
3458       Elf_Rela Rela;
3459       Rela.r_offset = Rel.r_offset;
3460       Rela.r_info = Rel.r_info;
3461       Rela.r_addend = 0;
3462       printDynamicRelocation(Obj, Rela);
3463     }
3464   if (DynPLTRelRegion.EntSize == sizeof(Elf_Rela))
3465     for (const Elf_Rela &Rela : DynPLTRelRegion.getAsArrayRef<Elf_Rela>())
3466       printDynamicRelocation(Obj, Rela);
3467   else
3468     for (const Elf_Rel &Rel : DynPLTRelRegion.getAsArrayRef<Elf_Rel>()) {
3469       Elf_Rela Rela;
3470       Rela.r_offset = Rel.r_offset;
3471       Rela.r_info = Rel.r_info;
3472       Rela.r_addend = 0;
3473       printDynamicRelocation(Obj, Rela);
3474     }
3475   W.unindent();
3476   W.startLine() << "}\n";
3477 }
3478 
3479 template <class ELFT>
3480 void LLVMStyle<ELFT>::printDynamicRelocation(const ELFO *Obj, Elf_Rela Rel) {
3481   SmallString<32> RelocName;
3482   Obj->getRelocationTypeName(Rel.getType(Obj->isMips64EL()), RelocName);
3483   StringRef SymbolName;
3484   uint32_t SymIndex = Rel.getSymbol(Obj->isMips64EL());
3485   const Elf_Sym *Sym = this->dumper()->dynamic_symbols().begin() + SymIndex;
3486   SymbolName =
3487       unwrapOrError(Sym->getName(this->dumper()->getDynamicStringTable()));
3488   if (opts::ExpandRelocs) {
3489     DictScope Group(W, "Relocation");
3490     W.printHex("Offset", Rel.r_offset);
3491     W.printNumber("Type", RelocName, (int)Rel.getType(Obj->isMips64EL()));
3492     W.printString("Symbol", SymbolName.size() > 0 ? SymbolName : "-");
3493     W.printHex("Addend", Rel.r_addend);
3494   } else {
3495     raw_ostream &OS = W.startLine();
3496     OS << W.hex(Rel.r_offset) << " " << RelocName << " "
3497        << (SymbolName.size() > 0 ? SymbolName : "-") << " "
3498        << W.hex(Rel.r_addend) << "\n";
3499   }
3500 }
3501 
3502 template <class ELFT>
3503 void LLVMStyle<ELFT>::printProgramHeaders(const ELFO *Obj) {
3504   ListScope L(W, "ProgramHeaders");
3505 
3506   for (const Elf_Phdr &Phdr : Obj->program_headers()) {
3507     DictScope P(W, "ProgramHeader");
3508     W.printHex("Type",
3509                getElfSegmentType(Obj->getHeader()->e_machine, Phdr.p_type),
3510                Phdr.p_type);
3511     W.printHex("Offset", Phdr.p_offset);
3512     W.printHex("VirtualAddress", Phdr.p_vaddr);
3513     W.printHex("PhysicalAddress", Phdr.p_paddr);
3514     W.printNumber("FileSize", Phdr.p_filesz);
3515     W.printNumber("MemSize", Phdr.p_memsz);
3516     W.printFlags("Flags", Phdr.p_flags, makeArrayRef(ElfSegmentFlags));
3517     W.printNumber("Alignment", Phdr.p_align);
3518   }
3519 }
3520 template <class ELFT>
3521 void LLVMStyle<ELFT>::printHashHistogram(const ELFFile<ELFT> *Obj) {
3522   W.startLine() << "Hash Histogram not implemented!\n";
3523 }
3524