OSDN Git Service

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