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