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