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