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