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