Path: blob/main/contrib/llvm-project/llvm/tools/llvm-readobj/COFFDumper.cpp
35231 views
//===-- COFFDumper.cpp - COFF-specific dumper -------------------*- C++ -*-===//1//2// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.3// See https://llvm.org/LICENSE.txt for license information.4// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception5//6//===----------------------------------------------------------------------===//7///8/// \file9/// This file implements the COFF-specific dumper for llvm-readobj.10///11//===----------------------------------------------------------------------===//1213#include "ARMWinEHPrinter.h"14#include "ObjDumper.h"15#include "StackMapPrinter.h"16#include "Win64EHDumper.h"17#include "llvm-readobj.h"18#include "llvm/ADT/DenseMap.h"19#include "llvm/ADT/SmallString.h"20#include "llvm/ADT/StringExtras.h"21#include "llvm/BinaryFormat/COFF.h"22#include "llvm/DebugInfo/CodeView/CVTypeVisitor.h"23#include "llvm/DebugInfo/CodeView/CodeView.h"24#include "llvm/DebugInfo/CodeView/DebugChecksumsSubsection.h"25#include "llvm/DebugInfo/CodeView/DebugFrameDataSubsection.h"26#include "llvm/DebugInfo/CodeView/DebugInlineeLinesSubsection.h"27#include "llvm/DebugInfo/CodeView/DebugLinesSubsection.h"28#include "llvm/DebugInfo/CodeView/DebugStringTableSubsection.h"29#include "llvm/DebugInfo/CodeView/Formatters.h"30#include "llvm/DebugInfo/CodeView/LazyRandomTypeCollection.h"31#include "llvm/DebugInfo/CodeView/Line.h"32#include "llvm/DebugInfo/CodeView/MergingTypeTableBuilder.h"33#include "llvm/DebugInfo/CodeView/RecordSerialization.h"34#include "llvm/DebugInfo/CodeView/SymbolDumpDelegate.h"35#include "llvm/DebugInfo/CodeView/SymbolDumper.h"36#include "llvm/DebugInfo/CodeView/SymbolRecord.h"37#include "llvm/DebugInfo/CodeView/TypeDumpVisitor.h"38#include "llvm/DebugInfo/CodeView/TypeHashing.h"39#include "llvm/DebugInfo/CodeView/TypeIndex.h"40#include "llvm/DebugInfo/CodeView/TypeRecord.h"41#include "llvm/DebugInfo/CodeView/TypeStreamMerger.h"42#include "llvm/DebugInfo/CodeView/TypeTableCollection.h"43#include "llvm/Object/COFF.h"44#include "llvm/Object/ObjectFile.h"45#include "llvm/Object/WindowsResource.h"46#include "llvm/Support/BinaryStreamReader.h"47#include "llvm/Support/Casting.h"48#include "llvm/Support/Compiler.h"49#include "llvm/Support/ConvertUTF.h"50#include "llvm/Support/FormatVariadic.h"51#include "llvm/Support/LEB128.h"52#include "llvm/Support/ScopedPrinter.h"53#include "llvm/Support/Win64EH.h"54#include "llvm/Support/raw_ostream.h"55#include <ctime>5657using namespace llvm;58using namespace llvm::object;59using namespace llvm::codeview;60using namespace llvm::support;61using namespace llvm::Win64EH;6263namespace {6465struct LoadConfigTables {66uint64_t SEHTableVA = 0;67uint64_t SEHTableCount = 0;68uint32_t GuardFlags = 0;69uint64_t GuardFidTableVA = 0;70uint64_t GuardFidTableCount = 0;71uint64_t GuardIatTableVA = 0;72uint64_t GuardIatTableCount = 0;73uint64_t GuardLJmpTableVA = 0;74uint64_t GuardLJmpTableCount = 0;75uint64_t GuardEHContTableVA = 0;76uint64_t GuardEHContTableCount = 0;77};7879class COFFDumper : public ObjDumper {80public:81friend class COFFObjectDumpDelegate;82COFFDumper(const llvm::object::COFFObjectFile *Obj, ScopedPrinter &Writer)83: ObjDumper(Writer, Obj->getFileName()), Obj(Obj), Writer(Writer),84Types(100) {}8586void printFileHeaders() override;87void printSectionHeaders() override;88void printRelocations() override;89void printUnwindInfo() override;9091void printNeededLibraries() override;9293void printCOFFImports() override;94void printCOFFExports() override;95void printCOFFDirectives() override;96void printCOFFBaseReloc() override;97void printCOFFDebugDirectory() override;98void printCOFFTLSDirectory() override;99void printCOFFResources() override;100void printCOFFLoadConfig() override;101void printCodeViewDebugInfo() override;102void mergeCodeViewTypes(llvm::codeview::MergingTypeTableBuilder &CVIDs,103llvm::codeview::MergingTypeTableBuilder &CVTypes,104llvm::codeview::GlobalTypeTableBuilder &GlobalCVIDs,105llvm::codeview::GlobalTypeTableBuilder &GlobalCVTypes,106bool GHash) override;107void printStackMap() const override;108void printAddrsig() override;109void printCGProfile() override;110111private:112StringRef getSymbolName(uint32_t Index);113void printSymbols(bool ExtraSymInfo) override;114void printDynamicSymbols() override;115void printSymbol(const SymbolRef &Sym);116void printRelocation(const SectionRef &Section, const RelocationRef &Reloc,117uint64_t Bias = 0);118void printDataDirectory(uint32_t Index, const std::string &FieldName);119120void printDOSHeader(const dos_header *DH);121template <class PEHeader> void printPEHeader(const PEHeader *Hdr);122void printBaseOfDataField(const pe32_header *Hdr);123void printBaseOfDataField(const pe32plus_header *Hdr);124template <typename T>125void printCOFFLoadConfig(const T *Conf, LoadConfigTables &Tables);126template <typename IntTy>127void printCOFFTLSDirectory(const coff_tls_directory<IntTy> *TlsTable);128typedef void (*PrintExtraCB)(raw_ostream &, const uint8_t *);129void printRVATable(uint64_t TableVA, uint64_t Count, uint64_t EntrySize,130PrintExtraCB PrintExtra = nullptr);131132void printCodeViewSymbolSection(StringRef SectionName, const SectionRef &Section);133void printCodeViewTypeSection(StringRef SectionName, const SectionRef &Section);134StringRef getFileNameForFileOffset(uint32_t FileOffset);135void printFileNameForOffset(StringRef Label, uint32_t FileOffset);136void printTypeIndex(StringRef FieldName, TypeIndex TI) {137// Forward to CVTypeDumper for simplicity.138codeview::printTypeIndex(Writer, FieldName, TI, Types);139}140141void printCodeViewSymbolsSubsection(StringRef Subsection,142const SectionRef &Section,143StringRef SectionContents);144145void printCodeViewFileChecksums(StringRef Subsection);146147void printCodeViewInlineeLines(StringRef Subsection);148149void printRelocatedField(StringRef Label, const coff_section *Sec,150uint32_t RelocOffset, uint32_t Offset,151StringRef *RelocSym = nullptr);152153uint32_t countTotalTableEntries(ResourceSectionRef RSF,154const coff_resource_dir_table &Table,155StringRef Level);156157void printResourceDirectoryTable(ResourceSectionRef RSF,158const coff_resource_dir_table &Table,159StringRef Level);160161void printBinaryBlockWithRelocs(StringRef Label, const SectionRef &Sec,162StringRef SectionContents, StringRef Block);163164/// Given a .debug$S section, find the string table and file checksum table.165void initializeFileAndStringTables(BinaryStreamReader &Reader);166167void cacheRelocations();168169std::error_code resolveSymbol(const coff_section *Section, uint64_t Offset,170SymbolRef &Sym);171std::error_code resolveSymbolName(const coff_section *Section,172uint64_t Offset, StringRef &Name);173std::error_code resolveSymbolName(const coff_section *Section,174StringRef SectionContents,175const void *RelocPtr, StringRef &Name);176void printImportedSymbols(iterator_range<imported_symbol_iterator> Range);177void printDelayImportedSymbols(178const DelayImportDirectoryEntryRef &I,179iterator_range<imported_symbol_iterator> Range);180181typedef DenseMap<const coff_section*, std::vector<RelocationRef> > RelocMapTy;182183const llvm::object::COFFObjectFile *Obj;184bool RelocCached = false;185RelocMapTy RelocMap;186187DebugChecksumsSubsectionRef CVFileChecksumTable;188189DebugStringTableSubsectionRef CVStringTable;190191/// Track the compilation CPU type. S_COMPILE3 symbol records typically come192/// first, but if we don't see one, just assume an X64 CPU type. It is common.193CPUType CompilationCPUType = CPUType::X64;194195ScopedPrinter &Writer;196LazyRandomTypeCollection Types;197};198199class COFFObjectDumpDelegate : public SymbolDumpDelegate {200public:201COFFObjectDumpDelegate(COFFDumper &CD, const SectionRef &SR,202const COFFObjectFile *Obj, StringRef SectionContents)203: CD(CD), SR(SR), SectionContents(SectionContents) {204Sec = Obj->getCOFFSection(SR);205}206207uint32_t getRecordOffset(BinaryStreamReader Reader) override {208ArrayRef<uint8_t> Data;209if (auto EC = Reader.readLongestContiguousChunk(Data)) {210llvm::consumeError(std::move(EC));211return 0;212}213return Data.data() - SectionContents.bytes_begin();214}215216void printRelocatedField(StringRef Label, uint32_t RelocOffset,217uint32_t Offset, StringRef *RelocSym) override {218CD.printRelocatedField(Label, Sec, RelocOffset, Offset, RelocSym);219}220221void printBinaryBlockWithRelocs(StringRef Label,222ArrayRef<uint8_t> Block) override {223StringRef SBlock(reinterpret_cast<const char *>(Block.data()),224Block.size());225if (opts::CodeViewSubsectionBytes)226CD.printBinaryBlockWithRelocs(Label, SR, SectionContents, SBlock);227}228229StringRef getFileNameForFileOffset(uint32_t FileOffset) override {230return CD.getFileNameForFileOffset(FileOffset);231}232233DebugStringTableSubsectionRef getStringTable() override {234return CD.CVStringTable;235}236237private:238COFFDumper &CD;239const SectionRef &SR;240const coff_section *Sec;241StringRef SectionContents;242};243244} // end namespace245246namespace llvm {247248std::unique_ptr<ObjDumper> createCOFFDumper(const object::COFFObjectFile &Obj,249ScopedPrinter &Writer) {250return std::make_unique<COFFDumper>(&Obj, Writer);251}252253} // namespace llvm254255// Given a section and an offset into this section the function returns the256// symbol used for the relocation at the offset.257std::error_code COFFDumper::resolveSymbol(const coff_section *Section,258uint64_t Offset, SymbolRef &Sym) {259cacheRelocations();260const auto &Relocations = RelocMap[Section];261auto SymI = Obj->symbol_end();262for (const auto &Relocation : Relocations) {263uint64_t RelocationOffset = Relocation.getOffset();264265if (RelocationOffset == Offset) {266SymI = Relocation.getSymbol();267break;268}269}270if (SymI == Obj->symbol_end())271return inconvertibleErrorCode();272Sym = *SymI;273return std::error_code();274}275276// Given a section and an offset into this section the function returns the name277// of the symbol used for the relocation at the offset.278std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,279uint64_t Offset,280StringRef &Name) {281SymbolRef Symbol;282if (std::error_code EC = resolveSymbol(Section, Offset, Symbol))283return EC;284Expected<StringRef> NameOrErr = Symbol.getName();285if (!NameOrErr)286return errorToErrorCode(NameOrErr.takeError());287Name = *NameOrErr;288return std::error_code();289}290291// Helper for when you have a pointer to real data and you want to know about292// relocations against it.293std::error_code COFFDumper::resolveSymbolName(const coff_section *Section,294StringRef SectionContents,295const void *RelocPtr,296StringRef &Name) {297assert(SectionContents.data() < RelocPtr &&298RelocPtr < SectionContents.data() + SectionContents.size() &&299"pointer to relocated object is not in section");300uint64_t Offset = ptrdiff_t(reinterpret_cast<const char *>(RelocPtr) -301SectionContents.data());302return resolveSymbolName(Section, Offset, Name);303}304305void COFFDumper::printRelocatedField(StringRef Label, const coff_section *Sec,306uint32_t RelocOffset, uint32_t Offset,307StringRef *RelocSym) {308StringRef SymStorage;309StringRef &Symbol = RelocSym ? *RelocSym : SymStorage;310if (!resolveSymbolName(Sec, RelocOffset, Symbol))311W.printSymbolOffset(Label, Symbol, Offset);312else313W.printHex(Label, RelocOffset);314}315316void COFFDumper::printBinaryBlockWithRelocs(StringRef Label,317const SectionRef &Sec,318StringRef SectionContents,319StringRef Block) {320W.printBinaryBlock(Label, Block);321322assert(SectionContents.begin() < Block.begin() &&323SectionContents.end() >= Block.end() &&324"Block is not contained in SectionContents");325uint64_t OffsetStart = Block.data() - SectionContents.data();326uint64_t OffsetEnd = OffsetStart + Block.size();327328W.flush();329cacheRelocations();330ListScope D(W, "BlockRelocations");331const coff_section *Section = Obj->getCOFFSection(Sec);332const auto &Relocations = RelocMap[Section];333for (const auto &Relocation : Relocations) {334uint64_t RelocationOffset = Relocation.getOffset();335if (OffsetStart <= RelocationOffset && RelocationOffset < OffsetEnd)336printRelocation(Sec, Relocation, OffsetStart);337}338}339340const EnumEntry<COFF::MachineTypes> ImageFileMachineType[] = {341LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_UNKNOWN ),342LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AM33 ),343LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AMD64 ),344LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM ),345LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM64 ),346LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM64EC ),347LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM64X ),348LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARMNT ),349LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_EBC ),350LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_I386 ),351LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_IA64 ),352LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_M32R ),353LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPS16 ),354LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU ),355LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU16),356LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPC ),357LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPCFP),358LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_R4000 ),359LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3 ),360LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3DSP ),361LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH4 ),362LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH5 ),363LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_THUMB ),364LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_WCEMIPSV2)365};366367const EnumEntry<COFF::Characteristics> ImageFileCharacteristics[] = {368LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_RELOCS_STRIPPED ),369LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_EXECUTABLE_IMAGE ),370LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LINE_NUMS_STRIPPED ),371LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LOCAL_SYMS_STRIPPED ),372LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_AGGRESSIVE_WS_TRIM ),373LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LARGE_ADDRESS_AWARE ),374LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_LO ),375LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_32BIT_MACHINE ),376LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DEBUG_STRIPPED ),377LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP),378LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_NET_RUN_FROM_SWAP ),379LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_SYSTEM ),380LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DLL ),381LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_UP_SYSTEM_ONLY ),382LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_HI )383};384385const EnumEntry<COFF::WindowsSubsystem> PEWindowsSubsystem[] = {386LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_UNKNOWN ),387LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_NATIVE ),388LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_GUI ),389LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CUI ),390LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_POSIX_CUI ),391LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CE_GUI ),392LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_APPLICATION ),393LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER),394LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER ),395LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_ROM ),396LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_XBOX ),397};398399const EnumEntry<COFF::DLLCharacteristics> PEDLLCharacteristics[] = {400LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA ),401LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE ),402LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY ),403LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NX_COMPAT ),404LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION ),405LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_SEH ),406LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_BIND ),407LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_APPCONTAINER ),408LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER ),409LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_GUARD_CF ),410LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE),411};412413static const EnumEntry<COFF::ExtendedDLLCharacteristics>414PEExtendedDLLCharacteristics[] = {415LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_EX_CET_COMPAT),416};417418static const EnumEntry<COFF::SectionCharacteristics>419ImageSectionCharacteristics[] = {420LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NOLOAD ),421LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NO_PAD ),422LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_CODE ),423LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_INITIALIZED_DATA ),424LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_UNINITIALIZED_DATA),425LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_OTHER ),426LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_INFO ),427LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_REMOVE ),428LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_COMDAT ),429LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_GPREL ),430LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PURGEABLE ),431LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_16BIT ),432LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_LOCKED ),433LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PRELOAD ),434LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1BYTES ),435LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2BYTES ),436LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4BYTES ),437LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8BYTES ),438LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_16BYTES ),439LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_32BYTES ),440LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_64BYTES ),441LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_128BYTES ),442LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_256BYTES ),443LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_512BYTES ),444LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1024BYTES ),445LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2048BYTES ),446LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4096BYTES ),447LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8192BYTES ),448LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_NRELOC_OVFL ),449LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_DISCARDABLE ),450LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_CACHED ),451LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_PAGED ),452LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_SHARED ),453LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_EXECUTE ),454LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_READ ),455LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_WRITE )456};457458const EnumEntry<COFF::SymbolBaseType> ImageSymType[] = {459{ "Null" , COFF::IMAGE_SYM_TYPE_NULL },460{ "Void" , COFF::IMAGE_SYM_TYPE_VOID },461{ "Char" , COFF::IMAGE_SYM_TYPE_CHAR },462{ "Short" , COFF::IMAGE_SYM_TYPE_SHORT },463{ "Int" , COFF::IMAGE_SYM_TYPE_INT },464{ "Long" , COFF::IMAGE_SYM_TYPE_LONG },465{ "Float" , COFF::IMAGE_SYM_TYPE_FLOAT },466{ "Double", COFF::IMAGE_SYM_TYPE_DOUBLE },467{ "Struct", COFF::IMAGE_SYM_TYPE_STRUCT },468{ "Union" , COFF::IMAGE_SYM_TYPE_UNION },469{ "Enum" , COFF::IMAGE_SYM_TYPE_ENUM },470{ "MOE" , COFF::IMAGE_SYM_TYPE_MOE },471{ "Byte" , COFF::IMAGE_SYM_TYPE_BYTE },472{ "Word" , COFF::IMAGE_SYM_TYPE_WORD },473{ "UInt" , COFF::IMAGE_SYM_TYPE_UINT },474{ "DWord" , COFF::IMAGE_SYM_TYPE_DWORD }475};476477const EnumEntry<COFF::SymbolComplexType> ImageSymDType[] = {478{ "Null" , COFF::IMAGE_SYM_DTYPE_NULL },479{ "Pointer" , COFF::IMAGE_SYM_DTYPE_POINTER },480{ "Function", COFF::IMAGE_SYM_DTYPE_FUNCTION },481{ "Array" , COFF::IMAGE_SYM_DTYPE_ARRAY }482};483484const EnumEntry<COFF::SymbolStorageClass> ImageSymClass[] = {485{ "EndOfFunction" , COFF::IMAGE_SYM_CLASS_END_OF_FUNCTION },486{ "Null" , COFF::IMAGE_SYM_CLASS_NULL },487{ "Automatic" , COFF::IMAGE_SYM_CLASS_AUTOMATIC },488{ "External" , COFF::IMAGE_SYM_CLASS_EXTERNAL },489{ "Static" , COFF::IMAGE_SYM_CLASS_STATIC },490{ "Register" , COFF::IMAGE_SYM_CLASS_REGISTER },491{ "ExternalDef" , COFF::IMAGE_SYM_CLASS_EXTERNAL_DEF },492{ "Label" , COFF::IMAGE_SYM_CLASS_LABEL },493{ "UndefinedLabel" , COFF::IMAGE_SYM_CLASS_UNDEFINED_LABEL },494{ "MemberOfStruct" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_STRUCT },495{ "Argument" , COFF::IMAGE_SYM_CLASS_ARGUMENT },496{ "StructTag" , COFF::IMAGE_SYM_CLASS_STRUCT_TAG },497{ "MemberOfUnion" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_UNION },498{ "UnionTag" , COFF::IMAGE_SYM_CLASS_UNION_TAG },499{ "TypeDefinition" , COFF::IMAGE_SYM_CLASS_TYPE_DEFINITION },500{ "UndefinedStatic", COFF::IMAGE_SYM_CLASS_UNDEFINED_STATIC },501{ "EnumTag" , COFF::IMAGE_SYM_CLASS_ENUM_TAG },502{ "MemberOfEnum" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_ENUM },503{ "RegisterParam" , COFF::IMAGE_SYM_CLASS_REGISTER_PARAM },504{ "BitField" , COFF::IMAGE_SYM_CLASS_BIT_FIELD },505{ "Block" , COFF::IMAGE_SYM_CLASS_BLOCK },506{ "Function" , COFF::IMAGE_SYM_CLASS_FUNCTION },507{ "EndOfStruct" , COFF::IMAGE_SYM_CLASS_END_OF_STRUCT },508{ "File" , COFF::IMAGE_SYM_CLASS_FILE },509{ "Section" , COFF::IMAGE_SYM_CLASS_SECTION },510{ "WeakExternal" , COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL },511{ "CLRToken" , COFF::IMAGE_SYM_CLASS_CLR_TOKEN }512};513514const EnumEntry<COFF::COMDATType> ImageCOMDATSelect[] = {515{ "NoDuplicates", COFF::IMAGE_COMDAT_SELECT_NODUPLICATES },516{ "Any" , COFF::IMAGE_COMDAT_SELECT_ANY },517{ "SameSize" , COFF::IMAGE_COMDAT_SELECT_SAME_SIZE },518{ "ExactMatch" , COFF::IMAGE_COMDAT_SELECT_EXACT_MATCH },519{ "Associative" , COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE },520{ "Largest" , COFF::IMAGE_COMDAT_SELECT_LARGEST },521{ "Newest" , COFF::IMAGE_COMDAT_SELECT_NEWEST }522};523524const EnumEntry<COFF::DebugType> ImageDebugType[] = {525{"Unknown", COFF::IMAGE_DEBUG_TYPE_UNKNOWN},526{"COFF", COFF::IMAGE_DEBUG_TYPE_COFF},527{"CodeView", COFF::IMAGE_DEBUG_TYPE_CODEVIEW},528{"FPO", COFF::IMAGE_DEBUG_TYPE_FPO},529{"Misc", COFF::IMAGE_DEBUG_TYPE_MISC},530{"Exception", COFF::IMAGE_DEBUG_TYPE_EXCEPTION},531{"Fixup", COFF::IMAGE_DEBUG_TYPE_FIXUP},532{"OmapToSrc", COFF::IMAGE_DEBUG_TYPE_OMAP_TO_SRC},533{"OmapFromSrc", COFF::IMAGE_DEBUG_TYPE_OMAP_FROM_SRC},534{"Borland", COFF::IMAGE_DEBUG_TYPE_BORLAND},535{"Reserved10", COFF::IMAGE_DEBUG_TYPE_RESERVED10},536{"CLSID", COFF::IMAGE_DEBUG_TYPE_CLSID},537{"VCFeature", COFF::IMAGE_DEBUG_TYPE_VC_FEATURE},538{"POGO", COFF::IMAGE_DEBUG_TYPE_POGO},539{"ILTCG", COFF::IMAGE_DEBUG_TYPE_ILTCG},540{"MPX", COFF::IMAGE_DEBUG_TYPE_MPX},541{"Repro", COFF::IMAGE_DEBUG_TYPE_REPRO},542{"ExtendedDLLCharacteristics",543COFF::IMAGE_DEBUG_TYPE_EX_DLLCHARACTERISTICS},544};545546static const EnumEntry<COFF::WeakExternalCharacteristics>547WeakExternalCharacteristics[] = {548{ "NoLibrary" , COFF::IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY },549{ "Library" , COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY },550{ "Alias" , COFF::IMAGE_WEAK_EXTERN_SEARCH_ALIAS },551{ "AntiDependency" , COFF::IMAGE_WEAK_EXTERN_ANTI_DEPENDENCY },552};553554const EnumEntry<uint32_t> SubSectionTypes[] = {555LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, Symbols),556LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, Lines),557LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, StringTable),558LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, FileChecksums),559LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, FrameData),560LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, InlineeLines),561LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, CrossScopeImports),562LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, CrossScopeExports),563LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, ILLines),564LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, FuncMDTokenMap),565LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, TypeMDTokenMap),566LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, MergedAssemblyInput),567LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, CoffSymbolRVA),568};569570const EnumEntry<uint32_t> FrameDataFlags[] = {571LLVM_READOBJ_ENUM_ENT(FrameData, HasSEH),572LLVM_READOBJ_ENUM_ENT(FrameData, HasEH),573LLVM_READOBJ_ENUM_ENT(FrameData, IsFunctionStart),574};575576const EnumEntry<uint8_t> FileChecksumKindNames[] = {577LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, None),578LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, MD5),579LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, SHA1),580LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, SHA256),581};582583const EnumEntry<uint32_t> PELoadConfigGuardFlags[] = {584LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags, CF_INSTRUMENTED),585LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags, CFW_INSTRUMENTED),586LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags, CF_FUNCTION_TABLE_PRESENT),587LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags, SECURITY_COOKIE_UNUSED),588LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags, PROTECT_DELAYLOAD_IAT),589LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags,590DELAYLOAD_IAT_IN_ITS_OWN_SECTION),591LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags,592CF_EXPORT_SUPPRESSION_INFO_PRESENT),593LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags, CF_ENABLE_EXPORT_SUPPRESSION),594LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags, CF_LONGJUMP_TABLE_PRESENT),595LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags,596EH_CONTINUATION_TABLE_PRESENT),597LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags,598CF_FUNCTION_TABLE_SIZE_5BYTES),599LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags,600CF_FUNCTION_TABLE_SIZE_6BYTES),601LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags,602CF_FUNCTION_TABLE_SIZE_7BYTES),603LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags,604CF_FUNCTION_TABLE_SIZE_8BYTES),605LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags,606CF_FUNCTION_TABLE_SIZE_9BYTES),607LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags,608CF_FUNCTION_TABLE_SIZE_10BYTES),609LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags,610CF_FUNCTION_TABLE_SIZE_11BYTES),611LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags,612CF_FUNCTION_TABLE_SIZE_12BYTES),613LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags,614CF_FUNCTION_TABLE_SIZE_13BYTES),615LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags,616CF_FUNCTION_TABLE_SIZE_14BYTES),617LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags,618CF_FUNCTION_TABLE_SIZE_15BYTES),619LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags,620CF_FUNCTION_TABLE_SIZE_16BYTES),621LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags,622CF_FUNCTION_TABLE_SIZE_17BYTES),623LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags,624CF_FUNCTION_TABLE_SIZE_18BYTES),625LLVM_READOBJ_ENUM_CLASS_ENT(COFF::GuardFlags,626CF_FUNCTION_TABLE_SIZE_19BYTES),627};628629template <typename T>630static std::error_code getSymbolAuxData(const COFFObjectFile *Obj,631COFFSymbolRef Symbol,632uint8_t AuxSymbolIdx, const T *&Aux) {633ArrayRef<uint8_t> AuxData = Obj->getSymbolAuxData(Symbol);634AuxData = AuxData.slice(AuxSymbolIdx * Obj->getSymbolTableEntrySize());635Aux = reinterpret_cast<const T*>(AuxData.data());636return std::error_code();637}638639void COFFDumper::cacheRelocations() {640if (RelocCached)641return;642RelocCached = true;643644for (const SectionRef &S : Obj->sections()) {645const coff_section *Section = Obj->getCOFFSection(S);646647append_range(RelocMap[Section], S.relocations());648649// Sort relocations by address.650llvm::sort(RelocMap[Section], [](RelocationRef L, RelocationRef R) {651return L.getOffset() < R.getOffset();652});653}654}655656void COFFDumper::printDataDirectory(uint32_t Index,657const std::string &FieldName) {658const data_directory *Data = Obj->getDataDirectory(Index);659if (!Data)660return;661W.printHex(FieldName + "RVA", Data->RelativeVirtualAddress);662W.printHex(FieldName + "Size", Data->Size);663}664665void COFFDumper::printFileHeaders() {666time_t TDS = Obj->getTimeDateStamp();667char FormattedTime[20] = { };668strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));669670{671DictScope D(W, "ImageFileHeader");672W.printEnum("Machine", Obj->getMachine(), ArrayRef(ImageFileMachineType));673W.printNumber("SectionCount", Obj->getNumberOfSections());674W.printHex ("TimeDateStamp", FormattedTime, Obj->getTimeDateStamp());675W.printHex ("PointerToSymbolTable", Obj->getPointerToSymbolTable());676W.printNumber("SymbolCount", Obj->getNumberOfSymbols());677W.printNumber("StringTableSize", Obj->getStringTableSize());678W.printNumber("OptionalHeaderSize", Obj->getSizeOfOptionalHeader());679W.printFlags("Characteristics", Obj->getCharacteristics(),680ArrayRef(ImageFileCharacteristics));681}682683// Print PE header. This header does not exist if this is an object file and684// not an executable.685if (const pe32_header *PEHeader = Obj->getPE32Header())686printPEHeader<pe32_header>(PEHeader);687688if (const pe32plus_header *PEPlusHeader = Obj->getPE32PlusHeader())689printPEHeader<pe32plus_header>(PEPlusHeader);690691if (const dos_header *DH = Obj->getDOSHeader())692printDOSHeader(DH);693}694695void COFFDumper::printDOSHeader(const dos_header *DH) {696DictScope D(W, "DOSHeader");697W.printString("Magic", StringRef(DH->Magic, sizeof(DH->Magic)));698W.printNumber("UsedBytesInTheLastPage", DH->UsedBytesInTheLastPage);699W.printNumber("FileSizeInPages", DH->FileSizeInPages);700W.printNumber("NumberOfRelocationItems", DH->NumberOfRelocationItems);701W.printNumber("HeaderSizeInParagraphs", DH->HeaderSizeInParagraphs);702W.printNumber("MinimumExtraParagraphs", DH->MinimumExtraParagraphs);703W.printNumber("MaximumExtraParagraphs", DH->MaximumExtraParagraphs);704W.printNumber("InitialRelativeSS", DH->InitialRelativeSS);705W.printNumber("InitialSP", DH->InitialSP);706W.printNumber("Checksum", DH->Checksum);707W.printNumber("InitialIP", DH->InitialIP);708W.printNumber("InitialRelativeCS", DH->InitialRelativeCS);709W.printNumber("AddressOfRelocationTable", DH->AddressOfRelocationTable);710W.printNumber("OverlayNumber", DH->OverlayNumber);711W.printNumber("OEMid", DH->OEMid);712W.printNumber("OEMinfo", DH->OEMinfo);713W.printNumber("AddressOfNewExeHeader", DH->AddressOfNewExeHeader);714}715716template <class PEHeader>717void COFFDumper::printPEHeader(const PEHeader *Hdr) {718DictScope D(W, "ImageOptionalHeader");719W.printHex ("Magic", Hdr->Magic);720W.printNumber("MajorLinkerVersion", Hdr->MajorLinkerVersion);721W.printNumber("MinorLinkerVersion", Hdr->MinorLinkerVersion);722W.printNumber("SizeOfCode", Hdr->SizeOfCode);723W.printNumber("SizeOfInitializedData", Hdr->SizeOfInitializedData);724W.printNumber("SizeOfUninitializedData", Hdr->SizeOfUninitializedData);725W.printHex ("AddressOfEntryPoint", Hdr->AddressOfEntryPoint);726W.printHex ("BaseOfCode", Hdr->BaseOfCode);727printBaseOfDataField(Hdr);728W.printHex ("ImageBase", Hdr->ImageBase);729W.printNumber("SectionAlignment", Hdr->SectionAlignment);730W.printNumber("FileAlignment", Hdr->FileAlignment);731W.printNumber("MajorOperatingSystemVersion",732Hdr->MajorOperatingSystemVersion);733W.printNumber("MinorOperatingSystemVersion",734Hdr->MinorOperatingSystemVersion);735W.printNumber("MajorImageVersion", Hdr->MajorImageVersion);736W.printNumber("MinorImageVersion", Hdr->MinorImageVersion);737W.printNumber("MajorSubsystemVersion", Hdr->MajorSubsystemVersion);738W.printNumber("MinorSubsystemVersion", Hdr->MinorSubsystemVersion);739W.printNumber("SizeOfImage", Hdr->SizeOfImage);740W.printNumber("SizeOfHeaders", Hdr->SizeOfHeaders);741W.printHex ("CheckSum", Hdr->CheckSum);742W.printEnum("Subsystem", Hdr->Subsystem, ArrayRef(PEWindowsSubsystem));743W.printFlags("Characteristics", Hdr->DLLCharacteristics,744ArrayRef(PEDLLCharacteristics));745W.printNumber("SizeOfStackReserve", Hdr->SizeOfStackReserve);746W.printNumber("SizeOfStackCommit", Hdr->SizeOfStackCommit);747W.printNumber("SizeOfHeapReserve", Hdr->SizeOfHeapReserve);748W.printNumber("SizeOfHeapCommit", Hdr->SizeOfHeapCommit);749W.printNumber("NumberOfRvaAndSize", Hdr->NumberOfRvaAndSize);750751if (Hdr->NumberOfRvaAndSize > 0) {752DictScope D(W, "DataDirectory");753static const char * const directory[] = {754"ExportTable", "ImportTable", "ResourceTable", "ExceptionTable",755"CertificateTable", "BaseRelocationTable", "Debug", "Architecture",756"GlobalPtr", "TLSTable", "LoadConfigTable", "BoundImport", "IAT",757"DelayImportDescriptor", "CLRRuntimeHeader", "Reserved"758};759760for (uint32_t i = 0; i < Hdr->NumberOfRvaAndSize; ++i)761if (i < std::size(directory))762printDataDirectory(i, directory[i]);763else764printDataDirectory(i, "Unknown");765}766}767768void COFFDumper::printCOFFDebugDirectory() {769ListScope LS(W, "DebugDirectory");770for (const debug_directory &D : Obj->debug_directories()) {771char FormattedTime[20] = {};772time_t TDS = D.TimeDateStamp;773strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));774DictScope S(W, "DebugEntry");775W.printHex("Characteristics", D.Characteristics);776W.printHex("TimeDateStamp", FormattedTime, D.TimeDateStamp);777W.printHex("MajorVersion", D.MajorVersion);778W.printHex("MinorVersion", D.MinorVersion);779W.printEnum("Type", D.Type, ArrayRef(ImageDebugType));780W.printHex("SizeOfData", D.SizeOfData);781W.printHex("AddressOfRawData", D.AddressOfRawData);782W.printHex("PointerToRawData", D.PointerToRawData);783// Ideally, if D.AddressOfRawData == 0, we should try to load the payload784// using D.PointerToRawData instead.785if (D.AddressOfRawData == 0)786continue;787if (D.Type == COFF::IMAGE_DEBUG_TYPE_CODEVIEW) {788const codeview::DebugInfo *DebugInfo;789StringRef PDBFileName;790if (Error E = Obj->getDebugPDBInfo(&D, DebugInfo, PDBFileName))791reportError(std::move(E), Obj->getFileName());792793DictScope PDBScope(W, "PDBInfo");794W.printHex("PDBSignature", DebugInfo->Signature.CVSignature);795if (DebugInfo->Signature.CVSignature == OMF::Signature::PDB70) {796W.printString(797"PDBGUID",798formatv("{0}", fmt_guid(DebugInfo->PDB70.Signature)).str());799W.printNumber("PDBAge", DebugInfo->PDB70.Age);800W.printString("PDBFileName", PDBFileName);801}802} else if (D.SizeOfData != 0) {803// FIXME: Data visualization for IMAGE_DEBUG_TYPE_VC_FEATURE and804// IMAGE_DEBUG_TYPE_POGO?805ArrayRef<uint8_t> RawData;806if (Error E = Obj->getRvaAndSizeAsBytes(D.AddressOfRawData,807D.SizeOfData, RawData))808reportError(std::move(E), Obj->getFileName());809if (D.Type == COFF::IMAGE_DEBUG_TYPE_EX_DLLCHARACTERISTICS) {810// FIXME right now the only possible value would fit in 8 bits,811// but that might change in the future812uint16_t Characteristics = RawData[0];813W.printFlags("ExtendedCharacteristics", Characteristics,814ArrayRef(PEExtendedDLLCharacteristics));815}816W.printBinaryBlock("RawData", RawData);817}818}819}820821void COFFDumper::printRVATable(uint64_t TableVA, uint64_t Count,822uint64_t EntrySize, PrintExtraCB PrintExtra) {823uintptr_t TableStart, TableEnd;824if (Error E = Obj->getVaPtr(TableVA, TableStart))825reportError(std::move(E), Obj->getFileName());826if (Error E =827Obj->getVaPtr(TableVA + Count * EntrySize - 1, TableEnd))828reportError(std::move(E), Obj->getFileName());829TableEnd++;830for (uintptr_t I = TableStart; I < TableEnd; I += EntrySize) {831uint32_t RVA = *reinterpret_cast<const ulittle32_t *>(I);832raw_ostream &OS = W.startLine();833OS << W.hex(Obj->getImageBase() + RVA);834if (PrintExtra)835PrintExtra(OS, reinterpret_cast<const uint8_t *>(I));836OS << '\n';837}838}839840void COFFDumper::printCOFFLoadConfig() {841LoadConfigTables Tables;842if (Obj->is64())843printCOFFLoadConfig(Obj->getLoadConfig64(), Tables);844else845printCOFFLoadConfig(Obj->getLoadConfig32(), Tables);846847if (auto CHPE = Obj->getCHPEMetadata()) {848ListScope LS(W, "CHPEMetadata");849W.printHex("Version", CHPE->Version);850851if (CHPE->CodeMapCount) {852ListScope CMLS(W, "CodeMap");853854uintptr_t CodeMapInt;855if (Error E = Obj->getRvaPtr(CHPE->CodeMap, CodeMapInt))856reportError(std::move(E), Obj->getFileName());857auto CodeMap = reinterpret_cast<const chpe_range_entry *>(CodeMapInt);858for (uint32_t i = 0; i < CHPE->CodeMapCount; i++) {859uint32_t Start = CodeMap[i].getStart();860W.startLine() << W.hex(Start) << " - "861<< W.hex(Start + CodeMap[i].Length) << " ";862switch (CodeMap[i].getType()) {863case chpe_range_type::Arm64:864W.getOStream() << "ARM64\n";865break;866case chpe_range_type::Arm64EC:867W.getOStream() << "ARM64EC\n";868break;869case chpe_range_type::Amd64:870W.getOStream() << "X64\n";871break;872default:873W.getOStream() << W.hex(CodeMap[i].StartOffset & 3) << "\n";874break;875}876}877} else {878W.printNumber("CodeMap", CHPE->CodeMap);879}880881if (CHPE->CodeRangesToEntryPointsCount) {882ListScope CRLS(W, "CodeRangesToEntryPoints");883884uintptr_t CodeRangesInt;885if (Error E =886Obj->getRvaPtr(CHPE->CodeRangesToEntryPoints, CodeRangesInt))887reportError(std::move(E), Obj->getFileName());888auto CodeRanges =889reinterpret_cast<const chpe_code_range_entry *>(CodeRangesInt);890for (uint32_t i = 0; i < CHPE->CodeRangesToEntryPointsCount; i++) {891W.startLine() << W.hex(CodeRanges[i].StartRva) << " - "892<< W.hex(CodeRanges[i].EndRva) << " -> "893<< W.hex(CodeRanges[i].EntryPoint) << "\n";894}895} else {896W.printNumber("CodeRangesToEntryPoints", CHPE->CodeRangesToEntryPoints);897}898899if (CHPE->RedirectionMetadataCount) {900ListScope RMLS(W, "RedirectionMetadata");901902uintptr_t RedirMetadataInt;903if (Error E = Obj->getRvaPtr(CHPE->RedirectionMetadata, RedirMetadataInt))904reportError(std::move(E), Obj->getFileName());905auto RedirMetadata =906reinterpret_cast<const chpe_redirection_entry *>(RedirMetadataInt);907for (uint32_t i = 0; i < CHPE->RedirectionMetadataCount; i++) {908W.startLine() << W.hex(RedirMetadata[i].Source) << " -> "909<< W.hex(RedirMetadata[i].Destination) << "\n";910}911} else {912W.printNumber("RedirectionMetadata", CHPE->RedirectionMetadata);913}914915W.printHex("__os_arm64x_dispatch_call_no_redirect",916CHPE->__os_arm64x_dispatch_call_no_redirect);917W.printHex("__os_arm64x_dispatch_ret", CHPE->__os_arm64x_dispatch_ret);918W.printHex("__os_arm64x_dispatch_call", CHPE->__os_arm64x_dispatch_call);919W.printHex("__os_arm64x_dispatch_icall", CHPE->__os_arm64x_dispatch_icall);920W.printHex("__os_arm64x_dispatch_icall_cfg",921CHPE->__os_arm64x_dispatch_icall_cfg);922W.printHex("AlternateEntryPoint", CHPE->AlternateEntryPoint);923W.printHex("AuxiliaryIAT", CHPE->AuxiliaryIAT);924W.printHex("GetX64InformationFunctionPointer",925CHPE->GetX64InformationFunctionPointer);926W.printHex("SetX64InformationFunctionPointer",927CHPE->SetX64InformationFunctionPointer);928W.printHex("ExtraRFETable", CHPE->ExtraRFETable);929W.printHex("ExtraRFETableSize", CHPE->ExtraRFETableSize);930W.printHex("__os_arm64x_dispatch_fptr", CHPE->__os_arm64x_dispatch_fptr);931W.printHex("AuxiliaryIATCopy", CHPE->AuxiliaryIATCopy);932}933934if (Tables.SEHTableVA) {935ListScope LS(W, "SEHTable");936printRVATable(Tables.SEHTableVA, Tables.SEHTableCount, 4);937}938939auto PrintGuardFlags = [](raw_ostream &OS, const uint8_t *Entry) {940uint8_t Flags = *reinterpret_cast<const uint8_t *>(Entry + 4);941if (Flags)942OS << " flags " << utohexstr(Flags);943};944945// The stride gives the number of extra bytes in addition to the 4-byte946// RVA of each entry in the table. As of writing only a 1-byte extra flag947// has been defined.948uint32_t Stride = Tables.GuardFlags >> 28;949PrintExtraCB PrintExtra = Stride == 1 ? +PrintGuardFlags : nullptr;950951if (Tables.GuardFidTableVA) {952ListScope LS(W, "GuardFidTable");953printRVATable(Tables.GuardFidTableVA, Tables.GuardFidTableCount,9544 + Stride, PrintExtra);955}956957if (Tables.GuardIatTableVA) {958ListScope LS(W, "GuardIatTable");959printRVATable(Tables.GuardIatTableVA, Tables.GuardIatTableCount,9604 + Stride, PrintExtra);961}962963if (Tables.GuardLJmpTableVA) {964ListScope LS(W, "GuardLJmpTable");965printRVATable(Tables.GuardLJmpTableVA, Tables.GuardLJmpTableCount,9664 + Stride, PrintExtra);967}968969if (Tables.GuardEHContTableVA) {970ListScope LS(W, "GuardEHContTable");971printRVATable(Tables.GuardEHContTableVA, Tables.GuardEHContTableCount,9724 + Stride, PrintExtra);973}974}975976template <typename T>977void COFFDumper::printCOFFLoadConfig(const T *Conf, LoadConfigTables &Tables) {978if (!Conf)979return;980981ListScope LS(W, "LoadConfig");982char FormattedTime[20] = {};983time_t TDS = Conf->TimeDateStamp;984strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));985W.printHex("Size", Conf->Size);986987// Print everything before SecurityCookie. The vast majority of images today988// have all these fields.989if (Conf->Size < offsetof(T, SEHandlerTable))990return;991W.printHex("TimeDateStamp", FormattedTime, TDS);992W.printHex("MajorVersion", Conf->MajorVersion);993W.printHex("MinorVersion", Conf->MinorVersion);994W.printHex("GlobalFlagsClear", Conf->GlobalFlagsClear);995W.printHex("GlobalFlagsSet", Conf->GlobalFlagsSet);996W.printHex("CriticalSectionDefaultTimeout",997Conf->CriticalSectionDefaultTimeout);998W.printHex("DeCommitFreeBlockThreshold", Conf->DeCommitFreeBlockThreshold);999W.printHex("DeCommitTotalFreeThreshold", Conf->DeCommitTotalFreeThreshold);1000W.printHex("LockPrefixTable", Conf->LockPrefixTable);1001W.printHex("MaximumAllocationSize", Conf->MaximumAllocationSize);1002W.printHex("VirtualMemoryThreshold", Conf->VirtualMemoryThreshold);1003W.printHex("ProcessHeapFlags", Conf->ProcessHeapFlags);1004W.printHex("ProcessAffinityMask", Conf->ProcessAffinityMask);1005W.printHex("CSDVersion", Conf->CSDVersion);1006W.printHex("DependentLoadFlags", Conf->DependentLoadFlags);1007W.printHex("EditList", Conf->EditList);1008W.printHex("SecurityCookie", Conf->SecurityCookie);10091010// Print the safe SEH table if present.1011if (Conf->Size < offsetof(T, GuardCFCheckFunction))1012return;1013W.printHex("SEHandlerTable", Conf->SEHandlerTable);1014W.printNumber("SEHandlerCount", Conf->SEHandlerCount);10151016Tables.SEHTableVA = Conf->SEHandlerTable;1017Tables.SEHTableCount = Conf->SEHandlerCount;10181019// Print everything before CodeIntegrity. (2015)1020if (Conf->Size < offsetof(T, CodeIntegrity))1021return;1022W.printHex("GuardCFCheckFunction", Conf->GuardCFCheckFunction);1023W.printHex("GuardCFCheckDispatch", Conf->GuardCFCheckDispatch);1024W.printHex("GuardCFFunctionTable", Conf->GuardCFFunctionTable);1025W.printNumber("GuardCFFunctionCount", Conf->GuardCFFunctionCount);1026W.printFlags("GuardFlags", Conf->GuardFlags, ArrayRef(PELoadConfigGuardFlags),1027(uint32_t)COFF::GuardFlags::CF_FUNCTION_TABLE_SIZE_MASK);10281029Tables.GuardFidTableVA = Conf->GuardCFFunctionTable;1030Tables.GuardFidTableCount = Conf->GuardCFFunctionCount;1031Tables.GuardFlags = Conf->GuardFlags;10321033// Print everything before Reserved3. (2017)1034if (Conf->Size < offsetof(T, Reserved3))1035return;1036W.printHex("GuardAddressTakenIatEntryTable",1037Conf->GuardAddressTakenIatEntryTable);1038W.printNumber("GuardAddressTakenIatEntryCount",1039Conf->GuardAddressTakenIatEntryCount);1040W.printHex("GuardLongJumpTargetTable", Conf->GuardLongJumpTargetTable);1041W.printNumber("GuardLongJumpTargetCount", Conf->GuardLongJumpTargetCount);1042W.printHex("DynamicValueRelocTable", Conf->DynamicValueRelocTable);1043W.printHex("CHPEMetadataPointer", Conf->CHPEMetadataPointer);1044W.printHex("GuardRFFailureRoutine", Conf->GuardRFFailureRoutine);1045W.printHex("GuardRFFailureRoutineFunctionPointer",1046Conf->GuardRFFailureRoutineFunctionPointer);1047W.printHex("DynamicValueRelocTableOffset",1048Conf->DynamicValueRelocTableOffset);1049W.printNumber("DynamicValueRelocTableSection",1050Conf->DynamicValueRelocTableSection);1051W.printHex("GuardRFVerifyStackPointerFunctionPointer",1052Conf->GuardRFVerifyStackPointerFunctionPointer);1053W.printHex("HotPatchTableOffset", Conf->HotPatchTableOffset);10541055Tables.GuardIatTableVA = Conf->GuardAddressTakenIatEntryTable;1056Tables.GuardIatTableCount = Conf->GuardAddressTakenIatEntryCount;10571058Tables.GuardLJmpTableVA = Conf->GuardLongJumpTargetTable;1059Tables.GuardLJmpTableCount = Conf->GuardLongJumpTargetCount;10601061// Print the rest. (2019)1062if (Conf->Size < sizeof(T))1063return;1064W.printHex("EnclaveConfigurationPointer", Conf->EnclaveConfigurationPointer);1065W.printHex("VolatileMetadataPointer", Conf->VolatileMetadataPointer);1066W.printHex("GuardEHContinuationTable", Conf->GuardEHContinuationTable);1067W.printNumber("GuardEHContinuationCount", Conf->GuardEHContinuationCount);10681069Tables.GuardEHContTableVA = Conf->GuardEHContinuationTable;1070Tables.GuardEHContTableCount = Conf->GuardEHContinuationCount;1071}10721073void COFFDumper::printBaseOfDataField(const pe32_header *Hdr) {1074W.printHex("BaseOfData", Hdr->BaseOfData);1075}10761077void COFFDumper::printBaseOfDataField(const pe32plus_header *) {}10781079void COFFDumper::printCodeViewDebugInfo() {1080// Print types first to build CVUDTNames, then print symbols.1081for (const SectionRef &S : Obj->sections()) {1082StringRef SectionName = unwrapOrError(Obj->getFileName(), S.getName());1083// .debug$T is a standard CodeView type section, while .debug$P is the same1084// format but used for MSVC precompiled header object files.1085if (SectionName == ".debug$T" || SectionName == ".debug$P")1086printCodeViewTypeSection(SectionName, S);1087}1088for (const SectionRef &S : Obj->sections()) {1089StringRef SectionName = unwrapOrError(Obj->getFileName(), S.getName());1090if (SectionName == ".debug$S")1091printCodeViewSymbolSection(SectionName, S);1092}1093}10941095void COFFDumper::initializeFileAndStringTables(BinaryStreamReader &Reader) {1096while (Reader.bytesRemaining() > 0 &&1097(!CVFileChecksumTable.valid() || !CVStringTable.valid())) {1098// The section consists of a number of subsection in the following format:1099// |SubSectionType|SubSectionSize|Contents...|1100uint32_t SubType, SubSectionSize;11011102if (Error E = Reader.readInteger(SubType))1103reportError(std::move(E), Obj->getFileName());1104if (Error E = Reader.readInteger(SubSectionSize))1105reportError(std::move(E), Obj->getFileName());11061107StringRef Contents;1108if (Error E = Reader.readFixedString(Contents, SubSectionSize))1109reportError(std::move(E), Obj->getFileName());11101111BinaryStreamRef ST(Contents, llvm::endianness::little);1112switch (DebugSubsectionKind(SubType)) {1113case DebugSubsectionKind::FileChecksums:1114if (Error E = CVFileChecksumTable.initialize(ST))1115reportError(std::move(E), Obj->getFileName());1116break;1117case DebugSubsectionKind::StringTable:1118if (Error E = CVStringTable.initialize(ST))1119reportError(std::move(E), Obj->getFileName());1120break;1121default:1122break;1123}11241125uint32_t PaddedSize = alignTo(SubSectionSize, 4);1126if (Error E = Reader.skip(PaddedSize - SubSectionSize))1127reportError(std::move(E), Obj->getFileName());1128}1129}11301131void COFFDumper::printCodeViewSymbolSection(StringRef SectionName,1132const SectionRef &Section) {1133StringRef SectionContents =1134unwrapOrError(Obj->getFileName(), Section.getContents());1135StringRef Data = SectionContents;11361137SmallVector<StringRef, 10> FunctionNames;1138StringMap<StringRef> FunctionLineTables;11391140ListScope D(W, "CodeViewDebugInfo");1141// Print the section to allow correlation with printSectionHeaders.1142W.printNumber("Section", SectionName, Obj->getSectionID(Section));11431144uint32_t Magic;1145if (Error E = consume(Data, Magic))1146reportError(std::move(E), Obj->getFileName());11471148W.printHex("Magic", Magic);1149if (Magic != COFF::DEBUG_SECTION_MAGIC)1150reportError(errorCodeToError(object_error::parse_failed),1151Obj->getFileName());11521153BinaryStreamReader FSReader(Data, llvm::endianness::little);1154initializeFileAndStringTables(FSReader);11551156// TODO: Convert this over to using ModuleSubstreamVisitor.1157while (!Data.empty()) {1158// The section consists of a number of subsection in the following format:1159// |SubSectionType|SubSectionSize|Contents...|1160uint32_t SubType, SubSectionSize;1161if (Error E = consume(Data, SubType))1162reportError(std::move(E), Obj->getFileName());1163if (Error E = consume(Data, SubSectionSize))1164reportError(std::move(E), Obj->getFileName());11651166ListScope S(W, "Subsection");1167// Dump the subsection as normal even if the ignore bit is set.1168if (SubType & SubsectionIgnoreFlag) {1169W.printHex("IgnoredSubsectionKind", SubType);1170SubType &= ~SubsectionIgnoreFlag;1171}1172W.printEnum("SubSectionType", SubType, ArrayRef(SubSectionTypes));1173W.printHex("SubSectionSize", SubSectionSize);11741175// Get the contents of the subsection.1176if (SubSectionSize > Data.size())1177return reportError(errorCodeToError(object_error::parse_failed),1178Obj->getFileName());1179StringRef Contents = Data.substr(0, SubSectionSize);11801181// Add SubSectionSize to the current offset and align that offset to find1182// the next subsection.1183size_t SectionOffset = Data.data() - SectionContents.data();1184size_t NextOffset = SectionOffset + SubSectionSize;1185NextOffset = alignTo(NextOffset, 4);1186if (NextOffset > SectionContents.size())1187return reportError(errorCodeToError(object_error::parse_failed),1188Obj->getFileName());1189Data = SectionContents.drop_front(NextOffset);11901191// Optionally print the subsection bytes in case our parsing gets confused1192// later.1193if (opts::CodeViewSubsectionBytes)1194printBinaryBlockWithRelocs("SubSectionContents", Section, SectionContents,1195Contents);11961197switch (DebugSubsectionKind(SubType)) {1198case DebugSubsectionKind::Symbols:1199printCodeViewSymbolsSubsection(Contents, Section, SectionContents);1200break;12011202case DebugSubsectionKind::InlineeLines:1203printCodeViewInlineeLines(Contents);1204break;12051206case DebugSubsectionKind::FileChecksums:1207printCodeViewFileChecksums(Contents);1208break;12091210case DebugSubsectionKind::Lines: {1211// Holds a PC to file:line table. Some data to parse this subsection is1212// stored in the other subsections, so just check sanity and store the1213// pointers for deferred processing.12141215if (SubSectionSize < 12) {1216// There should be at least three words to store two function1217// relocations and size of the code.1218reportError(errorCodeToError(object_error::parse_failed),1219Obj->getFileName());1220return;1221}12221223StringRef LinkageName;1224if (std::error_code EC = resolveSymbolName(Obj->getCOFFSection(Section),1225SectionOffset, LinkageName))1226reportError(errorCodeToError(EC), Obj->getFileName());12271228W.printString("LinkageName", LinkageName);1229if (FunctionLineTables.count(LinkageName) != 0) {1230// Saw debug info for this function already?1231reportError(errorCodeToError(object_error::parse_failed),1232Obj->getFileName());1233return;1234}12351236FunctionLineTables[LinkageName] = Contents;1237FunctionNames.push_back(LinkageName);1238break;1239}1240case DebugSubsectionKind::FrameData: {1241// First four bytes is a relocation against the function.1242BinaryStreamReader SR(Contents, llvm::endianness::little);12431244DebugFrameDataSubsectionRef FrameData;1245if (Error E = FrameData.initialize(SR))1246reportError(std::move(E), Obj->getFileName());12471248StringRef LinkageName;1249if (std::error_code EC =1250resolveSymbolName(Obj->getCOFFSection(Section), SectionContents,1251FrameData.getRelocPtr(), LinkageName))1252reportError(errorCodeToError(EC), Obj->getFileName());1253W.printString("LinkageName", LinkageName);12541255// To find the active frame description, search this array for the1256// smallest PC range that includes the current PC.1257for (const auto &FD : FrameData) {1258StringRef FrameFunc = unwrapOrError(1259Obj->getFileName(), CVStringTable.getString(FD.FrameFunc));12601261DictScope S(W, "FrameData");1262W.printHex("RvaStart", FD.RvaStart);1263W.printHex("CodeSize", FD.CodeSize);1264W.printHex("LocalSize", FD.LocalSize);1265W.printHex("ParamsSize", FD.ParamsSize);1266W.printHex("MaxStackSize", FD.MaxStackSize);1267W.printHex("PrologSize", FD.PrologSize);1268W.printHex("SavedRegsSize", FD.SavedRegsSize);1269W.printFlags("Flags", FD.Flags, ArrayRef(FrameDataFlags));12701271// The FrameFunc string is a small RPN program. It can be broken up into1272// statements that end in the '=' operator, which assigns the value on1273// the top of the stack to the previously pushed variable. Variables can1274// be temporary values ($T0) or physical registers ($esp). Print each1275// assignment on its own line to make these programs easier to read.1276{1277ListScope FFS(W, "FrameFunc");1278while (!FrameFunc.empty()) {1279size_t EqOrEnd = FrameFunc.find('=');1280if (EqOrEnd == StringRef::npos)1281EqOrEnd = FrameFunc.size();1282else1283++EqOrEnd;1284StringRef Stmt = FrameFunc.substr(0, EqOrEnd);1285W.printString(Stmt);1286FrameFunc = FrameFunc.drop_front(EqOrEnd).trim();1287}1288}1289}1290break;1291}12921293// Do nothing for unrecognized subsections.1294default:1295break;1296}1297W.flush();1298}12991300// Dump the line tables now that we've read all the subsections and know all1301// the required information.1302for (unsigned I = 0, E = FunctionNames.size(); I != E; ++I) {1303StringRef Name = FunctionNames[I];1304ListScope S(W, "FunctionLineTable");1305W.printString("LinkageName", Name);13061307BinaryStreamReader Reader(FunctionLineTables[Name],1308llvm::endianness::little);13091310DebugLinesSubsectionRef LineInfo;1311if (Error E = LineInfo.initialize(Reader))1312reportError(std::move(E), Obj->getFileName());13131314W.printHex("Flags", LineInfo.header()->Flags);1315W.printHex("CodeSize", LineInfo.header()->CodeSize);1316for (const auto &Entry : LineInfo) {13171318ListScope S(W, "FilenameSegment");1319printFileNameForOffset("Filename", Entry.NameIndex);1320uint32_t ColumnIndex = 0;1321for (const auto &Line : Entry.LineNumbers) {1322if (Line.Offset >= LineInfo.header()->CodeSize) {1323reportError(errorCodeToError(object_error::parse_failed),1324Obj->getFileName());1325return;1326}13271328std::string PC = std::string(formatv("+{0:X}", uint32_t(Line.Offset)));1329ListScope PCScope(W, PC);1330codeview::LineInfo LI(Line.Flags);13311332if (LI.isAlwaysStepInto())1333W.printString("StepInto", StringRef("Always"));1334else if (LI.isNeverStepInto())1335W.printString("StepInto", StringRef("Never"));1336else1337W.printNumber("LineNumberStart", LI.getStartLine());1338W.printNumber("LineNumberEndDelta", LI.getLineDelta());1339W.printBoolean("IsStatement", LI.isStatement());1340if (LineInfo.hasColumnInfo()) {1341W.printNumber("ColStart", Entry.Columns[ColumnIndex].StartColumn);1342W.printNumber("ColEnd", Entry.Columns[ColumnIndex].EndColumn);1343++ColumnIndex;1344}1345}1346}1347}1348}13491350void COFFDumper::printCodeViewSymbolsSubsection(StringRef Subsection,1351const SectionRef &Section,1352StringRef SectionContents) {1353ArrayRef<uint8_t> BinaryData(Subsection.bytes_begin(),1354Subsection.bytes_end());1355auto CODD = std::make_unique<COFFObjectDumpDelegate>(*this, Section, Obj,1356SectionContents);1357CVSymbolDumper CVSD(W, Types, CodeViewContainer::ObjectFile, std::move(CODD),1358CompilationCPUType, opts::CodeViewSubsectionBytes);1359CVSymbolArray Symbols;1360BinaryStreamReader Reader(BinaryData, llvm::endianness::little);1361if (Error E = Reader.readArray(Symbols, Reader.getLength())) {1362W.flush();1363reportError(std::move(E), Obj->getFileName());1364}13651366if (Error E = CVSD.dump(Symbols)) {1367W.flush();1368reportError(std::move(E), Obj->getFileName());1369}1370CompilationCPUType = CVSD.getCompilationCPUType();1371W.flush();1372}13731374void COFFDumper::printCodeViewFileChecksums(StringRef Subsection) {1375BinaryStreamRef Stream(Subsection, llvm::endianness::little);1376DebugChecksumsSubsectionRef Checksums;1377if (Error E = Checksums.initialize(Stream))1378reportError(std::move(E), Obj->getFileName());13791380for (auto &FC : Checksums) {1381DictScope S(W, "FileChecksum");13821383StringRef Filename = unwrapOrError(1384Obj->getFileName(), CVStringTable.getString(FC.FileNameOffset));1385W.printHex("Filename", Filename, FC.FileNameOffset);1386W.printHex("ChecksumSize", FC.Checksum.size());1387W.printEnum("ChecksumKind", uint8_t(FC.Kind),1388ArrayRef(FileChecksumKindNames));13891390W.printBinary("ChecksumBytes", FC.Checksum);1391}1392}13931394void COFFDumper::printCodeViewInlineeLines(StringRef Subsection) {1395BinaryStreamReader SR(Subsection, llvm::endianness::little);1396DebugInlineeLinesSubsectionRef Lines;1397if (Error E = Lines.initialize(SR))1398reportError(std::move(E), Obj->getFileName());13991400for (auto &Line : Lines) {1401DictScope S(W, "InlineeSourceLine");1402printTypeIndex("Inlinee", Line.Header->Inlinee);1403printFileNameForOffset("FileID", Line.Header->FileID);1404W.printNumber("SourceLineNum", Line.Header->SourceLineNum);14051406if (Lines.hasExtraFiles()) {1407W.printNumber("ExtraFileCount", Line.ExtraFiles.size());1408ListScope ExtraFiles(W, "ExtraFiles");1409for (const auto &FID : Line.ExtraFiles) {1410printFileNameForOffset("FileID", FID);1411}1412}1413}1414}14151416StringRef COFFDumper::getFileNameForFileOffset(uint32_t FileOffset) {1417// The file checksum subsection should precede all references to it.1418if (!CVFileChecksumTable.valid() || !CVStringTable.valid())1419reportError(errorCodeToError(object_error::parse_failed),1420Obj->getFileName());14211422auto Iter = CVFileChecksumTable.getArray().at(FileOffset);14231424// Check if the file checksum table offset is valid.1425if (Iter == CVFileChecksumTable.end())1426reportError(errorCodeToError(object_error::parse_failed),1427Obj->getFileName());14281429return unwrapOrError(Obj->getFileName(),1430CVStringTable.getString(Iter->FileNameOffset));1431}14321433void COFFDumper::printFileNameForOffset(StringRef Label, uint32_t FileOffset) {1434W.printHex(Label, getFileNameForFileOffset(FileOffset), FileOffset);1435}14361437void COFFDumper::mergeCodeViewTypes(MergingTypeTableBuilder &CVIDs,1438MergingTypeTableBuilder &CVTypes,1439GlobalTypeTableBuilder &GlobalCVIDs,1440GlobalTypeTableBuilder &GlobalCVTypes,1441bool GHash) {1442for (const SectionRef &S : Obj->sections()) {1443StringRef SectionName = unwrapOrError(Obj->getFileName(), S.getName());1444if (SectionName == ".debug$T") {1445StringRef Data = unwrapOrError(Obj->getFileName(), S.getContents());1446uint32_t Magic;1447if (Error E = consume(Data, Magic))1448reportError(std::move(E), Obj->getFileName());14491450if (Magic != 4)1451reportError(errorCodeToError(object_error::parse_failed),1452Obj->getFileName());14531454CVTypeArray Types;1455BinaryStreamReader Reader(Data, llvm::endianness::little);1456if (auto EC = Reader.readArray(Types, Reader.getLength())) {1457consumeError(std::move(EC));1458W.flush();1459reportError(errorCodeToError(object_error::parse_failed),1460Obj->getFileName());1461}1462SmallVector<TypeIndex, 128> SourceToDest;1463std::optional<PCHMergerInfo> PCHInfo;1464if (GHash) {1465std::vector<GloballyHashedType> Hashes =1466GloballyHashedType::hashTypes(Types);1467if (Error E =1468mergeTypeAndIdRecords(GlobalCVIDs, GlobalCVTypes, SourceToDest,1469Types, Hashes, PCHInfo))1470return reportError(std::move(E), Obj->getFileName());1471} else {1472if (Error E = mergeTypeAndIdRecords(CVIDs, CVTypes, SourceToDest, Types,1473PCHInfo))1474return reportError(std::move(E), Obj->getFileName());1475}1476}1477}1478}14791480void COFFDumper::printCodeViewTypeSection(StringRef SectionName,1481const SectionRef &Section) {1482ListScope D(W, "CodeViewTypes");1483W.printNumber("Section", SectionName, Obj->getSectionID(Section));14841485StringRef Data = unwrapOrError(Obj->getFileName(), Section.getContents());1486if (opts::CodeViewSubsectionBytes)1487W.printBinaryBlock("Data", Data);14881489uint32_t Magic;1490if (Error E = consume(Data, Magic))1491reportError(std::move(E), Obj->getFileName());14921493W.printHex("Magic", Magic);1494if (Magic != COFF::DEBUG_SECTION_MAGIC)1495reportError(errorCodeToError(object_error::parse_failed),1496Obj->getFileName());14971498Types.reset(Data, 100);14991500TypeDumpVisitor TDV(Types, &W, opts::CodeViewSubsectionBytes);1501if (Error E = codeview::visitTypeStream(Types, TDV))1502reportError(std::move(E), Obj->getFileName());15031504W.flush();1505}15061507void COFFDumper::printSectionHeaders() {1508ListScope SectionsD(W, "Sections");1509int SectionNumber = 0;1510for (const SectionRef &Sec : Obj->sections()) {1511++SectionNumber;1512const coff_section *Section = Obj->getCOFFSection(Sec);15131514StringRef Name = unwrapOrError(Obj->getFileName(), Sec.getName());15151516DictScope D(W, "Section");1517W.printNumber("Number", SectionNumber);1518W.printBinary("Name", Name, Section->Name);1519W.printHex ("VirtualSize", Section->VirtualSize);1520W.printHex ("VirtualAddress", Section->VirtualAddress);1521W.printNumber("RawDataSize", Section->SizeOfRawData);1522W.printHex ("PointerToRawData", Section->PointerToRawData);1523W.printHex ("PointerToRelocations", Section->PointerToRelocations);1524W.printHex ("PointerToLineNumbers", Section->PointerToLinenumbers);1525W.printNumber("RelocationCount", Section->NumberOfRelocations);1526W.printNumber("LineNumberCount", Section->NumberOfLinenumbers);1527W.printFlags("Characteristics", Section->Characteristics,1528ArrayRef(ImageSectionCharacteristics),1529COFF::SectionCharacteristics(0x00F00000));15301531if (opts::SectionRelocations) {1532ListScope D(W, "Relocations");1533for (const RelocationRef &Reloc : Sec.relocations())1534printRelocation(Sec, Reloc);1535}15361537if (opts::SectionSymbols) {1538ListScope D(W, "Symbols");1539for (const SymbolRef &Symbol : Obj->symbols()) {1540if (!Sec.containsSymbol(Symbol))1541continue;15421543printSymbol(Symbol);1544}1545}15461547if (opts::SectionData &&1548!(Section->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)) {1549StringRef Data = unwrapOrError(Obj->getFileName(), Sec.getContents());1550W.printBinaryBlock("SectionData", Data);1551}1552}1553}15541555void COFFDumper::printRelocations() {1556ListScope D(W, "Relocations");15571558int SectionNumber = 0;1559for (const SectionRef &Section : Obj->sections()) {1560++SectionNumber;1561StringRef Name = unwrapOrError(Obj->getFileName(), Section.getName());15621563bool PrintedGroup = false;1564for (const RelocationRef &Reloc : Section.relocations()) {1565if (!PrintedGroup) {1566W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n";1567W.indent();1568PrintedGroup = true;1569}15701571printRelocation(Section, Reloc);1572}15731574if (PrintedGroup) {1575W.unindent();1576W.startLine() << "}\n";1577}1578}1579}15801581void COFFDumper::printRelocation(const SectionRef &Section,1582const RelocationRef &Reloc, uint64_t Bias) {1583uint64_t Offset = Reloc.getOffset() - Bias;1584uint64_t RelocType = Reloc.getType();1585SmallString<32> RelocName;1586StringRef SymbolName;1587Reloc.getTypeName(RelocName);1588symbol_iterator Symbol = Reloc.getSymbol();1589int64_t SymbolIndex = -1;1590if (Symbol != Obj->symbol_end()) {1591Expected<StringRef> SymbolNameOrErr = Symbol->getName();1592if (!SymbolNameOrErr)1593reportError(SymbolNameOrErr.takeError(), Obj->getFileName());15941595SymbolName = *SymbolNameOrErr;1596SymbolIndex = Obj->getSymbolIndex(Obj->getCOFFSymbol(*Symbol));1597}15981599if (opts::ExpandRelocs) {1600DictScope Group(W, "Relocation");1601W.printHex("Offset", Offset);1602W.printNumber("Type", RelocName, RelocType);1603W.printString("Symbol", SymbolName.empty() ? "-" : SymbolName);1604W.printNumber("SymbolIndex", SymbolIndex);1605} else {1606raw_ostream& OS = W.startLine();1607OS << W.hex(Offset)1608<< " " << RelocName1609<< " " << (SymbolName.empty() ? "-" : SymbolName)1610<< " (" << SymbolIndex << ")"1611<< "\n";1612}1613}16141615void COFFDumper::printSymbols(bool /*ExtraSymInfo*/) {1616ListScope Group(W, "Symbols");16171618for (const SymbolRef &Symbol : Obj->symbols())1619printSymbol(Symbol);1620}16211622void COFFDumper::printDynamicSymbols() { ListScope Group(W, "DynamicSymbols"); }16231624static Expected<StringRef>1625getSectionName(const llvm::object::COFFObjectFile *Obj, int32_t SectionNumber,1626const coff_section *Section) {1627if (Section)1628return Obj->getSectionName(Section);1629if (SectionNumber == llvm::COFF::IMAGE_SYM_DEBUG)1630return StringRef("IMAGE_SYM_DEBUG");1631if (SectionNumber == llvm::COFF::IMAGE_SYM_ABSOLUTE)1632return StringRef("IMAGE_SYM_ABSOLUTE");1633if (SectionNumber == llvm::COFF::IMAGE_SYM_UNDEFINED)1634return StringRef("IMAGE_SYM_UNDEFINED");1635return StringRef("");1636}16371638void COFFDumper::printSymbol(const SymbolRef &Sym) {1639DictScope D(W, "Symbol");16401641COFFSymbolRef Symbol = Obj->getCOFFSymbol(Sym);1642Expected<const coff_section *> SecOrErr =1643Obj->getSection(Symbol.getSectionNumber());1644if (!SecOrErr) {1645W.startLine() << "Invalid section number: " << Symbol.getSectionNumber()1646<< "\n";1647W.flush();1648consumeError(SecOrErr.takeError());1649return;1650}1651const coff_section *Section = *SecOrErr;16521653StringRef SymbolName;1654if (Expected<StringRef> SymNameOrErr = Obj->getSymbolName(Symbol))1655SymbolName = *SymNameOrErr;16561657StringRef SectionName;1658if (Expected<StringRef> SecNameOrErr =1659getSectionName(Obj, Symbol.getSectionNumber(), Section))1660SectionName = *SecNameOrErr;16611662W.printString("Name", SymbolName);1663W.printNumber("Value", Symbol.getValue());1664W.printNumber("Section", SectionName, Symbol.getSectionNumber());1665W.printEnum("BaseType", Symbol.getBaseType(), ArrayRef(ImageSymType));1666W.printEnum("ComplexType", Symbol.getComplexType(), ArrayRef(ImageSymDType));1667W.printEnum("StorageClass", Symbol.getStorageClass(),1668ArrayRef(ImageSymClass));1669W.printNumber("AuxSymbolCount", Symbol.getNumberOfAuxSymbols());16701671for (uint8_t I = 0; I < Symbol.getNumberOfAuxSymbols(); ++I) {1672if (Symbol.isFunctionDefinition()) {1673const coff_aux_function_definition *Aux;1674if (std::error_code EC = getSymbolAuxData(Obj, Symbol, I, Aux))1675reportError(errorCodeToError(EC), Obj->getFileName());16761677DictScope AS(W, "AuxFunctionDef");1678W.printNumber("TagIndex", Aux->TagIndex);1679W.printNumber("TotalSize", Aux->TotalSize);1680W.printHex("PointerToLineNumber", Aux->PointerToLinenumber);1681W.printHex("PointerToNextFunction", Aux->PointerToNextFunction);16821683} else if (Symbol.isAnyUndefined()) {1684const coff_aux_weak_external *Aux;1685if (std::error_code EC = getSymbolAuxData(Obj, Symbol, I, Aux))1686reportError(errorCodeToError(EC), Obj->getFileName());16871688DictScope AS(W, "AuxWeakExternal");1689W.printNumber("Linked", getSymbolName(Aux->TagIndex), Aux->TagIndex);1690W.printEnum("Search", Aux->Characteristics,1691ArrayRef(WeakExternalCharacteristics));16921693} else if (Symbol.isFileRecord()) {1694const char *FileName;1695if (std::error_code EC = getSymbolAuxData(Obj, Symbol, I, FileName))1696reportError(errorCodeToError(EC), Obj->getFileName());1697DictScope AS(W, "AuxFileRecord");16981699StringRef Name(FileName, Symbol.getNumberOfAuxSymbols() *1700Obj->getSymbolTableEntrySize());1701W.printString("FileName", Name.rtrim(StringRef("\0", 1)));1702break;1703} else if (Symbol.isSectionDefinition()) {1704const coff_aux_section_definition *Aux;1705if (std::error_code EC = getSymbolAuxData(Obj, Symbol, I, Aux))1706reportError(errorCodeToError(EC), Obj->getFileName());17071708int32_t AuxNumber = Aux->getNumber(Symbol.isBigObj());17091710DictScope AS(W, "AuxSectionDef");1711W.printNumber("Length", Aux->Length);1712W.printNumber("RelocationCount", Aux->NumberOfRelocations);1713W.printNumber("LineNumberCount", Aux->NumberOfLinenumbers);1714W.printHex("Checksum", Aux->CheckSum);1715W.printNumber("Number", AuxNumber);1716W.printEnum("Selection", Aux->Selection, ArrayRef(ImageCOMDATSelect));17171718if (Section && Section->Characteristics & COFF::IMAGE_SCN_LNK_COMDAT1719&& Aux->Selection == COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE) {1720Expected<const coff_section *> Assoc = Obj->getSection(AuxNumber);1721if (!Assoc)1722reportError(Assoc.takeError(), Obj->getFileName());1723Expected<StringRef> AssocName = getSectionName(Obj, AuxNumber, *Assoc);1724if (!AssocName)1725reportError(AssocName.takeError(), Obj->getFileName());17261727W.printNumber("AssocSection", *AssocName, AuxNumber);1728}1729} else if (Symbol.isCLRToken()) {1730const coff_aux_clr_token *Aux;1731if (std::error_code EC = getSymbolAuxData(Obj, Symbol, I, Aux))1732reportError(errorCodeToError(EC), Obj->getFileName());17331734DictScope AS(W, "AuxCLRToken");1735W.printNumber("AuxType", Aux->AuxType);1736W.printNumber("Reserved", Aux->Reserved);1737W.printNumber("SymbolTableIndex", getSymbolName(Aux->SymbolTableIndex),1738Aux->SymbolTableIndex);17391740} else {1741W.startLine() << "<unhandled auxiliary record>\n";1742}1743}1744}17451746void COFFDumper::printUnwindInfo() {1747ListScope D(W, "UnwindInformation");1748switch (Obj->getMachine()) {1749case COFF::IMAGE_FILE_MACHINE_AMD64: {1750Win64EH::Dumper Dumper(W);1751Win64EH::Dumper::SymbolResolver1752Resolver = [](const object::coff_section *Section, uint64_t Offset,1753SymbolRef &Symbol, void *user_data) -> std::error_code {1754COFFDumper *Dumper = reinterpret_cast<COFFDumper *>(user_data);1755return Dumper->resolveSymbol(Section, Offset, Symbol);1756};1757Win64EH::Dumper::Context Ctx(*Obj, Resolver, this);1758Dumper.printData(Ctx);1759break;1760}1761case COFF::IMAGE_FILE_MACHINE_ARM64:1762case COFF::IMAGE_FILE_MACHINE_ARM64EC:1763case COFF::IMAGE_FILE_MACHINE_ARM64X:1764case COFF::IMAGE_FILE_MACHINE_ARMNT: {1765ARM::WinEH::Decoder Decoder(W, Obj->getMachine() !=1766COFF::IMAGE_FILE_MACHINE_ARMNT);1767// TODO Propagate the error.1768consumeError(Decoder.dumpProcedureData(*Obj));1769break;1770}1771default:1772W.printEnum("unsupported Image Machine", Obj->getMachine(),1773ArrayRef(ImageFileMachineType));1774break;1775}1776}17771778void COFFDumper::printNeededLibraries() {1779ListScope D(W, "NeededLibraries");17801781using LibsTy = std::vector<StringRef>;1782LibsTy Libs;17831784for (const ImportDirectoryEntryRef &DirRef : Obj->import_directories()) {1785StringRef Name;1786if (!DirRef.getName(Name))1787Libs.push_back(Name);1788}17891790llvm::stable_sort(Libs);17911792for (const auto &L : Libs) {1793W.startLine() << L << "\n";1794}1795}17961797void COFFDumper::printImportedSymbols(1798iterator_range<imported_symbol_iterator> Range) {1799for (const ImportedSymbolRef &I : Range) {1800StringRef Sym;1801if (Error E = I.getSymbolName(Sym))1802reportError(std::move(E), Obj->getFileName());1803uint16_t Ordinal;1804if (Error E = I.getOrdinal(Ordinal))1805reportError(std::move(E), Obj->getFileName());1806W.printNumber("Symbol", Sym, Ordinal);1807}1808}18091810void COFFDumper::printDelayImportedSymbols(1811const DelayImportDirectoryEntryRef &I,1812iterator_range<imported_symbol_iterator> Range) {1813int Index = 0;1814for (const ImportedSymbolRef &S : Range) {1815DictScope Import(W, "Import");1816StringRef Sym;1817if (Error E = S.getSymbolName(Sym))1818reportError(std::move(E), Obj->getFileName());18191820uint16_t Ordinal;1821if (Error E = S.getOrdinal(Ordinal))1822reportError(std::move(E), Obj->getFileName());1823W.printNumber("Symbol", Sym, Ordinal);18241825uint64_t Addr;1826if (Error E = I.getImportAddress(Index++, Addr))1827reportError(std::move(E), Obj->getFileName());1828W.printHex("Address", Addr);1829}1830}18311832void COFFDumper::printCOFFImports() {1833// Regular imports1834for (const ImportDirectoryEntryRef &I : Obj->import_directories()) {1835DictScope Import(W, "Import");1836StringRef Name;1837if (Error E = I.getName(Name))1838reportError(std::move(E), Obj->getFileName());1839W.printString("Name", Name);1840uint32_t ILTAddr;1841if (Error E = I.getImportLookupTableRVA(ILTAddr))1842reportError(std::move(E), Obj->getFileName());1843W.printHex("ImportLookupTableRVA", ILTAddr);1844uint32_t IATAddr;1845if (Error E = I.getImportAddressTableRVA(IATAddr))1846reportError(std::move(E), Obj->getFileName());1847W.printHex("ImportAddressTableRVA", IATAddr);1848// The import lookup table can be missing with certain older linkers, so1849// fall back to the import address table in that case.1850if (ILTAddr)1851printImportedSymbols(I.lookup_table_symbols());1852else1853printImportedSymbols(I.imported_symbols());1854}18551856// Delay imports1857for (const DelayImportDirectoryEntryRef &I : Obj->delay_import_directories()) {1858DictScope Import(W, "DelayImport");1859StringRef Name;1860if (Error E = I.getName(Name))1861reportError(std::move(E), Obj->getFileName());1862W.printString("Name", Name);1863const delay_import_directory_table_entry *Table;1864if (Error E = I.getDelayImportTable(Table))1865reportError(std::move(E), Obj->getFileName());1866W.printHex("Attributes", Table->Attributes);1867W.printHex("ModuleHandle", Table->ModuleHandle);1868W.printHex("ImportAddressTable", Table->DelayImportAddressTable);1869W.printHex("ImportNameTable", Table->DelayImportNameTable);1870W.printHex("BoundDelayImportTable", Table->BoundDelayImportTable);1871W.printHex("UnloadDelayImportTable", Table->UnloadDelayImportTable);1872printDelayImportedSymbols(I, I.imported_symbols());1873}1874}18751876void COFFDumper::printCOFFExports() {1877for (const ExportDirectoryEntryRef &Exp : Obj->export_directories()) {1878DictScope Export(W, "Export");18791880StringRef Name;1881uint32_t Ordinal;1882bool IsForwarder;18831884if (Error E = Exp.getSymbolName(Name))1885reportError(std::move(E), Obj->getFileName());1886if (Error E = Exp.getOrdinal(Ordinal))1887reportError(std::move(E), Obj->getFileName());1888if (Error E = Exp.isForwarder(IsForwarder))1889reportError(std::move(E), Obj->getFileName());18901891W.printNumber("Ordinal", Ordinal);1892W.printString("Name", Name);1893StringRef ForwardTo;1894if (IsForwarder) {1895if (Error E = Exp.getForwardTo(ForwardTo))1896reportError(std::move(E), Obj->getFileName());1897W.printString("ForwardedTo", ForwardTo);1898} else {1899uint32_t RVA;1900if (Error E = Exp.getExportRVA(RVA))1901reportError(std::move(E), Obj->getFileName());1902W.printHex("RVA", RVA);1903}1904}1905}19061907void COFFDumper::printCOFFDirectives() {1908for (const SectionRef &Section : Obj->sections()) {1909StringRef Name = unwrapOrError(Obj->getFileName(), Section.getName());1910if (Name != ".drectve")1911continue;19121913StringRef Contents =1914unwrapOrError(Obj->getFileName(), Section.getContents());1915W.printString("Directive(s)", Contents);1916}1917}19181919static std::string getBaseRelocTypeName(uint8_t Type) {1920switch (Type) {1921case COFF::IMAGE_REL_BASED_ABSOLUTE: return "ABSOLUTE";1922case COFF::IMAGE_REL_BASED_HIGH: return "HIGH";1923case COFF::IMAGE_REL_BASED_LOW: return "LOW";1924case COFF::IMAGE_REL_BASED_HIGHLOW: return "HIGHLOW";1925case COFF::IMAGE_REL_BASED_HIGHADJ: return "HIGHADJ";1926case COFF::IMAGE_REL_BASED_ARM_MOV32T: return "ARM_MOV32(T)";1927case COFF::IMAGE_REL_BASED_DIR64: return "DIR64";1928default: return "unknown (" + llvm::utostr(Type) + ")";1929}1930}19311932void COFFDumper::printCOFFBaseReloc() {1933ListScope D(W, "BaseReloc");1934for (const BaseRelocRef &I : Obj->base_relocs()) {1935uint8_t Type;1936uint32_t RVA;1937if (Error E = I.getRVA(RVA))1938reportError(std::move(E), Obj->getFileName());1939if (Error E = I.getType(Type))1940reportError(std::move(E), Obj->getFileName());1941DictScope Import(W, "Entry");1942W.printString("Type", getBaseRelocTypeName(Type));1943W.printHex("Address", RVA);1944}1945}19461947void COFFDumper::printCOFFResources() {1948ListScope ResourcesD(W, "Resources");1949for (const SectionRef &S : Obj->sections()) {1950StringRef Name = unwrapOrError(Obj->getFileName(), S.getName());1951if (!Name.starts_with(".rsrc"))1952continue;19531954StringRef Ref = unwrapOrError(Obj->getFileName(), S.getContents());19551956if ((Name == ".rsrc") || (Name == ".rsrc$01")) {1957ResourceSectionRef RSF;1958Error E = RSF.load(Obj, S);1959if (E)1960reportError(std::move(E), Obj->getFileName());1961auto &BaseTable = unwrapOrError(Obj->getFileName(), RSF.getBaseTable());1962W.printNumber("Total Number of Resources",1963countTotalTableEntries(RSF, BaseTable, "Type"));1964W.printHex("Base Table Address",1965Obj->getCOFFSection(S)->PointerToRawData);1966W.startLine() << "\n";1967printResourceDirectoryTable(RSF, BaseTable, "Type");1968}1969if (opts::SectionData)1970W.printBinaryBlock(Name.str() + " Data", Ref);1971}1972}19731974uint32_t1975COFFDumper::countTotalTableEntries(ResourceSectionRef RSF,1976const coff_resource_dir_table &Table,1977StringRef Level) {1978uint32_t TotalEntries = 0;1979for (int i = 0; i < Table.NumberOfNameEntries + Table.NumberOfIDEntries;1980i++) {1981auto Entry = unwrapOrError(Obj->getFileName(), RSF.getTableEntry(Table, i));1982if (Entry.Offset.isSubDir()) {1983StringRef NextLevel;1984if (Level == "Name")1985NextLevel = "Language";1986else1987NextLevel = "Name";1988auto &NextTable =1989unwrapOrError(Obj->getFileName(), RSF.getEntrySubDir(Entry));1990TotalEntries += countTotalTableEntries(RSF, NextTable, NextLevel);1991} else {1992TotalEntries += 1;1993}1994}1995return TotalEntries;1996}19971998void COFFDumper::printResourceDirectoryTable(1999ResourceSectionRef RSF, const coff_resource_dir_table &Table,2000StringRef Level) {20012002W.printNumber("Number of String Entries", Table.NumberOfNameEntries);2003W.printNumber("Number of ID Entries", Table.NumberOfIDEntries);20042005// Iterate through level in resource directory tree.2006for (int i = 0; i < Table.NumberOfNameEntries + Table.NumberOfIDEntries;2007i++) {2008auto Entry = unwrapOrError(Obj->getFileName(), RSF.getTableEntry(Table, i));2009StringRef Name;2010SmallString<20> IDStr;2011raw_svector_ostream OS(IDStr);2012if (i < Table.NumberOfNameEntries) {2013ArrayRef<UTF16> RawEntryNameString =2014unwrapOrError(Obj->getFileName(), RSF.getEntryNameString(Entry));2015std::vector<UTF16> EndianCorrectedNameString;2016if (llvm::sys::IsBigEndianHost) {2017EndianCorrectedNameString.resize(RawEntryNameString.size() + 1);2018std::copy(RawEntryNameString.begin(), RawEntryNameString.end(),2019EndianCorrectedNameString.begin() + 1);2020EndianCorrectedNameString[0] = UNI_UTF16_BYTE_ORDER_MARK_SWAPPED;2021RawEntryNameString = ArrayRef(EndianCorrectedNameString);2022}2023std::string EntryNameString;2024if (!llvm::convertUTF16ToUTF8String(RawEntryNameString, EntryNameString))2025reportError(errorCodeToError(object_error::parse_failed),2026Obj->getFileName());2027OS << ": ";2028OS << EntryNameString;2029} else {2030if (Level == "Type") {2031OS << ": ";2032printResourceTypeName(Entry.Identifier.ID, OS);2033} else {2034OS << ": (ID " << Entry.Identifier.ID << ")";2035}2036}2037Name = IDStr;2038ListScope ResourceType(W, Level.str() + Name.str());2039if (Entry.Offset.isSubDir()) {2040W.printHex("Table Offset", Entry.Offset.value());2041StringRef NextLevel;2042if (Level == "Name")2043NextLevel = "Language";2044else2045NextLevel = "Name";2046auto &NextTable =2047unwrapOrError(Obj->getFileName(), RSF.getEntrySubDir(Entry));2048printResourceDirectoryTable(RSF, NextTable, NextLevel);2049} else {2050W.printHex("Entry Offset", Entry.Offset.value());2051char FormattedTime[20] = {};2052time_t TDS = time_t(Table.TimeDateStamp);2053strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS));2054W.printHex("Time/Date Stamp", FormattedTime, Table.TimeDateStamp);2055W.printNumber("Major Version", Table.MajorVersion);2056W.printNumber("Minor Version", Table.MinorVersion);2057W.printNumber("Characteristics", Table.Characteristics);2058ListScope DataScope(W, "Data");2059auto &DataEntry =2060unwrapOrError(Obj->getFileName(), RSF.getEntryData(Entry));2061W.printHex("DataRVA", DataEntry.DataRVA);2062W.printNumber("DataSize", DataEntry.DataSize);2063W.printNumber("Codepage", DataEntry.Codepage);2064W.printNumber("Reserved", DataEntry.Reserved);2065StringRef Contents =2066unwrapOrError(Obj->getFileName(), RSF.getContents(DataEntry));2067W.printBinaryBlock("Data", Contents);2068}2069}2070}20712072void COFFDumper::printStackMap() const {2073SectionRef StackMapSection;2074for (auto Sec : Obj->sections()) {2075StringRef Name;2076if (Expected<StringRef> NameOrErr = Sec.getName())2077Name = *NameOrErr;2078else2079consumeError(NameOrErr.takeError());20802081if (Name == ".llvm_stackmaps") {2082StackMapSection = Sec;2083break;2084}2085}20862087if (StackMapSection == SectionRef())2088return;20892090StringRef StackMapContents =2091unwrapOrError(Obj->getFileName(), StackMapSection.getContents());2092ArrayRef<uint8_t> StackMapContentsArray =2093arrayRefFromStringRef(StackMapContents);20942095if (Obj->isLittleEndian())2096prettyPrintStackMap(2097W, StackMapParser<llvm::endianness::little>(StackMapContentsArray));2098else2099prettyPrintStackMap(2100W, StackMapParser<llvm::endianness::big>(StackMapContentsArray));2101}21022103void COFFDumper::printAddrsig() {2104SectionRef AddrsigSection;2105for (auto Sec : Obj->sections()) {2106StringRef Name;2107if (Expected<StringRef> NameOrErr = Sec.getName())2108Name = *NameOrErr;2109else2110consumeError(NameOrErr.takeError());21112112if (Name == ".llvm_addrsig") {2113AddrsigSection = Sec;2114break;2115}2116}21172118if (AddrsigSection == SectionRef())2119return;21202121StringRef AddrsigContents =2122unwrapOrError(Obj->getFileName(), AddrsigSection.getContents());2123ArrayRef<uint8_t> AddrsigContentsArray(AddrsigContents.bytes_begin(),2124AddrsigContents.size());21252126ListScope L(W, "Addrsig");2127const uint8_t *Cur = AddrsigContents.bytes_begin();2128const uint8_t *End = AddrsigContents.bytes_end();2129while (Cur != End) {2130unsigned Size;2131const char *Err = nullptr;2132uint64_t SymIndex = decodeULEB128(Cur, &Size, End, &Err);2133if (Err)2134reportError(createError(Err), Obj->getFileName());21352136W.printNumber("Sym", getSymbolName(SymIndex), SymIndex);2137Cur += Size;2138}2139}21402141void COFFDumper::printCGProfile() {2142SectionRef CGProfileSection;2143for (SectionRef Sec : Obj->sections()) {2144StringRef Name = unwrapOrError(Obj->getFileName(), Sec.getName());2145if (Name == ".llvm.call-graph-profile") {2146CGProfileSection = Sec;2147break;2148}2149}21502151if (CGProfileSection == SectionRef())2152return;21532154StringRef CGProfileContents =2155unwrapOrError(Obj->getFileName(), CGProfileSection.getContents());2156BinaryStreamReader Reader(CGProfileContents, llvm::endianness::little);21572158ListScope L(W, "CGProfile");2159while (!Reader.empty()) {2160uint32_t FromIndex, ToIndex;2161uint64_t Count;2162if (Error Err = Reader.readInteger(FromIndex))2163reportError(std::move(Err), Obj->getFileName());2164if (Error Err = Reader.readInteger(ToIndex))2165reportError(std::move(Err), Obj->getFileName());2166if (Error Err = Reader.readInteger(Count))2167reportError(std::move(Err), Obj->getFileName());21682169DictScope D(W, "CGProfileEntry");2170W.printNumber("From", getSymbolName(FromIndex), FromIndex);2171W.printNumber("To", getSymbolName(ToIndex), ToIndex);2172W.printNumber("Weight", Count);2173}2174}21752176StringRef COFFDumper::getSymbolName(uint32_t Index) {2177Expected<COFFSymbolRef> Sym = Obj->getSymbol(Index);2178if (!Sym)2179reportError(Sym.takeError(), Obj->getFileName());21802181Expected<StringRef> SymName = Obj->getSymbolName(*Sym);2182if (!SymName)2183reportError(SymName.takeError(), Obj->getFileName());21842185return *SymName;2186}21872188void llvm::dumpCodeViewMergedTypes(ScopedPrinter &Writer,2189ArrayRef<ArrayRef<uint8_t>> IpiRecords,2190ArrayRef<ArrayRef<uint8_t>> TpiRecords) {2191TypeTableCollection TpiTypes(TpiRecords);2192{2193ListScope S(Writer, "MergedTypeStream");2194TypeDumpVisitor TDV(TpiTypes, &Writer, opts::CodeViewSubsectionBytes);2195if (Error Err = codeview::visitTypeStream(TpiTypes, TDV))2196reportError(std::move(Err), "<?>");2197Writer.flush();2198}21992200// Flatten the id stream and print it next. The ID stream refers to names from2201// the type stream.2202TypeTableCollection IpiTypes(IpiRecords);2203{2204ListScope S(Writer, "MergedIDStream");2205TypeDumpVisitor TDV(TpiTypes, &Writer, opts::CodeViewSubsectionBytes);2206TDV.setIpiTypes(IpiTypes);2207if (Error Err = codeview::visitTypeStream(IpiTypes, TDV))2208reportError(std::move(Err), "<?>");2209Writer.flush();2210}2211}22122213void COFFDumper::printCOFFTLSDirectory() {2214if (Obj->is64())2215printCOFFTLSDirectory(Obj->getTLSDirectory64());2216else2217printCOFFTLSDirectory(Obj->getTLSDirectory32());2218}22192220template <typename IntTy>2221void COFFDumper::printCOFFTLSDirectory(2222const coff_tls_directory<IntTy> *TlsTable) {2223DictScope D(W, "TLSDirectory");2224if (!TlsTable)2225return;22262227W.printHex("StartAddressOfRawData", TlsTable->StartAddressOfRawData);2228W.printHex("EndAddressOfRawData", TlsTable->EndAddressOfRawData);2229W.printHex("AddressOfIndex", TlsTable->AddressOfIndex);2230W.printHex("AddressOfCallBacks", TlsTable->AddressOfCallBacks);2231W.printHex("SizeOfZeroFill", TlsTable->SizeOfZeroFill);2232W.printFlags("Characteristics", TlsTable->Characteristics,2233ArrayRef(ImageSectionCharacteristics),2234COFF::SectionCharacteristics(COFF::IMAGE_SCN_ALIGN_MASK));2235}223622372238