10b57cec5SDimitry Andric //===- ELFDumper.cpp - ELF-specific dumper --------------------------------===//
20b57cec5SDimitry Andric //
30b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
40b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
50b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
60b57cec5SDimitry Andric //
70b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
80b57cec5SDimitry Andric ///
90b57cec5SDimitry Andric /// \file
100b57cec5SDimitry Andric /// This file implements the ELF-specific dumper for llvm-readobj.
110b57cec5SDimitry Andric ///
120b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
130b57cec5SDimitry Andric 
140b57cec5SDimitry Andric #include "ARMEHABIPrinter.h"
150b57cec5SDimitry Andric #include "DwarfCFIEHPrinter.h"
160b57cec5SDimitry Andric #include "ObjDumper.h"
170b57cec5SDimitry Andric #include "StackMapPrinter.h"
180b57cec5SDimitry Andric #include "llvm-readobj.h"
190b57cec5SDimitry Andric #include "llvm/ADT/ArrayRef.h"
2004eeddc0SDimitry Andric #include "llvm/ADT/BitVector.h"
210b57cec5SDimitry Andric #include "llvm/ADT/DenseMap.h"
220b57cec5SDimitry Andric #include "llvm/ADT/DenseSet.h"
238bcb0991SDimitry Andric #include "llvm/ADT/MapVector.h"
240b57cec5SDimitry Andric #include "llvm/ADT/STLExtras.h"
250b57cec5SDimitry Andric #include "llvm/ADT/SmallString.h"
260b57cec5SDimitry Andric #include "llvm/ADT/SmallVector.h"
270b57cec5SDimitry Andric #include "llvm/ADT/StringExtras.h"
280b57cec5SDimitry Andric #include "llvm/ADT/StringRef.h"
290b57cec5SDimitry Andric #include "llvm/ADT/Twine.h"
300b57cec5SDimitry Andric #include "llvm/BinaryFormat/AMDGPUMetadataVerifier.h"
310b57cec5SDimitry Andric #include "llvm/BinaryFormat/ELF.h"
3204eeddc0SDimitry Andric #include "llvm/BinaryFormat/MsgPackDocument.h"
330b57cec5SDimitry Andric #include "llvm/Demangle/Demangle.h"
340eae32dcSDimitry Andric #include "llvm/Object/Archive.h"
350b57cec5SDimitry Andric #include "llvm/Object/ELF.h"
360b57cec5SDimitry Andric #include "llvm/Object/ELFObjectFile.h"
370b57cec5SDimitry Andric #include "llvm/Object/ELFTypes.h"
380b57cec5SDimitry Andric #include "llvm/Object/Error.h"
390b57cec5SDimitry Andric #include "llvm/Object/ObjectFile.h"
408bcb0991SDimitry Andric #include "llvm/Object/RelocationResolver.h"
410b57cec5SDimitry Andric #include "llvm/Object/StackMapParser.h"
420b57cec5SDimitry Andric #include "llvm/Support/AMDGPUMetadata.h"
430b57cec5SDimitry Andric #include "llvm/Support/ARMAttributeParser.h"
440b57cec5SDimitry Andric #include "llvm/Support/ARMBuildAttributes.h"
450b57cec5SDimitry Andric #include "llvm/Support/Casting.h"
460b57cec5SDimitry Andric #include "llvm/Support/Compiler.h"
470b57cec5SDimitry Andric #include "llvm/Support/Endian.h"
480b57cec5SDimitry Andric #include "llvm/Support/ErrorHandling.h"
490b57cec5SDimitry Andric #include "llvm/Support/Format.h"
500b57cec5SDimitry Andric #include "llvm/Support/FormatVariadic.h"
510b57cec5SDimitry Andric #include "llvm/Support/FormattedStream.h"
520b57cec5SDimitry Andric #include "llvm/Support/LEB128.h"
53349cc55cSDimitry Andric #include "llvm/Support/MSP430AttributeParser.h"
54349cc55cSDimitry Andric #include "llvm/Support/MSP430Attributes.h"
550b57cec5SDimitry Andric #include "llvm/Support/MathExtras.h"
560b57cec5SDimitry Andric #include "llvm/Support/MipsABIFlags.h"
575ffd83dbSDimitry Andric #include "llvm/Support/RISCVAttributeParser.h"
585ffd83dbSDimitry Andric #include "llvm/Support/RISCVAttributes.h"
590b57cec5SDimitry Andric #include "llvm/Support/ScopedPrinter.h"
605f757f3fSDimitry Andric #include "llvm/Support/SystemZ/zOSSupport.h"
610b57cec5SDimitry Andric #include "llvm/Support/raw_ostream.h"
620b57cec5SDimitry Andric #include <algorithm>
630b57cec5SDimitry Andric #include <cinttypes>
640b57cec5SDimitry Andric #include <cstddef>
650b57cec5SDimitry Andric #include <cstdint>
660b57cec5SDimitry Andric #include <cstdlib>
670b57cec5SDimitry Andric #include <iterator>
680b57cec5SDimitry Andric #include <memory>
69bdd1243dSDimitry Andric #include <optional>
700b57cec5SDimitry Andric #include <string>
710b57cec5SDimitry Andric #include <system_error>
720b57cec5SDimitry Andric #include <vector>
730b57cec5SDimitry Andric 
740b57cec5SDimitry Andric using namespace llvm;
750b57cec5SDimitry Andric using namespace llvm::object;
760b57cec5SDimitry Andric using namespace ELF;
770b57cec5SDimitry Andric 
780b57cec5SDimitry Andric #define LLVM_READOBJ_ENUM_CASE(ns, enum)                                       \
790b57cec5SDimitry Andric   case ns::enum:                                                               \
800b57cec5SDimitry Andric     return #enum;
810b57cec5SDimitry Andric 
820b57cec5SDimitry Andric #define ENUM_ENT(enum, altName)                                                \
830b57cec5SDimitry Andric   { #enum, altName, ELF::enum }
840b57cec5SDimitry Andric 
850b57cec5SDimitry Andric #define ENUM_ENT_1(enum)                                                       \
860b57cec5SDimitry Andric   { #enum, #enum, ELF::enum }
870b57cec5SDimitry Andric 
880b57cec5SDimitry Andric namespace {
890b57cec5SDimitry Andric 
90e8d8bef9SDimitry Andric template <class ELFT> struct RelSymbol {
RelSymbol__anonf567d4440111::RelSymbol91e8d8bef9SDimitry Andric   RelSymbol(const typename ELFT::Sym *S, StringRef N)
92e8d8bef9SDimitry Andric       : Sym(S), Name(N.str()) {}
93e8d8bef9SDimitry Andric   const typename ELFT::Sym *Sym;
94e8d8bef9SDimitry Andric   std::string Name;
95e8d8bef9SDimitry Andric };
960b57cec5SDimitry Andric 
970b57cec5SDimitry Andric /// Represents a contiguous uniform range in the file. We cannot just create a
980b57cec5SDimitry Andric /// range directly because when creating one of these from the .dynamic table
990b57cec5SDimitry Andric /// the size, entity size and virtual address are different entries in arbitrary
1000b57cec5SDimitry Andric /// order (DT_REL, DT_RELSZ, DT_RELENT for example).
1010b57cec5SDimitry Andric struct DynRegionInfo {
DynRegionInfo__anonf567d4440111::DynRegionInfo102e8d8bef9SDimitry Andric   DynRegionInfo(const Binary &Owner, const ObjDumper &D)
103e8d8bef9SDimitry Andric       : Obj(&Owner), Dumper(&D) {}
DynRegionInfo__anonf567d4440111::DynRegionInfo104e8d8bef9SDimitry Andric   DynRegionInfo(const Binary &Owner, const ObjDumper &D, const uint8_t *A,
105e8d8bef9SDimitry Andric                 uint64_t S, uint64_t ES)
106e8d8bef9SDimitry Andric       : Addr(A), Size(S), EntSize(ES), Obj(&Owner), Dumper(&D) {}
1070b57cec5SDimitry Andric 
1080b57cec5SDimitry Andric   /// Address in current address space.
109e8d8bef9SDimitry Andric   const uint8_t *Addr = nullptr;
1100b57cec5SDimitry Andric   /// Size in bytes of the region.
1110b57cec5SDimitry Andric   uint64_t Size = 0;
1120b57cec5SDimitry Andric   /// Size of each entity in the region.
1130b57cec5SDimitry Andric   uint64_t EntSize = 0;
1140b57cec5SDimitry Andric 
115e8d8bef9SDimitry Andric   /// Owner object. Used for error reporting.
116e8d8bef9SDimitry Andric   const Binary *Obj;
117e8d8bef9SDimitry Andric   /// Dumper used for error reporting.
118e8d8bef9SDimitry Andric   const ObjDumper *Dumper;
1195ffd83dbSDimitry Andric   /// Error prefix. Used for error reporting to provide more information.
1205ffd83dbSDimitry Andric   std::string Context;
1215ffd83dbSDimitry Andric   /// Region size name. Used for error reporting.
1225ffd83dbSDimitry Andric   StringRef SizePrintName = "size";
1235ffd83dbSDimitry Andric   /// Entry size name. Used for error reporting. If this field is empty, errors
1245ffd83dbSDimitry Andric   /// will not mention the entry size.
1255ffd83dbSDimitry Andric   StringRef EntSizePrintName = "entry size";
1268bcb0991SDimitry Andric 
getAsArrayRef__anonf567d4440111::DynRegionInfo1270b57cec5SDimitry Andric   template <typename Type> ArrayRef<Type> getAsArrayRef() const {
1280b57cec5SDimitry Andric     const Type *Start = reinterpret_cast<const Type *>(Addr);
1290b57cec5SDimitry Andric     if (!Start)
1300b57cec5SDimitry Andric       return {Start, Start};
131e8d8bef9SDimitry Andric 
132e8d8bef9SDimitry Andric     const uint64_t Offset =
133e8d8bef9SDimitry Andric         Addr - (const uint8_t *)Obj->getMemoryBufferRef().getBufferStart();
134e8d8bef9SDimitry Andric     const uint64_t ObjSize = Obj->getMemoryBufferRef().getBufferSize();
135e8d8bef9SDimitry Andric 
136e8d8bef9SDimitry Andric     if (Size > ObjSize - Offset) {
137e8d8bef9SDimitry Andric       Dumper->reportUniqueWarning(
138e8d8bef9SDimitry Andric           "unable to read data at 0x" + Twine::utohexstr(Offset) +
139e8d8bef9SDimitry Andric           " of size 0x" + Twine::utohexstr(Size) + " (" + SizePrintName +
140e8d8bef9SDimitry Andric           "): it goes past the end of the file of size 0x" +
141e8d8bef9SDimitry Andric           Twine::utohexstr(ObjSize));
142e8d8bef9SDimitry Andric       return {Start, Start};
143e8d8bef9SDimitry Andric     }
144e8d8bef9SDimitry Andric 
1455ffd83dbSDimitry Andric     if (EntSize == sizeof(Type) && (Size % EntSize == 0))
1460b57cec5SDimitry Andric       return {Start, Start + (Size / EntSize)};
1475ffd83dbSDimitry Andric 
1485ffd83dbSDimitry Andric     std::string Msg;
1495ffd83dbSDimitry Andric     if (!Context.empty())
1505ffd83dbSDimitry Andric       Msg += Context + " has ";
1515ffd83dbSDimitry Andric 
1525ffd83dbSDimitry Andric     Msg += ("invalid " + SizePrintName + " (0x" + Twine::utohexstr(Size) + ")")
1535ffd83dbSDimitry Andric                .str();
1545ffd83dbSDimitry Andric     if (!EntSizePrintName.empty())
1555ffd83dbSDimitry Andric       Msg +=
1565ffd83dbSDimitry Andric           (" or " + EntSizePrintName + " (0x" + Twine::utohexstr(EntSize) + ")")
1575ffd83dbSDimitry Andric               .str();
1585ffd83dbSDimitry Andric 
159e8d8bef9SDimitry Andric     Dumper->reportUniqueWarning(Msg);
1605ffd83dbSDimitry Andric     return {Start, Start};
1610b57cec5SDimitry Andric   }
1620b57cec5SDimitry Andric };
1630b57cec5SDimitry Andric 
164e8d8bef9SDimitry Andric struct GroupMember {
165e8d8bef9SDimitry Andric   StringRef Name;
166e8d8bef9SDimitry Andric   uint64_t Index;
167e8d8bef9SDimitry Andric };
168e8d8bef9SDimitry Andric 
169e8d8bef9SDimitry Andric struct GroupSection {
170e8d8bef9SDimitry Andric   StringRef Name;
171e8d8bef9SDimitry Andric   std::string Signature;
172e8d8bef9SDimitry Andric   uint64_t ShName;
173e8d8bef9SDimitry Andric   uint64_t Index;
174e8d8bef9SDimitry Andric   uint32_t Link;
175e8d8bef9SDimitry Andric   uint32_t Info;
176e8d8bef9SDimitry Andric   uint32_t Type;
177e8d8bef9SDimitry Andric   std::vector<GroupMember> Members;
178e8d8bef9SDimitry Andric };
179e8d8bef9SDimitry Andric 
180480093f4SDimitry Andric namespace {
181480093f4SDimitry Andric 
182e8d8bef9SDimitry Andric struct NoteType {
183e8d8bef9SDimitry Andric   uint32_t ID;
184e8d8bef9SDimitry Andric   StringRef Name;
185480093f4SDimitry Andric };
186480093f4SDimitry Andric 
187480093f4SDimitry Andric } // namespace
188480093f4SDimitry Andric 
189e8d8bef9SDimitry Andric template <class ELFT> class Relocation {
1900b57cec5SDimitry Andric public:
Relocation(const typename ELFT::Rel & R,bool IsMips64EL)191e8d8bef9SDimitry Andric   Relocation(const typename ELFT::Rel &R, bool IsMips64EL)
192e8d8bef9SDimitry Andric       : Type(R.getType(IsMips64EL)), Symbol(R.getSymbol(IsMips64EL)),
193e8d8bef9SDimitry Andric         Offset(R.r_offset), Info(R.r_info) {}
1940b57cec5SDimitry Andric 
Relocation(const typename ELFT::Rela & R,bool IsMips64EL)195e8d8bef9SDimitry Andric   Relocation(const typename ELFT::Rela &R, bool IsMips64EL)
196e8d8bef9SDimitry Andric       : Relocation((const typename ELFT::Rel &)R, IsMips64EL) {
197e8d8bef9SDimitry Andric     Addend = R.r_addend;
198e8d8bef9SDimitry Andric   }
199e8d8bef9SDimitry Andric 
200e8d8bef9SDimitry Andric   uint32_t Type;
201e8d8bef9SDimitry Andric   uint32_t Symbol;
202e8d8bef9SDimitry Andric   typename ELFT::uint Offset;
203e8d8bef9SDimitry Andric   typename ELFT::uint Info;
204bdd1243dSDimitry Andric   std::optional<int64_t> Addend;
205e8d8bef9SDimitry Andric };
206e8d8bef9SDimitry Andric 
207e8d8bef9SDimitry Andric template <class ELFT> class MipsGOTParser;
208e8d8bef9SDimitry Andric 
209e8d8bef9SDimitry Andric template <typename ELFT> class ELFDumper : public ObjDumper {
210e8d8bef9SDimitry Andric   LLVM_ELF_IMPORT_TYPES_ELFT(ELFT)
211e8d8bef9SDimitry Andric 
212e8d8bef9SDimitry Andric public:
213e8d8bef9SDimitry Andric   ELFDumper(const object::ELFObjectFile<ELFT> &ObjF, ScopedPrinter &Writer);
214e8d8bef9SDimitry Andric 
2150b57cec5SDimitry Andric   void printUnwindInfo() override;
2160b57cec5SDimitry Andric   void printNeededLibraries() override;
2170b57cec5SDimitry Andric   void printHashTable() override;
218e8d8bef9SDimitry Andric   void printGnuHashTable() override;
2190b57cec5SDimitry Andric   void printLoadName() override;
2200b57cec5SDimitry Andric   void printVersionInfo() override;
2218bcb0991SDimitry Andric   void printArchSpecificInfo() override;
2220b57cec5SDimitry Andric   void printStackMap() const override;
22306c3fb27SDimitry Andric   void printMemtag() override;
22406c3fb27SDimitry Andric   ArrayRef<uint8_t> getMemtagGlobalsSectionContents(uint64_t ExpectedAddr);
22506c3fb27SDimitry Andric 
22606c3fb27SDimitry Andric   // Hash histogram shows statistics of how efficient the hash was for the
22706c3fb27SDimitry Andric   // dynamic symbol table. The table shows the number of hash buckets for
22806c3fb27SDimitry Andric   // different lengths of chains as an absolute number and percentage of the
22906c3fb27SDimitry Andric   // total buckets, and the cumulative coverage of symbols for each set of
23006c3fb27SDimitry Andric   // buckets.
23106c3fb27SDimitry Andric   void printHashHistograms() override;
2320b57cec5SDimitry Andric 
getElfObject() const233e8d8bef9SDimitry Andric   const object::ELFObjectFile<ELFT> &getElfObject() const { return ObjF; };
2340b57cec5SDimitry Andric 
235e8d8bef9SDimitry Andric   std::string describe(const Elf_Shdr &Sec) const;
2360b57cec5SDimitry Andric 
getHashTableEntSize() const237e8d8bef9SDimitry Andric   unsigned getHashTableEntSize() const {
238e8d8bef9SDimitry Andric     // EM_S390 and ELF::EM_ALPHA platforms use 8-bytes entries in SHT_HASH
239e8d8bef9SDimitry Andric     // sections. This violates the ELF specification.
240e8d8bef9SDimitry Andric     if (Obj.getHeader().e_machine == ELF::EM_S390 ||
241e8d8bef9SDimitry Andric         Obj.getHeader().e_machine == ELF::EM_ALPHA)
242e8d8bef9SDimitry Andric       return 8;
243e8d8bef9SDimitry Andric     return 4;
2440b57cec5SDimitry Andric   }
2450b57cec5SDimitry Andric 
24606c3fb27SDimitry Andric   std::vector<EnumEntry<unsigned>>
24706c3fb27SDimitry Andric   getOtherFlagsFromSymbol(const Elf_Ehdr &Header, const Elf_Sym &Symbol) const;
24806c3fb27SDimitry Andric 
dynamic_table() const2490b57cec5SDimitry Andric   Elf_Dyn_Range dynamic_table() const {
2500b57cec5SDimitry Andric     // A valid .dynamic section contains an array of entries terminated
2510b57cec5SDimitry Andric     // with a DT_NULL entry. However, sometimes the section content may
2520b57cec5SDimitry Andric     // continue past the DT_NULL entry, so to dump the section correctly,
2530b57cec5SDimitry Andric     // we first find the end of the entries by iterating over them.
254e8d8bef9SDimitry Andric     Elf_Dyn_Range Table = DynamicTable.template getAsArrayRef<Elf_Dyn>();
2550b57cec5SDimitry Andric 
2560b57cec5SDimitry Andric     size_t Size = 0;
2570b57cec5SDimitry Andric     while (Size < Table.size())
2580b57cec5SDimitry Andric       if (Table[Size++].getTag() == DT_NULL)
2590b57cec5SDimitry Andric         break;
2600b57cec5SDimitry Andric 
2610b57cec5SDimitry Andric     return Table.slice(0, Size);
2620b57cec5SDimitry Andric   }
2630b57cec5SDimitry Andric 
dynamic_symbols() const2640b57cec5SDimitry Andric   Elf_Sym_Range dynamic_symbols() const {
2655ffd83dbSDimitry Andric     if (!DynSymRegion)
2665ffd83dbSDimitry Andric       return Elf_Sym_Range();
267e8d8bef9SDimitry Andric     return DynSymRegion->template getAsArrayRef<Elf_Sym>();
2680b57cec5SDimitry Andric   }
2690b57cec5SDimitry Andric 
270e8d8bef9SDimitry Andric   const Elf_Shdr *findSectionByName(StringRef Name) const;
271e8d8bef9SDimitry Andric 
getDynamicStringTable() const272e8d8bef9SDimitry Andric   StringRef getDynamicStringTable() const { return DynamicStringTable; }
273e8d8bef9SDimitry Andric 
274e8d8bef9SDimitry Andric protected:
275e8d8bef9SDimitry Andric   virtual void printVersionSymbolSection(const Elf_Shdr *Sec) = 0;
276e8d8bef9SDimitry Andric   virtual void printVersionDefinitionSection(const Elf_Shdr *Sec) = 0;
277e8d8bef9SDimitry Andric   virtual void printVersionDependencySection(const Elf_Shdr *Sec) = 0;
278e8d8bef9SDimitry Andric 
279e8d8bef9SDimitry Andric   void
280e8d8bef9SDimitry Andric   printDependentLibsHelper(function_ref<void(const Elf_Shdr &)> OnSectionStart,
281e8d8bef9SDimitry Andric                            function_ref<void(StringRef, uint64_t)> OnLibEntry);
282e8d8bef9SDimitry Andric 
283e8d8bef9SDimitry Andric   virtual void printRelRelaReloc(const Relocation<ELFT> &R,
284e8d8bef9SDimitry Andric                                  const RelSymbol<ELFT> &RelSym) = 0;
285e8d8bef9SDimitry Andric   virtual void printRelrReloc(const Elf_Relr &R) = 0;
printDynamicRelocHeader(unsigned Type,StringRef Name,const DynRegionInfo & Reg)286e8d8bef9SDimitry Andric   virtual void printDynamicRelocHeader(unsigned Type, StringRef Name,
287e8d8bef9SDimitry Andric                                        const DynRegionInfo &Reg) {}
288e8d8bef9SDimitry Andric   void printReloc(const Relocation<ELFT> &R, unsigned RelIndex,
289e8d8bef9SDimitry Andric                   const Elf_Shdr &Sec, const Elf_Shdr *SymTab);
290e8d8bef9SDimitry Andric   void printDynamicReloc(const Relocation<ELFT> &R);
291e8d8bef9SDimitry Andric   void printDynamicRelocationsHelper();
292e8d8bef9SDimitry Andric   void printRelocationsHelper(const Elf_Shdr &Sec);
293e8d8bef9SDimitry Andric   void forEachRelocationDo(
294e8d8bef9SDimitry Andric       const Elf_Shdr &Sec, bool RawRelr,
295e8d8bef9SDimitry Andric       llvm::function_ref<void(const Relocation<ELFT> &, unsigned,
296e8d8bef9SDimitry Andric                               const Elf_Shdr &, const Elf_Shdr *)>
297e8d8bef9SDimitry Andric           RelRelaFn,
298e8d8bef9SDimitry Andric       llvm::function_ref<void(const Elf_Relr &)> RelrFn);
299e8d8bef9SDimitry Andric 
printSymtabMessage(const Elf_Shdr * Symtab,size_t Offset,bool NonVisibilityBitsUsed,bool ExtraSymInfo) const300e8d8bef9SDimitry Andric   virtual void printSymtabMessage(const Elf_Shdr *Symtab, size_t Offset,
3015f757f3fSDimitry Andric                                   bool NonVisibilityBitsUsed,
3025f757f3fSDimitry Andric                                   bool ExtraSymInfo) const {};
303e8d8bef9SDimitry Andric   virtual void printSymbol(const Elf_Sym &Symbol, unsigned SymIndex,
304e8d8bef9SDimitry Andric                            DataRegion<Elf_Word> ShndxTable,
305bdd1243dSDimitry Andric                            std::optional<StringRef> StrTable, bool IsDynamic,
3065f757f3fSDimitry Andric                            bool NonVisibilityBitsUsed,
3075f757f3fSDimitry Andric                            bool ExtraSymInfo) const = 0;
308e8d8bef9SDimitry Andric 
309e8d8bef9SDimitry Andric   virtual void printMipsABIFlags() = 0;
310e8d8bef9SDimitry Andric   virtual void printMipsGOT(const MipsGOTParser<ELFT> &Parser) = 0;
311e8d8bef9SDimitry Andric   virtual void printMipsPLT(const MipsGOTParser<ELFT> &Parser) = 0;
312e8d8bef9SDimitry Andric 
31306c3fb27SDimitry Andric   virtual void printMemtag(
31406c3fb27SDimitry Andric       const ArrayRef<std::pair<std::string, std::string>> DynamicEntries,
31506c3fb27SDimitry Andric       const ArrayRef<uint8_t> AndroidNoteDesc,
31606c3fb27SDimitry Andric       const ArrayRef<std::pair<uint64_t, uint64_t>> Descriptors) = 0;
31706c3fb27SDimitry Andric 
31806c3fb27SDimitry Andric   virtual void printHashHistogram(const Elf_Hash &HashTable) const;
31906c3fb27SDimitry Andric   virtual void printGnuHashHistogram(const Elf_GnuHash &GnuHashTable) const;
32006c3fb27SDimitry Andric   virtual void printHashHistogramStats(size_t NBucket, size_t MaxChain,
32106c3fb27SDimitry Andric                                        size_t TotalSyms, ArrayRef<size_t> Count,
32206c3fb27SDimitry Andric                                        bool IsGnu) const = 0;
32306c3fb27SDimitry Andric 
324e8d8bef9SDimitry Andric   Expected<ArrayRef<Elf_Versym>>
325e8d8bef9SDimitry Andric   getVersionTable(const Elf_Shdr &Sec, ArrayRef<Elf_Sym> *SymTab,
326e8d8bef9SDimitry Andric                   StringRef *StrTab, const Elf_Shdr **SymTabSec) const;
327e8d8bef9SDimitry Andric   StringRef getPrintableSectionName(const Elf_Shdr &Sec) const;
328e8d8bef9SDimitry Andric 
329e8d8bef9SDimitry Andric   std::vector<GroupSection> getGroups();
330e8d8bef9SDimitry Andric 
331fe6060f1SDimitry Andric   // Returns the function symbol index for the given address. Matches the
332fe6060f1SDimitry Andric   // symbol's section with FunctionSec when specified.
333bdd1243dSDimitry Andric   // Returns std::nullopt if no function symbol can be found for the address or
334bdd1243dSDimitry Andric   // in case it is not defined in the specified section.
335bdd1243dSDimitry Andric   SmallVector<uint32_t> getSymbolIndexesForFunctionAddress(
336bdd1243dSDimitry Andric       uint64_t SymValue, std::optional<const Elf_Shdr *> FunctionSec);
337e8d8bef9SDimitry Andric   bool printFunctionStackSize(uint64_t SymValue,
338bdd1243dSDimitry Andric                               std::optional<const Elf_Shdr *> FunctionSec,
339e8d8bef9SDimitry Andric                               const Elf_Shdr &StackSizeSec, DataExtractor Data,
340e8d8bef9SDimitry Andric                               uint64_t *Offset);
341e8d8bef9SDimitry Andric   void printStackSize(const Relocation<ELFT> &R, const Elf_Shdr &RelocSec,
342e8d8bef9SDimitry Andric                       unsigned Ndx, const Elf_Shdr *SymTab,
343e8d8bef9SDimitry Andric                       const Elf_Shdr *FunctionSec, const Elf_Shdr &StackSizeSec,
344e8d8bef9SDimitry Andric                       const RelocationResolver &Resolver, DataExtractor Data);
345fe6060f1SDimitry Andric   virtual void printStackSizeEntry(uint64_t Size,
346fe6060f1SDimitry Andric                                    ArrayRef<std::string> FuncNames) = 0;
347e8d8bef9SDimitry Andric 
348e8d8bef9SDimitry Andric   void printRelocatableStackSizes(std::function<void()> PrintHeader);
349e8d8bef9SDimitry Andric   void printNonRelocatableStackSizes(std::function<void()> PrintHeader);
350e8d8bef9SDimitry Andric 
351e8d8bef9SDimitry Andric   const object::ELFObjectFile<ELFT> &ObjF;
352e8d8bef9SDimitry Andric   const ELFFile<ELFT> &Obj;
353e8d8bef9SDimitry Andric   StringRef FileName;
354e8d8bef9SDimitry Andric 
createDRI(uint64_t Offset,uint64_t Size,uint64_t EntSize)355e8d8bef9SDimitry Andric   Expected<DynRegionInfo> createDRI(uint64_t Offset, uint64_t Size,
356e8d8bef9SDimitry Andric                                     uint64_t EntSize) {
357e8d8bef9SDimitry Andric     if (Offset + Size < Offset || Offset + Size > Obj.getBufSize())
358e8d8bef9SDimitry Andric       return createError("offset (0x" + Twine::utohexstr(Offset) +
359e8d8bef9SDimitry Andric                          ") + size (0x" + Twine::utohexstr(Size) +
360e8d8bef9SDimitry Andric                          ") is greater than the file size (0x" +
361e8d8bef9SDimitry Andric                          Twine::utohexstr(Obj.getBufSize()) + ")");
362e8d8bef9SDimitry Andric     return DynRegionInfo(ObjF, *this, Obj.base() + Offset, Size, EntSize);
363e8d8bef9SDimitry Andric   }
364e8d8bef9SDimitry Andric 
365349cc55cSDimitry Andric   void printAttributes(unsigned, std::unique_ptr<ELFAttributeParser>,
3665f757f3fSDimitry Andric                        llvm::endianness);
367e8d8bef9SDimitry Andric   void printMipsReginfo();
368e8d8bef9SDimitry Andric   void printMipsOptions();
369e8d8bef9SDimitry Andric 
370e8d8bef9SDimitry Andric   std::pair<const Elf_Phdr *, const Elf_Shdr *> findDynamic();
371e8d8bef9SDimitry Andric   void loadDynamicTable();
372e8d8bef9SDimitry Andric   void parseDynamicTable();
373e8d8bef9SDimitry Andric 
374e8d8bef9SDimitry Andric   Expected<StringRef> getSymbolVersion(const Elf_Sym &Sym,
375e8d8bef9SDimitry Andric                                        bool &IsDefault) const;
376bdd1243dSDimitry Andric   Expected<SmallVector<std::optional<VersionEntry>, 0> *> getVersionMap() const;
377e8d8bef9SDimitry Andric 
378e8d8bef9SDimitry Andric   DynRegionInfo DynRelRegion;
379e8d8bef9SDimitry Andric   DynRegionInfo DynRelaRegion;
380e8d8bef9SDimitry Andric   DynRegionInfo DynRelrRegion;
381e8d8bef9SDimitry Andric   DynRegionInfo DynPLTRelRegion;
382bdd1243dSDimitry Andric   std::optional<DynRegionInfo> DynSymRegion;
383e8d8bef9SDimitry Andric   DynRegionInfo DynSymTabShndxRegion;
384e8d8bef9SDimitry Andric   DynRegionInfo DynamicTable;
385e8d8bef9SDimitry Andric   StringRef DynamicStringTable;
386e8d8bef9SDimitry Andric   const Elf_Hash *HashTable = nullptr;
387e8d8bef9SDimitry Andric   const Elf_GnuHash *GnuHashTable = nullptr;
388e8d8bef9SDimitry Andric   const Elf_Shdr *DotSymtabSec = nullptr;
389e8d8bef9SDimitry Andric   const Elf_Shdr *DotDynsymSec = nullptr;
390e8d8bef9SDimitry Andric   const Elf_Shdr *DotAddrsigSec = nullptr;
391e8d8bef9SDimitry Andric   DenseMap<const Elf_Shdr *, ArrayRef<Elf_Word>> ShndxTables;
392bdd1243dSDimitry Andric   std::optional<uint64_t> SONameOffset;
393bdd1243dSDimitry Andric   std::optional<DenseMap<uint64_t, std::vector<uint32_t>>> AddressToIndexMap;
394e8d8bef9SDimitry Andric 
395e8d8bef9SDimitry Andric   const Elf_Shdr *SymbolVersionSection = nullptr;   // .gnu.version
396e8d8bef9SDimitry Andric   const Elf_Shdr *SymbolVersionNeedSection = nullptr; // .gnu.version_r
397e8d8bef9SDimitry Andric   const Elf_Shdr *SymbolVersionDefSection = nullptr; // .gnu.version_d
398e8d8bef9SDimitry Andric 
399e8d8bef9SDimitry Andric   std::string getFullSymbolName(const Elf_Sym &Symbol, unsigned SymIndex,
400e8d8bef9SDimitry Andric                                 DataRegion<Elf_Word> ShndxTable,
401bdd1243dSDimitry Andric                                 std::optional<StringRef> StrTable,
4020b57cec5SDimitry Andric                                 bool IsDynamic) const;
403e8d8bef9SDimitry Andric   Expected<unsigned>
404e8d8bef9SDimitry Andric   getSymbolSectionIndex(const Elf_Sym &Symbol, unsigned SymIndex,
405e8d8bef9SDimitry Andric                         DataRegion<Elf_Word> ShndxTable) const;
406e8d8bef9SDimitry Andric   Expected<StringRef> getSymbolSectionName(const Elf_Sym &Symbol,
407480093f4SDimitry Andric                                            unsigned SectionIndex) const;
4085ffd83dbSDimitry Andric   std::string getStaticSymbolName(uint32_t Index) const;
4095ffd83dbSDimitry Andric   StringRef getDynamicString(uint64_t Value) const;
4100b57cec5SDimitry Andric 
4115f757f3fSDimitry Andric   void printSymbolsHelper(bool IsDynamic, bool ExtraSymInfo) const;
4125ffd83dbSDimitry Andric   std::string getDynamicEntry(uint64_t Type, uint64_t Value) const;
4130b57cec5SDimitry Andric 
414e8d8bef9SDimitry Andric   Expected<RelSymbol<ELFT>> getRelocationTarget(const Relocation<ELFT> &R,
415e8d8bef9SDimitry Andric                                                 const Elf_Shdr *SymTab) const;
416480093f4SDimitry Andric 
417e8d8bef9SDimitry Andric   ArrayRef<Elf_Word> getShndxTable(const Elf_Shdr *Symtab) const;
4185ffd83dbSDimitry Andric 
419e8d8bef9SDimitry Andric private:
420bdd1243dSDimitry Andric   mutable SmallVector<std::optional<VersionEntry>, 0> VersionMap;
4210b57cec5SDimitry Andric };
4220b57cec5SDimitry Andric 
4230b57cec5SDimitry Andric template <class ELFT>
describe(const Elf_Shdr & Sec) const424e8d8bef9SDimitry Andric std::string ELFDumper<ELFT>::describe(const Elf_Shdr &Sec) const {
425e8d8bef9SDimitry Andric   return ::describe(Obj, Sec);
426480093f4SDimitry Andric }
427480093f4SDimitry Andric 
428e8d8bef9SDimitry Andric namespace {
429e8d8bef9SDimitry Andric 
430e8d8bef9SDimitry Andric template <class ELFT> struct SymtabLink {
431e8d8bef9SDimitry Andric   typename ELFT::SymRange Symbols;
432e8d8bef9SDimitry Andric   StringRef StringTable;
433e8d8bef9SDimitry Andric   const typename ELFT::Shdr *SymTab;
434e8d8bef9SDimitry Andric };
435e8d8bef9SDimitry Andric 
436e8d8bef9SDimitry Andric // Returns the linked symbol table, symbols and associated string table for a
437e8d8bef9SDimitry Andric // given section.
438480093f4SDimitry Andric template <class ELFT>
getLinkAsSymtab(const ELFFile<ELFT> & Obj,const typename ELFT::Shdr & Sec,unsigned ExpectedType)439e8d8bef9SDimitry Andric Expected<SymtabLink<ELFT>> getLinkAsSymtab(const ELFFile<ELFT> &Obj,
440e8d8bef9SDimitry Andric                                            const typename ELFT::Shdr &Sec,
441e8d8bef9SDimitry Andric                                            unsigned ExpectedType) {
442480093f4SDimitry Andric   Expected<const typename ELFT::Shdr *> SymtabOrErr =
443e8d8bef9SDimitry Andric       Obj.getSection(Sec.sh_link);
444480093f4SDimitry Andric   if (!SymtabOrErr)
445e8d8bef9SDimitry Andric     return createError("invalid section linked to " + describe(Obj, Sec) +
446e8d8bef9SDimitry Andric                        ": " + toString(SymtabOrErr.takeError()));
447480093f4SDimitry Andric 
448480093f4SDimitry Andric   if ((*SymtabOrErr)->sh_type != ExpectedType)
449480093f4SDimitry Andric     return createError(
450e8d8bef9SDimitry Andric         "invalid section linked to " + describe(Obj, Sec) + ": expected " +
451e8d8bef9SDimitry Andric         object::getELFSectionTypeName(Obj.getHeader().e_machine, ExpectedType) +
452480093f4SDimitry Andric         ", but got " +
453e8d8bef9SDimitry Andric         object::getELFSectionTypeName(Obj.getHeader().e_machine,
454480093f4SDimitry Andric                                       (*SymtabOrErr)->sh_type));
455480093f4SDimitry Andric 
456e8d8bef9SDimitry Andric   Expected<StringRef> StrTabOrErr = Obj.getLinkAsStrtab(**SymtabOrErr);
457480093f4SDimitry Andric   if (!StrTabOrErr)
458480093f4SDimitry Andric     return createError(
459480093f4SDimitry Andric         "can't get a string table for the symbol table linked to " +
460e8d8bef9SDimitry Andric         describe(Obj, Sec) + ": " + toString(StrTabOrErr.takeError()));
461480093f4SDimitry Andric 
462e8d8bef9SDimitry Andric   Expected<typename ELFT::SymRange> SymsOrErr = Obj.symbols(*SymtabOrErr);
463480093f4SDimitry Andric   if (!SymsOrErr)
464e8d8bef9SDimitry Andric     return createError("unable to read symbols from the " + describe(Obj, Sec) +
465e8d8bef9SDimitry Andric                        ": " + toString(SymsOrErr.takeError()));
466480093f4SDimitry Andric 
467e8d8bef9SDimitry Andric   return SymtabLink<ELFT>{*SymsOrErr, *StrTabOrErr, *SymtabOrErr};
468480093f4SDimitry Andric }
469480093f4SDimitry Andric 
470e8d8bef9SDimitry Andric } // namespace
471e8d8bef9SDimitry Andric 
472480093f4SDimitry Andric template <class ELFT>
473480093f4SDimitry Andric Expected<ArrayRef<typename ELFT::Versym>>
getVersionTable(const Elf_Shdr & Sec,ArrayRef<Elf_Sym> * SymTab,StringRef * StrTab,const Elf_Shdr ** SymTabSec) const474e8d8bef9SDimitry Andric ELFDumper<ELFT>::getVersionTable(const Elf_Shdr &Sec, ArrayRef<Elf_Sym> *SymTab,
475e8d8bef9SDimitry Andric                                  StringRef *StrTab,
476e8d8bef9SDimitry Andric                                  const Elf_Shdr **SymTabSec) const {
477e8d8bef9SDimitry Andric   assert((!SymTab && !StrTab && !SymTabSec) || (SymTab && StrTab && SymTabSec));
478e8d8bef9SDimitry Andric   if (reinterpret_cast<uintptr_t>(Obj.base() + Sec.sh_offset) %
479e8d8bef9SDimitry Andric           sizeof(uint16_t) !=
480e8d8bef9SDimitry Andric       0)
481e8d8bef9SDimitry Andric     return createError("the " + describe(Sec) + " is misaligned");
482480093f4SDimitry Andric 
483480093f4SDimitry Andric   Expected<ArrayRef<Elf_Versym>> VersionsOrErr =
484e8d8bef9SDimitry Andric       Obj.template getSectionContentsAsArray<Elf_Versym>(Sec);
485480093f4SDimitry Andric   if (!VersionsOrErr)
486e8d8bef9SDimitry Andric     return createError("cannot read content of " + describe(Sec) + ": " +
487e8d8bef9SDimitry Andric                        toString(VersionsOrErr.takeError()));
488480093f4SDimitry Andric 
489e8d8bef9SDimitry Andric   Expected<SymtabLink<ELFT>> SymTabOrErr =
490e8d8bef9SDimitry Andric       getLinkAsSymtab(Obj, Sec, SHT_DYNSYM);
491480093f4SDimitry Andric   if (!SymTabOrErr) {
4925ffd83dbSDimitry Andric     reportUniqueWarning(SymTabOrErr.takeError());
493480093f4SDimitry Andric     return *VersionsOrErr;
494480093f4SDimitry Andric   }
495480093f4SDimitry Andric 
496e8d8bef9SDimitry Andric   if (SymTabOrErr->Symbols.size() != VersionsOrErr->size())
497e8d8bef9SDimitry Andric     reportUniqueWarning(describe(Sec) + ": the number of entries (" +
498e8d8bef9SDimitry Andric                         Twine(VersionsOrErr->size()) +
499480093f4SDimitry Andric                         ") does not match the number of symbols (" +
500e8d8bef9SDimitry Andric                         Twine(SymTabOrErr->Symbols.size()) +
501e8d8bef9SDimitry Andric                         ") in the symbol table with index " +
502e8d8bef9SDimitry Andric                         Twine(Sec.sh_link));
503480093f4SDimitry Andric 
504e8d8bef9SDimitry Andric   if (SymTab) {
505e8d8bef9SDimitry Andric     *SymTab = SymTabOrErr->Symbols;
506e8d8bef9SDimitry Andric     *StrTab = SymTabOrErr->StringTable;
507e8d8bef9SDimitry Andric     *SymTabSec = SymTabOrErr->SymTab;
508e8d8bef9SDimitry Andric   }
509480093f4SDimitry Andric   return *VersionsOrErr;
510480093f4SDimitry Andric }
511480093f4SDimitry Andric 
512480093f4SDimitry Andric template <class ELFT>
printSymbolsHelper(bool IsDynamic,bool ExtraSymInfo) const5135f757f3fSDimitry Andric void ELFDumper<ELFT>::printSymbolsHelper(bool IsDynamic,
5145f757f3fSDimitry Andric                                          bool ExtraSymInfo) const {
515bdd1243dSDimitry Andric   std::optional<StringRef> StrTable;
5160b57cec5SDimitry Andric   size_t Entries = 0;
5170b57cec5SDimitry Andric   Elf_Sym_Range Syms(nullptr, nullptr);
518e8d8bef9SDimitry Andric   const Elf_Shdr *SymtabSec = IsDynamic ? DotDynsymSec : DotSymtabSec;
519e8d8bef9SDimitry Andric 
5200b57cec5SDimitry Andric   if (IsDynamic) {
5210b57cec5SDimitry Andric     StrTable = DynamicStringTable;
5220b57cec5SDimitry Andric     Syms = dynamic_symbols();
5235ffd83dbSDimitry Andric     Entries = Syms.size();
524e8d8bef9SDimitry Andric   } else if (DotSymtabSec) {
5255ffd83dbSDimitry Andric     if (Expected<StringRef> StrTableOrErr =
526e8d8bef9SDimitry Andric             Obj.getStringTableForSymtab(*DotSymtabSec))
5275ffd83dbSDimitry Andric       StrTable = *StrTableOrErr;
5285ffd83dbSDimitry Andric     else
529e8d8bef9SDimitry Andric       reportUniqueWarning(
5305ffd83dbSDimitry Andric           "unable to get the string table for the SHT_SYMTAB section: " +
531e8d8bef9SDimitry Andric           toString(StrTableOrErr.takeError()));
5325ffd83dbSDimitry Andric 
533e8d8bef9SDimitry Andric     if (Expected<Elf_Sym_Range> SymsOrErr = Obj.symbols(DotSymtabSec))
5345ffd83dbSDimitry Andric       Syms = *SymsOrErr;
5355ffd83dbSDimitry Andric     else
5365ffd83dbSDimitry Andric       reportUniqueWarning(
537e8d8bef9SDimitry Andric           "unable to read symbols from the SHT_SYMTAB section: " +
538e8d8bef9SDimitry Andric           toString(SymsOrErr.takeError()));
5390b57cec5SDimitry Andric     Entries = DotSymtabSec->getEntityCount();
5400b57cec5SDimitry Andric   }
541e8d8bef9SDimitry Andric   if (Syms.empty())
5420b57cec5SDimitry Andric     return;
5438bcb0991SDimitry Andric 
5448bcb0991SDimitry Andric   // The st_other field has 2 logical parts. The first two bits hold the symbol
5458bcb0991SDimitry Andric   // visibility (STV_*) and the remainder hold other platform-specific values.
546e8d8bef9SDimitry Andric   bool NonVisibilityBitsUsed =
547e8d8bef9SDimitry Andric       llvm::any_of(Syms, [](const Elf_Sym &S) { return S.st_other & ~0x3; });
5488bcb0991SDimitry Andric 
549e8d8bef9SDimitry Andric   DataRegion<Elf_Word> ShndxTable =
550e8d8bef9SDimitry Andric       IsDynamic ? DataRegion<Elf_Word>(
551e8d8bef9SDimitry Andric                       (const Elf_Word *)this->DynSymTabShndxRegion.Addr,
552e8d8bef9SDimitry Andric                       this->getElfObject().getELFFile().end())
553e8d8bef9SDimitry Andric                 : DataRegion<Elf_Word>(this->getShndxTable(SymtabSec));
554e8d8bef9SDimitry Andric 
5555f757f3fSDimitry Andric   printSymtabMessage(SymtabSec, Entries, NonVisibilityBitsUsed, ExtraSymInfo);
556e8d8bef9SDimitry Andric   for (const Elf_Sym &Sym : Syms)
557e8d8bef9SDimitry Andric     printSymbol(Sym, &Sym - Syms.begin(), ShndxTable, StrTable, IsDynamic,
5585f757f3fSDimitry Andric                 NonVisibilityBitsUsed, ExtraSymInfo);
5590b57cec5SDimitry Andric }
5600b57cec5SDimitry Andric 
561e8d8bef9SDimitry Andric template <typename ELFT> class GNUELFDumper : public ELFDumper<ELFT> {
5620b57cec5SDimitry Andric   formatted_raw_ostream &OS;
5630b57cec5SDimitry Andric 
5640b57cec5SDimitry Andric public:
565e8d8bef9SDimitry Andric   LLVM_ELF_IMPORT_TYPES_ELFT(ELFT)
5660b57cec5SDimitry Andric 
GNUELFDumper(const object::ELFObjectFile<ELFT> & ObjF,ScopedPrinter & Writer)567e8d8bef9SDimitry Andric   GNUELFDumper(const object::ELFObjectFile<ELFT> &ObjF, ScopedPrinter &Writer)
568e8d8bef9SDimitry Andric       : ELFDumper<ELFT>(ObjF, Writer),
569e8d8bef9SDimitry Andric         OS(static_cast<formatted_raw_ostream &>(Writer.getOStream())) {
570e8d8bef9SDimitry Andric     assert(&this->W.getOStream() == &llvm::fouts());
5710b57cec5SDimitry Andric   }
5720b57cec5SDimitry Andric 
5730eae32dcSDimitry Andric   void printFileSummary(StringRef FileStr, ObjectFile &Obj,
5740eae32dcSDimitry Andric                         ArrayRef<std::string> InputFilenames,
5750eae32dcSDimitry Andric                         const Archive *A) override;
576e8d8bef9SDimitry Andric   void printFileHeaders() override;
577e8d8bef9SDimitry Andric   void printGroupSections() override;
578e8d8bef9SDimitry Andric   void printRelocations() override;
579e8d8bef9SDimitry Andric   void printSectionHeaders() override;
5805f757f3fSDimitry Andric   void printSymbols(bool PrintSymbols, bool PrintDynamicSymbols,
5815f757f3fSDimitry Andric                     bool ExtraSymInfo) override;
582e8d8bef9SDimitry Andric   void printHashSymbols() override;
583e8d8bef9SDimitry Andric   void printSectionDetails() override;
584e8d8bef9SDimitry Andric   void printDependentLibs() override;
585e8d8bef9SDimitry Andric   void printDynamicTable() override;
586e8d8bef9SDimitry Andric   void printDynamicRelocations() override;
587e8d8bef9SDimitry Andric   void printSymtabMessage(const Elf_Shdr *Symtab, size_t Offset,
5885f757f3fSDimitry Andric                           bool NonVisibilityBitsUsed,
5895f757f3fSDimitry Andric                           bool ExtraSymInfo) const override;
590e8d8bef9SDimitry Andric   void printProgramHeaders(bool PrintProgramHeaders,
5910b57cec5SDimitry Andric                            cl::boolOrDefault PrintSectionMapping) override;
592e8d8bef9SDimitry Andric   void printVersionSymbolSection(const Elf_Shdr *Sec) override;
593e8d8bef9SDimitry Andric   void printVersionDefinitionSection(const Elf_Shdr *Sec) override;
594e8d8bef9SDimitry Andric   void printVersionDependencySection(const Elf_Shdr *Sec) override;
595e8d8bef9SDimitry Andric   void printCGProfile() override;
596fe6060f1SDimitry Andric   void printBBAddrMaps() override;
597e8d8bef9SDimitry Andric   void printAddrsig() override;
598e8d8bef9SDimitry Andric   void printNotes() override;
599e8d8bef9SDimitry Andric   void printELFLinkerOptions() override;
600e8d8bef9SDimitry Andric   void printStackSizes() override;
60106c3fb27SDimitry Andric   void printMemtag(
60206c3fb27SDimitry Andric       const ArrayRef<std::pair<std::string, std::string>> DynamicEntries,
60306c3fb27SDimitry Andric       const ArrayRef<uint8_t> AndroidNoteDesc,
60406c3fb27SDimitry Andric       const ArrayRef<std::pair<uint64_t, uint64_t>> Descriptors) override;
60506c3fb27SDimitry Andric   void printHashHistogramStats(size_t NBucket, size_t MaxChain,
60606c3fb27SDimitry Andric                                size_t TotalSyms, ArrayRef<size_t> Count,
60706c3fb27SDimitry Andric                                bool IsGnu) const override;
6080b57cec5SDimitry Andric 
6090b57cec5SDimitry Andric private:
610e8d8bef9SDimitry Andric   void printHashTableSymbols(const Elf_Hash &HashTable);
611e8d8bef9SDimitry Andric   void printGnuHashTableSymbols(const Elf_GnuHash &GnuHashTable);
6125ffd83dbSDimitry Andric 
6130b57cec5SDimitry Andric   struct Field {
6140b57cec5SDimitry Andric     std::string Str;
6150b57cec5SDimitry Andric     unsigned Column;
6160b57cec5SDimitry Andric 
Field__anonf567d4440111::GNUELFDumper::Field6175ffd83dbSDimitry Andric     Field(StringRef S, unsigned Col) : Str(std::string(S)), Column(Col) {}
Field__anonf567d4440111::GNUELFDumper::Field6180b57cec5SDimitry Andric     Field(unsigned Col) : Column(Col) {}
6190b57cec5SDimitry Andric   };
6200b57cec5SDimitry Andric 
6210b57cec5SDimitry Andric   template <typename T, typename TEnum>
printFlags(T Value,ArrayRef<EnumEntry<TEnum>> EnumValues,TEnum EnumMask1={},TEnum EnumMask2={},TEnum EnumMask3={}) const6220b57cec5SDimitry Andric   std::string printFlags(T Value, ArrayRef<EnumEntry<TEnum>> EnumValues,
6230b57cec5SDimitry Andric                          TEnum EnumMask1 = {}, TEnum EnumMask2 = {},
624e8d8bef9SDimitry Andric                          TEnum EnumMask3 = {}) const {
6250b57cec5SDimitry Andric     std::string Str;
626e8d8bef9SDimitry Andric     for (const EnumEntry<TEnum> &Flag : EnumValues) {
6270b57cec5SDimitry Andric       if (Flag.Value == 0)
6280b57cec5SDimitry Andric         continue;
6290b57cec5SDimitry Andric 
6300b57cec5SDimitry Andric       TEnum EnumMask{};
6310b57cec5SDimitry Andric       if (Flag.Value & EnumMask1)
6320b57cec5SDimitry Andric         EnumMask = EnumMask1;
6330b57cec5SDimitry Andric       else if (Flag.Value & EnumMask2)
6340b57cec5SDimitry Andric         EnumMask = EnumMask2;
6350b57cec5SDimitry Andric       else if (Flag.Value & EnumMask3)
6360b57cec5SDimitry Andric         EnumMask = EnumMask3;
6370b57cec5SDimitry Andric       bool IsEnum = (Flag.Value & EnumMask) != 0;
6380b57cec5SDimitry Andric       if ((!IsEnum && (Value & Flag.Value) == Flag.Value) ||
6390b57cec5SDimitry Andric           (IsEnum && (Value & EnumMask) == Flag.Value)) {
6400b57cec5SDimitry Andric         if (!Str.empty())
6410b57cec5SDimitry Andric           Str += ", ";
6420b57cec5SDimitry Andric         Str += Flag.AltName;
6430b57cec5SDimitry Andric       }
6440b57cec5SDimitry Andric     }
6450b57cec5SDimitry Andric     return Str;
6460b57cec5SDimitry Andric   }
6470b57cec5SDimitry Andric 
printField(struct Field F) const648e8d8bef9SDimitry Andric   formatted_raw_ostream &printField(struct Field F) const {
6490b57cec5SDimitry Andric     if (F.Column != 0)
6500b57cec5SDimitry Andric       OS.PadToColumn(F.Column);
6510b57cec5SDimitry Andric     OS << F.Str;
6520b57cec5SDimitry Andric     OS.flush();
6530b57cec5SDimitry Andric     return OS;
6540b57cec5SDimitry Andric   }
655e8d8bef9SDimitry Andric   void printHashedSymbol(const Elf_Sym *Sym, unsigned SymIndex,
656e8d8bef9SDimitry Andric                          DataRegion<Elf_Word> ShndxTable, StringRef StrTable,
657e8d8bef9SDimitry Andric                          uint32_t Bucket);
658e8d8bef9SDimitry Andric   void printRelrReloc(const Elf_Relr &R) override;
659e8d8bef9SDimitry Andric   void printRelRelaReloc(const Relocation<ELFT> &R,
660e8d8bef9SDimitry Andric                          const RelSymbol<ELFT> &RelSym) override;
661e8d8bef9SDimitry Andric   void printSymbol(const Elf_Sym &Symbol, unsigned SymIndex,
662e8d8bef9SDimitry Andric                    DataRegion<Elf_Word> ShndxTable,
663bdd1243dSDimitry Andric                    std::optional<StringRef> StrTable, bool IsDynamic,
6645f757f3fSDimitry Andric                    bool NonVisibilityBitsUsed,
6655f757f3fSDimitry Andric                    bool ExtraSymInfo) const override;
666e8d8bef9SDimitry Andric   void printDynamicRelocHeader(unsigned Type, StringRef Name,
667e8d8bef9SDimitry Andric                                const DynRegionInfo &Reg) override;
668e8d8bef9SDimitry Andric 
669e8d8bef9SDimitry Andric   std::string getSymbolSectionNdx(const Elf_Sym &Symbol, unsigned SymIndex,
6705f757f3fSDimitry Andric                                   DataRegion<Elf_Word> ShndxTable,
6715f757f3fSDimitry Andric                                   bool ExtraSymInfo = false) const;
672e8d8bef9SDimitry Andric   void printProgramHeaders() override;
673e8d8bef9SDimitry Andric   void printSectionMapping() override;
674e8d8bef9SDimitry Andric   void printGNUVersionSectionProlog(const typename ELFT::Shdr &Sec,
675480093f4SDimitry Andric                                     const Twine &Label, unsigned EntriesNum);
6760b57cec5SDimitry Andric 
677fe6060f1SDimitry Andric   void printStackSizeEntry(uint64_t Size,
678fe6060f1SDimitry Andric                            ArrayRef<std::string> FuncNames) override;
679e8d8bef9SDimitry Andric 
6800b57cec5SDimitry Andric   void printMipsGOT(const MipsGOTParser<ELFT> &Parser) override;
6810b57cec5SDimitry Andric   void printMipsPLT(const MipsGOTParser<ELFT> &Parser) override;
682e8d8bef9SDimitry Andric   void printMipsABIFlags() override;
683e8d8bef9SDimitry Andric };
684e8d8bef9SDimitry Andric 
685e8d8bef9SDimitry Andric template <typename ELFT> class LLVMELFDumper : public ELFDumper<ELFT> {
686e8d8bef9SDimitry Andric public:
687e8d8bef9SDimitry Andric   LLVM_ELF_IMPORT_TYPES_ELFT(ELFT)
688e8d8bef9SDimitry Andric 
LLVMELFDumper(const object::ELFObjectFile<ELFT> & ObjF,ScopedPrinter & Writer)689e8d8bef9SDimitry Andric   LLVMELFDumper(const object::ELFObjectFile<ELFT> &ObjF, ScopedPrinter &Writer)
690e8d8bef9SDimitry Andric       : ELFDumper<ELFT>(ObjF, Writer), W(Writer) {}
691e8d8bef9SDimitry Andric 
692e8d8bef9SDimitry Andric   void printFileHeaders() override;
693e8d8bef9SDimitry Andric   void printGroupSections() override;
694e8d8bef9SDimitry Andric   void printRelocations() override;
695e8d8bef9SDimitry Andric   void printSectionHeaders() override;
6965f757f3fSDimitry Andric   void printSymbols(bool PrintSymbols, bool PrintDynamicSymbols,
6975f757f3fSDimitry Andric                     bool ExtraSymInfo) override;
698e8d8bef9SDimitry Andric   void printDependentLibs() override;
699e8d8bef9SDimitry Andric   void printDynamicTable() override;
700e8d8bef9SDimitry Andric   void printDynamicRelocations() override;
701e8d8bef9SDimitry Andric   void printProgramHeaders(bool PrintProgramHeaders,
702e8d8bef9SDimitry Andric                            cl::boolOrDefault PrintSectionMapping) override;
703e8d8bef9SDimitry Andric   void printVersionSymbolSection(const Elf_Shdr *Sec) override;
704e8d8bef9SDimitry Andric   void printVersionDefinitionSection(const Elf_Shdr *Sec) override;
705e8d8bef9SDimitry Andric   void printVersionDependencySection(const Elf_Shdr *Sec) override;
706e8d8bef9SDimitry Andric   void printCGProfile() override;
707fe6060f1SDimitry Andric   void printBBAddrMaps() override;
708e8d8bef9SDimitry Andric   void printAddrsig() override;
709e8d8bef9SDimitry Andric   void printNotes() override;
710e8d8bef9SDimitry Andric   void printELFLinkerOptions() override;
711e8d8bef9SDimitry Andric   void printStackSizes() override;
71206c3fb27SDimitry Andric   void printMemtag(
71306c3fb27SDimitry Andric       const ArrayRef<std::pair<std::string, std::string>> DynamicEntries,
71406c3fb27SDimitry Andric       const ArrayRef<uint8_t> AndroidNoteDesc,
71506c3fb27SDimitry Andric       const ArrayRef<std::pair<uint64_t, uint64_t>> Descriptors) override;
71606c3fb27SDimitry Andric   void printSymbolSection(const Elf_Sym &Symbol, unsigned SymIndex,
71706c3fb27SDimitry Andric                           DataRegion<Elf_Word> ShndxTable) const;
71806c3fb27SDimitry Andric   void printHashHistogramStats(size_t NBucket, size_t MaxChain,
71906c3fb27SDimitry Andric                                size_t TotalSyms, ArrayRef<size_t> Count,
72006c3fb27SDimitry Andric                                bool IsGnu) const override;
7210b57cec5SDimitry Andric 
7220b57cec5SDimitry Andric private:
723e8d8bef9SDimitry Andric   void printRelrReloc(const Elf_Relr &R) override;
724e8d8bef9SDimitry Andric   void printRelRelaReloc(const Relocation<ELFT> &R,
725e8d8bef9SDimitry Andric                          const RelSymbol<ELFT> &RelSym) override;
726e8d8bef9SDimitry Andric 
727e8d8bef9SDimitry Andric   void printSymbol(const Elf_Sym &Symbol, unsigned SymIndex,
728e8d8bef9SDimitry Andric                    DataRegion<Elf_Word> ShndxTable,
729bdd1243dSDimitry Andric                    std::optional<StringRef> StrTable, bool IsDynamic,
7305f757f3fSDimitry Andric                    bool /*NonVisibilityBitsUsed*/,
7315f757f3fSDimitry Andric                    bool /*ExtraSymInfo*/) const override;
732e8d8bef9SDimitry Andric   void printProgramHeaders() override;
printSectionMapping()733e8d8bef9SDimitry Andric   void printSectionMapping() override {}
734fe6060f1SDimitry Andric   void printStackSizeEntry(uint64_t Size,
735fe6060f1SDimitry Andric                            ArrayRef<std::string> FuncNames) override;
736e8d8bef9SDimitry Andric 
737e8d8bef9SDimitry Andric   void printMipsGOT(const MipsGOTParser<ELFT> &Parser) override;
738e8d8bef9SDimitry Andric   void printMipsPLT(const MipsGOTParser<ELFT> &Parser) override;
739e8d8bef9SDimitry Andric   void printMipsABIFlags() override;
74006c3fb27SDimitry Andric   virtual void printZeroSymbolOtherField(const Elf_Sym &Symbol) const;
7410b57cec5SDimitry Andric 
7420eae32dcSDimitry Andric protected:
74306c3fb27SDimitry Andric   virtual std::string getGroupSectionHeaderName() const;
74406c3fb27SDimitry Andric   void printSymbolOtherField(const Elf_Sym &Symbol) const;
74506c3fb27SDimitry Andric   virtual void printExpandedRelRelaReloc(const Relocation<ELFT> &R,
74606c3fb27SDimitry Andric                                          StringRef SymbolName,
74706c3fb27SDimitry Andric                                          StringRef RelocName);
74806c3fb27SDimitry Andric   virtual void printDefaultRelRelaReloc(const Relocation<ELFT> &R,
74906c3fb27SDimitry Andric                                         StringRef SymbolName,
75006c3fb27SDimitry Andric                                         StringRef RelocName);
75106c3fb27SDimitry Andric   virtual void printRelocationSectionInfo(const Elf_Shdr &Sec, StringRef Name,
75206c3fb27SDimitry Andric                                           const unsigned SecNdx);
75306c3fb27SDimitry Andric   virtual void printSectionGroupMembers(StringRef Name, uint64_t Idx) const;
75406c3fb27SDimitry Andric   virtual void printEmptyGroupMessage() const;
75506c3fb27SDimitry Andric 
7560b57cec5SDimitry Andric   ScopedPrinter &W;
7570b57cec5SDimitry Andric };
7580b57cec5SDimitry Andric 
7590eae32dcSDimitry Andric // JSONELFDumper shares most of the same implementation as LLVMELFDumper except
7600eae32dcSDimitry Andric // it uses a JSONScopedPrinter.
7610eae32dcSDimitry Andric template <typename ELFT> class JSONELFDumper : public LLVMELFDumper<ELFT> {
7620eae32dcSDimitry Andric public:
7630eae32dcSDimitry Andric   LLVM_ELF_IMPORT_TYPES_ELFT(ELFT)
7640eae32dcSDimitry Andric 
JSONELFDumper(const object::ELFObjectFile<ELFT> & ObjF,ScopedPrinter & Writer)7650eae32dcSDimitry Andric   JSONELFDumper(const object::ELFObjectFile<ELFT> &ObjF, ScopedPrinter &Writer)
7660eae32dcSDimitry Andric       : LLVMELFDumper<ELFT>(ObjF, Writer) {}
7670eae32dcSDimitry Andric 
76806c3fb27SDimitry Andric   std::string getGroupSectionHeaderName() const override;
76906c3fb27SDimitry Andric 
7700eae32dcSDimitry Andric   void printFileSummary(StringRef FileStr, ObjectFile &Obj,
7710eae32dcSDimitry Andric                         ArrayRef<std::string> InputFilenames,
7720eae32dcSDimitry Andric                         const Archive *A) override;
77306c3fb27SDimitry Andric   virtual void printZeroSymbolOtherField(const Elf_Sym &Symbol) const override;
77406c3fb27SDimitry Andric 
77506c3fb27SDimitry Andric   void printDefaultRelRelaReloc(const Relocation<ELFT> &R,
77606c3fb27SDimitry Andric                                 StringRef SymbolName,
77706c3fb27SDimitry Andric                                 StringRef RelocName) override;
77806c3fb27SDimitry Andric 
77906c3fb27SDimitry Andric   void printRelocationSectionInfo(const Elf_Shdr &Sec, StringRef Name,
78006c3fb27SDimitry Andric                                   const unsigned SecNdx) override;
78106c3fb27SDimitry Andric 
78206c3fb27SDimitry Andric   void printSectionGroupMembers(StringRef Name, uint64_t Idx) const override;
78306c3fb27SDimitry Andric 
78406c3fb27SDimitry Andric   void printEmptyGroupMessage() const override;
7850eae32dcSDimitry Andric 
7860eae32dcSDimitry Andric private:
7870eae32dcSDimitry Andric   std::unique_ptr<DictScope> FileScope;
7880eae32dcSDimitry Andric };
7890eae32dcSDimitry Andric 
7900b57cec5SDimitry Andric } // end anonymous namespace
7910b57cec5SDimitry Andric 
7920b57cec5SDimitry Andric namespace llvm {
7930b57cec5SDimitry Andric 
7940b57cec5SDimitry Andric template <class ELFT>
795e8d8bef9SDimitry Andric static std::unique_ptr<ObjDumper>
createELFDumper(const ELFObjectFile<ELFT> & Obj,ScopedPrinter & Writer)796e8d8bef9SDimitry Andric createELFDumper(const ELFObjectFile<ELFT> &Obj, ScopedPrinter &Writer) {
797e8d8bef9SDimitry Andric   if (opts::Output == opts::GNU)
798e8d8bef9SDimitry Andric     return std::make_unique<GNUELFDumper<ELFT>>(Obj, Writer);
7990eae32dcSDimitry Andric   else if (opts::Output == opts::JSON)
8000eae32dcSDimitry Andric     return std::make_unique<JSONELFDumper<ELFT>>(Obj, Writer);
801e8d8bef9SDimitry Andric   return std::make_unique<LLVMELFDumper<ELFT>>(Obj, Writer);
8020b57cec5SDimitry Andric }
8030b57cec5SDimitry Andric 
createELFDumper(const object::ELFObjectFileBase & Obj,ScopedPrinter & Writer)804e8d8bef9SDimitry Andric std::unique_ptr<ObjDumper> createELFDumper(const object::ELFObjectFileBase &Obj,
805e8d8bef9SDimitry Andric                                            ScopedPrinter &Writer) {
8060b57cec5SDimitry Andric   // Little-endian 32-bit
807e8d8bef9SDimitry Andric   if (const ELF32LEObjectFile *ELFObj = dyn_cast<ELF32LEObjectFile>(&Obj))
808e8d8bef9SDimitry Andric     return createELFDumper(*ELFObj, Writer);
8090b57cec5SDimitry Andric 
8100b57cec5SDimitry Andric   // Big-endian 32-bit
811e8d8bef9SDimitry Andric   if (const ELF32BEObjectFile *ELFObj = dyn_cast<ELF32BEObjectFile>(&Obj))
812e8d8bef9SDimitry Andric     return createELFDumper(*ELFObj, Writer);
8130b57cec5SDimitry Andric 
8140b57cec5SDimitry Andric   // Little-endian 64-bit
815e8d8bef9SDimitry Andric   if (const ELF64LEObjectFile *ELFObj = dyn_cast<ELF64LEObjectFile>(&Obj))
816e8d8bef9SDimitry Andric     return createELFDumper(*ELFObj, Writer);
8170b57cec5SDimitry Andric 
8180b57cec5SDimitry Andric   // Big-endian 64-bit
819e8d8bef9SDimitry Andric   return createELFDumper(*cast<ELF64BEObjectFile>(&Obj), Writer);
8200b57cec5SDimitry Andric }
8210b57cec5SDimitry Andric 
8220b57cec5SDimitry Andric } // end namespace llvm
8230b57cec5SDimitry Andric 
824e8d8bef9SDimitry Andric template <class ELFT>
825bdd1243dSDimitry Andric Expected<SmallVector<std::optional<VersionEntry>, 0> *>
getVersionMap() const826e8d8bef9SDimitry Andric ELFDumper<ELFT>::getVersionMap() const {
827e8d8bef9SDimitry Andric   // If the VersionMap has already been loaded or if there is no dynamic symtab
828e8d8bef9SDimitry Andric   // or version table, there is nothing to do.
829e8d8bef9SDimitry Andric   if (!VersionMap.empty() || !DynSymRegion || !SymbolVersionSection)
830e8d8bef9SDimitry Andric     return &VersionMap;
8310b57cec5SDimitry Andric 
832bdd1243dSDimitry Andric   Expected<SmallVector<std::optional<VersionEntry>, 0>> MapOrErr =
833e8d8bef9SDimitry Andric       Obj.loadVersionMap(SymbolVersionNeedSection, SymbolVersionDefSection);
834e8d8bef9SDimitry Andric   if (MapOrErr)
835e8d8bef9SDimitry Andric     VersionMap = *MapOrErr;
836e8d8bef9SDimitry Andric   else
837e8d8bef9SDimitry Andric     return MapOrErr.takeError();
8380b57cec5SDimitry Andric 
839e8d8bef9SDimitry Andric   return &VersionMap;
8400b57cec5SDimitry Andric }
8410b57cec5SDimitry Andric 
8420b57cec5SDimitry Andric template <typename ELFT>
getSymbolVersion(const Elf_Sym & Sym,bool & IsDefault) const843e8d8bef9SDimitry Andric Expected<StringRef> ELFDumper<ELFT>::getSymbolVersion(const Elf_Sym &Sym,
8440b57cec5SDimitry Andric                                                       bool &IsDefault) const {
8450b57cec5SDimitry Andric   // This is a dynamic symbol. Look in the GNU symbol version table.
8460b57cec5SDimitry Andric   if (!SymbolVersionSection) {
8470b57cec5SDimitry Andric     // No version table.
8480b57cec5SDimitry Andric     IsDefault = false;
8490b57cec5SDimitry Andric     return "";
8500b57cec5SDimitry Andric   }
8510b57cec5SDimitry Andric 
8525ffd83dbSDimitry Andric   assert(DynSymRegion && "DynSymRegion has not been initialised");
8530b57cec5SDimitry Andric   // Determine the position in the symbol table of this entry.
854e8d8bef9SDimitry Andric   size_t EntryIndex = (reinterpret_cast<uintptr_t>(&Sym) -
8555ffd83dbSDimitry Andric                        reinterpret_cast<uintptr_t>(DynSymRegion->Addr)) /
8560b57cec5SDimitry Andric                       sizeof(Elf_Sym);
8570b57cec5SDimitry Andric 
8580b57cec5SDimitry Andric   // Get the corresponding version index entry.
859e8d8bef9SDimitry Andric   Expected<const Elf_Versym *> EntryOrErr =
860e8d8bef9SDimitry Andric       Obj.template getEntry<Elf_Versym>(*SymbolVersionSection, EntryIndex);
861e8d8bef9SDimitry Andric   if (!EntryOrErr)
8625ffd83dbSDimitry Andric     return EntryOrErr.takeError();
863e8d8bef9SDimitry Andric 
864e8d8bef9SDimitry Andric   unsigned Version = (*EntryOrErr)->vs_index;
865e8d8bef9SDimitry Andric   if (Version == VER_NDX_LOCAL || Version == VER_NDX_GLOBAL) {
866e8d8bef9SDimitry Andric     IsDefault = false;
867e8d8bef9SDimitry Andric     return "";
868e8d8bef9SDimitry Andric   }
869e8d8bef9SDimitry Andric 
870bdd1243dSDimitry Andric   Expected<SmallVector<std::optional<VersionEntry>, 0> *> MapOrErr =
871e8d8bef9SDimitry Andric       getVersionMap();
872e8d8bef9SDimitry Andric   if (!MapOrErr)
873e8d8bef9SDimitry Andric     return MapOrErr.takeError();
874e8d8bef9SDimitry Andric 
875e8d8bef9SDimitry Andric   return Obj.getSymbolVersionByIndex(Version, IsDefault, **MapOrErr,
876e8d8bef9SDimitry Andric                                      Sym.st_shndx == ELF::SHN_UNDEF);
8770b57cec5SDimitry Andric }
8780b57cec5SDimitry Andric 
8790b57cec5SDimitry Andric template <typename ELFT>
880e8d8bef9SDimitry Andric Expected<RelSymbol<ELFT>>
getRelocationTarget(const Relocation<ELFT> & R,const Elf_Shdr * SymTab) const881e8d8bef9SDimitry Andric ELFDumper<ELFT>::getRelocationTarget(const Relocation<ELFT> &R,
882e8d8bef9SDimitry Andric                                      const Elf_Shdr *SymTab) const {
883e8d8bef9SDimitry Andric   if (R.Symbol == 0)
884e8d8bef9SDimitry Andric     return RelSymbol<ELFT>(nullptr, "");
885e8d8bef9SDimitry Andric 
886e8d8bef9SDimitry Andric   Expected<const Elf_Sym *> SymOrErr =
887e8d8bef9SDimitry Andric       Obj.template getEntry<Elf_Sym>(*SymTab, R.Symbol);
8885ffd83dbSDimitry Andric   if (!SymOrErr)
889e8d8bef9SDimitry Andric     return createError("unable to read an entry with index " + Twine(R.Symbol) +
890e8d8bef9SDimitry Andric                        " from " + describe(*SymTab) + ": " +
891e8d8bef9SDimitry Andric                        toString(SymOrErr.takeError()));
8925ffd83dbSDimitry Andric   const Elf_Sym *Sym = *SymOrErr;
8935ffd83dbSDimitry Andric   if (!Sym)
894e8d8bef9SDimitry Andric     return RelSymbol<ELFT>(nullptr, "");
8955ffd83dbSDimitry Andric 
896e8d8bef9SDimitry Andric   Expected<StringRef> StrTableOrErr = Obj.getStringTableForSymtab(*SymTab);
8975ffd83dbSDimitry Andric   if (!StrTableOrErr)
8985ffd83dbSDimitry Andric     return StrTableOrErr.takeError();
8995ffd83dbSDimitry Andric 
900e8d8bef9SDimitry Andric   const Elf_Sym *FirstSym =
901e8d8bef9SDimitry Andric       cantFail(Obj.template getEntry<Elf_Sym>(*SymTab, 0));
9025ffd83dbSDimitry Andric   std::string SymbolName =
903e8d8bef9SDimitry Andric       getFullSymbolName(*Sym, Sym - FirstSym, getShndxTable(SymTab),
904e8d8bef9SDimitry Andric                         *StrTableOrErr, SymTab->sh_type == SHT_DYNSYM);
905e8d8bef9SDimitry Andric   return RelSymbol<ELFT>(Sym, SymbolName);
906e8d8bef9SDimitry Andric }
907e8d8bef9SDimitry Andric 
908e8d8bef9SDimitry Andric template <typename ELFT>
909e8d8bef9SDimitry Andric ArrayRef<typename ELFT::Word>
getShndxTable(const Elf_Shdr * Symtab) const910e8d8bef9SDimitry Andric ELFDumper<ELFT>::getShndxTable(const Elf_Shdr *Symtab) const {
911e8d8bef9SDimitry Andric   if (Symtab) {
912e8d8bef9SDimitry Andric     auto It = ShndxTables.find(Symtab);
913e8d8bef9SDimitry Andric     if (It != ShndxTables.end())
914e8d8bef9SDimitry Andric       return It->second;
915e8d8bef9SDimitry Andric   }
916e8d8bef9SDimitry Andric   return {};
9175ffd83dbSDimitry Andric }
9185ffd83dbSDimitry Andric 
maybeDemangle(StringRef Name)9195ffd83dbSDimitry Andric static std::string maybeDemangle(StringRef Name) {
92006c3fb27SDimitry Andric   return opts::Demangle ? demangle(Name) : Name.str();
9215ffd83dbSDimitry Andric }
9225ffd83dbSDimitry Andric 
9235ffd83dbSDimitry Andric template <typename ELFT>
getStaticSymbolName(uint32_t Index) const9245ffd83dbSDimitry Andric std::string ELFDumper<ELFT>::getStaticSymbolName(uint32_t Index) const {
9255ffd83dbSDimitry Andric   auto Warn = [&](Error E) -> std::string {
926e8d8bef9SDimitry Andric     reportUniqueWarning("unable to read the name of symbol with index " +
927e8d8bef9SDimitry Andric                         Twine(Index) + ": " + toString(std::move(E)));
9285ffd83dbSDimitry Andric     return "<?>";
9295ffd83dbSDimitry Andric   };
9305ffd83dbSDimitry Andric 
9318bcb0991SDimitry Andric   Expected<const typename ELFT::Sym *> SymOrErr =
932e8d8bef9SDimitry Andric       Obj.getSymbol(DotSymtabSec, Index);
9338bcb0991SDimitry Andric   if (!SymOrErr)
9345ffd83dbSDimitry Andric     return Warn(SymOrErr.takeError());
9358bcb0991SDimitry Andric 
936e8d8bef9SDimitry Andric   Expected<StringRef> StrTabOrErr = Obj.getStringTableForSymtab(*DotSymtabSec);
9378bcb0991SDimitry Andric   if (!StrTabOrErr)
9385ffd83dbSDimitry Andric     return Warn(StrTabOrErr.takeError());
9398bcb0991SDimitry Andric 
9408bcb0991SDimitry Andric   Expected<StringRef> NameOrErr = (*SymOrErr)->getName(*StrTabOrErr);
9418bcb0991SDimitry Andric   if (!NameOrErr)
9425ffd83dbSDimitry Andric     return Warn(NameOrErr.takeError());
9438bcb0991SDimitry Andric   return maybeDemangle(*NameOrErr);
9440b57cec5SDimitry Andric }
9450b57cec5SDimitry Andric 
9460b57cec5SDimitry Andric template <typename ELFT>
getFullSymbolName(const Elf_Sym & Symbol,unsigned SymIndex,DataRegion<Elf_Word> ShndxTable,std::optional<StringRef> StrTable,bool IsDynamic) const947bdd1243dSDimitry Andric std::string ELFDumper<ELFT>::getFullSymbolName(
948bdd1243dSDimitry Andric     const Elf_Sym &Symbol, unsigned SymIndex, DataRegion<Elf_Word> ShndxTable,
949bdd1243dSDimitry Andric     std::optional<StringRef> StrTable, bool IsDynamic) const {
9505ffd83dbSDimitry Andric   if (!StrTable)
9515ffd83dbSDimitry Andric     return "<?>";
9525ffd83dbSDimitry Andric 
9535ffd83dbSDimitry Andric   std::string SymbolName;
954e8d8bef9SDimitry Andric   if (Expected<StringRef> NameOrErr = Symbol.getName(*StrTable)) {
9555ffd83dbSDimitry Andric     SymbolName = maybeDemangle(*NameOrErr);
9565ffd83dbSDimitry Andric   } else {
9575ffd83dbSDimitry Andric     reportUniqueWarning(NameOrErr.takeError());
9585ffd83dbSDimitry Andric     return "<?>";
9595ffd83dbSDimitry Andric   }
9600b57cec5SDimitry Andric 
961e8d8bef9SDimitry Andric   if (SymbolName.empty() && Symbol.getType() == ELF::STT_SECTION) {
962480093f4SDimitry Andric     Expected<unsigned> SectionIndex =
963e8d8bef9SDimitry Andric         getSymbolSectionIndex(Symbol, SymIndex, ShndxTable);
964480093f4SDimitry Andric     if (!SectionIndex) {
9655ffd83dbSDimitry Andric       reportUniqueWarning(SectionIndex.takeError());
966480093f4SDimitry Andric       return "<?>";
967480093f4SDimitry Andric     }
968480093f4SDimitry Andric     Expected<StringRef> NameOrErr = getSymbolSectionName(Symbol, *SectionIndex);
969480093f4SDimitry Andric     if (!NameOrErr) {
9705ffd83dbSDimitry Andric       reportUniqueWarning(NameOrErr.takeError());
971480093f4SDimitry Andric       return ("<section " + Twine(*SectionIndex) + ">").str();
972480093f4SDimitry Andric     }
9735ffd83dbSDimitry Andric     return std::string(*NameOrErr);
9740b57cec5SDimitry Andric   }
9750b57cec5SDimitry Andric 
9760b57cec5SDimitry Andric   if (!IsDynamic)
9770b57cec5SDimitry Andric     return SymbolName;
9780b57cec5SDimitry Andric 
9790b57cec5SDimitry Andric   bool IsDefault;
980e8d8bef9SDimitry Andric   Expected<StringRef> VersionOrErr = getSymbolVersion(Symbol, IsDefault);
981480093f4SDimitry Andric   if (!VersionOrErr) {
9825ffd83dbSDimitry Andric     reportUniqueWarning(VersionOrErr.takeError());
983480093f4SDimitry Andric     return SymbolName + "@<corrupt>";
984480093f4SDimitry Andric   }
985480093f4SDimitry Andric 
986480093f4SDimitry Andric   if (!VersionOrErr->empty()) {
9870b57cec5SDimitry Andric     SymbolName += (IsDefault ? "@@" : "@");
988480093f4SDimitry Andric     SymbolName += *VersionOrErr;
9890b57cec5SDimitry Andric   }
9900b57cec5SDimitry Andric   return SymbolName;
9910b57cec5SDimitry Andric }
9920b57cec5SDimitry Andric 
9930b57cec5SDimitry Andric template <typename ELFT>
994480093f4SDimitry Andric Expected<unsigned>
getSymbolSectionIndex(const Elf_Sym & Symbol,unsigned SymIndex,DataRegion<Elf_Word> ShndxTable) const995e8d8bef9SDimitry Andric ELFDumper<ELFT>::getSymbolSectionIndex(const Elf_Sym &Symbol, unsigned SymIndex,
996e8d8bef9SDimitry Andric                                        DataRegion<Elf_Word> ShndxTable) const {
997e8d8bef9SDimitry Andric   unsigned Ndx = Symbol.st_shndx;
998e8d8bef9SDimitry Andric   if (Ndx == SHN_XINDEX)
999e8d8bef9SDimitry Andric     return object::getExtendedSymbolTableIndex<ELFT>(Symbol, SymIndex,
1000e8d8bef9SDimitry Andric                                                      ShndxTable);
1001e8d8bef9SDimitry Andric   if (Ndx != SHN_UNDEF && Ndx < SHN_LORESERVE)
1002e8d8bef9SDimitry Andric     return Ndx;
1003e8d8bef9SDimitry Andric 
1004bdd1243dSDimitry Andric   auto CreateErr = [&](const Twine &Name,
1005bdd1243dSDimitry Andric                        std::optional<unsigned> Offset = std::nullopt) {
1006e8d8bef9SDimitry Andric     std::string Desc;
1007e8d8bef9SDimitry Andric     if (Offset)
1008e8d8bef9SDimitry Andric       Desc = (Name + "+0x" + Twine::utohexstr(*Offset)).str();
1009e8d8bef9SDimitry Andric     else
1010e8d8bef9SDimitry Andric       Desc = Name.str();
1011e8d8bef9SDimitry Andric     return createError(
1012e8d8bef9SDimitry Andric         "unable to get section index for symbol with st_shndx = 0x" +
1013e8d8bef9SDimitry Andric         Twine::utohexstr(Ndx) + " (" + Desc + ")");
1014e8d8bef9SDimitry Andric   };
1015e8d8bef9SDimitry Andric 
1016e8d8bef9SDimitry Andric   if (Ndx >= ELF::SHN_LOPROC && Ndx <= ELF::SHN_HIPROC)
1017e8d8bef9SDimitry Andric     return CreateErr("SHN_LOPROC", Ndx - ELF::SHN_LOPROC);
1018e8d8bef9SDimitry Andric   if (Ndx >= ELF::SHN_LOOS && Ndx <= ELF::SHN_HIOS)
1019e8d8bef9SDimitry Andric     return CreateErr("SHN_LOOS", Ndx - ELF::SHN_LOOS);
1020e8d8bef9SDimitry Andric   if (Ndx == ELF::SHN_UNDEF)
1021e8d8bef9SDimitry Andric     return CreateErr("SHN_UNDEF");
1022e8d8bef9SDimitry Andric   if (Ndx == ELF::SHN_ABS)
1023e8d8bef9SDimitry Andric     return CreateErr("SHN_ABS");
1024e8d8bef9SDimitry Andric   if (Ndx == ELF::SHN_COMMON)
1025e8d8bef9SDimitry Andric     return CreateErr("SHN_COMMON");
1026e8d8bef9SDimitry Andric   return CreateErr("SHN_LORESERVE", Ndx - SHN_LORESERVE);
10270b57cec5SDimitry Andric }
1028480093f4SDimitry Andric 
1029480093f4SDimitry Andric template <typename ELFT>
1030480093f4SDimitry Andric Expected<StringRef>
getSymbolSectionName(const Elf_Sym & Symbol,unsigned SectionIndex) const1031e8d8bef9SDimitry Andric ELFDumper<ELFT>::getSymbolSectionName(const Elf_Sym &Symbol,
1032480093f4SDimitry Andric                                       unsigned SectionIndex) const {
1033e8d8bef9SDimitry Andric   Expected<const Elf_Shdr *> SecOrErr = Obj.getSection(SectionIndex);
1034480093f4SDimitry Andric   if (!SecOrErr)
1035480093f4SDimitry Andric     return SecOrErr.takeError();
1036e8d8bef9SDimitry Andric   return Obj.getSectionName(**SecOrErr);
10370b57cec5SDimitry Andric }
10380b57cec5SDimitry Andric 
10390b57cec5SDimitry Andric template <class ELFO>
10400b57cec5SDimitry Andric static const typename ELFO::Elf_Shdr *
findNotEmptySectionByAddress(const ELFO & Obj,StringRef FileName,uint64_t Addr)1041e8d8bef9SDimitry Andric findNotEmptySectionByAddress(const ELFO &Obj, StringRef FileName,
10428bcb0991SDimitry Andric                              uint64_t Addr) {
10435ffd83dbSDimitry Andric   for (const typename ELFO::Elf_Shdr &Shdr : cantFail(Obj.sections()))
1044e8d8bef9SDimitry Andric     if (Shdr.sh_addr == Addr && Shdr.sh_size > 0)
10450b57cec5SDimitry Andric       return &Shdr;
10460b57cec5SDimitry Andric   return nullptr;
10470b57cec5SDimitry Andric }
10480b57cec5SDimitry Andric 
1049349cc55cSDimitry Andric const EnumEntry<unsigned> ElfClass[] = {
10500b57cec5SDimitry Andric   {"None",   "none",   ELF::ELFCLASSNONE},
10510b57cec5SDimitry Andric   {"32-bit", "ELF32",  ELF::ELFCLASS32},
10520b57cec5SDimitry Andric   {"64-bit", "ELF64",  ELF::ELFCLASS64},
10530b57cec5SDimitry Andric };
10540b57cec5SDimitry Andric 
1055349cc55cSDimitry Andric const EnumEntry<unsigned> ElfDataEncoding[] = {
10560b57cec5SDimitry Andric   {"None",         "none",                          ELF::ELFDATANONE},
10570b57cec5SDimitry Andric   {"LittleEndian", "2's complement, little endian", ELF::ELFDATA2LSB},
10580b57cec5SDimitry Andric   {"BigEndian",    "2's complement, big endian",    ELF::ELFDATA2MSB},
10590b57cec5SDimitry Andric };
10600b57cec5SDimitry Andric 
1061349cc55cSDimitry Andric const EnumEntry<unsigned> ElfObjectFileType[] = {
10620b57cec5SDimitry Andric   {"None",         "NONE (none)",              ELF::ET_NONE},
10630b57cec5SDimitry Andric   {"Relocatable",  "REL (Relocatable file)",   ELF::ET_REL},
10640b57cec5SDimitry Andric   {"Executable",   "EXEC (Executable file)",   ELF::ET_EXEC},
10650b57cec5SDimitry Andric   {"SharedObject", "DYN (Shared object file)", ELF::ET_DYN},
10660b57cec5SDimitry Andric   {"Core",         "CORE (Core file)",         ELF::ET_CORE},
10670b57cec5SDimitry Andric };
10680b57cec5SDimitry Andric 
1069349cc55cSDimitry Andric const EnumEntry<unsigned> ElfOSABI[] = {
10700b57cec5SDimitry Andric   {"SystemV",      "UNIX - System V",      ELF::ELFOSABI_NONE},
10710b57cec5SDimitry Andric   {"HPUX",         "UNIX - HP-UX",         ELF::ELFOSABI_HPUX},
10720b57cec5SDimitry Andric   {"NetBSD",       "UNIX - NetBSD",        ELF::ELFOSABI_NETBSD},
10730b57cec5SDimitry Andric   {"GNU/Linux",    "UNIX - GNU",           ELF::ELFOSABI_LINUX},
10740b57cec5SDimitry Andric   {"GNU/Hurd",     "GNU/Hurd",             ELF::ELFOSABI_HURD},
10750b57cec5SDimitry Andric   {"Solaris",      "UNIX - Solaris",       ELF::ELFOSABI_SOLARIS},
10760b57cec5SDimitry Andric   {"AIX",          "UNIX - AIX",           ELF::ELFOSABI_AIX},
10770b57cec5SDimitry Andric   {"IRIX",         "UNIX - IRIX",          ELF::ELFOSABI_IRIX},
10780b57cec5SDimitry Andric   {"FreeBSD",      "UNIX - FreeBSD",       ELF::ELFOSABI_FREEBSD},
10790b57cec5SDimitry Andric   {"TRU64",        "UNIX - TRU64",         ELF::ELFOSABI_TRU64},
10800b57cec5SDimitry Andric   {"Modesto",      "Novell - Modesto",     ELF::ELFOSABI_MODESTO},
10810b57cec5SDimitry Andric   {"OpenBSD",      "UNIX - OpenBSD",       ELF::ELFOSABI_OPENBSD},
10820b57cec5SDimitry Andric   {"OpenVMS",      "VMS - OpenVMS",        ELF::ELFOSABI_OPENVMS},
10830b57cec5SDimitry Andric   {"NSK",          "HP - Non-Stop Kernel", ELF::ELFOSABI_NSK},
10840b57cec5SDimitry Andric   {"AROS",         "AROS",                 ELF::ELFOSABI_AROS},
10850b57cec5SDimitry Andric   {"FenixOS",      "FenixOS",              ELF::ELFOSABI_FENIXOS},
10860b57cec5SDimitry Andric   {"CloudABI",     "CloudABI",             ELF::ELFOSABI_CLOUDABI},
10871db9f3b2SDimitry Andric   {"CUDA",         "NVIDIA - CUDA",        ELF::ELFOSABI_CUDA},
10880b57cec5SDimitry Andric   {"Standalone",   "Standalone App",       ELF::ELFOSABI_STANDALONE}
10890b57cec5SDimitry Andric };
10900b57cec5SDimitry Andric 
1091349cc55cSDimitry Andric const EnumEntry<unsigned> AMDGPUElfOSABI[] = {
10920b57cec5SDimitry Andric   {"AMDGPU_HSA",    "AMDGPU - HSA",    ELF::ELFOSABI_AMDGPU_HSA},
10930b57cec5SDimitry Andric   {"AMDGPU_PAL",    "AMDGPU - PAL",    ELF::ELFOSABI_AMDGPU_PAL},
10940b57cec5SDimitry Andric   {"AMDGPU_MESA3D", "AMDGPU - MESA3D", ELF::ELFOSABI_AMDGPU_MESA3D}
10950b57cec5SDimitry Andric };
10960b57cec5SDimitry Andric 
1097349cc55cSDimitry Andric const EnumEntry<unsigned> ARMElfOSABI[] = {
10980b57cec5SDimitry Andric   {"ARM", "ARM", ELF::ELFOSABI_ARM}
10990b57cec5SDimitry Andric };
11000b57cec5SDimitry Andric 
1101349cc55cSDimitry Andric const EnumEntry<unsigned> C6000ElfOSABI[] = {
11020b57cec5SDimitry Andric   {"C6000_ELFABI", "Bare-metal C6000", ELF::ELFOSABI_C6000_ELFABI},
11030b57cec5SDimitry Andric   {"C6000_LINUX",  "Linux C6000",      ELF::ELFOSABI_C6000_LINUX}
11040b57cec5SDimitry Andric };
11050b57cec5SDimitry Andric 
1106349cc55cSDimitry Andric const EnumEntry<unsigned> ElfMachineType[] = {
11070b57cec5SDimitry Andric   ENUM_ENT(EM_NONE,          "None"),
11080b57cec5SDimitry Andric   ENUM_ENT(EM_M32,           "WE32100"),
11090b57cec5SDimitry Andric   ENUM_ENT(EM_SPARC,         "Sparc"),
11100b57cec5SDimitry Andric   ENUM_ENT(EM_386,           "Intel 80386"),
11110b57cec5SDimitry Andric   ENUM_ENT(EM_68K,           "MC68000"),
11120b57cec5SDimitry Andric   ENUM_ENT(EM_88K,           "MC88000"),
11130b57cec5SDimitry Andric   ENUM_ENT(EM_IAMCU,         "EM_IAMCU"),
11140b57cec5SDimitry Andric   ENUM_ENT(EM_860,           "Intel 80860"),
11150b57cec5SDimitry Andric   ENUM_ENT(EM_MIPS,          "MIPS R3000"),
11160b57cec5SDimitry Andric   ENUM_ENT(EM_S370,          "IBM System/370"),
11170b57cec5SDimitry Andric   ENUM_ENT(EM_MIPS_RS3_LE,   "MIPS R3000 little-endian"),
11180b57cec5SDimitry Andric   ENUM_ENT(EM_PARISC,        "HPPA"),
11190b57cec5SDimitry Andric   ENUM_ENT(EM_VPP500,        "Fujitsu VPP500"),
11200b57cec5SDimitry Andric   ENUM_ENT(EM_SPARC32PLUS,   "Sparc v8+"),
11210b57cec5SDimitry Andric   ENUM_ENT(EM_960,           "Intel 80960"),
11220b57cec5SDimitry Andric   ENUM_ENT(EM_PPC,           "PowerPC"),
11230b57cec5SDimitry Andric   ENUM_ENT(EM_PPC64,         "PowerPC64"),
11240b57cec5SDimitry Andric   ENUM_ENT(EM_S390,          "IBM S/390"),
11250b57cec5SDimitry Andric   ENUM_ENT(EM_SPU,           "SPU"),
11260b57cec5SDimitry Andric   ENUM_ENT(EM_V800,          "NEC V800 series"),
11270b57cec5SDimitry Andric   ENUM_ENT(EM_FR20,          "Fujistsu FR20"),
11280b57cec5SDimitry Andric   ENUM_ENT(EM_RH32,          "TRW RH-32"),
11290b57cec5SDimitry Andric   ENUM_ENT(EM_RCE,           "Motorola RCE"),
11300b57cec5SDimitry Andric   ENUM_ENT(EM_ARM,           "ARM"),
11310b57cec5SDimitry Andric   ENUM_ENT(EM_ALPHA,         "EM_ALPHA"),
11320b57cec5SDimitry Andric   ENUM_ENT(EM_SH,            "Hitachi SH"),
11330b57cec5SDimitry Andric   ENUM_ENT(EM_SPARCV9,       "Sparc v9"),
11340b57cec5SDimitry Andric   ENUM_ENT(EM_TRICORE,       "Siemens Tricore"),
11350b57cec5SDimitry Andric   ENUM_ENT(EM_ARC,           "ARC"),
11360b57cec5SDimitry Andric   ENUM_ENT(EM_H8_300,        "Hitachi H8/300"),
11370b57cec5SDimitry Andric   ENUM_ENT(EM_H8_300H,       "Hitachi H8/300H"),
11380b57cec5SDimitry Andric   ENUM_ENT(EM_H8S,           "Hitachi H8S"),
11390b57cec5SDimitry Andric   ENUM_ENT(EM_H8_500,        "Hitachi H8/500"),
11400b57cec5SDimitry Andric   ENUM_ENT(EM_IA_64,         "Intel IA-64"),
11410b57cec5SDimitry Andric   ENUM_ENT(EM_MIPS_X,        "Stanford MIPS-X"),
11420b57cec5SDimitry Andric   ENUM_ENT(EM_COLDFIRE,      "Motorola Coldfire"),
11430b57cec5SDimitry Andric   ENUM_ENT(EM_68HC12,        "Motorola MC68HC12 Microcontroller"),
11440b57cec5SDimitry Andric   ENUM_ENT(EM_MMA,           "Fujitsu Multimedia Accelerator"),
11450b57cec5SDimitry Andric   ENUM_ENT(EM_PCP,           "Siemens PCP"),
11460b57cec5SDimitry Andric   ENUM_ENT(EM_NCPU,          "Sony nCPU embedded RISC processor"),
11470b57cec5SDimitry Andric   ENUM_ENT(EM_NDR1,          "Denso NDR1 microprocesspr"),
11480b57cec5SDimitry Andric   ENUM_ENT(EM_STARCORE,      "Motorola Star*Core processor"),
11490b57cec5SDimitry Andric   ENUM_ENT(EM_ME16,          "Toyota ME16 processor"),
11500b57cec5SDimitry Andric   ENUM_ENT(EM_ST100,         "STMicroelectronics ST100 processor"),
11510b57cec5SDimitry Andric   ENUM_ENT(EM_TINYJ,         "Advanced Logic Corp. TinyJ embedded processor"),
11520b57cec5SDimitry Andric   ENUM_ENT(EM_X86_64,        "Advanced Micro Devices X86-64"),
11530b57cec5SDimitry Andric   ENUM_ENT(EM_PDSP,          "Sony DSP processor"),
11540b57cec5SDimitry Andric   ENUM_ENT(EM_PDP10,         "Digital Equipment Corp. PDP-10"),
11550b57cec5SDimitry Andric   ENUM_ENT(EM_PDP11,         "Digital Equipment Corp. PDP-11"),
11560b57cec5SDimitry Andric   ENUM_ENT(EM_FX66,          "Siemens FX66 microcontroller"),
11570b57cec5SDimitry Andric   ENUM_ENT(EM_ST9PLUS,       "STMicroelectronics ST9+ 8/16 bit microcontroller"),
11580b57cec5SDimitry Andric   ENUM_ENT(EM_ST7,           "STMicroelectronics ST7 8-bit microcontroller"),
11590b57cec5SDimitry Andric   ENUM_ENT(EM_68HC16,        "Motorola MC68HC16 Microcontroller"),
11600b57cec5SDimitry Andric   ENUM_ENT(EM_68HC11,        "Motorola MC68HC11 Microcontroller"),
11610b57cec5SDimitry Andric   ENUM_ENT(EM_68HC08,        "Motorola MC68HC08 Microcontroller"),
11620b57cec5SDimitry Andric   ENUM_ENT(EM_68HC05,        "Motorola MC68HC05 Microcontroller"),
11630b57cec5SDimitry Andric   ENUM_ENT(EM_SVX,           "Silicon Graphics SVx"),
11640b57cec5SDimitry Andric   ENUM_ENT(EM_ST19,          "STMicroelectronics ST19 8-bit microcontroller"),
11650b57cec5SDimitry Andric   ENUM_ENT(EM_VAX,           "Digital VAX"),
11660b57cec5SDimitry Andric   ENUM_ENT(EM_CRIS,          "Axis Communications 32-bit embedded processor"),
11670b57cec5SDimitry Andric   ENUM_ENT(EM_JAVELIN,       "Infineon Technologies 32-bit embedded cpu"),
11680b57cec5SDimitry Andric   ENUM_ENT(EM_FIREPATH,      "Element 14 64-bit DSP processor"),
11690b57cec5SDimitry Andric   ENUM_ENT(EM_ZSP,           "LSI Logic's 16-bit DSP processor"),
11700b57cec5SDimitry Andric   ENUM_ENT(EM_MMIX,          "Donald Knuth's educational 64-bit processor"),
11710b57cec5SDimitry Andric   ENUM_ENT(EM_HUANY,         "Harvard Universitys's machine-independent object format"),
11720b57cec5SDimitry Andric   ENUM_ENT(EM_PRISM,         "Vitesse Prism"),
11730b57cec5SDimitry Andric   ENUM_ENT(EM_AVR,           "Atmel AVR 8-bit microcontroller"),
11740b57cec5SDimitry Andric   ENUM_ENT(EM_FR30,          "Fujitsu FR30"),
11750b57cec5SDimitry Andric   ENUM_ENT(EM_D10V,          "Mitsubishi D10V"),
11760b57cec5SDimitry Andric   ENUM_ENT(EM_D30V,          "Mitsubishi D30V"),
11770b57cec5SDimitry Andric   ENUM_ENT(EM_V850,          "NEC v850"),
11780b57cec5SDimitry Andric   ENUM_ENT(EM_M32R,          "Renesas M32R (formerly Mitsubishi M32r)"),
11790b57cec5SDimitry Andric   ENUM_ENT(EM_MN10300,       "Matsushita MN10300"),
11800b57cec5SDimitry Andric   ENUM_ENT(EM_MN10200,       "Matsushita MN10200"),
11810b57cec5SDimitry Andric   ENUM_ENT(EM_PJ,            "picoJava"),
11820b57cec5SDimitry Andric   ENUM_ENT(EM_OPENRISC,      "OpenRISC 32-bit embedded processor"),
11830b57cec5SDimitry Andric   ENUM_ENT(EM_ARC_COMPACT,   "EM_ARC_COMPACT"),
11840b57cec5SDimitry Andric   ENUM_ENT(EM_XTENSA,        "Tensilica Xtensa Processor"),
11850b57cec5SDimitry Andric   ENUM_ENT(EM_VIDEOCORE,     "Alphamosaic VideoCore processor"),
11860b57cec5SDimitry Andric   ENUM_ENT(EM_TMM_GPP,       "Thompson Multimedia General Purpose Processor"),
11870b57cec5SDimitry Andric   ENUM_ENT(EM_NS32K,         "National Semiconductor 32000 series"),
11880b57cec5SDimitry Andric   ENUM_ENT(EM_TPC,           "Tenor Network TPC processor"),
11890b57cec5SDimitry Andric   ENUM_ENT(EM_SNP1K,         "EM_SNP1K"),
11900b57cec5SDimitry Andric   ENUM_ENT(EM_ST200,         "STMicroelectronics ST200 microcontroller"),
11910b57cec5SDimitry Andric   ENUM_ENT(EM_IP2K,          "Ubicom IP2xxx 8-bit microcontrollers"),
11920b57cec5SDimitry Andric   ENUM_ENT(EM_MAX,           "MAX Processor"),
11930b57cec5SDimitry Andric   ENUM_ENT(EM_CR,            "National Semiconductor CompactRISC"),
11940b57cec5SDimitry Andric   ENUM_ENT(EM_F2MC16,        "Fujitsu F2MC16"),
11950b57cec5SDimitry Andric   ENUM_ENT(EM_MSP430,        "Texas Instruments msp430 microcontroller"),
11960b57cec5SDimitry Andric   ENUM_ENT(EM_BLACKFIN,      "Analog Devices Blackfin"),
11970b57cec5SDimitry Andric   ENUM_ENT(EM_SE_C33,        "S1C33 Family of Seiko Epson processors"),
11980b57cec5SDimitry Andric   ENUM_ENT(EM_SEP,           "Sharp embedded microprocessor"),
11990b57cec5SDimitry Andric   ENUM_ENT(EM_ARCA,          "Arca RISC microprocessor"),
12000b57cec5SDimitry Andric   ENUM_ENT(EM_UNICORE,       "Unicore"),
12010b57cec5SDimitry Andric   ENUM_ENT(EM_EXCESS,        "eXcess 16/32/64-bit configurable embedded CPU"),
12020b57cec5SDimitry Andric   ENUM_ENT(EM_DXP,           "Icera Semiconductor Inc. Deep Execution Processor"),
12030b57cec5SDimitry Andric   ENUM_ENT(EM_ALTERA_NIOS2,  "Altera Nios"),
12040b57cec5SDimitry Andric   ENUM_ENT(EM_CRX,           "National Semiconductor CRX microprocessor"),
12050b57cec5SDimitry Andric   ENUM_ENT(EM_XGATE,         "Motorola XGATE embedded processor"),
12060b57cec5SDimitry Andric   ENUM_ENT(EM_C166,          "Infineon Technologies xc16x"),
12070b57cec5SDimitry Andric   ENUM_ENT(EM_M16C,          "Renesas M16C"),
12080b57cec5SDimitry Andric   ENUM_ENT(EM_DSPIC30F,      "Microchip Technology dsPIC30F Digital Signal Controller"),
12090b57cec5SDimitry Andric   ENUM_ENT(EM_CE,            "Freescale Communication Engine RISC core"),
12100b57cec5SDimitry Andric   ENUM_ENT(EM_M32C,          "Renesas M32C"),
12110b57cec5SDimitry Andric   ENUM_ENT(EM_TSK3000,       "Altium TSK3000 core"),
12120b57cec5SDimitry Andric   ENUM_ENT(EM_RS08,          "Freescale RS08 embedded processor"),
12130b57cec5SDimitry Andric   ENUM_ENT(EM_SHARC,         "EM_SHARC"),
12140b57cec5SDimitry Andric   ENUM_ENT(EM_ECOG2,         "Cyan Technology eCOG2 microprocessor"),
12150b57cec5SDimitry Andric   ENUM_ENT(EM_SCORE7,        "SUNPLUS S+Core"),
12160b57cec5SDimitry Andric   ENUM_ENT(EM_DSP24,         "New Japan Radio (NJR) 24-bit DSP Processor"),
12170b57cec5SDimitry Andric   ENUM_ENT(EM_VIDEOCORE3,    "Broadcom VideoCore III processor"),
12180b57cec5SDimitry Andric   ENUM_ENT(EM_LATTICEMICO32, "Lattice Mico32"),
12190b57cec5SDimitry Andric   ENUM_ENT(EM_SE_C17,        "Seiko Epson C17 family"),
12200b57cec5SDimitry Andric   ENUM_ENT(EM_TI_C6000,      "Texas Instruments TMS320C6000 DSP family"),
12210b57cec5SDimitry Andric   ENUM_ENT(EM_TI_C2000,      "Texas Instruments TMS320C2000 DSP family"),
12220b57cec5SDimitry Andric   ENUM_ENT(EM_TI_C5500,      "Texas Instruments TMS320C55x DSP family"),
12230b57cec5SDimitry Andric   ENUM_ENT(EM_MMDSP_PLUS,    "STMicroelectronics 64bit VLIW Data Signal Processor"),
12240b57cec5SDimitry Andric   ENUM_ENT(EM_CYPRESS_M8C,   "Cypress M8C microprocessor"),
12250b57cec5SDimitry Andric   ENUM_ENT(EM_R32C,          "Renesas R32C series microprocessors"),
12260b57cec5SDimitry Andric   ENUM_ENT(EM_TRIMEDIA,      "NXP Semiconductors TriMedia architecture family"),
12270b57cec5SDimitry Andric   ENUM_ENT(EM_HEXAGON,       "Qualcomm Hexagon"),
12280b57cec5SDimitry Andric   ENUM_ENT(EM_8051,          "Intel 8051 and variants"),
12290b57cec5SDimitry Andric   ENUM_ENT(EM_STXP7X,        "STMicroelectronics STxP7x family"),
12300b57cec5SDimitry Andric   ENUM_ENT(EM_NDS32,         "Andes Technology compact code size embedded RISC processor family"),
12310b57cec5SDimitry Andric   ENUM_ENT(EM_ECOG1,         "Cyan Technology eCOG1 microprocessor"),
12325ffd83dbSDimitry Andric   // FIXME: Following EM_ECOG1X definitions is dead code since EM_ECOG1X has
12335ffd83dbSDimitry Andric   //        an identical number to EM_ECOG1.
12340b57cec5SDimitry Andric   ENUM_ENT(EM_ECOG1X,        "Cyan Technology eCOG1X family"),
12350b57cec5SDimitry Andric   ENUM_ENT(EM_MAXQ30,        "Dallas Semiconductor MAXQ30 Core microcontrollers"),
12360b57cec5SDimitry Andric   ENUM_ENT(EM_XIMO16,        "New Japan Radio (NJR) 16-bit DSP Processor"),
12370b57cec5SDimitry Andric   ENUM_ENT(EM_MANIK,         "M2000 Reconfigurable RISC Microprocessor"),
12380b57cec5SDimitry Andric   ENUM_ENT(EM_CRAYNV2,       "Cray Inc. NV2 vector architecture"),
12390b57cec5SDimitry Andric   ENUM_ENT(EM_RX,            "Renesas RX"),
12400b57cec5SDimitry Andric   ENUM_ENT(EM_METAG,         "Imagination Technologies Meta processor architecture"),
12410b57cec5SDimitry Andric   ENUM_ENT(EM_MCST_ELBRUS,   "MCST Elbrus general purpose hardware architecture"),
12420b57cec5SDimitry Andric   ENUM_ENT(EM_ECOG16,        "Cyan Technology eCOG16 family"),
1243fe6060f1SDimitry Andric   ENUM_ENT(EM_CR16,          "National Semiconductor CompactRISC 16-bit processor"),
12440b57cec5SDimitry Andric   ENUM_ENT(EM_ETPU,          "Freescale Extended Time Processing Unit"),
12450b57cec5SDimitry Andric   ENUM_ENT(EM_SLE9X,         "Infineon Technologies SLE9X core"),
12460b57cec5SDimitry Andric   ENUM_ENT(EM_L10M,          "EM_L10M"),
12470b57cec5SDimitry Andric   ENUM_ENT(EM_K10M,          "EM_K10M"),
12480b57cec5SDimitry Andric   ENUM_ENT(EM_AARCH64,       "AArch64"),
12490b57cec5SDimitry Andric   ENUM_ENT(EM_AVR32,         "Atmel Corporation 32-bit microprocessor family"),
12500b57cec5SDimitry Andric   ENUM_ENT(EM_STM8,          "STMicroeletronics STM8 8-bit microcontroller"),
12510b57cec5SDimitry Andric   ENUM_ENT(EM_TILE64,        "Tilera TILE64 multicore architecture family"),
12520b57cec5SDimitry Andric   ENUM_ENT(EM_TILEPRO,       "Tilera TILEPro multicore architecture family"),
1253fe6060f1SDimitry Andric   ENUM_ENT(EM_MICROBLAZE,    "Xilinx MicroBlaze 32-bit RISC soft processor core"),
12540b57cec5SDimitry Andric   ENUM_ENT(EM_CUDA,          "NVIDIA CUDA architecture"),
12550b57cec5SDimitry Andric   ENUM_ENT(EM_TILEGX,        "Tilera TILE-Gx multicore architecture family"),
12560b57cec5SDimitry Andric   ENUM_ENT(EM_CLOUDSHIELD,   "EM_CLOUDSHIELD"),
12570b57cec5SDimitry Andric   ENUM_ENT(EM_COREA_1ST,     "EM_COREA_1ST"),
12580b57cec5SDimitry Andric   ENUM_ENT(EM_COREA_2ND,     "EM_COREA_2ND"),
12590b57cec5SDimitry Andric   ENUM_ENT(EM_ARC_COMPACT2,  "EM_ARC_COMPACT2"),
12600b57cec5SDimitry Andric   ENUM_ENT(EM_OPEN8,         "EM_OPEN8"),
12610b57cec5SDimitry Andric   ENUM_ENT(EM_RL78,          "Renesas RL78"),
12620b57cec5SDimitry Andric   ENUM_ENT(EM_VIDEOCORE5,    "Broadcom VideoCore V processor"),
12630b57cec5SDimitry Andric   ENUM_ENT(EM_78KOR,         "EM_78KOR"),
12640b57cec5SDimitry Andric   ENUM_ENT(EM_56800EX,       "EM_56800EX"),
12650b57cec5SDimitry Andric   ENUM_ENT(EM_AMDGPU,        "EM_AMDGPU"),
12660b57cec5SDimitry Andric   ENUM_ENT(EM_RISCV,         "RISC-V"),
12670b57cec5SDimitry Andric   ENUM_ENT(EM_LANAI,         "EM_LANAI"),
12680b57cec5SDimitry Andric   ENUM_ENT(EM_BPF,           "EM_BPF"),
12695ffd83dbSDimitry Andric   ENUM_ENT(EM_VE,            "NEC SX-Aurora Vector Engine"),
127081ad6265SDimitry Andric   ENUM_ENT(EM_LOONGARCH,     "LoongArch"),
12710b57cec5SDimitry Andric };
12720b57cec5SDimitry Andric 
1273349cc55cSDimitry Andric const EnumEntry<unsigned> ElfSymbolBindings[] = {
12740b57cec5SDimitry Andric     {"Local",  "LOCAL",  ELF::STB_LOCAL},
12750b57cec5SDimitry Andric     {"Global", "GLOBAL", ELF::STB_GLOBAL},
12760b57cec5SDimitry Andric     {"Weak",   "WEAK",   ELF::STB_WEAK},
12770b57cec5SDimitry Andric     {"Unique", "UNIQUE", ELF::STB_GNU_UNIQUE}};
12780b57cec5SDimitry Andric 
1279349cc55cSDimitry Andric const EnumEntry<unsigned> ElfSymbolVisibilities[] = {
12800b57cec5SDimitry Andric     {"DEFAULT",   "DEFAULT",   ELF::STV_DEFAULT},
12810b57cec5SDimitry Andric     {"INTERNAL",  "INTERNAL",  ELF::STV_INTERNAL},
12820b57cec5SDimitry Andric     {"HIDDEN",    "HIDDEN",    ELF::STV_HIDDEN},
12830b57cec5SDimitry Andric     {"PROTECTED", "PROTECTED", ELF::STV_PROTECTED}};
12840b57cec5SDimitry Andric 
1285349cc55cSDimitry Andric const EnumEntry<unsigned> AMDGPUSymbolTypes[] = {
12860b57cec5SDimitry Andric   { "AMDGPU_HSA_KERNEL",            ELF::STT_AMDGPU_HSA_KERNEL }
12870b57cec5SDimitry Andric };
12880b57cec5SDimitry Andric 
getGroupType(uint32_t Flag)12890b57cec5SDimitry Andric static const char *getGroupType(uint32_t Flag) {
12900b57cec5SDimitry Andric   if (Flag & ELF::GRP_COMDAT)
12910b57cec5SDimitry Andric     return "COMDAT";
12920b57cec5SDimitry Andric   else
12930b57cec5SDimitry Andric     return "(unknown)";
12940b57cec5SDimitry Andric }
12950b57cec5SDimitry Andric 
1296349cc55cSDimitry Andric const EnumEntry<unsigned> ElfSectionFlags[] = {
12970b57cec5SDimitry Andric   ENUM_ENT(SHF_WRITE,            "W"),
12980b57cec5SDimitry Andric   ENUM_ENT(SHF_ALLOC,            "A"),
12990b57cec5SDimitry Andric   ENUM_ENT(SHF_EXECINSTR,        "X"),
13000b57cec5SDimitry Andric   ENUM_ENT(SHF_MERGE,            "M"),
13010b57cec5SDimitry Andric   ENUM_ENT(SHF_STRINGS,          "S"),
13020b57cec5SDimitry Andric   ENUM_ENT(SHF_INFO_LINK,        "I"),
13030b57cec5SDimitry Andric   ENUM_ENT(SHF_LINK_ORDER,       "L"),
1304480093f4SDimitry Andric   ENUM_ENT(SHF_OS_NONCONFORMING, "O"),
13050b57cec5SDimitry Andric   ENUM_ENT(SHF_GROUP,            "G"),
13060b57cec5SDimitry Andric   ENUM_ENT(SHF_TLS,              "T"),
1307480093f4SDimitry Andric   ENUM_ENT(SHF_COMPRESSED,       "C"),
1308480093f4SDimitry Andric   ENUM_ENT(SHF_EXCLUDE,          "E"),
13090b57cec5SDimitry Andric };
13100b57cec5SDimitry Andric 
131181ad6265SDimitry Andric const EnumEntry<unsigned> ElfGNUSectionFlags[] = {
131281ad6265SDimitry Andric   ENUM_ENT(SHF_GNU_RETAIN, "R")
131381ad6265SDimitry Andric };
131481ad6265SDimitry Andric 
131581ad6265SDimitry Andric const EnumEntry<unsigned> ElfSolarisSectionFlags[] = {
131681ad6265SDimitry Andric   ENUM_ENT(SHF_SUNW_NODISCARD, "R")
131781ad6265SDimitry Andric };
131881ad6265SDimitry Andric 
1319349cc55cSDimitry Andric const EnumEntry<unsigned> ElfXCoreSectionFlags[] = {
1320480093f4SDimitry Andric   ENUM_ENT(XCORE_SHF_CP_SECTION, ""),
1321480093f4SDimitry Andric   ENUM_ENT(XCORE_SHF_DP_SECTION, "")
13220b57cec5SDimitry Andric };
13230b57cec5SDimitry Andric 
1324349cc55cSDimitry Andric const EnumEntry<unsigned> ElfARMSectionFlags[] = {
1325480093f4SDimitry Andric   ENUM_ENT(SHF_ARM_PURECODE, "y")
13260b57cec5SDimitry Andric };
13270b57cec5SDimitry Andric 
1328349cc55cSDimitry Andric const EnumEntry<unsigned> ElfHexagonSectionFlags[] = {
1329480093f4SDimitry Andric   ENUM_ENT(SHF_HEX_GPREL, "")
13300b57cec5SDimitry Andric };
13310b57cec5SDimitry Andric 
1332349cc55cSDimitry Andric const EnumEntry<unsigned> ElfMipsSectionFlags[] = {
1333480093f4SDimitry Andric   ENUM_ENT(SHF_MIPS_NODUPES, ""),
1334480093f4SDimitry Andric   ENUM_ENT(SHF_MIPS_NAMES,   ""),
1335480093f4SDimitry Andric   ENUM_ENT(SHF_MIPS_LOCAL,   ""),
1336480093f4SDimitry Andric   ENUM_ENT(SHF_MIPS_NOSTRIP, ""),
1337480093f4SDimitry Andric   ENUM_ENT(SHF_MIPS_GPREL,   ""),
1338480093f4SDimitry Andric   ENUM_ENT(SHF_MIPS_MERGE,   ""),
1339480093f4SDimitry Andric   ENUM_ENT(SHF_MIPS_ADDR,    ""),
1340480093f4SDimitry Andric   ENUM_ENT(SHF_MIPS_STRING,  "")
13410b57cec5SDimitry Andric };
13420b57cec5SDimitry Andric 
1343349cc55cSDimitry Andric const EnumEntry<unsigned> ElfX86_64SectionFlags[] = {
1344480093f4SDimitry Andric   ENUM_ENT(SHF_X86_64_LARGE, "l")
13450b57cec5SDimitry Andric };
13460b57cec5SDimitry Andric 
1347480093f4SDimitry Andric static std::vector<EnumEntry<unsigned>>
getSectionFlagsForTarget(unsigned EOSAbi,unsigned EMachine)134881ad6265SDimitry Andric getSectionFlagsForTarget(unsigned EOSAbi, unsigned EMachine) {
1349480093f4SDimitry Andric   std::vector<EnumEntry<unsigned>> Ret(std::begin(ElfSectionFlags),
1350480093f4SDimitry Andric                                        std::end(ElfSectionFlags));
135181ad6265SDimitry Andric   switch (EOSAbi) {
135281ad6265SDimitry Andric   case ELFOSABI_SOLARIS:
135381ad6265SDimitry Andric     Ret.insert(Ret.end(), std::begin(ElfSolarisSectionFlags),
135481ad6265SDimitry Andric                std::end(ElfSolarisSectionFlags));
135581ad6265SDimitry Andric     break;
135681ad6265SDimitry Andric   default:
135781ad6265SDimitry Andric     Ret.insert(Ret.end(), std::begin(ElfGNUSectionFlags),
135881ad6265SDimitry Andric                std::end(ElfGNUSectionFlags));
135981ad6265SDimitry Andric     break;
136081ad6265SDimitry Andric   }
1361480093f4SDimitry Andric   switch (EMachine) {
1362480093f4SDimitry Andric   case EM_ARM:
1363480093f4SDimitry Andric     Ret.insert(Ret.end(), std::begin(ElfARMSectionFlags),
1364480093f4SDimitry Andric                std::end(ElfARMSectionFlags));
1365480093f4SDimitry Andric     break;
1366480093f4SDimitry Andric   case EM_HEXAGON:
1367480093f4SDimitry Andric     Ret.insert(Ret.end(), std::begin(ElfHexagonSectionFlags),
1368480093f4SDimitry Andric                std::end(ElfHexagonSectionFlags));
1369480093f4SDimitry Andric     break;
1370480093f4SDimitry Andric   case EM_MIPS:
1371480093f4SDimitry Andric     Ret.insert(Ret.end(), std::begin(ElfMipsSectionFlags),
1372480093f4SDimitry Andric                std::end(ElfMipsSectionFlags));
1373480093f4SDimitry Andric     break;
1374480093f4SDimitry Andric   case EM_X86_64:
1375480093f4SDimitry Andric     Ret.insert(Ret.end(), std::begin(ElfX86_64SectionFlags),
1376480093f4SDimitry Andric                std::end(ElfX86_64SectionFlags));
1377480093f4SDimitry Andric     break;
1378480093f4SDimitry Andric   case EM_XCORE:
1379480093f4SDimitry Andric     Ret.insert(Ret.end(), std::begin(ElfXCoreSectionFlags),
1380480093f4SDimitry Andric                std::end(ElfXCoreSectionFlags));
13810b57cec5SDimitry Andric     break;
13820b57cec5SDimitry Andric   default:
1383480093f4SDimitry Andric     break;
1384480093f4SDimitry Andric   }
1385480093f4SDimitry Andric   return Ret;
1386480093f4SDimitry Andric }
1387480093f4SDimitry Andric 
getGNUFlags(unsigned EOSAbi,unsigned EMachine,uint64_t Flags)138881ad6265SDimitry Andric static std::string getGNUFlags(unsigned EOSAbi, unsigned EMachine,
138981ad6265SDimitry Andric                                uint64_t Flags) {
1390480093f4SDimitry Andric   // Here we are trying to build the flags string in the same way as GNU does.
1391480093f4SDimitry Andric   // It is not that straightforward. Imagine we have sh_flags == 0x90000000.
1392480093f4SDimitry Andric   // SHF_EXCLUDE ("E") has a value of 0x80000000 and SHF_MASKPROC is 0xf0000000.
1393480093f4SDimitry Andric   // GNU readelf will not print "E" or "Ep" in this case, but will print just
1394480093f4SDimitry Andric   // "p". It only will print "E" when no other processor flag is set.
1395480093f4SDimitry Andric   std::string Str;
1396480093f4SDimitry Andric   bool HasUnknownFlag = false;
1397480093f4SDimitry Andric   bool HasOSFlag = false;
1398480093f4SDimitry Andric   bool HasProcFlag = false;
1399480093f4SDimitry Andric   std::vector<EnumEntry<unsigned>> FlagsList =
140081ad6265SDimitry Andric       getSectionFlagsForTarget(EOSAbi, EMachine);
1401480093f4SDimitry Andric   while (Flags) {
1402480093f4SDimitry Andric     // Take the least significant bit as a flag.
1403480093f4SDimitry Andric     uint64_t Flag = Flags & -Flags;
1404480093f4SDimitry Andric     Flags -= Flag;
1405480093f4SDimitry Andric 
1406480093f4SDimitry Andric     // Find the flag in the known flags list.
1407480093f4SDimitry Andric     auto I = llvm::find_if(FlagsList, [=](const EnumEntry<unsigned> &E) {
1408480093f4SDimitry Andric       // Flags with empty names are not printed in GNU style output.
1409480093f4SDimitry Andric       return E.Value == Flag && !E.AltName.empty();
1410480093f4SDimitry Andric     });
1411480093f4SDimitry Andric     if (I != FlagsList.end()) {
1412480093f4SDimitry Andric       Str += I->AltName;
1413480093f4SDimitry Andric       continue;
1414480093f4SDimitry Andric     }
1415480093f4SDimitry Andric 
1416480093f4SDimitry Andric     // If we did not find a matching regular flag, then we deal with an OS
1417480093f4SDimitry Andric     // specific flag, processor specific flag or an unknown flag.
1418480093f4SDimitry Andric     if (Flag & ELF::SHF_MASKOS) {
1419480093f4SDimitry Andric       HasOSFlag = true;
1420480093f4SDimitry Andric       Flags &= ~ELF::SHF_MASKOS;
1421480093f4SDimitry Andric     } else if (Flag & ELF::SHF_MASKPROC) {
1422480093f4SDimitry Andric       HasProcFlag = true;
1423480093f4SDimitry Andric       // Mask off all the processor-specific bits. This removes the SHF_EXCLUDE
1424480093f4SDimitry Andric       // bit if set so that it doesn't also get printed.
1425480093f4SDimitry Andric       Flags &= ~ELF::SHF_MASKPROC;
1426480093f4SDimitry Andric     } else {
1427480093f4SDimitry Andric       HasUnknownFlag = true;
1428480093f4SDimitry Andric     }
1429480093f4SDimitry Andric   }
1430480093f4SDimitry Andric 
1431480093f4SDimitry Andric   // "o", "p" and "x" are printed last.
1432480093f4SDimitry Andric   if (HasOSFlag)
14330b57cec5SDimitry Andric     Str += "o";
1434480093f4SDimitry Andric   if (HasProcFlag)
14350b57cec5SDimitry Andric     Str += "p";
1436480093f4SDimitry Andric   if (HasUnknownFlag)
14370b57cec5SDimitry Andric     Str += "x";
14380b57cec5SDimitry Andric   return Str;
14390b57cec5SDimitry Andric }
14400b57cec5SDimitry Andric 
segmentTypeToString(unsigned Arch,unsigned Type)1441e8d8bef9SDimitry Andric static StringRef segmentTypeToString(unsigned Arch, unsigned Type) {
1442e8d8bef9SDimitry Andric   // Check potentially overlapped processor-specific program header type.
14430b57cec5SDimitry Andric   switch (Arch) {
14440b57cec5SDimitry Andric   case ELF::EM_ARM:
14450b57cec5SDimitry Andric     switch (Type) { LLVM_READOBJ_ENUM_CASE(ELF, PT_ARM_EXIDX); }
14460b57cec5SDimitry Andric     break;
14470b57cec5SDimitry Andric   case ELF::EM_MIPS:
14480b57cec5SDimitry Andric   case ELF::EM_MIPS_RS3_LE:
14490b57cec5SDimitry Andric     switch (Type) {
14500b57cec5SDimitry Andric       LLVM_READOBJ_ENUM_CASE(ELF, PT_MIPS_REGINFO);
14510b57cec5SDimitry Andric       LLVM_READOBJ_ENUM_CASE(ELF, PT_MIPS_RTPROC);
14520b57cec5SDimitry Andric       LLVM_READOBJ_ENUM_CASE(ELF, PT_MIPS_OPTIONS);
14530b57cec5SDimitry Andric       LLVM_READOBJ_ENUM_CASE(ELF, PT_MIPS_ABIFLAGS);
14540b57cec5SDimitry Andric     }
14550b57cec5SDimitry Andric     break;
145681ad6265SDimitry Andric   case ELF::EM_RISCV:
145781ad6265SDimitry Andric     switch (Type) { LLVM_READOBJ_ENUM_CASE(ELF, PT_RISCV_ATTRIBUTES); }
14580b57cec5SDimitry Andric   }
14590b57cec5SDimitry Andric 
14600b57cec5SDimitry Andric   switch (Type) {
14610b57cec5SDimitry Andric     LLVM_READOBJ_ENUM_CASE(ELF, PT_NULL);
14620b57cec5SDimitry Andric     LLVM_READOBJ_ENUM_CASE(ELF, PT_LOAD);
14630b57cec5SDimitry Andric     LLVM_READOBJ_ENUM_CASE(ELF, PT_DYNAMIC);
14640b57cec5SDimitry Andric     LLVM_READOBJ_ENUM_CASE(ELF, PT_INTERP);
14650b57cec5SDimitry Andric     LLVM_READOBJ_ENUM_CASE(ELF, PT_NOTE);
14660b57cec5SDimitry Andric     LLVM_READOBJ_ENUM_CASE(ELF, PT_SHLIB);
14670b57cec5SDimitry Andric     LLVM_READOBJ_ENUM_CASE(ELF, PT_PHDR);
14680b57cec5SDimitry Andric     LLVM_READOBJ_ENUM_CASE(ELF, PT_TLS);
14690b57cec5SDimitry Andric 
14700b57cec5SDimitry Andric     LLVM_READOBJ_ENUM_CASE(ELF, PT_GNU_EH_FRAME);
14710b57cec5SDimitry Andric     LLVM_READOBJ_ENUM_CASE(ELF, PT_SUNW_UNWIND);
14720b57cec5SDimitry Andric 
14730b57cec5SDimitry Andric     LLVM_READOBJ_ENUM_CASE(ELF, PT_GNU_STACK);
14740b57cec5SDimitry Andric     LLVM_READOBJ_ENUM_CASE(ELF, PT_GNU_RELRO);
1475480093f4SDimitry Andric     LLVM_READOBJ_ENUM_CASE(ELF, PT_GNU_PROPERTY);
14760b57cec5SDimitry Andric 
1477bdd1243dSDimitry Andric     LLVM_READOBJ_ENUM_CASE(ELF, PT_OPENBSD_MUTABLE);
14780b57cec5SDimitry Andric     LLVM_READOBJ_ENUM_CASE(ELF, PT_OPENBSD_RANDOMIZE);
14790b57cec5SDimitry Andric     LLVM_READOBJ_ENUM_CASE(ELF, PT_OPENBSD_WXNEEDED);
14805f757f3fSDimitry Andric     LLVM_READOBJ_ENUM_CASE(ELF, PT_OPENBSD_NOBTCFI);
148156727255SDimitry Andric     LLVM_READOBJ_ENUM_CASE(ELF, PT_OPENBSD_SYSCALLS);
14820b57cec5SDimitry Andric     LLVM_READOBJ_ENUM_CASE(ELF, PT_OPENBSD_BOOTDATA);
14830b57cec5SDimitry Andric   default:
14840b57cec5SDimitry Andric     return "";
14850b57cec5SDimitry Andric   }
14860b57cec5SDimitry Andric }
14870b57cec5SDimitry Andric 
getGNUPtType(unsigned Arch,unsigned Type)1488e8d8bef9SDimitry Andric static std::string getGNUPtType(unsigned Arch, unsigned Type) {
1489e8d8bef9SDimitry Andric   StringRef Seg = segmentTypeToString(Arch, Type);
1490e8d8bef9SDimitry Andric   if (Seg.empty())
14910b57cec5SDimitry Andric     return std::string("<unknown>: ") + to_string(format_hex(Type, 1));
1492e8d8bef9SDimitry Andric 
1493e8d8bef9SDimitry Andric   // E.g. "PT_ARM_EXIDX" -> "EXIDX".
149481ad6265SDimitry Andric   if (Seg.consume_front("PT_ARM_"))
149581ad6265SDimitry Andric     return Seg.str();
1496e8d8bef9SDimitry Andric 
1497e8d8bef9SDimitry Andric   // E.g. "PT_MIPS_REGINFO" -> "REGINFO".
149881ad6265SDimitry Andric   if (Seg.consume_front("PT_MIPS_"))
149981ad6265SDimitry Andric     return Seg.str();
150081ad6265SDimitry Andric 
150181ad6265SDimitry Andric   // E.g. "PT_RISCV_ATTRIBUTES"
150281ad6265SDimitry Andric   if (Seg.consume_front("PT_RISCV_"))
150381ad6265SDimitry Andric     return Seg.str();
1504e8d8bef9SDimitry Andric 
1505e8d8bef9SDimitry Andric   // E.g. "PT_LOAD" -> "LOAD".
15065f757f3fSDimitry Andric   assert(Seg.starts_with("PT_"));
1507e8d8bef9SDimitry Andric   return Seg.drop_front(3).str();
15080b57cec5SDimitry Andric }
15090b57cec5SDimitry Andric 
1510349cc55cSDimitry Andric const EnumEntry<unsigned> ElfSegmentFlags[] = {
15110b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, PF_X),
15120b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, PF_W),
15130b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, PF_R)
15140b57cec5SDimitry Andric };
15150b57cec5SDimitry Andric 
1516349cc55cSDimitry Andric const EnumEntry<unsigned> ElfHeaderMipsFlags[] = {
15170b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_NOREORDER, "noreorder"),
15180b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_PIC, "pic"),
15190b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_CPIC, "cpic"),
15200b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_ABI2, "abi2"),
15210b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_32BITMODE, "32bitmode"),
15220b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_FP64, "fp64"),
15230b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_NAN2008, "nan2008"),
15240b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_ABI_O32, "o32"),
15250b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_ABI_O64, "o64"),
15260b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_ABI_EABI32, "eabi32"),
15270b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_ABI_EABI64, "eabi64"),
15280b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_MACH_3900, "3900"),
15290b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_MACH_4010, "4010"),
15300b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_MACH_4100, "4100"),
15310b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_MACH_4650, "4650"),
15320b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_MACH_4120, "4120"),
15330b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_MACH_4111, "4111"),
15340b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_MACH_SB1, "sb1"),
15350b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_MACH_OCTEON, "octeon"),
15360b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_MACH_XLR, "xlr"),
15370b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_MACH_OCTEON2, "octeon2"),
15380b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_MACH_OCTEON3, "octeon3"),
15390b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_MACH_5400, "5400"),
15400b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_MACH_5900, "5900"),
15410b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_MACH_5500, "5500"),
15420b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_MACH_9000, "9000"),
15430b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_MACH_LS2E, "loongson-2e"),
15440b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_MACH_LS2F, "loongson-2f"),
15450b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_MACH_LS3A, "loongson-3a"),
15460b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_MICROMIPS, "micromips"),
15470b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_ARCH_ASE_M16, "mips16"),
15480b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_ARCH_ASE_MDMX, "mdmx"),
15490b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_ARCH_1, "mips1"),
15500b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_ARCH_2, "mips2"),
15510b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_ARCH_3, "mips3"),
15520b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_ARCH_4, "mips4"),
15530b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_ARCH_5, "mips5"),
15540b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_ARCH_32, "mips32"),
15550b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_ARCH_64, "mips64"),
15560b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_ARCH_32R2, "mips32r2"),
15570b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_ARCH_64R2, "mips64r2"),
15580b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_ARCH_32R6, "mips32r6"),
15590b57cec5SDimitry Andric   ENUM_ENT(EF_MIPS_ARCH_64R6, "mips64r6")
15600b57cec5SDimitry Andric };
15610b57cec5SDimitry Andric 
1562349cc55cSDimitry Andric const EnumEntry<unsigned> ElfHeaderAMDGPUFlagsABIVersion3[] = {
1563cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_NONE, "none"),
1564cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_R600, "r600"),
1565cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_R630, "r630"),
1566cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_RS880, "rs880"),
1567cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_RV670, "rv670"),
1568cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_RV710, "rv710"),
1569cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_RV730, "rv730"),
1570cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_RV770, "rv770"),
1571cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_CEDAR, "cedar"),
1572cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_CYPRESS, "cypress"),
1573cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_JUNIPER, "juniper"),
1574cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_REDWOOD, "redwood"),
1575cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_SUMO, "sumo"),
1576cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_BARTS, "barts"),
1577cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_CAICOS, "caicos"),
1578cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_CAYMAN, "cayman"),
1579cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_TURKS, "turks"),
1580cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX600, "gfx600"),
1581cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX601, "gfx601"),
1582cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX602, "gfx602"),
1583cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX700, "gfx700"),
1584cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX701, "gfx701"),
1585cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX702, "gfx702"),
1586cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX703, "gfx703"),
1587cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX704, "gfx704"),
1588cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX705, "gfx705"),
1589cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX801, "gfx801"),
1590cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX802, "gfx802"),
1591cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX803, "gfx803"),
1592cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX805, "gfx805"),
1593cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX810, "gfx810"),
1594cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX900, "gfx900"),
1595cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX902, "gfx902"),
1596cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX904, "gfx904"),
1597cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX906, "gfx906"),
1598cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX908, "gfx908"),
1599cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX909, "gfx909"),
1600cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX90A, "gfx90a"),
1601cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX90C, "gfx90c"),
1602cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX940, "gfx940"),
1603cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX941, "gfx941"),
1604cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX942, "gfx942"),
1605cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1010, "gfx1010"),
1606cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1011, "gfx1011"),
1607cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1012, "gfx1012"),
1608cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1013, "gfx1013"),
1609cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1030, "gfx1030"),
1610cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1031, "gfx1031"),
1611cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1032, "gfx1032"),
1612cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1033, "gfx1033"),
1613cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1034, "gfx1034"),
1614cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1035, "gfx1035"),
1615cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1036, "gfx1036"),
1616cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1100, "gfx1100"),
1617cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1101, "gfx1101"),
1618cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1102, "gfx1102"),
1619cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1103, "gfx1103"),
1620cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1150, "gfx1150"),
1621cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1151, "gfx1151"),
1622cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1200, "gfx1200"),
1623cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1201, "gfx1201"),
1624cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_FEATURE_XNACK_V3, "xnack"),
1625cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_FEATURE_SRAMECC_V3, "sramecc"),
1626fe6060f1SDimitry Andric };
1627fe6060f1SDimitry Andric 
1628349cc55cSDimitry Andric const EnumEntry<unsigned> ElfHeaderAMDGPUFlagsABIVersion4[] = {
1629cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_NONE, "none"),
1630cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_R600, "r600"),
1631cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_R630, "r630"),
1632cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_RS880, "rs880"),
1633cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_RV670, "rv670"),
1634cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_RV710, "rv710"),
1635cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_RV730, "rv730"),
1636cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_RV770, "rv770"),
1637cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_CEDAR, "cedar"),
1638cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_CYPRESS, "cypress"),
1639cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_JUNIPER, "juniper"),
1640cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_REDWOOD, "redwood"),
1641cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_SUMO, "sumo"),
1642cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_BARTS, "barts"),
1643cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_CAICOS, "caicos"),
1644cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_CAYMAN, "cayman"),
1645cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_R600_TURKS, "turks"),
1646cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX600, "gfx600"),
1647cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX601, "gfx601"),
1648cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX602, "gfx602"),
1649cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX700, "gfx700"),
1650cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX701, "gfx701"),
1651cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX702, "gfx702"),
1652cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX703, "gfx703"),
1653cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX704, "gfx704"),
1654cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX705, "gfx705"),
1655cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX801, "gfx801"),
1656cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX802, "gfx802"),
1657cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX803, "gfx803"),
1658cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX805, "gfx805"),
1659cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX810, "gfx810"),
1660cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX900, "gfx900"),
1661cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX902, "gfx902"),
1662cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX904, "gfx904"),
1663cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX906, "gfx906"),
1664cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX908, "gfx908"),
1665cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX909, "gfx909"),
1666cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX90A, "gfx90a"),
1667cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX90C, "gfx90c"),
1668cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX940, "gfx940"),
1669cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX941, "gfx941"),
1670cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX942, "gfx942"),
1671cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1010, "gfx1010"),
1672cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1011, "gfx1011"),
1673cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1012, "gfx1012"),
1674cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1013, "gfx1013"),
1675cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1030, "gfx1030"),
1676cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1031, "gfx1031"),
1677cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1032, "gfx1032"),
1678cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1033, "gfx1033"),
1679cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1034, "gfx1034"),
1680cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1035, "gfx1035"),
1681cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1036, "gfx1036"),
1682cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1100, "gfx1100"),
1683cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1101, "gfx1101"),
1684cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1102, "gfx1102"),
1685cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1103, "gfx1103"),
1686cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1150, "gfx1150"),
1687cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1151, "gfx1151"),
1688cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1200, "gfx1200"),
1689cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_MACH_AMDGCN_GFX1201, "gfx1201"),
1690cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_FEATURE_XNACK_ANY_V4, "xnack"),
1691cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_FEATURE_XNACK_OFF_V4, "xnack-"),
1692cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_FEATURE_XNACK_ON_V4, "xnack+"),
1693cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_FEATURE_SRAMECC_ANY_V4, "sramecc"),
1694cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_FEATURE_SRAMECC_OFF_V4, "sramecc-"),
1695cb14a3feSDimitry Andric     ENUM_ENT(EF_AMDGPU_FEATURE_SRAMECC_ON_V4, "sramecc+"),
16965f757f3fSDimitry Andric };
16975f757f3fSDimitry Andric 
16985f757f3fSDimitry Andric const EnumEntry<unsigned> ElfHeaderNVPTXFlags[] = {
16995f757f3fSDimitry Andric     ENUM_ENT(EF_CUDA_SM20, "sm_20"), ENUM_ENT(EF_CUDA_SM21, "sm_21"),
17005f757f3fSDimitry Andric     ENUM_ENT(EF_CUDA_SM30, "sm_30"), ENUM_ENT(EF_CUDA_SM32, "sm_32"),
17015f757f3fSDimitry Andric     ENUM_ENT(EF_CUDA_SM35, "sm_35"), ENUM_ENT(EF_CUDA_SM37, "sm_37"),
17025f757f3fSDimitry Andric     ENUM_ENT(EF_CUDA_SM50, "sm_50"), ENUM_ENT(EF_CUDA_SM52, "sm_52"),
17035f757f3fSDimitry Andric     ENUM_ENT(EF_CUDA_SM53, "sm_53"), ENUM_ENT(EF_CUDA_SM60, "sm_60"),
17045f757f3fSDimitry Andric     ENUM_ENT(EF_CUDA_SM61, "sm_61"), ENUM_ENT(EF_CUDA_SM62, "sm_62"),
17055f757f3fSDimitry Andric     ENUM_ENT(EF_CUDA_SM70, "sm_70"), ENUM_ENT(EF_CUDA_SM72, "sm_72"),
17065f757f3fSDimitry Andric     ENUM_ENT(EF_CUDA_SM75, "sm_75"), ENUM_ENT(EF_CUDA_SM80, "sm_80"),
17075f757f3fSDimitry Andric     ENUM_ENT(EF_CUDA_SM86, "sm_86"), ENUM_ENT(EF_CUDA_SM87, "sm_87"),
17085f757f3fSDimitry Andric     ENUM_ENT(EF_CUDA_SM89, "sm_89"), ENUM_ENT(EF_CUDA_SM90, "sm_90"),
17090b57cec5SDimitry Andric };
17100b57cec5SDimitry Andric 
1711349cc55cSDimitry Andric const EnumEntry<unsigned> ElfHeaderRISCVFlags[] = {
17120b57cec5SDimitry Andric   ENUM_ENT(EF_RISCV_RVC, "RVC"),
17130b57cec5SDimitry Andric   ENUM_ENT(EF_RISCV_FLOAT_ABI_SINGLE, "single-float ABI"),
17140b57cec5SDimitry Andric   ENUM_ENT(EF_RISCV_FLOAT_ABI_DOUBLE, "double-float ABI"),
17150b57cec5SDimitry Andric   ENUM_ENT(EF_RISCV_FLOAT_ABI_QUAD, "quad-float ABI"),
171604eeddc0SDimitry Andric   ENUM_ENT(EF_RISCV_RVE, "RVE"),
171704eeddc0SDimitry Andric   ENUM_ENT(EF_RISCV_TSO, "TSO"),
17180b57cec5SDimitry Andric };
17190b57cec5SDimitry Andric 
1720349cc55cSDimitry Andric const EnumEntry<unsigned> ElfHeaderAVRFlags[] = {
1721fe6060f1SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, EF_AVR_ARCH_AVR1),
1722fe6060f1SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, EF_AVR_ARCH_AVR2),
1723fe6060f1SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, EF_AVR_ARCH_AVR25),
1724fe6060f1SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, EF_AVR_ARCH_AVR3),
1725fe6060f1SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, EF_AVR_ARCH_AVR31),
1726fe6060f1SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, EF_AVR_ARCH_AVR35),
1727fe6060f1SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, EF_AVR_ARCH_AVR4),
1728fe6060f1SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, EF_AVR_ARCH_AVR5),
1729fe6060f1SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, EF_AVR_ARCH_AVR51),
1730fe6060f1SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, EF_AVR_ARCH_AVR6),
1731fe6060f1SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, EF_AVR_ARCH_AVRTINY),
1732fe6060f1SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, EF_AVR_ARCH_XMEGA1),
1733fe6060f1SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, EF_AVR_ARCH_XMEGA2),
1734fe6060f1SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, EF_AVR_ARCH_XMEGA3),
1735fe6060f1SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, EF_AVR_ARCH_XMEGA4),
1736fe6060f1SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, EF_AVR_ARCH_XMEGA5),
1737fe6060f1SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, EF_AVR_ARCH_XMEGA6),
1738fe6060f1SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, EF_AVR_ARCH_XMEGA7),
1739fe6060f1SDimitry Andric   ENUM_ENT(EF_AVR_LINKRELAX_PREPARED, "relaxable"),
1740fe6060f1SDimitry Andric };
1741fe6060f1SDimitry Andric 
1742972a253aSDimitry Andric const EnumEntry<unsigned> ElfHeaderLoongArchFlags[] = {
1743bdd1243dSDimitry Andric   ENUM_ENT(EF_LOONGARCH_ABI_SOFT_FLOAT, "SOFT-FLOAT"),
1744bdd1243dSDimitry Andric   ENUM_ENT(EF_LOONGARCH_ABI_SINGLE_FLOAT, "SINGLE-FLOAT"),
1745bdd1243dSDimitry Andric   ENUM_ENT(EF_LOONGARCH_ABI_DOUBLE_FLOAT, "DOUBLE-FLOAT"),
1746bdd1243dSDimitry Andric   ENUM_ENT(EF_LOONGARCH_OBJABI_V0, "OBJ-v0"),
1747bdd1243dSDimitry Andric   ENUM_ENT(EF_LOONGARCH_OBJABI_V1, "OBJ-v1"),
1748972a253aSDimitry Andric };
1749972a253aSDimitry Andric 
1750bdd1243dSDimitry Andric static const EnumEntry<unsigned> ElfHeaderXtensaFlags[] = {
1751bdd1243dSDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, EF_XTENSA_MACH_NONE),
1752bdd1243dSDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, EF_XTENSA_XT_INSN),
1753bdd1243dSDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, EF_XTENSA_XT_LIT)
1754bdd1243dSDimitry Andric };
1755fe6060f1SDimitry Andric 
1756349cc55cSDimitry Andric const EnumEntry<unsigned> ElfSymOtherFlags[] = {
17570b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, STV_INTERNAL),
17580b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, STV_HIDDEN),
17590b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, STV_PROTECTED)
17600b57cec5SDimitry Andric };
17610b57cec5SDimitry Andric 
1762349cc55cSDimitry Andric const EnumEntry<unsigned> ElfMipsSymOtherFlags[] = {
17630b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_OPTIONAL),
17640b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_PLT),
17650b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_PIC),
17660b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_MICROMIPS)
17670b57cec5SDimitry Andric };
17680b57cec5SDimitry Andric 
1769349cc55cSDimitry Andric const EnumEntry<unsigned> ElfAArch64SymOtherFlags[] = {
1770e8d8bef9SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, STO_AARCH64_VARIANT_PCS)
1771e8d8bef9SDimitry Andric };
1772e8d8bef9SDimitry Andric 
1773349cc55cSDimitry Andric const EnumEntry<unsigned> ElfMips16SymOtherFlags[] = {
17740b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_OPTIONAL),
17750b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_PLT),
17760b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_ENT(ELF, STO_MIPS_MIPS16)
17770b57cec5SDimitry Andric };
17780b57cec5SDimitry Andric 
1779349cc55cSDimitry Andric const EnumEntry<unsigned> ElfRISCVSymOtherFlags[] = {
1780349cc55cSDimitry Andric     LLVM_READOBJ_ENUM_ENT(ELF, STO_RISCV_VARIANT_CC)};
1781349cc55cSDimitry Andric 
getElfMipsOptionsOdkType(unsigned Odk)17820b57cec5SDimitry Andric static const char *getElfMipsOptionsOdkType(unsigned Odk) {
17830b57cec5SDimitry Andric   switch (Odk) {
17840b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_CASE(ELF, ODK_NULL);
17850b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_CASE(ELF, ODK_REGINFO);
17860b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_CASE(ELF, ODK_EXCEPTIONS);
17870b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_CASE(ELF, ODK_PAD);
17880b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_CASE(ELF, ODK_HWPATCH);
17890b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_CASE(ELF, ODK_FILL);
17900b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_CASE(ELF, ODK_TAGS);
17910b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_CASE(ELF, ODK_HWAND);
17920b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_CASE(ELF, ODK_HWOR);
17930b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_CASE(ELF, ODK_GP_GROUP);
17940b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_CASE(ELF, ODK_IDENT);
17950b57cec5SDimitry Andric   LLVM_READOBJ_ENUM_CASE(ELF, ODK_PAGESIZE);
17960b57cec5SDimitry Andric   default:
17970b57cec5SDimitry Andric     return "Unknown";
17980b57cec5SDimitry Andric   }
17990b57cec5SDimitry Andric }
18000b57cec5SDimitry Andric 
18010b57cec5SDimitry Andric template <typename ELFT>
18028bcb0991SDimitry Andric std::pair<const typename ELFT::Phdr *, const typename ELFT::Shdr *>
findDynamic()1803e8d8bef9SDimitry Andric ELFDumper<ELFT>::findDynamic() {
18040b57cec5SDimitry Andric   // Try to locate the PT_DYNAMIC header.
18050b57cec5SDimitry Andric   const Elf_Phdr *DynamicPhdr = nullptr;
1806e8d8bef9SDimitry Andric   if (Expected<ArrayRef<Elf_Phdr>> PhdrsOrErr = Obj.program_headers()) {
18075ffd83dbSDimitry Andric     for (const Elf_Phdr &Phdr : *PhdrsOrErr) {
18080b57cec5SDimitry Andric       if (Phdr.p_type != ELF::PT_DYNAMIC)
18090b57cec5SDimitry Andric         continue;
18100b57cec5SDimitry Andric       DynamicPhdr = &Phdr;
18110b57cec5SDimitry Andric       break;
18120b57cec5SDimitry Andric     }
18135ffd83dbSDimitry Andric   } else {
1814e8d8bef9SDimitry Andric     reportUniqueWarning(
18155ffd83dbSDimitry Andric         "unable to read program headers to locate the PT_DYNAMIC segment: " +
1816e8d8bef9SDimitry Andric         toString(PhdrsOrErr.takeError()));
18175ffd83dbSDimitry Andric   }
18180b57cec5SDimitry Andric 
18190b57cec5SDimitry Andric   // Try to locate the .dynamic section in the sections header table.
18200b57cec5SDimitry Andric   const Elf_Shdr *DynamicSec = nullptr;
1821e8d8bef9SDimitry Andric   for (const Elf_Shdr &Sec : cantFail(Obj.sections())) {
18220b57cec5SDimitry Andric     if (Sec.sh_type != ELF::SHT_DYNAMIC)
18230b57cec5SDimitry Andric       continue;
18240b57cec5SDimitry Andric     DynamicSec = &Sec;
18250b57cec5SDimitry Andric     break;
18260b57cec5SDimitry Andric   }
18270b57cec5SDimitry Andric 
1828e8d8bef9SDimitry Andric   if (DynamicPhdr && ((DynamicPhdr->p_offset + DynamicPhdr->p_filesz >
1829e8d8bef9SDimitry Andric                        ObjF.getMemoryBufferRef().getBufferSize()) ||
1830e8d8bef9SDimitry Andric                       (DynamicPhdr->p_offset + DynamicPhdr->p_filesz <
1831e8d8bef9SDimitry Andric                        DynamicPhdr->p_offset))) {
1832e8d8bef9SDimitry Andric     reportUniqueWarning(
1833e8d8bef9SDimitry Andric         "PT_DYNAMIC segment offset (0x" +
1834e8d8bef9SDimitry Andric         Twine::utohexstr(DynamicPhdr->p_offset) + ") + file size (0x" +
1835e8d8bef9SDimitry Andric         Twine::utohexstr(DynamicPhdr->p_filesz) +
1836e8d8bef9SDimitry Andric         ") exceeds the size of the file (0x" +
1837e8d8bef9SDimitry Andric         Twine::utohexstr(ObjF.getMemoryBufferRef().getBufferSize()) + ")");
18388bcb0991SDimitry Andric     // Don't use the broken dynamic header.
18398bcb0991SDimitry Andric     DynamicPhdr = nullptr;
18400b57cec5SDimitry Andric   }
18410b57cec5SDimitry Andric 
18428bcb0991SDimitry Andric   if (DynamicPhdr && DynamicSec) {
18430b57cec5SDimitry Andric     if (DynamicSec->sh_addr + DynamicSec->sh_size >
18440b57cec5SDimitry Andric             DynamicPhdr->p_vaddr + DynamicPhdr->p_memsz ||
18450b57cec5SDimitry Andric         DynamicSec->sh_addr < DynamicPhdr->p_vaddr)
1846e8d8bef9SDimitry Andric       reportUniqueWarning(describe(*DynamicSec) +
1847e8d8bef9SDimitry Andric                           " is not contained within the "
1848e8d8bef9SDimitry Andric                           "PT_DYNAMIC segment");
18490b57cec5SDimitry Andric 
18500b57cec5SDimitry Andric     if (DynamicSec->sh_addr != DynamicPhdr->p_vaddr)
1851e8d8bef9SDimitry Andric       reportUniqueWarning(describe(*DynamicSec) + " is not at the start of "
1852e8d8bef9SDimitry Andric                                                   "PT_DYNAMIC segment");
18538bcb0991SDimitry Andric   }
18548bcb0991SDimitry Andric 
18558bcb0991SDimitry Andric   return std::make_pair(DynamicPhdr, DynamicSec);
18568bcb0991SDimitry Andric }
18578bcb0991SDimitry Andric 
18588bcb0991SDimitry Andric template <typename ELFT>
loadDynamicTable()1859e8d8bef9SDimitry Andric void ELFDumper<ELFT>::loadDynamicTable() {
18608bcb0991SDimitry Andric   const Elf_Phdr *DynamicPhdr;
18618bcb0991SDimitry Andric   const Elf_Shdr *DynamicSec;
1862e8d8bef9SDimitry Andric   std::tie(DynamicPhdr, DynamicSec) = findDynamic();
18638bcb0991SDimitry Andric   if (!DynamicPhdr && !DynamicSec)
18648bcb0991SDimitry Andric     return;
18658bcb0991SDimitry Andric 
1866e8d8bef9SDimitry Andric   DynRegionInfo FromPhdr(ObjF, *this);
18678bcb0991SDimitry Andric   bool IsPhdrTableValid = false;
18688bcb0991SDimitry Andric   if (DynamicPhdr) {
1869e8d8bef9SDimitry Andric     // Use cantFail(), because p_offset/p_filesz fields of a PT_DYNAMIC are
1870e8d8bef9SDimitry Andric     // validated in findDynamic() and so createDRI() is not expected to fail.
1871e8d8bef9SDimitry Andric     FromPhdr = cantFail(createDRI(DynamicPhdr->p_offset, DynamicPhdr->p_filesz,
1872e8d8bef9SDimitry Andric                                   sizeof(Elf_Dyn)));
18735ffd83dbSDimitry Andric     FromPhdr.SizePrintName = "PT_DYNAMIC size";
18745ffd83dbSDimitry Andric     FromPhdr.EntSizePrintName = "";
1875e8d8bef9SDimitry Andric     IsPhdrTableValid = !FromPhdr.template getAsArrayRef<Elf_Dyn>().empty();
18768bcb0991SDimitry Andric   }
18778bcb0991SDimitry Andric 
18788bcb0991SDimitry Andric   // Locate the dynamic table described in a section header.
18798bcb0991SDimitry Andric   // Ignore sh_entsize and use the expected value for entry size explicitly.
18808bcb0991SDimitry Andric   // This allows us to dump dynamic sections with a broken sh_entsize
18818bcb0991SDimitry Andric   // field.
1882e8d8bef9SDimitry Andric   DynRegionInfo FromSec(ObjF, *this);
18838bcb0991SDimitry Andric   bool IsSecTableValid = false;
18848bcb0991SDimitry Andric   if (DynamicSec) {
1885e8d8bef9SDimitry Andric     Expected<DynRegionInfo> RegOrErr =
1886e8d8bef9SDimitry Andric         createDRI(DynamicSec->sh_offset, DynamicSec->sh_size, sizeof(Elf_Dyn));
1887e8d8bef9SDimitry Andric     if (RegOrErr) {
1888e8d8bef9SDimitry Andric       FromSec = *RegOrErr;
1889e8d8bef9SDimitry Andric       FromSec.Context = describe(*DynamicSec);
18905ffd83dbSDimitry Andric       FromSec.EntSizePrintName = "";
1891e8d8bef9SDimitry Andric       IsSecTableValid = !FromSec.template getAsArrayRef<Elf_Dyn>().empty();
1892e8d8bef9SDimitry Andric     } else {
1893e8d8bef9SDimitry Andric       reportUniqueWarning("unable to read the dynamic table from " +
1894e8d8bef9SDimitry Andric                           describe(*DynamicSec) + ": " +
1895e8d8bef9SDimitry Andric                           toString(RegOrErr.takeError()));
1896e8d8bef9SDimitry Andric     }
18978bcb0991SDimitry Andric   }
18988bcb0991SDimitry Andric 
18998bcb0991SDimitry Andric   // When we only have information from one of the SHT_DYNAMIC section header or
19008bcb0991SDimitry Andric   // PT_DYNAMIC program header, just use that.
19018bcb0991SDimitry Andric   if (!DynamicPhdr || !DynamicSec) {
19028bcb0991SDimitry Andric     if ((DynamicPhdr && IsPhdrTableValid) || (DynamicSec && IsSecTableValid)) {
19038bcb0991SDimitry Andric       DynamicTable = DynamicPhdr ? FromPhdr : FromSec;
1904e8d8bef9SDimitry Andric       parseDynamicTable();
19058bcb0991SDimitry Andric     } else {
1906e8d8bef9SDimitry Andric       reportUniqueWarning("no valid dynamic table was found");
19078bcb0991SDimitry Andric     }
19088bcb0991SDimitry Andric     return;
19098bcb0991SDimitry Andric   }
19108bcb0991SDimitry Andric 
19118bcb0991SDimitry Andric   // At this point we have tables found from the section header and from the
19128bcb0991SDimitry Andric   // dynamic segment. Usually they match, but we have to do sanity checks to
19138bcb0991SDimitry Andric   // verify that.
19148bcb0991SDimitry Andric 
19158bcb0991SDimitry Andric   if (FromPhdr.Addr != FromSec.Addr)
1916e8d8bef9SDimitry Andric     reportUniqueWarning("SHT_DYNAMIC section header and PT_DYNAMIC "
19178bcb0991SDimitry Andric                         "program header disagree about "
1918e8d8bef9SDimitry Andric                         "the location of the dynamic table");
19198bcb0991SDimitry Andric 
19208bcb0991SDimitry Andric   if (!IsPhdrTableValid && !IsSecTableValid) {
1921e8d8bef9SDimitry Andric     reportUniqueWarning("no valid dynamic table was found");
19228bcb0991SDimitry Andric     return;
19238bcb0991SDimitry Andric   }
19248bcb0991SDimitry Andric 
1925e8d8bef9SDimitry Andric   // Information in the PT_DYNAMIC program header has priority over the
1926e8d8bef9SDimitry Andric   // information in a section header.
19278bcb0991SDimitry Andric   if (IsPhdrTableValid) {
19288bcb0991SDimitry Andric     if (!IsSecTableValid)
1929e8d8bef9SDimitry Andric       reportUniqueWarning(
1930e8d8bef9SDimitry Andric           "SHT_DYNAMIC dynamic table is invalid: PT_DYNAMIC will be used");
19318bcb0991SDimitry Andric     DynamicTable = FromPhdr;
19328bcb0991SDimitry Andric   } else {
1933e8d8bef9SDimitry Andric     reportUniqueWarning(
1934e8d8bef9SDimitry Andric         "PT_DYNAMIC dynamic table is invalid: SHT_DYNAMIC will be used");
19358bcb0991SDimitry Andric     DynamicTable = FromSec;
19368bcb0991SDimitry Andric   }
19378bcb0991SDimitry Andric 
1938e8d8bef9SDimitry Andric   parseDynamicTable();
19390b57cec5SDimitry Andric }
19400b57cec5SDimitry Andric 
19410b57cec5SDimitry Andric template <typename ELFT>
ELFDumper(const object::ELFObjectFile<ELFT> & O,ScopedPrinter & Writer)1942e8d8bef9SDimitry Andric ELFDumper<ELFT>::ELFDumper(const object::ELFObjectFile<ELFT> &O,
19430b57cec5SDimitry Andric                            ScopedPrinter &Writer)
1944e8d8bef9SDimitry Andric     : ObjDumper(Writer, O.getFileName()), ObjF(O), Obj(O.getELFFile()),
1945e8d8bef9SDimitry Andric       FileName(O.getFileName()), DynRelRegion(O, *this),
1946e8d8bef9SDimitry Andric       DynRelaRegion(O, *this), DynRelrRegion(O, *this),
1947e8d8bef9SDimitry Andric       DynPLTRelRegion(O, *this), DynSymTabShndxRegion(O, *this),
1948e8d8bef9SDimitry Andric       DynamicTable(O, *this) {
1949e8d8bef9SDimitry Andric   if (!O.IsContentValid())
1950e8d8bef9SDimitry Andric     return;
19515ffd83dbSDimitry Andric 
1952e8d8bef9SDimitry Andric   typename ELFT::ShdrRange Sections = cantFail(Obj.sections());
19535ffd83dbSDimitry Andric   for (const Elf_Shdr &Sec : Sections) {
19540b57cec5SDimitry Andric     switch (Sec.sh_type) {
19550b57cec5SDimitry Andric     case ELF::SHT_SYMTAB:
19560b57cec5SDimitry Andric       if (!DotSymtabSec)
19570b57cec5SDimitry Andric         DotSymtabSec = &Sec;
19580b57cec5SDimitry Andric       break;
19590b57cec5SDimitry Andric     case ELF::SHT_DYNSYM:
1960e8d8bef9SDimitry Andric       if (!DotDynsymSec)
1961e8d8bef9SDimitry Andric         DotDynsymSec = &Sec;
19620b57cec5SDimitry Andric 
1963e8d8bef9SDimitry Andric       if (!DynSymRegion) {
1964e8d8bef9SDimitry Andric         Expected<DynRegionInfo> RegOrErr =
1965e8d8bef9SDimitry Andric             createDRI(Sec.sh_offset, Sec.sh_size, Sec.sh_entsize);
1966e8d8bef9SDimitry Andric         if (RegOrErr) {
1967e8d8bef9SDimitry Andric           DynSymRegion = *RegOrErr;
1968e8d8bef9SDimitry Andric           DynSymRegion->Context = describe(Sec);
1969e8d8bef9SDimitry Andric 
1970e8d8bef9SDimitry Andric           if (Expected<StringRef> E = Obj.getStringTableForSymtab(Sec))
19710b57cec5SDimitry Andric             DynamicStringTable = *E;
19720b57cec5SDimitry Andric           else
1973e8d8bef9SDimitry Andric             reportUniqueWarning("unable to get the string table for the " +
1974e8d8bef9SDimitry Andric                                 describe(Sec) + ": " + toString(E.takeError()));
1975e8d8bef9SDimitry Andric         } else {
1976e8d8bef9SDimitry Andric           reportUniqueWarning("unable to read dynamic symbols from " +
1977e8d8bef9SDimitry Andric                               describe(Sec) + ": " +
1978e8d8bef9SDimitry Andric                               toString(RegOrErr.takeError()));
1979e8d8bef9SDimitry Andric         }
19800b57cec5SDimitry Andric       }
19810b57cec5SDimitry Andric       break;
1982e8d8bef9SDimitry Andric     case ELF::SHT_SYMTAB_SHNDX: {
1983e8d8bef9SDimitry Andric       uint32_t SymtabNdx = Sec.sh_link;
1984e8d8bef9SDimitry Andric       if (SymtabNdx >= Sections.size()) {
1985e8d8bef9SDimitry Andric         reportUniqueWarning(
1986e8d8bef9SDimitry Andric             "unable to get the associated symbol table for " + describe(Sec) +
1987e8d8bef9SDimitry Andric             ": sh_link (" + Twine(SymtabNdx) +
1988e8d8bef9SDimitry Andric             ") is greater than or equal to the total number of sections (" +
1989e8d8bef9SDimitry Andric             Twine(Sections.size()) + ")");
1990e8d8bef9SDimitry Andric         continue;
1991e8d8bef9SDimitry Andric       }
1992e8d8bef9SDimitry Andric 
1993e8d8bef9SDimitry Andric       if (Expected<ArrayRef<Elf_Word>> ShndxTableOrErr =
1994e8d8bef9SDimitry Andric               Obj.getSHNDXTable(Sec)) {
1995e8d8bef9SDimitry Andric         if (!ShndxTables.insert({&Sections[SymtabNdx], *ShndxTableOrErr})
1996e8d8bef9SDimitry Andric                  .second)
1997e8d8bef9SDimitry Andric           reportUniqueWarning(
1998e8d8bef9SDimitry Andric               "multiple SHT_SYMTAB_SHNDX sections are linked to " +
1999e8d8bef9SDimitry Andric               describe(Sec));
2000e8d8bef9SDimitry Andric       } else {
2001e8d8bef9SDimitry Andric         reportUniqueWarning(ShndxTableOrErr.takeError());
2002e8d8bef9SDimitry Andric       }
20030b57cec5SDimitry Andric       break;
2004e8d8bef9SDimitry Andric     }
20050b57cec5SDimitry Andric     case ELF::SHT_GNU_versym:
20060b57cec5SDimitry Andric       if (!SymbolVersionSection)
20070b57cec5SDimitry Andric         SymbolVersionSection = &Sec;
20080b57cec5SDimitry Andric       break;
20090b57cec5SDimitry Andric     case ELF::SHT_GNU_verdef:
20100b57cec5SDimitry Andric       if (!SymbolVersionDefSection)
20110b57cec5SDimitry Andric         SymbolVersionDefSection = &Sec;
20120b57cec5SDimitry Andric       break;
20130b57cec5SDimitry Andric     case ELF::SHT_GNU_verneed:
20140b57cec5SDimitry Andric       if (!SymbolVersionNeedSection)
20150b57cec5SDimitry Andric         SymbolVersionNeedSection = &Sec;
20160b57cec5SDimitry Andric       break;
20170b57cec5SDimitry Andric     case ELF::SHT_LLVM_ADDRSIG:
20180b57cec5SDimitry Andric       if (!DotAddrsigSec)
20190b57cec5SDimitry Andric         DotAddrsigSec = &Sec;
20200b57cec5SDimitry Andric       break;
20210b57cec5SDimitry Andric     }
20220b57cec5SDimitry Andric   }
20230b57cec5SDimitry Andric 
2024e8d8bef9SDimitry Andric   loadDynamicTable();
20250b57cec5SDimitry Andric }
20260b57cec5SDimitry Andric 
parseDynamicTable()2027e8d8bef9SDimitry Andric template <typename ELFT> void ELFDumper<ELFT>::parseDynamicTable() {
20280b57cec5SDimitry Andric   auto toMappedAddr = [&](uint64_t Tag, uint64_t VAddr) -> const uint8_t * {
2029e8d8bef9SDimitry Andric     auto MappedAddrOrError = Obj.toMappedAddr(VAddr, [&](const Twine &Msg) {
2030e8d8bef9SDimitry Andric       this->reportUniqueWarning(Msg);
2031e8d8bef9SDimitry Andric       return Error::success();
2032e8d8bef9SDimitry Andric     });
20330b57cec5SDimitry Andric     if (!MappedAddrOrError) {
2034e8d8bef9SDimitry Andric       this->reportUniqueWarning("unable to parse DT_" +
2035e8d8bef9SDimitry Andric                                 Obj.getDynamicTagAsString(Tag) + ": " +
2036e8d8bef9SDimitry Andric                                 llvm::toString(MappedAddrOrError.takeError()));
20370b57cec5SDimitry Andric       return nullptr;
20380b57cec5SDimitry Andric     }
20390b57cec5SDimitry Andric     return MappedAddrOrError.get();
20400b57cec5SDimitry Andric   };
20410b57cec5SDimitry Andric 
20420b57cec5SDimitry Andric   const char *StringTableBegin = nullptr;
20430b57cec5SDimitry Andric   uint64_t StringTableSize = 0;
2044bdd1243dSDimitry Andric   std::optional<DynRegionInfo> DynSymFromTable;
20450b57cec5SDimitry Andric   for (const Elf_Dyn &Dyn : dynamic_table()) {
20465f757f3fSDimitry Andric     if (Obj.getHeader().e_machine == EM_AARCH64) {
20475f757f3fSDimitry Andric       switch (Dyn.d_tag) {
20485f757f3fSDimitry Andric       case ELF::DT_AARCH64_AUTH_RELRSZ:
20495f757f3fSDimitry Andric         DynRelrRegion.Size = Dyn.getVal();
20505f757f3fSDimitry Andric         DynRelrRegion.SizePrintName = "DT_AARCH64_AUTH_RELRSZ value";
20515f757f3fSDimitry Andric         continue;
20525f757f3fSDimitry Andric       case ELF::DT_AARCH64_AUTH_RELRENT:
20535f757f3fSDimitry Andric         DynRelrRegion.EntSize = Dyn.getVal();
20545f757f3fSDimitry Andric         DynRelrRegion.EntSizePrintName = "DT_AARCH64_AUTH_RELRENT value";
20555f757f3fSDimitry Andric         continue;
20565f757f3fSDimitry Andric       }
20575f757f3fSDimitry Andric     }
20580b57cec5SDimitry Andric     switch (Dyn.d_tag) {
20590b57cec5SDimitry Andric     case ELF::DT_HASH:
20600b57cec5SDimitry Andric       HashTable = reinterpret_cast<const Elf_Hash *>(
20610b57cec5SDimitry Andric           toMappedAddr(Dyn.getTag(), Dyn.getPtr()));
20620b57cec5SDimitry Andric       break;
20630b57cec5SDimitry Andric     case ELF::DT_GNU_HASH:
20640b57cec5SDimitry Andric       GnuHashTable = reinterpret_cast<const Elf_GnuHash *>(
20650b57cec5SDimitry Andric           toMappedAddr(Dyn.getTag(), Dyn.getPtr()));
20660b57cec5SDimitry Andric       break;
20670b57cec5SDimitry Andric     case ELF::DT_STRTAB:
20680b57cec5SDimitry Andric       StringTableBegin = reinterpret_cast<const char *>(
20690b57cec5SDimitry Andric           toMappedAddr(Dyn.getTag(), Dyn.getPtr()));
20700b57cec5SDimitry Andric       break;
20710b57cec5SDimitry Andric     case ELF::DT_STRSZ:
20720b57cec5SDimitry Andric       StringTableSize = Dyn.getVal();
20730b57cec5SDimitry Andric       break;
20748bcb0991SDimitry Andric     case ELF::DT_SYMTAB: {
20755ffd83dbSDimitry Andric       // If we can't map the DT_SYMTAB value to an address (e.g. when there are
20765ffd83dbSDimitry Andric       // no program headers), we ignore its value.
20778bcb0991SDimitry Andric       if (const uint8_t *VA = toMappedAddr(Dyn.getTag(), Dyn.getPtr())) {
2078e8d8bef9SDimitry Andric         DynSymFromTable.emplace(ObjF, *this);
20795ffd83dbSDimitry Andric         DynSymFromTable->Addr = VA;
20805ffd83dbSDimitry Andric         DynSymFromTable->EntSize = sizeof(Elf_Sym);
20815ffd83dbSDimitry Andric         DynSymFromTable->EntSizePrintName = "";
20828bcb0991SDimitry Andric       }
20830b57cec5SDimitry Andric       break;
20848bcb0991SDimitry Andric     }
20855ffd83dbSDimitry Andric     case ELF::DT_SYMENT: {
20865ffd83dbSDimitry Andric       uint64_t Val = Dyn.getVal();
20875ffd83dbSDimitry Andric       if (Val != sizeof(Elf_Sym))
2088e8d8bef9SDimitry Andric         this->reportUniqueWarning("DT_SYMENT value of 0x" +
20895ffd83dbSDimitry Andric                                   Twine::utohexstr(Val) +
20905ffd83dbSDimitry Andric                                   " is not the size of a symbol (0x" +
2091e8d8bef9SDimitry Andric                                   Twine::utohexstr(sizeof(Elf_Sym)) + ")");
20925ffd83dbSDimitry Andric       break;
20935ffd83dbSDimitry Andric     }
20940b57cec5SDimitry Andric     case ELF::DT_RELA:
20950b57cec5SDimitry Andric       DynRelaRegion.Addr = toMappedAddr(Dyn.getTag(), Dyn.getPtr());
20960b57cec5SDimitry Andric       break;
20970b57cec5SDimitry Andric     case ELF::DT_RELASZ:
20980b57cec5SDimitry Andric       DynRelaRegion.Size = Dyn.getVal();
20995ffd83dbSDimitry Andric       DynRelaRegion.SizePrintName = "DT_RELASZ value";
21000b57cec5SDimitry Andric       break;
21010b57cec5SDimitry Andric     case ELF::DT_RELAENT:
21020b57cec5SDimitry Andric       DynRelaRegion.EntSize = Dyn.getVal();
21035ffd83dbSDimitry Andric       DynRelaRegion.EntSizePrintName = "DT_RELAENT value";
21040b57cec5SDimitry Andric       break;
21050b57cec5SDimitry Andric     case ELF::DT_SONAME:
21060b57cec5SDimitry Andric       SONameOffset = Dyn.getVal();
21070b57cec5SDimitry Andric       break;
21080b57cec5SDimitry Andric     case ELF::DT_REL:
21090b57cec5SDimitry Andric       DynRelRegion.Addr = toMappedAddr(Dyn.getTag(), Dyn.getPtr());
21100b57cec5SDimitry Andric       break;
21110b57cec5SDimitry Andric     case ELF::DT_RELSZ:
21120b57cec5SDimitry Andric       DynRelRegion.Size = Dyn.getVal();
21135ffd83dbSDimitry Andric       DynRelRegion.SizePrintName = "DT_RELSZ value";
21140b57cec5SDimitry Andric       break;
21150b57cec5SDimitry Andric     case ELF::DT_RELENT:
21160b57cec5SDimitry Andric       DynRelRegion.EntSize = Dyn.getVal();
21175ffd83dbSDimitry Andric       DynRelRegion.EntSizePrintName = "DT_RELENT value";
21180b57cec5SDimitry Andric       break;
21190b57cec5SDimitry Andric     case ELF::DT_RELR:
21200b57cec5SDimitry Andric     case ELF::DT_ANDROID_RELR:
21215f757f3fSDimitry Andric     case ELF::DT_AARCH64_AUTH_RELR:
21220b57cec5SDimitry Andric       DynRelrRegion.Addr = toMappedAddr(Dyn.getTag(), Dyn.getPtr());
21230b57cec5SDimitry Andric       break;
21240b57cec5SDimitry Andric     case ELF::DT_RELRSZ:
21250b57cec5SDimitry Andric     case ELF::DT_ANDROID_RELRSZ:
21265f757f3fSDimitry Andric     case ELF::DT_AARCH64_AUTH_RELRSZ:
21270b57cec5SDimitry Andric       DynRelrRegion.Size = Dyn.getVal();
21285ffd83dbSDimitry Andric       DynRelrRegion.SizePrintName = Dyn.d_tag == ELF::DT_RELRSZ
21295ffd83dbSDimitry Andric                                         ? "DT_RELRSZ value"
21305ffd83dbSDimitry Andric                                         : "DT_ANDROID_RELRSZ value";
21310b57cec5SDimitry Andric       break;
21320b57cec5SDimitry Andric     case ELF::DT_RELRENT:
21330b57cec5SDimitry Andric     case ELF::DT_ANDROID_RELRENT:
21345f757f3fSDimitry Andric     case ELF::DT_AARCH64_AUTH_RELRENT:
21350b57cec5SDimitry Andric       DynRelrRegion.EntSize = Dyn.getVal();
21365ffd83dbSDimitry Andric       DynRelrRegion.EntSizePrintName = Dyn.d_tag == ELF::DT_RELRENT
21375ffd83dbSDimitry Andric                                            ? "DT_RELRENT value"
21385ffd83dbSDimitry Andric                                            : "DT_ANDROID_RELRENT value";
21390b57cec5SDimitry Andric       break;
21400b57cec5SDimitry Andric     case ELF::DT_PLTREL:
21410b57cec5SDimitry Andric       if (Dyn.getVal() == DT_REL)
21420b57cec5SDimitry Andric         DynPLTRelRegion.EntSize = sizeof(Elf_Rel);
21430b57cec5SDimitry Andric       else if (Dyn.getVal() == DT_RELA)
21440b57cec5SDimitry Andric         DynPLTRelRegion.EntSize = sizeof(Elf_Rela);
21450b57cec5SDimitry Andric       else
2146e8d8bef9SDimitry Andric         reportUniqueWarning(Twine("unknown DT_PLTREL value of ") +
2147e8d8bef9SDimitry Andric                             Twine((uint64_t)Dyn.getVal()));
2148e8d8bef9SDimitry Andric       DynPLTRelRegion.EntSizePrintName = "PLTREL entry size";
21490b57cec5SDimitry Andric       break;
21500b57cec5SDimitry Andric     case ELF::DT_JMPREL:
21510b57cec5SDimitry Andric       DynPLTRelRegion.Addr = toMappedAddr(Dyn.getTag(), Dyn.getPtr());
21520b57cec5SDimitry Andric       break;
21530b57cec5SDimitry Andric     case ELF::DT_PLTRELSZ:
21540b57cec5SDimitry Andric       DynPLTRelRegion.Size = Dyn.getVal();
21555ffd83dbSDimitry Andric       DynPLTRelRegion.SizePrintName = "DT_PLTRELSZ value";
21560b57cec5SDimitry Andric       break;
2157e8d8bef9SDimitry Andric     case ELF::DT_SYMTAB_SHNDX:
2158e8d8bef9SDimitry Andric       DynSymTabShndxRegion.Addr = toMappedAddr(Dyn.getTag(), Dyn.getPtr());
2159e8d8bef9SDimitry Andric       DynSymTabShndxRegion.EntSize = sizeof(Elf_Word);
2160e8d8bef9SDimitry Andric       break;
21610b57cec5SDimitry Andric     }
21620b57cec5SDimitry Andric   }
21635ffd83dbSDimitry Andric 
21645ffd83dbSDimitry Andric   if (StringTableBegin) {
2165e8d8bef9SDimitry Andric     const uint64_t FileSize = Obj.getBufSize();
2166e8d8bef9SDimitry Andric     const uint64_t Offset = (const uint8_t *)StringTableBegin - Obj.base();
21675ffd83dbSDimitry Andric     if (StringTableSize > FileSize - Offset)
2168e8d8bef9SDimitry Andric       reportUniqueWarning(
21695ffd83dbSDimitry Andric           "the dynamic string table at 0x" + Twine::utohexstr(Offset) +
21705ffd83dbSDimitry Andric           " goes past the end of the file (0x" + Twine::utohexstr(FileSize) +
2171e8d8bef9SDimitry Andric           ") with DT_STRSZ = 0x" + Twine::utohexstr(StringTableSize));
21725ffd83dbSDimitry Andric     else
21730b57cec5SDimitry Andric       DynamicStringTable = StringRef(StringTableBegin, StringTableSize);
21745ffd83dbSDimitry Andric   }
21755ffd83dbSDimitry Andric 
2176e8d8bef9SDimitry Andric   const bool IsHashTableSupported = getHashTableEntSize() == 4;
21775ffd83dbSDimitry Andric   if (DynSymRegion) {
21785ffd83dbSDimitry Andric     // Often we find the information about the dynamic symbol table
21795ffd83dbSDimitry Andric     // location in the SHT_DYNSYM section header. However, the value in
21805ffd83dbSDimitry Andric     // DT_SYMTAB has priority, because it is used by dynamic loaders to
21815ffd83dbSDimitry Andric     // locate .dynsym at runtime. The location we find in the section header
21825ffd83dbSDimitry Andric     // and the location we find here should match.
21835ffd83dbSDimitry Andric     if (DynSymFromTable && DynSymFromTable->Addr != DynSymRegion->Addr)
21845ffd83dbSDimitry Andric       reportUniqueWarning(
21855ffd83dbSDimitry Andric           createError("SHT_DYNSYM section header and DT_SYMTAB disagree about "
21865ffd83dbSDimitry Andric                       "the location of the dynamic symbol table"));
21875ffd83dbSDimitry Andric 
21885ffd83dbSDimitry Andric     // According to the ELF gABI: "The number of symbol table entries should
21895ffd83dbSDimitry Andric     // equal nchain". Check to see if the DT_HASH hash table nchain value
21905ffd83dbSDimitry Andric     // conflicts with the number of symbols in the dynamic symbol table
21915ffd83dbSDimitry Andric     // according to the section header.
2192e8d8bef9SDimitry Andric     if (HashTable && IsHashTableSupported) {
21935ffd83dbSDimitry Andric       if (DynSymRegion->EntSize == 0)
2194e8d8bef9SDimitry Andric         reportUniqueWarning("SHT_DYNSYM section has sh_entsize == 0");
21955ffd83dbSDimitry Andric       else if (HashTable->nchain != DynSymRegion->Size / DynSymRegion->EntSize)
2196e8d8bef9SDimitry Andric         reportUniqueWarning(
21975ffd83dbSDimitry Andric             "hash table nchain (" + Twine(HashTable->nchain) +
21985ffd83dbSDimitry Andric             ") differs from symbol count derived from SHT_DYNSYM section "
21995ffd83dbSDimitry Andric             "header (" +
2200e8d8bef9SDimitry Andric             Twine(DynSymRegion->Size / DynSymRegion->EntSize) + ")");
22015ffd83dbSDimitry Andric     }
22025ffd83dbSDimitry Andric   }
22035ffd83dbSDimitry Andric 
22045ffd83dbSDimitry Andric   // Delay the creation of the actual dynamic symbol table until now, so that
22055ffd83dbSDimitry Andric   // checks can always be made against the section header-based properties,
22065ffd83dbSDimitry Andric   // without worrying about tag order.
22075ffd83dbSDimitry Andric   if (DynSymFromTable) {
22085ffd83dbSDimitry Andric     if (!DynSymRegion) {
22095ffd83dbSDimitry Andric       DynSymRegion = DynSymFromTable;
22105ffd83dbSDimitry Andric     } else {
22115ffd83dbSDimitry Andric       DynSymRegion->Addr = DynSymFromTable->Addr;
22125ffd83dbSDimitry Andric       DynSymRegion->EntSize = DynSymFromTable->EntSize;
22135ffd83dbSDimitry Andric       DynSymRegion->EntSizePrintName = DynSymFromTable->EntSizePrintName;
22145ffd83dbSDimitry Andric     }
22155ffd83dbSDimitry Andric   }
22165ffd83dbSDimitry Andric 
22175ffd83dbSDimitry Andric   // Derive the dynamic symbol table size from the DT_HASH hash table, if
22185ffd83dbSDimitry Andric   // present.
2219e8d8bef9SDimitry Andric   if (HashTable && IsHashTableSupported && DynSymRegion) {
2220e8d8bef9SDimitry Andric     const uint64_t FileSize = Obj.getBufSize();
2221e8d8bef9SDimitry Andric     const uint64_t DerivedSize =
2222e8d8bef9SDimitry Andric         (uint64_t)HashTable->nchain * DynSymRegion->EntSize;
2223e8d8bef9SDimitry Andric     const uint64_t Offset = (const uint8_t *)DynSymRegion->Addr - Obj.base();
2224e8d8bef9SDimitry Andric     if (DerivedSize > FileSize - Offset)
2225e8d8bef9SDimitry Andric       reportUniqueWarning(
2226e8d8bef9SDimitry Andric           "the size (0x" + Twine::utohexstr(DerivedSize) +
2227e8d8bef9SDimitry Andric           ") of the dynamic symbol table at 0x" + Twine::utohexstr(Offset) +
2228e8d8bef9SDimitry Andric           ", derived from the hash table, goes past the end of the file (0x" +
2229e8d8bef9SDimitry Andric           Twine::utohexstr(FileSize) + ") and will be ignored");
2230e8d8bef9SDimitry Andric     else
22315ffd83dbSDimitry Andric       DynSymRegion->Size = HashTable->nchain * DynSymRegion->EntSize;
22320b57cec5SDimitry Andric   }
22330b57cec5SDimitry Andric }
22340b57cec5SDimitry Andric 
printVersionInfo()22350b57cec5SDimitry Andric template <typename ELFT> void ELFDumper<ELFT>::printVersionInfo() {
22360b57cec5SDimitry Andric   // Dump version symbol section.
2237e8d8bef9SDimitry Andric   printVersionSymbolSection(SymbolVersionSection);
22380b57cec5SDimitry Andric 
22390b57cec5SDimitry Andric   // Dump version definition section.
2240e8d8bef9SDimitry Andric   printVersionDefinitionSection(SymbolVersionDefSection);
22410b57cec5SDimitry Andric 
22420b57cec5SDimitry Andric   // Dump version dependency section.
2243e8d8bef9SDimitry Andric   printVersionDependencySection(SymbolVersionNeedSection);
22448bcb0991SDimitry Andric }
22458bcb0991SDimitry Andric 
22460b57cec5SDimitry Andric #define LLVM_READOBJ_DT_FLAG_ENT(prefix, enum)                                 \
22470b57cec5SDimitry Andric   { #enum, prefix##_##enum }
22480b57cec5SDimitry Andric 
2249349cc55cSDimitry Andric const EnumEntry<unsigned> ElfDynamicDTFlags[] = {
22500b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF, ORIGIN),
22510b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF, SYMBOLIC),
22520b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF, TEXTREL),
22530b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF, BIND_NOW),
22540b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF, STATIC_TLS)
22550b57cec5SDimitry Andric };
22560b57cec5SDimitry Andric 
2257349cc55cSDimitry Andric const EnumEntry<unsigned> ElfDynamicDTFlags1[] = {
22580b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NOW),
22590b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, GLOBAL),
22600b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, GROUP),
22610b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NODELETE),
22620b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, LOADFLTR),
22630b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, INITFIRST),
22640b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NOOPEN),
22650b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, ORIGIN),
22660b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, DIRECT),
22670b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, TRANS),
22680b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, INTERPOSE),
22690b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NODEFLIB),
22700b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NODUMP),
22710b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, CONFALT),
22720b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, ENDFILTEE),
22730b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, DISPRELDNE),
22740b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, DISPRELPND),
22750b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NODIRECT),
22760b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, IGNMULDEF),
22770b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NOKSYMS),
22780b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NOHDR),
22790b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, EDITED),
22800b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, NORELOC),
22810b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, SYMINTPOSE),
22820b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(DF_1, GLOBAUDIT),
22834e99f454SEd Maste   LLVM_READOBJ_DT_FLAG_ENT(DF_1, SINGLETON),
22844e99f454SEd Maste   LLVM_READOBJ_DT_FLAG_ENT(DF_1, PIE),
22850b57cec5SDimitry Andric };
22860b57cec5SDimitry Andric 
2287349cc55cSDimitry Andric const EnumEntry<unsigned> ElfDynamicDTMipsFlags[] = {
22880b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(RHF, NONE),
22890b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(RHF, QUICKSTART),
22900b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(RHF, NOTPOT),
22910b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(RHS, NO_LIBRARY_REPLACEMENT),
22920b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(RHF, NO_MOVE),
22930b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(RHF, SGI_ONLY),
22940b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(RHF, GUARANTEE_INIT),
22950b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(RHF, DELTA_C_PLUS_PLUS),
22960b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(RHF, GUARANTEE_START_INIT),
22970b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(RHF, PIXIE),
22980b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(RHF, DEFAULT_DELAY_LOAD),
22990b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(RHF, REQUICKSTART),
23000b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(RHF, REQUICKSTARTED),
23010b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(RHF, CORD),
23020b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(RHF, NO_UNRES_UNDEF),
23030b57cec5SDimitry Andric   LLVM_READOBJ_DT_FLAG_ENT(RHF, RLD_ORDER_SAFE)
23040b57cec5SDimitry Andric };
23050b57cec5SDimitry Andric 
23060b57cec5SDimitry Andric #undef LLVM_READOBJ_DT_FLAG_ENT
23070b57cec5SDimitry Andric 
23080b57cec5SDimitry Andric template <typename T, typename TFlag>
printFlags(T Value,ArrayRef<EnumEntry<TFlag>> Flags,raw_ostream & OS)23090b57cec5SDimitry Andric void printFlags(T Value, ArrayRef<EnumEntry<TFlag>> Flags, raw_ostream &OS) {
2310e8d8bef9SDimitry Andric   SmallVector<EnumEntry<TFlag>, 10> SetFlags;
2311e8d8bef9SDimitry Andric   for (const EnumEntry<TFlag> &Flag : Flags)
2312e8d8bef9SDimitry Andric     if (Flag.Value != 0 && (Value & Flag.Value) == Flag.Value)
23130b57cec5SDimitry Andric       SetFlags.push_back(Flag);
23140b57cec5SDimitry Andric 
2315e8d8bef9SDimitry Andric   for (const EnumEntry<TFlag> &Flag : SetFlags)
23160b57cec5SDimitry Andric     OS << Flag.Name << " ";
23170b57cec5SDimitry Andric }
2318e8d8bef9SDimitry Andric 
2319e8d8bef9SDimitry Andric template <class ELFT>
2320e8d8bef9SDimitry Andric const typename ELFT::Shdr *
findSectionByName(StringRef Name) const2321e8d8bef9SDimitry Andric ELFDumper<ELFT>::findSectionByName(StringRef Name) const {
2322e8d8bef9SDimitry Andric   for (const Elf_Shdr &Shdr : cantFail(Obj.sections())) {
2323e8d8bef9SDimitry Andric     if (Expected<StringRef> NameOrErr = Obj.getSectionName(Shdr)) {
2324e8d8bef9SDimitry Andric       if (*NameOrErr == Name)
2325e8d8bef9SDimitry Andric         return &Shdr;
2326e8d8bef9SDimitry Andric     } else {
2327e8d8bef9SDimitry Andric       reportUniqueWarning("unable to read the name of " + describe(Shdr) +
2328e8d8bef9SDimitry Andric                           ": " + toString(NameOrErr.takeError()));
2329e8d8bef9SDimitry Andric     }
2330e8d8bef9SDimitry Andric   }
2331e8d8bef9SDimitry Andric   return nullptr;
23320b57cec5SDimitry Andric }
23330b57cec5SDimitry Andric 
23340b57cec5SDimitry Andric template <class ELFT>
getDynamicEntry(uint64_t Type,uint64_t Value) const23355ffd83dbSDimitry Andric std::string ELFDumper<ELFT>::getDynamicEntry(uint64_t Type,
23360b57cec5SDimitry Andric                                              uint64_t Value) const {
23375ffd83dbSDimitry Andric   auto FormatHexValue = [](uint64_t V) {
23385ffd83dbSDimitry Andric     std::string Str;
23395ffd83dbSDimitry Andric     raw_string_ostream OS(Str);
23400b57cec5SDimitry Andric     const char *ConvChar =
23410b57cec5SDimitry Andric         (opts::Output == opts::GNU) ? "0x%" PRIx64 : "0x%" PRIX64;
23425ffd83dbSDimitry Andric     OS << format(ConvChar, V);
23435ffd83dbSDimitry Andric     return OS.str();
23445ffd83dbSDimitry Andric   };
23455ffd83dbSDimitry Andric 
23465ffd83dbSDimitry Andric   auto FormatFlags = [](uint64_t V,
23475ffd83dbSDimitry Andric                         llvm::ArrayRef<llvm::EnumEntry<unsigned int>> Array) {
23485ffd83dbSDimitry Andric     std::string Str;
23495ffd83dbSDimitry Andric     raw_string_ostream OS(Str);
23505ffd83dbSDimitry Andric     printFlags(V, Array, OS);
23515ffd83dbSDimitry Andric     return OS.str();
23525ffd83dbSDimitry Andric   };
23530b57cec5SDimitry Andric 
23540b57cec5SDimitry Andric   // Handle custom printing of architecture specific tags
2355e8d8bef9SDimitry Andric   switch (Obj.getHeader().e_machine) {
23560b57cec5SDimitry Andric   case EM_AARCH64:
23570b57cec5SDimitry Andric     switch (Type) {
23580b57cec5SDimitry Andric     case DT_AARCH64_BTI_PLT:
23590b57cec5SDimitry Andric     case DT_AARCH64_PAC_PLT:
2360e8d8bef9SDimitry Andric     case DT_AARCH64_VARIANT_PCS:
236106c3fb27SDimitry Andric     case DT_AARCH64_MEMTAG_GLOBALSSZ:
23625ffd83dbSDimitry Andric       return std::to_string(Value);
236306c3fb27SDimitry Andric     case DT_AARCH64_MEMTAG_MODE:
236406c3fb27SDimitry Andric       switch (Value) {
236506c3fb27SDimitry Andric         case 0:
236606c3fb27SDimitry Andric           return "Synchronous (0)";
236706c3fb27SDimitry Andric         case 1:
236806c3fb27SDimitry Andric           return "Asynchronous (1)";
236906c3fb27SDimitry Andric         default:
237006c3fb27SDimitry Andric           return (Twine("Unknown (") + Twine(Value) + ")").str();
237106c3fb27SDimitry Andric       }
237206c3fb27SDimitry Andric     case DT_AARCH64_MEMTAG_HEAP:
237306c3fb27SDimitry Andric     case DT_AARCH64_MEMTAG_STACK:
237406c3fb27SDimitry Andric       switch (Value) {
237506c3fb27SDimitry Andric         case 0:
237606c3fb27SDimitry Andric           return "Disabled (0)";
237706c3fb27SDimitry Andric         case 1:
237806c3fb27SDimitry Andric           return "Enabled (1)";
237906c3fb27SDimitry Andric         default:
238006c3fb27SDimitry Andric           return (Twine("Unknown (") + Twine(Value) + ")").str();
238106c3fb27SDimitry Andric       }
238206c3fb27SDimitry Andric     case DT_AARCH64_MEMTAG_GLOBALS:
238306c3fb27SDimitry Andric       return (Twine("0x") + utohexstr(Value, /*LowerCase=*/true)).str();
23840b57cec5SDimitry Andric     default:
23850b57cec5SDimitry Andric       break;
23860b57cec5SDimitry Andric     }
23870b57cec5SDimitry Andric     break;
23880b57cec5SDimitry Andric   case EM_HEXAGON:
23890b57cec5SDimitry Andric     switch (Type) {
23900b57cec5SDimitry Andric     case DT_HEXAGON_VER:
23915ffd83dbSDimitry Andric       return std::to_string(Value);
23920b57cec5SDimitry Andric     case DT_HEXAGON_SYMSZ:
23930b57cec5SDimitry Andric     case DT_HEXAGON_PLT:
23945ffd83dbSDimitry Andric       return FormatHexValue(Value);
23950b57cec5SDimitry Andric     default:
23960b57cec5SDimitry Andric       break;
23970b57cec5SDimitry Andric     }
23980b57cec5SDimitry Andric     break;
23990b57cec5SDimitry Andric   case EM_MIPS:
24000b57cec5SDimitry Andric     switch (Type) {
24010b57cec5SDimitry Andric     case DT_MIPS_RLD_VERSION:
24020b57cec5SDimitry Andric     case DT_MIPS_LOCAL_GOTNO:
24030b57cec5SDimitry Andric     case DT_MIPS_SYMTABNO:
24040b57cec5SDimitry Andric     case DT_MIPS_UNREFEXTNO:
24055ffd83dbSDimitry Andric       return std::to_string(Value);
24060b57cec5SDimitry Andric     case DT_MIPS_TIME_STAMP:
24070b57cec5SDimitry Andric     case DT_MIPS_ICHECKSUM:
24080b57cec5SDimitry Andric     case DT_MIPS_IVERSION:
24090b57cec5SDimitry Andric     case DT_MIPS_BASE_ADDRESS:
24100b57cec5SDimitry Andric     case DT_MIPS_MSYM:
24110b57cec5SDimitry Andric     case DT_MIPS_CONFLICT:
24120b57cec5SDimitry Andric     case DT_MIPS_LIBLIST:
24130b57cec5SDimitry Andric     case DT_MIPS_CONFLICTNO:
24140b57cec5SDimitry Andric     case DT_MIPS_LIBLISTNO:
24150b57cec5SDimitry Andric     case DT_MIPS_GOTSYM:
24160b57cec5SDimitry Andric     case DT_MIPS_HIPAGENO:
24170b57cec5SDimitry Andric     case DT_MIPS_RLD_MAP:
24180b57cec5SDimitry Andric     case DT_MIPS_DELTA_CLASS:
24190b57cec5SDimitry Andric     case DT_MIPS_DELTA_CLASS_NO:
24200b57cec5SDimitry Andric     case DT_MIPS_DELTA_INSTANCE:
24210b57cec5SDimitry Andric     case DT_MIPS_DELTA_RELOC:
24220b57cec5SDimitry Andric     case DT_MIPS_DELTA_RELOC_NO:
24230b57cec5SDimitry Andric     case DT_MIPS_DELTA_SYM:
24240b57cec5SDimitry Andric     case DT_MIPS_DELTA_SYM_NO:
24250b57cec5SDimitry Andric     case DT_MIPS_DELTA_CLASSSYM:
24260b57cec5SDimitry Andric     case DT_MIPS_DELTA_CLASSSYM_NO:
24270b57cec5SDimitry Andric     case DT_MIPS_CXX_FLAGS:
24280b57cec5SDimitry Andric     case DT_MIPS_PIXIE_INIT:
24290b57cec5SDimitry Andric     case DT_MIPS_SYMBOL_LIB:
24300b57cec5SDimitry Andric     case DT_MIPS_LOCALPAGE_GOTIDX:
24310b57cec5SDimitry Andric     case DT_MIPS_LOCAL_GOTIDX:
24320b57cec5SDimitry Andric     case DT_MIPS_HIDDEN_GOTIDX:
24330b57cec5SDimitry Andric     case DT_MIPS_PROTECTED_GOTIDX:
24340b57cec5SDimitry Andric     case DT_MIPS_OPTIONS:
24350b57cec5SDimitry Andric     case DT_MIPS_INTERFACE:
24360b57cec5SDimitry Andric     case DT_MIPS_DYNSTR_ALIGN:
24370b57cec5SDimitry Andric     case DT_MIPS_INTERFACE_SIZE:
24380b57cec5SDimitry Andric     case DT_MIPS_RLD_TEXT_RESOLVE_ADDR:
24390b57cec5SDimitry Andric     case DT_MIPS_PERF_SUFFIX:
24400b57cec5SDimitry Andric     case DT_MIPS_COMPACT_SIZE:
24410b57cec5SDimitry Andric     case DT_MIPS_GP_VALUE:
24420b57cec5SDimitry Andric     case DT_MIPS_AUX_DYNAMIC:
24430b57cec5SDimitry Andric     case DT_MIPS_PLTGOT:
24440b57cec5SDimitry Andric     case DT_MIPS_RWPLT:
24450b57cec5SDimitry Andric     case DT_MIPS_RLD_MAP_REL:
2446d781ede6SDimitry Andric     case DT_MIPS_XHASH:
24475ffd83dbSDimitry Andric       return FormatHexValue(Value);
24480b57cec5SDimitry Andric     case DT_MIPS_FLAGS:
2449bdd1243dSDimitry Andric       return FormatFlags(Value, ArrayRef(ElfDynamicDTMipsFlags));
24500b57cec5SDimitry Andric     default:
24510b57cec5SDimitry Andric       break;
24520b57cec5SDimitry Andric     }
24530b57cec5SDimitry Andric     break;
24540b57cec5SDimitry Andric   default:
24550b57cec5SDimitry Andric     break;
24560b57cec5SDimitry Andric   }
24570b57cec5SDimitry Andric 
24580b57cec5SDimitry Andric   switch (Type) {
24590b57cec5SDimitry Andric   case DT_PLTREL:
24605ffd83dbSDimitry Andric     if (Value == DT_REL)
24615ffd83dbSDimitry Andric       return "REL";
24625ffd83dbSDimitry Andric     if (Value == DT_RELA)
24635ffd83dbSDimitry Andric       return "RELA";
2464bdd1243dSDimitry Andric     [[fallthrough]];
24650b57cec5SDimitry Andric   case DT_PLTGOT:
24660b57cec5SDimitry Andric   case DT_HASH:
24670b57cec5SDimitry Andric   case DT_STRTAB:
24680b57cec5SDimitry Andric   case DT_SYMTAB:
24690b57cec5SDimitry Andric   case DT_RELA:
24700b57cec5SDimitry Andric   case DT_INIT:
24710b57cec5SDimitry Andric   case DT_FINI:
24720b57cec5SDimitry Andric   case DT_REL:
24730b57cec5SDimitry Andric   case DT_JMPREL:
24740b57cec5SDimitry Andric   case DT_INIT_ARRAY:
24750b57cec5SDimitry Andric   case DT_FINI_ARRAY:
24760b57cec5SDimitry Andric   case DT_PREINIT_ARRAY:
24770b57cec5SDimitry Andric   case DT_DEBUG:
24780b57cec5SDimitry Andric   case DT_VERDEF:
24790b57cec5SDimitry Andric   case DT_VERNEED:
24800b57cec5SDimitry Andric   case DT_VERSYM:
24810b57cec5SDimitry Andric   case DT_GNU_HASH:
24820b57cec5SDimitry Andric   case DT_NULL:
24835ffd83dbSDimitry Andric     return FormatHexValue(Value);
24840b57cec5SDimitry Andric   case DT_RELACOUNT:
24850b57cec5SDimitry Andric   case DT_RELCOUNT:
24860b57cec5SDimitry Andric   case DT_VERDEFNUM:
24870b57cec5SDimitry Andric   case DT_VERNEEDNUM:
24885ffd83dbSDimitry Andric     return std::to_string(Value);
24890b57cec5SDimitry Andric   case DT_PLTRELSZ:
24900b57cec5SDimitry Andric   case DT_RELASZ:
24910b57cec5SDimitry Andric   case DT_RELAENT:
24920b57cec5SDimitry Andric   case DT_STRSZ:
24930b57cec5SDimitry Andric   case DT_SYMENT:
24940b57cec5SDimitry Andric   case DT_RELSZ:
24950b57cec5SDimitry Andric   case DT_RELENT:
24960b57cec5SDimitry Andric   case DT_INIT_ARRAYSZ:
24970b57cec5SDimitry Andric   case DT_FINI_ARRAYSZ:
24980b57cec5SDimitry Andric   case DT_PREINIT_ARRAYSZ:
2499349cc55cSDimitry Andric   case DT_RELRSZ:
2500349cc55cSDimitry Andric   case DT_RELRENT:
25015f757f3fSDimitry Andric   case DT_AARCH64_AUTH_RELRSZ:
25025f757f3fSDimitry Andric   case DT_AARCH64_AUTH_RELRENT:
25030b57cec5SDimitry Andric   case DT_ANDROID_RELSZ:
25040b57cec5SDimitry Andric   case DT_ANDROID_RELASZ:
25055ffd83dbSDimitry Andric     return std::to_string(Value) + " (bytes)";
25060b57cec5SDimitry Andric   case DT_NEEDED:
25070b57cec5SDimitry Andric   case DT_SONAME:
25080b57cec5SDimitry Andric   case DT_AUXILIARY:
25090b57cec5SDimitry Andric   case DT_USED:
25100b57cec5SDimitry Andric   case DT_FILTER:
25110b57cec5SDimitry Andric   case DT_RPATH:
25120b57cec5SDimitry Andric   case DT_RUNPATH: {
25130b57cec5SDimitry Andric     const std::map<uint64_t, const char *> TagNames = {
25145ffd83dbSDimitry Andric         {DT_NEEDED, "Shared library"},       {DT_SONAME, "Library soname"},
25155ffd83dbSDimitry Andric         {DT_AUXILIARY, "Auxiliary library"}, {DT_USED, "Not needed object"},
25165ffd83dbSDimitry Andric         {DT_FILTER, "Filter library"},       {DT_RPATH, "Library rpath"},
25170b57cec5SDimitry Andric         {DT_RUNPATH, "Library runpath"},
25180b57cec5SDimitry Andric     };
25195ffd83dbSDimitry Andric 
25205ffd83dbSDimitry Andric     return (Twine(TagNames.at(Type)) + ": [" + getDynamicString(Value) + "]")
25215ffd83dbSDimitry Andric         .str();
25220b57cec5SDimitry Andric   }
25230b57cec5SDimitry Andric   case DT_FLAGS:
2524bdd1243dSDimitry Andric     return FormatFlags(Value, ArrayRef(ElfDynamicDTFlags));
25250b57cec5SDimitry Andric   case DT_FLAGS_1:
2526bdd1243dSDimitry Andric     return FormatFlags(Value, ArrayRef(ElfDynamicDTFlags1));
25270b57cec5SDimitry Andric   default:
25285ffd83dbSDimitry Andric     return FormatHexValue(Value);
25290b57cec5SDimitry Andric   }
25300b57cec5SDimitry Andric }
25310b57cec5SDimitry Andric 
25328bcb0991SDimitry Andric template <class ELFT>
getDynamicString(uint64_t Value) const25335ffd83dbSDimitry Andric StringRef ELFDumper<ELFT>::getDynamicString(uint64_t Value) const {
25345ffd83dbSDimitry Andric   if (DynamicStringTable.empty() && !DynamicStringTable.data()) {
2535e8d8bef9SDimitry Andric     reportUniqueWarning("string table was not found");
25365ffd83dbSDimitry Andric     return "<?>";
25375ffd83dbSDimitry Andric   }
25385ffd83dbSDimitry Andric 
25395ffd83dbSDimitry Andric   auto WarnAndReturn = [this](const Twine &Msg, uint64_t Offset) {
2540e8d8bef9SDimitry Andric     reportUniqueWarning("string table at offset 0x" + Twine::utohexstr(Offset) +
2541e8d8bef9SDimitry Andric                         Msg);
25425ffd83dbSDimitry Andric     return "<?>";
25435ffd83dbSDimitry Andric   };
25445ffd83dbSDimitry Andric 
2545e8d8bef9SDimitry Andric   const uint64_t FileSize = Obj.getBufSize();
25465ffd83dbSDimitry Andric   const uint64_t Offset =
2547e8d8bef9SDimitry Andric       (const uint8_t *)DynamicStringTable.data() - Obj.base();
25485ffd83dbSDimitry Andric   if (DynamicStringTable.size() > FileSize - Offset)
25495ffd83dbSDimitry Andric     return WarnAndReturn(" with size 0x" +
25505ffd83dbSDimitry Andric                              Twine::utohexstr(DynamicStringTable.size()) +
25515ffd83dbSDimitry Andric                              " goes past the end of the file (0x" +
25525ffd83dbSDimitry Andric                              Twine::utohexstr(FileSize) + ")",
25535ffd83dbSDimitry Andric                          Offset);
25545ffd83dbSDimitry Andric 
25555ffd83dbSDimitry Andric   if (Value >= DynamicStringTable.size())
25565ffd83dbSDimitry Andric     return WarnAndReturn(
25575ffd83dbSDimitry Andric         ": unable to read the string at 0x" + Twine::utohexstr(Offset + Value) +
25585ffd83dbSDimitry Andric             ": it goes past the end of the table (0x" +
25595ffd83dbSDimitry Andric             Twine::utohexstr(Offset + DynamicStringTable.size()) + ")",
25605ffd83dbSDimitry Andric         Offset);
25615ffd83dbSDimitry Andric 
25625ffd83dbSDimitry Andric   if (DynamicStringTable.back() != '\0')
25635ffd83dbSDimitry Andric     return WarnAndReturn(": unable to read the string at 0x" +
25645ffd83dbSDimitry Andric                              Twine::utohexstr(Offset + Value) +
25655ffd83dbSDimitry Andric                              ": the string table is not null-terminated",
25665ffd83dbSDimitry Andric                          Offset);
25675ffd83dbSDimitry Andric 
25688bcb0991SDimitry Andric   return DynamicStringTable.data() + Value;
25698bcb0991SDimitry Andric }
25708bcb0991SDimitry Andric 
printUnwindInfo()25710b57cec5SDimitry Andric template <class ELFT> void ELFDumper<ELFT>::printUnwindInfo() {
25720b57cec5SDimitry Andric   DwarfCFIEH::PrinterContext<ELFT> Ctx(W, ObjF);
25730b57cec5SDimitry Andric   Ctx.printUnwindInformation();
25740b57cec5SDimitry Andric }
25750b57cec5SDimitry Andric 
2576e8d8bef9SDimitry Andric // The namespace is needed to fix the compilation with GCC older than 7.0+.
25770b57cec5SDimitry Andric namespace {
printUnwindInfo()25780b57cec5SDimitry Andric template <> void ELFDumper<ELF32LE>::printUnwindInfo() {
2579e8d8bef9SDimitry Andric   if (Obj.getHeader().e_machine == EM_ARM) {
2580e8d8bef9SDimitry Andric     ARM::EHABI::PrinterContext<ELF32LE> Ctx(W, Obj, ObjF.getFileName(),
25818bcb0991SDimitry Andric                                             DotSymtabSec);
25820b57cec5SDimitry Andric     Ctx.PrintUnwindInformation();
25830b57cec5SDimitry Andric   }
25840b57cec5SDimitry Andric   DwarfCFIEH::PrinterContext<ELF32LE> Ctx(W, ObjF);
25850b57cec5SDimitry Andric   Ctx.printUnwindInformation();
25860b57cec5SDimitry Andric }
2587e8d8bef9SDimitry Andric } // namespace
25880b57cec5SDimitry Andric 
printNeededLibraries()25890b57cec5SDimitry Andric template <class ELFT> void ELFDumper<ELFT>::printNeededLibraries() {
25900b57cec5SDimitry Andric   ListScope D(W, "NeededLibraries");
25910b57cec5SDimitry Andric 
25925ffd83dbSDimitry Andric   std::vector<StringRef> Libs;
25930b57cec5SDimitry Andric   for (const auto &Entry : dynamic_table())
25948bcb0991SDimitry Andric     if (Entry.d_tag == ELF::DT_NEEDED)
25958bcb0991SDimitry Andric       Libs.push_back(getDynamicString(Entry.d_un.d_val));
25960b57cec5SDimitry Andric 
25975ffd83dbSDimitry Andric   llvm::sort(Libs);
25980b57cec5SDimitry Andric 
25995ffd83dbSDimitry Andric   for (StringRef L : Libs)
26005f757f3fSDimitry Andric     W.printString(L);
26010b57cec5SDimitry Andric }
26020b57cec5SDimitry Andric 
26035ffd83dbSDimitry Andric template <class ELFT>
checkHashTable(const ELFDumper<ELFT> & Dumper,const typename ELFT::Hash * H,bool * IsHeaderValid=nullptr)2604e8d8bef9SDimitry Andric static Error checkHashTable(const ELFDumper<ELFT> &Dumper,
26055ffd83dbSDimitry Andric                             const typename ELFT::Hash *H,
26065ffd83dbSDimitry Andric                             bool *IsHeaderValid = nullptr) {
2607e8d8bef9SDimitry Andric   const ELFFile<ELFT> &Obj = Dumper.getElfObject().getELFFile();
2608e8d8bef9SDimitry Andric   const uint64_t SecOffset = (const uint8_t *)H - Obj.base();
2609e8d8bef9SDimitry Andric   if (Dumper.getHashTableEntSize() == 8) {
2610e8d8bef9SDimitry Andric     auto It = llvm::find_if(ElfMachineType, [&](const EnumEntry<unsigned> &E) {
2611e8d8bef9SDimitry Andric       return E.Value == Obj.getHeader().e_machine;
2612e8d8bef9SDimitry Andric     });
2613e8d8bef9SDimitry Andric     if (IsHeaderValid)
2614e8d8bef9SDimitry Andric       *IsHeaderValid = false;
2615e8d8bef9SDimitry Andric     return createError("the hash table at 0x" + Twine::utohexstr(SecOffset) +
2616e8d8bef9SDimitry Andric                        " is not supported: it contains non-standard 8 "
2617e8d8bef9SDimitry Andric                        "byte entries on " +
2618e8d8bef9SDimitry Andric                        It->AltName + " platform");
2619e8d8bef9SDimitry Andric   }
2620e8d8bef9SDimitry Andric 
2621e8d8bef9SDimitry Andric   auto MakeError = [&](const Twine &Msg = "") {
2622e8d8bef9SDimitry Andric     return createError("the hash table at offset 0x" +
2623e8d8bef9SDimitry Andric                        Twine::utohexstr(SecOffset) +
26245ffd83dbSDimitry Andric                        " goes past the end of the file (0x" +
2625e8d8bef9SDimitry Andric                        Twine::utohexstr(Obj.getBufSize()) + ")" + Msg);
26265ffd83dbSDimitry Andric   };
26275ffd83dbSDimitry Andric 
26285ffd83dbSDimitry Andric   // Each SHT_HASH section starts from two 32-bit fields: nbucket and nchain.
26295ffd83dbSDimitry Andric   const unsigned HeaderSize = 2 * sizeof(typename ELFT::Word);
26305ffd83dbSDimitry Andric 
26315ffd83dbSDimitry Andric   if (IsHeaderValid)
2632e8d8bef9SDimitry Andric     *IsHeaderValid = Obj.getBufSize() - SecOffset >= HeaderSize;
26335ffd83dbSDimitry Andric 
2634e8d8bef9SDimitry Andric   if (Obj.getBufSize() - SecOffset < HeaderSize)
2635e8d8bef9SDimitry Andric     return MakeError();
26365ffd83dbSDimitry Andric 
2637e8d8bef9SDimitry Andric   if (Obj.getBufSize() - SecOffset - HeaderSize <
26385ffd83dbSDimitry Andric       ((uint64_t)H->nbucket + H->nchain) * sizeof(typename ELFT::Word))
2639e8d8bef9SDimitry Andric     return MakeError(", nbucket = " + Twine(H->nbucket) +
26405ffd83dbSDimitry Andric                      ", nchain = " + Twine(H->nchain));
26415ffd83dbSDimitry Andric   return Error::success();
26425ffd83dbSDimitry Andric }
26435ffd83dbSDimitry Andric 
26445ffd83dbSDimitry Andric template <class ELFT>
checkGNUHashTable(const ELFFile<ELFT> & Obj,const typename ELFT::GnuHash * GnuHashTable,bool * IsHeaderValid=nullptr)2645e8d8bef9SDimitry Andric static Error checkGNUHashTable(const ELFFile<ELFT> &Obj,
26465ffd83dbSDimitry Andric                                const typename ELFT::GnuHash *GnuHashTable,
26475ffd83dbSDimitry Andric                                bool *IsHeaderValid = nullptr) {
26485ffd83dbSDimitry Andric   const uint8_t *TableData = reinterpret_cast<const uint8_t *>(GnuHashTable);
2649e8d8bef9SDimitry Andric   assert(TableData >= Obj.base() && TableData < Obj.base() + Obj.getBufSize() &&
26505ffd83dbSDimitry Andric          "GnuHashTable must always point to a location inside the file");
26515ffd83dbSDimitry Andric 
2652e8d8bef9SDimitry Andric   uint64_t TableOffset = TableData - Obj.base();
26535ffd83dbSDimitry Andric   if (IsHeaderValid)
2654e8d8bef9SDimitry Andric     *IsHeaderValid = TableOffset + /*Header size:*/ 16 < Obj.getBufSize();
26555ffd83dbSDimitry Andric   if (TableOffset + 16 + (uint64_t)GnuHashTable->nbuckets * 4 +
26565ffd83dbSDimitry Andric           (uint64_t)GnuHashTable->maskwords * sizeof(typename ELFT::Off) >=
2657e8d8bef9SDimitry Andric       Obj.getBufSize())
26585ffd83dbSDimitry Andric     return createError("unable to dump the SHT_GNU_HASH "
26595ffd83dbSDimitry Andric                        "section at 0x" +
26605ffd83dbSDimitry Andric                        Twine::utohexstr(TableOffset) +
26615ffd83dbSDimitry Andric                        ": it goes past the end of the file");
26625ffd83dbSDimitry Andric   return Error::success();
26635ffd83dbSDimitry Andric }
26645ffd83dbSDimitry Andric 
printHashTable()26650b57cec5SDimitry Andric template <typename ELFT> void ELFDumper<ELFT>::printHashTable() {
26660b57cec5SDimitry Andric   DictScope D(W, "HashTable");
26670b57cec5SDimitry Andric   if (!HashTable)
26680b57cec5SDimitry Andric     return;
26695ffd83dbSDimitry Andric 
26705ffd83dbSDimitry Andric   bool IsHeaderValid;
2671e8d8bef9SDimitry Andric   Error Err = checkHashTable(*this, HashTable, &IsHeaderValid);
26725ffd83dbSDimitry Andric   if (IsHeaderValid) {
26730b57cec5SDimitry Andric     W.printNumber("Num Buckets", HashTable->nbucket);
26740b57cec5SDimitry Andric     W.printNumber("Num Chains", HashTable->nchain);
26755ffd83dbSDimitry Andric   }
26765ffd83dbSDimitry Andric 
26775ffd83dbSDimitry Andric   if (Err) {
26785ffd83dbSDimitry Andric     reportUniqueWarning(std::move(Err));
26795ffd83dbSDimitry Andric     return;
26805ffd83dbSDimitry Andric   }
26815ffd83dbSDimitry Andric 
26820b57cec5SDimitry Andric   W.printList("Buckets", HashTable->buckets());
26830b57cec5SDimitry Andric   W.printList("Chains", HashTable->chains());
26840b57cec5SDimitry Andric }
26850b57cec5SDimitry Andric 
26865ffd83dbSDimitry Andric template <class ELFT>
26875ffd83dbSDimitry Andric static Expected<ArrayRef<typename ELFT::Word>>
getGnuHashTableChains(std::optional<DynRegionInfo> DynSymRegion,const typename ELFT::GnuHash * GnuHashTable)2688bdd1243dSDimitry Andric getGnuHashTableChains(std::optional<DynRegionInfo> DynSymRegion,
26895ffd83dbSDimitry Andric                       const typename ELFT::GnuHash *GnuHashTable) {
26905ffd83dbSDimitry Andric   if (!DynSymRegion)
26915ffd83dbSDimitry Andric     return createError("no dynamic symbol table found");
26925ffd83dbSDimitry Andric 
26935ffd83dbSDimitry Andric   ArrayRef<typename ELFT::Sym> DynSymTable =
2694e8d8bef9SDimitry Andric       DynSymRegion->template getAsArrayRef<typename ELFT::Sym>();
26955ffd83dbSDimitry Andric   size_t NumSyms = DynSymTable.size();
26965ffd83dbSDimitry Andric   if (!NumSyms)
26975ffd83dbSDimitry Andric     return createError("the dynamic symbol table is empty");
26985ffd83dbSDimitry Andric 
26995ffd83dbSDimitry Andric   if (GnuHashTable->symndx < NumSyms)
27005ffd83dbSDimitry Andric     return GnuHashTable->values(NumSyms);
27015ffd83dbSDimitry Andric 
27025ffd83dbSDimitry Andric   // A normal empty GNU hash table section produced by linker might have
27035ffd83dbSDimitry Andric   // symndx set to the number of dynamic symbols + 1 (for the zero symbol)
27045ffd83dbSDimitry Andric   // and have dummy null values in the Bloom filter and in the buckets
27055ffd83dbSDimitry Andric   // vector (or no values at all). It happens because the value of symndx is not
27065ffd83dbSDimitry Andric   // important for dynamic loaders when the GNU hash table is empty. They just
27075ffd83dbSDimitry Andric   // skip the whole object during symbol lookup. In such cases, the symndx value
27085ffd83dbSDimitry Andric   // is irrelevant and we should not report a warning.
27095ffd83dbSDimitry Andric   ArrayRef<typename ELFT::Word> Buckets = GnuHashTable->buckets();
27105ffd83dbSDimitry Andric   if (!llvm::all_of(Buckets, [](typename ELFT::Word V) { return V == 0; }))
2711e8d8bef9SDimitry Andric     return createError(
2712e8d8bef9SDimitry Andric         "the first hashed symbol index (" + Twine(GnuHashTable->symndx) +
2713e8d8bef9SDimitry Andric         ") is greater than or equal to the number of dynamic symbols (" +
27145ffd83dbSDimitry Andric         Twine(NumSyms) + ")");
27155ffd83dbSDimitry Andric   // There is no way to represent an array of (dynamic symbols count - symndx)
27165ffd83dbSDimitry Andric   // length.
27175ffd83dbSDimitry Andric   return ArrayRef<typename ELFT::Word>();
27185ffd83dbSDimitry Andric }
27195ffd83dbSDimitry Andric 
27205ffd83dbSDimitry Andric template <typename ELFT>
printGnuHashTable()2721e8d8bef9SDimitry Andric void ELFDumper<ELFT>::printGnuHashTable() {
27220b57cec5SDimitry Andric   DictScope D(W, "GnuHashTable");
27230b57cec5SDimitry Andric   if (!GnuHashTable)
27240b57cec5SDimitry Andric     return;
27255ffd83dbSDimitry Andric 
27265ffd83dbSDimitry Andric   bool IsHeaderValid;
2727e8d8bef9SDimitry Andric   Error Err = checkGNUHashTable<ELFT>(Obj, GnuHashTable, &IsHeaderValid);
27285ffd83dbSDimitry Andric   if (IsHeaderValid) {
27290b57cec5SDimitry Andric     W.printNumber("Num Buckets", GnuHashTable->nbuckets);
27300b57cec5SDimitry Andric     W.printNumber("First Hashed Symbol Index", GnuHashTable->symndx);
27310b57cec5SDimitry Andric     W.printNumber("Num Mask Words", GnuHashTable->maskwords);
27320b57cec5SDimitry Andric     W.printNumber("Shift Count", GnuHashTable->shift2);
27335ffd83dbSDimitry Andric   }
27345ffd83dbSDimitry Andric 
27355ffd83dbSDimitry Andric   if (Err) {
27365ffd83dbSDimitry Andric     reportUniqueWarning(std::move(Err));
27375ffd83dbSDimitry Andric     return;
27385ffd83dbSDimitry Andric   }
27395ffd83dbSDimitry Andric 
27405ffd83dbSDimitry Andric   ArrayRef<typename ELFT::Off> BloomFilter = GnuHashTable->filter();
27415ffd83dbSDimitry Andric   W.printHexList("Bloom Filter", BloomFilter);
27425ffd83dbSDimitry Andric 
27435ffd83dbSDimitry Andric   ArrayRef<Elf_Word> Buckets = GnuHashTable->buckets();
27445ffd83dbSDimitry Andric   W.printList("Buckets", Buckets);
27455ffd83dbSDimitry Andric 
27465ffd83dbSDimitry Andric   Expected<ArrayRef<Elf_Word>> Chains =
27475ffd83dbSDimitry Andric       getGnuHashTableChains<ELFT>(DynSymRegion, GnuHashTable);
27485ffd83dbSDimitry Andric   if (!Chains) {
2749e8d8bef9SDimitry Andric     reportUniqueWarning("unable to dump 'Values' for the SHT_GNU_HASH "
27505ffd83dbSDimitry Andric                         "section: " +
2751e8d8bef9SDimitry Andric                         toString(Chains.takeError()));
27525ffd83dbSDimitry Andric     return;
27535ffd83dbSDimitry Andric   }
27545ffd83dbSDimitry Andric 
27555ffd83dbSDimitry Andric   W.printHexList("Values", *Chains);
27560b57cec5SDimitry Andric }
27570b57cec5SDimitry Andric 
printHashHistograms()275806c3fb27SDimitry Andric template <typename ELFT> void ELFDumper<ELFT>::printHashHistograms() {
275906c3fb27SDimitry Andric   // Print histogram for the .hash section.
276006c3fb27SDimitry Andric   if (this->HashTable) {
276106c3fb27SDimitry Andric     if (Error E = checkHashTable<ELFT>(*this, this->HashTable))
276206c3fb27SDimitry Andric       this->reportUniqueWarning(std::move(E));
276306c3fb27SDimitry Andric     else
276406c3fb27SDimitry Andric       printHashHistogram(*this->HashTable);
276506c3fb27SDimitry Andric   }
276606c3fb27SDimitry Andric 
276706c3fb27SDimitry Andric   // Print histogram for the .gnu.hash section.
276806c3fb27SDimitry Andric   if (this->GnuHashTable) {
276906c3fb27SDimitry Andric     if (Error E = checkGNUHashTable<ELFT>(this->Obj, this->GnuHashTable))
277006c3fb27SDimitry Andric       this->reportUniqueWarning(std::move(E));
277106c3fb27SDimitry Andric     else
277206c3fb27SDimitry Andric       printGnuHashHistogram(*this->GnuHashTable);
277306c3fb27SDimitry Andric   }
277406c3fb27SDimitry Andric }
277506c3fb27SDimitry Andric 
277606c3fb27SDimitry Andric template <typename ELFT>
printHashHistogram(const Elf_Hash & HashTable) const277706c3fb27SDimitry Andric void ELFDumper<ELFT>::printHashHistogram(const Elf_Hash &HashTable) const {
277806c3fb27SDimitry Andric   size_t NBucket = HashTable.nbucket;
277906c3fb27SDimitry Andric   size_t NChain = HashTable.nchain;
278006c3fb27SDimitry Andric   ArrayRef<Elf_Word> Buckets = HashTable.buckets();
278106c3fb27SDimitry Andric   ArrayRef<Elf_Word> Chains = HashTable.chains();
278206c3fb27SDimitry Andric   size_t TotalSyms = 0;
278306c3fb27SDimitry Andric   // If hash table is correct, we have at least chains with 0 length.
278406c3fb27SDimitry Andric   size_t MaxChain = 1;
278506c3fb27SDimitry Andric 
278606c3fb27SDimitry Andric   if (NChain == 0 || NBucket == 0)
278706c3fb27SDimitry Andric     return;
278806c3fb27SDimitry Andric 
278906c3fb27SDimitry Andric   std::vector<size_t> ChainLen(NBucket, 0);
27905f757f3fSDimitry Andric   // Go over all buckets and note chain lengths of each bucket (total
279106c3fb27SDimitry Andric   // unique chain lengths).
279206c3fb27SDimitry Andric   for (size_t B = 0; B < NBucket; ++B) {
279306c3fb27SDimitry Andric     BitVector Visited(NChain);
279406c3fb27SDimitry Andric     for (size_t C = Buckets[B]; C < NChain; C = Chains[C]) {
279506c3fb27SDimitry Andric       if (C == ELF::STN_UNDEF)
279606c3fb27SDimitry Andric           break;
279706c3fb27SDimitry Andric       if (Visited[C]) {
279806c3fb27SDimitry Andric           this->reportUniqueWarning(
279906c3fb27SDimitry Andric               ".hash section is invalid: bucket " + Twine(C) +
280006c3fb27SDimitry Andric               ": a cycle was detected in the linked chain");
280106c3fb27SDimitry Andric           break;
280206c3fb27SDimitry Andric       }
280306c3fb27SDimitry Andric       Visited[C] = true;
280406c3fb27SDimitry Andric       if (MaxChain <= ++ChainLen[B])
280506c3fb27SDimitry Andric           ++MaxChain;
280606c3fb27SDimitry Andric     }
280706c3fb27SDimitry Andric     TotalSyms += ChainLen[B];
280806c3fb27SDimitry Andric   }
280906c3fb27SDimitry Andric 
281006c3fb27SDimitry Andric   if (!TotalSyms)
281106c3fb27SDimitry Andric     return;
281206c3fb27SDimitry Andric 
281306c3fb27SDimitry Andric   std::vector<size_t> Count(MaxChain, 0);
281406c3fb27SDimitry Andric   // Count how long is the chain for each bucket.
281506c3fb27SDimitry Andric   for (size_t B = 0; B < NBucket; B++)
281606c3fb27SDimitry Andric     ++Count[ChainLen[B]];
281706c3fb27SDimitry Andric   // Print Number of buckets with each chain lengths and their cumulative
281806c3fb27SDimitry Andric   // coverage of the symbols.
281906c3fb27SDimitry Andric   printHashHistogramStats(NBucket, MaxChain, TotalSyms, Count, /*IsGnu=*/false);
282006c3fb27SDimitry Andric }
282106c3fb27SDimitry Andric 
282206c3fb27SDimitry Andric template <class ELFT>
printGnuHashHistogram(const Elf_GnuHash & GnuHashTable) const282306c3fb27SDimitry Andric void ELFDumper<ELFT>::printGnuHashHistogram(
282406c3fb27SDimitry Andric     const Elf_GnuHash &GnuHashTable) const {
282506c3fb27SDimitry Andric   Expected<ArrayRef<Elf_Word>> ChainsOrErr =
282606c3fb27SDimitry Andric       getGnuHashTableChains<ELFT>(this->DynSymRegion, &GnuHashTable);
282706c3fb27SDimitry Andric   if (!ChainsOrErr) {
282806c3fb27SDimitry Andric     this->reportUniqueWarning("unable to print the GNU hash table histogram: " +
282906c3fb27SDimitry Andric                               toString(ChainsOrErr.takeError()));
283006c3fb27SDimitry Andric     return;
283106c3fb27SDimitry Andric   }
283206c3fb27SDimitry Andric 
283306c3fb27SDimitry Andric   ArrayRef<Elf_Word> Chains = *ChainsOrErr;
283406c3fb27SDimitry Andric   size_t Symndx = GnuHashTable.symndx;
283506c3fb27SDimitry Andric   size_t TotalSyms = 0;
283606c3fb27SDimitry Andric   size_t MaxChain = 1;
283706c3fb27SDimitry Andric 
283806c3fb27SDimitry Andric   size_t NBucket = GnuHashTable.nbuckets;
283906c3fb27SDimitry Andric   if (Chains.empty() || NBucket == 0)
284006c3fb27SDimitry Andric     return;
284106c3fb27SDimitry Andric 
284206c3fb27SDimitry Andric   ArrayRef<Elf_Word> Buckets = GnuHashTable.buckets();
284306c3fb27SDimitry Andric   std::vector<size_t> ChainLen(NBucket, 0);
284406c3fb27SDimitry Andric   for (size_t B = 0; B < NBucket; ++B) {
284506c3fb27SDimitry Andric     if (!Buckets[B])
284606c3fb27SDimitry Andric       continue;
284706c3fb27SDimitry Andric     size_t Len = 1;
284806c3fb27SDimitry Andric     for (size_t C = Buckets[B] - Symndx;
284906c3fb27SDimitry Andric          C < Chains.size() && (Chains[C] & 1) == 0; ++C)
285006c3fb27SDimitry Andric       if (MaxChain < ++Len)
285106c3fb27SDimitry Andric           ++MaxChain;
285206c3fb27SDimitry Andric     ChainLen[B] = Len;
285306c3fb27SDimitry Andric     TotalSyms += Len;
285406c3fb27SDimitry Andric   }
285506c3fb27SDimitry Andric   ++MaxChain;
285606c3fb27SDimitry Andric 
285706c3fb27SDimitry Andric   if (!TotalSyms)
285806c3fb27SDimitry Andric     return;
285906c3fb27SDimitry Andric 
286006c3fb27SDimitry Andric   std::vector<size_t> Count(MaxChain, 0);
286106c3fb27SDimitry Andric   for (size_t B = 0; B < NBucket; ++B)
286206c3fb27SDimitry Andric     ++Count[ChainLen[B]];
286306c3fb27SDimitry Andric   // Print Number of buckets with each chain lengths and their cumulative
286406c3fb27SDimitry Andric   // coverage of the symbols.
286506c3fb27SDimitry Andric   printHashHistogramStats(NBucket, MaxChain, TotalSyms, Count, /*IsGnu=*/true);
286606c3fb27SDimitry Andric }
286706c3fb27SDimitry Andric 
printLoadName()28680b57cec5SDimitry Andric template <typename ELFT> void ELFDumper<ELFT>::printLoadName() {
2869e8d8bef9SDimitry Andric   StringRef SOName = "<Not found>";
2870e8d8bef9SDimitry Andric   if (SONameOffset)
2871e8d8bef9SDimitry Andric     SOName = getDynamicString(*SONameOffset);
28720b57cec5SDimitry Andric   W.printString("LoadName", SOName);
28730b57cec5SDimitry Andric }
28740b57cec5SDimitry Andric 
printArchSpecificInfo()28758bcb0991SDimitry Andric template <class ELFT> void ELFDumper<ELFT>::printArchSpecificInfo() {
2876e8d8bef9SDimitry Andric   switch (Obj.getHeader().e_machine) {
28778bcb0991SDimitry Andric   case EM_ARM:
2878349cc55cSDimitry Andric     if (Obj.isLE())
2879349cc55cSDimitry Andric       printAttributes(ELF::SHT_ARM_ATTRIBUTES,
2880349cc55cSDimitry Andric                       std::make_unique<ARMAttributeParser>(&W),
28815f757f3fSDimitry Andric                       llvm::endianness::little);
2882349cc55cSDimitry Andric     else
2883349cc55cSDimitry Andric       reportUniqueWarning("attribute printing not implemented for big-endian "
2884349cc55cSDimitry Andric                           "ARM objects");
2885349cc55cSDimitry Andric     break;
28865ffd83dbSDimitry Andric   case EM_RISCV:
2887349cc55cSDimitry Andric     if (Obj.isLE())
2888349cc55cSDimitry Andric       printAttributes(ELF::SHT_RISCV_ATTRIBUTES,
2889349cc55cSDimitry Andric                       std::make_unique<RISCVAttributeParser>(&W),
28905f757f3fSDimitry Andric                       llvm::endianness::little);
2891349cc55cSDimitry Andric     else
2892349cc55cSDimitry Andric       reportUniqueWarning("attribute printing not implemented for big-endian "
2893349cc55cSDimitry Andric                           "RISC-V objects");
2894349cc55cSDimitry Andric     break;
2895349cc55cSDimitry Andric   case EM_MSP430:
2896349cc55cSDimitry Andric     printAttributes(ELF::SHT_MSP430_ATTRIBUTES,
2897349cc55cSDimitry Andric                     std::make_unique<MSP430AttributeParser>(&W),
28985f757f3fSDimitry Andric                     llvm::endianness::little);
28998bcb0991SDimitry Andric     break;
29008bcb0991SDimitry Andric   case EM_MIPS: {
2901e8d8bef9SDimitry Andric     printMipsABIFlags();
29028bcb0991SDimitry Andric     printMipsOptions();
29038bcb0991SDimitry Andric     printMipsReginfo();
2904e8d8bef9SDimitry Andric     MipsGOTParser<ELFT> Parser(*this);
29055ffd83dbSDimitry Andric     if (Error E = Parser.findGOT(dynamic_table(), dynamic_symbols()))
2906e8d8bef9SDimitry Andric       reportUniqueWarning(std::move(E));
29075ffd83dbSDimitry Andric     else if (!Parser.isGotEmpty())
2908e8d8bef9SDimitry Andric       printMipsGOT(Parser);
29095ffd83dbSDimitry Andric 
29105ffd83dbSDimitry Andric     if (Error E = Parser.findPLT(dynamic_table()))
2911e8d8bef9SDimitry Andric       reportUniqueWarning(std::move(E));
29125ffd83dbSDimitry Andric     else if (!Parser.isPltEmpty())
2913e8d8bef9SDimitry Andric       printMipsPLT(Parser);
29148bcb0991SDimitry Andric     break;
29158bcb0991SDimitry Andric   }
29168bcb0991SDimitry Andric   default:
29178bcb0991SDimitry Andric     break;
29188bcb0991SDimitry Andric   }
29198bcb0991SDimitry Andric }
29208bcb0991SDimitry Andric 
2921349cc55cSDimitry Andric template <class ELFT>
printAttributes(unsigned AttrShType,std::unique_ptr<ELFAttributeParser> AttrParser,llvm::endianness Endianness)2922349cc55cSDimitry Andric void ELFDumper<ELFT>::printAttributes(
2923349cc55cSDimitry Andric     unsigned AttrShType, std::unique_ptr<ELFAttributeParser> AttrParser,
29245f757f3fSDimitry Andric     llvm::endianness Endianness) {
2925349cc55cSDimitry Andric   assert((AttrShType != ELF::SHT_NULL) && AttrParser &&
2926349cc55cSDimitry Andric          "Incomplete ELF attribute implementation");
29270b57cec5SDimitry Andric   DictScope BA(W, "BuildAttributes");
2928e8d8bef9SDimitry Andric   for (const Elf_Shdr &Sec : cantFail(Obj.sections())) {
2929349cc55cSDimitry Andric     if (Sec.sh_type != AttrShType)
29300b57cec5SDimitry Andric       continue;
29310b57cec5SDimitry Andric 
2932e8d8bef9SDimitry Andric     ArrayRef<uint8_t> Contents;
2933e8d8bef9SDimitry Andric     if (Expected<ArrayRef<uint8_t>> ContentOrErr =
2934e8d8bef9SDimitry Andric             Obj.getSectionContents(Sec)) {
2935e8d8bef9SDimitry Andric       Contents = *ContentOrErr;
2936e8d8bef9SDimitry Andric       if (Contents.empty()) {
2937e8d8bef9SDimitry Andric         reportUniqueWarning("the " + describe(Sec) + " is empty");
29380b57cec5SDimitry Andric         continue;
29390b57cec5SDimitry Andric       }
2940e8d8bef9SDimitry Andric     } else {
2941e8d8bef9SDimitry Andric       reportUniqueWarning("unable to read the content of the " + describe(Sec) +
2942e8d8bef9SDimitry Andric                           ": " + toString(ContentOrErr.takeError()));
29430b57cec5SDimitry Andric       continue;
2944e8d8bef9SDimitry Andric     }
29450b57cec5SDimitry Andric 
2946e8d8bef9SDimitry Andric     W.printHex("FormatVersion", Contents[0]);
2947e8d8bef9SDimitry Andric 
2948349cc55cSDimitry Andric     if (Error E = AttrParser->parse(Contents, Endianness))
2949e8d8bef9SDimitry Andric       reportUniqueWarning("unable to dump attributes from the " +
2950e8d8bef9SDimitry Andric                           describe(Sec) + ": " + toString(std::move(E)));
29515ffd83dbSDimitry Andric   }
29520b57cec5SDimitry Andric }
2953e8d8bef9SDimitry Andric 
2954e8d8bef9SDimitry Andric namespace {
29550b57cec5SDimitry Andric 
29560b57cec5SDimitry Andric template <class ELFT> class MipsGOTParser {
29570b57cec5SDimitry Andric public:
2958e8d8bef9SDimitry Andric   LLVM_ELF_IMPORT_TYPES_ELFT(ELFT)
2959e8d8bef9SDimitry Andric   using Entry = typename ELFT::Addr;
29600b57cec5SDimitry Andric   using Entries = ArrayRef<Entry>;
29610b57cec5SDimitry Andric 
29620b57cec5SDimitry Andric   const bool IsStatic;
2963e8d8bef9SDimitry Andric   const ELFFile<ELFT> &Obj;
2964e8d8bef9SDimitry Andric   const ELFDumper<ELFT> &Dumper;
29650b57cec5SDimitry Andric 
2966e8d8bef9SDimitry Andric   MipsGOTParser(const ELFDumper<ELFT> &D);
29675ffd83dbSDimitry Andric   Error findGOT(Elf_Dyn_Range DynTable, Elf_Sym_Range DynSyms);
29685ffd83dbSDimitry Andric   Error findPLT(Elf_Dyn_Range DynTable);
29690b57cec5SDimitry Andric 
isGotEmpty() const29705ffd83dbSDimitry Andric   bool isGotEmpty() const { return GotEntries.empty(); }
isPltEmpty() const29715ffd83dbSDimitry Andric   bool isPltEmpty() const { return PltEntries.empty(); }
29720b57cec5SDimitry Andric 
29730b57cec5SDimitry Andric   uint64_t getGp() const;
29740b57cec5SDimitry Andric 
29750b57cec5SDimitry Andric   const Entry *getGotLazyResolver() const;
29760b57cec5SDimitry Andric   const Entry *getGotModulePointer() const;
29770b57cec5SDimitry Andric   const Entry *getPltLazyResolver() const;
29780b57cec5SDimitry Andric   const Entry *getPltModulePointer() const;
29790b57cec5SDimitry Andric 
29800b57cec5SDimitry Andric   Entries getLocalEntries() const;
29810b57cec5SDimitry Andric   Entries getGlobalEntries() const;
29820b57cec5SDimitry Andric   Entries getOtherEntries() const;
29830b57cec5SDimitry Andric   Entries getPltEntries() const;
29840b57cec5SDimitry Andric 
29850b57cec5SDimitry Andric   uint64_t getGotAddress(const Entry * E) const;
29860b57cec5SDimitry Andric   int64_t getGotOffset(const Entry * E) const;
29870b57cec5SDimitry Andric   const Elf_Sym *getGotSym(const Entry *E) const;
29880b57cec5SDimitry Andric 
29890b57cec5SDimitry Andric   uint64_t getPltAddress(const Entry * E) const;
29900b57cec5SDimitry Andric   const Elf_Sym *getPltSym(const Entry *E) const;
29910b57cec5SDimitry Andric 
getPltStrTable() const29920b57cec5SDimitry Andric   StringRef getPltStrTable() const { return PltStrTable; }
getPltSymTable() const2993e8d8bef9SDimitry Andric   const Elf_Shdr *getPltSymTable() const { return PltSymTable; }
29940b57cec5SDimitry Andric 
29950b57cec5SDimitry Andric private:
29960b57cec5SDimitry Andric   const Elf_Shdr *GotSec;
29970b57cec5SDimitry Andric   size_t LocalNum;
29980b57cec5SDimitry Andric   size_t GlobalNum;
29990b57cec5SDimitry Andric 
30000b57cec5SDimitry Andric   const Elf_Shdr *PltSec;
30010b57cec5SDimitry Andric   const Elf_Shdr *PltRelSec;
30020b57cec5SDimitry Andric   const Elf_Shdr *PltSymTable;
30038bcb0991SDimitry Andric   StringRef FileName;
30048bcb0991SDimitry Andric 
30050b57cec5SDimitry Andric   Elf_Sym_Range GotDynSyms;
30060b57cec5SDimitry Andric   StringRef PltStrTable;
30070b57cec5SDimitry Andric 
30080b57cec5SDimitry Andric   Entries GotEntries;
30090b57cec5SDimitry Andric   Entries PltEntries;
30100b57cec5SDimitry Andric };
30110b57cec5SDimitry Andric 
30120b57cec5SDimitry Andric } // end anonymous namespace
30130b57cec5SDimitry Andric 
30140b57cec5SDimitry Andric template <class ELFT>
MipsGOTParser(const ELFDumper<ELFT> & D)3015e8d8bef9SDimitry Andric MipsGOTParser<ELFT>::MipsGOTParser(const ELFDumper<ELFT> &D)
3016e8d8bef9SDimitry Andric     : IsStatic(D.dynamic_table().empty()), Obj(D.getElfObject().getELFFile()),
3017e8d8bef9SDimitry Andric       Dumper(D), GotSec(nullptr), LocalNum(0), GlobalNum(0), PltSec(nullptr),
3018e8d8bef9SDimitry Andric       PltRelSec(nullptr), PltSymTable(nullptr),
3019e8d8bef9SDimitry Andric       FileName(D.getElfObject().getFileName()) {}
30205ffd83dbSDimitry Andric 
30215ffd83dbSDimitry Andric template <class ELFT>
findGOT(Elf_Dyn_Range DynTable,Elf_Sym_Range DynSyms)30225ffd83dbSDimitry Andric Error MipsGOTParser<ELFT>::findGOT(Elf_Dyn_Range DynTable,
30235ffd83dbSDimitry Andric                                    Elf_Sym_Range DynSyms) {
30240b57cec5SDimitry Andric   // See "Global Offset Table" in Chapter 5 in the following document
30250b57cec5SDimitry Andric   // for detailed GOT description.
30260b57cec5SDimitry Andric   // ftp://www.linux-mips.org/pub/linux/mips/doc/ABI/mipsabi.pdf
30270b57cec5SDimitry Andric 
30280b57cec5SDimitry Andric   // Find static GOT secton.
30290b57cec5SDimitry Andric   if (IsStatic) {
3030e8d8bef9SDimitry Andric     GotSec = Dumper.findSectionByName(".got");
30310b57cec5SDimitry Andric     if (!GotSec)
30325ffd83dbSDimitry Andric       return Error::success();
30330b57cec5SDimitry Andric 
30348bcb0991SDimitry Andric     ArrayRef<uint8_t> Content =
3035e8d8bef9SDimitry Andric         unwrapOrError(FileName, Obj.getSectionContents(*GotSec));
30360b57cec5SDimitry Andric     GotEntries = Entries(reinterpret_cast<const Entry *>(Content.data()),
30370b57cec5SDimitry Andric                          Content.size() / sizeof(Entry));
30380b57cec5SDimitry Andric     LocalNum = GotEntries.size();
30395ffd83dbSDimitry Andric     return Error::success();
30400b57cec5SDimitry Andric   }
30410b57cec5SDimitry Andric 
30425ffd83dbSDimitry Andric   // Lookup dynamic table tags which define the GOT layout.
3043bdd1243dSDimitry Andric   std::optional<uint64_t> DtPltGot;
3044bdd1243dSDimitry Andric   std::optional<uint64_t> DtLocalGotNum;
3045bdd1243dSDimitry Andric   std::optional<uint64_t> DtGotSym;
30460b57cec5SDimitry Andric   for (const auto &Entry : DynTable) {
30470b57cec5SDimitry Andric     switch (Entry.getTag()) {
30480b57cec5SDimitry Andric     case ELF::DT_PLTGOT:
30490b57cec5SDimitry Andric       DtPltGot = Entry.getVal();
30500b57cec5SDimitry Andric       break;
30510b57cec5SDimitry Andric     case ELF::DT_MIPS_LOCAL_GOTNO:
30520b57cec5SDimitry Andric       DtLocalGotNum = Entry.getVal();
30530b57cec5SDimitry Andric       break;
30540b57cec5SDimitry Andric     case ELF::DT_MIPS_GOTSYM:
30550b57cec5SDimitry Andric       DtGotSym = Entry.getVal();
30560b57cec5SDimitry Andric       break;
30570b57cec5SDimitry Andric     }
30580b57cec5SDimitry Andric   }
30590b57cec5SDimitry Andric 
30605ffd83dbSDimitry Andric   if (!DtPltGot && !DtLocalGotNum && !DtGotSym)
30615ffd83dbSDimitry Andric     return Error::success();
30625ffd83dbSDimitry Andric 
30630b57cec5SDimitry Andric   if (!DtPltGot)
30645ffd83dbSDimitry Andric     return createError("cannot find PLTGOT dynamic tag");
30650b57cec5SDimitry Andric   if (!DtLocalGotNum)
30665ffd83dbSDimitry Andric     return createError("cannot find MIPS_LOCAL_GOTNO dynamic tag");
30670b57cec5SDimitry Andric   if (!DtGotSym)
30685ffd83dbSDimitry Andric     return createError("cannot find MIPS_GOTSYM dynamic tag");
30690b57cec5SDimitry Andric 
30700b57cec5SDimitry Andric   size_t DynSymTotal = DynSyms.size();
30710b57cec5SDimitry Andric   if (*DtGotSym > DynSymTotal)
30725ffd83dbSDimitry Andric     return createError("DT_MIPS_GOTSYM value (" + Twine(*DtGotSym) +
30735ffd83dbSDimitry Andric                        ") exceeds the number of dynamic symbols (" +
30745ffd83dbSDimitry Andric                        Twine(DynSymTotal) + ")");
30750b57cec5SDimitry Andric 
30768bcb0991SDimitry Andric   GotSec = findNotEmptySectionByAddress(Obj, FileName, *DtPltGot);
30770b57cec5SDimitry Andric   if (!GotSec)
30785ffd83dbSDimitry Andric     return createError("there is no non-empty GOT section at 0x" +
30795ffd83dbSDimitry Andric                        Twine::utohexstr(*DtPltGot));
30800b57cec5SDimitry Andric 
30810b57cec5SDimitry Andric   LocalNum = *DtLocalGotNum;
30820b57cec5SDimitry Andric   GlobalNum = DynSymTotal - *DtGotSym;
30830b57cec5SDimitry Andric 
30848bcb0991SDimitry Andric   ArrayRef<uint8_t> Content =
3085e8d8bef9SDimitry Andric       unwrapOrError(FileName, Obj.getSectionContents(*GotSec));
30860b57cec5SDimitry Andric   GotEntries = Entries(reinterpret_cast<const Entry *>(Content.data()),
30870b57cec5SDimitry Andric                        Content.size() / sizeof(Entry));
30880b57cec5SDimitry Andric   GotDynSyms = DynSyms.drop_front(*DtGotSym);
30895ffd83dbSDimitry Andric 
30905ffd83dbSDimitry Andric   return Error::success();
30910b57cec5SDimitry Andric }
30920b57cec5SDimitry Andric 
30935ffd83dbSDimitry Andric template <class ELFT>
findPLT(Elf_Dyn_Range DynTable)30945ffd83dbSDimitry Andric Error MipsGOTParser<ELFT>::findPLT(Elf_Dyn_Range DynTable) {
30955ffd83dbSDimitry Andric   // Lookup dynamic table tags which define the PLT layout.
3096bdd1243dSDimitry Andric   std::optional<uint64_t> DtMipsPltGot;
3097bdd1243dSDimitry Andric   std::optional<uint64_t> DtJmpRel;
30985ffd83dbSDimitry Andric   for (const auto &Entry : DynTable) {
30995ffd83dbSDimitry Andric     switch (Entry.getTag()) {
31005ffd83dbSDimitry Andric     case ELF::DT_MIPS_PLTGOT:
31015ffd83dbSDimitry Andric       DtMipsPltGot = Entry.getVal();
31025ffd83dbSDimitry Andric       break;
31035ffd83dbSDimitry Andric     case ELF::DT_JMPREL:
31045ffd83dbSDimitry Andric       DtJmpRel = Entry.getVal();
31055ffd83dbSDimitry Andric       break;
31065ffd83dbSDimitry Andric     }
31075ffd83dbSDimitry Andric   }
31085ffd83dbSDimitry Andric 
31095ffd83dbSDimitry Andric   if (!DtMipsPltGot && !DtJmpRel)
31105ffd83dbSDimitry Andric     return Error::success();
31115ffd83dbSDimitry Andric 
31120b57cec5SDimitry Andric   // Find PLT section.
31130b57cec5SDimitry Andric   if (!DtMipsPltGot)
31145ffd83dbSDimitry Andric     return createError("cannot find MIPS_PLTGOT dynamic tag");
31150b57cec5SDimitry Andric   if (!DtJmpRel)
31165ffd83dbSDimitry Andric     return createError("cannot find JMPREL dynamic tag");
31170b57cec5SDimitry Andric 
31188bcb0991SDimitry Andric   PltSec = findNotEmptySectionByAddress(Obj, FileName, *DtMipsPltGot);
31190b57cec5SDimitry Andric   if (!PltSec)
31205ffd83dbSDimitry Andric     return createError("there is no non-empty PLTGOT section at 0x" +
31210b57cec5SDimitry Andric                        Twine::utohexstr(*DtMipsPltGot));
31220b57cec5SDimitry Andric 
31238bcb0991SDimitry Andric   PltRelSec = findNotEmptySectionByAddress(Obj, FileName, *DtJmpRel);
31240b57cec5SDimitry Andric   if (!PltRelSec)
31255ffd83dbSDimitry Andric     return createError("there is no non-empty RELPLT section at 0x" +
31260b57cec5SDimitry Andric                        Twine::utohexstr(*DtJmpRel));
31270b57cec5SDimitry Andric 
31285ffd83dbSDimitry Andric   if (Expected<ArrayRef<uint8_t>> PltContentOrErr =
3129e8d8bef9SDimitry Andric           Obj.getSectionContents(*PltSec))
31305ffd83dbSDimitry Andric     PltEntries =
31315ffd83dbSDimitry Andric         Entries(reinterpret_cast<const Entry *>(PltContentOrErr->data()),
31325ffd83dbSDimitry Andric                 PltContentOrErr->size() / sizeof(Entry));
31335ffd83dbSDimitry Andric   else
31345ffd83dbSDimitry Andric     return createError("unable to read PLTGOT section content: " +
31355ffd83dbSDimitry Andric                        toString(PltContentOrErr.takeError()));
31360b57cec5SDimitry Andric 
31375ffd83dbSDimitry Andric   if (Expected<const Elf_Shdr *> PltSymTableOrErr =
3138e8d8bef9SDimitry Andric           Obj.getSection(PltRelSec->sh_link))
31395ffd83dbSDimitry Andric     PltSymTable = *PltSymTableOrErr;
3140e8d8bef9SDimitry Andric   else
3141e8d8bef9SDimitry Andric     return createError("unable to get a symbol table linked to the " +
3142e8d8bef9SDimitry Andric                        describe(Obj, *PltRelSec) + ": " +
31435ffd83dbSDimitry Andric                        toString(PltSymTableOrErr.takeError()));
31445ffd83dbSDimitry Andric 
31455ffd83dbSDimitry Andric   if (Expected<StringRef> StrTabOrErr =
3146e8d8bef9SDimitry Andric           Obj.getStringTableForSymtab(*PltSymTable))
31475ffd83dbSDimitry Andric     PltStrTable = *StrTabOrErr;
3148e8d8bef9SDimitry Andric   else
3149e8d8bef9SDimitry Andric     return createError("unable to get a string table for the " +
3150e8d8bef9SDimitry Andric                        describe(Obj, *PltSymTable) + ": " +
3151e8d8bef9SDimitry Andric                        toString(StrTabOrErr.takeError()));
31525ffd83dbSDimitry Andric 
31535ffd83dbSDimitry Andric   return Error::success();
31540b57cec5SDimitry Andric }
31550b57cec5SDimitry Andric 
getGp() const31560b57cec5SDimitry Andric template <class ELFT> uint64_t MipsGOTParser<ELFT>::getGp() const {
31570b57cec5SDimitry Andric   return GotSec->sh_addr + 0x7ff0;
31580b57cec5SDimitry Andric }
31590b57cec5SDimitry Andric 
31600b57cec5SDimitry Andric template <class ELFT>
31610b57cec5SDimitry Andric const typename MipsGOTParser<ELFT>::Entry *
getGotLazyResolver() const31620b57cec5SDimitry Andric MipsGOTParser<ELFT>::getGotLazyResolver() const {
31630b57cec5SDimitry Andric   return LocalNum > 0 ? &GotEntries[0] : nullptr;
31640b57cec5SDimitry Andric }
31650b57cec5SDimitry Andric 
31660b57cec5SDimitry Andric template <class ELFT>
31670b57cec5SDimitry Andric const typename MipsGOTParser<ELFT>::Entry *
getGotModulePointer() const31680b57cec5SDimitry Andric MipsGOTParser<ELFT>::getGotModulePointer() const {
31690b57cec5SDimitry Andric   if (LocalNum < 2)
31700b57cec5SDimitry Andric     return nullptr;
31710b57cec5SDimitry Andric   const Entry &E = GotEntries[1];
31720b57cec5SDimitry Andric   if ((E >> (sizeof(Entry) * 8 - 1)) == 0)
31730b57cec5SDimitry Andric     return nullptr;
31740b57cec5SDimitry Andric   return &E;
31750b57cec5SDimitry Andric }
31760b57cec5SDimitry Andric 
31770b57cec5SDimitry Andric template <class ELFT>
31780b57cec5SDimitry Andric typename MipsGOTParser<ELFT>::Entries
getLocalEntries() const31790b57cec5SDimitry Andric MipsGOTParser<ELFT>::getLocalEntries() const {
31800b57cec5SDimitry Andric   size_t Skip = getGotModulePointer() ? 2 : 1;
31810b57cec5SDimitry Andric   if (LocalNum - Skip <= 0)
31820b57cec5SDimitry Andric     return Entries();
31830b57cec5SDimitry Andric   return GotEntries.slice(Skip, LocalNum - Skip);
31840b57cec5SDimitry Andric }
31850b57cec5SDimitry Andric 
31860b57cec5SDimitry Andric template <class ELFT>
31870b57cec5SDimitry Andric typename MipsGOTParser<ELFT>::Entries
getGlobalEntries() const31880b57cec5SDimitry Andric MipsGOTParser<ELFT>::getGlobalEntries() const {
31890b57cec5SDimitry Andric   if (GlobalNum == 0)
31900b57cec5SDimitry Andric     return Entries();
31910b57cec5SDimitry Andric   return GotEntries.slice(LocalNum, GlobalNum);
31920b57cec5SDimitry Andric }
31930b57cec5SDimitry Andric 
31940b57cec5SDimitry Andric template <class ELFT>
31950b57cec5SDimitry Andric typename MipsGOTParser<ELFT>::Entries
getOtherEntries() const31960b57cec5SDimitry Andric MipsGOTParser<ELFT>::getOtherEntries() const {
31970b57cec5SDimitry Andric   size_t OtherNum = GotEntries.size() - LocalNum - GlobalNum;
31980b57cec5SDimitry Andric   if (OtherNum == 0)
31990b57cec5SDimitry Andric     return Entries();
32000b57cec5SDimitry Andric   return GotEntries.slice(LocalNum + GlobalNum, OtherNum);
32010b57cec5SDimitry Andric }
32020b57cec5SDimitry Andric 
32030b57cec5SDimitry Andric template <class ELFT>
getGotAddress(const Entry * E) const32040b57cec5SDimitry Andric uint64_t MipsGOTParser<ELFT>::getGotAddress(const Entry *E) const {
32050b57cec5SDimitry Andric   int64_t Offset = std::distance(GotEntries.data(), E) * sizeof(Entry);
32060b57cec5SDimitry Andric   return GotSec->sh_addr + Offset;
32070b57cec5SDimitry Andric }
32080b57cec5SDimitry Andric 
32090b57cec5SDimitry Andric template <class ELFT>
getGotOffset(const Entry * E) const32100b57cec5SDimitry Andric int64_t MipsGOTParser<ELFT>::getGotOffset(const Entry *E) const {
32110b57cec5SDimitry Andric   int64_t Offset = std::distance(GotEntries.data(), E) * sizeof(Entry);
32120b57cec5SDimitry Andric   return Offset - 0x7ff0;
32130b57cec5SDimitry Andric }
32140b57cec5SDimitry Andric 
32150b57cec5SDimitry Andric template <class ELFT>
32160b57cec5SDimitry Andric const typename MipsGOTParser<ELFT>::Elf_Sym *
getGotSym(const Entry * E) const32170b57cec5SDimitry Andric MipsGOTParser<ELFT>::getGotSym(const Entry *E) const {
32180b57cec5SDimitry Andric   int64_t Offset = std::distance(GotEntries.data(), E);
32190b57cec5SDimitry Andric   return &GotDynSyms[Offset - LocalNum];
32200b57cec5SDimitry Andric }
32210b57cec5SDimitry Andric 
32220b57cec5SDimitry Andric template <class ELFT>
32230b57cec5SDimitry Andric const typename MipsGOTParser<ELFT>::Entry *
getPltLazyResolver() const32240b57cec5SDimitry Andric MipsGOTParser<ELFT>::getPltLazyResolver() const {
32250b57cec5SDimitry Andric   return PltEntries.empty() ? nullptr : &PltEntries[0];
32260b57cec5SDimitry Andric }
32270b57cec5SDimitry Andric 
32280b57cec5SDimitry Andric template <class ELFT>
32290b57cec5SDimitry Andric const typename MipsGOTParser<ELFT>::Entry *
getPltModulePointer() const32300b57cec5SDimitry Andric MipsGOTParser<ELFT>::getPltModulePointer() const {
32310b57cec5SDimitry Andric   return PltEntries.size() < 2 ? nullptr : &PltEntries[1];
32320b57cec5SDimitry Andric }
32330b57cec5SDimitry Andric 
32340b57cec5SDimitry Andric template <class ELFT>
32350b57cec5SDimitry Andric typename MipsGOTParser<ELFT>::Entries
getPltEntries() const32360b57cec5SDimitry Andric MipsGOTParser<ELFT>::getPltEntries() const {
32370b57cec5SDimitry Andric   if (PltEntries.size() <= 2)
32380b57cec5SDimitry Andric     return Entries();
32390b57cec5SDimitry Andric   return PltEntries.slice(2, PltEntries.size() - 2);
32400b57cec5SDimitry Andric }
32410b57cec5SDimitry Andric 
32420b57cec5SDimitry Andric template <class ELFT>
getPltAddress(const Entry * E) const32430b57cec5SDimitry Andric uint64_t MipsGOTParser<ELFT>::getPltAddress(const Entry *E) const {
32440b57cec5SDimitry Andric   int64_t Offset = std::distance(PltEntries.data(), E) * sizeof(Entry);
32450b57cec5SDimitry Andric   return PltSec->sh_addr + Offset;
32460b57cec5SDimitry Andric }
32470b57cec5SDimitry Andric 
32480b57cec5SDimitry Andric template <class ELFT>
32490b57cec5SDimitry Andric const typename MipsGOTParser<ELFT>::Elf_Sym *
getPltSym(const Entry * E) const32500b57cec5SDimitry Andric MipsGOTParser<ELFT>::getPltSym(const Entry *E) const {
32510b57cec5SDimitry Andric   int64_t Offset = std::distance(getPltEntries().data(), E);
32520b57cec5SDimitry Andric   if (PltRelSec->sh_type == ELF::SHT_REL) {
3253e8d8bef9SDimitry Andric     Elf_Rel_Range Rels = unwrapOrError(FileName, Obj.rels(*PltRelSec));
32548bcb0991SDimitry Andric     return unwrapOrError(FileName,
3255e8d8bef9SDimitry Andric                          Obj.getRelocationSymbol(Rels[Offset], PltSymTable));
32560b57cec5SDimitry Andric   } else {
3257e8d8bef9SDimitry Andric     Elf_Rela_Range Rels = unwrapOrError(FileName, Obj.relas(*PltRelSec));
32588bcb0991SDimitry Andric     return unwrapOrError(FileName,
3259e8d8bef9SDimitry Andric                          Obj.getRelocationSymbol(Rels[Offset], PltSymTable));
32600b57cec5SDimitry Andric   }
32610b57cec5SDimitry Andric }
32620b57cec5SDimitry Andric 
3263349cc55cSDimitry Andric const EnumEntry<unsigned> ElfMipsISAExtType[] = {
32640b57cec5SDimitry Andric   {"None",                    Mips::AFL_EXT_NONE},
32650b57cec5SDimitry Andric   {"Broadcom SB-1",           Mips::AFL_EXT_SB1},
32660b57cec5SDimitry Andric   {"Cavium Networks Octeon",  Mips::AFL_EXT_OCTEON},
32670b57cec5SDimitry Andric   {"Cavium Networks Octeon2", Mips::AFL_EXT_OCTEON2},
32680b57cec5SDimitry Andric   {"Cavium Networks OcteonP", Mips::AFL_EXT_OCTEONP},
32690b57cec5SDimitry Andric   {"Cavium Networks Octeon3", Mips::AFL_EXT_OCTEON3},
32700b57cec5SDimitry Andric   {"LSI R4010",               Mips::AFL_EXT_4010},
32710b57cec5SDimitry Andric   {"Loongson 2E",             Mips::AFL_EXT_LOONGSON_2E},
32720b57cec5SDimitry Andric   {"Loongson 2F",             Mips::AFL_EXT_LOONGSON_2F},
32730b57cec5SDimitry Andric   {"Loongson 3A",             Mips::AFL_EXT_LOONGSON_3A},
32740b57cec5SDimitry Andric   {"MIPS R4650",              Mips::AFL_EXT_4650},
32750b57cec5SDimitry Andric   {"MIPS R5900",              Mips::AFL_EXT_5900},
32760b57cec5SDimitry Andric   {"MIPS R10000",             Mips::AFL_EXT_10000},
32770b57cec5SDimitry Andric   {"NEC VR4100",              Mips::AFL_EXT_4100},
32780b57cec5SDimitry Andric   {"NEC VR4111/VR4181",       Mips::AFL_EXT_4111},
32790b57cec5SDimitry Andric   {"NEC VR4120",              Mips::AFL_EXT_4120},
32800b57cec5SDimitry Andric   {"NEC VR5400",              Mips::AFL_EXT_5400},
32810b57cec5SDimitry Andric   {"NEC VR5500",              Mips::AFL_EXT_5500},
32820b57cec5SDimitry Andric   {"RMI Xlr",                 Mips::AFL_EXT_XLR},
32830b57cec5SDimitry Andric   {"Toshiba R3900",           Mips::AFL_EXT_3900}
32840b57cec5SDimitry Andric };
32850b57cec5SDimitry Andric 
3286349cc55cSDimitry Andric const EnumEntry<unsigned> ElfMipsASEFlags[] = {
32870b57cec5SDimitry Andric   {"DSP",                Mips::AFL_ASE_DSP},
32880b57cec5SDimitry Andric   {"DSPR2",              Mips::AFL_ASE_DSPR2},
32890b57cec5SDimitry Andric   {"Enhanced VA Scheme", Mips::AFL_ASE_EVA},
32900b57cec5SDimitry Andric   {"MCU",                Mips::AFL_ASE_MCU},
32910b57cec5SDimitry Andric   {"MDMX",               Mips::AFL_ASE_MDMX},
32920b57cec5SDimitry Andric   {"MIPS-3D",            Mips::AFL_ASE_MIPS3D},
32930b57cec5SDimitry Andric   {"MT",                 Mips::AFL_ASE_MT},
32940b57cec5SDimitry Andric   {"SmartMIPS",          Mips::AFL_ASE_SMARTMIPS},
32950b57cec5SDimitry Andric   {"VZ",                 Mips::AFL_ASE_VIRT},
32960b57cec5SDimitry Andric   {"MSA",                Mips::AFL_ASE_MSA},
32970b57cec5SDimitry Andric   {"MIPS16",             Mips::AFL_ASE_MIPS16},
32980b57cec5SDimitry Andric   {"microMIPS",          Mips::AFL_ASE_MICROMIPS},
32990b57cec5SDimitry Andric   {"XPA",                Mips::AFL_ASE_XPA},
33000b57cec5SDimitry Andric   {"CRC",                Mips::AFL_ASE_CRC},
33010b57cec5SDimitry Andric   {"GINV",               Mips::AFL_ASE_GINV},
33020b57cec5SDimitry Andric };
33030b57cec5SDimitry Andric 
3304349cc55cSDimitry Andric const EnumEntry<unsigned> ElfMipsFpABIType[] = {
33050b57cec5SDimitry Andric   {"Hard or soft float",                  Mips::Val_GNU_MIPS_ABI_FP_ANY},
33060b57cec5SDimitry Andric   {"Hard float (double precision)",       Mips::Val_GNU_MIPS_ABI_FP_DOUBLE},
33070b57cec5SDimitry Andric   {"Hard float (single precision)",       Mips::Val_GNU_MIPS_ABI_FP_SINGLE},
33080b57cec5SDimitry Andric   {"Soft float",                          Mips::Val_GNU_MIPS_ABI_FP_SOFT},
33090b57cec5SDimitry Andric   {"Hard float (MIPS32r2 64-bit FPU 12 callee-saved)",
33100b57cec5SDimitry Andric    Mips::Val_GNU_MIPS_ABI_FP_OLD_64},
33110b57cec5SDimitry Andric   {"Hard float (32-bit CPU, Any FPU)",    Mips::Val_GNU_MIPS_ABI_FP_XX},
33120b57cec5SDimitry Andric   {"Hard float (32-bit CPU, 64-bit FPU)", Mips::Val_GNU_MIPS_ABI_FP_64},
33130b57cec5SDimitry Andric   {"Hard float compat (32-bit CPU, 64-bit FPU)",
33140b57cec5SDimitry Andric    Mips::Val_GNU_MIPS_ABI_FP_64A}
33150b57cec5SDimitry Andric };
33160b57cec5SDimitry Andric 
33170b57cec5SDimitry Andric static const EnumEntry<unsigned> ElfMipsFlags1[] {
33180b57cec5SDimitry Andric   {"ODDSPREG", Mips::AFL_FLAGS1_ODDSPREG},
33190b57cec5SDimitry Andric };
33200b57cec5SDimitry Andric 
getMipsRegisterSize(uint8_t Flag)33210b57cec5SDimitry Andric static int getMipsRegisterSize(uint8_t Flag) {
33220b57cec5SDimitry Andric   switch (Flag) {
33230b57cec5SDimitry Andric   case Mips::AFL_REG_NONE:
33240b57cec5SDimitry Andric     return 0;
33250b57cec5SDimitry Andric   case Mips::AFL_REG_32:
33260b57cec5SDimitry Andric     return 32;
33270b57cec5SDimitry Andric   case Mips::AFL_REG_64:
33280b57cec5SDimitry Andric     return 64;
33290b57cec5SDimitry Andric   case Mips::AFL_REG_128:
33300b57cec5SDimitry Andric     return 128;
33310b57cec5SDimitry Andric   default:
33320b57cec5SDimitry Andric     return -1;
33330b57cec5SDimitry Andric   }
33340b57cec5SDimitry Andric }
33350b57cec5SDimitry Andric 
33360b57cec5SDimitry Andric template <class ELFT>
printMipsReginfoData(ScopedPrinter & W,const Elf_Mips_RegInfo<ELFT> & Reginfo)33370b57cec5SDimitry Andric static void printMipsReginfoData(ScopedPrinter &W,
33380b57cec5SDimitry Andric                                  const Elf_Mips_RegInfo<ELFT> &Reginfo) {
33390b57cec5SDimitry Andric   W.printHex("GP", Reginfo.ri_gp_value);
33400b57cec5SDimitry Andric   W.printHex("General Mask", Reginfo.ri_gprmask);
33410b57cec5SDimitry Andric   W.printHex("Co-Proc Mask0", Reginfo.ri_cprmask[0]);
33420b57cec5SDimitry Andric   W.printHex("Co-Proc Mask1", Reginfo.ri_cprmask[1]);
33430b57cec5SDimitry Andric   W.printHex("Co-Proc Mask2", Reginfo.ri_cprmask[2]);
33440b57cec5SDimitry Andric   W.printHex("Co-Proc Mask3", Reginfo.ri_cprmask[3]);
33450b57cec5SDimitry Andric }
33460b57cec5SDimitry Andric 
printMipsReginfo()33470b57cec5SDimitry Andric template <class ELFT> void ELFDumper<ELFT>::printMipsReginfo() {
3348e8d8bef9SDimitry Andric   const Elf_Shdr *RegInfoSec = findSectionByName(".reginfo");
3349e8d8bef9SDimitry Andric   if (!RegInfoSec) {
33500b57cec5SDimitry Andric     W.startLine() << "There is no .reginfo section in the file.\n";
33510b57cec5SDimitry Andric     return;
33520b57cec5SDimitry Andric   }
3353e8d8bef9SDimitry Andric 
3354e8d8bef9SDimitry Andric   Expected<ArrayRef<uint8_t>> ContentsOrErr =
3355e8d8bef9SDimitry Andric       Obj.getSectionContents(*RegInfoSec);
3356e8d8bef9SDimitry Andric   if (!ContentsOrErr) {
3357e8d8bef9SDimitry Andric     this->reportUniqueWarning(
3358e8d8bef9SDimitry Andric         "unable to read the content of the .reginfo section (" +
3359e8d8bef9SDimitry Andric         describe(*RegInfoSec) + "): " + toString(ContentsOrErr.takeError()));
3360e8d8bef9SDimitry Andric     return;
3361e8d8bef9SDimitry Andric   }
3362e8d8bef9SDimitry Andric 
3363e8d8bef9SDimitry Andric   if (ContentsOrErr->size() < sizeof(Elf_Mips_RegInfo<ELFT>)) {
3364e8d8bef9SDimitry Andric     this->reportUniqueWarning("the .reginfo section has an invalid size (0x" +
3365e8d8bef9SDimitry Andric                               Twine::utohexstr(ContentsOrErr->size()) + ")");
33660b57cec5SDimitry Andric     return;
33670b57cec5SDimitry Andric   }
33680b57cec5SDimitry Andric 
33690b57cec5SDimitry Andric   DictScope GS(W, "MIPS RegInfo");
3370e8d8bef9SDimitry Andric   printMipsReginfoData(W, *reinterpret_cast<const Elf_Mips_RegInfo<ELFT> *>(
3371e8d8bef9SDimitry Andric                               ContentsOrErr->data()));
3372e8d8bef9SDimitry Andric }
3373e8d8bef9SDimitry Andric 
3374e8d8bef9SDimitry Andric template <class ELFT>
3375e8d8bef9SDimitry Andric static Expected<const Elf_Mips_Options<ELFT> *>
readMipsOptions(const uint8_t * SecBegin,ArrayRef<uint8_t> & SecData,bool & IsSupported)3376e8d8bef9SDimitry Andric readMipsOptions(const uint8_t *SecBegin, ArrayRef<uint8_t> &SecData,
3377e8d8bef9SDimitry Andric                 bool &IsSupported) {
3378e8d8bef9SDimitry Andric   if (SecData.size() < sizeof(Elf_Mips_Options<ELFT>))
3379e8d8bef9SDimitry Andric     return createError("the .MIPS.options section has an invalid size (0x" +
3380e8d8bef9SDimitry Andric                        Twine::utohexstr(SecData.size()) + ")");
3381e8d8bef9SDimitry Andric 
3382e8d8bef9SDimitry Andric   const Elf_Mips_Options<ELFT> *O =
3383e8d8bef9SDimitry Andric       reinterpret_cast<const Elf_Mips_Options<ELFT> *>(SecData.data());
3384e8d8bef9SDimitry Andric   const uint8_t Size = O->size;
3385e8d8bef9SDimitry Andric   if (Size > SecData.size()) {
3386e8d8bef9SDimitry Andric     const uint64_t Offset = SecData.data() - SecBegin;
3387e8d8bef9SDimitry Andric     const uint64_t SecSize = Offset + SecData.size();
3388e8d8bef9SDimitry Andric     return createError("a descriptor of size 0x" + Twine::utohexstr(Size) +
3389e8d8bef9SDimitry Andric                        " at offset 0x" + Twine::utohexstr(Offset) +
3390e8d8bef9SDimitry Andric                        " goes past the end of the .MIPS.options "
3391e8d8bef9SDimitry Andric                        "section of size 0x" +
3392e8d8bef9SDimitry Andric                        Twine::utohexstr(SecSize));
3393e8d8bef9SDimitry Andric   }
3394e8d8bef9SDimitry Andric 
3395e8d8bef9SDimitry Andric   IsSupported = O->kind == ODK_REGINFO;
3396e8d8bef9SDimitry Andric   const size_t ExpectedSize =
3397e8d8bef9SDimitry Andric       sizeof(Elf_Mips_Options<ELFT>) + sizeof(Elf_Mips_RegInfo<ELFT>);
3398e8d8bef9SDimitry Andric 
3399e8d8bef9SDimitry Andric   if (IsSupported)
3400e8d8bef9SDimitry Andric     if (Size < ExpectedSize)
3401e8d8bef9SDimitry Andric       return createError(
3402e8d8bef9SDimitry Andric           "a .MIPS.options entry of kind " +
3403e8d8bef9SDimitry Andric           Twine(getElfMipsOptionsOdkType(O->kind)) +
3404e8d8bef9SDimitry Andric           " has an invalid size (0x" + Twine::utohexstr(Size) +
3405e8d8bef9SDimitry Andric           "), the expected size is 0x" + Twine::utohexstr(ExpectedSize));
3406e8d8bef9SDimitry Andric 
3407e8d8bef9SDimitry Andric   SecData = SecData.drop_front(Size);
3408e8d8bef9SDimitry Andric   return O;
34090b57cec5SDimitry Andric }
34100b57cec5SDimitry Andric 
printMipsOptions()34110b57cec5SDimitry Andric template <class ELFT> void ELFDumper<ELFT>::printMipsOptions() {
3412e8d8bef9SDimitry Andric   const Elf_Shdr *MipsOpts = findSectionByName(".MIPS.options");
3413e8d8bef9SDimitry Andric   if (!MipsOpts) {
34140b57cec5SDimitry Andric     W.startLine() << "There is no .MIPS.options section in the file.\n";
34150b57cec5SDimitry Andric     return;
34160b57cec5SDimitry Andric   }
34170b57cec5SDimitry Andric 
34180b57cec5SDimitry Andric   DictScope GS(W, "MIPS Options");
34190b57cec5SDimitry Andric 
3420e8d8bef9SDimitry Andric   ArrayRef<uint8_t> Data =
3421e8d8bef9SDimitry Andric       unwrapOrError(ObjF.getFileName(), Obj.getSectionContents(*MipsOpts));
3422e8d8bef9SDimitry Andric   const uint8_t *const SecBegin = Data.begin();
3423e8d8bef9SDimitry Andric   while (!Data.empty()) {
3424e8d8bef9SDimitry Andric     bool IsSupported;
3425e8d8bef9SDimitry Andric     Expected<const Elf_Mips_Options<ELFT> *> OptsOrErr =
3426e8d8bef9SDimitry Andric         readMipsOptions<ELFT>(SecBegin, Data, IsSupported);
3427e8d8bef9SDimitry Andric     if (!OptsOrErr) {
3428e8d8bef9SDimitry Andric       reportUniqueWarning(OptsOrErr.takeError());
34290b57cec5SDimitry Andric       break;
34300b57cec5SDimitry Andric     }
3431e8d8bef9SDimitry Andric 
3432e8d8bef9SDimitry Andric     unsigned Kind = (*OptsOrErr)->kind;
3433e8d8bef9SDimitry Andric     const char *Type = getElfMipsOptionsOdkType(Kind);
3434e8d8bef9SDimitry Andric     if (!IsSupported) {
3435e8d8bef9SDimitry Andric       W.startLine() << "Unsupported MIPS options tag: " << Type << " (" << Kind
3436e8d8bef9SDimitry Andric                     << ")\n";
3437e8d8bef9SDimitry Andric       continue;
3438e8d8bef9SDimitry Andric     }
3439e8d8bef9SDimitry Andric 
3440e8d8bef9SDimitry Andric     DictScope GS(W, Type);
3441e8d8bef9SDimitry Andric     if (Kind == ODK_REGINFO)
3442e8d8bef9SDimitry Andric       printMipsReginfoData(W, (*OptsOrErr)->getRegInfo());
3443e8d8bef9SDimitry Andric     else
3444e8d8bef9SDimitry Andric       llvm_unreachable("unexpected .MIPS.options section descriptor kind");
34450b57cec5SDimitry Andric   }
34460b57cec5SDimitry Andric }
34470b57cec5SDimitry Andric 
printStackMap() const34480b57cec5SDimitry Andric template <class ELFT> void ELFDumper<ELFT>::printStackMap() const {
3449e8d8bef9SDimitry Andric   const Elf_Shdr *StackMapSection = findSectionByName(".llvm_stackmaps");
34500b57cec5SDimitry Andric   if (!StackMapSection)
34510b57cec5SDimitry Andric     return;
34520b57cec5SDimitry Andric 
3453e8d8bef9SDimitry Andric   auto Warn = [&](Error &&E) {
3454e8d8bef9SDimitry Andric     this->reportUniqueWarning("unable to read the stack map from " +
3455e8d8bef9SDimitry Andric                               describe(*StackMapSection) + ": " +
3456e8d8bef9SDimitry Andric                               toString(std::move(E)));
3457e8d8bef9SDimitry Andric   };
34580b57cec5SDimitry Andric 
3459e8d8bef9SDimitry Andric   Expected<ArrayRef<uint8_t>> ContentOrErr =
3460e8d8bef9SDimitry Andric       Obj.getSectionContents(*StackMapSection);
3461e8d8bef9SDimitry Andric   if (!ContentOrErr) {
3462e8d8bef9SDimitry Andric     Warn(ContentOrErr.takeError());
3463e8d8bef9SDimitry Andric     return;
34640b57cec5SDimitry Andric   }
34650b57cec5SDimitry Andric 
3466e8d8bef9SDimitry Andric   if (Error E = StackMapParser<ELFT::TargetEndianness>::validateHeader(
3467e8d8bef9SDimitry Andric           *ContentOrErr)) {
3468e8d8bef9SDimitry Andric     Warn(std::move(E));
3469e8d8bef9SDimitry Andric     return;
34700b57cec5SDimitry Andric   }
34710b57cec5SDimitry Andric 
3472e8d8bef9SDimitry Andric   prettyPrintStackMap(W, StackMapParser<ELFT::TargetEndianness>(*ContentOrErr));
3473e8d8bef9SDimitry Andric }
3474e8d8bef9SDimitry Andric 
3475e8d8bef9SDimitry Andric template <class ELFT>
printReloc(const Relocation<ELFT> & R,unsigned RelIndex,const Elf_Shdr & Sec,const Elf_Shdr * SymTab)3476e8d8bef9SDimitry Andric void ELFDumper<ELFT>::printReloc(const Relocation<ELFT> &R, unsigned RelIndex,
3477e8d8bef9SDimitry Andric                                  const Elf_Shdr &Sec, const Elf_Shdr *SymTab) {
3478e8d8bef9SDimitry Andric   Expected<RelSymbol<ELFT>> Target = getRelocationTarget(R, SymTab);
3479e8d8bef9SDimitry Andric   if (!Target)
3480e8d8bef9SDimitry Andric     reportUniqueWarning("unable to print relocation " + Twine(RelIndex) +
3481e8d8bef9SDimitry Andric                         " in " + describe(Sec) + ": " +
3482e8d8bef9SDimitry Andric                         toString(Target.takeError()));
3483e8d8bef9SDimitry Andric   else
3484e8d8bef9SDimitry Andric     printRelRelaReloc(R, *Target);
34850b57cec5SDimitry Andric }
34860b57cec5SDimitry Andric 
348706c3fb27SDimitry Andric template <class ELFT>
348806c3fb27SDimitry Andric std::vector<EnumEntry<unsigned>>
getOtherFlagsFromSymbol(const Elf_Ehdr & Header,const Elf_Sym & Symbol) const348906c3fb27SDimitry Andric ELFDumper<ELFT>::getOtherFlagsFromSymbol(const Elf_Ehdr &Header,
349006c3fb27SDimitry Andric                                          const Elf_Sym &Symbol) const {
349106c3fb27SDimitry Andric   std::vector<EnumEntry<unsigned>> SymOtherFlags(std::begin(ElfSymOtherFlags),
349206c3fb27SDimitry Andric                                                  std::end(ElfSymOtherFlags));
349306c3fb27SDimitry Andric   if (Header.e_machine == EM_MIPS) {
349406c3fb27SDimitry Andric     // Someone in their infinite wisdom decided to make STO_MIPS_MIPS16
349506c3fb27SDimitry Andric     // flag overlap with other ST_MIPS_xxx flags. So consider both
349606c3fb27SDimitry Andric     // cases separately.
349706c3fb27SDimitry Andric     if ((Symbol.st_other & STO_MIPS_MIPS16) == STO_MIPS_MIPS16)
349806c3fb27SDimitry Andric       SymOtherFlags.insert(SymOtherFlags.end(),
349906c3fb27SDimitry Andric                            std::begin(ElfMips16SymOtherFlags),
350006c3fb27SDimitry Andric                            std::end(ElfMips16SymOtherFlags));
350106c3fb27SDimitry Andric     else
350206c3fb27SDimitry Andric       SymOtherFlags.insert(SymOtherFlags.end(),
350306c3fb27SDimitry Andric                            std::begin(ElfMipsSymOtherFlags),
350406c3fb27SDimitry Andric                            std::end(ElfMipsSymOtherFlags));
350506c3fb27SDimitry Andric   } else if (Header.e_machine == EM_AARCH64) {
350606c3fb27SDimitry Andric     SymOtherFlags.insert(SymOtherFlags.end(),
350706c3fb27SDimitry Andric                          std::begin(ElfAArch64SymOtherFlags),
350806c3fb27SDimitry Andric                          std::end(ElfAArch64SymOtherFlags));
350906c3fb27SDimitry Andric   } else if (Header.e_machine == EM_RISCV) {
351006c3fb27SDimitry Andric     SymOtherFlags.insert(SymOtherFlags.end(), std::begin(ElfRISCVSymOtherFlags),
351106c3fb27SDimitry Andric                          std::end(ElfRISCVSymOtherFlags));
351206c3fb27SDimitry Andric   }
351306c3fb27SDimitry Andric   return SymOtherFlags;
351406c3fb27SDimitry Andric }
351506c3fb27SDimitry Andric 
printFields(formatted_raw_ostream & OS,StringRef Str1,StringRef Str2)35160b57cec5SDimitry Andric static inline void printFields(formatted_raw_ostream &OS, StringRef Str1,
35170b57cec5SDimitry Andric                                StringRef Str2) {
35180b57cec5SDimitry Andric   OS.PadToColumn(2u);
35190b57cec5SDimitry Andric   OS << Str1;
35200b57cec5SDimitry Andric   OS.PadToColumn(37u);
35210b57cec5SDimitry Andric   OS << Str2 << "\n";
35220b57cec5SDimitry Andric   OS.flush();
35230b57cec5SDimitry Andric }
35240b57cec5SDimitry Andric 
35250b57cec5SDimitry Andric template <class ELFT>
getSectionHeadersNumString(const ELFFile<ELFT> & Obj,StringRef FileName)3526e8d8bef9SDimitry Andric static std::string getSectionHeadersNumString(const ELFFile<ELFT> &Obj,
35278bcb0991SDimitry Andric                                               StringRef FileName) {
3528e8d8bef9SDimitry Andric   const typename ELFT::Ehdr &ElfHeader = Obj.getHeader();
3529e8d8bef9SDimitry Andric   if (ElfHeader.e_shnum != 0)
3530e8d8bef9SDimitry Andric     return to_string(ElfHeader.e_shnum);
35310b57cec5SDimitry Andric 
3532e8d8bef9SDimitry Andric   Expected<ArrayRef<typename ELFT::Shdr>> ArrOrErr = Obj.sections();
3533e8d8bef9SDimitry Andric   if (!ArrOrErr) {
3534e8d8bef9SDimitry Andric     // In this case we can ignore an error, because we have already reported a
3535e8d8bef9SDimitry Andric     // warning about the broken section header table earlier.
3536e8d8bef9SDimitry Andric     consumeError(ArrOrErr.takeError());
3537e8d8bef9SDimitry Andric     return "<?>";
3538e8d8bef9SDimitry Andric   }
3539e8d8bef9SDimitry Andric 
3540e8d8bef9SDimitry Andric   if (ArrOrErr->empty())
35410b57cec5SDimitry Andric     return "0";
3542e8d8bef9SDimitry Andric   return "0 (" + to_string((*ArrOrErr)[0].sh_size) + ")";
35430b57cec5SDimitry Andric }
35440b57cec5SDimitry Andric 
35450b57cec5SDimitry Andric template <class ELFT>
getSectionHeaderTableIndexString(const ELFFile<ELFT> & Obj,StringRef FileName)3546e8d8bef9SDimitry Andric static std::string getSectionHeaderTableIndexString(const ELFFile<ELFT> &Obj,
35478bcb0991SDimitry Andric                                                     StringRef FileName) {
3548e8d8bef9SDimitry Andric   const typename ELFT::Ehdr &ElfHeader = Obj.getHeader();
3549e8d8bef9SDimitry Andric   if (ElfHeader.e_shstrndx != SHN_XINDEX)
3550e8d8bef9SDimitry Andric     return to_string(ElfHeader.e_shstrndx);
35510b57cec5SDimitry Andric 
3552e8d8bef9SDimitry Andric   Expected<ArrayRef<typename ELFT::Shdr>> ArrOrErr = Obj.sections();
3553e8d8bef9SDimitry Andric   if (!ArrOrErr) {
3554e8d8bef9SDimitry Andric     // In this case we can ignore an error, because we have already reported a
3555e8d8bef9SDimitry Andric     // warning about the broken section header table earlier.
3556e8d8bef9SDimitry Andric     consumeError(ArrOrErr.takeError());
3557e8d8bef9SDimitry Andric     return "<?>";
35580b57cec5SDimitry Andric   }
35590b57cec5SDimitry Andric 
3560e8d8bef9SDimitry Andric   if (ArrOrErr->empty())
3561e8d8bef9SDimitry Andric     return "65535 (corrupt: out of range)";
3562e8d8bef9SDimitry Andric   return to_string(ElfHeader.e_shstrndx) + " (" +
3563e8d8bef9SDimitry Andric          to_string((*ArrOrErr)[0].sh_link) + ")";
3564e8d8bef9SDimitry Andric }
3565e8d8bef9SDimitry Andric 
getObjectFileEnumEntry(unsigned Type)3566e8d8bef9SDimitry Andric static const EnumEntry<unsigned> *getObjectFileEnumEntry(unsigned Type) {
3567e8d8bef9SDimitry Andric   auto It = llvm::find_if(ElfObjectFileType, [&](const EnumEntry<unsigned> &E) {
3568e8d8bef9SDimitry Andric     return E.Value == Type;
3569e8d8bef9SDimitry Andric   });
3570bdd1243dSDimitry Andric   if (It != ArrayRef(ElfObjectFileType).end())
3571e8d8bef9SDimitry Andric     return It;
3572e8d8bef9SDimitry Andric   return nullptr;
3573e8d8bef9SDimitry Andric }
3574e8d8bef9SDimitry Andric 
35750eae32dcSDimitry Andric template <class ELFT>
printFileSummary(StringRef FileStr,ObjectFile & Obj,ArrayRef<std::string> InputFilenames,const Archive * A)35760eae32dcSDimitry Andric void GNUELFDumper<ELFT>::printFileSummary(StringRef FileStr, ObjectFile &Obj,
35770eae32dcSDimitry Andric                                           ArrayRef<std::string> InputFilenames,
35780eae32dcSDimitry Andric                                           const Archive *A) {
35790eae32dcSDimitry Andric   if (InputFilenames.size() > 1 || A) {
35800eae32dcSDimitry Andric     this->W.startLine() << "\n";
35810eae32dcSDimitry Andric     this->W.printString("File", FileStr);
35820eae32dcSDimitry Andric   }
35830eae32dcSDimitry Andric }
35840eae32dcSDimitry Andric 
printFileHeaders()3585e8d8bef9SDimitry Andric template <class ELFT> void GNUELFDumper<ELFT>::printFileHeaders() {
3586e8d8bef9SDimitry Andric   const Elf_Ehdr &e = this->Obj.getHeader();
35870b57cec5SDimitry Andric   OS << "ELF Header:\n";
35880b57cec5SDimitry Andric   OS << "  Magic:  ";
35890b57cec5SDimitry Andric   std::string Str;
35900b57cec5SDimitry Andric   for (int i = 0; i < ELF::EI_NIDENT; i++)
3591e8d8bef9SDimitry Andric     OS << format(" %02x", static_cast<int>(e.e_ident[i]));
35920b57cec5SDimitry Andric   OS << "\n";
3593bdd1243dSDimitry Andric   Str = enumToString(e.e_ident[ELF::EI_CLASS], ArrayRef(ElfClass));
35940b57cec5SDimitry Andric   printFields(OS, "Class:", Str);
3595bdd1243dSDimitry Andric   Str = enumToString(e.e_ident[ELF::EI_DATA], ArrayRef(ElfDataEncoding));
35960b57cec5SDimitry Andric   printFields(OS, "Data:", Str);
35970b57cec5SDimitry Andric   OS.PadToColumn(2u);
35980b57cec5SDimitry Andric   OS << "Version:";
35990b57cec5SDimitry Andric   OS.PadToColumn(37u);
360081ad6265SDimitry Andric   OS << utohexstr(e.e_ident[ELF::EI_VERSION]);
3601e8d8bef9SDimitry Andric   if (e.e_version == ELF::EV_CURRENT)
36020b57cec5SDimitry Andric     OS << " (current)";
36030b57cec5SDimitry Andric   OS << "\n";
3604cb14a3feSDimitry Andric   auto OSABI = ArrayRef(ElfOSABI);
3605cb14a3feSDimitry Andric   if (e.e_ident[ELF::EI_OSABI] >= ELF::ELFOSABI_FIRST_ARCH &&
3606cb14a3feSDimitry Andric       e.e_ident[ELF::EI_OSABI] <= ELF::ELFOSABI_LAST_ARCH) {
3607cb14a3feSDimitry Andric     switch (e.e_machine) {
3608cb14a3feSDimitry Andric     case ELF::EM_AMDGPU:
3609cb14a3feSDimitry Andric       OSABI = ArrayRef(AMDGPUElfOSABI);
3610cb14a3feSDimitry Andric       break;
3611cb14a3feSDimitry Andric     default:
3612cb14a3feSDimitry Andric       break;
3613cb14a3feSDimitry Andric     }
3614cb14a3feSDimitry Andric   }
3615cb14a3feSDimitry Andric   Str = enumToString(e.e_ident[ELF::EI_OSABI], OSABI);
36160b57cec5SDimitry Andric   printFields(OS, "OS/ABI:", Str);
3617480093f4SDimitry Andric   printFields(OS,
3618e8d8bef9SDimitry Andric               "ABI Version:", std::to_string(e.e_ident[ELF::EI_ABIVERSION]));
3619e8d8bef9SDimitry Andric 
3620e8d8bef9SDimitry Andric   if (const EnumEntry<unsigned> *E = getObjectFileEnumEntry(e.e_type)) {
3621e8d8bef9SDimitry Andric     Str = E->AltName.str();
3622e8d8bef9SDimitry Andric   } else {
3623e8d8bef9SDimitry Andric     if (e.e_type >= ET_LOPROC)
362481ad6265SDimitry Andric       Str = "Processor Specific: (" + utohexstr(e.e_type, /*LowerCase=*/true) + ")";
3625e8d8bef9SDimitry Andric     else if (e.e_type >= ET_LOOS)
362681ad6265SDimitry Andric       Str = "OS Specific: (" + utohexstr(e.e_type, /*LowerCase=*/true) + ")";
3627e8d8bef9SDimitry Andric     else
362881ad6265SDimitry Andric       Str = "<unknown>: " + utohexstr(e.e_type, /*LowerCase=*/true);
3629e8d8bef9SDimitry Andric   }
36300b57cec5SDimitry Andric   printFields(OS, "Type:", Str);
3631e8d8bef9SDimitry Andric 
3632bdd1243dSDimitry Andric   Str = enumToString(e.e_machine, ArrayRef(ElfMachineType));
36330b57cec5SDimitry Andric   printFields(OS, "Machine:", Str);
363481ad6265SDimitry Andric   Str = "0x" + utohexstr(e.e_version);
36350b57cec5SDimitry Andric   printFields(OS, "Version:", Str);
363681ad6265SDimitry Andric   Str = "0x" + utohexstr(e.e_entry);
36370b57cec5SDimitry Andric   printFields(OS, "Entry point address:", Str);
3638e8d8bef9SDimitry Andric   Str = to_string(e.e_phoff) + " (bytes into file)";
36390b57cec5SDimitry Andric   printFields(OS, "Start of program headers:", Str);
3640e8d8bef9SDimitry Andric   Str = to_string(e.e_shoff) + " (bytes into file)";
36410b57cec5SDimitry Andric   printFields(OS, "Start of section headers:", Str);
36420b57cec5SDimitry Andric   std::string ElfFlags;
3643e8d8bef9SDimitry Andric   if (e.e_machine == EM_MIPS)
3644bdd1243dSDimitry Andric     ElfFlags = printFlags(
3645bdd1243dSDimitry Andric         e.e_flags, ArrayRef(ElfHeaderMipsFlags), unsigned(ELF::EF_MIPS_ARCH),
3646bdd1243dSDimitry Andric         unsigned(ELF::EF_MIPS_ABI), unsigned(ELF::EF_MIPS_MACH));
3647e8d8bef9SDimitry Andric   else if (e.e_machine == EM_RISCV)
3648bdd1243dSDimitry Andric     ElfFlags = printFlags(e.e_flags, ArrayRef(ElfHeaderRISCVFlags));
3649fe6060f1SDimitry Andric   else if (e.e_machine == EM_AVR)
3650bdd1243dSDimitry Andric     ElfFlags = printFlags(e.e_flags, ArrayRef(ElfHeaderAVRFlags),
3651fe6060f1SDimitry Andric                           unsigned(ELF::EF_AVR_ARCH_MASK));
3652972a253aSDimitry Andric   else if (e.e_machine == EM_LOONGARCH)
3653bdd1243dSDimitry Andric     ElfFlags = printFlags(e.e_flags, ArrayRef(ElfHeaderLoongArchFlags),
3654bdd1243dSDimitry Andric                           unsigned(ELF::EF_LOONGARCH_ABI_MODIFIER_MASK),
3655bdd1243dSDimitry Andric                           unsigned(ELF::EF_LOONGARCH_OBJABI_MASK));
3656bdd1243dSDimitry Andric   else if (e.e_machine == EM_XTENSA)
3657bdd1243dSDimitry Andric     ElfFlags = printFlags(e.e_flags, ArrayRef(ElfHeaderXtensaFlags),
3658bdd1243dSDimitry Andric                           unsigned(ELF::EF_XTENSA_MACH));
36595f757f3fSDimitry Andric   else if (e.e_machine == EM_CUDA)
36605f757f3fSDimitry Andric     ElfFlags = printFlags(e.e_flags, ArrayRef(ElfHeaderNVPTXFlags),
36615f757f3fSDimitry Andric                           unsigned(ELF::EF_CUDA_SM));
3662cb14a3feSDimitry Andric   else if (e.e_machine == EM_AMDGPU) {
3663cb14a3feSDimitry Andric     switch (e.e_ident[ELF::EI_ABIVERSION]) {
3664cb14a3feSDimitry Andric     default:
3665cb14a3feSDimitry Andric       break;
3666cb14a3feSDimitry Andric     case 0:
3667cb14a3feSDimitry Andric       // ELFOSABI_AMDGPU_PAL, ELFOSABI_AMDGPU_MESA3D support *_V3 flags.
3668cb14a3feSDimitry Andric       [[fallthrough]];
3669cb14a3feSDimitry Andric     case ELF::ELFABIVERSION_AMDGPU_HSA_V3:
3670cb14a3feSDimitry Andric       ElfFlags =
3671cb14a3feSDimitry Andric           printFlags(e.e_flags, ArrayRef(ElfHeaderAMDGPUFlagsABIVersion3),
3672cb14a3feSDimitry Andric                      unsigned(ELF::EF_AMDGPU_MACH));
3673cb14a3feSDimitry Andric       break;
3674cb14a3feSDimitry Andric     case ELF::ELFABIVERSION_AMDGPU_HSA_V4:
3675cb14a3feSDimitry Andric     case ELF::ELFABIVERSION_AMDGPU_HSA_V5:
3676cb14a3feSDimitry Andric       ElfFlags =
3677cb14a3feSDimitry Andric           printFlags(e.e_flags, ArrayRef(ElfHeaderAMDGPUFlagsABIVersion4),
3678cb14a3feSDimitry Andric                      unsigned(ELF::EF_AMDGPU_MACH),
3679cb14a3feSDimitry Andric                      unsigned(ELF::EF_AMDGPU_FEATURE_XNACK_V4),
3680cb14a3feSDimitry Andric                      unsigned(ELF::EF_AMDGPU_FEATURE_SRAMECC_V4));
3681cb14a3feSDimitry Andric       break;
3682cb14a3feSDimitry Andric     }
3683cb14a3feSDimitry Andric   }
368481ad6265SDimitry Andric   Str = "0x" + utohexstr(e.e_flags);
36850b57cec5SDimitry Andric   if (!ElfFlags.empty())
36860b57cec5SDimitry Andric     Str = Str + ", " + ElfFlags;
36870b57cec5SDimitry Andric   printFields(OS, "Flags:", Str);
3688e8d8bef9SDimitry Andric   Str = to_string(e.e_ehsize) + " (bytes)";
36890b57cec5SDimitry Andric   printFields(OS, "Size of this header:", Str);
3690e8d8bef9SDimitry Andric   Str = to_string(e.e_phentsize) + " (bytes)";
36910b57cec5SDimitry Andric   printFields(OS, "Size of program headers:", Str);
3692e8d8bef9SDimitry Andric   Str = to_string(e.e_phnum);
36930b57cec5SDimitry Andric   printFields(OS, "Number of program headers:", Str);
3694e8d8bef9SDimitry Andric   Str = to_string(e.e_shentsize) + " (bytes)";
36950b57cec5SDimitry Andric   printFields(OS, "Size of section headers:", Str);
3696e8d8bef9SDimitry Andric   Str = getSectionHeadersNumString(this->Obj, this->FileName);
36970b57cec5SDimitry Andric   printFields(OS, "Number of section headers:", Str);
3698e8d8bef9SDimitry Andric   Str = getSectionHeaderTableIndexString(this->Obj, this->FileName);
36990b57cec5SDimitry Andric   printFields(OS, "Section header string table index:", Str);
37000b57cec5SDimitry Andric }
37010b57cec5SDimitry Andric 
getGroups()3702e8d8bef9SDimitry Andric template <class ELFT> std::vector<GroupSection> ELFDumper<ELFT>::getGroups() {
3703e8d8bef9SDimitry Andric   auto GetSignature = [&](const Elf_Sym &Sym, unsigned SymNdx,
3704e8d8bef9SDimitry Andric                           const Elf_Shdr &Symtab) -> StringRef {
3705e8d8bef9SDimitry Andric     Expected<StringRef> StrTableOrErr = Obj.getStringTableForSymtab(Symtab);
3706e8d8bef9SDimitry Andric     if (!StrTableOrErr) {
3707e8d8bef9SDimitry Andric       reportUniqueWarning("unable to get the string table for " +
3708e8d8bef9SDimitry Andric                           describe(Symtab) + ": " +
3709e8d8bef9SDimitry Andric                           toString(StrTableOrErr.takeError()));
3710e8d8bef9SDimitry Andric       return "<?>";
3711e8d8bef9SDimitry Andric     }
37120b57cec5SDimitry Andric 
3713e8d8bef9SDimitry Andric     StringRef Strings = *StrTableOrErr;
3714e8d8bef9SDimitry Andric     if (Sym.st_name >= Strings.size()) {
3715e8d8bef9SDimitry Andric       reportUniqueWarning("unable to get the name of the symbol with index " +
3716e8d8bef9SDimitry Andric                           Twine(SymNdx) + ": st_name (0x" +
3717e8d8bef9SDimitry Andric                           Twine::utohexstr(Sym.st_name) +
3718e8d8bef9SDimitry Andric                           ") is past the end of the string table of size 0x" +
3719e8d8bef9SDimitry Andric                           Twine::utohexstr(Strings.size()));
3720e8d8bef9SDimitry Andric       return "<?>";
3721e8d8bef9SDimitry Andric     }
37220b57cec5SDimitry Andric 
3723e8d8bef9SDimitry Andric     return StrTableOrErr->data() + Sym.st_name;
3724e8d8bef9SDimitry Andric   };
37250b57cec5SDimitry Andric 
37260b57cec5SDimitry Andric   std::vector<GroupSection> Ret;
37270b57cec5SDimitry Andric   uint64_t I = 0;
3728e8d8bef9SDimitry Andric   for (const Elf_Shdr &Sec : cantFail(Obj.sections())) {
37290b57cec5SDimitry Andric     ++I;
37300b57cec5SDimitry Andric     if (Sec.sh_type != ELF::SHT_GROUP)
37310b57cec5SDimitry Andric       continue;
37320b57cec5SDimitry Andric 
3733e8d8bef9SDimitry Andric     StringRef Signature = "<?>";
3734e8d8bef9SDimitry Andric     if (Expected<const Elf_Shdr *> SymtabOrErr = Obj.getSection(Sec.sh_link)) {
3735e8d8bef9SDimitry Andric       if (Expected<const Elf_Sym *> SymOrErr =
3736e8d8bef9SDimitry Andric               Obj.template getEntry<Elf_Sym>(**SymtabOrErr, Sec.sh_info))
3737e8d8bef9SDimitry Andric         Signature = GetSignature(**SymOrErr, Sec.sh_info, **SymtabOrErr);
3738e8d8bef9SDimitry Andric       else
3739e8d8bef9SDimitry Andric         reportUniqueWarning("unable to get the signature symbol for " +
3740e8d8bef9SDimitry Andric                             describe(Sec) + ": " +
3741e8d8bef9SDimitry Andric                             toString(SymOrErr.takeError()));
3742e8d8bef9SDimitry Andric     } else {
3743e8d8bef9SDimitry Andric       reportUniqueWarning("unable to get the symbol table for " +
3744e8d8bef9SDimitry Andric                           describe(Sec) + ": " +
3745e8d8bef9SDimitry Andric                           toString(SymtabOrErr.takeError()));
3746e8d8bef9SDimitry Andric     }
37470b57cec5SDimitry Andric 
3748e8d8bef9SDimitry Andric     ArrayRef<Elf_Word> Data;
3749e8d8bef9SDimitry Andric     if (Expected<ArrayRef<Elf_Word>> ContentsOrErr =
3750e8d8bef9SDimitry Andric             Obj.template getSectionContentsAsArray<Elf_Word>(Sec)) {
3751e8d8bef9SDimitry Andric       if (ContentsOrErr->empty())
3752e8d8bef9SDimitry Andric         reportUniqueWarning("unable to read the section group flag from the " +
3753e8d8bef9SDimitry Andric                             describe(Sec) + ": the section is empty");
3754e8d8bef9SDimitry Andric       else
3755e8d8bef9SDimitry Andric         Data = *ContentsOrErr;
3756e8d8bef9SDimitry Andric     } else {
3757e8d8bef9SDimitry Andric       reportUniqueWarning("unable to get the content of the " + describe(Sec) +
3758e8d8bef9SDimitry Andric                           ": " + toString(ContentsOrErr.takeError()));
3759e8d8bef9SDimitry Andric     }
3760e8d8bef9SDimitry Andric 
3761e8d8bef9SDimitry Andric     Ret.push_back({getPrintableSectionName(Sec),
37620b57cec5SDimitry Andric                    maybeDemangle(Signature),
37630b57cec5SDimitry Andric                    Sec.sh_name,
37640b57cec5SDimitry Andric                    I - 1,
37650b57cec5SDimitry Andric                    Sec.sh_link,
37660b57cec5SDimitry Andric                    Sec.sh_info,
3767e8d8bef9SDimitry Andric                    Data.empty() ? Elf_Word(0) : Data[0],
37680b57cec5SDimitry Andric                    {}});
37690b57cec5SDimitry Andric 
3770e8d8bef9SDimitry Andric     if (Data.empty())
3771e8d8bef9SDimitry Andric       continue;
3772e8d8bef9SDimitry Andric 
37730b57cec5SDimitry Andric     std::vector<GroupMember> &GM = Ret.back().Members;
37740b57cec5SDimitry Andric     for (uint32_t Ndx : Data.slice(1)) {
3775e8d8bef9SDimitry Andric       if (Expected<const Elf_Shdr *> SecOrErr = Obj.getSection(Ndx)) {
3776e8d8bef9SDimitry Andric         GM.push_back({getPrintableSectionName(**SecOrErr), Ndx});
3777e8d8bef9SDimitry Andric       } else {
3778e8d8bef9SDimitry Andric         reportUniqueWarning("unable to get the section with index " +
3779e8d8bef9SDimitry Andric                             Twine(Ndx) + " when dumping the " + describe(Sec) +
3780e8d8bef9SDimitry Andric                             ": " + toString(SecOrErr.takeError()));
3781e8d8bef9SDimitry Andric         GM.push_back({"<?>", Ndx});
3782e8d8bef9SDimitry Andric       }
37830b57cec5SDimitry Andric     }
37840b57cec5SDimitry Andric   }
37850b57cec5SDimitry Andric   return Ret;
37860b57cec5SDimitry Andric }
37870b57cec5SDimitry Andric 
3788e8d8bef9SDimitry Andric static DenseMap<uint64_t, const GroupSection *>
mapSectionsToGroups(ArrayRef<GroupSection> Groups)37890b57cec5SDimitry Andric mapSectionsToGroups(ArrayRef<GroupSection> Groups) {
37900b57cec5SDimitry Andric   DenseMap<uint64_t, const GroupSection *> Ret;
37910b57cec5SDimitry Andric   for (const GroupSection &G : Groups)
37920b57cec5SDimitry Andric     for (const GroupMember &GM : G.Members)
37930b57cec5SDimitry Andric       Ret.insert({GM.Index, &G});
37940b57cec5SDimitry Andric   return Ret;
37950b57cec5SDimitry Andric }
37960b57cec5SDimitry Andric 
printGroupSections()3797e8d8bef9SDimitry Andric template <class ELFT> void GNUELFDumper<ELFT>::printGroupSections() {
3798e8d8bef9SDimitry Andric   std::vector<GroupSection> V = this->getGroups();
37990b57cec5SDimitry Andric   DenseMap<uint64_t, const GroupSection *> Map = mapSectionsToGroups(V);
38000b57cec5SDimitry Andric   for (const GroupSection &G : V) {
38010b57cec5SDimitry Andric     OS << "\n"
38020b57cec5SDimitry Andric        << getGroupType(G.Type) << " group section ["
38030b57cec5SDimitry Andric        << format_decimal(G.Index, 5) << "] `" << G.Name << "' [" << G.Signature
38040b57cec5SDimitry Andric        << "] contains " << G.Members.size() << " sections:\n"
38050b57cec5SDimitry Andric        << "   [Index]    Name\n";
38060b57cec5SDimitry Andric     for (const GroupMember &GM : G.Members) {
38070b57cec5SDimitry Andric       const GroupSection *MainGroup = Map[GM.Index];
3808e8d8bef9SDimitry Andric       if (MainGroup != &G)
3809e8d8bef9SDimitry Andric         this->reportUniqueWarning(
3810e8d8bef9SDimitry Andric             "section with index " + Twine(GM.Index) +
3811e8d8bef9SDimitry Andric             ", included in the group section with index " +
3812e8d8bef9SDimitry Andric             Twine(MainGroup->Index) +
3813e8d8bef9SDimitry Andric             ", was also found in the group section with index " +
3814e8d8bef9SDimitry Andric             Twine(G.Index));
38150b57cec5SDimitry Andric       OS << "   [" << format_decimal(GM.Index, 5) << "]   " << GM.Name << "\n";
38160b57cec5SDimitry Andric     }
38170b57cec5SDimitry Andric   }
38180b57cec5SDimitry Andric 
38190b57cec5SDimitry Andric   if (V.empty())
38200b57cec5SDimitry Andric     OS << "There are no section groups in this file.\n";
38210b57cec5SDimitry Andric }
38220b57cec5SDimitry Andric 
38230b57cec5SDimitry Andric template <class ELFT>
printRelrReloc(const Elf_Relr & R)3824e8d8bef9SDimitry Andric void GNUELFDumper<ELFT>::printRelrReloc(const Elf_Relr &R) {
3825e8d8bef9SDimitry Andric   OS << to_string(format_hex_no_prefix(R, ELFT::Is64Bits ? 16 : 8)) << "\n";
38260b57cec5SDimitry Andric }
38270b57cec5SDimitry Andric 
38280b57cec5SDimitry Andric template <class ELFT>
printRelRelaReloc(const Relocation<ELFT> & R,const RelSymbol<ELFT> & RelSym)3829e8d8bef9SDimitry Andric void GNUELFDumper<ELFT>::printRelRelaReloc(const Relocation<ELFT> &R,
3830e8d8bef9SDimitry Andric                                            const RelSymbol<ELFT> &RelSym) {
38310b57cec5SDimitry Andric   // First two fields are bit width dependent. The rest of them are fixed width.
38320b57cec5SDimitry Andric   unsigned Bias = ELFT::Is64Bits ? 8 : 0;
38330b57cec5SDimitry Andric   Field Fields[5] = {0, 10 + Bias, 19 + 2 * Bias, 42 + 2 * Bias, 53 + 2 * Bias};
38340b57cec5SDimitry Andric   unsigned Width = ELFT::Is64Bits ? 16 : 8;
38350b57cec5SDimitry Andric 
3836e8d8bef9SDimitry Andric   Fields[0].Str = to_string(format_hex_no_prefix(R.Offset, Width));
3837e8d8bef9SDimitry Andric   Fields[1].Str = to_string(format_hex_no_prefix(R.Info, Width));
38380b57cec5SDimitry Andric 
38390b57cec5SDimitry Andric   SmallString<32> RelocName;
3840e8d8bef9SDimitry Andric   this->Obj.getRelocationTypeName(R.Type, RelocName);
38410b57cec5SDimitry Andric   Fields[2].Str = RelocName.c_str();
38420b57cec5SDimitry Andric 
3843e8d8bef9SDimitry Andric   if (RelSym.Sym)
3844e8d8bef9SDimitry Andric     Fields[3].Str =
3845e8d8bef9SDimitry Andric         to_string(format_hex_no_prefix(RelSym.Sym->getValue(), Width));
384606c3fb27SDimitry Andric   if (RelSym.Sym && RelSym.Name.empty())
384706c3fb27SDimitry Andric     Fields[4].Str = "<null>";
384806c3fb27SDimitry Andric   else
3849e8d8bef9SDimitry Andric     Fields[4].Str = std::string(RelSym.Name);
385006c3fb27SDimitry Andric 
38510b57cec5SDimitry Andric   for (const Field &F : Fields)
38520b57cec5SDimitry Andric     printField(F);
38530b57cec5SDimitry Andric 
38540b57cec5SDimitry Andric   std::string Addend;
3855bdd1243dSDimitry Andric   if (std::optional<int64_t> A = R.Addend) {
3856e8d8bef9SDimitry Andric     int64_t RelAddend = *A;
385706c3fb27SDimitry Andric     if (!Fields[4].Str.empty()) {
3858e8d8bef9SDimitry Andric       if (RelAddend < 0) {
38590b57cec5SDimitry Andric         Addend = " - ";
38608a4dda33SDimitry Andric         RelAddend = -static_cast<uint64_t>(RelAddend);
3861e8d8bef9SDimitry Andric       } else {
38620b57cec5SDimitry Andric         Addend = " + ";
38630b57cec5SDimitry Andric       }
3864e8d8bef9SDimitry Andric     }
386581ad6265SDimitry Andric     Addend += utohexstr(RelAddend, /*LowerCase=*/true);
38660b57cec5SDimitry Andric   }
38670b57cec5SDimitry Andric   OS << Addend << "\n";
38680b57cec5SDimitry Andric }
38690b57cec5SDimitry Andric 
3870e8d8bef9SDimitry Andric template <class ELFT>
printRelocHeaderFields(formatted_raw_ostream & OS,unsigned SType,const typename ELFT::Ehdr & EHeader)38715f757f3fSDimitry Andric static void printRelocHeaderFields(formatted_raw_ostream &OS, unsigned SType,
38725f757f3fSDimitry Andric                                    const typename ELFT::Ehdr &EHeader) {
38730b57cec5SDimitry Andric   bool IsRela = SType == ELF::SHT_RELA || SType == ELF::SHT_ANDROID_RELA;
38745f757f3fSDimitry Andric   bool IsRelr =
38755f757f3fSDimitry Andric       SType == ELF::SHT_RELR || SType == ELF::SHT_ANDROID_RELR ||
38765f757f3fSDimitry Andric       (EHeader.e_machine == EM_AARCH64 && SType == ELF::SHT_AARCH64_AUTH_RELR);
38770b57cec5SDimitry Andric   if (ELFT::Is64Bits)
38780b57cec5SDimitry Andric     OS << "    ";
38790b57cec5SDimitry Andric   else
38800b57cec5SDimitry Andric     OS << " ";
38810b57cec5SDimitry Andric   if (IsRelr && opts::RawRelr)
38820b57cec5SDimitry Andric     OS << "Data  ";
38830b57cec5SDimitry Andric   else
38840b57cec5SDimitry Andric     OS << "Offset";
38850b57cec5SDimitry Andric   if (ELFT::Is64Bits)
38860b57cec5SDimitry Andric     OS << "             Info             Type"
38870b57cec5SDimitry Andric        << "               Symbol's Value  Symbol's Name";
38880b57cec5SDimitry Andric   else
38890b57cec5SDimitry Andric     OS << "     Info    Type                Sym. Value  Symbol's Name";
38900b57cec5SDimitry Andric   if (IsRela)
38910b57cec5SDimitry Andric     OS << " + Addend";
38920b57cec5SDimitry Andric   OS << "\n";
38930b57cec5SDimitry Andric }
38940b57cec5SDimitry Andric 
3895e8d8bef9SDimitry Andric template <class ELFT>
printDynamicRelocHeader(unsigned Type,StringRef Name,const DynRegionInfo & Reg)3896e8d8bef9SDimitry Andric void GNUELFDumper<ELFT>::printDynamicRelocHeader(unsigned Type, StringRef Name,
3897e8d8bef9SDimitry Andric                                                  const DynRegionInfo &Reg) {
3898e8d8bef9SDimitry Andric   uint64_t Offset = Reg.Addr - this->Obj.base();
3899e8d8bef9SDimitry Andric   OS << "\n'" << Name.str().c_str() << "' relocation section at offset 0x"
390081ad6265SDimitry Andric      << utohexstr(Offset, /*LowerCase=*/true) << " contains " << Reg.Size << " bytes:\n";
39015f757f3fSDimitry Andric   printRelocHeaderFields<ELFT>(OS, Type, this->Obj.getHeader());
3902e8d8bef9SDimitry Andric }
3903e8d8bef9SDimitry Andric 
3904e8d8bef9SDimitry Andric template <class ELFT>
isRelocationSec(const typename ELFT::Shdr & Sec,const typename ELFT::Ehdr & EHeader)39055f757f3fSDimitry Andric static bool isRelocationSec(const typename ELFT::Shdr &Sec,
39065f757f3fSDimitry Andric                             const typename ELFT::Ehdr &EHeader) {
3907e8d8bef9SDimitry Andric   return Sec.sh_type == ELF::SHT_REL || Sec.sh_type == ELF::SHT_RELA ||
3908e8d8bef9SDimitry Andric          Sec.sh_type == ELF::SHT_RELR || Sec.sh_type == ELF::SHT_ANDROID_REL ||
3909e8d8bef9SDimitry Andric          Sec.sh_type == ELF::SHT_ANDROID_RELA ||
39105f757f3fSDimitry Andric          Sec.sh_type == ELF::SHT_ANDROID_RELR ||
39115f757f3fSDimitry Andric          (EHeader.e_machine == EM_AARCH64 &&
39125f757f3fSDimitry Andric           Sec.sh_type == ELF::SHT_AARCH64_AUTH_RELR);
3913e8d8bef9SDimitry Andric }
3914e8d8bef9SDimitry Andric 
printRelocations()3915e8d8bef9SDimitry Andric template <class ELFT> void GNUELFDumper<ELFT>::printRelocations() {
3916e8d8bef9SDimitry Andric   auto GetEntriesNum = [&](const Elf_Shdr &Sec) -> Expected<size_t> {
39170b57cec5SDimitry Andric     // Android's packed relocation section needs to be unpacked first
39180b57cec5SDimitry Andric     // to get the actual number of entries.
3919e8d8bef9SDimitry Andric     if (Sec.sh_type == ELF::SHT_ANDROID_REL ||
3920e8d8bef9SDimitry Andric         Sec.sh_type == ELF::SHT_ANDROID_RELA) {
3921e8d8bef9SDimitry Andric       Expected<std::vector<typename ELFT::Rela>> RelasOrErr =
3922e8d8bef9SDimitry Andric           this->Obj.android_relas(Sec);
3923e8d8bef9SDimitry Andric       if (!RelasOrErr)
3924e8d8bef9SDimitry Andric         return RelasOrErr.takeError();
3925e8d8bef9SDimitry Andric       return RelasOrErr->size();
39260b57cec5SDimitry Andric     }
3927e8d8bef9SDimitry Andric 
39285f757f3fSDimitry Andric     if (!opts::RawRelr &&
39295f757f3fSDimitry Andric         (Sec.sh_type == ELF::SHT_RELR || Sec.sh_type == ELF::SHT_ANDROID_RELR ||
39305f757f3fSDimitry Andric          (this->Obj.getHeader().e_machine == EM_AARCH64 &&
39315f757f3fSDimitry Andric           Sec.sh_type == ELF::SHT_AARCH64_AUTH_RELR))) {
3932e8d8bef9SDimitry Andric       Expected<Elf_Relr_Range> RelrsOrErr = this->Obj.relrs(Sec);
3933e8d8bef9SDimitry Andric       if (!RelrsOrErr)
3934e8d8bef9SDimitry Andric         return RelrsOrErr.takeError();
3935e8d8bef9SDimitry Andric       return this->Obj.decode_relrs(*RelrsOrErr).size();
39360b57cec5SDimitry Andric     }
39375ffd83dbSDimitry Andric 
3938e8d8bef9SDimitry Andric     return Sec.getEntityCount();
3939e8d8bef9SDimitry Andric   };
3940e8d8bef9SDimitry Andric 
3941e8d8bef9SDimitry Andric   bool HasRelocSections = false;
3942e8d8bef9SDimitry Andric   for (const Elf_Shdr &Sec : cantFail(this->Obj.sections())) {
39435f757f3fSDimitry Andric     if (!isRelocationSec<ELFT>(Sec, this->Obj.getHeader()))
3944e8d8bef9SDimitry Andric       continue;
3945e8d8bef9SDimitry Andric     HasRelocSections = true;
3946e8d8bef9SDimitry Andric 
3947e8d8bef9SDimitry Andric     std::string EntriesNum = "<?>";
3948e8d8bef9SDimitry Andric     if (Expected<size_t> NumOrErr = GetEntriesNum(Sec))
3949e8d8bef9SDimitry Andric       EntriesNum = std::to_string(*NumOrErr);
39500b57cec5SDimitry Andric     else
3951e8d8bef9SDimitry Andric       this->reportUniqueWarning("unable to get the number of relocations in " +
3952e8d8bef9SDimitry Andric                                 this->describe(Sec) + ": " +
3953e8d8bef9SDimitry Andric                                 toString(NumOrErr.takeError()));
3954e8d8bef9SDimitry Andric 
3955e8d8bef9SDimitry Andric     uintX_t Offset = Sec.sh_offset;
3956e8d8bef9SDimitry Andric     StringRef Name = this->getPrintableSectionName(Sec);
3957e8d8bef9SDimitry Andric     OS << "\nRelocation section '" << Name << "' at offset 0x"
395881ad6265SDimitry Andric        << utohexstr(Offset, /*LowerCase=*/true) << " contains " << EntriesNum
3959e8d8bef9SDimitry Andric        << " entries:\n";
39605f757f3fSDimitry Andric     printRelocHeaderFields<ELFT>(OS, Sec.sh_type, this->Obj.getHeader());
3961e8d8bef9SDimitry Andric     this->printRelocationsHelper(Sec);
39620b57cec5SDimitry Andric   }
39630b57cec5SDimitry Andric   if (!HasRelocSections)
39640b57cec5SDimitry Andric     OS << "\nThere are no relocations in this file.\n";
39650b57cec5SDimitry Andric }
39660b57cec5SDimitry Andric 
39670b57cec5SDimitry Andric // Print the offset of a particular section from anyone of the ranges:
39680b57cec5SDimitry Andric // [SHT_LOOS, SHT_HIOS], [SHT_LOPROC, SHT_HIPROC], [SHT_LOUSER, SHT_HIUSER].
39690b57cec5SDimitry Andric // If 'Type' does not fall within any of those ranges, then a string is
39700b57cec5SDimitry Andric // returned as '<unknown>' followed by the type value.
getSectionTypeOffsetString(unsigned Type)39710b57cec5SDimitry Andric static std::string getSectionTypeOffsetString(unsigned Type) {
39720b57cec5SDimitry Andric   if (Type >= SHT_LOOS && Type <= SHT_HIOS)
397381ad6265SDimitry Andric     return "LOOS+0x" + utohexstr(Type - SHT_LOOS);
39740b57cec5SDimitry Andric   else if (Type >= SHT_LOPROC && Type <= SHT_HIPROC)
397581ad6265SDimitry Andric     return "LOPROC+0x" + utohexstr(Type - SHT_LOPROC);
39760b57cec5SDimitry Andric   else if (Type >= SHT_LOUSER && Type <= SHT_HIUSER)
397781ad6265SDimitry Andric     return "LOUSER+0x" + utohexstr(Type - SHT_LOUSER);
397881ad6265SDimitry Andric   return "0x" + utohexstr(Type) + ": <unknown>";
39790b57cec5SDimitry Andric }
39800b57cec5SDimitry Andric 
getSectionTypeString(unsigned Machine,unsigned Type)3981e8d8bef9SDimitry Andric static std::string getSectionTypeString(unsigned Machine, unsigned Type) {
3982e8d8bef9SDimitry Andric   StringRef Name = getELFSectionTypeName(Machine, Type);
39830b57cec5SDimitry Andric 
3984e8d8bef9SDimitry Andric   // Handle SHT_GNU_* type names.
398581ad6265SDimitry Andric   if (Name.consume_front("SHT_GNU_")) {
398681ad6265SDimitry Andric     if (Name == "HASH")
39870b57cec5SDimitry Andric       return "GNU_HASH";
3988e8d8bef9SDimitry Andric     // E.g. SHT_GNU_verneed -> VERNEED.
398981ad6265SDimitry Andric     return Name.upper();
39900b57cec5SDimitry Andric   }
3991e8d8bef9SDimitry Andric 
3992e8d8bef9SDimitry Andric   if (Name == "SHT_SYMTAB_SHNDX")
3993e8d8bef9SDimitry Andric     return "SYMTAB SECTION INDICES";
3994e8d8bef9SDimitry Andric 
399581ad6265SDimitry Andric   if (Name.consume_front("SHT_"))
399681ad6265SDimitry Andric     return Name.str();
3997e8d8bef9SDimitry Andric   return getSectionTypeOffsetString(Type);
39980b57cec5SDimitry Andric }
39990b57cec5SDimitry Andric 
printSectionDescription(formatted_raw_ostream & OS,unsigned EMachine)4000480093f4SDimitry Andric static void printSectionDescription(formatted_raw_ostream &OS,
4001480093f4SDimitry Andric                                     unsigned EMachine) {
4002480093f4SDimitry Andric   OS << "Key to Flags:\n";
4003480093f4SDimitry Andric   OS << "  W (write), A (alloc), X (execute), M (merge), S (strings), I "
4004480093f4SDimitry Andric         "(info),\n";
4005480093f4SDimitry Andric   OS << "  L (link order), O (extra OS processing required), G (group), T "
4006480093f4SDimitry Andric         "(TLS),\n";
4007480093f4SDimitry Andric   OS << "  C (compressed), x (unknown), o (OS specific), E (exclude),\n";
4008fe6060f1SDimitry Andric   OS << "  R (retain)";
4009480093f4SDimitry Andric 
4010480093f4SDimitry Andric   if (EMachine == EM_X86_64)
4011fe6060f1SDimitry Andric     OS << ", l (large)";
4012480093f4SDimitry Andric   else if (EMachine == EM_ARM)
4013fe6060f1SDimitry Andric     OS << ", y (purecode)";
4014480093f4SDimitry Andric 
4015fe6060f1SDimitry Andric   OS << ", p (processor specific)\n";
4016480093f4SDimitry Andric }
4017480093f4SDimitry Andric 
printSectionHeaders()4018e8d8bef9SDimitry Andric template <class ELFT> void GNUELFDumper<ELFT>::printSectionHeaders() {
4019e8d8bef9SDimitry Andric   ArrayRef<Elf_Shdr> Sections = cantFail(this->Obj.sections());
4020bdd1243dSDimitry Andric   if (Sections.empty()) {
4021bdd1243dSDimitry Andric     OS << "\nThere are no sections in this file.\n";
4022bdd1243dSDimitry Andric     Expected<StringRef> SecStrTableOrErr =
4023bdd1243dSDimitry Andric         this->Obj.getSectionStringTable(Sections, this->WarningHandler);
4024bdd1243dSDimitry Andric     if (!SecStrTableOrErr)
4025bdd1243dSDimitry Andric       this->reportUniqueWarning(SecStrTableOrErr.takeError());
4026bdd1243dSDimitry Andric     return;
4027bdd1243dSDimitry Andric   }
4028bdd1243dSDimitry Andric   unsigned Bias = ELFT::Is64Bits ? 0 : 8;
40290b57cec5SDimitry Andric   OS << "There are " << to_string(Sections.size())
40300b57cec5SDimitry Andric      << " section headers, starting at offset "
403181ad6265SDimitry Andric      << "0x" << utohexstr(this->Obj.getHeader().e_shoff, /*LowerCase=*/true) << ":\n\n";
40320b57cec5SDimitry Andric   OS << "Section Headers:\n";
40330b57cec5SDimitry Andric   Field Fields[11] = {
40340b57cec5SDimitry Andric       {"[Nr]", 2},        {"Name", 7},        {"Type", 25},
40350b57cec5SDimitry Andric       {"Address", 41},    {"Off", 58 - Bias}, {"Size", 65 - Bias},
40360b57cec5SDimitry Andric       {"ES", 72 - Bias},  {"Flg", 75 - Bias}, {"Lk", 79 - Bias},
40370b57cec5SDimitry Andric       {"Inf", 82 - Bias}, {"Al", 86 - Bias}};
4038e8d8bef9SDimitry Andric   for (const Field &F : Fields)
40390b57cec5SDimitry Andric     printField(F);
40400b57cec5SDimitry Andric   OS << "\n";
40410b57cec5SDimitry Andric 
40425ffd83dbSDimitry Andric   StringRef SecStrTable;
40435ffd83dbSDimitry Andric   if (Expected<StringRef> SecStrTableOrErr =
4044e8d8bef9SDimitry Andric           this->Obj.getSectionStringTable(Sections, this->WarningHandler))
40455ffd83dbSDimitry Andric     SecStrTable = *SecStrTableOrErr;
40465ffd83dbSDimitry Andric   else
40475ffd83dbSDimitry Andric     this->reportUniqueWarning(SecStrTableOrErr.takeError());
40485ffd83dbSDimitry Andric 
40490b57cec5SDimitry Andric   size_t SectionIndex = 0;
40500b57cec5SDimitry Andric   for (const Elf_Shdr &Sec : Sections) {
40510b57cec5SDimitry Andric     Fields[0].Str = to_string(SectionIndex);
40525ffd83dbSDimitry Andric     if (SecStrTable.empty())
40535ffd83dbSDimitry Andric       Fields[1].Str = "<no-strings>";
40545ffd83dbSDimitry Andric     else
40555ffd83dbSDimitry Andric       Fields[1].Str = std::string(unwrapOrError<StringRef>(
4056e8d8bef9SDimitry Andric           this->FileName, this->Obj.getSectionName(Sec, SecStrTable)));
40570b57cec5SDimitry Andric     Fields[2].Str =
4058e8d8bef9SDimitry Andric         getSectionTypeString(this->Obj.getHeader().e_machine, Sec.sh_type);
40590b57cec5SDimitry Andric     Fields[3].Str =
40600b57cec5SDimitry Andric         to_string(format_hex_no_prefix(Sec.sh_addr, ELFT::Is64Bits ? 16 : 8));
40610b57cec5SDimitry Andric     Fields[4].Str = to_string(format_hex_no_prefix(Sec.sh_offset, 6));
40620b57cec5SDimitry Andric     Fields[5].Str = to_string(format_hex_no_prefix(Sec.sh_size, 6));
40630b57cec5SDimitry Andric     Fields[6].Str = to_string(format_hex_no_prefix(Sec.sh_entsize, 2));
406481ad6265SDimitry Andric     Fields[7].Str = getGNUFlags(this->Obj.getHeader().e_ident[ELF::EI_OSABI],
406581ad6265SDimitry Andric                                 this->Obj.getHeader().e_machine, Sec.sh_flags);
40660b57cec5SDimitry Andric     Fields[8].Str = to_string(Sec.sh_link);
40670b57cec5SDimitry Andric     Fields[9].Str = to_string(Sec.sh_info);
40680b57cec5SDimitry Andric     Fields[10].Str = to_string(Sec.sh_addralign);
40690b57cec5SDimitry Andric 
40700b57cec5SDimitry Andric     OS.PadToColumn(Fields[0].Column);
40710b57cec5SDimitry Andric     OS << "[" << right_justify(Fields[0].Str, 2) << "]";
40720b57cec5SDimitry Andric     for (int i = 1; i < 7; i++)
40730b57cec5SDimitry Andric       printField(Fields[i]);
40740b57cec5SDimitry Andric     OS.PadToColumn(Fields[7].Column);
40750b57cec5SDimitry Andric     OS << right_justify(Fields[7].Str, 3);
40760b57cec5SDimitry Andric     OS.PadToColumn(Fields[8].Column);
40770b57cec5SDimitry Andric     OS << right_justify(Fields[8].Str, 2);
40780b57cec5SDimitry Andric     OS.PadToColumn(Fields[9].Column);
40790b57cec5SDimitry Andric     OS << right_justify(Fields[9].Str, 3);
40800b57cec5SDimitry Andric     OS.PadToColumn(Fields[10].Column);
40810b57cec5SDimitry Andric     OS << right_justify(Fields[10].Str, 2);
40820b57cec5SDimitry Andric     OS << "\n";
40830b57cec5SDimitry Andric     ++SectionIndex;
40840b57cec5SDimitry Andric   }
4085e8d8bef9SDimitry Andric   printSectionDescription(OS, this->Obj.getHeader().e_machine);
40860b57cec5SDimitry Andric }
40870b57cec5SDimitry Andric 
40880b57cec5SDimitry Andric template <class ELFT>
printSymtabMessage(const Elf_Shdr * Symtab,size_t Entries,bool NonVisibilityBitsUsed,bool ExtraSymInfo) const4089e8d8bef9SDimitry Andric void GNUELFDumper<ELFT>::printSymtabMessage(const Elf_Shdr *Symtab,
40908bcb0991SDimitry Andric                                             size_t Entries,
40915f757f3fSDimitry Andric                                             bool NonVisibilityBitsUsed,
40925f757f3fSDimitry Andric                                             bool ExtraSymInfo) const {
4093e8d8bef9SDimitry Andric   StringRef Name;
4094e8d8bef9SDimitry Andric   if (Symtab)
4095e8d8bef9SDimitry Andric     Name = this->getPrintableSectionName(*Symtab);
40960b57cec5SDimitry Andric   if (!Name.empty())
40975ffd83dbSDimitry Andric     OS << "\nSymbol table '" << Name << "'";
40980b57cec5SDimitry Andric   else
40995ffd83dbSDimitry Andric     OS << "\nSymbol table for image";
41005ffd83dbSDimitry Andric   OS << " contains " << Entries << " entries:\n";
41010b57cec5SDimitry Andric 
41025f757f3fSDimitry Andric   if (ELFT::Is64Bits) {
41038bcb0991SDimitry Andric     OS << "   Num:    Value          Size Type    Bind   Vis";
41045f757f3fSDimitry Andric     if (ExtraSymInfo)
41055f757f3fSDimitry Andric       OS << "+Other";
41065f757f3fSDimitry Andric   } else {
41078bcb0991SDimitry Andric     OS << "   Num:    Value  Size Type    Bind   Vis";
41085f757f3fSDimitry Andric     if (ExtraSymInfo)
41095f757f3fSDimitry Andric       OS << "+Other";
41105f757f3fSDimitry Andric   }
41118bcb0991SDimitry Andric 
41125f757f3fSDimitry Andric   OS.PadToColumn((ELFT::Is64Bits ? 56 : 48) + (NonVisibilityBitsUsed ? 13 : 0));
41135f757f3fSDimitry Andric   if (ExtraSymInfo)
41145f757f3fSDimitry Andric     OS << "Ndx(SecName) Name [+ Version Info]\n";
41155f757f3fSDimitry Andric   else
41168bcb0991SDimitry Andric     OS << "Ndx Name\n";
41170b57cec5SDimitry Andric }
41180b57cec5SDimitry Andric 
41190b57cec5SDimitry Andric template <class ELFT>
getSymbolSectionNdx(const Elf_Sym & Symbol,unsigned SymIndex,DataRegion<Elf_Word> ShndxTable,bool ExtraSymInfo) const41205f757f3fSDimitry Andric std::string GNUELFDumper<ELFT>::getSymbolSectionNdx(
41215f757f3fSDimitry Andric     const Elf_Sym &Symbol, unsigned SymIndex, DataRegion<Elf_Word> ShndxTable,
41225f757f3fSDimitry Andric     bool ExtraSymInfo) const {
4123e8d8bef9SDimitry Andric   unsigned SectionIndex = Symbol.st_shndx;
41240b57cec5SDimitry Andric   switch (SectionIndex) {
41250b57cec5SDimitry Andric   case ELF::SHN_UNDEF:
41260b57cec5SDimitry Andric     return "UND";
41270b57cec5SDimitry Andric   case ELF::SHN_ABS:
41280b57cec5SDimitry Andric     return "ABS";
41290b57cec5SDimitry Andric   case ELF::SHN_COMMON:
41300b57cec5SDimitry Andric     return "COM";
4131480093f4SDimitry Andric   case ELF::SHN_XINDEX: {
4132e8d8bef9SDimitry Andric     Expected<uint32_t> IndexOrErr =
4133e8d8bef9SDimitry Andric         object::getExtendedSymbolTableIndex<ELFT>(Symbol, SymIndex, ShndxTable);
4134480093f4SDimitry Andric     if (!IndexOrErr) {
4135e8d8bef9SDimitry Andric       assert(Symbol.st_shndx == SHN_XINDEX &&
4136e8d8bef9SDimitry Andric              "getExtendedSymbolTableIndex should only fail due to an invalid "
4137480093f4SDimitry Andric              "SHT_SYMTAB_SHNDX table/reference");
4138480093f4SDimitry Andric       this->reportUniqueWarning(IndexOrErr.takeError());
4139480093f4SDimitry Andric       return "RSV[0xffff]";
4140480093f4SDimitry Andric     }
41415f757f3fSDimitry Andric     SectionIndex = *IndexOrErr;
41425f757f3fSDimitry Andric     break;
4143480093f4SDimitry Andric   }
41440b57cec5SDimitry Andric   default:
41450b57cec5SDimitry Andric     // Find if:
41460b57cec5SDimitry Andric     // Processor specific
41470b57cec5SDimitry Andric     if (SectionIndex >= ELF::SHN_LOPROC && SectionIndex <= ELF::SHN_HIPROC)
41480b57cec5SDimitry Andric       return std::string("PRC[0x") +
41490b57cec5SDimitry Andric              to_string(format_hex_no_prefix(SectionIndex, 4)) + "]";
41500b57cec5SDimitry Andric     // OS specific
41510b57cec5SDimitry Andric     if (SectionIndex >= ELF::SHN_LOOS && SectionIndex <= ELF::SHN_HIOS)
41520b57cec5SDimitry Andric       return std::string("OS[0x") +
41530b57cec5SDimitry Andric              to_string(format_hex_no_prefix(SectionIndex, 4)) + "]";
41540b57cec5SDimitry Andric     // Architecture reserved:
41550b57cec5SDimitry Andric     if (SectionIndex >= ELF::SHN_LORESERVE &&
41560b57cec5SDimitry Andric         SectionIndex <= ELF::SHN_HIRESERVE)
41570b57cec5SDimitry Andric       return std::string("RSV[0x") +
41580b57cec5SDimitry Andric              to_string(format_hex_no_prefix(SectionIndex, 4)) + "]";
41595f757f3fSDimitry Andric     break;
41600b57cec5SDimitry Andric   }
41615f757f3fSDimitry Andric 
41625f757f3fSDimitry Andric   std::string Extra;
41635f757f3fSDimitry Andric   if (ExtraSymInfo) {
41645f757f3fSDimitry Andric     auto Sec = this->Obj.getSection(SectionIndex);
41655f757f3fSDimitry Andric     if (!Sec) {
41665f757f3fSDimitry Andric       this->reportUniqueWarning(Sec.takeError());
41675f757f3fSDimitry Andric     } else {
41685f757f3fSDimitry Andric       auto SecName = this->Obj.getSectionName(**Sec);
41695f757f3fSDimitry Andric       if (!SecName)
41705f757f3fSDimitry Andric         this->reportUniqueWarning(SecName.takeError());
41715f757f3fSDimitry Andric       else
41725f757f3fSDimitry Andric         Extra = Twine(" (" + *SecName + ")").str();
41735f757f3fSDimitry Andric     }
41745f757f3fSDimitry Andric   }
41755f757f3fSDimitry Andric   return to_string(format_decimal(SectionIndex, 3)) + Extra;
41760b57cec5SDimitry Andric }
41770b57cec5SDimitry Andric 
41780b57cec5SDimitry Andric template <class ELFT>
printSymbol(const Elf_Sym & Symbol,unsigned SymIndex,DataRegion<Elf_Word> ShndxTable,std::optional<StringRef> StrTable,bool IsDynamic,bool NonVisibilityBitsUsed,bool ExtraSymInfo) const4179e8d8bef9SDimitry Andric void GNUELFDumper<ELFT>::printSymbol(const Elf_Sym &Symbol, unsigned SymIndex,
4180e8d8bef9SDimitry Andric                                      DataRegion<Elf_Word> ShndxTable,
4181bdd1243dSDimitry Andric                                      std::optional<StringRef> StrTable,
41825f757f3fSDimitry Andric                                      bool IsDynamic, bool NonVisibilityBitsUsed,
41835f757f3fSDimitry Andric                                      bool ExtraSymInfo) const {
41840b57cec5SDimitry Andric   unsigned Bias = ELFT::Is64Bits ? 8 : 0;
41850b57cec5SDimitry Andric   Field Fields[8] = {0,         8,         17 + Bias, 23 + Bias,
41868bcb0991SDimitry Andric                      31 + Bias, 38 + Bias, 48 + Bias, 51 + Bias};
4187e8d8bef9SDimitry Andric   Fields[0].Str = to_string(format_decimal(SymIndex, 6)) + ":";
4188e8d8bef9SDimitry Andric   Fields[1].Str =
4189e8d8bef9SDimitry Andric       to_string(format_hex_no_prefix(Symbol.st_value, ELFT::Is64Bits ? 16 : 8));
4190e8d8bef9SDimitry Andric   Fields[2].Str = to_string(format_decimal(Symbol.st_size, 5));
41910b57cec5SDimitry Andric 
4192e8d8bef9SDimitry Andric   unsigned char SymbolType = Symbol.getType();
4193e8d8bef9SDimitry Andric   if (this->Obj.getHeader().e_machine == ELF::EM_AMDGPU &&
41940b57cec5SDimitry Andric       SymbolType >= ELF::STT_LOOS && SymbolType < ELF::STT_HIOS)
4195bdd1243dSDimitry Andric     Fields[3].Str = enumToString(SymbolType, ArrayRef(AMDGPUSymbolTypes));
41960b57cec5SDimitry Andric   else
4197bdd1243dSDimitry Andric     Fields[3].Str = enumToString(SymbolType, ArrayRef(ElfSymbolTypes));
41980b57cec5SDimitry Andric 
41990b57cec5SDimitry Andric   Fields[4].Str =
4200bdd1243dSDimitry Andric       enumToString(Symbol.getBinding(), ArrayRef(ElfSymbolBindings));
42010b57cec5SDimitry Andric   Fields[5].Str =
4202bdd1243dSDimitry Andric       enumToString(Symbol.getVisibility(), ArrayRef(ElfSymbolVisibilities));
4203e8d8bef9SDimitry Andric 
4204e8d8bef9SDimitry Andric   if (Symbol.st_other & ~0x3) {
4205e8d8bef9SDimitry Andric     if (this->Obj.getHeader().e_machine == ELF::EM_AARCH64) {
4206e8d8bef9SDimitry Andric       uint8_t Other = Symbol.st_other & ~0x3;
4207e8d8bef9SDimitry Andric       if (Other & STO_AARCH64_VARIANT_PCS) {
4208e8d8bef9SDimitry Andric         Other &= ~STO_AARCH64_VARIANT_PCS;
4209e8d8bef9SDimitry Andric         Fields[5].Str += " [VARIANT_PCS";
4210e8d8bef9SDimitry Andric         if (Other != 0)
421181ad6265SDimitry Andric           Fields[5].Str.append(" | " + utohexstr(Other, /*LowerCase=*/true));
4212e8d8bef9SDimitry Andric         Fields[5].Str.append("]");
4213e8d8bef9SDimitry Andric       }
4214349cc55cSDimitry Andric     } else if (this->Obj.getHeader().e_machine == ELF::EM_RISCV) {
4215349cc55cSDimitry Andric       uint8_t Other = Symbol.st_other & ~0x3;
4216349cc55cSDimitry Andric       if (Other & STO_RISCV_VARIANT_CC) {
4217349cc55cSDimitry Andric         Other &= ~STO_RISCV_VARIANT_CC;
4218349cc55cSDimitry Andric         Fields[5].Str += " [VARIANT_CC";
4219349cc55cSDimitry Andric         if (Other != 0)
422081ad6265SDimitry Andric           Fields[5].Str.append(" | " + utohexstr(Other, /*LowerCase=*/true));
4221349cc55cSDimitry Andric         Fields[5].Str.append("]");
4222349cc55cSDimitry Andric       }
4223e8d8bef9SDimitry Andric     } else {
42248bcb0991SDimitry Andric       Fields[5].Str +=
4225e8d8bef9SDimitry Andric           " [<other: " + to_string(format_hex(Symbol.st_other, 2)) + ">]";
4226e8d8bef9SDimitry Andric     }
4227e8d8bef9SDimitry Andric   }
42288bcb0991SDimitry Andric 
42298bcb0991SDimitry Andric   Fields[6].Column += NonVisibilityBitsUsed ? 13 : 0;
42305f757f3fSDimitry Andric   Fields[6].Str =
42315f757f3fSDimitry Andric       getSymbolSectionNdx(Symbol, SymIndex, ShndxTable, ExtraSymInfo);
42328bcb0991SDimitry Andric 
42335f757f3fSDimitry Andric   Fields[7].Column += ExtraSymInfo ? 10 : 0;
4234e8d8bef9SDimitry Andric   Fields[7].Str = this->getFullSymbolName(Symbol, SymIndex, ShndxTable,
4235e8d8bef9SDimitry Andric                                           StrTable, IsDynamic);
4236e8d8bef9SDimitry Andric   for (const Field &Entry : Fields)
42370b57cec5SDimitry Andric     printField(Entry);
42380b57cec5SDimitry Andric   OS << "\n";
42390b57cec5SDimitry Andric }
42400b57cec5SDimitry Andric 
42410b57cec5SDimitry Andric template <class ELFT>
printHashedSymbol(const Elf_Sym * Symbol,unsigned SymIndex,DataRegion<Elf_Word> ShndxTable,StringRef StrTable,uint32_t Bucket)4242e8d8bef9SDimitry Andric void GNUELFDumper<ELFT>::printHashedSymbol(const Elf_Sym *Symbol,
4243e8d8bef9SDimitry Andric                                            unsigned SymIndex,
4244e8d8bef9SDimitry Andric                                            DataRegion<Elf_Word> ShndxTable,
4245e8d8bef9SDimitry Andric                                            StringRef StrTable,
42460b57cec5SDimitry Andric                                            uint32_t Bucket) {
42470b57cec5SDimitry Andric   unsigned Bias = ELFT::Is64Bits ? 8 : 0;
42480b57cec5SDimitry Andric   Field Fields[9] = {0,         6,         11,        20 + Bias, 25 + Bias,
42490b57cec5SDimitry Andric                      34 + Bias, 41 + Bias, 49 + Bias, 53 + Bias};
4250e8d8bef9SDimitry Andric   Fields[0].Str = to_string(format_decimal(SymIndex, 5));
42510b57cec5SDimitry Andric   Fields[1].Str = to_string(format_decimal(Bucket, 3)) + ":";
42520b57cec5SDimitry Andric 
42530b57cec5SDimitry Andric   Fields[2].Str = to_string(
42548bcb0991SDimitry Andric       format_hex_no_prefix(Symbol->st_value, ELFT::Is64Bits ? 16 : 8));
42550b57cec5SDimitry Andric   Fields[3].Str = to_string(format_decimal(Symbol->st_size, 5));
42560b57cec5SDimitry Andric 
42570b57cec5SDimitry Andric   unsigned char SymbolType = Symbol->getType();
4258e8d8bef9SDimitry Andric   if (this->Obj.getHeader().e_machine == ELF::EM_AMDGPU &&
42590b57cec5SDimitry Andric       SymbolType >= ELF::STT_LOOS && SymbolType < ELF::STT_HIOS)
4260bdd1243dSDimitry Andric     Fields[4].Str = enumToString(SymbolType, ArrayRef(AMDGPUSymbolTypes));
42610b57cec5SDimitry Andric   else
4262bdd1243dSDimitry Andric     Fields[4].Str = enumToString(SymbolType, ArrayRef(ElfSymbolTypes));
42630b57cec5SDimitry Andric 
42640b57cec5SDimitry Andric   Fields[5].Str =
4265bdd1243dSDimitry Andric       enumToString(Symbol->getBinding(), ArrayRef(ElfSymbolBindings));
4266bdd1243dSDimitry Andric   Fields[6].Str =
4267bdd1243dSDimitry Andric       enumToString(Symbol->getVisibility(), ArrayRef(ElfSymbolVisibilities));
4268e8d8bef9SDimitry Andric   Fields[7].Str = getSymbolSectionNdx(*Symbol, SymIndex, ShndxTable);
4269e8d8bef9SDimitry Andric   Fields[8].Str =
4270e8d8bef9SDimitry Andric       this->getFullSymbolName(*Symbol, SymIndex, ShndxTable, StrTable, true);
42710b57cec5SDimitry Andric 
4272e8d8bef9SDimitry Andric   for (const Field &Entry : Fields)
42730b57cec5SDimitry Andric     printField(Entry);
42740b57cec5SDimitry Andric   OS << "\n";
42750b57cec5SDimitry Andric }
42760b57cec5SDimitry Andric 
42770b57cec5SDimitry Andric template <class ELFT>
printSymbols(bool PrintSymbols,bool PrintDynamicSymbols,bool ExtraSymInfo)4278e8d8bef9SDimitry Andric void GNUELFDumper<ELFT>::printSymbols(bool PrintSymbols,
42795f757f3fSDimitry Andric                                       bool PrintDynamicSymbols,
42805f757f3fSDimitry Andric                                       bool ExtraSymInfo) {
42810b57cec5SDimitry Andric   if (!PrintSymbols && !PrintDynamicSymbols)
42820b57cec5SDimitry Andric     return;
42830b57cec5SDimitry Andric   // GNU readelf prints both the .dynsym and .symtab with --symbols.
42845f757f3fSDimitry Andric   this->printSymbolsHelper(true, ExtraSymInfo);
42850b57cec5SDimitry Andric   if (PrintSymbols)
42865f757f3fSDimitry Andric     this->printSymbolsHelper(false, ExtraSymInfo);
42870b57cec5SDimitry Andric }
42880b57cec5SDimitry Andric 
42895ffd83dbSDimitry Andric template <class ELFT>
printHashTableSymbols(const Elf_Hash & SysVHash)4290e8d8bef9SDimitry Andric void GNUELFDumper<ELFT>::printHashTableSymbols(const Elf_Hash &SysVHash) {
4291e8d8bef9SDimitry Andric   if (this->DynamicStringTable.empty())
42920b57cec5SDimitry Andric     return;
42930b57cec5SDimitry Andric 
42940b57cec5SDimitry Andric   if (ELFT::Is64Bits)
42950b57cec5SDimitry Andric     OS << "  Num Buc:    Value          Size   Type   Bind Vis      Ndx Name";
42960b57cec5SDimitry Andric   else
42970b57cec5SDimitry Andric     OS << "  Num Buc:    Value  Size   Type   Bind Vis      Ndx Name";
42980b57cec5SDimitry Andric   OS << "\n";
42990b57cec5SDimitry Andric 
4300e8d8bef9SDimitry Andric   Elf_Sym_Range DynSyms = this->dynamic_symbols();
43015ffd83dbSDimitry Andric   const Elf_Sym *FirstSym = DynSyms.empty() ? nullptr : &DynSyms[0];
43025ffd83dbSDimitry Andric   if (!FirstSym) {
43035ffd83dbSDimitry Andric     this->reportUniqueWarning(
4304e8d8bef9SDimitry Andric         Twine("unable to print symbols for the .hash table: the "
43055ffd83dbSDimitry Andric               "dynamic symbol table ") +
4306e8d8bef9SDimitry Andric         (this->DynSymRegion ? "is empty" : "was not found"));
43075ffd83dbSDimitry Andric     return;
43085ffd83dbSDimitry Andric   }
43095ffd83dbSDimitry Andric 
4310e8d8bef9SDimitry Andric   DataRegion<Elf_Word> ShndxTable(
4311e8d8bef9SDimitry Andric       (const Elf_Word *)this->DynSymTabShndxRegion.Addr, this->Obj.end());
43125ffd83dbSDimitry Andric   auto Buckets = SysVHash.buckets();
43135ffd83dbSDimitry Andric   auto Chains = SysVHash.chains();
43145ffd83dbSDimitry Andric   for (uint32_t Buc = 0; Buc < SysVHash.nbucket; Buc++) {
43150b57cec5SDimitry Andric     if (Buckets[Buc] == ELF::STN_UNDEF)
43160b57cec5SDimitry Andric       continue;
431704eeddc0SDimitry Andric     BitVector Visited(SysVHash.nchain);
43185ffd83dbSDimitry Andric     for (uint32_t Ch = Buckets[Buc]; Ch < SysVHash.nchain; Ch = Chains[Ch]) {
43190b57cec5SDimitry Andric       if (Ch == ELF::STN_UNDEF)
43200b57cec5SDimitry Andric         break;
43218bcb0991SDimitry Andric 
43228bcb0991SDimitry Andric       if (Visited[Ch]) {
4323e8d8bef9SDimitry Andric         this->reportUniqueWarning(".hash section is invalid: bucket " +
43245ffd83dbSDimitry Andric                                   Twine(Ch) +
4325e8d8bef9SDimitry Andric                                   ": a cycle was detected in the linked chain");
43268bcb0991SDimitry Andric         break;
43278bcb0991SDimitry Andric       }
43288bcb0991SDimitry Andric 
4329e8d8bef9SDimitry Andric       printHashedSymbol(FirstSym + Ch, Ch, ShndxTable, this->DynamicStringTable,
4330e8d8bef9SDimitry Andric                         Buc);
43318bcb0991SDimitry Andric       Visited[Ch] = true;
43320b57cec5SDimitry Andric     }
43330b57cec5SDimitry Andric   }
43340b57cec5SDimitry Andric }
43350b57cec5SDimitry Andric 
43365ffd83dbSDimitry Andric template <class ELFT>
printGnuHashTableSymbols(const Elf_GnuHash & GnuHash)4337e8d8bef9SDimitry Andric void GNUELFDumper<ELFT>::printGnuHashTableSymbols(const Elf_GnuHash &GnuHash) {
4338e8d8bef9SDimitry Andric   if (this->DynamicStringTable.empty())
43395ffd83dbSDimitry Andric     return;
43405ffd83dbSDimitry Andric 
4341e8d8bef9SDimitry Andric   Elf_Sym_Range DynSyms = this->dynamic_symbols();
43425ffd83dbSDimitry Andric   const Elf_Sym *FirstSym = DynSyms.empty() ? nullptr : &DynSyms[0];
43435ffd83dbSDimitry Andric   if (!FirstSym) {
4344e8d8bef9SDimitry Andric     this->reportUniqueWarning(
43455ffd83dbSDimitry Andric         Twine("unable to print symbols for the .gnu.hash table: the "
43465ffd83dbSDimitry Andric               "dynamic symbol table ") +
4347e8d8bef9SDimitry Andric         (this->DynSymRegion ? "is empty" : "was not found"));
43485ffd83dbSDimitry Andric     return;
43495ffd83dbSDimitry Andric   }
43505ffd83dbSDimitry Andric 
4351e8d8bef9SDimitry Andric   auto GetSymbol = [&](uint64_t SymIndex,
4352e8d8bef9SDimitry Andric                        uint64_t SymsTotal) -> const Elf_Sym * {
4353e8d8bef9SDimitry Andric     if (SymIndex >= SymsTotal) {
4354e8d8bef9SDimitry Andric       this->reportUniqueWarning(
4355e8d8bef9SDimitry Andric           "unable to print hashed symbol with index " + Twine(SymIndex) +
4356e8d8bef9SDimitry Andric           ", which is greater than or equal to the number of dynamic symbols "
4357e8d8bef9SDimitry Andric           "(" +
4358e8d8bef9SDimitry Andric           Twine::utohexstr(SymsTotal) + ")");
4359e8d8bef9SDimitry Andric       return nullptr;
4360e8d8bef9SDimitry Andric     }
4361e8d8bef9SDimitry Andric     return FirstSym + SymIndex;
4362e8d8bef9SDimitry Andric   };
4363e8d8bef9SDimitry Andric 
4364e8d8bef9SDimitry Andric   Expected<ArrayRef<Elf_Word>> ValuesOrErr =
4365e8d8bef9SDimitry Andric       getGnuHashTableChains<ELFT>(this->DynSymRegion, &GnuHash);
4366e8d8bef9SDimitry Andric   ArrayRef<Elf_Word> Values;
4367e8d8bef9SDimitry Andric   if (!ValuesOrErr)
4368e8d8bef9SDimitry Andric     this->reportUniqueWarning("unable to get hash values for the SHT_GNU_HASH "
4369e8d8bef9SDimitry Andric                               "section: " +
4370e8d8bef9SDimitry Andric                               toString(ValuesOrErr.takeError()));
4371e8d8bef9SDimitry Andric   else
4372e8d8bef9SDimitry Andric     Values = *ValuesOrErr;
4373e8d8bef9SDimitry Andric 
4374e8d8bef9SDimitry Andric   DataRegion<Elf_Word> ShndxTable(
4375e8d8bef9SDimitry Andric       (const Elf_Word *)this->DynSymTabShndxRegion.Addr, this->Obj.end());
43765ffd83dbSDimitry Andric   ArrayRef<Elf_Word> Buckets = GnuHash.buckets();
43775ffd83dbSDimitry Andric   for (uint32_t Buc = 0; Buc < GnuHash.nbuckets; Buc++) {
43785ffd83dbSDimitry Andric     if (Buckets[Buc] == ELF::STN_UNDEF)
43795ffd83dbSDimitry Andric       continue;
43805ffd83dbSDimitry Andric     uint32_t Index = Buckets[Buc];
4381e8d8bef9SDimitry Andric     // Print whole chain.
43825ffd83dbSDimitry Andric     while (true) {
4383e8d8bef9SDimitry Andric       uint32_t SymIndex = Index++;
4384e8d8bef9SDimitry Andric       if (const Elf_Sym *Sym = GetSymbol(SymIndex, DynSyms.size()))
4385e8d8bef9SDimitry Andric         printHashedSymbol(Sym, SymIndex, ShndxTable, this->DynamicStringTable,
4386e8d8bef9SDimitry Andric                           Buc);
4387e8d8bef9SDimitry Andric       else
4388e8d8bef9SDimitry Andric         break;
4389e8d8bef9SDimitry Andric 
4390e8d8bef9SDimitry Andric       if (SymIndex < GnuHash.symndx) {
4391e8d8bef9SDimitry Andric         this->reportUniqueWarning(
4392e8d8bef9SDimitry Andric             "unable to read the hash value for symbol with index " +
4393e8d8bef9SDimitry Andric             Twine(SymIndex) +
4394e8d8bef9SDimitry Andric             ", which is less than the index of the first hashed symbol (" +
4395e8d8bef9SDimitry Andric             Twine(GnuHash.symndx) + ")");
4396e8d8bef9SDimitry Andric         break;
4397e8d8bef9SDimitry Andric       }
4398e8d8bef9SDimitry Andric 
4399e8d8bef9SDimitry Andric        // Chain ends at symbol with stopper bit.
4400e8d8bef9SDimitry Andric       if ((Values[SymIndex - GnuHash.symndx] & 1) == 1)
44015ffd83dbSDimitry Andric         break;
44025ffd83dbSDimitry Andric     }
44035ffd83dbSDimitry Andric   }
44045ffd83dbSDimitry Andric }
44055ffd83dbSDimitry Andric 
printHashSymbols()4406e8d8bef9SDimitry Andric template <class ELFT> void GNUELFDumper<ELFT>::printHashSymbols() {
4407e8d8bef9SDimitry Andric   if (this->HashTable) {
44085ffd83dbSDimitry Andric     OS << "\n Symbol table of .hash for image:\n";
4409e8d8bef9SDimitry Andric     if (Error E = checkHashTable<ELFT>(*this, this->HashTable))
44105ffd83dbSDimitry Andric       this->reportUniqueWarning(std::move(E));
44115ffd83dbSDimitry Andric     else
4412e8d8bef9SDimitry Andric       printHashTableSymbols(*this->HashTable);
44135ffd83dbSDimitry Andric   }
44145ffd83dbSDimitry Andric 
44155ffd83dbSDimitry Andric   // Try printing the .gnu.hash table.
4416e8d8bef9SDimitry Andric   if (this->GnuHashTable) {
44170b57cec5SDimitry Andric     OS << "\n Symbol table of .gnu.hash for image:\n";
44180b57cec5SDimitry Andric     if (ELFT::Is64Bits)
44190b57cec5SDimitry Andric       OS << "  Num Buc:    Value          Size   Type   Bind Vis      Ndx Name";
44200b57cec5SDimitry Andric     else
44210b57cec5SDimitry Andric       OS << "  Num Buc:    Value  Size   Type   Bind Vis      Ndx Name";
44220b57cec5SDimitry Andric     OS << "\n";
44235ffd83dbSDimitry Andric 
4424e8d8bef9SDimitry Andric     if (Error E = checkGNUHashTable<ELFT>(this->Obj, this->GnuHashTable))
44255ffd83dbSDimitry Andric       this->reportUniqueWarning(std::move(E));
44265ffd83dbSDimitry Andric     else
4427e8d8bef9SDimitry Andric       printGnuHashTableSymbols(*this->GnuHashTable);
4428e8d8bef9SDimitry Andric   }
4429e8d8bef9SDimitry Andric }
4430e8d8bef9SDimitry Andric 
printSectionDetails()4431e8d8bef9SDimitry Andric template <class ELFT> void GNUELFDumper<ELFT>::printSectionDetails() {
4432e8d8bef9SDimitry Andric   ArrayRef<Elf_Shdr> Sections = cantFail(this->Obj.sections());
4433bdd1243dSDimitry Andric   if (Sections.empty()) {
4434bdd1243dSDimitry Andric     OS << "\nThere are no sections in this file.\n";
4435bdd1243dSDimitry Andric     Expected<StringRef> SecStrTableOrErr =
4436bdd1243dSDimitry Andric         this->Obj.getSectionStringTable(Sections, this->WarningHandler);
4437bdd1243dSDimitry Andric     if (!SecStrTableOrErr)
4438bdd1243dSDimitry Andric       this->reportUniqueWarning(SecStrTableOrErr.takeError());
4439bdd1243dSDimitry Andric     return;
4440bdd1243dSDimitry Andric   }
4441e8d8bef9SDimitry Andric   OS << "There are " << to_string(Sections.size())
4442e8d8bef9SDimitry Andric      << " section headers, starting at offset "
444381ad6265SDimitry Andric      << "0x" << utohexstr(this->Obj.getHeader().e_shoff, /*LowerCase=*/true) << ":\n\n";
4444e8d8bef9SDimitry Andric 
4445e8d8bef9SDimitry Andric   OS << "Section Headers:\n";
4446e8d8bef9SDimitry Andric 
4447e8d8bef9SDimitry Andric   auto PrintFields = [&](ArrayRef<Field> V) {
4448e8d8bef9SDimitry Andric     for (const Field &F : V)
4449e8d8bef9SDimitry Andric       printField(F);
4450e8d8bef9SDimitry Andric     OS << "\n";
4451e8d8bef9SDimitry Andric   };
4452e8d8bef9SDimitry Andric 
4453e8d8bef9SDimitry Andric   PrintFields({{"[Nr]", 2}, {"Name", 7}});
4454e8d8bef9SDimitry Andric 
4455e8d8bef9SDimitry Andric   constexpr bool Is64 = ELFT::Is64Bits;
4456e8d8bef9SDimitry Andric   PrintFields({{"Type", 7},
4457e8d8bef9SDimitry Andric                {Is64 ? "Address" : "Addr", 23},
4458e8d8bef9SDimitry Andric                {"Off", Is64 ? 40 : 32},
4459e8d8bef9SDimitry Andric                {"Size", Is64 ? 47 : 39},
4460e8d8bef9SDimitry Andric                {"ES", Is64 ? 54 : 46},
4461e8d8bef9SDimitry Andric                {"Lk", Is64 ? 59 : 51},
4462e8d8bef9SDimitry Andric                {"Inf", Is64 ? 62 : 54},
4463e8d8bef9SDimitry Andric                {"Al", Is64 ? 66 : 57}});
4464e8d8bef9SDimitry Andric   PrintFields({{"Flags", 7}});
4465e8d8bef9SDimitry Andric 
4466e8d8bef9SDimitry Andric   StringRef SecStrTable;
4467e8d8bef9SDimitry Andric   if (Expected<StringRef> SecStrTableOrErr =
4468e8d8bef9SDimitry Andric           this->Obj.getSectionStringTable(Sections, this->WarningHandler))
4469e8d8bef9SDimitry Andric     SecStrTable = *SecStrTableOrErr;
4470e8d8bef9SDimitry Andric   else
4471e8d8bef9SDimitry Andric     this->reportUniqueWarning(SecStrTableOrErr.takeError());
4472e8d8bef9SDimitry Andric 
4473e8d8bef9SDimitry Andric   size_t SectionIndex = 0;
4474e8d8bef9SDimitry Andric   const unsigned AddrSize = Is64 ? 16 : 8;
4475e8d8bef9SDimitry Andric   for (const Elf_Shdr &S : Sections) {
4476e8d8bef9SDimitry Andric     StringRef Name = "<?>";
4477e8d8bef9SDimitry Andric     if (Expected<StringRef> NameOrErr =
4478e8d8bef9SDimitry Andric             this->Obj.getSectionName(S, SecStrTable))
4479e8d8bef9SDimitry Andric       Name = *NameOrErr;
4480e8d8bef9SDimitry Andric     else
4481e8d8bef9SDimitry Andric       this->reportUniqueWarning(NameOrErr.takeError());
4482e8d8bef9SDimitry Andric 
4483e8d8bef9SDimitry Andric     OS.PadToColumn(2);
4484e8d8bef9SDimitry Andric     OS << "[" << right_justify(to_string(SectionIndex), 2) << "]";
4485e8d8bef9SDimitry Andric     PrintFields({{Name, 7}});
4486e8d8bef9SDimitry Andric     PrintFields(
4487e8d8bef9SDimitry Andric         {{getSectionTypeString(this->Obj.getHeader().e_machine, S.sh_type), 7},
4488e8d8bef9SDimitry Andric          {to_string(format_hex_no_prefix(S.sh_addr, AddrSize)), 23},
4489e8d8bef9SDimitry Andric          {to_string(format_hex_no_prefix(S.sh_offset, 6)), Is64 ? 39 : 32},
4490e8d8bef9SDimitry Andric          {to_string(format_hex_no_prefix(S.sh_size, 6)), Is64 ? 47 : 39},
4491e8d8bef9SDimitry Andric          {to_string(format_hex_no_prefix(S.sh_entsize, 2)), Is64 ? 54 : 46},
4492e8d8bef9SDimitry Andric          {to_string(S.sh_link), Is64 ? 59 : 51},
4493e8d8bef9SDimitry Andric          {to_string(S.sh_info), Is64 ? 63 : 55},
4494e8d8bef9SDimitry Andric          {to_string(S.sh_addralign), Is64 ? 66 : 58}});
4495e8d8bef9SDimitry Andric 
4496e8d8bef9SDimitry Andric     OS.PadToColumn(7);
4497e8d8bef9SDimitry Andric     OS << "[" << to_string(format_hex_no_prefix(S.sh_flags, AddrSize)) << "]: ";
4498e8d8bef9SDimitry Andric 
4499e8d8bef9SDimitry Andric     DenseMap<unsigned, StringRef> FlagToName = {
4500e8d8bef9SDimitry Andric         {SHF_WRITE, "WRITE"},           {SHF_ALLOC, "ALLOC"},
4501e8d8bef9SDimitry Andric         {SHF_EXECINSTR, "EXEC"},        {SHF_MERGE, "MERGE"},
4502e8d8bef9SDimitry Andric         {SHF_STRINGS, "STRINGS"},       {SHF_INFO_LINK, "INFO LINK"},
4503e8d8bef9SDimitry Andric         {SHF_LINK_ORDER, "LINK ORDER"}, {SHF_OS_NONCONFORMING, "OS NONCONF"},
4504e8d8bef9SDimitry Andric         {SHF_GROUP, "GROUP"},           {SHF_TLS, "TLS"},
4505e8d8bef9SDimitry Andric         {SHF_COMPRESSED, "COMPRESSED"}, {SHF_EXCLUDE, "EXCLUDE"}};
4506e8d8bef9SDimitry Andric 
4507e8d8bef9SDimitry Andric     uint64_t Flags = S.sh_flags;
4508e8d8bef9SDimitry Andric     uint64_t UnknownFlags = 0;
4509fe6060f1SDimitry Andric     ListSeparator LS;
4510e8d8bef9SDimitry Andric     while (Flags) {
4511e8d8bef9SDimitry Andric       // Take the least significant bit as a flag.
4512e8d8bef9SDimitry Andric       uint64_t Flag = Flags & -Flags;
4513e8d8bef9SDimitry Andric       Flags -= Flag;
4514e8d8bef9SDimitry Andric 
4515e8d8bef9SDimitry Andric       auto It = FlagToName.find(Flag);
4516fe6060f1SDimitry Andric       if (It != FlagToName.end())
4517fe6060f1SDimitry Andric         OS << LS << It->second;
4518fe6060f1SDimitry Andric       else
4519e8d8bef9SDimitry Andric         UnknownFlags |= Flag;
4520e8d8bef9SDimitry Andric     }
4521e8d8bef9SDimitry Andric 
4522e8d8bef9SDimitry Andric     auto PrintUnknownFlags = [&](uint64_t Mask, StringRef Name) {
4523e8d8bef9SDimitry Andric       uint64_t FlagsToPrint = UnknownFlags & Mask;
4524e8d8bef9SDimitry Andric       if (!FlagsToPrint)
4525e8d8bef9SDimitry Andric         return;
4526e8d8bef9SDimitry Andric 
4527fe6060f1SDimitry Andric       OS << LS << Name << " ("
4528e8d8bef9SDimitry Andric          << to_string(format_hex_no_prefix(FlagsToPrint, AddrSize)) << ")";
4529e8d8bef9SDimitry Andric       UnknownFlags &= ~Mask;
4530e8d8bef9SDimitry Andric     };
4531e8d8bef9SDimitry Andric 
4532e8d8bef9SDimitry Andric     PrintUnknownFlags(SHF_MASKOS, "OS");
4533e8d8bef9SDimitry Andric     PrintUnknownFlags(SHF_MASKPROC, "PROC");
4534e8d8bef9SDimitry Andric     PrintUnknownFlags(uint64_t(-1), "UNKNOWN");
4535e8d8bef9SDimitry Andric 
4536e8d8bef9SDimitry Andric     OS << "\n";
4537e8d8bef9SDimitry Andric     ++SectionIndex;
4538bdd1243dSDimitry Andric 
4539bdd1243dSDimitry Andric     if (!(S.sh_flags & SHF_COMPRESSED))
4540bdd1243dSDimitry Andric       continue;
4541bdd1243dSDimitry Andric     Expected<ArrayRef<uint8_t>> Data = this->Obj.getSectionContents(S);
4542bdd1243dSDimitry Andric     if (!Data || Data->size() < sizeof(Elf_Chdr)) {
4543bdd1243dSDimitry Andric       consumeError(Data.takeError());
4544bdd1243dSDimitry Andric       reportWarning(createError("SHF_COMPRESSED section '" + Name +
4545bdd1243dSDimitry Andric                                 "' does not have an Elf_Chdr header"),
4546bdd1243dSDimitry Andric                     this->FileName);
4547bdd1243dSDimitry Andric       OS.indent(7);
4548bdd1243dSDimitry Andric       OS << "[<corrupt>]";
4549bdd1243dSDimitry Andric     } else {
4550bdd1243dSDimitry Andric       OS.indent(7);
4551bdd1243dSDimitry Andric       auto *Chdr = reinterpret_cast<const Elf_Chdr *>(Data->data());
4552bdd1243dSDimitry Andric       if (Chdr->ch_type == ELFCOMPRESS_ZLIB)
4553bdd1243dSDimitry Andric         OS << "ZLIB";
4554bdd1243dSDimitry Andric       else if (Chdr->ch_type == ELFCOMPRESS_ZSTD)
4555bdd1243dSDimitry Andric         OS << "ZSTD";
4556bdd1243dSDimitry Andric       else
4557bdd1243dSDimitry Andric         OS << format("[<unknown>: 0x%x]", unsigned(Chdr->ch_type));
4558bdd1243dSDimitry Andric       OS << ", " << format_hex_no_prefix(Chdr->ch_size, ELFT::Is64Bits ? 16 : 8)
4559bdd1243dSDimitry Andric          << ", " << Chdr->ch_addralign;
4560bdd1243dSDimitry Andric     }
4561bdd1243dSDimitry Andric     OS << '\n';
45620b57cec5SDimitry Andric   }
45630b57cec5SDimitry Andric }
45640b57cec5SDimitry Andric 
printPhdrFlags(unsigned Flag)45650b57cec5SDimitry Andric static inline std::string printPhdrFlags(unsigned Flag) {
45660b57cec5SDimitry Andric   std::string Str;
45670b57cec5SDimitry Andric   Str = (Flag & PF_R) ? "R" : " ";
45680b57cec5SDimitry Andric   Str += (Flag & PF_W) ? "W" : " ";
45690b57cec5SDimitry Andric   Str += (Flag & PF_X) ? "E" : " ";
45700b57cec5SDimitry Andric   return Str;
45710b57cec5SDimitry Andric }
45720b57cec5SDimitry Andric 
45730b57cec5SDimitry Andric template <class ELFT>
checkTLSSections(const typename ELFT::Phdr & Phdr,const typename ELFT::Shdr & Sec)45745ffd83dbSDimitry Andric static bool checkTLSSections(const typename ELFT::Phdr &Phdr,
45755ffd83dbSDimitry Andric                              const typename ELFT::Shdr &Sec) {
45765ffd83dbSDimitry Andric   if (Sec.sh_flags & ELF::SHF_TLS) {
45775ffd83dbSDimitry Andric     // .tbss must only be shown in the PT_TLS segment.
45785ffd83dbSDimitry Andric     if (Sec.sh_type == ELF::SHT_NOBITS)
45795ffd83dbSDimitry Andric       return Phdr.p_type == ELF::PT_TLS;
45805ffd83dbSDimitry Andric 
45815ffd83dbSDimitry Andric     // SHF_TLS sections are only shown in PT_TLS, PT_LOAD or PT_GNU_RELRO
45825ffd83dbSDimitry Andric     // segments.
45835ffd83dbSDimitry Andric     return (Phdr.p_type == ELF::PT_TLS) || (Phdr.p_type == ELF::PT_LOAD) ||
45845ffd83dbSDimitry Andric            (Phdr.p_type == ELF::PT_GNU_RELRO);
45850b57cec5SDimitry Andric   }
45860b57cec5SDimitry Andric 
45875ffd83dbSDimitry Andric   // PT_TLS must only have SHF_TLS sections.
45885ffd83dbSDimitry Andric   return Phdr.p_type != ELF::PT_TLS;
45895ffd83dbSDimitry Andric }
45905ffd83dbSDimitry Andric 
45910b57cec5SDimitry Andric template <class ELFT>
checkPTDynamic(const typename ELFT::Phdr & Phdr,const typename ELFT::Shdr & Sec)45925ffd83dbSDimitry Andric static bool checkPTDynamic(const typename ELFT::Phdr &Phdr,
45935ffd83dbSDimitry Andric                            const typename ELFT::Shdr &Sec) {
45945ffd83dbSDimitry Andric   if (Phdr.p_type != ELF::PT_DYNAMIC || Phdr.p_memsz == 0 || Sec.sh_size != 0)
45950b57cec5SDimitry Andric     return true;
45965ffd83dbSDimitry Andric 
45975ffd83dbSDimitry Andric   // We get here when we have an empty section. Only non-empty sections can be
45985ffd83dbSDimitry Andric   // at the start or at the end of PT_DYNAMIC.
45990b57cec5SDimitry Andric   // Is section within the phdr both based on offset and VMA?
46005ffd83dbSDimitry Andric   bool CheckOffset = (Sec.sh_type == ELF::SHT_NOBITS) ||
46010b57cec5SDimitry Andric                      (Sec.sh_offset > Phdr.p_offset &&
46025ffd83dbSDimitry Andric                       Sec.sh_offset < Phdr.p_offset + Phdr.p_filesz);
46035ffd83dbSDimitry Andric   bool CheckVA = !(Sec.sh_flags & ELF::SHF_ALLOC) ||
46045ffd83dbSDimitry Andric                  (Sec.sh_addr > Phdr.p_vaddr && Sec.sh_addr < Phdr.p_memsz);
46055ffd83dbSDimitry Andric   return CheckOffset && CheckVA;
46060b57cec5SDimitry Andric }
46070b57cec5SDimitry Andric 
46080b57cec5SDimitry Andric template <class ELFT>
printProgramHeaders(bool PrintProgramHeaders,cl::boolOrDefault PrintSectionMapping)4609e8d8bef9SDimitry Andric void GNUELFDumper<ELFT>::printProgramHeaders(
4610e8d8bef9SDimitry Andric     bool PrintProgramHeaders, cl::boolOrDefault PrintSectionMapping) {
4611bdd1243dSDimitry Andric   const bool ShouldPrintSectionMapping = (PrintSectionMapping != cl::BOU_FALSE);
4612bdd1243dSDimitry Andric   // Exit early if no program header or section mapping details were requested.
4613bdd1243dSDimitry Andric   if (!PrintProgramHeaders && !ShouldPrintSectionMapping)
4614bdd1243dSDimitry Andric     return;
46150b57cec5SDimitry Andric 
4616bdd1243dSDimitry Andric   if (PrintProgramHeaders) {
4617bdd1243dSDimitry Andric     const Elf_Ehdr &Header = this->Obj.getHeader();
4618bdd1243dSDimitry Andric     if (Header.e_phnum == 0) {
4619bdd1243dSDimitry Andric       OS << "\nThere are no program headers in this file.\n";
4620bdd1243dSDimitry Andric     } else {
4621bdd1243dSDimitry Andric       printProgramHeaders();
4622bdd1243dSDimitry Andric     }
4623bdd1243dSDimitry Andric   }
4624bdd1243dSDimitry Andric 
4625bdd1243dSDimitry Andric   if (ShouldPrintSectionMapping)
4626e8d8bef9SDimitry Andric     printSectionMapping();
46270b57cec5SDimitry Andric }
46280b57cec5SDimitry Andric 
printProgramHeaders()4629e8d8bef9SDimitry Andric template <class ELFT> void GNUELFDumper<ELFT>::printProgramHeaders() {
46300b57cec5SDimitry Andric   unsigned Bias = ELFT::Is64Bits ? 8 : 0;
4631e8d8bef9SDimitry Andric   const Elf_Ehdr &Header = this->Obj.getHeader();
46320b57cec5SDimitry Andric   Field Fields[8] = {2,         17,        26,        37 + Bias,
46330b57cec5SDimitry Andric                      48 + Bias, 56 + Bias, 64 + Bias, 68 + Bias};
46340b57cec5SDimitry Andric   OS << "\nElf file type is "
4635bdd1243dSDimitry Andric      << enumToString(Header.e_type, ArrayRef(ElfObjectFileType)) << "\n"
4636e8d8bef9SDimitry Andric      << "Entry point " << format_hex(Header.e_entry, 3) << "\n"
4637e8d8bef9SDimitry Andric      << "There are " << Header.e_phnum << " program headers,"
4638e8d8bef9SDimitry Andric      << " starting at offset " << Header.e_phoff << "\n\n"
46390b57cec5SDimitry Andric      << "Program Headers:\n";
46400b57cec5SDimitry Andric   if (ELFT::Is64Bits)
46410b57cec5SDimitry Andric     OS << "  Type           Offset   VirtAddr           PhysAddr         "
46420b57cec5SDimitry Andric        << "  FileSiz  MemSiz   Flg Align\n";
46430b57cec5SDimitry Andric   else
46440b57cec5SDimitry Andric     OS << "  Type           Offset   VirtAddr   PhysAddr   FileSiz "
46450b57cec5SDimitry Andric        << "MemSiz  Flg Align\n";
46460b57cec5SDimitry Andric 
46470b57cec5SDimitry Andric   unsigned Width = ELFT::Is64Bits ? 18 : 10;
46480b57cec5SDimitry Andric   unsigned SizeWidth = ELFT::Is64Bits ? 8 : 7;
46495ffd83dbSDimitry Andric 
4650e8d8bef9SDimitry Andric   Expected<ArrayRef<Elf_Phdr>> PhdrsOrErr = this->Obj.program_headers();
46515ffd83dbSDimitry Andric   if (!PhdrsOrErr) {
4652e8d8bef9SDimitry Andric     this->reportUniqueWarning("unable to dump program headers: " +
4653e8d8bef9SDimitry Andric                               toString(PhdrsOrErr.takeError()));
46545ffd83dbSDimitry Andric     return;
46555ffd83dbSDimitry Andric   }
46565ffd83dbSDimitry Andric 
46575ffd83dbSDimitry Andric   for (const Elf_Phdr &Phdr : *PhdrsOrErr) {
4658e8d8bef9SDimitry Andric     Fields[0].Str = getGNUPtType(Header.e_machine, Phdr.p_type);
46590b57cec5SDimitry Andric     Fields[1].Str = to_string(format_hex(Phdr.p_offset, 8));
46600b57cec5SDimitry Andric     Fields[2].Str = to_string(format_hex(Phdr.p_vaddr, Width));
46610b57cec5SDimitry Andric     Fields[3].Str = to_string(format_hex(Phdr.p_paddr, Width));
46620b57cec5SDimitry Andric     Fields[4].Str = to_string(format_hex(Phdr.p_filesz, SizeWidth));
46630b57cec5SDimitry Andric     Fields[5].Str = to_string(format_hex(Phdr.p_memsz, SizeWidth));
46640b57cec5SDimitry Andric     Fields[6].Str = printPhdrFlags(Phdr.p_flags);
46650b57cec5SDimitry Andric     Fields[7].Str = to_string(format_hex(Phdr.p_align, 1));
4666e8d8bef9SDimitry Andric     for (const Field &F : Fields)
4667e8d8bef9SDimitry Andric       printField(F);
46680b57cec5SDimitry Andric     if (Phdr.p_type == ELF::PT_INTERP) {
46695ffd83dbSDimitry Andric       OS << "\n";
46705ffd83dbSDimitry Andric       auto ReportBadInterp = [&](const Twine &Msg) {
4671e8d8bef9SDimitry Andric         this->reportUniqueWarning(
4672e8d8bef9SDimitry Andric             "unable to read program interpreter name at offset 0x" +
4673e8d8bef9SDimitry Andric             Twine::utohexstr(Phdr.p_offset) + ": " + Msg);
46745ffd83dbSDimitry Andric       };
46755ffd83dbSDimitry Andric 
4676e8d8bef9SDimitry Andric       if (Phdr.p_offset >= this->Obj.getBufSize()) {
46775ffd83dbSDimitry Andric         ReportBadInterp("it goes past the end of the file (0x" +
4678e8d8bef9SDimitry Andric                         Twine::utohexstr(this->Obj.getBufSize()) + ")");
46795ffd83dbSDimitry Andric         continue;
46805ffd83dbSDimitry Andric       }
46815ffd83dbSDimitry Andric 
46825ffd83dbSDimitry Andric       const char *Data =
4683e8d8bef9SDimitry Andric           reinterpret_cast<const char *>(this->Obj.base()) + Phdr.p_offset;
4684e8d8bef9SDimitry Andric       size_t MaxSize = this->Obj.getBufSize() - Phdr.p_offset;
46855ffd83dbSDimitry Andric       size_t Len = strnlen(Data, MaxSize);
46865ffd83dbSDimitry Andric       if (Len == MaxSize) {
46875ffd83dbSDimitry Andric         ReportBadInterp("it is not null-terminated");
46885ffd83dbSDimitry Andric         continue;
46895ffd83dbSDimitry Andric       }
46905ffd83dbSDimitry Andric 
46915ffd83dbSDimitry Andric       OS << "      [Requesting program interpreter: ";
46925ffd83dbSDimitry Andric       OS << StringRef(Data, Len) << "]";
46930b57cec5SDimitry Andric     }
46940b57cec5SDimitry Andric     OS << "\n";
46950b57cec5SDimitry Andric   }
46960b57cec5SDimitry Andric }
46970b57cec5SDimitry Andric 
printSectionMapping()4698e8d8bef9SDimitry Andric template <class ELFT> void GNUELFDumper<ELFT>::printSectionMapping() {
46990b57cec5SDimitry Andric   OS << "\n Section to Segment mapping:\n  Segment Sections...\n";
47000b57cec5SDimitry Andric   DenseSet<const Elf_Shdr *> BelongsToSegment;
47010b57cec5SDimitry Andric   int Phnum = 0;
47025ffd83dbSDimitry Andric 
4703e8d8bef9SDimitry Andric   Expected<ArrayRef<Elf_Phdr>> PhdrsOrErr = this->Obj.program_headers();
47045ffd83dbSDimitry Andric   if (!PhdrsOrErr) {
4705e8d8bef9SDimitry Andric     this->reportUniqueWarning(
47065ffd83dbSDimitry Andric         "can't read program headers to build section to segment mapping: " +
4707e8d8bef9SDimitry Andric         toString(PhdrsOrErr.takeError()));
47085ffd83dbSDimitry Andric     return;
47095ffd83dbSDimitry Andric   }
47105ffd83dbSDimitry Andric 
47115ffd83dbSDimitry Andric   for (const Elf_Phdr &Phdr : *PhdrsOrErr) {
47120b57cec5SDimitry Andric     std::string Sections;
47130b57cec5SDimitry Andric     OS << format("   %2.2d     ", Phnum++);
47140b57cec5SDimitry Andric     // Check if each section is in a segment and then print mapping.
4715e8d8bef9SDimitry Andric     for (const Elf_Shdr &Sec : cantFail(this->Obj.sections())) {
47165ffd83dbSDimitry Andric       if (Sec.sh_type == ELF::SHT_NULL)
47175ffd83dbSDimitry Andric         continue;
47185ffd83dbSDimitry Andric 
47190b57cec5SDimitry Andric       // readelf additionally makes sure it does not print zero sized sections
47200b57cec5SDimitry Andric       // at end of segments and for PT_DYNAMIC both start and end of section
47210b57cec5SDimitry Andric       // .tbss must only be shown in PT_TLS section.
47225f757f3fSDimitry Andric       if (isSectionInSegment<ELFT>(Phdr, Sec) &&
47235f757f3fSDimitry Andric           checkTLSSections<ELFT>(Phdr, Sec) &&
47245f757f3fSDimitry Andric           checkPTDynamic<ELFT>(Phdr, Sec)) {
47258bcb0991SDimitry Andric         Sections +=
4726e8d8bef9SDimitry Andric             unwrapOrError(this->FileName, this->Obj.getSectionName(Sec)).str() +
47278bcb0991SDimitry Andric             " ";
47280b57cec5SDimitry Andric         BelongsToSegment.insert(&Sec);
47290b57cec5SDimitry Andric       }
47300b57cec5SDimitry Andric     }
47310b57cec5SDimitry Andric     OS << Sections << "\n";
47320b57cec5SDimitry Andric     OS.flush();
47330b57cec5SDimitry Andric   }
47340b57cec5SDimitry Andric 
47350b57cec5SDimitry Andric   // Display sections that do not belong to a segment.
47360b57cec5SDimitry Andric   std::string Sections;
4737e8d8bef9SDimitry Andric   for (const Elf_Shdr &Sec : cantFail(this->Obj.sections())) {
47380b57cec5SDimitry Andric     if (BelongsToSegment.find(&Sec) == BelongsToSegment.end())
47398bcb0991SDimitry Andric       Sections +=
4740e8d8bef9SDimitry Andric           unwrapOrError(this->FileName, this->Obj.getSectionName(Sec)).str() +
4741e8d8bef9SDimitry Andric           ' ';
47420b57cec5SDimitry Andric   }
47430b57cec5SDimitry Andric   if (!Sections.empty()) {
47440b57cec5SDimitry Andric     OS << "   None  " << Sections << '\n';
47450b57cec5SDimitry Andric     OS.flush();
47460b57cec5SDimitry Andric   }
47470b57cec5SDimitry Andric }
47480b57cec5SDimitry Andric 
47498bcb0991SDimitry Andric namespace {
47508bcb0991SDimitry Andric 
47518bcb0991SDimitry Andric template <class ELFT>
getSymbolForReloc(const ELFDumper<ELFT> & Dumper,const Relocation<ELFT> & Reloc)4752e8d8bef9SDimitry Andric RelSymbol<ELFT> getSymbolForReloc(const ELFDumper<ELFT> &Dumper,
4753e8d8bef9SDimitry Andric                                   const Relocation<ELFT> &Reloc) {
4754e8d8bef9SDimitry Andric   using Elf_Sym = typename ELFT::Sym;
4755e8d8bef9SDimitry Andric   auto WarnAndReturn = [&](const Elf_Sym *Sym,
47565ffd83dbSDimitry Andric                            const Twine &Reason) -> RelSymbol<ELFT> {
4757e8d8bef9SDimitry Andric     Dumper.reportUniqueWarning(
4758e8d8bef9SDimitry Andric         "unable to get name of the dynamic symbol with index " +
4759e8d8bef9SDimitry Andric         Twine(Reloc.Symbol) + ": " + Reason);
47605ffd83dbSDimitry Andric     return {Sym, "<corrupt>"};
47615ffd83dbSDimitry Andric   };
47628bcb0991SDimitry Andric 
4763e8d8bef9SDimitry Andric   ArrayRef<Elf_Sym> Symbols = Dumper.dynamic_symbols();
4764e8d8bef9SDimitry Andric   const Elf_Sym *FirstSym = Symbols.begin();
47655ffd83dbSDimitry Andric   if (!FirstSym)
47665ffd83dbSDimitry Andric     return WarnAndReturn(nullptr, "no dynamic symbol table found");
47675ffd83dbSDimitry Andric 
47685ffd83dbSDimitry Andric   // We might have an object without a section header. In this case the size of
47695ffd83dbSDimitry Andric   // Symbols is zero, because there is no way to know the size of the dynamic
47705ffd83dbSDimitry Andric   // table. We should allow this case and not print a warning.
4771e8d8bef9SDimitry Andric   if (!Symbols.empty() && Reloc.Symbol >= Symbols.size())
47725ffd83dbSDimitry Andric     return WarnAndReturn(
47735ffd83dbSDimitry Andric         nullptr,
47745ffd83dbSDimitry Andric         "index is greater than or equal to the number of dynamic symbols (" +
47755ffd83dbSDimitry Andric             Twine(Symbols.size()) + ")");
47765ffd83dbSDimitry Andric 
4777e8d8bef9SDimitry Andric   const ELFFile<ELFT> &Obj = Dumper.getElfObject().getELFFile();
4778e8d8bef9SDimitry Andric   const uint64_t FileSize = Obj.getBufSize();
4779e8d8bef9SDimitry Andric   const uint64_t SymOffset = ((const uint8_t *)FirstSym - Obj.base()) +
4780e8d8bef9SDimitry Andric                              (uint64_t)Reloc.Symbol * sizeof(Elf_Sym);
4781e8d8bef9SDimitry Andric   if (SymOffset + sizeof(Elf_Sym) > FileSize)
4782e8d8bef9SDimitry Andric     return WarnAndReturn(nullptr, "symbol at 0x" + Twine::utohexstr(SymOffset) +
4783e8d8bef9SDimitry Andric                                       " goes past the end of the file (0x" +
4784e8d8bef9SDimitry Andric                                       Twine::utohexstr(FileSize) + ")");
4785e8d8bef9SDimitry Andric 
4786e8d8bef9SDimitry Andric   const Elf_Sym *Sym = FirstSym + Reloc.Symbol;
4787e8d8bef9SDimitry Andric   Expected<StringRef> ErrOrName = Sym->getName(Dumper.getDynamicStringTable());
47885ffd83dbSDimitry Andric   if (!ErrOrName)
47895ffd83dbSDimitry Andric     return WarnAndReturn(Sym, toString(ErrOrName.takeError()));
47905ffd83dbSDimitry Andric 
47915ffd83dbSDimitry Andric   return {Sym == FirstSym ? nullptr : Sym, maybeDemangle(*ErrOrName)};
47928bcb0991SDimitry Andric }
47938bcb0991SDimitry Andric } // namespace
47948bcb0991SDimitry Andric 
47950b57cec5SDimitry Andric template <class ELFT>
getMaxDynamicTagSize(const ELFFile<ELFT> & Obj,typename ELFT::DynRange Tags)4796e8d8bef9SDimitry Andric static size_t getMaxDynamicTagSize(const ELFFile<ELFT> &Obj,
47975ffd83dbSDimitry Andric                                    typename ELFT::DynRange Tags) {
47985ffd83dbSDimitry Andric   size_t Max = 0;
47995ffd83dbSDimitry Andric   for (const typename ELFT::Dyn &Dyn : Tags)
4800e8d8bef9SDimitry Andric     Max = std::max(Max, Obj.getDynamicTagAsString(Dyn.d_tag).size());
48015ffd83dbSDimitry Andric   return Max;
48025ffd83dbSDimitry Andric }
48035ffd83dbSDimitry Andric 
printDynamicTable()4804e8d8bef9SDimitry Andric template <class ELFT> void GNUELFDumper<ELFT>::printDynamicTable() {
4805e8d8bef9SDimitry Andric   Elf_Dyn_Range Table = this->dynamic_table();
48060b57cec5SDimitry Andric   if (Table.empty())
48070b57cec5SDimitry Andric     return;
48080b57cec5SDimitry Andric 
48090b57cec5SDimitry Andric   OS << "Dynamic section at offset "
4810e8d8bef9SDimitry Andric      << format_hex(reinterpret_cast<const uint8_t *>(this->DynamicTable.Addr) -
4811e8d8bef9SDimitry Andric                        this->Obj.base(),
48120b57cec5SDimitry Andric                    1)
48130b57cec5SDimitry Andric      << " contains " << Table.size() << " entries:\n";
48140b57cec5SDimitry Andric 
48155ffd83dbSDimitry Andric   // The type name is surrounded with round brackets, hence add 2.
4816e8d8bef9SDimitry Andric   size_t MaxTagSize = getMaxDynamicTagSize(this->Obj, Table) + 2;
48175ffd83dbSDimitry Andric   // The "Name/Value" column should be indented from the "Type" column by N
48185ffd83dbSDimitry Andric   // spaces, where N = MaxTagSize - length of "Type" (4) + trailing
48195ffd83dbSDimitry Andric   // space (1) = 3.
48205ffd83dbSDimitry Andric   OS << "  Tag" + std::string(ELFT::Is64Bits ? 16 : 8, ' ') + "Type"
48215ffd83dbSDimitry Andric      << std::string(MaxTagSize - 3, ' ') << "Name/Value\n";
48225ffd83dbSDimitry Andric 
48235ffd83dbSDimitry Andric   std::string ValueFmt = " %-" + std::to_string(MaxTagSize) + "s ";
48240b57cec5SDimitry Andric   for (auto Entry : Table) {
48250b57cec5SDimitry Andric     uintX_t Tag = Entry.getTag();
48265ffd83dbSDimitry Andric     std::string Type =
4827349cc55cSDimitry Andric         std::string("(") + this->Obj.getDynamicTagAsString(Tag) + ")";
4828e8d8bef9SDimitry Andric     std::string Value = this->getDynamicEntry(Tag, Entry.getVal());
48295ffd83dbSDimitry Andric     OS << "  " << format_hex(Tag, ELFT::Is64Bits ? 18 : 10)
48305ffd83dbSDimitry Andric        << format(ValueFmt.c_str(), Type.c_str()) << Value << "\n";
48310b57cec5SDimitry Andric   }
48320b57cec5SDimitry Andric }
48330b57cec5SDimitry Andric 
printDynamicRelocations()4834e8d8bef9SDimitry Andric template <class ELFT> void GNUELFDumper<ELFT>::printDynamicRelocations() {
4835e8d8bef9SDimitry Andric   this->printDynamicRelocationsHelper();
48360b57cec5SDimitry Andric }
48375ffd83dbSDimitry Andric 
4838e8d8bef9SDimitry Andric template <class ELFT>
printDynamicReloc(const Relocation<ELFT> & R)4839e8d8bef9SDimitry Andric void ELFDumper<ELFT>::printDynamicReloc(const Relocation<ELFT> &R) {
4840e8d8bef9SDimitry Andric   printRelRelaReloc(R, getSymbolForReloc(*this, R));
4841e8d8bef9SDimitry Andric }
4842e8d8bef9SDimitry Andric 
4843e8d8bef9SDimitry Andric template <class ELFT>
printRelocationsHelper(const Elf_Shdr & Sec)4844e8d8bef9SDimitry Andric void ELFDumper<ELFT>::printRelocationsHelper(const Elf_Shdr &Sec) {
4845e8d8bef9SDimitry Andric   this->forEachRelocationDo(
4846e8d8bef9SDimitry Andric       Sec, opts::RawRelr,
4847e8d8bef9SDimitry Andric       [&](const Relocation<ELFT> &R, unsigned Ndx, const Elf_Shdr &Sec,
4848e8d8bef9SDimitry Andric           const Elf_Shdr *SymTab) { printReloc(R, Ndx, Sec, SymTab); },
4849e8d8bef9SDimitry Andric       [&](const Elf_Relr &R) { printRelrReloc(R); });
4850e8d8bef9SDimitry Andric }
4851e8d8bef9SDimitry Andric 
printDynamicRelocationsHelper()4852e8d8bef9SDimitry Andric template <class ELFT> void ELFDumper<ELFT>::printDynamicRelocationsHelper() {
4853e8d8bef9SDimitry Andric   const bool IsMips64EL = this->Obj.isMips64EL();
4854e8d8bef9SDimitry Andric   if (this->DynRelaRegion.Size > 0) {
4855e8d8bef9SDimitry Andric     printDynamicRelocHeader(ELF::SHT_RELA, "RELA", this->DynRelaRegion);
4856e8d8bef9SDimitry Andric     for (const Elf_Rela &Rela :
4857e8d8bef9SDimitry Andric          this->DynRelaRegion.template getAsArrayRef<Elf_Rela>())
4858e8d8bef9SDimitry Andric       printDynamicReloc(Relocation<ELFT>(Rela, IsMips64EL));
4859e8d8bef9SDimitry Andric   }
4860e8d8bef9SDimitry Andric 
4861e8d8bef9SDimitry Andric   if (this->DynRelRegion.Size > 0) {
4862e8d8bef9SDimitry Andric     printDynamicRelocHeader(ELF::SHT_REL, "REL", this->DynRelRegion);
4863e8d8bef9SDimitry Andric     for (const Elf_Rel &Rel :
4864e8d8bef9SDimitry Andric          this->DynRelRegion.template getAsArrayRef<Elf_Rel>())
4865e8d8bef9SDimitry Andric       printDynamicReloc(Relocation<ELFT>(Rel, IsMips64EL));
4866e8d8bef9SDimitry Andric   }
4867e8d8bef9SDimitry Andric 
4868e8d8bef9SDimitry Andric   if (this->DynRelrRegion.Size > 0) {
4869e8d8bef9SDimitry Andric     printDynamicRelocHeader(ELF::SHT_REL, "RELR", this->DynRelrRegion);
4870e8d8bef9SDimitry Andric     Elf_Relr_Range Relrs =
4871e8d8bef9SDimitry Andric         this->DynRelrRegion.template getAsArrayRef<Elf_Relr>();
4872e8d8bef9SDimitry Andric     for (const Elf_Rel &Rel : Obj.decode_relrs(Relrs))
4873e8d8bef9SDimitry Andric       printDynamicReloc(Relocation<ELFT>(Rel, IsMips64EL));
4874e8d8bef9SDimitry Andric   }
4875e8d8bef9SDimitry Andric 
4876e8d8bef9SDimitry Andric   if (this->DynPLTRelRegion.Size) {
4877e8d8bef9SDimitry Andric     if (this->DynPLTRelRegion.EntSize == sizeof(Elf_Rela)) {
4878e8d8bef9SDimitry Andric       printDynamicRelocHeader(ELF::SHT_RELA, "PLT", this->DynPLTRelRegion);
4879e8d8bef9SDimitry Andric       for (const Elf_Rela &Rela :
4880e8d8bef9SDimitry Andric            this->DynPLTRelRegion.template getAsArrayRef<Elf_Rela>())
4881e8d8bef9SDimitry Andric         printDynamicReloc(Relocation<ELFT>(Rela, IsMips64EL));
48820b57cec5SDimitry Andric     } else {
4883e8d8bef9SDimitry Andric       printDynamicRelocHeader(ELF::SHT_REL, "PLT", this->DynPLTRelRegion);
4884e8d8bef9SDimitry Andric       for (const Elf_Rel &Rel :
4885e8d8bef9SDimitry Andric            this->DynPLTRelRegion.template getAsArrayRef<Elf_Rel>())
4886e8d8bef9SDimitry Andric         printDynamicReloc(Relocation<ELFT>(Rel, IsMips64EL));
48870b57cec5SDimitry Andric     }
48880b57cec5SDimitry Andric   }
48895ffd83dbSDimitry Andric }
48900b57cec5SDimitry Andric 
48910b57cec5SDimitry Andric template <class ELFT>
printGNUVersionSectionProlog(const typename ELFT::Shdr & Sec,const Twine & Label,unsigned EntriesNum)4892e8d8bef9SDimitry Andric void GNUELFDumper<ELFT>::printGNUVersionSectionProlog(
4893e8d8bef9SDimitry Andric     const typename ELFT::Shdr &Sec, const Twine &Label, unsigned EntriesNum) {
4894e8d8bef9SDimitry Andric   // Don't inline the SecName, because it might report a warning to stderr and
4895e8d8bef9SDimitry Andric   // corrupt the output.
4896e8d8bef9SDimitry Andric   StringRef SecName = this->getPrintableSectionName(Sec);
4897480093f4SDimitry Andric   OS << Label << " section '" << SecName << "' "
48980b57cec5SDimitry Andric      << "contains " << EntriesNum << " entries:\n";
48990b57cec5SDimitry Andric 
4900e8d8bef9SDimitry Andric   StringRef LinkedSecName = "<corrupt>";
4901e8d8bef9SDimitry Andric   if (Expected<const typename ELFT::Shdr *> LinkedSecOrErr =
4902e8d8bef9SDimitry Andric           this->Obj.getSection(Sec.sh_link))
4903e8d8bef9SDimitry Andric     LinkedSecName = this->getPrintableSectionName(**LinkedSecOrErr);
4904480093f4SDimitry Andric   else
4905e8d8bef9SDimitry Andric     this->reportUniqueWarning("invalid section linked to " +
4906e8d8bef9SDimitry Andric                               this->describe(Sec) + ": " +
4907e8d8bef9SDimitry Andric                               toString(LinkedSecOrErr.takeError()));
4908480093f4SDimitry Andric 
4909e8d8bef9SDimitry Andric   OS << " Addr: " << format_hex_no_prefix(Sec.sh_addr, 16)
4910e8d8bef9SDimitry Andric      << "  Offset: " << format_hex(Sec.sh_offset, 8)
4911e8d8bef9SDimitry Andric      << "  Link: " << Sec.sh_link << " (" << LinkedSecName << ")\n";
49120b57cec5SDimitry Andric }
49130b57cec5SDimitry Andric 
49140b57cec5SDimitry Andric template <class ELFT>
printVersionSymbolSection(const Elf_Shdr * Sec)4915e8d8bef9SDimitry Andric void GNUELFDumper<ELFT>::printVersionSymbolSection(const Elf_Shdr *Sec) {
49160b57cec5SDimitry Andric   if (!Sec)
49170b57cec5SDimitry Andric     return;
49180b57cec5SDimitry Andric 
4919e8d8bef9SDimitry Andric   printGNUVersionSectionProlog(*Sec, "Version symbols",
4920480093f4SDimitry Andric                                Sec->sh_size / sizeof(Elf_Versym));
4921480093f4SDimitry Andric   Expected<ArrayRef<Elf_Versym>> VerTableOrErr =
4922e8d8bef9SDimitry Andric       this->getVersionTable(*Sec, /*SymTab=*/nullptr,
4923e8d8bef9SDimitry Andric                             /*StrTab=*/nullptr, /*SymTabSec=*/nullptr);
4924480093f4SDimitry Andric   if (!VerTableOrErr) {
4925480093f4SDimitry Andric     this->reportUniqueWarning(VerTableOrErr.takeError());
4926480093f4SDimitry Andric     return;
4927480093f4SDimitry Andric   }
49280b57cec5SDimitry Andric 
4929bdd1243dSDimitry Andric   SmallVector<std::optional<VersionEntry>, 0> *VersionMap = nullptr;
4930bdd1243dSDimitry Andric   if (Expected<SmallVector<std::optional<VersionEntry>, 0> *> MapOrErr =
4931e8d8bef9SDimitry Andric           this->getVersionMap())
4932e8d8bef9SDimitry Andric     VersionMap = *MapOrErr;
4933e8d8bef9SDimitry Andric   else
4934e8d8bef9SDimitry Andric     this->reportUniqueWarning(MapOrErr.takeError());
4935e8d8bef9SDimitry Andric 
4936480093f4SDimitry Andric   ArrayRef<Elf_Versym> VerTable = *VerTableOrErr;
4937480093f4SDimitry Andric   std::vector<StringRef> Versions;
4938480093f4SDimitry Andric   for (size_t I = 0, E = VerTable.size(); I < E; ++I) {
4939480093f4SDimitry Andric     unsigned Ndx = VerTable[I].vs_index;
4940480093f4SDimitry Andric     if (Ndx == VER_NDX_LOCAL || Ndx == VER_NDX_GLOBAL) {
4941480093f4SDimitry Andric       Versions.emplace_back(Ndx == VER_NDX_LOCAL ? "*local*" : "*global*");
4942480093f4SDimitry Andric       continue;
4943480093f4SDimitry Andric     }
4944480093f4SDimitry Andric 
4945e8d8bef9SDimitry Andric     if (!VersionMap) {
4946e8d8bef9SDimitry Andric       Versions.emplace_back("<corrupt>");
4947e8d8bef9SDimitry Andric       continue;
4948480093f4SDimitry Andric     }
4949e8d8bef9SDimitry Andric 
4950e8d8bef9SDimitry Andric     bool IsDefault;
4951e8d8bef9SDimitry Andric     Expected<StringRef> NameOrErr = this->Obj.getSymbolVersionByIndex(
4952bdd1243dSDimitry Andric         Ndx, IsDefault, *VersionMap, /*IsSymHidden=*/std::nullopt);
4953e8d8bef9SDimitry Andric     if (!NameOrErr) {
4954e8d8bef9SDimitry Andric       this->reportUniqueWarning("unable to get a version for entry " +
4955e8d8bef9SDimitry Andric                                 Twine(I) + " of " + this->describe(*Sec) +
4956e8d8bef9SDimitry Andric                                 ": " + toString(NameOrErr.takeError()));
4957480093f4SDimitry Andric       Versions.emplace_back("<corrupt>");
4958480093f4SDimitry Andric       continue;
4959480093f4SDimitry Andric     }
4960480093f4SDimitry Andric     Versions.emplace_back(*NameOrErr);
4961480093f4SDimitry Andric   }
49620b57cec5SDimitry Andric 
49630b57cec5SDimitry Andric   // readelf prints 4 entries per line.
4964480093f4SDimitry Andric   uint64_t Entries = VerTable.size();
49650b57cec5SDimitry Andric   for (uint64_t VersymRow = 0; VersymRow < Entries; VersymRow += 4) {
49660b57cec5SDimitry Andric     OS << "  " << format_hex_no_prefix(VersymRow, 3) << ":";
4967480093f4SDimitry Andric     for (uint64_t I = 0; (I < 4) && (I + VersymRow) < Entries; ++I) {
4968480093f4SDimitry Andric       unsigned Ndx = VerTable[VersymRow + I].vs_index;
4969480093f4SDimitry Andric       OS << format("%4x%c", Ndx & VERSYM_VERSION,
4970480093f4SDimitry Andric                    Ndx & VERSYM_HIDDEN ? 'h' : ' ');
4971480093f4SDimitry Andric       OS << left_justify("(" + std::string(Versions[VersymRow + I]) + ")", 13);
49720b57cec5SDimitry Andric     }
49730b57cec5SDimitry Andric     OS << '\n';
49740b57cec5SDimitry Andric   }
49750b57cec5SDimitry Andric   OS << '\n';
49760b57cec5SDimitry Andric }
49770b57cec5SDimitry Andric 
versionFlagToString(unsigned Flags)49780b57cec5SDimitry Andric static std::string versionFlagToString(unsigned Flags) {
49790b57cec5SDimitry Andric   if (Flags == 0)
49800b57cec5SDimitry Andric     return "none";
49810b57cec5SDimitry Andric 
49820b57cec5SDimitry Andric   std::string Ret;
49830b57cec5SDimitry Andric   auto AddFlag = [&Ret, &Flags](unsigned Flag, StringRef Name) {
49840b57cec5SDimitry Andric     if (!(Flags & Flag))
49850b57cec5SDimitry Andric       return;
49860b57cec5SDimitry Andric     if (!Ret.empty())
49870b57cec5SDimitry Andric       Ret += " | ";
49880b57cec5SDimitry Andric     Ret += Name;
49890b57cec5SDimitry Andric     Flags &= ~Flag;
49900b57cec5SDimitry Andric   };
49910b57cec5SDimitry Andric 
49920b57cec5SDimitry Andric   AddFlag(VER_FLG_BASE, "BASE");
49930b57cec5SDimitry Andric   AddFlag(VER_FLG_WEAK, "WEAK");
49940b57cec5SDimitry Andric   AddFlag(VER_FLG_INFO, "INFO");
49950b57cec5SDimitry Andric   AddFlag(~0, "<unknown>");
49960b57cec5SDimitry Andric   return Ret;
49970b57cec5SDimitry Andric }
49980b57cec5SDimitry Andric 
49990b57cec5SDimitry Andric template <class ELFT>
printVersionDefinitionSection(const Elf_Shdr * Sec)5000e8d8bef9SDimitry Andric void GNUELFDumper<ELFT>::printVersionDefinitionSection(const Elf_Shdr *Sec) {
50010b57cec5SDimitry Andric   if (!Sec)
50020b57cec5SDimitry Andric     return;
50030b57cec5SDimitry Andric 
5004e8d8bef9SDimitry Andric   printGNUVersionSectionProlog(*Sec, "Version definition", Sec->sh_info);
50050b57cec5SDimitry Andric 
5006e8d8bef9SDimitry Andric   Expected<std::vector<VerDef>> V = this->Obj.getVersionDefinitions(*Sec);
5007480093f4SDimitry Andric   if (!V) {
5008480093f4SDimitry Andric     this->reportUniqueWarning(V.takeError());
5009480093f4SDimitry Andric     return;
50100b57cec5SDimitry Andric   }
50110b57cec5SDimitry Andric 
5012480093f4SDimitry Andric   for (const VerDef &Def : *V) {
5013480093f4SDimitry Andric     OS << format("  0x%04x: Rev: %u  Flags: %s  Index: %u  Cnt: %u  Name: %s\n",
5014480093f4SDimitry Andric                  Def.Offset, Def.Version,
5015480093f4SDimitry Andric                  versionFlagToString(Def.Flags).c_str(), Def.Ndx, Def.Cnt,
5016480093f4SDimitry Andric                  Def.Name.data());
5017480093f4SDimitry Andric     unsigned I = 0;
5018480093f4SDimitry Andric     for (const VerdAux &Aux : Def.AuxV)
5019480093f4SDimitry Andric       OS << format("  0x%04x: Parent %u: %s\n", Aux.Offset, ++I,
5020480093f4SDimitry Andric                    Aux.Name.data());
50210b57cec5SDimitry Andric   }
5022480093f4SDimitry Andric 
50230b57cec5SDimitry Andric   OS << '\n';
50240b57cec5SDimitry Andric }
50250b57cec5SDimitry Andric 
50260b57cec5SDimitry Andric template <class ELFT>
printVersionDependencySection(const Elf_Shdr * Sec)5027e8d8bef9SDimitry Andric void GNUELFDumper<ELFT>::printVersionDependencySection(const Elf_Shdr *Sec) {
50280b57cec5SDimitry Andric   if (!Sec)
50290b57cec5SDimitry Andric     return;
50300b57cec5SDimitry Andric 
50310b57cec5SDimitry Andric   unsigned VerneedNum = Sec->sh_info;
5032e8d8bef9SDimitry Andric   printGNUVersionSectionProlog(*Sec, "Version needs", VerneedNum);
50330b57cec5SDimitry Andric 
5034480093f4SDimitry Andric   Expected<std::vector<VerNeed>> V =
5035e8d8bef9SDimitry Andric       this->Obj.getVersionDependencies(*Sec, this->WarningHandler);
5036480093f4SDimitry Andric   if (!V) {
5037480093f4SDimitry Andric     this->reportUniqueWarning(V.takeError());
5038480093f4SDimitry Andric     return;
50390b57cec5SDimitry Andric   }
5040480093f4SDimitry Andric 
5041480093f4SDimitry Andric   for (const VerNeed &VN : *V) {
5042480093f4SDimitry Andric     OS << format("  0x%04x: Version: %u  File: %s  Cnt: %u\n", VN.Offset,
5043480093f4SDimitry Andric                  VN.Version, VN.File.data(), VN.Cnt);
5044480093f4SDimitry Andric     for (const VernAux &Aux : VN.AuxV)
5045480093f4SDimitry Andric       OS << format("  0x%04x:   Name: %s  Flags: %s  Version: %u\n", Aux.Offset,
5046480093f4SDimitry Andric                    Aux.Name.data(), versionFlagToString(Aux.Flags).c_str(),
5047480093f4SDimitry Andric                    Aux.Other);
50480b57cec5SDimitry Andric   }
50490b57cec5SDimitry Andric   OS << '\n';
50500b57cec5SDimitry Andric }
50510b57cec5SDimitry Andric 
50520b57cec5SDimitry Andric template <class ELFT>
printHashHistogramStats(size_t NBucket,size_t MaxChain,size_t TotalSyms,ArrayRef<size_t> Count,bool IsGnu) const505306c3fb27SDimitry Andric void GNUELFDumper<ELFT>::printHashHistogramStats(size_t NBucket,
505406c3fb27SDimitry Andric                                                  size_t MaxChain,
505506c3fb27SDimitry Andric                                                  size_t TotalSyms,
505606c3fb27SDimitry Andric                                                  ArrayRef<size_t> Count,
505706c3fb27SDimitry Andric                                                  bool IsGnu) const {
50580b57cec5SDimitry Andric   size_t CumulativeNonZero = 0;
505906c3fb27SDimitry Andric   OS << "Histogram for" << (IsGnu ? " `.gnu.hash'" : "")
506006c3fb27SDimitry Andric      << " bucket list length (total of " << NBucket << " buckets)\n"
50610b57cec5SDimitry Andric      << " Length  Number     % of total  Coverage\n";
506206c3fb27SDimitry Andric   for (size_t I = 0; I < MaxChain; ++I) {
50630b57cec5SDimitry Andric     CumulativeNonZero += Count[I] * I;
50640b57cec5SDimitry Andric     OS << format("%7lu  %-10lu (%5.1f%%)     %5.1f%%\n", I, Count[I],
50650b57cec5SDimitry Andric                  (Count[I] * 100.0) / NBucket,
50660b57cec5SDimitry Andric                  (CumulativeNonZero * 100.0) / TotalSyms);
50670b57cec5SDimitry Andric   }
50680b57cec5SDimitry Andric }
50690b57cec5SDimitry Andric 
printCGProfile()5070e8d8bef9SDimitry Andric template <class ELFT> void GNUELFDumper<ELFT>::printCGProfile() {
50710b57cec5SDimitry Andric   OS << "GNUStyle::printCGProfile not implemented\n";
50720b57cec5SDimitry Andric }
50730b57cec5SDimitry Andric 
printBBAddrMaps()5074fe6060f1SDimitry Andric template <class ELFT> void GNUELFDumper<ELFT>::printBBAddrMaps() {
5075fe6060f1SDimitry Andric   OS << "GNUStyle::printBBAddrMaps not implemented\n";
5076fe6060f1SDimitry Andric }
5077fe6060f1SDimitry Andric 
toULEB128Array(ArrayRef<uint8_t> Data)5078e8d8bef9SDimitry Andric static Expected<std::vector<uint64_t>> toULEB128Array(ArrayRef<uint8_t> Data) {
5079e8d8bef9SDimitry Andric   std::vector<uint64_t> Ret;
5080e8d8bef9SDimitry Andric   const uint8_t *Cur = Data.begin();
5081e8d8bef9SDimitry Andric   const uint8_t *End = Data.end();
5082e8d8bef9SDimitry Andric   while (Cur != End) {
5083e8d8bef9SDimitry Andric     unsigned Size;
50845f757f3fSDimitry Andric     const char *Err = nullptr;
5085e8d8bef9SDimitry Andric     Ret.push_back(decodeULEB128(Cur, &Size, End, &Err));
5086e8d8bef9SDimitry Andric     if (Err)
5087e8d8bef9SDimitry Andric       return createError(Err);
5088e8d8bef9SDimitry Andric     Cur += Size;
5089e8d8bef9SDimitry Andric   }
5090e8d8bef9SDimitry Andric   return Ret;
5091e8d8bef9SDimitry Andric }
5092e8d8bef9SDimitry Andric 
50930b57cec5SDimitry Andric template <class ELFT>
5094e8d8bef9SDimitry Andric static Expected<std::vector<uint64_t>>
decodeAddrsigSection(const ELFFile<ELFT> & Obj,const typename ELFT::Shdr & Sec)5095e8d8bef9SDimitry Andric decodeAddrsigSection(const ELFFile<ELFT> &Obj, const typename ELFT::Shdr &Sec) {
5096e8d8bef9SDimitry Andric   Expected<ArrayRef<uint8_t>> ContentsOrErr = Obj.getSectionContents(Sec);
5097e8d8bef9SDimitry Andric   if (!ContentsOrErr)
5098e8d8bef9SDimitry Andric     return ContentsOrErr.takeError();
5099e8d8bef9SDimitry Andric 
5100e8d8bef9SDimitry Andric   if (Expected<std::vector<uint64_t>> SymsOrErr =
5101e8d8bef9SDimitry Andric           toULEB128Array(*ContentsOrErr))
5102e8d8bef9SDimitry Andric     return *SymsOrErr;
5103e8d8bef9SDimitry Andric   else
5104e8d8bef9SDimitry Andric     return createError("unable to decode " + describe(Obj, Sec) + ": " +
5105e8d8bef9SDimitry Andric                        toString(SymsOrErr.takeError()));
51060b57cec5SDimitry Andric }
51070b57cec5SDimitry Andric 
printAddrsig()5108e8d8bef9SDimitry Andric template <class ELFT> void GNUELFDumper<ELFT>::printAddrsig() {
5109e8d8bef9SDimitry Andric   if (!this->DotAddrsigSec)
5110e8d8bef9SDimitry Andric     return;
51110b57cec5SDimitry Andric 
5112e8d8bef9SDimitry Andric   Expected<std::vector<uint64_t>> SymsOrErr =
5113e8d8bef9SDimitry Andric       decodeAddrsigSection(this->Obj, *this->DotAddrsigSec);
5114e8d8bef9SDimitry Andric   if (!SymsOrErr) {
5115e8d8bef9SDimitry Andric     this->reportUniqueWarning(SymsOrErr.takeError());
5116e8d8bef9SDimitry Andric     return;
51170b57cec5SDimitry Andric   }
51180b57cec5SDimitry Andric 
5119e8d8bef9SDimitry Andric   StringRef Name = this->getPrintableSectionName(*this->DotAddrsigSec);
5120e8d8bef9SDimitry Andric   OS << "\nAddress-significant symbols section '" << Name << "'"
5121e8d8bef9SDimitry Andric      << " contains " << SymsOrErr->size() << " entries:\n";
5122e8d8bef9SDimitry Andric   OS << "   Num: Name\n";
51238bcb0991SDimitry Andric 
5124e8d8bef9SDimitry Andric   Field Fields[2] = {0, 8};
5125e8d8bef9SDimitry Andric   size_t SymIndex = 0;
5126e8d8bef9SDimitry Andric   for (uint64_t Sym : *SymsOrErr) {
5127e8d8bef9SDimitry Andric     Fields[0].Str = to_string(format_decimal(++SymIndex, 6)) + ":";
5128e8d8bef9SDimitry Andric     Fields[1].Str = this->getStaticSymbolName(Sym);
5129e8d8bef9SDimitry Andric     for (const Field &Entry : Fields)
5130e8d8bef9SDimitry Andric       printField(Entry);
5131e8d8bef9SDimitry Andric     OS << "\n";
51328bcb0991SDimitry Andric   }
51330b57cec5SDimitry Andric }
51340b57cec5SDimitry Andric 
51350b57cec5SDimitry Andric template <typename ELFT>
getGNUProperty(uint32_t Type,uint32_t DataSize,ArrayRef<uint8_t> Data)51360b57cec5SDimitry Andric static std::string getGNUProperty(uint32_t Type, uint32_t DataSize,
51370b57cec5SDimitry Andric                                   ArrayRef<uint8_t> Data) {
51380b57cec5SDimitry Andric   std::string str;
51390b57cec5SDimitry Andric   raw_string_ostream OS(str);
51400b57cec5SDimitry Andric   uint32_t PrData;
51410b57cec5SDimitry Andric   auto DumpBit = [&](uint32_t Flag, StringRef Name) {
51420b57cec5SDimitry Andric     if (PrData & Flag) {
51430b57cec5SDimitry Andric       PrData &= ~Flag;
51440b57cec5SDimitry Andric       OS << Name;
51450b57cec5SDimitry Andric       if (PrData)
51460b57cec5SDimitry Andric         OS << ", ";
51470b57cec5SDimitry Andric     }
51480b57cec5SDimitry Andric   };
51490b57cec5SDimitry Andric 
51500b57cec5SDimitry Andric   switch (Type) {
51510b57cec5SDimitry Andric   default:
51520b57cec5SDimitry Andric     OS << format("<application-specific type 0x%x>", Type);
51530b57cec5SDimitry Andric     return OS.str();
51540b57cec5SDimitry Andric   case GNU_PROPERTY_STACK_SIZE: {
51550b57cec5SDimitry Andric     OS << "stack size: ";
51560b57cec5SDimitry Andric     if (DataSize == sizeof(typename ELFT::uint))
51570b57cec5SDimitry Andric       OS << formatv("{0:x}",
51580b57cec5SDimitry Andric                     (uint64_t)(*(const typename ELFT::Addr *)Data.data()));
51590b57cec5SDimitry Andric     else
51600b57cec5SDimitry Andric       OS << format("<corrupt length: 0x%x>", DataSize);
51610b57cec5SDimitry Andric     return OS.str();
51620b57cec5SDimitry Andric   }
51630b57cec5SDimitry Andric   case GNU_PROPERTY_NO_COPY_ON_PROTECTED:
51640b57cec5SDimitry Andric     OS << "no copy on protected";
51650b57cec5SDimitry Andric     if (DataSize)
51660b57cec5SDimitry Andric       OS << format(" <corrupt length: 0x%x>", DataSize);
51670b57cec5SDimitry Andric     return OS.str();
51680b57cec5SDimitry Andric   case GNU_PROPERTY_AARCH64_FEATURE_1_AND:
51690b57cec5SDimitry Andric   case GNU_PROPERTY_X86_FEATURE_1_AND:
51700b57cec5SDimitry Andric     OS << ((Type == GNU_PROPERTY_AARCH64_FEATURE_1_AND) ? "aarch64 feature: "
51710b57cec5SDimitry Andric                                                         : "x86 feature: ");
51720b57cec5SDimitry Andric     if (DataSize != 4) {
51730b57cec5SDimitry Andric       OS << format("<corrupt length: 0x%x>", DataSize);
51740b57cec5SDimitry Andric       return OS.str();
51750b57cec5SDimitry Andric     }
51760b57cec5SDimitry Andric     PrData = support::endian::read32<ELFT::TargetEndianness>(Data.data());
51770b57cec5SDimitry Andric     if (PrData == 0) {
51780b57cec5SDimitry Andric       OS << "<None>";
51790b57cec5SDimitry Andric       return OS.str();
51800b57cec5SDimitry Andric     }
51810b57cec5SDimitry Andric     if (Type == GNU_PROPERTY_AARCH64_FEATURE_1_AND) {
51820b57cec5SDimitry Andric       DumpBit(GNU_PROPERTY_AARCH64_FEATURE_1_BTI, "BTI");
51830b57cec5SDimitry Andric       DumpBit(GNU_PROPERTY_AARCH64_FEATURE_1_PAC, "PAC");
51845f757f3fSDimitry Andric       DumpBit(GNU_PROPERTY_AARCH64_FEATURE_1_GCS, "GCS");
51850b57cec5SDimitry Andric     } else {
51860b57cec5SDimitry Andric       DumpBit(GNU_PROPERTY_X86_FEATURE_1_IBT, "IBT");
51870b57cec5SDimitry Andric       DumpBit(GNU_PROPERTY_X86_FEATURE_1_SHSTK, "SHSTK");
51880b57cec5SDimitry Andric     }
51890b57cec5SDimitry Andric     if (PrData)
51900b57cec5SDimitry Andric       OS << format("<unknown flags: 0x%x>", PrData);
51910b57cec5SDimitry Andric     return OS.str();
51920b57cec5SDimitry Andric   case GNU_PROPERTY_X86_FEATURE_2_NEEDED:
51930b57cec5SDimitry Andric   case GNU_PROPERTY_X86_FEATURE_2_USED:
51940b57cec5SDimitry Andric     OS << "x86 feature "
51950b57cec5SDimitry Andric        << (Type == GNU_PROPERTY_X86_FEATURE_2_NEEDED ? "needed: " : "used: ");
51960b57cec5SDimitry Andric     if (DataSize != 4) {
51970b57cec5SDimitry Andric       OS << format("<corrupt length: 0x%x>", DataSize);
51980b57cec5SDimitry Andric       return OS.str();
51990b57cec5SDimitry Andric     }
52000b57cec5SDimitry Andric     PrData = support::endian::read32<ELFT::TargetEndianness>(Data.data());
52010b57cec5SDimitry Andric     if (PrData == 0) {
52020b57cec5SDimitry Andric       OS << "<None>";
52030b57cec5SDimitry Andric       return OS.str();
52040b57cec5SDimitry Andric     }
52050b57cec5SDimitry Andric     DumpBit(GNU_PROPERTY_X86_FEATURE_2_X86, "x86");
52060b57cec5SDimitry Andric     DumpBit(GNU_PROPERTY_X86_FEATURE_2_X87, "x87");
52070b57cec5SDimitry Andric     DumpBit(GNU_PROPERTY_X86_FEATURE_2_MMX, "MMX");
52080b57cec5SDimitry Andric     DumpBit(GNU_PROPERTY_X86_FEATURE_2_XMM, "XMM");
52090b57cec5SDimitry Andric     DumpBit(GNU_PROPERTY_X86_FEATURE_2_YMM, "YMM");
52100b57cec5SDimitry Andric     DumpBit(GNU_PROPERTY_X86_FEATURE_2_ZMM, "ZMM");
52110b57cec5SDimitry Andric     DumpBit(GNU_PROPERTY_X86_FEATURE_2_FXSR, "FXSR");
52120b57cec5SDimitry Andric     DumpBit(GNU_PROPERTY_X86_FEATURE_2_XSAVE, "XSAVE");
52130b57cec5SDimitry Andric     DumpBit(GNU_PROPERTY_X86_FEATURE_2_XSAVEOPT, "XSAVEOPT");
52140b57cec5SDimitry Andric     DumpBit(GNU_PROPERTY_X86_FEATURE_2_XSAVEC, "XSAVEC");
52150b57cec5SDimitry Andric     if (PrData)
52160b57cec5SDimitry Andric       OS << format("<unknown flags: 0x%x>", PrData);
52170b57cec5SDimitry Andric     return OS.str();
5218fe6060f1SDimitry Andric   case GNU_PROPERTY_X86_ISA_1_NEEDED:
5219fe6060f1SDimitry Andric   case GNU_PROPERTY_X86_ISA_1_USED:
5220fe6060f1SDimitry Andric     OS << "x86 ISA "
5221fe6060f1SDimitry Andric        << (Type == GNU_PROPERTY_X86_ISA_1_NEEDED ? "needed: " : "used: ");
5222fe6060f1SDimitry Andric     if (DataSize != 4) {
5223fe6060f1SDimitry Andric       OS << format("<corrupt length: 0x%x>", DataSize);
5224fe6060f1SDimitry Andric       return OS.str();
5225fe6060f1SDimitry Andric     }
5226fe6060f1SDimitry Andric     PrData = support::endian::read32<ELFT::TargetEndianness>(Data.data());
5227fe6060f1SDimitry Andric     if (PrData == 0) {
5228fe6060f1SDimitry Andric       OS << "<None>";
5229fe6060f1SDimitry Andric       return OS.str();
5230fe6060f1SDimitry Andric     }
5231fe6060f1SDimitry Andric     DumpBit(GNU_PROPERTY_X86_ISA_1_BASELINE, "x86-64-baseline");
5232fe6060f1SDimitry Andric     DumpBit(GNU_PROPERTY_X86_ISA_1_V2, "x86-64-v2");
5233fe6060f1SDimitry Andric     DumpBit(GNU_PROPERTY_X86_ISA_1_V3, "x86-64-v3");
5234fe6060f1SDimitry Andric     DumpBit(GNU_PROPERTY_X86_ISA_1_V4, "x86-64-v4");
5235fe6060f1SDimitry Andric     if (PrData)
5236fe6060f1SDimitry Andric       OS << format("<unknown flags: 0x%x>", PrData);
5237fe6060f1SDimitry Andric     return OS.str();
52380b57cec5SDimitry Andric   }
52390b57cec5SDimitry Andric }
52400b57cec5SDimitry Andric 
52410b57cec5SDimitry Andric template <typename ELFT>
getGNUPropertyList(ArrayRef<uint8_t> Arr)52420b57cec5SDimitry Andric static SmallVector<std::string, 4> getGNUPropertyList(ArrayRef<uint8_t> Arr) {
52430b57cec5SDimitry Andric   using Elf_Word = typename ELFT::Word;
52440b57cec5SDimitry Andric 
52450b57cec5SDimitry Andric   SmallVector<std::string, 4> Properties;
52460b57cec5SDimitry Andric   while (Arr.size() >= 8) {
52470b57cec5SDimitry Andric     uint32_t Type = *reinterpret_cast<const Elf_Word *>(Arr.data());
52480b57cec5SDimitry Andric     uint32_t DataSize = *reinterpret_cast<const Elf_Word *>(Arr.data() + 4);
52490b57cec5SDimitry Andric     Arr = Arr.drop_front(8);
52500b57cec5SDimitry Andric 
52510b57cec5SDimitry Andric     // Take padding size into account if present.
52520b57cec5SDimitry Andric     uint64_t PaddedSize = alignTo(DataSize, sizeof(typename ELFT::uint));
52530b57cec5SDimitry Andric     std::string str;
52540b57cec5SDimitry Andric     raw_string_ostream OS(str);
52550b57cec5SDimitry Andric     if (Arr.size() < PaddedSize) {
52560b57cec5SDimitry Andric       OS << format("<corrupt type (0x%x) datasz: 0x%x>", Type, DataSize);
52570b57cec5SDimitry Andric       Properties.push_back(OS.str());
52580b57cec5SDimitry Andric       break;
52590b57cec5SDimitry Andric     }
52600b57cec5SDimitry Andric     Properties.push_back(
52610b57cec5SDimitry Andric         getGNUProperty<ELFT>(Type, DataSize, Arr.take_front(PaddedSize)));
52620b57cec5SDimitry Andric     Arr = Arr.drop_front(PaddedSize);
52630b57cec5SDimitry Andric   }
52640b57cec5SDimitry Andric 
52650b57cec5SDimitry Andric   if (!Arr.empty())
52660b57cec5SDimitry Andric     Properties.push_back("<corrupted GNU_PROPERTY_TYPE_0>");
52670b57cec5SDimitry Andric 
52680b57cec5SDimitry Andric   return Properties;
52690b57cec5SDimitry Andric }
52700b57cec5SDimitry Andric 
52710b57cec5SDimitry Andric struct GNUAbiTag {
52720b57cec5SDimitry Andric   std::string OSName;
52730b57cec5SDimitry Andric   std::string ABI;
52740b57cec5SDimitry Andric   bool IsValid;
52750b57cec5SDimitry Andric };
52760b57cec5SDimitry Andric 
getGNUAbiTag(ArrayRef<uint8_t> Desc)52770b57cec5SDimitry Andric template <typename ELFT> static GNUAbiTag getGNUAbiTag(ArrayRef<uint8_t> Desc) {
52780b57cec5SDimitry Andric   typedef typename ELFT::Word Elf_Word;
52790b57cec5SDimitry Andric 
52800b57cec5SDimitry Andric   ArrayRef<Elf_Word> Words(reinterpret_cast<const Elf_Word *>(Desc.begin()),
52810b57cec5SDimitry Andric                            reinterpret_cast<const Elf_Word *>(Desc.end()));
52820b57cec5SDimitry Andric 
52830b57cec5SDimitry Andric   if (Words.size() < 4)
52840b57cec5SDimitry Andric     return {"", "", /*IsValid=*/false};
52850b57cec5SDimitry Andric 
52860b57cec5SDimitry Andric   static const char *OSNames[] = {
52870b57cec5SDimitry Andric       "Linux", "Hurd", "Solaris", "FreeBSD", "NetBSD", "Syllable", "NaCl",
52880b57cec5SDimitry Andric   };
52890b57cec5SDimitry Andric   StringRef OSName = "Unknown";
5290bdd1243dSDimitry Andric   if (Words[0] < std::size(OSNames))
52910b57cec5SDimitry Andric     OSName = OSNames[Words[0]];
52920b57cec5SDimitry Andric   uint32_t Major = Words[1], Minor = Words[2], Patch = Words[3];
52930b57cec5SDimitry Andric   std::string str;
52940b57cec5SDimitry Andric   raw_string_ostream ABI(str);
52950b57cec5SDimitry Andric   ABI << Major << "." << Minor << "." << Patch;
52965ffd83dbSDimitry Andric   return {std::string(OSName), ABI.str(), /*IsValid=*/true};
52970b57cec5SDimitry Andric }
52980b57cec5SDimitry Andric 
getGNUBuildId(ArrayRef<uint8_t> Desc)52990b57cec5SDimitry Andric static std::string getGNUBuildId(ArrayRef<uint8_t> Desc) {
53000b57cec5SDimitry Andric   std::string str;
53010b57cec5SDimitry Andric   raw_string_ostream OS(str);
5302e8d8bef9SDimitry Andric   for (uint8_t B : Desc)
53030b57cec5SDimitry Andric     OS << format_hex_no_prefix(B, 2);
53040b57cec5SDimitry Andric   return OS.str();
53050b57cec5SDimitry Andric }
53060b57cec5SDimitry Andric 
getDescAsStringRef(ArrayRef<uint8_t> Desc)5307349cc55cSDimitry Andric static StringRef getDescAsStringRef(ArrayRef<uint8_t> Desc) {
53080b57cec5SDimitry Andric   return StringRef(reinterpret_cast<const char *>(Desc.data()), Desc.size());
53090b57cec5SDimitry Andric }
53100b57cec5SDimitry Andric 
53110b57cec5SDimitry Andric template <typename ELFT>
printGNUNote(raw_ostream & OS,uint32_t NoteType,ArrayRef<uint8_t> Desc)5312fe6060f1SDimitry Andric static bool printGNUNote(raw_ostream &OS, uint32_t NoteType,
53130b57cec5SDimitry Andric                          ArrayRef<uint8_t> Desc) {
5314fe6060f1SDimitry Andric   // Return true if we were able to pretty-print the note, false otherwise.
53150b57cec5SDimitry Andric   switch (NoteType) {
53160b57cec5SDimitry Andric   default:
5317fe6060f1SDimitry Andric     return false;
53180b57cec5SDimitry Andric   case ELF::NT_GNU_ABI_TAG: {
53190b57cec5SDimitry Andric     const GNUAbiTag &AbiTag = getGNUAbiTag<ELFT>(Desc);
53200b57cec5SDimitry Andric     if (!AbiTag.IsValid)
53210b57cec5SDimitry Andric       OS << "    <corrupt GNU_ABI_TAG>";
53220b57cec5SDimitry Andric     else
53230b57cec5SDimitry Andric       OS << "    OS: " << AbiTag.OSName << ", ABI: " << AbiTag.ABI;
53240b57cec5SDimitry Andric     break;
53250b57cec5SDimitry Andric   }
53260b57cec5SDimitry Andric   case ELF::NT_GNU_BUILD_ID: {
53270b57cec5SDimitry Andric     OS << "    Build ID: " << getGNUBuildId(Desc);
53280b57cec5SDimitry Andric     break;
53290b57cec5SDimitry Andric   }
53300b57cec5SDimitry Andric   case ELF::NT_GNU_GOLD_VERSION:
5331349cc55cSDimitry Andric     OS << "    Version: " << getDescAsStringRef(Desc);
53320b57cec5SDimitry Andric     break;
53330b57cec5SDimitry Andric   case ELF::NT_GNU_PROPERTY_TYPE_0:
53340b57cec5SDimitry Andric     OS << "    Properties:";
5335e8d8bef9SDimitry Andric     for (const std::string &Property : getGNUPropertyList<ELFT>(Desc))
53360b57cec5SDimitry Andric       OS << "    " << Property << "\n";
53370b57cec5SDimitry Andric     break;
53380b57cec5SDimitry Andric   }
53390b57cec5SDimitry Andric   OS << '\n';
5340fe6060f1SDimitry Andric   return true;
5341fe6060f1SDimitry Andric }
5342fe6060f1SDimitry Andric 
534381ad6265SDimitry Andric using AndroidNoteProperties = std::vector<std::pair<StringRef, std::string>>;
getAndroidNoteProperties(uint32_t NoteType,ArrayRef<uint8_t> Desc)534481ad6265SDimitry Andric static AndroidNoteProperties getAndroidNoteProperties(uint32_t NoteType,
534581ad6265SDimitry Andric                                                       ArrayRef<uint8_t> Desc) {
534681ad6265SDimitry Andric   AndroidNoteProperties Props;
534781ad6265SDimitry Andric   switch (NoteType) {
534881ad6265SDimitry Andric   case ELF::NT_ANDROID_TYPE_MEMTAG:
534981ad6265SDimitry Andric     if (Desc.empty()) {
535081ad6265SDimitry Andric       Props.emplace_back("Invalid .note.android.memtag", "");
535181ad6265SDimitry Andric       return Props;
535281ad6265SDimitry Andric     }
535381ad6265SDimitry Andric 
535481ad6265SDimitry Andric     switch (Desc[0] & NT_MEMTAG_LEVEL_MASK) {
535581ad6265SDimitry Andric     case NT_MEMTAG_LEVEL_NONE:
535681ad6265SDimitry Andric       Props.emplace_back("Tagging Mode", "NONE");
535781ad6265SDimitry Andric       break;
535881ad6265SDimitry Andric     case NT_MEMTAG_LEVEL_ASYNC:
535981ad6265SDimitry Andric       Props.emplace_back("Tagging Mode", "ASYNC");
536081ad6265SDimitry Andric       break;
536181ad6265SDimitry Andric     case NT_MEMTAG_LEVEL_SYNC:
536281ad6265SDimitry Andric       Props.emplace_back("Tagging Mode", "SYNC");
536381ad6265SDimitry Andric       break;
536481ad6265SDimitry Andric     default:
536581ad6265SDimitry Andric       Props.emplace_back(
536681ad6265SDimitry Andric           "Tagging Mode",
536781ad6265SDimitry Andric           ("Unknown (" + Twine::utohexstr(Desc[0] & NT_MEMTAG_LEVEL_MASK) + ")")
536881ad6265SDimitry Andric               .str());
536981ad6265SDimitry Andric       break;
537081ad6265SDimitry Andric     }
537181ad6265SDimitry Andric     Props.emplace_back("Heap",
537281ad6265SDimitry Andric                        (Desc[0] & NT_MEMTAG_HEAP) ? "Enabled" : "Disabled");
537381ad6265SDimitry Andric     Props.emplace_back("Stack",
537481ad6265SDimitry Andric                        (Desc[0] & NT_MEMTAG_STACK) ? "Enabled" : "Disabled");
537581ad6265SDimitry Andric     break;
537681ad6265SDimitry Andric   default:
537781ad6265SDimitry Andric     return Props;
537881ad6265SDimitry Andric   }
537981ad6265SDimitry Andric   return Props;
538081ad6265SDimitry Andric }
538181ad6265SDimitry Andric 
printAndroidNote(raw_ostream & OS,uint32_t NoteType,ArrayRef<uint8_t> Desc)538281ad6265SDimitry Andric static bool printAndroidNote(raw_ostream &OS, uint32_t NoteType,
538381ad6265SDimitry Andric                              ArrayRef<uint8_t> Desc) {
538481ad6265SDimitry Andric   // Return true if we were able to pretty-print the note, false otherwise.
538581ad6265SDimitry Andric   AndroidNoteProperties Props = getAndroidNoteProperties(NoteType, Desc);
538681ad6265SDimitry Andric   if (Props.empty())
538781ad6265SDimitry Andric     return false;
538881ad6265SDimitry Andric   for (const auto &KV : Props)
538981ad6265SDimitry Andric     OS << "    " << KV.first << ": " << KV.second << '\n';
539081ad6265SDimitry Andric   return true;
539181ad6265SDimitry Andric }
539281ad6265SDimitry Andric 
539306c3fb27SDimitry Andric template <class ELFT>
printAArch64Note(raw_ostream & OS,uint32_t NoteType,ArrayRef<uint8_t> Desc)53945f757f3fSDimitry Andric static bool printAArch64Note(raw_ostream &OS, uint32_t NoteType,
53955f757f3fSDimitry Andric                              ArrayRef<uint8_t> Desc) {
53965f757f3fSDimitry Andric   if (NoteType != NT_ARM_TYPE_PAUTH_ABI_TAG)
53975f757f3fSDimitry Andric     return false;
53985f757f3fSDimitry Andric 
53995f757f3fSDimitry Andric   OS << "    AArch64 PAuth ABI tag: ";
54005f757f3fSDimitry Andric   if (Desc.size() < 16) {
54015f757f3fSDimitry Andric     OS << format("<corrupted size: expected at least 16, got %d>", Desc.size());
54025f757f3fSDimitry Andric     return false;
54035f757f3fSDimitry Andric   }
54045f757f3fSDimitry Andric 
54055f757f3fSDimitry Andric   uint64_t Platform =
54065f757f3fSDimitry Andric       support::endian::read64<ELFT::TargetEndianness>(Desc.data() + 0);
54075f757f3fSDimitry Andric   uint64_t Version =
54085f757f3fSDimitry Andric       support::endian::read64<ELFT::TargetEndianness>(Desc.data() + 8);
54095f757f3fSDimitry Andric   OS << format("platform 0x%" PRIx64 ", version 0x%" PRIx64, Platform, Version);
54105f757f3fSDimitry Andric 
54115f757f3fSDimitry Andric   if (Desc.size() > 16)
54125f757f3fSDimitry Andric     OS << ", additional info 0x"
54135f757f3fSDimitry Andric        << toHex(ArrayRef<uint8_t>(Desc.data() + 16, Desc.size() - 16));
54145f757f3fSDimitry Andric 
54155f757f3fSDimitry Andric   return true;
54165f757f3fSDimitry Andric }
54175f757f3fSDimitry Andric 
54185f757f3fSDimitry Andric template <class ELFT>
printMemtag(const ArrayRef<std::pair<std::string,std::string>> DynamicEntries,const ArrayRef<uint8_t> AndroidNoteDesc,const ArrayRef<std::pair<uint64_t,uint64_t>> Descriptors)541906c3fb27SDimitry Andric void GNUELFDumper<ELFT>::printMemtag(
542006c3fb27SDimitry Andric     const ArrayRef<std::pair<std::string, std::string>> DynamicEntries,
542106c3fb27SDimitry Andric     const ArrayRef<uint8_t> AndroidNoteDesc,
542206c3fb27SDimitry Andric     const ArrayRef<std::pair<uint64_t, uint64_t>> Descriptors) {
542306c3fb27SDimitry Andric   OS << "Memtag Dynamic Entries:\n";
542406c3fb27SDimitry Andric   if (DynamicEntries.empty())
542506c3fb27SDimitry Andric     OS << "    < none found >\n";
542606c3fb27SDimitry Andric   for (const auto &DynamicEntryKV : DynamicEntries)
542706c3fb27SDimitry Andric     OS << "    " << DynamicEntryKV.first << ": " << DynamicEntryKV.second
542806c3fb27SDimitry Andric        << "\n";
542906c3fb27SDimitry Andric 
543006c3fb27SDimitry Andric   if (!AndroidNoteDesc.empty()) {
543106c3fb27SDimitry Andric     OS << "Memtag Android Note:\n";
543206c3fb27SDimitry Andric     printAndroidNote(OS, ELF::NT_ANDROID_TYPE_MEMTAG, AndroidNoteDesc);
543306c3fb27SDimitry Andric   }
543406c3fb27SDimitry Andric 
543506c3fb27SDimitry Andric   if (Descriptors.empty())
543606c3fb27SDimitry Andric     return;
543706c3fb27SDimitry Andric 
543806c3fb27SDimitry Andric   OS << "Memtag Global Descriptors:\n";
543906c3fb27SDimitry Andric   for (const auto &[Addr, BytesToTag] : Descriptors) {
544006c3fb27SDimitry Andric     OS << "    0x" << utohexstr(Addr, /*LowerCase=*/true) << ": 0x"
544106c3fb27SDimitry Andric        << utohexstr(BytesToTag, /*LowerCase=*/true) << "\n";
544206c3fb27SDimitry Andric   }
544306c3fb27SDimitry Andric }
544406c3fb27SDimitry Andric 
5445349cc55cSDimitry Andric template <typename ELFT>
printLLVMOMPOFFLOADNote(raw_ostream & OS,uint32_t NoteType,ArrayRef<uint8_t> Desc)5446349cc55cSDimitry Andric static bool printLLVMOMPOFFLOADNote(raw_ostream &OS, uint32_t NoteType,
5447349cc55cSDimitry Andric                                     ArrayRef<uint8_t> Desc) {
5448349cc55cSDimitry Andric   switch (NoteType) {
5449349cc55cSDimitry Andric   default:
5450349cc55cSDimitry Andric     return false;
5451349cc55cSDimitry Andric   case ELF::NT_LLVM_OPENMP_OFFLOAD_VERSION:
5452349cc55cSDimitry Andric     OS << "    Version: " << getDescAsStringRef(Desc);
5453349cc55cSDimitry Andric     break;
5454349cc55cSDimitry Andric   case ELF::NT_LLVM_OPENMP_OFFLOAD_PRODUCER:
5455349cc55cSDimitry Andric     OS << "    Producer: " << getDescAsStringRef(Desc);
5456349cc55cSDimitry Andric     break;
5457349cc55cSDimitry Andric   case ELF::NT_LLVM_OPENMP_OFFLOAD_PRODUCER_VERSION:
5458349cc55cSDimitry Andric     OS << "    Producer version: " << getDescAsStringRef(Desc);
5459349cc55cSDimitry Andric     break;
5460349cc55cSDimitry Andric   }
5461349cc55cSDimitry Andric   OS << '\n';
5462349cc55cSDimitry Andric   return true;
5463349cc55cSDimitry Andric }
5464349cc55cSDimitry Andric 
5465349cc55cSDimitry Andric const EnumEntry<unsigned> FreeBSDFeatureCtlFlags[] = {
5466fe6060f1SDimitry Andric     {"ASLR_DISABLE", NT_FREEBSD_FCTL_ASLR_DISABLE},
5467fe6060f1SDimitry Andric     {"PROTMAX_DISABLE", NT_FREEBSD_FCTL_PROTMAX_DISABLE},
5468fe6060f1SDimitry Andric     {"STKGAP_DISABLE", NT_FREEBSD_FCTL_STKGAP_DISABLE},
5469fe6060f1SDimitry Andric     {"WXNEEDED", NT_FREEBSD_FCTL_WXNEEDED},
5470fe6060f1SDimitry Andric     {"LA48", NT_FREEBSD_FCTL_LA48},
5471fe6060f1SDimitry Andric     {"ASG_DISABLE", NT_FREEBSD_FCTL_ASG_DISABLE},
5472fe6060f1SDimitry Andric };
5473fe6060f1SDimitry Andric 
5474fe6060f1SDimitry Andric struct FreeBSDNote {
5475fe6060f1SDimitry Andric   std::string Type;
5476fe6060f1SDimitry Andric   std::string Value;
5477fe6060f1SDimitry Andric };
5478fe6060f1SDimitry Andric 
5479fe6060f1SDimitry Andric template <typename ELFT>
5480bdd1243dSDimitry Andric static std::optional<FreeBSDNote>
getFreeBSDNote(uint32_t NoteType,ArrayRef<uint8_t> Desc,bool IsCore)5481fe6060f1SDimitry Andric getFreeBSDNote(uint32_t NoteType, ArrayRef<uint8_t> Desc, bool IsCore) {
5482fe6060f1SDimitry Andric   if (IsCore)
5483bdd1243dSDimitry Andric     return std::nullopt; // No pretty-printing yet.
5484fe6060f1SDimitry Andric   switch (NoteType) {
5485fe6060f1SDimitry Andric   case ELF::NT_FREEBSD_ABI_TAG:
5486fe6060f1SDimitry Andric     if (Desc.size() != 4)
5487bdd1243dSDimitry Andric       return std::nullopt;
5488fe6060f1SDimitry Andric     return FreeBSDNote{
5489fe6060f1SDimitry Andric         "ABI tag",
5490fe6060f1SDimitry Andric         utostr(support::endian::read32<ELFT::TargetEndianness>(Desc.data()))};
5491fe6060f1SDimitry Andric   case ELF::NT_FREEBSD_ARCH_TAG:
5492fe6060f1SDimitry Andric     return FreeBSDNote{"Arch tag", toStringRef(Desc).str()};
5493fe6060f1SDimitry Andric   case ELF::NT_FREEBSD_FEATURE_CTL: {
5494fe6060f1SDimitry Andric     if (Desc.size() != 4)
5495bdd1243dSDimitry Andric       return std::nullopt;
5496fe6060f1SDimitry Andric     unsigned Value =
5497fe6060f1SDimitry Andric         support::endian::read32<ELFT::TargetEndianness>(Desc.data());
5498fe6060f1SDimitry Andric     std::string FlagsStr;
5499fe6060f1SDimitry Andric     raw_string_ostream OS(FlagsStr);
5500bdd1243dSDimitry Andric     printFlags(Value, ArrayRef(FreeBSDFeatureCtlFlags), OS);
5501fe6060f1SDimitry Andric     if (OS.str().empty())
5502fe6060f1SDimitry Andric       OS << "0x" << utohexstr(Value);
5503fe6060f1SDimitry Andric     else
5504fe6060f1SDimitry Andric       OS << "(0x" << utohexstr(Value) << ")";
5505fe6060f1SDimitry Andric     return FreeBSDNote{"Feature flags", OS.str()};
5506fe6060f1SDimitry Andric   }
5507fe6060f1SDimitry Andric   default:
5508bdd1243dSDimitry Andric     return std::nullopt;
5509fe6060f1SDimitry Andric   }
55100b57cec5SDimitry Andric }
55110b57cec5SDimitry Andric 
55120b57cec5SDimitry Andric struct AMDNote {
55130b57cec5SDimitry Andric   std::string Type;
55140b57cec5SDimitry Andric   std::string Value;
55150b57cec5SDimitry Andric };
55160b57cec5SDimitry Andric 
55170b57cec5SDimitry Andric template <typename ELFT>
getAMDNote(uint32_t NoteType,ArrayRef<uint8_t> Desc)55180b57cec5SDimitry Andric static AMDNote getAMDNote(uint32_t NoteType, ArrayRef<uint8_t> Desc) {
55190b57cec5SDimitry Andric   switch (NoteType) {
55200b57cec5SDimitry Andric   default:
55210b57cec5SDimitry Andric     return {"", ""};
5522fe6060f1SDimitry Andric   case ELF::NT_AMD_HSA_CODE_OBJECT_VERSION: {
5523fe6060f1SDimitry Andric     struct CodeObjectVersion {
55245f757f3fSDimitry Andric       support::aligned_ulittle32_t MajorVersion;
55255f757f3fSDimitry Andric       support::aligned_ulittle32_t MinorVersion;
5526fe6060f1SDimitry Andric     };
5527fe6060f1SDimitry Andric     if (Desc.size() != sizeof(CodeObjectVersion))
5528fe6060f1SDimitry Andric       return {"AMD HSA Code Object Version",
5529fe6060f1SDimitry Andric               "Invalid AMD HSA Code Object Version"};
5530fe6060f1SDimitry Andric     std::string VersionString;
5531fe6060f1SDimitry Andric     raw_string_ostream StrOS(VersionString);
5532fe6060f1SDimitry Andric     auto Version = reinterpret_cast<const CodeObjectVersion *>(Desc.data());
5533fe6060f1SDimitry Andric     StrOS << "[Major: " << Version->MajorVersion
5534fe6060f1SDimitry Andric           << ", Minor: " << Version->MinorVersion << "]";
5535fe6060f1SDimitry Andric     return {"AMD HSA Code Object Version", VersionString};
5536fe6060f1SDimitry Andric   }
5537fe6060f1SDimitry Andric   case ELF::NT_AMD_HSA_HSAIL: {
5538fe6060f1SDimitry Andric     struct HSAILProperties {
55395f757f3fSDimitry Andric       support::aligned_ulittle32_t HSAILMajorVersion;
55405f757f3fSDimitry Andric       support::aligned_ulittle32_t HSAILMinorVersion;
5541fe6060f1SDimitry Andric       uint8_t Profile;
5542fe6060f1SDimitry Andric       uint8_t MachineModel;
5543fe6060f1SDimitry Andric       uint8_t DefaultFloatRound;
5544fe6060f1SDimitry Andric     };
5545fe6060f1SDimitry Andric     if (Desc.size() != sizeof(HSAILProperties))
5546fe6060f1SDimitry Andric       return {"AMD HSA HSAIL Properties", "Invalid AMD HSA HSAIL Properties"};
5547fe6060f1SDimitry Andric     auto Properties = reinterpret_cast<const HSAILProperties *>(Desc.data());
5548fe6060f1SDimitry Andric     std::string HSAILPropetiesString;
5549fe6060f1SDimitry Andric     raw_string_ostream StrOS(HSAILPropetiesString);
5550fe6060f1SDimitry Andric     StrOS << "[HSAIL Major: " << Properties->HSAILMajorVersion
5551fe6060f1SDimitry Andric           << ", HSAIL Minor: " << Properties->HSAILMinorVersion
5552fe6060f1SDimitry Andric           << ", Profile: " << uint32_t(Properties->Profile)
5553fe6060f1SDimitry Andric           << ", Machine Model: " << uint32_t(Properties->MachineModel)
5554fe6060f1SDimitry Andric           << ", Default Float Round: "
5555fe6060f1SDimitry Andric           << uint32_t(Properties->DefaultFloatRound) << "]";
5556fe6060f1SDimitry Andric     return {"AMD HSA HSAIL Properties", HSAILPropetiesString};
5557fe6060f1SDimitry Andric   }
5558fe6060f1SDimitry Andric   case ELF::NT_AMD_HSA_ISA_VERSION: {
5559fe6060f1SDimitry Andric     struct IsaVersion {
55605f757f3fSDimitry Andric       support::aligned_ulittle16_t VendorNameSize;
55615f757f3fSDimitry Andric       support::aligned_ulittle16_t ArchitectureNameSize;
55625f757f3fSDimitry Andric       support::aligned_ulittle32_t Major;
55635f757f3fSDimitry Andric       support::aligned_ulittle32_t Minor;
55645f757f3fSDimitry Andric       support::aligned_ulittle32_t Stepping;
5565fe6060f1SDimitry Andric     };
5566fe6060f1SDimitry Andric     if (Desc.size() < sizeof(IsaVersion))
5567fe6060f1SDimitry Andric       return {"AMD HSA ISA Version", "Invalid AMD HSA ISA Version"};
5568fe6060f1SDimitry Andric     auto Isa = reinterpret_cast<const IsaVersion *>(Desc.data());
5569fe6060f1SDimitry Andric     if (Desc.size() < sizeof(IsaVersion) +
5570fe6060f1SDimitry Andric                           Isa->VendorNameSize + Isa->ArchitectureNameSize ||
5571fe6060f1SDimitry Andric         Isa->VendorNameSize == 0 || Isa->ArchitectureNameSize == 0)
5572fe6060f1SDimitry Andric       return {"AMD HSA ISA Version", "Invalid AMD HSA ISA Version"};
5573fe6060f1SDimitry Andric     std::string IsaString;
5574fe6060f1SDimitry Andric     raw_string_ostream StrOS(IsaString);
5575fe6060f1SDimitry Andric     StrOS << "[Vendor: "
5576fe6060f1SDimitry Andric           << StringRef((const char*)Desc.data() + sizeof(IsaVersion), Isa->VendorNameSize - 1)
5577fe6060f1SDimitry Andric           << ", Architecture: "
5578fe6060f1SDimitry Andric           << StringRef((const char*)Desc.data() + sizeof(IsaVersion) + Isa->VendorNameSize,
5579fe6060f1SDimitry Andric                        Isa->ArchitectureNameSize - 1)
5580fe6060f1SDimitry Andric           << ", Major: " << Isa->Major << ", Minor: " << Isa->Minor
5581fe6060f1SDimitry Andric           << ", Stepping: " << Isa->Stepping << "]";
5582fe6060f1SDimitry Andric     return {"AMD HSA ISA Version", IsaString};
5583fe6060f1SDimitry Andric   }
5584fe6060f1SDimitry Andric   case ELF::NT_AMD_HSA_METADATA: {
5585fe6060f1SDimitry Andric     if (Desc.size() == 0)
5586fe6060f1SDimitry Andric       return {"AMD HSA Metadata", ""};
55870b57cec5SDimitry Andric     return {
5588fe6060f1SDimitry Andric         "AMD HSA Metadata",
5589fe6060f1SDimitry Andric         std::string(reinterpret_cast<const char *>(Desc.data()), Desc.size() - 1)};
5590fe6060f1SDimitry Andric   }
5591fe6060f1SDimitry Andric   case ELF::NT_AMD_HSA_ISA_NAME: {
5592fe6060f1SDimitry Andric     if (Desc.size() == 0)
5593fe6060f1SDimitry Andric       return {"AMD HSA ISA Name", ""};
55940b57cec5SDimitry Andric     return {
5595fe6060f1SDimitry Andric         "AMD HSA ISA Name",
55960b57cec5SDimitry Andric         std::string(reinterpret_cast<const char *>(Desc.data()), Desc.size())};
55970b57cec5SDimitry Andric   }
5598fe6060f1SDimitry Andric   case ELF::NT_AMD_PAL_METADATA: {
5599fe6060f1SDimitry Andric     struct PALMetadata {
56005f757f3fSDimitry Andric       support::aligned_ulittle32_t Key;
56015f757f3fSDimitry Andric       support::aligned_ulittle32_t Value;
5602fe6060f1SDimitry Andric     };
5603fe6060f1SDimitry Andric     if (Desc.size() % sizeof(PALMetadata) != 0)
5604fe6060f1SDimitry Andric       return {"AMD PAL Metadata", "Invalid AMD PAL Metadata"};
5605fe6060f1SDimitry Andric     auto Isa = reinterpret_cast<const PALMetadata *>(Desc.data());
5606fe6060f1SDimitry Andric     std::string MetadataString;
5607fe6060f1SDimitry Andric     raw_string_ostream StrOS(MetadataString);
5608fe6060f1SDimitry Andric     for (size_t I = 0, E = Desc.size() / sizeof(PALMetadata); I < E; ++I) {
5609fe6060f1SDimitry Andric       StrOS << "[" << Isa[I].Key << ": " << Isa[I].Value << "]";
5610fe6060f1SDimitry Andric     }
5611fe6060f1SDimitry Andric     return {"AMD PAL Metadata", MetadataString};
5612fe6060f1SDimitry Andric   }
5613fe6060f1SDimitry Andric   }
56140b57cec5SDimitry Andric }
56150b57cec5SDimitry Andric 
56160b57cec5SDimitry Andric struct AMDGPUNote {
56170b57cec5SDimitry Andric   std::string Type;
56180b57cec5SDimitry Andric   std::string Value;
56190b57cec5SDimitry Andric };
56200b57cec5SDimitry Andric 
56210b57cec5SDimitry Andric template <typename ELFT>
getAMDGPUNote(uint32_t NoteType,ArrayRef<uint8_t> Desc)56220b57cec5SDimitry Andric static AMDGPUNote getAMDGPUNote(uint32_t NoteType, ArrayRef<uint8_t> Desc) {
56230b57cec5SDimitry Andric   switch (NoteType) {
56240b57cec5SDimitry Andric   default:
56250b57cec5SDimitry Andric     return {"", ""};
56260b57cec5SDimitry Andric   case ELF::NT_AMDGPU_METADATA: {
5627e8d8bef9SDimitry Andric     StringRef MsgPackString =
56280b57cec5SDimitry Andric         StringRef(reinterpret_cast<const char *>(Desc.data()), Desc.size());
56290b57cec5SDimitry Andric     msgpack::Document MsgPackDoc;
56300b57cec5SDimitry Andric     if (!MsgPackDoc.readFromBlob(MsgPackString, /*Multi=*/false))
5631fe6060f1SDimitry Andric       return {"", ""};
56320b57cec5SDimitry Andric 
5633fe6060f1SDimitry Andric     std::string MetadataString;
563406c3fb27SDimitry Andric 
563506c3fb27SDimitry Andric     // FIXME: Metadata Verifier only works with AMDHSA.
563606c3fb27SDimitry Andric     //  This is an ugly workaround to avoid the verifier for other MD
563706c3fb27SDimitry Andric     //  formats (e.g. amdpal)
56385f757f3fSDimitry Andric     if (MsgPackString.contains("amdhsa.")) {
563906c3fb27SDimitry Andric       AMDGPU::HSAMD::V3::MetadataVerifier Verifier(true);
5640e8d8bef9SDimitry Andric       if (!Verifier.verify(MsgPackDoc.getRoot()))
5641fe6060f1SDimitry Andric         MetadataString = "Invalid AMDGPU Metadata\n";
564206c3fb27SDimitry Andric     }
5643e8d8bef9SDimitry Andric 
5644fe6060f1SDimitry Andric     raw_string_ostream StrOS(MetadataString);
5645fe6060f1SDimitry Andric     if (MsgPackDoc.getRoot().isScalar()) {
5646fe6060f1SDimitry Andric       // TODO: passing a scalar root to toYAML() asserts:
5647fe6060f1SDimitry Andric       // (PolymorphicTraits<T>::getKind(Val) != NodeKind::Scalar &&
5648fe6060f1SDimitry Andric       //    "plain scalar documents are not supported")
5649fe6060f1SDimitry Andric       // To avoid this crash we print the raw data instead.
5650fe6060f1SDimitry Andric       return {"", ""};
5651fe6060f1SDimitry Andric     }
56520b57cec5SDimitry Andric     MsgPackDoc.toYAML(StrOS);
56530b57cec5SDimitry Andric     return {"AMDGPU Metadata", StrOS.str()};
56540b57cec5SDimitry Andric   }
56550b57cec5SDimitry Andric   }
56560b57cec5SDimitry Andric }
56570b57cec5SDimitry Andric 
56588bcb0991SDimitry Andric struct CoreFileMapping {
56598bcb0991SDimitry Andric   uint64_t Start, End, Offset;
56608bcb0991SDimitry Andric   StringRef Filename;
56618bcb0991SDimitry Andric };
56628bcb0991SDimitry Andric 
56638bcb0991SDimitry Andric struct CoreNote {
56648bcb0991SDimitry Andric   uint64_t PageSize;
56658bcb0991SDimitry Andric   std::vector<CoreFileMapping> Mappings;
56668bcb0991SDimitry Andric };
56678bcb0991SDimitry Andric 
readCoreNote(DataExtractor Desc)56688bcb0991SDimitry Andric static Expected<CoreNote> readCoreNote(DataExtractor Desc) {
56698bcb0991SDimitry Andric   // Expected format of the NT_FILE note description:
56708bcb0991SDimitry Andric   // 1. # of file mappings (call it N)
56718bcb0991SDimitry Andric   // 2. Page size
56728bcb0991SDimitry Andric   // 3. N (start, end, offset) triples
56738bcb0991SDimitry Andric   // 4. N packed filenames (null delimited)
56748bcb0991SDimitry Andric   // Each field is an Elf_Addr, except for filenames which are char* strings.
56758bcb0991SDimitry Andric 
56768bcb0991SDimitry Andric   CoreNote Ret;
56778bcb0991SDimitry Andric   const int Bytes = Desc.getAddressSize();
56788bcb0991SDimitry Andric 
56798bcb0991SDimitry Andric   if (!Desc.isValidOffsetForAddress(2))
5680e8d8bef9SDimitry Andric     return createError("the note of size 0x" + Twine::utohexstr(Desc.size()) +
5681e8d8bef9SDimitry Andric                        " is too short, expected at least 0x" +
5682e8d8bef9SDimitry Andric                        Twine::utohexstr(Bytes * 2));
56838bcb0991SDimitry Andric   if (Desc.getData().back() != 0)
5684e8d8bef9SDimitry Andric     return createError("the note is not NUL terminated");
56858bcb0991SDimitry Andric 
56868bcb0991SDimitry Andric   uint64_t DescOffset = 0;
56878bcb0991SDimitry Andric   uint64_t FileCount = Desc.getAddress(&DescOffset);
56888bcb0991SDimitry Andric   Ret.PageSize = Desc.getAddress(&DescOffset);
56898bcb0991SDimitry Andric 
56908bcb0991SDimitry Andric   if (!Desc.isValidOffsetForAddress(3 * FileCount * Bytes))
5691e8d8bef9SDimitry Andric     return createError("unable to read file mappings (found " +
5692e8d8bef9SDimitry Andric                        Twine(FileCount) + "): the note of size 0x" +
5693e8d8bef9SDimitry Andric                        Twine::utohexstr(Desc.size()) + " is too short");
56948bcb0991SDimitry Andric 
56958bcb0991SDimitry Andric   uint64_t FilenamesOffset = 0;
56968bcb0991SDimitry Andric   DataExtractor Filenames(
56978bcb0991SDimitry Andric       Desc.getData().drop_front(DescOffset + 3 * FileCount * Bytes),
56988bcb0991SDimitry Andric       Desc.isLittleEndian(), Desc.getAddressSize());
56998bcb0991SDimitry Andric 
57008bcb0991SDimitry Andric   Ret.Mappings.resize(FileCount);
5701e8d8bef9SDimitry Andric   size_t I = 0;
57028bcb0991SDimitry Andric   for (CoreFileMapping &Mapping : Ret.Mappings) {
5703e8d8bef9SDimitry Andric     ++I;
57048bcb0991SDimitry Andric     if (!Filenames.isValidOffsetForDataOfSize(FilenamesOffset, 1))
5705e8d8bef9SDimitry Andric       return createError(
5706e8d8bef9SDimitry Andric           "unable to read the file name for the mapping with index " +
5707e8d8bef9SDimitry Andric           Twine(I) + ": the note of size 0x" + Twine::utohexstr(Desc.size()) +
5708e8d8bef9SDimitry Andric           " is truncated");
57098bcb0991SDimitry Andric     Mapping.Start = Desc.getAddress(&DescOffset);
57108bcb0991SDimitry Andric     Mapping.End = Desc.getAddress(&DescOffset);
57118bcb0991SDimitry Andric     Mapping.Offset = Desc.getAddress(&DescOffset);
57128bcb0991SDimitry Andric     Mapping.Filename = Filenames.getCStrRef(&FilenamesOffset);
57138bcb0991SDimitry Andric   }
57148bcb0991SDimitry Andric 
57158bcb0991SDimitry Andric   return Ret;
57168bcb0991SDimitry Andric }
57178bcb0991SDimitry Andric 
57188bcb0991SDimitry Andric template <typename ELFT>
printCoreNote(raw_ostream & OS,const CoreNote & Note)57198bcb0991SDimitry Andric static void printCoreNote(raw_ostream &OS, const CoreNote &Note) {
57208bcb0991SDimitry Andric   // Length of "0x<address>" string.
57218bcb0991SDimitry Andric   const int FieldWidth = ELFT::Is64Bits ? 18 : 10;
57228bcb0991SDimitry Andric 
57238bcb0991SDimitry Andric   OS << "    Page size: " << format_decimal(Note.PageSize, 0) << '\n';
57248bcb0991SDimitry Andric   OS << "    " << right_justify("Start", FieldWidth) << "  "
57258bcb0991SDimitry Andric      << right_justify("End", FieldWidth) << "  "
57268bcb0991SDimitry Andric      << right_justify("Page Offset", FieldWidth) << '\n';
57278bcb0991SDimitry Andric   for (const CoreFileMapping &Mapping : Note.Mappings) {
57288bcb0991SDimitry Andric     OS << "    " << format_hex(Mapping.Start, FieldWidth) << "  "
57298bcb0991SDimitry Andric        << format_hex(Mapping.End, FieldWidth) << "  "
57308bcb0991SDimitry Andric        << format_hex(Mapping.Offset, FieldWidth) << "\n        "
57318bcb0991SDimitry Andric        << Mapping.Filename << '\n';
57328bcb0991SDimitry Andric   }
57338bcb0991SDimitry Andric }
57348bcb0991SDimitry Andric 
5735349cc55cSDimitry Andric const NoteType GenericNoteTypes[] = {
5736e8d8bef9SDimitry Andric     {ELF::NT_VERSION, "NT_VERSION (version)"},
5737e8d8bef9SDimitry Andric     {ELF::NT_ARCH, "NT_ARCH (architecture)"},
5738e8d8bef9SDimitry Andric     {ELF::NT_GNU_BUILD_ATTRIBUTE_OPEN, "OPEN"},
5739e8d8bef9SDimitry Andric     {ELF::NT_GNU_BUILD_ATTRIBUTE_FUNC, "func"},
5740e8d8bef9SDimitry Andric };
5741e8d8bef9SDimitry Andric 
5742349cc55cSDimitry Andric const NoteType GNUNoteTypes[] = {
5743e8d8bef9SDimitry Andric     {ELF::NT_GNU_ABI_TAG, "NT_GNU_ABI_TAG (ABI version tag)"},
5744e8d8bef9SDimitry Andric     {ELF::NT_GNU_HWCAP, "NT_GNU_HWCAP (DSO-supplied software HWCAP info)"},
5745e8d8bef9SDimitry Andric     {ELF::NT_GNU_BUILD_ID, "NT_GNU_BUILD_ID (unique build ID bitstring)"},
5746e8d8bef9SDimitry Andric     {ELF::NT_GNU_GOLD_VERSION, "NT_GNU_GOLD_VERSION (gold version)"},
5747e8d8bef9SDimitry Andric     {ELF::NT_GNU_PROPERTY_TYPE_0, "NT_GNU_PROPERTY_TYPE_0 (property note)"},
5748e8d8bef9SDimitry Andric };
5749e8d8bef9SDimitry Andric 
5750349cc55cSDimitry Andric const NoteType FreeBSDCoreNoteTypes[] = {
5751e8d8bef9SDimitry Andric     {ELF::NT_FREEBSD_THRMISC, "NT_THRMISC (thrmisc structure)"},
5752e8d8bef9SDimitry Andric     {ELF::NT_FREEBSD_PROCSTAT_PROC, "NT_PROCSTAT_PROC (proc data)"},
5753e8d8bef9SDimitry Andric     {ELF::NT_FREEBSD_PROCSTAT_FILES, "NT_PROCSTAT_FILES (files data)"},
5754e8d8bef9SDimitry Andric     {ELF::NT_FREEBSD_PROCSTAT_VMMAP, "NT_PROCSTAT_VMMAP (vmmap data)"},
5755e8d8bef9SDimitry Andric     {ELF::NT_FREEBSD_PROCSTAT_GROUPS, "NT_PROCSTAT_GROUPS (groups data)"},
5756e8d8bef9SDimitry Andric     {ELF::NT_FREEBSD_PROCSTAT_UMASK, "NT_PROCSTAT_UMASK (umask data)"},
5757e8d8bef9SDimitry Andric     {ELF::NT_FREEBSD_PROCSTAT_RLIMIT, "NT_PROCSTAT_RLIMIT (rlimit data)"},
5758e8d8bef9SDimitry Andric     {ELF::NT_FREEBSD_PROCSTAT_OSREL, "NT_PROCSTAT_OSREL (osreldate data)"},
5759e8d8bef9SDimitry Andric     {ELF::NT_FREEBSD_PROCSTAT_PSSTRINGS,
5760e8d8bef9SDimitry Andric      "NT_PROCSTAT_PSSTRINGS (ps_strings data)"},
5761e8d8bef9SDimitry Andric     {ELF::NT_FREEBSD_PROCSTAT_AUXV, "NT_PROCSTAT_AUXV (auxv data)"},
5762e8d8bef9SDimitry Andric };
5763e8d8bef9SDimitry Andric 
5764349cc55cSDimitry Andric const NoteType FreeBSDNoteTypes[] = {
5765fe6060f1SDimitry Andric     {ELF::NT_FREEBSD_ABI_TAG, "NT_FREEBSD_ABI_TAG (ABI version tag)"},
5766fe6060f1SDimitry Andric     {ELF::NT_FREEBSD_NOINIT_TAG, "NT_FREEBSD_NOINIT_TAG (no .init tag)"},
5767fe6060f1SDimitry Andric     {ELF::NT_FREEBSD_ARCH_TAG, "NT_FREEBSD_ARCH_TAG (architecture tag)"},
5768fe6060f1SDimitry Andric     {ELF::NT_FREEBSD_FEATURE_CTL,
5769fe6060f1SDimitry Andric      "NT_FREEBSD_FEATURE_CTL (FreeBSD feature control)"},
5770fe6060f1SDimitry Andric };
5771fe6060f1SDimitry Andric 
57724824e7fdSDimitry Andric const NoteType NetBSDCoreNoteTypes[] = {
57734824e7fdSDimitry Andric     {ELF::NT_NETBSDCORE_PROCINFO,
57744824e7fdSDimitry Andric      "NT_NETBSDCORE_PROCINFO (procinfo structure)"},
57754824e7fdSDimitry Andric     {ELF::NT_NETBSDCORE_AUXV, "NT_NETBSDCORE_AUXV (ELF auxiliary vector data)"},
57764824e7fdSDimitry Andric     {ELF::NT_NETBSDCORE_LWPSTATUS, "PT_LWPSTATUS (ptrace_lwpstatus structure)"},
57774824e7fdSDimitry Andric };
57784824e7fdSDimitry Andric 
5779349cc55cSDimitry Andric const NoteType OpenBSDCoreNoteTypes[] = {
5780349cc55cSDimitry Andric     {ELF::NT_OPENBSD_PROCINFO, "NT_OPENBSD_PROCINFO (procinfo structure)"},
5781349cc55cSDimitry Andric     {ELF::NT_OPENBSD_AUXV, "NT_OPENBSD_AUXV (ELF auxiliary vector data)"},
5782349cc55cSDimitry Andric     {ELF::NT_OPENBSD_REGS, "NT_OPENBSD_REGS (regular registers)"},
5783349cc55cSDimitry Andric     {ELF::NT_OPENBSD_FPREGS, "NT_OPENBSD_FPREGS (floating point registers)"},
5784349cc55cSDimitry Andric     {ELF::NT_OPENBSD_WCOOKIE, "NT_OPENBSD_WCOOKIE (window cookie)"},
5785349cc55cSDimitry Andric };
5786349cc55cSDimitry Andric 
5787349cc55cSDimitry Andric const NoteType AMDNoteTypes[] = {
5788fe6060f1SDimitry Andric     {ELF::NT_AMD_HSA_CODE_OBJECT_VERSION,
5789fe6060f1SDimitry Andric      "NT_AMD_HSA_CODE_OBJECT_VERSION (AMD HSA Code Object Version)"},
5790fe6060f1SDimitry Andric     {ELF::NT_AMD_HSA_HSAIL, "NT_AMD_HSA_HSAIL (AMD HSA HSAIL Properties)"},
5791fe6060f1SDimitry Andric     {ELF::NT_AMD_HSA_ISA_VERSION, "NT_AMD_HSA_ISA_VERSION (AMD HSA ISA Version)"},
5792fe6060f1SDimitry Andric     {ELF::NT_AMD_HSA_METADATA, "NT_AMD_HSA_METADATA (AMD HSA Metadata)"},
5793fe6060f1SDimitry Andric     {ELF::NT_AMD_HSA_ISA_NAME, "NT_AMD_HSA_ISA_NAME (AMD HSA ISA Name)"},
5794fe6060f1SDimitry Andric     {ELF::NT_AMD_PAL_METADATA, "NT_AMD_PAL_METADATA (AMD PAL Metadata)"},
5795e8d8bef9SDimitry Andric };
5796e8d8bef9SDimitry Andric 
5797349cc55cSDimitry Andric const NoteType AMDGPUNoteTypes[] = {
5798e8d8bef9SDimitry Andric     {ELF::NT_AMDGPU_METADATA, "NT_AMDGPU_METADATA (AMDGPU Metadata)"},
5799e8d8bef9SDimitry Andric };
5800e8d8bef9SDimitry Andric 
5801349cc55cSDimitry Andric const NoteType LLVMOMPOFFLOADNoteTypes[] = {
5802349cc55cSDimitry Andric     {ELF::NT_LLVM_OPENMP_OFFLOAD_VERSION,
5803349cc55cSDimitry Andric      "NT_LLVM_OPENMP_OFFLOAD_VERSION (image format version)"},
5804349cc55cSDimitry Andric     {ELF::NT_LLVM_OPENMP_OFFLOAD_PRODUCER,
5805349cc55cSDimitry Andric      "NT_LLVM_OPENMP_OFFLOAD_PRODUCER (producing toolchain)"},
5806349cc55cSDimitry Andric     {ELF::NT_LLVM_OPENMP_OFFLOAD_PRODUCER_VERSION,
5807349cc55cSDimitry Andric      "NT_LLVM_OPENMP_OFFLOAD_PRODUCER_VERSION (producing toolchain version)"},
5808349cc55cSDimitry Andric };
5809349cc55cSDimitry Andric 
581081ad6265SDimitry Andric const NoteType AndroidNoteTypes[] = {
581181ad6265SDimitry Andric     {ELF::NT_ANDROID_TYPE_IDENT, "NT_ANDROID_TYPE_IDENT"},
581281ad6265SDimitry Andric     {ELF::NT_ANDROID_TYPE_KUSER, "NT_ANDROID_TYPE_KUSER"},
581381ad6265SDimitry Andric     {ELF::NT_ANDROID_TYPE_MEMTAG,
581481ad6265SDimitry Andric      "NT_ANDROID_TYPE_MEMTAG (Android memory tagging information)"},
581581ad6265SDimitry Andric };
581681ad6265SDimitry Andric 
58175f757f3fSDimitry Andric const NoteType ARMNoteTypes[] = {
58185f757f3fSDimitry Andric     {ELF::NT_ARM_TYPE_PAUTH_ABI_TAG, "NT_ARM_TYPE_PAUTH_ABI_TAG"},
58195f757f3fSDimitry Andric };
58205f757f3fSDimitry Andric 
5821349cc55cSDimitry Andric const NoteType CoreNoteTypes[] = {
5822e8d8bef9SDimitry Andric     {ELF::NT_PRSTATUS, "NT_PRSTATUS (prstatus structure)"},
5823e8d8bef9SDimitry Andric     {ELF::NT_FPREGSET, "NT_FPREGSET (floating point registers)"},
5824e8d8bef9SDimitry Andric     {ELF::NT_PRPSINFO, "NT_PRPSINFO (prpsinfo structure)"},
5825e8d8bef9SDimitry Andric     {ELF::NT_TASKSTRUCT, "NT_TASKSTRUCT (task structure)"},
5826e8d8bef9SDimitry Andric     {ELF::NT_AUXV, "NT_AUXV (auxiliary vector)"},
5827e8d8bef9SDimitry Andric     {ELF::NT_PSTATUS, "NT_PSTATUS (pstatus structure)"},
5828e8d8bef9SDimitry Andric     {ELF::NT_FPREGS, "NT_FPREGS (floating point registers)"},
5829e8d8bef9SDimitry Andric     {ELF::NT_PSINFO, "NT_PSINFO (psinfo structure)"},
5830e8d8bef9SDimitry Andric     {ELF::NT_LWPSTATUS, "NT_LWPSTATUS (lwpstatus_t structure)"},
5831e8d8bef9SDimitry Andric     {ELF::NT_LWPSINFO, "NT_LWPSINFO (lwpsinfo_t structure)"},
5832e8d8bef9SDimitry Andric     {ELF::NT_WIN32PSTATUS, "NT_WIN32PSTATUS (win32_pstatus structure)"},
5833e8d8bef9SDimitry Andric 
5834e8d8bef9SDimitry Andric     {ELF::NT_PPC_VMX, "NT_PPC_VMX (ppc Altivec registers)"},
5835e8d8bef9SDimitry Andric     {ELF::NT_PPC_VSX, "NT_PPC_VSX (ppc VSX registers)"},
5836e8d8bef9SDimitry Andric     {ELF::NT_PPC_TAR, "NT_PPC_TAR (ppc TAR register)"},
5837e8d8bef9SDimitry Andric     {ELF::NT_PPC_PPR, "NT_PPC_PPR (ppc PPR register)"},
5838e8d8bef9SDimitry Andric     {ELF::NT_PPC_DSCR, "NT_PPC_DSCR (ppc DSCR register)"},
5839e8d8bef9SDimitry Andric     {ELF::NT_PPC_EBB, "NT_PPC_EBB (ppc EBB registers)"},
5840e8d8bef9SDimitry Andric     {ELF::NT_PPC_PMU, "NT_PPC_PMU (ppc PMU registers)"},
5841e8d8bef9SDimitry Andric     {ELF::NT_PPC_TM_CGPR, "NT_PPC_TM_CGPR (ppc checkpointed GPR registers)"},
5842e8d8bef9SDimitry Andric     {ELF::NT_PPC_TM_CFPR,
5843e8d8bef9SDimitry Andric      "NT_PPC_TM_CFPR (ppc checkpointed floating point registers)"},
5844e8d8bef9SDimitry Andric     {ELF::NT_PPC_TM_CVMX,
5845e8d8bef9SDimitry Andric      "NT_PPC_TM_CVMX (ppc checkpointed Altivec registers)"},
5846e8d8bef9SDimitry Andric     {ELF::NT_PPC_TM_CVSX, "NT_PPC_TM_CVSX (ppc checkpointed VSX registers)"},
5847e8d8bef9SDimitry Andric     {ELF::NT_PPC_TM_SPR, "NT_PPC_TM_SPR (ppc TM special purpose registers)"},
5848e8d8bef9SDimitry Andric     {ELF::NT_PPC_TM_CTAR, "NT_PPC_TM_CTAR (ppc checkpointed TAR register)"},
5849e8d8bef9SDimitry Andric     {ELF::NT_PPC_TM_CPPR, "NT_PPC_TM_CPPR (ppc checkpointed PPR register)"},
5850e8d8bef9SDimitry Andric     {ELF::NT_PPC_TM_CDSCR, "NT_PPC_TM_CDSCR (ppc checkpointed DSCR register)"},
5851e8d8bef9SDimitry Andric 
5852e8d8bef9SDimitry Andric     {ELF::NT_386_TLS, "NT_386_TLS (x86 TLS information)"},
5853e8d8bef9SDimitry Andric     {ELF::NT_386_IOPERM, "NT_386_IOPERM (x86 I/O permissions)"},
5854e8d8bef9SDimitry Andric     {ELF::NT_X86_XSTATE, "NT_X86_XSTATE (x86 XSAVE extended state)"},
5855e8d8bef9SDimitry Andric 
5856e8d8bef9SDimitry Andric     {ELF::NT_S390_HIGH_GPRS, "NT_S390_HIGH_GPRS (s390 upper register halves)"},
5857e8d8bef9SDimitry Andric     {ELF::NT_S390_TIMER, "NT_S390_TIMER (s390 timer register)"},
5858e8d8bef9SDimitry Andric     {ELF::NT_S390_TODCMP, "NT_S390_TODCMP (s390 TOD comparator register)"},
5859e8d8bef9SDimitry Andric     {ELF::NT_S390_TODPREG, "NT_S390_TODPREG (s390 TOD programmable register)"},
5860e8d8bef9SDimitry Andric     {ELF::NT_S390_CTRS, "NT_S390_CTRS (s390 control registers)"},
5861e8d8bef9SDimitry Andric     {ELF::NT_S390_PREFIX, "NT_S390_PREFIX (s390 prefix register)"},
5862e8d8bef9SDimitry Andric     {ELF::NT_S390_LAST_BREAK,
5863e8d8bef9SDimitry Andric      "NT_S390_LAST_BREAK (s390 last breaking event address)"},
5864e8d8bef9SDimitry Andric     {ELF::NT_S390_SYSTEM_CALL,
5865e8d8bef9SDimitry Andric      "NT_S390_SYSTEM_CALL (s390 system call restart data)"},
5866e8d8bef9SDimitry Andric     {ELF::NT_S390_TDB, "NT_S390_TDB (s390 transaction diagnostic block)"},
5867e8d8bef9SDimitry Andric     {ELF::NT_S390_VXRS_LOW,
5868e8d8bef9SDimitry Andric      "NT_S390_VXRS_LOW (s390 vector registers 0-15 upper half)"},
5869e8d8bef9SDimitry Andric     {ELF::NT_S390_VXRS_HIGH, "NT_S390_VXRS_HIGH (s390 vector registers 16-31)"},
5870e8d8bef9SDimitry Andric     {ELF::NT_S390_GS_CB, "NT_S390_GS_CB (s390 guarded-storage registers)"},
5871e8d8bef9SDimitry Andric     {ELF::NT_S390_GS_BC,
5872e8d8bef9SDimitry Andric      "NT_S390_GS_BC (s390 guarded-storage broadcast control)"},
5873e8d8bef9SDimitry Andric 
5874e8d8bef9SDimitry Andric     {ELF::NT_ARM_VFP, "NT_ARM_VFP (arm VFP registers)"},
5875e8d8bef9SDimitry Andric     {ELF::NT_ARM_TLS, "NT_ARM_TLS (AArch TLS registers)"},
5876e8d8bef9SDimitry Andric     {ELF::NT_ARM_HW_BREAK,
5877e8d8bef9SDimitry Andric      "NT_ARM_HW_BREAK (AArch hardware breakpoint registers)"},
5878e8d8bef9SDimitry Andric     {ELF::NT_ARM_HW_WATCH,
5879e8d8bef9SDimitry Andric      "NT_ARM_HW_WATCH (AArch hardware watchpoint registers)"},
588006c3fb27SDimitry Andric     {ELF::NT_ARM_SVE, "NT_ARM_SVE (AArch64 SVE registers)"},
588106c3fb27SDimitry Andric     {ELF::NT_ARM_PAC_MASK,
588206c3fb27SDimitry Andric      "NT_ARM_PAC_MASK (AArch64 Pointer Authentication code masks)"},
58835f757f3fSDimitry Andric     {ELF::NT_ARM_TAGGED_ADDR_CTRL,
58845f757f3fSDimitry Andric      "NT_ARM_TAGGED_ADDR_CTRL (AArch64 Tagged Address Control)"},
588506c3fb27SDimitry Andric     {ELF::NT_ARM_SSVE, "NT_ARM_SSVE (AArch64 Streaming SVE registers)"},
588606c3fb27SDimitry Andric     {ELF::NT_ARM_ZA, "NT_ARM_ZA (AArch64 SME ZA registers)"},
588706c3fb27SDimitry Andric     {ELF::NT_ARM_ZT, "NT_ARM_ZT (AArch64 SME ZT registers)"},
5888e8d8bef9SDimitry Andric 
5889e8d8bef9SDimitry Andric     {ELF::NT_FILE, "NT_FILE (mapped files)"},
5890e8d8bef9SDimitry Andric     {ELF::NT_PRXFPREG, "NT_PRXFPREG (user_xfpregs structure)"},
5891e8d8bef9SDimitry Andric     {ELF::NT_SIGINFO, "NT_SIGINFO (siginfo_t data)"},
5892e8d8bef9SDimitry Andric };
5893e8d8bef9SDimitry Andric 
58940b57cec5SDimitry Andric template <class ELFT>
getNoteTypeName(const typename ELFT::Note & Note,unsigned ELFType)5895fe6060f1SDimitry Andric StringRef getNoteTypeName(const typename ELFT::Note &Note, unsigned ELFType) {
5896e8d8bef9SDimitry Andric   uint32_t Type = Note.getType();
5897e8d8bef9SDimitry Andric   auto FindNote = [&](ArrayRef<NoteType> V) -> StringRef {
5898e8d8bef9SDimitry Andric     for (const NoteType &N : V)
5899e8d8bef9SDimitry Andric       if (N.ID == Type)
5900e8d8bef9SDimitry Andric         return N.Name;
5901e8d8bef9SDimitry Andric     return "";
5902e8d8bef9SDimitry Andric   };
5903e8d8bef9SDimitry Andric 
5904e8d8bef9SDimitry Andric   StringRef Name = Note.getName();
5905e8d8bef9SDimitry Andric   if (Name == "GNU")
5906e8d8bef9SDimitry Andric     return FindNote(GNUNoteTypes);
5907fe6060f1SDimitry Andric   if (Name == "FreeBSD") {
5908fe6060f1SDimitry Andric     if (ELFType == ELF::ET_CORE) {
5909fe6060f1SDimitry Andric       // FreeBSD also places the generic core notes in the FreeBSD namespace.
5910fe6060f1SDimitry Andric       StringRef Result = FindNote(FreeBSDCoreNoteTypes);
5911fe6060f1SDimitry Andric       if (!Result.empty())
5912fe6060f1SDimitry Andric         return Result;
5913fe6060f1SDimitry Andric       return FindNote(CoreNoteTypes);
5914fe6060f1SDimitry Andric     } else {
5915e8d8bef9SDimitry Andric       return FindNote(FreeBSDNoteTypes);
5916fe6060f1SDimitry Andric     }
5917fe6060f1SDimitry Andric   }
59185f757f3fSDimitry Andric   if (ELFType == ELF::ET_CORE && Name.starts_with("NetBSD-CORE")) {
59194824e7fdSDimitry Andric     StringRef Result = FindNote(NetBSDCoreNoteTypes);
59204824e7fdSDimitry Andric     if (!Result.empty())
59214824e7fdSDimitry Andric       return Result;
59224824e7fdSDimitry Andric     return FindNote(CoreNoteTypes);
59234824e7fdSDimitry Andric   }
59245f757f3fSDimitry Andric   if (ELFType == ELF::ET_CORE && Name.starts_with("OpenBSD")) {
5925349cc55cSDimitry Andric     // OpenBSD also places the generic core notes in the OpenBSD namespace.
5926349cc55cSDimitry Andric     StringRef Result = FindNote(OpenBSDCoreNoteTypes);
5927349cc55cSDimitry Andric     if (!Result.empty())
5928349cc55cSDimitry Andric       return Result;
5929349cc55cSDimitry Andric     return FindNote(CoreNoteTypes);
5930349cc55cSDimitry Andric   }
5931e8d8bef9SDimitry Andric   if (Name == "AMD")
5932e8d8bef9SDimitry Andric     return FindNote(AMDNoteTypes);
5933e8d8bef9SDimitry Andric   if (Name == "AMDGPU")
5934e8d8bef9SDimitry Andric     return FindNote(AMDGPUNoteTypes);
5935349cc55cSDimitry Andric   if (Name == "LLVMOMPOFFLOAD")
5936349cc55cSDimitry Andric     return FindNote(LLVMOMPOFFLOADNoteTypes);
593781ad6265SDimitry Andric   if (Name == "Android")
593881ad6265SDimitry Andric     return FindNote(AndroidNoteTypes);
59395f757f3fSDimitry Andric   if (Name == "ARM")
59405f757f3fSDimitry Andric     return FindNote(ARMNoteTypes);
5941e8d8bef9SDimitry Andric 
5942e8d8bef9SDimitry Andric   if (ELFType == ELF::ET_CORE)
5943e8d8bef9SDimitry Andric     return FindNote(CoreNoteTypes);
5944e8d8bef9SDimitry Andric   return FindNote(GenericNoteTypes);
5945e8d8bef9SDimitry Andric }
5946e8d8bef9SDimitry Andric 
5947e8d8bef9SDimitry Andric template <class ELFT>
processNotesHelper(const ELFDumper<ELFT> & Dumper,llvm::function_ref<void (std::optional<StringRef>,typename ELFT::Off,typename ELFT::Addr,size_t)> StartNotesFn,llvm::function_ref<Error (const typename ELFT::Note &,bool)> ProcessNoteFn,llvm::function_ref<void ()> FinishNotesFn)594806c3fb27SDimitry Andric static void processNotesHelper(
5949e8d8bef9SDimitry Andric     const ELFDumper<ELFT> &Dumper,
5950bdd1243dSDimitry Andric     llvm::function_ref<void(std::optional<StringRef>, typename ELFT::Off,
595106c3fb27SDimitry Andric                             typename ELFT::Addr, size_t)>
5952e8d8bef9SDimitry Andric         StartNotesFn,
5953fe6060f1SDimitry Andric     llvm::function_ref<Error(const typename ELFT::Note &, bool)> ProcessNoteFn,
5954e8d8bef9SDimitry Andric     llvm::function_ref<void()> FinishNotesFn) {
5955e8d8bef9SDimitry Andric   const ELFFile<ELFT> &Obj = Dumper.getElfObject().getELFFile();
5956fe6060f1SDimitry Andric   bool IsCoreFile = Obj.getHeader().e_type == ELF::ET_CORE;
5957e8d8bef9SDimitry Andric 
5958e8d8bef9SDimitry Andric   ArrayRef<typename ELFT::Shdr> Sections = cantFail(Obj.sections());
5959fe6060f1SDimitry Andric   if (!IsCoreFile && !Sections.empty()) {
5960e8d8bef9SDimitry Andric     for (const typename ELFT::Shdr &S : Sections) {
5961e8d8bef9SDimitry Andric       if (S.sh_type != SHT_NOTE)
5962e8d8bef9SDimitry Andric         continue;
5963bdd1243dSDimitry Andric       StartNotesFn(expectedToStdOptional(Obj.getSectionName(S)), S.sh_offset,
596406c3fb27SDimitry Andric                    S.sh_size, S.sh_addralign);
5965e8d8bef9SDimitry Andric       Error Err = Error::success();
5966e8d8bef9SDimitry Andric       size_t I = 0;
5967e8d8bef9SDimitry Andric       for (const typename ELFT::Note Note : Obj.notes(S, Err)) {
5968fe6060f1SDimitry Andric         if (Error E = ProcessNoteFn(Note, IsCoreFile))
5969e8d8bef9SDimitry Andric           Dumper.reportUniqueWarning(
5970e8d8bef9SDimitry Andric               "unable to read note with index " + Twine(I) + " from the " +
5971e8d8bef9SDimitry Andric               describe(Obj, S) + ": " + toString(std::move(E)));
5972e8d8bef9SDimitry Andric         ++I;
5973e8d8bef9SDimitry Andric       }
5974e8d8bef9SDimitry Andric       if (Err)
5975e8d8bef9SDimitry Andric         Dumper.reportUniqueWarning("unable to read notes from the " +
5976e8d8bef9SDimitry Andric                                    describe(Obj, S) + ": " +
5977e8d8bef9SDimitry Andric                                    toString(std::move(Err)));
5978e8d8bef9SDimitry Andric       FinishNotesFn();
5979e8d8bef9SDimitry Andric     }
5980e8d8bef9SDimitry Andric     return;
5981e8d8bef9SDimitry Andric   }
5982e8d8bef9SDimitry Andric 
5983e8d8bef9SDimitry Andric   Expected<ArrayRef<typename ELFT::Phdr>> PhdrsOrErr = Obj.program_headers();
5984e8d8bef9SDimitry Andric   if (!PhdrsOrErr) {
5985e8d8bef9SDimitry Andric     Dumper.reportUniqueWarning(
5986e8d8bef9SDimitry Andric         "unable to read program headers to locate the PT_NOTE segment: " +
5987e8d8bef9SDimitry Andric         toString(PhdrsOrErr.takeError()));
5988e8d8bef9SDimitry Andric     return;
5989e8d8bef9SDimitry Andric   }
5990e8d8bef9SDimitry Andric 
5991e8d8bef9SDimitry Andric   for (size_t I = 0, E = (*PhdrsOrErr).size(); I != E; ++I) {
5992e8d8bef9SDimitry Andric     const typename ELFT::Phdr &P = (*PhdrsOrErr)[I];
5993e8d8bef9SDimitry Andric     if (P.p_type != PT_NOTE)
5994e8d8bef9SDimitry Andric       continue;
599506c3fb27SDimitry Andric     StartNotesFn(/*SecName=*/std::nullopt, P.p_offset, P.p_filesz, P.p_align);
5996e8d8bef9SDimitry Andric     Error Err = Error::success();
5997e8d8bef9SDimitry Andric     size_t Index = 0;
5998e8d8bef9SDimitry Andric     for (const typename ELFT::Note Note : Obj.notes(P, Err)) {
5999fe6060f1SDimitry Andric       if (Error E = ProcessNoteFn(Note, IsCoreFile))
6000e8d8bef9SDimitry Andric         Dumper.reportUniqueWarning("unable to read note with index " +
6001e8d8bef9SDimitry Andric                                    Twine(Index) +
6002e8d8bef9SDimitry Andric                                    " from the PT_NOTE segment with index " +
6003e8d8bef9SDimitry Andric                                    Twine(I) + ": " + toString(std::move(E)));
6004e8d8bef9SDimitry Andric       ++Index;
6005e8d8bef9SDimitry Andric     }
6006e8d8bef9SDimitry Andric     if (Err)
6007e8d8bef9SDimitry Andric       Dumper.reportUniqueWarning(
6008e8d8bef9SDimitry Andric           "unable to read notes from the PT_NOTE segment with index " +
6009e8d8bef9SDimitry Andric           Twine(I) + ": " + toString(std::move(Err)));
6010e8d8bef9SDimitry Andric     FinishNotesFn();
6011e8d8bef9SDimitry Andric   }
6012e8d8bef9SDimitry Andric }
6013e8d8bef9SDimitry Andric 
printNotes()6014e8d8bef9SDimitry Andric template <class ELFT> void GNUELFDumper<ELFT>::printNotes() {
601506c3fb27SDimitry Andric   size_t Align = 0;
6016fe6060f1SDimitry Andric   bool IsFirstHeader = true;
6017bdd1243dSDimitry Andric   auto PrintHeader = [&](std::optional<StringRef> SecName,
60185ffd83dbSDimitry Andric                          const typename ELFT::Off Offset,
601906c3fb27SDimitry Andric                          const typename ELFT::Addr Size, size_t Al) {
602006c3fb27SDimitry Andric     Align = std::max<size_t>(Al, 4);
6021fe6060f1SDimitry Andric     // Print a newline between notes sections to match GNU readelf.
6022fe6060f1SDimitry Andric     if (!IsFirstHeader) {
6023fe6060f1SDimitry Andric       OS << '\n';
6024fe6060f1SDimitry Andric     } else {
6025fe6060f1SDimitry Andric       IsFirstHeader = false;
6026fe6060f1SDimitry Andric     }
6027fe6060f1SDimitry Andric 
60285ffd83dbSDimitry Andric     OS << "Displaying notes found ";
60295ffd83dbSDimitry Andric 
60305ffd83dbSDimitry Andric     if (SecName)
60315ffd83dbSDimitry Andric       OS << "in: " << *SecName << "\n";
60325ffd83dbSDimitry Andric     else
60335ffd83dbSDimitry Andric       OS << "at file offset " << format_hex(Offset, 10) << " with length "
60345ffd83dbSDimitry Andric          << format_hex(Size, 10) << ":\n";
60355ffd83dbSDimitry Andric 
60365ffd83dbSDimitry Andric     OS << "  Owner                Data size \tDescription\n";
60370b57cec5SDimitry Andric   };
60380b57cec5SDimitry Andric 
6039fe6060f1SDimitry Andric   auto ProcessNote = [&](const Elf_Note &Note, bool IsCore) -> Error {
60400b57cec5SDimitry Andric     StringRef Name = Note.getName();
604106c3fb27SDimitry Andric     ArrayRef<uint8_t> Descriptor = Note.getDesc(Align);
60420b57cec5SDimitry Andric     Elf_Word Type = Note.getType();
60430b57cec5SDimitry Andric 
60448bcb0991SDimitry Andric     // Print the note owner/type.
60458bcb0991SDimitry Andric     OS << "  " << left_justify(Name, 20) << ' '
60460b57cec5SDimitry Andric        << format_hex(Descriptor.size(), 10) << '\t';
6047e8d8bef9SDimitry Andric 
6048e8d8bef9SDimitry Andric     StringRef NoteType =
6049e8d8bef9SDimitry Andric         getNoteTypeName<ELFT>(Note, this->Obj.getHeader().e_type);
60508bcb0991SDimitry Andric     if (!NoteType.empty())
60518bcb0991SDimitry Andric       OS << NoteType << '\n';
60528bcb0991SDimitry Andric     else
60538bcb0991SDimitry Andric       OS << "Unknown note type: (" << format_hex(Type, 10) << ")\n";
60548bcb0991SDimitry Andric 
60558bcb0991SDimitry Andric     // Print the description, or fallback to printing raw bytes for unknown
6056fe6060f1SDimitry Andric     // owners/if we fail to pretty-print the contents.
60578bcb0991SDimitry Andric     if (Name == "GNU") {
6058fe6060f1SDimitry Andric       if (printGNUNote<ELFT>(OS, Type, Descriptor))
6059fe6060f1SDimitry Andric         return Error::success();
6060fe6060f1SDimitry Andric     } else if (Name == "FreeBSD") {
6061bdd1243dSDimitry Andric       if (std::optional<FreeBSDNote> N =
6062fe6060f1SDimitry Andric               getFreeBSDNote<ELFT>(Type, Descriptor, IsCore)) {
6063fe6060f1SDimitry Andric         OS << "    " << N->Type << ": " << N->Value << '\n';
6064fe6060f1SDimitry Andric         return Error::success();
6065fe6060f1SDimitry Andric       }
60668bcb0991SDimitry Andric     } else if (Name == "AMD") {
60670b57cec5SDimitry Andric       const AMDNote N = getAMDNote<ELFT>(Type, Descriptor);
6068fe6060f1SDimitry Andric       if (!N.Type.empty()) {
60690b57cec5SDimitry Andric         OS << "    " << N.Type << ":\n        " << N.Value << '\n';
6070fe6060f1SDimitry Andric         return Error::success();
6071fe6060f1SDimitry Andric       }
60720b57cec5SDimitry Andric     } else if (Name == "AMDGPU") {
60730b57cec5SDimitry Andric       const AMDGPUNote N = getAMDGPUNote<ELFT>(Type, Descriptor);
6074fe6060f1SDimitry Andric       if (!N.Type.empty()) {
60750b57cec5SDimitry Andric         OS << "    " << N.Type << ":\n        " << N.Value << '\n';
6076fe6060f1SDimitry Andric         return Error::success();
6077fe6060f1SDimitry Andric       }
6078349cc55cSDimitry Andric     } else if (Name == "LLVMOMPOFFLOAD") {
6079349cc55cSDimitry Andric       if (printLLVMOMPOFFLOADNote<ELFT>(OS, Type, Descriptor))
6080349cc55cSDimitry Andric         return Error::success();
60818bcb0991SDimitry Andric     } else if (Name == "CORE") {
60828bcb0991SDimitry Andric       if (Type == ELF::NT_FILE) {
60835f757f3fSDimitry Andric         DataExtractor DescExtractor(
60845f757f3fSDimitry Andric             Descriptor, ELFT::TargetEndianness == llvm::endianness::little,
60858bcb0991SDimitry Andric             sizeof(Elf_Addr));
6086fe6060f1SDimitry Andric         if (Expected<CoreNote> NoteOrErr = readCoreNote(DescExtractor)) {
6087e8d8bef9SDimitry Andric           printCoreNote<ELFT>(OS, *NoteOrErr);
6088fe6060f1SDimitry Andric           return Error::success();
6089fe6060f1SDimitry Andric         } else {
6090e8d8bef9SDimitry Andric           return NoteOrErr.takeError();
60910b57cec5SDimitry Andric         }
6092fe6060f1SDimitry Andric       }
609381ad6265SDimitry Andric     } else if (Name == "Android") {
609481ad6265SDimitry Andric       if (printAndroidNote(OS, Type, Descriptor))
609581ad6265SDimitry Andric         return Error::success();
60965f757f3fSDimitry Andric     } else if (Name == "ARM") {
60975f757f3fSDimitry Andric       if (printAArch64Note<ELFT>(OS, Type, Descriptor))
60985f757f3fSDimitry Andric         return Error::success();
6099fe6060f1SDimitry Andric     }
6100fe6060f1SDimitry Andric     if (!Descriptor.empty()) {
61018bcb0991SDimitry Andric       OS << "   description data:";
61028bcb0991SDimitry Andric       for (uint8_t B : Descriptor)
61038bcb0991SDimitry Andric         OS << " " << format("%02x", B);
61040b57cec5SDimitry Andric       OS << '\n';
61058bcb0991SDimitry Andric     }
6106e8d8bef9SDimitry Andric     return Error::success();
61070b57cec5SDimitry Andric   };
61080b57cec5SDimitry Andric 
610906c3fb27SDimitry Andric   processNotesHelper(*this, /*StartNotesFn=*/PrintHeader,
611006c3fb27SDimitry Andric                      /*ProcessNoteFn=*/ProcessNote, /*FinishNotesFn=*/[]() {});
611106c3fb27SDimitry Andric }
611206c3fb27SDimitry Andric 
611306c3fb27SDimitry Andric template <class ELFT>
611406c3fb27SDimitry Andric ArrayRef<uint8_t>
getMemtagGlobalsSectionContents(uint64_t ExpectedAddr)611506c3fb27SDimitry Andric ELFDumper<ELFT>::getMemtagGlobalsSectionContents(uint64_t ExpectedAddr) {
611606c3fb27SDimitry Andric   for (const typename ELFT::Shdr &Sec : cantFail(Obj.sections())) {
611706c3fb27SDimitry Andric     if (Sec.sh_type != SHT_AARCH64_MEMTAG_GLOBALS_DYNAMIC)
611806c3fb27SDimitry Andric       continue;
611906c3fb27SDimitry Andric     if (Sec.sh_addr != ExpectedAddr) {
612006c3fb27SDimitry Andric       reportUniqueWarning(
612106c3fb27SDimitry Andric           "SHT_AARCH64_MEMTAG_GLOBALS_DYNAMIC section was unexpectedly at 0x" +
612206c3fb27SDimitry Andric           Twine::utohexstr(Sec.sh_addr) +
612306c3fb27SDimitry Andric           ", when DT_AARCH64_MEMTAG_GLOBALS says it should be at 0x" +
612406c3fb27SDimitry Andric           Twine::utohexstr(ExpectedAddr));
612506c3fb27SDimitry Andric       return ArrayRef<uint8_t>();
612606c3fb27SDimitry Andric     }
612706c3fb27SDimitry Andric     Expected<ArrayRef<uint8_t>> Contents = Obj.getSectionContents(Sec);
612806c3fb27SDimitry Andric     if (auto E = Contents.takeError()) {
612906c3fb27SDimitry Andric       reportUniqueWarning(
613006c3fb27SDimitry Andric           "couldn't get SHT_AARCH64_MEMTAG_GLOBALS_DYNAMIC section contents: " +
613106c3fb27SDimitry Andric           toString(std::move(E)));
613206c3fb27SDimitry Andric       return ArrayRef<uint8_t>();
613306c3fb27SDimitry Andric     }
613406c3fb27SDimitry Andric     return Contents.get();
613506c3fb27SDimitry Andric   }
613606c3fb27SDimitry Andric   return ArrayRef<uint8_t>();
613706c3fb27SDimitry Andric }
613806c3fb27SDimitry Andric 
613906c3fb27SDimitry Andric // Reserve the lower three bits of the first byte of the step distance when
614006c3fb27SDimitry Andric // encoding the memtag descriptors. Found to be the best overall size tradeoff
614106c3fb27SDimitry Andric // when compiling Android T with full MTE globals enabled.
614206c3fb27SDimitry Andric constexpr uint64_t MemtagStepVarintReservedBits = 3;
614306c3fb27SDimitry Andric constexpr uint64_t MemtagGranuleSize = 16;
614406c3fb27SDimitry Andric 
printMemtag()614506c3fb27SDimitry Andric template <typename ELFT> void ELFDumper<ELFT>::printMemtag() {
614606c3fb27SDimitry Andric   if (Obj.getHeader().e_machine != EM_AARCH64) return;
614706c3fb27SDimitry Andric   std::vector<std::pair<std::string, std::string>> DynamicEntries;
614806c3fb27SDimitry Andric   uint64_t MemtagGlobalsSz = 0;
614906c3fb27SDimitry Andric   uint64_t MemtagGlobals = 0;
615006c3fb27SDimitry Andric   for (const typename ELFT::Dyn &Entry : dynamic_table()) {
615106c3fb27SDimitry Andric     uintX_t Tag = Entry.getTag();
615206c3fb27SDimitry Andric     switch (Tag) {
615306c3fb27SDimitry Andric     case DT_AARCH64_MEMTAG_GLOBALSSZ:
615406c3fb27SDimitry Andric       MemtagGlobalsSz = Entry.getVal();
615506c3fb27SDimitry Andric       DynamicEntries.emplace_back(Obj.getDynamicTagAsString(Tag),
615606c3fb27SDimitry Andric                                   getDynamicEntry(Tag, Entry.getVal()));
615706c3fb27SDimitry Andric       break;
615806c3fb27SDimitry Andric     case DT_AARCH64_MEMTAG_GLOBALS:
615906c3fb27SDimitry Andric       MemtagGlobals = Entry.getVal();
616006c3fb27SDimitry Andric       DynamicEntries.emplace_back(Obj.getDynamicTagAsString(Tag),
616106c3fb27SDimitry Andric                                   getDynamicEntry(Tag, Entry.getVal()));
616206c3fb27SDimitry Andric       break;
616306c3fb27SDimitry Andric     case DT_AARCH64_MEMTAG_MODE:
616406c3fb27SDimitry Andric     case DT_AARCH64_MEMTAG_HEAP:
616506c3fb27SDimitry Andric     case DT_AARCH64_MEMTAG_STACK:
616606c3fb27SDimitry Andric       DynamicEntries.emplace_back(Obj.getDynamicTagAsString(Tag),
616706c3fb27SDimitry Andric                                   getDynamicEntry(Tag, Entry.getVal()));
616806c3fb27SDimitry Andric       break;
616906c3fb27SDimitry Andric     }
617006c3fb27SDimitry Andric   }
617106c3fb27SDimitry Andric 
617206c3fb27SDimitry Andric   ArrayRef<uint8_t> AndroidNoteDesc;
617306c3fb27SDimitry Andric   auto FindAndroidNote = [&](const Elf_Note &Note, bool IsCore) -> Error {
617406c3fb27SDimitry Andric     if (Note.getName() == "Android" &&
617506c3fb27SDimitry Andric         Note.getType() == ELF::NT_ANDROID_TYPE_MEMTAG)
617606c3fb27SDimitry Andric       AndroidNoteDesc = Note.getDesc(4);
617706c3fb27SDimitry Andric     return Error::success();
617806c3fb27SDimitry Andric   };
617906c3fb27SDimitry Andric 
618006c3fb27SDimitry Andric   processNotesHelper(
618106c3fb27SDimitry Andric       *this,
618206c3fb27SDimitry Andric       /*StartNotesFn=*/
618306c3fb27SDimitry Andric       [](std::optional<StringRef>, const typename ELFT::Off,
618406c3fb27SDimitry Andric          const typename ELFT::Addr, size_t) {},
618506c3fb27SDimitry Andric       /*ProcessNoteFn=*/FindAndroidNote, /*FinishNotesFn=*/[]() {});
618606c3fb27SDimitry Andric 
618706c3fb27SDimitry Andric   ArrayRef<uint8_t> Contents = getMemtagGlobalsSectionContents(MemtagGlobals);
618806c3fb27SDimitry Andric   if (Contents.size() != MemtagGlobalsSz) {
618906c3fb27SDimitry Andric     reportUniqueWarning(
619006c3fb27SDimitry Andric         "mismatch between DT_AARCH64_MEMTAG_GLOBALSSZ (0x" +
619106c3fb27SDimitry Andric         Twine::utohexstr(MemtagGlobalsSz) +
619206c3fb27SDimitry Andric         ") and SHT_AARCH64_MEMTAG_GLOBALS_DYNAMIC section size (0x" +
619306c3fb27SDimitry Andric         Twine::utohexstr(Contents.size()) + ")");
619406c3fb27SDimitry Andric     Contents = ArrayRef<uint8_t>();
619506c3fb27SDimitry Andric   }
619606c3fb27SDimitry Andric 
619706c3fb27SDimitry Andric   std::vector<std::pair<uint64_t, uint64_t>> GlobalDescriptors;
619806c3fb27SDimitry Andric   uint64_t Address = 0;
619906c3fb27SDimitry Andric   // See the AArch64 MemtagABI document for a description of encoding scheme:
620006c3fb27SDimitry Andric   // https://github.com/ARM-software/abi-aa/blob/main/memtagabielf64/memtagabielf64.rst#83encoding-of-sht_aarch64_memtag_globals_dynamic
620106c3fb27SDimitry Andric   for (size_t I = 0; I < Contents.size();) {
620206c3fb27SDimitry Andric     const char *Error = nullptr;
620306c3fb27SDimitry Andric     unsigned DecodedBytes = 0;
620406c3fb27SDimitry Andric     uint64_t Value = decodeULEB128(Contents.data() + I, &DecodedBytes,
620506c3fb27SDimitry Andric                                    Contents.end(), &Error);
620606c3fb27SDimitry Andric     I += DecodedBytes;
620706c3fb27SDimitry Andric     if (Error) {
620806c3fb27SDimitry Andric       reportUniqueWarning(
620906c3fb27SDimitry Andric           "error decoding distance uleb, " + Twine(DecodedBytes) +
621006c3fb27SDimitry Andric           " byte(s) into SHT_AARCH64_MEMTAG_GLOBALS_DYNAMIC: " + Twine(Error));
621106c3fb27SDimitry Andric       GlobalDescriptors.clear();
621206c3fb27SDimitry Andric       break;
621306c3fb27SDimitry Andric     }
621406c3fb27SDimitry Andric     uint64_t Distance = Value >> MemtagStepVarintReservedBits;
621506c3fb27SDimitry Andric     uint64_t GranulesToTag = Value & ((1 << MemtagStepVarintReservedBits) - 1);
621606c3fb27SDimitry Andric     if (GranulesToTag == 0) {
621706c3fb27SDimitry Andric       GranulesToTag = decodeULEB128(Contents.data() + I, &DecodedBytes,
621806c3fb27SDimitry Andric                                     Contents.end(), &Error) +
621906c3fb27SDimitry Andric                       1;
622006c3fb27SDimitry Andric       I += DecodedBytes;
622106c3fb27SDimitry Andric       if (Error) {
622206c3fb27SDimitry Andric         reportUniqueWarning(
622306c3fb27SDimitry Andric             "error decoding size-only uleb, " + Twine(DecodedBytes) +
622406c3fb27SDimitry Andric             " byte(s) into SHT_AARCH64_MEMTAG_GLOBALS_DYNAMIC: " + Twine(Error));
622506c3fb27SDimitry Andric         GlobalDescriptors.clear();
622606c3fb27SDimitry Andric         break;
622706c3fb27SDimitry Andric       }
622806c3fb27SDimitry Andric     }
622906c3fb27SDimitry Andric     Address += Distance * MemtagGranuleSize;
623006c3fb27SDimitry Andric     GlobalDescriptors.emplace_back(Address, GranulesToTag * MemtagGranuleSize);
623106c3fb27SDimitry Andric     Address += GranulesToTag * MemtagGranuleSize;
623206c3fb27SDimitry Andric   }
623306c3fb27SDimitry Andric 
623406c3fb27SDimitry Andric   printMemtag(DynamicEntries, AndroidNoteDesc, GlobalDescriptors);
62355ffd83dbSDimitry Andric }
62365ffd83dbSDimitry Andric 
printELFLinkerOptions()6237e8d8bef9SDimitry Andric template <class ELFT> void GNUELFDumper<ELFT>::printELFLinkerOptions() {
62380b57cec5SDimitry Andric   OS << "printELFLinkerOptions not implemented!\n";
62390b57cec5SDimitry Andric }
62400b57cec5SDimitry Andric 
6241480093f4SDimitry Andric template <class ELFT>
printDependentLibsHelper(function_ref<void (const Elf_Shdr &)> OnSectionStart,function_ref<void (StringRef,uint64_t)> OnLibEntry)6242e8d8bef9SDimitry Andric void ELFDumper<ELFT>::printDependentLibsHelper(
62435ffd83dbSDimitry Andric     function_ref<void(const Elf_Shdr &)> OnSectionStart,
62445ffd83dbSDimitry Andric     function_ref<void(StringRef, uint64_t)> OnLibEntry) {
62455ffd83dbSDimitry Andric   auto Warn = [this](unsigned SecNdx, StringRef Msg) {
6246e8d8bef9SDimitry Andric     this->reportUniqueWarning("SHT_LLVM_DEPENDENT_LIBRARIES section at index " +
6247e8d8bef9SDimitry Andric                               Twine(SecNdx) + " is broken: " + Msg);
62485ffd83dbSDimitry Andric   };
62495ffd83dbSDimitry Andric 
62505ffd83dbSDimitry Andric   unsigned I = -1;
6251e8d8bef9SDimitry Andric   for (const Elf_Shdr &Shdr : cantFail(Obj.sections())) {
62525ffd83dbSDimitry Andric     ++I;
62535ffd83dbSDimitry Andric     if (Shdr.sh_type != ELF::SHT_LLVM_DEPENDENT_LIBRARIES)
62545ffd83dbSDimitry Andric       continue;
62555ffd83dbSDimitry Andric 
62565ffd83dbSDimitry Andric     OnSectionStart(Shdr);
62575ffd83dbSDimitry Andric 
6258e8d8bef9SDimitry Andric     Expected<ArrayRef<uint8_t>> ContentsOrErr = Obj.getSectionContents(Shdr);
62595ffd83dbSDimitry Andric     if (!ContentsOrErr) {
62605ffd83dbSDimitry Andric       Warn(I, toString(ContentsOrErr.takeError()));
62615ffd83dbSDimitry Andric       continue;
62625ffd83dbSDimitry Andric     }
62635ffd83dbSDimitry Andric 
62645ffd83dbSDimitry Andric     ArrayRef<uint8_t> Contents = *ContentsOrErr;
62655ffd83dbSDimitry Andric     if (!Contents.empty() && Contents.back() != 0) {
62665ffd83dbSDimitry Andric       Warn(I, "the content is not null-terminated");
62675ffd83dbSDimitry Andric       continue;
62685ffd83dbSDimitry Andric     }
62695ffd83dbSDimitry Andric 
62705ffd83dbSDimitry Andric     for (const uint8_t *I = Contents.begin(), *E = Contents.end(); I < E;) {
62715ffd83dbSDimitry Andric       StringRef Lib((const char *)I);
62725ffd83dbSDimitry Andric       OnLibEntry(Lib, I - Contents.begin());
62735ffd83dbSDimitry Andric       I += Lib.size() + 1;
62745ffd83dbSDimitry Andric     }
62755ffd83dbSDimitry Andric   }
62765ffd83dbSDimitry Andric }
62775ffd83dbSDimitry Andric 
62785ffd83dbSDimitry Andric template <class ELFT>
forEachRelocationDo(const Elf_Shdr & Sec,bool RawRelr,llvm::function_ref<void (const Relocation<ELFT> &,unsigned,const Elf_Shdr &,const Elf_Shdr *)> RelRelaFn,llvm::function_ref<void (const Elf_Relr &)> RelrFn)6279e8d8bef9SDimitry Andric void ELFDumper<ELFT>::forEachRelocationDo(
6280e8d8bef9SDimitry Andric     const Elf_Shdr &Sec, bool RawRelr,
6281e8d8bef9SDimitry Andric     llvm::function_ref<void(const Relocation<ELFT> &, unsigned,
6282e8d8bef9SDimitry Andric                             const Elf_Shdr &, const Elf_Shdr *)>
6283e8d8bef9SDimitry Andric         RelRelaFn,
6284e8d8bef9SDimitry Andric     llvm::function_ref<void(const Elf_Relr &)> RelrFn) {
6285e8d8bef9SDimitry Andric   auto Warn = [&](Error &&E,
6286e8d8bef9SDimitry Andric                   const Twine &Prefix = "unable to read relocations from") {
6287e8d8bef9SDimitry Andric     this->reportUniqueWarning(Prefix + " " + describe(Sec) + ": " +
6288e8d8bef9SDimitry Andric                               toString(std::move(E)));
6289e8d8bef9SDimitry Andric   };
6290e8d8bef9SDimitry Andric 
62915f757f3fSDimitry Andric   // SHT_RELR/SHT_ANDROID_RELR/SHT_AARCH64_AUTH_RELR sections do not have an
62925f757f3fSDimitry Andric   // associated symbol table. For them we should not treat the value of the
62935f757f3fSDimitry Andric   // sh_link field as an index of a symbol table.
6294e8d8bef9SDimitry Andric   const Elf_Shdr *SymTab;
62955f757f3fSDimitry Andric   if (Sec.sh_type != ELF::SHT_RELR && Sec.sh_type != ELF::SHT_ANDROID_RELR &&
62965f757f3fSDimitry Andric       !(Obj.getHeader().e_machine == EM_AARCH64 &&
62975f757f3fSDimitry Andric         Sec.sh_type == ELF::SHT_AARCH64_AUTH_RELR)) {
6298e8d8bef9SDimitry Andric     Expected<const Elf_Shdr *> SymTabOrErr = Obj.getSection(Sec.sh_link);
6299e8d8bef9SDimitry Andric     if (!SymTabOrErr) {
6300e8d8bef9SDimitry Andric       Warn(SymTabOrErr.takeError(), "unable to locate a symbol table for");
6301e8d8bef9SDimitry Andric       return;
6302e8d8bef9SDimitry Andric     }
6303e8d8bef9SDimitry Andric     SymTab = *SymTabOrErr;
6304e8d8bef9SDimitry Andric   }
6305e8d8bef9SDimitry Andric 
6306e8d8bef9SDimitry Andric   unsigned RelNdx = 0;
6307e8d8bef9SDimitry Andric   const bool IsMips64EL = this->Obj.isMips64EL();
6308e8d8bef9SDimitry Andric   switch (Sec.sh_type) {
6309e8d8bef9SDimitry Andric   case ELF::SHT_REL:
6310e8d8bef9SDimitry Andric     if (Expected<Elf_Rel_Range> RangeOrErr = Obj.rels(Sec)) {
6311e8d8bef9SDimitry Andric       for (const Elf_Rel &R : *RangeOrErr)
6312e8d8bef9SDimitry Andric         RelRelaFn(Relocation<ELFT>(R, IsMips64EL), RelNdx++, Sec, SymTab);
6313e8d8bef9SDimitry Andric     } else {
6314e8d8bef9SDimitry Andric       Warn(RangeOrErr.takeError());
6315e8d8bef9SDimitry Andric     }
6316e8d8bef9SDimitry Andric     break;
6317e8d8bef9SDimitry Andric   case ELF::SHT_RELA:
6318e8d8bef9SDimitry Andric     if (Expected<Elf_Rela_Range> RangeOrErr = Obj.relas(Sec)) {
6319e8d8bef9SDimitry Andric       for (const Elf_Rela &R : *RangeOrErr)
6320e8d8bef9SDimitry Andric         RelRelaFn(Relocation<ELFT>(R, IsMips64EL), RelNdx++, Sec, SymTab);
6321e8d8bef9SDimitry Andric     } else {
6322e8d8bef9SDimitry Andric       Warn(RangeOrErr.takeError());
6323e8d8bef9SDimitry Andric     }
6324e8d8bef9SDimitry Andric     break;
63255f757f3fSDimitry Andric   case ELF::SHT_AARCH64_AUTH_RELR:
63265f757f3fSDimitry Andric     if (Obj.getHeader().e_machine != EM_AARCH64)
63275f757f3fSDimitry Andric       break;
63285f757f3fSDimitry Andric     [[fallthrough]];
6329e8d8bef9SDimitry Andric   case ELF::SHT_RELR:
6330e8d8bef9SDimitry Andric   case ELF::SHT_ANDROID_RELR: {
6331e8d8bef9SDimitry Andric     Expected<Elf_Relr_Range> RangeOrErr = Obj.relrs(Sec);
6332e8d8bef9SDimitry Andric     if (!RangeOrErr) {
6333e8d8bef9SDimitry Andric       Warn(RangeOrErr.takeError());
6334e8d8bef9SDimitry Andric       break;
6335e8d8bef9SDimitry Andric     }
6336e8d8bef9SDimitry Andric     if (RawRelr) {
6337e8d8bef9SDimitry Andric       for (const Elf_Relr &R : *RangeOrErr)
6338e8d8bef9SDimitry Andric         RelrFn(R);
6339e8d8bef9SDimitry Andric       break;
6340e8d8bef9SDimitry Andric     }
6341e8d8bef9SDimitry Andric 
6342e8d8bef9SDimitry Andric     for (const Elf_Rel &R : Obj.decode_relrs(*RangeOrErr))
6343e8d8bef9SDimitry Andric       RelRelaFn(Relocation<ELFT>(R, IsMips64EL), RelNdx++, Sec,
6344e8d8bef9SDimitry Andric                 /*SymTab=*/nullptr);
6345e8d8bef9SDimitry Andric     break;
6346e8d8bef9SDimitry Andric   }
6347e8d8bef9SDimitry Andric   case ELF::SHT_ANDROID_REL:
6348e8d8bef9SDimitry Andric   case ELF::SHT_ANDROID_RELA:
6349e8d8bef9SDimitry Andric     if (Expected<std::vector<Elf_Rela>> RelasOrErr = Obj.android_relas(Sec)) {
6350e8d8bef9SDimitry Andric       for (const Elf_Rela &R : *RelasOrErr)
6351e8d8bef9SDimitry Andric         RelRelaFn(Relocation<ELFT>(R, IsMips64EL), RelNdx++, Sec, SymTab);
6352e8d8bef9SDimitry Andric     } else {
6353e8d8bef9SDimitry Andric       Warn(RelasOrErr.takeError());
6354e8d8bef9SDimitry Andric     }
6355e8d8bef9SDimitry Andric     break;
6356e8d8bef9SDimitry Andric   }
6357e8d8bef9SDimitry Andric }
6358e8d8bef9SDimitry Andric 
6359e8d8bef9SDimitry Andric template <class ELFT>
getPrintableSectionName(const Elf_Shdr & Sec) const6360e8d8bef9SDimitry Andric StringRef ELFDumper<ELFT>::getPrintableSectionName(const Elf_Shdr &Sec) const {
6361e8d8bef9SDimitry Andric   StringRef Name = "<?>";
6362e8d8bef9SDimitry Andric   if (Expected<StringRef> SecNameOrErr =
6363e8d8bef9SDimitry Andric           Obj.getSectionName(Sec, this->WarningHandler))
6364e8d8bef9SDimitry Andric     Name = *SecNameOrErr;
6365e8d8bef9SDimitry Andric   else
6366e8d8bef9SDimitry Andric     this->reportUniqueWarning("unable to get the name of " + describe(Sec) +
6367e8d8bef9SDimitry Andric                               ": " + toString(SecNameOrErr.takeError()));
6368e8d8bef9SDimitry Andric   return Name;
6369e8d8bef9SDimitry Andric }
6370e8d8bef9SDimitry Andric 
printDependentLibs()6371e8d8bef9SDimitry Andric template <class ELFT> void GNUELFDumper<ELFT>::printDependentLibs() {
63725ffd83dbSDimitry Andric   bool SectionStarted = false;
63735ffd83dbSDimitry Andric   struct NameOffset {
63745ffd83dbSDimitry Andric     StringRef Name;
63755ffd83dbSDimitry Andric     uint64_t Offset;
63765ffd83dbSDimitry Andric   };
63775ffd83dbSDimitry Andric   std::vector<NameOffset> SecEntries;
63785ffd83dbSDimitry Andric   NameOffset Current;
63795ffd83dbSDimitry Andric   auto PrintSection = [&]() {
63805ffd83dbSDimitry Andric     OS << "Dependent libraries section " << Current.Name << " at offset "
63815ffd83dbSDimitry Andric        << format_hex(Current.Offset, 1) << " contains " << SecEntries.size()
63825ffd83dbSDimitry Andric        << " entries:\n";
63835ffd83dbSDimitry Andric     for (NameOffset Entry : SecEntries)
6384e8d8bef9SDimitry Andric       OS << "  [" << format("%6" PRIx64, Entry.Offset) << "]  " << Entry.Name
63855ffd83dbSDimitry Andric          << "\n";
63865ffd83dbSDimitry Andric     OS << "\n";
63875ffd83dbSDimitry Andric     SecEntries.clear();
63885ffd83dbSDimitry Andric   };
63895ffd83dbSDimitry Andric 
63905ffd83dbSDimitry Andric   auto OnSectionStart = [&](const Elf_Shdr &Shdr) {
63915ffd83dbSDimitry Andric     if (SectionStarted)
63925ffd83dbSDimitry Andric       PrintSection();
63935ffd83dbSDimitry Andric     SectionStarted = true;
63945ffd83dbSDimitry Andric     Current.Offset = Shdr.sh_offset;
6395e8d8bef9SDimitry Andric     Current.Name = this->getPrintableSectionName(Shdr);
63965ffd83dbSDimitry Andric   };
63975ffd83dbSDimitry Andric   auto OnLibEntry = [&](StringRef Lib, uint64_t Offset) {
63985ffd83dbSDimitry Andric     SecEntries.push_back(NameOffset{Lib, Offset});
63995ffd83dbSDimitry Andric   };
64005ffd83dbSDimitry Andric 
6401e8d8bef9SDimitry Andric   this->printDependentLibsHelper(OnSectionStart, OnLibEntry);
64025ffd83dbSDimitry Andric   if (SectionStarted)
64035ffd83dbSDimitry Andric     PrintSection();
6404480093f4SDimitry Andric }
6405480093f4SDimitry Andric 
64068bcb0991SDimitry Andric template <class ELFT>
getSymbolIndexesForFunctionAddress(uint64_t SymValue,std::optional<const Elf_Shdr * > FunctionSec)6407fe6060f1SDimitry Andric SmallVector<uint32_t> ELFDumper<ELFT>::getSymbolIndexesForFunctionAddress(
6408bdd1243dSDimitry Andric     uint64_t SymValue, std::optional<const Elf_Shdr *> FunctionSec) {
6409fe6060f1SDimitry Andric   SmallVector<uint32_t> SymbolIndexes;
641081ad6265SDimitry Andric   if (!this->AddressToIndexMap) {
6411fe6060f1SDimitry Andric     // Populate the address to index map upon the first invocation of this
6412fe6060f1SDimitry Andric     // function.
6413fe6060f1SDimitry Andric     this->AddressToIndexMap.emplace();
6414e8d8bef9SDimitry Andric     if (this->DotSymtabSec) {
6415fe6060f1SDimitry Andric       if (Expected<Elf_Sym_Range> SymsOrError =
6416fe6060f1SDimitry Andric               Obj.symbols(this->DotSymtabSec)) {
6417e8d8bef9SDimitry Andric         uint32_t Index = (uint32_t)-1;
6418e8d8bef9SDimitry Andric         for (const Elf_Sym &Sym : *SymsOrError) {
6419e8d8bef9SDimitry Andric           ++Index;
6420e8d8bef9SDimitry Andric 
6421e8d8bef9SDimitry Andric           if (Sym.st_shndx == ELF::SHN_UNDEF || Sym.getType() != ELF::STT_FUNC)
64228bcb0991SDimitry Andric             continue;
6423e8d8bef9SDimitry Andric 
6424fe6060f1SDimitry Andric           Expected<uint64_t> SymAddrOrErr =
6425fe6060f1SDimitry Andric               ObjF.toSymbolRef(this->DotSymtabSec, Index).getAddress();
6426fe6060f1SDimitry Andric           if (!SymAddrOrErr) {
6427e8d8bef9SDimitry Andric             std::string Name = this->getStaticSymbolName(Index);
6428e8d8bef9SDimitry Andric             reportUniqueWarning("unable to get address of symbol '" + Name +
6429e8d8bef9SDimitry Andric                                 "': " + toString(SymAddrOrErr.takeError()));
6430fe6060f1SDimitry Andric             return SymbolIndexes;
64318bcb0991SDimitry Andric           }
6432e8d8bef9SDimitry Andric 
6433fe6060f1SDimitry Andric           (*this->AddressToIndexMap)[*SymAddrOrErr].push_back(Index);
6434fe6060f1SDimitry Andric         }
6435fe6060f1SDimitry Andric       } else {
6436fe6060f1SDimitry Andric         reportUniqueWarning("unable to read the symbol table: " +
6437fe6060f1SDimitry Andric                             toString(SymsOrError.takeError()));
6438fe6060f1SDimitry Andric       }
6439fe6060f1SDimitry Andric     }
6440fe6060f1SDimitry Andric   }
6441fe6060f1SDimitry Andric 
6442fe6060f1SDimitry Andric   auto Symbols = this->AddressToIndexMap->find(SymValue);
6443fe6060f1SDimitry Andric   if (Symbols == this->AddressToIndexMap->end())
6444fe6060f1SDimitry Andric     return SymbolIndexes;
6445fe6060f1SDimitry Andric 
6446fe6060f1SDimitry Andric   for (uint32_t Index : Symbols->second) {
6447e8d8bef9SDimitry Andric     // Check if the symbol is in the right section. FunctionSec == None
6448e8d8bef9SDimitry Andric     // means "any section".
6449e8d8bef9SDimitry Andric     if (FunctionSec) {
6450fe6060f1SDimitry Andric       const Elf_Sym &Sym = *cantFail(Obj.getSymbol(this->DotSymtabSec, Index));
6451e8d8bef9SDimitry Andric       if (Expected<const Elf_Shdr *> SecOrErr =
6452e8d8bef9SDimitry Andric               Obj.getSection(Sym, this->DotSymtabSec,
6453e8d8bef9SDimitry Andric                              this->getShndxTable(this->DotSymtabSec))) {
6454e8d8bef9SDimitry Andric         if (*FunctionSec != *SecOrErr)
6455e8d8bef9SDimitry Andric           continue;
6456e8d8bef9SDimitry Andric       } else {
6457e8d8bef9SDimitry Andric         std::string Name = this->getStaticSymbolName(Index);
6458e8d8bef9SDimitry Andric         // Note: it is impossible to trigger this error currently, it is
6459e8d8bef9SDimitry Andric         // untested.
6460e8d8bef9SDimitry Andric         reportUniqueWarning("unable to get section of symbol '" + Name +
6461e8d8bef9SDimitry Andric                             "': " + toString(SecOrErr.takeError()));
6462fe6060f1SDimitry Andric         return SymbolIndexes;
6463e8d8bef9SDimitry Andric       }
6464e8d8bef9SDimitry Andric     }
6465e8d8bef9SDimitry Andric 
6466fe6060f1SDimitry Andric     SymbolIndexes.push_back(Index);
64678bcb0991SDimitry Andric   }
64688bcb0991SDimitry Andric 
6469fe6060f1SDimitry Andric   return SymbolIndexes;
6470fe6060f1SDimitry Andric }
6471fe6060f1SDimitry Andric 
6472fe6060f1SDimitry Andric template <class ELFT>
printFunctionStackSize(uint64_t SymValue,std::optional<const Elf_Shdr * > FunctionSec,const Elf_Shdr & StackSizeSec,DataExtractor Data,uint64_t * Offset)6473fe6060f1SDimitry Andric bool ELFDumper<ELFT>::printFunctionStackSize(
6474bdd1243dSDimitry Andric     uint64_t SymValue, std::optional<const Elf_Shdr *> FunctionSec,
6475fe6060f1SDimitry Andric     const Elf_Shdr &StackSizeSec, DataExtractor Data, uint64_t *Offset) {
6476fe6060f1SDimitry Andric   SmallVector<uint32_t> FuncSymIndexes =
6477fe6060f1SDimitry Andric       this->getSymbolIndexesForFunctionAddress(SymValue, FunctionSec);
6478fe6060f1SDimitry Andric   if (FuncSymIndexes.empty())
6479e8d8bef9SDimitry Andric     reportUniqueWarning(
6480e8d8bef9SDimitry Andric         "could not identify function symbol for stack size entry in " +
6481e8d8bef9SDimitry Andric         describe(StackSizeSec));
64828bcb0991SDimitry Andric 
64838bcb0991SDimitry Andric   // Extract the size. The expectation is that Offset is pointing to the right
64848bcb0991SDimitry Andric   // place, i.e. past the function address.
6485e8d8bef9SDimitry Andric   Error Err = Error::success();
6486e8d8bef9SDimitry Andric   uint64_t StackSize = Data.getULEB128(Offset, &Err);
6487e8d8bef9SDimitry Andric   if (Err) {
6488e8d8bef9SDimitry Andric     reportUniqueWarning("could not extract a valid stack size from " +
6489e8d8bef9SDimitry Andric                         describe(StackSizeSec) + ": " +
6490e8d8bef9SDimitry Andric                         toString(std::move(Err)));
6491e8d8bef9SDimitry Andric     return false;
6492e8d8bef9SDimitry Andric   }
6493fe6060f1SDimitry Andric 
6494fe6060f1SDimitry Andric   if (FuncSymIndexes.empty()) {
6495fe6060f1SDimitry Andric     printStackSizeEntry(StackSize, {"?"});
6496fe6060f1SDimitry Andric   } else {
6497fe6060f1SDimitry Andric     SmallVector<std::string> FuncSymNames;
6498fe6060f1SDimitry Andric     for (uint32_t Index : FuncSymIndexes)
6499fe6060f1SDimitry Andric       FuncSymNames.push_back(this->getStaticSymbolName(Index));
6500fe6060f1SDimitry Andric     printStackSizeEntry(StackSize, FuncSymNames);
6501fe6060f1SDimitry Andric   }
6502fe6060f1SDimitry Andric 
6503e8d8bef9SDimitry Andric   return true;
65048bcb0991SDimitry Andric }
65058bcb0991SDimitry Andric 
65068bcb0991SDimitry Andric template <class ELFT>
printStackSizeEntry(uint64_t Size,ArrayRef<std::string> FuncNames)6507e8d8bef9SDimitry Andric void GNUELFDumper<ELFT>::printStackSizeEntry(uint64_t Size,
6508fe6060f1SDimitry Andric                                              ArrayRef<std::string> FuncNames) {
65098bcb0991SDimitry Andric   OS.PadToColumn(2);
65108bcb0991SDimitry Andric   OS << format_decimal(Size, 11);
65118bcb0991SDimitry Andric   OS.PadToColumn(18);
6512fe6060f1SDimitry Andric 
6513fe6060f1SDimitry Andric   OS << join(FuncNames.begin(), FuncNames.end(), ", ") << "\n";
65148bcb0991SDimitry Andric }
65158bcb0991SDimitry Andric 
65168bcb0991SDimitry Andric template <class ELFT>
printStackSize(const Relocation<ELFT> & R,const Elf_Shdr & RelocSec,unsigned Ndx,const Elf_Shdr * SymTab,const Elf_Shdr * FunctionSec,const Elf_Shdr & StackSizeSec,const RelocationResolver & Resolver,DataExtractor Data)6517e8d8bef9SDimitry Andric void ELFDumper<ELFT>::printStackSize(const Relocation<ELFT> &R,
6518e8d8bef9SDimitry Andric                                      const Elf_Shdr &RelocSec, unsigned Ndx,
6519e8d8bef9SDimitry Andric                                      const Elf_Shdr *SymTab,
6520e8d8bef9SDimitry Andric                                      const Elf_Shdr *FunctionSec,
6521e8d8bef9SDimitry Andric                                      const Elf_Shdr &StackSizeSec,
65228bcb0991SDimitry Andric                                      const RelocationResolver &Resolver,
65238bcb0991SDimitry Andric                                      DataExtractor Data) {
65248bcb0991SDimitry Andric   // This function ignores potentially erroneous input, unless it is directly
65258bcb0991SDimitry Andric   // related to stack size reporting.
6526e8d8bef9SDimitry Andric   const Elf_Sym *Sym = nullptr;
6527e8d8bef9SDimitry Andric   Expected<RelSymbol<ELFT>> TargetOrErr = this->getRelocationTarget(R, SymTab);
6528e8d8bef9SDimitry Andric   if (!TargetOrErr)
6529e8d8bef9SDimitry Andric     reportUniqueWarning("unable to get the target of relocation with index " +
6530e8d8bef9SDimitry Andric                         Twine(Ndx) + " in " + describe(RelocSec) + ": " +
6531e8d8bef9SDimitry Andric                         toString(TargetOrErr.takeError()));
6532e8d8bef9SDimitry Andric   else
6533e8d8bef9SDimitry Andric     Sym = TargetOrErr->Sym;
6534e8d8bef9SDimitry Andric 
65358bcb0991SDimitry Andric   uint64_t RelocSymValue = 0;
6536e8d8bef9SDimitry Andric   if (Sym) {
6537e8d8bef9SDimitry Andric     Expected<const Elf_Shdr *> SectionOrErr =
6538e8d8bef9SDimitry Andric         this->Obj.getSection(*Sym, SymTab, this->getShndxTable(SymTab));
65398bcb0991SDimitry Andric     if (!SectionOrErr) {
6540e8d8bef9SDimitry Andric       reportUniqueWarning(
6541e8d8bef9SDimitry Andric           "cannot identify the section for relocation symbol '" +
6542e8d8bef9SDimitry Andric           (*TargetOrErr).Name + "': " + toString(SectionOrErr.takeError()));
65438bcb0991SDimitry Andric     } else if (*SectionOrErr != FunctionSec) {
6544e8d8bef9SDimitry Andric       reportUniqueWarning("relocation symbol '" + (*TargetOrErr).Name +
6545e8d8bef9SDimitry Andric                           "' is not in the expected section");
65468bcb0991SDimitry Andric       // Pretend that the symbol is in the correct section and report its
65478bcb0991SDimitry Andric       // stack size anyway.
6548e8d8bef9SDimitry Andric       FunctionSec = *SectionOrErr;
65498bcb0991SDimitry Andric     }
65508bcb0991SDimitry Andric 
6551e8d8bef9SDimitry Andric     RelocSymValue = Sym->st_value;
65528bcb0991SDimitry Andric   }
65538bcb0991SDimitry Andric 
6554e8d8bef9SDimitry Andric   uint64_t Offset = R.Offset;
6555e8d8bef9SDimitry Andric   if (!Data.isValidOffsetForDataOfSize(Offset, sizeof(Elf_Addr) + 1)) {
6556e8d8bef9SDimitry Andric     reportUniqueWarning("found invalid relocation offset (0x" +
6557e8d8bef9SDimitry Andric                         Twine::utohexstr(Offset) + ") into " +
6558e8d8bef9SDimitry Andric                         describe(StackSizeSec) +
6559e8d8bef9SDimitry Andric                         " while trying to extract a stack size entry");
6560e8d8bef9SDimitry Andric     return;
6561e8d8bef9SDimitry Andric   }
65628bcb0991SDimitry Andric 
656381ad6265SDimitry Andric   uint64_t SymValue = Resolver(R.Type, Offset, RelocSymValue,
656481ad6265SDimitry Andric                                Data.getAddress(&Offset), R.Addend.value_or(0));
6565e8d8bef9SDimitry Andric   this->printFunctionStackSize(SymValue, FunctionSec, StackSizeSec, Data,
6566e8d8bef9SDimitry Andric                                &Offset);
65678bcb0991SDimitry Andric }
65688bcb0991SDimitry Andric 
65698bcb0991SDimitry Andric template <class ELFT>
printNonRelocatableStackSizes(std::function<void ()> PrintHeader)6570e8d8bef9SDimitry Andric void ELFDumper<ELFT>::printNonRelocatableStackSizes(
6571e8d8bef9SDimitry Andric     std::function<void()> PrintHeader) {
65728bcb0991SDimitry Andric   // This function ignores potentially erroneous input, unless it is directly
65738bcb0991SDimitry Andric   // related to stack size reporting.
6574e8d8bef9SDimitry Andric   for (const Elf_Shdr &Sec : cantFail(Obj.sections())) {
6575e8d8bef9SDimitry Andric     if (this->getPrintableSectionName(Sec) != ".stack_sizes")
65768bcb0991SDimitry Andric       continue;
65778bcb0991SDimitry Andric     PrintHeader();
65788bcb0991SDimitry Andric     ArrayRef<uint8_t> Contents =
6579e8d8bef9SDimitry Andric         unwrapOrError(this->FileName, Obj.getSectionContents(Sec));
6580e8d8bef9SDimitry Andric     DataExtractor Data(Contents, Obj.isLE(), sizeof(Elf_Addr));
65818bcb0991SDimitry Andric     uint64_t Offset = 0;
65828bcb0991SDimitry Andric     while (Offset < Contents.size()) {
65838bcb0991SDimitry Andric       // The function address is followed by a ULEB representing the stack
65848bcb0991SDimitry Andric       // size. Check for an extra byte before we try to process the entry.
65858bcb0991SDimitry Andric       if (!Data.isValidOffsetForDataOfSize(Offset, sizeof(Elf_Addr) + 1)) {
6586e8d8bef9SDimitry Andric         reportUniqueWarning(
6587e8d8bef9SDimitry Andric             describe(Sec) +
6588e8d8bef9SDimitry Andric             " ended while trying to extract a stack size entry");
6589e8d8bef9SDimitry Andric         break;
65908bcb0991SDimitry Andric       }
65918bcb0991SDimitry Andric       uint64_t SymValue = Data.getAddress(&Offset);
6592bdd1243dSDimitry Andric       if (!printFunctionStackSize(SymValue, /*FunctionSec=*/std::nullopt, Sec,
6593bdd1243dSDimitry Andric                                   Data, &Offset))
6594e8d8bef9SDimitry Andric         break;
65958bcb0991SDimitry Andric     }
65968bcb0991SDimitry Andric   }
65978bcb0991SDimitry Andric }
65988bcb0991SDimitry Andric 
65998bcb0991SDimitry Andric template <class ELFT>
printRelocatableStackSizes(std::function<void ()> PrintHeader)6600fe6060f1SDimitry Andric void ELFDumper<ELFT>::printRelocatableStackSizes(
6601fe6060f1SDimitry Andric     std::function<void()> PrintHeader) {
6602fe6060f1SDimitry Andric   // Build a map between stack size sections and their corresponding relocation
6603fe6060f1SDimitry Andric   // sections.
6604fe6060f1SDimitry Andric   auto IsMatch = [&](const Elf_Shdr &Sec) -> bool {
6605fe6060f1SDimitry Andric     StringRef SectionName;
6606fe6060f1SDimitry Andric     if (Expected<StringRef> NameOrErr = Obj.getSectionName(Sec))
6607fe6060f1SDimitry Andric       SectionName = *NameOrErr;
6608fe6060f1SDimitry Andric     else
6609fe6060f1SDimitry Andric       consumeError(NameOrErr.takeError());
6610fe6060f1SDimitry Andric 
6611fe6060f1SDimitry Andric     return SectionName == ".stack_sizes";
6612fe6060f1SDimitry Andric   };
66138bcb0991SDimitry Andric 
661406c3fb27SDimitry Andric   Expected<MapVector<const Elf_Shdr *, const Elf_Shdr *>>
661506c3fb27SDimitry Andric       StackSizeRelocMapOrErr = Obj.getSectionAndRelocations(IsMatch);
661606c3fb27SDimitry Andric   if (!StackSizeRelocMapOrErr) {
661706c3fb27SDimitry Andric     reportUniqueWarning("unable to get stack size map section(s): " +
661806c3fb27SDimitry Andric                         toString(StackSizeRelocMapOrErr.takeError()));
661906c3fb27SDimitry Andric     return;
662006c3fb27SDimitry Andric   }
662106c3fb27SDimitry Andric 
662206c3fb27SDimitry Andric   for (const auto &StackSizeMapEntry : *StackSizeRelocMapOrErr) {
66238bcb0991SDimitry Andric     PrintHeader();
6624e8d8bef9SDimitry Andric     const Elf_Shdr *StackSizesELFSec = StackSizeMapEntry.first;
6625e8d8bef9SDimitry Andric     const Elf_Shdr *RelocSec = StackSizeMapEntry.second;
66268bcb0991SDimitry Andric 
66278bcb0991SDimitry Andric     // Warn about stack size sections without a relocation section.
6628e8d8bef9SDimitry Andric     if (!RelocSec) {
6629e8d8bef9SDimitry Andric       reportWarning(createError(".stack_sizes (" + describe(*StackSizesELFSec) +
6630e8d8bef9SDimitry Andric                                 ") does not have a corresponding "
66318bcb0991SDimitry Andric                                 "relocation section"),
6632e8d8bef9SDimitry Andric                     FileName);
66338bcb0991SDimitry Andric       continue;
66348bcb0991SDimitry Andric     }
66358bcb0991SDimitry Andric 
66368bcb0991SDimitry Andric     // A .stack_sizes section header's sh_link field is supposed to point
66378bcb0991SDimitry Andric     // to the section that contains the functions whose stack sizes are
66388bcb0991SDimitry Andric     // described in it.
6639e8d8bef9SDimitry Andric     const Elf_Shdr *FunctionSec = unwrapOrError(
6640e8d8bef9SDimitry Andric         this->FileName, Obj.getSection(StackSizesELFSec->sh_link));
66418bcb0991SDimitry Andric 
6642e8d8bef9SDimitry Andric     SupportsRelocation IsSupportedFn;
66438bcb0991SDimitry Andric     RelocationResolver Resolver;
6644e8d8bef9SDimitry Andric     std::tie(IsSupportedFn, Resolver) = getRelocationResolver(this->ObjF);
6645e8d8bef9SDimitry Andric     ArrayRef<uint8_t> Contents =
6646e8d8bef9SDimitry Andric         unwrapOrError(this->FileName, Obj.getSectionContents(*StackSizesELFSec));
6647e8d8bef9SDimitry Andric     DataExtractor Data(Contents, Obj.isLE(), sizeof(Elf_Addr));
6648e8d8bef9SDimitry Andric 
6649e8d8bef9SDimitry Andric     forEachRelocationDo(
6650e8d8bef9SDimitry Andric         *RelocSec, /*RawRelr=*/false,
6651e8d8bef9SDimitry Andric         [&](const Relocation<ELFT> &R, unsigned Ndx, const Elf_Shdr &Sec,
6652e8d8bef9SDimitry Andric             const Elf_Shdr *SymTab) {
6653e8d8bef9SDimitry Andric           if (!IsSupportedFn || !IsSupportedFn(R.Type)) {
6654e8d8bef9SDimitry Andric             reportUniqueWarning(
6655e8d8bef9SDimitry Andric                 describe(*RelocSec) +
6656e8d8bef9SDimitry Andric                 " contains an unsupported relocation with index " + Twine(Ndx) +
6657e8d8bef9SDimitry Andric                 ": " + Obj.getRelocationTypeName(R.Type));
6658e8d8bef9SDimitry Andric             return;
66598bcb0991SDimitry Andric           }
6660e8d8bef9SDimitry Andric 
6661e8d8bef9SDimitry Andric           this->printStackSize(R, *RelocSec, Ndx, SymTab, FunctionSec,
6662e8d8bef9SDimitry Andric                                *StackSizesELFSec, Resolver, Data);
6663e8d8bef9SDimitry Andric         },
6664e8d8bef9SDimitry Andric         [](const Elf_Relr &) {
6665e8d8bef9SDimitry Andric           llvm_unreachable("can't get here, because we only support "
6666e8d8bef9SDimitry Andric                            "SHT_REL/SHT_RELA sections");
6667e8d8bef9SDimitry Andric         });
66688bcb0991SDimitry Andric   }
66698bcb0991SDimitry Andric }
66708bcb0991SDimitry Andric 
66718bcb0991SDimitry Andric template <class ELFT>
printStackSizes()6672e8d8bef9SDimitry Andric void GNUELFDumper<ELFT>::printStackSizes() {
66738bcb0991SDimitry Andric   bool HeaderHasBeenPrinted = false;
66748bcb0991SDimitry Andric   auto PrintHeader = [&]() {
66758bcb0991SDimitry Andric     if (HeaderHasBeenPrinted)
66768bcb0991SDimitry Andric       return;
66778bcb0991SDimitry Andric     OS << "\nStack Sizes:\n";
66788bcb0991SDimitry Andric     OS.PadToColumn(9);
66798bcb0991SDimitry Andric     OS << "Size";
66808bcb0991SDimitry Andric     OS.PadToColumn(18);
6681fe6060f1SDimitry Andric     OS << "Functions\n";
66828bcb0991SDimitry Andric     HeaderHasBeenPrinted = true;
66838bcb0991SDimitry Andric   };
66848bcb0991SDimitry Andric 
66858bcb0991SDimitry Andric   // For non-relocatable objects, look directly for sections whose name starts
66868bcb0991SDimitry Andric   // with .stack_sizes and process the contents.
6687e8d8bef9SDimitry Andric   if (this->Obj.getHeader().e_type == ELF::ET_REL)
6688e8d8bef9SDimitry Andric     this->printRelocatableStackSizes(PrintHeader);
66898bcb0991SDimitry Andric   else
6690e8d8bef9SDimitry Andric     this->printNonRelocatableStackSizes(PrintHeader);
66918bcb0991SDimitry Andric }
66928bcb0991SDimitry Andric 
66930b57cec5SDimitry Andric template <class ELFT>
printMipsGOT(const MipsGOTParser<ELFT> & Parser)6694e8d8bef9SDimitry Andric void GNUELFDumper<ELFT>::printMipsGOT(const MipsGOTParser<ELFT> &Parser) {
66950b57cec5SDimitry Andric   size_t Bias = ELFT::Is64Bits ? 8 : 0;
66960b57cec5SDimitry Andric   auto PrintEntry = [&](const Elf_Addr *E, StringRef Purpose) {
66970b57cec5SDimitry Andric     OS.PadToColumn(2);
66980b57cec5SDimitry Andric     OS << format_hex_no_prefix(Parser.getGotAddress(E), 8 + Bias);
66990b57cec5SDimitry Andric     OS.PadToColumn(11 + Bias);
67000b57cec5SDimitry Andric     OS << format_decimal(Parser.getGotOffset(E), 6) << "(gp)";
67010b57cec5SDimitry Andric     OS.PadToColumn(22 + Bias);
67020b57cec5SDimitry Andric     OS << format_hex_no_prefix(*E, 8 + Bias);
67030b57cec5SDimitry Andric     OS.PadToColumn(31 + 2 * Bias);
67040b57cec5SDimitry Andric     OS << Purpose << "\n";
67050b57cec5SDimitry Andric   };
67060b57cec5SDimitry Andric 
67070b57cec5SDimitry Andric   OS << (Parser.IsStatic ? "Static GOT:\n" : "Primary GOT:\n");
67080b57cec5SDimitry Andric   OS << " Canonical gp value: "
67090b57cec5SDimitry Andric      << format_hex_no_prefix(Parser.getGp(), 8 + Bias) << "\n\n";
67100b57cec5SDimitry Andric 
67110b57cec5SDimitry Andric   OS << " Reserved entries:\n";
67120b57cec5SDimitry Andric   if (ELFT::Is64Bits)
67130b57cec5SDimitry Andric     OS << "           Address     Access          Initial Purpose\n";
67140b57cec5SDimitry Andric   else
67150b57cec5SDimitry Andric     OS << "   Address     Access  Initial Purpose\n";
67160b57cec5SDimitry Andric   PrintEntry(Parser.getGotLazyResolver(), "Lazy resolver");
67170b57cec5SDimitry Andric   if (Parser.getGotModulePointer())
67180b57cec5SDimitry Andric     PrintEntry(Parser.getGotModulePointer(), "Module pointer (GNU extension)");
67190b57cec5SDimitry Andric 
67200b57cec5SDimitry Andric   if (!Parser.getLocalEntries().empty()) {
67210b57cec5SDimitry Andric     OS << "\n";
67220b57cec5SDimitry Andric     OS << " Local entries:\n";
67230b57cec5SDimitry Andric     if (ELFT::Is64Bits)
67240b57cec5SDimitry Andric       OS << "           Address     Access          Initial\n";
67250b57cec5SDimitry Andric     else
67260b57cec5SDimitry Andric       OS << "   Address     Access  Initial\n";
67270b57cec5SDimitry Andric     for (auto &E : Parser.getLocalEntries())
67280b57cec5SDimitry Andric       PrintEntry(&E, "");
67290b57cec5SDimitry Andric   }
67300b57cec5SDimitry Andric 
67310b57cec5SDimitry Andric   if (Parser.IsStatic)
67320b57cec5SDimitry Andric     return;
67330b57cec5SDimitry Andric 
67340b57cec5SDimitry Andric   if (!Parser.getGlobalEntries().empty()) {
67350b57cec5SDimitry Andric     OS << "\n";
67360b57cec5SDimitry Andric     OS << " Global entries:\n";
67370b57cec5SDimitry Andric     if (ELFT::Is64Bits)
67380b57cec5SDimitry Andric       OS << "           Address     Access          Initial         Sym.Val."
67390b57cec5SDimitry Andric          << " Type    Ndx Name\n";
67400b57cec5SDimitry Andric     else
67410b57cec5SDimitry Andric       OS << "   Address     Access  Initial Sym.Val. Type    Ndx Name\n";
6742e8d8bef9SDimitry Andric 
6743e8d8bef9SDimitry Andric     DataRegion<Elf_Word> ShndxTable(
6744e8d8bef9SDimitry Andric         (const Elf_Word *)this->DynSymTabShndxRegion.Addr, this->Obj.end());
67450b57cec5SDimitry Andric     for (auto &E : Parser.getGlobalEntries()) {
6746e8d8bef9SDimitry Andric       const Elf_Sym &Sym = *Parser.getGotSym(&E);
6747e8d8bef9SDimitry Andric       const Elf_Sym &FirstSym = this->dynamic_symbols()[0];
6748e8d8bef9SDimitry Andric       std::string SymName = this->getFullSymbolName(
6749e8d8bef9SDimitry Andric           Sym, &Sym - &FirstSym, ShndxTable, this->DynamicStringTable, false);
67500b57cec5SDimitry Andric 
67510b57cec5SDimitry Andric       OS.PadToColumn(2);
67520b57cec5SDimitry Andric       OS << to_string(format_hex_no_prefix(Parser.getGotAddress(&E), 8 + Bias));
67530b57cec5SDimitry Andric       OS.PadToColumn(11 + Bias);
67540b57cec5SDimitry Andric       OS << to_string(format_decimal(Parser.getGotOffset(&E), 6)) + "(gp)";
67550b57cec5SDimitry Andric       OS.PadToColumn(22 + Bias);
67560b57cec5SDimitry Andric       OS << to_string(format_hex_no_prefix(E, 8 + Bias));
67570b57cec5SDimitry Andric       OS.PadToColumn(31 + 2 * Bias);
6758e8d8bef9SDimitry Andric       OS << to_string(format_hex_no_prefix(Sym.st_value, 8 + Bias));
67590b57cec5SDimitry Andric       OS.PadToColumn(40 + 3 * Bias);
6760bdd1243dSDimitry Andric       OS << enumToString(Sym.getType(), ArrayRef(ElfSymbolTypes));
67610b57cec5SDimitry Andric       OS.PadToColumn(48 + 3 * Bias);
6762e8d8bef9SDimitry Andric       OS << getSymbolSectionNdx(Sym, &Sym - this->dynamic_symbols().begin(),
6763e8d8bef9SDimitry Andric                                 ShndxTable);
67640b57cec5SDimitry Andric       OS.PadToColumn(52 + 3 * Bias);
67650b57cec5SDimitry Andric       OS << SymName << "\n";
67660b57cec5SDimitry Andric     }
67670b57cec5SDimitry Andric   }
67680b57cec5SDimitry Andric 
67690b57cec5SDimitry Andric   if (!Parser.getOtherEntries().empty())
67700b57cec5SDimitry Andric     OS << "\n Number of TLS and multi-GOT entries "
67710b57cec5SDimitry Andric        << Parser.getOtherEntries().size() << "\n";
67720b57cec5SDimitry Andric }
67730b57cec5SDimitry Andric 
67740b57cec5SDimitry Andric template <class ELFT>
printMipsPLT(const MipsGOTParser<ELFT> & Parser)6775e8d8bef9SDimitry Andric void GNUELFDumper<ELFT>::printMipsPLT(const MipsGOTParser<ELFT> &Parser) {
67760b57cec5SDimitry Andric   size_t Bias = ELFT::Is64Bits ? 8 : 0;
67770b57cec5SDimitry Andric   auto PrintEntry = [&](const Elf_Addr *E, StringRef Purpose) {
67780b57cec5SDimitry Andric     OS.PadToColumn(2);
67790b57cec5SDimitry Andric     OS << format_hex_no_prefix(Parser.getPltAddress(E), 8 + Bias);
67800b57cec5SDimitry Andric     OS.PadToColumn(11 + Bias);
67810b57cec5SDimitry Andric     OS << format_hex_no_prefix(*E, 8 + Bias);
67820b57cec5SDimitry Andric     OS.PadToColumn(20 + 2 * Bias);
67830b57cec5SDimitry Andric     OS << Purpose << "\n";
67840b57cec5SDimitry Andric   };
67850b57cec5SDimitry Andric 
67860b57cec5SDimitry Andric   OS << "PLT GOT:\n\n";
67870b57cec5SDimitry Andric 
67880b57cec5SDimitry Andric   OS << " Reserved entries:\n";
67890b57cec5SDimitry Andric   OS << "   Address  Initial Purpose\n";
67900b57cec5SDimitry Andric   PrintEntry(Parser.getPltLazyResolver(), "PLT lazy resolver");
67910b57cec5SDimitry Andric   if (Parser.getPltModulePointer())
67920b57cec5SDimitry Andric     PrintEntry(Parser.getPltModulePointer(), "Module pointer");
67930b57cec5SDimitry Andric 
67940b57cec5SDimitry Andric   if (!Parser.getPltEntries().empty()) {
67950b57cec5SDimitry Andric     OS << "\n";
67960b57cec5SDimitry Andric     OS << " Entries:\n";
67970b57cec5SDimitry Andric     OS << "   Address  Initial Sym.Val. Type    Ndx Name\n";
6798e8d8bef9SDimitry Andric     DataRegion<Elf_Word> ShndxTable(
6799e8d8bef9SDimitry Andric         (const Elf_Word *)this->DynSymTabShndxRegion.Addr, this->Obj.end());
68000b57cec5SDimitry Andric     for (auto &E : Parser.getPltEntries()) {
6801e8d8bef9SDimitry Andric       const Elf_Sym &Sym = *Parser.getPltSym(&E);
6802e8d8bef9SDimitry Andric       const Elf_Sym &FirstSym = *cantFail(
6803e8d8bef9SDimitry Andric           this->Obj.template getEntry<Elf_Sym>(*Parser.getPltSymTable(), 0));
6804e8d8bef9SDimitry Andric       std::string SymName = this->getFullSymbolName(
6805e8d8bef9SDimitry Andric           Sym, &Sym - &FirstSym, ShndxTable, this->DynamicStringTable, false);
68060b57cec5SDimitry Andric 
68070b57cec5SDimitry Andric       OS.PadToColumn(2);
68080b57cec5SDimitry Andric       OS << to_string(format_hex_no_prefix(Parser.getPltAddress(&E), 8 + Bias));
68090b57cec5SDimitry Andric       OS.PadToColumn(11 + Bias);
68100b57cec5SDimitry Andric       OS << to_string(format_hex_no_prefix(E, 8 + Bias));
68110b57cec5SDimitry Andric       OS.PadToColumn(20 + 2 * Bias);
6812e8d8bef9SDimitry Andric       OS << to_string(format_hex_no_prefix(Sym.st_value, 8 + Bias));
68130b57cec5SDimitry Andric       OS.PadToColumn(29 + 3 * Bias);
6814bdd1243dSDimitry Andric       OS << enumToString(Sym.getType(), ArrayRef(ElfSymbolTypes));
68150b57cec5SDimitry Andric       OS.PadToColumn(37 + 3 * Bias);
6816e8d8bef9SDimitry Andric       OS << getSymbolSectionNdx(Sym, &Sym - this->dynamic_symbols().begin(),
6817e8d8bef9SDimitry Andric                                 ShndxTable);
68180b57cec5SDimitry Andric       OS.PadToColumn(41 + 3 * Bias);
68190b57cec5SDimitry Andric       OS << SymName << "\n";
68200b57cec5SDimitry Andric     }
68210b57cec5SDimitry Andric   }
68220b57cec5SDimitry Andric }
68230b57cec5SDimitry Andric 
68248bcb0991SDimitry Andric template <class ELFT>
6825e8d8bef9SDimitry Andric Expected<const Elf_Mips_ABIFlags<ELFT> *>
getMipsAbiFlagsSection(const ELFDumper<ELFT> & Dumper)6826e8d8bef9SDimitry Andric getMipsAbiFlagsSection(const ELFDumper<ELFT> &Dumper) {
6827e8d8bef9SDimitry Andric   const typename ELFT::Shdr *Sec = Dumper.findSectionByName(".MIPS.abiflags");
6828e8d8bef9SDimitry Andric   if (Sec == nullptr)
6829e8d8bef9SDimitry Andric     return nullptr;
6830e8d8bef9SDimitry Andric 
6831e8d8bef9SDimitry Andric   constexpr StringRef ErrPrefix = "unable to read the .MIPS.abiflags section: ";
6832e8d8bef9SDimitry Andric   Expected<ArrayRef<uint8_t>> DataOrErr =
6833e8d8bef9SDimitry Andric       Dumper.getElfObject().getELFFile().getSectionContents(*Sec);
6834e8d8bef9SDimitry Andric   if (!DataOrErr)
6835e8d8bef9SDimitry Andric     return createError(ErrPrefix + toString(DataOrErr.takeError()));
6836e8d8bef9SDimitry Andric 
6837e8d8bef9SDimitry Andric   if (DataOrErr->size() != sizeof(Elf_Mips_ABIFlags<ELFT>))
6838e8d8bef9SDimitry Andric     return createError(ErrPrefix + "it has a wrong size (" +
6839e8d8bef9SDimitry Andric         Twine(DataOrErr->size()) + ")");
6840e8d8bef9SDimitry Andric   return reinterpret_cast<const Elf_Mips_ABIFlags<ELFT> *>(DataOrErr->data());
6841e8d8bef9SDimitry Andric }
6842e8d8bef9SDimitry Andric 
printMipsABIFlags()6843e8d8bef9SDimitry Andric template <class ELFT> void GNUELFDumper<ELFT>::printMipsABIFlags() {
6844e8d8bef9SDimitry Andric   const Elf_Mips_ABIFlags<ELFT> *Flags = nullptr;
6845e8d8bef9SDimitry Andric   if (Expected<const Elf_Mips_ABIFlags<ELFT> *> SecOrErr =
6846e8d8bef9SDimitry Andric           getMipsAbiFlagsSection(*this))
6847e8d8bef9SDimitry Andric     Flags = *SecOrErr;
6848e8d8bef9SDimitry Andric   else
6849e8d8bef9SDimitry Andric     this->reportUniqueWarning(SecOrErr.takeError());
6850e8d8bef9SDimitry Andric   if (!Flags)
68518bcb0991SDimitry Andric     return;
68528bcb0991SDimitry Andric 
68538bcb0991SDimitry Andric   OS << "MIPS ABI Flags Version: " << Flags->version << "\n\n";
68548bcb0991SDimitry Andric   OS << "ISA: MIPS" << int(Flags->isa_level);
68558bcb0991SDimitry Andric   if (Flags->isa_rev > 1)
68568bcb0991SDimitry Andric     OS << "r" << int(Flags->isa_rev);
68578bcb0991SDimitry Andric   OS << "\n";
68588bcb0991SDimitry Andric   OS << "GPR size: " << getMipsRegisterSize(Flags->gpr_size) << "\n";
68598bcb0991SDimitry Andric   OS << "CPR1 size: " << getMipsRegisterSize(Flags->cpr1_size) << "\n";
68608bcb0991SDimitry Andric   OS << "CPR2 size: " << getMipsRegisterSize(Flags->cpr2_size) << "\n";
6861bdd1243dSDimitry Andric   OS << "FP ABI: " << enumToString(Flags->fp_abi, ArrayRef(ElfMipsFpABIType))
6862bdd1243dSDimitry Andric      << "\n";
68638bcb0991SDimitry Andric   OS << "ISA Extension: "
6864bdd1243dSDimitry Andric      << enumToString(Flags->isa_ext, ArrayRef(ElfMipsISAExtType)) << "\n";
68658bcb0991SDimitry Andric   if (Flags->ases == 0)
68668bcb0991SDimitry Andric     OS << "ASEs: None\n";
68678bcb0991SDimitry Andric   else
68688bcb0991SDimitry Andric     // FIXME: Print each flag on a separate line.
6869bdd1243dSDimitry Andric     OS << "ASEs: " << printFlags(Flags->ases, ArrayRef(ElfMipsASEFlags))
68708bcb0991SDimitry Andric        << "\n";
68718bcb0991SDimitry Andric   OS << "FLAGS 1: " << format_hex_no_prefix(Flags->flags1, 8, false) << "\n";
68728bcb0991SDimitry Andric   OS << "FLAGS 2: " << format_hex_no_prefix(Flags->flags2, 8, false) << "\n";
68738bcb0991SDimitry Andric   OS << "\n";
68748bcb0991SDimitry Andric }
68758bcb0991SDimitry Andric 
printFileHeaders()6876e8d8bef9SDimitry Andric template <class ELFT> void LLVMELFDumper<ELFT>::printFileHeaders() {
6877e8d8bef9SDimitry Andric   const Elf_Ehdr &E = this->Obj.getHeader();
68780b57cec5SDimitry Andric   {
68790b57cec5SDimitry Andric     DictScope D(W, "ElfHeader");
68800b57cec5SDimitry Andric     {
68810b57cec5SDimitry Andric       DictScope D(W, "Ident");
6882bdd1243dSDimitry Andric       W.printBinary("Magic",
6883bdd1243dSDimitry Andric                     ArrayRef<unsigned char>(E.e_ident).slice(ELF::EI_MAG0, 4));
6884bdd1243dSDimitry Andric       W.printEnum("Class", E.e_ident[ELF::EI_CLASS], ArrayRef(ElfClass));
6885e8d8bef9SDimitry Andric       W.printEnum("DataEncoding", E.e_ident[ELF::EI_DATA],
6886bdd1243dSDimitry Andric                   ArrayRef(ElfDataEncoding));
6887e8d8bef9SDimitry Andric       W.printNumber("FileVersion", E.e_ident[ELF::EI_VERSION]);
68880b57cec5SDimitry Andric 
6889bdd1243dSDimitry Andric       auto OSABI = ArrayRef(ElfOSABI);
6890e8d8bef9SDimitry Andric       if (E.e_ident[ELF::EI_OSABI] >= ELF::ELFOSABI_FIRST_ARCH &&
6891e8d8bef9SDimitry Andric           E.e_ident[ELF::EI_OSABI] <= ELF::ELFOSABI_LAST_ARCH) {
6892e8d8bef9SDimitry Andric         switch (E.e_machine) {
68930b57cec5SDimitry Andric         case ELF::EM_AMDGPU:
6894bdd1243dSDimitry Andric           OSABI = ArrayRef(AMDGPUElfOSABI);
68950b57cec5SDimitry Andric           break;
68960b57cec5SDimitry Andric         case ELF::EM_ARM:
6897bdd1243dSDimitry Andric           OSABI = ArrayRef(ARMElfOSABI);
68980b57cec5SDimitry Andric           break;
68990b57cec5SDimitry Andric         case ELF::EM_TI_C6000:
6900bdd1243dSDimitry Andric           OSABI = ArrayRef(C6000ElfOSABI);
69010b57cec5SDimitry Andric           break;
69020b57cec5SDimitry Andric         }
69030b57cec5SDimitry Andric       }
6904e8d8bef9SDimitry Andric       W.printEnum("OS/ABI", E.e_ident[ELF::EI_OSABI], OSABI);
6905e8d8bef9SDimitry Andric       W.printNumber("ABIVersion", E.e_ident[ELF::EI_ABIVERSION]);
6906bdd1243dSDimitry Andric       W.printBinary("Unused",
6907bdd1243dSDimitry Andric                     ArrayRef<unsigned char>(E.e_ident).slice(ELF::EI_PAD));
69080b57cec5SDimitry Andric     }
69090b57cec5SDimitry Andric 
6910e8d8bef9SDimitry Andric     std::string TypeStr;
6911e8d8bef9SDimitry Andric     if (const EnumEntry<unsigned> *Ent = getObjectFileEnumEntry(E.e_type)) {
6912e8d8bef9SDimitry Andric       TypeStr = Ent->Name.str();
6913e8d8bef9SDimitry Andric     } else {
6914e8d8bef9SDimitry Andric       if (E.e_type >= ET_LOPROC)
6915e8d8bef9SDimitry Andric         TypeStr = "Processor Specific";
6916e8d8bef9SDimitry Andric       else if (E.e_type >= ET_LOOS)
6917e8d8bef9SDimitry Andric         TypeStr = "OS Specific";
6918e8d8bef9SDimitry Andric       else
6919e8d8bef9SDimitry Andric         TypeStr = "Unknown";
6920e8d8bef9SDimitry Andric     }
692181ad6265SDimitry Andric     W.printString("Type", TypeStr + " (0x" + utohexstr(E.e_type) + ")");
6922e8d8bef9SDimitry Andric 
6923bdd1243dSDimitry Andric     W.printEnum("Machine", E.e_machine, ArrayRef(ElfMachineType));
6924e8d8bef9SDimitry Andric     W.printNumber("Version", E.e_version);
6925e8d8bef9SDimitry Andric     W.printHex("Entry", E.e_entry);
6926e8d8bef9SDimitry Andric     W.printHex("ProgramHeaderOffset", E.e_phoff);
6927e8d8bef9SDimitry Andric     W.printHex("SectionHeaderOffset", E.e_shoff);
6928e8d8bef9SDimitry Andric     if (E.e_machine == EM_MIPS)
6929bdd1243dSDimitry Andric       W.printFlags("Flags", E.e_flags, ArrayRef(ElfHeaderMipsFlags),
69300b57cec5SDimitry Andric                    unsigned(ELF::EF_MIPS_ARCH), unsigned(ELF::EF_MIPS_ABI),
69310b57cec5SDimitry Andric                    unsigned(ELF::EF_MIPS_MACH));
6932fe6060f1SDimitry Andric     else if (E.e_machine == EM_AMDGPU) {
6933fe6060f1SDimitry Andric       switch (E.e_ident[ELF::EI_ABIVERSION]) {
6934fe6060f1SDimitry Andric       default:
6935fe6060f1SDimitry Andric         W.printHex("Flags", E.e_flags);
6936fe6060f1SDimitry Andric         break;
6937fe6060f1SDimitry Andric       case 0:
6938fe6060f1SDimitry Andric         // ELFOSABI_AMDGPU_PAL, ELFOSABI_AMDGPU_MESA3D support *_V3 flags.
6939bdd1243dSDimitry Andric         [[fallthrough]];
6940fe6060f1SDimitry Andric       case ELF::ELFABIVERSION_AMDGPU_HSA_V3:
6941fe6060f1SDimitry Andric         W.printFlags("Flags", E.e_flags,
6942bdd1243dSDimitry Andric                      ArrayRef(ElfHeaderAMDGPUFlagsABIVersion3),
69430b57cec5SDimitry Andric                      unsigned(ELF::EF_AMDGPU_MACH));
6944fe6060f1SDimitry Andric         break;
6945fe6060f1SDimitry Andric       case ELF::ELFABIVERSION_AMDGPU_HSA_V4:
69461fd87a68SDimitry Andric       case ELF::ELFABIVERSION_AMDGPU_HSA_V5:
6947fe6060f1SDimitry Andric         W.printFlags("Flags", E.e_flags,
6948bdd1243dSDimitry Andric                      ArrayRef(ElfHeaderAMDGPUFlagsABIVersion4),
6949fe6060f1SDimitry Andric                      unsigned(ELF::EF_AMDGPU_MACH),
6950fe6060f1SDimitry Andric                      unsigned(ELF::EF_AMDGPU_FEATURE_XNACK_V4),
6951fe6060f1SDimitry Andric                      unsigned(ELF::EF_AMDGPU_FEATURE_SRAMECC_V4));
6952fe6060f1SDimitry Andric         break;
6953fe6060f1SDimitry Andric       }
6954fe6060f1SDimitry Andric     } else if (E.e_machine == EM_RISCV)
6955bdd1243dSDimitry Andric       W.printFlags("Flags", E.e_flags, ArrayRef(ElfHeaderRISCVFlags));
6956fe6060f1SDimitry Andric     else if (E.e_machine == EM_AVR)
6957bdd1243dSDimitry Andric       W.printFlags("Flags", E.e_flags, ArrayRef(ElfHeaderAVRFlags),
6958fe6060f1SDimitry Andric                    unsigned(ELF::EF_AVR_ARCH_MASK));
6959972a253aSDimitry Andric     else if (E.e_machine == EM_LOONGARCH)
6960bdd1243dSDimitry Andric       W.printFlags("Flags", E.e_flags, ArrayRef(ElfHeaderLoongArchFlags),
6961bdd1243dSDimitry Andric                    unsigned(ELF::EF_LOONGARCH_ABI_MODIFIER_MASK),
6962bdd1243dSDimitry Andric                    unsigned(ELF::EF_LOONGARCH_OBJABI_MASK));
6963bdd1243dSDimitry Andric     else if (E.e_machine == EM_XTENSA)
6964bdd1243dSDimitry Andric       W.printFlags("Flags", E.e_flags, ArrayRef(ElfHeaderXtensaFlags),
6965bdd1243dSDimitry Andric                    unsigned(ELF::EF_XTENSA_MACH));
69665f757f3fSDimitry Andric     else if (E.e_machine == EM_CUDA)
69675f757f3fSDimitry Andric       W.printFlags("Flags", E.e_flags, ArrayRef(ElfHeaderNVPTXFlags),
69685f757f3fSDimitry Andric                    unsigned(ELF::EF_CUDA_SM));
69690b57cec5SDimitry Andric     else
6970e8d8bef9SDimitry Andric       W.printFlags("Flags", E.e_flags);
6971e8d8bef9SDimitry Andric     W.printNumber("HeaderSize", E.e_ehsize);
6972e8d8bef9SDimitry Andric     W.printNumber("ProgramHeaderEntrySize", E.e_phentsize);
6973e8d8bef9SDimitry Andric     W.printNumber("ProgramHeaderCount", E.e_phnum);
6974e8d8bef9SDimitry Andric     W.printNumber("SectionHeaderEntrySize", E.e_shentsize);
69758bcb0991SDimitry Andric     W.printString("SectionHeaderCount",
6976e8d8bef9SDimitry Andric                   getSectionHeadersNumString(this->Obj, this->FileName));
69770b57cec5SDimitry Andric     W.printString("StringTableSectionIndex",
6978e8d8bef9SDimitry Andric                   getSectionHeaderTableIndexString(this->Obj, this->FileName));
69790b57cec5SDimitry Andric   }
69800b57cec5SDimitry Andric }
69810b57cec5SDimitry Andric 
printGroupSections()6982e8d8bef9SDimitry Andric template <class ELFT> void LLVMELFDumper<ELFT>::printGroupSections() {
69830b57cec5SDimitry Andric   DictScope Lists(W, "Groups");
6984e8d8bef9SDimitry Andric   std::vector<GroupSection> V = this->getGroups();
69850b57cec5SDimitry Andric   DenseMap<uint64_t, const GroupSection *> Map = mapSectionsToGroups(V);
69860b57cec5SDimitry Andric   for (const GroupSection &G : V) {
69870b57cec5SDimitry Andric     DictScope D(W, "Group");
69880b57cec5SDimitry Andric     W.printNumber("Name", G.Name, G.ShName);
69890b57cec5SDimitry Andric     W.printNumber("Index", G.Index);
69900b57cec5SDimitry Andric     W.printNumber("Link", G.Link);
69910b57cec5SDimitry Andric     W.printNumber("Info", G.Info);
69920b57cec5SDimitry Andric     W.printHex("Type", getGroupType(G.Type), G.Type);
699306c3fb27SDimitry Andric     W.printString("Signature", G.Signature);
69940b57cec5SDimitry Andric 
699506c3fb27SDimitry Andric     ListScope L(W, getGroupSectionHeaderName());
69960b57cec5SDimitry Andric     for (const GroupMember &GM : G.Members) {
69970b57cec5SDimitry Andric       const GroupSection *MainGroup = Map[GM.Index];
6998e8d8bef9SDimitry Andric       if (MainGroup != &G)
6999e8d8bef9SDimitry Andric         this->reportUniqueWarning(
7000e8d8bef9SDimitry Andric             "section with index " + Twine(GM.Index) +
7001e8d8bef9SDimitry Andric             ", included in the group section with index " +
7002e8d8bef9SDimitry Andric             Twine(MainGroup->Index) +
7003e8d8bef9SDimitry Andric             ", was also found in the group section with index " +
7004e8d8bef9SDimitry Andric             Twine(G.Index));
700506c3fb27SDimitry Andric       printSectionGroupMembers(GM.Name, GM.Index);
70060b57cec5SDimitry Andric     }
70070b57cec5SDimitry Andric   }
70080b57cec5SDimitry Andric 
70090b57cec5SDimitry Andric   if (V.empty())
701006c3fb27SDimitry Andric     printEmptyGroupMessage();
701106c3fb27SDimitry Andric }
701206c3fb27SDimitry Andric 
701306c3fb27SDimitry Andric template <class ELFT>
getGroupSectionHeaderName() const701406c3fb27SDimitry Andric std::string LLVMELFDumper<ELFT>::getGroupSectionHeaderName() const {
701506c3fb27SDimitry Andric   return "Section(s) in group";
701606c3fb27SDimitry Andric }
701706c3fb27SDimitry Andric 
701806c3fb27SDimitry Andric template <class ELFT>
printSectionGroupMembers(StringRef Name,uint64_t Idx) const701906c3fb27SDimitry Andric void LLVMELFDumper<ELFT>::printSectionGroupMembers(StringRef Name,
702006c3fb27SDimitry Andric                                                    uint64_t Idx) const {
702106c3fb27SDimitry Andric   W.startLine() << Name << " (" << Idx << ")\n";
70220b57cec5SDimitry Andric }
70230b57cec5SDimitry Andric 
printRelocations()7024e8d8bef9SDimitry Andric template <class ELFT> void LLVMELFDumper<ELFT>::printRelocations() {
70250b57cec5SDimitry Andric   ListScope D(W, "Relocations");
70260b57cec5SDimitry Andric 
7027e8d8bef9SDimitry Andric   for (const Elf_Shdr &Sec : cantFail(this->Obj.sections())) {
70285f757f3fSDimitry Andric     if (!isRelocationSec<ELFT>(Sec, this->Obj.getHeader()))
70290b57cec5SDimitry Andric       continue;
70300b57cec5SDimitry Andric 
7031e8d8bef9SDimitry Andric     StringRef Name = this->getPrintableSectionName(Sec);
7032e8d8bef9SDimitry Andric     unsigned SecNdx = &Sec - &cantFail(this->Obj.sections()).front();
703306c3fb27SDimitry Andric     printRelocationSectionInfo(Sec, Name, SecNdx);
70340b57cec5SDimitry Andric   }
70350b57cec5SDimitry Andric }
70360b57cec5SDimitry Andric 
70370b57cec5SDimitry Andric template <class ELFT>
printRelrReloc(const Elf_Relr & R)7038e8d8bef9SDimitry Andric void LLVMELFDumper<ELFT>::printRelrReloc(const Elf_Relr &R) {
70390b57cec5SDimitry Andric   W.startLine() << W.hex(R) << "\n";
70400b57cec5SDimitry Andric }
70410b57cec5SDimitry Andric 
70420b57cec5SDimitry Andric template <class ELFT>
printExpandedRelRelaReloc(const Relocation<ELFT> & R,StringRef SymbolName,StringRef RelocName)704306c3fb27SDimitry Andric void LLVMELFDumper<ELFT>::printExpandedRelRelaReloc(const Relocation<ELFT> &R,
704406c3fb27SDimitry Andric                                                     StringRef SymbolName,
704506c3fb27SDimitry Andric                                                     StringRef RelocName) {
70460b57cec5SDimitry Andric   DictScope Group(W, "Relocation");
7047e8d8bef9SDimitry Andric   W.printHex("Offset", R.Offset);
7048e8d8bef9SDimitry Andric   W.printNumber("Type", RelocName, R.Type);
7049e8d8bef9SDimitry Andric   W.printNumber("Symbol", !SymbolName.empty() ? SymbolName : "-", R.Symbol);
7050e8d8bef9SDimitry Andric   if (R.Addend)
7051e8d8bef9SDimitry Andric     W.printHex("Addend", (uintX_t)*R.Addend);
705206c3fb27SDimitry Andric }
705306c3fb27SDimitry Andric 
705406c3fb27SDimitry Andric template <class ELFT>
printDefaultRelRelaReloc(const Relocation<ELFT> & R,StringRef SymbolName,StringRef RelocName)705506c3fb27SDimitry Andric void LLVMELFDumper<ELFT>::printDefaultRelRelaReloc(const Relocation<ELFT> &R,
705606c3fb27SDimitry Andric                                                    StringRef SymbolName,
705706c3fb27SDimitry Andric                                                    StringRef RelocName) {
70580b57cec5SDimitry Andric   raw_ostream &OS = W.startLine();
7059e8d8bef9SDimitry Andric   OS << W.hex(R.Offset) << " " << RelocName << " "
7060e8d8bef9SDimitry Andric      << (!SymbolName.empty() ? SymbolName : "-");
7061e8d8bef9SDimitry Andric   if (R.Addend)
7062e8d8bef9SDimitry Andric     OS << " " << W.hex((uintX_t)*R.Addend);
7063e8d8bef9SDimitry Andric   OS << "\n";
70640b57cec5SDimitry Andric }
706506c3fb27SDimitry Andric 
706606c3fb27SDimitry Andric template <class ELFT>
printRelocationSectionInfo(const Elf_Shdr & Sec,StringRef Name,const unsigned SecNdx)706706c3fb27SDimitry Andric void LLVMELFDumper<ELFT>::printRelocationSectionInfo(const Elf_Shdr &Sec,
706806c3fb27SDimitry Andric                                                      StringRef Name,
706906c3fb27SDimitry Andric                                                      const unsigned SecNdx) {
707006c3fb27SDimitry Andric   DictScope D(W, (Twine("Section (") + Twine(SecNdx) + ") " + Name).str());
707106c3fb27SDimitry Andric   this->printRelocationsHelper(Sec);
707206c3fb27SDimitry Andric }
707306c3fb27SDimitry Andric 
printEmptyGroupMessage() const707406c3fb27SDimitry Andric template <class ELFT> void LLVMELFDumper<ELFT>::printEmptyGroupMessage() const {
707506c3fb27SDimitry Andric   W.startLine() << "There are no group sections in the file.\n";
707606c3fb27SDimitry Andric }
707706c3fb27SDimitry Andric 
707806c3fb27SDimitry Andric template <class ELFT>
printRelRelaReloc(const Relocation<ELFT> & R,const RelSymbol<ELFT> & RelSym)707906c3fb27SDimitry Andric void LLVMELFDumper<ELFT>::printRelRelaReloc(const Relocation<ELFT> &R,
708006c3fb27SDimitry Andric                                             const RelSymbol<ELFT> &RelSym) {
708106c3fb27SDimitry Andric   StringRef SymbolName = RelSym.Name;
708206c3fb27SDimitry Andric   if (RelSym.Sym && RelSym.Name.empty())
708306c3fb27SDimitry Andric     SymbolName = "<null>";
708406c3fb27SDimitry Andric   SmallString<32> RelocName;
708506c3fb27SDimitry Andric   this->Obj.getRelocationTypeName(R.Type, RelocName);
708606c3fb27SDimitry Andric 
708706c3fb27SDimitry Andric   if (opts::ExpandRelocs) {
708806c3fb27SDimitry Andric     printExpandedRelRelaReloc(R, SymbolName, RelocName);
708906c3fb27SDimitry Andric   } else {
709006c3fb27SDimitry Andric     printDefaultRelRelaReloc(R, SymbolName, RelocName);
709106c3fb27SDimitry Andric   }
70920b57cec5SDimitry Andric }
70930b57cec5SDimitry Andric 
printSectionHeaders()7094e8d8bef9SDimitry Andric template <class ELFT> void LLVMELFDumper<ELFT>::printSectionHeaders() {
70950b57cec5SDimitry Andric   ListScope SectionsD(W, "Sections");
70960b57cec5SDimitry Andric 
70970b57cec5SDimitry Andric   int SectionIndex = -1;
7098480093f4SDimitry Andric   std::vector<EnumEntry<unsigned>> FlagsList =
709981ad6265SDimitry Andric       getSectionFlagsForTarget(this->Obj.getHeader().e_ident[ELF::EI_OSABI],
710081ad6265SDimitry Andric                                this->Obj.getHeader().e_machine);
7101e8d8bef9SDimitry Andric   for (const Elf_Shdr &Sec : cantFail(this->Obj.sections())) {
71020b57cec5SDimitry Andric     DictScope SectionD(W, "Section");
71030b57cec5SDimitry Andric     W.printNumber("Index", ++SectionIndex);
7104e8d8bef9SDimitry Andric     W.printNumber("Name", this->getPrintableSectionName(Sec), Sec.sh_name);
7105e8d8bef9SDimitry Andric     W.printHex("Type",
7106e8d8bef9SDimitry Andric                object::getELFSectionTypeName(this->Obj.getHeader().e_machine,
7107e8d8bef9SDimitry Andric                                              Sec.sh_type),
71080b57cec5SDimitry Andric                Sec.sh_type);
7109bdd1243dSDimitry Andric     W.printFlags("Flags", Sec.sh_flags, ArrayRef(FlagsList));
71100b57cec5SDimitry Andric     W.printHex("Address", Sec.sh_addr);
71110b57cec5SDimitry Andric     W.printHex("Offset", Sec.sh_offset);
71120b57cec5SDimitry Andric     W.printNumber("Size", Sec.sh_size);
71130b57cec5SDimitry Andric     W.printNumber("Link", Sec.sh_link);
71140b57cec5SDimitry Andric     W.printNumber("Info", Sec.sh_info);
71150b57cec5SDimitry Andric     W.printNumber("AddressAlignment", Sec.sh_addralign);
71160b57cec5SDimitry Andric     W.printNumber("EntrySize", Sec.sh_entsize);
71170b57cec5SDimitry Andric 
71180b57cec5SDimitry Andric     if (opts::SectionRelocations) {
71190b57cec5SDimitry Andric       ListScope D(W, "Relocations");
7120e8d8bef9SDimitry Andric       this->printRelocationsHelper(Sec);
71210b57cec5SDimitry Andric     }
71220b57cec5SDimitry Andric 
71230b57cec5SDimitry Andric     if (opts::SectionSymbols) {
71240b57cec5SDimitry Andric       ListScope D(W, "Symbols");
7125e8d8bef9SDimitry Andric       if (this->DotSymtabSec) {
7126e8d8bef9SDimitry Andric         StringRef StrTable = unwrapOrError(
7127e8d8bef9SDimitry Andric             this->FileName,
7128e8d8bef9SDimitry Andric             this->Obj.getStringTableForSymtab(*this->DotSymtabSec));
7129e8d8bef9SDimitry Andric         ArrayRef<Elf_Word> ShndxTable = this->getShndxTable(this->DotSymtabSec);
71300b57cec5SDimitry Andric 
7131e8d8bef9SDimitry Andric         typename ELFT::SymRange Symbols = unwrapOrError(
7132e8d8bef9SDimitry Andric             this->FileName, this->Obj.symbols(this->DotSymtabSec));
7133e8d8bef9SDimitry Andric         for (const Elf_Sym &Sym : Symbols) {
71340b57cec5SDimitry Andric           const Elf_Shdr *SymSec = unwrapOrError(
71358bcb0991SDimitry Andric               this->FileName,
7136e8d8bef9SDimitry Andric               this->Obj.getSection(Sym, this->DotSymtabSec, ShndxTable));
71370b57cec5SDimitry Andric           if (SymSec == &Sec)
7138e8d8bef9SDimitry Andric             printSymbol(Sym, &Sym - &Symbols[0], ShndxTable, StrTable, false,
71395f757f3fSDimitry Andric                         /*NonVisibilityBitsUsed=*/false,
71405f757f3fSDimitry Andric                         /*ExtraSymInfo=*/false);
7141e8d8bef9SDimitry Andric         }
71420b57cec5SDimitry Andric       }
71430b57cec5SDimitry Andric     }
71440b57cec5SDimitry Andric 
71450b57cec5SDimitry Andric     if (opts::SectionData && Sec.sh_type != ELF::SHT_NOBITS) {
71468bcb0991SDimitry Andric       ArrayRef<uint8_t> Data =
7147e8d8bef9SDimitry Andric           unwrapOrError(this->FileName, this->Obj.getSectionContents(Sec));
71480b57cec5SDimitry Andric       W.printBinaryBlock(
71490b57cec5SDimitry Andric           "SectionData",
71500b57cec5SDimitry Andric           StringRef(reinterpret_cast<const char *>(Data.data()), Data.size()));
71510b57cec5SDimitry Andric     }
71520b57cec5SDimitry Andric   }
71530b57cec5SDimitry Andric }
71540b57cec5SDimitry Andric 
71550b57cec5SDimitry Andric template <class ELFT>
printSymbolSection(const Elf_Sym & Symbol,unsigned SymIndex,DataRegion<Elf_Word> ShndxTable) const7156e8d8bef9SDimitry Andric void LLVMELFDumper<ELFT>::printSymbolSection(
7157e8d8bef9SDimitry Andric     const Elf_Sym &Symbol, unsigned SymIndex,
7158e8d8bef9SDimitry Andric     DataRegion<Elf_Word> ShndxTable) const {
7159bdd1243dSDimitry Andric   auto GetSectionSpecialType = [&]() -> std::optional<StringRef> {
7160e8d8bef9SDimitry Andric     if (Symbol.isUndefined())
7161e8d8bef9SDimitry Andric       return StringRef("Undefined");
7162e8d8bef9SDimitry Andric     if (Symbol.isProcessorSpecific())
7163e8d8bef9SDimitry Andric       return StringRef("Processor Specific");
7164e8d8bef9SDimitry Andric     if (Symbol.isOSSpecific())
7165e8d8bef9SDimitry Andric       return StringRef("Operating System Specific");
7166e8d8bef9SDimitry Andric     if (Symbol.isAbsolute())
7167e8d8bef9SDimitry Andric       return StringRef("Absolute");
7168e8d8bef9SDimitry Andric     if (Symbol.isCommon())
7169e8d8bef9SDimitry Andric       return StringRef("Common");
7170e8d8bef9SDimitry Andric     if (Symbol.isReserved() && Symbol.st_shndx != SHN_XINDEX)
7171e8d8bef9SDimitry Andric       return StringRef("Reserved");
7172bdd1243dSDimitry Andric     return std::nullopt;
7173e8d8bef9SDimitry Andric   };
7174e8d8bef9SDimitry Andric 
7175bdd1243dSDimitry Andric   if (std::optional<StringRef> Type = GetSectionSpecialType()) {
7176e8d8bef9SDimitry Andric     W.printHex("Section", *Type, Symbol.st_shndx);
7177e8d8bef9SDimitry Andric     return;
7178e8d8bef9SDimitry Andric   }
7179e8d8bef9SDimitry Andric 
7180480093f4SDimitry Andric   Expected<unsigned> SectionIndex =
7181e8d8bef9SDimitry Andric       this->getSymbolSectionIndex(Symbol, SymIndex, ShndxTable);
7182480093f4SDimitry Andric   if (!SectionIndex) {
7183e8d8bef9SDimitry Andric     assert(Symbol.st_shndx == SHN_XINDEX &&
7184480093f4SDimitry Andric            "getSymbolSectionIndex should only fail due to an invalid "
7185480093f4SDimitry Andric            "SHT_SYMTAB_SHNDX table/reference");
7186480093f4SDimitry Andric     this->reportUniqueWarning(SectionIndex.takeError());
7187480093f4SDimitry Andric     W.printHex("Section", "Reserved", SHN_XINDEX);
7188480093f4SDimitry Andric     return;
7189480093f4SDimitry Andric   }
7190480093f4SDimitry Andric 
7191480093f4SDimitry Andric   Expected<StringRef> SectionName =
7192e8d8bef9SDimitry Andric       this->getSymbolSectionName(Symbol, *SectionIndex);
7193480093f4SDimitry Andric   if (!SectionName) {
71945ffd83dbSDimitry Andric     // Don't report an invalid section name if the section headers are missing.
71955ffd83dbSDimitry Andric     // In such situations, all sections will be "invalid".
7196e8d8bef9SDimitry Andric     if (!this->ObjF.sections().empty())
7197480093f4SDimitry Andric       this->reportUniqueWarning(SectionName.takeError());
71985ffd83dbSDimitry Andric     else
71995ffd83dbSDimitry Andric       consumeError(SectionName.takeError());
7200480093f4SDimitry Andric     W.printHex("Section", "<?>", *SectionIndex);
7201480093f4SDimitry Andric   } else {
7202480093f4SDimitry Andric     W.printHex("Section", *SectionName, *SectionIndex);
7203480093f4SDimitry Andric   }
7204480093f4SDimitry Andric }
7205480093f4SDimitry Andric 
7206480093f4SDimitry Andric template <class ELFT>
printSymbolOtherField(const Elf_Sym & Symbol) const720706c3fb27SDimitry Andric void LLVMELFDumper<ELFT>::printSymbolOtherField(const Elf_Sym &Symbol) const {
720806c3fb27SDimitry Andric   std::vector<EnumEntry<unsigned>> SymOtherFlags =
720906c3fb27SDimitry Andric       this->getOtherFlagsFromSymbol(this->Obj.getHeader(), Symbol);
721006c3fb27SDimitry Andric   W.printFlags("Other", Symbol.st_other, ArrayRef(SymOtherFlags), 0x3u);
721106c3fb27SDimitry Andric }
721206c3fb27SDimitry Andric 
721306c3fb27SDimitry Andric template <class ELFT>
printZeroSymbolOtherField(const Elf_Sym & Symbol) const721406c3fb27SDimitry Andric void LLVMELFDumper<ELFT>::printZeroSymbolOtherField(
721506c3fb27SDimitry Andric     const Elf_Sym &Symbol) const {
721606c3fb27SDimitry Andric   assert(Symbol.st_other == 0 && "non-zero Other Field");
721706c3fb27SDimitry Andric   // Usually st_other flag is zero. Do not pollute the output
721806c3fb27SDimitry Andric   // by flags enumeration in that case.
721906c3fb27SDimitry Andric   W.printNumber("Other", 0);
722006c3fb27SDimitry Andric }
722106c3fb27SDimitry Andric 
722206c3fb27SDimitry Andric template <class ELFT>
printSymbol(const Elf_Sym & Symbol,unsigned SymIndex,DataRegion<Elf_Word> ShndxTable,std::optional<StringRef> StrTable,bool IsDynamic,bool,bool) const7223e8d8bef9SDimitry Andric void LLVMELFDumper<ELFT>::printSymbol(const Elf_Sym &Symbol, unsigned SymIndex,
7224e8d8bef9SDimitry Andric                                       DataRegion<Elf_Word> ShndxTable,
7225bdd1243dSDimitry Andric                                       std::optional<StringRef> StrTable,
7226e8d8bef9SDimitry Andric                                       bool IsDynamic,
72275f757f3fSDimitry Andric                                       bool /*NonVisibilityBitsUsed*/,
72285f757f3fSDimitry Andric                                       bool /*ExtraSymInfo*/) const {
7229e8d8bef9SDimitry Andric   std::string FullSymbolName = this->getFullSymbolName(
7230e8d8bef9SDimitry Andric       Symbol, SymIndex, ShndxTable, StrTable, IsDynamic);
7231e8d8bef9SDimitry Andric   unsigned char SymbolType = Symbol.getType();
72320b57cec5SDimitry Andric 
72330b57cec5SDimitry Andric   DictScope D(W, "Symbol");
7234e8d8bef9SDimitry Andric   W.printNumber("Name", FullSymbolName, Symbol.st_name);
7235e8d8bef9SDimitry Andric   W.printHex("Value", Symbol.st_value);
7236e8d8bef9SDimitry Andric   W.printNumber("Size", Symbol.st_size);
7237bdd1243dSDimitry Andric   W.printEnum("Binding", Symbol.getBinding(), ArrayRef(ElfSymbolBindings));
7238e8d8bef9SDimitry Andric   if (this->Obj.getHeader().e_machine == ELF::EM_AMDGPU &&
72390b57cec5SDimitry Andric       SymbolType >= ELF::STT_LOOS && SymbolType < ELF::STT_HIOS)
7240bdd1243dSDimitry Andric     W.printEnum("Type", SymbolType, ArrayRef(AMDGPUSymbolTypes));
72410b57cec5SDimitry Andric   else
7242bdd1243dSDimitry Andric     W.printEnum("Type", SymbolType, ArrayRef(ElfSymbolTypes));
7243e8d8bef9SDimitry Andric   if (Symbol.st_other == 0)
724406c3fb27SDimitry Andric     printZeroSymbolOtherField(Symbol);
72450b57cec5SDimitry Andric   else
724606c3fb27SDimitry Andric     printSymbolOtherField(Symbol);
7247e8d8bef9SDimitry Andric   printSymbolSection(Symbol, SymIndex, ShndxTable);
72480b57cec5SDimitry Andric }
72490b57cec5SDimitry Andric 
72500b57cec5SDimitry Andric template <class ELFT>
printSymbols(bool PrintSymbols,bool PrintDynamicSymbols,bool ExtraSymInfo)7251e8d8bef9SDimitry Andric void LLVMELFDumper<ELFT>::printSymbols(bool PrintSymbols,
72525f757f3fSDimitry Andric                                        bool PrintDynamicSymbols,
72535f757f3fSDimitry Andric                                        bool ExtraSymInfo) {
7254e8d8bef9SDimitry Andric   if (PrintSymbols) {
72550b57cec5SDimitry Andric     ListScope Group(W, "Symbols");
72565f757f3fSDimitry Andric     this->printSymbolsHelper(false, ExtraSymInfo);
72570b57cec5SDimitry Andric   }
7258e8d8bef9SDimitry Andric   if (PrintDynamicSymbols) {
72590b57cec5SDimitry Andric     ListScope Group(W, "DynamicSymbols");
72605f757f3fSDimitry Andric     this->printSymbolsHelper(true, ExtraSymInfo);
7261e8d8bef9SDimitry Andric   }
72620b57cec5SDimitry Andric }
72630b57cec5SDimitry Andric 
printDynamicTable()7264e8d8bef9SDimitry Andric template <class ELFT> void LLVMELFDumper<ELFT>::printDynamicTable() {
7265e8d8bef9SDimitry Andric   Elf_Dyn_Range Table = this->dynamic_table();
72660b57cec5SDimitry Andric   if (Table.empty())
72670b57cec5SDimitry Andric     return;
72680b57cec5SDimitry Andric 
72690b57cec5SDimitry Andric   W.startLine() << "DynamicSection [ (" << Table.size() << " entries)\n";
72700b57cec5SDimitry Andric 
7271e8d8bef9SDimitry Andric   size_t MaxTagSize = getMaxDynamicTagSize(this->Obj, Table);
72725ffd83dbSDimitry Andric   // The "Name/Value" column should be indented from the "Type" column by N
72735ffd83dbSDimitry Andric   // spaces, where N = MaxTagSize - length of "Type" (4) + trailing
72745ffd83dbSDimitry Andric   // space (1) = -3.
72755ffd83dbSDimitry Andric   W.startLine() << "  Tag" << std::string(ELFT::Is64Bits ? 16 : 8, ' ')
72765ffd83dbSDimitry Andric                 << "Type" << std::string(MaxTagSize - 3, ' ') << "Name/Value\n";
72775ffd83dbSDimitry Andric 
72785ffd83dbSDimitry Andric   std::string ValueFmt = "%-" + std::to_string(MaxTagSize) + "s ";
72790b57cec5SDimitry Andric   for (auto Entry : Table) {
72800b57cec5SDimitry Andric     uintX_t Tag = Entry.getTag();
7281e8d8bef9SDimitry Andric     std::string Value = this->getDynamicEntry(Tag, Entry.getVal());
72825ffd83dbSDimitry Andric     W.startLine() << "  " << format_hex(Tag, ELFT::Is64Bits ? 18 : 10, true)
72835ffd83dbSDimitry Andric                   << " "
72845ffd83dbSDimitry Andric                   << format(ValueFmt.c_str(),
7285e8d8bef9SDimitry Andric                             this->Obj.getDynamicTagAsString(Tag).c_str())
72865ffd83dbSDimitry Andric                   << Value << "\n";
72870b57cec5SDimitry Andric   }
72880b57cec5SDimitry Andric   W.startLine() << "]\n";
72890b57cec5SDimitry Andric }
72900b57cec5SDimitry Andric 
printDynamicRelocations()7291e8d8bef9SDimitry Andric template <class ELFT> void LLVMELFDumper<ELFT>::printDynamicRelocations() {
72920b57cec5SDimitry Andric   W.startLine() << "Dynamic Relocations {\n";
72930b57cec5SDimitry Andric   W.indent();
7294e8d8bef9SDimitry Andric   this->printDynamicRelocationsHelper();
72950b57cec5SDimitry Andric   W.unindent();
72960b57cec5SDimitry Andric   W.startLine() << "}\n";
72970b57cec5SDimitry Andric }
72980b57cec5SDimitry Andric 
72990b57cec5SDimitry Andric template <class ELFT>
printProgramHeaders(bool PrintProgramHeaders,cl::boolOrDefault PrintSectionMapping)7300e8d8bef9SDimitry Andric void LLVMELFDumper<ELFT>::printProgramHeaders(
7301e8d8bef9SDimitry Andric     bool PrintProgramHeaders, cl::boolOrDefault PrintSectionMapping) {
73020b57cec5SDimitry Andric   if (PrintProgramHeaders)
7303e8d8bef9SDimitry Andric     printProgramHeaders();
73040b57cec5SDimitry Andric   if (PrintSectionMapping == cl::BOU_TRUE)
7305e8d8bef9SDimitry Andric     printSectionMapping();
73060b57cec5SDimitry Andric }
73070b57cec5SDimitry Andric 
printProgramHeaders()7308e8d8bef9SDimitry Andric template <class ELFT> void LLVMELFDumper<ELFT>::printProgramHeaders() {
73090b57cec5SDimitry Andric   ListScope L(W, "ProgramHeaders");
73100b57cec5SDimitry Andric 
7311e8d8bef9SDimitry Andric   Expected<ArrayRef<Elf_Phdr>> PhdrsOrErr = this->Obj.program_headers();
73125ffd83dbSDimitry Andric   if (!PhdrsOrErr) {
7313e8d8bef9SDimitry Andric     this->reportUniqueWarning("unable to dump program headers: " +
7314e8d8bef9SDimitry Andric                               toString(PhdrsOrErr.takeError()));
73155ffd83dbSDimitry Andric     return;
73165ffd83dbSDimitry Andric   }
73175ffd83dbSDimitry Andric 
73185ffd83dbSDimitry Andric   for (const Elf_Phdr &Phdr : *PhdrsOrErr) {
73190b57cec5SDimitry Andric     DictScope P(W, "ProgramHeader");
7320e8d8bef9SDimitry Andric     StringRef Type =
7321e8d8bef9SDimitry Andric         segmentTypeToString(this->Obj.getHeader().e_machine, Phdr.p_type);
7322e8d8bef9SDimitry Andric 
7323e8d8bef9SDimitry Andric     W.printHex("Type", Type.empty() ? "Unknown" : Type, Phdr.p_type);
73240b57cec5SDimitry Andric     W.printHex("Offset", Phdr.p_offset);
73250b57cec5SDimitry Andric     W.printHex("VirtualAddress", Phdr.p_vaddr);
73260b57cec5SDimitry Andric     W.printHex("PhysicalAddress", Phdr.p_paddr);
73270b57cec5SDimitry Andric     W.printNumber("FileSize", Phdr.p_filesz);
73280b57cec5SDimitry Andric     W.printNumber("MemSize", Phdr.p_memsz);
7329bdd1243dSDimitry Andric     W.printFlags("Flags", Phdr.p_flags, ArrayRef(ElfSegmentFlags));
73300b57cec5SDimitry Andric     W.printNumber("Alignment", Phdr.p_align);
73310b57cec5SDimitry Andric   }
73320b57cec5SDimitry Andric }
73330b57cec5SDimitry Andric 
73340b57cec5SDimitry Andric template <class ELFT>
printVersionSymbolSection(const Elf_Shdr * Sec)7335e8d8bef9SDimitry Andric void LLVMELFDumper<ELFT>::printVersionSymbolSection(const Elf_Shdr *Sec) {
73368bcb0991SDimitry Andric   ListScope SS(W, "VersionSymbols");
73370b57cec5SDimitry Andric   if (!Sec)
73380b57cec5SDimitry Andric     return;
73390b57cec5SDimitry Andric 
7340480093f4SDimitry Andric   StringRef StrTable;
7341480093f4SDimitry Andric   ArrayRef<Elf_Sym> Syms;
7342e8d8bef9SDimitry Andric   const Elf_Shdr *SymTabSec;
7343480093f4SDimitry Andric   Expected<ArrayRef<Elf_Versym>> VerTableOrErr =
7344e8d8bef9SDimitry Andric       this->getVersionTable(*Sec, &Syms, &StrTable, &SymTabSec);
7345480093f4SDimitry Andric   if (!VerTableOrErr) {
7346480093f4SDimitry Andric     this->reportUniqueWarning(VerTableOrErr.takeError());
7347480093f4SDimitry Andric     return;
7348480093f4SDimitry Andric   }
73490b57cec5SDimitry Andric 
7350480093f4SDimitry Andric   if (StrTable.empty() || Syms.empty() || Syms.size() != VerTableOrErr->size())
7351480093f4SDimitry Andric     return;
7352480093f4SDimitry Andric 
7353e8d8bef9SDimitry Andric   ArrayRef<Elf_Word> ShNdxTable = this->getShndxTable(SymTabSec);
7354480093f4SDimitry Andric   for (size_t I = 0, E = Syms.size(); I < E; ++I) {
73550b57cec5SDimitry Andric     DictScope S(W, "Symbol");
7356480093f4SDimitry Andric     W.printNumber("Version", (*VerTableOrErr)[I].vs_index & VERSYM_VERSION);
7357e8d8bef9SDimitry Andric     W.printString("Name",
7358e8d8bef9SDimitry Andric                   this->getFullSymbolName(Syms[I], I, ShNdxTable, StrTable,
7359e8d8bef9SDimitry Andric                                           /*IsDynamic=*/true));
73600b57cec5SDimitry Andric   }
73610b57cec5SDimitry Andric }
73620b57cec5SDimitry Andric 
7363349cc55cSDimitry Andric const EnumEntry<unsigned> SymVersionFlags[] = {
7364e8d8bef9SDimitry Andric     {"Base", "BASE", VER_FLG_BASE},
7365e8d8bef9SDimitry Andric     {"Weak", "WEAK", VER_FLG_WEAK},
7366e8d8bef9SDimitry Andric     {"Info", "INFO", VER_FLG_INFO}};
7367e8d8bef9SDimitry Andric 
73680b57cec5SDimitry Andric template <class ELFT>
printVersionDefinitionSection(const Elf_Shdr * Sec)7369e8d8bef9SDimitry Andric void LLVMELFDumper<ELFT>::printVersionDefinitionSection(const Elf_Shdr *Sec) {
73708bcb0991SDimitry Andric   ListScope SD(W, "VersionDefinitions");
73710b57cec5SDimitry Andric   if (!Sec)
73720b57cec5SDimitry Andric     return;
73730b57cec5SDimitry Andric 
7374e8d8bef9SDimitry Andric   Expected<std::vector<VerDef>> V = this->Obj.getVersionDefinitions(*Sec);
7375480093f4SDimitry Andric   if (!V) {
7376480093f4SDimitry Andric     this->reportUniqueWarning(V.takeError());
7377480093f4SDimitry Andric     return;
73780b57cec5SDimitry Andric   }
7379480093f4SDimitry Andric 
7380480093f4SDimitry Andric   for (const VerDef &D : *V) {
7381480093f4SDimitry Andric     DictScope Def(W, "Definition");
7382480093f4SDimitry Andric     W.printNumber("Version", D.Version);
7383bdd1243dSDimitry Andric     W.printFlags("Flags", D.Flags, ArrayRef(SymVersionFlags));
7384480093f4SDimitry Andric     W.printNumber("Index", D.Ndx);
7385480093f4SDimitry Andric     W.printNumber("Hash", D.Hash);
7386480093f4SDimitry Andric     W.printString("Name", D.Name.c_str());
7387480093f4SDimitry Andric     W.printList(
7388480093f4SDimitry Andric         "Predecessors", D.AuxV,
7389480093f4SDimitry Andric         [](raw_ostream &OS, const VerdAux &Aux) { OS << Aux.Name.c_str(); });
73900b57cec5SDimitry Andric   }
73910b57cec5SDimitry Andric }
73920b57cec5SDimitry Andric 
73930b57cec5SDimitry Andric template <class ELFT>
printVersionDependencySection(const Elf_Shdr * Sec)7394e8d8bef9SDimitry Andric void LLVMELFDumper<ELFT>::printVersionDependencySection(const Elf_Shdr *Sec) {
73958bcb0991SDimitry Andric   ListScope SD(W, "VersionRequirements");
73960b57cec5SDimitry Andric   if (!Sec)
73970b57cec5SDimitry Andric     return;
73980b57cec5SDimitry Andric 
7399480093f4SDimitry Andric   Expected<std::vector<VerNeed>> V =
7400e8d8bef9SDimitry Andric       this->Obj.getVersionDependencies(*Sec, this->WarningHandler);
7401480093f4SDimitry Andric   if (!V) {
7402480093f4SDimitry Andric     this->reportUniqueWarning(V.takeError());
7403480093f4SDimitry Andric     return;
74040b57cec5SDimitry Andric   }
7405480093f4SDimitry Andric 
7406480093f4SDimitry Andric   for (const VerNeed &VN : *V) {
7407480093f4SDimitry Andric     DictScope Entry(W, "Dependency");
7408480093f4SDimitry Andric     W.printNumber("Version", VN.Version);
7409480093f4SDimitry Andric     W.printNumber("Count", VN.Cnt);
7410480093f4SDimitry Andric     W.printString("FileName", VN.File.c_str());
7411480093f4SDimitry Andric 
7412480093f4SDimitry Andric     ListScope L(W, "Entries");
7413480093f4SDimitry Andric     for (const VernAux &Aux : VN.AuxV) {
7414480093f4SDimitry Andric       DictScope Entry(W, "Entry");
7415480093f4SDimitry Andric       W.printNumber("Hash", Aux.Hash);
7416bdd1243dSDimitry Andric       W.printFlags("Flags", Aux.Flags, ArrayRef(SymVersionFlags));
7417480093f4SDimitry Andric       W.printNumber("Index", Aux.Other);
7418480093f4SDimitry Andric       W.printString("Name", Aux.Name.c_str());
7419480093f4SDimitry Andric     }
74200b57cec5SDimitry Andric   }
74210b57cec5SDimitry Andric }
74220b57cec5SDimitry Andric 
742306c3fb27SDimitry Andric template <class ELFT>
printHashHistogramStats(size_t NBucket,size_t MaxChain,size_t TotalSyms,ArrayRef<size_t> Count,bool IsGnu) const742406c3fb27SDimitry Andric void LLVMELFDumper<ELFT>::printHashHistogramStats(size_t NBucket,
742506c3fb27SDimitry Andric                                                   size_t MaxChain,
742606c3fb27SDimitry Andric                                                   size_t TotalSyms,
742706c3fb27SDimitry Andric                                                   ArrayRef<size_t> Count,
742806c3fb27SDimitry Andric                                                   bool IsGnu) const {
742906c3fb27SDimitry Andric   StringRef HistName = IsGnu ? "GnuHashHistogram" : "HashHistogram";
743006c3fb27SDimitry Andric   StringRef BucketName = IsGnu ? "Bucket" : "Chain";
743106c3fb27SDimitry Andric   StringRef ListName = IsGnu ? "Buckets" : "Chains";
743206c3fb27SDimitry Andric   DictScope Outer(W, HistName);
743306c3fb27SDimitry Andric   W.printNumber("TotalBuckets", NBucket);
743406c3fb27SDimitry Andric   ListScope Buckets(W, ListName);
743506c3fb27SDimitry Andric   size_t CumulativeNonZero = 0;
743606c3fb27SDimitry Andric   for (size_t I = 0; I < MaxChain; ++I) {
743706c3fb27SDimitry Andric     CumulativeNonZero += Count[I] * I;
743806c3fb27SDimitry Andric     DictScope Bucket(W, BucketName);
743906c3fb27SDimitry Andric     W.printNumber("Length", I);
744006c3fb27SDimitry Andric     W.printNumber("Count", Count[I]);
744106c3fb27SDimitry Andric     W.printNumber("Percentage", (float)(Count[I] * 100.0) / NBucket);
744206c3fb27SDimitry Andric     W.printNumber("Coverage", (float)(CumulativeNonZero * 100.0) / TotalSyms);
744306c3fb27SDimitry Andric   }
74440b57cec5SDimitry Andric }
74450b57cec5SDimitry Andric 
7446fe6060f1SDimitry Andric // Returns true if rel/rela section exists, and populates SymbolIndices.
7447fe6060f1SDimitry Andric // Otherwise returns false.
7448fe6060f1SDimitry Andric template <class ELFT>
getSymbolIndices(const typename ELFT::Shdr * CGRelSection,const ELFFile<ELFT> & Obj,const LLVMELFDumper<ELFT> * Dumper,SmallVector<uint32_t,128> & SymbolIndices)7449fe6060f1SDimitry Andric static bool getSymbolIndices(const typename ELFT::Shdr *CGRelSection,
7450fe6060f1SDimitry Andric                              const ELFFile<ELFT> &Obj,
7451fe6060f1SDimitry Andric                              const LLVMELFDumper<ELFT> *Dumper,
7452fe6060f1SDimitry Andric                              SmallVector<uint32_t, 128> &SymbolIndices) {
7453fe6060f1SDimitry Andric   if (!CGRelSection) {
7454fe6060f1SDimitry Andric     Dumper->reportUniqueWarning(
7455fe6060f1SDimitry Andric         "relocation section for a call graph section doesn't exist");
7456fe6060f1SDimitry Andric     return false;
7457fe6060f1SDimitry Andric   }
7458fe6060f1SDimitry Andric 
7459fe6060f1SDimitry Andric   if (CGRelSection->sh_type == SHT_REL) {
7460fe6060f1SDimitry Andric     typename ELFT::RelRange CGProfileRel;
7461fe6060f1SDimitry Andric     Expected<typename ELFT::RelRange> CGProfileRelOrError =
7462fe6060f1SDimitry Andric         Obj.rels(*CGRelSection);
7463fe6060f1SDimitry Andric     if (!CGProfileRelOrError) {
7464fe6060f1SDimitry Andric       Dumper->reportUniqueWarning("unable to load relocations for "
7465fe6060f1SDimitry Andric                                   "SHT_LLVM_CALL_GRAPH_PROFILE section: " +
7466fe6060f1SDimitry Andric                                   toString(CGProfileRelOrError.takeError()));
7467fe6060f1SDimitry Andric       return false;
7468fe6060f1SDimitry Andric     }
7469fe6060f1SDimitry Andric 
7470fe6060f1SDimitry Andric     CGProfileRel = *CGProfileRelOrError;
7471fe6060f1SDimitry Andric     for (const typename ELFT::Rel &Rel : CGProfileRel)
7472fe6060f1SDimitry Andric       SymbolIndices.push_back(Rel.getSymbol(Obj.isMips64EL()));
7473fe6060f1SDimitry Andric   } else {
7474fe6060f1SDimitry Andric     // MC unconditionally produces SHT_REL, but GNU strip/objcopy may convert
7475fe6060f1SDimitry Andric     // the format to SHT_RELA
7476fe6060f1SDimitry Andric     // (https://sourceware.org/bugzilla/show_bug.cgi?id=28035)
7477fe6060f1SDimitry Andric     typename ELFT::RelaRange CGProfileRela;
7478fe6060f1SDimitry Andric     Expected<typename ELFT::RelaRange> CGProfileRelaOrError =
7479fe6060f1SDimitry Andric         Obj.relas(*CGRelSection);
7480fe6060f1SDimitry Andric     if (!CGProfileRelaOrError) {
7481fe6060f1SDimitry Andric       Dumper->reportUniqueWarning("unable to load relocations for "
7482fe6060f1SDimitry Andric                                   "SHT_LLVM_CALL_GRAPH_PROFILE section: " +
7483fe6060f1SDimitry Andric                                   toString(CGProfileRelaOrError.takeError()));
7484fe6060f1SDimitry Andric       return false;
7485fe6060f1SDimitry Andric     }
7486fe6060f1SDimitry Andric 
7487fe6060f1SDimitry Andric     CGProfileRela = *CGProfileRelaOrError;
7488fe6060f1SDimitry Andric     for (const typename ELFT::Rela &Rela : CGProfileRela)
7489fe6060f1SDimitry Andric       SymbolIndices.push_back(Rela.getSymbol(Obj.isMips64EL()));
7490fe6060f1SDimitry Andric   }
7491fe6060f1SDimitry Andric 
7492fe6060f1SDimitry Andric   return true;
7493fe6060f1SDimitry Andric }
7494fe6060f1SDimitry Andric 
printCGProfile()7495e8d8bef9SDimitry Andric template <class ELFT> void LLVMELFDumper<ELFT>::printCGProfile() {
7496fe6060f1SDimitry Andric   auto IsMatch = [](const Elf_Shdr &Sec) -> bool {
7497fe6060f1SDimitry Andric     return Sec.sh_type == ELF::SHT_LLVM_CALL_GRAPH_PROFILE;
7498fe6060f1SDimitry Andric   };
7499fe6060f1SDimitry Andric 
750006c3fb27SDimitry Andric   Expected<MapVector<const Elf_Shdr *, const Elf_Shdr *>> SecToRelocMapOrErr =
750106c3fb27SDimitry Andric       this->Obj.getSectionAndRelocations(IsMatch);
750206c3fb27SDimitry Andric   if (!SecToRelocMapOrErr) {
750306c3fb27SDimitry Andric     this->reportUniqueWarning("unable to get CG Profile section(s): " +
750406c3fb27SDimitry Andric                               toString(SecToRelocMapOrErr.takeError()));
750506c3fb27SDimitry Andric     return;
750606c3fb27SDimitry Andric   }
750706c3fb27SDimitry Andric 
750806c3fb27SDimitry Andric   for (const auto &CGMapEntry : *SecToRelocMapOrErr) {
7509fe6060f1SDimitry Andric     const Elf_Shdr *CGSection = CGMapEntry.first;
7510fe6060f1SDimitry Andric     const Elf_Shdr *CGRelSection = CGMapEntry.second;
75115ffd83dbSDimitry Andric 
75125ffd83dbSDimitry Andric     Expected<ArrayRef<Elf_CGProfile>> CGProfileOrErr =
7513fe6060f1SDimitry Andric         this->Obj.template getSectionContentsAsArray<Elf_CGProfile>(*CGSection);
75145ffd83dbSDimitry Andric     if (!CGProfileOrErr) {
75155ffd83dbSDimitry Andric       this->reportUniqueWarning(
7516fe6060f1SDimitry Andric           "unable to load the SHT_LLVM_CALL_GRAPH_PROFILE section: " +
7517e8d8bef9SDimitry Andric           toString(CGProfileOrErr.takeError()));
75185ffd83dbSDimitry Andric       return;
75195ffd83dbSDimitry Andric     }
75205ffd83dbSDimitry Andric 
7521fe6060f1SDimitry Andric     SmallVector<uint32_t, 128> SymbolIndices;
7522fe6060f1SDimitry Andric     bool UseReloc =
7523fe6060f1SDimitry Andric         getSymbolIndices<ELFT>(CGRelSection, this->Obj, this, SymbolIndices);
7524fe6060f1SDimitry Andric     if (UseReloc && SymbolIndices.size() != CGProfileOrErr->size() * 2) {
7525fe6060f1SDimitry Andric       this->reportUniqueWarning(
7526fe6060f1SDimitry Andric           "number of from/to pairs does not match number of frequencies");
7527fe6060f1SDimitry Andric       UseReloc = false;
7528fe6060f1SDimitry Andric     }
7529fe6060f1SDimitry Andric 
7530fe6060f1SDimitry Andric     ListScope L(W, "CGProfile");
7531fe6060f1SDimitry Andric     for (uint32_t I = 0, Size = CGProfileOrErr->size(); I != Size; ++I) {
7532fe6060f1SDimitry Andric       const Elf_CGProfile &CGPE = (*CGProfileOrErr)[I];
75330b57cec5SDimitry Andric       DictScope D(W, "CGProfileEntry");
7534fe6060f1SDimitry Andric       if (UseReloc) {
7535fe6060f1SDimitry Andric         uint32_t From = SymbolIndices[I * 2];
7536fe6060f1SDimitry Andric         uint32_t To = SymbolIndices[I * 2 + 1];
7537fe6060f1SDimitry Andric         W.printNumber("From", this->getStaticSymbolName(From), From);
7538fe6060f1SDimitry Andric         W.printNumber("To", this->getStaticSymbolName(To), To);
7539fe6060f1SDimitry Andric       }
75400b57cec5SDimitry Andric       W.printNumber("Weight", CGPE.cgp_weight);
75410b57cec5SDimitry Andric     }
75420b57cec5SDimitry Andric   }
7543fe6060f1SDimitry Andric }
7544fe6060f1SDimitry Andric 
printBBAddrMaps()7545fe6060f1SDimitry Andric template <class ELFT> void LLVMELFDumper<ELFT>::printBBAddrMaps() {
7546fe6060f1SDimitry Andric   bool IsRelocatable = this->Obj.getHeader().e_type == ELF::ET_REL;
754706c3fb27SDimitry Andric   using Elf_Shdr = typename ELFT::Shdr;
754806c3fb27SDimitry Andric   auto IsMatch = [](const Elf_Shdr &Sec) -> bool {
754906c3fb27SDimitry Andric     return Sec.sh_type == ELF::SHT_LLVM_BB_ADDR_MAP ||
755006c3fb27SDimitry Andric            Sec.sh_type == ELF::SHT_LLVM_BB_ADDR_MAP_V0;
755106c3fb27SDimitry Andric   };
755206c3fb27SDimitry Andric   Expected<MapVector<const Elf_Shdr *, const Elf_Shdr *>> SecRelocMapOrErr =
755306c3fb27SDimitry Andric       this->Obj.getSectionAndRelocations(IsMatch);
755406c3fb27SDimitry Andric   if (!SecRelocMapOrErr) {
755506c3fb27SDimitry Andric     this->reportUniqueWarning(
755606c3fb27SDimitry Andric         "failed to get SHT_LLVM_BB_ADDR_MAP section(s): " +
755706c3fb27SDimitry Andric         toString(SecRelocMapOrErr.takeError()));
755806c3fb27SDimitry Andric     return;
755981ad6265SDimitry Andric   }
756006c3fb27SDimitry Andric   for (auto const &[Sec, RelocSec] : *SecRelocMapOrErr) {
7561bdd1243dSDimitry Andric     std::optional<const Elf_Shdr *> FunctionSec;
7562fe6060f1SDimitry Andric     if (IsRelocatable)
7563fe6060f1SDimitry Andric       FunctionSec =
756406c3fb27SDimitry Andric           unwrapOrError(this->FileName, this->Obj.getSection(Sec->sh_link));
7565fe6060f1SDimitry Andric     ListScope L(W, "BBAddrMap");
756606c3fb27SDimitry Andric     if (IsRelocatable && !RelocSec) {
756706c3fb27SDimitry Andric       this->reportUniqueWarning("unable to get relocation section for " +
756806c3fb27SDimitry Andric                                 this->describe(*Sec));
756906c3fb27SDimitry Andric       continue;
757006c3fb27SDimitry Andric     }
7571349cc55cSDimitry Andric     Expected<std::vector<BBAddrMap>> BBAddrMapOrErr =
757206c3fb27SDimitry Andric         this->Obj.decodeBBAddrMap(*Sec, RelocSec);
7573fe6060f1SDimitry Andric     if (!BBAddrMapOrErr) {
757406c3fb27SDimitry Andric       this->reportUniqueWarning("unable to dump " + this->describe(*Sec) +
757506c3fb27SDimitry Andric                                 ": " + toString(BBAddrMapOrErr.takeError()));
7576fe6060f1SDimitry Andric       continue;
7577fe6060f1SDimitry Andric     }
7578349cc55cSDimitry Andric     for (const BBAddrMap &AM : *BBAddrMapOrErr) {
7579fe6060f1SDimitry Andric       DictScope D(W, "Function");
7580fe6060f1SDimitry Andric       W.printHex("At", AM.Addr);
7581fe6060f1SDimitry Andric       SmallVector<uint32_t> FuncSymIndex =
7582fe6060f1SDimitry Andric           this->getSymbolIndexesForFunctionAddress(AM.Addr, FunctionSec);
7583fe6060f1SDimitry Andric       std::string FuncName = "<?>";
7584fe6060f1SDimitry Andric       if (FuncSymIndex.empty())
7585fe6060f1SDimitry Andric         this->reportUniqueWarning(
7586fe6060f1SDimitry Andric             "could not identify function symbol for address (0x" +
758706c3fb27SDimitry Andric             Twine::utohexstr(AM.Addr) + ") in " + this->describe(*Sec));
7588fe6060f1SDimitry Andric       else
7589fe6060f1SDimitry Andric         FuncName = this->getStaticSymbolName(FuncSymIndex.front());
7590fe6060f1SDimitry Andric       W.printString("Name", FuncName);
7591fe6060f1SDimitry Andric 
7592fe6060f1SDimitry Andric       ListScope L(W, "BB entries");
7593349cc55cSDimitry Andric       for (const BBAddrMap::BBEntry &BBE : AM.BBEntries) {
7594fe6060f1SDimitry Andric         DictScope L(W);
7595bdd1243dSDimitry Andric         W.printNumber("ID", BBE.ID);
7596fe6060f1SDimitry Andric         W.printHex("Offset", BBE.Offset);
7597fe6060f1SDimitry Andric         W.printHex("Size", BBE.Size);
759806c3fb27SDimitry Andric         W.printBoolean("HasReturn", BBE.hasReturn());
759906c3fb27SDimitry Andric         W.printBoolean("HasTailCall", BBE.hasTailCall());
760006c3fb27SDimitry Andric         W.printBoolean("IsEHPad", BBE.isEHPad());
760106c3fb27SDimitry Andric         W.printBoolean("CanFallThrough", BBE.canFallThrough());
76025f757f3fSDimitry Andric         W.printBoolean("HasIndirectBranch", BBE.hasIndirectBranch());
7603fe6060f1SDimitry Andric       }
7604fe6060f1SDimitry Andric     }
7605fe6060f1SDimitry Andric   }
7606fe6060f1SDimitry Andric }
76070b57cec5SDimitry Andric 
printAddrsig()7608e8d8bef9SDimitry Andric template <class ELFT> void LLVMELFDumper<ELFT>::printAddrsig() {
76090b57cec5SDimitry Andric   ListScope L(W, "Addrsig");
7610e8d8bef9SDimitry Andric   if (!this->DotAddrsigSec)
76110b57cec5SDimitry Andric     return;
7612e8d8bef9SDimitry Andric 
7613e8d8bef9SDimitry Andric   Expected<std::vector<uint64_t>> SymsOrErr =
7614e8d8bef9SDimitry Andric       decodeAddrsigSection(this->Obj, *this->DotAddrsigSec);
7615e8d8bef9SDimitry Andric   if (!SymsOrErr) {
7616e8d8bef9SDimitry Andric     this->reportUniqueWarning(SymsOrErr.takeError());
76178bcb0991SDimitry Andric     return;
76188bcb0991SDimitry Andric   }
76198bcb0991SDimitry Andric 
7620e8d8bef9SDimitry Andric   for (uint64_t Sym : *SymsOrErr)
7621e8d8bef9SDimitry Andric     W.printNumber("Sym", this->getStaticSymbolName(Sym), Sym);
76220b57cec5SDimitry Andric }
76230b57cec5SDimitry Andric 
76240b57cec5SDimitry Andric template <typename ELFT>
printGNUNoteLLVMStyle(uint32_t NoteType,ArrayRef<uint8_t> Desc,ScopedPrinter & W)7625fe6060f1SDimitry Andric static bool printGNUNoteLLVMStyle(uint32_t NoteType, ArrayRef<uint8_t> Desc,
76260b57cec5SDimitry Andric                                   ScopedPrinter &W) {
7627fe6060f1SDimitry Andric   // Return true if we were able to pretty-print the note, false otherwise.
76280b57cec5SDimitry Andric   switch (NoteType) {
76290b57cec5SDimitry Andric   default:
7630fe6060f1SDimitry Andric     return false;
76310b57cec5SDimitry Andric   case ELF::NT_GNU_ABI_TAG: {
76320b57cec5SDimitry Andric     const GNUAbiTag &AbiTag = getGNUAbiTag<ELFT>(Desc);
76330b57cec5SDimitry Andric     if (!AbiTag.IsValid) {
76340b57cec5SDimitry Andric       W.printString("ABI", "<corrupt GNU_ABI_TAG>");
7635fe6060f1SDimitry Andric       return false;
76360b57cec5SDimitry Andric     } else {
76370b57cec5SDimitry Andric       W.printString("OS", AbiTag.OSName);
76380b57cec5SDimitry Andric       W.printString("ABI", AbiTag.ABI);
76390b57cec5SDimitry Andric     }
76400b57cec5SDimitry Andric     break;
76410b57cec5SDimitry Andric   }
76420b57cec5SDimitry Andric   case ELF::NT_GNU_BUILD_ID: {
76430b57cec5SDimitry Andric     W.printString("Build ID", getGNUBuildId(Desc));
76440b57cec5SDimitry Andric     break;
76450b57cec5SDimitry Andric   }
76460b57cec5SDimitry Andric   case ELF::NT_GNU_GOLD_VERSION:
7647349cc55cSDimitry Andric     W.printString("Version", getDescAsStringRef(Desc));
76480b57cec5SDimitry Andric     break;
76490b57cec5SDimitry Andric   case ELF::NT_GNU_PROPERTY_TYPE_0:
76500b57cec5SDimitry Andric     ListScope D(W, "Property");
7651e8d8bef9SDimitry Andric     for (const std::string &Property : getGNUPropertyList<ELFT>(Desc))
76520b57cec5SDimitry Andric       W.printString(Property);
76530b57cec5SDimitry Andric     break;
76540b57cec5SDimitry Andric   }
7655fe6060f1SDimitry Andric   return true;
76560b57cec5SDimitry Andric }
76570b57cec5SDimitry Andric 
printAndroidNoteLLVMStyle(uint32_t NoteType,ArrayRef<uint8_t> Desc,ScopedPrinter & W)765881ad6265SDimitry Andric static bool printAndroidNoteLLVMStyle(uint32_t NoteType, ArrayRef<uint8_t> Desc,
765981ad6265SDimitry Andric                                       ScopedPrinter &W) {
766081ad6265SDimitry Andric   // Return true if we were able to pretty-print the note, false otherwise.
766181ad6265SDimitry Andric   AndroidNoteProperties Props = getAndroidNoteProperties(NoteType, Desc);
766281ad6265SDimitry Andric   if (Props.empty())
766381ad6265SDimitry Andric     return false;
766481ad6265SDimitry Andric   for (const auto &KV : Props)
766581ad6265SDimitry Andric     W.printString(KV.first, KV.second);
766681ad6265SDimitry Andric   return true;
766781ad6265SDimitry Andric }
766881ad6265SDimitry Andric 
766906c3fb27SDimitry Andric template <class ELFT>
printAarch64NoteLLVMStyle(uint32_t NoteType,ArrayRef<uint8_t> Desc,ScopedPrinter & W)76705f757f3fSDimitry Andric static bool printAarch64NoteLLVMStyle(uint32_t NoteType, ArrayRef<uint8_t> Desc,
76715f757f3fSDimitry Andric                                       ScopedPrinter &W) {
76725f757f3fSDimitry Andric   if (NoteType != NT_ARM_TYPE_PAUTH_ABI_TAG)
76735f757f3fSDimitry Andric     return false;
76745f757f3fSDimitry Andric 
76755f757f3fSDimitry Andric   if (Desc.size() < 16)
76765f757f3fSDimitry Andric     return false;
76775f757f3fSDimitry Andric 
76785f757f3fSDimitry Andric   uint64_t platform =
76795f757f3fSDimitry Andric       support::endian::read64<ELFT::TargetEndianness>(Desc.data() + 0);
76805f757f3fSDimitry Andric   uint64_t version =
76815f757f3fSDimitry Andric       support::endian::read64<ELFT::TargetEndianness>(Desc.data() + 8);
76825f757f3fSDimitry Andric   W.printNumber("Platform", platform);
76835f757f3fSDimitry Andric   W.printNumber("Version", version);
76845f757f3fSDimitry Andric 
76855f757f3fSDimitry Andric   if (Desc.size() > 16)
76865f757f3fSDimitry Andric     W.printString("Additional info",
76875f757f3fSDimitry Andric                   toHex(ArrayRef<uint8_t>(Desc.data() + 16, Desc.size() - 16)));
76885f757f3fSDimitry Andric 
76895f757f3fSDimitry Andric   return true;
76905f757f3fSDimitry Andric }
76915f757f3fSDimitry Andric 
76925f757f3fSDimitry Andric template <class ELFT>
printMemtag(const ArrayRef<std::pair<std::string,std::string>> DynamicEntries,const ArrayRef<uint8_t> AndroidNoteDesc,const ArrayRef<std::pair<uint64_t,uint64_t>> Descriptors)769306c3fb27SDimitry Andric void LLVMELFDumper<ELFT>::printMemtag(
769406c3fb27SDimitry Andric     const ArrayRef<std::pair<std::string, std::string>> DynamicEntries,
769506c3fb27SDimitry Andric     const ArrayRef<uint8_t> AndroidNoteDesc,
769606c3fb27SDimitry Andric     const ArrayRef<std::pair<uint64_t, uint64_t>> Descriptors) {
769706c3fb27SDimitry Andric   {
769806c3fb27SDimitry Andric     ListScope L(W, "Memtag Dynamic Entries:");
769906c3fb27SDimitry Andric     if (DynamicEntries.empty())
770006c3fb27SDimitry Andric       W.printString("< none found >");
770106c3fb27SDimitry Andric     for (const auto &DynamicEntryKV : DynamicEntries)
770206c3fb27SDimitry Andric       W.printString(DynamicEntryKV.first, DynamicEntryKV.second);
770306c3fb27SDimitry Andric   }
770406c3fb27SDimitry Andric 
770506c3fb27SDimitry Andric   if (!AndroidNoteDesc.empty()) {
770606c3fb27SDimitry Andric     ListScope L(W, "Memtag Android Note:");
770706c3fb27SDimitry Andric     printAndroidNoteLLVMStyle(ELF::NT_ANDROID_TYPE_MEMTAG, AndroidNoteDesc, W);
770806c3fb27SDimitry Andric   }
770906c3fb27SDimitry Andric 
771006c3fb27SDimitry Andric   if (Descriptors.empty())
771106c3fb27SDimitry Andric     return;
771206c3fb27SDimitry Andric 
771306c3fb27SDimitry Andric   {
771406c3fb27SDimitry Andric     ListScope L(W, "Memtag Global Descriptors:");
771506c3fb27SDimitry Andric     for (const auto &[Addr, BytesToTag] : Descriptors) {
771606c3fb27SDimitry Andric       W.printHex("0x" + utohexstr(Addr), BytesToTag);
771706c3fb27SDimitry Andric     }
771806c3fb27SDimitry Andric   }
771906c3fb27SDimitry Andric }
772006c3fb27SDimitry Andric 
7721349cc55cSDimitry Andric template <typename ELFT>
printLLVMOMPOFFLOADNoteLLVMStyle(uint32_t NoteType,ArrayRef<uint8_t> Desc,ScopedPrinter & W)7722349cc55cSDimitry Andric static bool printLLVMOMPOFFLOADNoteLLVMStyle(uint32_t NoteType,
7723349cc55cSDimitry Andric                                              ArrayRef<uint8_t> Desc,
7724349cc55cSDimitry Andric                                              ScopedPrinter &W) {
7725349cc55cSDimitry Andric   switch (NoteType) {
7726349cc55cSDimitry Andric   default:
7727349cc55cSDimitry Andric     return false;
7728349cc55cSDimitry Andric   case ELF::NT_LLVM_OPENMP_OFFLOAD_VERSION:
7729349cc55cSDimitry Andric     W.printString("Version", getDescAsStringRef(Desc));
7730349cc55cSDimitry Andric     break;
7731349cc55cSDimitry Andric   case ELF::NT_LLVM_OPENMP_OFFLOAD_PRODUCER:
7732349cc55cSDimitry Andric     W.printString("Producer", getDescAsStringRef(Desc));
7733349cc55cSDimitry Andric     break;
7734349cc55cSDimitry Andric   case ELF::NT_LLVM_OPENMP_OFFLOAD_PRODUCER_VERSION:
7735349cc55cSDimitry Andric     W.printString("Producer version", getDescAsStringRef(Desc));
7736349cc55cSDimitry Andric     break;
7737349cc55cSDimitry Andric   }
7738349cc55cSDimitry Andric   return true;
7739349cc55cSDimitry Andric }
7740349cc55cSDimitry Andric 
printCoreNoteLLVMStyle(const CoreNote & Note,ScopedPrinter & W)77418bcb0991SDimitry Andric static void printCoreNoteLLVMStyle(const CoreNote &Note, ScopedPrinter &W) {
77428bcb0991SDimitry Andric   W.printNumber("Page Size", Note.PageSize);
77438bcb0991SDimitry Andric   for (const CoreFileMapping &Mapping : Note.Mappings) {
77448bcb0991SDimitry Andric     ListScope D(W, "Mapping");
77458bcb0991SDimitry Andric     W.printHex("Start", Mapping.Start);
77468bcb0991SDimitry Andric     W.printHex("End", Mapping.End);
77478bcb0991SDimitry Andric     W.printHex("Offset", Mapping.Offset);
77488bcb0991SDimitry Andric     W.printString("Filename", Mapping.Filename);
77498bcb0991SDimitry Andric   }
77508bcb0991SDimitry Andric }
77518bcb0991SDimitry Andric 
printNotes()7752e8d8bef9SDimitry Andric template <class ELFT> void LLVMELFDumper<ELFT>::printNotes() {
77530b57cec5SDimitry Andric   ListScope L(W, "Notes");
77540b57cec5SDimitry Andric 
7755e8d8bef9SDimitry Andric   std::unique_ptr<DictScope> NoteScope;
775606c3fb27SDimitry Andric   size_t Align = 0;
7757bdd1243dSDimitry Andric   auto StartNotes = [&](std::optional<StringRef> SecName,
77585ffd83dbSDimitry Andric                         const typename ELFT::Off Offset,
775906c3fb27SDimitry Andric                         const typename ELFT::Addr Size, size_t Al) {
776006c3fb27SDimitry Andric     Align = std::max<size_t>(Al, 4);
7761e8d8bef9SDimitry Andric     NoteScope = std::make_unique<DictScope>(W, "NoteSection");
77625ffd83dbSDimitry Andric     W.printString("Name", SecName ? *SecName : "<?>");
77630b57cec5SDimitry Andric     W.printHex("Offset", Offset);
77640b57cec5SDimitry Andric     W.printHex("Size", Size);
77650b57cec5SDimitry Andric   };
77660b57cec5SDimitry Andric 
7767e8d8bef9SDimitry Andric   auto EndNotes = [&] { NoteScope.reset(); };
7768e8d8bef9SDimitry Andric 
7769fe6060f1SDimitry Andric   auto ProcessNote = [&](const Elf_Note &Note, bool IsCore) -> Error {
77700b57cec5SDimitry Andric     DictScope D2(W, "Note");
77710b57cec5SDimitry Andric     StringRef Name = Note.getName();
777206c3fb27SDimitry Andric     ArrayRef<uint8_t> Descriptor = Note.getDesc(Align);
77730b57cec5SDimitry Andric     Elf_Word Type = Note.getType();
77740b57cec5SDimitry Andric 
77758bcb0991SDimitry Andric     // Print the note owner/type.
77760b57cec5SDimitry Andric     W.printString("Owner", Name);
77770b57cec5SDimitry Andric     W.printHex("Data size", Descriptor.size());
7778e8d8bef9SDimitry Andric 
7779e8d8bef9SDimitry Andric     StringRef NoteType =
7780e8d8bef9SDimitry Andric         getNoteTypeName<ELFT>(Note, this->Obj.getHeader().e_type);
77810b57cec5SDimitry Andric     if (!NoteType.empty())
77820b57cec5SDimitry Andric       W.printString("Type", NoteType);
77830b57cec5SDimitry Andric     else
77840b57cec5SDimitry Andric       W.printString("Type",
77850b57cec5SDimitry Andric                     "Unknown (" + to_string(format_hex(Type, 10)) + ")");
77868bcb0991SDimitry Andric 
77878bcb0991SDimitry Andric     // Print the description, or fallback to printing raw bytes for unknown
7788fe6060f1SDimitry Andric     // owners/if we fail to pretty-print the contents.
77898bcb0991SDimitry Andric     if (Name == "GNU") {
7790fe6060f1SDimitry Andric       if (printGNUNoteLLVMStyle<ELFT>(Type, Descriptor, W))
7791fe6060f1SDimitry Andric         return Error::success();
7792fe6060f1SDimitry Andric     } else if (Name == "FreeBSD") {
7793bdd1243dSDimitry Andric       if (std::optional<FreeBSDNote> N =
7794fe6060f1SDimitry Andric               getFreeBSDNote<ELFT>(Type, Descriptor, IsCore)) {
7795fe6060f1SDimitry Andric         W.printString(N->Type, N->Value);
7796fe6060f1SDimitry Andric         return Error::success();
7797fe6060f1SDimitry Andric       }
77988bcb0991SDimitry Andric     } else if (Name == "AMD") {
77998bcb0991SDimitry Andric       const AMDNote N = getAMDNote<ELFT>(Type, Descriptor);
7800fe6060f1SDimitry Andric       if (!N.Type.empty()) {
78018bcb0991SDimitry Andric         W.printString(N.Type, N.Value);
7802fe6060f1SDimitry Andric         return Error::success();
7803fe6060f1SDimitry Andric       }
78048bcb0991SDimitry Andric     } else if (Name == "AMDGPU") {
78058bcb0991SDimitry Andric       const AMDGPUNote N = getAMDGPUNote<ELFT>(Type, Descriptor);
7806fe6060f1SDimitry Andric       if (!N.Type.empty()) {
78078bcb0991SDimitry Andric         W.printString(N.Type, N.Value);
7808fe6060f1SDimitry Andric         return Error::success();
7809fe6060f1SDimitry Andric       }
7810349cc55cSDimitry Andric     } else if (Name == "LLVMOMPOFFLOAD") {
7811349cc55cSDimitry Andric       if (printLLVMOMPOFFLOADNoteLLVMStyle<ELFT>(Type, Descriptor, W))
7812349cc55cSDimitry Andric         return Error::success();
78138bcb0991SDimitry Andric     } else if (Name == "CORE") {
78148bcb0991SDimitry Andric       if (Type == ELF::NT_FILE) {
78155f757f3fSDimitry Andric         DataExtractor DescExtractor(
78165f757f3fSDimitry Andric             Descriptor, ELFT::TargetEndianness == llvm::endianness::little,
78178bcb0991SDimitry Andric             sizeof(Elf_Addr));
7818fe6060f1SDimitry Andric         if (Expected<CoreNote> N = readCoreNote(DescExtractor)) {
7819fe6060f1SDimitry Andric           printCoreNoteLLVMStyle(*N, W);
7820fe6060f1SDimitry Andric           return Error::success();
7821fe6060f1SDimitry Andric         } else {
7822fe6060f1SDimitry Andric           return N.takeError();
78238bcb0991SDimitry Andric         }
7824fe6060f1SDimitry Andric       }
782581ad6265SDimitry Andric     } else if (Name == "Android") {
782681ad6265SDimitry Andric       if (printAndroidNoteLLVMStyle(Type, Descriptor, W))
782781ad6265SDimitry Andric         return Error::success();
78285f757f3fSDimitry Andric     } else if (Name == "ARM") {
78295f757f3fSDimitry Andric       if (printAarch64NoteLLVMStyle<ELFT>(Type, Descriptor, W))
78305f757f3fSDimitry Andric         return Error::success();
7831fe6060f1SDimitry Andric     }
7832fe6060f1SDimitry Andric     if (!Descriptor.empty()) {
78338bcb0991SDimitry Andric       W.printBinaryBlock("Description data", Descriptor);
78348bcb0991SDimitry Andric     }
7835e8d8bef9SDimitry Andric     return Error::success();
78360b57cec5SDimitry Andric   };
78370b57cec5SDimitry Andric 
783806c3fb27SDimitry Andric   processNotesHelper(*this, /*StartNotesFn=*/StartNotes,
783906c3fb27SDimitry Andric                      /*ProcessNoteFn=*/ProcessNote, /*FinishNotesFn=*/EndNotes);
78405ffd83dbSDimitry Andric }
78415ffd83dbSDimitry Andric 
printELFLinkerOptions()7842e8d8bef9SDimitry Andric template <class ELFT> void LLVMELFDumper<ELFT>::printELFLinkerOptions() {
78430b57cec5SDimitry Andric   ListScope L(W, "LinkerOptions");
78440b57cec5SDimitry Andric 
7845480093f4SDimitry Andric   unsigned I = -1;
7846e8d8bef9SDimitry Andric   for (const Elf_Shdr &Shdr : cantFail(this->Obj.sections())) {
7847480093f4SDimitry Andric     ++I;
78480b57cec5SDimitry Andric     if (Shdr.sh_type != ELF::SHT_LLVM_LINKER_OPTIONS)
78490b57cec5SDimitry Andric       continue;
78500b57cec5SDimitry Andric 
7851e8d8bef9SDimitry Andric     Expected<ArrayRef<uint8_t>> ContentsOrErr =
7852e8d8bef9SDimitry Andric         this->Obj.getSectionContents(Shdr);
78535ffd83dbSDimitry Andric     if (!ContentsOrErr) {
7854e8d8bef9SDimitry Andric       this->reportUniqueWarning("unable to read the content of the "
78555ffd83dbSDimitry Andric                                 "SHT_LLVM_LINKER_OPTIONS section: " +
7856e8d8bef9SDimitry Andric                                 toString(ContentsOrErr.takeError()));
78575ffd83dbSDimitry Andric       continue;
78585ffd83dbSDimitry Andric     }
78595ffd83dbSDimitry Andric     if (ContentsOrErr->empty())
7860480093f4SDimitry Andric       continue;
78610b57cec5SDimitry Andric 
78625ffd83dbSDimitry Andric     if (ContentsOrErr->back() != 0) {
7863e8d8bef9SDimitry Andric       this->reportUniqueWarning("SHT_LLVM_LINKER_OPTIONS section at index " +
7864e8d8bef9SDimitry Andric                                 Twine(I) +
7865480093f4SDimitry Andric                                 " is broken: the "
7866e8d8bef9SDimitry Andric                                 "content is not null-terminated");
7867480093f4SDimitry Andric       continue;
7868480093f4SDimitry Andric     }
78690b57cec5SDimitry Andric 
7870480093f4SDimitry Andric     SmallVector<StringRef, 16> Strings;
78715ffd83dbSDimitry Andric     toStringRef(ContentsOrErr->drop_back()).split(Strings, '\0');
7872480093f4SDimitry Andric     if (Strings.size() % 2 != 0) {
7873e8d8bef9SDimitry Andric       this->reportUniqueWarning(
7874480093f4SDimitry Andric           "SHT_LLVM_LINKER_OPTIONS section at index " + Twine(I) +
7875480093f4SDimitry Andric           " is broken: an incomplete "
7876480093f4SDimitry Andric           "key-value pair was found. The last possible key was: \"" +
7877e8d8bef9SDimitry Andric           Strings.back() + "\"");
7878480093f4SDimitry Andric       continue;
7879480093f4SDimitry Andric     }
7880480093f4SDimitry Andric 
7881480093f4SDimitry Andric     for (size_t I = 0; I < Strings.size(); I += 2)
7882480093f4SDimitry Andric       W.printString(Strings[I], Strings[I + 1]);
7883480093f4SDimitry Andric   }
7884480093f4SDimitry Andric }
7885480093f4SDimitry Andric 
printDependentLibs()7886e8d8bef9SDimitry Andric template <class ELFT> void LLVMELFDumper<ELFT>::printDependentLibs() {
7887480093f4SDimitry Andric   ListScope L(W, "DependentLibs");
78885ffd83dbSDimitry Andric   this->printDependentLibsHelper(
7889e8d8bef9SDimitry Andric       [](const Elf_Shdr &) {},
78905ffd83dbSDimitry Andric       [this](StringRef Lib, uint64_t) { W.printString(Lib); });
78910b57cec5SDimitry Andric }
78920b57cec5SDimitry Andric 
printStackSizes()7893e8d8bef9SDimitry Andric template <class ELFT> void LLVMELFDumper<ELFT>::printStackSizes() {
78948bcb0991SDimitry Andric   ListScope L(W, "StackSizes");
7895e8d8bef9SDimitry Andric   if (this->Obj.getHeader().e_type == ELF::ET_REL)
7896e8d8bef9SDimitry Andric     this->printRelocatableStackSizes([]() {});
78978bcb0991SDimitry Andric   else
7898e8d8bef9SDimitry Andric     this->printNonRelocatableStackSizes([]() {});
78998bcb0991SDimitry Andric }
79008bcb0991SDimitry Andric 
79018bcb0991SDimitry Andric template <class ELFT>
printStackSizeEntry(uint64_t Size,ArrayRef<std::string> FuncNames)7902fe6060f1SDimitry Andric void LLVMELFDumper<ELFT>::printStackSizeEntry(uint64_t Size,
7903fe6060f1SDimitry Andric                                               ArrayRef<std::string> FuncNames) {
79048bcb0991SDimitry Andric   DictScope D(W, "Entry");
7905fe6060f1SDimitry Andric   W.printList("Functions", FuncNames);
79068bcb0991SDimitry Andric   W.printHex("Size", Size);
79078bcb0991SDimitry Andric }
79088bcb0991SDimitry Andric 
79098bcb0991SDimitry Andric template <class ELFT>
printMipsGOT(const MipsGOTParser<ELFT> & Parser)7910e8d8bef9SDimitry Andric void LLVMELFDumper<ELFT>::printMipsGOT(const MipsGOTParser<ELFT> &Parser) {
79110b57cec5SDimitry Andric   auto PrintEntry = [&](const Elf_Addr *E) {
79120b57cec5SDimitry Andric     W.printHex("Address", Parser.getGotAddress(E));
79130b57cec5SDimitry Andric     W.printNumber("Access", Parser.getGotOffset(E));
79140b57cec5SDimitry Andric     W.printHex("Initial", *E);
79150b57cec5SDimitry Andric   };
79160b57cec5SDimitry Andric 
79170b57cec5SDimitry Andric   DictScope GS(W, Parser.IsStatic ? "Static GOT" : "Primary GOT");
79180b57cec5SDimitry Andric 
79190b57cec5SDimitry Andric   W.printHex("Canonical gp value", Parser.getGp());
79200b57cec5SDimitry Andric   {
79210b57cec5SDimitry Andric     ListScope RS(W, "Reserved entries");
79220b57cec5SDimitry Andric     {
79230b57cec5SDimitry Andric       DictScope D(W, "Entry");
79240b57cec5SDimitry Andric       PrintEntry(Parser.getGotLazyResolver());
79250b57cec5SDimitry Andric       W.printString("Purpose", StringRef("Lazy resolver"));
79260b57cec5SDimitry Andric     }
79270b57cec5SDimitry Andric 
79280b57cec5SDimitry Andric     if (Parser.getGotModulePointer()) {
79290b57cec5SDimitry Andric       DictScope D(W, "Entry");
79300b57cec5SDimitry Andric       PrintEntry(Parser.getGotModulePointer());
79310b57cec5SDimitry Andric       W.printString("Purpose", StringRef("Module pointer (GNU extension)"));
79320b57cec5SDimitry Andric     }
79330b57cec5SDimitry Andric   }
79340b57cec5SDimitry Andric   {
79350b57cec5SDimitry Andric     ListScope LS(W, "Local entries");
79360b57cec5SDimitry Andric     for (auto &E : Parser.getLocalEntries()) {
79370b57cec5SDimitry Andric       DictScope D(W, "Entry");
79380b57cec5SDimitry Andric       PrintEntry(&E);
79390b57cec5SDimitry Andric     }
79400b57cec5SDimitry Andric   }
79410b57cec5SDimitry Andric 
79420b57cec5SDimitry Andric   if (Parser.IsStatic)
79430b57cec5SDimitry Andric     return;
79440b57cec5SDimitry Andric 
79450b57cec5SDimitry Andric   {
79460b57cec5SDimitry Andric     ListScope GS(W, "Global entries");
79470b57cec5SDimitry Andric     for (auto &E : Parser.getGlobalEntries()) {
79480b57cec5SDimitry Andric       DictScope D(W, "Entry");
79490b57cec5SDimitry Andric 
79500b57cec5SDimitry Andric       PrintEntry(&E);
79510b57cec5SDimitry Andric 
7952e8d8bef9SDimitry Andric       const Elf_Sym &Sym = *Parser.getGotSym(&E);
7953e8d8bef9SDimitry Andric       W.printHex("Value", Sym.st_value);
7954bdd1243dSDimitry Andric       W.printEnum("Type", Sym.getType(), ArrayRef(ElfSymbolTypes));
79550b57cec5SDimitry Andric 
7956e8d8bef9SDimitry Andric       const unsigned SymIndex = &Sym - this->dynamic_symbols().begin();
7957e8d8bef9SDimitry Andric       DataRegion<Elf_Word> ShndxTable(
7958e8d8bef9SDimitry Andric           (const Elf_Word *)this->DynSymTabShndxRegion.Addr, this->Obj.end());
7959e8d8bef9SDimitry Andric       printSymbolSection(Sym, SymIndex, ShndxTable);
7960e8d8bef9SDimitry Andric 
7961e8d8bef9SDimitry Andric       std::string SymName = this->getFullSymbolName(
7962e8d8bef9SDimitry Andric           Sym, SymIndex, ShndxTable, this->DynamicStringTable, true);
7963e8d8bef9SDimitry Andric       W.printNumber("Name", SymName, Sym.st_name);
79640b57cec5SDimitry Andric     }
79650b57cec5SDimitry Andric   }
79660b57cec5SDimitry Andric 
79670b57cec5SDimitry Andric   W.printNumber("Number of TLS and multi-GOT entries",
79680b57cec5SDimitry Andric                 uint64_t(Parser.getOtherEntries().size()));
79690b57cec5SDimitry Andric }
79700b57cec5SDimitry Andric 
79710b57cec5SDimitry Andric template <class ELFT>
printMipsPLT(const MipsGOTParser<ELFT> & Parser)7972e8d8bef9SDimitry Andric void LLVMELFDumper<ELFT>::printMipsPLT(const MipsGOTParser<ELFT> &Parser) {
79730b57cec5SDimitry Andric   auto PrintEntry = [&](const Elf_Addr *E) {
79740b57cec5SDimitry Andric     W.printHex("Address", Parser.getPltAddress(E));
79750b57cec5SDimitry Andric     W.printHex("Initial", *E);
79760b57cec5SDimitry Andric   };
79770b57cec5SDimitry Andric 
79780b57cec5SDimitry Andric   DictScope GS(W, "PLT GOT");
79790b57cec5SDimitry Andric 
79800b57cec5SDimitry Andric   {
79810b57cec5SDimitry Andric     ListScope RS(W, "Reserved entries");
79820b57cec5SDimitry Andric     {
79830b57cec5SDimitry Andric       DictScope D(W, "Entry");
79840b57cec5SDimitry Andric       PrintEntry(Parser.getPltLazyResolver());
79850b57cec5SDimitry Andric       W.printString("Purpose", StringRef("PLT lazy resolver"));
79860b57cec5SDimitry Andric     }
79870b57cec5SDimitry Andric 
79880b57cec5SDimitry Andric     if (auto E = Parser.getPltModulePointer()) {
79890b57cec5SDimitry Andric       DictScope D(W, "Entry");
79900b57cec5SDimitry Andric       PrintEntry(E);
79910b57cec5SDimitry Andric       W.printString("Purpose", StringRef("Module pointer"));
79920b57cec5SDimitry Andric     }
79930b57cec5SDimitry Andric   }
79940b57cec5SDimitry Andric   {
79950b57cec5SDimitry Andric     ListScope LS(W, "Entries");
7996e8d8bef9SDimitry Andric     DataRegion<Elf_Word> ShndxTable(
7997e8d8bef9SDimitry Andric         (const Elf_Word *)this->DynSymTabShndxRegion.Addr, this->Obj.end());
79980b57cec5SDimitry Andric     for (auto &E : Parser.getPltEntries()) {
79990b57cec5SDimitry Andric       DictScope D(W, "Entry");
80000b57cec5SDimitry Andric       PrintEntry(&E);
80010b57cec5SDimitry Andric 
8002e8d8bef9SDimitry Andric       const Elf_Sym &Sym = *Parser.getPltSym(&E);
8003e8d8bef9SDimitry Andric       W.printHex("Value", Sym.st_value);
8004bdd1243dSDimitry Andric       W.printEnum("Type", Sym.getType(), ArrayRef(ElfSymbolTypes));
8005e8d8bef9SDimitry Andric       printSymbolSection(Sym, &Sym - this->dynamic_symbols().begin(),
8006e8d8bef9SDimitry Andric                          ShndxTable);
80070b57cec5SDimitry Andric 
8008e8d8bef9SDimitry Andric       const Elf_Sym *FirstSym = cantFail(
8009e8d8bef9SDimitry Andric           this->Obj.template getEntry<Elf_Sym>(*Parser.getPltSymTable(), 0));
8010e8d8bef9SDimitry Andric       std::string SymName = this->getFullSymbolName(
8011e8d8bef9SDimitry Andric           Sym, &Sym - FirstSym, ShndxTable, Parser.getPltStrTable(), true);
8012e8d8bef9SDimitry Andric       W.printNumber("Name", SymName, Sym.st_name);
80130b57cec5SDimitry Andric     }
80140b57cec5SDimitry Andric   }
80150b57cec5SDimitry Andric }
80168bcb0991SDimitry Andric 
printMipsABIFlags()8017e8d8bef9SDimitry Andric template <class ELFT> void LLVMELFDumper<ELFT>::printMipsABIFlags() {
8018e8d8bef9SDimitry Andric   const Elf_Mips_ABIFlags<ELFT> *Flags;
8019e8d8bef9SDimitry Andric   if (Expected<const Elf_Mips_ABIFlags<ELFT> *> SecOrErr =
8020e8d8bef9SDimitry Andric           getMipsAbiFlagsSection(*this)) {
8021e8d8bef9SDimitry Andric     Flags = *SecOrErr;
8022e8d8bef9SDimitry Andric     if (!Flags) {
80238bcb0991SDimitry Andric       W.startLine() << "There is no .MIPS.abiflags section in the file.\n";
80248bcb0991SDimitry Andric       return;
80258bcb0991SDimitry Andric     }
8026e8d8bef9SDimitry Andric   } else {
8027e8d8bef9SDimitry Andric     this->reportUniqueWarning(SecOrErr.takeError());
80288bcb0991SDimitry Andric     return;
80298bcb0991SDimitry Andric   }
80308bcb0991SDimitry Andric 
80318bcb0991SDimitry Andric   raw_ostream &OS = W.getOStream();
80328bcb0991SDimitry Andric   DictScope GS(W, "MIPS ABI Flags");
80338bcb0991SDimitry Andric 
80348bcb0991SDimitry Andric   W.printNumber("Version", Flags->version);
80358bcb0991SDimitry Andric   W.startLine() << "ISA: ";
80368bcb0991SDimitry Andric   if (Flags->isa_rev <= 1)
80378bcb0991SDimitry Andric     OS << format("MIPS%u", Flags->isa_level);
80388bcb0991SDimitry Andric   else
80398bcb0991SDimitry Andric     OS << format("MIPS%ur%u", Flags->isa_level, Flags->isa_rev);
80408bcb0991SDimitry Andric   OS << "\n";
8041bdd1243dSDimitry Andric   W.printEnum("ISA Extension", Flags->isa_ext, ArrayRef(ElfMipsISAExtType));
8042bdd1243dSDimitry Andric   W.printFlags("ASEs", Flags->ases, ArrayRef(ElfMipsASEFlags));
8043bdd1243dSDimitry Andric   W.printEnum("FP ABI", Flags->fp_abi, ArrayRef(ElfMipsFpABIType));
80448bcb0991SDimitry Andric   W.printNumber("GPR size", getMipsRegisterSize(Flags->gpr_size));
80458bcb0991SDimitry Andric   W.printNumber("CPR1 size", getMipsRegisterSize(Flags->cpr1_size));
80468bcb0991SDimitry Andric   W.printNumber("CPR2 size", getMipsRegisterSize(Flags->cpr2_size));
8047bdd1243dSDimitry Andric   W.printFlags("Flags 1", Flags->flags1, ArrayRef(ElfMipsFlags1));
80488bcb0991SDimitry Andric   W.printHex("Flags 2", Flags->flags2);
80498bcb0991SDimitry Andric }
80500eae32dcSDimitry Andric 
80510eae32dcSDimitry Andric template <class ELFT>
printFileSummary(StringRef FileStr,ObjectFile & Obj,ArrayRef<std::string> InputFilenames,const Archive * A)80520eae32dcSDimitry Andric void JSONELFDumper<ELFT>::printFileSummary(StringRef FileStr, ObjectFile &Obj,
80530eae32dcSDimitry Andric                                            ArrayRef<std::string> InputFilenames,
80540eae32dcSDimitry Andric                                            const Archive *A) {
8055bdd1243dSDimitry Andric   FileScope = std::make_unique<DictScope>(this->W);
80560eae32dcSDimitry Andric   DictScope D(this->W, "FileSummary");
80570eae32dcSDimitry Andric   this->W.printString("File", FileStr);
80580eae32dcSDimitry Andric   this->W.printString("Format", Obj.getFileFormatName());
80590eae32dcSDimitry Andric   this->W.printString("Arch", Triple::getArchTypeName(Obj.getArch()));
80600eae32dcSDimitry Andric   this->W.printString(
80610eae32dcSDimitry Andric       "AddressSize",
80620eae32dcSDimitry Andric       std::string(formatv("{0}bit", 8 * Obj.getBytesInAddress())));
80630eae32dcSDimitry Andric   this->printLoadName();
80640eae32dcSDimitry Andric }
806506c3fb27SDimitry Andric 
806606c3fb27SDimitry Andric template <class ELFT>
printZeroSymbolOtherField(const Elf_Sym & Symbol) const806706c3fb27SDimitry Andric void JSONELFDumper<ELFT>::printZeroSymbolOtherField(
806806c3fb27SDimitry Andric     const Elf_Sym &Symbol) const {
806906c3fb27SDimitry Andric   // We want the JSON format to be uniform, since it is machine readable, so
807006c3fb27SDimitry Andric   // always print the `Other` field the same way.
807106c3fb27SDimitry Andric   this->printSymbolOtherField(Symbol);
807206c3fb27SDimitry Andric }
807306c3fb27SDimitry Andric 
807406c3fb27SDimitry Andric template <class ELFT>
printDefaultRelRelaReloc(const Relocation<ELFT> & R,StringRef SymbolName,StringRef RelocName)807506c3fb27SDimitry Andric void JSONELFDumper<ELFT>::printDefaultRelRelaReloc(const Relocation<ELFT> &R,
807606c3fb27SDimitry Andric                                                    StringRef SymbolName,
807706c3fb27SDimitry Andric                                                    StringRef RelocName) {
807806c3fb27SDimitry Andric   this->printExpandedRelRelaReloc(R, SymbolName, RelocName);
807906c3fb27SDimitry Andric }
808006c3fb27SDimitry Andric 
808106c3fb27SDimitry Andric template <class ELFT>
printRelocationSectionInfo(const Elf_Shdr & Sec,StringRef Name,const unsigned SecNdx)808206c3fb27SDimitry Andric void JSONELFDumper<ELFT>::printRelocationSectionInfo(const Elf_Shdr &Sec,
808306c3fb27SDimitry Andric                                                      StringRef Name,
808406c3fb27SDimitry Andric                                                      const unsigned SecNdx) {
808506c3fb27SDimitry Andric   DictScope Group(this->W);
808606c3fb27SDimitry Andric   this->W.printNumber("SectionIndex", SecNdx);
808706c3fb27SDimitry Andric   ListScope D(this->W, "Relocs");
808806c3fb27SDimitry Andric   this->printRelocationsHelper(Sec);
808906c3fb27SDimitry Andric }
809006c3fb27SDimitry Andric 
809106c3fb27SDimitry Andric template <class ELFT>
getGroupSectionHeaderName() const809206c3fb27SDimitry Andric std::string JSONELFDumper<ELFT>::getGroupSectionHeaderName() const {
809306c3fb27SDimitry Andric   return "GroupSections";
809406c3fb27SDimitry Andric }
809506c3fb27SDimitry Andric 
809606c3fb27SDimitry Andric template <class ELFT>
printSectionGroupMembers(StringRef Name,uint64_t Idx) const809706c3fb27SDimitry Andric void JSONELFDumper<ELFT>::printSectionGroupMembers(StringRef Name,
809806c3fb27SDimitry Andric                                                    uint64_t Idx) const {
809906c3fb27SDimitry Andric   DictScope Grp(this->W);
810006c3fb27SDimitry Andric   this->W.printString("Name", Name);
810106c3fb27SDimitry Andric   this->W.printNumber("Index", Idx);
810206c3fb27SDimitry Andric }
810306c3fb27SDimitry Andric 
printEmptyGroupMessage() const810406c3fb27SDimitry Andric template <class ELFT> void JSONELFDumper<ELFT>::printEmptyGroupMessage() const {
810506c3fb27SDimitry Andric   // JSON output does not need to print anything for empty groups
810606c3fb27SDimitry Andric }
8107