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