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