1 //===- ELFDumper.cpp - ELF-specific dumper --------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 ///
9 /// \file
10 /// This file implements the ELF-specific dumper for llvm-readobj.
11 ///
12 //===----------------------------------------------------------------------===//
13 
14 #include "ARMEHABIPrinter.h"
15 #include "DwarfCFIEHPrinter.h"
16 #include "Error.h"
17 #include "ObjDumper.h"
18 #include "StackMapPrinter.h"
19 #include "llvm-readobj.h"
20 #include "llvm/ADT/ArrayRef.h"
21 #include "llvm/ADT/DenseMap.h"
22 #include "llvm/ADT/DenseSet.h"
23 #include "llvm/ADT/MapVector.h"
24 #include "llvm/ADT/Optional.h"
25 #include "llvm/ADT/PointerIntPair.h"
26 #include "llvm/ADT/STLExtras.h"
27 #include "llvm/ADT/SmallString.h"
28 #include "llvm/ADT/SmallVector.h"
29 #include "llvm/ADT/StringExtras.h"
30 #include "llvm/ADT/StringRef.h"
31 #include "llvm/ADT/Twine.h"
32 #include "llvm/BinaryFormat/AMDGPUMetadataVerifier.h"
33 #include "llvm/BinaryFormat/ELF.h"
34 #include "llvm/Demangle/Demangle.h"
35 #include "llvm/Object/ELF.h"
36 #include "llvm/Object/ELFObjectFile.h"
37 #include "llvm/Object/ELFTypes.h"
38 #include "llvm/Object/Error.h"
39 #include "llvm/Object/ObjectFile.h"
40 #include "llvm/Object/RelocationResolver.h"
41 #include "llvm/Object/StackMapParser.h"
42 #include "llvm/Support/AMDGPUMetadata.h"
43 #include "llvm/Support/ARMAttributeParser.h"
44 #include "llvm/Support/ARMBuildAttributes.h"
45 #include "llvm/Support/Casting.h"
46 #include "llvm/Support/Compiler.h"
47 #include "llvm/Support/Endian.h"
48 #include "llvm/Support/ErrorHandling.h"
49 #include "llvm/Support/Format.h"
50 #include "llvm/Support/FormatVariadic.h"
51 #include "llvm/Support/FormattedStream.h"
52 #include "llvm/Support/LEB128.h"
53 #include "llvm/Support/MathExtras.h"
54 #include "llvm/Support/MipsABIFlags.h"
55 #include "llvm/Support/RISCVAttributeParser.h"
56 #include "llvm/Support/RISCVAttributes.h"
57 #include "llvm/Support/ScopedPrinter.h"
58 #include "llvm/Support/raw_ostream.h"
59 #include <algorithm>
60 #include <cinttypes>
61 #include <cstddef>
62 #include <cstdint>
63 #include <cstdlib>
64 #include <iterator>
65 #include <memory>
66 #include <string>
67 #include <system_error>
68 #include <unordered_set>
69 #include <vector>
70 
71 using namespace llvm;
72 using namespace llvm::object;
73 using namespace ELF;
74 
75 #define LLVM_READOBJ_ENUM_CASE(ns, enum)                                       \
76   case ns::enum:                                                               \
77     return #enum;
78 
79 #define ENUM_ENT(enum, altName)                                                \
80   { #enum, altName, ELF::enum }
81 
82 #define ENUM_ENT_1(enum)                                                       \
83   { #enum, #enum, ELF::enum }
84 
85 #define LLVM_READOBJ_PHDR_ENUM(ns, enum)                                       \
86   case ns::enum:                                                               \
87     return std::string(#enum).substr(3);
88 
89 #define TYPEDEF_ELF_TYPES(ELFT)                                                \
90   using ELFO = ELFFile<ELFT>;                                                  \
91   using Elf_Addr = typename ELFT::Addr;                                        \
92   using Elf_Shdr = typename ELFT::Shdr;                                        \
93   using Elf_Sym = typename ELFT::Sym;                                          \
94   using Elf_Dyn = typename ELFT::Dyn;                                          \
95   using Elf_Dyn_Range = typename ELFT::DynRange;                               \
96   using Elf_Rel = typename ELFT::Rel;                                          \
97   using Elf_Rela = typename ELFT::Rela;                                        \
98   using Elf_Relr = typename ELFT::Relr;                                        \
99   using Elf_Rel_Range = typename ELFT::RelRange;                               \
100   using Elf_Rela_Range = typename ELFT::RelaRange;                             \
101   using Elf_Relr_Range = typename ELFT::RelrRange;                             \
102   using Elf_Phdr = typename ELFT::Phdr;                                        \
103   using Elf_Half = typename ELFT::Half;                                        \
104   using Elf_Ehdr = typename ELFT::Ehdr;                                        \
105   using Elf_Word = typename ELFT::Word;                                        \
106   using Elf_Hash = typename ELFT::Hash;                                        \
107   using Elf_GnuHash = typename ELFT::GnuHash;                                  \
108   using Elf_Note  = typename ELFT::Note;                                       \
109   using Elf_Sym_Range = typename ELFT::SymRange;                               \
110   using Elf_Versym = typename ELFT::Versym;                                    \
111   using Elf_Verneed = typename ELFT::Verneed;                                  \
112   using Elf_Vernaux = typename ELFT::Vernaux;                                  \
113   using Elf_Verdef = typename ELFT::Verdef;                                    \
114   using Elf_Verdaux = typename ELFT::Verdaux;                                  \
115   using Elf_CGProfile = typename ELFT::CGProfile;                              \
116   using uintX_t = typename ELFT::uint;
117 
118 namespace {
119 
120 template <class ELFT> class DumpStyle;
121 
122 /// Represents a contiguous uniform range in the file. We cannot just create a
123 /// range directly because when creating one of these from the .dynamic table
124 /// the size, entity size and virtual address are different entries in arbitrary
125 /// order (DT_REL, DT_RELSZ, DT_RELENT for example).
126 struct DynRegionInfo {
127   DynRegionInfo(StringRef ObjName) : FileName(ObjName) {}
128   DynRegionInfo(const void *A, uint64_t S, uint64_t ES, StringRef ObjName)
129       : Addr(A), Size(S), EntSize(ES), FileName(ObjName) {}
130 
131   /// Address in current address space.
132   const void *Addr = nullptr;
133   /// Size in bytes of the region.
134   uint64_t Size = 0;
135   /// Size of each entity in the region.
136   uint64_t EntSize = 0;
137 
138   /// Name of the file. Used for error reporting.
139   StringRef FileName;
140   /// Error prefix. Used for error reporting to provide more information.
141   std::string Context;
142   /// Region size name. Used for error reporting.
143   StringRef SizePrintName = "size";
144   /// Entry size name. Used for error reporting. If this field is empty, errors
145   /// will not mention the entry size.
146   StringRef EntSizePrintName = "entry size";
147 
148   template <typename Type> ArrayRef<Type> getAsArrayRef() const {
149     const Type *Start = reinterpret_cast<const Type *>(Addr);
150     if (!Start)
151       return {Start, Start};
152     if (EntSize == sizeof(Type) && (Size % EntSize == 0))
153       return {Start, Start + (Size / EntSize)};
154 
155     std::string Msg;
156     if (!Context.empty())
157       Msg += Context + " has ";
158 
159     Msg += ("invalid " + SizePrintName + " (0x" + Twine::utohexstr(Size) + ")")
160                .str();
161     if (!EntSizePrintName.empty())
162       Msg +=
163           (" or " + EntSizePrintName + " (0x" + Twine::utohexstr(EntSize) + ")")
164               .str();
165 
166     reportWarning(createError(Msg.c_str()), FileName);
167     return {Start, Start};
168   }
169 };
170 
171 namespace {
172 struct VerdAux {
173   unsigned Offset;
174   std::string Name;
175 };
176 
177 struct VerDef {
178   unsigned Offset;
179   unsigned Version;
180   unsigned Flags;
181   unsigned Ndx;
182   unsigned Cnt;
183   unsigned Hash;
184   std::string Name;
185   std::vector<VerdAux> AuxV;
186 };
187 
188 struct VernAux {
189   unsigned Hash;
190   unsigned Flags;
191   unsigned Other;
192   unsigned Offset;
193   std::string Name;
194 };
195 
196 struct VerNeed {
197   unsigned Version;
198   unsigned Cnt;
199   unsigned Offset;
200   std::string File;
201   std::vector<VernAux> AuxV;
202 };
203 
204 } // namespace
205 
206 template <typename ELFT> class ELFDumper : public ObjDumper {
207 public:
208   ELFDumper(const object::ELFObjectFile<ELFT> *ObjF, ScopedPrinter &Writer);
209 
210   void printFileHeaders() override;
211   void printSectionHeaders() override;
212   void printRelocations() override;
213   void printDependentLibs() override;
214   void printDynamicRelocations() override;
215   void printSymbols(bool PrintSymbols, bool PrintDynamicSymbols) override;
216   void printHashSymbols() override;
217   void printUnwindInfo() override;
218 
219   void printDynamicTable() override;
220   void printNeededLibraries() override;
221   void printProgramHeaders(bool PrintProgramHeaders,
222                            cl::boolOrDefault PrintSectionMapping) override;
223   void printHashTable() override;
224   void printGnuHashTable(const object::ObjectFile *Obj) override;
225   void printLoadName() override;
226   void printVersionInfo() override;
227   void printGroupSections() override;
228 
229   void printArchSpecificInfo() override;
230 
231   void printStackMap() const override;
232 
233   void printHashHistograms() override;
234 
235   void printCGProfile() override;
236   void printAddrsig() override;
237 
238   void printNotes() override;
239 
240   void printELFLinkerOptions() override;
241   void printStackSizes() override;
242 
243   const object::ELFObjectFile<ELFT> *getElfObject() const { return ObjF; };
244 
245 private:
246   std::unique_ptr<DumpStyle<ELFT>> ELFDumperStyle;
247 
248   TYPEDEF_ELF_TYPES(ELFT)
249 
250   DynRegionInfo checkDRI(DynRegionInfo DRI) {
251     const ELFFile<ELFT> *Obj = ObjF->getELFFile();
252     if (DRI.Addr < Obj->base() ||
253         reinterpret_cast<const uint8_t *>(DRI.Addr) + DRI.Size >
254             Obj->base() + Obj->getBufSize())
255       reportError(errorCodeToError(llvm::object::object_error::parse_failed),
256                   ObjF->getFileName());
257     return DRI;
258   }
259 
260   DynRegionInfo createDRIFrom(const Elf_Phdr *P, uintX_t EntSize) {
261     return checkDRI({ObjF->getELFFile()->base() + P->p_offset, P->p_filesz,
262                      EntSize, ObjF->getFileName()});
263   }
264 
265   DynRegionInfo createDRIFrom(const Elf_Shdr *S) {
266     return checkDRI({ObjF->getELFFile()->base() + S->sh_offset, S->sh_size,
267                      S->sh_entsize, ObjF->getFileName()});
268   }
269 
270   void printAttributes();
271   void printMipsReginfo();
272   void printMipsOptions();
273 
274   std::pair<const Elf_Phdr *, const Elf_Shdr *>
275   findDynamic(const ELFFile<ELFT> *Obj);
276   void loadDynamicTable(const ELFFile<ELFT> *Obj);
277   void parseDynamicTable(const ELFFile<ELFT> *Obj);
278 
279   Expected<StringRef> getSymbolVersion(const Elf_Sym *symb,
280                                        bool &IsDefault) const;
281   Error LoadVersionMap() const;
282 
283   const object::ELFObjectFile<ELFT> *ObjF;
284   DynRegionInfo DynRelRegion;
285   DynRegionInfo DynRelaRegion;
286   DynRegionInfo DynRelrRegion;
287   DynRegionInfo DynPLTRelRegion;
288   Optional<DynRegionInfo> DynSymRegion;
289   DynRegionInfo DynamicTable;
290   StringRef DynamicStringTable;
291   StringRef SOName = "<Not found>";
292   const Elf_Hash *HashTable = nullptr;
293   const Elf_GnuHash *GnuHashTable = nullptr;
294   const Elf_Shdr *DotSymtabSec = nullptr;
295   const Elf_Shdr *DotCGProfileSec = nullptr;
296   const Elf_Shdr *DotAddrsigSec = nullptr;
297   StringRef DynSymtabName;
298   ArrayRef<Elf_Word> ShndxTable;
299 
300   const Elf_Shdr *SymbolVersionSection = nullptr;   // .gnu.version
301   const Elf_Shdr *SymbolVersionNeedSection = nullptr; // .gnu.version_r
302   const Elf_Shdr *SymbolVersionDefSection = nullptr; // .gnu.version_d
303 
304   struct VersionEntry {
305     std::string Name;
306     bool IsVerDef;
307   };
308   mutable SmallVector<Optional<VersionEntry>, 16> VersionMap;
309 
310   std::unordered_set<std::string> Warnings;
311 
312 public:
313   Elf_Dyn_Range dynamic_table() const {
314     // A valid .dynamic section contains an array of entries terminated
315     // with a DT_NULL entry. However, sometimes the section content may
316     // continue past the DT_NULL entry, so to dump the section correctly,
317     // we first find the end of the entries by iterating over them.
318     Elf_Dyn_Range Table = DynamicTable.getAsArrayRef<Elf_Dyn>();
319 
320     size_t Size = 0;
321     while (Size < Table.size())
322       if (Table[Size++].getTag() == DT_NULL)
323         break;
324 
325     return Table.slice(0, Size);
326   }
327 
328   Optional<DynRegionInfo> getDynSymRegion() const { return DynSymRegion; }
329 
330   Elf_Sym_Range dynamic_symbols() const {
331     if (!DynSymRegion)
332       return Elf_Sym_Range();
333     return DynSymRegion->getAsArrayRef<Elf_Sym>();
334   }
335 
336   Elf_Rel_Range dyn_rels() const;
337   Elf_Rela_Range dyn_relas() const;
338   Elf_Relr_Range dyn_relrs() const;
339   std::string getFullSymbolName(const Elf_Sym *Symbol,
340                                 Optional<StringRef> StrTable,
341                                 bool IsDynamic) const;
342   Expected<unsigned> getSymbolSectionIndex(const Elf_Sym *Symbol,
343                                            const Elf_Sym *FirstSym) const;
344   Expected<StringRef> getSymbolSectionName(const Elf_Sym *Symbol,
345                                            unsigned SectionIndex) const;
346   std::string getStaticSymbolName(uint32_t Index) const;
347   StringRef getDynamicString(uint64_t Value) const;
348   Expected<StringRef> getSymbolVersionByIndex(uint32_t VersionSymbolIndex,
349                                               bool &IsDefault) const;
350 
351   void printSymbolsHelper(bool IsDynamic) const;
352   std::string getDynamicEntry(uint64_t Type, uint64_t Value) const;
353 
354   const Elf_Shdr *getDotSymtabSec() const { return DotSymtabSec; }
355   const Elf_Shdr *getDotCGProfileSec() const { return DotCGProfileSec; }
356   const Elf_Shdr *getDotAddrsigSec() const { return DotAddrsigSec; }
357   ArrayRef<Elf_Word> getShndxTable() const { return ShndxTable; }
358   StringRef getDynamicStringTable() const { return DynamicStringTable; }
359   const DynRegionInfo &getDynRelRegion() const { return DynRelRegion; }
360   const DynRegionInfo &getDynRelaRegion() const { return DynRelaRegion; }
361   const DynRegionInfo &getDynRelrRegion() const { return DynRelrRegion; }
362   const DynRegionInfo &getDynPLTRelRegion() const { return DynPLTRelRegion; }
363   const DynRegionInfo &getDynamicTableRegion() const { return DynamicTable; }
364   const Elf_Hash *getHashTable() const { return HashTable; }
365   const Elf_GnuHash *getGnuHashTable() const { return GnuHashTable; }
366 
367   Expected<ArrayRef<Elf_Versym>> getVersionTable(const Elf_Shdr *Sec,
368                                                  ArrayRef<Elf_Sym> *SymTab,
369                                                  StringRef *StrTab) const;
370   Expected<std::vector<VerDef>>
371   getVersionDefinitions(const Elf_Shdr *Sec) const;
372   Expected<std::vector<VerNeed>>
373   getVersionDependencies(const Elf_Shdr *Sec) const;
374 
375   Expected<std::pair<const Elf_Sym *, std::string>>
376   getRelocationTarget(const Elf_Shdr *SymTab, const Elf_Rela &R) const;
377 
378   std::function<Error(const Twine &Msg)> WarningHandler;
379   void reportUniqueWarning(Error Err) const;
380 };
381 
382 template <class ELFT>
383 static Expected<StringRef> getLinkAsStrtab(const ELFFile<ELFT> *Obj,
384                                            const typename ELFT::Shdr *Sec,
385                                            unsigned SecNdx) {
386   Expected<const typename ELFT::Shdr *> StrTabSecOrErr =
387       Obj->getSection(Sec->sh_link);
388   if (!StrTabSecOrErr)
389     return createError("invalid section linked to " +
390                        object::getELFSectionTypeName(
391                            Obj->getHeader()->e_machine, Sec->sh_type) +
392                        " section with index " + Twine(SecNdx) + ": " +
393                        toString(StrTabSecOrErr.takeError()));
394 
395   Expected<StringRef> StrTabOrErr = Obj->getStringTable(*StrTabSecOrErr);
396   if (!StrTabOrErr)
397     return createError("invalid string table linked to " +
398                        object::getELFSectionTypeName(
399                            Obj->getHeader()->e_machine, Sec->sh_type) +
400                        " section with index " + Twine(SecNdx) + ": " +
401                        toString(StrTabOrErr.takeError()));
402   return *StrTabOrErr;
403 }
404 
405 // Returns the linked symbol table and associated string table for a given section.
406 template <class ELFT>
407 static Expected<std::pair<typename ELFT::SymRange, StringRef>>
408 getLinkAsSymtab(const ELFFile<ELFT> *Obj, const typename ELFT::Shdr *Sec,
409                    unsigned SecNdx, unsigned ExpectedType) {
410   Expected<const typename ELFT::Shdr *> SymtabOrErr =
411       Obj->getSection(Sec->sh_link);
412   if (!SymtabOrErr)
413     return createError("invalid section linked to " +
414                        object::getELFSectionTypeName(
415                            Obj->getHeader()->e_machine, Sec->sh_type) +
416                        " section with index " + Twine(SecNdx) + ": " +
417                        toString(SymtabOrErr.takeError()));
418 
419   if ((*SymtabOrErr)->sh_type != ExpectedType)
420     return createError(
421         "invalid section linked to " +
422         object::getELFSectionTypeName(Obj->getHeader()->e_machine,
423                                       Sec->sh_type) +
424         " section with index " + Twine(SecNdx) + ": expected " +
425         object::getELFSectionTypeName(Obj->getHeader()->e_machine,
426                                       ExpectedType) +
427         ", but got " +
428         object::getELFSectionTypeName(Obj->getHeader()->e_machine,
429                                       (*SymtabOrErr)->sh_type));
430 
431   Expected<StringRef> StrTabOrErr =
432       getLinkAsStrtab(Obj, *SymtabOrErr, Sec->sh_link);
433   if (!StrTabOrErr)
434     return createError(
435         "can't get a string table for the symbol table linked to " +
436         object::getELFSectionTypeName(Obj->getHeader()->e_machine,
437                                       Sec->sh_type) +
438         " section with index " + Twine(SecNdx) + ": " +
439         toString(StrTabOrErr.takeError()));
440 
441   Expected<typename ELFT::SymRange> SymsOrErr = Obj->symbols(*SymtabOrErr);
442   if (!SymsOrErr)
443     return createError(
444         "unable to read symbols from the symbol table with index " +
445         Twine(Sec->sh_link) + ": " + toString(SymsOrErr.takeError()));
446 
447   return std::make_pair(*SymsOrErr, *StrTabOrErr);
448 }
449 
450 template <class ELFT>
451 Expected<ArrayRef<typename ELFT::Versym>>
452 ELFDumper<ELFT>::getVersionTable(const Elf_Shdr *Sec, ArrayRef<Elf_Sym> *SymTab,
453                                  StringRef *StrTab) const {
454   assert((!SymTab && !StrTab) || (SymTab && StrTab));
455   const ELFFile<ELFT> *Obj = ObjF->getELFFile();
456   unsigned SecNdx = Sec - &cantFail(Obj->sections()).front();
457 
458   if (uintptr_t(Obj->base() + Sec->sh_offset) % sizeof(uint16_t) != 0)
459     return createError("the SHT_GNU_versym section with index " +
460                        Twine(SecNdx) + " is misaligned");
461 
462   Expected<ArrayRef<Elf_Versym>> VersionsOrErr =
463       Obj->template getSectionContentsAsArray<Elf_Versym>(Sec);
464   if (!VersionsOrErr)
465     return createError(
466         "cannot read content of SHT_GNU_versym section with index " +
467         Twine(SecNdx) + ": " + toString(VersionsOrErr.takeError()));
468 
469   Expected<std::pair<ArrayRef<Elf_Sym>, StringRef>> SymTabOrErr =
470       getLinkAsSymtab(Obj, Sec, SecNdx, SHT_DYNSYM);
471   if (!SymTabOrErr) {
472     reportUniqueWarning(SymTabOrErr.takeError());
473     return *VersionsOrErr;
474   }
475 
476   if (SymTabOrErr->first.size() != VersionsOrErr->size())
477     reportUniqueWarning(
478         createError("SHT_GNU_versym section with index " + Twine(SecNdx) +
479                     ": the number of entries (" + Twine(VersionsOrErr->size()) +
480                     ") does not match the number of symbols (" +
481                     Twine(SymTabOrErr->first.size()) +
482                     ") in the symbol table with index " + Twine(Sec->sh_link)));
483 
484   if (SymTab)
485     std::tie(*SymTab, *StrTab) = *SymTabOrErr;
486   return *VersionsOrErr;
487 }
488 
489 template <class ELFT>
490 Expected<std::vector<VerDef>>
491 ELFDumper<ELFT>::getVersionDefinitions(const Elf_Shdr *Sec) const {
492   const ELFFile<ELFT> *Obj = ObjF->getELFFile();
493   unsigned SecNdx = Sec - &cantFail(Obj->sections()).front();
494 
495   Expected<StringRef> StrTabOrErr = getLinkAsStrtab(Obj, Sec, SecNdx);
496   if (!StrTabOrErr)
497     return StrTabOrErr.takeError();
498 
499   Expected<ArrayRef<uint8_t>> ContentsOrErr = Obj->getSectionContents(Sec);
500   if (!ContentsOrErr)
501     return createError(
502         "cannot read content of SHT_GNU_verdef section with index " +
503         Twine(SecNdx) + ": " + toString(ContentsOrErr.takeError()));
504 
505   const uint8_t *Start = ContentsOrErr->data();
506   const uint8_t *End = Start + ContentsOrErr->size();
507 
508   auto ExtractNextAux = [&](const uint8_t *&VerdauxBuf,
509                             unsigned VerDefNdx) -> Expected<VerdAux> {
510     if (VerdauxBuf + sizeof(Elf_Verdaux) > End)
511       return createError("invalid SHT_GNU_verdef section with index " +
512                          Twine(SecNdx) + ": version definition " +
513                          Twine(VerDefNdx) +
514                          " refers to an auxiliary entry that goes past the end "
515                          "of the section");
516 
517     auto *Verdaux = reinterpret_cast<const Elf_Verdaux *>(VerdauxBuf);
518     VerdauxBuf += Verdaux->vda_next;
519 
520     VerdAux Aux;
521     Aux.Offset = VerdauxBuf - Start;
522     if (Verdaux->vda_name <= StrTabOrErr->size())
523       Aux.Name = std::string(StrTabOrErr->drop_front(Verdaux->vda_name));
524     else
525       Aux.Name = "<invalid vda_name: " + to_string(Verdaux->vda_name) + ">";
526     return Aux;
527   };
528 
529   std::vector<VerDef> Ret;
530   const uint8_t *VerdefBuf = Start;
531   for (unsigned I = 1; I <= /*VerDefsNum=*/Sec->sh_info; ++I) {
532     if (VerdefBuf + sizeof(Elf_Verdef) > End)
533       return createError("invalid SHT_GNU_verdef section with index " +
534                          Twine(SecNdx) + ": version definition " + Twine(I) +
535                          " goes past the end of the section");
536 
537     if (uintptr_t(VerdefBuf) % sizeof(uint32_t) != 0)
538       return createError(
539           "invalid SHT_GNU_verdef section with index " + Twine(SecNdx) +
540           ": found a misaligned version definition entry at offset 0x" +
541           Twine::utohexstr(VerdefBuf - Start));
542 
543     unsigned Version = *reinterpret_cast<const Elf_Half *>(VerdefBuf);
544     if (Version != 1)
545       return createError("unable to dump SHT_GNU_verdef section with index " +
546                          Twine(SecNdx) + ": version " + Twine(Version) +
547                          " is not yet supported");
548 
549     const Elf_Verdef *D = reinterpret_cast<const Elf_Verdef *>(VerdefBuf);
550     VerDef &VD = *Ret.emplace(Ret.end());
551     VD.Offset = VerdefBuf - Start;
552     VD.Version = D->vd_version;
553     VD.Flags = D->vd_flags;
554     VD.Ndx = D->vd_ndx;
555     VD.Cnt = D->vd_cnt;
556     VD.Hash = D->vd_hash;
557 
558     const uint8_t *VerdauxBuf = VerdefBuf + D->vd_aux;
559     for (unsigned J = 0; J < D->vd_cnt; ++J) {
560       if (uintptr_t(VerdauxBuf) % sizeof(uint32_t) != 0)
561         return createError("invalid SHT_GNU_verdef section with index " +
562                            Twine(SecNdx) +
563                            ": found a misaligned auxiliary entry at offset 0x" +
564                            Twine::utohexstr(VerdauxBuf - Start));
565 
566       Expected<VerdAux> AuxOrErr = ExtractNextAux(VerdauxBuf, I);
567       if (!AuxOrErr)
568         return AuxOrErr.takeError();
569 
570       if (J == 0)
571         VD.Name = AuxOrErr->Name;
572       else
573         VD.AuxV.push_back(*AuxOrErr);
574     }
575 
576     VerdefBuf += D->vd_next;
577   }
578 
579   return Ret;
580 }
581 
582 template <class ELFT>
583 Expected<std::vector<VerNeed>>
584 ELFDumper<ELFT>::getVersionDependencies(const Elf_Shdr *Sec) const {
585   const ELFFile<ELFT> *Obj = ObjF->getELFFile();
586   unsigned SecNdx = Sec - &cantFail(Obj->sections()).front();
587 
588   StringRef StrTab;
589   Expected<StringRef> StrTabOrErr = getLinkAsStrtab(Obj, Sec, SecNdx);
590   if (!StrTabOrErr)
591     reportUniqueWarning(StrTabOrErr.takeError());
592   else
593     StrTab = *StrTabOrErr;
594 
595   Expected<ArrayRef<uint8_t>> ContentsOrErr = Obj->getSectionContents(Sec);
596   if (!ContentsOrErr)
597     return createError(
598         "cannot read content of SHT_GNU_verneed section with index " +
599         Twine(SecNdx) + ": " + toString(ContentsOrErr.takeError()));
600 
601   const uint8_t *Start = ContentsOrErr->data();
602   const uint8_t *End = Start + ContentsOrErr->size();
603   const uint8_t *VerneedBuf = Start;
604 
605   std::vector<VerNeed> Ret;
606   for (unsigned I = 1; I <= /*VerneedNum=*/Sec->sh_info; ++I) {
607     if (VerneedBuf + sizeof(Elf_Verdef) > End)
608       return createError("invalid SHT_GNU_verneed section with index " +
609                          Twine(SecNdx) + ": version dependency " + Twine(I) +
610                          " goes past the end of the section");
611 
612     if (uintptr_t(VerneedBuf) % sizeof(uint32_t) != 0)
613       return createError(
614           "invalid SHT_GNU_verneed section with index " + Twine(SecNdx) +
615           ": found a misaligned version dependency entry at offset 0x" +
616           Twine::utohexstr(VerneedBuf - Start));
617 
618     unsigned Version = *reinterpret_cast<const Elf_Half *>(VerneedBuf);
619     if (Version != 1)
620       return createError("unable to dump SHT_GNU_verneed section with index " +
621                          Twine(SecNdx) + ": version " + Twine(Version) +
622                          " is not yet supported");
623 
624     const Elf_Verneed *Verneed =
625         reinterpret_cast<const Elf_Verneed *>(VerneedBuf);
626 
627     VerNeed &VN = *Ret.emplace(Ret.end());
628     VN.Version = Verneed->vn_version;
629     VN.Cnt = Verneed->vn_cnt;
630     VN.Offset = VerneedBuf - Start;
631 
632     if (Verneed->vn_file < StrTab.size())
633       VN.File = std::string(StrTab.drop_front(Verneed->vn_file));
634     else
635       VN.File = "<corrupt vn_file: " + to_string(Verneed->vn_file) + ">";
636 
637     const uint8_t *VernauxBuf = VerneedBuf + Verneed->vn_aux;
638     for (unsigned J = 0; J < Verneed->vn_cnt; ++J) {
639       if (uintptr_t(VernauxBuf) % sizeof(uint32_t) != 0)
640         return createError("invalid SHT_GNU_verneed section with index " +
641                            Twine(SecNdx) +
642                            ": found a misaligned auxiliary entry at offset 0x" +
643                            Twine::utohexstr(VernauxBuf - Start));
644 
645       if (VernauxBuf + sizeof(Elf_Vernaux) > End)
646         return createError(
647             "invalid SHT_GNU_verneed section with index " + Twine(SecNdx) +
648             ": version dependency " + Twine(I) +
649             " refers to an auxiliary entry that goes past the end "
650             "of the section");
651 
652       const Elf_Vernaux *Vernaux =
653           reinterpret_cast<const Elf_Vernaux *>(VernauxBuf);
654 
655       VernAux &Aux = *VN.AuxV.emplace(VN.AuxV.end());
656       Aux.Hash = Vernaux->vna_hash;
657       Aux.Flags = Vernaux->vna_flags;
658       Aux.Other = Vernaux->vna_other;
659       Aux.Offset = VernauxBuf - Start;
660       if (StrTab.size() <= Vernaux->vna_name)
661         Aux.Name = "<corrupt>";
662       else
663         Aux.Name = std::string(StrTab.drop_front(Vernaux->vna_name));
664 
665       VernauxBuf += Vernaux->vna_next;
666     }
667     VerneedBuf += Verneed->vn_next;
668   }
669   return Ret;
670 }
671 
672 template <class ELFT>
673 void ELFDumper<ELFT>::printSymbolsHelper(bool IsDynamic) const {
674   Optional<StringRef> StrTable;
675   StringRef SymtabName;
676   size_t Entries = 0;
677   Elf_Sym_Range Syms(nullptr, nullptr);
678   const ELFFile<ELFT> *Obj = ObjF->getELFFile();
679   if (IsDynamic) {
680     StrTable = DynamicStringTable;
681     Syms = dynamic_symbols();
682     SymtabName = DynSymtabName;
683     Entries = Syms.size();
684   } else {
685     if (!DotSymtabSec)
686       return;
687 
688     if (Expected<StringRef> StrTableOrErr =
689             Obj->getStringTableForSymtab(*DotSymtabSec))
690       StrTable = *StrTableOrErr;
691     else
692       reportUniqueWarning(createError(
693           "unable to get the string table for the SHT_SYMTAB section: " +
694           toString(StrTableOrErr.takeError())));
695 
696     if (Expected<Elf_Sym_Range> SymsOrErr = Obj->symbols(DotSymtabSec))
697       Syms = *SymsOrErr;
698     else
699       reportUniqueWarning(
700           createError("unable to read symbols from the SHT_SYMTAB section: " +
701                       toString(SymsOrErr.takeError())));
702 
703     if (Expected<StringRef> SymtabNameOrErr =
704             Obj->getSectionName(DotSymtabSec)) {
705       SymtabName = *SymtabNameOrErr;
706     } else {
707       reportUniqueWarning(
708           createError("unable to get the name of the SHT_SYMTAB section: " +
709                       toString(SymtabNameOrErr.takeError())));
710       SymtabName = "<?>";
711     }
712 
713     Entries = DotSymtabSec->getEntityCount();
714   }
715   if (Syms.begin() == Syms.end())
716     return;
717 
718   // The st_other field has 2 logical parts. The first two bits hold the symbol
719   // visibility (STV_*) and the remainder hold other platform-specific values.
720   bool NonVisibilityBitsUsed = llvm::find_if(Syms, [](const Elf_Sym &S) {
721                                  return S.st_other & ~0x3;
722                                }) != Syms.end();
723 
724   ELFDumperStyle->printSymtabMessage(Obj, SymtabName, Entries,
725                                      NonVisibilityBitsUsed);
726   for (const auto &Sym : Syms)
727     ELFDumperStyle->printSymbol(Obj, &Sym, Syms.begin(), StrTable, IsDynamic,
728                                 NonVisibilityBitsUsed);
729 }
730 
731 template <class ELFT> class MipsGOTParser;
732 
733 template <typename ELFT> class DumpStyle {
734 public:
735   using Elf_Shdr = typename ELFT::Shdr;
736   using Elf_Sym = typename ELFT::Sym;
737   using Elf_Addr = typename ELFT::Addr;
738 
739   DumpStyle(ELFDumper<ELFT> *Dumper) : Dumper(Dumper) {
740     FileName = this->Dumper->getElfObject()->getFileName();
741   }
742 
743   virtual ~DumpStyle() = default;
744 
745   virtual void printFileHeaders(const ELFFile<ELFT> *Obj) = 0;
746   virtual void printGroupSections(const ELFFile<ELFT> *Obj) = 0;
747   virtual void printRelocations(const ELFFile<ELFT> *Obj) = 0;
748   virtual void printSectionHeaders(const ELFFile<ELFT> *Obj) = 0;
749   virtual void printSymbols(const ELFFile<ELFT> *Obj, bool PrintSymbols,
750                             bool PrintDynamicSymbols) = 0;
751   virtual void printHashSymbols(const ELFFile<ELFT> *Obj) {}
752   virtual void printDependentLibs(const ELFFile<ELFT> *Obj) = 0;
753   virtual void printDynamic(const ELFFile<ELFT> *Obj) {}
754   virtual void printDynamicRelocations(const ELFFile<ELFT> *Obj) = 0;
755   virtual void printSymtabMessage(const ELFFile<ELFT> *Obj, StringRef Name,
756                                   size_t Offset, bool NonVisibilityBitsUsed) {}
757   virtual void printSymbol(const ELFFile<ELFT> *Obj, const Elf_Sym *Symbol,
758                            const Elf_Sym *FirstSym,
759                            Optional<StringRef> StrTable, bool IsDynamic,
760                            bool NonVisibilityBitsUsed) = 0;
761   virtual void printProgramHeaders(const ELFFile<ELFT> *Obj,
762                                    bool PrintProgramHeaders,
763                                    cl::boolOrDefault PrintSectionMapping) = 0;
764   virtual void printVersionSymbolSection(const ELFFile<ELFT> *Obj,
765                                          const Elf_Shdr *Sec) = 0;
766   virtual void printVersionDefinitionSection(const ELFFile<ELFT> *Obj,
767                                              const Elf_Shdr *Sec) = 0;
768   virtual void printVersionDependencySection(const ELFFile<ELFT> *Obj,
769                                              const Elf_Shdr *Sec) = 0;
770   virtual void printHashHistograms(const ELFFile<ELFT> *Obj) = 0;
771   virtual void printCGProfile(const ELFFile<ELFT> *Obj) = 0;
772   virtual void printAddrsig(const ELFFile<ELFT> *Obj) = 0;
773   virtual void printNotes(const ELFFile<ELFT> *Obj) = 0;
774   virtual void printELFLinkerOptions(const ELFFile<ELFT> *Obj) = 0;
775   virtual void printStackSizes(const ELFObjectFile<ELFT> *Obj) = 0;
776   void printNonRelocatableStackSizes(const ELFObjectFile<ELFT> *Obj,
777                                      std::function<void()> PrintHeader);
778   void printRelocatableStackSizes(const ELFObjectFile<ELFT> *Obj,
779                                   std::function<void()> PrintHeader);
780   void printFunctionStackSize(const ELFObjectFile<ELFT> *Obj, uint64_t SymValue,
781                               Optional<SectionRef> FunctionSec,
782                               const StringRef SectionName, DataExtractor Data,
783                               uint64_t *Offset);
784   void printStackSize(const ELFObjectFile<ELFT> *Obj, RelocationRef Rel,
785                       SectionRef FunctionSec,
786                       const StringRef &StackSizeSectionName,
787                       const RelocationResolver &Resolver, DataExtractor Data);
788   virtual void printStackSizeEntry(uint64_t Size, StringRef FuncName) = 0;
789   virtual void printMipsGOT(const MipsGOTParser<ELFT> &Parser) = 0;
790   virtual void printMipsPLT(const MipsGOTParser<ELFT> &Parser) = 0;
791   virtual void printMipsABIFlags(const ELFObjectFile<ELFT> *Obj) = 0;
792   const ELFDumper<ELFT> *dumper() const { return Dumper; }
793 
794 protected:
795   void printDependentLibsHelper(
796       const ELFFile<ELFT> *Obj,
797       function_ref<void(const Elf_Shdr &)> OnSectionStart,
798       function_ref<void(StringRef, uint64_t)> OnSectionEntry);
799 
800   void reportUniqueWarning(Error Err) const;
801   StringRef FileName;
802 
803 private:
804   const ELFDumper<ELFT> *Dumper;
805 };
806 
807 template <typename ELFT> class GNUStyle : public DumpStyle<ELFT> {
808   formatted_raw_ostream &OS;
809 
810 public:
811   TYPEDEF_ELF_TYPES(ELFT)
812 
813   GNUStyle(ScopedPrinter &W, ELFDumper<ELFT> *Dumper)
814       : DumpStyle<ELFT>(Dumper),
815         OS(static_cast<formatted_raw_ostream&>(W.getOStream())) {
816     assert (&W.getOStream() == &llvm::fouts());
817   }
818 
819   void printFileHeaders(const ELFO *Obj) override;
820   void printGroupSections(const ELFFile<ELFT> *Obj) override;
821   void printRelocations(const ELFO *Obj) override;
822   void printSectionHeaders(const ELFO *Obj) override;
823   void printSymbols(const ELFO *Obj, bool PrintSymbols,
824                     bool PrintDynamicSymbols) override;
825   void printHashSymbols(const ELFO *Obj) override;
826   void printDependentLibs(const ELFFile<ELFT> *Obj) override;
827   void printDynamic(const ELFFile<ELFT> *Obj) override;
828   void printDynamicRelocations(const ELFO *Obj) override;
829   void printSymtabMessage(const ELFO *Obj, StringRef Name, size_t Offset,
830                           bool NonVisibilityBitsUsed) override;
831   void printProgramHeaders(const ELFO *Obj, bool PrintProgramHeaders,
832                            cl::boolOrDefault PrintSectionMapping) override;
833   void printVersionSymbolSection(const ELFFile<ELFT> *Obj,
834                                  const Elf_Shdr *Sec) override;
835   void printVersionDefinitionSection(const ELFFile<ELFT> *Obj,
836                                      const Elf_Shdr *Sec) override;
837   void printVersionDependencySection(const ELFFile<ELFT> *Obj,
838                                      const Elf_Shdr *Sec) override;
839   void printHashHistograms(const ELFFile<ELFT> *Obj) override;
840   void printCGProfile(const ELFFile<ELFT> *Obj) override;
841   void printAddrsig(const ELFFile<ELFT> *Obj) override;
842   void printNotes(const ELFFile<ELFT> *Obj) override;
843   void printELFLinkerOptions(const ELFFile<ELFT> *Obj) override;
844   void printStackSizes(const ELFObjectFile<ELFT> *Obj) override;
845   void printStackSizeEntry(uint64_t Size, StringRef FuncName) override;
846   void printMipsGOT(const MipsGOTParser<ELFT> &Parser) override;
847   void printMipsPLT(const MipsGOTParser<ELFT> &Parser) override;
848   void printMipsABIFlags(const ELFObjectFile<ELFT> *Obj) override;
849 
850 private:
851   void printHashHistogram(const Elf_Hash &HashTable);
852   void printGnuHashHistogram(const Elf_GnuHash &GnuHashTable);
853 
854   void printHashTableSymbols(const ELFO *Obj, const Elf_Hash &HashTable);
855   void printGnuHashTableSymbols(const ELFO *Obj,
856                                 const Elf_GnuHash &GnuHashTable);
857 
858   struct Field {
859     std::string Str;
860     unsigned Column;
861 
862     Field(StringRef S, unsigned Col) : Str(std::string(S)), Column(Col) {}
863     Field(unsigned Col) : Column(Col) {}
864   };
865 
866   template <typename T, typename TEnum>
867   std::string printEnum(T Value, ArrayRef<EnumEntry<TEnum>> EnumValues) {
868     for (const auto &EnumItem : EnumValues)
869       if (EnumItem.Value == Value)
870         return std::string(EnumItem.AltName);
871     return to_hexString(Value, false);
872   }
873 
874   template <typename T, typename TEnum>
875   std::string printFlags(T Value, ArrayRef<EnumEntry<TEnum>> EnumValues,
876                          TEnum EnumMask1 = {}, TEnum EnumMask2 = {},
877                          TEnum EnumMask3 = {}) {
878     std::string Str;
879     for (const auto &Flag : EnumValues) {
880       if (Flag.Value == 0)
881         continue;
882 
883       TEnum EnumMask{};
884       if (Flag.Value & EnumMask1)
885         EnumMask = EnumMask1;
886       else if (Flag.Value & EnumMask2)
887         EnumMask = EnumMask2;
888       else if (Flag.Value & EnumMask3)
889         EnumMask = EnumMask3;
890       bool IsEnum = (Flag.Value & EnumMask) != 0;
891       if ((!IsEnum && (Value & Flag.Value) == Flag.Value) ||
892           (IsEnum && (Value & EnumMask) == Flag.Value)) {
893         if (!Str.empty())
894           Str += ", ";
895         Str += Flag.AltName;
896       }
897     }
898     return Str;
899   }
900 
901   formatted_raw_ostream &printField(struct Field F) {
902     if (F.Column != 0)
903       OS.PadToColumn(F.Column);
904     OS << F.Str;
905     OS.flush();
906     return OS;
907   }
908   void printHashedSymbol(const ELFO *Obj, const Elf_Sym *FirstSym, uint32_t Sym,
909                          StringRef StrTable, uint32_t Bucket);
910   void printRelocHeader(unsigned SType);
911   void printRelocation(const ELFO *Obj, unsigned SecIndex,
912                        const Elf_Shdr *SymTab, const Elf_Rela &R,
913                        unsigned RelIndex, bool IsRela);
914   void printRelocation(const ELFO *Obj, const Elf_Sym *Sym,
915                        StringRef SymbolName, const Elf_Rela &R, bool IsRela);
916   void printSymbol(const ELFO *Obj, const Elf_Sym *Symbol, const Elf_Sym *First,
917                    Optional<StringRef> StrTable, bool IsDynamic,
918                    bool NonVisibilityBitsUsed) override;
919   std::string getSymbolSectionNdx(const ELFO *Obj, const Elf_Sym *Symbol,
920                                   const Elf_Sym *FirstSym);
921   void printDynamicRelocation(const ELFO *Obj, Elf_Rela R, bool IsRela);
922   void printProgramHeaders(const ELFO *Obj);
923   void printSectionMapping(const ELFO *Obj);
924   void printGNUVersionSectionProlog(const ELFFile<ELFT> *Obj,
925                                     const typename ELFT::Shdr *Sec,
926                                     const Twine &Label, unsigned EntriesNum);
927 };
928 
929 template <class ELFT>
930 void ELFDumper<ELFT>::reportUniqueWarning(Error Err) const {
931   handleAllErrors(std::move(Err), [&](const ErrorInfoBase &EI) {
932     cantFail(WarningHandler(EI.message()),
933              "WarningHandler should always return ErrorSuccess");
934   });
935 }
936 
937 template <class ELFT>
938 void DumpStyle<ELFT>::reportUniqueWarning(Error Err) const {
939   this->dumper()->reportUniqueWarning(std::move(Err));
940 }
941 
942 template <typename ELFT> class LLVMStyle : public DumpStyle<ELFT> {
943 public:
944   TYPEDEF_ELF_TYPES(ELFT)
945 
946   LLVMStyle(ScopedPrinter &W, ELFDumper<ELFT> *Dumper)
947       : DumpStyle<ELFT>(Dumper), W(W) {}
948 
949   void printFileHeaders(const ELFO *Obj) override;
950   void printGroupSections(const ELFFile<ELFT> *Obj) override;
951   void printRelocations(const ELFO *Obj) override;
952   void printRelocations(const Elf_Shdr *Sec, const ELFO *Obj);
953   void printSectionHeaders(const ELFO *Obj) override;
954   void printSymbols(const ELFO *Obj, bool PrintSymbols,
955                     bool PrintDynamicSymbols) override;
956   void printDependentLibs(const ELFFile<ELFT> *Obj) override;
957   void printDynamic(const ELFFile<ELFT> *Obj) override;
958   void printDynamicRelocations(const ELFO *Obj) override;
959   void printProgramHeaders(const ELFO *Obj, bool PrintProgramHeaders,
960                            cl::boolOrDefault PrintSectionMapping) override;
961   void printVersionSymbolSection(const ELFFile<ELFT> *Obj,
962                                  const Elf_Shdr *Sec) override;
963   void printVersionDefinitionSection(const ELFFile<ELFT> *Obj,
964                                      const Elf_Shdr *Sec) override;
965   void printVersionDependencySection(const ELFFile<ELFT> *Obj,
966                                      const Elf_Shdr *Sec) override;
967   void printHashHistograms(const ELFFile<ELFT> *Obj) override;
968   void printCGProfile(const ELFFile<ELFT> *Obj) override;
969   void printAddrsig(const ELFFile<ELFT> *Obj) override;
970   void printNotes(const ELFFile<ELFT> *Obj) override;
971   void printELFLinkerOptions(const ELFFile<ELFT> *Obj) override;
972   void printStackSizes(const ELFObjectFile<ELFT> *Obj) override;
973   void printStackSizeEntry(uint64_t Size, StringRef FuncName) override;
974   void printMipsGOT(const MipsGOTParser<ELFT> &Parser) override;
975   void printMipsPLT(const MipsGOTParser<ELFT> &Parser) override;
976   void printMipsABIFlags(const ELFObjectFile<ELFT> *Obj) override;
977 
978 private:
979   void printRelocation(const ELFO *Obj, unsigned SecIndex, Elf_Rela Rel,
980                        unsigned RelIndex, const Elf_Shdr *SymTab);
981   void printDynamicRelocation(const ELFO *Obj, Elf_Rela Rel);
982   void printSymbols(const ELFO *Obj);
983   void printDynamicSymbols(const ELFO *Obj);
984   void printSymbolSection(const Elf_Sym *Symbol, const Elf_Sym *First);
985   void printSymbol(const ELFO *Obj, const Elf_Sym *Symbol, const Elf_Sym *First,
986                    Optional<StringRef> StrTable, bool IsDynamic,
987                    bool /*NonVisibilityBitsUsed*/) override;
988   void printProgramHeaders(const ELFO *Obj);
989   void printSectionMapping(const ELFO *Obj) {}
990 
991   ScopedPrinter &W;
992 };
993 
994 } // end anonymous namespace
995 
996 namespace llvm {
997 
998 template <class ELFT>
999 static std::error_code createELFDumper(const ELFObjectFile<ELFT> *Obj,
1000                                        ScopedPrinter &Writer,
1001                                        std::unique_ptr<ObjDumper> &Result) {
1002   Result.reset(new ELFDumper<ELFT>(Obj, Writer));
1003   return readobj_error::success;
1004 }
1005 
1006 std::error_code createELFDumper(const object::ObjectFile *Obj,
1007                                 ScopedPrinter &Writer,
1008                                 std::unique_ptr<ObjDumper> &Result) {
1009   // Little-endian 32-bit
1010   if (const ELF32LEObjectFile *ELFObj = dyn_cast<ELF32LEObjectFile>(Obj))
1011     return createELFDumper(ELFObj, Writer, Result);
1012 
1013   // Big-endian 32-bit
1014   if (const ELF32BEObjectFile *ELFObj = dyn_cast<ELF32BEObjectFile>(Obj))
1015     return createELFDumper(ELFObj, Writer, Result);
1016 
1017   // Little-endian 64-bit
1018   if (const ELF64LEObjectFile *ELFObj = dyn_cast<ELF64LEObjectFile>(Obj))
1019     return createELFDumper(ELFObj, Writer, Result);
1020 
1021   // Big-endian 64-bit
1022   if (const ELF64BEObjectFile *ELFObj = dyn_cast<ELF64BEObjectFile>(Obj))
1023     return createELFDumper(ELFObj, Writer, Result);
1024 
1025   return readobj_error::unsupported_obj_file_format;
1026 }
1027 
1028 } // end namespace llvm
1029 
1030 template <class ELFT> Error ELFDumper<ELFT>::LoadVersionMap() const {
1031   // If there is no dynamic symtab or version table, there is nothing to do.
1032   if (!DynSymRegion || !SymbolVersionSection)
1033     return Error::success();
1034 
1035   // Has the VersionMap already been loaded?
1036   if (!VersionMap.empty())
1037     return Error::success();
1038 
1039   // The first two version indexes are reserved.
1040   // Index 0 is LOCAL, index 1 is GLOBAL.
1041   VersionMap.push_back(VersionEntry());
1042   VersionMap.push_back(VersionEntry());
1043 
1044   auto InsertEntry = [this](unsigned N, StringRef Version, bool IsVerdef) {
1045     if (N >= VersionMap.size())
1046       VersionMap.resize(N + 1);
1047     VersionMap[N] = {std::string(Version), IsVerdef};
1048   };
1049 
1050   if (SymbolVersionDefSection) {
1051     Expected<std::vector<VerDef>> Defs =
1052         this->getVersionDefinitions(SymbolVersionDefSection);
1053     if (!Defs)
1054       return Defs.takeError();
1055     for (const VerDef &Def : *Defs)
1056       InsertEntry(Def.Ndx & ELF::VERSYM_VERSION, Def.Name, true);
1057   }
1058 
1059   if (SymbolVersionNeedSection) {
1060     Expected<std::vector<VerNeed>> Deps =
1061         this->getVersionDependencies(SymbolVersionNeedSection);
1062     if (!Deps)
1063       return Deps.takeError();
1064     for (const VerNeed &Dep : *Deps)
1065       for (const VernAux &Aux : Dep.AuxV)
1066         InsertEntry(Aux.Other & ELF::VERSYM_VERSION, Aux.Name, false);
1067   }
1068 
1069   return Error::success();
1070 }
1071 
1072 template <typename ELFT>
1073 Expected<StringRef> ELFDumper<ELFT>::getSymbolVersion(const Elf_Sym *Sym,
1074                                                       bool &IsDefault) const {
1075   // This is a dynamic symbol. Look in the GNU symbol version table.
1076   if (!SymbolVersionSection) {
1077     // No version table.
1078     IsDefault = false;
1079     return "";
1080   }
1081 
1082   assert(DynSymRegion && "DynSymRegion has not been initialised");
1083   // Determine the position in the symbol table of this entry.
1084   size_t EntryIndex = (reinterpret_cast<uintptr_t>(Sym) -
1085                        reinterpret_cast<uintptr_t>(DynSymRegion->Addr)) /
1086                       sizeof(Elf_Sym);
1087 
1088   // Get the corresponding version index entry.
1089   const Elf_Versym *Versym = unwrapOrError(
1090       ObjF->getFileName(), ObjF->getELFFile()->template getEntry<Elf_Versym>(
1091                                SymbolVersionSection, EntryIndex));
1092   return this->getSymbolVersionByIndex(Versym->vs_index, IsDefault);
1093 }
1094 
1095 template <typename ELFT>
1096 Expected<std::pair<const typename ELFT::Sym *, std::string>>
1097 ELFDumper<ELFT>::getRelocationTarget(const Elf_Shdr *SymTab,
1098                                      const Elf_Rela &R) const {
1099   const ELFFile<ELFT> *Obj = ObjF->getELFFile();
1100   Expected<const Elf_Sym *> SymOrErr = Obj->getRelocationSymbol(&R, SymTab);
1101   if (!SymOrErr)
1102     return SymOrErr.takeError();
1103   const Elf_Sym *Sym = *SymOrErr;
1104   if (!Sym)
1105     return std::make_pair(nullptr, "");
1106 
1107   // The st_name field of a STT_SECTION is usually 0 (empty string).
1108   // This code block returns the section name.
1109   if (Sym->getType() == ELF::STT_SECTION) {
1110     Expected<const Elf_Shdr *> SecOrErr =
1111         Obj->getSection(Sym, SymTab, ShndxTable);
1112     if (!SecOrErr)
1113       return SecOrErr.takeError();
1114     // A section symbol describes the section at index 0.
1115     if (*SecOrErr == nullptr)
1116       return std::make_pair(Sym, "");
1117 
1118     Expected<StringRef> NameOrErr = Obj->getSectionName(*SecOrErr);
1119     if (!NameOrErr)
1120       return NameOrErr.takeError();
1121     return std::make_pair(Sym, NameOrErr->str());
1122   }
1123 
1124   Expected<StringRef> StrTableOrErr = Obj->getStringTableForSymtab(*SymTab);
1125   if (!StrTableOrErr)
1126     return StrTableOrErr.takeError();
1127 
1128   std::string SymbolName =
1129       getFullSymbolName(Sym, *StrTableOrErr, SymTab->sh_type == SHT_DYNSYM);
1130   return std::make_pair(Sym, SymbolName);
1131 }
1132 
1133 static std::string maybeDemangle(StringRef Name) {
1134   return opts::Demangle ? demangle(std::string(Name)) : Name.str();
1135 }
1136 
1137 template <typename ELFT>
1138 std::string ELFDumper<ELFT>::getStaticSymbolName(uint32_t Index) const {
1139   auto Warn = [&](Error E) -> std::string {
1140     this->reportUniqueWarning(
1141         createError("unable to read the name of symbol with index " +
1142                     Twine(Index) + ": " + toString(std::move(E))));
1143     return "<?>";
1144   };
1145 
1146   const ELFFile<ELFT> *Obj = ObjF->getELFFile();
1147   Expected<const typename ELFT::Sym *> SymOrErr =
1148       Obj->getSymbol(DotSymtabSec, Index);
1149   if (!SymOrErr)
1150     return Warn(SymOrErr.takeError());
1151 
1152   Expected<StringRef> StrTabOrErr = Obj->getStringTableForSymtab(*DotSymtabSec);
1153   if (!StrTabOrErr)
1154     return Warn(StrTabOrErr.takeError());
1155 
1156   Expected<StringRef> NameOrErr = (*SymOrErr)->getName(*StrTabOrErr);
1157   if (!NameOrErr)
1158     return Warn(NameOrErr.takeError());
1159   return maybeDemangle(*NameOrErr);
1160 }
1161 
1162 template <typename ELFT>
1163 Expected<StringRef>
1164 ELFDumper<ELFT>::getSymbolVersionByIndex(uint32_t SymbolVersionIndex,
1165                                          bool &IsDefault) const {
1166   size_t VersionIndex = SymbolVersionIndex & VERSYM_VERSION;
1167 
1168   // Special markers for unversioned symbols.
1169   if (VersionIndex == VER_NDX_LOCAL || VersionIndex == VER_NDX_GLOBAL) {
1170     IsDefault = false;
1171     return "";
1172   }
1173 
1174   // Lookup this symbol in the version table.
1175   if (Error E = LoadVersionMap())
1176     return std::move(E);
1177   if (VersionIndex >= VersionMap.size() || !VersionMap[VersionIndex])
1178     return createError("SHT_GNU_versym section refers to a version index " +
1179                        Twine(VersionIndex) + " which is missing");
1180 
1181   const VersionEntry &Entry = *VersionMap[VersionIndex];
1182   if (Entry.IsVerDef)
1183     IsDefault = !(SymbolVersionIndex & VERSYM_HIDDEN);
1184   else
1185     IsDefault = false;
1186   return Entry.Name.c_str();
1187 }
1188 
1189 template <typename ELFT>
1190 std::string ELFDumper<ELFT>::getFullSymbolName(const Elf_Sym *Symbol,
1191                                                Optional<StringRef> StrTable,
1192                                                bool IsDynamic) const {
1193   if (!StrTable)
1194     return "<?>";
1195 
1196   std::string SymbolName;
1197   if (Expected<StringRef> NameOrErr = Symbol->getName(*StrTable)) {
1198     SymbolName = maybeDemangle(*NameOrErr);
1199   } else {
1200     reportUniqueWarning(NameOrErr.takeError());
1201     return "<?>";
1202   }
1203 
1204   if (SymbolName.empty() && Symbol->getType() == ELF::STT_SECTION) {
1205     Elf_Sym_Range Syms = unwrapOrError(
1206         ObjF->getFileName(), ObjF->getELFFile()->symbols(DotSymtabSec));
1207     Expected<unsigned> SectionIndex =
1208         getSymbolSectionIndex(Symbol, Syms.begin());
1209     if (!SectionIndex) {
1210       reportUniqueWarning(SectionIndex.takeError());
1211       return "<?>";
1212     }
1213     Expected<StringRef> NameOrErr = getSymbolSectionName(Symbol, *SectionIndex);
1214     if (!NameOrErr) {
1215       reportUniqueWarning(NameOrErr.takeError());
1216       return ("<section " + Twine(*SectionIndex) + ">").str();
1217     }
1218     return std::string(*NameOrErr);
1219   }
1220 
1221   if (!IsDynamic)
1222     return SymbolName;
1223 
1224   bool IsDefault;
1225   Expected<StringRef> VersionOrErr = getSymbolVersion(&*Symbol, IsDefault);
1226   if (!VersionOrErr) {
1227     reportUniqueWarning(VersionOrErr.takeError());
1228     return SymbolName + "@<corrupt>";
1229   }
1230 
1231   if (!VersionOrErr->empty()) {
1232     SymbolName += (IsDefault ? "@@" : "@");
1233     SymbolName += *VersionOrErr;
1234   }
1235   return SymbolName;
1236 }
1237 
1238 template <typename ELFT>
1239 Expected<unsigned>
1240 ELFDumper<ELFT>::getSymbolSectionIndex(const Elf_Sym *Symbol,
1241                                        const Elf_Sym *FirstSym) const {
1242   return Symbol->st_shndx == SHN_XINDEX
1243              ? object::getExtendedSymbolTableIndex<ELFT>(Symbol, FirstSym,
1244                                                          ShndxTable)
1245              : Symbol->st_shndx;
1246 }
1247 
1248 // If the Symbol has a reserved st_shndx other than SHN_XINDEX, return a
1249 // descriptive interpretation of the st_shndx value. Otherwise, return the name
1250 // of the section with index SectionIndex. This function assumes that if the
1251 // Symbol has st_shndx == SHN_XINDEX the SectionIndex will be the value derived
1252 // from the SHT_SYMTAB_SHNDX section.
1253 template <typename ELFT>
1254 Expected<StringRef>
1255 ELFDumper<ELFT>::getSymbolSectionName(const Elf_Sym *Symbol,
1256                                       unsigned SectionIndex) const {
1257   if (Symbol->isUndefined())
1258     return "Undefined";
1259   if (Symbol->isProcessorSpecific())
1260     return "Processor Specific";
1261   if (Symbol->isOSSpecific())
1262     return "Operating System Specific";
1263   if (Symbol->isAbsolute())
1264     return "Absolute";
1265   if (Symbol->isCommon())
1266     return "Common";
1267   if (Symbol->isReserved() && Symbol->st_shndx != SHN_XINDEX)
1268     return "Reserved";
1269 
1270   const ELFFile<ELFT> *Obj = ObjF->getELFFile();
1271   Expected<const Elf_Shdr *> SecOrErr =
1272       Obj->getSection(SectionIndex);
1273   if (!SecOrErr)
1274     return SecOrErr.takeError();
1275   return Obj->getSectionName(*SecOrErr);
1276 }
1277 
1278 template <class ELFO>
1279 static const typename ELFO::Elf_Shdr *
1280 findNotEmptySectionByAddress(const ELFO *Obj, StringRef FileName,
1281                              uint64_t Addr) {
1282   for (const typename ELFO::Elf_Shdr &Shdr : cantFail(Obj->sections()))
1283     if (Shdr.sh_addr == Addr && Shdr.sh_size > 0)
1284       return &Shdr;
1285   return nullptr;
1286 }
1287 
1288 template <class ELFO>
1289 static const typename ELFO::Elf_Shdr *
1290 findSectionByName(const ELFO &Obj, StringRef FileName, StringRef Name) {
1291   for (const typename ELFO::Elf_Shdr &Shdr : cantFail(Obj.sections()))
1292     if (Name == unwrapOrError(FileName, Obj.getSectionName(&Shdr)))
1293       return &Shdr;
1294   return nullptr;
1295 }
1296 
1297 static const EnumEntry<unsigned> ElfClass[] = {
1298   {"None",   "none",   ELF::ELFCLASSNONE},
1299   {"32-bit", "ELF32",  ELF::ELFCLASS32},
1300   {"64-bit", "ELF64",  ELF::ELFCLASS64},
1301 };
1302 
1303 static const EnumEntry<unsigned> ElfDataEncoding[] = {
1304   {"None",         "none",                          ELF::ELFDATANONE},
1305   {"LittleEndian", "2's complement, little endian", ELF::ELFDATA2LSB},
1306   {"BigEndian",    "2's complement, big endian",    ELF::ELFDATA2MSB},
1307 };
1308 
1309 static const EnumEntry<unsigned> ElfObjectFileType[] = {
1310   {"None",         "NONE (none)",              ELF::ET_NONE},
1311   {"Relocatable",  "REL (Relocatable file)",   ELF::ET_REL},
1312   {"Executable",   "EXEC (Executable file)",   ELF::ET_EXEC},
1313   {"SharedObject", "DYN (Shared object file)", ELF::ET_DYN},
1314   {"Core",         "CORE (Core file)",         ELF::ET_CORE},
1315 };
1316 
1317 static const EnumEntry<unsigned> ElfOSABI[] = {
1318   {"SystemV",      "UNIX - System V",      ELF::ELFOSABI_NONE},
1319   {"HPUX",         "UNIX - HP-UX",         ELF::ELFOSABI_HPUX},
1320   {"NetBSD",       "UNIX - NetBSD",        ELF::ELFOSABI_NETBSD},
1321   {"GNU/Linux",    "UNIX - GNU",           ELF::ELFOSABI_LINUX},
1322   {"GNU/Hurd",     "GNU/Hurd",             ELF::ELFOSABI_HURD},
1323   {"Solaris",      "UNIX - Solaris",       ELF::ELFOSABI_SOLARIS},
1324   {"AIX",          "UNIX - AIX",           ELF::ELFOSABI_AIX},
1325   {"IRIX",         "UNIX - IRIX",          ELF::ELFOSABI_IRIX},
1326   {"FreeBSD",      "UNIX - FreeBSD",       ELF::ELFOSABI_FREEBSD},
1327   {"TRU64",        "UNIX - TRU64",         ELF::ELFOSABI_TRU64},
1328   {"Modesto",      "Novell - Modesto",     ELF::ELFOSABI_MODESTO},
1329   {"OpenBSD",      "UNIX - OpenBSD",       ELF::ELFOSABI_OPENBSD},
1330   {"OpenVMS",      "VMS - OpenVMS",        ELF::ELFOSABI_OPENVMS},
1331   {"NSK",          "HP - Non-Stop Kernel", ELF::ELFOSABI_NSK},
1332   {"AROS",         "AROS",                 ELF::ELFOSABI_AROS},
1333   {"FenixOS",      "FenixOS",              ELF::ELFOSABI_FENIXOS},
1334   {"CloudABI",     "CloudABI",             ELF::ELFOSABI_CLOUDABI},
1335   {"Standalone",   "Standalone App",       ELF::ELFOSABI_STANDALONE}
1336 };
1337 
1338 static const EnumEntry<unsigned> SymVersionFlags[] = {
1339     {"Base", "BASE", VER_FLG_BASE},
1340     {"Weak", "WEAK", VER_FLG_WEAK},
1341     {"Info", "INFO", VER_FLG_INFO}};
1342 
1343 static const EnumEntry<unsigned> AMDGPUElfOSABI[] = {
1344   {"AMDGPU_HSA",    "AMDGPU - HSA",    ELF::ELFOSABI_AMDGPU_HSA},
1345   {"AMDGPU_PAL",    "AMDGPU - PAL",    ELF::ELFOSABI_AMDGPU_PAL},
1346   {"AMDGPU_MESA3D", "AMDGPU - MESA3D", ELF::ELFOSABI_AMDGPU_MESA3D}
1347 };
1348 
1349 static const EnumEntry<unsigned> ARMElfOSABI[] = {
1350   {"ARM", "ARM", ELF::ELFOSABI_ARM}
1351 };
1352 
1353 static const EnumEntry<unsigned> C6000ElfOSABI[] = {
1354   {"C6000_ELFABI", "Bare-metal C6000", ELF::ELFOSABI_C6000_ELFABI},
1355   {"C6000_LINUX",  "Linux C6000",      ELF::ELFOSABI_C6000_LINUX}
1356 };
1357 
1358 static const EnumEntry<unsigned> ElfMachineType[] = {
1359   ENUM_ENT(EM_NONE,          "None"),
1360   ENUM_ENT(EM_M32,           "WE32100"),
1361   ENUM_ENT(EM_SPARC,         "Sparc"),
1362   ENUM_ENT(EM_386,           "Intel 80386"),
1363   ENUM_ENT(EM_68K,           "MC68000"),
1364   ENUM_ENT(EM_88K,           "MC88000"),
1365   ENUM_ENT(EM_IAMCU,         "EM_IAMCU"),
1366   ENUM_ENT(EM_860,           "Intel 80860"),
1367   ENUM_ENT(EM_MIPS,          "MIPS R3000"),
1368   ENUM_ENT(EM_S370,          "IBM System/370"),
1369   ENUM_ENT(EM_MIPS_RS3_LE,   "MIPS R3000 little-endian"),
1370   ENUM_ENT(EM_PARISC,        "HPPA"),
1371   ENUM_ENT(EM_VPP500,        "Fujitsu VPP500"),
1372   ENUM_ENT(EM_SPARC32PLUS,   "Sparc v8+"),
1373   ENUM_ENT(EM_960,           "Intel 80960"),
1374   ENUM_ENT(EM_PPC,           "PowerPC"),
1375   ENUM_ENT(EM_PPC64,         "PowerPC64"),
1376   ENUM_ENT(EM_S390,          "IBM S/390"),
1377   ENUM_ENT(EM_SPU,           "SPU"),
1378   ENUM_ENT(EM_V800,          "NEC V800 series"),
1379   ENUM_ENT(EM_FR20,          "Fujistsu FR20"),
1380   ENUM_ENT(EM_RH32,          "TRW RH-32"),
1381   ENUM_ENT(EM_RCE,           "Motorola RCE"),
1382   ENUM_ENT(EM_ARM,           "ARM"),
1383   ENUM_ENT(EM_ALPHA,         "EM_ALPHA"),
1384   ENUM_ENT(EM_SH,            "Hitachi SH"),
1385   ENUM_ENT(EM_SPARCV9,       "Sparc v9"),
1386   ENUM_ENT(EM_TRICORE,       "Siemens Tricore"),
1387   ENUM_ENT(EM_ARC,           "ARC"),
1388   ENUM_ENT(EM_H8_300,        "Hitachi H8/300"),
1389   ENUM_ENT(EM_H8_300H,       "Hitachi H8/300H"),
1390   ENUM_ENT(EM_H8S,           "Hitachi H8S"),
1391   ENUM_ENT(EM_H8_500,        "Hitachi H8/500"),
1392   ENUM_ENT(EM_IA_64,         "Intel IA-64"),
1393   ENUM_ENT(EM_MIPS_X,        "Stanford MIPS-X"),
1394   ENUM_ENT(EM_COLDFIRE,      "Motorola Coldfire"),
1395   ENUM_ENT(EM_68HC12,        "Motorola MC68HC12 Microcontroller"),
1396   ENUM_ENT(EM_MMA,           "Fujitsu Multimedia Accelerator"),
1397   ENUM_ENT(EM_PCP,           "Siemens PCP"),
1398   ENUM_ENT(EM_NCPU,          "Sony nCPU embedded RISC processor"),
1399   ENUM_ENT(EM_NDR1,          "Denso NDR1 microprocesspr"),
1400   ENUM_ENT(EM_STARCORE,      "Motorola Star*Core processor"),
1401   ENUM_ENT(EM_ME16,          "Toyota ME16 processor"),
1402   ENUM_ENT(EM_ST100,         "STMicroelectronics ST100 processor"),
1403   ENUM_ENT(EM_TINYJ,         "Advanced Logic Corp. TinyJ embedded processor"),
1404   ENUM_ENT(EM_X86_64,        "Advanced Micro Devices X86-64"),
1405   ENUM_ENT(EM_PDSP,          "Sony DSP processor"),
1406   ENUM_ENT(EM_PDP10,         "Digital Equipment Corp. PDP-10"),
1407   ENUM_ENT(EM_PDP11,         "Digital Equipment Corp. PDP-11"),
1408   ENUM_ENT(EM_FX66,          "Siemens FX66 microcontroller"),
1409   ENUM_ENT(EM_ST9PLUS,       "STMicroelectronics ST9+ 8/16 bit microcontroller"),
1410   ENUM_ENT(EM_ST7,           "STMicroelectronics ST7 8-bit microcontroller"),
1411   ENUM_ENT(EM_68HC16,        "Motorola MC68HC16 Microcontroller"),
1412   ENUM_ENT(EM_68HC11,        "Motorola MC68HC11 Microcontroller"),
1413   ENUM_ENT(EM_68HC08,        "Motorola MC68HC08 Microcontroller"),
1414   ENUM_ENT(EM_68HC05,        "Motorola MC68HC05 Microcontroller"),
1415   ENUM_ENT(EM_SVX,           "Silicon Graphics SVx"),
1416   ENUM_ENT(EM_ST19,          "STMicroelectronics ST19 8-bit microcontroller"),
1417   ENUM_ENT(EM_VAX,           "Digital VAX"),
1418   ENUM_ENT(EM_CRIS,          "Axis Communications 32-bit embedded processor"),
1419   ENUM_ENT(EM_JAVELIN,       "Infineon Technologies 32-bit embedded cpu"),
1420   ENUM_ENT(EM_FIREPATH,      "Element 14 64-bit DSP processor"),
1421   ENUM_ENT(EM_ZSP,           "LSI Logic's 16-bit DSP processor"),
1422   ENUM_ENT(EM_MMIX,          "Donald Knuth's educational 64-bit processor"),
1423   ENUM_ENT(EM_HUANY,         "Harvard Universitys's machine-independent object format"),
1424   ENUM_ENT(EM_PRISM,         "Vitesse Prism"),
1425   ENUM_ENT(EM_AVR,           "Atmel AVR 8-bit microcontroller"),
1426   ENUM_ENT(EM_FR30,          "Fujitsu FR30"),
1427   ENUM_ENT(EM_D10V,          "Mitsubishi D10V"),
1428   ENUM_ENT(EM_D30V,          "Mitsubishi D30V"),
1429   ENUM_ENT(EM_V850,          "NEC v850"),
1430   ENUM_ENT(EM_M32R,          "Renesas M32R (formerly Mitsubishi M32r)"),
1431   ENUM_ENT(EM_MN10300,       "Matsushita MN10300"),
1432   ENUM_ENT(EM_MN10200,       "Matsushita MN10200"),
1433   ENUM_ENT(EM_PJ,            "picoJava"),
1434   ENUM_ENT(EM_OPENRISC,      "OpenRISC 32-bit embedded processor"),
1435   ENUM_ENT(EM_ARC_COMPACT,   "EM_ARC_COMPACT"),
1436   ENUM_ENT(EM_XTENSA,        "Tensilica Xtensa Processor"),
1437   ENUM_ENT(EM_VIDEOCORE,     "Alphamosaic VideoCore processor"),
1438   ENUM_ENT(EM_TMM_GPP,       "Thompson Multimedia General Purpose Processor"),
1439   ENUM_ENT(EM_NS32K,         "National Semiconductor 32000 series"),
1440   ENUM_ENT(EM_TPC,           "Tenor Network TPC processor"),
1441   ENUM_ENT(EM_SNP1K,         "EM_SNP1K"),
1442   ENUM_ENT(EM_ST200,         "STMicroelectronics ST200 microcontroller"),
1443   ENUM_ENT(EM_IP2K,          "Ubicom IP2xxx 8-bit microcontrollers"),
1444   ENUM_ENT(EM_MAX,           "MAX Processor"),
1445   ENUM_ENT(EM_CR,            "National Semiconductor CompactRISC"),
1446   ENUM_ENT(EM_F2MC16,        "Fujitsu F2MC16"),
1447   ENUM_ENT(EM_MSP430,        "Texas Instruments msp430 microcontroller"),
1448   ENUM_ENT(EM_BLACKFIN,      "Analog Devices Blackfin"),
1449   ENUM_ENT(EM_SE_C33,        "S1C33 Family of Seiko Epson processors"),
1450   ENUM_ENT(EM_SEP,           "Sharp embedded microprocessor"),
1451   ENUM_ENT(EM_ARCA,          "Arca RISC microprocessor"),
1452   ENUM_ENT(EM_UNICORE,       "Unicore"),
1453   ENUM_ENT(EM_EXCESS,        "eXcess 16/32/64-bit configurable embedded CPU"),
1454   ENUM_ENT(EM_DXP,           "Icera Semiconductor Inc. Deep Execution Processor"),
1455   ENUM_ENT(EM_ALTERA_NIOS2,  "Altera Nios"),
1456   ENUM_ENT(EM_CRX,           "National Semiconductor CRX microprocessor"),
1457   ENUM_ENT(EM_XGATE,         "Motorola XGATE embedded processor"),
1458   ENUM_ENT(EM_C166,          "Infineon Technologies xc16x"),
1459   ENUM_ENT(EM_M16C,          "Renesas M16C"),
1460   ENUM_ENT(EM_DSPIC30F,      "Microchip Technology dsPIC30F Digital Signal Controller"),
1461   ENUM_ENT(EM_CE,            "Freescale Communication Engine RISC core"),
1462   ENUM_ENT(EM_M32C,          "Renesas M32C"),
1463   ENUM_ENT(EM_TSK3000,       "Altium TSK3000 core"),
1464   ENUM_ENT(EM_RS08,          "Freescale RS08 embedded processor"),
1465   ENUM_ENT(EM_SHARC,         "EM_SHARC"),
1466   ENUM_ENT(EM_ECOG2,         "Cyan Technology eCOG2 microprocessor"),
1467   ENUM_ENT(EM_SCORE7,        "SUNPLUS S+Core"),
1468   ENUM_ENT(EM_DSP24,         "New Japan Radio (NJR) 24-bit DSP Processor"),
1469   ENUM_ENT(EM_VIDEOCORE3,    "Broadcom VideoCore III processor"),
1470   ENUM_ENT(EM_LATTICEMICO32, "Lattice Mico32"),
1471   ENUM_ENT(EM_SE_C17,        "Seiko Epson C17 family"),
1472   ENUM_ENT(EM_TI_C6000,      "Texas Instruments TMS320C6000 DSP family"),
1473   ENUM_ENT(EM_TI_C2000,      "Texas Instruments TMS320C2000 DSP family"),
1474   ENUM_ENT(EM_TI_C5500,      "Texas Instruments TMS320C55x DSP family"),
1475   ENUM_ENT(EM_MMDSP_PLUS,    "STMicroelectronics 64bit VLIW Data Signal Processor"),
1476   ENUM_ENT(EM_CYPRESS_M8C,   "Cypress M8C microprocessor"),
1477   ENUM_ENT(EM_R32C,          "Renesas R32C series microprocessors"),
1478   ENUM_ENT(EM_TRIMEDIA,      "NXP Semiconductors TriMedia architecture family"),
1479   ENUM_ENT(EM_HEXAGON,       "Qualcomm Hexagon"),
1480   ENUM_ENT(EM_8051,          "Intel 8051 and variants"),
1481   ENUM_ENT(EM_STXP7X,        "STMicroelectronics STxP7x family"),
1482   ENUM_ENT(EM_NDS32,         "Andes Technology compact code size embedded RISC processor family"),
1483   ENUM_ENT(EM_ECOG1,         "Cyan Technology eCOG1 microprocessor"),
1484   // FIXME: Following EM_ECOG1X definitions is dead code since EM_ECOG1X has
1485   //        an identical number to EM_ECOG1.
1486   ENUM_ENT(EM_ECOG1X,        "Cyan Technology eCOG1X family"),
1487   ENUM_ENT(EM_MAXQ30,        "Dallas Semiconductor MAXQ30 Core microcontrollers"),
1488   ENUM_ENT(EM_XIMO16,        "New Japan Radio (NJR) 16-bit DSP Processor"),
1489   ENUM_ENT(EM_MANIK,         "M2000 Reconfigurable RISC Microprocessor"),
1490   ENUM_ENT(EM_CRAYNV2,       "Cray Inc. NV2 vector architecture"),
1491   ENUM_ENT(EM_RX,            "Renesas RX"),
1492   ENUM_ENT(EM_METAG,         "Imagination Technologies Meta processor architecture"),
1493   ENUM_ENT(EM_MCST_ELBRUS,   "MCST Elbrus general purpose hardware architecture"),
1494   ENUM_ENT(EM_ECOG16,        "Cyan Technology eCOG16 family"),
1495   ENUM_ENT(EM_CR16,          "Xilinx MicroBlaze"),
1496   ENUM_ENT(EM_ETPU,          "Freescale Extended Time Processing Unit"),
1497   ENUM_ENT(EM_SLE9X,         "Infineon Technologies SLE9X core"),
1498   ENUM_ENT(EM_L10M,          "EM_L10M"),
1499   ENUM_ENT(EM_K10M,          "EM_K10M"),
1500   ENUM_ENT(EM_AARCH64,       "AArch64"),
1501   ENUM_ENT(EM_AVR32,         "Atmel Corporation 32-bit microprocessor family"),
1502   ENUM_ENT(EM_STM8,          "STMicroeletronics STM8 8-bit microcontroller"),
1503   ENUM_ENT(EM_TILE64,        "Tilera TILE64 multicore architecture family"),
1504   ENUM_ENT(EM_TILEPRO,       "Tilera TILEPro multicore architecture family"),
1505   ENUM_ENT(EM_CUDA,          "NVIDIA CUDA architecture"),
1506   ENUM_ENT(EM_TILEGX,        "Tilera TILE-Gx multicore architecture family"),
1507   ENUM_ENT(EM_CLOUDSHIELD,   "EM_CLOUDSHIELD"),
1508   ENUM_ENT(EM_COREA_1ST,     "EM_COREA_1ST"),
1509   ENUM_ENT(EM_COREA_2ND,     "EM_COREA_2ND"),
1510   ENUM_ENT(EM_ARC_COMPACT2,  "EM_ARC_COMPACT2"),
1511   ENUM_ENT(EM_OPEN8,         "EM_OPEN8"),
1512   ENUM_ENT(EM_RL78,          "Renesas RL78"),
1513   ENUM_ENT(EM_VIDEOCORE5,    "Broadcom VideoCore V processor"),
1514   ENUM_ENT(EM_78KOR,         "EM_78KOR"),
1515   ENUM_ENT(EM_56800EX,       "EM_56800EX"),
1516   ENUM_ENT(EM_AMDGPU,        "EM_AMDGPU"),
1517   ENUM_ENT(EM_RISCV,         "RISC-V"),
1518   ENUM_ENT(EM_LANAI,         "EM_LANAI"),
1519   ENUM_ENT(EM_BPF,           "EM_BPF"),
1520   ENUM_ENT(EM_VE,            "NEC SX-Aurora Vector Engine"),
1521 };
1522 
1523 static const EnumEntry<unsigned> ElfSymbolBindings[] = {
1524     {"Local",  "LOCAL",  ELF::STB_LOCAL},
1525     {"Global", "GLOBAL", ELF::STB_GLOBAL},
1526     {"Weak",   "WEAK",   ELF::STB_WEAK},
1527     {"Unique", "UNIQUE", ELF::STB_GNU_UNIQUE}};
1528 
1529 static const EnumEntry<unsigned> ElfSymbolVisibilities[] = {
1530     {"DEFAULT",   "DEFAULT",   ELF::STV_DEFAULT},
1531     {"INTERNAL",  "INTERNAL",  ELF::STV_INTERNAL},
1532     {"HIDDEN",    "HIDDEN",    ELF::STV_HIDDEN},
1533     {"PROTECTED", "PROTECTED", ELF::STV_PROTECTED}};
1534 
1535 static const EnumEntry<unsigned> AMDGPUSymbolTypes[] = {
1536   { "AMDGPU_HSA_KERNEL",            ELF::STT_AMDGPU_HSA_KERNEL }
1537 };
1538 
1539 static const char *getGroupType(uint32_t Flag) {
1540   if (Flag & ELF::GRP_COMDAT)
1541     return "COMDAT";
1542   else
1543     return "(unknown)";
1544 }
1545 
1546 static const EnumEntry<unsigned> ElfSectionFlags[] = {
1547   ENUM_ENT(SHF_WRITE,            "W"),
1548   ENUM_ENT(SHF_ALLOC,            "A"),
1549   ENUM_ENT(SHF_EXECINSTR,        "X"),
1550   ENUM_ENT(SHF_MERGE,            "M"),
1551   ENUM_ENT(SHF_STRINGS,          "S"),
1552   ENUM_ENT(SHF_INFO_LINK,        "I"),
1553   ENUM_ENT(SHF_LINK_ORDER,       "L"),
1554   ENUM_ENT(SHF_OS_NONCONFORMING, "O"),
1555   ENUM_ENT(SHF_GROUP,            "G"),
1556   ENUM_ENT(SHF_TLS,              "T"),
1557   ENUM_ENT(SHF_COMPRESSED,       "C"),
1558   ENUM_ENT(SHF_EXCLUDE,          "E"),
1559 };
1560 
1561 static const EnumEntry<unsigned> ElfXCoreSectionFlags[] = {
1562   ENUM_ENT(XCORE_SHF_CP_SECTION, ""),
1563   ENUM_ENT(XCORE_SHF_DP_SECTION, "")
1564 };
1565 
1566 static const EnumEntry<unsigned> ElfARMSectionFlags[] = {
1567   ENUM_ENT(SHF_ARM_PURECODE, "y")
1568 };
1569 
1570 static const EnumEntry<unsigned> ElfHexagonSectionFlags[] = {
1571   ENUM_ENT(SHF_HEX_GPREL, "")
1572 };
1573 
1574 static const EnumEntry<unsigned> ElfMipsSectionFlags[] = {
1575   ENUM_ENT(SHF_MIPS_NODUPES, ""),
1576   ENUM_ENT(SHF_MIPS_NAMES,   ""),
1577   ENUM_ENT(SHF_MIPS_LOCAL,   ""),
1578   ENUM_ENT(SHF_MIPS_NOSTRIP, ""),
1579   ENUM_ENT(SHF_MIPS_GPREL,   ""),
1580   ENUM_ENT(SHF_MIPS_MERGE,   ""),
1581   ENUM_ENT(SHF_MIPS_ADDR,    ""),
1582   ENUM_ENT(SHF_MIPS_STRING,  "")
1583 };
1584 
1585 static const EnumEntry<unsigned> ElfX86_64SectionFlags[] = {
1586   ENUM_ENT(SHF_X86_64_LARGE, "l")
1587 };
1588 
1589 static std::vector<EnumEntry<unsigned>>
1590 getSectionFlagsForTarget(unsigned EMachine) {
1591   std::vector<EnumEntry<unsigned>> Ret(std::begin(ElfSectionFlags),
1592                                        std::end(ElfSectionFlags));
1593   switch (EMachine) {
1594   case EM_ARM:
1595     Ret.insert(Ret.end(), std::begin(ElfARMSectionFlags),
1596                std::end(ElfARMSectionFlags));
1597     break;
1598   case EM_HEXAGON:
1599     Ret.insert(Ret.end(), std::begin(ElfHexagonSectionFlags),
1600                std::end(ElfHexagonSectionFlags));
1601     break;
1602   case EM_MIPS:
1603     Ret.insert(Ret.end(), std::begin(ElfMipsSectionFlags),
1604                std::end(ElfMipsSectionFlags));
1605     break;
1606   case EM_X86_64:
1607     Ret.insert(Ret.end(), std::begin(ElfX86_64SectionFlags),
1608                std::end(ElfX86_64SectionFlags));
1609     break;
1610   case EM_XCORE:
1611     Ret.insert(Ret.end(), std::begin(ElfXCoreSectionFlags),
1612                std::end(ElfXCoreSectionFlags));
1613     break;
1614   default:
1615     break;
1616   }
1617   return Ret;
1618 }
1619 
1620 static std::string getGNUFlags(unsigned EMachine, uint64_t Flags) {
1621   // Here we are trying to build the flags string in the same way as GNU does.
1622   // It is not that straightforward. Imagine we have sh_flags == 0x90000000.
1623   // SHF_EXCLUDE ("E") has a value of 0x80000000 and SHF_MASKPROC is 0xf0000000.
1624   // GNU readelf will not print "E" or "Ep" in this case, but will print just
1625   // "p". It only will print "E" when no other processor flag is set.
1626   std::string Str;
1627   bool HasUnknownFlag = false;
1628   bool HasOSFlag = false;
1629   bool HasProcFlag = false;
1630   std::vector<EnumEntry<unsigned>> FlagsList =
1631       getSectionFlagsForTarget(EMachine);
1632   while (Flags) {
1633     // Take the least significant bit as a flag.
1634     uint64_t Flag = Flags & -Flags;
1635     Flags -= Flag;
1636 
1637     // Find the flag in the known flags list.
1638     auto I = llvm::find_if(FlagsList, [=](const EnumEntry<unsigned> &E) {
1639       // Flags with empty names are not printed in GNU style output.
1640       return E.Value == Flag && !E.AltName.empty();
1641     });
1642     if (I != FlagsList.end()) {
1643       Str += I->AltName;
1644       continue;
1645     }
1646 
1647     // If we did not find a matching regular flag, then we deal with an OS
1648     // specific flag, processor specific flag or an unknown flag.
1649     if (Flag & ELF::SHF_MASKOS) {
1650       HasOSFlag = true;
1651       Flags &= ~ELF::SHF_MASKOS;
1652     } else if (Flag & ELF::SHF_MASKPROC) {
1653       HasProcFlag = true;
1654       // Mask off all the processor-specific bits. This removes the SHF_EXCLUDE
1655       // bit if set so that it doesn't also get printed.
1656       Flags &= ~ELF::SHF_MASKPROC;
1657     } else {
1658       HasUnknownFlag = true;
1659     }
1660   }
1661 
1662   // "o", "p" and "x" are printed last.
1663   if (HasOSFlag)
1664     Str += "o";
1665   if (HasProcFlag)
1666     Str += "p";
1667   if (HasUnknownFlag)
1668     Str += "x";
1669   return Str;
1670 }
1671 
1672 static const char *getElfSegmentType(unsigned Arch, unsigned Type) {
1673   // Check potentially overlapped processor-specific
1674   // program header type.
1675   switch (Arch) {
1676   case ELF::EM_ARM:
1677     switch (Type) { LLVM_READOBJ_ENUM_CASE(ELF, PT_ARM_EXIDX); }
1678     break;
1679   case ELF::EM_MIPS:
1680   case ELF::EM_MIPS_RS3_LE:
1681     switch (Type) {
1682       LLVM_READOBJ_ENUM_CASE(ELF, PT_MIPS_REGINFO);
1683     LLVM_READOBJ_ENUM_CASE(ELF, PT_MIPS_RTPROC);
1684     LLVM_READOBJ_ENUM_CASE(ELF, PT_MIPS_OPTIONS);
1685     LLVM_READOBJ_ENUM_CASE(ELF, PT_MIPS_ABIFLAGS);
1686     }
1687     break;
1688   }
1689 
1690   switch (Type) {
1691   LLVM_READOBJ_ENUM_CASE(ELF, PT_NULL   );
1692   LLVM_READOBJ_ENUM_CASE(ELF, PT_LOAD   );
1693   LLVM_READOBJ_ENUM_CASE(ELF, PT_DYNAMIC);
1694   LLVM_READOBJ_ENUM_CASE(ELF, PT_INTERP );
1695   LLVM_READOBJ_ENUM_CASE(ELF, PT_NOTE   );
1696   LLVM_READOBJ_ENUM_CASE(ELF, PT_SHLIB  );
1697   LLVM_READOBJ_ENUM_CASE(ELF, PT_PHDR   );
1698   LLVM_READOBJ_ENUM_CASE(ELF, PT_TLS    );
1699 
1700   LLVM_READOBJ_ENUM_CASE(ELF, PT_GNU_EH_FRAME);
1701   LLVM_READOBJ_ENUM_CASE(ELF, PT_SUNW_UNWIND);
1702 
1703     LLVM_READOBJ_ENUM_CASE(ELF, PT_GNU_STACK);
1704     LLVM_READOBJ_ENUM_CASE(ELF, PT_GNU_RELRO);
1705     LLVM_READOBJ_ENUM_CASE(ELF, PT_GNU_PROPERTY);
1706 
1707     LLVM_READOBJ_ENUM_CASE(ELF, PT_OPENBSD_RANDOMIZE);
1708     LLVM_READOBJ_ENUM_CASE(ELF, PT_OPENBSD_WXNEEDED);
1709     LLVM_READOBJ_ENUM_CASE(ELF, PT_OPENBSD_BOOTDATA);
1710 
1711   default:
1712     return "";
1713   }
1714 }
1715 
1716 static std::string getElfPtType(unsigned Arch, unsigned Type) {
1717   switch (Type) {
1718     LLVM_READOBJ_PHDR_ENUM(ELF, PT_NULL)
1719     LLVM_READOBJ_PHDR_ENUM(ELF, PT_LOAD)
1720     LLVM_READOBJ_PHDR_ENUM(ELF, PT_DYNAMIC)
1721     LLVM_READOBJ_PHDR_ENUM(ELF, PT_INTERP)
1722     LLVM_READOBJ_PHDR_ENUM(ELF, PT_NOTE)
1723     LLVM_READOBJ_PHDR_ENUM(ELF, PT_SHLIB)
1724     LLVM_READOBJ_PHDR_ENUM(ELF, PT_PHDR)
1725     LLVM_READOBJ_PHDR_ENUM(ELF, PT_TLS)
1726     LLVM_READOBJ_PHDR_ENUM(ELF, PT_GNU_EH_FRAME)
1727     LLVM_READOBJ_PHDR_ENUM(ELF, PT_SUNW_UNWIND)
1728     LLVM_READOBJ_PHDR_ENUM(ELF, PT_GNU_STACK)
1729     LLVM_READOBJ_PHDR_ENUM(ELF, PT_GNU_RELRO)
1730     LLVM_READOBJ_PHDR_ENUM(ELF, PT_GNU_PROPERTY)
1731   default:
1732     // All machine specific PT_* types
1733     switch (Arch) {
1734     case ELF::EM_ARM:
1735       if (Type == ELF::PT_ARM_EXIDX)
1736         return "EXIDX";
1737       break;
1738     case ELF::EM_MIPS:
1739     case ELF::EM_MIPS_RS3_LE:
1740       switch (Type) {
1741       case PT_MIPS_REGINFO:
1742         return "REGINFO";
1743       case PT_MIPS_RTPROC:
1744         return "RTPROC";
1745       case PT_MIPS_OPTIONS:
1746         return "OPTIONS";
1747       case PT_MIPS_ABIFLAGS:
1748         return "ABIFLAGS";
1749       }
1750       break;
1751     }
1752   }
1753   return std::string("<unknown>: ") + to_string(format_hex(Type, 1));
1754 }
1755 
1756 static const EnumEntry<unsigned> ElfSegmentFlags[] = {
1757   LLVM_READOBJ_ENUM_ENT(ELF, PF_X),
1758   LLVM_READOBJ_ENUM_ENT(ELF, PF_W),
1759   LLVM_READOBJ_ENUM_ENT(ELF, PF_R)
1760 };
1761 
1762 static const EnumEntry<unsigned> ElfHeaderMipsFlags[] = {
1763   ENUM_ENT(EF_MIPS_NOREORDER, "noreorder"),
1764   ENUM_ENT(EF_MIPS_PIC, "pic"),
1765   ENUM_ENT(EF_MIPS_CPIC, "cpic"),
1766   ENUM_ENT(EF_MIPS_ABI2, "abi2"),
1767   ENUM_ENT(EF_MIPS_32BITMODE, "32bitmode"),
1768   ENUM_ENT(EF_MIPS_FP64, "fp64"),
1769   ENUM_ENT(EF_MIPS_NAN2008, "nan2008"),
1770   ENUM_ENT(EF_MIPS_ABI_O32, "o32"),
1771   ENUM_ENT(EF_MIPS_ABI_O64, "o64"),
1772   ENUM_ENT(EF_MIPS_ABI_EABI32, "eabi32"),
1773   ENUM_ENT(EF_MIPS_ABI_EABI64, "eabi64"),
1774   ENUM_ENT(EF_MIPS_MACH_3900, "3900"),
1775   ENUM_ENT(EF_MIPS_MACH_4010, "4010"),
1776   ENUM_ENT(EF_MIPS_MACH_4100, "4100"),
1777   ENUM_ENT(EF_MIPS_MACH_4650, "4650"),
1778   ENUM_ENT(EF_MIPS_MACH_4120, "4120"),
1779   ENUM_ENT(EF_MIPS_MACH_4111, "4111"),
1780   ENUM_ENT(EF_MIPS_MACH_SB1, "sb1"),
1781   ENUM_ENT(EF_MIPS_MACH_OCTEON, "octeon"),
1782   ENUM_ENT(EF_MIPS_MACH_XLR, "xlr"),
1783   ENUM_ENT(EF_MIPS_MACH_OCTEON2, "octeon2"),
1784   ENUM_ENT(EF_MIPS_MACH_OCTEON3, "octeon3"),
1785   ENUM_ENT(EF_MIPS_MACH_5400, "5400"),
1786   ENUM_ENT(EF_MIPS_MACH_5900, "5900"),
1787   ENUM_ENT(EF_MIPS_MACH_5500, "5500"),
1788   ENUM_ENT(EF_MIPS_MACH_9000, "9000"),
1789   ENUM_ENT(EF_MIPS_MACH_LS2E, "loongson-2e"),
1790   ENUM_ENT(EF_MIPS_MACH_LS2F, "loongson-2f"),
1791   ENUM_ENT(EF_MIPS_MACH_LS3A, "loongson-3a"),
1792   ENUM_ENT(EF_MIPS_MICROMIPS, "micromips"),
1793   ENUM_ENT(EF_MIPS_ARCH_ASE_M16, "mips16"),
1794   ENUM_ENT(EF_MIPS_ARCH_ASE_MDMX, "mdmx"),
1795   ENUM_ENT(EF_MIPS_ARCH_1, "mips1"),
1796   ENUM_ENT(EF_MIPS_ARCH_2, "mips2"),
1797   ENUM_ENT(EF_MIPS_ARCH_3, "mips3"),
1798   ENUM_ENT(EF_MIPS_ARCH_4, "mips4"),
1799   ENUM_ENT(EF_MIPS_ARCH_5, "mips5"),
1800   ENUM_ENT(EF_MIPS_ARCH_32, "mips32"),
1801   ENUM_ENT(EF_MIPS_ARCH_64, "mips64"),
1802   ENUM_ENT(EF_MIPS_ARCH_32R2, "mips32r2"),
1803   ENUM_ENT(EF_MIPS_ARCH_64R2, "mips64r2"),
1804   ENUM_ENT(EF_MIPS_ARCH_32R6, "mips32r6"),
1805   ENUM_ENT(EF_MIPS_ARCH_64R6, "mips64r6")
1806 };
1807 
1808 static const EnumEntry<unsigned> ElfHeaderAMDGPUFlags[] = {
1809   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_NONE),
1810   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_R600_R600),
1811   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_R600_R630),
1812   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_R600_RS880),
1813   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_R600_RV670),
1814   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_R600_RV710),
1815   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_R600_RV730),
1816   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_R600_RV770),
1817   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_R600_CEDAR),
1818   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_R600_CYPRESS),
1819   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_R600_JUNIPER),
1820   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_R600_REDWOOD),
1821   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_R600_SUMO),
1822   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_R600_BARTS),
1823   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_R600_CAICOS),
1824   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_R600_CAYMAN),
1825   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_R600_TURKS),
1826   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_AMDGCN_GFX600),
1827   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_AMDGCN_GFX601),
1828   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_AMDGCN_GFX700),
1829   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_AMDGCN_GFX701),
1830   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_AMDGCN_GFX702),
1831   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_AMDGCN_GFX703),
1832   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_AMDGCN_GFX704),
1833   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_AMDGCN_GFX801),
1834   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_AMDGCN_GFX802),
1835   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_AMDGCN_GFX803),
1836   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_AMDGCN_GFX810),
1837   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_AMDGCN_GFX900),
1838   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_AMDGCN_GFX902),
1839   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_AMDGCN_GFX904),
1840   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_AMDGCN_GFX906),
1841   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_AMDGCN_GFX908),
1842   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_AMDGCN_GFX909),
1843   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_AMDGCN_GFX1010),
1844   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_AMDGCN_GFX1011),
1845   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_AMDGCN_GFX1012),
1846   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_MACH_AMDGCN_GFX1030),
1847   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_XNACK),
1848   LLVM_READOBJ_ENUM_ENT(ELF, EF_AMDGPU_SRAM_ECC)
1849 };
1850 
1851 static const EnumEntry<unsigned> ElfHeaderRISCVFlags[] = {
1852   ENUM_ENT(EF_RISCV_RVC, "RVC"),
1853   ENUM_ENT(EF_RISCV_FLOAT_ABI_SINGLE, "single-float ABI"),
1854   ENUM_ENT(EF_RISCV_FLOAT_ABI_DOUBLE, "double-float ABI"),
1855   ENUM_ENT(EF_RISCV_FLOAT_ABI_QUAD, "quad-float ABI"),
1856   ENUM_ENT(EF_RISCV_RVE, "RVE")
1857 };
1858 
1859 static const EnumEntry<unsigned> ElfSymOtherFlags[] = {
1860   LLVM_READOBJ_ENUM_ENT(ELF, STV_INTERNAL),
1861   LLVM_READOBJ_ENUM_ENT(ELF, STV_HIDDEN),
1862   LLVM_READOBJ_ENUM_ENT(ELF, STV_PROTECTED)
1863 };
1864 
1865 static const EnumEntry<unsigned> ElfMipsSymOtherFlags[] = {
1866   LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_OPTIONAL),
1867   LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_PLT),
1868   LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_PIC),
1869   LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_MICROMIPS)
1870 };
1871 
1872 static const EnumEntry<unsigned> ElfMips16SymOtherFlags[] = {
1873   LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_OPTIONAL),
1874   LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_PLT),
1875   LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_MIPS16)
1876 };
1877 
1878 static const char *getElfMipsOptionsOdkType(unsigned Odk) {
1879   switch (Odk) {
1880   LLVM_READOBJ_ENUM_CASE(ELF, ODK_NULL);
1881   LLVM_READOBJ_ENUM_CASE(ELF, ODK_REGINFO);
1882   LLVM_READOBJ_ENUM_CASE(ELF, ODK_EXCEPTIONS);
1883   LLVM_READOBJ_ENUM_CASE(ELF, ODK_PAD);
1884   LLVM_READOBJ_ENUM_CASE(ELF, ODK_HWPATCH);
1885   LLVM_READOBJ_ENUM_CASE(ELF, ODK_FILL);
1886   LLVM_READOBJ_ENUM_CASE(ELF, ODK_TAGS);
1887   LLVM_READOBJ_ENUM_CASE(ELF, ODK_HWAND);
1888   LLVM_READOBJ_ENUM_CASE(ELF, ODK_HWOR);
1889   LLVM_READOBJ_ENUM_CASE(ELF, ODK_GP_GROUP);
1890   LLVM_READOBJ_ENUM_CASE(ELF, ODK_IDENT);
1891   LLVM_READOBJ_ENUM_CASE(ELF, ODK_PAGESIZE);
1892   default:
1893     return "Unknown";
1894   }
1895 }
1896 
1897 template <typename ELFT>
1898 std::pair<const typename ELFT::Phdr *, const typename ELFT::Shdr *>
1899 ELFDumper<ELFT>::findDynamic(const ELFFile<ELFT> *Obj) {
1900   // Try to locate the PT_DYNAMIC header.
1901   const Elf_Phdr *DynamicPhdr = nullptr;
1902   for (const Elf_Phdr &Phdr :
1903        unwrapOrError(ObjF->getFileName(), Obj->program_headers())) {
1904     if (Phdr.p_type != ELF::PT_DYNAMIC)
1905       continue;
1906     DynamicPhdr = &Phdr;
1907     break;
1908   }
1909 
1910   // Try to locate the .dynamic section in the sections header table.
1911   const Elf_Shdr *DynamicSec = nullptr;
1912   for (const Elf_Shdr &Sec : cantFail(Obj->sections())) {
1913     if (Sec.sh_type != ELF::SHT_DYNAMIC)
1914       continue;
1915     DynamicSec = &Sec;
1916     break;
1917   }
1918 
1919   if (DynamicPhdr && DynamicPhdr->p_offset + DynamicPhdr->p_filesz >
1920                          ObjF->getMemoryBufferRef().getBufferSize()) {
1921     reportWarning(
1922         createError(
1923             "PT_DYNAMIC segment offset + size exceeds the size of the file"),
1924         ObjF->getFileName());
1925     // Don't use the broken dynamic header.
1926     DynamicPhdr = nullptr;
1927   }
1928 
1929   if (DynamicPhdr && DynamicSec) {
1930     StringRef Name =
1931         unwrapOrError(ObjF->getFileName(), Obj->getSectionName(DynamicSec));
1932     if (DynamicSec->sh_addr + DynamicSec->sh_size >
1933             DynamicPhdr->p_vaddr + DynamicPhdr->p_memsz ||
1934         DynamicSec->sh_addr < DynamicPhdr->p_vaddr)
1935       reportWarning(createError("The SHT_DYNAMIC section '" + Name +
1936                                 "' is not contained within the "
1937                                 "PT_DYNAMIC segment"),
1938                     ObjF->getFileName());
1939 
1940     if (DynamicSec->sh_addr != DynamicPhdr->p_vaddr)
1941       reportWarning(createError("The SHT_DYNAMIC section '" + Name +
1942                                 "' is not at the start of "
1943                                 "PT_DYNAMIC segment"),
1944                     ObjF->getFileName());
1945   }
1946 
1947   return std::make_pair(DynamicPhdr, DynamicSec);
1948 }
1949 
1950 template <typename ELFT>
1951 void ELFDumper<ELFT>::loadDynamicTable(const ELFFile<ELFT> *Obj) {
1952   const Elf_Phdr *DynamicPhdr;
1953   const Elf_Shdr *DynamicSec;
1954   std::tie(DynamicPhdr, DynamicSec) = findDynamic(Obj);
1955   if (!DynamicPhdr && !DynamicSec)
1956     return;
1957 
1958   DynRegionInfo FromPhdr(ObjF->getFileName());
1959   bool IsPhdrTableValid = false;
1960   if (DynamicPhdr) {
1961     FromPhdr = createDRIFrom(DynamicPhdr, sizeof(Elf_Dyn));
1962     FromPhdr.SizePrintName = "PT_DYNAMIC size";
1963     FromPhdr.EntSizePrintName = "";
1964 
1965     IsPhdrTableValid = !FromPhdr.getAsArrayRef<Elf_Dyn>().empty();
1966   }
1967 
1968   // Locate the dynamic table described in a section header.
1969   // Ignore sh_entsize and use the expected value for entry size explicitly.
1970   // This allows us to dump dynamic sections with a broken sh_entsize
1971   // field.
1972   DynRegionInfo FromSec(ObjF->getFileName());
1973   bool IsSecTableValid = false;
1974   if (DynamicSec) {
1975     FromSec =
1976         checkDRI({ObjF->getELFFile()->base() + DynamicSec->sh_offset,
1977                   DynamicSec->sh_size, sizeof(Elf_Dyn), ObjF->getFileName()});
1978     FromSec.Context = ("section with index " +
1979                        Twine(DynamicSec - &cantFail(Obj->sections()).front()))
1980                           .str();
1981     FromSec.EntSizePrintName = "";
1982 
1983     IsSecTableValid = !FromSec.getAsArrayRef<Elf_Dyn>().empty();
1984   }
1985 
1986   // When we only have information from one of the SHT_DYNAMIC section header or
1987   // PT_DYNAMIC program header, just use that.
1988   if (!DynamicPhdr || !DynamicSec) {
1989     if ((DynamicPhdr && IsPhdrTableValid) || (DynamicSec && IsSecTableValid)) {
1990       DynamicTable = DynamicPhdr ? FromPhdr : FromSec;
1991       parseDynamicTable(Obj);
1992     } else {
1993       reportWarning(createError("no valid dynamic table was found"),
1994                     ObjF->getFileName());
1995     }
1996     return;
1997   }
1998 
1999   // At this point we have tables found from the section header and from the
2000   // dynamic segment. Usually they match, but we have to do sanity checks to
2001   // verify that.
2002 
2003   if (FromPhdr.Addr != FromSec.Addr)
2004     reportWarning(createError("SHT_DYNAMIC section header and PT_DYNAMIC "
2005                               "program header disagree about "
2006                               "the location of the dynamic table"),
2007                   ObjF->getFileName());
2008 
2009   if (!IsPhdrTableValid && !IsSecTableValid) {
2010     reportWarning(createError("no valid dynamic table was found"),
2011                   ObjF->getFileName());
2012     return;
2013   }
2014 
2015   // Information in the PT_DYNAMIC program header has priority over the information
2016   // in a section header.
2017   if (IsPhdrTableValid) {
2018     if (!IsSecTableValid)
2019       reportWarning(
2020           createError(
2021               "SHT_DYNAMIC dynamic table is invalid: PT_DYNAMIC will be used"),
2022           ObjF->getFileName());
2023     DynamicTable = FromPhdr;
2024   } else {
2025     reportWarning(
2026         createError(
2027             "PT_DYNAMIC dynamic table is invalid: SHT_DYNAMIC will be used"),
2028         ObjF->getFileName());
2029     DynamicTable = FromSec;
2030   }
2031 
2032   parseDynamicTable(Obj);
2033 }
2034 
2035 template <typename ELFT>
2036 ELFDumper<ELFT>::ELFDumper(const object::ELFObjectFile<ELFT> *ObjF,
2037                            ScopedPrinter &Writer)
2038     : ObjDumper(Writer), ObjF(ObjF), DynRelRegion(ObjF->getFileName()),
2039       DynRelaRegion(ObjF->getFileName()), DynRelrRegion(ObjF->getFileName()),
2040       DynPLTRelRegion(ObjF->getFileName()), DynamicTable(ObjF->getFileName()) {
2041   // Dumper reports all non-critical errors as warnings.
2042   // It does not print the same warning more than once.
2043   WarningHandler = [this](const Twine &Msg) {
2044     if (Warnings.insert(Msg.str()).second)
2045       reportWarning(createError(Msg), this->ObjF->getFileName());
2046     return Error::success();
2047   };
2048 
2049   if (opts::Output == opts::GNU)
2050     ELFDumperStyle.reset(new GNUStyle<ELFT>(Writer, this));
2051   else
2052     ELFDumperStyle.reset(new LLVMStyle<ELFT>(Writer, this));
2053 
2054   const ELFFile<ELFT> *Obj = ObjF->getELFFile();
2055   typename ELFT::ShdrRange Sections = cantFail(Obj->sections());
2056   for (const Elf_Shdr &Sec : Sections) {
2057     switch (Sec.sh_type) {
2058     case ELF::SHT_SYMTAB:
2059       if (!DotSymtabSec)
2060         DotSymtabSec = &Sec;
2061       break;
2062     case ELF::SHT_DYNSYM:
2063       if (!DynSymRegion) {
2064         DynSymRegion = createDRIFrom(&Sec);
2065         DynSymRegion->Context =
2066             ("section with index " + Twine(&Sec - &Sections.front())).str();
2067         // This is only used (if Elf_Shdr present)for naming section in GNU
2068         // style
2069         DynSymtabName =
2070             unwrapOrError(ObjF->getFileName(), Obj->getSectionName(&Sec));
2071 
2072         if (Expected<StringRef> E = Obj->getStringTableForSymtab(Sec))
2073           DynamicStringTable = *E;
2074         else
2075           reportWarning(E.takeError(), ObjF->getFileName());
2076       }
2077       break;
2078     case ELF::SHT_SYMTAB_SHNDX:
2079       ShndxTable = unwrapOrError(ObjF->getFileName(), Obj->getSHNDXTable(Sec));
2080       break;
2081     case ELF::SHT_GNU_versym:
2082       if (!SymbolVersionSection)
2083         SymbolVersionSection = &Sec;
2084       break;
2085     case ELF::SHT_GNU_verdef:
2086       if (!SymbolVersionDefSection)
2087         SymbolVersionDefSection = &Sec;
2088       break;
2089     case ELF::SHT_GNU_verneed:
2090       if (!SymbolVersionNeedSection)
2091         SymbolVersionNeedSection = &Sec;
2092       break;
2093     case ELF::SHT_LLVM_CALL_GRAPH_PROFILE:
2094       if (!DotCGProfileSec)
2095         DotCGProfileSec = &Sec;
2096       break;
2097     case ELF::SHT_LLVM_ADDRSIG:
2098       if (!DotAddrsigSec)
2099         DotAddrsigSec = &Sec;
2100       break;
2101     }
2102   }
2103 
2104   loadDynamicTable(Obj);
2105 }
2106 
2107 template <typename ELFT>
2108 void ELFDumper<ELFT>::parseDynamicTable(const ELFFile<ELFT> *Obj) {
2109   auto toMappedAddr = [&](uint64_t Tag, uint64_t VAddr) -> const uint8_t * {
2110     auto MappedAddrOrError = ObjF->getELFFile()->toMappedAddr(VAddr);
2111     if (!MappedAddrOrError) {
2112       Error Err =
2113           createError("Unable to parse DT_" + Obj->getDynamicTagAsString(Tag) +
2114                       ": " + llvm::toString(MappedAddrOrError.takeError()));
2115 
2116       reportWarning(std::move(Err), ObjF->getFileName());
2117       return nullptr;
2118     }
2119     return MappedAddrOrError.get();
2120   };
2121 
2122   uint64_t SONameOffset = 0;
2123   const char *StringTableBegin = nullptr;
2124   uint64_t StringTableSize = 0;
2125   Optional<DynRegionInfo> DynSymFromTable;
2126   for (const Elf_Dyn &Dyn : dynamic_table()) {
2127     switch (Dyn.d_tag) {
2128     case ELF::DT_HASH:
2129       HashTable = reinterpret_cast<const Elf_Hash *>(
2130           toMappedAddr(Dyn.getTag(), Dyn.getPtr()));
2131       break;
2132     case ELF::DT_GNU_HASH:
2133       GnuHashTable = reinterpret_cast<const Elf_GnuHash *>(
2134           toMappedAddr(Dyn.getTag(), Dyn.getPtr()));
2135       break;
2136     case ELF::DT_STRTAB:
2137       StringTableBegin = reinterpret_cast<const char *>(
2138           toMappedAddr(Dyn.getTag(), Dyn.getPtr()));
2139       break;
2140     case ELF::DT_STRSZ:
2141       StringTableSize = Dyn.getVal();
2142       break;
2143     case ELF::DT_SYMTAB: {
2144       // If we can't map the DT_SYMTAB value to an address (e.g. when there are
2145       // no program headers), we ignore its value.
2146       if (const uint8_t *VA = toMappedAddr(Dyn.getTag(), Dyn.getPtr())) {
2147         DynSymFromTable.emplace(ObjF->getFileName());
2148         DynSymFromTable->Addr = VA;
2149         DynSymFromTable->EntSize = sizeof(Elf_Sym);
2150         DynSymFromTable->EntSizePrintName = "";
2151       }
2152       break;
2153     }
2154     case ELF::DT_SYMENT: {
2155       uint64_t Val = Dyn.getVal();
2156       if (Val != sizeof(Elf_Sym))
2157         reportWarning(createError("DT_SYMENT value of 0x" +
2158                                   Twine::utohexstr(Val) +
2159                                   " is not the size of a symbol (0x" +
2160                                   Twine::utohexstr(sizeof(Elf_Sym)) + ")"),
2161                       ObjF->getFileName());
2162       break;
2163     }
2164     case ELF::DT_RELA:
2165       DynRelaRegion.Addr = toMappedAddr(Dyn.getTag(), Dyn.getPtr());
2166       break;
2167     case ELF::DT_RELASZ:
2168       DynRelaRegion.Size = Dyn.getVal();
2169       DynRelaRegion.SizePrintName = "DT_RELASZ value";
2170       break;
2171     case ELF::DT_RELAENT:
2172       DynRelaRegion.EntSize = Dyn.getVal();
2173       DynRelaRegion.EntSizePrintName = "DT_RELAENT value";
2174       break;
2175     case ELF::DT_SONAME:
2176       SONameOffset = Dyn.getVal();
2177       break;
2178     case ELF::DT_REL:
2179       DynRelRegion.Addr = toMappedAddr(Dyn.getTag(), Dyn.getPtr());
2180       break;
2181     case ELF::DT_RELSZ:
2182       DynRelRegion.Size = Dyn.getVal();
2183       DynRelRegion.SizePrintName = "DT_RELSZ value";
2184       break;
2185     case ELF::DT_RELENT:
2186       DynRelRegion.EntSize = Dyn.getVal();
2187       DynRelRegion.EntSizePrintName = "DT_RELENT value";
2188       break;
2189     case ELF::DT_RELR:
2190     case ELF::DT_ANDROID_RELR:
2191       DynRelrRegion.Addr = toMappedAddr(Dyn.getTag(), Dyn.getPtr());
2192       break;
2193     case ELF::DT_RELRSZ:
2194     case ELF::DT_ANDROID_RELRSZ:
2195       DynRelrRegion.Size = Dyn.getVal();
2196       DynRelrRegion.SizePrintName = Dyn.d_tag == ELF::DT_RELRSZ
2197                                         ? "DT_RELRSZ value"
2198                                         : "DT_ANDROID_RELRSZ value";
2199       break;
2200     case ELF::DT_RELRENT:
2201     case ELF::DT_ANDROID_RELRENT:
2202       DynRelrRegion.EntSize = Dyn.getVal();
2203       DynRelrRegion.EntSizePrintName = Dyn.d_tag == ELF::DT_RELRENT
2204                                            ? "DT_RELRENT value"
2205                                            : "DT_ANDROID_RELRENT value";
2206       break;
2207     case ELF::DT_PLTREL:
2208       if (Dyn.getVal() == DT_REL)
2209         DynPLTRelRegion.EntSize = sizeof(Elf_Rel);
2210       else if (Dyn.getVal() == DT_RELA)
2211         DynPLTRelRegion.EntSize = sizeof(Elf_Rela);
2212       else
2213         reportError(createError(Twine("unknown DT_PLTREL value of ") +
2214                                 Twine((uint64_t)Dyn.getVal())),
2215                     ObjF->getFileName());
2216       DynPLTRelRegion.EntSizePrintName = "";
2217       break;
2218     case ELF::DT_JMPREL:
2219       DynPLTRelRegion.Addr = toMappedAddr(Dyn.getTag(), Dyn.getPtr());
2220       break;
2221     case ELF::DT_PLTRELSZ:
2222       DynPLTRelRegion.Size = Dyn.getVal();
2223       DynPLTRelRegion.SizePrintName = "DT_PLTRELSZ value";
2224       break;
2225     }
2226   }
2227 
2228   if (StringTableBegin) {
2229     const uint64_t FileSize = ObjF->getELFFile()->getBufSize();
2230     const uint64_t Offset =
2231         (const uint8_t *)StringTableBegin - ObjF->getELFFile()->base();
2232     if (StringTableSize > FileSize - Offset)
2233       reportUniqueWarning(createError(
2234           "the dynamic string table at 0x" + Twine::utohexstr(Offset) +
2235           " goes past the end of the file (0x" + Twine::utohexstr(FileSize) +
2236           ") with DT_STRSZ = 0x" + Twine::utohexstr(StringTableSize)));
2237     else
2238       DynamicStringTable = StringRef(StringTableBegin, StringTableSize);
2239   }
2240 
2241   SOName = getDynamicString(SONameOffset);
2242 
2243   if (DynSymRegion) {
2244     // Often we find the information about the dynamic symbol table
2245     // location in the SHT_DYNSYM section header. However, the value in
2246     // DT_SYMTAB has priority, because it is used by dynamic loaders to
2247     // locate .dynsym at runtime. The location we find in the section header
2248     // and the location we find here should match.
2249     if (DynSymFromTable && DynSymFromTable->Addr != DynSymRegion->Addr)
2250       reportUniqueWarning(
2251           createError("SHT_DYNSYM section header and DT_SYMTAB disagree about "
2252                       "the location of the dynamic symbol table"));
2253 
2254     // According to the ELF gABI: "The number of symbol table entries should
2255     // equal nchain". Check to see if the DT_HASH hash table nchain value
2256     // conflicts with the number of symbols in the dynamic symbol table
2257     // according to the section header.
2258     if (HashTable) {
2259       if (DynSymRegion->EntSize == 0)
2260         reportUniqueWarning(
2261             createError("SHT_DYNSYM section has sh_entsize == 0"));
2262       else if (HashTable->nchain != DynSymRegion->Size / DynSymRegion->EntSize)
2263         reportUniqueWarning(createError(
2264             "hash table nchain (" + Twine(HashTable->nchain) +
2265             ") differs from symbol count derived from SHT_DYNSYM section "
2266             "header (" +
2267             Twine(DynSymRegion->Size / DynSymRegion->EntSize) + ")"));
2268     }
2269   }
2270 
2271   // Delay the creation of the actual dynamic symbol table until now, so that
2272   // checks can always be made against the section header-based properties,
2273   // without worrying about tag order.
2274   if (DynSymFromTable) {
2275     if (!DynSymRegion) {
2276       DynSymRegion = DynSymFromTable;
2277     } else {
2278       DynSymRegion->Addr = DynSymFromTable->Addr;
2279       DynSymRegion->EntSize = DynSymFromTable->EntSize;
2280       DynSymRegion->EntSizePrintName = DynSymFromTable->EntSizePrintName;
2281     }
2282   }
2283 
2284   // Derive the dynamic symbol table size from the DT_HASH hash table, if
2285   // present.
2286   if (HashTable && DynSymRegion)
2287     DynSymRegion->Size = HashTable->nchain * DynSymRegion->EntSize;
2288 }
2289 
2290 template <typename ELFT>
2291 typename ELFDumper<ELFT>::Elf_Rel_Range ELFDumper<ELFT>::dyn_rels() const {
2292   return DynRelRegion.getAsArrayRef<Elf_Rel>();
2293 }
2294 
2295 template <typename ELFT>
2296 typename ELFDumper<ELFT>::Elf_Rela_Range ELFDumper<ELFT>::dyn_relas() const {
2297   return DynRelaRegion.getAsArrayRef<Elf_Rela>();
2298 }
2299 
2300 template <typename ELFT>
2301 typename ELFDumper<ELFT>::Elf_Relr_Range ELFDumper<ELFT>::dyn_relrs() const {
2302   return DynRelrRegion.getAsArrayRef<Elf_Relr>();
2303 }
2304 
2305 template <class ELFT> void ELFDumper<ELFT>::printFileHeaders() {
2306   ELFDumperStyle->printFileHeaders(ObjF->getELFFile());
2307 }
2308 
2309 template <class ELFT> void ELFDumper<ELFT>::printSectionHeaders() {
2310   ELFDumperStyle->printSectionHeaders(ObjF->getELFFile());
2311 }
2312 
2313 template <class ELFT> void ELFDumper<ELFT>::printRelocations() {
2314   ELFDumperStyle->printRelocations(ObjF->getELFFile());
2315 }
2316 
2317 template <class ELFT>
2318 void ELFDumper<ELFT>::printProgramHeaders(
2319     bool PrintProgramHeaders, cl::boolOrDefault PrintSectionMapping) {
2320   ELFDumperStyle->printProgramHeaders(ObjF->getELFFile(), PrintProgramHeaders,
2321                                       PrintSectionMapping);
2322 }
2323 
2324 template <typename ELFT> void ELFDumper<ELFT>::printVersionInfo() {
2325   // Dump version symbol section.
2326   ELFDumperStyle->printVersionSymbolSection(ObjF->getELFFile(),
2327                                             SymbolVersionSection);
2328 
2329   // Dump version definition section.
2330   ELFDumperStyle->printVersionDefinitionSection(ObjF->getELFFile(),
2331                                                 SymbolVersionDefSection);
2332 
2333   // Dump version dependency section.
2334   ELFDumperStyle->printVersionDependencySection(ObjF->getELFFile(),
2335                                                 SymbolVersionNeedSection);
2336 }
2337 
2338 template <class ELFT> void ELFDumper<ELFT>::printDependentLibs() {
2339   ELFDumperStyle->printDependentLibs(ObjF->getELFFile());
2340 }
2341 
2342 template <class ELFT> void ELFDumper<ELFT>::printDynamicRelocations() {
2343   ELFDumperStyle->printDynamicRelocations(ObjF->getELFFile());
2344 }
2345 
2346 template <class ELFT>
2347 void ELFDumper<ELFT>::printSymbols(bool PrintSymbols,
2348                                    bool PrintDynamicSymbols) {
2349   ELFDumperStyle->printSymbols(ObjF->getELFFile(), PrintSymbols,
2350                                PrintDynamicSymbols);
2351 }
2352 
2353 template <class ELFT> void ELFDumper<ELFT>::printHashSymbols() {
2354   ELFDumperStyle->printHashSymbols(ObjF->getELFFile());
2355 }
2356 
2357 template <class ELFT> void ELFDumper<ELFT>::printHashHistograms() {
2358   ELFDumperStyle->printHashHistograms(ObjF->getELFFile());
2359 }
2360 
2361 template <class ELFT> void ELFDumper<ELFT>::printCGProfile() {
2362   ELFDumperStyle->printCGProfile(ObjF->getELFFile());
2363 }
2364 
2365 template <class ELFT> void ELFDumper<ELFT>::printNotes() {
2366   ELFDumperStyle->printNotes(ObjF->getELFFile());
2367 }
2368 
2369 template <class ELFT> void ELFDumper<ELFT>::printELFLinkerOptions() {
2370   ELFDumperStyle->printELFLinkerOptions(ObjF->getELFFile());
2371 }
2372 
2373 template <class ELFT> void ELFDumper<ELFT>::printStackSizes() {
2374   ELFDumperStyle->printStackSizes(ObjF);
2375 }
2376 
2377 #define LLVM_READOBJ_DT_FLAG_ENT(prefix, enum)                                 \
2378   { #enum, prefix##_##enum }
2379 
2380 static const EnumEntry<unsigned> ElfDynamicDTFlags[] = {
2381   LLVM_READOBJ_DT_FLAG_ENT(DF, ORIGIN),
2382   LLVM_READOBJ_DT_FLAG_ENT(DF, SYMBOLIC),
2383   LLVM_READOBJ_DT_FLAG_ENT(DF, TEXTREL),
2384   LLVM_READOBJ_DT_FLAG_ENT(DF, BIND_NOW),
2385   LLVM_READOBJ_DT_FLAG_ENT(DF, STATIC_TLS)
2386 };
2387 
2388 static const EnumEntry<unsigned> ElfDynamicDTFlags1[] = {
2389   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NOW),
2390   LLVM_READOBJ_DT_FLAG_ENT(DF_1, GLOBAL),
2391   LLVM_READOBJ_DT_FLAG_ENT(DF_1, GROUP),
2392   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NODELETE),
2393   LLVM_READOBJ_DT_FLAG_ENT(DF_1, LOADFLTR),
2394   LLVM_READOBJ_DT_FLAG_ENT(DF_1, INITFIRST),
2395   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NOOPEN),
2396   LLVM_READOBJ_DT_FLAG_ENT(DF_1, ORIGIN),
2397   LLVM_READOBJ_DT_FLAG_ENT(DF_1, DIRECT),
2398   LLVM_READOBJ_DT_FLAG_ENT(DF_1, TRANS),
2399   LLVM_READOBJ_DT_FLAG_ENT(DF_1, INTERPOSE),
2400   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NODEFLIB),
2401   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NODUMP),
2402   LLVM_READOBJ_DT_FLAG_ENT(DF_1, CONFALT),
2403   LLVM_READOBJ_DT_FLAG_ENT(DF_1, ENDFILTEE),
2404   LLVM_READOBJ_DT_FLAG_ENT(DF_1, DISPRELDNE),
2405   LLVM_READOBJ_DT_FLAG_ENT(DF_1, DISPRELPND),
2406   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NODIRECT),
2407   LLVM_READOBJ_DT_FLAG_ENT(DF_1, IGNMULDEF),
2408   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NOKSYMS),
2409   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NOHDR),
2410   LLVM_READOBJ_DT_FLAG_ENT(DF_1, EDITED),
2411   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NORELOC),
2412   LLVM_READOBJ_DT_FLAG_ENT(DF_1, SYMINTPOSE),
2413   LLVM_READOBJ_DT_FLAG_ENT(DF_1, GLOBAUDIT),
2414   LLVM_READOBJ_DT_FLAG_ENT(DF_1, SINGLETON),
2415   LLVM_READOBJ_DT_FLAG_ENT(DF_1, PIE),
2416 };
2417 
2418 static const EnumEntry<unsigned> ElfDynamicDTMipsFlags[] = {
2419   LLVM_READOBJ_DT_FLAG_ENT(RHF, NONE),
2420   LLVM_READOBJ_DT_FLAG_ENT(RHF, QUICKSTART),
2421   LLVM_READOBJ_DT_FLAG_ENT(RHF, NOTPOT),
2422   LLVM_READOBJ_DT_FLAG_ENT(RHS, NO_LIBRARY_REPLACEMENT),
2423   LLVM_READOBJ_DT_FLAG_ENT(RHF, NO_MOVE),
2424   LLVM_READOBJ_DT_FLAG_ENT(RHF, SGI_ONLY),
2425   LLVM_READOBJ_DT_FLAG_ENT(RHF, GUARANTEE_INIT),
2426   LLVM_READOBJ_DT_FLAG_ENT(RHF, DELTA_C_PLUS_PLUS),
2427   LLVM_READOBJ_DT_FLAG_ENT(RHF, GUARANTEE_START_INIT),
2428   LLVM_READOBJ_DT_FLAG_ENT(RHF, PIXIE),
2429   LLVM_READOBJ_DT_FLAG_ENT(RHF, DEFAULT_DELAY_LOAD),
2430   LLVM_READOBJ_DT_FLAG_ENT(RHF, REQUICKSTART),
2431   LLVM_READOBJ_DT_FLAG_ENT(RHF, REQUICKSTARTED),
2432   LLVM_READOBJ_DT_FLAG_ENT(RHF, CORD),
2433   LLVM_READOBJ_DT_FLAG_ENT(RHF, NO_UNRES_UNDEF),
2434   LLVM_READOBJ_DT_FLAG_ENT(RHF, RLD_ORDER_SAFE)
2435 };
2436 
2437 #undef LLVM_READOBJ_DT_FLAG_ENT
2438 
2439 template <typename T, typename TFlag>
2440 void printFlags(T Value, ArrayRef<EnumEntry<TFlag>> Flags, raw_ostream &OS) {
2441   using FlagEntry = EnumEntry<TFlag>;
2442   using FlagVector = SmallVector<FlagEntry, 10>;
2443   FlagVector SetFlags;
2444 
2445   for (const auto &Flag : Flags) {
2446     if (Flag.Value == 0)
2447       continue;
2448 
2449     if ((Value & Flag.Value) == Flag.Value)
2450       SetFlags.push_back(Flag);
2451   }
2452 
2453   for (const auto &Flag : SetFlags) {
2454     OS << Flag.Name << " ";
2455   }
2456 }
2457 
2458 template <class ELFT>
2459 std::string ELFDumper<ELFT>::getDynamicEntry(uint64_t Type,
2460                                              uint64_t Value) const {
2461   auto FormatHexValue = [](uint64_t V) {
2462     std::string Str;
2463     raw_string_ostream OS(Str);
2464     const char *ConvChar =
2465         (opts::Output == opts::GNU) ? "0x%" PRIx64 : "0x%" PRIX64;
2466     OS << format(ConvChar, V);
2467     return OS.str();
2468   };
2469 
2470   auto FormatFlags = [](uint64_t V,
2471                         llvm::ArrayRef<llvm::EnumEntry<unsigned int>> Array) {
2472     std::string Str;
2473     raw_string_ostream OS(Str);
2474     printFlags(V, Array, OS);
2475     return OS.str();
2476   };
2477 
2478   // Handle custom printing of architecture specific tags
2479   switch (ObjF->getELFFile()->getHeader()->e_machine) {
2480   case EM_AARCH64:
2481     switch (Type) {
2482     case DT_AARCH64_BTI_PLT:
2483     case DT_AARCH64_PAC_PLT:
2484       return std::to_string(Value);
2485     default:
2486       break;
2487     }
2488     break;
2489   case EM_HEXAGON:
2490     switch (Type) {
2491     case DT_HEXAGON_VER:
2492       return std::to_string(Value);
2493     case DT_HEXAGON_SYMSZ:
2494     case DT_HEXAGON_PLT:
2495       return FormatHexValue(Value);
2496     default:
2497       break;
2498     }
2499     break;
2500   case EM_MIPS:
2501     switch (Type) {
2502     case DT_MIPS_RLD_VERSION:
2503     case DT_MIPS_LOCAL_GOTNO:
2504     case DT_MIPS_SYMTABNO:
2505     case DT_MIPS_UNREFEXTNO:
2506       return std::to_string(Value);
2507     case DT_MIPS_TIME_STAMP:
2508     case DT_MIPS_ICHECKSUM:
2509     case DT_MIPS_IVERSION:
2510     case DT_MIPS_BASE_ADDRESS:
2511     case DT_MIPS_MSYM:
2512     case DT_MIPS_CONFLICT:
2513     case DT_MIPS_LIBLIST:
2514     case DT_MIPS_CONFLICTNO:
2515     case DT_MIPS_LIBLISTNO:
2516     case DT_MIPS_GOTSYM:
2517     case DT_MIPS_HIPAGENO:
2518     case DT_MIPS_RLD_MAP:
2519     case DT_MIPS_DELTA_CLASS:
2520     case DT_MIPS_DELTA_CLASS_NO:
2521     case DT_MIPS_DELTA_INSTANCE:
2522     case DT_MIPS_DELTA_RELOC:
2523     case DT_MIPS_DELTA_RELOC_NO:
2524     case DT_MIPS_DELTA_SYM:
2525     case DT_MIPS_DELTA_SYM_NO:
2526     case DT_MIPS_DELTA_CLASSSYM:
2527     case DT_MIPS_DELTA_CLASSSYM_NO:
2528     case DT_MIPS_CXX_FLAGS:
2529     case DT_MIPS_PIXIE_INIT:
2530     case DT_MIPS_SYMBOL_LIB:
2531     case DT_MIPS_LOCALPAGE_GOTIDX:
2532     case DT_MIPS_LOCAL_GOTIDX:
2533     case DT_MIPS_HIDDEN_GOTIDX:
2534     case DT_MIPS_PROTECTED_GOTIDX:
2535     case DT_MIPS_OPTIONS:
2536     case DT_MIPS_INTERFACE:
2537     case DT_MIPS_DYNSTR_ALIGN:
2538     case DT_MIPS_INTERFACE_SIZE:
2539     case DT_MIPS_RLD_TEXT_RESOLVE_ADDR:
2540     case DT_MIPS_PERF_SUFFIX:
2541     case DT_MIPS_COMPACT_SIZE:
2542     case DT_MIPS_GP_VALUE:
2543     case DT_MIPS_AUX_DYNAMIC:
2544     case DT_MIPS_PLTGOT:
2545     case DT_MIPS_RWPLT:
2546     case DT_MIPS_RLD_MAP_REL:
2547       return FormatHexValue(Value);
2548     case DT_MIPS_FLAGS:
2549       return FormatFlags(Value, makeArrayRef(ElfDynamicDTMipsFlags));
2550     default:
2551       break;
2552     }
2553     break;
2554   default:
2555     break;
2556   }
2557 
2558   switch (Type) {
2559   case DT_PLTREL:
2560     if (Value == DT_REL)
2561       return "REL";
2562     if (Value == DT_RELA)
2563       return "RELA";
2564     LLVM_FALLTHROUGH;
2565   case DT_PLTGOT:
2566   case DT_HASH:
2567   case DT_STRTAB:
2568   case DT_SYMTAB:
2569   case DT_RELA:
2570   case DT_INIT:
2571   case DT_FINI:
2572   case DT_REL:
2573   case DT_JMPREL:
2574   case DT_INIT_ARRAY:
2575   case DT_FINI_ARRAY:
2576   case DT_PREINIT_ARRAY:
2577   case DT_DEBUG:
2578   case DT_VERDEF:
2579   case DT_VERNEED:
2580   case DT_VERSYM:
2581   case DT_GNU_HASH:
2582   case DT_NULL:
2583     return FormatHexValue(Value);
2584   case DT_RELACOUNT:
2585   case DT_RELCOUNT:
2586   case DT_VERDEFNUM:
2587   case DT_VERNEEDNUM:
2588     return std::to_string(Value);
2589   case DT_PLTRELSZ:
2590   case DT_RELASZ:
2591   case DT_RELAENT:
2592   case DT_STRSZ:
2593   case DT_SYMENT:
2594   case DT_RELSZ:
2595   case DT_RELENT:
2596   case DT_INIT_ARRAYSZ:
2597   case DT_FINI_ARRAYSZ:
2598   case DT_PREINIT_ARRAYSZ:
2599   case DT_ANDROID_RELSZ:
2600   case DT_ANDROID_RELASZ:
2601     return std::to_string(Value) + " (bytes)";
2602   case DT_NEEDED:
2603   case DT_SONAME:
2604   case DT_AUXILIARY:
2605   case DT_USED:
2606   case DT_FILTER:
2607   case DT_RPATH:
2608   case DT_RUNPATH: {
2609     const std::map<uint64_t, const char *> TagNames = {
2610         {DT_NEEDED, "Shared library"},       {DT_SONAME, "Library soname"},
2611         {DT_AUXILIARY, "Auxiliary library"}, {DT_USED, "Not needed object"},
2612         {DT_FILTER, "Filter library"},       {DT_RPATH, "Library rpath"},
2613         {DT_RUNPATH, "Library runpath"},
2614     };
2615 
2616     return (Twine(TagNames.at(Type)) + ": [" + getDynamicString(Value) + "]")
2617         .str();
2618   }
2619   case DT_FLAGS:
2620     return FormatFlags(Value, makeArrayRef(ElfDynamicDTFlags));
2621   case DT_FLAGS_1:
2622     return FormatFlags(Value, makeArrayRef(ElfDynamicDTFlags1));
2623   default:
2624     return FormatHexValue(Value);
2625   }
2626 }
2627 
2628 template <class ELFT>
2629 StringRef ELFDumper<ELFT>::getDynamicString(uint64_t Value) const {
2630   if (DynamicStringTable.empty() && !DynamicStringTable.data()) {
2631     reportUniqueWarning(createError("string table was not found"));
2632     return "<?>";
2633   }
2634 
2635   auto WarnAndReturn = [this](const Twine &Msg, uint64_t Offset) {
2636     reportUniqueWarning(createError("string table at offset 0x" +
2637                                     Twine::utohexstr(Offset) + Msg));
2638     return "<?>";
2639   };
2640 
2641   const uint64_t FileSize = ObjF->getELFFile()->getBufSize();
2642   const uint64_t Offset =
2643       (const uint8_t *)DynamicStringTable.data() - ObjF->getELFFile()->base();
2644   if (DynamicStringTable.size() > FileSize - Offset)
2645     return WarnAndReturn(" with size 0x" +
2646                              Twine::utohexstr(DynamicStringTable.size()) +
2647                              " goes past the end of the file (0x" +
2648                              Twine::utohexstr(FileSize) + ")",
2649                          Offset);
2650 
2651   if (Value >= DynamicStringTable.size())
2652     return WarnAndReturn(
2653         ": unable to read the string at 0x" + Twine::utohexstr(Offset + Value) +
2654             ": it goes past the end of the table (0x" +
2655             Twine::utohexstr(Offset + DynamicStringTable.size()) + ")",
2656         Offset);
2657 
2658   if (DynamicStringTable.back() != '\0')
2659     return WarnAndReturn(": unable to read the string at 0x" +
2660                              Twine::utohexstr(Offset + Value) +
2661                              ": the string table is not null-terminated",
2662                          Offset);
2663 
2664   return DynamicStringTable.data() + Value;
2665 }
2666 
2667 template <class ELFT> void ELFDumper<ELFT>::printUnwindInfo() {
2668   DwarfCFIEH::PrinterContext<ELFT> Ctx(W, ObjF);
2669   Ctx.printUnwindInformation();
2670 }
2671 
2672 namespace {
2673 
2674 template <> void ELFDumper<ELF32LE>::printUnwindInfo() {
2675   const ELFFile<ELF32LE> *Obj = ObjF->getELFFile();
2676   const unsigned Machine = Obj->getHeader()->e_machine;
2677   if (Machine == EM_ARM) {
2678     ARM::EHABI::PrinterContext<ELF32LE> Ctx(W, Obj, ObjF->getFileName(),
2679                                             DotSymtabSec);
2680     Ctx.PrintUnwindInformation();
2681   }
2682   DwarfCFIEH::PrinterContext<ELF32LE> Ctx(W, ObjF);
2683   Ctx.printUnwindInformation();
2684 }
2685 
2686 } // end anonymous namespace
2687 
2688 template <class ELFT> void ELFDumper<ELFT>::printDynamicTable() {
2689   ELFDumperStyle->printDynamic(ObjF->getELFFile());
2690 }
2691 
2692 template <class ELFT> void ELFDumper<ELFT>::printNeededLibraries() {
2693   ListScope D(W, "NeededLibraries");
2694 
2695   std::vector<StringRef> Libs;
2696   for (const auto &Entry : dynamic_table())
2697     if (Entry.d_tag == ELF::DT_NEEDED)
2698       Libs.push_back(getDynamicString(Entry.d_un.d_val));
2699 
2700   llvm::sort(Libs);
2701 
2702   for (StringRef L : Libs)
2703     W.startLine() << L << "\n";
2704 }
2705 
2706 template <class ELFT>
2707 static Error checkHashTable(const ELFFile<ELFT> *Obj,
2708                             const typename ELFT::Hash *H,
2709                             bool *IsHeaderValid = nullptr) {
2710   auto MakeError = [&](uint64_t Off, const Twine &Msg = "") {
2711     return createError("the hash table at offset 0x" + Twine::utohexstr(Off) +
2712                        " goes past the end of the file (0x" +
2713                        Twine::utohexstr(Obj->getBufSize()) + ")" + Msg);
2714   };
2715 
2716   // Each SHT_HASH section starts from two 32-bit fields: nbucket and nchain.
2717   const unsigned HeaderSize = 2 * sizeof(typename ELFT::Word);
2718   const uint64_t SecOffset = (const uint8_t *)H - Obj->base();
2719 
2720   if (IsHeaderValid)
2721     *IsHeaderValid = Obj->getBufSize() - SecOffset >= HeaderSize;
2722 
2723   if (Obj->getBufSize() - SecOffset < HeaderSize)
2724     return MakeError(SecOffset);
2725 
2726   if (Obj->getBufSize() - SecOffset - HeaderSize <
2727       ((uint64_t)H->nbucket + H->nchain) * sizeof(typename ELFT::Word))
2728     return MakeError(SecOffset, ", nbucket = " + Twine(H->nbucket) +
2729                                     ", nchain = " + Twine(H->nchain));
2730   return Error::success();
2731 }
2732 
2733 template <class ELFT>
2734 static Error checkGNUHashTable(const ELFFile<ELFT> *Obj,
2735                                const typename ELFT::GnuHash *GnuHashTable,
2736                                bool *IsHeaderValid = nullptr) {
2737   const uint8_t *TableData = reinterpret_cast<const uint8_t *>(GnuHashTable);
2738   assert(TableData >= Obj->base() &&
2739          TableData < Obj->base() + Obj->getBufSize() &&
2740          "GnuHashTable must always point to a location inside the file");
2741 
2742   uint64_t TableOffset = TableData - Obj->base();
2743   if (IsHeaderValid)
2744     *IsHeaderValid = TableOffset + /*Header size:*/ 16 < Obj->getBufSize();
2745   if (TableOffset + 16 + (uint64_t)GnuHashTable->nbuckets * 4 +
2746           (uint64_t)GnuHashTable->maskwords * sizeof(typename ELFT::Off) >=
2747       Obj->getBufSize())
2748     return createError("unable to dump the SHT_GNU_HASH "
2749                        "section at 0x" +
2750                        Twine::utohexstr(TableOffset) +
2751                        ": it goes past the end of the file");
2752   return Error::success();
2753 }
2754 
2755 template <typename ELFT> void ELFDumper<ELFT>::printHashTable() {
2756   DictScope D(W, "HashTable");
2757   if (!HashTable)
2758     return;
2759 
2760   bool IsHeaderValid;
2761   Error Err = checkHashTable(ObjF->getELFFile(), HashTable, &IsHeaderValid);
2762   if (IsHeaderValid) {
2763     W.printNumber("Num Buckets", HashTable->nbucket);
2764     W.printNumber("Num Chains", HashTable->nchain);
2765   }
2766 
2767   if (Err) {
2768     reportUniqueWarning(std::move(Err));
2769     return;
2770   }
2771 
2772   W.printList("Buckets", HashTable->buckets());
2773   W.printList("Chains", HashTable->chains());
2774 }
2775 
2776 template <class ELFT>
2777 static Expected<ArrayRef<typename ELFT::Word>>
2778 getGnuHashTableChains(Optional<DynRegionInfo> DynSymRegion,
2779                       const typename ELFT::GnuHash *GnuHashTable) {
2780   if (!DynSymRegion)
2781     return createError("no dynamic symbol table found");
2782 
2783   ArrayRef<typename ELFT::Sym> DynSymTable =
2784       DynSymRegion->getAsArrayRef<typename ELFT::Sym>();
2785   size_t NumSyms = DynSymTable.size();
2786   if (!NumSyms)
2787     return createError("the dynamic symbol table is empty");
2788 
2789   if (GnuHashTable->symndx < NumSyms)
2790     return GnuHashTable->values(NumSyms);
2791 
2792   // A normal empty GNU hash table section produced by linker might have
2793   // symndx set to the number of dynamic symbols + 1 (for the zero symbol)
2794   // and have dummy null values in the Bloom filter and in the buckets
2795   // vector (or no values at all). It happens because the value of symndx is not
2796   // important for dynamic loaders when the GNU hash table is empty. They just
2797   // skip the whole object during symbol lookup. In such cases, the symndx value
2798   // is irrelevant and we should not report a warning.
2799   ArrayRef<typename ELFT::Word> Buckets = GnuHashTable->buckets();
2800   if (!llvm::all_of(Buckets, [](typename ELFT::Word V) { return V == 0; }))
2801     return createError("the first hashed symbol index (" +
2802                        Twine(GnuHashTable->symndx) +
2803                        ") is larger than the number of dynamic symbols (" +
2804                        Twine(NumSyms) + ")");
2805   // There is no way to represent an array of (dynamic symbols count - symndx)
2806   // length.
2807   return ArrayRef<typename ELFT::Word>();
2808 }
2809 
2810 template <typename ELFT>
2811 void ELFDumper<ELFT>::printGnuHashTable(const object::ObjectFile *Obj) {
2812   DictScope D(W, "GnuHashTable");
2813   if (!GnuHashTable)
2814     return;
2815 
2816   bool IsHeaderValid;
2817   Error Err =
2818       checkGNUHashTable<ELFT>(ObjF->getELFFile(), GnuHashTable, &IsHeaderValid);
2819   if (IsHeaderValid) {
2820     W.printNumber("Num Buckets", GnuHashTable->nbuckets);
2821     W.printNumber("First Hashed Symbol Index", GnuHashTable->symndx);
2822     W.printNumber("Num Mask Words", GnuHashTable->maskwords);
2823     W.printNumber("Shift Count", GnuHashTable->shift2);
2824   }
2825 
2826   if (Err) {
2827     reportUniqueWarning(std::move(Err));
2828     return;
2829   }
2830 
2831   ArrayRef<typename ELFT::Off> BloomFilter = GnuHashTable->filter();
2832   W.printHexList("Bloom Filter", BloomFilter);
2833 
2834   ArrayRef<Elf_Word> Buckets = GnuHashTable->buckets();
2835   W.printList("Buckets", Buckets);
2836 
2837   Expected<ArrayRef<Elf_Word>> Chains =
2838       getGnuHashTableChains<ELFT>(DynSymRegion, GnuHashTable);
2839   if (!Chains) {
2840     reportUniqueWarning(
2841         createError("unable to dump 'Values' for the SHT_GNU_HASH "
2842                     "section: " +
2843                     toString(Chains.takeError())));
2844     return;
2845   }
2846 
2847   W.printHexList("Values", *Chains);
2848 }
2849 
2850 template <typename ELFT> void ELFDumper<ELFT>::printLoadName() {
2851   W.printString("LoadName", SOName);
2852 }
2853 
2854 template <class ELFT> void ELFDumper<ELFT>::printArchSpecificInfo() {
2855   const ELFFile<ELFT> *Obj = ObjF->getELFFile();
2856   switch (Obj->getHeader()->e_machine) {
2857   case EM_ARM:
2858   case EM_RISCV:
2859     printAttributes();
2860     break;
2861   case EM_MIPS: {
2862     ELFDumperStyle->printMipsABIFlags(ObjF);
2863     printMipsOptions();
2864     printMipsReginfo();
2865 
2866     MipsGOTParser<ELFT> Parser(Obj, ObjF->getFileName(), dynamic_table(),
2867                                dynamic_symbols());
2868     if (Error E = Parser.findGOT(dynamic_table(), dynamic_symbols()))
2869       reportError(std::move(E), ObjF->getFileName());
2870     else if (!Parser.isGotEmpty())
2871       ELFDumperStyle->printMipsGOT(Parser);
2872 
2873     if (Error E = Parser.findPLT(dynamic_table()))
2874       reportError(std::move(E), ObjF->getFileName());
2875     else if (!Parser.isPltEmpty())
2876       ELFDumperStyle->printMipsPLT(Parser);
2877     break;
2878   }
2879   default:
2880     break;
2881   }
2882 }
2883 
2884 namespace {
2885 
2886 template <class ELFT> void ELFDumper<ELFT>::printAttributes() {
2887   const ELFFile<ELFT> *Obj = ObjF->getELFFile();
2888   if (!Obj->isLE()) {
2889     W.startLine() << "Attributes not implemented.\n";
2890     return;
2891   }
2892 
2893   const unsigned Machine = Obj->getHeader()->e_machine;
2894   assert((Machine == EM_ARM || Machine == EM_RISCV) &&
2895          "Attributes not implemented.");
2896 
2897   DictScope BA(W, "BuildAttributes");
2898   for (const Elf_Shdr &Sec : cantFail(Obj->sections())) {
2899     if (Sec.sh_type != ELF::SHT_ARM_ATTRIBUTES &&
2900         Sec.sh_type != ELF::SHT_RISCV_ATTRIBUTES)
2901       continue;
2902 
2903     ArrayRef<uint8_t> Contents =
2904         unwrapOrError(ObjF->getFileName(), Obj->getSectionContents(&Sec));
2905     if (Contents[0] != ELFAttrs::Format_Version) {
2906       reportWarning(createError(Twine("unrecognised FormatVersion: 0x") +
2907                                 Twine::utohexstr(Contents[0])),
2908                     ObjF->getFileName());
2909       continue;
2910     }
2911     W.printHex("FormatVersion", Contents[0]);
2912     if (Contents.size() == 1)
2913       continue;
2914 
2915     // TODO: Delete the redundant FormatVersion check above.
2916     if (Machine == EM_ARM) {
2917       if (Error E = ARMAttributeParser(&W).parse(Contents, support::little))
2918         reportWarning(std::move(E), ObjF->getFileName());
2919     } else if (Machine == EM_RISCV) {
2920       if (Error E = RISCVAttributeParser(&W).parse(Contents, support::little))
2921         reportWarning(std::move(E), ObjF->getFileName());
2922     }
2923   }
2924 }
2925 
2926 template <class ELFT> class MipsGOTParser {
2927 public:
2928   TYPEDEF_ELF_TYPES(ELFT)
2929   using Entry = typename ELFO::Elf_Addr;
2930   using Entries = ArrayRef<Entry>;
2931 
2932   const bool IsStatic;
2933   const ELFO * const Obj;
2934 
2935   MipsGOTParser(const ELFO *Obj, StringRef FileName, Elf_Dyn_Range DynTable,
2936                 Elf_Sym_Range DynSyms);
2937   Error findGOT(Elf_Dyn_Range DynTable, Elf_Sym_Range DynSyms);
2938   Error findPLT(Elf_Dyn_Range DynTable);
2939 
2940   bool isGotEmpty() const { return GotEntries.empty(); }
2941   bool isPltEmpty() const { return PltEntries.empty(); }
2942 
2943   uint64_t getGp() const;
2944 
2945   const Entry *getGotLazyResolver() const;
2946   const Entry *getGotModulePointer() const;
2947   const Entry *getPltLazyResolver() const;
2948   const Entry *getPltModulePointer() const;
2949 
2950   Entries getLocalEntries() const;
2951   Entries getGlobalEntries() const;
2952   Entries getOtherEntries() const;
2953   Entries getPltEntries() const;
2954 
2955   uint64_t getGotAddress(const Entry * E) const;
2956   int64_t getGotOffset(const Entry * E) const;
2957   const Elf_Sym *getGotSym(const Entry *E) const;
2958 
2959   uint64_t getPltAddress(const Entry * E) const;
2960   const Elf_Sym *getPltSym(const Entry *E) const;
2961 
2962   StringRef getPltStrTable() const { return PltStrTable; }
2963 
2964 private:
2965   const Elf_Shdr *GotSec;
2966   size_t LocalNum;
2967   size_t GlobalNum;
2968 
2969   const Elf_Shdr *PltSec;
2970   const Elf_Shdr *PltRelSec;
2971   const Elf_Shdr *PltSymTable;
2972   StringRef FileName;
2973 
2974   Elf_Sym_Range GotDynSyms;
2975   StringRef PltStrTable;
2976 
2977   Entries GotEntries;
2978   Entries PltEntries;
2979 };
2980 
2981 } // end anonymous namespace
2982 
2983 template <class ELFT>
2984 MipsGOTParser<ELFT>::MipsGOTParser(const ELFO *Obj, StringRef FileName,
2985                                    Elf_Dyn_Range DynTable,
2986                                    Elf_Sym_Range DynSyms)
2987     : IsStatic(DynTable.empty()), Obj(Obj), GotSec(nullptr), LocalNum(0),
2988       GlobalNum(0), PltSec(nullptr), PltRelSec(nullptr), PltSymTable(nullptr),
2989       FileName(FileName) {}
2990 
2991 template <class ELFT>
2992 Error MipsGOTParser<ELFT>::findGOT(Elf_Dyn_Range DynTable,
2993                                    Elf_Sym_Range DynSyms) {
2994   // See "Global Offset Table" in Chapter 5 in the following document
2995   // for detailed GOT description.
2996   // ftp://www.linux-mips.org/pub/linux/mips/doc/ABI/mipsabi.pdf
2997 
2998   // Find static GOT secton.
2999   if (IsStatic) {
3000     GotSec = findSectionByName(*Obj, FileName, ".got");
3001     if (!GotSec)
3002       return Error::success();
3003 
3004     ArrayRef<uint8_t> Content =
3005         unwrapOrError(FileName, Obj->getSectionContents(GotSec));
3006     GotEntries = Entries(reinterpret_cast<const Entry *>(Content.data()),
3007                          Content.size() / sizeof(Entry));
3008     LocalNum = GotEntries.size();
3009     return Error::success();
3010   }
3011 
3012   // Lookup dynamic table tags which define the GOT layout.
3013   Optional<uint64_t> DtPltGot;
3014   Optional<uint64_t> DtLocalGotNum;
3015   Optional<uint64_t> DtGotSym;
3016   for (const auto &Entry : DynTable) {
3017     switch (Entry.getTag()) {
3018     case ELF::DT_PLTGOT:
3019       DtPltGot = Entry.getVal();
3020       break;
3021     case ELF::DT_MIPS_LOCAL_GOTNO:
3022       DtLocalGotNum = Entry.getVal();
3023       break;
3024     case ELF::DT_MIPS_GOTSYM:
3025       DtGotSym = Entry.getVal();
3026       break;
3027     }
3028   }
3029 
3030   if (!DtPltGot && !DtLocalGotNum && !DtGotSym)
3031     return Error::success();
3032 
3033   if (!DtPltGot)
3034     return createError("cannot find PLTGOT dynamic tag");
3035   if (!DtLocalGotNum)
3036     return createError("cannot find MIPS_LOCAL_GOTNO dynamic tag");
3037   if (!DtGotSym)
3038     return createError("cannot find MIPS_GOTSYM dynamic tag");
3039 
3040   size_t DynSymTotal = DynSyms.size();
3041   if (*DtGotSym > DynSymTotal)
3042     return createError("MIPS_GOTSYM exceeds a number of dynamic symbols");
3043 
3044   GotSec = findNotEmptySectionByAddress(Obj, FileName, *DtPltGot);
3045   if (!GotSec)
3046     return createError("there is no non-empty GOT section at 0x" +
3047                        Twine::utohexstr(*DtPltGot));
3048 
3049   LocalNum = *DtLocalGotNum;
3050   GlobalNum = DynSymTotal - *DtGotSym;
3051 
3052   ArrayRef<uint8_t> Content =
3053       unwrapOrError(FileName, Obj->getSectionContents(GotSec));
3054   GotEntries = Entries(reinterpret_cast<const Entry *>(Content.data()),
3055                        Content.size() / sizeof(Entry));
3056   GotDynSyms = DynSyms.drop_front(*DtGotSym);
3057 
3058   return Error::success();
3059 }
3060 
3061 template <class ELFT>
3062 Error MipsGOTParser<ELFT>::findPLT(Elf_Dyn_Range DynTable) {
3063   // Lookup dynamic table tags which define the PLT layout.
3064   Optional<uint64_t> DtMipsPltGot;
3065   Optional<uint64_t> DtJmpRel;
3066   for (const auto &Entry : DynTable) {
3067     switch (Entry.getTag()) {
3068     case ELF::DT_MIPS_PLTGOT:
3069       DtMipsPltGot = Entry.getVal();
3070       break;
3071     case ELF::DT_JMPREL:
3072       DtJmpRel = Entry.getVal();
3073       break;
3074     }
3075   }
3076 
3077   if (!DtMipsPltGot && !DtJmpRel)
3078     return Error::success();
3079 
3080   // Find PLT section.
3081   if (!DtMipsPltGot)
3082     return createError("cannot find MIPS_PLTGOT dynamic tag");
3083   if (!DtJmpRel)
3084     return createError("cannot find JMPREL dynamic tag");
3085 
3086   PltSec = findNotEmptySectionByAddress(Obj, FileName, *DtMipsPltGot);
3087   if (!PltSec)
3088     return createError("there is no non-empty PLTGOT section at 0x" +
3089                        Twine::utohexstr(*DtMipsPltGot));
3090 
3091   PltRelSec = findNotEmptySectionByAddress(Obj, FileName, *DtJmpRel);
3092   if (!PltRelSec)
3093     return createError("there is no non-empty RELPLT section at 0x" +
3094                        Twine::utohexstr(*DtJmpRel));
3095 
3096   ArrayRef<uint8_t> PltContent =
3097       unwrapOrError(FileName, Obj->getSectionContents(PltSec));
3098   PltEntries = Entries(reinterpret_cast<const Entry *>(PltContent.data()),
3099                        PltContent.size() / sizeof(Entry));
3100 
3101   PltSymTable = unwrapOrError(FileName, Obj->getSection(PltRelSec->sh_link));
3102   PltStrTable =
3103       unwrapOrError(FileName, Obj->getStringTableForSymtab(*PltSymTable));
3104 
3105   return Error::success();
3106 }
3107 
3108 template <class ELFT> uint64_t MipsGOTParser<ELFT>::getGp() const {
3109   return GotSec->sh_addr + 0x7ff0;
3110 }
3111 
3112 template <class ELFT>
3113 const typename MipsGOTParser<ELFT>::Entry *
3114 MipsGOTParser<ELFT>::getGotLazyResolver() const {
3115   return LocalNum > 0 ? &GotEntries[0] : nullptr;
3116 }
3117 
3118 template <class ELFT>
3119 const typename MipsGOTParser<ELFT>::Entry *
3120 MipsGOTParser<ELFT>::getGotModulePointer() const {
3121   if (LocalNum < 2)
3122     return nullptr;
3123   const Entry &E = GotEntries[1];
3124   if ((E >> (sizeof(Entry) * 8 - 1)) == 0)
3125     return nullptr;
3126   return &E;
3127 }
3128 
3129 template <class ELFT>
3130 typename MipsGOTParser<ELFT>::Entries
3131 MipsGOTParser<ELFT>::getLocalEntries() const {
3132   size_t Skip = getGotModulePointer() ? 2 : 1;
3133   if (LocalNum - Skip <= 0)
3134     return Entries();
3135   return GotEntries.slice(Skip, LocalNum - Skip);
3136 }
3137 
3138 template <class ELFT>
3139 typename MipsGOTParser<ELFT>::Entries
3140 MipsGOTParser<ELFT>::getGlobalEntries() const {
3141   if (GlobalNum == 0)
3142     return Entries();
3143   return GotEntries.slice(LocalNum, GlobalNum);
3144 }
3145 
3146 template <class ELFT>
3147 typename MipsGOTParser<ELFT>::Entries
3148 MipsGOTParser<ELFT>::getOtherEntries() const {
3149   size_t OtherNum = GotEntries.size() - LocalNum - GlobalNum;
3150   if (OtherNum == 0)
3151     return Entries();
3152   return GotEntries.slice(LocalNum + GlobalNum, OtherNum);
3153 }
3154 
3155 template <class ELFT>
3156 uint64_t MipsGOTParser<ELFT>::getGotAddress(const Entry *E) const {
3157   int64_t Offset = std::distance(GotEntries.data(), E) * sizeof(Entry);
3158   return GotSec->sh_addr + Offset;
3159 }
3160 
3161 template <class ELFT>
3162 int64_t MipsGOTParser<ELFT>::getGotOffset(const Entry *E) const {
3163   int64_t Offset = std::distance(GotEntries.data(), E) * sizeof(Entry);
3164   return Offset - 0x7ff0;
3165 }
3166 
3167 template <class ELFT>
3168 const typename MipsGOTParser<ELFT>::Elf_Sym *
3169 MipsGOTParser<ELFT>::getGotSym(const Entry *E) const {
3170   int64_t Offset = std::distance(GotEntries.data(), E);
3171   return &GotDynSyms[Offset - LocalNum];
3172 }
3173 
3174 template <class ELFT>
3175 const typename MipsGOTParser<ELFT>::Entry *
3176 MipsGOTParser<ELFT>::getPltLazyResolver() const {
3177   return PltEntries.empty() ? nullptr : &PltEntries[0];
3178 }
3179 
3180 template <class ELFT>
3181 const typename MipsGOTParser<ELFT>::Entry *
3182 MipsGOTParser<ELFT>::getPltModulePointer() const {
3183   return PltEntries.size() < 2 ? nullptr : &PltEntries[1];
3184 }
3185 
3186 template <class ELFT>
3187 typename MipsGOTParser<ELFT>::Entries
3188 MipsGOTParser<ELFT>::getPltEntries() const {
3189   if (PltEntries.size() <= 2)
3190     return Entries();
3191   return PltEntries.slice(2, PltEntries.size() - 2);
3192 }
3193 
3194 template <class ELFT>
3195 uint64_t MipsGOTParser<ELFT>::getPltAddress(const Entry *E) const {
3196   int64_t Offset = std::distance(PltEntries.data(), E) * sizeof(Entry);
3197   return PltSec->sh_addr + Offset;
3198 }
3199 
3200 template <class ELFT>
3201 const typename MipsGOTParser<ELFT>::Elf_Sym *
3202 MipsGOTParser<ELFT>::getPltSym(const Entry *E) const {
3203   int64_t Offset = std::distance(getPltEntries().data(), E);
3204   if (PltRelSec->sh_type == ELF::SHT_REL) {
3205     Elf_Rel_Range Rels = unwrapOrError(FileName, Obj->rels(PltRelSec));
3206     return unwrapOrError(FileName,
3207                          Obj->getRelocationSymbol(&Rels[Offset], PltSymTable));
3208   } else {
3209     Elf_Rela_Range Rels = unwrapOrError(FileName, Obj->relas(PltRelSec));
3210     return unwrapOrError(FileName,
3211                          Obj->getRelocationSymbol(&Rels[Offset], PltSymTable));
3212   }
3213 }
3214 
3215 static const EnumEntry<unsigned> ElfMipsISAExtType[] = {
3216   {"None",                    Mips::AFL_EXT_NONE},
3217   {"Broadcom SB-1",           Mips::AFL_EXT_SB1},
3218   {"Cavium Networks Octeon",  Mips::AFL_EXT_OCTEON},
3219   {"Cavium Networks Octeon2", Mips::AFL_EXT_OCTEON2},
3220   {"Cavium Networks OcteonP", Mips::AFL_EXT_OCTEONP},
3221   {"Cavium Networks Octeon3", Mips::AFL_EXT_OCTEON3},
3222   {"LSI R4010",               Mips::AFL_EXT_4010},
3223   {"Loongson 2E",             Mips::AFL_EXT_LOONGSON_2E},
3224   {"Loongson 2F",             Mips::AFL_EXT_LOONGSON_2F},
3225   {"Loongson 3A",             Mips::AFL_EXT_LOONGSON_3A},
3226   {"MIPS R4650",              Mips::AFL_EXT_4650},
3227   {"MIPS R5900",              Mips::AFL_EXT_5900},
3228   {"MIPS R10000",             Mips::AFL_EXT_10000},
3229   {"NEC VR4100",              Mips::AFL_EXT_4100},
3230   {"NEC VR4111/VR4181",       Mips::AFL_EXT_4111},
3231   {"NEC VR4120",              Mips::AFL_EXT_4120},
3232   {"NEC VR5400",              Mips::AFL_EXT_5400},
3233   {"NEC VR5500",              Mips::AFL_EXT_5500},
3234   {"RMI Xlr",                 Mips::AFL_EXT_XLR},
3235   {"Toshiba R3900",           Mips::AFL_EXT_3900}
3236 };
3237 
3238 static const EnumEntry<unsigned> ElfMipsASEFlags[] = {
3239   {"DSP",                Mips::AFL_ASE_DSP},
3240   {"DSPR2",              Mips::AFL_ASE_DSPR2},
3241   {"Enhanced VA Scheme", Mips::AFL_ASE_EVA},
3242   {"MCU",                Mips::AFL_ASE_MCU},
3243   {"MDMX",               Mips::AFL_ASE_MDMX},
3244   {"MIPS-3D",            Mips::AFL_ASE_MIPS3D},
3245   {"MT",                 Mips::AFL_ASE_MT},
3246   {"SmartMIPS",          Mips::AFL_ASE_SMARTMIPS},
3247   {"VZ",                 Mips::AFL_ASE_VIRT},
3248   {"MSA",                Mips::AFL_ASE_MSA},
3249   {"MIPS16",             Mips::AFL_ASE_MIPS16},
3250   {"microMIPS",          Mips::AFL_ASE_MICROMIPS},
3251   {"XPA",                Mips::AFL_ASE_XPA},
3252   {"CRC",                Mips::AFL_ASE_CRC},
3253   {"GINV",               Mips::AFL_ASE_GINV},
3254 };
3255 
3256 static const EnumEntry<unsigned> ElfMipsFpABIType[] = {
3257   {"Hard or soft float",                  Mips::Val_GNU_MIPS_ABI_FP_ANY},
3258   {"Hard float (double precision)",       Mips::Val_GNU_MIPS_ABI_FP_DOUBLE},
3259   {"Hard float (single precision)",       Mips::Val_GNU_MIPS_ABI_FP_SINGLE},
3260   {"Soft float",                          Mips::Val_GNU_MIPS_ABI_FP_SOFT},
3261   {"Hard float (MIPS32r2 64-bit FPU 12 callee-saved)",
3262    Mips::Val_GNU_MIPS_ABI_FP_OLD_64},
3263   {"Hard float (32-bit CPU, Any FPU)",    Mips::Val_GNU_MIPS_ABI_FP_XX},
3264   {"Hard float (32-bit CPU, 64-bit FPU)", Mips::Val_GNU_MIPS_ABI_FP_64},
3265   {"Hard float compat (32-bit CPU, 64-bit FPU)",
3266    Mips::Val_GNU_MIPS_ABI_FP_64A}
3267 };
3268 
3269 static const EnumEntry<unsigned> ElfMipsFlags1[] {
3270   {"ODDSPREG", Mips::AFL_FLAGS1_ODDSPREG},
3271 };
3272 
3273 static int getMipsRegisterSize(uint8_t Flag) {
3274   switch (Flag) {
3275   case Mips::AFL_REG_NONE:
3276     return 0;
3277   case Mips::AFL_REG_32:
3278     return 32;
3279   case Mips::AFL_REG_64:
3280     return 64;
3281   case Mips::AFL_REG_128:
3282     return 128;
3283   default:
3284     return -1;
3285   }
3286 }
3287 
3288 template <class ELFT>
3289 static void printMipsReginfoData(ScopedPrinter &W,
3290                                  const Elf_Mips_RegInfo<ELFT> &Reginfo) {
3291   W.printHex("GP", Reginfo.ri_gp_value);
3292   W.printHex("General Mask", Reginfo.ri_gprmask);
3293   W.printHex("Co-Proc Mask0", Reginfo.ri_cprmask[0]);
3294   W.printHex("Co-Proc Mask1", Reginfo.ri_cprmask[1]);
3295   W.printHex("Co-Proc Mask2", Reginfo.ri_cprmask[2]);
3296   W.printHex("Co-Proc Mask3", Reginfo.ri_cprmask[3]);
3297 }
3298 
3299 template <class ELFT> void ELFDumper<ELFT>::printMipsReginfo() {
3300   const ELFFile<ELFT> *Obj = ObjF->getELFFile();
3301   const Elf_Shdr *Shdr = findSectionByName(*Obj, ObjF->getFileName(), ".reginfo");
3302   if (!Shdr) {
3303     W.startLine() << "There is no .reginfo section in the file.\n";
3304     return;
3305   }
3306   ArrayRef<uint8_t> Sec =
3307       unwrapOrError(ObjF->getFileName(), Obj->getSectionContents(Shdr));
3308   if (Sec.size() != sizeof(Elf_Mips_RegInfo<ELFT>)) {
3309     W.startLine() << "The .reginfo section has a wrong size.\n";
3310     return;
3311   }
3312 
3313   DictScope GS(W, "MIPS RegInfo");
3314   auto *Reginfo = reinterpret_cast<const Elf_Mips_RegInfo<ELFT> *>(Sec.data());
3315   printMipsReginfoData(W, *Reginfo);
3316 }
3317 
3318 template <class ELFT> void ELFDumper<ELFT>::printMipsOptions() {
3319   const ELFFile<ELFT> *Obj = ObjF->getELFFile();
3320   const Elf_Shdr *Shdr =
3321       findSectionByName(*Obj, ObjF->getFileName(), ".MIPS.options");
3322   if (!Shdr) {
3323     W.startLine() << "There is no .MIPS.options section in the file.\n";
3324     return;
3325   }
3326 
3327   DictScope GS(W, "MIPS Options");
3328 
3329   ArrayRef<uint8_t> Sec =
3330       unwrapOrError(ObjF->getFileName(), Obj->getSectionContents(Shdr));
3331   while (!Sec.empty()) {
3332     if (Sec.size() < sizeof(Elf_Mips_Options<ELFT>)) {
3333       W.startLine() << "The .MIPS.options section has a wrong size.\n";
3334       return;
3335     }
3336     auto *O = reinterpret_cast<const Elf_Mips_Options<ELFT> *>(Sec.data());
3337     DictScope GS(W, getElfMipsOptionsOdkType(O->kind));
3338     switch (O->kind) {
3339     case ODK_REGINFO:
3340       printMipsReginfoData(W, O->getRegInfo());
3341       break;
3342     default:
3343       W.startLine() << "Unsupported MIPS options tag.\n";
3344       break;
3345     }
3346     Sec = Sec.slice(O->size);
3347   }
3348 }
3349 
3350 template <class ELFT> void ELFDumper<ELFT>::printStackMap() const {
3351   const ELFFile<ELFT> *Obj = ObjF->getELFFile();
3352   const Elf_Shdr *StackMapSection = nullptr;
3353   for (const Elf_Shdr &Sec : cantFail(Obj->sections())) {
3354     StringRef Name =
3355         unwrapOrError(ObjF->getFileName(), Obj->getSectionName(&Sec));
3356     if (Name == ".llvm_stackmaps") {
3357       StackMapSection = &Sec;
3358       break;
3359     }
3360   }
3361 
3362   if (!StackMapSection)
3363     return;
3364 
3365   ArrayRef<uint8_t> StackMapContentsArray = unwrapOrError(
3366       ObjF->getFileName(), Obj->getSectionContents(StackMapSection));
3367 
3368   prettyPrintStackMap(
3369       W, StackMapParser<ELFT::TargetEndianness>(StackMapContentsArray));
3370 }
3371 
3372 template <class ELFT> void ELFDumper<ELFT>::printGroupSections() {
3373   ELFDumperStyle->printGroupSections(ObjF->getELFFile());
3374 }
3375 
3376 template <class ELFT> void ELFDumper<ELFT>::printAddrsig() {
3377   ELFDumperStyle->printAddrsig(ObjF->getELFFile());
3378 }
3379 
3380 static inline void printFields(formatted_raw_ostream &OS, StringRef Str1,
3381                                StringRef Str2) {
3382   OS.PadToColumn(2u);
3383   OS << Str1;
3384   OS.PadToColumn(37u);
3385   OS << Str2 << "\n";
3386   OS.flush();
3387 }
3388 
3389 template <class ELFT>
3390 static std::string getSectionHeadersNumString(const ELFFile<ELFT> *Obj,
3391                                               StringRef FileName) {
3392   const typename ELFT::Ehdr *ElfHeader = Obj->getHeader();
3393   if (ElfHeader->e_shnum != 0)
3394     return to_string(ElfHeader->e_shnum);
3395 
3396   ArrayRef<typename ELFT::Shdr> Arr = cantFail(Obj->sections());
3397   if (Arr.empty())
3398     return "0";
3399   return "0 (" + to_string(Arr[0].sh_size) + ")";
3400 }
3401 
3402 template <class ELFT>
3403 static std::string getSectionHeaderTableIndexString(const ELFFile<ELFT> *Obj,
3404                                                     StringRef FileName) {
3405   const typename ELFT::Ehdr *ElfHeader = Obj->getHeader();
3406   if (ElfHeader->e_shstrndx != SHN_XINDEX)
3407     return to_string(ElfHeader->e_shstrndx);
3408 
3409   ArrayRef<typename ELFT::Shdr> Arr = cantFail(Obj->sections());
3410   if (Arr.empty())
3411     return "65535 (corrupt: out of range)";
3412   return to_string(ElfHeader->e_shstrndx) + " (" + to_string(Arr[0].sh_link) +
3413          ")";
3414 }
3415 
3416 template <class ELFT> void GNUStyle<ELFT>::printFileHeaders(const ELFO *Obj) {
3417   const Elf_Ehdr *e = Obj->getHeader();
3418   OS << "ELF Header:\n";
3419   OS << "  Magic:  ";
3420   std::string Str;
3421   for (int i = 0; i < ELF::EI_NIDENT; i++)
3422     OS << format(" %02x", static_cast<int>(e->e_ident[i]));
3423   OS << "\n";
3424   Str = printEnum(e->e_ident[ELF::EI_CLASS], makeArrayRef(ElfClass));
3425   printFields(OS, "Class:", Str);
3426   Str = printEnum(e->e_ident[ELF::EI_DATA], makeArrayRef(ElfDataEncoding));
3427   printFields(OS, "Data:", Str);
3428   OS.PadToColumn(2u);
3429   OS << "Version:";
3430   OS.PadToColumn(37u);
3431   OS << to_hexString(e->e_ident[ELF::EI_VERSION]);
3432   if (e->e_version == ELF::EV_CURRENT)
3433     OS << " (current)";
3434   OS << "\n";
3435   Str = printEnum(e->e_ident[ELF::EI_OSABI], makeArrayRef(ElfOSABI));
3436   printFields(OS, "OS/ABI:", Str);
3437   printFields(OS,
3438               "ABI Version:", std::to_string(e->e_ident[ELF::EI_ABIVERSION]));
3439   Str = printEnum(e->e_type, makeArrayRef(ElfObjectFileType));
3440   printFields(OS, "Type:", Str);
3441   Str = printEnum(e->e_machine, makeArrayRef(ElfMachineType));
3442   printFields(OS, "Machine:", Str);
3443   Str = "0x" + to_hexString(e->e_version);
3444   printFields(OS, "Version:", Str);
3445   Str = "0x" + to_hexString(e->e_entry);
3446   printFields(OS, "Entry point address:", Str);
3447   Str = to_string(e->e_phoff) + " (bytes into file)";
3448   printFields(OS, "Start of program headers:", Str);
3449   Str = to_string(e->e_shoff) + " (bytes into file)";
3450   printFields(OS, "Start of section headers:", Str);
3451   std::string ElfFlags;
3452   if (e->e_machine == EM_MIPS)
3453     ElfFlags =
3454         printFlags(e->e_flags, makeArrayRef(ElfHeaderMipsFlags),
3455                    unsigned(ELF::EF_MIPS_ARCH), unsigned(ELF::EF_MIPS_ABI),
3456                    unsigned(ELF::EF_MIPS_MACH));
3457   else if (e->e_machine == EM_RISCV)
3458     ElfFlags = printFlags(e->e_flags, makeArrayRef(ElfHeaderRISCVFlags));
3459   Str = "0x" + to_hexString(e->e_flags);
3460   if (!ElfFlags.empty())
3461     Str = Str + ", " + ElfFlags;
3462   printFields(OS, "Flags:", Str);
3463   Str = to_string(e->e_ehsize) + " (bytes)";
3464   printFields(OS, "Size of this header:", Str);
3465   Str = to_string(e->e_phentsize) + " (bytes)";
3466   printFields(OS, "Size of program headers:", Str);
3467   Str = to_string(e->e_phnum);
3468   printFields(OS, "Number of program headers:", Str);
3469   Str = to_string(e->e_shentsize) + " (bytes)";
3470   printFields(OS, "Size of section headers:", Str);
3471   Str = getSectionHeadersNumString(Obj, this->FileName);
3472   printFields(OS, "Number of section headers:", Str);
3473   Str = getSectionHeaderTableIndexString(Obj, this->FileName);
3474   printFields(OS, "Section header string table index:", Str);
3475 }
3476 
3477 namespace {
3478 struct GroupMember {
3479   StringRef Name;
3480   uint64_t Index;
3481 };
3482 
3483 struct GroupSection {
3484   StringRef Name;
3485   std::string Signature;
3486   uint64_t ShName;
3487   uint64_t Index;
3488   uint32_t Link;
3489   uint32_t Info;
3490   uint32_t Type;
3491   std::vector<GroupMember> Members;
3492 };
3493 
3494 template <class ELFT>
3495 std::vector<GroupSection> getGroups(const ELFFile<ELFT> *Obj,
3496                                     StringRef FileName) {
3497   using Elf_Shdr = typename ELFT::Shdr;
3498   using Elf_Sym = typename ELFT::Sym;
3499   using Elf_Word = typename ELFT::Word;
3500 
3501   std::vector<GroupSection> Ret;
3502   uint64_t I = 0;
3503   for (const Elf_Shdr &Sec : cantFail(Obj->sections())) {
3504     ++I;
3505     if (Sec.sh_type != ELF::SHT_GROUP)
3506       continue;
3507 
3508     const Elf_Shdr *Symtab =
3509         unwrapOrError(FileName, Obj->getSection(Sec.sh_link));
3510     StringRef StrTable =
3511         unwrapOrError(FileName, Obj->getStringTableForSymtab(*Symtab));
3512     const Elf_Sym *Sym = unwrapOrError(
3513         FileName, Obj->template getEntry<Elf_Sym>(Symtab, Sec.sh_info));
3514     auto Data = unwrapOrError(
3515         FileName, Obj->template getSectionContentsAsArray<Elf_Word>(&Sec));
3516 
3517     StringRef Name = unwrapOrError(FileName, Obj->getSectionName(&Sec));
3518     StringRef Signature = StrTable.data() + Sym->st_name;
3519     Ret.push_back({Name,
3520                    maybeDemangle(Signature),
3521                    Sec.sh_name,
3522                    I - 1,
3523                    Sec.sh_link,
3524                    Sec.sh_info,
3525                    Data[0],
3526                    {}});
3527 
3528     std::vector<GroupMember> &GM = Ret.back().Members;
3529     for (uint32_t Ndx : Data.slice(1)) {
3530       auto Sec = unwrapOrError(FileName, Obj->getSection(Ndx));
3531       const StringRef Name = unwrapOrError(FileName, Obj->getSectionName(Sec));
3532       GM.push_back({Name, Ndx});
3533     }
3534   }
3535   return Ret;
3536 }
3537 
3538 DenseMap<uint64_t, const GroupSection *>
3539 mapSectionsToGroups(ArrayRef<GroupSection> Groups) {
3540   DenseMap<uint64_t, const GroupSection *> Ret;
3541   for (const GroupSection &G : Groups)
3542     for (const GroupMember &GM : G.Members)
3543       Ret.insert({GM.Index, &G});
3544   return Ret;
3545 }
3546 
3547 } // namespace
3548 
3549 template <class ELFT> void GNUStyle<ELFT>::printGroupSections(const ELFO *Obj) {
3550   std::vector<GroupSection> V = getGroups<ELFT>(Obj, this->FileName);
3551   DenseMap<uint64_t, const GroupSection *> Map = mapSectionsToGroups(V);
3552   for (const GroupSection &G : V) {
3553     OS << "\n"
3554        << getGroupType(G.Type) << " group section ["
3555        << format_decimal(G.Index, 5) << "] `" << G.Name << "' [" << G.Signature
3556        << "] contains " << G.Members.size() << " sections:\n"
3557        << "   [Index]    Name\n";
3558     for (const GroupMember &GM : G.Members) {
3559       const GroupSection *MainGroup = Map[GM.Index];
3560       if (MainGroup != &G) {
3561         OS.flush();
3562         errs() << "Error: section [" << format_decimal(GM.Index, 5)
3563                << "] in group section [" << format_decimal(G.Index, 5)
3564                << "] already in group section ["
3565                << format_decimal(MainGroup->Index, 5) << "]";
3566         errs().flush();
3567         continue;
3568       }
3569       OS << "   [" << format_decimal(GM.Index, 5) << "]   " << GM.Name << "\n";
3570     }
3571   }
3572 
3573   if (V.empty())
3574     OS << "There are no section groups in this file.\n";
3575 }
3576 
3577 template <class ELFT>
3578 void GNUStyle<ELFT>::printRelocation(const ELFO *Obj, unsigned SecIndex,
3579                                      const Elf_Shdr *SymTab, const Elf_Rela &R,
3580                                      unsigned RelIndex, bool IsRela) {
3581   Expected<std::pair<const typename ELFT::Sym *, std::string>> Target =
3582       this->dumper()->getRelocationTarget(SymTab, R);
3583   if (!Target)
3584     this->reportUniqueWarning(createError(
3585         "unable to print relocation " + Twine(RelIndex) + " in section " +
3586         Twine(SecIndex) + ": " + toString(Target.takeError())));
3587   else
3588     printRelocation(Obj, /*Sym=*/Target->first, /*Name=*/Target->second, R,
3589                     IsRela);
3590 }
3591 
3592 template <class ELFT>
3593 void GNUStyle<ELFT>::printRelocation(const ELFO *Obj, const Elf_Sym *Sym,
3594                                      StringRef SymbolName, const Elf_Rela &R,
3595                                      bool IsRela) {
3596   // First two fields are bit width dependent. The rest of them are fixed width.
3597   unsigned Bias = ELFT::Is64Bits ? 8 : 0;
3598   Field Fields[5] = {0, 10 + Bias, 19 + 2 * Bias, 42 + 2 * Bias, 53 + 2 * Bias};
3599   unsigned Width = ELFT::Is64Bits ? 16 : 8;
3600 
3601   Fields[0].Str = to_string(format_hex_no_prefix(R.r_offset, Width));
3602   Fields[1].Str = to_string(format_hex_no_prefix(R.r_info, Width));
3603 
3604   SmallString<32> RelocName;
3605   Obj->getRelocationTypeName(R.getType(Obj->isMips64EL()), RelocName);
3606   Fields[2].Str = RelocName.c_str();
3607 
3608   if (Sym)
3609     Fields[3].Str = to_string(format_hex_no_prefix(Sym->getValue(), Width));
3610 
3611   Fields[4].Str = std::string(SymbolName);
3612   for (const Field &F : Fields)
3613     printField(F);
3614 
3615   std::string Addend;
3616   if (IsRela) {
3617     int64_t RelAddend = R.r_addend;
3618     if (!SymbolName.empty()) {
3619       if (R.r_addend < 0) {
3620         Addend = " - ";
3621         RelAddend = std::abs(RelAddend);
3622       } else
3623         Addend = " + ";
3624     }
3625 
3626     Addend += to_hexString(RelAddend, false);
3627   }
3628   OS << Addend << "\n";
3629 }
3630 
3631 template <class ELFT> void GNUStyle<ELFT>::printRelocHeader(unsigned SType) {
3632   bool IsRela = SType == ELF::SHT_RELA || SType == ELF::SHT_ANDROID_RELA;
3633   bool IsRelr = SType == ELF::SHT_RELR || SType == ELF::SHT_ANDROID_RELR;
3634   if (ELFT::Is64Bits)
3635     OS << "    ";
3636   else
3637     OS << " ";
3638   if (IsRelr && opts::RawRelr)
3639     OS << "Data  ";
3640   else
3641     OS << "Offset";
3642   if (ELFT::Is64Bits)
3643     OS << "             Info             Type"
3644        << "               Symbol's Value  Symbol's Name";
3645   else
3646     OS << "     Info    Type                Sym. Value  Symbol's Name";
3647   if (IsRela)
3648     OS << " + Addend";
3649   OS << "\n";
3650 }
3651 
3652 template <class ELFT> void GNUStyle<ELFT>::printRelocations(const ELFO *Obj) {
3653   bool HasRelocSections = false;
3654   for (const Elf_Shdr &Sec : cantFail(Obj->sections())) {
3655     if (Sec.sh_type != ELF::SHT_REL && Sec.sh_type != ELF::SHT_RELA &&
3656         Sec.sh_type != ELF::SHT_RELR && Sec.sh_type != ELF::SHT_ANDROID_REL &&
3657         Sec.sh_type != ELF::SHT_ANDROID_RELA &&
3658         Sec.sh_type != ELF::SHT_ANDROID_RELR)
3659       continue;
3660     HasRelocSections = true;
3661     StringRef Name = unwrapOrError(this->FileName, Obj->getSectionName(&Sec));
3662     unsigned Entries = Sec.getEntityCount();
3663     std::vector<Elf_Rela> AndroidRelas;
3664     if (Sec.sh_type == ELF::SHT_ANDROID_REL ||
3665         Sec.sh_type == ELF::SHT_ANDROID_RELA) {
3666       // Android's packed relocation section needs to be unpacked first
3667       // to get the actual number of entries.
3668       AndroidRelas = unwrapOrError(this->FileName, Obj->android_relas(&Sec));
3669       Entries = AndroidRelas.size();
3670     }
3671     std::vector<Elf_Rela> RelrRelas;
3672     if (!opts::RawRelr && (Sec.sh_type == ELF::SHT_RELR ||
3673                            Sec.sh_type == ELF::SHT_ANDROID_RELR)) {
3674       // .relr.dyn relative relocation section needs to be unpacked first
3675       // to get the actual number of entries.
3676       Elf_Relr_Range Relrs = unwrapOrError(this->FileName, Obj->relrs(&Sec));
3677       RelrRelas = unwrapOrError(this->FileName, Obj->decode_relrs(Relrs));
3678       Entries = RelrRelas.size();
3679     }
3680     uintX_t Offset = Sec.sh_offset;
3681     OS << "\nRelocation section '" << Name << "' at offset 0x"
3682        << to_hexString(Offset, false) << " contains " << Entries
3683        << " entries:\n";
3684     printRelocHeader(Sec.sh_type);
3685     const Elf_Shdr *SymTab =
3686         unwrapOrError(this->FileName, Obj->getSection(Sec.sh_link));
3687     unsigned SecNdx = &Sec - &cantFail(Obj->sections()).front();
3688     unsigned RelNdx = 0;
3689 
3690     switch (Sec.sh_type) {
3691     case ELF::SHT_REL:
3692       for (const auto &R : unwrapOrError(this->FileName, Obj->rels(&Sec))) {
3693         Elf_Rela Rela;
3694         Rela.r_offset = R.r_offset;
3695         Rela.r_info = R.r_info;
3696         Rela.r_addend = 0;
3697         printRelocation(Obj, SecNdx, SymTab, Rela, ++RelNdx, false);
3698       }
3699       break;
3700     case ELF::SHT_RELA:
3701       for (const auto &R : unwrapOrError(this->FileName, Obj->relas(&Sec)))
3702         printRelocation(Obj, SecNdx, SymTab, R, ++RelNdx, true);
3703       break;
3704     case ELF::SHT_RELR:
3705     case ELF::SHT_ANDROID_RELR:
3706       if (opts::RawRelr)
3707         for (const auto &R : unwrapOrError(this->FileName, Obj->relrs(&Sec)))
3708           OS << to_string(format_hex_no_prefix(R, ELFT::Is64Bits ? 16 : 8))
3709              << "\n";
3710       else
3711         for (const auto &R : RelrRelas)
3712           printRelocation(Obj, SecNdx, SymTab, R, ++RelNdx, false);
3713       break;
3714     case ELF::SHT_ANDROID_REL:
3715     case ELF::SHT_ANDROID_RELA:
3716       for (const auto &R : AndroidRelas)
3717         printRelocation(Obj, SecNdx, SymTab, R, ++RelNdx,
3718                         Sec.sh_type == ELF::SHT_ANDROID_RELA);
3719       break;
3720     }
3721   }
3722   if (!HasRelocSections)
3723     OS << "\nThere are no relocations in this file.\n";
3724 }
3725 
3726 // Print the offset of a particular section from anyone of the ranges:
3727 // [SHT_LOOS, SHT_HIOS], [SHT_LOPROC, SHT_HIPROC], [SHT_LOUSER, SHT_HIUSER].
3728 // If 'Type' does not fall within any of those ranges, then a string is
3729 // returned as '<unknown>' followed by the type value.
3730 static std::string getSectionTypeOffsetString(unsigned Type) {
3731   if (Type >= SHT_LOOS && Type <= SHT_HIOS)
3732     return "LOOS+0x" + to_hexString(Type - SHT_LOOS);
3733   else if (Type >= SHT_LOPROC && Type <= SHT_HIPROC)
3734     return "LOPROC+0x" + to_hexString(Type - SHT_LOPROC);
3735   else if (Type >= SHT_LOUSER && Type <= SHT_HIUSER)
3736     return "LOUSER+0x" + to_hexString(Type - SHT_LOUSER);
3737   return "0x" + to_hexString(Type) + ": <unknown>";
3738 }
3739 
3740 static std::string getSectionTypeString(unsigned Arch, unsigned Type) {
3741   using namespace ELF;
3742 
3743   switch (Arch) {
3744   case EM_ARM:
3745     switch (Type) {
3746     case SHT_ARM_EXIDX:
3747       return "ARM_EXIDX";
3748     case SHT_ARM_PREEMPTMAP:
3749       return "ARM_PREEMPTMAP";
3750     case SHT_ARM_ATTRIBUTES:
3751       return "ARM_ATTRIBUTES";
3752     case SHT_ARM_DEBUGOVERLAY:
3753       return "ARM_DEBUGOVERLAY";
3754     case SHT_ARM_OVERLAYSECTION:
3755       return "ARM_OVERLAYSECTION";
3756     }
3757     break;
3758   case EM_X86_64:
3759     switch (Type) {
3760     case SHT_X86_64_UNWIND:
3761       return "X86_64_UNWIND";
3762     }
3763     break;
3764   case EM_MIPS:
3765   case EM_MIPS_RS3_LE:
3766     switch (Type) {
3767     case SHT_MIPS_REGINFO:
3768       return "MIPS_REGINFO";
3769     case SHT_MIPS_OPTIONS:
3770       return "MIPS_OPTIONS";
3771     case SHT_MIPS_DWARF:
3772       return "MIPS_DWARF";
3773     case SHT_MIPS_ABIFLAGS:
3774       return "MIPS_ABIFLAGS";
3775     }
3776     break;
3777   case EM_RISCV:
3778     switch (Type) {
3779     case SHT_RISCV_ATTRIBUTES:
3780       return "RISCV_ATTRIBUTES";
3781     }
3782   }
3783   switch (Type) {
3784   case SHT_NULL:
3785     return "NULL";
3786   case SHT_PROGBITS:
3787     return "PROGBITS";
3788   case SHT_SYMTAB:
3789     return "SYMTAB";
3790   case SHT_STRTAB:
3791     return "STRTAB";
3792   case SHT_RELA:
3793     return "RELA";
3794   case SHT_HASH:
3795     return "HASH";
3796   case SHT_DYNAMIC:
3797     return "DYNAMIC";
3798   case SHT_NOTE:
3799     return "NOTE";
3800   case SHT_NOBITS:
3801     return "NOBITS";
3802   case SHT_REL:
3803     return "REL";
3804   case SHT_SHLIB:
3805     return "SHLIB";
3806   case SHT_DYNSYM:
3807     return "DYNSYM";
3808   case SHT_INIT_ARRAY:
3809     return "INIT_ARRAY";
3810   case SHT_FINI_ARRAY:
3811     return "FINI_ARRAY";
3812   case SHT_PREINIT_ARRAY:
3813     return "PREINIT_ARRAY";
3814   case SHT_GROUP:
3815     return "GROUP";
3816   case SHT_SYMTAB_SHNDX:
3817     return "SYMTAB SECTION INDICES";
3818   case SHT_ANDROID_REL:
3819     return "ANDROID_REL";
3820   case SHT_ANDROID_RELA:
3821     return "ANDROID_RELA";
3822   case SHT_RELR:
3823   case SHT_ANDROID_RELR:
3824     return "RELR";
3825   case SHT_LLVM_ODRTAB:
3826     return "LLVM_ODRTAB";
3827   case SHT_LLVM_LINKER_OPTIONS:
3828     return "LLVM_LINKER_OPTIONS";
3829   case SHT_LLVM_CALL_GRAPH_PROFILE:
3830     return "LLVM_CALL_GRAPH_PROFILE";
3831   case SHT_LLVM_ADDRSIG:
3832     return "LLVM_ADDRSIG";
3833   case SHT_LLVM_DEPENDENT_LIBRARIES:
3834     return "LLVM_DEPENDENT_LIBRARIES";
3835   case SHT_LLVM_SYMPART:
3836     return "LLVM_SYMPART";
3837   case SHT_LLVM_PART_EHDR:
3838     return "LLVM_PART_EHDR";
3839   case SHT_LLVM_PART_PHDR:
3840     return "LLVM_PART_PHDR";
3841   // FIXME: Parse processor specific GNU attributes
3842   case SHT_GNU_ATTRIBUTES:
3843     return "ATTRIBUTES";
3844   case SHT_GNU_HASH:
3845     return "GNU_HASH";
3846   case SHT_GNU_verdef:
3847     return "VERDEF";
3848   case SHT_GNU_verneed:
3849     return "VERNEED";
3850   case SHT_GNU_versym:
3851     return "VERSYM";
3852   default:
3853     return getSectionTypeOffsetString(Type);
3854   }
3855   return "";
3856 }
3857 
3858 static void printSectionDescription(formatted_raw_ostream &OS,
3859                                     unsigned EMachine) {
3860   OS << "Key to Flags:\n";
3861   OS << "  W (write), A (alloc), X (execute), M (merge), S (strings), I "
3862         "(info),\n";
3863   OS << "  L (link order), O (extra OS processing required), G (group), T "
3864         "(TLS),\n";
3865   OS << "  C (compressed), x (unknown), o (OS specific), E (exclude),\n";
3866 
3867   if (EMachine == EM_X86_64)
3868     OS << "  l (large), ";
3869   else if (EMachine == EM_ARM)
3870     OS << "  y (purecode), ";
3871   else
3872     OS << "  ";
3873 
3874   OS << "p (processor specific)\n";
3875 }
3876 
3877 template <class ELFT>
3878 void GNUStyle<ELFT>::printSectionHeaders(const ELFO *Obj) {
3879   unsigned Bias = ELFT::Is64Bits ? 0 : 8;
3880   ArrayRef<Elf_Shdr> Sections = cantFail(Obj->sections());
3881   OS << "There are " << to_string(Sections.size())
3882      << " section headers, starting at offset "
3883      << "0x" << to_hexString(Obj->getHeader()->e_shoff, false) << ":\n\n";
3884   OS << "Section Headers:\n";
3885   Field Fields[11] = {
3886       {"[Nr]", 2},        {"Name", 7},        {"Type", 25},
3887       {"Address", 41},    {"Off", 58 - Bias}, {"Size", 65 - Bias},
3888       {"ES", 72 - Bias},  {"Flg", 75 - Bias}, {"Lk", 79 - Bias},
3889       {"Inf", 82 - Bias}, {"Al", 86 - Bias}};
3890   for (auto &F : Fields)
3891     printField(F);
3892   OS << "\n";
3893 
3894   StringRef SecStrTable;
3895   if (Expected<StringRef> SecStrTableOrErr =
3896           Obj->getSectionStringTable(Sections, this->dumper()->WarningHandler))
3897     SecStrTable = *SecStrTableOrErr;
3898   else
3899     this->reportUniqueWarning(SecStrTableOrErr.takeError());
3900 
3901   size_t SectionIndex = 0;
3902   for (const Elf_Shdr &Sec : Sections) {
3903     Fields[0].Str = to_string(SectionIndex);
3904     if (SecStrTable.empty())
3905       Fields[1].Str = "<no-strings>";
3906     else
3907       Fields[1].Str = std::string(unwrapOrError<StringRef>(
3908           this->FileName, Obj->getSectionName(&Sec, SecStrTable)));
3909     Fields[2].Str =
3910         getSectionTypeString(Obj->getHeader()->e_machine, Sec.sh_type);
3911     Fields[3].Str =
3912         to_string(format_hex_no_prefix(Sec.sh_addr, ELFT::Is64Bits ? 16 : 8));
3913     Fields[4].Str = to_string(format_hex_no_prefix(Sec.sh_offset, 6));
3914     Fields[5].Str = to_string(format_hex_no_prefix(Sec.sh_size, 6));
3915     Fields[6].Str = to_string(format_hex_no_prefix(Sec.sh_entsize, 2));
3916     Fields[7].Str = getGNUFlags(Obj->getHeader()->e_machine, Sec.sh_flags);
3917     Fields[8].Str = to_string(Sec.sh_link);
3918     Fields[9].Str = to_string(Sec.sh_info);
3919     Fields[10].Str = to_string(Sec.sh_addralign);
3920 
3921     OS.PadToColumn(Fields[0].Column);
3922     OS << "[" << right_justify(Fields[0].Str, 2) << "]";
3923     for (int i = 1; i < 7; i++)
3924       printField(Fields[i]);
3925     OS.PadToColumn(Fields[7].Column);
3926     OS << right_justify(Fields[7].Str, 3);
3927     OS.PadToColumn(Fields[8].Column);
3928     OS << right_justify(Fields[8].Str, 2);
3929     OS.PadToColumn(Fields[9].Column);
3930     OS << right_justify(Fields[9].Str, 3);
3931     OS.PadToColumn(Fields[10].Column);
3932     OS << right_justify(Fields[10].Str, 2);
3933     OS << "\n";
3934     ++SectionIndex;
3935   }
3936   printSectionDescription(OS, Obj->getHeader()->e_machine);
3937 }
3938 
3939 template <class ELFT>
3940 void GNUStyle<ELFT>::printSymtabMessage(const ELFO *Obj, StringRef Name,
3941                                         size_t Entries,
3942                                         bool NonVisibilityBitsUsed) {
3943   if (!Name.empty())
3944     OS << "\nSymbol table '" << Name << "'";
3945   else
3946     OS << "\nSymbol table for image";
3947   OS << " contains " << Entries << " entries:\n";
3948 
3949   if (ELFT::Is64Bits)
3950     OS << "   Num:    Value          Size Type    Bind   Vis";
3951   else
3952     OS << "   Num:    Value  Size Type    Bind   Vis";
3953 
3954   if (NonVisibilityBitsUsed)
3955     OS << "             ";
3956   OS << "       Ndx Name\n";
3957 }
3958 
3959 template <class ELFT>
3960 std::string GNUStyle<ELFT>::getSymbolSectionNdx(const ELFO *Obj,
3961                                                 const Elf_Sym *Symbol,
3962                                                 const Elf_Sym *FirstSym) {
3963   unsigned SectionIndex = Symbol->st_shndx;
3964   switch (SectionIndex) {
3965   case ELF::SHN_UNDEF:
3966     return "UND";
3967   case ELF::SHN_ABS:
3968     return "ABS";
3969   case ELF::SHN_COMMON:
3970     return "COM";
3971   case ELF::SHN_XINDEX: {
3972     Expected<uint32_t> IndexOrErr = object::getExtendedSymbolTableIndex<ELFT>(
3973         Symbol, FirstSym, this->dumper()->getShndxTable());
3974     if (!IndexOrErr) {
3975       assert(Symbol->st_shndx == SHN_XINDEX &&
3976              "getSymbolSectionIndex should only fail due to an invalid "
3977              "SHT_SYMTAB_SHNDX table/reference");
3978       this->reportUniqueWarning(IndexOrErr.takeError());
3979       return "RSV[0xffff]";
3980     }
3981     return to_string(format_decimal(*IndexOrErr, 3));
3982   }
3983   default:
3984     // Find if:
3985     // Processor specific
3986     if (SectionIndex >= ELF::SHN_LOPROC && SectionIndex <= ELF::SHN_HIPROC)
3987       return std::string("PRC[0x") +
3988              to_string(format_hex_no_prefix(SectionIndex, 4)) + "]";
3989     // OS specific
3990     if (SectionIndex >= ELF::SHN_LOOS && SectionIndex <= ELF::SHN_HIOS)
3991       return std::string("OS[0x") +
3992              to_string(format_hex_no_prefix(SectionIndex, 4)) + "]";
3993     // Architecture reserved:
3994     if (SectionIndex >= ELF::SHN_LORESERVE &&
3995         SectionIndex <= ELF::SHN_HIRESERVE)
3996       return std::string("RSV[0x") +
3997              to_string(format_hex_no_prefix(SectionIndex, 4)) + "]";
3998     // A normal section with an index
3999     return to_string(format_decimal(SectionIndex, 3));
4000   }
4001 }
4002 
4003 template <class ELFT>
4004 void GNUStyle<ELFT>::printSymbol(const ELFO *Obj, const Elf_Sym *Symbol,
4005                                  const Elf_Sym *FirstSym,
4006                                  Optional<StringRef> StrTable, bool IsDynamic,
4007                                  bool NonVisibilityBitsUsed) {
4008   static int Idx = 0;
4009   static bool Dynamic = true;
4010 
4011   // If this function was called with a different value from IsDynamic
4012   // from last call, happens when we move from dynamic to static symbol
4013   // table, "Num" field should be reset.
4014   if (!Dynamic != !IsDynamic) {
4015     Idx = 0;
4016     Dynamic = false;
4017   }
4018 
4019   unsigned Bias = ELFT::Is64Bits ? 8 : 0;
4020   Field Fields[8] = {0,         8,         17 + Bias, 23 + Bias,
4021                      31 + Bias, 38 + Bias, 48 + Bias, 51 + Bias};
4022   Fields[0].Str = to_string(format_decimal(Idx++, 6)) + ":";
4023   Fields[1].Str = to_string(
4024       format_hex_no_prefix(Symbol->st_value, ELFT::Is64Bits ? 16 : 8));
4025   Fields[2].Str = to_string(format_decimal(Symbol->st_size, 5));
4026 
4027   unsigned char SymbolType = Symbol->getType();
4028   if (Obj->getHeader()->e_machine == ELF::EM_AMDGPU &&
4029       SymbolType >= ELF::STT_LOOS && SymbolType < ELF::STT_HIOS)
4030     Fields[3].Str = printEnum(SymbolType, makeArrayRef(AMDGPUSymbolTypes));
4031   else
4032     Fields[3].Str = printEnum(SymbolType, makeArrayRef(ElfSymbolTypes));
4033 
4034   Fields[4].Str =
4035       printEnum(Symbol->getBinding(), makeArrayRef(ElfSymbolBindings));
4036   Fields[5].Str =
4037       printEnum(Symbol->getVisibility(), makeArrayRef(ElfSymbolVisibilities));
4038   if (Symbol->st_other & ~0x3)
4039     Fields[5].Str +=
4040         " [<other: " + to_string(format_hex(Symbol->st_other, 2)) + ">]";
4041 
4042   Fields[6].Column += NonVisibilityBitsUsed ? 13 : 0;
4043   Fields[6].Str = getSymbolSectionNdx(Obj, Symbol, FirstSym);
4044 
4045   Fields[7].Str =
4046       this->dumper()->getFullSymbolName(Symbol, StrTable, IsDynamic);
4047   for (auto &Entry : Fields)
4048     printField(Entry);
4049   OS << "\n";
4050 }
4051 
4052 template <class ELFT>
4053 void GNUStyle<ELFT>::printHashedSymbol(const ELFO *Obj, const Elf_Sym *FirstSym,
4054                                        uint32_t Sym, StringRef StrTable,
4055                                        uint32_t Bucket) {
4056   unsigned Bias = ELFT::Is64Bits ? 8 : 0;
4057   Field Fields[9] = {0,         6,         11,        20 + Bias, 25 + Bias,
4058                      34 + Bias, 41 + Bias, 49 + Bias, 53 + Bias};
4059   Fields[0].Str = to_string(format_decimal(Sym, 5));
4060   Fields[1].Str = to_string(format_decimal(Bucket, 3)) + ":";
4061 
4062   const auto Symbol = FirstSym + Sym;
4063   Fields[2].Str = to_string(
4064       format_hex_no_prefix(Symbol->st_value, ELFT::Is64Bits ? 16 : 8));
4065   Fields[3].Str = to_string(format_decimal(Symbol->st_size, 5));
4066 
4067   unsigned char SymbolType = Symbol->getType();
4068   if (Obj->getHeader()->e_machine == ELF::EM_AMDGPU &&
4069       SymbolType >= ELF::STT_LOOS && SymbolType < ELF::STT_HIOS)
4070     Fields[4].Str = printEnum(SymbolType, makeArrayRef(AMDGPUSymbolTypes));
4071   else
4072     Fields[4].Str = printEnum(SymbolType, makeArrayRef(ElfSymbolTypes));
4073 
4074   Fields[5].Str =
4075       printEnum(Symbol->getBinding(), makeArrayRef(ElfSymbolBindings));
4076   Fields[6].Str =
4077       printEnum(Symbol->getVisibility(), makeArrayRef(ElfSymbolVisibilities));
4078   Fields[7].Str = getSymbolSectionNdx(Obj, Symbol, FirstSym);
4079   Fields[8].Str = this->dumper()->getFullSymbolName(Symbol, StrTable, true);
4080 
4081   for (auto &Entry : Fields)
4082     printField(Entry);
4083   OS << "\n";
4084 }
4085 
4086 template <class ELFT>
4087 void GNUStyle<ELFT>::printSymbols(const ELFO *Obj, bool PrintSymbols,
4088                                   bool PrintDynamicSymbols) {
4089   if (!PrintSymbols && !PrintDynamicSymbols)
4090     return;
4091   // GNU readelf prints both the .dynsym and .symtab with --symbols.
4092   this->dumper()->printSymbolsHelper(true);
4093   if (PrintSymbols)
4094     this->dumper()->printSymbolsHelper(false);
4095 }
4096 
4097 template <class ELFT>
4098 void GNUStyle<ELFT>::printHashTableSymbols(const ELFO *Obj,
4099                                            const Elf_Hash &SysVHash) {
4100   StringRef StringTable = this->dumper()->getDynamicStringTable();
4101   if (StringTable.empty())
4102     return;
4103 
4104   if (ELFT::Is64Bits)
4105     OS << "  Num Buc:    Value          Size   Type   Bind Vis      Ndx Name";
4106   else
4107     OS << "  Num Buc:    Value  Size   Type   Bind Vis      Ndx Name";
4108   OS << "\n";
4109 
4110   Elf_Sym_Range DynSyms = this->dumper()->dynamic_symbols();
4111   const Elf_Sym *FirstSym = DynSyms.empty() ? nullptr : &DynSyms[0];
4112   if (!FirstSym) {
4113     Optional<DynRegionInfo> DynSymRegion = this->dumper()->getDynSymRegion();
4114     this->reportUniqueWarning(
4115         createError(Twine("unable to print symbols for the .hash table: the "
4116                           "dynamic symbol table ") +
4117                     (DynSymRegion ? "is empty" : "was not found")));
4118     return;
4119   }
4120 
4121   auto Buckets = SysVHash.buckets();
4122   auto Chains = SysVHash.chains();
4123   for (uint32_t Buc = 0; Buc < SysVHash.nbucket; Buc++) {
4124     if (Buckets[Buc] == ELF::STN_UNDEF)
4125       continue;
4126     std::vector<bool> Visited(SysVHash.nchain);
4127     for (uint32_t Ch = Buckets[Buc]; Ch < SysVHash.nchain; Ch = Chains[Ch]) {
4128       if (Ch == ELF::STN_UNDEF)
4129         break;
4130 
4131       if (Visited[Ch]) {
4132         reportWarning(createError(".hash section is invalid: bucket " +
4133                                   Twine(Ch) +
4134                                   ": a cycle was detected in the linked chain"),
4135                       this->FileName);
4136         break;
4137       }
4138 
4139       printHashedSymbol(Obj, FirstSym, Ch, StringTable, Buc);
4140       Visited[Ch] = true;
4141     }
4142   }
4143 }
4144 
4145 template <class ELFT>
4146 void GNUStyle<ELFT>::printGnuHashTableSymbols(const ELFO *Obj,
4147                                               const Elf_GnuHash &GnuHash) {
4148   StringRef StringTable = this->dumper()->getDynamicStringTable();
4149   if (StringTable.empty())
4150     return;
4151 
4152   Elf_Sym_Range DynSyms = this->dumper()->dynamic_symbols();
4153   const Elf_Sym *FirstSym = DynSyms.empty() ? nullptr : &DynSyms[0];
4154   if (!FirstSym) {
4155     Optional<DynRegionInfo> DynSymRegion = this->dumper()->getDynSymRegion();
4156     this->reportUniqueWarning(createError(
4157         Twine("unable to print symbols for the .gnu.hash table: the "
4158               "dynamic symbol table ") +
4159         (DynSymRegion ? "is empty" : "was not found")));
4160     return;
4161   }
4162 
4163   ArrayRef<Elf_Word> Buckets = GnuHash.buckets();
4164   for (uint32_t Buc = 0; Buc < GnuHash.nbuckets; Buc++) {
4165     if (Buckets[Buc] == ELF::STN_UNDEF)
4166       continue;
4167     uint32_t Index = Buckets[Buc];
4168     uint32_t GnuHashable = Index - GnuHash.symndx;
4169     // Print whole chain
4170     while (true) {
4171       printHashedSymbol(Obj, FirstSym, Index++, StringTable, Buc);
4172       // Chain ends at symbol with stopper bit
4173       if ((GnuHash.values(DynSyms.size())[GnuHashable++] & 1) == 1)
4174         break;
4175     }
4176   }
4177 }
4178 
4179 template <class ELFT> void GNUStyle<ELFT>::printHashSymbols(const ELFO *Obj) {
4180   if (const Elf_Hash *SysVHash = this->dumper()->getHashTable()) {
4181     OS << "\n Symbol table of .hash for image:\n";
4182     if (Error E = checkHashTable<ELFT>(Obj, SysVHash))
4183       this->reportUniqueWarning(std::move(E));
4184     else
4185       printHashTableSymbols(Obj, *SysVHash);
4186   }
4187 
4188   // Try printing the .gnu.hash table.
4189   if (const Elf_GnuHash *GnuHash = this->dumper()->getGnuHashTable()) {
4190     OS << "\n Symbol table of .gnu.hash for image:\n";
4191     if (ELFT::Is64Bits)
4192       OS << "  Num Buc:    Value          Size   Type   Bind Vis      Ndx Name";
4193     else
4194       OS << "  Num Buc:    Value  Size   Type   Bind Vis      Ndx Name";
4195     OS << "\n";
4196 
4197     if (Error E = checkGNUHashTable<ELFT>(Obj, GnuHash))
4198       this->reportUniqueWarning(std::move(E));
4199     else
4200       printGnuHashTableSymbols(Obj, *GnuHash);
4201   }
4202 }
4203 
4204 static inline std::string printPhdrFlags(unsigned Flag) {
4205   std::string Str;
4206   Str = (Flag & PF_R) ? "R" : " ";
4207   Str += (Flag & PF_W) ? "W" : " ";
4208   Str += (Flag & PF_X) ? "E" : " ";
4209   return Str;
4210 }
4211 
4212 template <class ELFT>
4213 static bool checkTLSSections(const typename ELFT::Phdr &Phdr,
4214                              const typename ELFT::Shdr &Sec) {
4215   if (Sec.sh_flags & ELF::SHF_TLS) {
4216     // .tbss must only be shown in the PT_TLS segment.
4217     if (Sec.sh_type == ELF::SHT_NOBITS)
4218       return Phdr.p_type == ELF::PT_TLS;
4219 
4220     // SHF_TLS sections are only shown in PT_TLS, PT_LOAD or PT_GNU_RELRO
4221     // segments.
4222     return (Phdr.p_type == ELF::PT_TLS) || (Phdr.p_type == ELF::PT_LOAD) ||
4223            (Phdr.p_type == ELF::PT_GNU_RELRO);
4224   }
4225 
4226   // PT_TLS must only have SHF_TLS sections.
4227   return Phdr.p_type != ELF::PT_TLS;
4228 }
4229 
4230 template <class ELFT>
4231 static bool checkOffsets(const typename ELFT::Phdr &Phdr,
4232                          const typename ELFT::Shdr &Sec) {
4233   // SHT_NOBITS sections don't need to have an offset inside the segment.
4234   if (Sec.sh_type == ELF::SHT_NOBITS)
4235     return true;
4236 
4237   if (Sec.sh_offset < Phdr.p_offset)
4238     return false;
4239 
4240   // Only non-empty sections can be at the end of a segment.
4241   if (Sec.sh_size == 0)
4242     return (Sec.sh_offset + 1 <= Phdr.p_offset + Phdr.p_filesz);
4243   return Sec.sh_offset + Sec.sh_size <= Phdr.p_offset + Phdr.p_filesz;
4244 }
4245 
4246 // Check that an allocatable section belongs to a virtual address
4247 // space of a segment.
4248 template <class ELFT>
4249 static bool checkVMA(const typename ELFT::Phdr &Phdr,
4250                      const typename ELFT::Shdr &Sec) {
4251   if (!(Sec.sh_flags & ELF::SHF_ALLOC))
4252     return true;
4253 
4254   if (Sec.sh_addr < Phdr.p_vaddr)
4255     return false;
4256 
4257   bool IsTbss =
4258       (Sec.sh_type == ELF::SHT_NOBITS) && ((Sec.sh_flags & ELF::SHF_TLS) != 0);
4259   // .tbss is special, it only has memory in PT_TLS and has NOBITS properties.
4260   bool IsTbssInNonTLS = IsTbss && Phdr.p_type != ELF::PT_TLS;
4261   // Only non-empty sections can be at the end of a segment.
4262   if (Sec.sh_size == 0 || IsTbssInNonTLS)
4263     return Sec.sh_addr + 1 <= Phdr.p_vaddr + Phdr.p_memsz;
4264   return Sec.sh_addr + Sec.sh_size <= Phdr.p_vaddr + Phdr.p_memsz;
4265 }
4266 
4267 template <class ELFT>
4268 static bool checkPTDynamic(const typename ELFT::Phdr &Phdr,
4269                            const typename ELFT::Shdr &Sec) {
4270   if (Phdr.p_type != ELF::PT_DYNAMIC || Phdr.p_memsz == 0 || Sec.sh_size != 0)
4271     return true;
4272 
4273   // We get here when we have an empty section. Only non-empty sections can be
4274   // at the start or at the end of PT_DYNAMIC.
4275   // Is section within the phdr both based on offset and VMA?
4276   bool CheckOffset = (Sec.sh_type == ELF::SHT_NOBITS) ||
4277                      (Sec.sh_offset > Phdr.p_offset &&
4278                       Sec.sh_offset < Phdr.p_offset + Phdr.p_filesz);
4279   bool CheckVA = !(Sec.sh_flags & ELF::SHF_ALLOC) ||
4280                  (Sec.sh_addr > Phdr.p_vaddr && Sec.sh_addr < Phdr.p_memsz);
4281   return CheckOffset && CheckVA;
4282 }
4283 
4284 template <class ELFT>
4285 void GNUStyle<ELFT>::printProgramHeaders(
4286     const ELFO *Obj, bool PrintProgramHeaders,
4287     cl::boolOrDefault PrintSectionMapping) {
4288   if (PrintProgramHeaders)
4289     printProgramHeaders(Obj);
4290 
4291   // Display the section mapping along with the program headers, unless
4292   // -section-mapping is explicitly set to false.
4293   if (PrintSectionMapping != cl::BOU_FALSE)
4294     printSectionMapping(Obj);
4295 }
4296 
4297 template <class ELFT>
4298 void GNUStyle<ELFT>::printProgramHeaders(const ELFO *Obj) {
4299   unsigned Bias = ELFT::Is64Bits ? 8 : 0;
4300   const Elf_Ehdr *Header = Obj->getHeader();
4301   Field Fields[8] = {2,         17,        26,        37 + Bias,
4302                      48 + Bias, 56 + Bias, 64 + Bias, 68 + Bias};
4303   OS << "\nElf file type is "
4304      << printEnum(Header->e_type, makeArrayRef(ElfObjectFileType)) << "\n"
4305      << "Entry point " << format_hex(Header->e_entry, 3) << "\n"
4306      << "There are " << Header->e_phnum << " program headers,"
4307      << " starting at offset " << Header->e_phoff << "\n\n"
4308      << "Program Headers:\n";
4309   if (ELFT::Is64Bits)
4310     OS << "  Type           Offset   VirtAddr           PhysAddr         "
4311        << "  FileSiz  MemSiz   Flg Align\n";
4312   else
4313     OS << "  Type           Offset   VirtAddr   PhysAddr   FileSiz "
4314        << "MemSiz  Flg Align\n";
4315 
4316   unsigned Width = ELFT::Is64Bits ? 18 : 10;
4317   unsigned SizeWidth = ELFT::Is64Bits ? 8 : 7;
4318   for (const auto &Phdr :
4319        unwrapOrError(this->FileName, Obj->program_headers())) {
4320     Fields[0].Str = getElfPtType(Header->e_machine, Phdr.p_type);
4321     Fields[1].Str = to_string(format_hex(Phdr.p_offset, 8));
4322     Fields[2].Str = to_string(format_hex(Phdr.p_vaddr, Width));
4323     Fields[3].Str = to_string(format_hex(Phdr.p_paddr, Width));
4324     Fields[4].Str = to_string(format_hex(Phdr.p_filesz, SizeWidth));
4325     Fields[5].Str = to_string(format_hex(Phdr.p_memsz, SizeWidth));
4326     Fields[6].Str = printPhdrFlags(Phdr.p_flags);
4327     Fields[7].Str = to_string(format_hex(Phdr.p_align, 1));
4328     for (auto Field : Fields)
4329       printField(Field);
4330     if (Phdr.p_type == ELF::PT_INTERP) {
4331       OS << "\n";
4332       auto ReportBadInterp = [&](const Twine &Msg) {
4333         reportWarning(
4334             createError("unable to read program interpreter name at offset 0x" +
4335                         Twine::utohexstr(Phdr.p_offset) + ": " + Msg),
4336             this->FileName);
4337       };
4338 
4339       if (Phdr.p_offset >= Obj->getBufSize()) {
4340         ReportBadInterp("it goes past the end of the file (0x" +
4341                         Twine::utohexstr(Obj->getBufSize()) + ")");
4342         continue;
4343       }
4344 
4345       const char *Data =
4346           reinterpret_cast<const char *>(Obj->base()) + Phdr.p_offset;
4347       size_t MaxSize = Obj->getBufSize() - Phdr.p_offset;
4348       size_t Len = strnlen(Data, MaxSize);
4349       if (Len == MaxSize) {
4350         ReportBadInterp("it is not null-terminated");
4351         continue;
4352       }
4353 
4354       OS << "      [Requesting program interpreter: ";
4355       OS << StringRef(Data, Len) << "]";
4356     }
4357     OS << "\n";
4358   }
4359 }
4360 
4361 template <class ELFT>
4362 void GNUStyle<ELFT>::printSectionMapping(const ELFO *Obj) {
4363   OS << "\n Section to Segment mapping:\n  Segment Sections...\n";
4364   DenseSet<const Elf_Shdr *> BelongsToSegment;
4365   int Phnum = 0;
4366   for (const Elf_Phdr &Phdr :
4367        unwrapOrError(this->FileName, Obj->program_headers())) {
4368     std::string Sections;
4369     OS << format("   %2.2d     ", Phnum++);
4370     // Check if each section is in a segment and then print mapping.
4371     for (const Elf_Shdr &Sec : cantFail(Obj->sections())) {
4372       if (Sec.sh_type == ELF::SHT_NULL)
4373         continue;
4374 
4375       // readelf additionally makes sure it does not print zero sized sections
4376       // at end of segments and for PT_DYNAMIC both start and end of section
4377       // .tbss must only be shown in PT_TLS section.
4378       if (checkTLSSections<ELFT>(Phdr, Sec) && checkOffsets<ELFT>(Phdr, Sec) &&
4379           checkVMA<ELFT>(Phdr, Sec) && checkPTDynamic<ELFT>(Phdr, Sec)) {
4380         Sections +=
4381             unwrapOrError(this->FileName, Obj->getSectionName(&Sec)).str() +
4382             " ";
4383         BelongsToSegment.insert(&Sec);
4384       }
4385     }
4386     OS << Sections << "\n";
4387     OS.flush();
4388   }
4389 
4390   // Display sections that do not belong to a segment.
4391   std::string Sections;
4392   for (const Elf_Shdr &Sec : cantFail(Obj->sections())) {
4393     if (BelongsToSegment.find(&Sec) == BelongsToSegment.end())
4394       Sections +=
4395           unwrapOrError(this->FileName, Obj->getSectionName(&Sec)).str() + ' ';
4396   }
4397   if (!Sections.empty()) {
4398     OS << "   None  " << Sections << '\n';
4399     OS.flush();
4400   }
4401 }
4402 
4403 namespace {
4404 template <class ELFT> struct RelSymbol {
4405   const typename ELFT::Sym *Sym;
4406   std::string Name;
4407 };
4408 
4409 template <class ELFT>
4410 RelSymbol<ELFT> getSymbolForReloc(const ELFFile<ELFT> *Obj, StringRef FileName,
4411                                   const ELFDumper<ELFT> *Dumper,
4412                                   const typename ELFT::Rela &Reloc) {
4413   uint32_t SymIndex = Reloc.getSymbol(Obj->isMips64EL());
4414   auto WarnAndReturn = [&](const typename ELFT::Sym *Sym,
4415                            const Twine &Reason) -> RelSymbol<ELFT> {
4416     reportWarning(
4417         createError("unable to get name of the dynamic symbol with index " +
4418                     Twine(SymIndex) + ": " + Reason),
4419         FileName);
4420     return {Sym, "<corrupt>"};
4421   };
4422 
4423   ArrayRef<typename ELFT::Sym> Symbols = Dumper->dynamic_symbols();
4424   const typename ELFT::Sym *FirstSym = Symbols.begin();
4425   if (!FirstSym)
4426     return WarnAndReturn(nullptr, "no dynamic symbol table found");
4427 
4428   // We might have an object without a section header. In this case the size of
4429   // Symbols is zero, because there is no way to know the size of the dynamic
4430   // table. We should allow this case and not print a warning.
4431   if (!Symbols.empty() && SymIndex >= Symbols.size())
4432     return WarnAndReturn(
4433         nullptr,
4434         "index is greater than or equal to the number of dynamic symbols (" +
4435             Twine(Symbols.size()) + ")");
4436 
4437   const typename ELFT::Sym *Sym = FirstSym + SymIndex;
4438   Expected<StringRef> ErrOrName = Sym->getName(Dumper->getDynamicStringTable());
4439   if (!ErrOrName)
4440     return WarnAndReturn(Sym, toString(ErrOrName.takeError()));
4441 
4442   return {Sym == FirstSym ? nullptr : Sym, maybeDemangle(*ErrOrName)};
4443 }
4444 } // namespace
4445 
4446 template <class ELFT>
4447 void GNUStyle<ELFT>::printDynamicRelocation(const ELFO *Obj, Elf_Rela R,
4448                                             bool IsRela) {
4449   RelSymbol<ELFT> S = getSymbolForReloc(Obj, this->FileName, this->dumper(), R);
4450   printRelocation(Obj, S.Sym, S.Name, R, IsRela);
4451 }
4452 
4453 template <class ELFT>
4454 static size_t getMaxDynamicTagSize(const ELFFile<ELFT> *Obj,
4455                                    typename ELFT::DynRange Tags) {
4456   size_t Max = 0;
4457   for (const typename ELFT::Dyn &Dyn : Tags)
4458     Max = std::max(Max, Obj->getDynamicTagAsString(Dyn.d_tag).size());
4459   return Max;
4460 }
4461 
4462 template <class ELFT> void GNUStyle<ELFT>::printDynamic(const ELFO *Obj) {
4463   Elf_Dyn_Range Table = this->dumper()->dynamic_table();
4464   if (Table.empty())
4465     return;
4466 
4467   const DynRegionInfo &DynamicTableRegion =
4468       this->dumper()->getDynamicTableRegion();
4469 
4470   OS << "Dynamic section at offset "
4471      << format_hex(reinterpret_cast<const uint8_t *>(DynamicTableRegion.Addr) -
4472                        Obj->base(),
4473                    1)
4474      << " contains " << Table.size() << " entries:\n";
4475 
4476   // The type name is surrounded with round brackets, hence add 2.
4477   size_t MaxTagSize = getMaxDynamicTagSize(Obj, Table) + 2;
4478   // The "Name/Value" column should be indented from the "Type" column by N
4479   // spaces, where N = MaxTagSize - length of "Type" (4) + trailing
4480   // space (1) = 3.
4481   OS << "  Tag" + std::string(ELFT::Is64Bits ? 16 : 8, ' ') + "Type"
4482      << std::string(MaxTagSize - 3, ' ') << "Name/Value\n";
4483 
4484   std::string ValueFmt = " %-" + std::to_string(MaxTagSize) + "s ";
4485   for (auto Entry : Table) {
4486     uintX_t Tag = Entry.getTag();
4487     std::string Type =
4488         std::string("(") + Obj->getDynamicTagAsString(Tag).c_str() + ")";
4489     std::string Value = this->dumper()->getDynamicEntry(Tag, Entry.getVal());
4490     OS << "  " << format_hex(Tag, ELFT::Is64Bits ? 18 : 10)
4491        << format(ValueFmt.c_str(), Type.c_str()) << Value << "\n";
4492   }
4493 }
4494 
4495 template <class ELFT>
4496 void GNUStyle<ELFT>::printDynamicRelocations(const ELFO *Obj) {
4497   const DynRegionInfo &DynRelRegion = this->dumper()->getDynRelRegion();
4498   const DynRegionInfo &DynRelaRegion = this->dumper()->getDynRelaRegion();
4499   const DynRegionInfo &DynRelrRegion = this->dumper()->getDynRelrRegion();
4500   const DynRegionInfo &DynPLTRelRegion = this->dumper()->getDynPLTRelRegion();
4501   if (DynRelaRegion.Size > 0) {
4502     OS << "\n'RELA' relocation section at offset "
4503        << format_hex(reinterpret_cast<const uint8_t *>(DynRelaRegion.Addr) -
4504                          Obj->base(),
4505                      1)
4506        << " contains " << DynRelaRegion.Size << " bytes:\n";
4507     printRelocHeader(ELF::SHT_RELA);
4508     for (const Elf_Rela &Rela : this->dumper()->dyn_relas())
4509       printDynamicRelocation(Obj, Rela, true);
4510   }
4511   if (DynRelRegion.Size > 0) {
4512     OS << "\n'REL' relocation section at offset "
4513        << format_hex(reinterpret_cast<const uint8_t *>(DynRelRegion.Addr) -
4514                          Obj->base(),
4515                      1)
4516        << " contains " << DynRelRegion.Size << " bytes:\n";
4517     printRelocHeader(ELF::SHT_REL);
4518     for (const Elf_Rel &Rel : this->dumper()->dyn_rels()) {
4519       Elf_Rela Rela;
4520       Rela.r_offset = Rel.r_offset;
4521       Rela.r_info = Rel.r_info;
4522       Rela.r_addend = 0;
4523       printDynamicRelocation(Obj, Rela, false);
4524     }
4525   }
4526   if (DynRelrRegion.Size > 0) {
4527     OS << "\n'RELR' relocation section at offset "
4528        << format_hex(reinterpret_cast<const uint8_t *>(DynRelrRegion.Addr) -
4529                          Obj->base(),
4530                      1)
4531        << " contains " << DynRelrRegion.Size << " bytes:\n";
4532     printRelocHeader(ELF::SHT_REL);
4533     Elf_Relr_Range Relrs = this->dumper()->dyn_relrs();
4534     std::vector<Elf_Rela> RelrRelas =
4535         unwrapOrError(this->FileName, Obj->decode_relrs(Relrs));
4536     for (const Elf_Rela &Rela : RelrRelas) {
4537       printDynamicRelocation(Obj, Rela, false);
4538     }
4539   }
4540   if (DynPLTRelRegion.Size) {
4541     OS << "\n'PLT' relocation section at offset "
4542        << format_hex(reinterpret_cast<const uint8_t *>(DynPLTRelRegion.Addr) -
4543                          Obj->base(),
4544                      1)
4545        << " contains " << DynPLTRelRegion.Size << " bytes:\n";
4546   }
4547   if (DynPLTRelRegion.EntSize == sizeof(Elf_Rela)) {
4548     printRelocHeader(ELF::SHT_RELA);
4549     for (const Elf_Rela &Rela : DynPLTRelRegion.getAsArrayRef<Elf_Rela>())
4550       printDynamicRelocation(Obj, Rela, true);
4551   } else {
4552     printRelocHeader(ELF::SHT_REL);
4553     for (const Elf_Rel &Rel : DynPLTRelRegion.getAsArrayRef<Elf_Rel>()) {
4554       Elf_Rela Rela;
4555       Rela.r_offset = Rel.r_offset;
4556       Rela.r_info = Rel.r_info;
4557       Rela.r_addend = 0;
4558       printDynamicRelocation(Obj, Rela, false);
4559     }
4560   }
4561 }
4562 
4563 template <class ELFT>
4564 void GNUStyle<ELFT>::printGNUVersionSectionProlog(
4565     const ELFFile<ELFT> *Obj, const typename ELFT::Shdr *Sec,
4566     const Twine &Label, unsigned EntriesNum) {
4567   StringRef SecName = unwrapOrError(this->FileName, Obj->getSectionName(Sec));
4568   OS << Label << " section '" << SecName << "' "
4569      << "contains " << EntriesNum << " entries:\n";
4570 
4571   unsigned SecNdx = Sec - &cantFail(Obj->sections()).front();
4572   StringRef SymTabName = "<corrupt>";
4573 
4574   Expected<const typename ELFT::Shdr *> SymTabOrErr =
4575       Obj->getSection(Sec->sh_link);
4576   if (SymTabOrErr)
4577     SymTabName =
4578         unwrapOrError(this->FileName, Obj->getSectionName(*SymTabOrErr));
4579   else
4580     this->reportUniqueWarning(
4581         createError("invalid section linked to " +
4582                     object::getELFSectionTypeName(Obj->getHeader()->e_machine,
4583                                                   Sec->sh_type) +
4584                     " section with index " + Twine(SecNdx) + ": " +
4585                     toString(SymTabOrErr.takeError())));
4586 
4587   OS << " Addr: " << format_hex_no_prefix(Sec->sh_addr, 16)
4588      << "  Offset: " << format_hex(Sec->sh_offset, 8)
4589      << "  Link: " << Sec->sh_link << " (" << SymTabName << ")\n";
4590 }
4591 
4592 template <class ELFT>
4593 void GNUStyle<ELFT>::printVersionSymbolSection(const ELFFile<ELFT> *Obj,
4594                                                const Elf_Shdr *Sec) {
4595   if (!Sec)
4596     return;
4597 
4598   printGNUVersionSectionProlog(Obj, Sec, "Version symbols",
4599                                Sec->sh_size / sizeof(Elf_Versym));
4600   Expected<ArrayRef<Elf_Versym>> VerTableOrErr =
4601       this->dumper()->getVersionTable(Sec, /*SymTab=*/nullptr,
4602                                       /*StrTab=*/nullptr);
4603   if (!VerTableOrErr) {
4604     this->reportUniqueWarning(VerTableOrErr.takeError());
4605     return;
4606   }
4607 
4608   ArrayRef<Elf_Versym> VerTable = *VerTableOrErr;
4609   std::vector<StringRef> Versions;
4610   for (size_t I = 0, E = VerTable.size(); I < E; ++I) {
4611     unsigned Ndx = VerTable[I].vs_index;
4612     if (Ndx == VER_NDX_LOCAL || Ndx == VER_NDX_GLOBAL) {
4613       Versions.emplace_back(Ndx == VER_NDX_LOCAL ? "*local*" : "*global*");
4614       continue;
4615     }
4616 
4617     bool IsDefault;
4618     Expected<StringRef> NameOrErr =
4619         this->dumper()->getSymbolVersionByIndex(Ndx, IsDefault);
4620     if (!NameOrErr) {
4621       if (!NameOrErr) {
4622         unsigned SecNdx = Sec - &cantFail(Obj->sections()).front();
4623         this->reportUniqueWarning(createError(
4624             "unable to get a version for entry " + Twine(I) +
4625             " of SHT_GNU_versym section with index " + Twine(SecNdx) + ": " +
4626             toString(NameOrErr.takeError())));
4627       }
4628       Versions.emplace_back("<corrupt>");
4629       continue;
4630     }
4631     Versions.emplace_back(*NameOrErr);
4632   }
4633 
4634   // readelf prints 4 entries per line.
4635   uint64_t Entries = VerTable.size();
4636   for (uint64_t VersymRow = 0; VersymRow < Entries; VersymRow += 4) {
4637     OS << "  " << format_hex_no_prefix(VersymRow, 3) << ":";
4638     for (uint64_t I = 0; (I < 4) && (I + VersymRow) < Entries; ++I) {
4639       unsigned Ndx = VerTable[VersymRow + I].vs_index;
4640       OS << format("%4x%c", Ndx & VERSYM_VERSION,
4641                    Ndx & VERSYM_HIDDEN ? 'h' : ' ');
4642       OS << left_justify("(" + std::string(Versions[VersymRow + I]) + ")", 13);
4643     }
4644     OS << '\n';
4645   }
4646   OS << '\n';
4647 }
4648 
4649 static std::string versionFlagToString(unsigned Flags) {
4650   if (Flags == 0)
4651     return "none";
4652 
4653   std::string Ret;
4654   auto AddFlag = [&Ret, &Flags](unsigned Flag, StringRef Name) {
4655     if (!(Flags & Flag))
4656       return;
4657     if (!Ret.empty())
4658       Ret += " | ";
4659     Ret += Name;
4660     Flags &= ~Flag;
4661   };
4662 
4663   AddFlag(VER_FLG_BASE, "BASE");
4664   AddFlag(VER_FLG_WEAK, "WEAK");
4665   AddFlag(VER_FLG_INFO, "INFO");
4666   AddFlag(~0, "<unknown>");
4667   return Ret;
4668 }
4669 
4670 template <class ELFT>
4671 void GNUStyle<ELFT>::printVersionDefinitionSection(const ELFFile<ELFT> *Obj,
4672                                                    const Elf_Shdr *Sec) {
4673   if (!Sec)
4674     return;
4675 
4676   printGNUVersionSectionProlog(Obj, Sec, "Version definition", Sec->sh_info);
4677 
4678   Expected<std::vector<VerDef>> V = this->dumper()->getVersionDefinitions(Sec);
4679   if (!V) {
4680     this->reportUniqueWarning(V.takeError());
4681     return;
4682   }
4683 
4684   for (const VerDef &Def : *V) {
4685     OS << format("  0x%04x: Rev: %u  Flags: %s  Index: %u  Cnt: %u  Name: %s\n",
4686                  Def.Offset, Def.Version,
4687                  versionFlagToString(Def.Flags).c_str(), Def.Ndx, Def.Cnt,
4688                  Def.Name.data());
4689     unsigned I = 0;
4690     for (const VerdAux &Aux : Def.AuxV)
4691       OS << format("  0x%04x: Parent %u: %s\n", Aux.Offset, ++I,
4692                    Aux.Name.data());
4693   }
4694 
4695   OS << '\n';
4696 }
4697 
4698 template <class ELFT>
4699 void GNUStyle<ELFT>::printVersionDependencySection(const ELFFile<ELFT> *Obj,
4700                                                    const Elf_Shdr *Sec) {
4701   if (!Sec)
4702     return;
4703 
4704   unsigned VerneedNum = Sec->sh_info;
4705   printGNUVersionSectionProlog(Obj, Sec, "Version needs", VerneedNum);
4706 
4707   Expected<std::vector<VerNeed>> V =
4708       this->dumper()->getVersionDependencies(Sec);
4709   if (!V) {
4710     this->reportUniqueWarning(V.takeError());
4711     return;
4712   }
4713 
4714   for (const VerNeed &VN : *V) {
4715     OS << format("  0x%04x: Version: %u  File: %s  Cnt: %u\n", VN.Offset,
4716                  VN.Version, VN.File.data(), VN.Cnt);
4717     for (const VernAux &Aux : VN.AuxV)
4718       OS << format("  0x%04x:   Name: %s  Flags: %s  Version: %u\n", Aux.Offset,
4719                    Aux.Name.data(), versionFlagToString(Aux.Flags).c_str(),
4720                    Aux.Other);
4721   }
4722   OS << '\n';
4723 }
4724 
4725 template <class ELFT>
4726 void GNUStyle<ELFT>::printHashHistogram(const Elf_Hash &HashTable) {
4727   size_t NBucket = HashTable.nbucket;
4728   size_t NChain = HashTable.nchain;
4729   ArrayRef<Elf_Word> Buckets = HashTable.buckets();
4730   ArrayRef<Elf_Word> Chains = HashTable.chains();
4731   size_t TotalSyms = 0;
4732   // If hash table is correct, we have at least chains with 0 length
4733   size_t MaxChain = 1;
4734   size_t CumulativeNonZero = 0;
4735 
4736   if (NChain == 0 || NBucket == 0)
4737     return;
4738 
4739   std::vector<size_t> ChainLen(NBucket, 0);
4740   // Go over all buckets and and note chain lengths of each bucket (total
4741   // unique chain lengths).
4742   for (size_t B = 0; B < NBucket; B++) {
4743     std::vector<bool> Visited(NChain);
4744     for (size_t C = Buckets[B]; C < NChain; C = Chains[C]) {
4745       if (C == ELF::STN_UNDEF)
4746         break;
4747       if (Visited[C]) {
4748         reportWarning(createError(".hash section is invalid: bucket " +
4749                                   Twine(C) +
4750                                   ": a cycle was detected in the linked chain"),
4751                       this->FileName);
4752         break;
4753       }
4754       Visited[C] = true;
4755       if (MaxChain <= ++ChainLen[B])
4756         MaxChain++;
4757     }
4758     TotalSyms += ChainLen[B];
4759   }
4760 
4761   if (!TotalSyms)
4762     return;
4763 
4764   std::vector<size_t> Count(MaxChain, 0);
4765   // Count how long is the chain for each bucket
4766   for (size_t B = 0; B < NBucket; B++)
4767     ++Count[ChainLen[B]];
4768   // Print Number of buckets with each chain lengths and their cumulative
4769   // coverage of the symbols
4770   OS << "Histogram for bucket list length (total of " << NBucket
4771      << " buckets)\n"
4772      << " Length  Number     % of total  Coverage\n";
4773   for (size_t I = 0; I < MaxChain; I++) {
4774     CumulativeNonZero += Count[I] * I;
4775     OS << format("%7lu  %-10lu (%5.1f%%)     %5.1f%%\n", I, Count[I],
4776                  (Count[I] * 100.0) / NBucket,
4777                  (CumulativeNonZero * 100.0) / TotalSyms);
4778   }
4779 }
4780 
4781 template <class ELFT>
4782 void GNUStyle<ELFT>::printGnuHashHistogram(const Elf_GnuHash &GnuHashTable) {
4783   Expected<ArrayRef<Elf_Word>> ChainsOrErr = getGnuHashTableChains<ELFT>(
4784       this->dumper()->getDynSymRegion(), &GnuHashTable);
4785   if (!ChainsOrErr) {
4786     this->reportUniqueWarning(
4787         createError("unable to print the GNU hash table histogram: " +
4788                     toString(ChainsOrErr.takeError())));
4789     return;
4790   }
4791 
4792   ArrayRef<Elf_Word> Chains = *ChainsOrErr;
4793   size_t Symndx = GnuHashTable.symndx;
4794   size_t TotalSyms = 0;
4795   size_t MaxChain = 1;
4796   size_t CumulativeNonZero = 0;
4797 
4798   size_t NBucket = GnuHashTable.nbuckets;
4799   if (Chains.empty() || NBucket == 0)
4800     return;
4801 
4802   ArrayRef<Elf_Word> Buckets = GnuHashTable.buckets();
4803   std::vector<size_t> ChainLen(NBucket, 0);
4804   for (size_t B = 0; B < NBucket; B++) {
4805     if (!Buckets[B])
4806       continue;
4807     size_t Len = 1;
4808     for (size_t C = Buckets[B] - Symndx;
4809          C < Chains.size() && (Chains[C] & 1) == 0; C++)
4810       if (MaxChain < ++Len)
4811         MaxChain++;
4812     ChainLen[B] = Len;
4813     TotalSyms += Len;
4814   }
4815   MaxChain++;
4816 
4817   if (!TotalSyms)
4818     return;
4819 
4820   std::vector<size_t> Count(MaxChain, 0);
4821   for (size_t B = 0; B < NBucket; B++)
4822     ++Count[ChainLen[B]];
4823   // Print Number of buckets with each chain lengths and their cumulative
4824   // coverage of the symbols
4825   OS << "Histogram for `.gnu.hash' bucket list length (total of " << NBucket
4826      << " buckets)\n"
4827      << " Length  Number     % of total  Coverage\n";
4828   for (size_t I = 0; I < MaxChain; I++) {
4829     CumulativeNonZero += Count[I] * I;
4830     OS << format("%7lu  %-10lu (%5.1f%%)     %5.1f%%\n", I, Count[I],
4831                  (Count[I] * 100.0) / NBucket,
4832                  (CumulativeNonZero * 100.0) / TotalSyms);
4833   }
4834 }
4835 
4836 // Hash histogram shows statistics of how efficient the hash was for the
4837 // dynamic symbol table. The table shows the number of hash buckets for
4838 // different lengths of chains as an absolute number and percentage of the total
4839 // buckets, and the cumulative coverage of symbols for each set of buckets.
4840 template <class ELFT>
4841 void GNUStyle<ELFT>::printHashHistograms(const ELFFile<ELFT> *Obj) {
4842   // Print histogram for the .hash section.
4843   if (const Elf_Hash *HashTable = this->dumper()->getHashTable()) {
4844     if (Error E = checkHashTable<ELFT>(Obj, HashTable))
4845       this->reportUniqueWarning(std::move(E));
4846     else
4847       printHashHistogram(*HashTable);
4848   }
4849 
4850   // Print histogram for the .gnu.hash section.
4851   if (const Elf_GnuHash *GnuHashTable = this->dumper()->getGnuHashTable()) {
4852     if (Error E = checkGNUHashTable<ELFT>(Obj, GnuHashTable))
4853       this->reportUniqueWarning(std::move(E));
4854     else
4855       printGnuHashHistogram(*GnuHashTable);
4856   }
4857 }
4858 
4859 template <class ELFT>
4860 void GNUStyle<ELFT>::printCGProfile(const ELFFile<ELFT> *Obj) {
4861   OS << "GNUStyle::printCGProfile not implemented\n";
4862 }
4863 
4864 template <class ELFT>
4865 void GNUStyle<ELFT>::printAddrsig(const ELFFile<ELFT> *Obj) {
4866   reportError(createError("--addrsig: not implemented"), this->FileName);
4867 }
4868 
4869 static StringRef getGenericNoteTypeName(const uint32_t NT) {
4870   static const struct {
4871     uint32_t ID;
4872     const char *Name;
4873   } Notes[] = {
4874       {ELF::NT_VERSION, "NT_VERSION (version)"},
4875       {ELF::NT_ARCH, "NT_ARCH (architecture)"},
4876       {ELF::NT_GNU_BUILD_ATTRIBUTE_OPEN, "OPEN"},
4877       {ELF::NT_GNU_BUILD_ATTRIBUTE_FUNC, "func"},
4878   };
4879 
4880   for (const auto &Note : Notes)
4881     if (Note.ID == NT)
4882       return Note.Name;
4883 
4884   return "";
4885 }
4886 
4887 static StringRef getCoreNoteTypeName(const uint32_t NT) {
4888   static const struct {
4889     uint32_t ID;
4890     const char *Name;
4891   } Notes[] = {
4892       {ELF::NT_PRSTATUS, "NT_PRSTATUS (prstatus structure)"},
4893       {ELF::NT_FPREGSET, "NT_FPREGSET (floating point registers)"},
4894       {ELF::NT_PRPSINFO, "NT_PRPSINFO (prpsinfo structure)"},
4895       {ELF::NT_TASKSTRUCT, "NT_TASKSTRUCT (task structure)"},
4896       {ELF::NT_AUXV, "NT_AUXV (auxiliary vector)"},
4897       {ELF::NT_PSTATUS, "NT_PSTATUS (pstatus structure)"},
4898       {ELF::NT_FPREGS, "NT_FPREGS (floating point registers)"},
4899       {ELF::NT_PSINFO, "NT_PSINFO (psinfo structure)"},
4900       {ELF::NT_LWPSTATUS, "NT_LWPSTATUS (lwpstatus_t structure)"},
4901       {ELF::NT_LWPSINFO, "NT_LWPSINFO (lwpsinfo_t structure)"},
4902       {ELF::NT_WIN32PSTATUS, "NT_WIN32PSTATUS (win32_pstatus structure)"},
4903 
4904       {ELF::NT_PPC_VMX, "NT_PPC_VMX (ppc Altivec registers)"},
4905       {ELF::NT_PPC_VSX, "NT_PPC_VSX (ppc VSX registers)"},
4906       {ELF::NT_PPC_TAR, "NT_PPC_TAR (ppc TAR register)"},
4907       {ELF::NT_PPC_PPR, "NT_PPC_PPR (ppc PPR register)"},
4908       {ELF::NT_PPC_DSCR, "NT_PPC_DSCR (ppc DSCR register)"},
4909       {ELF::NT_PPC_EBB, "NT_PPC_EBB (ppc EBB registers)"},
4910       {ELF::NT_PPC_PMU, "NT_PPC_PMU (ppc PMU registers)"},
4911       {ELF::NT_PPC_TM_CGPR, "NT_PPC_TM_CGPR (ppc checkpointed GPR registers)"},
4912       {ELF::NT_PPC_TM_CFPR,
4913        "NT_PPC_TM_CFPR (ppc checkpointed floating point registers)"},
4914       {ELF::NT_PPC_TM_CVMX,
4915        "NT_PPC_TM_CVMX (ppc checkpointed Altivec registers)"},
4916       {ELF::NT_PPC_TM_CVSX, "NT_PPC_TM_CVSX (ppc checkpointed VSX registers)"},
4917       {ELF::NT_PPC_TM_SPR, "NT_PPC_TM_SPR (ppc TM special purpose registers)"},
4918       {ELF::NT_PPC_TM_CTAR, "NT_PPC_TM_CTAR (ppc checkpointed TAR register)"},
4919       {ELF::NT_PPC_TM_CPPR, "NT_PPC_TM_CPPR (ppc checkpointed PPR register)"},
4920       {ELF::NT_PPC_TM_CDSCR,
4921        "NT_PPC_TM_CDSCR (ppc checkpointed DSCR register)"},
4922 
4923       {ELF::NT_386_TLS, "NT_386_TLS (x86 TLS information)"},
4924       {ELF::NT_386_IOPERM, "NT_386_IOPERM (x86 I/O permissions)"},
4925       {ELF::NT_X86_XSTATE, "NT_X86_XSTATE (x86 XSAVE extended state)"},
4926 
4927       {ELF::NT_S390_HIGH_GPRS,
4928        "NT_S390_HIGH_GPRS (s390 upper register halves)"},
4929       {ELF::NT_S390_TIMER, "NT_S390_TIMER (s390 timer register)"},
4930       {ELF::NT_S390_TODCMP, "NT_S390_TODCMP (s390 TOD comparator register)"},
4931       {ELF::NT_S390_TODPREG,
4932        "NT_S390_TODPREG (s390 TOD programmable register)"},
4933       {ELF::NT_S390_CTRS, "NT_S390_CTRS (s390 control registers)"},
4934       {ELF::NT_S390_PREFIX, "NT_S390_PREFIX (s390 prefix register)"},
4935       {ELF::NT_S390_LAST_BREAK,
4936        "NT_S390_LAST_BREAK (s390 last breaking event address)"},
4937       {ELF::NT_S390_SYSTEM_CALL,
4938        "NT_S390_SYSTEM_CALL (s390 system call restart data)"},
4939       {ELF::NT_S390_TDB, "NT_S390_TDB (s390 transaction diagnostic block)"},
4940       {ELF::NT_S390_VXRS_LOW,
4941        "NT_S390_VXRS_LOW (s390 vector registers 0-15 upper half)"},
4942       {ELF::NT_S390_VXRS_HIGH,
4943        "NT_S390_VXRS_HIGH (s390 vector registers 16-31)"},
4944       {ELF::NT_S390_GS_CB, "NT_S390_GS_CB (s390 guarded-storage registers)"},
4945       {ELF::NT_S390_GS_BC,
4946        "NT_S390_GS_BC (s390 guarded-storage broadcast control)"},
4947 
4948       {ELF::NT_ARM_VFP, "NT_ARM_VFP (arm VFP registers)"},
4949       {ELF::NT_ARM_TLS, "NT_ARM_TLS (AArch TLS registers)"},
4950       {ELF::NT_ARM_HW_BREAK,
4951        "NT_ARM_HW_BREAK (AArch hardware breakpoint registers)"},
4952       {ELF::NT_ARM_HW_WATCH,
4953        "NT_ARM_HW_WATCH (AArch hardware watchpoint registers)"},
4954 
4955       {ELF::NT_FILE, "NT_FILE (mapped files)"},
4956       {ELF::NT_PRXFPREG, "NT_PRXFPREG (user_xfpregs structure)"},
4957       {ELF::NT_SIGINFO, "NT_SIGINFO (siginfo_t data)"},
4958   };
4959 
4960   for (const auto &Note : Notes)
4961     if (Note.ID == NT)
4962       return Note.Name;
4963 
4964   return "";
4965 }
4966 
4967 static std::string getGNUNoteTypeName(const uint32_t NT) {
4968   static const struct {
4969     uint32_t ID;
4970     const char *Name;
4971   } Notes[] = {
4972       {ELF::NT_GNU_ABI_TAG, "NT_GNU_ABI_TAG (ABI version tag)"},
4973       {ELF::NT_GNU_HWCAP, "NT_GNU_HWCAP (DSO-supplied software HWCAP info)"},
4974       {ELF::NT_GNU_BUILD_ID, "NT_GNU_BUILD_ID (unique build ID bitstring)"},
4975       {ELF::NT_GNU_GOLD_VERSION, "NT_GNU_GOLD_VERSION (gold version)"},
4976       {ELF::NT_GNU_PROPERTY_TYPE_0, "NT_GNU_PROPERTY_TYPE_0 (property note)"},
4977   };
4978 
4979   for (const auto &Note : Notes)
4980     if (Note.ID == NT)
4981       return std::string(Note.Name);
4982 
4983   std::string string;
4984   raw_string_ostream OS(string);
4985   OS << format("Unknown note type (0x%08x)", NT);
4986   return OS.str();
4987 }
4988 
4989 static std::string getFreeBSDNoteTypeName(const uint32_t NT) {
4990   static const struct {
4991     uint32_t ID;
4992     const char *Name;
4993   } Notes[] = {
4994       {ELF::NT_FREEBSD_THRMISC, "NT_THRMISC (thrmisc structure)"},
4995       {ELF::NT_FREEBSD_PROCSTAT_PROC, "NT_PROCSTAT_PROC (proc data)"},
4996       {ELF::NT_FREEBSD_PROCSTAT_FILES, "NT_PROCSTAT_FILES (files data)"},
4997       {ELF::NT_FREEBSD_PROCSTAT_VMMAP, "NT_PROCSTAT_VMMAP (vmmap data)"},
4998       {ELF::NT_FREEBSD_PROCSTAT_GROUPS, "NT_PROCSTAT_GROUPS (groups data)"},
4999       {ELF::NT_FREEBSD_PROCSTAT_UMASK, "NT_PROCSTAT_UMASK (umask data)"},
5000       {ELF::NT_FREEBSD_PROCSTAT_RLIMIT, "NT_PROCSTAT_RLIMIT (rlimit data)"},
5001       {ELF::NT_FREEBSD_PROCSTAT_OSREL, "NT_PROCSTAT_OSREL (osreldate data)"},
5002       {ELF::NT_FREEBSD_PROCSTAT_PSSTRINGS,
5003        "NT_PROCSTAT_PSSTRINGS (ps_strings data)"},
5004       {ELF::NT_FREEBSD_PROCSTAT_AUXV, "NT_PROCSTAT_AUXV (auxv data)"},
5005   };
5006 
5007   for (const auto &Note : Notes)
5008     if (Note.ID == NT)
5009       return std::string(Note.Name);
5010 
5011   std::string string;
5012   raw_string_ostream OS(string);
5013   OS << format("Unknown note type (0x%08x)", NT);
5014   return OS.str();
5015 }
5016 
5017 static std::string getAMDNoteTypeName(const uint32_t NT) {
5018   static const struct {
5019     uint32_t ID;
5020     const char *Name;
5021   } Notes[] = {{ELF::NT_AMD_AMDGPU_HSA_METADATA,
5022                 "NT_AMD_AMDGPU_HSA_METADATA (HSA Metadata)"},
5023                {ELF::NT_AMD_AMDGPU_ISA, "NT_AMD_AMDGPU_ISA (ISA Version)"},
5024                {ELF::NT_AMD_AMDGPU_PAL_METADATA,
5025                 "NT_AMD_AMDGPU_PAL_METADATA (PAL Metadata)"}};
5026 
5027   for (const auto &Note : Notes)
5028     if (Note.ID == NT)
5029       return std::string(Note.Name);
5030 
5031   std::string string;
5032   raw_string_ostream OS(string);
5033   OS << format("Unknown note type (0x%08x)", NT);
5034   return OS.str();
5035 }
5036 
5037 static std::string getAMDGPUNoteTypeName(const uint32_t NT) {
5038   if (NT == ELF::NT_AMDGPU_METADATA)
5039     return std::string("NT_AMDGPU_METADATA (AMDGPU Metadata)");
5040 
5041   std::string string;
5042   raw_string_ostream OS(string);
5043   OS << format("Unknown note type (0x%08x)", NT);
5044   return OS.str();
5045 }
5046 
5047 template <typename ELFT>
5048 static std::string getGNUProperty(uint32_t Type, uint32_t DataSize,
5049                                   ArrayRef<uint8_t> Data) {
5050   std::string str;
5051   raw_string_ostream OS(str);
5052   uint32_t PrData;
5053   auto DumpBit = [&](uint32_t Flag, StringRef Name) {
5054     if (PrData & Flag) {
5055       PrData &= ~Flag;
5056       OS << Name;
5057       if (PrData)
5058         OS << ", ";
5059     }
5060   };
5061 
5062   switch (Type) {
5063   default:
5064     OS << format("<application-specific type 0x%x>", Type);
5065     return OS.str();
5066   case GNU_PROPERTY_STACK_SIZE: {
5067     OS << "stack size: ";
5068     if (DataSize == sizeof(typename ELFT::uint))
5069       OS << formatv("{0:x}",
5070                     (uint64_t)(*(const typename ELFT::Addr *)Data.data()));
5071     else
5072       OS << format("<corrupt length: 0x%x>", DataSize);
5073     return OS.str();
5074   }
5075   case GNU_PROPERTY_NO_COPY_ON_PROTECTED:
5076     OS << "no copy on protected";
5077     if (DataSize)
5078       OS << format(" <corrupt length: 0x%x>", DataSize);
5079     return OS.str();
5080   case GNU_PROPERTY_AARCH64_FEATURE_1_AND:
5081   case GNU_PROPERTY_X86_FEATURE_1_AND:
5082     OS << ((Type == GNU_PROPERTY_AARCH64_FEATURE_1_AND) ? "aarch64 feature: "
5083                                                         : "x86 feature: ");
5084     if (DataSize != 4) {
5085       OS << format("<corrupt length: 0x%x>", DataSize);
5086       return OS.str();
5087     }
5088     PrData = support::endian::read32<ELFT::TargetEndianness>(Data.data());
5089     if (PrData == 0) {
5090       OS << "<None>";
5091       return OS.str();
5092     }
5093     if (Type == GNU_PROPERTY_AARCH64_FEATURE_1_AND) {
5094       DumpBit(GNU_PROPERTY_AARCH64_FEATURE_1_BTI, "BTI");
5095       DumpBit(GNU_PROPERTY_AARCH64_FEATURE_1_PAC, "PAC");
5096     } else {
5097       DumpBit(GNU_PROPERTY_X86_FEATURE_1_IBT, "IBT");
5098       DumpBit(GNU_PROPERTY_X86_FEATURE_1_SHSTK, "SHSTK");
5099     }
5100     if (PrData)
5101       OS << format("<unknown flags: 0x%x>", PrData);
5102     return OS.str();
5103   case GNU_PROPERTY_X86_ISA_1_NEEDED:
5104   case GNU_PROPERTY_X86_ISA_1_USED:
5105     OS << "x86 ISA "
5106        << (Type == GNU_PROPERTY_X86_ISA_1_NEEDED ? "needed: " : "used: ");
5107     if (DataSize != 4) {
5108       OS << format("<corrupt length: 0x%x>", DataSize);
5109       return OS.str();
5110     }
5111     PrData = support::endian::read32<ELFT::TargetEndianness>(Data.data());
5112     if (PrData == 0) {
5113       OS << "<None>";
5114       return OS.str();
5115     }
5116     DumpBit(GNU_PROPERTY_X86_ISA_1_CMOV, "CMOV");
5117     DumpBit(GNU_PROPERTY_X86_ISA_1_SSE, "SSE");
5118     DumpBit(GNU_PROPERTY_X86_ISA_1_SSE2, "SSE2");
5119     DumpBit(GNU_PROPERTY_X86_ISA_1_SSE3, "SSE3");
5120     DumpBit(GNU_PROPERTY_X86_ISA_1_SSSE3, "SSSE3");
5121     DumpBit(GNU_PROPERTY_X86_ISA_1_SSE4_1, "SSE4_1");
5122     DumpBit(GNU_PROPERTY_X86_ISA_1_SSE4_2, "SSE4_2");
5123     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX, "AVX");
5124     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX2, "AVX2");
5125     DumpBit(GNU_PROPERTY_X86_ISA_1_FMA, "FMA");
5126     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512F, "AVX512F");
5127     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512CD, "AVX512CD");
5128     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512ER, "AVX512ER");
5129     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512PF, "AVX512PF");
5130     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512VL, "AVX512VL");
5131     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512DQ, "AVX512DQ");
5132     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512BW, "AVX512BW");
5133     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512_4FMAPS, "AVX512_4FMAPS");
5134     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512_4VNNIW, "AVX512_4VNNIW");
5135     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512_BITALG, "AVX512_BITALG");
5136     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512_IFMA, "AVX512_IFMA");
5137     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512_VBMI, "AVX512_VBMI");
5138     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512_VBMI2, "AVX512_VBMI2");
5139     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512_VNNI, "AVX512_VNNI");
5140     if (PrData)
5141       OS << format("<unknown flags: 0x%x>", PrData);
5142     return OS.str();
5143     break;
5144   case GNU_PROPERTY_X86_FEATURE_2_NEEDED:
5145   case GNU_PROPERTY_X86_FEATURE_2_USED:
5146     OS << "x86 feature "
5147        << (Type == GNU_PROPERTY_X86_FEATURE_2_NEEDED ? "needed: " : "used: ");
5148     if (DataSize != 4) {
5149       OS << format("<corrupt length: 0x%x>", DataSize);
5150       return OS.str();
5151     }
5152     PrData = support::endian::read32<ELFT::TargetEndianness>(Data.data());
5153     if (PrData == 0) {
5154       OS << "<None>";
5155       return OS.str();
5156     }
5157     DumpBit(GNU_PROPERTY_X86_FEATURE_2_X86, "x86");
5158     DumpBit(GNU_PROPERTY_X86_FEATURE_2_X87, "x87");
5159     DumpBit(GNU_PROPERTY_X86_FEATURE_2_MMX, "MMX");
5160     DumpBit(GNU_PROPERTY_X86_FEATURE_2_XMM, "XMM");
5161     DumpBit(GNU_PROPERTY_X86_FEATURE_2_YMM, "YMM");
5162     DumpBit(GNU_PROPERTY_X86_FEATURE_2_ZMM, "ZMM");
5163     DumpBit(GNU_PROPERTY_X86_FEATURE_2_FXSR, "FXSR");
5164     DumpBit(GNU_PROPERTY_X86_FEATURE_2_XSAVE, "XSAVE");
5165     DumpBit(GNU_PROPERTY_X86_FEATURE_2_XSAVEOPT, "XSAVEOPT");
5166     DumpBit(GNU_PROPERTY_X86_FEATURE_2_XSAVEC, "XSAVEC");
5167     if (PrData)
5168       OS << format("<unknown flags: 0x%x>", PrData);
5169     return OS.str();
5170   }
5171 }
5172 
5173 template <typename ELFT>
5174 static SmallVector<std::string, 4> getGNUPropertyList(ArrayRef<uint8_t> Arr) {
5175   using Elf_Word = typename ELFT::Word;
5176 
5177   SmallVector<std::string, 4> Properties;
5178   while (Arr.size() >= 8) {
5179     uint32_t Type = *reinterpret_cast<const Elf_Word *>(Arr.data());
5180     uint32_t DataSize = *reinterpret_cast<const Elf_Word *>(Arr.data() + 4);
5181     Arr = Arr.drop_front(8);
5182 
5183     // Take padding size into account if present.
5184     uint64_t PaddedSize = alignTo(DataSize, sizeof(typename ELFT::uint));
5185     std::string str;
5186     raw_string_ostream OS(str);
5187     if (Arr.size() < PaddedSize) {
5188       OS << format("<corrupt type (0x%x) datasz: 0x%x>", Type, DataSize);
5189       Properties.push_back(OS.str());
5190       break;
5191     }
5192     Properties.push_back(
5193         getGNUProperty<ELFT>(Type, DataSize, Arr.take_front(PaddedSize)));
5194     Arr = Arr.drop_front(PaddedSize);
5195   }
5196 
5197   if (!Arr.empty())
5198     Properties.push_back("<corrupted GNU_PROPERTY_TYPE_0>");
5199 
5200   return Properties;
5201 }
5202 
5203 struct GNUAbiTag {
5204   std::string OSName;
5205   std::string ABI;
5206   bool IsValid;
5207 };
5208 
5209 template <typename ELFT> static GNUAbiTag getGNUAbiTag(ArrayRef<uint8_t> Desc) {
5210   typedef typename ELFT::Word Elf_Word;
5211 
5212   ArrayRef<Elf_Word> Words(reinterpret_cast<const Elf_Word *>(Desc.begin()),
5213                            reinterpret_cast<const Elf_Word *>(Desc.end()));
5214 
5215   if (Words.size() < 4)
5216     return {"", "", /*IsValid=*/false};
5217 
5218   static const char *OSNames[] = {
5219       "Linux", "Hurd", "Solaris", "FreeBSD", "NetBSD", "Syllable", "NaCl",
5220   };
5221   StringRef OSName = "Unknown";
5222   if (Words[0] < array_lengthof(OSNames))
5223     OSName = OSNames[Words[0]];
5224   uint32_t Major = Words[1], Minor = Words[2], Patch = Words[3];
5225   std::string str;
5226   raw_string_ostream ABI(str);
5227   ABI << Major << "." << Minor << "." << Patch;
5228   return {std::string(OSName), ABI.str(), /*IsValid=*/true};
5229 }
5230 
5231 static std::string getGNUBuildId(ArrayRef<uint8_t> Desc) {
5232   std::string str;
5233   raw_string_ostream OS(str);
5234   for (const auto &B : Desc)
5235     OS << format_hex_no_prefix(B, 2);
5236   return OS.str();
5237 }
5238 
5239 static StringRef getGNUGoldVersion(ArrayRef<uint8_t> Desc) {
5240   return StringRef(reinterpret_cast<const char *>(Desc.data()), Desc.size());
5241 }
5242 
5243 template <typename ELFT>
5244 static void printGNUNote(raw_ostream &OS, uint32_t NoteType,
5245                          ArrayRef<uint8_t> Desc) {
5246   switch (NoteType) {
5247   default:
5248     return;
5249   case ELF::NT_GNU_ABI_TAG: {
5250     const GNUAbiTag &AbiTag = getGNUAbiTag<ELFT>(Desc);
5251     if (!AbiTag.IsValid)
5252       OS << "    <corrupt GNU_ABI_TAG>";
5253     else
5254       OS << "    OS: " << AbiTag.OSName << ", ABI: " << AbiTag.ABI;
5255     break;
5256   }
5257   case ELF::NT_GNU_BUILD_ID: {
5258     OS << "    Build ID: " << getGNUBuildId(Desc);
5259     break;
5260   }
5261   case ELF::NT_GNU_GOLD_VERSION:
5262     OS << "    Version: " << getGNUGoldVersion(Desc);
5263     break;
5264   case ELF::NT_GNU_PROPERTY_TYPE_0:
5265     OS << "    Properties:";
5266     for (const auto &Property : getGNUPropertyList<ELFT>(Desc))
5267       OS << "    " << Property << "\n";
5268     break;
5269   }
5270   OS << '\n';
5271 }
5272 
5273 struct AMDNote {
5274   std::string Type;
5275   std::string Value;
5276 };
5277 
5278 template <typename ELFT>
5279 static AMDNote getAMDNote(uint32_t NoteType, ArrayRef<uint8_t> Desc) {
5280   switch (NoteType) {
5281   default:
5282     return {"", ""};
5283   case ELF::NT_AMD_AMDGPU_HSA_METADATA:
5284     return {
5285         "HSA Metadata",
5286         std::string(reinterpret_cast<const char *>(Desc.data()), Desc.size())};
5287   case ELF::NT_AMD_AMDGPU_ISA:
5288     return {
5289         "ISA Version",
5290         std::string(reinterpret_cast<const char *>(Desc.data()), Desc.size())};
5291   }
5292 }
5293 
5294 struct AMDGPUNote {
5295   std::string Type;
5296   std::string Value;
5297 };
5298 
5299 template <typename ELFT>
5300 static AMDGPUNote getAMDGPUNote(uint32_t NoteType, ArrayRef<uint8_t> Desc) {
5301   switch (NoteType) {
5302   default:
5303     return {"", ""};
5304   case ELF::NT_AMDGPU_METADATA: {
5305     auto MsgPackString =
5306         StringRef(reinterpret_cast<const char *>(Desc.data()), Desc.size());
5307     msgpack::Document MsgPackDoc;
5308     if (!MsgPackDoc.readFromBlob(MsgPackString, /*Multi=*/false))
5309       return {"AMDGPU Metadata", "Invalid AMDGPU Metadata"};
5310 
5311     AMDGPU::HSAMD::V3::MetadataVerifier Verifier(true);
5312     if (!Verifier.verify(MsgPackDoc.getRoot()))
5313       return {"AMDGPU Metadata", "Invalid AMDGPU Metadata"};
5314 
5315     std::string HSAMetadataString;
5316     raw_string_ostream StrOS(HSAMetadataString);
5317     MsgPackDoc.toYAML(StrOS);
5318 
5319     return {"AMDGPU Metadata", StrOS.str()};
5320   }
5321   }
5322 }
5323 
5324 struct CoreFileMapping {
5325   uint64_t Start, End, Offset;
5326   StringRef Filename;
5327 };
5328 
5329 struct CoreNote {
5330   uint64_t PageSize;
5331   std::vector<CoreFileMapping> Mappings;
5332 };
5333 
5334 static Expected<CoreNote> readCoreNote(DataExtractor Desc) {
5335   // Expected format of the NT_FILE note description:
5336   // 1. # of file mappings (call it N)
5337   // 2. Page size
5338   // 3. N (start, end, offset) triples
5339   // 4. N packed filenames (null delimited)
5340   // Each field is an Elf_Addr, except for filenames which are char* strings.
5341 
5342   CoreNote Ret;
5343   const int Bytes = Desc.getAddressSize();
5344 
5345   if (!Desc.isValidOffsetForAddress(2))
5346     return createStringError(object_error::parse_failed,
5347                              "malformed note: header too short");
5348   if (Desc.getData().back() != 0)
5349     return createStringError(object_error::parse_failed,
5350                              "malformed note: not NUL terminated");
5351 
5352   uint64_t DescOffset = 0;
5353   uint64_t FileCount = Desc.getAddress(&DescOffset);
5354   Ret.PageSize = Desc.getAddress(&DescOffset);
5355 
5356   if (!Desc.isValidOffsetForAddress(3 * FileCount * Bytes))
5357     return createStringError(object_error::parse_failed,
5358                              "malformed note: too short for number of files");
5359 
5360   uint64_t FilenamesOffset = 0;
5361   DataExtractor Filenames(
5362       Desc.getData().drop_front(DescOffset + 3 * FileCount * Bytes),
5363       Desc.isLittleEndian(), Desc.getAddressSize());
5364 
5365   Ret.Mappings.resize(FileCount);
5366   for (CoreFileMapping &Mapping : Ret.Mappings) {
5367     if (!Filenames.isValidOffsetForDataOfSize(FilenamesOffset, 1))
5368       return createStringError(object_error::parse_failed,
5369                                "malformed note: too few filenames");
5370     Mapping.Start = Desc.getAddress(&DescOffset);
5371     Mapping.End = Desc.getAddress(&DescOffset);
5372     Mapping.Offset = Desc.getAddress(&DescOffset);
5373     Mapping.Filename = Filenames.getCStrRef(&FilenamesOffset);
5374   }
5375 
5376   return Ret;
5377 }
5378 
5379 template <typename ELFT>
5380 static void printCoreNote(raw_ostream &OS, const CoreNote &Note) {
5381   // Length of "0x<address>" string.
5382   const int FieldWidth = ELFT::Is64Bits ? 18 : 10;
5383 
5384   OS << "    Page size: " << format_decimal(Note.PageSize, 0) << '\n';
5385   OS << "    " << right_justify("Start", FieldWidth) << "  "
5386      << right_justify("End", FieldWidth) << "  "
5387      << right_justify("Page Offset", FieldWidth) << '\n';
5388   for (const CoreFileMapping &Mapping : Note.Mappings) {
5389     OS << "    " << format_hex(Mapping.Start, FieldWidth) << "  "
5390        << format_hex(Mapping.End, FieldWidth) << "  "
5391        << format_hex(Mapping.Offset, FieldWidth) << "\n        "
5392        << Mapping.Filename << '\n';
5393   }
5394 }
5395 
5396 template <class ELFT>
5397 void GNUStyle<ELFT>::printNotes(const ELFFile<ELFT> *Obj) {
5398   auto PrintHeader = [&](Optional<StringRef> SecName,
5399                          const typename ELFT::Off Offset,
5400                          const typename ELFT::Addr Size) {
5401     OS << "Displaying notes found ";
5402 
5403     if (SecName)
5404       OS << "in: " << *SecName << "\n";
5405     else
5406       OS << "at file offset " << format_hex(Offset, 10) << " with length "
5407          << format_hex(Size, 10) << ":\n";
5408 
5409     OS << "  Owner                Data size \tDescription\n";
5410   };
5411 
5412   auto ProcessNote = [&](const Elf_Note &Note) {
5413     StringRef Name = Note.getName();
5414     ArrayRef<uint8_t> Descriptor = Note.getDesc();
5415     Elf_Word Type = Note.getType();
5416 
5417     // Print the note owner/type.
5418     OS << "  " << left_justify(Name, 20) << ' '
5419        << format_hex(Descriptor.size(), 10) << '\t';
5420     if (Name == "GNU") {
5421       OS << getGNUNoteTypeName(Type) << '\n';
5422     } else if (Name == "FreeBSD") {
5423       OS << getFreeBSDNoteTypeName(Type) << '\n';
5424     } else if (Name == "AMD") {
5425       OS << getAMDNoteTypeName(Type) << '\n';
5426     } else if (Name == "AMDGPU") {
5427       OS << getAMDGPUNoteTypeName(Type) << '\n';
5428     } else {
5429       StringRef NoteType = Obj->getHeader()->e_type == ELF::ET_CORE
5430                                ? getCoreNoteTypeName(Type)
5431                                : getGenericNoteTypeName(Type);
5432       if (!NoteType.empty())
5433         OS << NoteType << '\n';
5434       else
5435         OS << "Unknown note type: (" << format_hex(Type, 10) << ")\n";
5436     }
5437 
5438     // Print the description, or fallback to printing raw bytes for unknown
5439     // owners.
5440     if (Name == "GNU") {
5441       printGNUNote<ELFT>(OS, Type, Descriptor);
5442     } else if (Name == "AMD") {
5443       const AMDNote N = getAMDNote<ELFT>(Type, Descriptor);
5444       if (!N.Type.empty())
5445         OS << "    " << N.Type << ":\n        " << N.Value << '\n';
5446     } else if (Name == "AMDGPU") {
5447       const AMDGPUNote N = getAMDGPUNote<ELFT>(Type, Descriptor);
5448       if (!N.Type.empty())
5449         OS << "    " << N.Type << ":\n        " << N.Value << '\n';
5450     } else if (Name == "CORE") {
5451       if (Type == ELF::NT_FILE) {
5452         DataExtractor DescExtractor(Descriptor,
5453                                     ELFT::TargetEndianness == support::little,
5454                                     sizeof(Elf_Addr));
5455         Expected<CoreNote> Note = readCoreNote(DescExtractor);
5456         if (Note)
5457           printCoreNote<ELFT>(OS, *Note);
5458         else
5459           reportWarning(Note.takeError(), this->FileName);
5460       }
5461     } else if (!Descriptor.empty()) {
5462       OS << "   description data:";
5463       for (uint8_t B : Descriptor)
5464         OS << " " << format("%02x", B);
5465       OS << '\n';
5466     }
5467   };
5468 
5469   ArrayRef<Elf_Shdr> Sections = cantFail(Obj->sections());
5470   if (Obj->getHeader()->e_type != ELF::ET_CORE && !Sections.empty()) {
5471     for (const auto &S : Sections) {
5472       if (S.sh_type != SHT_NOTE)
5473         continue;
5474       PrintHeader(expectedToOptional(Obj->getSectionName(&S)), S.sh_offset,
5475                   S.sh_size);
5476       Error Err = Error::success();
5477       for (auto Note : Obj->notes(S, Err))
5478         ProcessNote(Note);
5479       if (Err)
5480         reportError(std::move(Err), this->FileName);
5481     }
5482   } else {
5483     for (const auto &P :
5484          unwrapOrError(this->FileName, Obj->program_headers())) {
5485       if (P.p_type != PT_NOTE)
5486         continue;
5487       PrintHeader(/*SecName=*/None, P.p_offset, P.p_filesz);
5488       Error Err = Error::success();
5489       for (auto Note : Obj->notes(P, Err))
5490         ProcessNote(Note);
5491       if (Err)
5492         reportError(std::move(Err), this->FileName);
5493     }
5494   }
5495 }
5496 
5497 template <class ELFT>
5498 void GNUStyle<ELFT>::printELFLinkerOptions(const ELFFile<ELFT> *Obj) {
5499   OS << "printELFLinkerOptions not implemented!\n";
5500 }
5501 
5502 template <class ELFT>
5503 void DumpStyle<ELFT>::printDependentLibsHelper(
5504     const ELFFile<ELFT> *Obj,
5505     function_ref<void(const Elf_Shdr &)> OnSectionStart,
5506     function_ref<void(StringRef, uint64_t)> OnLibEntry) {
5507   auto Warn = [this](unsigned SecNdx, StringRef Msg) {
5508     this->reportUniqueWarning(
5509         createError("SHT_LLVM_DEPENDENT_LIBRARIES section at index " +
5510                     Twine(SecNdx) + " is broken: " + Msg));
5511   };
5512 
5513   unsigned I = -1;
5514   for (const Elf_Shdr &Shdr : cantFail(Obj->sections())) {
5515     ++I;
5516     if (Shdr.sh_type != ELF::SHT_LLVM_DEPENDENT_LIBRARIES)
5517       continue;
5518 
5519     OnSectionStart(Shdr);
5520 
5521     Expected<ArrayRef<uint8_t>> ContentsOrErr = Obj->getSectionContents(&Shdr);
5522     if (!ContentsOrErr) {
5523       Warn(I, toString(ContentsOrErr.takeError()));
5524       continue;
5525     }
5526 
5527     ArrayRef<uint8_t> Contents = *ContentsOrErr;
5528     if (!Contents.empty() && Contents.back() != 0) {
5529       Warn(I, "the content is not null-terminated");
5530       continue;
5531     }
5532 
5533     for (const uint8_t *I = Contents.begin(), *E = Contents.end(); I < E;) {
5534       StringRef Lib((const char *)I);
5535       OnLibEntry(Lib, I - Contents.begin());
5536       I += Lib.size() + 1;
5537     }
5538   }
5539 }
5540 
5541 template <class ELFT>
5542 void GNUStyle<ELFT>::printDependentLibs(const ELFFile<ELFT> *Obj) {
5543   bool SectionStarted = false;
5544   struct NameOffset {
5545     StringRef Name;
5546     uint64_t Offset;
5547   };
5548   std::vector<NameOffset> SecEntries;
5549   NameOffset Current;
5550   auto PrintSection = [&]() {
5551     OS << "Dependent libraries section " << Current.Name << " at offset "
5552        << format_hex(Current.Offset, 1) << " contains " << SecEntries.size()
5553        << " entries:\n";
5554     for (NameOffset Entry : SecEntries)
5555       OS << "  [" << format("%6tx", Entry.Offset) << "]  " << Entry.Name
5556          << "\n";
5557     OS << "\n";
5558     SecEntries.clear();
5559   };
5560 
5561   auto OnSectionStart = [&](const Elf_Shdr &Shdr) {
5562     if (SectionStarted)
5563       PrintSection();
5564     SectionStarted = true;
5565     Current.Offset = Shdr.sh_offset;
5566     Expected<StringRef> Name = Obj->getSectionName(&Shdr);
5567     if (!Name) {
5568       Current.Name = "<?>";
5569       this->reportUniqueWarning(
5570           createError("cannot get section name of "
5571                       "SHT_LLVM_DEPENDENT_LIBRARIES section: " +
5572                       toString(Name.takeError())));
5573     } else {
5574       Current.Name = *Name;
5575     }
5576   };
5577   auto OnLibEntry = [&](StringRef Lib, uint64_t Offset) {
5578     SecEntries.push_back(NameOffset{Lib, Offset});
5579   };
5580 
5581   this->printDependentLibsHelper(Obj, OnSectionStart, OnLibEntry);
5582   if (SectionStarted)
5583     PrintSection();
5584 }
5585 
5586 // Used for printing section names in places where possible errors can be
5587 // ignored.
5588 static StringRef getSectionName(const SectionRef &Sec) {
5589   Expected<StringRef> NameOrErr = Sec.getName();
5590   if (NameOrErr)
5591     return *NameOrErr;
5592   consumeError(NameOrErr.takeError());
5593   return "<?>";
5594 }
5595 
5596 // Used for printing symbol names in places where possible errors can be
5597 // ignored.
5598 static std::string getSymbolName(const ELFSymbolRef &Sym) {
5599   Expected<StringRef> NameOrErr = Sym.getName();
5600   if (NameOrErr)
5601     return maybeDemangle(*NameOrErr);
5602   consumeError(NameOrErr.takeError());
5603   return "<?>";
5604 }
5605 
5606 template <class ELFT>
5607 void DumpStyle<ELFT>::printFunctionStackSize(const ELFObjectFile<ELFT> *Obj,
5608                                              uint64_t SymValue,
5609                                              Optional<SectionRef> FunctionSec,
5610                                              const StringRef SectionName,
5611                                              DataExtractor Data,
5612                                              uint64_t *Offset) {
5613   // This function ignores potentially erroneous input, unless it is directly
5614   // related to stack size reporting.
5615   SymbolRef FuncSym;
5616   for (const ELFSymbolRef &Symbol : Obj->symbols()) {
5617     Expected<uint64_t> SymAddrOrErr = Symbol.getAddress();
5618     if (!SymAddrOrErr) {
5619       consumeError(SymAddrOrErr.takeError());
5620       continue;
5621     }
5622     if (Expected<uint32_t> SymFlags = Symbol.getFlags()) {
5623       if (*SymFlags & SymbolRef::SF_Undefined)
5624         continue;
5625     } else
5626       consumeError(SymFlags.takeError());
5627     if (Symbol.getELFType() == ELF::STT_FUNC && *SymAddrOrErr == SymValue) {
5628       // Check if the symbol is in the right section. FunctionSec == None means
5629       // "any section".
5630       if (!FunctionSec || FunctionSec->containsSymbol(Symbol)) {
5631         FuncSym = Symbol;
5632         break;
5633       }
5634     }
5635   }
5636 
5637   std::string FuncName = "?";
5638   // A valid SymbolRef has a non-null object file pointer.
5639   if (FuncSym.BasicSymbolRef::getObject())
5640     FuncName = getSymbolName(FuncSym);
5641   else
5642     reportWarning(
5643         createError("could not identify function symbol for stack size entry"),
5644         Obj->getFileName());
5645 
5646   // Extract the size. The expectation is that Offset is pointing to the right
5647   // place, i.e. past the function address.
5648   uint64_t PrevOffset = *Offset;
5649   uint64_t StackSize = Data.getULEB128(Offset);
5650   // getULEB128() does not advance Offset if it is not able to extract a valid
5651   // integer.
5652   if (*Offset == PrevOffset)
5653     reportError(
5654         createStringError(object_error::parse_failed,
5655                           "could not extract a valid stack size in section %s",
5656                           SectionName.data()),
5657         Obj->getFileName());
5658 
5659   printStackSizeEntry(StackSize, FuncName);
5660 }
5661 
5662 template <class ELFT>
5663 void GNUStyle<ELFT>::printStackSizeEntry(uint64_t Size, StringRef FuncName) {
5664   OS.PadToColumn(2);
5665   OS << format_decimal(Size, 11);
5666   OS.PadToColumn(18);
5667   OS << FuncName << "\n";
5668 }
5669 
5670 template <class ELFT>
5671 void DumpStyle<ELFT>::printStackSize(const ELFObjectFile<ELFT> *Obj,
5672                                      RelocationRef Reloc,
5673                                      SectionRef FunctionSec,
5674                                      const StringRef &StackSizeSectionName,
5675                                      const RelocationResolver &Resolver,
5676                                      DataExtractor Data) {
5677   // This function ignores potentially erroneous input, unless it is directly
5678   // related to stack size reporting.
5679   object::symbol_iterator RelocSym = Reloc.getSymbol();
5680   uint64_t RelocSymValue = 0;
5681   StringRef FileStr = Obj->getFileName();
5682   if (RelocSym != Obj->symbol_end()) {
5683     // Ensure that the relocation symbol is in the function section, i.e. the
5684     // section where the functions whose stack sizes we are reporting are
5685     // located.
5686     auto SectionOrErr = RelocSym->getSection();
5687     if (!SectionOrErr) {
5688       reportWarning(
5689           createError("cannot identify the section for relocation symbol '" +
5690                       getSymbolName(*RelocSym) + "'"),
5691           FileStr);
5692       consumeError(SectionOrErr.takeError());
5693     } else if (*SectionOrErr != FunctionSec) {
5694       reportWarning(createError("relocation symbol '" +
5695                                 getSymbolName(*RelocSym) +
5696                                 "' is not in the expected section"),
5697                     FileStr);
5698       // Pretend that the symbol is in the correct section and report its
5699       // stack size anyway.
5700       FunctionSec = **SectionOrErr;
5701     }
5702 
5703     Expected<uint64_t> RelocSymValueOrErr = RelocSym->getValue();
5704     if (RelocSymValueOrErr)
5705       RelocSymValue = *RelocSymValueOrErr;
5706     else
5707       consumeError(RelocSymValueOrErr.takeError());
5708   }
5709 
5710   uint64_t Offset = Reloc.getOffset();
5711   if (!Data.isValidOffsetForDataOfSize(Offset, sizeof(Elf_Addr) + 1))
5712     reportError(
5713         createStringError(object_error::parse_failed,
5714                           "found invalid relocation offset into section %s "
5715                           "while trying to extract a stack size entry",
5716                           StackSizeSectionName.data()),
5717         FileStr);
5718 
5719   uint64_t Addend = Data.getAddress(&Offset);
5720   uint64_t SymValue = Resolver(Reloc, RelocSymValue, Addend);
5721   this->printFunctionStackSize(Obj, SymValue, FunctionSec, StackSizeSectionName,
5722                                Data, &Offset);
5723 }
5724 
5725 template <class ELFT>
5726 void DumpStyle<ELFT>::printNonRelocatableStackSizes(
5727     const ELFObjectFile<ELFT> *Obj, std::function<void()> PrintHeader) {
5728   // This function ignores potentially erroneous input, unless it is directly
5729   // related to stack size reporting.
5730   const ELFFile<ELFT> *EF = Obj->getELFFile();
5731   StringRef FileStr = Obj->getFileName();
5732   for (const SectionRef &Sec : Obj->sections()) {
5733     StringRef SectionName = getSectionName(Sec);
5734     if (SectionName != ".stack_sizes")
5735       continue;
5736     PrintHeader();
5737     const Elf_Shdr *ElfSec = Obj->getSection(Sec.getRawDataRefImpl());
5738     ArrayRef<uint8_t> Contents =
5739         unwrapOrError(this->FileName, EF->getSectionContents(ElfSec));
5740     DataExtractor Data(Contents, Obj->isLittleEndian(), sizeof(Elf_Addr));
5741     uint64_t Offset = 0;
5742     while (Offset < Contents.size()) {
5743       // The function address is followed by a ULEB representing the stack
5744       // size. Check for an extra byte before we try to process the entry.
5745       if (!Data.isValidOffsetForDataOfSize(Offset, sizeof(Elf_Addr) + 1)) {
5746         reportError(
5747             createStringError(
5748                 object_error::parse_failed,
5749                 "section %s ended while trying to extract a stack size entry",
5750                 SectionName.data()),
5751             FileStr);
5752       }
5753       uint64_t SymValue = Data.getAddress(&Offset);
5754       printFunctionStackSize(Obj, SymValue, /*FunctionSec=*/None, SectionName,
5755                              Data, &Offset);
5756     }
5757   }
5758 }
5759 
5760 template <class ELFT>
5761 void DumpStyle<ELFT>::printRelocatableStackSizes(
5762     const ELFObjectFile<ELFT> *Obj, std::function<void()> PrintHeader) {
5763   const ELFFile<ELFT> *EF = Obj->getELFFile();
5764 
5765   // Build a map between stack size sections and their corresponding relocation
5766   // sections.
5767   llvm::MapVector<SectionRef, SectionRef> StackSizeRelocMap;
5768   const SectionRef NullSection{};
5769 
5770   for (const SectionRef &Sec : Obj->sections()) {
5771     StringRef SectionName;
5772     if (Expected<StringRef> NameOrErr = Sec.getName())
5773       SectionName = *NameOrErr;
5774     else
5775       consumeError(NameOrErr.takeError());
5776 
5777     // A stack size section that we haven't encountered yet is mapped to the
5778     // null section until we find its corresponding relocation section.
5779     if (SectionName == ".stack_sizes")
5780       if (StackSizeRelocMap.count(Sec) == 0) {
5781         StackSizeRelocMap[Sec] = NullSection;
5782         continue;
5783       }
5784 
5785     // Check relocation sections if they are relocating contents of a
5786     // stack sizes section.
5787     const Elf_Shdr *ElfSec = Obj->getSection(Sec.getRawDataRefImpl());
5788     uint32_t SectionType = ElfSec->sh_type;
5789     if (SectionType != ELF::SHT_RELA && SectionType != ELF::SHT_REL)
5790       continue;
5791 
5792     Expected<section_iterator> RelSecOrErr = Sec.getRelocatedSection();
5793     if (!RelSecOrErr)
5794       reportError(createStringError(object_error::parse_failed,
5795                                     "%s: failed to get a relocated section: %s",
5796                                     SectionName.data(),
5797                                     toString(RelSecOrErr.takeError()).c_str()),
5798                   Obj->getFileName());
5799 
5800     const Elf_Shdr *ContentsSec =
5801         Obj->getSection((*RelSecOrErr)->getRawDataRefImpl());
5802     Expected<StringRef> ContentsSectionNameOrErr =
5803         EF->getSectionName(ContentsSec);
5804     if (!ContentsSectionNameOrErr) {
5805       consumeError(ContentsSectionNameOrErr.takeError());
5806       continue;
5807     }
5808     if (*ContentsSectionNameOrErr != ".stack_sizes")
5809       continue;
5810     // Insert a mapping from the stack sizes section to its relocation section.
5811     StackSizeRelocMap[Obj->toSectionRef(ContentsSec)] = Sec;
5812   }
5813 
5814   for (const auto &StackSizeMapEntry : StackSizeRelocMap) {
5815     PrintHeader();
5816     const SectionRef &StackSizesSec = StackSizeMapEntry.first;
5817     const SectionRef &RelocSec = StackSizeMapEntry.second;
5818 
5819     // Warn about stack size sections without a relocation section.
5820     StringRef StackSizeSectionName = getSectionName(StackSizesSec);
5821     if (RelocSec == NullSection) {
5822       reportWarning(createError("section " + StackSizeSectionName +
5823                                 " does not have a corresponding "
5824                                 "relocation section"),
5825                     Obj->getFileName());
5826       continue;
5827     }
5828 
5829     // A .stack_sizes section header's sh_link field is supposed to point
5830     // to the section that contains the functions whose stack sizes are
5831     // described in it.
5832     const Elf_Shdr *StackSizesELFSec =
5833         Obj->getSection(StackSizesSec.getRawDataRefImpl());
5834     const SectionRef FunctionSec = Obj->toSectionRef(unwrapOrError(
5835         this->FileName, EF->getSection(StackSizesELFSec->sh_link)));
5836 
5837     bool (*IsSupportedFn)(uint64_t);
5838     RelocationResolver Resolver;
5839     std::tie(IsSupportedFn, Resolver) = getRelocationResolver(*Obj);
5840     auto Contents = unwrapOrError(this->FileName, StackSizesSec.getContents());
5841     DataExtractor Data(Contents, Obj->isLittleEndian(), sizeof(Elf_Addr));
5842     for (const RelocationRef &Reloc : RelocSec.relocations()) {
5843       if (!IsSupportedFn || !IsSupportedFn(Reloc.getType()))
5844         reportError(createStringError(
5845                         object_error::parse_failed,
5846                         "unsupported relocation type in section %s: %s",
5847                         getSectionName(RelocSec).data(),
5848                         EF->getRelocationTypeName(Reloc.getType()).data()),
5849                     Obj->getFileName());
5850       this->printStackSize(Obj, Reloc, FunctionSec, StackSizeSectionName,
5851                            Resolver, Data);
5852     }
5853   }
5854 }
5855 
5856 template <class ELFT>
5857 void GNUStyle<ELFT>::printStackSizes(const ELFObjectFile<ELFT> *Obj) {
5858   bool HeaderHasBeenPrinted = false;
5859   auto PrintHeader = [&]() {
5860     if (HeaderHasBeenPrinted)
5861       return;
5862     OS << "\nStack Sizes:\n";
5863     OS.PadToColumn(9);
5864     OS << "Size";
5865     OS.PadToColumn(18);
5866     OS << "Function\n";
5867     HeaderHasBeenPrinted = true;
5868   };
5869 
5870   // For non-relocatable objects, look directly for sections whose name starts
5871   // with .stack_sizes and process the contents.
5872   if (Obj->isRelocatableObject())
5873     this->printRelocatableStackSizes(Obj, PrintHeader);
5874   else
5875     this->printNonRelocatableStackSizes(Obj, PrintHeader);
5876 }
5877 
5878 template <class ELFT>
5879 void GNUStyle<ELFT>::printMipsGOT(const MipsGOTParser<ELFT> &Parser) {
5880   size_t Bias = ELFT::Is64Bits ? 8 : 0;
5881   auto PrintEntry = [&](const Elf_Addr *E, StringRef Purpose) {
5882     OS.PadToColumn(2);
5883     OS << format_hex_no_prefix(Parser.getGotAddress(E), 8 + Bias);
5884     OS.PadToColumn(11 + Bias);
5885     OS << format_decimal(Parser.getGotOffset(E), 6) << "(gp)";
5886     OS.PadToColumn(22 + Bias);
5887     OS << format_hex_no_prefix(*E, 8 + Bias);
5888     OS.PadToColumn(31 + 2 * Bias);
5889     OS << Purpose << "\n";
5890   };
5891 
5892   OS << (Parser.IsStatic ? "Static GOT:\n" : "Primary GOT:\n");
5893   OS << " Canonical gp value: "
5894      << format_hex_no_prefix(Parser.getGp(), 8 + Bias) << "\n\n";
5895 
5896   OS << " Reserved entries:\n";
5897   if (ELFT::Is64Bits)
5898     OS << "           Address     Access          Initial Purpose\n";
5899   else
5900     OS << "   Address     Access  Initial Purpose\n";
5901   PrintEntry(Parser.getGotLazyResolver(), "Lazy resolver");
5902   if (Parser.getGotModulePointer())
5903     PrintEntry(Parser.getGotModulePointer(), "Module pointer (GNU extension)");
5904 
5905   if (!Parser.getLocalEntries().empty()) {
5906     OS << "\n";
5907     OS << " Local entries:\n";
5908     if (ELFT::Is64Bits)
5909       OS << "           Address     Access          Initial\n";
5910     else
5911       OS << "   Address     Access  Initial\n";
5912     for (auto &E : Parser.getLocalEntries())
5913       PrintEntry(&E, "");
5914   }
5915 
5916   if (Parser.IsStatic)
5917     return;
5918 
5919   if (!Parser.getGlobalEntries().empty()) {
5920     OS << "\n";
5921     OS << " Global entries:\n";
5922     if (ELFT::Is64Bits)
5923       OS << "           Address     Access          Initial         Sym.Val."
5924          << " Type    Ndx Name\n";
5925     else
5926       OS << "   Address     Access  Initial Sym.Val. Type    Ndx Name\n";
5927     for (auto &E : Parser.getGlobalEntries()) {
5928       const Elf_Sym *Sym = Parser.getGotSym(&E);
5929       std::string SymName = this->dumper()->getFullSymbolName(
5930           Sym, this->dumper()->getDynamicStringTable(), false);
5931 
5932       OS.PadToColumn(2);
5933       OS << to_string(format_hex_no_prefix(Parser.getGotAddress(&E), 8 + Bias));
5934       OS.PadToColumn(11 + Bias);
5935       OS << to_string(format_decimal(Parser.getGotOffset(&E), 6)) + "(gp)";
5936       OS.PadToColumn(22 + Bias);
5937       OS << to_string(format_hex_no_prefix(E, 8 + Bias));
5938       OS.PadToColumn(31 + 2 * Bias);
5939       OS << to_string(format_hex_no_prefix(Sym->st_value, 8 + Bias));
5940       OS.PadToColumn(40 + 3 * Bias);
5941       OS << printEnum(Sym->getType(), makeArrayRef(ElfSymbolTypes));
5942       OS.PadToColumn(48 + 3 * Bias);
5943       OS << getSymbolSectionNdx(Parser.Obj, Sym,
5944                                 this->dumper()->dynamic_symbols().begin());
5945       OS.PadToColumn(52 + 3 * Bias);
5946       OS << SymName << "\n";
5947     }
5948   }
5949 
5950   if (!Parser.getOtherEntries().empty())
5951     OS << "\n Number of TLS and multi-GOT entries "
5952        << Parser.getOtherEntries().size() << "\n";
5953 }
5954 
5955 template <class ELFT>
5956 void GNUStyle<ELFT>::printMipsPLT(const MipsGOTParser<ELFT> &Parser) {
5957   size_t Bias = ELFT::Is64Bits ? 8 : 0;
5958   auto PrintEntry = [&](const Elf_Addr *E, StringRef Purpose) {
5959     OS.PadToColumn(2);
5960     OS << format_hex_no_prefix(Parser.getPltAddress(E), 8 + Bias);
5961     OS.PadToColumn(11 + Bias);
5962     OS << format_hex_no_prefix(*E, 8 + Bias);
5963     OS.PadToColumn(20 + 2 * Bias);
5964     OS << Purpose << "\n";
5965   };
5966 
5967   OS << "PLT GOT:\n\n";
5968 
5969   OS << " Reserved entries:\n";
5970   OS << "   Address  Initial Purpose\n";
5971   PrintEntry(Parser.getPltLazyResolver(), "PLT lazy resolver");
5972   if (Parser.getPltModulePointer())
5973     PrintEntry(Parser.getPltModulePointer(), "Module pointer");
5974 
5975   if (!Parser.getPltEntries().empty()) {
5976     OS << "\n";
5977     OS << " Entries:\n";
5978     OS << "   Address  Initial Sym.Val. Type    Ndx Name\n";
5979     for (auto &E : Parser.getPltEntries()) {
5980       const Elf_Sym *Sym = Parser.getPltSym(&E);
5981       std::string SymName = this->dumper()->getFullSymbolName(
5982           Sym, this->dumper()->getDynamicStringTable(), false);
5983 
5984       OS.PadToColumn(2);
5985       OS << to_string(format_hex_no_prefix(Parser.getPltAddress(&E), 8 + Bias));
5986       OS.PadToColumn(11 + Bias);
5987       OS << to_string(format_hex_no_prefix(E, 8 + Bias));
5988       OS.PadToColumn(20 + 2 * Bias);
5989       OS << to_string(format_hex_no_prefix(Sym->st_value, 8 + Bias));
5990       OS.PadToColumn(29 + 3 * Bias);
5991       OS << printEnum(Sym->getType(), makeArrayRef(ElfSymbolTypes));
5992       OS.PadToColumn(37 + 3 * Bias);
5993       OS << getSymbolSectionNdx(Parser.Obj, Sym,
5994                                 this->dumper()->dynamic_symbols().begin());
5995       OS.PadToColumn(41 + 3 * Bias);
5996       OS << SymName << "\n";
5997     }
5998   }
5999 }
6000 
6001 template <class ELFT>
6002 void GNUStyle<ELFT>::printMipsABIFlags(const ELFObjectFile<ELFT> *ObjF) {
6003   const ELFFile<ELFT> *Obj = ObjF->getELFFile();
6004   const Elf_Shdr *Shdr =
6005       findSectionByName(*Obj, ObjF->getFileName(), ".MIPS.abiflags");
6006   if (!Shdr)
6007     return;
6008 
6009   ArrayRef<uint8_t> Sec =
6010       unwrapOrError(ObjF->getFileName(), Obj->getSectionContents(Shdr));
6011   if (Sec.size() != sizeof(Elf_Mips_ABIFlags<ELFT>))
6012     reportError(createError(".MIPS.abiflags section has a wrong size"),
6013                 ObjF->getFileName());
6014 
6015   auto *Flags = reinterpret_cast<const Elf_Mips_ABIFlags<ELFT> *>(Sec.data());
6016 
6017   OS << "MIPS ABI Flags Version: " << Flags->version << "\n\n";
6018   OS << "ISA: MIPS" << int(Flags->isa_level);
6019   if (Flags->isa_rev > 1)
6020     OS << "r" << int(Flags->isa_rev);
6021   OS << "\n";
6022   OS << "GPR size: " << getMipsRegisterSize(Flags->gpr_size) << "\n";
6023   OS << "CPR1 size: " << getMipsRegisterSize(Flags->cpr1_size) << "\n";
6024   OS << "CPR2 size: " << getMipsRegisterSize(Flags->cpr2_size) << "\n";
6025   OS << "FP ABI: " << printEnum(Flags->fp_abi, makeArrayRef(ElfMipsFpABIType))
6026      << "\n";
6027   OS << "ISA Extension: "
6028      << printEnum(Flags->isa_ext, makeArrayRef(ElfMipsISAExtType)) << "\n";
6029   if (Flags->ases == 0)
6030     OS << "ASEs: None\n";
6031   else
6032     // FIXME: Print each flag on a separate line.
6033     OS << "ASEs: " << printFlags(Flags->ases, makeArrayRef(ElfMipsASEFlags))
6034        << "\n";
6035   OS << "FLAGS 1: " << format_hex_no_prefix(Flags->flags1, 8, false) << "\n";
6036   OS << "FLAGS 2: " << format_hex_no_prefix(Flags->flags2, 8, false) << "\n";
6037   OS << "\n";
6038 }
6039 
6040 template <class ELFT> void LLVMStyle<ELFT>::printFileHeaders(const ELFO *Obj) {
6041   const Elf_Ehdr *E = Obj->getHeader();
6042   {
6043     DictScope D(W, "ElfHeader");
6044     {
6045       DictScope D(W, "Ident");
6046       W.printBinary("Magic", makeArrayRef(E->e_ident).slice(ELF::EI_MAG0, 4));
6047       W.printEnum("Class", E->e_ident[ELF::EI_CLASS], makeArrayRef(ElfClass));
6048       W.printEnum("DataEncoding", E->e_ident[ELF::EI_DATA],
6049                   makeArrayRef(ElfDataEncoding));
6050       W.printNumber("FileVersion", E->e_ident[ELF::EI_VERSION]);
6051 
6052       auto OSABI = makeArrayRef(ElfOSABI);
6053       if (E->e_ident[ELF::EI_OSABI] >= ELF::ELFOSABI_FIRST_ARCH &&
6054           E->e_ident[ELF::EI_OSABI] <= ELF::ELFOSABI_LAST_ARCH) {
6055         switch (E->e_machine) {
6056         case ELF::EM_AMDGPU:
6057           OSABI = makeArrayRef(AMDGPUElfOSABI);
6058           break;
6059         case ELF::EM_ARM:
6060           OSABI = makeArrayRef(ARMElfOSABI);
6061           break;
6062         case ELF::EM_TI_C6000:
6063           OSABI = makeArrayRef(C6000ElfOSABI);
6064           break;
6065         }
6066       }
6067       W.printEnum("OS/ABI", E->e_ident[ELF::EI_OSABI], OSABI);
6068       W.printNumber("ABIVersion", E->e_ident[ELF::EI_ABIVERSION]);
6069       W.printBinary("Unused", makeArrayRef(E->e_ident).slice(ELF::EI_PAD));
6070     }
6071 
6072     W.printEnum("Type", E->e_type, makeArrayRef(ElfObjectFileType));
6073     W.printEnum("Machine", E->e_machine, makeArrayRef(ElfMachineType));
6074     W.printNumber("Version", E->e_version);
6075     W.printHex("Entry", E->e_entry);
6076     W.printHex("ProgramHeaderOffset", E->e_phoff);
6077     W.printHex("SectionHeaderOffset", E->e_shoff);
6078     if (E->e_machine == EM_MIPS)
6079       W.printFlags("Flags", E->e_flags, makeArrayRef(ElfHeaderMipsFlags),
6080                    unsigned(ELF::EF_MIPS_ARCH), unsigned(ELF::EF_MIPS_ABI),
6081                    unsigned(ELF::EF_MIPS_MACH));
6082     else if (E->e_machine == EM_AMDGPU)
6083       W.printFlags("Flags", E->e_flags, makeArrayRef(ElfHeaderAMDGPUFlags),
6084                    unsigned(ELF::EF_AMDGPU_MACH));
6085     else if (E->e_machine == EM_RISCV)
6086       W.printFlags("Flags", E->e_flags, makeArrayRef(ElfHeaderRISCVFlags));
6087     else
6088       W.printFlags("Flags", E->e_flags);
6089     W.printNumber("HeaderSize", E->e_ehsize);
6090     W.printNumber("ProgramHeaderEntrySize", E->e_phentsize);
6091     W.printNumber("ProgramHeaderCount", E->e_phnum);
6092     W.printNumber("SectionHeaderEntrySize", E->e_shentsize);
6093     W.printString("SectionHeaderCount",
6094                   getSectionHeadersNumString(Obj, this->FileName));
6095     W.printString("StringTableSectionIndex",
6096                   getSectionHeaderTableIndexString(Obj, this->FileName));
6097   }
6098 }
6099 
6100 template <class ELFT>
6101 void LLVMStyle<ELFT>::printGroupSections(const ELFO *Obj) {
6102   DictScope Lists(W, "Groups");
6103   std::vector<GroupSection> V = getGroups<ELFT>(Obj, this->FileName);
6104   DenseMap<uint64_t, const GroupSection *> Map = mapSectionsToGroups(V);
6105   for (const GroupSection &G : V) {
6106     DictScope D(W, "Group");
6107     W.printNumber("Name", G.Name, G.ShName);
6108     W.printNumber("Index", G.Index);
6109     W.printNumber("Link", G.Link);
6110     W.printNumber("Info", G.Info);
6111     W.printHex("Type", getGroupType(G.Type), G.Type);
6112     W.startLine() << "Signature: " << G.Signature << "\n";
6113 
6114     ListScope L(W, "Section(s) in group");
6115     for (const GroupMember &GM : G.Members) {
6116       const GroupSection *MainGroup = Map[GM.Index];
6117       if (MainGroup != &G) {
6118         W.flush();
6119         errs() << "Error: " << GM.Name << " (" << GM.Index
6120                << ") in a group " + G.Name + " (" << G.Index
6121                << ") is already in a group " + MainGroup->Name + " ("
6122                << MainGroup->Index << ")\n";
6123         errs().flush();
6124         continue;
6125       }
6126       W.startLine() << GM.Name << " (" << GM.Index << ")\n";
6127     }
6128   }
6129 
6130   if (V.empty())
6131     W.startLine() << "There are no group sections in the file.\n";
6132 }
6133 
6134 template <class ELFT> void LLVMStyle<ELFT>::printRelocations(const ELFO *Obj) {
6135   ListScope D(W, "Relocations");
6136 
6137   int SectionNumber = -1;
6138   for (const Elf_Shdr &Sec : cantFail(Obj->sections())) {
6139     ++SectionNumber;
6140 
6141     if (Sec.sh_type != ELF::SHT_REL && Sec.sh_type != ELF::SHT_RELA &&
6142         Sec.sh_type != ELF::SHT_RELR && Sec.sh_type != ELF::SHT_ANDROID_REL &&
6143         Sec.sh_type != ELF::SHT_ANDROID_RELA &&
6144         Sec.sh_type != ELF::SHT_ANDROID_RELR)
6145       continue;
6146 
6147     StringRef Name = unwrapOrError(this->FileName, Obj->getSectionName(&Sec));
6148 
6149     W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";
6150     W.indent();
6151 
6152     printRelocations(&Sec, Obj);
6153 
6154     W.unindent();
6155     W.startLine() << "}\n";
6156   }
6157 }
6158 
6159 template <class ELFT>
6160 void LLVMStyle<ELFT>::printRelocations(const Elf_Shdr *Sec, const ELFO *Obj) {
6161   const Elf_Shdr *SymTab =
6162       unwrapOrError(this->FileName, Obj->getSection(Sec->sh_link));
6163   unsigned SecNdx = Sec - &cantFail(Obj->sections()).front();
6164   unsigned RelNdx = 0;
6165 
6166   switch (Sec->sh_type) {
6167   case ELF::SHT_REL:
6168     for (const Elf_Rel &R : unwrapOrError(this->FileName, Obj->rels(Sec))) {
6169       Elf_Rela Rela;
6170       Rela.r_offset = R.r_offset;
6171       Rela.r_info = R.r_info;
6172       Rela.r_addend = 0;
6173       printRelocation(Obj, SecNdx, Rela, ++RelNdx, SymTab);
6174     }
6175     break;
6176   case ELF::SHT_RELA:
6177     for (const Elf_Rela &R : unwrapOrError(this->FileName, Obj->relas(Sec)))
6178       printRelocation(Obj, SecNdx, R, ++RelNdx, SymTab);
6179     break;
6180   case ELF::SHT_RELR:
6181   case ELF::SHT_ANDROID_RELR: {
6182     Elf_Relr_Range Relrs = unwrapOrError(this->FileName, Obj->relrs(Sec));
6183     if (opts::RawRelr) {
6184       for (const Elf_Relr &R : Relrs)
6185         W.startLine() << W.hex(R) << "\n";
6186     } else {
6187       std::vector<Elf_Rela> RelrRelas =
6188           unwrapOrError(this->FileName, Obj->decode_relrs(Relrs));
6189       for (const Elf_Rela &R : RelrRelas)
6190         printRelocation(Obj, SecNdx, R, ++RelNdx, SymTab);
6191     }
6192     break;
6193   }
6194   case ELF::SHT_ANDROID_REL:
6195   case ELF::SHT_ANDROID_RELA:
6196     for (const Elf_Rela &R :
6197          unwrapOrError(this->FileName, Obj->android_relas(Sec)))
6198       printRelocation(Obj, SecNdx, R, ++RelNdx, SymTab);
6199     break;
6200   }
6201 }
6202 
6203 template <class ELFT>
6204 void LLVMStyle<ELFT>::printRelocation(const ELFO *Obj, unsigned SecIndex,
6205                                       Elf_Rela Rel, unsigned RelIndex,
6206                                       const Elf_Shdr *SymTab) {
6207   Expected<std::pair<const typename ELFT::Sym *, std::string>> Target =
6208       this->dumper()->getRelocationTarget(SymTab, Rel);
6209   if (!Target) {
6210     this->reportUniqueWarning(createError(
6211         "unable to print relocation " + Twine(RelIndex) + " in section " +
6212         Twine(SecIndex) + ": " + toString(Target.takeError())));
6213     return;
6214   }
6215 
6216   std::string TargetName = Target->second;
6217   SmallString<32> RelocName;
6218   Obj->getRelocationTypeName(Rel.getType(Obj->isMips64EL()), RelocName);
6219 
6220   if (opts::ExpandRelocs) {
6221     DictScope Group(W, "Relocation");
6222     W.printHex("Offset", Rel.r_offset);
6223     W.printNumber("Type", RelocName, (int)Rel.getType(Obj->isMips64EL()));
6224     W.printNumber("Symbol", !TargetName.empty() ? TargetName : "-",
6225                   Rel.getSymbol(Obj->isMips64EL()));
6226     W.printHex("Addend", Rel.r_addend);
6227   } else {
6228     raw_ostream &OS = W.startLine();
6229     OS << W.hex(Rel.r_offset) << " " << RelocName << " "
6230        << (!TargetName.empty() ? TargetName : "-") << " " << W.hex(Rel.r_addend)
6231        << "\n";
6232   }
6233 }
6234 
6235 template <class ELFT>
6236 void LLVMStyle<ELFT>::printSectionHeaders(const ELFO *Obj) {
6237   ListScope SectionsD(W, "Sections");
6238 
6239   int SectionIndex = -1;
6240   std::vector<EnumEntry<unsigned>> FlagsList =
6241       getSectionFlagsForTarget(Obj->getHeader()->e_machine);
6242   for (const Elf_Shdr &Sec : cantFail(Obj->sections())) {
6243     StringRef Name = "<?>";
6244     if (Expected<StringRef> SecNameOrErr =
6245             Obj->getSectionName(&Sec, this->dumper()->WarningHandler))
6246       Name = *SecNameOrErr;
6247     else
6248       this->reportUniqueWarning(SecNameOrErr.takeError());
6249 
6250     DictScope SectionD(W, "Section");
6251     W.printNumber("Index", ++SectionIndex);
6252     W.printNumber("Name", Name, Sec.sh_name);
6253     W.printHex(
6254         "Type",
6255         object::getELFSectionTypeName(Obj->getHeader()->e_machine, Sec.sh_type),
6256         Sec.sh_type);
6257     W.printFlags("Flags", Sec.sh_flags, makeArrayRef(FlagsList));
6258     W.printHex("Address", Sec.sh_addr);
6259     W.printHex("Offset", Sec.sh_offset);
6260     W.printNumber("Size", Sec.sh_size);
6261     W.printNumber("Link", Sec.sh_link);
6262     W.printNumber("Info", Sec.sh_info);
6263     W.printNumber("AddressAlignment", Sec.sh_addralign);
6264     W.printNumber("EntrySize", Sec.sh_entsize);
6265 
6266     if (opts::SectionRelocations) {
6267       ListScope D(W, "Relocations");
6268       printRelocations(&Sec, Obj);
6269     }
6270 
6271     if (opts::SectionSymbols) {
6272       ListScope D(W, "Symbols");
6273       const Elf_Shdr *Symtab = this->dumper()->getDotSymtabSec();
6274       StringRef StrTable =
6275           unwrapOrError(this->FileName, Obj->getStringTableForSymtab(*Symtab));
6276 
6277       for (const Elf_Sym &Sym :
6278            unwrapOrError(this->FileName, Obj->symbols(Symtab))) {
6279         const Elf_Shdr *SymSec = unwrapOrError(
6280             this->FileName,
6281             Obj->getSection(&Sym, Symtab, this->dumper()->getShndxTable()));
6282         if (SymSec == &Sec)
6283           printSymbol(
6284               Obj, &Sym,
6285               unwrapOrError(this->FileName, Obj->symbols(Symtab)).begin(),
6286               StrTable, false, false);
6287       }
6288     }
6289 
6290     if (opts::SectionData && Sec.sh_type != ELF::SHT_NOBITS) {
6291       ArrayRef<uint8_t> Data =
6292           unwrapOrError(this->FileName, Obj->getSectionContents(&Sec));
6293       W.printBinaryBlock(
6294           "SectionData",
6295           StringRef(reinterpret_cast<const char *>(Data.data()), Data.size()));
6296     }
6297   }
6298 }
6299 
6300 template <class ELFT>
6301 void LLVMStyle<ELFT>::printSymbolSection(const Elf_Sym *Symbol,
6302                                          const Elf_Sym *First) {
6303   Expected<unsigned> SectionIndex =
6304       this->dumper()->getSymbolSectionIndex(Symbol, First);
6305   if (!SectionIndex) {
6306     assert(Symbol->st_shndx == SHN_XINDEX &&
6307            "getSymbolSectionIndex should only fail due to an invalid "
6308            "SHT_SYMTAB_SHNDX table/reference");
6309     this->reportUniqueWarning(SectionIndex.takeError());
6310     W.printHex("Section", "Reserved", SHN_XINDEX);
6311     return;
6312   }
6313 
6314   Expected<StringRef> SectionName =
6315       this->dumper()->getSymbolSectionName(Symbol, *SectionIndex);
6316   if (!SectionName) {
6317     // Don't report an invalid section name if the section headers are missing.
6318     // In such situations, all sections will be "invalid".
6319     if (!this->dumper()->getElfObject()->sections().empty())
6320       this->reportUniqueWarning(SectionName.takeError());
6321     else
6322       consumeError(SectionName.takeError());
6323     W.printHex("Section", "<?>", *SectionIndex);
6324   } else {
6325     W.printHex("Section", *SectionName, *SectionIndex);
6326   }
6327 }
6328 
6329 template <class ELFT>
6330 void LLVMStyle<ELFT>::printSymbol(const ELFO *Obj, const Elf_Sym *Symbol,
6331                                   const Elf_Sym *First,
6332                                   Optional<StringRef> StrTable, bool IsDynamic,
6333                                   bool /*NonVisibilityBitsUsed*/) {
6334   std::string FullSymbolName =
6335       this->dumper()->getFullSymbolName(Symbol, StrTable, IsDynamic);
6336   unsigned char SymbolType = Symbol->getType();
6337 
6338   DictScope D(W, "Symbol");
6339   W.printNumber("Name", FullSymbolName, Symbol->st_name);
6340   W.printHex("Value", Symbol->st_value);
6341   W.printNumber("Size", Symbol->st_size);
6342   W.printEnum("Binding", Symbol->getBinding(), makeArrayRef(ElfSymbolBindings));
6343   if (Obj->getHeader()->e_machine == ELF::EM_AMDGPU &&
6344       SymbolType >= ELF::STT_LOOS && SymbolType < ELF::STT_HIOS)
6345     W.printEnum("Type", SymbolType, makeArrayRef(AMDGPUSymbolTypes));
6346   else
6347     W.printEnum("Type", SymbolType, makeArrayRef(ElfSymbolTypes));
6348   if (Symbol->st_other == 0)
6349     // Usually st_other flag is zero. Do not pollute the output
6350     // by flags enumeration in that case.
6351     W.printNumber("Other", 0);
6352   else {
6353     std::vector<EnumEntry<unsigned>> SymOtherFlags(std::begin(ElfSymOtherFlags),
6354                                                    std::end(ElfSymOtherFlags));
6355     if (Obj->getHeader()->e_machine == EM_MIPS) {
6356       // Someones in their infinite wisdom decided to make STO_MIPS_MIPS16
6357       // flag overlapped with other ST_MIPS_xxx flags. So consider both
6358       // cases separately.
6359       if ((Symbol->st_other & STO_MIPS_MIPS16) == STO_MIPS_MIPS16)
6360         SymOtherFlags.insert(SymOtherFlags.end(),
6361                              std::begin(ElfMips16SymOtherFlags),
6362                              std::end(ElfMips16SymOtherFlags));
6363       else
6364         SymOtherFlags.insert(SymOtherFlags.end(),
6365                              std::begin(ElfMipsSymOtherFlags),
6366                              std::end(ElfMipsSymOtherFlags));
6367     }
6368     W.printFlags("Other", Symbol->st_other, makeArrayRef(SymOtherFlags), 0x3u);
6369   }
6370   printSymbolSection(Symbol, First);
6371 }
6372 
6373 template <class ELFT>
6374 void LLVMStyle<ELFT>::printSymbols(const ELFO *Obj, bool PrintSymbols,
6375                                    bool PrintDynamicSymbols) {
6376   if (PrintSymbols)
6377     printSymbols(Obj);
6378   if (PrintDynamicSymbols)
6379     printDynamicSymbols(Obj);
6380 }
6381 
6382 template <class ELFT> void LLVMStyle<ELFT>::printSymbols(const ELFO *Obj) {
6383   ListScope Group(W, "Symbols");
6384   this->dumper()->printSymbolsHelper(false);
6385 }
6386 
6387 template <class ELFT>
6388 void LLVMStyle<ELFT>::printDynamicSymbols(const ELFO *Obj) {
6389   ListScope Group(W, "DynamicSymbols");
6390   this->dumper()->printSymbolsHelper(true);
6391 }
6392 
6393 template <class ELFT> void LLVMStyle<ELFT>::printDynamic(const ELFFile<ELFT> *Obj) {
6394   Elf_Dyn_Range Table = this->dumper()->dynamic_table();
6395   if (Table.empty())
6396     return;
6397 
6398   W.startLine() << "DynamicSection [ (" << Table.size() << " entries)\n";
6399 
6400   size_t MaxTagSize = getMaxDynamicTagSize(Obj, Table);
6401   // The "Name/Value" column should be indented from the "Type" column by N
6402   // spaces, where N = MaxTagSize - length of "Type" (4) + trailing
6403   // space (1) = -3.
6404   W.startLine() << "  Tag" << std::string(ELFT::Is64Bits ? 16 : 8, ' ')
6405                 << "Type" << std::string(MaxTagSize - 3, ' ') << "Name/Value\n";
6406 
6407   std::string ValueFmt = "%-" + std::to_string(MaxTagSize) + "s ";
6408   for (auto Entry : Table) {
6409     uintX_t Tag = Entry.getTag();
6410     std::string Value = this->dumper()->getDynamicEntry(Tag, Entry.getVal());
6411     W.startLine() << "  " << format_hex(Tag, ELFT::Is64Bits ? 18 : 10, true)
6412                   << " "
6413                   << format(ValueFmt.c_str(),
6414                             Obj->getDynamicTagAsString(Tag).c_str())
6415                   << Value << "\n";
6416   }
6417   W.startLine() << "]\n";
6418 }
6419 
6420 template <class ELFT>
6421 void LLVMStyle<ELFT>::printDynamicRelocations(const ELFO *Obj) {
6422   const DynRegionInfo &DynRelRegion = this->dumper()->getDynRelRegion();
6423   const DynRegionInfo &DynRelaRegion = this->dumper()->getDynRelaRegion();
6424   const DynRegionInfo &DynRelrRegion = this->dumper()->getDynRelrRegion();
6425   const DynRegionInfo &DynPLTRelRegion = this->dumper()->getDynPLTRelRegion();
6426 
6427   W.startLine() << "Dynamic Relocations {\n";
6428   W.indent();
6429   if (DynRelaRegion.Size > 0) {
6430     for (const Elf_Rela &Rela : this->dumper()->dyn_relas())
6431       printDynamicRelocation(Obj, Rela);
6432   }
6433   if (DynRelRegion.Size > 0) {
6434     for (const Elf_Rel &Rel : this->dumper()->dyn_rels()) {
6435       Elf_Rela Rela;
6436       Rela.r_offset = Rel.r_offset;
6437       Rela.r_info = Rel.r_info;
6438       Rela.r_addend = 0;
6439       printDynamicRelocation(Obj, Rela);
6440     }
6441   }
6442 
6443   if (DynRelrRegion.Size > 0) {
6444     Elf_Relr_Range Relrs = this->dumper()->dyn_relrs();
6445     std::vector<Elf_Rela> RelrRelas =
6446         unwrapOrError(this->FileName, Obj->decode_relrs(Relrs));
6447     for (const Elf_Rela &Rela : RelrRelas)
6448       printDynamicRelocation(Obj, Rela);
6449   }
6450   if (DynPLTRelRegion.EntSize == sizeof(Elf_Rela))
6451     for (const Elf_Rela &Rela : DynPLTRelRegion.getAsArrayRef<Elf_Rela>())
6452       printDynamicRelocation(Obj, Rela);
6453   else
6454     for (const Elf_Rel &Rel : DynPLTRelRegion.getAsArrayRef<Elf_Rel>()) {
6455       Elf_Rela Rela;
6456       Rela.r_offset = Rel.r_offset;
6457       Rela.r_info = Rel.r_info;
6458       Rela.r_addend = 0;
6459       printDynamicRelocation(Obj, Rela);
6460     }
6461   W.unindent();
6462   W.startLine() << "}\n";
6463 }
6464 
6465 template <class ELFT>
6466 void LLVMStyle<ELFT>::printDynamicRelocation(const ELFO *Obj, Elf_Rela Rel) {
6467   SmallString<32> RelocName;
6468   Obj->getRelocationTypeName(Rel.getType(Obj->isMips64EL()), RelocName);
6469   std::string SymbolName =
6470       getSymbolForReloc(Obj, this->FileName, this->dumper(), Rel).Name;
6471 
6472   if (opts::ExpandRelocs) {
6473     DictScope Group(W, "Relocation");
6474     W.printHex("Offset", Rel.r_offset);
6475     W.printNumber("Type", RelocName, (int)Rel.getType(Obj->isMips64EL()));
6476     W.printString("Symbol", !SymbolName.empty() ? SymbolName : "-");
6477     W.printHex("Addend", Rel.r_addend);
6478   } else {
6479     raw_ostream &OS = W.startLine();
6480     OS << W.hex(Rel.r_offset) << " " << RelocName << " "
6481        << (!SymbolName.empty() ? SymbolName : "-") << " " << W.hex(Rel.r_addend)
6482        << "\n";
6483   }
6484 }
6485 
6486 template <class ELFT>
6487 void LLVMStyle<ELFT>::printProgramHeaders(
6488     const ELFO *Obj, bool PrintProgramHeaders,
6489     cl::boolOrDefault PrintSectionMapping) {
6490   if (PrintProgramHeaders)
6491     printProgramHeaders(Obj);
6492   if (PrintSectionMapping == cl::BOU_TRUE)
6493     printSectionMapping(Obj);
6494 }
6495 
6496 template <class ELFT>
6497 void LLVMStyle<ELFT>::printProgramHeaders(const ELFO *Obj) {
6498   ListScope L(W, "ProgramHeaders");
6499 
6500   for (const Elf_Phdr &Phdr :
6501        unwrapOrError(this->FileName, Obj->program_headers())) {
6502     DictScope P(W, "ProgramHeader");
6503     W.printHex("Type",
6504                getElfSegmentType(Obj->getHeader()->e_machine, Phdr.p_type),
6505                Phdr.p_type);
6506     W.printHex("Offset", Phdr.p_offset);
6507     W.printHex("VirtualAddress", Phdr.p_vaddr);
6508     W.printHex("PhysicalAddress", Phdr.p_paddr);
6509     W.printNumber("FileSize", Phdr.p_filesz);
6510     W.printNumber("MemSize", Phdr.p_memsz);
6511     W.printFlags("Flags", Phdr.p_flags, makeArrayRef(ElfSegmentFlags));
6512     W.printNumber("Alignment", Phdr.p_align);
6513   }
6514 }
6515 
6516 template <class ELFT>
6517 void LLVMStyle<ELFT>::printVersionSymbolSection(const ELFFile<ELFT> *Obj,
6518                                                 const Elf_Shdr *Sec) {
6519   ListScope SS(W, "VersionSymbols");
6520   if (!Sec)
6521     return;
6522 
6523   StringRef StrTable;
6524   ArrayRef<Elf_Sym> Syms;
6525   Expected<ArrayRef<Elf_Versym>> VerTableOrErr =
6526       this->dumper()->getVersionTable(Sec, &Syms, &StrTable);
6527   if (!VerTableOrErr) {
6528     this->reportUniqueWarning(VerTableOrErr.takeError());
6529     return;
6530   }
6531 
6532   if (StrTable.empty() || Syms.empty() || Syms.size() != VerTableOrErr->size())
6533     return;
6534 
6535   for (size_t I = 0, E = Syms.size(); I < E; ++I) {
6536     DictScope S(W, "Symbol");
6537     W.printNumber("Version", (*VerTableOrErr)[I].vs_index & VERSYM_VERSION);
6538     W.printString("Name", this->dumper()->getFullSymbolName(
6539                               &Syms[I], StrTable, /*IsDynamic=*/true));
6540   }
6541 }
6542 
6543 template <class ELFT>
6544 void LLVMStyle<ELFT>::printVersionDefinitionSection(const ELFFile<ELFT> *Obj,
6545                                                     const Elf_Shdr *Sec) {
6546   ListScope SD(W, "VersionDefinitions");
6547   if (!Sec)
6548     return;
6549 
6550   Expected<std::vector<VerDef>> V = this->dumper()->getVersionDefinitions(Sec);
6551   if (!V) {
6552     this->reportUniqueWarning(V.takeError());
6553     return;
6554   }
6555 
6556   for (const VerDef &D : *V) {
6557     DictScope Def(W, "Definition");
6558     W.printNumber("Version", D.Version);
6559     W.printFlags("Flags", D.Flags, makeArrayRef(SymVersionFlags));
6560     W.printNumber("Index", D.Ndx);
6561     W.printNumber("Hash", D.Hash);
6562     W.printString("Name", D.Name.c_str());
6563     W.printList(
6564         "Predecessors", D.AuxV,
6565         [](raw_ostream &OS, const VerdAux &Aux) { OS << Aux.Name.c_str(); });
6566   }
6567 }
6568 
6569 template <class ELFT>
6570 void LLVMStyle<ELFT>::printVersionDependencySection(const ELFFile<ELFT> *Obj,
6571                                                     const Elf_Shdr *Sec) {
6572   ListScope SD(W, "VersionRequirements");
6573   if (!Sec)
6574     return;
6575 
6576   Expected<std::vector<VerNeed>> V =
6577       this->dumper()->getVersionDependencies(Sec);
6578   if (!V) {
6579     this->reportUniqueWarning(V.takeError());
6580     return;
6581   }
6582 
6583   for (const VerNeed &VN : *V) {
6584     DictScope Entry(W, "Dependency");
6585     W.printNumber("Version", VN.Version);
6586     W.printNumber("Count", VN.Cnt);
6587     W.printString("FileName", VN.File.c_str());
6588 
6589     ListScope L(W, "Entries");
6590     for (const VernAux &Aux : VN.AuxV) {
6591       DictScope Entry(W, "Entry");
6592       W.printNumber("Hash", Aux.Hash);
6593       W.printFlags("Flags", Aux.Flags, makeArrayRef(SymVersionFlags));
6594       W.printNumber("Index", Aux.Other);
6595       W.printString("Name", Aux.Name.c_str());
6596     }
6597   }
6598 }
6599 
6600 template <class ELFT>
6601 void LLVMStyle<ELFT>::printHashHistograms(const ELFFile<ELFT> *Obj) {
6602   W.startLine() << "Hash Histogram not implemented!\n";
6603 }
6604 
6605 template <class ELFT>
6606 void LLVMStyle<ELFT>::printCGProfile(const ELFFile<ELFT> *Obj) {
6607   ListScope L(W, "CGProfile");
6608   if (!this->dumper()->getDotCGProfileSec())
6609     return;
6610 
6611   Expected<ArrayRef<Elf_CGProfile>> CGProfileOrErr =
6612       Obj->template getSectionContentsAsArray<Elf_CGProfile>(
6613           this->dumper()->getDotCGProfileSec());
6614   if (!CGProfileOrErr) {
6615     this->reportUniqueWarning(
6616         createError("unable to dump the SHT_LLVM_CALL_GRAPH_PROFILE section: " +
6617                     toString(CGProfileOrErr.takeError())));
6618     return;
6619   }
6620 
6621   for (const Elf_CGProfile &CGPE : *CGProfileOrErr) {
6622     DictScope D(W, "CGProfileEntry");
6623     W.printNumber("From", this->dumper()->getStaticSymbolName(CGPE.cgp_from),
6624                   CGPE.cgp_from);
6625     W.printNumber("To", this->dumper()->getStaticSymbolName(CGPE.cgp_to),
6626                   CGPE.cgp_to);
6627     W.printNumber("Weight", CGPE.cgp_weight);
6628   }
6629 }
6630 
6631 static Expected<std::vector<uint64_t>> toULEB128Array(ArrayRef<uint8_t> Data) {
6632   std::vector<uint64_t> Ret;
6633   const uint8_t *Cur = Data.begin();
6634   const uint8_t *End = Data.end();
6635   while (Cur != End) {
6636     unsigned Size;
6637     const char *Err;
6638     Ret.push_back(decodeULEB128(Cur, &Size, End, &Err));
6639     if (Err)
6640       return createError(Err);
6641     Cur += Size;
6642   }
6643   return Ret;
6644 }
6645 
6646 template <class ELFT>
6647 void LLVMStyle<ELFT>::printAddrsig(const ELFFile<ELFT> *Obj) {
6648   ListScope L(W, "Addrsig");
6649   if (!this->dumper()->getDotAddrsigSec())
6650     return;
6651   ArrayRef<uint8_t> Contents = unwrapOrError(
6652       this->FileName,
6653       Obj->getSectionContents(this->dumper()->getDotAddrsigSec()));
6654   Expected<std::vector<uint64_t>> V = toULEB128Array(Contents);
6655   if (!V) {
6656     reportWarning(V.takeError(), this->FileName);
6657     return;
6658   }
6659 
6660   for (uint64_t Sym : *V) {
6661     Expected<std::string> NameOrErr = this->dumper()->getStaticSymbolName(Sym);
6662     if (NameOrErr) {
6663       W.printNumber("Sym", *NameOrErr, Sym);
6664       continue;
6665     }
6666     reportWarning(NameOrErr.takeError(), this->FileName);
6667     W.printNumber("Sym", "<?>", Sym);
6668   }
6669 }
6670 
6671 template <typename ELFT>
6672 static void printGNUNoteLLVMStyle(uint32_t NoteType, ArrayRef<uint8_t> Desc,
6673                                   ScopedPrinter &W) {
6674   switch (NoteType) {
6675   default:
6676     return;
6677   case ELF::NT_GNU_ABI_TAG: {
6678     const GNUAbiTag &AbiTag = getGNUAbiTag<ELFT>(Desc);
6679     if (!AbiTag.IsValid) {
6680       W.printString("ABI", "<corrupt GNU_ABI_TAG>");
6681     } else {
6682       W.printString("OS", AbiTag.OSName);
6683       W.printString("ABI", AbiTag.ABI);
6684     }
6685     break;
6686   }
6687   case ELF::NT_GNU_BUILD_ID: {
6688     W.printString("Build ID", getGNUBuildId(Desc));
6689     break;
6690   }
6691   case ELF::NT_GNU_GOLD_VERSION:
6692     W.printString("Version", getGNUGoldVersion(Desc));
6693     break;
6694   case ELF::NT_GNU_PROPERTY_TYPE_0:
6695     ListScope D(W, "Property");
6696     for (const auto &Property : getGNUPropertyList<ELFT>(Desc))
6697       W.printString(Property);
6698     break;
6699   }
6700 }
6701 
6702 static void printCoreNoteLLVMStyle(const CoreNote &Note, ScopedPrinter &W) {
6703   W.printNumber("Page Size", Note.PageSize);
6704   for (const CoreFileMapping &Mapping : Note.Mappings) {
6705     ListScope D(W, "Mapping");
6706     W.printHex("Start", Mapping.Start);
6707     W.printHex("End", Mapping.End);
6708     W.printHex("Offset", Mapping.Offset);
6709     W.printString("Filename", Mapping.Filename);
6710   }
6711 }
6712 
6713 template <class ELFT>
6714 void LLVMStyle<ELFT>::printNotes(const ELFFile<ELFT> *Obj) {
6715   ListScope L(W, "Notes");
6716 
6717   auto PrintHeader = [&](Optional<StringRef> SecName,
6718                          const typename ELFT::Off Offset,
6719                          const typename ELFT::Addr Size) {
6720     W.printString("Name", SecName ? *SecName : "<?>");
6721     W.printHex("Offset", Offset);
6722     W.printHex("Size", Size);
6723   };
6724 
6725   auto ProcessNote = [&](const Elf_Note &Note) {
6726     DictScope D2(W, "Note");
6727     StringRef Name = Note.getName();
6728     ArrayRef<uint8_t> Descriptor = Note.getDesc();
6729     Elf_Word Type = Note.getType();
6730 
6731     // Print the note owner/type.
6732     W.printString("Owner", Name);
6733     W.printHex("Data size", Descriptor.size());
6734     if (Name == "GNU") {
6735       W.printString("Type", getGNUNoteTypeName(Type));
6736     } else if (Name == "FreeBSD") {
6737       W.printString("Type", getFreeBSDNoteTypeName(Type));
6738     } else if (Name == "AMD") {
6739       W.printString("Type", getAMDNoteTypeName(Type));
6740     } else if (Name == "AMDGPU") {
6741       W.printString("Type", getAMDGPUNoteTypeName(Type));
6742     } else {
6743       StringRef NoteType = Obj->getHeader()->e_type == ELF::ET_CORE
6744                                ? getCoreNoteTypeName(Type)
6745                                : getGenericNoteTypeName(Type);
6746       if (!NoteType.empty())
6747         W.printString("Type", NoteType);
6748       else
6749         W.printString("Type",
6750                       "Unknown (" + to_string(format_hex(Type, 10)) + ")");
6751     }
6752 
6753     // Print the description, or fallback to printing raw bytes for unknown
6754     // owners.
6755     if (Name == "GNU") {
6756       printGNUNoteLLVMStyle<ELFT>(Type, Descriptor, W);
6757     } else if (Name == "AMD") {
6758       const AMDNote N = getAMDNote<ELFT>(Type, Descriptor);
6759       if (!N.Type.empty())
6760         W.printString(N.Type, N.Value);
6761     } else if (Name == "AMDGPU") {
6762       const AMDGPUNote N = getAMDGPUNote<ELFT>(Type, Descriptor);
6763       if (!N.Type.empty())
6764         W.printString(N.Type, N.Value);
6765     } else if (Name == "CORE") {
6766       if (Type == ELF::NT_FILE) {
6767         DataExtractor DescExtractor(Descriptor,
6768                                     ELFT::TargetEndianness == support::little,
6769                                     sizeof(Elf_Addr));
6770         Expected<CoreNote> Note = readCoreNote(DescExtractor);
6771         if (Note)
6772           printCoreNoteLLVMStyle(*Note, W);
6773         else
6774           reportWarning(Note.takeError(), this->FileName);
6775       }
6776     } else if (!Descriptor.empty()) {
6777       W.printBinaryBlock("Description data", Descriptor);
6778     }
6779   };
6780 
6781   ArrayRef<Elf_Shdr> Sections = cantFail(Obj->sections());
6782   if (Obj->getHeader()->e_type != ELF::ET_CORE && !Sections.empty()) {
6783     for (const auto &S : Sections) {
6784       if (S.sh_type != SHT_NOTE)
6785         continue;
6786       DictScope D(W, "NoteSection");
6787       PrintHeader(expectedToOptional(Obj->getSectionName(&S)), S.sh_offset,
6788                   S.sh_size);
6789       Error Err = Error::success();
6790       for (auto Note : Obj->notes(S, Err))
6791         ProcessNote(Note);
6792       if (Err)
6793         reportError(std::move(Err), this->FileName);
6794     }
6795   } else {
6796     for (const auto &P :
6797          unwrapOrError(this->FileName, Obj->program_headers())) {
6798       if (P.p_type != PT_NOTE)
6799         continue;
6800       DictScope D(W, "NoteSection");
6801       PrintHeader(/*SecName=*/None, P.p_offset, P.p_filesz);
6802       Error Err = Error::success();
6803       for (auto Note : Obj->notes(P, Err))
6804         ProcessNote(Note);
6805       if (Err)
6806         reportError(std::move(Err), this->FileName);
6807     }
6808   }
6809 }
6810 
6811 template <class ELFT>
6812 void LLVMStyle<ELFT>::printELFLinkerOptions(const ELFFile<ELFT> *Obj) {
6813   ListScope L(W, "LinkerOptions");
6814 
6815   unsigned I = -1;
6816   for (const Elf_Shdr &Shdr : cantFail(Obj->sections())) {
6817     ++I;
6818     if (Shdr.sh_type != ELF::SHT_LLVM_LINKER_OPTIONS)
6819       continue;
6820 
6821     Expected<ArrayRef<uint8_t>> ContentsOrErr = Obj->getSectionContents(&Shdr);
6822     if (!ContentsOrErr) {
6823       this->reportUniqueWarning(
6824           createError("unable to read the content of the "
6825                       "SHT_LLVM_LINKER_OPTIONS section: " +
6826                       toString(ContentsOrErr.takeError())));
6827       continue;
6828     }
6829     if (ContentsOrErr->empty())
6830       continue;
6831 
6832     if (ContentsOrErr->back() != 0) {
6833       this->reportUniqueWarning(
6834           createError("SHT_LLVM_LINKER_OPTIONS section at index " + Twine(I) +
6835                       " is broken: the "
6836                       "content is not null-terminated"));
6837       continue;
6838     }
6839 
6840     SmallVector<StringRef, 16> Strings;
6841     toStringRef(ContentsOrErr->drop_back()).split(Strings, '\0');
6842     if (Strings.size() % 2 != 0) {
6843       this->reportUniqueWarning(createError(
6844           "SHT_LLVM_LINKER_OPTIONS section at index " + Twine(I) +
6845           " is broken: an incomplete "
6846           "key-value pair was found. The last possible key was: \"" +
6847           Strings.back() + "\""));
6848       continue;
6849     }
6850 
6851     for (size_t I = 0; I < Strings.size(); I += 2)
6852       W.printString(Strings[I], Strings[I + 1]);
6853   }
6854 }
6855 
6856 template <class ELFT>
6857 void LLVMStyle<ELFT>::printDependentLibs(const ELFFile<ELFT> *Obj) {
6858   ListScope L(W, "DependentLibs");
6859   this->printDependentLibsHelper(
6860       Obj, [](const Elf_Shdr &) {},
6861       [this](StringRef Lib, uint64_t) { W.printString(Lib); });
6862 }
6863 
6864 template <class ELFT>
6865 void LLVMStyle<ELFT>::printStackSizes(const ELFObjectFile<ELFT> *Obj) {
6866   ListScope L(W, "StackSizes");
6867   if (Obj->isRelocatableObject())
6868     this->printRelocatableStackSizes(Obj, []() {});
6869   else
6870     this->printNonRelocatableStackSizes(Obj, []() {});
6871 }
6872 
6873 template <class ELFT>
6874 void LLVMStyle<ELFT>::printStackSizeEntry(uint64_t Size, StringRef FuncName) {
6875   DictScope D(W, "Entry");
6876   W.printString("Function", FuncName);
6877   W.printHex("Size", Size);
6878 }
6879 
6880 template <class ELFT>
6881 void LLVMStyle<ELFT>::printMipsGOT(const MipsGOTParser<ELFT> &Parser) {
6882   auto PrintEntry = [&](const Elf_Addr *E) {
6883     W.printHex("Address", Parser.getGotAddress(E));
6884     W.printNumber("Access", Parser.getGotOffset(E));
6885     W.printHex("Initial", *E);
6886   };
6887 
6888   DictScope GS(W, Parser.IsStatic ? "Static GOT" : "Primary GOT");
6889 
6890   W.printHex("Canonical gp value", Parser.getGp());
6891   {
6892     ListScope RS(W, "Reserved entries");
6893     {
6894       DictScope D(W, "Entry");
6895       PrintEntry(Parser.getGotLazyResolver());
6896       W.printString("Purpose", StringRef("Lazy resolver"));
6897     }
6898 
6899     if (Parser.getGotModulePointer()) {
6900       DictScope D(W, "Entry");
6901       PrintEntry(Parser.getGotModulePointer());
6902       W.printString("Purpose", StringRef("Module pointer (GNU extension)"));
6903     }
6904   }
6905   {
6906     ListScope LS(W, "Local entries");
6907     for (auto &E : Parser.getLocalEntries()) {
6908       DictScope D(W, "Entry");
6909       PrintEntry(&E);
6910     }
6911   }
6912 
6913   if (Parser.IsStatic)
6914     return;
6915 
6916   {
6917     ListScope GS(W, "Global entries");
6918     for (auto &E : Parser.getGlobalEntries()) {
6919       DictScope D(W, "Entry");
6920 
6921       PrintEntry(&E);
6922 
6923       const Elf_Sym *Sym = Parser.getGotSym(&E);
6924       W.printHex("Value", Sym->st_value);
6925       W.printEnum("Type", Sym->getType(), makeArrayRef(ElfSymbolTypes));
6926       printSymbolSection(Sym, this->dumper()->dynamic_symbols().begin());
6927 
6928       std::string SymName = this->dumper()->getFullSymbolName(
6929           Sym, this->dumper()->getDynamicStringTable(), true);
6930       W.printNumber("Name", SymName, Sym->st_name);
6931     }
6932   }
6933 
6934   W.printNumber("Number of TLS and multi-GOT entries",
6935                 uint64_t(Parser.getOtherEntries().size()));
6936 }
6937 
6938 template <class ELFT>
6939 void LLVMStyle<ELFT>::printMipsPLT(const MipsGOTParser<ELFT> &Parser) {
6940   auto PrintEntry = [&](const Elf_Addr *E) {
6941     W.printHex("Address", Parser.getPltAddress(E));
6942     W.printHex("Initial", *E);
6943   };
6944 
6945   DictScope GS(W, "PLT GOT");
6946 
6947   {
6948     ListScope RS(W, "Reserved entries");
6949     {
6950       DictScope D(W, "Entry");
6951       PrintEntry(Parser.getPltLazyResolver());
6952       W.printString("Purpose", StringRef("PLT lazy resolver"));
6953     }
6954 
6955     if (auto E = Parser.getPltModulePointer()) {
6956       DictScope D(W, "Entry");
6957       PrintEntry(E);
6958       W.printString("Purpose", StringRef("Module pointer"));
6959     }
6960   }
6961   {
6962     ListScope LS(W, "Entries");
6963     for (auto &E : Parser.getPltEntries()) {
6964       DictScope D(W, "Entry");
6965       PrintEntry(&E);
6966 
6967       const Elf_Sym *Sym = Parser.getPltSym(&E);
6968       W.printHex("Value", Sym->st_value);
6969       W.printEnum("Type", Sym->getType(), makeArrayRef(ElfSymbolTypes));
6970       printSymbolSection(Sym, this->dumper()->dynamic_symbols().begin());
6971 
6972       std::string SymName =
6973           this->dumper()->getFullSymbolName(Sym, Parser.getPltStrTable(), true);
6974       W.printNumber("Name", SymName, Sym->st_name);
6975     }
6976   }
6977 }
6978 
6979 template <class ELFT>
6980 void LLVMStyle<ELFT>::printMipsABIFlags(const ELFObjectFile<ELFT> *ObjF) {
6981   const ELFFile<ELFT> *Obj = ObjF->getELFFile();
6982   const Elf_Shdr *Shdr =
6983       findSectionByName(*Obj, ObjF->getFileName(), ".MIPS.abiflags");
6984   if (!Shdr) {
6985     W.startLine() << "There is no .MIPS.abiflags section in the file.\n";
6986     return;
6987   }
6988   ArrayRef<uint8_t> Sec =
6989       unwrapOrError(ObjF->getFileName(), Obj->getSectionContents(Shdr));
6990   if (Sec.size() != sizeof(Elf_Mips_ABIFlags<ELFT>)) {
6991     W.startLine() << "The .MIPS.abiflags section has a wrong size.\n";
6992     return;
6993   }
6994 
6995   auto *Flags = reinterpret_cast<const Elf_Mips_ABIFlags<ELFT> *>(Sec.data());
6996 
6997   raw_ostream &OS = W.getOStream();
6998   DictScope GS(W, "MIPS ABI Flags");
6999 
7000   W.printNumber("Version", Flags->version);
7001   W.startLine() << "ISA: ";
7002   if (Flags->isa_rev <= 1)
7003     OS << format("MIPS%u", Flags->isa_level);
7004   else
7005     OS << format("MIPS%ur%u", Flags->isa_level, Flags->isa_rev);
7006   OS << "\n";
7007   W.printEnum("ISA Extension", Flags->isa_ext, makeArrayRef(ElfMipsISAExtType));
7008   W.printFlags("ASEs", Flags->ases, makeArrayRef(ElfMipsASEFlags));
7009   W.printEnum("FP ABI", Flags->fp_abi, makeArrayRef(ElfMipsFpABIType));
7010   W.printNumber("GPR size", getMipsRegisterSize(Flags->gpr_size));
7011   W.printNumber("CPR1 size", getMipsRegisterSize(Flags->cpr1_size));
7012   W.printNumber("CPR2 size", getMipsRegisterSize(Flags->cpr2_size));
7013   W.printFlags("Flags 1", Flags->flags1, makeArrayRef(ElfMipsFlags1));
7014   W.printHex("Flags 2", Flags->flags2);
7015 }
7016