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   auto WarnAndReturn = [this](const Twine &Msg) {
2562     reportUniqueWarning(createError(Msg));
2563     return "<?>";
2564   };
2565 
2566   if (DynamicStringTable.empty() && !DynamicStringTable.data())
2567     return WarnAndReturn("string table was not found");
2568 
2569   if (Value < DynamicStringTable.size())
2570     return DynamicStringTable.data() + Value;
2571 
2572   const uint64_t Offset =
2573       (const uint8_t *)DynamicStringTable.data() - ObjF->getELFFile()->base();
2574   return WarnAndReturn(
2575       "string table at offset 0x" + Twine::utohexstr(Offset) +
2576       ": unable to read the string at 0x" + Twine::utohexstr(Offset + Value) +
2577       ", it goes past the end of the table (0x" +
2578       Twine::utohexstr(Offset + DynamicStringTable.size()) + ")");
2579 }
2580 
2581 template <class ELFT> void ELFDumper<ELFT>::printUnwindInfo() {
2582   DwarfCFIEH::PrinterContext<ELFT> Ctx(W, ObjF);
2583   Ctx.printUnwindInformation();
2584 }
2585 
2586 namespace {
2587 
2588 template <> void ELFDumper<ELF32LE>::printUnwindInfo() {
2589   const ELFFile<ELF32LE> *Obj = ObjF->getELFFile();
2590   const unsigned Machine = Obj->getHeader()->e_machine;
2591   if (Machine == EM_ARM) {
2592     ARM::EHABI::PrinterContext<ELF32LE> Ctx(W, Obj, ObjF->getFileName(),
2593                                             DotSymtabSec);
2594     Ctx.PrintUnwindInformation();
2595   }
2596   DwarfCFIEH::PrinterContext<ELF32LE> Ctx(W, ObjF);
2597   Ctx.printUnwindInformation();
2598 }
2599 
2600 } // end anonymous namespace
2601 
2602 template <class ELFT> void ELFDumper<ELFT>::printDynamicTable() {
2603   ELFDumperStyle->printDynamic(ObjF->getELFFile());
2604 }
2605 
2606 template <class ELFT> void ELFDumper<ELFT>::printNeededLibraries() {
2607   ListScope D(W, "NeededLibraries");
2608 
2609   std::vector<StringRef> Libs;
2610   for (const auto &Entry : dynamic_table())
2611     if (Entry.d_tag == ELF::DT_NEEDED)
2612       Libs.push_back(getDynamicString(Entry.d_un.d_val));
2613 
2614   llvm::sort(Libs);
2615 
2616   for (StringRef L : Libs)
2617     W.startLine() << L << "\n";
2618 }
2619 
2620 template <class ELFT>
2621 static bool checkHashTable(const ELFFile<ELFT> *Obj,
2622                            const typename ELFT::Hash *H, StringRef FileName) {
2623   auto WarnAndReturn = [&](uint64_t Off, const Twine &Msg = "") {
2624     reportWarning(createError("the hash table at offset 0x" +
2625                               Twine::utohexstr(Off) +
2626                               " goes past the end of the file (0x" +
2627                               Twine::utohexstr(Obj->getBufSize()) + ")" + Msg),
2628                   FileName);
2629     return false;
2630   };
2631 
2632   // Each SHT_HASH section starts from two 32-bit fields: nbucket and nchain.
2633   const unsigned HeaderSize = 2 * sizeof(typename ELFT::Word);
2634   const uint64_t SecOffset = (const uint8_t *)H - Obj->base();
2635   if (Obj->getBufSize() - SecOffset < HeaderSize)
2636     return WarnAndReturn(SecOffset);
2637 
2638   if (Obj->getBufSize() - SecOffset - HeaderSize <
2639       ((uint64_t)H->nbucket + H->nchain) * sizeof(typename ELFT::Word))
2640     return WarnAndReturn(SecOffset, ", nbucket = " + Twine(H->nbucket) +
2641                                         ", nchain = " + Twine(H->nchain));
2642   return true;
2643 }
2644 
2645 template <typename ELFT> void ELFDumper<ELFT>::printHashTable() {
2646   DictScope D(W, "HashTable");
2647   if (!HashTable ||
2648       !checkHashTable(ObjF->getELFFile(), HashTable, ObjF->getFileName()))
2649     return;
2650   W.printNumber("Num Buckets", HashTable->nbucket);
2651   W.printNumber("Num Chains", HashTable->nchain);
2652   W.printList("Buckets", HashTable->buckets());
2653   W.printList("Chains", HashTable->chains());
2654 }
2655 
2656 template <typename ELFT> void ELFDumper<ELFT>::printGnuHashTable() {
2657   DictScope D(W, "GnuHashTable");
2658   if (!GnuHashTable)
2659     return;
2660   W.printNumber("Num Buckets", GnuHashTable->nbuckets);
2661   W.printNumber("First Hashed Symbol Index", GnuHashTable->symndx);
2662   W.printNumber("Num Mask Words", GnuHashTable->maskwords);
2663   W.printNumber("Shift Count", GnuHashTable->shift2);
2664 
2665   ArrayRef<typename ELFT::Off> BloomFilter = GnuHashTable->filter();
2666   W.printHexList("Bloom Filter", BloomFilter);
2667 
2668   ArrayRef<Elf_Word> Buckets = GnuHashTable->buckets();
2669   W.printList("Buckets", Buckets);
2670 
2671   if (!DynSymRegion) {
2672     reportWarning(createError("unable to dump 'Values' for the SHT_GNU_HASH "
2673                               "section: no dynamic symbol table found"),
2674                   ObjF->getFileName());
2675     return;
2676   }
2677 
2678   size_t NumSyms = dynamic_symbols().size();
2679   if (!NumSyms) {
2680     reportWarning(createError("unable to dump 'Values' for the SHT_GNU_HASH "
2681                               "section: the dynamic symbol table is empty"),
2682                   ObjF->getFileName());
2683     return;
2684   }
2685 
2686   if (GnuHashTable->symndx >= NumSyms) {
2687     // A normal empty GNU hash table section produced by linker might have
2688     // symndx set to the number of dynamic symbols + 1 (for the zero symbol)
2689     // and have dummy null values in the Bloom filter and in the buckets
2690     // vector. It happens because the value of symndx is not important for
2691     // dynamic loaders when the GNU hash table is empty. They just skip the
2692     // whole object during symbol lookup. In such cases, the symndx value is
2693     // irrelevant and we should not report a warning.
2694     bool IsEmptyHashTable =
2695         llvm::all_of(Buckets, [](Elf_Word V) { return V == 0; });
2696 
2697     if (!IsEmptyHashTable) {
2698       reportWarning(
2699           createError("the first hashed symbol index (" +
2700                       Twine(GnuHashTable->symndx) +
2701                       ") is larger than the number of dynamic symbols (" +
2702                       Twine(NumSyms) + ")"),
2703           ObjF->getFileName());
2704       return;
2705     }
2706   }
2707 
2708   W.printHexList("Values", GnuHashTable->values(NumSyms));
2709 }
2710 
2711 template <typename ELFT> void ELFDumper<ELFT>::printLoadName() {
2712   W.printString("LoadName", SOName);
2713 }
2714 
2715 template <class ELFT> void ELFDumper<ELFT>::printArchSpecificInfo() {
2716   const ELFFile<ELFT> *Obj = ObjF->getELFFile();
2717   switch (Obj->getHeader()->e_machine) {
2718   case EM_ARM:
2719   case EM_RISCV:
2720     printAttributes();
2721     break;
2722   case EM_MIPS: {
2723     ELFDumperStyle->printMipsABIFlags(ObjF);
2724     printMipsOptions();
2725     printMipsReginfo();
2726 
2727     MipsGOTParser<ELFT> Parser(Obj, ObjF->getFileName(), dynamic_table(),
2728                                dynamic_symbols());
2729     if (Parser.hasGot())
2730       ELFDumperStyle->printMipsGOT(Parser);
2731     if (Parser.hasPlt())
2732       ELFDumperStyle->printMipsPLT(Parser);
2733     break;
2734   }
2735   default:
2736     break;
2737   }
2738 }
2739 
2740 namespace {
2741 
2742 template <class ELFT> void ELFDumper<ELFT>::printAttributes() {
2743   const ELFFile<ELFT> *Obj = ObjF->getELFFile();
2744   if (!Obj->isLE()) {
2745     W.startLine() << "Attributes not implemented.\n";
2746     return;
2747   }
2748 
2749   const unsigned Machine = Obj->getHeader()->e_machine;
2750   assert((Machine == EM_ARM || Machine == EM_RISCV) &&
2751          "Attributes not implemented.");
2752 
2753   DictScope BA(W, "BuildAttributes");
2754   for (const auto &Sec : unwrapOrError(ObjF->getFileName(), Obj->sections())) {
2755     if (Sec.sh_type != ELF::SHT_ARM_ATTRIBUTES &&
2756         Sec.sh_type != ELF::SHT_RISCV_ATTRIBUTES)
2757       continue;
2758 
2759     ArrayRef<uint8_t> Contents =
2760         unwrapOrError(ObjF->getFileName(), Obj->getSectionContents(&Sec));
2761     if (Contents[0] != ELFAttrs::Format_Version) {
2762       reportWarning(createError(Twine("unrecognised FormatVersion: 0x") +
2763                                 Twine::utohexstr(Contents[0])),
2764                     ObjF->getFileName());
2765       continue;
2766     }
2767     W.printHex("FormatVersion", Contents[0]);
2768     if (Contents.size() == 1)
2769       continue;
2770 
2771     // TODO: Delete the redundant FormatVersion check above.
2772     if (Machine == EM_ARM) {
2773       if (Error E = ARMAttributeParser(&W).parse(Contents, support::little))
2774         reportWarning(std::move(E), ObjF->getFileName());
2775     } else if (Machine == EM_RISCV) {
2776       if (Error E = RISCVAttributeParser(&W).parse(Contents, support::little))
2777         reportWarning(std::move(E), ObjF->getFileName());
2778     }
2779   }
2780 }
2781 
2782 template <class ELFT> class MipsGOTParser {
2783 public:
2784   TYPEDEF_ELF_TYPES(ELFT)
2785   using Entry = typename ELFO::Elf_Addr;
2786   using Entries = ArrayRef<Entry>;
2787 
2788   const bool IsStatic;
2789   const ELFO * const Obj;
2790 
2791   MipsGOTParser(const ELFO *Obj, StringRef FileName, Elf_Dyn_Range DynTable,
2792                 Elf_Sym_Range DynSyms);
2793 
2794   bool hasGot() const { return !GotEntries.empty(); }
2795   bool hasPlt() const { return !PltEntries.empty(); }
2796 
2797   uint64_t getGp() const;
2798 
2799   const Entry *getGotLazyResolver() const;
2800   const Entry *getGotModulePointer() const;
2801   const Entry *getPltLazyResolver() const;
2802   const Entry *getPltModulePointer() const;
2803 
2804   Entries getLocalEntries() const;
2805   Entries getGlobalEntries() const;
2806   Entries getOtherEntries() const;
2807   Entries getPltEntries() const;
2808 
2809   uint64_t getGotAddress(const Entry * E) const;
2810   int64_t getGotOffset(const Entry * E) const;
2811   const Elf_Sym *getGotSym(const Entry *E) const;
2812 
2813   uint64_t getPltAddress(const Entry * E) const;
2814   const Elf_Sym *getPltSym(const Entry *E) const;
2815 
2816   StringRef getPltStrTable() const { return PltStrTable; }
2817 
2818 private:
2819   const Elf_Shdr *GotSec;
2820   size_t LocalNum;
2821   size_t GlobalNum;
2822 
2823   const Elf_Shdr *PltSec;
2824   const Elf_Shdr *PltRelSec;
2825   const Elf_Shdr *PltSymTable;
2826   StringRef FileName;
2827 
2828   Elf_Sym_Range GotDynSyms;
2829   StringRef PltStrTable;
2830 
2831   Entries GotEntries;
2832   Entries PltEntries;
2833 };
2834 
2835 } // end anonymous namespace
2836 
2837 template <class ELFT>
2838 MipsGOTParser<ELFT>::MipsGOTParser(const ELFO *Obj, StringRef FileName,
2839                                    Elf_Dyn_Range DynTable,
2840                                    Elf_Sym_Range DynSyms)
2841     : IsStatic(DynTable.empty()), Obj(Obj), GotSec(nullptr), LocalNum(0),
2842       GlobalNum(0), PltSec(nullptr), PltRelSec(nullptr), PltSymTable(nullptr),
2843       FileName(FileName) {
2844   // See "Global Offset Table" in Chapter 5 in the following document
2845   // for detailed GOT description.
2846   // ftp://www.linux-mips.org/pub/linux/mips/doc/ABI/mipsabi.pdf
2847 
2848   // Find static GOT secton.
2849   if (IsStatic) {
2850     GotSec = findSectionByName(*Obj, FileName, ".got");
2851     if (!GotSec)
2852       return;
2853 
2854     ArrayRef<uint8_t> Content =
2855         unwrapOrError(FileName, Obj->getSectionContents(GotSec));
2856     GotEntries = Entries(reinterpret_cast<const Entry *>(Content.data()),
2857                          Content.size() / sizeof(Entry));
2858     LocalNum = GotEntries.size();
2859     return;
2860   }
2861 
2862   // Lookup dynamic table tags which define GOT/PLT layouts.
2863   Optional<uint64_t> DtPltGot;
2864   Optional<uint64_t> DtLocalGotNum;
2865   Optional<uint64_t> DtGotSym;
2866   Optional<uint64_t> DtMipsPltGot;
2867   Optional<uint64_t> DtJmpRel;
2868   for (const auto &Entry : DynTable) {
2869     switch (Entry.getTag()) {
2870     case ELF::DT_PLTGOT:
2871       DtPltGot = Entry.getVal();
2872       break;
2873     case ELF::DT_MIPS_LOCAL_GOTNO:
2874       DtLocalGotNum = Entry.getVal();
2875       break;
2876     case ELF::DT_MIPS_GOTSYM:
2877       DtGotSym = Entry.getVal();
2878       break;
2879     case ELF::DT_MIPS_PLTGOT:
2880       DtMipsPltGot = Entry.getVal();
2881       break;
2882     case ELF::DT_JMPREL:
2883       DtJmpRel = Entry.getVal();
2884       break;
2885     }
2886   }
2887 
2888   // Find dynamic GOT section.
2889   if (DtPltGot || DtLocalGotNum || DtGotSym) {
2890     if (!DtPltGot)
2891       report_fatal_error("Cannot find PLTGOT dynamic table tag.");
2892     if (!DtLocalGotNum)
2893       report_fatal_error("Cannot find MIPS_LOCAL_GOTNO dynamic table tag.");
2894     if (!DtGotSym)
2895       report_fatal_error("Cannot find MIPS_GOTSYM dynamic table tag.");
2896 
2897     size_t DynSymTotal = DynSyms.size();
2898     if (*DtGotSym > DynSymTotal)
2899       reportError(
2900           createError("MIPS_GOTSYM exceeds a number of dynamic symbols"),
2901           FileName);
2902 
2903     GotSec = findNotEmptySectionByAddress(Obj, FileName, *DtPltGot);
2904     if (!GotSec)
2905       reportError(createError("There is no not empty GOT section at 0x" +
2906                               Twine::utohexstr(*DtPltGot)),
2907                   FileName);
2908 
2909     LocalNum = *DtLocalGotNum;
2910     GlobalNum = DynSymTotal - *DtGotSym;
2911 
2912     ArrayRef<uint8_t> Content =
2913         unwrapOrError(FileName, Obj->getSectionContents(GotSec));
2914     GotEntries = Entries(reinterpret_cast<const Entry *>(Content.data()),
2915                          Content.size() / sizeof(Entry));
2916     GotDynSyms = DynSyms.drop_front(*DtGotSym);
2917   }
2918 
2919   // Find PLT section.
2920   if (DtMipsPltGot || DtJmpRel) {
2921     if (!DtMipsPltGot)
2922       report_fatal_error("Cannot find MIPS_PLTGOT dynamic table tag.");
2923     if (!DtJmpRel)
2924       report_fatal_error("Cannot find JMPREL dynamic table tag.");
2925 
2926     PltSec = findNotEmptySectionByAddress(Obj, FileName, * DtMipsPltGot);
2927     if (!PltSec)
2928       report_fatal_error("There is no not empty PLTGOT section at 0x " +
2929                          Twine::utohexstr(*DtMipsPltGot));
2930 
2931     PltRelSec = findNotEmptySectionByAddress(Obj, FileName, * DtJmpRel);
2932     if (!PltRelSec)
2933       report_fatal_error("There is no not empty RELPLT section at 0x" +
2934                          Twine::utohexstr(*DtJmpRel));
2935 
2936     ArrayRef<uint8_t> PltContent =
2937         unwrapOrError(FileName, Obj->getSectionContents(PltSec));
2938     PltEntries = Entries(reinterpret_cast<const Entry *>(PltContent.data()),
2939                          PltContent.size() / sizeof(Entry));
2940 
2941     PltSymTable = unwrapOrError(FileName, Obj->getSection(PltRelSec->sh_link));
2942     PltStrTable =
2943         unwrapOrError(FileName, Obj->getStringTableForSymtab(*PltSymTable));
2944   }
2945 }
2946 
2947 template <class ELFT> uint64_t MipsGOTParser<ELFT>::getGp() const {
2948   return GotSec->sh_addr + 0x7ff0;
2949 }
2950 
2951 template <class ELFT>
2952 const typename MipsGOTParser<ELFT>::Entry *
2953 MipsGOTParser<ELFT>::getGotLazyResolver() const {
2954   return LocalNum > 0 ? &GotEntries[0] : nullptr;
2955 }
2956 
2957 template <class ELFT>
2958 const typename MipsGOTParser<ELFT>::Entry *
2959 MipsGOTParser<ELFT>::getGotModulePointer() const {
2960   if (LocalNum < 2)
2961     return nullptr;
2962   const Entry &E = GotEntries[1];
2963   if ((E >> (sizeof(Entry) * 8 - 1)) == 0)
2964     return nullptr;
2965   return &E;
2966 }
2967 
2968 template <class ELFT>
2969 typename MipsGOTParser<ELFT>::Entries
2970 MipsGOTParser<ELFT>::getLocalEntries() const {
2971   size_t Skip = getGotModulePointer() ? 2 : 1;
2972   if (LocalNum - Skip <= 0)
2973     return Entries();
2974   return GotEntries.slice(Skip, LocalNum - Skip);
2975 }
2976 
2977 template <class ELFT>
2978 typename MipsGOTParser<ELFT>::Entries
2979 MipsGOTParser<ELFT>::getGlobalEntries() const {
2980   if (GlobalNum == 0)
2981     return Entries();
2982   return GotEntries.slice(LocalNum, GlobalNum);
2983 }
2984 
2985 template <class ELFT>
2986 typename MipsGOTParser<ELFT>::Entries
2987 MipsGOTParser<ELFT>::getOtherEntries() const {
2988   size_t OtherNum = GotEntries.size() - LocalNum - GlobalNum;
2989   if (OtherNum == 0)
2990     return Entries();
2991   return GotEntries.slice(LocalNum + GlobalNum, OtherNum);
2992 }
2993 
2994 template <class ELFT>
2995 uint64_t MipsGOTParser<ELFT>::getGotAddress(const Entry *E) const {
2996   int64_t Offset = std::distance(GotEntries.data(), E) * sizeof(Entry);
2997   return GotSec->sh_addr + Offset;
2998 }
2999 
3000 template <class ELFT>
3001 int64_t MipsGOTParser<ELFT>::getGotOffset(const Entry *E) const {
3002   int64_t Offset = std::distance(GotEntries.data(), E) * sizeof(Entry);
3003   return Offset - 0x7ff0;
3004 }
3005 
3006 template <class ELFT>
3007 const typename MipsGOTParser<ELFT>::Elf_Sym *
3008 MipsGOTParser<ELFT>::getGotSym(const Entry *E) const {
3009   int64_t Offset = std::distance(GotEntries.data(), E);
3010   return &GotDynSyms[Offset - LocalNum];
3011 }
3012 
3013 template <class ELFT>
3014 const typename MipsGOTParser<ELFT>::Entry *
3015 MipsGOTParser<ELFT>::getPltLazyResolver() const {
3016   return PltEntries.empty() ? nullptr : &PltEntries[0];
3017 }
3018 
3019 template <class ELFT>
3020 const typename MipsGOTParser<ELFT>::Entry *
3021 MipsGOTParser<ELFT>::getPltModulePointer() const {
3022   return PltEntries.size() < 2 ? nullptr : &PltEntries[1];
3023 }
3024 
3025 template <class ELFT>
3026 typename MipsGOTParser<ELFT>::Entries
3027 MipsGOTParser<ELFT>::getPltEntries() const {
3028   if (PltEntries.size() <= 2)
3029     return Entries();
3030   return PltEntries.slice(2, PltEntries.size() - 2);
3031 }
3032 
3033 template <class ELFT>
3034 uint64_t MipsGOTParser<ELFT>::getPltAddress(const Entry *E) const {
3035   int64_t Offset = std::distance(PltEntries.data(), E) * sizeof(Entry);
3036   return PltSec->sh_addr + Offset;
3037 }
3038 
3039 template <class ELFT>
3040 const typename MipsGOTParser<ELFT>::Elf_Sym *
3041 MipsGOTParser<ELFT>::getPltSym(const Entry *E) const {
3042   int64_t Offset = std::distance(getPltEntries().data(), E);
3043   if (PltRelSec->sh_type == ELF::SHT_REL) {
3044     Elf_Rel_Range Rels = unwrapOrError(FileName, Obj->rels(PltRelSec));
3045     return unwrapOrError(FileName,
3046                          Obj->getRelocationSymbol(&Rels[Offset], PltSymTable));
3047   } else {
3048     Elf_Rela_Range Rels = unwrapOrError(FileName, Obj->relas(PltRelSec));
3049     return unwrapOrError(FileName,
3050                          Obj->getRelocationSymbol(&Rels[Offset], PltSymTable));
3051   }
3052 }
3053 
3054 static const EnumEntry<unsigned> ElfMipsISAExtType[] = {
3055   {"None",                    Mips::AFL_EXT_NONE},
3056   {"Broadcom SB-1",           Mips::AFL_EXT_SB1},
3057   {"Cavium Networks Octeon",  Mips::AFL_EXT_OCTEON},
3058   {"Cavium Networks Octeon2", Mips::AFL_EXT_OCTEON2},
3059   {"Cavium Networks OcteonP", Mips::AFL_EXT_OCTEONP},
3060   {"Cavium Networks Octeon3", Mips::AFL_EXT_OCTEON3},
3061   {"LSI R4010",               Mips::AFL_EXT_4010},
3062   {"Loongson 2E",             Mips::AFL_EXT_LOONGSON_2E},
3063   {"Loongson 2F",             Mips::AFL_EXT_LOONGSON_2F},
3064   {"Loongson 3A",             Mips::AFL_EXT_LOONGSON_3A},
3065   {"MIPS R4650",              Mips::AFL_EXT_4650},
3066   {"MIPS R5900",              Mips::AFL_EXT_5900},
3067   {"MIPS R10000",             Mips::AFL_EXT_10000},
3068   {"NEC VR4100",              Mips::AFL_EXT_4100},
3069   {"NEC VR4111/VR4181",       Mips::AFL_EXT_4111},
3070   {"NEC VR4120",              Mips::AFL_EXT_4120},
3071   {"NEC VR5400",              Mips::AFL_EXT_5400},
3072   {"NEC VR5500",              Mips::AFL_EXT_5500},
3073   {"RMI Xlr",                 Mips::AFL_EXT_XLR},
3074   {"Toshiba R3900",           Mips::AFL_EXT_3900}
3075 };
3076 
3077 static const EnumEntry<unsigned> ElfMipsASEFlags[] = {
3078   {"DSP",                Mips::AFL_ASE_DSP},
3079   {"DSPR2",              Mips::AFL_ASE_DSPR2},
3080   {"Enhanced VA Scheme", Mips::AFL_ASE_EVA},
3081   {"MCU",                Mips::AFL_ASE_MCU},
3082   {"MDMX",               Mips::AFL_ASE_MDMX},
3083   {"MIPS-3D",            Mips::AFL_ASE_MIPS3D},
3084   {"MT",                 Mips::AFL_ASE_MT},
3085   {"SmartMIPS",          Mips::AFL_ASE_SMARTMIPS},
3086   {"VZ",                 Mips::AFL_ASE_VIRT},
3087   {"MSA",                Mips::AFL_ASE_MSA},
3088   {"MIPS16",             Mips::AFL_ASE_MIPS16},
3089   {"microMIPS",          Mips::AFL_ASE_MICROMIPS},
3090   {"XPA",                Mips::AFL_ASE_XPA},
3091   {"CRC",                Mips::AFL_ASE_CRC},
3092   {"GINV",               Mips::AFL_ASE_GINV},
3093 };
3094 
3095 static const EnumEntry<unsigned> ElfMipsFpABIType[] = {
3096   {"Hard or soft float",                  Mips::Val_GNU_MIPS_ABI_FP_ANY},
3097   {"Hard float (double precision)",       Mips::Val_GNU_MIPS_ABI_FP_DOUBLE},
3098   {"Hard float (single precision)",       Mips::Val_GNU_MIPS_ABI_FP_SINGLE},
3099   {"Soft float",                          Mips::Val_GNU_MIPS_ABI_FP_SOFT},
3100   {"Hard float (MIPS32r2 64-bit FPU 12 callee-saved)",
3101    Mips::Val_GNU_MIPS_ABI_FP_OLD_64},
3102   {"Hard float (32-bit CPU, Any FPU)",    Mips::Val_GNU_MIPS_ABI_FP_XX},
3103   {"Hard float (32-bit CPU, 64-bit FPU)", Mips::Val_GNU_MIPS_ABI_FP_64},
3104   {"Hard float compat (32-bit CPU, 64-bit FPU)",
3105    Mips::Val_GNU_MIPS_ABI_FP_64A}
3106 };
3107 
3108 static const EnumEntry<unsigned> ElfMipsFlags1[] {
3109   {"ODDSPREG", Mips::AFL_FLAGS1_ODDSPREG},
3110 };
3111 
3112 static int getMipsRegisterSize(uint8_t Flag) {
3113   switch (Flag) {
3114   case Mips::AFL_REG_NONE:
3115     return 0;
3116   case Mips::AFL_REG_32:
3117     return 32;
3118   case Mips::AFL_REG_64:
3119     return 64;
3120   case Mips::AFL_REG_128:
3121     return 128;
3122   default:
3123     return -1;
3124   }
3125 }
3126 
3127 template <class ELFT>
3128 static void printMipsReginfoData(ScopedPrinter &W,
3129                                  const Elf_Mips_RegInfo<ELFT> &Reginfo) {
3130   W.printHex("GP", Reginfo.ri_gp_value);
3131   W.printHex("General Mask", Reginfo.ri_gprmask);
3132   W.printHex("Co-Proc Mask0", Reginfo.ri_cprmask[0]);
3133   W.printHex("Co-Proc Mask1", Reginfo.ri_cprmask[1]);
3134   W.printHex("Co-Proc Mask2", Reginfo.ri_cprmask[2]);
3135   W.printHex("Co-Proc Mask3", Reginfo.ri_cprmask[3]);
3136 }
3137 
3138 template <class ELFT> void ELFDumper<ELFT>::printMipsReginfo() {
3139   const ELFFile<ELFT> *Obj = ObjF->getELFFile();
3140   const Elf_Shdr *Shdr = findSectionByName(*Obj, ObjF->getFileName(), ".reginfo");
3141   if (!Shdr) {
3142     W.startLine() << "There is no .reginfo section in the file.\n";
3143     return;
3144   }
3145   ArrayRef<uint8_t> Sec =
3146       unwrapOrError(ObjF->getFileName(), Obj->getSectionContents(Shdr));
3147   if (Sec.size() != sizeof(Elf_Mips_RegInfo<ELFT>)) {
3148     W.startLine() << "The .reginfo section has a wrong size.\n";
3149     return;
3150   }
3151 
3152   DictScope GS(W, "MIPS RegInfo");
3153   auto *Reginfo = reinterpret_cast<const Elf_Mips_RegInfo<ELFT> *>(Sec.data());
3154   printMipsReginfoData(W, *Reginfo);
3155 }
3156 
3157 template <class ELFT> void ELFDumper<ELFT>::printMipsOptions() {
3158   const ELFFile<ELFT> *Obj = ObjF->getELFFile();
3159   const Elf_Shdr *Shdr =
3160       findSectionByName(*Obj, ObjF->getFileName(), ".MIPS.options");
3161   if (!Shdr) {
3162     W.startLine() << "There is no .MIPS.options section in the file.\n";
3163     return;
3164   }
3165 
3166   DictScope GS(W, "MIPS Options");
3167 
3168   ArrayRef<uint8_t> Sec =
3169       unwrapOrError(ObjF->getFileName(), Obj->getSectionContents(Shdr));
3170   while (!Sec.empty()) {
3171     if (Sec.size() < sizeof(Elf_Mips_Options<ELFT>)) {
3172       W.startLine() << "The .MIPS.options section has a wrong size.\n";
3173       return;
3174     }
3175     auto *O = reinterpret_cast<const Elf_Mips_Options<ELFT> *>(Sec.data());
3176     DictScope GS(W, getElfMipsOptionsOdkType(O->kind));
3177     switch (O->kind) {
3178     case ODK_REGINFO:
3179       printMipsReginfoData(W, O->getRegInfo());
3180       break;
3181     default:
3182       W.startLine() << "Unsupported MIPS options tag.\n";
3183       break;
3184     }
3185     Sec = Sec.slice(O->size);
3186   }
3187 }
3188 
3189 template <class ELFT> void ELFDumper<ELFT>::printStackMap() const {
3190   const ELFFile<ELFT> *Obj = ObjF->getELFFile();
3191   const Elf_Shdr *StackMapSection = nullptr;
3192   for (const auto &Sec : unwrapOrError(ObjF->getFileName(), Obj->sections())) {
3193     StringRef Name =
3194         unwrapOrError(ObjF->getFileName(), Obj->getSectionName(&Sec));
3195     if (Name == ".llvm_stackmaps") {
3196       StackMapSection = &Sec;
3197       break;
3198     }
3199   }
3200 
3201   if (!StackMapSection)
3202     return;
3203 
3204   ArrayRef<uint8_t> StackMapContentsArray = unwrapOrError(
3205       ObjF->getFileName(), Obj->getSectionContents(StackMapSection));
3206 
3207   prettyPrintStackMap(
3208       W, StackMapParser<ELFT::TargetEndianness>(StackMapContentsArray));
3209 }
3210 
3211 template <class ELFT> void ELFDumper<ELFT>::printGroupSections() {
3212   ELFDumperStyle->printGroupSections(ObjF->getELFFile());
3213 }
3214 
3215 template <class ELFT> void ELFDumper<ELFT>::printAddrsig() {
3216   ELFDumperStyle->printAddrsig(ObjF->getELFFile());
3217 }
3218 
3219 static inline void printFields(formatted_raw_ostream &OS, StringRef Str1,
3220                                StringRef Str2) {
3221   OS.PadToColumn(2u);
3222   OS << Str1;
3223   OS.PadToColumn(37u);
3224   OS << Str2 << "\n";
3225   OS.flush();
3226 }
3227 
3228 template <class ELFT>
3229 static std::string getSectionHeadersNumString(const ELFFile<ELFT> *Obj,
3230                                               StringRef FileName) {
3231   const typename ELFT::Ehdr *ElfHeader = Obj->getHeader();
3232   if (ElfHeader->e_shnum != 0)
3233     return to_string(ElfHeader->e_shnum);
3234 
3235   ArrayRef<typename ELFT::Shdr> Arr = unwrapOrError(FileName, Obj->sections());
3236   if (Arr.empty())
3237     return "0";
3238   return "0 (" + to_string(Arr[0].sh_size) + ")";
3239 }
3240 
3241 template <class ELFT>
3242 static std::string getSectionHeaderTableIndexString(const ELFFile<ELFT> *Obj,
3243                                                     StringRef FileName) {
3244   const typename ELFT::Ehdr *ElfHeader = Obj->getHeader();
3245   if (ElfHeader->e_shstrndx != SHN_XINDEX)
3246     return to_string(ElfHeader->e_shstrndx);
3247 
3248   ArrayRef<typename ELFT::Shdr> Arr = unwrapOrError(FileName, Obj->sections());
3249   if (Arr.empty())
3250     return "65535 (corrupt: out of range)";
3251   return to_string(ElfHeader->e_shstrndx) + " (" + to_string(Arr[0].sh_link) +
3252          ")";
3253 }
3254 
3255 template <class ELFT> void GNUStyle<ELFT>::printFileHeaders(const ELFO *Obj) {
3256   const Elf_Ehdr *e = Obj->getHeader();
3257   OS << "ELF Header:\n";
3258   OS << "  Magic:  ";
3259   std::string Str;
3260   for (int i = 0; i < ELF::EI_NIDENT; i++)
3261     OS << format(" %02x", static_cast<int>(e->e_ident[i]));
3262   OS << "\n";
3263   Str = printEnum(e->e_ident[ELF::EI_CLASS], makeArrayRef(ElfClass));
3264   printFields(OS, "Class:", Str);
3265   Str = printEnum(e->e_ident[ELF::EI_DATA], makeArrayRef(ElfDataEncoding));
3266   printFields(OS, "Data:", Str);
3267   OS.PadToColumn(2u);
3268   OS << "Version:";
3269   OS.PadToColumn(37u);
3270   OS << to_hexString(e->e_ident[ELF::EI_VERSION]);
3271   if (e->e_version == ELF::EV_CURRENT)
3272     OS << " (current)";
3273   OS << "\n";
3274   Str = printEnum(e->e_ident[ELF::EI_OSABI], makeArrayRef(ElfOSABI));
3275   printFields(OS, "OS/ABI:", Str);
3276   printFields(OS,
3277               "ABI Version:", std::to_string(e->e_ident[ELF::EI_ABIVERSION]));
3278   Str = printEnum(e->e_type, makeArrayRef(ElfObjectFileType));
3279   printFields(OS, "Type:", Str);
3280   Str = printEnum(e->e_machine, makeArrayRef(ElfMachineType));
3281   printFields(OS, "Machine:", Str);
3282   Str = "0x" + to_hexString(e->e_version);
3283   printFields(OS, "Version:", Str);
3284   Str = "0x" + to_hexString(e->e_entry);
3285   printFields(OS, "Entry point address:", Str);
3286   Str = to_string(e->e_phoff) + " (bytes into file)";
3287   printFields(OS, "Start of program headers:", Str);
3288   Str = to_string(e->e_shoff) + " (bytes into file)";
3289   printFields(OS, "Start of section headers:", Str);
3290   std::string ElfFlags;
3291   if (e->e_machine == EM_MIPS)
3292     ElfFlags =
3293         printFlags(e->e_flags, makeArrayRef(ElfHeaderMipsFlags),
3294                    unsigned(ELF::EF_MIPS_ARCH), unsigned(ELF::EF_MIPS_ABI),
3295                    unsigned(ELF::EF_MIPS_MACH));
3296   else if (e->e_machine == EM_RISCV)
3297     ElfFlags = printFlags(e->e_flags, makeArrayRef(ElfHeaderRISCVFlags));
3298   Str = "0x" + to_hexString(e->e_flags);
3299   if (!ElfFlags.empty())
3300     Str = Str + ", " + ElfFlags;
3301   printFields(OS, "Flags:", Str);
3302   Str = to_string(e->e_ehsize) + " (bytes)";
3303   printFields(OS, "Size of this header:", Str);
3304   Str = to_string(e->e_phentsize) + " (bytes)";
3305   printFields(OS, "Size of program headers:", Str);
3306   Str = to_string(e->e_phnum);
3307   printFields(OS, "Number of program headers:", Str);
3308   Str = to_string(e->e_shentsize) + " (bytes)";
3309   printFields(OS, "Size of section headers:", Str);
3310   Str = getSectionHeadersNumString(Obj, this->FileName);
3311   printFields(OS, "Number of section headers:", Str);
3312   Str = getSectionHeaderTableIndexString(Obj, this->FileName);
3313   printFields(OS, "Section header string table index:", Str);
3314 }
3315 
3316 namespace {
3317 struct GroupMember {
3318   StringRef Name;
3319   uint64_t Index;
3320 };
3321 
3322 struct GroupSection {
3323   StringRef Name;
3324   std::string Signature;
3325   uint64_t ShName;
3326   uint64_t Index;
3327   uint32_t Link;
3328   uint32_t Info;
3329   uint32_t Type;
3330   std::vector<GroupMember> Members;
3331 };
3332 
3333 template <class ELFT>
3334 std::vector<GroupSection> getGroups(const ELFFile<ELFT> *Obj,
3335                                     StringRef FileName) {
3336   using Elf_Shdr = typename ELFT::Shdr;
3337   using Elf_Sym = typename ELFT::Sym;
3338   using Elf_Word = typename ELFT::Word;
3339 
3340   std::vector<GroupSection> Ret;
3341   uint64_t I = 0;
3342   for (const Elf_Shdr &Sec : unwrapOrError(FileName, Obj->sections())) {
3343     ++I;
3344     if (Sec.sh_type != ELF::SHT_GROUP)
3345       continue;
3346 
3347     const Elf_Shdr *Symtab =
3348         unwrapOrError(FileName, Obj->getSection(Sec.sh_link));
3349     StringRef StrTable =
3350         unwrapOrError(FileName, Obj->getStringTableForSymtab(*Symtab));
3351     const Elf_Sym *Sym = unwrapOrError(
3352         FileName, Obj->template getEntry<Elf_Sym>(Symtab, Sec.sh_info));
3353     auto Data = unwrapOrError(
3354         FileName, Obj->template getSectionContentsAsArray<Elf_Word>(&Sec));
3355 
3356     StringRef Name = unwrapOrError(FileName, Obj->getSectionName(&Sec));
3357     StringRef Signature = StrTable.data() + Sym->st_name;
3358     Ret.push_back({Name,
3359                    maybeDemangle(Signature),
3360                    Sec.sh_name,
3361                    I - 1,
3362                    Sec.sh_link,
3363                    Sec.sh_info,
3364                    Data[0],
3365                    {}});
3366 
3367     std::vector<GroupMember> &GM = Ret.back().Members;
3368     for (uint32_t Ndx : Data.slice(1)) {
3369       auto Sec = unwrapOrError(FileName, Obj->getSection(Ndx));
3370       const StringRef Name = unwrapOrError(FileName, Obj->getSectionName(Sec));
3371       GM.push_back({Name, Ndx});
3372     }
3373   }
3374   return Ret;
3375 }
3376 
3377 DenseMap<uint64_t, const GroupSection *>
3378 mapSectionsToGroups(ArrayRef<GroupSection> Groups) {
3379   DenseMap<uint64_t, const GroupSection *> Ret;
3380   for (const GroupSection &G : Groups)
3381     for (const GroupMember &GM : G.Members)
3382       Ret.insert({GM.Index, &G});
3383   return Ret;
3384 }
3385 
3386 } // namespace
3387 
3388 template <class ELFT> void GNUStyle<ELFT>::printGroupSections(const ELFO *Obj) {
3389   std::vector<GroupSection> V = getGroups<ELFT>(Obj, this->FileName);
3390   DenseMap<uint64_t, const GroupSection *> Map = mapSectionsToGroups(V);
3391   for (const GroupSection &G : V) {
3392     OS << "\n"
3393        << getGroupType(G.Type) << " group section ["
3394        << format_decimal(G.Index, 5) << "] `" << G.Name << "' [" << G.Signature
3395        << "] contains " << G.Members.size() << " sections:\n"
3396        << "   [Index]    Name\n";
3397     for (const GroupMember &GM : G.Members) {
3398       const GroupSection *MainGroup = Map[GM.Index];
3399       if (MainGroup != &G) {
3400         OS.flush();
3401         errs() << "Error: section [" << format_decimal(GM.Index, 5)
3402                << "] in group section [" << format_decimal(G.Index, 5)
3403                << "] already in group section ["
3404                << format_decimal(MainGroup->Index, 5) << "]";
3405         errs().flush();
3406         continue;
3407       }
3408       OS << "   [" << format_decimal(GM.Index, 5) << "]   " << GM.Name << "\n";
3409     }
3410   }
3411 
3412   if (V.empty())
3413     OS << "There are no section groups in this file.\n";
3414 }
3415 
3416 template <class ELFT>
3417 void GNUStyle<ELFT>::printRelocation(const ELFO *Obj, unsigned SecIndex,
3418                                      const Elf_Shdr *SymTab, const Elf_Rela &R,
3419                                      unsigned RelIndex, bool IsRela) {
3420   Expected<std::pair<const typename ELFT::Sym *, std::string>> Target =
3421       this->dumper()->getRelocationTarget(SymTab, R);
3422   if (!Target)
3423     this->reportUniqueWarning(createError(
3424         "unable to print relocation " + Twine(RelIndex) + " in section " +
3425         Twine(SecIndex) + ": " + toString(Target.takeError())));
3426   else
3427     printRelocation(Obj, /*Sym=*/Target->first, /*Name=*/Target->second, R,
3428                     IsRela);
3429 }
3430 
3431 template <class ELFT>
3432 void GNUStyle<ELFT>::printRelocation(const ELFO *Obj, const Elf_Sym *Sym,
3433                                      StringRef SymbolName, const Elf_Rela &R,
3434                                      bool IsRela) {
3435   // First two fields are bit width dependent. The rest of them are fixed width.
3436   unsigned Bias = ELFT::Is64Bits ? 8 : 0;
3437   Field Fields[5] = {0, 10 + Bias, 19 + 2 * Bias, 42 + 2 * Bias, 53 + 2 * Bias};
3438   unsigned Width = ELFT::Is64Bits ? 16 : 8;
3439 
3440   Fields[0].Str = to_string(format_hex_no_prefix(R.r_offset, Width));
3441   Fields[1].Str = to_string(format_hex_no_prefix(R.r_info, Width));
3442 
3443   SmallString<32> RelocName;
3444   Obj->getRelocationTypeName(R.getType(Obj->isMips64EL()), RelocName);
3445   Fields[2].Str = RelocName.c_str();
3446 
3447   if (Sym && (!SymbolName.empty() || Sym->getValue() != 0))
3448     Fields[3].Str = to_string(format_hex_no_prefix(Sym->getValue(), Width));
3449 
3450   Fields[4].Str = std::string(SymbolName);
3451   for (const Field &F : Fields)
3452     printField(F);
3453 
3454   std::string Addend;
3455   if (IsRela) {
3456     int64_t RelAddend = R.r_addend;
3457     if (!SymbolName.empty()) {
3458       if (R.r_addend < 0) {
3459         Addend = " - ";
3460         RelAddend = std::abs(RelAddend);
3461       } else
3462         Addend = " + ";
3463     }
3464 
3465     Addend += to_hexString(RelAddend, false);
3466   }
3467   OS << Addend << "\n";
3468 }
3469 
3470 template <class ELFT> void GNUStyle<ELFT>::printRelocHeader(unsigned SType) {
3471   bool IsRela = SType == ELF::SHT_RELA || SType == ELF::SHT_ANDROID_RELA;
3472   bool IsRelr = SType == ELF::SHT_RELR || SType == ELF::SHT_ANDROID_RELR;
3473   if (ELFT::Is64Bits)
3474     OS << "    ";
3475   else
3476     OS << " ";
3477   if (IsRelr && opts::RawRelr)
3478     OS << "Data  ";
3479   else
3480     OS << "Offset";
3481   if (ELFT::Is64Bits)
3482     OS << "             Info             Type"
3483        << "               Symbol's Value  Symbol's Name";
3484   else
3485     OS << "     Info    Type                Sym. Value  Symbol's Name";
3486   if (IsRela)
3487     OS << " + Addend";
3488   OS << "\n";
3489 }
3490 
3491 template <class ELFT> void GNUStyle<ELFT>::printRelocations(const ELFO *Obj) {
3492   bool HasRelocSections = false;
3493   for (const Elf_Shdr &Sec : unwrapOrError(this->FileName, Obj->sections())) {
3494     if (Sec.sh_type != ELF::SHT_REL && Sec.sh_type != ELF::SHT_RELA &&
3495         Sec.sh_type != ELF::SHT_RELR && Sec.sh_type != ELF::SHT_ANDROID_REL &&
3496         Sec.sh_type != ELF::SHT_ANDROID_RELA &&
3497         Sec.sh_type != ELF::SHT_ANDROID_RELR)
3498       continue;
3499     HasRelocSections = true;
3500     StringRef Name = unwrapOrError(this->FileName, Obj->getSectionName(&Sec));
3501     unsigned Entries = Sec.getEntityCount();
3502     std::vector<Elf_Rela> AndroidRelas;
3503     if (Sec.sh_type == ELF::SHT_ANDROID_REL ||
3504         Sec.sh_type == ELF::SHT_ANDROID_RELA) {
3505       // Android's packed relocation section needs to be unpacked first
3506       // to get the actual number of entries.
3507       AndroidRelas = unwrapOrError(this->FileName, Obj->android_relas(&Sec));
3508       Entries = AndroidRelas.size();
3509     }
3510     std::vector<Elf_Rela> RelrRelas;
3511     if (!opts::RawRelr && (Sec.sh_type == ELF::SHT_RELR ||
3512                            Sec.sh_type == ELF::SHT_ANDROID_RELR)) {
3513       // .relr.dyn relative relocation section needs to be unpacked first
3514       // to get the actual number of entries.
3515       Elf_Relr_Range Relrs = unwrapOrError(this->FileName, Obj->relrs(&Sec));
3516       RelrRelas = unwrapOrError(this->FileName, Obj->decode_relrs(Relrs));
3517       Entries = RelrRelas.size();
3518     }
3519     uintX_t Offset = Sec.sh_offset;
3520     OS << "\nRelocation section '" << Name << "' at offset 0x"
3521        << to_hexString(Offset, false) << " contains " << Entries
3522        << " entries:\n";
3523     printRelocHeader(Sec.sh_type);
3524     const Elf_Shdr *SymTab =
3525         unwrapOrError(this->FileName, Obj->getSection(Sec.sh_link));
3526     unsigned SecNdx = &Sec - &cantFail(Obj->sections()).front();
3527     unsigned RelNdx = 0;
3528 
3529     switch (Sec.sh_type) {
3530     case ELF::SHT_REL:
3531       for (const auto &R : unwrapOrError(this->FileName, Obj->rels(&Sec))) {
3532         Elf_Rela Rela;
3533         Rela.r_offset = R.r_offset;
3534         Rela.r_info = R.r_info;
3535         Rela.r_addend = 0;
3536         printRelocation(Obj, SecNdx, SymTab, Rela, ++RelNdx, false);
3537       }
3538       break;
3539     case ELF::SHT_RELA:
3540       for (const auto &R : unwrapOrError(this->FileName, Obj->relas(&Sec)))
3541         printRelocation(Obj, SecNdx, SymTab, R, ++RelNdx, true);
3542       break;
3543     case ELF::SHT_RELR:
3544     case ELF::SHT_ANDROID_RELR:
3545       if (opts::RawRelr)
3546         for (const auto &R : unwrapOrError(this->FileName, Obj->relrs(&Sec)))
3547           OS << to_string(format_hex_no_prefix(R, ELFT::Is64Bits ? 16 : 8))
3548              << "\n";
3549       else
3550         for (const auto &R : RelrRelas)
3551           printRelocation(Obj, SecNdx, SymTab, R, ++RelNdx, false);
3552       break;
3553     case ELF::SHT_ANDROID_REL:
3554     case ELF::SHT_ANDROID_RELA:
3555       for (const auto &R : AndroidRelas)
3556         printRelocation(Obj, SecNdx, SymTab, R, ++RelNdx,
3557                         Sec.sh_type == ELF::SHT_ANDROID_RELA);
3558       break;
3559     }
3560   }
3561   if (!HasRelocSections)
3562     OS << "\nThere are no relocations in this file.\n";
3563 }
3564 
3565 // Print the offset of a particular section from anyone of the ranges:
3566 // [SHT_LOOS, SHT_HIOS], [SHT_LOPROC, SHT_HIPROC], [SHT_LOUSER, SHT_HIUSER].
3567 // If 'Type' does not fall within any of those ranges, then a string is
3568 // returned as '<unknown>' followed by the type value.
3569 static std::string getSectionTypeOffsetString(unsigned Type) {
3570   if (Type >= SHT_LOOS && Type <= SHT_HIOS)
3571     return "LOOS+0x" + to_hexString(Type - SHT_LOOS);
3572   else if (Type >= SHT_LOPROC && Type <= SHT_HIPROC)
3573     return "LOPROC+0x" + to_hexString(Type - SHT_LOPROC);
3574   else if (Type >= SHT_LOUSER && Type <= SHT_HIUSER)
3575     return "LOUSER+0x" + to_hexString(Type - SHT_LOUSER);
3576   return "0x" + to_hexString(Type) + ": <unknown>";
3577 }
3578 
3579 static std::string getSectionTypeString(unsigned Arch, unsigned Type) {
3580   using namespace ELF;
3581 
3582   switch (Arch) {
3583   case EM_ARM:
3584     switch (Type) {
3585     case SHT_ARM_EXIDX:
3586       return "ARM_EXIDX";
3587     case SHT_ARM_PREEMPTMAP:
3588       return "ARM_PREEMPTMAP";
3589     case SHT_ARM_ATTRIBUTES:
3590       return "ARM_ATTRIBUTES";
3591     case SHT_ARM_DEBUGOVERLAY:
3592       return "ARM_DEBUGOVERLAY";
3593     case SHT_ARM_OVERLAYSECTION:
3594       return "ARM_OVERLAYSECTION";
3595     }
3596     break;
3597   case EM_X86_64:
3598     switch (Type) {
3599     case SHT_X86_64_UNWIND:
3600       return "X86_64_UNWIND";
3601     }
3602     break;
3603   case EM_MIPS:
3604   case EM_MIPS_RS3_LE:
3605     switch (Type) {
3606     case SHT_MIPS_REGINFO:
3607       return "MIPS_REGINFO";
3608     case SHT_MIPS_OPTIONS:
3609       return "MIPS_OPTIONS";
3610     case SHT_MIPS_DWARF:
3611       return "MIPS_DWARF";
3612     case SHT_MIPS_ABIFLAGS:
3613       return "MIPS_ABIFLAGS";
3614     }
3615     break;
3616   case EM_RISCV:
3617     switch (Type) {
3618     case SHT_RISCV_ATTRIBUTES:
3619       return "RISCV_ATTRIBUTES";
3620     }
3621   }
3622   switch (Type) {
3623   case SHT_NULL:
3624     return "NULL";
3625   case SHT_PROGBITS:
3626     return "PROGBITS";
3627   case SHT_SYMTAB:
3628     return "SYMTAB";
3629   case SHT_STRTAB:
3630     return "STRTAB";
3631   case SHT_RELA:
3632     return "RELA";
3633   case SHT_HASH:
3634     return "HASH";
3635   case SHT_DYNAMIC:
3636     return "DYNAMIC";
3637   case SHT_NOTE:
3638     return "NOTE";
3639   case SHT_NOBITS:
3640     return "NOBITS";
3641   case SHT_REL:
3642     return "REL";
3643   case SHT_SHLIB:
3644     return "SHLIB";
3645   case SHT_DYNSYM:
3646     return "DYNSYM";
3647   case SHT_INIT_ARRAY:
3648     return "INIT_ARRAY";
3649   case SHT_FINI_ARRAY:
3650     return "FINI_ARRAY";
3651   case SHT_PREINIT_ARRAY:
3652     return "PREINIT_ARRAY";
3653   case SHT_GROUP:
3654     return "GROUP";
3655   case SHT_SYMTAB_SHNDX:
3656     return "SYMTAB SECTION INDICES";
3657   case SHT_ANDROID_REL:
3658     return "ANDROID_REL";
3659   case SHT_ANDROID_RELA:
3660     return "ANDROID_RELA";
3661   case SHT_RELR:
3662   case SHT_ANDROID_RELR:
3663     return "RELR";
3664   case SHT_LLVM_ODRTAB:
3665     return "LLVM_ODRTAB";
3666   case SHT_LLVM_LINKER_OPTIONS:
3667     return "LLVM_LINKER_OPTIONS";
3668   case SHT_LLVM_CALL_GRAPH_PROFILE:
3669     return "LLVM_CALL_GRAPH_PROFILE";
3670   case SHT_LLVM_ADDRSIG:
3671     return "LLVM_ADDRSIG";
3672   case SHT_LLVM_DEPENDENT_LIBRARIES:
3673     return "LLVM_DEPENDENT_LIBRARIES";
3674   case SHT_LLVM_SYMPART:
3675     return "LLVM_SYMPART";
3676   case SHT_LLVM_PART_EHDR:
3677     return "LLVM_PART_EHDR";
3678   case SHT_LLVM_PART_PHDR:
3679     return "LLVM_PART_PHDR";
3680   // FIXME: Parse processor specific GNU attributes
3681   case SHT_GNU_ATTRIBUTES:
3682     return "ATTRIBUTES";
3683   case SHT_GNU_HASH:
3684     return "GNU_HASH";
3685   case SHT_GNU_verdef:
3686     return "VERDEF";
3687   case SHT_GNU_verneed:
3688     return "VERNEED";
3689   case SHT_GNU_versym:
3690     return "VERSYM";
3691   default:
3692     return getSectionTypeOffsetString(Type);
3693   }
3694   return "";
3695 }
3696 
3697 static void printSectionDescription(formatted_raw_ostream &OS,
3698                                     unsigned EMachine) {
3699   OS << "Key to Flags:\n";
3700   OS << "  W (write), A (alloc), X (execute), M (merge), S (strings), I "
3701         "(info),\n";
3702   OS << "  L (link order), O (extra OS processing required), G (group), T "
3703         "(TLS),\n";
3704   OS << "  C (compressed), x (unknown), o (OS specific), E (exclude),\n";
3705 
3706   if (EMachine == EM_X86_64)
3707     OS << "  l (large), ";
3708   else if (EMachine == EM_ARM)
3709     OS << "  y (purecode), ";
3710   else
3711     OS << "  ";
3712 
3713   OS << "p (processor specific)\n";
3714 }
3715 
3716 template <class ELFT>
3717 void GNUStyle<ELFT>::printSectionHeaders(const ELFO *Obj) {
3718   unsigned Bias = ELFT::Is64Bits ? 0 : 8;
3719   ArrayRef<Elf_Shdr> Sections = unwrapOrError(this->FileName, Obj->sections());
3720   OS << "There are " << to_string(Sections.size())
3721      << " section headers, starting at offset "
3722      << "0x" << to_hexString(Obj->getHeader()->e_shoff, false) << ":\n\n";
3723   OS << "Section Headers:\n";
3724   Field Fields[11] = {
3725       {"[Nr]", 2},        {"Name", 7},        {"Type", 25},
3726       {"Address", 41},    {"Off", 58 - Bias}, {"Size", 65 - Bias},
3727       {"ES", 72 - Bias},  {"Flg", 75 - Bias}, {"Lk", 79 - Bias},
3728       {"Inf", 82 - Bias}, {"Al", 86 - Bias}};
3729   for (auto &F : Fields)
3730     printField(F);
3731   OS << "\n";
3732 
3733   const ELFObjectFile<ELFT> *ElfObj = this->dumper()->getElfObject();
3734   StringRef SecStrTable = unwrapOrError<StringRef>(
3735       ElfObj->getFileName(),
3736       Obj->getSectionStringTable(Sections, this->dumper()->WarningHandler));
3737   size_t SectionIndex = 0;
3738   for (const Elf_Shdr &Sec : Sections) {
3739     Fields[0].Str = to_string(SectionIndex);
3740     if (SecStrTable.empty())
3741       Fields[1].Str = "<no-strings>";
3742     else
3743       Fields[1].Str = std::string(unwrapOrError<StringRef>(
3744           ElfObj->getFileName(), Obj->getSectionName(&Sec, SecStrTable)));
3745     Fields[2].Str =
3746         getSectionTypeString(Obj->getHeader()->e_machine, Sec.sh_type);
3747     Fields[3].Str =
3748         to_string(format_hex_no_prefix(Sec.sh_addr, ELFT::Is64Bits ? 16 : 8));
3749     Fields[4].Str = to_string(format_hex_no_prefix(Sec.sh_offset, 6));
3750     Fields[5].Str = to_string(format_hex_no_prefix(Sec.sh_size, 6));
3751     Fields[6].Str = to_string(format_hex_no_prefix(Sec.sh_entsize, 2));
3752     Fields[7].Str = getGNUFlags(Obj->getHeader()->e_machine, Sec.sh_flags);
3753     Fields[8].Str = to_string(Sec.sh_link);
3754     Fields[9].Str = to_string(Sec.sh_info);
3755     Fields[10].Str = to_string(Sec.sh_addralign);
3756 
3757     OS.PadToColumn(Fields[0].Column);
3758     OS << "[" << right_justify(Fields[0].Str, 2) << "]";
3759     for (int i = 1; i < 7; i++)
3760       printField(Fields[i]);
3761     OS.PadToColumn(Fields[7].Column);
3762     OS << right_justify(Fields[7].Str, 3);
3763     OS.PadToColumn(Fields[8].Column);
3764     OS << right_justify(Fields[8].Str, 2);
3765     OS.PadToColumn(Fields[9].Column);
3766     OS << right_justify(Fields[9].Str, 3);
3767     OS.PadToColumn(Fields[10].Column);
3768     OS << right_justify(Fields[10].Str, 2);
3769     OS << "\n";
3770     ++SectionIndex;
3771   }
3772   printSectionDescription(OS, Obj->getHeader()->e_machine);
3773 }
3774 
3775 template <class ELFT>
3776 void GNUStyle<ELFT>::printSymtabMessage(const ELFO *Obj, StringRef Name,
3777                                         size_t Entries,
3778                                         bool NonVisibilityBitsUsed) {
3779   if (!Name.empty())
3780     OS << "\nSymbol table '" << Name << "'";
3781   else
3782     OS << "\nSymbol table for image";
3783   OS << " contains " << Entries << " entries:\n";
3784 
3785   if (ELFT::Is64Bits)
3786     OS << "   Num:    Value          Size Type    Bind   Vis";
3787   else
3788     OS << "   Num:    Value  Size Type    Bind   Vis";
3789 
3790   if (NonVisibilityBitsUsed)
3791     OS << "             ";
3792   OS << "       Ndx Name\n";
3793 }
3794 
3795 template <class ELFT>
3796 std::string GNUStyle<ELFT>::getSymbolSectionNdx(const ELFO *Obj,
3797                                                 const Elf_Sym *Symbol,
3798                                                 const Elf_Sym *FirstSym) {
3799   unsigned SectionIndex = Symbol->st_shndx;
3800   switch (SectionIndex) {
3801   case ELF::SHN_UNDEF:
3802     return "UND";
3803   case ELF::SHN_ABS:
3804     return "ABS";
3805   case ELF::SHN_COMMON:
3806     return "COM";
3807   case ELF::SHN_XINDEX: {
3808     Expected<uint32_t> IndexOrErr = object::getExtendedSymbolTableIndex<ELFT>(
3809         Symbol, FirstSym, this->dumper()->getShndxTable());
3810     if (!IndexOrErr) {
3811       assert(Symbol->st_shndx == SHN_XINDEX &&
3812              "getSymbolSectionIndex should only fail due to an invalid "
3813              "SHT_SYMTAB_SHNDX table/reference");
3814       this->reportUniqueWarning(IndexOrErr.takeError());
3815       return "RSV[0xffff]";
3816     }
3817     return to_string(format_decimal(*IndexOrErr, 3));
3818   }
3819   default:
3820     // Find if:
3821     // Processor specific
3822     if (SectionIndex >= ELF::SHN_LOPROC && SectionIndex <= ELF::SHN_HIPROC)
3823       return std::string("PRC[0x") +
3824              to_string(format_hex_no_prefix(SectionIndex, 4)) + "]";
3825     // OS specific
3826     if (SectionIndex >= ELF::SHN_LOOS && SectionIndex <= ELF::SHN_HIOS)
3827       return std::string("OS[0x") +
3828              to_string(format_hex_no_prefix(SectionIndex, 4)) + "]";
3829     // Architecture reserved:
3830     if (SectionIndex >= ELF::SHN_LORESERVE &&
3831         SectionIndex <= ELF::SHN_HIRESERVE)
3832       return std::string("RSV[0x") +
3833              to_string(format_hex_no_prefix(SectionIndex, 4)) + "]";
3834     // A normal section with an index
3835     return to_string(format_decimal(SectionIndex, 3));
3836   }
3837 }
3838 
3839 template <class ELFT>
3840 void GNUStyle<ELFT>::printSymbol(const ELFO *Obj, const Elf_Sym *Symbol,
3841                                  const Elf_Sym *FirstSym, StringRef StrTable,
3842                                  bool IsDynamic, bool NonVisibilityBitsUsed) {
3843   static int Idx = 0;
3844   static bool Dynamic = true;
3845 
3846   // If this function was called with a different value from IsDynamic
3847   // from last call, happens when we move from dynamic to static symbol
3848   // table, "Num" field should be reset.
3849   if (!Dynamic != !IsDynamic) {
3850     Idx = 0;
3851     Dynamic = false;
3852   }
3853 
3854   unsigned Bias = ELFT::Is64Bits ? 8 : 0;
3855   Field Fields[8] = {0,         8,         17 + Bias, 23 + Bias,
3856                      31 + Bias, 38 + Bias, 48 + Bias, 51 + Bias};
3857   Fields[0].Str = to_string(format_decimal(Idx++, 6)) + ":";
3858   Fields[1].Str = to_string(
3859       format_hex_no_prefix(Symbol->st_value, ELFT::Is64Bits ? 16 : 8));
3860   Fields[2].Str = to_string(format_decimal(Symbol->st_size, 5));
3861 
3862   unsigned char SymbolType = Symbol->getType();
3863   if (Obj->getHeader()->e_machine == ELF::EM_AMDGPU &&
3864       SymbolType >= ELF::STT_LOOS && SymbolType < ELF::STT_HIOS)
3865     Fields[3].Str = printEnum(SymbolType, makeArrayRef(AMDGPUSymbolTypes));
3866   else
3867     Fields[3].Str = printEnum(SymbolType, makeArrayRef(ElfSymbolTypes));
3868 
3869   Fields[4].Str =
3870       printEnum(Symbol->getBinding(), makeArrayRef(ElfSymbolBindings));
3871   Fields[5].Str =
3872       printEnum(Symbol->getVisibility(), makeArrayRef(ElfSymbolVisibilities));
3873   if (Symbol->st_other & ~0x3)
3874     Fields[5].Str +=
3875         " [<other: " + to_string(format_hex(Symbol->st_other, 2)) + ">]";
3876 
3877   Fields[6].Column += NonVisibilityBitsUsed ? 13 : 0;
3878   Fields[6].Str = getSymbolSectionNdx(Obj, Symbol, FirstSym);
3879 
3880   Fields[7].Str =
3881       this->dumper()->getFullSymbolName(Symbol, StrTable, IsDynamic);
3882   for (auto &Entry : Fields)
3883     printField(Entry);
3884   OS << "\n";
3885 }
3886 
3887 template <class ELFT>
3888 void GNUStyle<ELFT>::printHashedSymbol(const ELFO *Obj, const Elf_Sym *FirstSym,
3889                                        uint32_t Sym, StringRef StrTable,
3890                                        uint32_t Bucket) {
3891   unsigned Bias = ELFT::Is64Bits ? 8 : 0;
3892   Field Fields[9] = {0,         6,         11,        20 + Bias, 25 + Bias,
3893                      34 + Bias, 41 + Bias, 49 + Bias, 53 + Bias};
3894   Fields[0].Str = to_string(format_decimal(Sym, 5));
3895   Fields[1].Str = to_string(format_decimal(Bucket, 3)) + ":";
3896 
3897   const auto Symbol = FirstSym + Sym;
3898   Fields[2].Str = to_string(
3899       format_hex_no_prefix(Symbol->st_value, ELFT::Is64Bits ? 16 : 8));
3900   Fields[3].Str = to_string(format_decimal(Symbol->st_size, 5));
3901 
3902   unsigned char SymbolType = Symbol->getType();
3903   if (Obj->getHeader()->e_machine == ELF::EM_AMDGPU &&
3904       SymbolType >= ELF::STT_LOOS && SymbolType < ELF::STT_HIOS)
3905     Fields[4].Str = printEnum(SymbolType, makeArrayRef(AMDGPUSymbolTypes));
3906   else
3907     Fields[4].Str = printEnum(SymbolType, makeArrayRef(ElfSymbolTypes));
3908 
3909   Fields[5].Str =
3910       printEnum(Symbol->getBinding(), makeArrayRef(ElfSymbolBindings));
3911   Fields[6].Str =
3912       printEnum(Symbol->getVisibility(), makeArrayRef(ElfSymbolVisibilities));
3913   Fields[7].Str = getSymbolSectionNdx(Obj, Symbol, FirstSym);
3914   Fields[8].Str = this->dumper()->getFullSymbolName(Symbol, StrTable, true);
3915 
3916   for (auto &Entry : Fields)
3917     printField(Entry);
3918   OS << "\n";
3919 }
3920 
3921 template <class ELFT>
3922 void GNUStyle<ELFT>::printSymbols(const ELFO *Obj, bool PrintSymbols,
3923                                   bool PrintDynamicSymbols) {
3924   if (!PrintSymbols && !PrintDynamicSymbols)
3925     return;
3926   // GNU readelf prints both the .dynsym and .symtab with --symbols.
3927   this->dumper()->printSymbolsHelper(true);
3928   if (PrintSymbols)
3929     this->dumper()->printSymbolsHelper(false);
3930 }
3931 
3932 template <class ELFT> void GNUStyle<ELFT>::printHashSymbols(const ELFO *Obj) {
3933   if (this->dumper()->getDynamicStringTable().empty())
3934     return;
3935   auto StringTable = this->dumper()->getDynamicStringTable();
3936   auto DynSyms = this->dumper()->dynamic_symbols();
3937 
3938   auto PrintHashTable = [&](const Elf_Hash *SysVHash) {
3939     if (ELFT::Is64Bits)
3940       OS << "  Num Buc:    Value          Size   Type   Bind Vis      Ndx Name";
3941     else
3942       OS << "  Num Buc:    Value  Size   Type   Bind Vis      Ndx Name";
3943     OS << "\n";
3944 
3945     auto Buckets = SysVHash->buckets();
3946     auto Chains = SysVHash->chains();
3947     for (uint32_t Buc = 0; Buc < SysVHash->nbucket; Buc++) {
3948       if (Buckets[Buc] == ELF::STN_UNDEF)
3949         continue;
3950       std::vector<bool> Visited(SysVHash->nchain);
3951       for (uint32_t Ch = Buckets[Buc]; Ch < SysVHash->nchain; Ch = Chains[Ch]) {
3952         if (Ch == ELF::STN_UNDEF)
3953           break;
3954 
3955         if (Visited[Ch]) {
3956           reportWarning(
3957               createError(".hash section is invalid: bucket " + Twine(Ch) +
3958                           ": a cycle was detected in the linked chain"),
3959               this->FileName);
3960           break;
3961         }
3962 
3963         printHashedSymbol(Obj, &DynSyms[0], Ch, StringTable, Buc);
3964         Visited[Ch] = true;
3965       }
3966     }
3967   };
3968 
3969   if (const Elf_Hash *SysVHash = this->dumper()->getHashTable()) {
3970     OS << "\n Symbol table of .hash for image:\n";
3971     if (checkHashTable(Obj, SysVHash, this->FileName))
3972       PrintHashTable(SysVHash);
3973   }
3974 
3975   // Try printing .gnu.hash
3976   if (auto GnuHash = this->dumper()->getGnuHashTable()) {
3977     OS << "\n Symbol table of .gnu.hash for image:\n";
3978     if (ELFT::Is64Bits)
3979       OS << "  Num Buc:    Value          Size   Type   Bind Vis      Ndx Name";
3980     else
3981       OS << "  Num Buc:    Value  Size   Type   Bind Vis      Ndx Name";
3982     OS << "\n";
3983     auto Buckets = GnuHash->buckets();
3984     for (uint32_t Buc = 0; Buc < GnuHash->nbuckets; Buc++) {
3985       if (Buckets[Buc] == ELF::STN_UNDEF)
3986         continue;
3987       uint32_t Index = Buckets[Buc];
3988       uint32_t GnuHashable = Index - GnuHash->symndx;
3989       // Print whole chain
3990       while (true) {
3991         printHashedSymbol(Obj, &DynSyms[0], Index++, StringTable, Buc);
3992         // Chain ends at symbol with stopper bit
3993         if ((GnuHash->values(DynSyms.size())[GnuHashable++] & 1) == 1)
3994           break;
3995       }
3996     }
3997   }
3998 }
3999 
4000 static inline std::string printPhdrFlags(unsigned Flag) {
4001   std::string Str;
4002   Str = (Flag & PF_R) ? "R" : " ";
4003   Str += (Flag & PF_W) ? "W" : " ";
4004   Str += (Flag & PF_X) ? "E" : " ";
4005   return Str;
4006 }
4007 
4008 // SHF_TLS sections are only in PT_TLS, PT_LOAD or PT_GNU_RELRO
4009 // PT_TLS must only have SHF_TLS sections
4010 template <class ELFT>
4011 bool GNUStyle<ELFT>::checkTLSSections(const Elf_Phdr &Phdr,
4012                                       const Elf_Shdr &Sec) {
4013   return (((Sec.sh_flags & ELF::SHF_TLS) &&
4014            ((Phdr.p_type == ELF::PT_TLS) || (Phdr.p_type == ELF::PT_LOAD) ||
4015             (Phdr.p_type == ELF::PT_GNU_RELRO))) ||
4016           (!(Sec.sh_flags & ELF::SHF_TLS) && Phdr.p_type != ELF::PT_TLS));
4017 }
4018 
4019 // Non-SHT_NOBITS must have its offset inside the segment
4020 // Only non-zero section can be at end of segment
4021 template <class ELFT>
4022 bool GNUStyle<ELFT>::checkoffsets(const Elf_Phdr &Phdr, const Elf_Shdr &Sec) {
4023   if (Sec.sh_type == ELF::SHT_NOBITS)
4024     return true;
4025   bool IsSpecial =
4026       (Sec.sh_type == ELF::SHT_NOBITS) && ((Sec.sh_flags & ELF::SHF_TLS) != 0);
4027   // .tbss is special, it only has memory in PT_TLS and has NOBITS properties
4028   auto SectionSize =
4029       (IsSpecial && Phdr.p_type != ELF::PT_TLS) ? 0 : Sec.sh_size;
4030   if (Sec.sh_offset >= Phdr.p_offset)
4031     return ((Sec.sh_offset + SectionSize <= Phdr.p_filesz + Phdr.p_offset)
4032             /*only non-zero sized sections at end*/
4033             && (Sec.sh_offset + 1 <= Phdr.p_offset + Phdr.p_filesz));
4034   return false;
4035 }
4036 
4037 // SHF_ALLOC must have VMA inside segment
4038 // Only non-zero section can be at end of segment
4039 template <class ELFT>
4040 bool GNUStyle<ELFT>::checkVMA(const Elf_Phdr &Phdr, const Elf_Shdr &Sec) {
4041   if (!(Sec.sh_flags & ELF::SHF_ALLOC))
4042     return true;
4043   bool IsSpecial =
4044       (Sec.sh_type == ELF::SHT_NOBITS) && ((Sec.sh_flags & ELF::SHF_TLS) != 0);
4045   // .tbss is special, it only has memory in PT_TLS and has NOBITS properties
4046   auto SectionSize =
4047       (IsSpecial && Phdr.p_type != ELF::PT_TLS) ? 0 : Sec.sh_size;
4048   if (Sec.sh_addr >= Phdr.p_vaddr)
4049     return ((Sec.sh_addr + SectionSize <= Phdr.p_vaddr + Phdr.p_memsz) &&
4050             (Sec.sh_addr + 1 <= Phdr.p_vaddr + Phdr.p_memsz));
4051   return false;
4052 }
4053 
4054 // No section with zero size must be at start or end of PT_DYNAMIC
4055 template <class ELFT>
4056 bool GNUStyle<ELFT>::checkPTDynamic(const Elf_Phdr &Phdr, const Elf_Shdr &Sec) {
4057   if (Phdr.p_type != ELF::PT_DYNAMIC || Sec.sh_size != 0 || Phdr.p_memsz == 0)
4058     return true;
4059   // Is section within the phdr both based on offset and VMA ?
4060   return ((Sec.sh_type == ELF::SHT_NOBITS) ||
4061           (Sec.sh_offset > Phdr.p_offset &&
4062            Sec.sh_offset < Phdr.p_offset + Phdr.p_filesz)) &&
4063          (!(Sec.sh_flags & ELF::SHF_ALLOC) ||
4064           (Sec.sh_addr > Phdr.p_vaddr && Sec.sh_addr < Phdr.p_memsz));
4065 }
4066 
4067 template <class ELFT>
4068 void GNUStyle<ELFT>::printProgramHeaders(
4069     const ELFO *Obj, bool PrintProgramHeaders,
4070     cl::boolOrDefault PrintSectionMapping) {
4071   if (PrintProgramHeaders)
4072     printProgramHeaders(Obj);
4073 
4074   // Display the section mapping along with the program headers, unless
4075   // -section-mapping is explicitly set to false.
4076   if (PrintSectionMapping != cl::BOU_FALSE)
4077     printSectionMapping(Obj);
4078 }
4079 
4080 template <class ELFT>
4081 void GNUStyle<ELFT>::printProgramHeaders(const ELFO *Obj) {
4082   unsigned Bias = ELFT::Is64Bits ? 8 : 0;
4083   const Elf_Ehdr *Header = Obj->getHeader();
4084   Field Fields[8] = {2,         17,        26,        37 + Bias,
4085                      48 + Bias, 56 + Bias, 64 + Bias, 68 + Bias};
4086   OS << "\nElf file type is "
4087      << printEnum(Header->e_type, makeArrayRef(ElfObjectFileType)) << "\n"
4088      << "Entry point " << format_hex(Header->e_entry, 3) << "\n"
4089      << "There are " << Header->e_phnum << " program headers,"
4090      << " starting at offset " << Header->e_phoff << "\n\n"
4091      << "Program Headers:\n";
4092   if (ELFT::Is64Bits)
4093     OS << "  Type           Offset   VirtAddr           PhysAddr         "
4094        << "  FileSiz  MemSiz   Flg Align\n";
4095   else
4096     OS << "  Type           Offset   VirtAddr   PhysAddr   FileSiz "
4097        << "MemSiz  Flg Align\n";
4098 
4099   unsigned Width = ELFT::Is64Bits ? 18 : 10;
4100   unsigned SizeWidth = ELFT::Is64Bits ? 8 : 7;
4101   for (const auto &Phdr :
4102        unwrapOrError(this->FileName, Obj->program_headers())) {
4103     Fields[0].Str = getElfPtType(Header->e_machine, Phdr.p_type);
4104     Fields[1].Str = to_string(format_hex(Phdr.p_offset, 8));
4105     Fields[2].Str = to_string(format_hex(Phdr.p_vaddr, Width));
4106     Fields[3].Str = to_string(format_hex(Phdr.p_paddr, Width));
4107     Fields[4].Str = to_string(format_hex(Phdr.p_filesz, SizeWidth));
4108     Fields[5].Str = to_string(format_hex(Phdr.p_memsz, SizeWidth));
4109     Fields[6].Str = printPhdrFlags(Phdr.p_flags);
4110     Fields[7].Str = to_string(format_hex(Phdr.p_align, 1));
4111     for (auto Field : Fields)
4112       printField(Field);
4113     if (Phdr.p_type == ELF::PT_INTERP) {
4114       OS << "\n      [Requesting program interpreter: ";
4115       OS << reinterpret_cast<const char *>(Obj->base()) + Phdr.p_offset << "]";
4116     }
4117     OS << "\n";
4118   }
4119 }
4120 
4121 template <class ELFT>
4122 void GNUStyle<ELFT>::printSectionMapping(const ELFO *Obj) {
4123   OS << "\n Section to Segment mapping:\n  Segment Sections...\n";
4124   DenseSet<const Elf_Shdr *> BelongsToSegment;
4125   int Phnum = 0;
4126   for (const Elf_Phdr &Phdr :
4127        unwrapOrError(this->FileName, Obj->program_headers())) {
4128     std::string Sections;
4129     OS << format("   %2.2d     ", Phnum++);
4130     for (const Elf_Shdr &Sec : unwrapOrError(this->FileName, Obj->sections())) {
4131       // Check if each section is in a segment and then print mapping.
4132       // readelf additionally makes sure it does not print zero sized sections
4133       // at end of segments and for PT_DYNAMIC both start and end of section
4134       // .tbss must only be shown in PT_TLS section.
4135       bool TbssInNonTLS = (Sec.sh_type == ELF::SHT_NOBITS) &&
4136                           ((Sec.sh_flags & ELF::SHF_TLS) != 0) &&
4137                           Phdr.p_type != ELF::PT_TLS;
4138       if (!TbssInNonTLS && checkTLSSections(Phdr, Sec) &&
4139           checkoffsets(Phdr, Sec) && checkVMA(Phdr, Sec) &&
4140           checkPTDynamic(Phdr, Sec) && (Sec.sh_type != ELF::SHT_NULL)) {
4141         Sections +=
4142             unwrapOrError(this->FileName, Obj->getSectionName(&Sec)).str() +
4143             " ";
4144         BelongsToSegment.insert(&Sec);
4145       }
4146     }
4147     OS << Sections << "\n";
4148     OS.flush();
4149   }
4150 
4151   // Display sections that do not belong to a segment.
4152   std::string Sections;
4153   for (const Elf_Shdr &Sec : unwrapOrError(this->FileName, Obj->sections())) {
4154     if (BelongsToSegment.find(&Sec) == BelongsToSegment.end())
4155       Sections +=
4156           unwrapOrError(this->FileName, Obj->getSectionName(&Sec)).str() + ' ';
4157   }
4158   if (!Sections.empty()) {
4159     OS << "   None  " << Sections << '\n';
4160     OS.flush();
4161   }
4162 }
4163 
4164 namespace {
4165 template <class ELFT> struct RelSymbol {
4166   const typename ELFT::Sym *Sym;
4167   std::string Name;
4168 };
4169 
4170 template <class ELFT>
4171 RelSymbol<ELFT> getSymbolForReloc(const ELFFile<ELFT> *Obj, StringRef FileName,
4172                                   const ELFDumper<ELFT> *Dumper,
4173                                   const typename ELFT::Rela &Reloc) {
4174   uint32_t SymIndex = Reloc.getSymbol(Obj->isMips64EL());
4175   auto WarnAndReturn = [&](const typename ELFT::Sym *Sym,
4176                            const Twine &Reason) -> RelSymbol<ELFT> {
4177     reportWarning(
4178         createError("unable to get name of the dynamic symbol with index " +
4179                     Twine(SymIndex) + ": " + Reason),
4180         FileName);
4181     return {Sym, "<corrupt>"};
4182   };
4183 
4184   ArrayRef<typename ELFT::Sym> Symbols = Dumper->dynamic_symbols();
4185   const typename ELFT::Sym *FirstSym = Symbols.begin();
4186   if (!FirstSym)
4187     return WarnAndReturn(nullptr, "no dynamic symbol table found");
4188 
4189   // We might have an object without a section header. In this case the size of
4190   // Symbols is zero, because there is no way to know the size of the dynamic
4191   // table. We should allow this case and not print a warning.
4192   if (!Symbols.empty() && SymIndex >= Symbols.size())
4193     return WarnAndReturn(
4194         nullptr,
4195         "index is greater than or equal to the number of dynamic symbols (" +
4196             Twine(Symbols.size()) + ")");
4197 
4198   const typename ELFT::Sym *Sym = FirstSym + SymIndex;
4199   Expected<StringRef> ErrOrName = Sym->getName(Dumper->getDynamicStringTable());
4200   if (!ErrOrName)
4201     return WarnAndReturn(Sym, toString(ErrOrName.takeError()));
4202 
4203   return {Sym, maybeDemangle(*ErrOrName)};
4204 }
4205 } // namespace
4206 
4207 template <class ELFT>
4208 void GNUStyle<ELFT>::printDynamicRelocation(const ELFO *Obj, Elf_Rela R,
4209                                             bool IsRela) {
4210   RelSymbol<ELFT> S = getSymbolForReloc(Obj, this->FileName, this->dumper(), R);
4211   printRelocation(Obj, S.Sym, S.Name, R, IsRela);
4212 }
4213 
4214 template <class ELFT>
4215 static size_t getMaxDynamicTagSize(const ELFFile<ELFT> *Obj,
4216                                    typename ELFT::DynRange Tags) {
4217   size_t Max = 0;
4218   for (const typename ELFT::Dyn &Dyn : Tags)
4219     Max = std::max(Max, Obj->getDynamicTagAsString(Dyn.d_tag).size());
4220   return Max;
4221 }
4222 
4223 template <class ELFT> void GNUStyle<ELFT>::printDynamic(const ELFO *Obj) {
4224   Elf_Dyn_Range Table = this->dumper()->dynamic_table();
4225   if (Table.empty())
4226     return;
4227 
4228   const DynRegionInfo &DynamicTableRegion =
4229       this->dumper()->getDynamicTableRegion();
4230 
4231   OS << "Dynamic section at offset "
4232      << format_hex(reinterpret_cast<const uint8_t *>(DynamicTableRegion.Addr) -
4233                        Obj->base(),
4234                    1)
4235      << " contains " << Table.size() << " entries:\n";
4236 
4237   // The type name is surrounded with round brackets, hence add 2.
4238   size_t MaxTagSize = getMaxDynamicTagSize(Obj, Table) + 2;
4239   // The "Name/Value" column should be indented from the "Type" column by N
4240   // spaces, where N = MaxTagSize - length of "Type" (4) + trailing
4241   // space (1) = 3.
4242   OS << "  Tag" + std::string(ELFT::Is64Bits ? 16 : 8, ' ') + "Type"
4243      << std::string(MaxTagSize - 3, ' ') << "Name/Value\n";
4244 
4245   std::string ValueFmt = " %-" + std::to_string(MaxTagSize) + "s ";
4246   for (auto Entry : Table) {
4247     uintX_t Tag = Entry.getTag();
4248     std::string Type =
4249         std::string("(") + Obj->getDynamicTagAsString(Tag).c_str() + ")";
4250     std::string Value = this->dumper()->getDynamicEntry(Tag, Entry.getVal());
4251     OS << "  " << format_hex(Tag, ELFT::Is64Bits ? 18 : 10)
4252        << format(ValueFmt.c_str(), Type.c_str()) << Value << "\n";
4253   }
4254 }
4255 
4256 template <class ELFT>
4257 void GNUStyle<ELFT>::printDynamicRelocations(const ELFO *Obj) {
4258   const DynRegionInfo &DynRelRegion = this->dumper()->getDynRelRegion();
4259   const DynRegionInfo &DynRelaRegion = this->dumper()->getDynRelaRegion();
4260   const DynRegionInfo &DynRelrRegion = this->dumper()->getDynRelrRegion();
4261   const DynRegionInfo &DynPLTRelRegion = this->dumper()->getDynPLTRelRegion();
4262   if (DynRelaRegion.Size > 0) {
4263     OS << "\n'RELA' relocation section at offset "
4264        << format_hex(reinterpret_cast<const uint8_t *>(DynRelaRegion.Addr) -
4265                          Obj->base(),
4266                      1)
4267        << " contains " << DynRelaRegion.Size << " bytes:\n";
4268     printRelocHeader(ELF::SHT_RELA);
4269     for (const Elf_Rela &Rela : this->dumper()->dyn_relas())
4270       printDynamicRelocation(Obj, Rela, true);
4271   }
4272   if (DynRelRegion.Size > 0) {
4273     OS << "\n'REL' relocation section at offset "
4274        << format_hex(reinterpret_cast<const uint8_t *>(DynRelRegion.Addr) -
4275                          Obj->base(),
4276                      1)
4277        << " contains " << DynRelRegion.Size << " bytes:\n";
4278     printRelocHeader(ELF::SHT_REL);
4279     for (const Elf_Rel &Rel : this->dumper()->dyn_rels()) {
4280       Elf_Rela Rela;
4281       Rela.r_offset = Rel.r_offset;
4282       Rela.r_info = Rel.r_info;
4283       Rela.r_addend = 0;
4284       printDynamicRelocation(Obj, Rela, false);
4285     }
4286   }
4287   if (DynRelrRegion.Size > 0) {
4288     OS << "\n'RELR' relocation section at offset "
4289        << format_hex(reinterpret_cast<const uint8_t *>(DynRelrRegion.Addr) -
4290                          Obj->base(),
4291                      1)
4292        << " contains " << DynRelrRegion.Size << " bytes:\n";
4293     printRelocHeader(ELF::SHT_REL);
4294     Elf_Relr_Range Relrs = this->dumper()->dyn_relrs();
4295     std::vector<Elf_Rela> RelrRelas =
4296         unwrapOrError(this->FileName, Obj->decode_relrs(Relrs));
4297     for (const Elf_Rela &Rela : RelrRelas) {
4298       printDynamicRelocation(Obj, Rela, false);
4299     }
4300   }
4301   if (DynPLTRelRegion.Size) {
4302     OS << "\n'PLT' relocation section at offset "
4303        << format_hex(reinterpret_cast<const uint8_t *>(DynPLTRelRegion.Addr) -
4304                          Obj->base(),
4305                      1)
4306        << " contains " << DynPLTRelRegion.Size << " bytes:\n";
4307   }
4308   if (DynPLTRelRegion.EntSize == sizeof(Elf_Rela)) {
4309     printRelocHeader(ELF::SHT_RELA);
4310     for (const Elf_Rela &Rela : DynPLTRelRegion.getAsArrayRef<Elf_Rela>())
4311       printDynamicRelocation(Obj, Rela, true);
4312   } else {
4313     printRelocHeader(ELF::SHT_REL);
4314     for (const Elf_Rel &Rel : DynPLTRelRegion.getAsArrayRef<Elf_Rel>()) {
4315       Elf_Rela Rela;
4316       Rela.r_offset = Rel.r_offset;
4317       Rela.r_info = Rel.r_info;
4318       Rela.r_addend = 0;
4319       printDynamicRelocation(Obj, Rela, false);
4320     }
4321   }
4322 }
4323 
4324 template <class ELFT>
4325 void GNUStyle<ELFT>::printGNUVersionSectionProlog(
4326     const ELFFile<ELFT> *Obj, const typename ELFT::Shdr *Sec,
4327     const Twine &Label, unsigned EntriesNum) {
4328   StringRef SecName = unwrapOrError(this->FileName, Obj->getSectionName(Sec));
4329   OS << Label << " section '" << SecName << "' "
4330      << "contains " << EntriesNum << " entries:\n";
4331 
4332   unsigned SecNdx = Sec - &cantFail(Obj->sections()).front();
4333   StringRef SymTabName = "<corrupt>";
4334 
4335   Expected<const typename ELFT::Shdr *> SymTabOrErr =
4336       Obj->getSection(Sec->sh_link);
4337   if (SymTabOrErr)
4338     SymTabName =
4339         unwrapOrError(this->FileName, Obj->getSectionName(*SymTabOrErr));
4340   else
4341     this->reportUniqueWarning(
4342         createError("invalid section linked to " +
4343                     object::getELFSectionTypeName(Obj->getHeader()->e_machine,
4344                                                   Sec->sh_type) +
4345                     " section with index " + Twine(SecNdx) + ": " +
4346                     toString(SymTabOrErr.takeError())));
4347 
4348   OS << " Addr: " << format_hex_no_prefix(Sec->sh_addr, 16)
4349      << "  Offset: " << format_hex(Sec->sh_offset, 8)
4350      << "  Link: " << Sec->sh_link << " (" << SymTabName << ")\n";
4351 }
4352 
4353 template <class ELFT>
4354 void GNUStyle<ELFT>::printVersionSymbolSection(const ELFFile<ELFT> *Obj,
4355                                                const Elf_Shdr *Sec) {
4356   if (!Sec)
4357     return;
4358 
4359   printGNUVersionSectionProlog(Obj, Sec, "Version symbols",
4360                                Sec->sh_size / sizeof(Elf_Versym));
4361   Expected<ArrayRef<Elf_Versym>> VerTableOrErr =
4362       this->dumper()->getVersionTable(Sec, /*SymTab=*/nullptr,
4363                                       /*StrTab=*/nullptr);
4364   if (!VerTableOrErr) {
4365     this->reportUniqueWarning(VerTableOrErr.takeError());
4366     return;
4367   }
4368 
4369   ArrayRef<Elf_Versym> VerTable = *VerTableOrErr;
4370   std::vector<StringRef> Versions;
4371   for (size_t I = 0, E = VerTable.size(); I < E; ++I) {
4372     unsigned Ndx = VerTable[I].vs_index;
4373     if (Ndx == VER_NDX_LOCAL || Ndx == VER_NDX_GLOBAL) {
4374       Versions.emplace_back(Ndx == VER_NDX_LOCAL ? "*local*" : "*global*");
4375       continue;
4376     }
4377 
4378     bool IsDefault;
4379     Expected<StringRef> NameOrErr =
4380         this->dumper()->getSymbolVersionByIndex(Ndx, IsDefault);
4381     if (!NameOrErr) {
4382       if (!NameOrErr) {
4383         unsigned SecNdx = Sec - &cantFail(Obj->sections()).front();
4384         this->reportUniqueWarning(createError(
4385             "unable to get a version for entry " + Twine(I) +
4386             " of SHT_GNU_versym section with index " + Twine(SecNdx) + ": " +
4387             toString(NameOrErr.takeError())));
4388       }
4389       Versions.emplace_back("<corrupt>");
4390       continue;
4391     }
4392     Versions.emplace_back(*NameOrErr);
4393   }
4394 
4395   // readelf prints 4 entries per line.
4396   uint64_t Entries = VerTable.size();
4397   for (uint64_t VersymRow = 0; VersymRow < Entries; VersymRow += 4) {
4398     OS << "  " << format_hex_no_prefix(VersymRow, 3) << ":";
4399     for (uint64_t I = 0; (I < 4) && (I + VersymRow) < Entries; ++I) {
4400       unsigned Ndx = VerTable[VersymRow + I].vs_index;
4401       OS << format("%4x%c", Ndx & VERSYM_VERSION,
4402                    Ndx & VERSYM_HIDDEN ? 'h' : ' ');
4403       OS << left_justify("(" + std::string(Versions[VersymRow + I]) + ")", 13);
4404     }
4405     OS << '\n';
4406   }
4407   OS << '\n';
4408 }
4409 
4410 static std::string versionFlagToString(unsigned Flags) {
4411   if (Flags == 0)
4412     return "none";
4413 
4414   std::string Ret;
4415   auto AddFlag = [&Ret, &Flags](unsigned Flag, StringRef Name) {
4416     if (!(Flags & Flag))
4417       return;
4418     if (!Ret.empty())
4419       Ret += " | ";
4420     Ret += Name;
4421     Flags &= ~Flag;
4422   };
4423 
4424   AddFlag(VER_FLG_BASE, "BASE");
4425   AddFlag(VER_FLG_WEAK, "WEAK");
4426   AddFlag(VER_FLG_INFO, "INFO");
4427   AddFlag(~0, "<unknown>");
4428   return Ret;
4429 }
4430 
4431 template <class ELFT>
4432 void GNUStyle<ELFT>::printVersionDefinitionSection(const ELFFile<ELFT> *Obj,
4433                                                    const Elf_Shdr *Sec) {
4434   if (!Sec)
4435     return;
4436 
4437   printGNUVersionSectionProlog(Obj, Sec, "Version definition", Sec->sh_info);
4438 
4439   Expected<std::vector<VerDef>> V = this->dumper()->getVersionDefinitions(Sec);
4440   if (!V) {
4441     this->reportUniqueWarning(V.takeError());
4442     return;
4443   }
4444 
4445   for (const VerDef &Def : *V) {
4446     OS << format("  0x%04x: Rev: %u  Flags: %s  Index: %u  Cnt: %u  Name: %s\n",
4447                  Def.Offset, Def.Version,
4448                  versionFlagToString(Def.Flags).c_str(), Def.Ndx, Def.Cnt,
4449                  Def.Name.data());
4450     unsigned I = 0;
4451     for (const VerdAux &Aux : Def.AuxV)
4452       OS << format("  0x%04x: Parent %u: %s\n", Aux.Offset, ++I,
4453                    Aux.Name.data());
4454   }
4455 
4456   OS << '\n';
4457 }
4458 
4459 template <class ELFT>
4460 void GNUStyle<ELFT>::printVersionDependencySection(const ELFFile<ELFT> *Obj,
4461                                                    const Elf_Shdr *Sec) {
4462   if (!Sec)
4463     return;
4464 
4465   unsigned VerneedNum = Sec->sh_info;
4466   printGNUVersionSectionProlog(Obj, Sec, "Version needs", VerneedNum);
4467 
4468   Expected<std::vector<VerNeed>> V =
4469       this->dumper()->getVersionDependencies(Sec);
4470   if (!V) {
4471     this->reportUniqueWarning(V.takeError());
4472     return;
4473   }
4474 
4475   for (const VerNeed &VN : *V) {
4476     OS << format("  0x%04x: Version: %u  File: %s  Cnt: %u\n", VN.Offset,
4477                  VN.Version, VN.File.data(), VN.Cnt);
4478     for (const VernAux &Aux : VN.AuxV)
4479       OS << format("  0x%04x:   Name: %s  Flags: %s  Version: %u\n", Aux.Offset,
4480                    Aux.Name.data(), versionFlagToString(Aux.Flags).c_str(),
4481                    Aux.Other);
4482   }
4483   OS << '\n';
4484 }
4485 
4486 // Hash histogram shows  statistics of how efficient the hash was for the
4487 // dynamic symbol table. The table shows number of hash buckets for different
4488 // lengths of chains as absolute number and percentage of the total buckets.
4489 // Additionally cumulative coverage of symbols for each set of buckets.
4490 template <class ELFT>
4491 void GNUStyle<ELFT>::printHashHistogram(const ELFFile<ELFT> *Obj) {
4492   // Print histogram for .hash section
4493   if (const Elf_Hash *HashTable = this->dumper()->getHashTable()) {
4494     if (!checkHashTable(Obj, HashTable, this->FileName))
4495       return;
4496 
4497     size_t NBucket = HashTable->nbucket;
4498     size_t NChain = HashTable->nchain;
4499     ArrayRef<Elf_Word> Buckets = HashTable->buckets();
4500     ArrayRef<Elf_Word> Chains = HashTable->chains();
4501     size_t TotalSyms = 0;
4502     // If hash table is correct, we have at least chains with 0 length
4503     size_t MaxChain = 1;
4504     size_t CumulativeNonZero = 0;
4505 
4506     if (NChain == 0 || NBucket == 0)
4507       return;
4508 
4509     std::vector<size_t> ChainLen(NBucket, 0);
4510     // Go over all buckets and and note chain lengths of each bucket (total
4511     // unique chain lengths).
4512     for (size_t B = 0; B < NBucket; B++) {
4513       std::vector<bool> Visited(NChain);
4514       for (size_t C = Buckets[B]; C < NChain; C = Chains[C]) {
4515         if (C == ELF::STN_UNDEF)
4516           break;
4517         if (Visited[C]) {
4518           reportWarning(
4519               createError(".hash section is invalid: bucket " + Twine(C) +
4520                           ": a cycle was detected in the linked chain"),
4521               this->FileName);
4522           break;
4523         }
4524         Visited[C] = true;
4525         if (MaxChain <= ++ChainLen[B])
4526           MaxChain++;
4527       }
4528       TotalSyms += ChainLen[B];
4529     }
4530 
4531     if (!TotalSyms)
4532       return;
4533 
4534     std::vector<size_t> Count(MaxChain, 0) ;
4535     // Count how long is the chain for each bucket
4536     for (size_t B = 0; B < NBucket; B++)
4537       ++Count[ChainLen[B]];
4538     // Print Number of buckets with each chain lengths and their cumulative
4539     // coverage of the symbols
4540     OS << "Histogram for bucket list length (total of " << NBucket
4541        << " buckets)\n"
4542        << " Length  Number     % of total  Coverage\n";
4543     for (size_t I = 0; I < MaxChain; I++) {
4544       CumulativeNonZero += Count[I] * I;
4545       OS << format("%7lu  %-10lu (%5.1f%%)     %5.1f%%\n", I, Count[I],
4546                    (Count[I] * 100.0) / NBucket,
4547                    (CumulativeNonZero * 100.0) / TotalSyms);
4548     }
4549   }
4550 
4551   // Print histogram for .gnu.hash section
4552   if (const Elf_GnuHash *GnuHashTable = this->dumper()->getGnuHashTable()) {
4553     size_t NBucket = GnuHashTable->nbuckets;
4554     ArrayRef<Elf_Word> Buckets = GnuHashTable->buckets();
4555     unsigned NumSyms = this->dumper()->dynamic_symbols().size();
4556     if (!NumSyms)
4557       return;
4558     ArrayRef<Elf_Word> Chains = GnuHashTable->values(NumSyms);
4559     size_t Symndx = GnuHashTable->symndx;
4560     size_t TotalSyms = 0;
4561     size_t MaxChain = 1;
4562     size_t CumulativeNonZero = 0;
4563 
4564     if (Chains.empty() || NBucket == 0)
4565       return;
4566 
4567     std::vector<size_t> ChainLen(NBucket, 0);
4568 
4569     for (size_t B = 0; B < NBucket; B++) {
4570       if (!Buckets[B])
4571         continue;
4572       size_t Len = 1;
4573       for (size_t C = Buckets[B] - Symndx;
4574            C < Chains.size() && (Chains[C] & 1) == 0; C++)
4575         if (MaxChain < ++Len)
4576           MaxChain++;
4577       ChainLen[B] = Len;
4578       TotalSyms += Len;
4579     }
4580     MaxChain++;
4581 
4582     if (!TotalSyms)
4583       return;
4584 
4585     std::vector<size_t> Count(MaxChain, 0) ;
4586     for (size_t B = 0; B < NBucket; B++)
4587       ++Count[ChainLen[B]];
4588     // Print Number of buckets with each chain lengths and their cumulative
4589     // coverage of the symbols
4590     OS << "Histogram for `.gnu.hash' bucket list length (total of " << NBucket
4591        << " buckets)\n"
4592        << " Length  Number     % of total  Coverage\n";
4593     for (size_t I = 0; I <MaxChain; I++) {
4594       CumulativeNonZero += Count[I] * I;
4595       OS << format("%7lu  %-10lu (%5.1f%%)     %5.1f%%\n", I, Count[I],
4596                    (Count[I] * 100.0) / NBucket,
4597                    (CumulativeNonZero * 100.0) / TotalSyms);
4598     }
4599   }
4600 }
4601 
4602 template <class ELFT>
4603 void GNUStyle<ELFT>::printCGProfile(const ELFFile<ELFT> *Obj) {
4604   OS << "GNUStyle::printCGProfile not implemented\n";
4605 }
4606 
4607 template <class ELFT>
4608 void GNUStyle<ELFT>::printAddrsig(const ELFFile<ELFT> *Obj) {
4609   reportError(createError("--addrsig: not implemented"), this->FileName);
4610 }
4611 
4612 static StringRef getGenericNoteTypeName(const uint32_t NT) {
4613   static const struct {
4614     uint32_t ID;
4615     const char *Name;
4616   } Notes[] = {
4617       {ELF::NT_VERSION, "NT_VERSION (version)"},
4618       {ELF::NT_ARCH, "NT_ARCH (architecture)"},
4619       {ELF::NT_GNU_BUILD_ATTRIBUTE_OPEN, "OPEN"},
4620       {ELF::NT_GNU_BUILD_ATTRIBUTE_FUNC, "func"},
4621   };
4622 
4623   for (const auto &Note : Notes)
4624     if (Note.ID == NT)
4625       return Note.Name;
4626 
4627   return "";
4628 }
4629 
4630 static StringRef getCoreNoteTypeName(const uint32_t NT) {
4631   static const struct {
4632     uint32_t ID;
4633     const char *Name;
4634   } Notes[] = {
4635       {ELF::NT_PRSTATUS, "NT_PRSTATUS (prstatus structure)"},
4636       {ELF::NT_FPREGSET, "NT_FPREGSET (floating point registers)"},
4637       {ELF::NT_PRPSINFO, "NT_PRPSINFO (prpsinfo structure)"},
4638       {ELF::NT_TASKSTRUCT, "NT_TASKSTRUCT (task structure)"},
4639       {ELF::NT_AUXV, "NT_AUXV (auxiliary vector)"},
4640       {ELF::NT_PSTATUS, "NT_PSTATUS (pstatus structure)"},
4641       {ELF::NT_FPREGS, "NT_FPREGS (floating point registers)"},
4642       {ELF::NT_PSINFO, "NT_PSINFO (psinfo structure)"},
4643       {ELF::NT_LWPSTATUS, "NT_LWPSTATUS (lwpstatus_t structure)"},
4644       {ELF::NT_LWPSINFO, "NT_LWPSINFO (lwpsinfo_t structure)"},
4645       {ELF::NT_WIN32PSTATUS, "NT_WIN32PSTATUS (win32_pstatus structure)"},
4646 
4647       {ELF::NT_PPC_VMX, "NT_PPC_VMX (ppc Altivec registers)"},
4648       {ELF::NT_PPC_VSX, "NT_PPC_VSX (ppc VSX registers)"},
4649       {ELF::NT_PPC_TAR, "NT_PPC_TAR (ppc TAR register)"},
4650       {ELF::NT_PPC_PPR, "NT_PPC_PPR (ppc PPR register)"},
4651       {ELF::NT_PPC_DSCR, "NT_PPC_DSCR (ppc DSCR register)"},
4652       {ELF::NT_PPC_EBB, "NT_PPC_EBB (ppc EBB registers)"},
4653       {ELF::NT_PPC_PMU, "NT_PPC_PMU (ppc PMU registers)"},
4654       {ELF::NT_PPC_TM_CGPR, "NT_PPC_TM_CGPR (ppc checkpointed GPR registers)"},
4655       {ELF::NT_PPC_TM_CFPR,
4656        "NT_PPC_TM_CFPR (ppc checkpointed floating point registers)"},
4657       {ELF::NT_PPC_TM_CVMX,
4658        "NT_PPC_TM_CVMX (ppc checkpointed Altivec registers)"},
4659       {ELF::NT_PPC_TM_CVSX, "NT_PPC_TM_CVSX (ppc checkpointed VSX registers)"},
4660       {ELF::NT_PPC_TM_SPR, "NT_PPC_TM_SPR (ppc TM special purpose registers)"},
4661       {ELF::NT_PPC_TM_CTAR, "NT_PPC_TM_CTAR (ppc checkpointed TAR register)"},
4662       {ELF::NT_PPC_TM_CPPR, "NT_PPC_TM_CPPR (ppc checkpointed PPR register)"},
4663       {ELF::NT_PPC_TM_CDSCR,
4664        "NT_PPC_TM_CDSCR (ppc checkpointed DSCR register)"},
4665 
4666       {ELF::NT_386_TLS, "NT_386_TLS (x86 TLS information)"},
4667       {ELF::NT_386_IOPERM, "NT_386_IOPERM (x86 I/O permissions)"},
4668       {ELF::NT_X86_XSTATE, "NT_X86_XSTATE (x86 XSAVE extended state)"},
4669 
4670       {ELF::NT_S390_HIGH_GPRS,
4671        "NT_S390_HIGH_GPRS (s390 upper register halves)"},
4672       {ELF::NT_S390_TIMER, "NT_S390_TIMER (s390 timer register)"},
4673       {ELF::NT_S390_TODCMP, "NT_S390_TODCMP (s390 TOD comparator register)"},
4674       {ELF::NT_S390_TODPREG,
4675        "NT_S390_TODPREG (s390 TOD programmable register)"},
4676       {ELF::NT_S390_CTRS, "NT_S390_CTRS (s390 control registers)"},
4677       {ELF::NT_S390_PREFIX, "NT_S390_PREFIX (s390 prefix register)"},
4678       {ELF::NT_S390_LAST_BREAK,
4679        "NT_S390_LAST_BREAK (s390 last breaking event address)"},
4680       {ELF::NT_S390_SYSTEM_CALL,
4681        "NT_S390_SYSTEM_CALL (s390 system call restart data)"},
4682       {ELF::NT_S390_TDB, "NT_S390_TDB (s390 transaction diagnostic block)"},
4683       {ELF::NT_S390_VXRS_LOW,
4684        "NT_S390_VXRS_LOW (s390 vector registers 0-15 upper half)"},
4685       {ELF::NT_S390_VXRS_HIGH,
4686        "NT_S390_VXRS_HIGH (s390 vector registers 16-31)"},
4687       {ELF::NT_S390_GS_CB, "NT_S390_GS_CB (s390 guarded-storage registers)"},
4688       {ELF::NT_S390_GS_BC,
4689        "NT_S390_GS_BC (s390 guarded-storage broadcast control)"},
4690 
4691       {ELF::NT_ARM_VFP, "NT_ARM_VFP (arm VFP registers)"},
4692       {ELF::NT_ARM_TLS, "NT_ARM_TLS (AArch TLS registers)"},
4693       {ELF::NT_ARM_HW_BREAK,
4694        "NT_ARM_HW_BREAK (AArch hardware breakpoint registers)"},
4695       {ELF::NT_ARM_HW_WATCH,
4696        "NT_ARM_HW_WATCH (AArch hardware watchpoint registers)"},
4697 
4698       {ELF::NT_FILE, "NT_FILE (mapped files)"},
4699       {ELF::NT_PRXFPREG, "NT_PRXFPREG (user_xfpregs structure)"},
4700       {ELF::NT_SIGINFO, "NT_SIGINFO (siginfo_t data)"},
4701   };
4702 
4703   for (const auto &Note : Notes)
4704     if (Note.ID == NT)
4705       return Note.Name;
4706 
4707   return "";
4708 }
4709 
4710 static std::string getGNUNoteTypeName(const uint32_t NT) {
4711   static const struct {
4712     uint32_t ID;
4713     const char *Name;
4714   } Notes[] = {
4715       {ELF::NT_GNU_ABI_TAG, "NT_GNU_ABI_TAG (ABI version tag)"},
4716       {ELF::NT_GNU_HWCAP, "NT_GNU_HWCAP (DSO-supplied software HWCAP info)"},
4717       {ELF::NT_GNU_BUILD_ID, "NT_GNU_BUILD_ID (unique build ID bitstring)"},
4718       {ELF::NT_GNU_GOLD_VERSION, "NT_GNU_GOLD_VERSION (gold version)"},
4719       {ELF::NT_GNU_PROPERTY_TYPE_0, "NT_GNU_PROPERTY_TYPE_0 (property note)"},
4720   };
4721 
4722   for (const auto &Note : Notes)
4723     if (Note.ID == NT)
4724       return std::string(Note.Name);
4725 
4726   std::string string;
4727   raw_string_ostream OS(string);
4728   OS << format("Unknown note type (0x%08x)", NT);
4729   return OS.str();
4730 }
4731 
4732 static std::string getFreeBSDNoteTypeName(const uint32_t NT) {
4733   static const struct {
4734     uint32_t ID;
4735     const char *Name;
4736   } Notes[] = {
4737       {ELF::NT_FREEBSD_THRMISC, "NT_THRMISC (thrmisc structure)"},
4738       {ELF::NT_FREEBSD_PROCSTAT_PROC, "NT_PROCSTAT_PROC (proc data)"},
4739       {ELF::NT_FREEBSD_PROCSTAT_FILES, "NT_PROCSTAT_FILES (files data)"},
4740       {ELF::NT_FREEBSD_PROCSTAT_VMMAP, "NT_PROCSTAT_VMMAP (vmmap data)"},
4741       {ELF::NT_FREEBSD_PROCSTAT_GROUPS, "NT_PROCSTAT_GROUPS (groups data)"},
4742       {ELF::NT_FREEBSD_PROCSTAT_UMASK, "NT_PROCSTAT_UMASK (umask data)"},
4743       {ELF::NT_FREEBSD_PROCSTAT_RLIMIT, "NT_PROCSTAT_RLIMIT (rlimit data)"},
4744       {ELF::NT_FREEBSD_PROCSTAT_OSREL, "NT_PROCSTAT_OSREL (osreldate data)"},
4745       {ELF::NT_FREEBSD_PROCSTAT_PSSTRINGS,
4746        "NT_PROCSTAT_PSSTRINGS (ps_strings data)"},
4747       {ELF::NT_FREEBSD_PROCSTAT_AUXV, "NT_PROCSTAT_AUXV (auxv data)"},
4748   };
4749 
4750   for (const auto &Note : Notes)
4751     if (Note.ID == NT)
4752       return std::string(Note.Name);
4753 
4754   std::string string;
4755   raw_string_ostream OS(string);
4756   OS << format("Unknown note type (0x%08x)", NT);
4757   return OS.str();
4758 }
4759 
4760 static std::string getAMDNoteTypeName(const uint32_t NT) {
4761   static const struct {
4762     uint32_t ID;
4763     const char *Name;
4764   } Notes[] = {{ELF::NT_AMD_AMDGPU_HSA_METADATA,
4765                 "NT_AMD_AMDGPU_HSA_METADATA (HSA Metadata)"},
4766                {ELF::NT_AMD_AMDGPU_ISA, "NT_AMD_AMDGPU_ISA (ISA Version)"},
4767                {ELF::NT_AMD_AMDGPU_PAL_METADATA,
4768                 "NT_AMD_AMDGPU_PAL_METADATA (PAL Metadata)"}};
4769 
4770   for (const auto &Note : Notes)
4771     if (Note.ID == NT)
4772       return std::string(Note.Name);
4773 
4774   std::string string;
4775   raw_string_ostream OS(string);
4776   OS << format("Unknown note type (0x%08x)", NT);
4777   return OS.str();
4778 }
4779 
4780 static std::string getAMDGPUNoteTypeName(const uint32_t NT) {
4781   if (NT == ELF::NT_AMDGPU_METADATA)
4782     return std::string("NT_AMDGPU_METADATA (AMDGPU Metadata)");
4783 
4784   std::string string;
4785   raw_string_ostream OS(string);
4786   OS << format("Unknown note type (0x%08x)", NT);
4787   return OS.str();
4788 }
4789 
4790 template <typename ELFT>
4791 static std::string getGNUProperty(uint32_t Type, uint32_t DataSize,
4792                                   ArrayRef<uint8_t> Data) {
4793   std::string str;
4794   raw_string_ostream OS(str);
4795   uint32_t PrData;
4796   auto DumpBit = [&](uint32_t Flag, StringRef Name) {
4797     if (PrData & Flag) {
4798       PrData &= ~Flag;
4799       OS << Name;
4800       if (PrData)
4801         OS << ", ";
4802     }
4803   };
4804 
4805   switch (Type) {
4806   default:
4807     OS << format("<application-specific type 0x%x>", Type);
4808     return OS.str();
4809   case GNU_PROPERTY_STACK_SIZE: {
4810     OS << "stack size: ";
4811     if (DataSize == sizeof(typename ELFT::uint))
4812       OS << formatv("{0:x}",
4813                     (uint64_t)(*(const typename ELFT::Addr *)Data.data()));
4814     else
4815       OS << format("<corrupt length: 0x%x>", DataSize);
4816     return OS.str();
4817   }
4818   case GNU_PROPERTY_NO_COPY_ON_PROTECTED:
4819     OS << "no copy on protected";
4820     if (DataSize)
4821       OS << format(" <corrupt length: 0x%x>", DataSize);
4822     return OS.str();
4823   case GNU_PROPERTY_AARCH64_FEATURE_1_AND:
4824   case GNU_PROPERTY_X86_FEATURE_1_AND:
4825     OS << ((Type == GNU_PROPERTY_AARCH64_FEATURE_1_AND) ? "aarch64 feature: "
4826                                                         : "x86 feature: ");
4827     if (DataSize != 4) {
4828       OS << format("<corrupt length: 0x%x>", DataSize);
4829       return OS.str();
4830     }
4831     PrData = support::endian::read32<ELFT::TargetEndianness>(Data.data());
4832     if (PrData == 0) {
4833       OS << "<None>";
4834       return OS.str();
4835     }
4836     if (Type == GNU_PROPERTY_AARCH64_FEATURE_1_AND) {
4837       DumpBit(GNU_PROPERTY_AARCH64_FEATURE_1_BTI, "BTI");
4838       DumpBit(GNU_PROPERTY_AARCH64_FEATURE_1_PAC, "PAC");
4839     } else {
4840       DumpBit(GNU_PROPERTY_X86_FEATURE_1_IBT, "IBT");
4841       DumpBit(GNU_PROPERTY_X86_FEATURE_1_SHSTK, "SHSTK");
4842     }
4843     if (PrData)
4844       OS << format("<unknown flags: 0x%x>", PrData);
4845     return OS.str();
4846   case GNU_PROPERTY_X86_ISA_1_NEEDED:
4847   case GNU_PROPERTY_X86_ISA_1_USED:
4848     OS << "x86 ISA "
4849        << (Type == GNU_PROPERTY_X86_ISA_1_NEEDED ? "needed: " : "used: ");
4850     if (DataSize != 4) {
4851       OS << format("<corrupt length: 0x%x>", DataSize);
4852       return OS.str();
4853     }
4854     PrData = support::endian::read32<ELFT::TargetEndianness>(Data.data());
4855     if (PrData == 0) {
4856       OS << "<None>";
4857       return OS.str();
4858     }
4859     DumpBit(GNU_PROPERTY_X86_ISA_1_CMOV, "CMOV");
4860     DumpBit(GNU_PROPERTY_X86_ISA_1_SSE, "SSE");
4861     DumpBit(GNU_PROPERTY_X86_ISA_1_SSE2, "SSE2");
4862     DumpBit(GNU_PROPERTY_X86_ISA_1_SSE3, "SSE3");
4863     DumpBit(GNU_PROPERTY_X86_ISA_1_SSSE3, "SSSE3");
4864     DumpBit(GNU_PROPERTY_X86_ISA_1_SSE4_1, "SSE4_1");
4865     DumpBit(GNU_PROPERTY_X86_ISA_1_SSE4_2, "SSE4_2");
4866     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX, "AVX");
4867     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX2, "AVX2");
4868     DumpBit(GNU_PROPERTY_X86_ISA_1_FMA, "FMA");
4869     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512F, "AVX512F");
4870     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512CD, "AVX512CD");
4871     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512ER, "AVX512ER");
4872     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512PF, "AVX512PF");
4873     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512VL, "AVX512VL");
4874     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512DQ, "AVX512DQ");
4875     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512BW, "AVX512BW");
4876     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512_4FMAPS, "AVX512_4FMAPS");
4877     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512_4VNNIW, "AVX512_4VNNIW");
4878     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512_BITALG, "AVX512_BITALG");
4879     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512_IFMA, "AVX512_IFMA");
4880     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512_VBMI, "AVX512_VBMI");
4881     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512_VBMI2, "AVX512_VBMI2");
4882     DumpBit(GNU_PROPERTY_X86_ISA_1_AVX512_VNNI, "AVX512_VNNI");
4883     if (PrData)
4884       OS << format("<unknown flags: 0x%x>", PrData);
4885     return OS.str();
4886     break;
4887   case GNU_PROPERTY_X86_FEATURE_2_NEEDED:
4888   case GNU_PROPERTY_X86_FEATURE_2_USED:
4889     OS << "x86 feature "
4890        << (Type == GNU_PROPERTY_X86_FEATURE_2_NEEDED ? "needed: " : "used: ");
4891     if (DataSize != 4) {
4892       OS << format("<corrupt length: 0x%x>", DataSize);
4893       return OS.str();
4894     }
4895     PrData = support::endian::read32<ELFT::TargetEndianness>(Data.data());
4896     if (PrData == 0) {
4897       OS << "<None>";
4898       return OS.str();
4899     }
4900     DumpBit(GNU_PROPERTY_X86_FEATURE_2_X86, "x86");
4901     DumpBit(GNU_PROPERTY_X86_FEATURE_2_X87, "x87");
4902     DumpBit(GNU_PROPERTY_X86_FEATURE_2_MMX, "MMX");
4903     DumpBit(GNU_PROPERTY_X86_FEATURE_2_XMM, "XMM");
4904     DumpBit(GNU_PROPERTY_X86_FEATURE_2_YMM, "YMM");
4905     DumpBit(GNU_PROPERTY_X86_FEATURE_2_ZMM, "ZMM");
4906     DumpBit(GNU_PROPERTY_X86_FEATURE_2_FXSR, "FXSR");
4907     DumpBit(GNU_PROPERTY_X86_FEATURE_2_XSAVE, "XSAVE");
4908     DumpBit(GNU_PROPERTY_X86_FEATURE_2_XSAVEOPT, "XSAVEOPT");
4909     DumpBit(GNU_PROPERTY_X86_FEATURE_2_XSAVEC, "XSAVEC");
4910     if (PrData)
4911       OS << format("<unknown flags: 0x%x>", PrData);
4912     return OS.str();
4913   }
4914 }
4915 
4916 template <typename ELFT>
4917 static SmallVector<std::string, 4> getGNUPropertyList(ArrayRef<uint8_t> Arr) {
4918   using Elf_Word = typename ELFT::Word;
4919 
4920   SmallVector<std::string, 4> Properties;
4921   while (Arr.size() >= 8) {
4922     uint32_t Type = *reinterpret_cast<const Elf_Word *>(Arr.data());
4923     uint32_t DataSize = *reinterpret_cast<const Elf_Word *>(Arr.data() + 4);
4924     Arr = Arr.drop_front(8);
4925 
4926     // Take padding size into account if present.
4927     uint64_t PaddedSize = alignTo(DataSize, sizeof(typename ELFT::uint));
4928     std::string str;
4929     raw_string_ostream OS(str);
4930     if (Arr.size() < PaddedSize) {
4931       OS << format("<corrupt type (0x%x) datasz: 0x%x>", Type, DataSize);
4932       Properties.push_back(OS.str());
4933       break;
4934     }
4935     Properties.push_back(
4936         getGNUProperty<ELFT>(Type, DataSize, Arr.take_front(PaddedSize)));
4937     Arr = Arr.drop_front(PaddedSize);
4938   }
4939 
4940   if (!Arr.empty())
4941     Properties.push_back("<corrupted GNU_PROPERTY_TYPE_0>");
4942 
4943   return Properties;
4944 }
4945 
4946 struct GNUAbiTag {
4947   std::string OSName;
4948   std::string ABI;
4949   bool IsValid;
4950 };
4951 
4952 template <typename ELFT> static GNUAbiTag getGNUAbiTag(ArrayRef<uint8_t> Desc) {
4953   typedef typename ELFT::Word Elf_Word;
4954 
4955   ArrayRef<Elf_Word> Words(reinterpret_cast<const Elf_Word *>(Desc.begin()),
4956                            reinterpret_cast<const Elf_Word *>(Desc.end()));
4957 
4958   if (Words.size() < 4)
4959     return {"", "", /*IsValid=*/false};
4960 
4961   static const char *OSNames[] = {
4962       "Linux", "Hurd", "Solaris", "FreeBSD", "NetBSD", "Syllable", "NaCl",
4963   };
4964   StringRef OSName = "Unknown";
4965   if (Words[0] < array_lengthof(OSNames))
4966     OSName = OSNames[Words[0]];
4967   uint32_t Major = Words[1], Minor = Words[2], Patch = Words[3];
4968   std::string str;
4969   raw_string_ostream ABI(str);
4970   ABI << Major << "." << Minor << "." << Patch;
4971   return {std::string(OSName), ABI.str(), /*IsValid=*/true};
4972 }
4973 
4974 static std::string getGNUBuildId(ArrayRef<uint8_t> Desc) {
4975   std::string str;
4976   raw_string_ostream OS(str);
4977   for (const auto &B : Desc)
4978     OS << format_hex_no_prefix(B, 2);
4979   return OS.str();
4980 }
4981 
4982 static StringRef getGNUGoldVersion(ArrayRef<uint8_t> Desc) {
4983   return StringRef(reinterpret_cast<const char *>(Desc.data()), Desc.size());
4984 }
4985 
4986 template <typename ELFT>
4987 static void printGNUNote(raw_ostream &OS, uint32_t NoteType,
4988                          ArrayRef<uint8_t> Desc) {
4989   switch (NoteType) {
4990   default:
4991     return;
4992   case ELF::NT_GNU_ABI_TAG: {
4993     const GNUAbiTag &AbiTag = getGNUAbiTag<ELFT>(Desc);
4994     if (!AbiTag.IsValid)
4995       OS << "    <corrupt GNU_ABI_TAG>";
4996     else
4997       OS << "    OS: " << AbiTag.OSName << ", ABI: " << AbiTag.ABI;
4998     break;
4999   }
5000   case ELF::NT_GNU_BUILD_ID: {
5001     OS << "    Build ID: " << getGNUBuildId(Desc);
5002     break;
5003   }
5004   case ELF::NT_GNU_GOLD_VERSION:
5005     OS << "    Version: " << getGNUGoldVersion(Desc);
5006     break;
5007   case ELF::NT_GNU_PROPERTY_TYPE_0:
5008     OS << "    Properties:";
5009     for (const auto &Property : getGNUPropertyList<ELFT>(Desc))
5010       OS << "    " << Property << "\n";
5011     break;
5012   }
5013   OS << '\n';
5014 }
5015 
5016 struct AMDNote {
5017   std::string Type;
5018   std::string Value;
5019 };
5020 
5021 template <typename ELFT>
5022 static AMDNote getAMDNote(uint32_t NoteType, ArrayRef<uint8_t> Desc) {
5023   switch (NoteType) {
5024   default:
5025     return {"", ""};
5026   case ELF::NT_AMD_AMDGPU_HSA_METADATA:
5027     return {
5028         "HSA Metadata",
5029         std::string(reinterpret_cast<const char *>(Desc.data()), Desc.size())};
5030   case ELF::NT_AMD_AMDGPU_ISA:
5031     return {
5032         "ISA Version",
5033         std::string(reinterpret_cast<const char *>(Desc.data()), Desc.size())};
5034   }
5035 }
5036 
5037 struct AMDGPUNote {
5038   std::string Type;
5039   std::string Value;
5040 };
5041 
5042 template <typename ELFT>
5043 static AMDGPUNote getAMDGPUNote(uint32_t NoteType, ArrayRef<uint8_t> Desc) {
5044   switch (NoteType) {
5045   default:
5046     return {"", ""};
5047   case ELF::NT_AMDGPU_METADATA: {
5048     auto MsgPackString =
5049         StringRef(reinterpret_cast<const char *>(Desc.data()), Desc.size());
5050     msgpack::Document MsgPackDoc;
5051     if (!MsgPackDoc.readFromBlob(MsgPackString, /*Multi=*/false))
5052       return {"AMDGPU Metadata", "Invalid AMDGPU Metadata"};
5053 
5054     AMDGPU::HSAMD::V3::MetadataVerifier Verifier(true);
5055     if (!Verifier.verify(MsgPackDoc.getRoot()))
5056       return {"AMDGPU Metadata", "Invalid AMDGPU Metadata"};
5057 
5058     std::string HSAMetadataString;
5059     raw_string_ostream StrOS(HSAMetadataString);
5060     MsgPackDoc.toYAML(StrOS);
5061 
5062     return {"AMDGPU Metadata", StrOS.str()};
5063   }
5064   }
5065 }
5066 
5067 struct CoreFileMapping {
5068   uint64_t Start, End, Offset;
5069   StringRef Filename;
5070 };
5071 
5072 struct CoreNote {
5073   uint64_t PageSize;
5074   std::vector<CoreFileMapping> Mappings;
5075 };
5076 
5077 static Expected<CoreNote> readCoreNote(DataExtractor Desc) {
5078   // Expected format of the NT_FILE note description:
5079   // 1. # of file mappings (call it N)
5080   // 2. Page size
5081   // 3. N (start, end, offset) triples
5082   // 4. N packed filenames (null delimited)
5083   // Each field is an Elf_Addr, except for filenames which are char* strings.
5084 
5085   CoreNote Ret;
5086   const int Bytes = Desc.getAddressSize();
5087 
5088   if (!Desc.isValidOffsetForAddress(2))
5089     return createStringError(object_error::parse_failed,
5090                              "malformed note: header too short");
5091   if (Desc.getData().back() != 0)
5092     return createStringError(object_error::parse_failed,
5093                              "malformed note: not NUL terminated");
5094 
5095   uint64_t DescOffset = 0;
5096   uint64_t FileCount = Desc.getAddress(&DescOffset);
5097   Ret.PageSize = Desc.getAddress(&DescOffset);
5098 
5099   if (!Desc.isValidOffsetForAddress(3 * FileCount * Bytes))
5100     return createStringError(object_error::parse_failed,
5101                              "malformed note: too short for number of files");
5102 
5103   uint64_t FilenamesOffset = 0;
5104   DataExtractor Filenames(
5105       Desc.getData().drop_front(DescOffset + 3 * FileCount * Bytes),
5106       Desc.isLittleEndian(), Desc.getAddressSize());
5107 
5108   Ret.Mappings.resize(FileCount);
5109   for (CoreFileMapping &Mapping : Ret.Mappings) {
5110     if (!Filenames.isValidOffsetForDataOfSize(FilenamesOffset, 1))
5111       return createStringError(object_error::parse_failed,
5112                                "malformed note: too few filenames");
5113     Mapping.Start = Desc.getAddress(&DescOffset);
5114     Mapping.End = Desc.getAddress(&DescOffset);
5115     Mapping.Offset = Desc.getAddress(&DescOffset);
5116     Mapping.Filename = Filenames.getCStrRef(&FilenamesOffset);
5117   }
5118 
5119   return Ret;
5120 }
5121 
5122 template <typename ELFT>
5123 static void printCoreNote(raw_ostream &OS, const CoreNote &Note) {
5124   // Length of "0x<address>" string.
5125   const int FieldWidth = ELFT::Is64Bits ? 18 : 10;
5126 
5127   OS << "    Page size: " << format_decimal(Note.PageSize, 0) << '\n';
5128   OS << "    " << right_justify("Start", FieldWidth) << "  "
5129      << right_justify("End", FieldWidth) << "  "
5130      << right_justify("Page Offset", FieldWidth) << '\n';
5131   for (const CoreFileMapping &Mapping : Note.Mappings) {
5132     OS << "    " << format_hex(Mapping.Start, FieldWidth) << "  "
5133        << format_hex(Mapping.End, FieldWidth) << "  "
5134        << format_hex(Mapping.Offset, FieldWidth) << "\n        "
5135        << Mapping.Filename << '\n';
5136   }
5137 }
5138 
5139 template <class ELFT>
5140 void GNUStyle<ELFT>::printNotes(const ELFFile<ELFT> *Obj) {
5141   auto PrintHeader = [&](Optional<StringRef> SecName,
5142                          const typename ELFT::Off Offset,
5143                          const typename ELFT::Addr Size) {
5144     OS << "Displaying notes found ";
5145 
5146     if (SecName)
5147       OS << "in: " << *SecName << "\n";
5148     else
5149       OS << "at file offset " << format_hex(Offset, 10) << " with length "
5150          << format_hex(Size, 10) << ":\n";
5151 
5152     OS << "  Owner                Data size \tDescription\n";
5153   };
5154 
5155   auto ProcessNote = [&](const Elf_Note &Note) {
5156     StringRef Name = Note.getName();
5157     ArrayRef<uint8_t> Descriptor = Note.getDesc();
5158     Elf_Word Type = Note.getType();
5159 
5160     // Print the note owner/type.
5161     OS << "  " << left_justify(Name, 20) << ' '
5162        << format_hex(Descriptor.size(), 10) << '\t';
5163     if (Name == "GNU") {
5164       OS << getGNUNoteTypeName(Type) << '\n';
5165     } else if (Name == "FreeBSD") {
5166       OS << getFreeBSDNoteTypeName(Type) << '\n';
5167     } else if (Name == "AMD") {
5168       OS << getAMDNoteTypeName(Type) << '\n';
5169     } else if (Name == "AMDGPU") {
5170       OS << getAMDGPUNoteTypeName(Type) << '\n';
5171     } else {
5172       StringRef NoteType = Obj->getHeader()->e_type == ELF::ET_CORE
5173                                ? getCoreNoteTypeName(Type)
5174                                : getGenericNoteTypeName(Type);
5175       if (!NoteType.empty())
5176         OS << NoteType << '\n';
5177       else
5178         OS << "Unknown note type: (" << format_hex(Type, 10) << ")\n";
5179     }
5180 
5181     // Print the description, or fallback to printing raw bytes for unknown
5182     // owners.
5183     if (Name == "GNU") {
5184       printGNUNote<ELFT>(OS, Type, Descriptor);
5185     } else if (Name == "AMD") {
5186       const AMDNote N = getAMDNote<ELFT>(Type, Descriptor);
5187       if (!N.Type.empty())
5188         OS << "    " << N.Type << ":\n        " << N.Value << '\n';
5189     } else if (Name == "AMDGPU") {
5190       const AMDGPUNote N = getAMDGPUNote<ELFT>(Type, Descriptor);
5191       if (!N.Type.empty())
5192         OS << "    " << N.Type << ":\n        " << N.Value << '\n';
5193     } else if (Name == "CORE") {
5194       if (Type == ELF::NT_FILE) {
5195         DataExtractor DescExtractor(Descriptor,
5196                                     ELFT::TargetEndianness == support::little,
5197                                     sizeof(Elf_Addr));
5198         Expected<CoreNote> Note = readCoreNote(DescExtractor);
5199         if (Note)
5200           printCoreNote<ELFT>(OS, *Note);
5201         else
5202           reportWarning(Note.takeError(), this->FileName);
5203       }
5204     } else if (!Descriptor.empty()) {
5205       OS << "   description data:";
5206       for (uint8_t B : Descriptor)
5207         OS << " " << format("%02x", B);
5208       OS << '\n';
5209     }
5210   };
5211 
5212   ArrayRef<Elf_Shdr> Sections = unwrapOrError(this->FileName, Obj->sections());
5213   if (Obj->getHeader()->e_type != ELF::ET_CORE && !Sections.empty()) {
5214     for (const auto &S : Sections) {
5215       if (S.sh_type != SHT_NOTE)
5216         continue;
5217       PrintHeader(expectedToOptional(Obj->getSectionName(&S)), S.sh_offset,
5218                   S.sh_size);
5219       Error Err = Error::success();
5220       for (auto Note : Obj->notes(S, Err))
5221         ProcessNote(Note);
5222       if (Err)
5223         reportError(std::move(Err), this->FileName);
5224     }
5225   } else {
5226     for (const auto &P :
5227          unwrapOrError(this->FileName, Obj->program_headers())) {
5228       if (P.p_type != PT_NOTE)
5229         continue;
5230       PrintHeader(/*SecName=*/None, P.p_offset, P.p_filesz);
5231       Error Err = Error::success();
5232       for (auto Note : Obj->notes(P, Err))
5233         ProcessNote(Note);
5234       if (Err)
5235         reportError(std::move(Err), this->FileName);
5236     }
5237   }
5238 }
5239 
5240 template <class ELFT>
5241 void GNUStyle<ELFT>::printELFLinkerOptions(const ELFFile<ELFT> *Obj) {
5242   OS << "printELFLinkerOptions not implemented!\n";
5243 }
5244 
5245 template <class ELFT>
5246 void GNUStyle<ELFT>::printDependentLibs(const ELFFile<ELFT> *Obj) {
5247   OS << "printDependentLibs not implemented!\n";
5248 }
5249 
5250 // Used for printing section names in places where possible errors can be
5251 // ignored.
5252 static StringRef getSectionName(const SectionRef &Sec) {
5253   Expected<StringRef> NameOrErr = Sec.getName();
5254   if (NameOrErr)
5255     return *NameOrErr;
5256   consumeError(NameOrErr.takeError());
5257   return "<?>";
5258 }
5259 
5260 // Used for printing symbol names in places where possible errors can be
5261 // ignored.
5262 static std::string getSymbolName(const ELFSymbolRef &Sym) {
5263   Expected<StringRef> NameOrErr = Sym.getName();
5264   if (NameOrErr)
5265     return maybeDemangle(*NameOrErr);
5266   consumeError(NameOrErr.takeError());
5267   return "<?>";
5268 }
5269 
5270 template <class ELFT>
5271 void DumpStyle<ELFT>::printFunctionStackSize(const ELFObjectFile<ELFT> *Obj,
5272                                              uint64_t SymValue,
5273                                              Optional<SectionRef> FunctionSec,
5274                                              const StringRef SectionName,
5275                                              DataExtractor Data,
5276                                              uint64_t *Offset) {
5277   // This function ignores potentially erroneous input, unless it is directly
5278   // related to stack size reporting.
5279   SymbolRef FuncSym;
5280   for (const ELFSymbolRef &Symbol : Obj->symbols()) {
5281     Expected<uint64_t> SymAddrOrErr = Symbol.getAddress();
5282     if (!SymAddrOrErr) {
5283       consumeError(SymAddrOrErr.takeError());
5284       continue;
5285     }
5286     if (Expected<uint32_t> SymFlags = Symbol.getFlags()) {
5287       if (*SymFlags & SymbolRef::SF_Undefined)
5288         continue;
5289     } else
5290       consumeError(SymFlags.takeError());
5291     if (Symbol.getELFType() == ELF::STT_FUNC && *SymAddrOrErr == SymValue) {
5292       // Check if the symbol is in the right section. FunctionSec == None means
5293       // "any section".
5294       if (!FunctionSec || FunctionSec->containsSymbol(Symbol)) {
5295         FuncSym = Symbol;
5296         break;
5297       }
5298     }
5299   }
5300 
5301   std::string FuncName = "?";
5302   // A valid SymbolRef has a non-null object file pointer.
5303   if (FuncSym.BasicSymbolRef::getObject())
5304     FuncName = getSymbolName(FuncSym);
5305   else
5306     reportWarning(
5307         createError("could not identify function symbol for stack size entry"),
5308         Obj->getFileName());
5309 
5310   // Extract the size. The expectation is that Offset is pointing to the right
5311   // place, i.e. past the function address.
5312   uint64_t PrevOffset = *Offset;
5313   uint64_t StackSize = Data.getULEB128(Offset);
5314   // getULEB128() does not advance Offset if it is not able to extract a valid
5315   // integer.
5316   if (*Offset == PrevOffset)
5317     reportError(
5318         createStringError(object_error::parse_failed,
5319                           "could not extract a valid stack size in section %s",
5320                           SectionName.data()),
5321         Obj->getFileName());
5322 
5323   printStackSizeEntry(StackSize, FuncName);
5324 }
5325 
5326 template <class ELFT>
5327 void GNUStyle<ELFT>::printStackSizeEntry(uint64_t Size, StringRef FuncName) {
5328   OS.PadToColumn(2);
5329   OS << format_decimal(Size, 11);
5330   OS.PadToColumn(18);
5331   OS << FuncName << "\n";
5332 }
5333 
5334 template <class ELFT>
5335 void DumpStyle<ELFT>::printStackSize(const ELFObjectFile<ELFT> *Obj,
5336                                      RelocationRef Reloc,
5337                                      SectionRef FunctionSec,
5338                                      const StringRef &StackSizeSectionName,
5339                                      const RelocationResolver &Resolver,
5340                                      DataExtractor Data) {
5341   // This function ignores potentially erroneous input, unless it is directly
5342   // related to stack size reporting.
5343   object::symbol_iterator RelocSym = Reloc.getSymbol();
5344   uint64_t RelocSymValue = 0;
5345   StringRef FileStr = Obj->getFileName();
5346   if (RelocSym != Obj->symbol_end()) {
5347     // Ensure that the relocation symbol is in the function section, i.e. the
5348     // section where the functions whose stack sizes we are reporting are
5349     // located.
5350     auto SectionOrErr = RelocSym->getSection();
5351     if (!SectionOrErr) {
5352       reportWarning(
5353           createError("cannot identify the section for relocation symbol '" +
5354                       getSymbolName(*RelocSym) + "'"),
5355           FileStr);
5356       consumeError(SectionOrErr.takeError());
5357     } else if (*SectionOrErr != FunctionSec) {
5358       reportWarning(createError("relocation symbol '" +
5359                                 getSymbolName(*RelocSym) +
5360                                 "' is not in the expected section"),
5361                     FileStr);
5362       // Pretend that the symbol is in the correct section and report its
5363       // stack size anyway.
5364       FunctionSec = **SectionOrErr;
5365     }
5366 
5367     Expected<uint64_t> RelocSymValueOrErr = RelocSym->getValue();
5368     if (RelocSymValueOrErr)
5369       RelocSymValue = *RelocSymValueOrErr;
5370     else
5371       consumeError(RelocSymValueOrErr.takeError());
5372   }
5373 
5374   uint64_t Offset = Reloc.getOffset();
5375   if (!Data.isValidOffsetForDataOfSize(Offset, sizeof(Elf_Addr) + 1))
5376     reportError(
5377         createStringError(object_error::parse_failed,
5378                           "found invalid relocation offset into section %s "
5379                           "while trying to extract a stack size entry",
5380                           StackSizeSectionName.data()),
5381         FileStr);
5382 
5383   uint64_t Addend = Data.getAddress(&Offset);
5384   uint64_t SymValue = Resolver(Reloc, RelocSymValue, Addend);
5385   this->printFunctionStackSize(Obj, SymValue, FunctionSec, StackSizeSectionName,
5386                                Data, &Offset);
5387 }
5388 
5389 template <class ELFT>
5390 void DumpStyle<ELFT>::printNonRelocatableStackSizes(
5391     const ELFObjectFile<ELFT> *Obj, std::function<void()> PrintHeader) {
5392   // This function ignores potentially erroneous input, unless it is directly
5393   // related to stack size reporting.
5394   const ELFFile<ELFT> *EF = Obj->getELFFile();
5395   StringRef FileStr = Obj->getFileName();
5396   for (const SectionRef &Sec : Obj->sections()) {
5397     StringRef SectionName = getSectionName(Sec);
5398     if (SectionName != ".stack_sizes")
5399       continue;
5400     PrintHeader();
5401     const Elf_Shdr *ElfSec = Obj->getSection(Sec.getRawDataRefImpl());
5402     ArrayRef<uint8_t> Contents =
5403         unwrapOrError(this->FileName, EF->getSectionContents(ElfSec));
5404     DataExtractor Data(Contents, Obj->isLittleEndian(), sizeof(Elf_Addr));
5405     uint64_t Offset = 0;
5406     while (Offset < Contents.size()) {
5407       // The function address is followed by a ULEB representing the stack
5408       // size. Check for an extra byte before we try to process the entry.
5409       if (!Data.isValidOffsetForDataOfSize(Offset, sizeof(Elf_Addr) + 1)) {
5410         reportError(
5411             createStringError(
5412                 object_error::parse_failed,
5413                 "section %s ended while trying to extract a stack size entry",
5414                 SectionName.data()),
5415             FileStr);
5416       }
5417       uint64_t SymValue = Data.getAddress(&Offset);
5418       printFunctionStackSize(Obj, SymValue, /*FunctionSec=*/None, SectionName,
5419                              Data, &Offset);
5420     }
5421   }
5422 }
5423 
5424 template <class ELFT>
5425 void DumpStyle<ELFT>::printRelocatableStackSizes(
5426     const ELFObjectFile<ELFT> *Obj, std::function<void()> PrintHeader) {
5427   const ELFFile<ELFT> *EF = Obj->getELFFile();
5428 
5429   // Build a map between stack size sections and their corresponding relocation
5430   // sections.
5431   llvm::MapVector<SectionRef, SectionRef> StackSizeRelocMap;
5432   const SectionRef NullSection{};
5433 
5434   for (const SectionRef &Sec : Obj->sections()) {
5435     StringRef SectionName;
5436     if (Expected<StringRef> NameOrErr = Sec.getName())
5437       SectionName = *NameOrErr;
5438     else
5439       consumeError(NameOrErr.takeError());
5440 
5441     // A stack size section that we haven't encountered yet is mapped to the
5442     // null section until we find its corresponding relocation section.
5443     if (SectionName == ".stack_sizes")
5444       if (StackSizeRelocMap.count(Sec) == 0) {
5445         StackSizeRelocMap[Sec] = NullSection;
5446         continue;
5447       }
5448 
5449     // Check relocation sections if they are relocating contents of a
5450     // stack sizes section.
5451     const Elf_Shdr *ElfSec = Obj->getSection(Sec.getRawDataRefImpl());
5452     uint32_t SectionType = ElfSec->sh_type;
5453     if (SectionType != ELF::SHT_RELA && SectionType != ELF::SHT_REL)
5454       continue;
5455 
5456     Expected<section_iterator> RelSecOrErr = Sec.getRelocatedSection();
5457     if (!RelSecOrErr)
5458       reportError(createStringError(object_error::parse_failed,
5459                                     "%s: failed to get a relocated section: %s",
5460                                     SectionName.data(),
5461                                     toString(RelSecOrErr.takeError()).c_str()),
5462                   Obj->getFileName());
5463 
5464     const Elf_Shdr *ContentsSec =
5465         Obj->getSection((*RelSecOrErr)->getRawDataRefImpl());
5466     Expected<StringRef> ContentsSectionNameOrErr =
5467         EF->getSectionName(ContentsSec);
5468     if (!ContentsSectionNameOrErr) {
5469       consumeError(ContentsSectionNameOrErr.takeError());
5470       continue;
5471     }
5472     if (*ContentsSectionNameOrErr != ".stack_sizes")
5473       continue;
5474     // Insert a mapping from the stack sizes section to its relocation section.
5475     StackSizeRelocMap[Obj->toSectionRef(ContentsSec)] = Sec;
5476   }
5477 
5478   for (const auto &StackSizeMapEntry : StackSizeRelocMap) {
5479     PrintHeader();
5480     const SectionRef &StackSizesSec = StackSizeMapEntry.first;
5481     const SectionRef &RelocSec = StackSizeMapEntry.second;
5482 
5483     // Warn about stack size sections without a relocation section.
5484     StringRef StackSizeSectionName = getSectionName(StackSizesSec);
5485     if (RelocSec == NullSection) {
5486       reportWarning(createError("section " + StackSizeSectionName +
5487                                 " does not have a corresponding "
5488                                 "relocation section"),
5489                     Obj->getFileName());
5490       continue;
5491     }
5492 
5493     // A .stack_sizes section header's sh_link field is supposed to point
5494     // to the section that contains the functions whose stack sizes are
5495     // described in it.
5496     const Elf_Shdr *StackSizesELFSec =
5497         Obj->getSection(StackSizesSec.getRawDataRefImpl());
5498     const SectionRef FunctionSec = Obj->toSectionRef(unwrapOrError(
5499         this->FileName, EF->getSection(StackSizesELFSec->sh_link)));
5500 
5501     bool (*IsSupportedFn)(uint64_t);
5502     RelocationResolver Resolver;
5503     std::tie(IsSupportedFn, Resolver) = getRelocationResolver(*Obj);
5504     auto Contents = unwrapOrError(this->FileName, StackSizesSec.getContents());
5505     DataExtractor Data(Contents, Obj->isLittleEndian(), sizeof(Elf_Addr));
5506     for (const RelocationRef &Reloc : RelocSec.relocations()) {
5507       if (!IsSupportedFn || !IsSupportedFn(Reloc.getType()))
5508         reportError(createStringError(
5509                         object_error::parse_failed,
5510                         "unsupported relocation type in section %s: %s",
5511                         getSectionName(RelocSec).data(),
5512                         EF->getRelocationTypeName(Reloc.getType()).data()),
5513                     Obj->getFileName());
5514       this->printStackSize(Obj, Reloc, FunctionSec, StackSizeSectionName,
5515                            Resolver, Data);
5516     }
5517   }
5518 }
5519 
5520 template <class ELFT>
5521 void GNUStyle<ELFT>::printStackSizes(const ELFObjectFile<ELFT> *Obj) {
5522   bool HeaderHasBeenPrinted = false;
5523   auto PrintHeader = [&]() {
5524     if (HeaderHasBeenPrinted)
5525       return;
5526     OS << "\nStack Sizes:\n";
5527     OS.PadToColumn(9);
5528     OS << "Size";
5529     OS.PadToColumn(18);
5530     OS << "Function\n";
5531     HeaderHasBeenPrinted = true;
5532   };
5533 
5534   // For non-relocatable objects, look directly for sections whose name starts
5535   // with .stack_sizes and process the contents.
5536   if (Obj->isRelocatableObject())
5537     this->printRelocatableStackSizes(Obj, PrintHeader);
5538   else
5539     this->printNonRelocatableStackSizes(Obj, PrintHeader);
5540 }
5541 
5542 template <class ELFT>
5543 void GNUStyle<ELFT>::printMipsGOT(const MipsGOTParser<ELFT> &Parser) {
5544   size_t Bias = ELFT::Is64Bits ? 8 : 0;
5545   auto PrintEntry = [&](const Elf_Addr *E, StringRef Purpose) {
5546     OS.PadToColumn(2);
5547     OS << format_hex_no_prefix(Parser.getGotAddress(E), 8 + Bias);
5548     OS.PadToColumn(11 + Bias);
5549     OS << format_decimal(Parser.getGotOffset(E), 6) << "(gp)";
5550     OS.PadToColumn(22 + Bias);
5551     OS << format_hex_no_prefix(*E, 8 + Bias);
5552     OS.PadToColumn(31 + 2 * Bias);
5553     OS << Purpose << "\n";
5554   };
5555 
5556   OS << (Parser.IsStatic ? "Static GOT:\n" : "Primary GOT:\n");
5557   OS << " Canonical gp value: "
5558      << format_hex_no_prefix(Parser.getGp(), 8 + Bias) << "\n\n";
5559 
5560   OS << " Reserved entries:\n";
5561   if (ELFT::Is64Bits)
5562     OS << "           Address     Access          Initial Purpose\n";
5563   else
5564     OS << "   Address     Access  Initial Purpose\n";
5565   PrintEntry(Parser.getGotLazyResolver(), "Lazy resolver");
5566   if (Parser.getGotModulePointer())
5567     PrintEntry(Parser.getGotModulePointer(), "Module pointer (GNU extension)");
5568 
5569   if (!Parser.getLocalEntries().empty()) {
5570     OS << "\n";
5571     OS << " Local entries:\n";
5572     if (ELFT::Is64Bits)
5573       OS << "           Address     Access          Initial\n";
5574     else
5575       OS << "   Address     Access  Initial\n";
5576     for (auto &E : Parser.getLocalEntries())
5577       PrintEntry(&E, "");
5578   }
5579 
5580   if (Parser.IsStatic)
5581     return;
5582 
5583   if (!Parser.getGlobalEntries().empty()) {
5584     OS << "\n";
5585     OS << " Global entries:\n";
5586     if (ELFT::Is64Bits)
5587       OS << "           Address     Access          Initial         Sym.Val."
5588          << " Type    Ndx Name\n";
5589     else
5590       OS << "   Address     Access  Initial Sym.Val. Type    Ndx Name\n";
5591     for (auto &E : Parser.getGlobalEntries()) {
5592       const Elf_Sym *Sym = Parser.getGotSym(&E);
5593       std::string SymName = this->dumper()->getFullSymbolName(
5594           Sym, this->dumper()->getDynamicStringTable(), false);
5595 
5596       OS.PadToColumn(2);
5597       OS << to_string(format_hex_no_prefix(Parser.getGotAddress(&E), 8 + Bias));
5598       OS.PadToColumn(11 + Bias);
5599       OS << to_string(format_decimal(Parser.getGotOffset(&E), 6)) + "(gp)";
5600       OS.PadToColumn(22 + Bias);
5601       OS << to_string(format_hex_no_prefix(E, 8 + Bias));
5602       OS.PadToColumn(31 + 2 * Bias);
5603       OS << to_string(format_hex_no_prefix(Sym->st_value, 8 + Bias));
5604       OS.PadToColumn(40 + 3 * Bias);
5605       OS << printEnum(Sym->getType(), makeArrayRef(ElfSymbolTypes));
5606       OS.PadToColumn(48 + 3 * Bias);
5607       OS << getSymbolSectionNdx(Parser.Obj, Sym,
5608                                 this->dumper()->dynamic_symbols().begin());
5609       OS.PadToColumn(52 + 3 * Bias);
5610       OS << SymName << "\n";
5611     }
5612   }
5613 
5614   if (!Parser.getOtherEntries().empty())
5615     OS << "\n Number of TLS and multi-GOT entries "
5616        << Parser.getOtherEntries().size() << "\n";
5617 }
5618 
5619 template <class ELFT>
5620 void GNUStyle<ELFT>::printMipsPLT(const MipsGOTParser<ELFT> &Parser) {
5621   size_t Bias = ELFT::Is64Bits ? 8 : 0;
5622   auto PrintEntry = [&](const Elf_Addr *E, StringRef Purpose) {
5623     OS.PadToColumn(2);
5624     OS << format_hex_no_prefix(Parser.getPltAddress(E), 8 + Bias);
5625     OS.PadToColumn(11 + Bias);
5626     OS << format_hex_no_prefix(*E, 8 + Bias);
5627     OS.PadToColumn(20 + 2 * Bias);
5628     OS << Purpose << "\n";
5629   };
5630 
5631   OS << "PLT GOT:\n\n";
5632 
5633   OS << " Reserved entries:\n";
5634   OS << "   Address  Initial Purpose\n";
5635   PrintEntry(Parser.getPltLazyResolver(), "PLT lazy resolver");
5636   if (Parser.getPltModulePointer())
5637     PrintEntry(Parser.getPltModulePointer(), "Module pointer");
5638 
5639   if (!Parser.getPltEntries().empty()) {
5640     OS << "\n";
5641     OS << " Entries:\n";
5642     OS << "   Address  Initial Sym.Val. Type    Ndx Name\n";
5643     for (auto &E : Parser.getPltEntries()) {
5644       const Elf_Sym *Sym = Parser.getPltSym(&E);
5645       std::string SymName = this->dumper()->getFullSymbolName(
5646           Sym, this->dumper()->getDynamicStringTable(), false);
5647 
5648       OS.PadToColumn(2);
5649       OS << to_string(format_hex_no_prefix(Parser.getPltAddress(&E), 8 + Bias));
5650       OS.PadToColumn(11 + Bias);
5651       OS << to_string(format_hex_no_prefix(E, 8 + Bias));
5652       OS.PadToColumn(20 + 2 * Bias);
5653       OS << to_string(format_hex_no_prefix(Sym->st_value, 8 + Bias));
5654       OS.PadToColumn(29 + 3 * Bias);
5655       OS << printEnum(Sym->getType(), makeArrayRef(ElfSymbolTypes));
5656       OS.PadToColumn(37 + 3 * Bias);
5657       OS << getSymbolSectionNdx(Parser.Obj, Sym,
5658                                 this->dumper()->dynamic_symbols().begin());
5659       OS.PadToColumn(41 + 3 * Bias);
5660       OS << SymName << "\n";
5661     }
5662   }
5663 }
5664 
5665 template <class ELFT>
5666 void GNUStyle<ELFT>::printMipsABIFlags(const ELFObjectFile<ELFT> *ObjF) {
5667   const ELFFile<ELFT> *Obj = ObjF->getELFFile();
5668   const Elf_Shdr *Shdr =
5669       findSectionByName(*Obj, ObjF->getFileName(), ".MIPS.abiflags");
5670   if (!Shdr)
5671     return;
5672 
5673   ArrayRef<uint8_t> Sec =
5674       unwrapOrError(ObjF->getFileName(), Obj->getSectionContents(Shdr));
5675   if (Sec.size() != sizeof(Elf_Mips_ABIFlags<ELFT>))
5676     reportError(createError(".MIPS.abiflags section has a wrong size"),
5677                 ObjF->getFileName());
5678 
5679   auto *Flags = reinterpret_cast<const Elf_Mips_ABIFlags<ELFT> *>(Sec.data());
5680 
5681   OS << "MIPS ABI Flags Version: " << Flags->version << "\n\n";
5682   OS << "ISA: MIPS" << int(Flags->isa_level);
5683   if (Flags->isa_rev > 1)
5684     OS << "r" << int(Flags->isa_rev);
5685   OS << "\n";
5686   OS << "GPR size: " << getMipsRegisterSize(Flags->gpr_size) << "\n";
5687   OS << "CPR1 size: " << getMipsRegisterSize(Flags->cpr1_size) << "\n";
5688   OS << "CPR2 size: " << getMipsRegisterSize(Flags->cpr2_size) << "\n";
5689   OS << "FP ABI: " << printEnum(Flags->fp_abi, makeArrayRef(ElfMipsFpABIType))
5690      << "\n";
5691   OS << "ISA Extension: "
5692      << printEnum(Flags->isa_ext, makeArrayRef(ElfMipsISAExtType)) << "\n";
5693   if (Flags->ases == 0)
5694     OS << "ASEs: None\n";
5695   else
5696     // FIXME: Print each flag on a separate line.
5697     OS << "ASEs: " << printFlags(Flags->ases, makeArrayRef(ElfMipsASEFlags))
5698        << "\n";
5699   OS << "FLAGS 1: " << format_hex_no_prefix(Flags->flags1, 8, false) << "\n";
5700   OS << "FLAGS 2: " << format_hex_no_prefix(Flags->flags2, 8, false) << "\n";
5701   OS << "\n";
5702 }
5703 
5704 template <class ELFT> void LLVMStyle<ELFT>::printFileHeaders(const ELFO *Obj) {
5705   const Elf_Ehdr *E = Obj->getHeader();
5706   {
5707     DictScope D(W, "ElfHeader");
5708     {
5709       DictScope D(W, "Ident");
5710       W.printBinary("Magic", makeArrayRef(E->e_ident).slice(ELF::EI_MAG0, 4));
5711       W.printEnum("Class", E->e_ident[ELF::EI_CLASS], makeArrayRef(ElfClass));
5712       W.printEnum("DataEncoding", E->e_ident[ELF::EI_DATA],
5713                   makeArrayRef(ElfDataEncoding));
5714       W.printNumber("FileVersion", E->e_ident[ELF::EI_VERSION]);
5715 
5716       auto OSABI = makeArrayRef(ElfOSABI);
5717       if (E->e_ident[ELF::EI_OSABI] >= ELF::ELFOSABI_FIRST_ARCH &&
5718           E->e_ident[ELF::EI_OSABI] <= ELF::ELFOSABI_LAST_ARCH) {
5719         switch (E->e_machine) {
5720         case ELF::EM_AMDGPU:
5721           OSABI = makeArrayRef(AMDGPUElfOSABI);
5722           break;
5723         case ELF::EM_ARM:
5724           OSABI = makeArrayRef(ARMElfOSABI);
5725           break;
5726         case ELF::EM_TI_C6000:
5727           OSABI = makeArrayRef(C6000ElfOSABI);
5728           break;
5729         }
5730       }
5731       W.printEnum("OS/ABI", E->e_ident[ELF::EI_OSABI], OSABI);
5732       W.printNumber("ABIVersion", E->e_ident[ELF::EI_ABIVERSION]);
5733       W.printBinary("Unused", makeArrayRef(E->e_ident).slice(ELF::EI_PAD));
5734     }
5735 
5736     W.printEnum("Type", E->e_type, makeArrayRef(ElfObjectFileType));
5737     W.printEnum("Machine", E->e_machine, makeArrayRef(ElfMachineType));
5738     W.printNumber("Version", E->e_version);
5739     W.printHex("Entry", E->e_entry);
5740     W.printHex("ProgramHeaderOffset", E->e_phoff);
5741     W.printHex("SectionHeaderOffset", E->e_shoff);
5742     if (E->e_machine == EM_MIPS)
5743       W.printFlags("Flags", E->e_flags, makeArrayRef(ElfHeaderMipsFlags),
5744                    unsigned(ELF::EF_MIPS_ARCH), unsigned(ELF::EF_MIPS_ABI),
5745                    unsigned(ELF::EF_MIPS_MACH));
5746     else if (E->e_machine == EM_AMDGPU)
5747       W.printFlags("Flags", E->e_flags, makeArrayRef(ElfHeaderAMDGPUFlags),
5748                    unsigned(ELF::EF_AMDGPU_MACH));
5749     else if (E->e_machine == EM_RISCV)
5750       W.printFlags("Flags", E->e_flags, makeArrayRef(ElfHeaderRISCVFlags));
5751     else
5752       W.printFlags("Flags", E->e_flags);
5753     W.printNumber("HeaderSize", E->e_ehsize);
5754     W.printNumber("ProgramHeaderEntrySize", E->e_phentsize);
5755     W.printNumber("ProgramHeaderCount", E->e_phnum);
5756     W.printNumber("SectionHeaderEntrySize", E->e_shentsize);
5757     W.printString("SectionHeaderCount",
5758                   getSectionHeadersNumString(Obj, this->FileName));
5759     W.printString("StringTableSectionIndex",
5760                   getSectionHeaderTableIndexString(Obj, this->FileName));
5761   }
5762 }
5763 
5764 template <class ELFT>
5765 void LLVMStyle<ELFT>::printGroupSections(const ELFO *Obj) {
5766   DictScope Lists(W, "Groups");
5767   std::vector<GroupSection> V = getGroups<ELFT>(Obj, this->FileName);
5768   DenseMap<uint64_t, const GroupSection *> Map = mapSectionsToGroups(V);
5769   for (const GroupSection &G : V) {
5770     DictScope D(W, "Group");
5771     W.printNumber("Name", G.Name, G.ShName);
5772     W.printNumber("Index", G.Index);
5773     W.printNumber("Link", G.Link);
5774     W.printNumber("Info", G.Info);
5775     W.printHex("Type", getGroupType(G.Type), G.Type);
5776     W.startLine() << "Signature: " << G.Signature << "\n";
5777 
5778     ListScope L(W, "Section(s) in group");
5779     for (const GroupMember &GM : G.Members) {
5780       const GroupSection *MainGroup = Map[GM.Index];
5781       if (MainGroup != &G) {
5782         W.flush();
5783         errs() << "Error: " << GM.Name << " (" << GM.Index
5784                << ") in a group " + G.Name + " (" << G.Index
5785                << ") is already in a group " + MainGroup->Name + " ("
5786                << MainGroup->Index << ")\n";
5787         errs().flush();
5788         continue;
5789       }
5790       W.startLine() << GM.Name << " (" << GM.Index << ")\n";
5791     }
5792   }
5793 
5794   if (V.empty())
5795     W.startLine() << "There are no group sections in the file.\n";
5796 }
5797 
5798 template <class ELFT> void LLVMStyle<ELFT>::printRelocations(const ELFO *Obj) {
5799   ListScope D(W, "Relocations");
5800 
5801   int SectionNumber = -1;
5802   for (const Elf_Shdr &Sec : unwrapOrError(this->FileName, Obj->sections())) {
5803     ++SectionNumber;
5804 
5805     if (Sec.sh_type != ELF::SHT_REL && Sec.sh_type != ELF::SHT_RELA &&
5806         Sec.sh_type != ELF::SHT_RELR && Sec.sh_type != ELF::SHT_ANDROID_REL &&
5807         Sec.sh_type != ELF::SHT_ANDROID_RELA &&
5808         Sec.sh_type != ELF::SHT_ANDROID_RELR)
5809       continue;
5810 
5811     StringRef Name = unwrapOrError(this->FileName, Obj->getSectionName(&Sec));
5812 
5813     W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";
5814     W.indent();
5815 
5816     printRelocations(&Sec, Obj);
5817 
5818     W.unindent();
5819     W.startLine() << "}\n";
5820   }
5821 }
5822 
5823 template <class ELFT>
5824 void LLVMStyle<ELFT>::printRelocations(const Elf_Shdr *Sec, const ELFO *Obj) {
5825   const Elf_Shdr *SymTab =
5826       unwrapOrError(this->FileName, Obj->getSection(Sec->sh_link));
5827   unsigned SecNdx = Sec - &cantFail(Obj->sections()).front();
5828   unsigned RelNdx = 0;
5829 
5830   switch (Sec->sh_type) {
5831   case ELF::SHT_REL:
5832     for (const Elf_Rel &R : unwrapOrError(this->FileName, Obj->rels(Sec))) {
5833       Elf_Rela Rela;
5834       Rela.r_offset = R.r_offset;
5835       Rela.r_info = R.r_info;
5836       Rela.r_addend = 0;
5837       printRelocation(Obj, SecNdx, Rela, ++RelNdx, SymTab);
5838     }
5839     break;
5840   case ELF::SHT_RELA:
5841     for (const Elf_Rela &R : unwrapOrError(this->FileName, Obj->relas(Sec)))
5842       printRelocation(Obj, SecNdx, R, ++RelNdx, SymTab);
5843     break;
5844   case ELF::SHT_RELR:
5845   case ELF::SHT_ANDROID_RELR: {
5846     Elf_Relr_Range Relrs = unwrapOrError(this->FileName, Obj->relrs(Sec));
5847     if (opts::RawRelr) {
5848       for (const Elf_Relr &R : Relrs)
5849         W.startLine() << W.hex(R) << "\n";
5850     } else {
5851       std::vector<Elf_Rela> RelrRelas =
5852           unwrapOrError(this->FileName, Obj->decode_relrs(Relrs));
5853       for (const Elf_Rela &R : RelrRelas)
5854         printRelocation(Obj, SecNdx, R, ++RelNdx, SymTab);
5855     }
5856     break;
5857   }
5858   case ELF::SHT_ANDROID_REL:
5859   case ELF::SHT_ANDROID_RELA:
5860     for (const Elf_Rela &R :
5861          unwrapOrError(this->FileName, Obj->android_relas(Sec)))
5862       printRelocation(Obj, SecNdx, R, ++RelNdx, SymTab);
5863     break;
5864   }
5865 }
5866 
5867 template <class ELFT>
5868 void LLVMStyle<ELFT>::printRelocation(const ELFO *Obj, unsigned SecIndex,
5869                                       Elf_Rela Rel, unsigned RelIndex,
5870                                       const Elf_Shdr *SymTab) {
5871   Expected<std::pair<const typename ELFT::Sym *, std::string>> Target =
5872       this->dumper()->getRelocationTarget(SymTab, Rel);
5873   if (!Target) {
5874     this->reportUniqueWarning(createError(
5875         "unable to print relocation " + Twine(RelIndex) + " in section " +
5876         Twine(SecIndex) + ": " + toString(Target.takeError())));
5877     return;
5878   }
5879 
5880   std::string TargetName = Target->second;
5881   SmallString<32> RelocName;
5882   Obj->getRelocationTypeName(Rel.getType(Obj->isMips64EL()), RelocName);
5883 
5884   if (opts::ExpandRelocs) {
5885     DictScope Group(W, "Relocation");
5886     W.printHex("Offset", Rel.r_offset);
5887     W.printNumber("Type", RelocName, (int)Rel.getType(Obj->isMips64EL()));
5888     W.printNumber("Symbol", !TargetName.empty() ? TargetName : "-",
5889                   Rel.getSymbol(Obj->isMips64EL()));
5890     W.printHex("Addend", Rel.r_addend);
5891   } else {
5892     raw_ostream &OS = W.startLine();
5893     OS << W.hex(Rel.r_offset) << " " << RelocName << " "
5894        << (!TargetName.empty() ? TargetName : "-") << " " << W.hex(Rel.r_addend)
5895        << "\n";
5896   }
5897 }
5898 
5899 template <class ELFT>
5900 void LLVMStyle<ELFT>::printSectionHeaders(const ELFO *Obj) {
5901   ListScope SectionsD(W, "Sections");
5902 
5903   int SectionIndex = -1;
5904   ArrayRef<Elf_Shdr> Sections = unwrapOrError(this->FileName, Obj->sections());
5905   std::vector<EnumEntry<unsigned>> FlagsList =
5906       getSectionFlagsForTarget(Obj->getHeader()->e_machine);
5907   for (const Elf_Shdr &Sec : Sections) {
5908     StringRef Name = "<?>";
5909     if (Expected<StringRef> SecNameOrErr =
5910             Obj->getSectionName(&Sec, this->dumper()->WarningHandler))
5911       Name = *SecNameOrErr;
5912     else
5913       this->reportUniqueWarning(SecNameOrErr.takeError());
5914 
5915     DictScope SectionD(W, "Section");
5916     W.printNumber("Index", ++SectionIndex);
5917     W.printNumber("Name", Name, Sec.sh_name);
5918     W.printHex(
5919         "Type",
5920         object::getELFSectionTypeName(Obj->getHeader()->e_machine, Sec.sh_type),
5921         Sec.sh_type);
5922     W.printFlags("Flags", Sec.sh_flags, makeArrayRef(FlagsList));
5923     W.printHex("Address", Sec.sh_addr);
5924     W.printHex("Offset", Sec.sh_offset);
5925     W.printNumber("Size", Sec.sh_size);
5926     W.printNumber("Link", Sec.sh_link);
5927     W.printNumber("Info", Sec.sh_info);
5928     W.printNumber("AddressAlignment", Sec.sh_addralign);
5929     W.printNumber("EntrySize", Sec.sh_entsize);
5930 
5931     if (opts::SectionRelocations) {
5932       ListScope D(W, "Relocations");
5933       printRelocations(&Sec, Obj);
5934     }
5935 
5936     if (opts::SectionSymbols) {
5937       ListScope D(W, "Symbols");
5938       const Elf_Shdr *Symtab = this->dumper()->getDotSymtabSec();
5939       StringRef StrTable =
5940           unwrapOrError(this->FileName, Obj->getStringTableForSymtab(*Symtab));
5941 
5942       for (const Elf_Sym &Sym :
5943            unwrapOrError(this->FileName, Obj->symbols(Symtab))) {
5944         const Elf_Shdr *SymSec = unwrapOrError(
5945             this->FileName,
5946             Obj->getSection(&Sym, Symtab, this->dumper()->getShndxTable()));
5947         if (SymSec == &Sec)
5948           printSymbol(
5949               Obj, &Sym,
5950               unwrapOrError(this->FileName, Obj->symbols(Symtab)).begin(),
5951               StrTable, false, false);
5952       }
5953     }
5954 
5955     if (opts::SectionData && Sec.sh_type != ELF::SHT_NOBITS) {
5956       ArrayRef<uint8_t> Data =
5957           unwrapOrError(this->FileName, Obj->getSectionContents(&Sec));
5958       W.printBinaryBlock(
5959           "SectionData",
5960           StringRef(reinterpret_cast<const char *>(Data.data()), Data.size()));
5961     }
5962   }
5963 }
5964 
5965 template <class ELFT>
5966 void LLVMStyle<ELFT>::printSymbolSection(const Elf_Sym *Symbol,
5967                                          const Elf_Sym *First) {
5968   Expected<unsigned> SectionIndex =
5969       this->dumper()->getSymbolSectionIndex(Symbol, First);
5970   if (!SectionIndex) {
5971     assert(Symbol->st_shndx == SHN_XINDEX &&
5972            "getSymbolSectionIndex should only fail due to an invalid "
5973            "SHT_SYMTAB_SHNDX table/reference");
5974     this->reportUniqueWarning(SectionIndex.takeError());
5975     W.printHex("Section", "Reserved", SHN_XINDEX);
5976     return;
5977   }
5978 
5979   Expected<StringRef> SectionName =
5980       this->dumper()->getSymbolSectionName(Symbol, *SectionIndex);
5981   if (!SectionName) {
5982     // Don't report an invalid section name if the section headers are missing.
5983     // In such situations, all sections will be "invalid".
5984     if (!this->dumper()->getElfObject()->sections().empty())
5985       this->reportUniqueWarning(SectionName.takeError());
5986     else
5987       consumeError(SectionName.takeError());
5988     W.printHex("Section", "<?>", *SectionIndex);
5989   } else {
5990     W.printHex("Section", *SectionName, *SectionIndex);
5991   }
5992 }
5993 
5994 template <class ELFT>
5995 void LLVMStyle<ELFT>::printSymbol(const ELFO *Obj, const Elf_Sym *Symbol,
5996                                   const Elf_Sym *First, StringRef StrTable,
5997                                   bool IsDynamic,
5998                                   bool /*NonVisibilityBitsUsed*/) {
5999   std::string FullSymbolName =
6000       this->dumper()->getFullSymbolName(Symbol, StrTable, IsDynamic);
6001   unsigned char SymbolType = Symbol->getType();
6002 
6003   DictScope D(W, "Symbol");
6004   W.printNumber("Name", FullSymbolName, Symbol->st_name);
6005   W.printHex("Value", Symbol->st_value);
6006   W.printNumber("Size", Symbol->st_size);
6007   W.printEnum("Binding", Symbol->getBinding(), makeArrayRef(ElfSymbolBindings));
6008   if (Obj->getHeader()->e_machine == ELF::EM_AMDGPU &&
6009       SymbolType >= ELF::STT_LOOS && SymbolType < ELF::STT_HIOS)
6010     W.printEnum("Type", SymbolType, makeArrayRef(AMDGPUSymbolTypes));
6011   else
6012     W.printEnum("Type", SymbolType, makeArrayRef(ElfSymbolTypes));
6013   if (Symbol->st_other == 0)
6014     // Usually st_other flag is zero. Do not pollute the output
6015     // by flags enumeration in that case.
6016     W.printNumber("Other", 0);
6017   else {
6018     std::vector<EnumEntry<unsigned>> SymOtherFlags(std::begin(ElfSymOtherFlags),
6019                                                    std::end(ElfSymOtherFlags));
6020     if (Obj->getHeader()->e_machine == EM_MIPS) {
6021       // Someones in their infinite wisdom decided to make STO_MIPS_MIPS16
6022       // flag overlapped with other ST_MIPS_xxx flags. So consider both
6023       // cases separately.
6024       if ((Symbol->st_other & STO_MIPS_MIPS16) == STO_MIPS_MIPS16)
6025         SymOtherFlags.insert(SymOtherFlags.end(),
6026                              std::begin(ElfMips16SymOtherFlags),
6027                              std::end(ElfMips16SymOtherFlags));
6028       else
6029         SymOtherFlags.insert(SymOtherFlags.end(),
6030                              std::begin(ElfMipsSymOtherFlags),
6031                              std::end(ElfMipsSymOtherFlags));
6032     }
6033     W.printFlags("Other", Symbol->st_other, makeArrayRef(SymOtherFlags), 0x3u);
6034   }
6035   printSymbolSection(Symbol, First);
6036 }
6037 
6038 template <class ELFT>
6039 void LLVMStyle<ELFT>::printSymbols(const ELFO *Obj, bool PrintSymbols,
6040                                    bool PrintDynamicSymbols) {
6041   if (PrintSymbols)
6042     printSymbols(Obj);
6043   if (PrintDynamicSymbols)
6044     printDynamicSymbols(Obj);
6045 }
6046 
6047 template <class ELFT> void LLVMStyle<ELFT>::printSymbols(const ELFO *Obj) {
6048   ListScope Group(W, "Symbols");
6049   this->dumper()->printSymbolsHelper(false);
6050 }
6051 
6052 template <class ELFT>
6053 void LLVMStyle<ELFT>::printDynamicSymbols(const ELFO *Obj) {
6054   ListScope Group(W, "DynamicSymbols");
6055   this->dumper()->printSymbolsHelper(true);
6056 }
6057 
6058 template <class ELFT> void LLVMStyle<ELFT>::printDynamic(const ELFFile<ELFT> *Obj) {
6059   Elf_Dyn_Range Table = this->dumper()->dynamic_table();
6060   if (Table.empty())
6061     return;
6062 
6063   W.startLine() << "DynamicSection [ (" << Table.size() << " entries)\n";
6064 
6065   size_t MaxTagSize = getMaxDynamicTagSize(Obj, Table);
6066   // The "Name/Value" column should be indented from the "Type" column by N
6067   // spaces, where N = MaxTagSize - length of "Type" (4) + trailing
6068   // space (1) = -3.
6069   W.startLine() << "  Tag" << std::string(ELFT::Is64Bits ? 16 : 8, ' ')
6070                 << "Type" << std::string(MaxTagSize - 3, ' ') << "Name/Value\n";
6071 
6072   std::string ValueFmt = "%-" + std::to_string(MaxTagSize) + "s ";
6073   for (auto Entry : Table) {
6074     uintX_t Tag = Entry.getTag();
6075     std::string Value = this->dumper()->getDynamicEntry(Tag, Entry.getVal());
6076     W.startLine() << "  " << format_hex(Tag, ELFT::Is64Bits ? 18 : 10, true)
6077                   << " "
6078                   << format(ValueFmt.c_str(),
6079                             Obj->getDynamicTagAsString(Tag).c_str())
6080                   << Value << "\n";
6081   }
6082   W.startLine() << "]\n";
6083 }
6084 
6085 template <class ELFT>
6086 void LLVMStyle<ELFT>::printDynamicRelocations(const ELFO *Obj) {
6087   const DynRegionInfo &DynRelRegion = this->dumper()->getDynRelRegion();
6088   const DynRegionInfo &DynRelaRegion = this->dumper()->getDynRelaRegion();
6089   const DynRegionInfo &DynRelrRegion = this->dumper()->getDynRelrRegion();
6090   const DynRegionInfo &DynPLTRelRegion = this->dumper()->getDynPLTRelRegion();
6091   if (DynRelRegion.Size && DynRelaRegion.Size)
6092     report_fatal_error("There are both REL and RELA dynamic relocations");
6093   W.startLine() << "Dynamic Relocations {\n";
6094   W.indent();
6095   if (DynRelaRegion.Size > 0)
6096     for (const Elf_Rela &Rela : this->dumper()->dyn_relas())
6097       printDynamicRelocation(Obj, Rela);
6098   else
6099     for (const Elf_Rel &Rel : this->dumper()->dyn_rels()) {
6100       Elf_Rela Rela;
6101       Rela.r_offset = Rel.r_offset;
6102       Rela.r_info = Rel.r_info;
6103       Rela.r_addend = 0;
6104       printDynamicRelocation(Obj, Rela);
6105     }
6106   if (DynRelrRegion.Size > 0) {
6107     Elf_Relr_Range Relrs = this->dumper()->dyn_relrs();
6108     std::vector<Elf_Rela> RelrRelas =
6109         unwrapOrError(this->FileName, Obj->decode_relrs(Relrs));
6110     for (const Elf_Rela &Rela : RelrRelas)
6111       printDynamicRelocation(Obj, Rela);
6112   }
6113   if (DynPLTRelRegion.EntSize == sizeof(Elf_Rela))
6114     for (const Elf_Rela &Rela : DynPLTRelRegion.getAsArrayRef<Elf_Rela>())
6115       printDynamicRelocation(Obj, Rela);
6116   else
6117     for (const Elf_Rel &Rel : DynPLTRelRegion.getAsArrayRef<Elf_Rel>()) {
6118       Elf_Rela Rela;
6119       Rela.r_offset = Rel.r_offset;
6120       Rela.r_info = Rel.r_info;
6121       Rela.r_addend = 0;
6122       printDynamicRelocation(Obj, Rela);
6123     }
6124   W.unindent();
6125   W.startLine() << "}\n";
6126 }
6127 
6128 template <class ELFT>
6129 void LLVMStyle<ELFT>::printDynamicRelocation(const ELFO *Obj, Elf_Rela Rel) {
6130   SmallString<32> RelocName;
6131   Obj->getRelocationTypeName(Rel.getType(Obj->isMips64EL()), RelocName);
6132   std::string SymbolName =
6133       getSymbolForReloc(Obj, this->FileName, this->dumper(), Rel).Name;
6134 
6135   if (opts::ExpandRelocs) {
6136     DictScope Group(W, "Relocation");
6137     W.printHex("Offset", Rel.r_offset);
6138     W.printNumber("Type", RelocName, (int)Rel.getType(Obj->isMips64EL()));
6139     W.printString("Symbol", !SymbolName.empty() ? SymbolName : "-");
6140     W.printHex("Addend", Rel.r_addend);
6141   } else {
6142     raw_ostream &OS = W.startLine();
6143     OS << W.hex(Rel.r_offset) << " " << RelocName << " "
6144        << (!SymbolName.empty() ? SymbolName : "-") << " " << W.hex(Rel.r_addend)
6145        << "\n";
6146   }
6147 }
6148 
6149 template <class ELFT>
6150 void LLVMStyle<ELFT>::printProgramHeaders(
6151     const ELFO *Obj, bool PrintProgramHeaders,
6152     cl::boolOrDefault PrintSectionMapping) {
6153   if (PrintProgramHeaders)
6154     printProgramHeaders(Obj);
6155   if (PrintSectionMapping == cl::BOU_TRUE)
6156     printSectionMapping(Obj);
6157 }
6158 
6159 template <class ELFT>
6160 void LLVMStyle<ELFT>::printProgramHeaders(const ELFO *Obj) {
6161   ListScope L(W, "ProgramHeaders");
6162 
6163   for (const Elf_Phdr &Phdr :
6164        unwrapOrError(this->FileName, Obj->program_headers())) {
6165     DictScope P(W, "ProgramHeader");
6166     W.printHex("Type",
6167                getElfSegmentType(Obj->getHeader()->e_machine, Phdr.p_type),
6168                Phdr.p_type);
6169     W.printHex("Offset", Phdr.p_offset);
6170     W.printHex("VirtualAddress", Phdr.p_vaddr);
6171     W.printHex("PhysicalAddress", Phdr.p_paddr);
6172     W.printNumber("FileSize", Phdr.p_filesz);
6173     W.printNumber("MemSize", Phdr.p_memsz);
6174     W.printFlags("Flags", Phdr.p_flags, makeArrayRef(ElfSegmentFlags));
6175     W.printNumber("Alignment", Phdr.p_align);
6176   }
6177 }
6178 
6179 template <class ELFT>
6180 void LLVMStyle<ELFT>::printVersionSymbolSection(const ELFFile<ELFT> *Obj,
6181                                                 const Elf_Shdr *Sec) {
6182   ListScope SS(W, "VersionSymbols");
6183   if (!Sec)
6184     return;
6185 
6186   StringRef StrTable;
6187   ArrayRef<Elf_Sym> Syms;
6188   Expected<ArrayRef<Elf_Versym>> VerTableOrErr =
6189       this->dumper()->getVersionTable(Sec, &Syms, &StrTable);
6190   if (!VerTableOrErr) {
6191     this->reportUniqueWarning(VerTableOrErr.takeError());
6192     return;
6193   }
6194 
6195   if (StrTable.empty() || Syms.empty() || Syms.size() != VerTableOrErr->size())
6196     return;
6197 
6198   for (size_t I = 0, E = Syms.size(); I < E; ++I) {
6199     DictScope S(W, "Symbol");
6200     W.printNumber("Version", (*VerTableOrErr)[I].vs_index & VERSYM_VERSION);
6201     W.printString("Name", this->dumper()->getFullSymbolName(
6202                               &Syms[I], StrTable, /*IsDynamic=*/true));
6203   }
6204 }
6205 
6206 template <class ELFT>
6207 void LLVMStyle<ELFT>::printVersionDefinitionSection(const ELFFile<ELFT> *Obj,
6208                                                     const Elf_Shdr *Sec) {
6209   ListScope SD(W, "VersionDefinitions");
6210   if (!Sec)
6211     return;
6212 
6213   Expected<std::vector<VerDef>> V = this->dumper()->getVersionDefinitions(Sec);
6214   if (!V) {
6215     this->reportUniqueWarning(V.takeError());
6216     return;
6217   }
6218 
6219   for (const VerDef &D : *V) {
6220     DictScope Def(W, "Definition");
6221     W.printNumber("Version", D.Version);
6222     W.printFlags("Flags", D.Flags, makeArrayRef(SymVersionFlags));
6223     W.printNumber("Index", D.Ndx);
6224     W.printNumber("Hash", D.Hash);
6225     W.printString("Name", D.Name.c_str());
6226     W.printList(
6227         "Predecessors", D.AuxV,
6228         [](raw_ostream &OS, const VerdAux &Aux) { OS << Aux.Name.c_str(); });
6229   }
6230 }
6231 
6232 template <class ELFT>
6233 void LLVMStyle<ELFT>::printVersionDependencySection(const ELFFile<ELFT> *Obj,
6234                                                     const Elf_Shdr *Sec) {
6235   ListScope SD(W, "VersionRequirements");
6236   if (!Sec)
6237     return;
6238 
6239   Expected<std::vector<VerNeed>> V =
6240       this->dumper()->getVersionDependencies(Sec);
6241   if (!V) {
6242     this->reportUniqueWarning(V.takeError());
6243     return;
6244   }
6245 
6246   for (const VerNeed &VN : *V) {
6247     DictScope Entry(W, "Dependency");
6248     W.printNumber("Version", VN.Version);
6249     W.printNumber("Count", VN.Cnt);
6250     W.printString("FileName", VN.File.c_str());
6251 
6252     ListScope L(W, "Entries");
6253     for (const VernAux &Aux : VN.AuxV) {
6254       DictScope Entry(W, "Entry");
6255       W.printNumber("Hash", Aux.Hash);
6256       W.printFlags("Flags", Aux.Flags, makeArrayRef(SymVersionFlags));
6257       W.printNumber("Index", Aux.Other);
6258       W.printString("Name", Aux.Name.c_str());
6259     }
6260   }
6261 }
6262 
6263 template <class ELFT>
6264 void LLVMStyle<ELFT>::printHashHistogram(const ELFFile<ELFT> *Obj) {
6265   W.startLine() << "Hash Histogram not implemented!\n";
6266 }
6267 
6268 template <class ELFT>
6269 void LLVMStyle<ELFT>::printCGProfile(const ELFFile<ELFT> *Obj) {
6270   ListScope L(W, "CGProfile");
6271   if (!this->dumper()->getDotCGProfileSec())
6272     return;
6273   auto CGProfile = unwrapOrError(
6274       this->FileName, Obj->template getSectionContentsAsArray<Elf_CGProfile>(
6275                           this->dumper()->getDotCGProfileSec()));
6276   for (const Elf_CGProfile &CGPE : CGProfile) {
6277     DictScope D(W, "CGProfileEntry");
6278     W.printNumber(
6279         "From",
6280         unwrapOrError(this->FileName,
6281                       this->dumper()->getStaticSymbolName(CGPE.cgp_from)),
6282         CGPE.cgp_from);
6283     W.printNumber(
6284         "To",
6285         unwrapOrError(this->FileName,
6286                       this->dumper()->getStaticSymbolName(CGPE.cgp_to)),
6287         CGPE.cgp_to);
6288     W.printNumber("Weight", CGPE.cgp_weight);
6289   }
6290 }
6291 
6292 static Expected<std::vector<uint64_t>> toULEB128Array(ArrayRef<uint8_t> Data) {
6293   std::vector<uint64_t> Ret;
6294   const uint8_t *Cur = Data.begin();
6295   const uint8_t *End = Data.end();
6296   while (Cur != End) {
6297     unsigned Size;
6298     const char *Err;
6299     Ret.push_back(decodeULEB128(Cur, &Size, End, &Err));
6300     if (Err)
6301       return createError(Err);
6302     Cur += Size;
6303   }
6304   return Ret;
6305 }
6306 
6307 template <class ELFT>
6308 void LLVMStyle<ELFT>::printAddrsig(const ELFFile<ELFT> *Obj) {
6309   ListScope L(W, "Addrsig");
6310   if (!this->dumper()->getDotAddrsigSec())
6311     return;
6312   ArrayRef<uint8_t> Contents = unwrapOrError(
6313       this->FileName,
6314       Obj->getSectionContents(this->dumper()->getDotAddrsigSec()));
6315   Expected<std::vector<uint64_t>> V = toULEB128Array(Contents);
6316   if (!V) {
6317     reportWarning(V.takeError(), this->FileName);
6318     return;
6319   }
6320 
6321   for (uint64_t Sym : *V) {
6322     Expected<std::string> NameOrErr = this->dumper()->getStaticSymbolName(Sym);
6323     if (NameOrErr) {
6324       W.printNumber("Sym", *NameOrErr, Sym);
6325       continue;
6326     }
6327     reportWarning(NameOrErr.takeError(), this->FileName);
6328     W.printNumber("Sym", "<?>", Sym);
6329   }
6330 }
6331 
6332 template <typename ELFT>
6333 static void printGNUNoteLLVMStyle(uint32_t NoteType, ArrayRef<uint8_t> Desc,
6334                                   ScopedPrinter &W) {
6335   switch (NoteType) {
6336   default:
6337     return;
6338   case ELF::NT_GNU_ABI_TAG: {
6339     const GNUAbiTag &AbiTag = getGNUAbiTag<ELFT>(Desc);
6340     if (!AbiTag.IsValid) {
6341       W.printString("ABI", "<corrupt GNU_ABI_TAG>");
6342     } else {
6343       W.printString("OS", AbiTag.OSName);
6344       W.printString("ABI", AbiTag.ABI);
6345     }
6346     break;
6347   }
6348   case ELF::NT_GNU_BUILD_ID: {
6349     W.printString("Build ID", getGNUBuildId(Desc));
6350     break;
6351   }
6352   case ELF::NT_GNU_GOLD_VERSION:
6353     W.printString("Version", getGNUGoldVersion(Desc));
6354     break;
6355   case ELF::NT_GNU_PROPERTY_TYPE_0:
6356     ListScope D(W, "Property");
6357     for (const auto &Property : getGNUPropertyList<ELFT>(Desc))
6358       W.printString(Property);
6359     break;
6360   }
6361 }
6362 
6363 static void printCoreNoteLLVMStyle(const CoreNote &Note, ScopedPrinter &W) {
6364   W.printNumber("Page Size", Note.PageSize);
6365   for (const CoreFileMapping &Mapping : Note.Mappings) {
6366     ListScope D(W, "Mapping");
6367     W.printHex("Start", Mapping.Start);
6368     W.printHex("End", Mapping.End);
6369     W.printHex("Offset", Mapping.Offset);
6370     W.printString("Filename", Mapping.Filename);
6371   }
6372 }
6373 
6374 template <class ELFT>
6375 void LLVMStyle<ELFT>::printNotes(const ELFFile<ELFT> *Obj) {
6376   ListScope L(W, "Notes");
6377 
6378   auto PrintHeader = [&](Optional<StringRef> SecName,
6379                          const typename ELFT::Off Offset,
6380                          const typename ELFT::Addr Size) {
6381     W.printString("Name", SecName ? *SecName : "<?>");
6382     W.printHex("Offset", Offset);
6383     W.printHex("Size", Size);
6384   };
6385 
6386   auto ProcessNote = [&](const Elf_Note &Note) {
6387     DictScope D2(W, "Note");
6388     StringRef Name = Note.getName();
6389     ArrayRef<uint8_t> Descriptor = Note.getDesc();
6390     Elf_Word Type = Note.getType();
6391 
6392     // Print the note owner/type.
6393     W.printString("Owner", Name);
6394     W.printHex("Data size", Descriptor.size());
6395     if (Name == "GNU") {
6396       W.printString("Type", getGNUNoteTypeName(Type));
6397     } else if (Name == "FreeBSD") {
6398       W.printString("Type", getFreeBSDNoteTypeName(Type));
6399     } else if (Name == "AMD") {
6400       W.printString("Type", getAMDNoteTypeName(Type));
6401     } else if (Name == "AMDGPU") {
6402       W.printString("Type", getAMDGPUNoteTypeName(Type));
6403     } else {
6404       StringRef NoteType = Obj->getHeader()->e_type == ELF::ET_CORE
6405                                ? getCoreNoteTypeName(Type)
6406                                : getGenericNoteTypeName(Type);
6407       if (!NoteType.empty())
6408         W.printString("Type", NoteType);
6409       else
6410         W.printString("Type",
6411                       "Unknown (" + to_string(format_hex(Type, 10)) + ")");
6412     }
6413 
6414     // Print the description, or fallback to printing raw bytes for unknown
6415     // owners.
6416     if (Name == "GNU") {
6417       printGNUNoteLLVMStyle<ELFT>(Type, Descriptor, W);
6418     } else if (Name == "AMD") {
6419       const AMDNote N = getAMDNote<ELFT>(Type, Descriptor);
6420       if (!N.Type.empty())
6421         W.printString(N.Type, N.Value);
6422     } else if (Name == "AMDGPU") {
6423       const AMDGPUNote N = getAMDGPUNote<ELFT>(Type, Descriptor);
6424       if (!N.Type.empty())
6425         W.printString(N.Type, N.Value);
6426     } else if (Name == "CORE") {
6427       if (Type == ELF::NT_FILE) {
6428         DataExtractor DescExtractor(Descriptor,
6429                                     ELFT::TargetEndianness == support::little,
6430                                     sizeof(Elf_Addr));
6431         Expected<CoreNote> Note = readCoreNote(DescExtractor);
6432         if (Note)
6433           printCoreNoteLLVMStyle(*Note, W);
6434         else
6435           reportWarning(Note.takeError(), this->FileName);
6436       }
6437     } else if (!Descriptor.empty()) {
6438       W.printBinaryBlock("Description data", Descriptor);
6439     }
6440   };
6441 
6442   ArrayRef<Elf_Shdr> Sections = unwrapOrError(this->FileName, Obj->sections());
6443   if (Obj->getHeader()->e_type != ELF::ET_CORE && !Sections.empty()) {
6444     for (const auto &S : Sections) {
6445       if (S.sh_type != SHT_NOTE)
6446         continue;
6447       DictScope D(W, "NoteSection");
6448       PrintHeader(expectedToOptional(Obj->getSectionName(&S)), S.sh_offset,
6449                   S.sh_size);
6450       Error Err = Error::success();
6451       for (auto Note : Obj->notes(S, Err))
6452         ProcessNote(Note);
6453       if (Err)
6454         reportError(std::move(Err), this->FileName);
6455     }
6456   } else {
6457     for (const auto &P :
6458          unwrapOrError(this->FileName, Obj->program_headers())) {
6459       if (P.p_type != PT_NOTE)
6460         continue;
6461       DictScope D(W, "NoteSection");
6462       PrintHeader(/*SecName=*/None, P.p_offset, P.p_filesz);
6463       Error Err = Error::success();
6464       for (auto Note : Obj->notes(P, Err))
6465         ProcessNote(Note);
6466       if (Err)
6467         reportError(std::move(Err), this->FileName);
6468     }
6469   }
6470 }
6471 
6472 template <class ELFT>
6473 void LLVMStyle<ELFT>::printELFLinkerOptions(const ELFFile<ELFT> *Obj) {
6474   ListScope L(W, "LinkerOptions");
6475 
6476   unsigned I = -1;
6477   for (const Elf_Shdr &Shdr : unwrapOrError(this->FileName, Obj->sections())) {
6478     ++I;
6479     if (Shdr.sh_type != ELF::SHT_LLVM_LINKER_OPTIONS)
6480       continue;
6481 
6482     ArrayRef<uint8_t> Contents =
6483         unwrapOrError(this->FileName, Obj->getSectionContents(&Shdr));
6484     if (Contents.empty())
6485       continue;
6486 
6487     if (Contents.back() != 0) {
6488       reportWarning(createError("SHT_LLVM_LINKER_OPTIONS section at index " +
6489                                 Twine(I) +
6490                                 " is broken: the "
6491                                 "content is not null-terminated"),
6492                     this->FileName);
6493       continue;
6494     }
6495 
6496     SmallVector<StringRef, 16> Strings;
6497     toStringRef(Contents.drop_back()).split(Strings, '\0');
6498     if (Strings.size() % 2 != 0) {
6499       reportWarning(
6500           createError(
6501               "SHT_LLVM_LINKER_OPTIONS section at index " + Twine(I) +
6502               " is broken: an incomplete "
6503               "key-value pair was found. The last possible key was: \"" +
6504               Strings.back() + "\""),
6505           this->FileName);
6506       continue;
6507     }
6508 
6509     for (size_t I = 0; I < Strings.size(); I += 2)
6510       W.printString(Strings[I], Strings[I + 1]);
6511   }
6512 }
6513 
6514 template <class ELFT>
6515 void LLVMStyle<ELFT>::printDependentLibs(const ELFFile<ELFT> *Obj) {
6516   ListScope L(W, "DependentLibs");
6517 
6518   auto Warn = [this](unsigned SecNdx, StringRef Msg) {
6519     this->reportUniqueWarning(
6520         createError("SHT_LLVM_DEPENDENT_LIBRARIES section at index " +
6521                     Twine(SecNdx) + " is broken: " + Msg));
6522   };
6523 
6524   unsigned I = -1;
6525   for (const Elf_Shdr &Shdr : unwrapOrError(this->FileName, Obj->sections())) {
6526     ++I;
6527     if (Shdr.sh_type != ELF::SHT_LLVM_DEPENDENT_LIBRARIES)
6528       continue;
6529 
6530     Expected<ArrayRef<uint8_t>> ContentsOrErr = Obj->getSectionContents(&Shdr);
6531     if (!ContentsOrErr) {
6532       Warn(I, toString(ContentsOrErr.takeError()));
6533       continue;
6534     }
6535 
6536     ArrayRef<uint8_t> Contents = *ContentsOrErr;
6537     if (!Contents.empty() && Contents.back() != 0) {
6538       Warn(I, "the content is not null-terminated");
6539       continue;
6540     }
6541 
6542     for (const uint8_t *I = Contents.begin(), *E = Contents.end(); I < E;) {
6543       StringRef Lib((const char *)I);
6544       W.printString(Lib);
6545       I += Lib.size() + 1;
6546     }
6547   }
6548 }
6549 
6550 template <class ELFT>
6551 void LLVMStyle<ELFT>::printStackSizes(const ELFObjectFile<ELFT> *Obj) {
6552   ListScope L(W, "StackSizes");
6553   if (Obj->isRelocatableObject())
6554     this->printRelocatableStackSizes(Obj, []() {});
6555   else
6556     this->printNonRelocatableStackSizes(Obj, []() {});
6557 }
6558 
6559 template <class ELFT>
6560 void LLVMStyle<ELFT>::printStackSizeEntry(uint64_t Size, StringRef FuncName) {
6561   DictScope D(W, "Entry");
6562   W.printString("Function", FuncName);
6563   W.printHex("Size", Size);
6564 }
6565 
6566 template <class ELFT>
6567 void LLVMStyle<ELFT>::printMipsGOT(const MipsGOTParser<ELFT> &Parser) {
6568   auto PrintEntry = [&](const Elf_Addr *E) {
6569     W.printHex("Address", Parser.getGotAddress(E));
6570     W.printNumber("Access", Parser.getGotOffset(E));
6571     W.printHex("Initial", *E);
6572   };
6573 
6574   DictScope GS(W, Parser.IsStatic ? "Static GOT" : "Primary GOT");
6575 
6576   W.printHex("Canonical gp value", Parser.getGp());
6577   {
6578     ListScope RS(W, "Reserved entries");
6579     {
6580       DictScope D(W, "Entry");
6581       PrintEntry(Parser.getGotLazyResolver());
6582       W.printString("Purpose", StringRef("Lazy resolver"));
6583     }
6584 
6585     if (Parser.getGotModulePointer()) {
6586       DictScope D(W, "Entry");
6587       PrintEntry(Parser.getGotModulePointer());
6588       W.printString("Purpose", StringRef("Module pointer (GNU extension)"));
6589     }
6590   }
6591   {
6592     ListScope LS(W, "Local entries");
6593     for (auto &E : Parser.getLocalEntries()) {
6594       DictScope D(W, "Entry");
6595       PrintEntry(&E);
6596     }
6597   }
6598 
6599   if (Parser.IsStatic)
6600     return;
6601 
6602   {
6603     ListScope GS(W, "Global entries");
6604     for (auto &E : Parser.getGlobalEntries()) {
6605       DictScope D(W, "Entry");
6606 
6607       PrintEntry(&E);
6608 
6609       const Elf_Sym *Sym = Parser.getGotSym(&E);
6610       W.printHex("Value", Sym->st_value);
6611       W.printEnum("Type", Sym->getType(), makeArrayRef(ElfSymbolTypes));
6612       printSymbolSection(Sym, this->dumper()->dynamic_symbols().begin());
6613 
6614       std::string SymName = this->dumper()->getFullSymbolName(
6615           Sym, this->dumper()->getDynamicStringTable(), true);
6616       W.printNumber("Name", SymName, Sym->st_name);
6617     }
6618   }
6619 
6620   W.printNumber("Number of TLS and multi-GOT entries",
6621                 uint64_t(Parser.getOtherEntries().size()));
6622 }
6623 
6624 template <class ELFT>
6625 void LLVMStyle<ELFT>::printMipsPLT(const MipsGOTParser<ELFT> &Parser) {
6626   auto PrintEntry = [&](const Elf_Addr *E) {
6627     W.printHex("Address", Parser.getPltAddress(E));
6628     W.printHex("Initial", *E);
6629   };
6630 
6631   DictScope GS(W, "PLT GOT");
6632 
6633   {
6634     ListScope RS(W, "Reserved entries");
6635     {
6636       DictScope D(W, "Entry");
6637       PrintEntry(Parser.getPltLazyResolver());
6638       W.printString("Purpose", StringRef("PLT lazy resolver"));
6639     }
6640 
6641     if (auto E = Parser.getPltModulePointer()) {
6642       DictScope D(W, "Entry");
6643       PrintEntry(E);
6644       W.printString("Purpose", StringRef("Module pointer"));
6645     }
6646   }
6647   {
6648     ListScope LS(W, "Entries");
6649     for (auto &E : Parser.getPltEntries()) {
6650       DictScope D(W, "Entry");
6651       PrintEntry(&E);
6652 
6653       const Elf_Sym *Sym = Parser.getPltSym(&E);
6654       W.printHex("Value", Sym->st_value);
6655       W.printEnum("Type", Sym->getType(), makeArrayRef(ElfSymbolTypes));
6656       printSymbolSection(Sym, this->dumper()->dynamic_symbols().begin());
6657 
6658       std::string SymName =
6659           this->dumper()->getFullSymbolName(Sym, Parser.getPltStrTable(), true);
6660       W.printNumber("Name", SymName, Sym->st_name);
6661     }
6662   }
6663 }
6664 
6665 template <class ELFT>
6666 void LLVMStyle<ELFT>::printMipsABIFlags(const ELFObjectFile<ELFT> *ObjF) {
6667   const ELFFile<ELFT> *Obj = ObjF->getELFFile();
6668   const Elf_Shdr *Shdr =
6669       findSectionByName(*Obj, ObjF->getFileName(), ".MIPS.abiflags");
6670   if (!Shdr) {
6671     W.startLine() << "There is no .MIPS.abiflags section in the file.\n";
6672     return;
6673   }
6674   ArrayRef<uint8_t> Sec =
6675       unwrapOrError(ObjF->getFileName(), Obj->getSectionContents(Shdr));
6676   if (Sec.size() != sizeof(Elf_Mips_ABIFlags<ELFT>)) {
6677     W.startLine() << "The .MIPS.abiflags section has a wrong size.\n";
6678     return;
6679   }
6680 
6681   auto *Flags = reinterpret_cast<const Elf_Mips_ABIFlags<ELFT> *>(Sec.data());
6682 
6683   raw_ostream &OS = W.getOStream();
6684   DictScope GS(W, "MIPS ABI Flags");
6685 
6686   W.printNumber("Version", Flags->version);
6687   W.startLine() << "ISA: ";
6688   if (Flags->isa_rev <= 1)
6689     OS << format("MIPS%u", Flags->isa_level);
6690   else
6691     OS << format("MIPS%ur%u", Flags->isa_level, Flags->isa_rev);
6692   OS << "\n";
6693   W.printEnum("ISA Extension", Flags->isa_ext, makeArrayRef(ElfMipsISAExtType));
6694   W.printFlags("ASEs", Flags->ases, makeArrayRef(ElfMipsASEFlags));
6695   W.printEnum("FP ABI", Flags->fp_abi, makeArrayRef(ElfMipsFpABIType));
6696   W.printNumber("GPR size", getMipsRegisterSize(Flags->gpr_size));
6697   W.printNumber("CPR1 size", getMipsRegisterSize(Flags->cpr1_size));
6698   W.printNumber("CPR2 size", getMipsRegisterSize(Flags->cpr2_size));
6699   W.printFlags("Flags 1", Flags->flags1, makeArrayRef(ElfMipsFlags1));
6700   W.printHex("Flags 2", Flags->flags2);
6701 }
6702