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