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