1 //===-- COFFDumper.cpp - COFF-specific dumper -------------------*- C++ -*-===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 /// 10 /// \file 11 /// \brief This file implements the COFF-specific dumper for llvm-readobj. 12 /// 13 //===----------------------------------------------------------------------===// 14 15 #include "ARMWinEHPrinter.h" 16 #include "Error.h" 17 #include "ObjDumper.h" 18 #include "StackMapPrinter.h" 19 #include "Win64EHDumper.h" 20 #include "llvm-readobj.h" 21 #include "llvm/ADT/DenseMap.h" 22 #include "llvm/ADT/SmallString.h" 23 #include "llvm/ADT/StringExtras.h" 24 #include "llvm/BinaryFormat/COFF.h" 25 #include "llvm/DebugInfo/CodeView/CVTypeVisitor.h" 26 #include "llvm/DebugInfo/CodeView/CodeView.h" 27 #include "llvm/DebugInfo/CodeView/DebugChecksumsSubsection.h" 28 #include "llvm/DebugInfo/CodeView/DebugFrameDataSubsection.h" 29 #include "llvm/DebugInfo/CodeView/DebugInlineeLinesSubsection.h" 30 #include "llvm/DebugInfo/CodeView/DebugLinesSubsection.h" 31 #include "llvm/DebugInfo/CodeView/DebugStringTableSubsection.h" 32 #include "llvm/DebugInfo/CodeView/LazyRandomTypeCollection.h" 33 #include "llvm/DebugInfo/CodeView/Line.h" 34 #include "llvm/DebugInfo/CodeView/RecordSerialization.h" 35 #include "llvm/DebugInfo/CodeView/SymbolDeserializer.h" 36 #include "llvm/DebugInfo/CodeView/SymbolDumpDelegate.h" 37 #include "llvm/DebugInfo/CodeView/SymbolDumper.h" 38 #include "llvm/DebugInfo/CodeView/SymbolRecord.h" 39 #include "llvm/DebugInfo/CodeView/TypeDumpVisitor.h" 40 #include "llvm/DebugInfo/CodeView/TypeIndex.h" 41 #include "llvm/DebugInfo/CodeView/TypeRecord.h" 42 #include "llvm/DebugInfo/CodeView/TypeStreamMerger.h" 43 #include "llvm/DebugInfo/CodeView/TypeTableBuilder.h" 44 #include "llvm/DebugInfo/CodeView/TypeTableCollection.h" 45 #include "llvm/Object/COFF.h" 46 #include "llvm/Object/ObjectFile.h" 47 #include "llvm/Support/BinaryStreamReader.h" 48 #include "llvm/Support/Casting.h" 49 #include "llvm/Support/Compiler.h" 50 #include "llvm/Support/ConvertUTF.h" 51 #include "llvm/Support/DataExtractor.h" 52 #include "llvm/Support/FormatVariadic.h" 53 #include "llvm/Support/Path.h" 54 #include "llvm/Support/ScopedPrinter.h" 55 #include "llvm/Support/SourceMgr.h" 56 #include "llvm/Support/Win64EH.h" 57 #include "llvm/Support/raw_ostream.h" 58 #include <algorithm> 59 #include <cstring> 60 #include <system_error> 61 #include <time.h> 62 63 using namespace llvm; 64 using namespace llvm::object; 65 using namespace llvm::codeview; 66 using namespace llvm::support; 67 using namespace llvm::Win64EH; 68 69 namespace { 70 71 struct LoadConfigTables { 72 uint64_t SEHTableVA = 0; 73 uint64_t SEHTableCount = 0; 74 uint32_t GuardFlags = 0; 75 uint64_t GuardFidTableVA = 0; 76 uint64_t GuardFidTableCount = 0; 77 }; 78 79 class COFFDumper : public ObjDumper { 80 public: 81 friend class COFFObjectDumpDelegate; 82 COFFDumper(const llvm::object::COFFObjectFile *Obj, ScopedPrinter &Writer) 83 : ObjDumper(Writer), Obj(Obj), Writer(Writer), Types(100) {} 84 85 void printFileHeaders() override; 86 void printSections() override; 87 void printRelocations() override; 88 void printSymbols() override; 89 void printDynamicSymbols() override; 90 void printUnwindInfo() override; 91 void printCOFFImports() override; 92 void printCOFFExports() override; 93 void printCOFFDirectives() override; 94 void printCOFFBaseReloc() override; 95 void printCOFFDebugDirectory() override; 96 void printCOFFResources() override; 97 void printCOFFLoadConfig() override; 98 void printCodeViewDebugInfo() override; 99 void mergeCodeViewTypes(llvm::codeview::TypeTableBuilder &CVIDs, 100 llvm::codeview::TypeTableBuilder &CVTypes) override; 101 void printStackMap() const override; 102 private: 103 void printSymbol(const SymbolRef &Sym); 104 void printRelocation(const SectionRef &Section, const RelocationRef &Reloc, 105 uint64_t Bias = 0); 106 void printDataDirectory(uint32_t Index, const std::string &FieldName); 107 108 void printDOSHeader(const dos_header *DH); 109 template <class PEHeader> void printPEHeader(const PEHeader *Hdr); 110 void printBaseOfDataField(const pe32_header *Hdr); 111 void printBaseOfDataField(const pe32plus_header *Hdr); 112 template <typename T> 113 void printCOFFLoadConfig(const T *Conf, LoadConfigTables &Tables); 114 typedef void (*PrintExtraCB)(raw_ostream &, const uint8_t *); 115 void printRVATable(uint64_t TableVA, uint64_t Count, uint64_t EntrySize, 116 PrintExtraCB PrintExtra = 0); 117 118 void printCodeViewSymbolSection(StringRef SectionName, const SectionRef &Section); 119 void printCodeViewTypeSection(StringRef SectionName, const SectionRef &Section); 120 StringRef getTypeName(TypeIndex Ty); 121 StringRef getFileNameForFileOffset(uint32_t FileOffset); 122 void printFileNameForOffset(StringRef Label, uint32_t FileOffset); 123 void printTypeIndex(StringRef FieldName, TypeIndex TI) { 124 // Forward to CVTypeDumper for simplicity. 125 codeview::printTypeIndex(Writer, FieldName, TI, Types); 126 } 127 128 void printCodeViewSymbolsSubsection(StringRef Subsection, 129 const SectionRef &Section, 130 StringRef SectionContents); 131 132 void printCodeViewFileChecksums(StringRef Subsection); 133 134 void printCodeViewInlineeLines(StringRef Subsection); 135 136 void printRelocatedField(StringRef Label, const coff_section *Sec, 137 uint32_t RelocOffset, uint32_t Offset, 138 StringRef *RelocSym = nullptr); 139 140 uint32_t countTotalTableEntries(ResourceSectionRef RSF, 141 const coff_resource_dir_table &Table, 142 StringRef Level); 143 144 void printResourceDirectoryTable(ResourceSectionRef RSF, 145 const coff_resource_dir_table &Table, 146 StringRef Level); 147 148 void printBinaryBlockWithRelocs(StringRef Label, const SectionRef &Sec, 149 StringRef SectionContents, StringRef Block); 150 151 /// Given a .debug$S section, find the string table and file checksum table. 152 void initializeFileAndStringTables(BinaryStreamReader &Reader); 153 154 void cacheRelocations(); 155 156 std::error_code resolveSymbol(const coff_section *Section, uint64_t Offset, 157 SymbolRef &Sym); 158 std::error_code resolveSymbolName(const coff_section *Section, 159 uint64_t Offset, StringRef &Name); 160 std::error_code resolveSymbolName(const coff_section *Section, 161 StringRef SectionContents, 162 const void *RelocPtr, StringRef &Name); 163 void printImportedSymbols(iterator_range<imported_symbol_iterator> Range); 164 void printDelayImportedSymbols( 165 const DelayImportDirectoryEntryRef &I, 166 iterator_range<imported_symbol_iterator> Range); 167 ErrorOr<const coff_resource_dir_entry &> 168 getResourceDirectoryTableEntry(const coff_resource_dir_table &Table, 169 uint32_t Index); 170 171 typedef DenseMap<const coff_section*, std::vector<RelocationRef> > RelocMapTy; 172 173 const llvm::object::COFFObjectFile *Obj; 174 bool RelocCached = false; 175 RelocMapTy RelocMap; 176 177 DebugChecksumsSubsectionRef CVFileChecksumTable; 178 179 DebugStringTableSubsectionRef CVStringTable; 180 181 ScopedPrinter &Writer; 182 BinaryByteStream TypeContents; 183 LazyRandomTypeCollection Types; 184 }; 185 186 class COFFObjectDumpDelegate : public SymbolDumpDelegate { 187 public: 188 COFFObjectDumpDelegate(COFFDumper &CD, const SectionRef &SR, 189 const COFFObjectFile *Obj, StringRef SectionContents) 190 : CD(CD), SR(SR), SectionContents(SectionContents) { 191 Sec = Obj->getCOFFSection(SR); 192 } 193 194 uint32_t getRecordOffset(BinaryStreamReader Reader) override { 195 ArrayRef<uint8_t> Data; 196 if (auto EC = Reader.readLongestContiguousChunk(Data)) { 197 llvm::consumeError(std::move(EC)); 198 return 0; 199 } 200 return Data.data() - SectionContents.bytes_begin(); 201 } 202 203 void printRelocatedField(StringRef Label, uint32_t RelocOffset, 204 uint32_t Offset, StringRef *RelocSym) override { 205 CD.printRelocatedField(Label, Sec, RelocOffset, Offset, RelocSym); 206 } 207 208 void printBinaryBlockWithRelocs(StringRef Label, 209 ArrayRef<uint8_t> Block) override { 210 StringRef SBlock(reinterpret_cast<const char *>(Block.data()), 211 Block.size()); 212 if (opts::CodeViewSubsectionBytes) 213 CD.printBinaryBlockWithRelocs(Label, SR, SectionContents, SBlock); 214 } 215 216 StringRef getFileNameForFileOffset(uint32_t FileOffset) override { 217 return CD.getFileNameForFileOffset(FileOffset); 218 } 219 220 DebugStringTableSubsectionRef getStringTable() override { 221 return CD.CVStringTable; 222 } 223 224 private: 225 COFFDumper &CD; 226 const SectionRef &SR; 227 const coff_section *Sec; 228 StringRef SectionContents; 229 }; 230 231 } // end namespace 232 233 namespace llvm { 234 235 std::error_code createCOFFDumper(const object::ObjectFile *Obj, 236 ScopedPrinter &Writer, 237 std::unique_ptr<ObjDumper> &Result) { 238 const COFFObjectFile *COFFObj = dyn_cast<COFFObjectFile>(Obj); 239 if (!COFFObj) 240 return readobj_error::unsupported_obj_file_format; 241 242 Result.reset(new COFFDumper(COFFObj, Writer)); 243 return readobj_error::success; 244 } 245 246 } // namespace llvm 247 248 // Given a a section and an offset into this section the function returns the 249 // symbol used for the relocation at the offset. 250 std::error_code COFFDumper::resolveSymbol(const coff_section *Section, 251 uint64_t Offset, SymbolRef &Sym) { 252 cacheRelocations(); 253 const auto &Relocations = RelocMap[Section]; 254 auto SymI = Obj->symbol_end(); 255 for (const auto &Relocation : Relocations) { 256 uint64_t RelocationOffset = Relocation.getOffset(); 257 258 if (RelocationOffset == Offset) { 259 SymI = Relocation.getSymbol(); 260 break; 261 } 262 } 263 if (SymI == Obj->symbol_end()) 264 return readobj_error::unknown_symbol; 265 Sym = *SymI; 266 return readobj_error::success; 267 } 268 269 // Given a section and an offset into this section the function returns the name 270 // of the symbol used for the relocation at the offset. 271 std::error_code COFFDumper::resolveSymbolName(const coff_section *Section, 272 uint64_t Offset, 273 StringRef &Name) { 274 SymbolRef Symbol; 275 if (std::error_code EC = resolveSymbol(Section, Offset, Symbol)) 276 return EC; 277 Expected<StringRef> NameOrErr = Symbol.getName(); 278 if (!NameOrErr) 279 return errorToErrorCode(NameOrErr.takeError()); 280 Name = *NameOrErr; 281 return std::error_code(); 282 } 283 284 // Helper for when you have a pointer to real data and you want to know about 285 // relocations against it. 286 std::error_code COFFDumper::resolveSymbolName(const coff_section *Section, 287 StringRef SectionContents, 288 const void *RelocPtr, 289 StringRef &Name) { 290 assert(SectionContents.data() < RelocPtr && 291 RelocPtr < SectionContents.data() + SectionContents.size() && 292 "pointer to relocated object is not in section"); 293 uint64_t Offset = ptrdiff_t(reinterpret_cast<const char *>(RelocPtr) - 294 SectionContents.data()); 295 return resolveSymbolName(Section, Offset, Name); 296 } 297 298 void COFFDumper::printRelocatedField(StringRef Label, const coff_section *Sec, 299 uint32_t RelocOffset, uint32_t Offset, 300 StringRef *RelocSym) { 301 StringRef SymStorage; 302 StringRef &Symbol = RelocSym ? *RelocSym : SymStorage; 303 if (!resolveSymbolName(Sec, RelocOffset, Symbol)) 304 W.printSymbolOffset(Label, Symbol, Offset); 305 else 306 W.printHex(Label, RelocOffset); 307 } 308 309 void COFFDumper::printBinaryBlockWithRelocs(StringRef Label, 310 const SectionRef &Sec, 311 StringRef SectionContents, 312 StringRef Block) { 313 W.printBinaryBlock(Label, Block); 314 315 assert(SectionContents.begin() < Block.begin() && 316 SectionContents.end() >= Block.end() && 317 "Block is not contained in SectionContents"); 318 uint64_t OffsetStart = Block.data() - SectionContents.data(); 319 uint64_t OffsetEnd = OffsetStart + Block.size(); 320 321 W.flush(); 322 cacheRelocations(); 323 ListScope D(W, "BlockRelocations"); 324 const coff_section *Section = Obj->getCOFFSection(Sec); 325 const auto &Relocations = RelocMap[Section]; 326 for (const auto &Relocation : Relocations) { 327 uint64_t RelocationOffset = Relocation.getOffset(); 328 if (OffsetStart <= RelocationOffset && RelocationOffset < OffsetEnd) 329 printRelocation(Sec, Relocation, OffsetStart); 330 } 331 } 332 333 static const EnumEntry<COFF::MachineTypes> ImageFileMachineType[] = { 334 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_UNKNOWN ), 335 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AM33 ), 336 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_AMD64 ), 337 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM ), 338 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARM64 ), 339 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_ARMNT ), 340 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_EBC ), 341 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_I386 ), 342 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_IA64 ), 343 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_M32R ), 344 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPS16 ), 345 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU ), 346 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_MIPSFPU16), 347 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPC ), 348 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_POWERPCFP), 349 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_R4000 ), 350 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3 ), 351 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH3DSP ), 352 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH4 ), 353 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_SH5 ), 354 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_THUMB ), 355 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_MACHINE_WCEMIPSV2) 356 }; 357 358 static const EnumEntry<COFF::Characteristics> ImageFileCharacteristics[] = { 359 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_RELOCS_STRIPPED ), 360 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_EXECUTABLE_IMAGE ), 361 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LINE_NUMS_STRIPPED ), 362 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LOCAL_SYMS_STRIPPED ), 363 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_AGGRESSIVE_WS_TRIM ), 364 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_LARGE_ADDRESS_AWARE ), 365 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_LO ), 366 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_32BIT_MACHINE ), 367 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DEBUG_STRIPPED ), 368 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP), 369 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_NET_RUN_FROM_SWAP ), 370 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_SYSTEM ), 371 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_DLL ), 372 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_UP_SYSTEM_ONLY ), 373 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_FILE_BYTES_REVERSED_HI ) 374 }; 375 376 static const EnumEntry<COFF::WindowsSubsystem> PEWindowsSubsystem[] = { 377 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_UNKNOWN ), 378 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_NATIVE ), 379 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_GUI ), 380 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CUI ), 381 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_POSIX_CUI ), 382 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_WINDOWS_CE_GUI ), 383 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_APPLICATION ), 384 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER), 385 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER ), 386 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_EFI_ROM ), 387 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SUBSYSTEM_XBOX ), 388 }; 389 390 static const EnumEntry<COFF::DLLCharacteristics> PEDLLCharacteristics[] = { 391 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA ), 392 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE ), 393 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY ), 394 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NX_COMPAT ), 395 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION ), 396 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_SEH ), 397 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_NO_BIND ), 398 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_APPCONTAINER ), 399 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER ), 400 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_GUARD_CF ), 401 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE), 402 }; 403 404 static const EnumEntry<COFF::SectionCharacteristics> 405 ImageSectionCharacteristics[] = { 406 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NOLOAD ), 407 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_TYPE_NO_PAD ), 408 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_CODE ), 409 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_INITIALIZED_DATA ), 410 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_CNT_UNINITIALIZED_DATA), 411 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_OTHER ), 412 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_INFO ), 413 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_REMOVE ), 414 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_COMDAT ), 415 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_GPREL ), 416 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PURGEABLE ), 417 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_16BIT ), 418 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_LOCKED ), 419 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_PRELOAD ), 420 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1BYTES ), 421 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2BYTES ), 422 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4BYTES ), 423 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8BYTES ), 424 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_16BYTES ), 425 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_32BYTES ), 426 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_64BYTES ), 427 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_128BYTES ), 428 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_256BYTES ), 429 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_512BYTES ), 430 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_1024BYTES ), 431 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_2048BYTES ), 432 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_4096BYTES ), 433 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_ALIGN_8192BYTES ), 434 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_LNK_NRELOC_OVFL ), 435 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_DISCARDABLE ), 436 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_CACHED ), 437 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_NOT_PAGED ), 438 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_SHARED ), 439 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_EXECUTE ), 440 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_READ ), 441 LLVM_READOBJ_ENUM_ENT(COFF, IMAGE_SCN_MEM_WRITE ) 442 }; 443 444 static const EnumEntry<COFF::SymbolBaseType> ImageSymType[] = { 445 { "Null" , COFF::IMAGE_SYM_TYPE_NULL }, 446 { "Void" , COFF::IMAGE_SYM_TYPE_VOID }, 447 { "Char" , COFF::IMAGE_SYM_TYPE_CHAR }, 448 { "Short" , COFF::IMAGE_SYM_TYPE_SHORT }, 449 { "Int" , COFF::IMAGE_SYM_TYPE_INT }, 450 { "Long" , COFF::IMAGE_SYM_TYPE_LONG }, 451 { "Float" , COFF::IMAGE_SYM_TYPE_FLOAT }, 452 { "Double", COFF::IMAGE_SYM_TYPE_DOUBLE }, 453 { "Struct", COFF::IMAGE_SYM_TYPE_STRUCT }, 454 { "Union" , COFF::IMAGE_SYM_TYPE_UNION }, 455 { "Enum" , COFF::IMAGE_SYM_TYPE_ENUM }, 456 { "MOE" , COFF::IMAGE_SYM_TYPE_MOE }, 457 { "Byte" , COFF::IMAGE_SYM_TYPE_BYTE }, 458 { "Word" , COFF::IMAGE_SYM_TYPE_WORD }, 459 { "UInt" , COFF::IMAGE_SYM_TYPE_UINT }, 460 { "DWord" , COFF::IMAGE_SYM_TYPE_DWORD } 461 }; 462 463 static const EnumEntry<COFF::SymbolComplexType> ImageSymDType[] = { 464 { "Null" , COFF::IMAGE_SYM_DTYPE_NULL }, 465 { "Pointer" , COFF::IMAGE_SYM_DTYPE_POINTER }, 466 { "Function", COFF::IMAGE_SYM_DTYPE_FUNCTION }, 467 { "Array" , COFF::IMAGE_SYM_DTYPE_ARRAY } 468 }; 469 470 static const EnumEntry<COFF::SymbolStorageClass> ImageSymClass[] = { 471 { "EndOfFunction" , COFF::IMAGE_SYM_CLASS_END_OF_FUNCTION }, 472 { "Null" , COFF::IMAGE_SYM_CLASS_NULL }, 473 { "Automatic" , COFF::IMAGE_SYM_CLASS_AUTOMATIC }, 474 { "External" , COFF::IMAGE_SYM_CLASS_EXTERNAL }, 475 { "Static" , COFF::IMAGE_SYM_CLASS_STATIC }, 476 { "Register" , COFF::IMAGE_SYM_CLASS_REGISTER }, 477 { "ExternalDef" , COFF::IMAGE_SYM_CLASS_EXTERNAL_DEF }, 478 { "Label" , COFF::IMAGE_SYM_CLASS_LABEL }, 479 { "UndefinedLabel" , COFF::IMAGE_SYM_CLASS_UNDEFINED_LABEL }, 480 { "MemberOfStruct" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_STRUCT }, 481 { "Argument" , COFF::IMAGE_SYM_CLASS_ARGUMENT }, 482 { "StructTag" , COFF::IMAGE_SYM_CLASS_STRUCT_TAG }, 483 { "MemberOfUnion" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_UNION }, 484 { "UnionTag" , COFF::IMAGE_SYM_CLASS_UNION_TAG }, 485 { "TypeDefinition" , COFF::IMAGE_SYM_CLASS_TYPE_DEFINITION }, 486 { "UndefinedStatic", COFF::IMAGE_SYM_CLASS_UNDEFINED_STATIC }, 487 { "EnumTag" , COFF::IMAGE_SYM_CLASS_ENUM_TAG }, 488 { "MemberOfEnum" , COFF::IMAGE_SYM_CLASS_MEMBER_OF_ENUM }, 489 { "RegisterParam" , COFF::IMAGE_SYM_CLASS_REGISTER_PARAM }, 490 { "BitField" , COFF::IMAGE_SYM_CLASS_BIT_FIELD }, 491 { "Block" , COFF::IMAGE_SYM_CLASS_BLOCK }, 492 { "Function" , COFF::IMAGE_SYM_CLASS_FUNCTION }, 493 { "EndOfStruct" , COFF::IMAGE_SYM_CLASS_END_OF_STRUCT }, 494 { "File" , COFF::IMAGE_SYM_CLASS_FILE }, 495 { "Section" , COFF::IMAGE_SYM_CLASS_SECTION }, 496 { "WeakExternal" , COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL }, 497 { "CLRToken" , COFF::IMAGE_SYM_CLASS_CLR_TOKEN } 498 }; 499 500 static const EnumEntry<COFF::COMDATType> ImageCOMDATSelect[] = { 501 { "NoDuplicates", COFF::IMAGE_COMDAT_SELECT_NODUPLICATES }, 502 { "Any" , COFF::IMAGE_COMDAT_SELECT_ANY }, 503 { "SameSize" , COFF::IMAGE_COMDAT_SELECT_SAME_SIZE }, 504 { "ExactMatch" , COFF::IMAGE_COMDAT_SELECT_EXACT_MATCH }, 505 { "Associative" , COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE }, 506 { "Largest" , COFF::IMAGE_COMDAT_SELECT_LARGEST }, 507 { "Newest" , COFF::IMAGE_COMDAT_SELECT_NEWEST } 508 }; 509 510 static const EnumEntry<COFF::DebugType> ImageDebugType[] = { 511 { "Unknown" , COFF::IMAGE_DEBUG_TYPE_UNKNOWN }, 512 { "COFF" , COFF::IMAGE_DEBUG_TYPE_COFF }, 513 { "CodeView" , COFF::IMAGE_DEBUG_TYPE_CODEVIEW }, 514 { "FPO" , COFF::IMAGE_DEBUG_TYPE_FPO }, 515 { "Misc" , COFF::IMAGE_DEBUG_TYPE_MISC }, 516 { "Exception" , COFF::IMAGE_DEBUG_TYPE_EXCEPTION }, 517 { "Fixup" , COFF::IMAGE_DEBUG_TYPE_FIXUP }, 518 { "OmapToSrc" , COFF::IMAGE_DEBUG_TYPE_OMAP_TO_SRC }, 519 { "OmapFromSrc", COFF::IMAGE_DEBUG_TYPE_OMAP_FROM_SRC }, 520 { "Borland" , COFF::IMAGE_DEBUG_TYPE_BORLAND }, 521 { "Reserved10" , COFF::IMAGE_DEBUG_TYPE_RESERVED10 }, 522 { "CLSID" , COFF::IMAGE_DEBUG_TYPE_CLSID }, 523 { "VCFeature" , COFF::IMAGE_DEBUG_TYPE_VC_FEATURE }, 524 { "POGO" , COFF::IMAGE_DEBUG_TYPE_POGO }, 525 { "ILTCG" , COFF::IMAGE_DEBUG_TYPE_ILTCG }, 526 { "MPX" , COFF::IMAGE_DEBUG_TYPE_MPX }, 527 { "Repro" , COFF::IMAGE_DEBUG_TYPE_REPRO }, 528 }; 529 530 static const EnumEntry<COFF::WeakExternalCharacteristics> 531 WeakExternalCharacteristics[] = { 532 { "NoLibrary", COFF::IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY }, 533 { "Library" , COFF::IMAGE_WEAK_EXTERN_SEARCH_LIBRARY }, 534 { "Alias" , COFF::IMAGE_WEAK_EXTERN_SEARCH_ALIAS } 535 }; 536 537 static const EnumEntry<uint32_t> SubSectionTypes[] = { 538 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, Symbols), 539 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, Lines), 540 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, StringTable), 541 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, FileChecksums), 542 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, FrameData), 543 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, InlineeLines), 544 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, CrossScopeImports), 545 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, CrossScopeExports), 546 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, ILLines), 547 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, FuncMDTokenMap), 548 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, TypeMDTokenMap), 549 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, MergedAssemblyInput), 550 LLVM_READOBJ_ENUM_CLASS_ENT(DebugSubsectionKind, CoffSymbolRVA), 551 }; 552 553 static const EnumEntry<uint32_t> FrameDataFlags[] = { 554 LLVM_READOBJ_ENUM_ENT(FrameData, HasSEH), 555 LLVM_READOBJ_ENUM_ENT(FrameData, HasEH), 556 LLVM_READOBJ_ENUM_ENT(FrameData, IsFunctionStart), 557 }; 558 559 static const EnumEntry<uint8_t> FileChecksumKindNames[] = { 560 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, None), 561 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, MD5), 562 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, SHA1), 563 LLVM_READOBJ_ENUM_CLASS_ENT(FileChecksumKind, SHA256), 564 }; 565 566 static const EnumEntry<COFF::ResourceTypeID> ResourceTypeNames[]{ 567 {"kRT_CURSOR (ID 1)", COFF::RID_Cursor}, 568 {"kRT_BITMAP (ID 2)", COFF::RID_Bitmap}, 569 {"kRT_ICON (ID 3)", COFF::RID_Icon}, 570 {"kRT_MENU (ID 4)", COFF::RID_Menu}, 571 {"kRT_DIALOG (ID 5)", COFF::RID_Dialog}, 572 {"kRT_STRING (ID 6)", COFF::RID_String}, 573 {"kRT_FONTDIR (ID 7)", COFF::RID_FontDir}, 574 {"kRT_FONT (ID 8)", COFF::RID_Font}, 575 {"kRT_ACCELERATOR (ID 9)", COFF::RID_Accelerator}, 576 {"kRT_RCDATA (ID 10)", COFF::RID_RCData}, 577 {"kRT_MESSAGETABLE (ID 11)", COFF::RID_MessageTable}, 578 {"kRT_GROUP_CURSOR (ID 12)", COFF::RID_Group_Cursor}, 579 {"kRT_GROUP_ICON (ID 14)", COFF::RID_Group_Icon}, 580 {"kRT_VERSION (ID 16)", COFF::RID_Version}, 581 {"kRT_DLGINCLUDE (ID 17)", COFF::RID_DLGInclude}, 582 {"kRT_PLUGPLAY (ID 19)", COFF::RID_PlugPlay}, 583 {"kRT_VXD (ID 20)", COFF::RID_VXD}, 584 {"kRT_ANICURSOR (ID 21)", COFF::RID_AniCursor}, 585 {"kRT_ANIICON (ID 22)", COFF::RID_AniIcon}, 586 {"kRT_HTML (ID 23)", COFF::RID_HTML}, 587 {"kRT_MANIFEST (ID 24)", COFF::RID_Manifest}}; 588 589 template <typename T> 590 static std::error_code getSymbolAuxData(const COFFObjectFile *Obj, 591 COFFSymbolRef Symbol, 592 uint8_t AuxSymbolIdx, const T *&Aux) { 593 ArrayRef<uint8_t> AuxData = Obj->getSymbolAuxData(Symbol); 594 AuxData = AuxData.slice(AuxSymbolIdx * Obj->getSymbolTableEntrySize()); 595 Aux = reinterpret_cast<const T*>(AuxData.data()); 596 return readobj_error::success; 597 } 598 599 void COFFDumper::cacheRelocations() { 600 if (RelocCached) 601 return; 602 RelocCached = true; 603 604 for (const SectionRef &S : Obj->sections()) { 605 const coff_section *Section = Obj->getCOFFSection(S); 606 607 for (const RelocationRef &Reloc : S.relocations()) 608 RelocMap[Section].push_back(Reloc); 609 610 // Sort relocations by address. 611 std::sort(RelocMap[Section].begin(), RelocMap[Section].end(), 612 relocAddressLess); 613 } 614 } 615 616 void COFFDumper::printDataDirectory(uint32_t Index, const std::string &FieldName) { 617 const data_directory *Data; 618 if (Obj->getDataDirectory(Index, Data)) 619 return; 620 W.printHex(FieldName + "RVA", Data->RelativeVirtualAddress); 621 W.printHex(FieldName + "Size", Data->Size); 622 } 623 624 void COFFDumper::printFileHeaders() { 625 time_t TDS = Obj->getTimeDateStamp(); 626 char FormattedTime[20] = { }; 627 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS)); 628 629 { 630 DictScope D(W, "ImageFileHeader"); 631 W.printEnum ("Machine", Obj->getMachine(), 632 makeArrayRef(ImageFileMachineType)); 633 W.printNumber("SectionCount", Obj->getNumberOfSections()); 634 W.printHex ("TimeDateStamp", FormattedTime, Obj->getTimeDateStamp()); 635 W.printHex ("PointerToSymbolTable", Obj->getPointerToSymbolTable()); 636 W.printNumber("SymbolCount", Obj->getNumberOfSymbols()); 637 W.printNumber("OptionalHeaderSize", Obj->getSizeOfOptionalHeader()); 638 W.printFlags ("Characteristics", Obj->getCharacteristics(), 639 makeArrayRef(ImageFileCharacteristics)); 640 } 641 642 // Print PE header. This header does not exist if this is an object file and 643 // not an executable. 644 const pe32_header *PEHeader = nullptr; 645 error(Obj->getPE32Header(PEHeader)); 646 if (PEHeader) 647 printPEHeader<pe32_header>(PEHeader); 648 649 const pe32plus_header *PEPlusHeader = nullptr; 650 error(Obj->getPE32PlusHeader(PEPlusHeader)); 651 if (PEPlusHeader) 652 printPEHeader<pe32plus_header>(PEPlusHeader); 653 654 if (const dos_header *DH = Obj->getDOSHeader()) 655 printDOSHeader(DH); 656 } 657 658 void COFFDumper::printDOSHeader(const dos_header *DH) { 659 DictScope D(W, "DOSHeader"); 660 W.printString("Magic", StringRef(DH->Magic, sizeof(DH->Magic))); 661 W.printNumber("UsedBytesInTheLastPage", DH->UsedBytesInTheLastPage); 662 W.printNumber("FileSizeInPages", DH->FileSizeInPages); 663 W.printNumber("NumberOfRelocationItems", DH->NumberOfRelocationItems); 664 W.printNumber("HeaderSizeInParagraphs", DH->HeaderSizeInParagraphs); 665 W.printNumber("MinimumExtraParagraphs", DH->MinimumExtraParagraphs); 666 W.printNumber("MaximumExtraParagraphs", DH->MaximumExtraParagraphs); 667 W.printNumber("InitialRelativeSS", DH->InitialRelativeSS); 668 W.printNumber("InitialSP", DH->InitialSP); 669 W.printNumber("Checksum", DH->Checksum); 670 W.printNumber("InitialIP", DH->InitialIP); 671 W.printNumber("InitialRelativeCS", DH->InitialRelativeCS); 672 W.printNumber("AddressOfRelocationTable", DH->AddressOfRelocationTable); 673 W.printNumber("OverlayNumber", DH->OverlayNumber); 674 W.printNumber("OEMid", DH->OEMid); 675 W.printNumber("OEMinfo", DH->OEMinfo); 676 W.printNumber("AddressOfNewExeHeader", DH->AddressOfNewExeHeader); 677 } 678 679 template <class PEHeader> 680 void COFFDumper::printPEHeader(const PEHeader *Hdr) { 681 DictScope D(W, "ImageOptionalHeader"); 682 W.printHex ("Magic", Hdr->Magic); 683 W.printNumber("MajorLinkerVersion", Hdr->MajorLinkerVersion); 684 W.printNumber("MinorLinkerVersion", Hdr->MinorLinkerVersion); 685 W.printNumber("SizeOfCode", Hdr->SizeOfCode); 686 W.printNumber("SizeOfInitializedData", Hdr->SizeOfInitializedData); 687 W.printNumber("SizeOfUninitializedData", Hdr->SizeOfUninitializedData); 688 W.printHex ("AddressOfEntryPoint", Hdr->AddressOfEntryPoint); 689 W.printHex ("BaseOfCode", Hdr->BaseOfCode); 690 printBaseOfDataField(Hdr); 691 W.printHex ("ImageBase", Hdr->ImageBase); 692 W.printNumber("SectionAlignment", Hdr->SectionAlignment); 693 W.printNumber("FileAlignment", Hdr->FileAlignment); 694 W.printNumber("MajorOperatingSystemVersion", 695 Hdr->MajorOperatingSystemVersion); 696 W.printNumber("MinorOperatingSystemVersion", 697 Hdr->MinorOperatingSystemVersion); 698 W.printNumber("MajorImageVersion", Hdr->MajorImageVersion); 699 W.printNumber("MinorImageVersion", Hdr->MinorImageVersion); 700 W.printNumber("MajorSubsystemVersion", Hdr->MajorSubsystemVersion); 701 W.printNumber("MinorSubsystemVersion", Hdr->MinorSubsystemVersion); 702 W.printNumber("SizeOfImage", Hdr->SizeOfImage); 703 W.printNumber("SizeOfHeaders", Hdr->SizeOfHeaders); 704 W.printEnum ("Subsystem", Hdr->Subsystem, makeArrayRef(PEWindowsSubsystem)); 705 W.printFlags ("Characteristics", Hdr->DLLCharacteristics, 706 makeArrayRef(PEDLLCharacteristics)); 707 W.printNumber("SizeOfStackReserve", Hdr->SizeOfStackReserve); 708 W.printNumber("SizeOfStackCommit", Hdr->SizeOfStackCommit); 709 W.printNumber("SizeOfHeapReserve", Hdr->SizeOfHeapReserve); 710 W.printNumber("SizeOfHeapCommit", Hdr->SizeOfHeapCommit); 711 W.printNumber("NumberOfRvaAndSize", Hdr->NumberOfRvaAndSize); 712 713 if (Hdr->NumberOfRvaAndSize > 0) { 714 DictScope D(W, "DataDirectory"); 715 static const char * const directory[] = { 716 "ExportTable", "ImportTable", "ResourceTable", "ExceptionTable", 717 "CertificateTable", "BaseRelocationTable", "Debug", "Architecture", 718 "GlobalPtr", "TLSTable", "LoadConfigTable", "BoundImport", "IAT", 719 "DelayImportDescriptor", "CLRRuntimeHeader", "Reserved" 720 }; 721 722 for (uint32_t i = 0; i < Hdr->NumberOfRvaAndSize; ++i) 723 printDataDirectory(i, directory[i]); 724 } 725 } 726 727 void COFFDumper::printCOFFDebugDirectory() { 728 ListScope LS(W, "DebugDirectory"); 729 for (const debug_directory &D : Obj->debug_directories()) { 730 char FormattedTime[20] = {}; 731 time_t TDS = D.TimeDateStamp; 732 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS)); 733 DictScope S(W, "DebugEntry"); 734 W.printHex("Characteristics", D.Characteristics); 735 W.printHex("TimeDateStamp", FormattedTime, D.TimeDateStamp); 736 W.printHex("MajorVersion", D.MajorVersion); 737 W.printHex("MinorVersion", D.MinorVersion); 738 W.printEnum("Type", D.Type, makeArrayRef(ImageDebugType)); 739 W.printHex("SizeOfData", D.SizeOfData); 740 W.printHex("AddressOfRawData", D.AddressOfRawData); 741 W.printHex("PointerToRawData", D.PointerToRawData); 742 if (D.Type == COFF::IMAGE_DEBUG_TYPE_CODEVIEW) { 743 const codeview::DebugInfo *DebugInfo; 744 StringRef PDBFileName; 745 error(Obj->getDebugPDBInfo(&D, DebugInfo, PDBFileName)); 746 DictScope PDBScope(W, "PDBInfo"); 747 W.printHex("PDBSignature", DebugInfo->Signature.CVSignature); 748 if (DebugInfo->Signature.CVSignature == OMF::Signature::PDB70) { 749 W.printBinary("PDBGUID", makeArrayRef(DebugInfo->PDB70.Signature)); 750 W.printNumber("PDBAge", DebugInfo->PDB70.Age); 751 W.printString("PDBFileName", PDBFileName); 752 } 753 } else { 754 // FIXME: Type values of 12 and 13 are commonly observed but are not in 755 // the documented type enum. Figure out what they mean. 756 ArrayRef<uint8_t> RawData; 757 error( 758 Obj->getRvaAndSizeAsBytes(D.AddressOfRawData, D.SizeOfData, RawData)); 759 W.printBinaryBlock("RawData", RawData); 760 } 761 } 762 } 763 764 void COFFDumper::printRVATable(uint64_t TableVA, uint64_t Count, 765 uint64_t EntrySize, PrintExtraCB PrintExtra) { 766 uintptr_t TableStart, TableEnd; 767 error(Obj->getVaPtr(TableVA, TableStart)); 768 error(Obj->getVaPtr(TableVA + Count * EntrySize - 1, TableEnd)); 769 TableEnd++; 770 for (uintptr_t I = TableStart; I < TableEnd; I += EntrySize) { 771 uint32_t RVA = *reinterpret_cast<const ulittle32_t *>(I); 772 raw_ostream &OS = W.startLine(); 773 OS << "0x" << utohexstr(Obj->getImageBase() + RVA); 774 if (PrintExtra) 775 PrintExtra(OS, reinterpret_cast<const uint8_t *>(I)); 776 OS << '\n'; 777 } 778 } 779 780 void COFFDumper::printCOFFLoadConfig() { 781 LoadConfigTables Tables; 782 if (Obj->is64()) 783 printCOFFLoadConfig(Obj->getLoadConfig64(), Tables); 784 else 785 printCOFFLoadConfig(Obj->getLoadConfig32(), Tables); 786 787 if (Tables.SEHTableVA) { 788 ListScope LS(W, "SEHTable"); 789 printRVATable(Tables.SEHTableVA, Tables.SEHTableCount, 4); 790 } 791 792 if (Tables.GuardFidTableVA) { 793 ListScope LS(W, "GuardFidTable"); 794 if (Tables.GuardFlags & uint32_t(coff_guard_flags::FidTableHasFlags)) { 795 auto PrintGuardFlags = [](raw_ostream &OS, const uint8_t *Entry) { 796 uint8_t Flags = *reinterpret_cast<const uint8_t *>(Entry + 4); 797 if (Flags) 798 OS << " flags " << utohexstr(Flags); 799 }; 800 printRVATable(Tables.GuardFidTableVA, Tables.GuardFidTableCount, 5, 801 PrintGuardFlags); 802 } else { 803 printRVATable(Tables.GuardFidTableVA, Tables.GuardFidTableCount, 4); 804 } 805 } 806 } 807 808 template <typename T> 809 void COFFDumper::printCOFFLoadConfig(const T *Conf, LoadConfigTables &Tables) { 810 if (!Conf) 811 return; 812 813 ListScope LS(W, "LoadConfig"); 814 char FormattedTime[20] = {}; 815 time_t TDS = Conf->TimeDateStamp; 816 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS)); 817 W.printHex("Size", Conf->Size); 818 819 // Print everything before SecurityCookie. The vast majority of images today 820 // have all these fields. 821 if (Conf->Size < offsetof(T, SEHandlerTable)) 822 return; 823 W.printHex("TimeDateStamp", FormattedTime, TDS); 824 W.printHex("MajorVersion", Conf->MajorVersion); 825 W.printHex("MinorVersion", Conf->MinorVersion); 826 W.printHex("GlobalFlagsClear", Conf->GlobalFlagsClear); 827 W.printHex("GlobalFlagsSet", Conf->GlobalFlagsSet); 828 W.printHex("CriticalSectionDefaultTimeout", 829 Conf->CriticalSectionDefaultTimeout); 830 W.printHex("DeCommitFreeBlockThreshold", Conf->DeCommitFreeBlockThreshold); 831 W.printHex("DeCommitTotalFreeThreshold", Conf->DeCommitTotalFreeThreshold); 832 W.printHex("LockPrefixTable", Conf->LockPrefixTable); 833 W.printHex("MaximumAllocationSize", Conf->MaximumAllocationSize); 834 W.printHex("VirtualMemoryThreshold", Conf->VirtualMemoryThreshold); 835 W.printHex("ProcessHeapFlags", Conf->ProcessHeapFlags); 836 W.printHex("ProcessAffinityMask", Conf->ProcessAffinityMask); 837 W.printHex("CSDVersion", Conf->CSDVersion); 838 W.printHex("DependentLoadFlags", Conf->DependentLoadFlags); 839 W.printHex("EditList", Conf->EditList); 840 W.printHex("SecurityCookie", Conf->SecurityCookie); 841 842 // Print the safe SEH table if present. 843 if (Conf->Size < offsetof(coff_load_configuration32, GuardCFCheckFunction)) 844 return; 845 W.printHex("SEHandlerTable", Conf->SEHandlerTable); 846 W.printNumber("SEHandlerCount", Conf->SEHandlerCount); 847 848 Tables.SEHTableVA = Conf->SEHandlerTable; 849 Tables.SEHTableCount = Conf->SEHandlerCount; 850 851 // Print everything before CodeIntegrity. (2015) 852 if (Conf->Size < offsetof(T, CodeIntegrity)) 853 return; 854 W.printHex("GuardCFCheckFunction", Conf->GuardCFCheckFunction); 855 W.printHex("GuardCFCheckDispatch", Conf->GuardCFCheckDispatch); 856 W.printHex("GuardCFFunctionTable", Conf->GuardCFFunctionTable); 857 W.printNumber("GuardCFFunctionCount", Conf->GuardCFFunctionCount); 858 W.printHex("GuardFlags", Conf->GuardFlags); 859 860 Tables.GuardFidTableVA = Conf->GuardCFFunctionTable; 861 Tables.GuardFidTableCount = Conf->GuardCFFunctionCount; 862 Tables.GuardFlags = Conf->GuardFlags; 863 864 // Print the rest. (2017) 865 if (Conf->Size < sizeof(T)) 866 return; 867 W.printHex("GuardAddressTakenIatEntryTable", 868 Conf->GuardAddressTakenIatEntryTable); 869 W.printNumber("GuardAddressTakenIatEntryCount", 870 Conf->GuardAddressTakenIatEntryCount); 871 W.printHex("GuardLongJumpTargetTable", Conf->GuardLongJumpTargetTable); 872 W.printNumber("GuardLongJumpTargetCount", Conf->GuardLongJumpTargetCount); 873 W.printHex("DynamicValueRelocTable", Conf->DynamicValueRelocTable); 874 W.printHex("CHPEMetadataPointer", Conf->CHPEMetadataPointer); 875 W.printHex("GuardRFFailureRoutine", Conf->GuardRFFailureRoutine); 876 W.printHex("GuardRFFailureRoutineFunctionPointer", 877 Conf->GuardRFFailureRoutineFunctionPointer); 878 W.printHex("DynamicValueRelocTableOffset", 879 Conf->DynamicValueRelocTableOffset); 880 W.printNumber("DynamicValueRelocTableSection", 881 Conf->DynamicValueRelocTableSection); 882 W.printHex("GuardRFVerifyStackPointerFunctionPointer", 883 Conf->GuardRFVerifyStackPointerFunctionPointer); 884 W.printHex("HotPatchTableOffset", Conf->HotPatchTableOffset); 885 } 886 887 void COFFDumper::printBaseOfDataField(const pe32_header *Hdr) { 888 W.printHex("BaseOfData", Hdr->BaseOfData); 889 } 890 891 void COFFDumper::printBaseOfDataField(const pe32plus_header *) {} 892 893 void COFFDumper::printCodeViewDebugInfo() { 894 // Print types first to build CVUDTNames, then print symbols. 895 for (const SectionRef &S : Obj->sections()) { 896 StringRef SectionName; 897 error(S.getName(SectionName)); 898 if (SectionName == ".debug$T") 899 printCodeViewTypeSection(SectionName, S); 900 } 901 for (const SectionRef &S : Obj->sections()) { 902 StringRef SectionName; 903 error(S.getName(SectionName)); 904 if (SectionName == ".debug$S") 905 printCodeViewSymbolSection(SectionName, S); 906 } 907 } 908 909 void COFFDumper::initializeFileAndStringTables(BinaryStreamReader &Reader) { 910 while (Reader.bytesRemaining() > 0 && 911 (!CVFileChecksumTable.valid() || !CVStringTable.valid())) { 912 // The section consists of a number of subsection in the following format: 913 // |SubSectionType|SubSectionSize|Contents...| 914 uint32_t SubType, SubSectionSize; 915 error(Reader.readInteger(SubType)); 916 error(Reader.readInteger(SubSectionSize)); 917 918 StringRef Contents; 919 error(Reader.readFixedString(Contents, SubSectionSize)); 920 921 BinaryStreamRef ST(Contents, support::little); 922 switch (DebugSubsectionKind(SubType)) { 923 case DebugSubsectionKind::FileChecksums: 924 error(CVFileChecksumTable.initialize(ST)); 925 break; 926 case DebugSubsectionKind::StringTable: 927 error(CVStringTable.initialize(ST)); 928 break; 929 default: 930 break; 931 } 932 933 uint32_t PaddedSize = alignTo(SubSectionSize, 4); 934 error(Reader.skip(PaddedSize - SubSectionSize)); 935 } 936 } 937 938 void COFFDumper::printCodeViewSymbolSection(StringRef SectionName, 939 const SectionRef &Section) { 940 StringRef SectionContents; 941 error(Section.getContents(SectionContents)); 942 StringRef Data = SectionContents; 943 944 SmallVector<StringRef, 10> FunctionNames; 945 StringMap<StringRef> FunctionLineTables; 946 947 ListScope D(W, "CodeViewDebugInfo"); 948 // Print the section to allow correlation with printSections. 949 W.printNumber("Section", SectionName, Obj->getSectionID(Section)); 950 951 uint32_t Magic; 952 error(consume(Data, Magic)); 953 W.printHex("Magic", Magic); 954 if (Magic != COFF::DEBUG_SECTION_MAGIC) 955 return error(object_error::parse_failed); 956 957 BinaryStreamReader FSReader(Data, support::little); 958 initializeFileAndStringTables(FSReader); 959 960 // TODO: Convert this over to using ModuleSubstreamVisitor. 961 while (!Data.empty()) { 962 // The section consists of a number of subsection in the following format: 963 // |SubSectionType|SubSectionSize|Contents...| 964 uint32_t SubType, SubSectionSize; 965 error(consume(Data, SubType)); 966 error(consume(Data, SubSectionSize)); 967 968 ListScope S(W, "Subsection"); 969 W.printEnum("SubSectionType", SubType, makeArrayRef(SubSectionTypes)); 970 W.printHex("SubSectionSize", SubSectionSize); 971 972 // Get the contents of the subsection. 973 if (SubSectionSize > Data.size()) 974 return error(object_error::parse_failed); 975 StringRef Contents = Data.substr(0, SubSectionSize); 976 977 // Add SubSectionSize to the current offset and align that offset to find 978 // the next subsection. 979 size_t SectionOffset = Data.data() - SectionContents.data(); 980 size_t NextOffset = SectionOffset + SubSectionSize; 981 NextOffset = alignTo(NextOffset, 4); 982 if (NextOffset > SectionContents.size()) 983 return error(object_error::parse_failed); 984 Data = SectionContents.drop_front(NextOffset); 985 986 // Optionally print the subsection bytes in case our parsing gets confused 987 // later. 988 if (opts::CodeViewSubsectionBytes) 989 printBinaryBlockWithRelocs("SubSectionContents", Section, SectionContents, 990 Contents); 991 992 switch (DebugSubsectionKind(SubType)) { 993 case DebugSubsectionKind::Symbols: 994 printCodeViewSymbolsSubsection(Contents, Section, SectionContents); 995 break; 996 997 case DebugSubsectionKind::InlineeLines: 998 printCodeViewInlineeLines(Contents); 999 break; 1000 1001 case DebugSubsectionKind::FileChecksums: 1002 printCodeViewFileChecksums(Contents); 1003 break; 1004 1005 case DebugSubsectionKind::Lines: { 1006 // Holds a PC to file:line table. Some data to parse this subsection is 1007 // stored in the other subsections, so just check sanity and store the 1008 // pointers for deferred processing. 1009 1010 if (SubSectionSize < 12) { 1011 // There should be at least three words to store two function 1012 // relocations and size of the code. 1013 error(object_error::parse_failed); 1014 return; 1015 } 1016 1017 StringRef LinkageName; 1018 error(resolveSymbolName(Obj->getCOFFSection(Section), SectionOffset, 1019 LinkageName)); 1020 W.printString("LinkageName", LinkageName); 1021 if (FunctionLineTables.count(LinkageName) != 0) { 1022 // Saw debug info for this function already? 1023 error(object_error::parse_failed); 1024 return; 1025 } 1026 1027 FunctionLineTables[LinkageName] = Contents; 1028 FunctionNames.push_back(LinkageName); 1029 break; 1030 } 1031 case DebugSubsectionKind::FrameData: { 1032 // First four bytes is a relocation against the function. 1033 BinaryStreamReader SR(Contents, llvm::support::little); 1034 1035 DebugFrameDataSubsectionRef FrameData; 1036 error(FrameData.initialize(SR)); 1037 1038 StringRef LinkageName; 1039 error(resolveSymbolName(Obj->getCOFFSection(Section), SectionContents, 1040 FrameData.getRelocPtr(), LinkageName)); 1041 W.printString("LinkageName", LinkageName); 1042 1043 // To find the active frame description, search this array for the 1044 // smallest PC range that includes the current PC. 1045 for (const auto &FD : FrameData) { 1046 StringRef FrameFunc = error(CVStringTable.getString(FD.FrameFunc)); 1047 1048 DictScope S(W, "FrameData"); 1049 W.printHex("RvaStart", FD.RvaStart); 1050 W.printHex("CodeSize", FD.CodeSize); 1051 W.printHex("LocalSize", FD.LocalSize); 1052 W.printHex("ParamsSize", FD.ParamsSize); 1053 W.printHex("MaxStackSize", FD.MaxStackSize); 1054 W.printString("FrameFunc", FrameFunc); 1055 W.printHex("PrologSize", FD.PrologSize); 1056 W.printHex("SavedRegsSize", FD.SavedRegsSize); 1057 W.printFlags("Flags", FD.Flags, makeArrayRef(FrameDataFlags)); 1058 } 1059 break; 1060 } 1061 1062 // Do nothing for unrecognized subsections. 1063 default: 1064 break; 1065 } 1066 W.flush(); 1067 } 1068 1069 // Dump the line tables now that we've read all the subsections and know all 1070 // the required information. 1071 for (unsigned I = 0, E = FunctionNames.size(); I != E; ++I) { 1072 StringRef Name = FunctionNames[I]; 1073 ListScope S(W, "FunctionLineTable"); 1074 W.printString("LinkageName", Name); 1075 1076 BinaryStreamReader Reader(FunctionLineTables[Name], support::little); 1077 1078 DebugLinesSubsectionRef LineInfo; 1079 error(LineInfo.initialize(Reader)); 1080 1081 W.printHex("Flags", LineInfo.header()->Flags); 1082 W.printHex("CodeSize", LineInfo.header()->CodeSize); 1083 for (const auto &Entry : LineInfo) { 1084 1085 ListScope S(W, "FilenameSegment"); 1086 printFileNameForOffset("Filename", Entry.NameIndex); 1087 uint32_t ColumnIndex = 0; 1088 for (const auto &Line : Entry.LineNumbers) { 1089 if (Line.Offset >= LineInfo.header()->CodeSize) { 1090 error(object_error::parse_failed); 1091 return; 1092 } 1093 1094 std::string PC = formatv("+{0:X}", uint32_t(Line.Offset)); 1095 ListScope PCScope(W, PC); 1096 codeview::LineInfo LI(Line.Flags); 1097 1098 if (LI.isAlwaysStepInto()) 1099 W.printString("StepInto", StringRef("Always")); 1100 else if (LI.isNeverStepInto()) 1101 W.printString("StepInto", StringRef("Never")); 1102 else 1103 W.printNumber("LineNumberStart", LI.getStartLine()); 1104 W.printNumber("LineNumberEndDelta", LI.getLineDelta()); 1105 W.printBoolean("IsStatement", LI.isStatement()); 1106 if (LineInfo.hasColumnInfo()) { 1107 W.printNumber("ColStart", Entry.Columns[ColumnIndex].StartColumn); 1108 W.printNumber("ColEnd", Entry.Columns[ColumnIndex].EndColumn); 1109 ++ColumnIndex; 1110 } 1111 } 1112 } 1113 } 1114 } 1115 1116 void COFFDumper::printCodeViewSymbolsSubsection(StringRef Subsection, 1117 const SectionRef &Section, 1118 StringRef SectionContents) { 1119 ArrayRef<uint8_t> BinaryData(Subsection.bytes_begin(), 1120 Subsection.bytes_end()); 1121 auto CODD = llvm::make_unique<COFFObjectDumpDelegate>(*this, Section, Obj, 1122 SectionContents); 1123 CVSymbolDumper CVSD(W, Types, CodeViewContainer::ObjectFile, std::move(CODD), 1124 opts::CodeViewSubsectionBytes); 1125 CVSymbolArray Symbols; 1126 BinaryStreamReader Reader(BinaryData, llvm::support::little); 1127 if (auto EC = Reader.readArray(Symbols, Reader.getLength())) { 1128 consumeError(std::move(EC)); 1129 W.flush(); 1130 error(object_error::parse_failed); 1131 } 1132 1133 if (auto EC = CVSD.dump(Symbols)) { 1134 W.flush(); 1135 error(std::move(EC)); 1136 } 1137 W.flush(); 1138 } 1139 1140 void COFFDumper::printCodeViewFileChecksums(StringRef Subsection) { 1141 BinaryStreamRef Stream(Subsection, llvm::support::little); 1142 DebugChecksumsSubsectionRef Checksums; 1143 error(Checksums.initialize(Stream)); 1144 1145 for (auto &FC : Checksums) { 1146 DictScope S(W, "FileChecksum"); 1147 1148 StringRef Filename = error(CVStringTable.getString(FC.FileNameOffset)); 1149 W.printHex("Filename", Filename, FC.FileNameOffset); 1150 W.printHex("ChecksumSize", FC.Checksum.size()); 1151 W.printEnum("ChecksumKind", uint8_t(FC.Kind), 1152 makeArrayRef(FileChecksumKindNames)); 1153 1154 W.printBinary("ChecksumBytes", FC.Checksum); 1155 } 1156 } 1157 1158 void COFFDumper::printCodeViewInlineeLines(StringRef Subsection) { 1159 BinaryStreamReader SR(Subsection, llvm::support::little); 1160 DebugInlineeLinesSubsectionRef Lines; 1161 error(Lines.initialize(SR)); 1162 1163 for (auto &Line : Lines) { 1164 DictScope S(W, "InlineeSourceLine"); 1165 printTypeIndex("Inlinee", Line.Header->Inlinee); 1166 printFileNameForOffset("FileID", Line.Header->FileID); 1167 W.printNumber("SourceLineNum", Line.Header->SourceLineNum); 1168 1169 if (Lines.hasExtraFiles()) { 1170 W.printNumber("ExtraFileCount", Line.ExtraFiles.size()); 1171 ListScope ExtraFiles(W, "ExtraFiles"); 1172 for (const auto &FID : Line.ExtraFiles) { 1173 printFileNameForOffset("FileID", FID); 1174 } 1175 } 1176 } 1177 } 1178 1179 StringRef COFFDumper::getFileNameForFileOffset(uint32_t FileOffset) { 1180 // The file checksum subsection should precede all references to it. 1181 if (!CVFileChecksumTable.valid() || !CVStringTable.valid()) 1182 error(object_error::parse_failed); 1183 1184 auto Iter = CVFileChecksumTable.getArray().at(FileOffset); 1185 1186 // Check if the file checksum table offset is valid. 1187 if (Iter == CVFileChecksumTable.end()) 1188 error(object_error::parse_failed); 1189 1190 return error(CVStringTable.getString(Iter->FileNameOffset)); 1191 } 1192 1193 void COFFDumper::printFileNameForOffset(StringRef Label, uint32_t FileOffset) { 1194 W.printHex(Label, getFileNameForFileOffset(FileOffset), FileOffset); 1195 } 1196 1197 void COFFDumper::mergeCodeViewTypes(TypeTableBuilder &CVIDs, 1198 TypeTableBuilder &CVTypes) { 1199 for (const SectionRef &S : Obj->sections()) { 1200 StringRef SectionName; 1201 error(S.getName(SectionName)); 1202 if (SectionName == ".debug$T") { 1203 StringRef Data; 1204 error(S.getContents(Data)); 1205 uint32_t Magic; 1206 error(consume(Data, Magic)); 1207 if (Magic != 4) 1208 error(object_error::parse_failed); 1209 1210 CVTypeArray Types; 1211 BinaryStreamReader Reader(Data, llvm::support::little); 1212 if (auto EC = Reader.readArray(Types, Reader.getLength())) { 1213 consumeError(std::move(EC)); 1214 W.flush(); 1215 error(object_error::parse_failed); 1216 } 1217 SmallVector<TypeIndex, 128> SourceToDest; 1218 if (auto EC = mergeTypeAndIdRecords(CVIDs, CVTypes, SourceToDest, Types)) 1219 return error(std::move(EC)); 1220 } 1221 } 1222 } 1223 1224 void COFFDumper::printCodeViewTypeSection(StringRef SectionName, 1225 const SectionRef &Section) { 1226 ListScope D(W, "CodeViewTypes"); 1227 W.printNumber("Section", SectionName, Obj->getSectionID(Section)); 1228 1229 StringRef Data; 1230 error(Section.getContents(Data)); 1231 if (opts::CodeViewSubsectionBytes) 1232 W.printBinaryBlock("Data", Data); 1233 1234 uint32_t Magic; 1235 error(consume(Data, Magic)); 1236 W.printHex("Magic", Magic); 1237 if (Magic != COFF::DEBUG_SECTION_MAGIC) 1238 return error(object_error::parse_failed); 1239 1240 Types.reset(Data, 100); 1241 1242 TypeDumpVisitor TDV(Types, &W, opts::CodeViewSubsectionBytes); 1243 error(codeview::visitTypeStream(Types, TDV)); 1244 W.flush(); 1245 } 1246 1247 void COFFDumper::printSections() { 1248 ListScope SectionsD(W, "Sections"); 1249 int SectionNumber = 0; 1250 for (const SectionRef &Sec : Obj->sections()) { 1251 ++SectionNumber; 1252 const coff_section *Section = Obj->getCOFFSection(Sec); 1253 1254 StringRef Name; 1255 error(Sec.getName(Name)); 1256 1257 DictScope D(W, "Section"); 1258 W.printNumber("Number", SectionNumber); 1259 W.printBinary("Name", Name, Section->Name); 1260 W.printHex ("VirtualSize", Section->VirtualSize); 1261 W.printHex ("VirtualAddress", Section->VirtualAddress); 1262 W.printNumber("RawDataSize", Section->SizeOfRawData); 1263 W.printHex ("PointerToRawData", Section->PointerToRawData); 1264 W.printHex ("PointerToRelocations", Section->PointerToRelocations); 1265 W.printHex ("PointerToLineNumbers", Section->PointerToLinenumbers); 1266 W.printNumber("RelocationCount", Section->NumberOfRelocations); 1267 W.printNumber("LineNumberCount", Section->NumberOfLinenumbers); 1268 W.printFlags ("Characteristics", Section->Characteristics, 1269 makeArrayRef(ImageSectionCharacteristics), 1270 COFF::SectionCharacteristics(0x00F00000)); 1271 1272 if (opts::SectionRelocations) { 1273 ListScope D(W, "Relocations"); 1274 for (const RelocationRef &Reloc : Sec.relocations()) 1275 printRelocation(Sec, Reloc); 1276 } 1277 1278 if (opts::SectionSymbols) { 1279 ListScope D(W, "Symbols"); 1280 for (const SymbolRef &Symbol : Obj->symbols()) { 1281 if (!Sec.containsSymbol(Symbol)) 1282 continue; 1283 1284 printSymbol(Symbol); 1285 } 1286 } 1287 1288 if (opts::SectionData && 1289 !(Section->Characteristics & COFF::IMAGE_SCN_CNT_UNINITIALIZED_DATA)) { 1290 StringRef Data; 1291 error(Sec.getContents(Data)); 1292 1293 W.printBinaryBlock("SectionData", Data); 1294 } 1295 } 1296 } 1297 1298 void COFFDumper::printRelocations() { 1299 ListScope D(W, "Relocations"); 1300 1301 int SectionNumber = 0; 1302 for (const SectionRef &Section : Obj->sections()) { 1303 ++SectionNumber; 1304 StringRef Name; 1305 error(Section.getName(Name)); 1306 1307 bool PrintedGroup = false; 1308 for (const RelocationRef &Reloc : Section.relocations()) { 1309 if (!PrintedGroup) { 1310 W.startLine() << "Section (" << SectionNumber << ") " << Name << " {\n"; 1311 W.indent(); 1312 PrintedGroup = true; 1313 } 1314 1315 printRelocation(Section, Reloc); 1316 } 1317 1318 if (PrintedGroup) { 1319 W.unindent(); 1320 W.startLine() << "}\n"; 1321 } 1322 } 1323 } 1324 1325 void COFFDumper::printRelocation(const SectionRef &Section, 1326 const RelocationRef &Reloc, uint64_t Bias) { 1327 uint64_t Offset = Reloc.getOffset() - Bias; 1328 uint64_t RelocType = Reloc.getType(); 1329 SmallString<32> RelocName; 1330 StringRef SymbolName; 1331 Reloc.getTypeName(RelocName); 1332 symbol_iterator Symbol = Reloc.getSymbol(); 1333 if (Symbol != Obj->symbol_end()) { 1334 Expected<StringRef> SymbolNameOrErr = Symbol->getName(); 1335 error(errorToErrorCode(SymbolNameOrErr.takeError())); 1336 SymbolName = *SymbolNameOrErr; 1337 } 1338 1339 if (opts::ExpandRelocs) { 1340 DictScope Group(W, "Relocation"); 1341 W.printHex("Offset", Offset); 1342 W.printNumber("Type", RelocName, RelocType); 1343 W.printString("Symbol", SymbolName.empty() ? "-" : SymbolName); 1344 } else { 1345 raw_ostream& OS = W.startLine(); 1346 OS << W.hex(Offset) 1347 << " " << RelocName 1348 << " " << (SymbolName.empty() ? "-" : SymbolName) 1349 << "\n"; 1350 } 1351 } 1352 1353 void COFFDumper::printSymbols() { 1354 ListScope Group(W, "Symbols"); 1355 1356 for (const SymbolRef &Symbol : Obj->symbols()) 1357 printSymbol(Symbol); 1358 } 1359 1360 void COFFDumper::printDynamicSymbols() { ListScope Group(W, "DynamicSymbols"); } 1361 1362 static ErrorOr<StringRef> 1363 getSectionName(const llvm::object::COFFObjectFile *Obj, int32_t SectionNumber, 1364 const coff_section *Section) { 1365 if (Section) { 1366 StringRef SectionName; 1367 if (std::error_code EC = Obj->getSectionName(Section, SectionName)) 1368 return EC; 1369 return SectionName; 1370 } 1371 if (SectionNumber == llvm::COFF::IMAGE_SYM_DEBUG) 1372 return StringRef("IMAGE_SYM_DEBUG"); 1373 if (SectionNumber == llvm::COFF::IMAGE_SYM_ABSOLUTE) 1374 return StringRef("IMAGE_SYM_ABSOLUTE"); 1375 if (SectionNumber == llvm::COFF::IMAGE_SYM_UNDEFINED) 1376 return StringRef("IMAGE_SYM_UNDEFINED"); 1377 return StringRef(""); 1378 } 1379 1380 void COFFDumper::printSymbol(const SymbolRef &Sym) { 1381 DictScope D(W, "Symbol"); 1382 1383 COFFSymbolRef Symbol = Obj->getCOFFSymbol(Sym); 1384 const coff_section *Section; 1385 if (std::error_code EC = Obj->getSection(Symbol.getSectionNumber(), Section)) { 1386 W.startLine() << "Invalid section number: " << EC.message() << "\n"; 1387 W.flush(); 1388 return; 1389 } 1390 1391 StringRef SymbolName; 1392 if (Obj->getSymbolName(Symbol, SymbolName)) 1393 SymbolName = ""; 1394 1395 StringRef SectionName = ""; 1396 ErrorOr<StringRef> Res = 1397 getSectionName(Obj, Symbol.getSectionNumber(), Section); 1398 if (Res) 1399 SectionName = *Res; 1400 1401 W.printString("Name", SymbolName); 1402 W.printNumber("Value", Symbol.getValue()); 1403 W.printNumber("Section", SectionName, Symbol.getSectionNumber()); 1404 W.printEnum ("BaseType", Symbol.getBaseType(), makeArrayRef(ImageSymType)); 1405 W.printEnum ("ComplexType", Symbol.getComplexType(), 1406 makeArrayRef(ImageSymDType)); 1407 W.printEnum ("StorageClass", Symbol.getStorageClass(), 1408 makeArrayRef(ImageSymClass)); 1409 W.printNumber("AuxSymbolCount", Symbol.getNumberOfAuxSymbols()); 1410 1411 for (uint8_t I = 0; I < Symbol.getNumberOfAuxSymbols(); ++I) { 1412 if (Symbol.isFunctionDefinition()) { 1413 const coff_aux_function_definition *Aux; 1414 error(getSymbolAuxData(Obj, Symbol, I, Aux)); 1415 1416 DictScope AS(W, "AuxFunctionDef"); 1417 W.printNumber("TagIndex", Aux->TagIndex); 1418 W.printNumber("TotalSize", Aux->TotalSize); 1419 W.printHex("PointerToLineNumber", Aux->PointerToLinenumber); 1420 W.printHex("PointerToNextFunction", Aux->PointerToNextFunction); 1421 1422 } else if (Symbol.isAnyUndefined()) { 1423 const coff_aux_weak_external *Aux; 1424 error(getSymbolAuxData(Obj, Symbol, I, Aux)); 1425 1426 ErrorOr<COFFSymbolRef> Linked = Obj->getSymbol(Aux->TagIndex); 1427 StringRef LinkedName; 1428 std::error_code EC = Linked.getError(); 1429 if (EC || (EC = Obj->getSymbolName(*Linked, LinkedName))) { 1430 LinkedName = ""; 1431 error(EC); 1432 } 1433 1434 DictScope AS(W, "AuxWeakExternal"); 1435 W.printNumber("Linked", LinkedName, Aux->TagIndex); 1436 W.printEnum ("Search", Aux->Characteristics, 1437 makeArrayRef(WeakExternalCharacteristics)); 1438 1439 } else if (Symbol.isFileRecord()) { 1440 const char *FileName; 1441 error(getSymbolAuxData(Obj, Symbol, I, FileName)); 1442 1443 DictScope AS(W, "AuxFileRecord"); 1444 1445 StringRef Name(FileName, Symbol.getNumberOfAuxSymbols() * 1446 Obj->getSymbolTableEntrySize()); 1447 W.printString("FileName", Name.rtrim(StringRef("\0", 1))); 1448 break; 1449 } else if (Symbol.isSectionDefinition()) { 1450 const coff_aux_section_definition *Aux; 1451 error(getSymbolAuxData(Obj, Symbol, I, Aux)); 1452 1453 int32_t AuxNumber = Aux->getNumber(Symbol.isBigObj()); 1454 1455 DictScope AS(W, "AuxSectionDef"); 1456 W.printNumber("Length", Aux->Length); 1457 W.printNumber("RelocationCount", Aux->NumberOfRelocations); 1458 W.printNumber("LineNumberCount", Aux->NumberOfLinenumbers); 1459 W.printHex("Checksum", Aux->CheckSum); 1460 W.printNumber("Number", AuxNumber); 1461 W.printEnum("Selection", Aux->Selection, makeArrayRef(ImageCOMDATSelect)); 1462 1463 if (Section && Section->Characteristics & COFF::IMAGE_SCN_LNK_COMDAT 1464 && Aux->Selection == COFF::IMAGE_COMDAT_SELECT_ASSOCIATIVE) { 1465 const coff_section *Assoc; 1466 StringRef AssocName = ""; 1467 std::error_code EC = Obj->getSection(AuxNumber, Assoc); 1468 ErrorOr<StringRef> Res = getSectionName(Obj, AuxNumber, Assoc); 1469 if (Res) 1470 AssocName = *Res; 1471 if (!EC) 1472 EC = Res.getError(); 1473 if (EC) { 1474 AssocName = ""; 1475 error(EC); 1476 } 1477 1478 W.printNumber("AssocSection", AssocName, AuxNumber); 1479 } 1480 } else if (Symbol.isCLRToken()) { 1481 const coff_aux_clr_token *Aux; 1482 error(getSymbolAuxData(Obj, Symbol, I, Aux)); 1483 1484 ErrorOr<COFFSymbolRef> ReferredSym = 1485 Obj->getSymbol(Aux->SymbolTableIndex); 1486 StringRef ReferredName; 1487 std::error_code EC = ReferredSym.getError(); 1488 if (EC || (EC = Obj->getSymbolName(*ReferredSym, ReferredName))) { 1489 ReferredName = ""; 1490 error(EC); 1491 } 1492 1493 DictScope AS(W, "AuxCLRToken"); 1494 W.printNumber("AuxType", Aux->AuxType); 1495 W.printNumber("Reserved", Aux->Reserved); 1496 W.printNumber("SymbolTableIndex", ReferredName, Aux->SymbolTableIndex); 1497 1498 } else { 1499 W.startLine() << "<unhandled auxiliary record>\n"; 1500 } 1501 } 1502 } 1503 1504 void COFFDumper::printUnwindInfo() { 1505 ListScope D(W, "UnwindInformation"); 1506 switch (Obj->getMachine()) { 1507 case COFF::IMAGE_FILE_MACHINE_AMD64: { 1508 Win64EH::Dumper Dumper(W); 1509 Win64EH::Dumper::SymbolResolver 1510 Resolver = [](const object::coff_section *Section, uint64_t Offset, 1511 SymbolRef &Symbol, void *user_data) -> std::error_code { 1512 COFFDumper *Dumper = reinterpret_cast<COFFDumper *>(user_data); 1513 return Dumper->resolveSymbol(Section, Offset, Symbol); 1514 }; 1515 Win64EH::Dumper::Context Ctx(*Obj, Resolver, this); 1516 Dumper.printData(Ctx); 1517 break; 1518 } 1519 case COFF::IMAGE_FILE_MACHINE_ARMNT: { 1520 ARM::WinEH::Decoder Decoder(W); 1521 Decoder.dumpProcedureData(*Obj); 1522 break; 1523 } 1524 default: 1525 W.printEnum("unsupported Image Machine", Obj->getMachine(), 1526 makeArrayRef(ImageFileMachineType)); 1527 break; 1528 } 1529 } 1530 1531 void COFFDumper::printImportedSymbols( 1532 iterator_range<imported_symbol_iterator> Range) { 1533 for (const ImportedSymbolRef &I : Range) { 1534 StringRef Sym; 1535 error(I.getSymbolName(Sym)); 1536 uint16_t Ordinal; 1537 error(I.getOrdinal(Ordinal)); 1538 W.printNumber("Symbol", Sym, Ordinal); 1539 } 1540 } 1541 1542 void COFFDumper::printDelayImportedSymbols( 1543 const DelayImportDirectoryEntryRef &I, 1544 iterator_range<imported_symbol_iterator> Range) { 1545 int Index = 0; 1546 for (const ImportedSymbolRef &S : Range) { 1547 DictScope Import(W, "Import"); 1548 StringRef Sym; 1549 error(S.getSymbolName(Sym)); 1550 uint16_t Ordinal; 1551 error(S.getOrdinal(Ordinal)); 1552 W.printNumber("Symbol", Sym, Ordinal); 1553 uint64_t Addr; 1554 error(I.getImportAddress(Index++, Addr)); 1555 W.printHex("Address", Addr); 1556 } 1557 } 1558 1559 void COFFDumper::printCOFFImports() { 1560 // Regular imports 1561 for (const ImportDirectoryEntryRef &I : Obj->import_directories()) { 1562 DictScope Import(W, "Import"); 1563 StringRef Name; 1564 error(I.getName(Name)); 1565 W.printString("Name", Name); 1566 uint32_t ILTAddr; 1567 error(I.getImportLookupTableRVA(ILTAddr)); 1568 W.printHex("ImportLookupTableRVA", ILTAddr); 1569 uint32_t IATAddr; 1570 error(I.getImportAddressTableRVA(IATAddr)); 1571 W.printHex("ImportAddressTableRVA", IATAddr); 1572 // The import lookup table can be missing with certain older linkers, so 1573 // fall back to the import address table in that case. 1574 if (ILTAddr) 1575 printImportedSymbols(I.lookup_table_symbols()); 1576 else 1577 printImportedSymbols(I.imported_symbols()); 1578 } 1579 1580 // Delay imports 1581 for (const DelayImportDirectoryEntryRef &I : Obj->delay_import_directories()) { 1582 DictScope Import(W, "DelayImport"); 1583 StringRef Name; 1584 error(I.getName(Name)); 1585 W.printString("Name", Name); 1586 const delay_import_directory_table_entry *Table; 1587 error(I.getDelayImportTable(Table)); 1588 W.printHex("Attributes", Table->Attributes); 1589 W.printHex("ModuleHandle", Table->ModuleHandle); 1590 W.printHex("ImportAddressTable", Table->DelayImportAddressTable); 1591 W.printHex("ImportNameTable", Table->DelayImportNameTable); 1592 W.printHex("BoundDelayImportTable", Table->BoundDelayImportTable); 1593 W.printHex("UnloadDelayImportTable", Table->UnloadDelayImportTable); 1594 printDelayImportedSymbols(I, I.imported_symbols()); 1595 } 1596 } 1597 1598 void COFFDumper::printCOFFExports() { 1599 for (const ExportDirectoryEntryRef &E : Obj->export_directories()) { 1600 DictScope Export(W, "Export"); 1601 1602 StringRef Name; 1603 uint32_t Ordinal, RVA; 1604 1605 error(E.getSymbolName(Name)); 1606 error(E.getOrdinal(Ordinal)); 1607 error(E.getExportRVA(RVA)); 1608 1609 W.printNumber("Ordinal", Ordinal); 1610 W.printString("Name", Name); 1611 W.printHex("RVA", RVA); 1612 } 1613 } 1614 1615 void COFFDumper::printCOFFDirectives() { 1616 for (const SectionRef &Section : Obj->sections()) { 1617 StringRef Contents; 1618 StringRef Name; 1619 1620 error(Section.getName(Name)); 1621 if (Name != ".drectve") 1622 continue; 1623 1624 error(Section.getContents(Contents)); 1625 1626 W.printString("Directive(s)", Contents); 1627 } 1628 } 1629 1630 static StringRef getBaseRelocTypeName(uint8_t Type) { 1631 switch (Type) { 1632 case COFF::IMAGE_REL_BASED_ABSOLUTE: return "ABSOLUTE"; 1633 case COFF::IMAGE_REL_BASED_HIGH: return "HIGH"; 1634 case COFF::IMAGE_REL_BASED_LOW: return "LOW"; 1635 case COFF::IMAGE_REL_BASED_HIGHLOW: return "HIGHLOW"; 1636 case COFF::IMAGE_REL_BASED_HIGHADJ: return "HIGHADJ"; 1637 case COFF::IMAGE_REL_BASED_ARM_MOV32T: return "ARM_MOV32(T)"; 1638 case COFF::IMAGE_REL_BASED_DIR64: return "DIR64"; 1639 default: { 1640 static std::string Result; 1641 Result = "unknown (" + llvm::utostr(Type) + ")"; 1642 return Result; 1643 } 1644 } 1645 } 1646 1647 void COFFDumper::printCOFFBaseReloc() { 1648 ListScope D(W, "BaseReloc"); 1649 for (const BaseRelocRef &I : Obj->base_relocs()) { 1650 uint8_t Type; 1651 uint32_t RVA; 1652 error(I.getRVA(RVA)); 1653 error(I.getType(Type)); 1654 DictScope Import(W, "Entry"); 1655 W.printString("Type", getBaseRelocTypeName(Type)); 1656 W.printHex("Address", RVA); 1657 } 1658 } 1659 1660 void COFFDumper::printCOFFResources() { 1661 ListScope ResourcesD(W, "Resources"); 1662 for (const SectionRef &S : Obj->sections()) { 1663 StringRef Name; 1664 error(S.getName(Name)); 1665 if (!Name.startswith(".rsrc")) 1666 continue; 1667 1668 StringRef Ref; 1669 error(S.getContents(Ref)); 1670 1671 if ((Name == ".rsrc") || (Name == ".rsrc$01")) { 1672 ResourceSectionRef RSF(Ref); 1673 auto &BaseTable = unwrapOrError(RSF.getBaseTable()); 1674 W.printNumber("Total Number of Resources", 1675 countTotalTableEntries(RSF, BaseTable, "Type")); 1676 W.printHex("Base Table Address", 1677 Obj->getCOFFSection(S)->PointerToRawData); 1678 W.startLine() << "\n"; 1679 printResourceDirectoryTable(RSF, BaseTable, "Type"); 1680 } 1681 if (opts::SectionData) 1682 W.printBinaryBlock(Name.str() + " Data", Ref); 1683 } 1684 } 1685 1686 uint32_t 1687 COFFDumper::countTotalTableEntries(ResourceSectionRef RSF, 1688 const coff_resource_dir_table &Table, 1689 StringRef Level) { 1690 uint32_t TotalEntries = 0; 1691 for (int i = 0; i < Table.NumberOfNameEntries + Table.NumberOfIDEntries; 1692 i++) { 1693 auto Entry = unwrapOrError(getResourceDirectoryTableEntry(Table, i)); 1694 if (Entry.Offset.isSubDir()) { 1695 StringRef NextLevel; 1696 if (Level == "Name") 1697 NextLevel = "Language"; 1698 else 1699 NextLevel = "Name"; 1700 auto &NextTable = unwrapOrError(RSF.getEntrySubDir(Entry)); 1701 TotalEntries += countTotalTableEntries(RSF, NextTable, NextLevel); 1702 } else { 1703 TotalEntries += 1; 1704 } 1705 } 1706 return TotalEntries; 1707 } 1708 1709 void COFFDumper::printResourceDirectoryTable( 1710 ResourceSectionRef RSF, const coff_resource_dir_table &Table, 1711 StringRef Level) { 1712 1713 W.printNumber("Number of String Entries", Table.NumberOfNameEntries); 1714 W.printNumber("Number of ID Entries", Table.NumberOfIDEntries); 1715 1716 // Iterate through level in resource directory tree. 1717 for (int i = 0; i < Table.NumberOfNameEntries + Table.NumberOfIDEntries; 1718 i++) { 1719 auto Entry = unwrapOrError(getResourceDirectoryTableEntry(Table, i)); 1720 StringRef Name; 1721 SmallString<20> IDStr; 1722 raw_svector_ostream OS(IDStr); 1723 if (i < Table.NumberOfNameEntries) { 1724 ArrayRef<UTF16> RawEntryNameString = unwrapOrError(RSF.getEntryNameString(Entry)); 1725 std::vector<UTF16> EndianCorrectedNameString; 1726 if (llvm::sys::IsBigEndianHost) { 1727 EndianCorrectedNameString.resize(RawEntryNameString.size() + 1); 1728 std::copy(RawEntryNameString.begin(), RawEntryNameString.end(), 1729 EndianCorrectedNameString.begin() + 1); 1730 EndianCorrectedNameString[0] = UNI_UTF16_BYTE_ORDER_MARK_SWAPPED; 1731 RawEntryNameString = makeArrayRef(EndianCorrectedNameString); 1732 } 1733 std::string EntryNameString; 1734 if (!llvm::convertUTF16ToUTF8String(RawEntryNameString, EntryNameString)) 1735 error(object_error::parse_failed); 1736 OS << ": "; 1737 OS << EntryNameString; 1738 } else { 1739 if (Level == "Type") { 1740 ScopedPrinter Printer(OS); 1741 Printer.printEnum("", Entry.Identifier.ID, 1742 makeArrayRef(ResourceTypeNames)); 1743 IDStr = IDStr.slice(0, IDStr.find_first_of(")", 0) + 1); 1744 } else { 1745 OS << ": (ID " << Entry.Identifier.ID << ")"; 1746 } 1747 } 1748 Name = StringRef(IDStr); 1749 ListScope ResourceType(W, Level.str() + Name.str()); 1750 if (Entry.Offset.isSubDir()) { 1751 W.printHex("Table Offset", Entry.Offset.value()); 1752 StringRef NextLevel; 1753 if (Level == "Name") 1754 NextLevel = "Language"; 1755 else 1756 NextLevel = "Name"; 1757 auto &NextTable = unwrapOrError(RSF.getEntrySubDir(Entry)); 1758 printResourceDirectoryTable(RSF, NextTable, NextLevel); 1759 } else { 1760 W.printHex("Entry Offset", Entry.Offset.value()); 1761 char FormattedTime[20] = {}; 1762 time_t TDS = time_t(Table.TimeDateStamp); 1763 strftime(FormattedTime, 20, "%Y-%m-%d %H:%M:%S", gmtime(&TDS)); 1764 W.printHex("Time/Date Stamp", FormattedTime, Table.TimeDateStamp); 1765 W.printNumber("Major Version", Table.MajorVersion); 1766 W.printNumber("Minor Version", Table.MinorVersion); 1767 W.printNumber("Characteristics", Table.Characteristics); 1768 } 1769 } 1770 } 1771 1772 ErrorOr<const coff_resource_dir_entry &> 1773 COFFDumper::getResourceDirectoryTableEntry(const coff_resource_dir_table &Table, 1774 uint32_t Index) { 1775 if (Index >= (uint32_t)(Table.NumberOfNameEntries + Table.NumberOfIDEntries)) 1776 return object_error::parse_failed; 1777 auto TablePtr = reinterpret_cast<const coff_resource_dir_entry *>(&Table + 1); 1778 return TablePtr[Index]; 1779 } 1780 1781 void COFFDumper::printStackMap() const { 1782 object::SectionRef StackMapSection; 1783 for (auto Sec : Obj->sections()) { 1784 StringRef Name; 1785 Sec.getName(Name); 1786 if (Name == ".llvm_stackmaps") { 1787 StackMapSection = Sec; 1788 break; 1789 } 1790 } 1791 1792 if (StackMapSection == object::SectionRef()) 1793 return; 1794 1795 StringRef StackMapContents; 1796 StackMapSection.getContents(StackMapContents); 1797 ArrayRef<uint8_t> StackMapContentsArray( 1798 reinterpret_cast<const uint8_t*>(StackMapContents.data()), 1799 StackMapContents.size()); 1800 1801 if (Obj->isLittleEndian()) 1802 prettyPrintStackMap( 1803 llvm::outs(), 1804 StackMapV2Parser<support::little>(StackMapContentsArray)); 1805 else 1806 prettyPrintStackMap(llvm::outs(), 1807 StackMapV2Parser<support::big>(StackMapContentsArray)); 1808 } 1809 1810 void llvm::dumpCodeViewMergedTypes(ScopedPrinter &Writer, 1811 llvm::codeview::TypeTableBuilder &IDTable, 1812 llvm::codeview::TypeTableBuilder &CVTypes) { 1813 // Flatten it first, then run our dumper on it. 1814 SmallString<0> TypeBuf; 1815 CVTypes.ForEachRecord([&](TypeIndex TI, ArrayRef<uint8_t> Record) { 1816 TypeBuf.append(Record.begin(), Record.end()); 1817 }); 1818 1819 TypeTableCollection TpiTypes(CVTypes.records()); 1820 { 1821 ListScope S(Writer, "MergedTypeStream"); 1822 TypeDumpVisitor TDV(TpiTypes, &Writer, opts::CodeViewSubsectionBytes); 1823 error(codeview::visitTypeStream(TpiTypes, TDV)); 1824 Writer.flush(); 1825 } 1826 1827 // Flatten the id stream and print it next. The ID stream refers to names from 1828 // the type stream. 1829 TypeTableCollection IpiTypes(IDTable.records()); 1830 { 1831 ListScope S(Writer, "MergedIDStream"); 1832 TypeDumpVisitor TDV(TpiTypes, &Writer, opts::CodeViewSubsectionBytes); 1833 TDV.setIpiTypes(IpiTypes); 1834 error(codeview::visitTypeStream(IpiTypes, TDV)); 1835 Writer.flush(); 1836 } 1837 } 1838