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