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