COFF.h 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317
  1. #pragma once
  2. #ifdef __GNUC__
  3. #pragma GCC diagnostic push
  4. #pragma GCC diagnostic ignored "-Wunused-parameter"
  5. #endif
  6. //===- COFF.h - COFF object file implementation -----------------*- C++ -*-===//
  7. //
  8. // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
  9. // See https://llvm.org/LICENSE.txt for license information.
  10. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
  11. //
  12. //===----------------------------------------------------------------------===//
  13. //
  14. // This file declares the COFFObjectFile class.
  15. //
  16. //===----------------------------------------------------------------------===//
  17. #ifndef LLVM_OBJECT_COFF_H
  18. #define LLVM_OBJECT_COFF_H
  19. #include "llvm/ADT/iterator_range.h"
  20. #include "llvm/BinaryFormat/COFF.h"
  21. #include "llvm/MC/SubtargetFeature.h"
  22. #include "llvm/Object/Binary.h"
  23. #include "llvm/Object/CVDebugRecord.h"
  24. #include "llvm/Object/Error.h"
  25. #include "llvm/Object/ObjectFile.h"
  26. #include "llvm/Support/BinaryByteStream.h"
  27. #include "llvm/Support/ConvertUTF.h"
  28. #include "llvm/Support/Endian.h"
  29. #include "llvm/Support/ErrorHandling.h"
  30. #include <cassert>
  31. #include <cstddef>
  32. #include <cstdint>
  33. #include <system_error>
  34. namespace llvm {
  35. template <typename T> class ArrayRef;
  36. namespace object {
  37. class BaseRelocRef;
  38. class DelayImportDirectoryEntryRef;
  39. class ExportDirectoryEntryRef;
  40. class ImportDirectoryEntryRef;
  41. class ImportedSymbolRef;
  42. class ResourceSectionRef;
  43. using import_directory_iterator = content_iterator<ImportDirectoryEntryRef>;
  44. using delay_import_directory_iterator =
  45. content_iterator<DelayImportDirectoryEntryRef>;
  46. using export_directory_iterator = content_iterator<ExportDirectoryEntryRef>;
  47. using imported_symbol_iterator = content_iterator<ImportedSymbolRef>;
  48. using base_reloc_iterator = content_iterator<BaseRelocRef>;
  49. /// The DOS compatible header at the front of all PE/COFF executables.
  50. struct dos_header {
  51. char Magic[2];
  52. support::ulittle16_t UsedBytesInTheLastPage;
  53. support::ulittle16_t FileSizeInPages;
  54. support::ulittle16_t NumberOfRelocationItems;
  55. support::ulittle16_t HeaderSizeInParagraphs;
  56. support::ulittle16_t MinimumExtraParagraphs;
  57. support::ulittle16_t MaximumExtraParagraphs;
  58. support::ulittle16_t InitialRelativeSS;
  59. support::ulittle16_t InitialSP;
  60. support::ulittle16_t Checksum;
  61. support::ulittle16_t InitialIP;
  62. support::ulittle16_t InitialRelativeCS;
  63. support::ulittle16_t AddressOfRelocationTable;
  64. support::ulittle16_t OverlayNumber;
  65. support::ulittle16_t Reserved[4];
  66. support::ulittle16_t OEMid;
  67. support::ulittle16_t OEMinfo;
  68. support::ulittle16_t Reserved2[10];
  69. support::ulittle32_t AddressOfNewExeHeader;
  70. };
  71. struct coff_file_header {
  72. support::ulittle16_t Machine;
  73. support::ulittle16_t NumberOfSections;
  74. support::ulittle32_t TimeDateStamp;
  75. support::ulittle32_t PointerToSymbolTable;
  76. support::ulittle32_t NumberOfSymbols;
  77. support::ulittle16_t SizeOfOptionalHeader;
  78. support::ulittle16_t Characteristics;
  79. bool isImportLibrary() const { return NumberOfSections == 0xffff; }
  80. };
  81. struct coff_bigobj_file_header {
  82. support::ulittle16_t Sig1;
  83. support::ulittle16_t Sig2;
  84. support::ulittle16_t Version;
  85. support::ulittle16_t Machine;
  86. support::ulittle32_t TimeDateStamp;
  87. uint8_t UUID[16];
  88. support::ulittle32_t unused1;
  89. support::ulittle32_t unused2;
  90. support::ulittle32_t unused3;
  91. support::ulittle32_t unused4;
  92. support::ulittle32_t NumberOfSections;
  93. support::ulittle32_t PointerToSymbolTable;
  94. support::ulittle32_t NumberOfSymbols;
  95. };
  96. /// The 32-bit PE header that follows the COFF header.
  97. struct pe32_header {
  98. support::ulittle16_t Magic;
  99. uint8_t MajorLinkerVersion;
  100. uint8_t MinorLinkerVersion;
  101. support::ulittle32_t SizeOfCode;
  102. support::ulittle32_t SizeOfInitializedData;
  103. support::ulittle32_t SizeOfUninitializedData;
  104. support::ulittle32_t AddressOfEntryPoint;
  105. support::ulittle32_t BaseOfCode;
  106. support::ulittle32_t BaseOfData;
  107. support::ulittle32_t ImageBase;
  108. support::ulittle32_t SectionAlignment;
  109. support::ulittle32_t FileAlignment;
  110. support::ulittle16_t MajorOperatingSystemVersion;
  111. support::ulittle16_t MinorOperatingSystemVersion;
  112. support::ulittle16_t MajorImageVersion;
  113. support::ulittle16_t MinorImageVersion;
  114. support::ulittle16_t MajorSubsystemVersion;
  115. support::ulittle16_t MinorSubsystemVersion;
  116. support::ulittle32_t Win32VersionValue;
  117. support::ulittle32_t SizeOfImage;
  118. support::ulittle32_t SizeOfHeaders;
  119. support::ulittle32_t CheckSum;
  120. support::ulittle16_t Subsystem;
  121. // FIXME: This should be DllCharacteristics.
  122. support::ulittle16_t DLLCharacteristics;
  123. support::ulittle32_t SizeOfStackReserve;
  124. support::ulittle32_t SizeOfStackCommit;
  125. support::ulittle32_t SizeOfHeapReserve;
  126. support::ulittle32_t SizeOfHeapCommit;
  127. support::ulittle32_t LoaderFlags;
  128. // FIXME: This should be NumberOfRvaAndSizes.
  129. support::ulittle32_t NumberOfRvaAndSize;
  130. };
  131. /// The 64-bit PE header that follows the COFF header.
  132. struct pe32plus_header {
  133. support::ulittle16_t Magic;
  134. uint8_t MajorLinkerVersion;
  135. uint8_t MinorLinkerVersion;
  136. support::ulittle32_t SizeOfCode;
  137. support::ulittle32_t SizeOfInitializedData;
  138. support::ulittle32_t SizeOfUninitializedData;
  139. support::ulittle32_t AddressOfEntryPoint;
  140. support::ulittle32_t BaseOfCode;
  141. support::ulittle64_t ImageBase;
  142. support::ulittle32_t SectionAlignment;
  143. support::ulittle32_t FileAlignment;
  144. support::ulittle16_t MajorOperatingSystemVersion;
  145. support::ulittle16_t MinorOperatingSystemVersion;
  146. support::ulittle16_t MajorImageVersion;
  147. support::ulittle16_t MinorImageVersion;
  148. support::ulittle16_t MajorSubsystemVersion;
  149. support::ulittle16_t MinorSubsystemVersion;
  150. support::ulittle32_t Win32VersionValue;
  151. support::ulittle32_t SizeOfImage;
  152. support::ulittle32_t SizeOfHeaders;
  153. support::ulittle32_t CheckSum;
  154. support::ulittle16_t Subsystem;
  155. support::ulittle16_t DLLCharacteristics;
  156. support::ulittle64_t SizeOfStackReserve;
  157. support::ulittle64_t SizeOfStackCommit;
  158. support::ulittle64_t SizeOfHeapReserve;
  159. support::ulittle64_t SizeOfHeapCommit;
  160. support::ulittle32_t LoaderFlags;
  161. support::ulittle32_t NumberOfRvaAndSize;
  162. };
  163. struct data_directory {
  164. support::ulittle32_t RelativeVirtualAddress;
  165. support::ulittle32_t Size;
  166. };
  167. struct debug_directory {
  168. support::ulittle32_t Characteristics;
  169. support::ulittle32_t TimeDateStamp;
  170. support::ulittle16_t MajorVersion;
  171. support::ulittle16_t MinorVersion;
  172. support::ulittle32_t Type;
  173. support::ulittle32_t SizeOfData;
  174. support::ulittle32_t AddressOfRawData;
  175. support::ulittle32_t PointerToRawData;
  176. };
  177. template <typename IntTy>
  178. struct import_lookup_table_entry {
  179. IntTy Data;
  180. bool isOrdinal() const { return Data < 0; }
  181. uint16_t getOrdinal() const {
  182. assert(isOrdinal() && "ILT entry is not an ordinal!");
  183. return Data & 0xFFFF;
  184. }
  185. uint32_t getHintNameRVA() const {
  186. assert(!isOrdinal() && "ILT entry is not a Hint/Name RVA!");
  187. return Data & 0xFFFFFFFF;
  188. }
  189. };
  190. using import_lookup_table_entry32 =
  191. import_lookup_table_entry<support::little32_t>;
  192. using import_lookup_table_entry64 =
  193. import_lookup_table_entry<support::little64_t>;
  194. struct delay_import_directory_table_entry {
  195. // dumpbin reports this field as "Characteristics" instead of "Attributes".
  196. support::ulittle32_t Attributes;
  197. support::ulittle32_t Name;
  198. support::ulittle32_t ModuleHandle;
  199. support::ulittle32_t DelayImportAddressTable;
  200. support::ulittle32_t DelayImportNameTable;
  201. support::ulittle32_t BoundDelayImportTable;
  202. support::ulittle32_t UnloadDelayImportTable;
  203. support::ulittle32_t TimeStamp;
  204. };
  205. struct export_directory_table_entry {
  206. support::ulittle32_t ExportFlags;
  207. support::ulittle32_t TimeDateStamp;
  208. support::ulittle16_t MajorVersion;
  209. support::ulittle16_t MinorVersion;
  210. support::ulittle32_t NameRVA;
  211. support::ulittle32_t OrdinalBase;
  212. support::ulittle32_t AddressTableEntries;
  213. support::ulittle32_t NumberOfNamePointers;
  214. support::ulittle32_t ExportAddressTableRVA;
  215. support::ulittle32_t NamePointerRVA;
  216. support::ulittle32_t OrdinalTableRVA;
  217. };
  218. union export_address_table_entry {
  219. support::ulittle32_t ExportRVA;
  220. support::ulittle32_t ForwarderRVA;
  221. };
  222. using export_name_pointer_table_entry = support::ulittle32_t;
  223. using export_ordinal_table_entry = support::ulittle16_t;
  224. struct StringTableOffset {
  225. support::ulittle32_t Zeroes;
  226. support::ulittle32_t Offset;
  227. };
  228. template <typename SectionNumberType>
  229. struct coff_symbol {
  230. union {
  231. char ShortName[COFF::NameSize];
  232. StringTableOffset Offset;
  233. } Name;
  234. support::ulittle32_t Value;
  235. SectionNumberType SectionNumber;
  236. support::ulittle16_t Type;
  237. uint8_t StorageClass;
  238. uint8_t NumberOfAuxSymbols;
  239. };
  240. using coff_symbol16 = coff_symbol<support::ulittle16_t>;
  241. using coff_symbol32 = coff_symbol<support::ulittle32_t>;
  242. // Contains only common parts of coff_symbol16 and coff_symbol32.
  243. struct coff_symbol_generic {
  244. union {
  245. char ShortName[COFF::NameSize];
  246. StringTableOffset Offset;
  247. } Name;
  248. support::ulittle32_t Value;
  249. };
  250. struct coff_aux_section_definition;
  251. struct coff_aux_weak_external;
  252. class COFFSymbolRef {
  253. public:
  254. COFFSymbolRef() = default;
  255. COFFSymbolRef(const coff_symbol16 *CS) : CS16(CS) {}
  256. COFFSymbolRef(const coff_symbol32 *CS) : CS32(CS) {}
  257. const void *getRawPtr() const {
  258. return CS16 ? static_cast<const void *>(CS16) : CS32;
  259. }
  260. const coff_symbol_generic *getGeneric() const {
  261. if (CS16)
  262. return reinterpret_cast<const coff_symbol_generic *>(CS16);
  263. return reinterpret_cast<const coff_symbol_generic *>(CS32);
  264. }
  265. friend bool operator<(COFFSymbolRef A, COFFSymbolRef B) {
  266. return A.getRawPtr() < B.getRawPtr();
  267. }
  268. bool isBigObj() const {
  269. if (CS16)
  270. return false;
  271. if (CS32)
  272. return true;
  273. llvm_unreachable("COFFSymbolRef points to nothing!");
  274. }
  275. const char *getShortName() const {
  276. return CS16 ? CS16->Name.ShortName : CS32->Name.ShortName;
  277. }
  278. const StringTableOffset &getStringTableOffset() const {
  279. assert(isSet() && "COFFSymbolRef points to nothing!");
  280. return CS16 ? CS16->Name.Offset : CS32->Name.Offset;
  281. }
  282. uint32_t getValue() const {
  283. assert(isSet() && "COFFSymbolRef points to nothing!");
  284. return CS16 ? CS16->Value : CS32->Value;
  285. }
  286. int32_t getSectionNumber() const {
  287. assert(isSet() && "COFFSymbolRef points to nothing!");
  288. if (CS16) {
  289. // Reserved sections are returned as negative numbers.
  290. if (CS16->SectionNumber <= COFF::MaxNumberOfSections16)
  291. return CS16->SectionNumber;
  292. return static_cast<int16_t>(CS16->SectionNumber);
  293. }
  294. return static_cast<int32_t>(CS32->SectionNumber);
  295. }
  296. uint16_t getType() const {
  297. assert(isSet() && "COFFSymbolRef points to nothing!");
  298. return CS16 ? CS16->Type : CS32->Type;
  299. }
  300. uint8_t getStorageClass() const {
  301. assert(isSet() && "COFFSymbolRef points to nothing!");
  302. return CS16 ? CS16->StorageClass : CS32->StorageClass;
  303. }
  304. uint8_t getNumberOfAuxSymbols() const {
  305. assert(isSet() && "COFFSymbolRef points to nothing!");
  306. return CS16 ? CS16->NumberOfAuxSymbols : CS32->NumberOfAuxSymbols;
  307. }
  308. uint8_t getBaseType() const { return getType() & 0x0F; }
  309. uint8_t getComplexType() const {
  310. return (getType() & 0xF0) >> COFF::SCT_COMPLEX_TYPE_SHIFT;
  311. }
  312. template <typename T> const T *getAux() const {
  313. return CS16 ? reinterpret_cast<const T *>(CS16 + 1)
  314. : reinterpret_cast<const T *>(CS32 + 1);
  315. }
  316. const coff_aux_section_definition *getSectionDefinition() const {
  317. if (!getNumberOfAuxSymbols() ||
  318. getStorageClass() != COFF::IMAGE_SYM_CLASS_STATIC)
  319. return nullptr;
  320. return getAux<coff_aux_section_definition>();
  321. }
  322. const coff_aux_weak_external *getWeakExternal() const {
  323. if (!getNumberOfAuxSymbols() ||
  324. getStorageClass() != COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL)
  325. return nullptr;
  326. return getAux<coff_aux_weak_external>();
  327. }
  328. bool isAbsolute() const {
  329. return getSectionNumber() == -1;
  330. }
  331. bool isExternal() const {
  332. return getStorageClass() == COFF::IMAGE_SYM_CLASS_EXTERNAL;
  333. }
  334. bool isCommon() const {
  335. return (isExternal() || isSection()) &&
  336. getSectionNumber() == COFF::IMAGE_SYM_UNDEFINED && getValue() != 0;
  337. }
  338. bool isUndefined() const {
  339. return isExternal() && getSectionNumber() == COFF::IMAGE_SYM_UNDEFINED &&
  340. getValue() == 0;
  341. }
  342. bool isWeakExternal() const {
  343. return getStorageClass() == COFF::IMAGE_SYM_CLASS_WEAK_EXTERNAL;
  344. }
  345. bool isFunctionDefinition() const {
  346. return isExternal() && getBaseType() == COFF::IMAGE_SYM_TYPE_NULL &&
  347. getComplexType() == COFF::IMAGE_SYM_DTYPE_FUNCTION &&
  348. !COFF::isReservedSectionNumber(getSectionNumber());
  349. }
  350. bool isFunctionLineInfo() const {
  351. return getStorageClass() == COFF::IMAGE_SYM_CLASS_FUNCTION;
  352. }
  353. bool isAnyUndefined() const {
  354. return isUndefined() || isWeakExternal();
  355. }
  356. bool isFileRecord() const {
  357. return getStorageClass() == COFF::IMAGE_SYM_CLASS_FILE;
  358. }
  359. bool isSection() const {
  360. return getStorageClass() == COFF::IMAGE_SYM_CLASS_SECTION;
  361. }
  362. bool isSectionDefinition() const {
  363. // C++/CLI creates external ABS symbols for non-const appdomain globals.
  364. // These are also followed by an auxiliary section definition.
  365. bool isAppdomainGlobal =
  366. getStorageClass() == COFF::IMAGE_SYM_CLASS_EXTERNAL &&
  367. getSectionNumber() == COFF::IMAGE_SYM_ABSOLUTE;
  368. bool isOrdinarySection = getStorageClass() == COFF::IMAGE_SYM_CLASS_STATIC;
  369. if (!getNumberOfAuxSymbols())
  370. return false;
  371. return isAppdomainGlobal || isOrdinarySection;
  372. }
  373. bool isCLRToken() const {
  374. return getStorageClass() == COFF::IMAGE_SYM_CLASS_CLR_TOKEN;
  375. }
  376. private:
  377. bool isSet() const { return CS16 || CS32; }
  378. const coff_symbol16 *CS16 = nullptr;
  379. const coff_symbol32 *CS32 = nullptr;
  380. };
  381. struct coff_section {
  382. char Name[COFF::NameSize];
  383. support::ulittle32_t VirtualSize;
  384. support::ulittle32_t VirtualAddress;
  385. support::ulittle32_t SizeOfRawData;
  386. support::ulittle32_t PointerToRawData;
  387. support::ulittle32_t PointerToRelocations;
  388. support::ulittle32_t PointerToLinenumbers;
  389. support::ulittle16_t NumberOfRelocations;
  390. support::ulittle16_t NumberOfLinenumbers;
  391. support::ulittle32_t Characteristics;
  392. // Returns true if the actual number of relocations is stored in
  393. // VirtualAddress field of the first relocation table entry.
  394. bool hasExtendedRelocations() const {
  395. return (Characteristics & COFF::IMAGE_SCN_LNK_NRELOC_OVFL) &&
  396. NumberOfRelocations == UINT16_MAX;
  397. }
  398. uint32_t getAlignment() const {
  399. // The IMAGE_SCN_TYPE_NO_PAD bit is a legacy way of getting to
  400. // IMAGE_SCN_ALIGN_1BYTES.
  401. if (Characteristics & COFF::IMAGE_SCN_TYPE_NO_PAD)
  402. return 1;
  403. // Bit [20:24] contains section alignment. 0 means use a default alignment
  404. // of 16.
  405. uint32_t Shift = (Characteristics >> 20) & 0xF;
  406. if (Shift > 0)
  407. return 1U << (Shift - 1);
  408. return 16;
  409. }
  410. };
  411. struct coff_relocation {
  412. support::ulittle32_t VirtualAddress;
  413. support::ulittle32_t SymbolTableIndex;
  414. support::ulittle16_t Type;
  415. };
  416. struct coff_aux_function_definition {
  417. support::ulittle32_t TagIndex;
  418. support::ulittle32_t TotalSize;
  419. support::ulittle32_t PointerToLinenumber;
  420. support::ulittle32_t PointerToNextFunction;
  421. char Unused1[2];
  422. };
  423. static_assert(sizeof(coff_aux_function_definition) == 18,
  424. "auxiliary entry must be 18 bytes");
  425. struct coff_aux_bf_and_ef_symbol {
  426. char Unused1[4];
  427. support::ulittle16_t Linenumber;
  428. char Unused2[6];
  429. support::ulittle32_t PointerToNextFunction;
  430. char Unused3[2];
  431. };
  432. static_assert(sizeof(coff_aux_bf_and_ef_symbol) == 18,
  433. "auxiliary entry must be 18 bytes");
  434. struct coff_aux_weak_external {
  435. support::ulittle32_t TagIndex;
  436. support::ulittle32_t Characteristics;
  437. char Unused1[10];
  438. };
  439. static_assert(sizeof(coff_aux_weak_external) == 18,
  440. "auxiliary entry must be 18 bytes");
  441. struct coff_aux_section_definition {
  442. support::ulittle32_t Length;
  443. support::ulittle16_t NumberOfRelocations;
  444. support::ulittle16_t NumberOfLinenumbers;
  445. support::ulittle32_t CheckSum;
  446. support::ulittle16_t NumberLowPart;
  447. uint8_t Selection;
  448. uint8_t Unused;
  449. support::ulittle16_t NumberHighPart;
  450. int32_t getNumber(bool IsBigObj) const {
  451. uint32_t Number = static_cast<uint32_t>(NumberLowPart);
  452. if (IsBigObj)
  453. Number |= static_cast<uint32_t>(NumberHighPart) << 16;
  454. return static_cast<int32_t>(Number);
  455. }
  456. };
  457. static_assert(sizeof(coff_aux_section_definition) == 18,
  458. "auxiliary entry must be 18 bytes");
  459. struct coff_aux_clr_token {
  460. uint8_t AuxType;
  461. uint8_t Reserved;
  462. support::ulittle32_t SymbolTableIndex;
  463. char MBZ[12];
  464. };
  465. static_assert(sizeof(coff_aux_clr_token) == 18,
  466. "auxiliary entry must be 18 bytes");
  467. struct coff_import_header {
  468. support::ulittle16_t Sig1;
  469. support::ulittle16_t Sig2;
  470. support::ulittle16_t Version;
  471. support::ulittle16_t Machine;
  472. support::ulittle32_t TimeDateStamp;
  473. support::ulittle32_t SizeOfData;
  474. support::ulittle16_t OrdinalHint;
  475. support::ulittle16_t TypeInfo;
  476. int getType() const { return TypeInfo & 0x3; }
  477. int getNameType() const { return (TypeInfo >> 2) & 0x7; }
  478. };
  479. struct coff_import_directory_table_entry {
  480. support::ulittle32_t ImportLookupTableRVA;
  481. support::ulittle32_t TimeDateStamp;
  482. support::ulittle32_t ForwarderChain;
  483. support::ulittle32_t NameRVA;
  484. support::ulittle32_t ImportAddressTableRVA;
  485. bool isNull() const {
  486. return ImportLookupTableRVA == 0 && TimeDateStamp == 0 &&
  487. ForwarderChain == 0 && NameRVA == 0 && ImportAddressTableRVA == 0;
  488. }
  489. };
  490. template <typename IntTy>
  491. struct coff_tls_directory {
  492. IntTy StartAddressOfRawData;
  493. IntTy EndAddressOfRawData;
  494. IntTy AddressOfIndex;
  495. IntTy AddressOfCallBacks;
  496. support::ulittle32_t SizeOfZeroFill;
  497. support::ulittle32_t Characteristics;
  498. uint32_t getAlignment() const {
  499. // Bit [20:24] contains section alignment.
  500. uint32_t Shift = (Characteristics & COFF::IMAGE_SCN_ALIGN_MASK) >> 20;
  501. if (Shift > 0)
  502. return 1U << (Shift - 1);
  503. return 0;
  504. }
  505. void setAlignment(uint32_t Align) {
  506. uint32_t AlignBits = 0;
  507. if (Align) {
  508. assert(llvm::isPowerOf2_32(Align) && "alignment is not a power of 2");
  509. assert(llvm::Log2_32(Align) <= 13 && "alignment requested is too large");
  510. AlignBits = (llvm::Log2_32(Align) + 1) << 20;
  511. }
  512. Characteristics =
  513. (Characteristics & ~COFF::IMAGE_SCN_ALIGN_MASK) | AlignBits;
  514. }
  515. };
  516. using coff_tls_directory32 = coff_tls_directory<support::little32_t>;
  517. using coff_tls_directory64 = coff_tls_directory<support::little64_t>;
  518. enum class frame_type : uint16_t { Fpo = 0, Trap = 1, Tss = 2, NonFpo = 3 };
  519. struct coff_load_config_code_integrity {
  520. support::ulittle16_t Flags;
  521. support::ulittle16_t Catalog;
  522. support::ulittle32_t CatalogOffset;
  523. support::ulittle32_t Reserved;
  524. };
  525. /// 32-bit load config (IMAGE_LOAD_CONFIG_DIRECTORY32)
  526. struct coff_load_configuration32 {
  527. support::ulittle32_t Size;
  528. support::ulittle32_t TimeDateStamp;
  529. support::ulittle16_t MajorVersion;
  530. support::ulittle16_t MinorVersion;
  531. support::ulittle32_t GlobalFlagsClear;
  532. support::ulittle32_t GlobalFlagsSet;
  533. support::ulittle32_t CriticalSectionDefaultTimeout;
  534. support::ulittle32_t DeCommitFreeBlockThreshold;
  535. support::ulittle32_t DeCommitTotalFreeThreshold;
  536. support::ulittle32_t LockPrefixTable;
  537. support::ulittle32_t MaximumAllocationSize;
  538. support::ulittle32_t VirtualMemoryThreshold;
  539. support::ulittle32_t ProcessAffinityMask;
  540. support::ulittle32_t ProcessHeapFlags;
  541. support::ulittle16_t CSDVersion;
  542. support::ulittle16_t DependentLoadFlags;
  543. support::ulittle32_t EditList;
  544. support::ulittle32_t SecurityCookie;
  545. support::ulittle32_t SEHandlerTable;
  546. support::ulittle32_t SEHandlerCount;
  547. // Added in MSVC 2015 for /guard:cf.
  548. support::ulittle32_t GuardCFCheckFunction;
  549. support::ulittle32_t GuardCFCheckDispatch;
  550. support::ulittle32_t GuardCFFunctionTable;
  551. support::ulittle32_t GuardCFFunctionCount;
  552. support::ulittle32_t GuardFlags; // coff_guard_flags
  553. // Added in MSVC 2017
  554. coff_load_config_code_integrity CodeIntegrity;
  555. support::ulittle32_t GuardAddressTakenIatEntryTable;
  556. support::ulittle32_t GuardAddressTakenIatEntryCount;
  557. support::ulittle32_t GuardLongJumpTargetTable;
  558. support::ulittle32_t GuardLongJumpTargetCount;
  559. support::ulittle32_t DynamicValueRelocTable;
  560. support::ulittle32_t CHPEMetadataPointer;
  561. support::ulittle32_t GuardRFFailureRoutine;
  562. support::ulittle32_t GuardRFFailureRoutineFunctionPointer;
  563. support::ulittle32_t DynamicValueRelocTableOffset;
  564. support::ulittle16_t DynamicValueRelocTableSection;
  565. support::ulittle16_t Reserved2;
  566. support::ulittle32_t GuardRFVerifyStackPointerFunctionPointer;
  567. support::ulittle32_t HotPatchTableOffset;
  568. // Added in MSVC 2019
  569. support::ulittle32_t Reserved3;
  570. support::ulittle32_t EnclaveConfigurationPointer;
  571. support::ulittle32_t VolatileMetadataPointer;
  572. support::ulittle32_t GuardEHContinuationTable;
  573. support::ulittle32_t GuardEHContinuationCount;
  574. support::ulittle32_t GuardXFGCheckFunctionPointer;
  575. support::ulittle32_t GuardXFGDispatchFunctionPointer;
  576. support::ulittle32_t GuardXFGTableDispatchFunctionPointer;
  577. support::ulittle32_t CastGuardOsDeterminedFailureMode;
  578. };
  579. /// 64-bit load config (IMAGE_LOAD_CONFIG_DIRECTORY64)
  580. struct coff_load_configuration64 {
  581. support::ulittle32_t Size;
  582. support::ulittle32_t TimeDateStamp;
  583. support::ulittle16_t MajorVersion;
  584. support::ulittle16_t MinorVersion;
  585. support::ulittle32_t GlobalFlagsClear;
  586. support::ulittle32_t GlobalFlagsSet;
  587. support::ulittle32_t CriticalSectionDefaultTimeout;
  588. support::ulittle64_t DeCommitFreeBlockThreshold;
  589. support::ulittle64_t DeCommitTotalFreeThreshold;
  590. support::ulittle64_t LockPrefixTable;
  591. support::ulittle64_t MaximumAllocationSize;
  592. support::ulittle64_t VirtualMemoryThreshold;
  593. support::ulittle64_t ProcessAffinityMask;
  594. support::ulittle32_t ProcessHeapFlags;
  595. support::ulittle16_t CSDVersion;
  596. support::ulittle16_t DependentLoadFlags;
  597. support::ulittle64_t EditList;
  598. support::ulittle64_t SecurityCookie;
  599. support::ulittle64_t SEHandlerTable;
  600. support::ulittle64_t SEHandlerCount;
  601. // Added in MSVC 2015 for /guard:cf.
  602. support::ulittle64_t GuardCFCheckFunction;
  603. support::ulittle64_t GuardCFCheckDispatch;
  604. support::ulittle64_t GuardCFFunctionTable;
  605. support::ulittle64_t GuardCFFunctionCount;
  606. support::ulittle32_t GuardFlags;
  607. // Added in MSVC 2017
  608. coff_load_config_code_integrity CodeIntegrity;
  609. support::ulittle64_t GuardAddressTakenIatEntryTable;
  610. support::ulittle64_t GuardAddressTakenIatEntryCount;
  611. support::ulittle64_t GuardLongJumpTargetTable;
  612. support::ulittle64_t GuardLongJumpTargetCount;
  613. support::ulittle64_t DynamicValueRelocTable;
  614. support::ulittle64_t CHPEMetadataPointer;
  615. support::ulittle64_t GuardRFFailureRoutine;
  616. support::ulittle64_t GuardRFFailureRoutineFunctionPointer;
  617. support::ulittle32_t DynamicValueRelocTableOffset;
  618. support::ulittle16_t DynamicValueRelocTableSection;
  619. support::ulittle16_t Reserved2;
  620. support::ulittle64_t GuardRFVerifyStackPointerFunctionPointer;
  621. support::ulittle32_t HotPatchTableOffset;
  622. // Added in MSVC 2019
  623. support::ulittle32_t Reserved3;
  624. support::ulittle64_t EnclaveConfigurationPointer;
  625. support::ulittle64_t VolatileMetadataPointer;
  626. support::ulittle64_t GuardEHContinuationTable;
  627. support::ulittle64_t GuardEHContinuationCount;
  628. support::ulittle64_t GuardXFGCheckFunctionPointer;
  629. support::ulittle64_t GuardXFGDispatchFunctionPointer;
  630. support::ulittle64_t GuardXFGTableDispatchFunctionPointer;
  631. support::ulittle64_t CastGuardOsDeterminedFailureMode;
  632. };
  633. struct coff_runtime_function_x64 {
  634. support::ulittle32_t BeginAddress;
  635. support::ulittle32_t EndAddress;
  636. support::ulittle32_t UnwindInformation;
  637. };
  638. struct coff_base_reloc_block_header {
  639. support::ulittle32_t PageRVA;
  640. support::ulittle32_t BlockSize;
  641. };
  642. struct coff_base_reloc_block_entry {
  643. support::ulittle16_t Data;
  644. int getType() const { return Data >> 12; }
  645. int getOffset() const { return Data & ((1 << 12) - 1); }
  646. };
  647. struct coff_resource_dir_entry {
  648. union {
  649. support::ulittle32_t NameOffset;
  650. support::ulittle32_t ID;
  651. uint32_t getNameOffset() const {
  652. return maskTrailingOnes<uint32_t>(31) & NameOffset;
  653. }
  654. // Even though the PE/COFF spec doesn't mention this, the high bit of a name
  655. // offset is set.
  656. void setNameOffset(uint32_t Offset) { NameOffset = Offset | (1 << 31); }
  657. } Identifier;
  658. union {
  659. support::ulittle32_t DataEntryOffset;
  660. support::ulittle32_t SubdirOffset;
  661. bool isSubDir() const { return SubdirOffset >> 31; }
  662. uint32_t value() const {
  663. return maskTrailingOnes<uint32_t>(31) & SubdirOffset;
  664. }
  665. } Offset;
  666. };
  667. struct coff_resource_data_entry {
  668. support::ulittle32_t DataRVA;
  669. support::ulittle32_t DataSize;
  670. support::ulittle32_t Codepage;
  671. support::ulittle32_t Reserved;
  672. };
  673. struct coff_resource_dir_table {
  674. support::ulittle32_t Characteristics;
  675. support::ulittle32_t TimeDateStamp;
  676. support::ulittle16_t MajorVersion;
  677. support::ulittle16_t MinorVersion;
  678. support::ulittle16_t NumberOfNameEntries;
  679. support::ulittle16_t NumberOfIDEntries;
  680. };
  681. struct debug_h_header {
  682. support::ulittle32_t Magic;
  683. support::ulittle16_t Version;
  684. support::ulittle16_t HashAlgorithm;
  685. };
  686. class COFFObjectFile : public ObjectFile {
  687. private:
  688. COFFObjectFile(MemoryBufferRef Object);
  689. friend class ImportDirectoryEntryRef;
  690. friend class ExportDirectoryEntryRef;
  691. const coff_file_header *COFFHeader;
  692. const coff_bigobj_file_header *COFFBigObjHeader;
  693. const pe32_header *PE32Header;
  694. const pe32plus_header *PE32PlusHeader;
  695. const data_directory *DataDirectory;
  696. const coff_section *SectionTable;
  697. const coff_symbol16 *SymbolTable16;
  698. const coff_symbol32 *SymbolTable32;
  699. const char *StringTable;
  700. uint32_t StringTableSize;
  701. const coff_import_directory_table_entry *ImportDirectory;
  702. const delay_import_directory_table_entry *DelayImportDirectory;
  703. uint32_t NumberOfDelayImportDirectory;
  704. const export_directory_table_entry *ExportDirectory;
  705. const coff_base_reloc_block_header *BaseRelocHeader;
  706. const coff_base_reloc_block_header *BaseRelocEnd;
  707. const debug_directory *DebugDirectoryBegin;
  708. const debug_directory *DebugDirectoryEnd;
  709. const coff_tls_directory32 *TLSDirectory32;
  710. const coff_tls_directory64 *TLSDirectory64;
  711. // Either coff_load_configuration32 or coff_load_configuration64.
  712. const void *LoadConfig = nullptr;
  713. Expected<StringRef> getString(uint32_t offset) const;
  714. template <typename coff_symbol_type>
  715. const coff_symbol_type *toSymb(DataRefImpl Symb) const;
  716. const coff_section *toSec(DataRefImpl Sec) const;
  717. const coff_relocation *toRel(DataRefImpl Rel) const;
  718. // Finish initializing the object and return success or an error.
  719. Error initialize();
  720. Error initSymbolTablePtr();
  721. Error initImportTablePtr();
  722. Error initDelayImportTablePtr();
  723. Error initExportTablePtr();
  724. Error initBaseRelocPtr();
  725. Error initDebugDirectoryPtr();
  726. Error initTLSDirectoryPtr();
  727. Error initLoadConfigPtr();
  728. public:
  729. static Expected<std::unique_ptr<COFFObjectFile>>
  730. create(MemoryBufferRef Object);
  731. uintptr_t getSymbolTable() const {
  732. if (SymbolTable16)
  733. return reinterpret_cast<uintptr_t>(SymbolTable16);
  734. if (SymbolTable32)
  735. return reinterpret_cast<uintptr_t>(SymbolTable32);
  736. return uintptr_t(0);
  737. }
  738. uint16_t getMachine() const {
  739. if (COFFHeader)
  740. return COFFHeader->Machine;
  741. if (COFFBigObjHeader)
  742. return COFFBigObjHeader->Machine;
  743. llvm_unreachable("no COFF header!");
  744. }
  745. uint16_t getSizeOfOptionalHeader() const {
  746. if (COFFHeader)
  747. return COFFHeader->isImportLibrary() ? 0
  748. : COFFHeader->SizeOfOptionalHeader;
  749. // bigobj doesn't have this field.
  750. if (COFFBigObjHeader)
  751. return 0;
  752. llvm_unreachable("no COFF header!");
  753. }
  754. uint16_t getCharacteristics() const {
  755. if (COFFHeader)
  756. return COFFHeader->isImportLibrary() ? 0 : COFFHeader->Characteristics;
  757. // bigobj doesn't have characteristics to speak of,
  758. // editbin will silently lie to you if you attempt to set any.
  759. if (COFFBigObjHeader)
  760. return 0;
  761. llvm_unreachable("no COFF header!");
  762. }
  763. uint32_t getTimeDateStamp() const {
  764. if (COFFHeader)
  765. return COFFHeader->TimeDateStamp;
  766. if (COFFBigObjHeader)
  767. return COFFBigObjHeader->TimeDateStamp;
  768. llvm_unreachable("no COFF header!");
  769. }
  770. uint32_t getNumberOfSections() const {
  771. if (COFFHeader)
  772. return COFFHeader->isImportLibrary() ? 0 : COFFHeader->NumberOfSections;
  773. if (COFFBigObjHeader)
  774. return COFFBigObjHeader->NumberOfSections;
  775. llvm_unreachable("no COFF header!");
  776. }
  777. uint32_t getPointerToSymbolTable() const {
  778. if (COFFHeader)
  779. return COFFHeader->isImportLibrary() ? 0
  780. : COFFHeader->PointerToSymbolTable;
  781. if (COFFBigObjHeader)
  782. return COFFBigObjHeader->PointerToSymbolTable;
  783. llvm_unreachable("no COFF header!");
  784. }
  785. uint32_t getRawNumberOfSymbols() const {
  786. if (COFFHeader)
  787. return COFFHeader->isImportLibrary() ? 0 : COFFHeader->NumberOfSymbols;
  788. if (COFFBigObjHeader)
  789. return COFFBigObjHeader->NumberOfSymbols;
  790. llvm_unreachable("no COFF header!");
  791. }
  792. uint32_t getNumberOfSymbols() const {
  793. if (!SymbolTable16 && !SymbolTable32)
  794. return 0;
  795. return getRawNumberOfSymbols();
  796. }
  797. uint32_t getStringTableSize() const { return StringTableSize; }
  798. const export_directory_table_entry *getExportTable() const {
  799. return ExportDirectory;
  800. }
  801. const coff_load_configuration32 *getLoadConfig32() const {
  802. assert(!is64());
  803. return reinterpret_cast<const coff_load_configuration32 *>(LoadConfig);
  804. }
  805. const coff_load_configuration64 *getLoadConfig64() const {
  806. assert(is64());
  807. return reinterpret_cast<const coff_load_configuration64 *>(LoadConfig);
  808. }
  809. StringRef getRelocationTypeName(uint16_t Type) const;
  810. protected:
  811. void moveSymbolNext(DataRefImpl &Symb) const override;
  812. Expected<StringRef> getSymbolName(DataRefImpl Symb) const override;
  813. Expected<uint64_t> getSymbolAddress(DataRefImpl Symb) const override;
  814. uint32_t getSymbolAlignment(DataRefImpl Symb) const override;
  815. uint64_t getSymbolValueImpl(DataRefImpl Symb) const override;
  816. uint64_t getCommonSymbolSizeImpl(DataRefImpl Symb) const override;
  817. Expected<uint32_t> getSymbolFlags(DataRefImpl Symb) const override;
  818. Expected<SymbolRef::Type> getSymbolType(DataRefImpl Symb) const override;
  819. Expected<section_iterator> getSymbolSection(DataRefImpl Symb) const override;
  820. void moveSectionNext(DataRefImpl &Sec) const override;
  821. Expected<StringRef> getSectionName(DataRefImpl Sec) const override;
  822. uint64_t getSectionAddress(DataRefImpl Sec) const override;
  823. uint64_t getSectionIndex(DataRefImpl Sec) const override;
  824. uint64_t getSectionSize(DataRefImpl Sec) const override;
  825. Expected<ArrayRef<uint8_t>>
  826. getSectionContents(DataRefImpl Sec) const override;
  827. uint64_t getSectionAlignment(DataRefImpl Sec) const override;
  828. bool isSectionCompressed(DataRefImpl Sec) const override;
  829. bool isSectionText(DataRefImpl Sec) const override;
  830. bool isSectionData(DataRefImpl Sec) const override;
  831. bool isSectionBSS(DataRefImpl Sec) const override;
  832. bool isSectionVirtual(DataRefImpl Sec) const override;
  833. bool isDebugSection(DataRefImpl Sec) const override;
  834. relocation_iterator section_rel_begin(DataRefImpl Sec) const override;
  835. relocation_iterator section_rel_end(DataRefImpl Sec) const override;
  836. void moveRelocationNext(DataRefImpl &Rel) const override;
  837. uint64_t getRelocationOffset(DataRefImpl Rel) const override;
  838. symbol_iterator getRelocationSymbol(DataRefImpl Rel) const override;
  839. uint64_t getRelocationType(DataRefImpl Rel) const override;
  840. void getRelocationTypeName(DataRefImpl Rel,
  841. SmallVectorImpl<char> &Result) const override;
  842. public:
  843. basic_symbol_iterator symbol_begin() const override;
  844. basic_symbol_iterator symbol_end() const override;
  845. section_iterator section_begin() const override;
  846. section_iterator section_end() const override;
  847. const coff_section *getCOFFSection(const SectionRef &Section) const;
  848. COFFSymbolRef getCOFFSymbol(const DataRefImpl &Ref) const;
  849. COFFSymbolRef getCOFFSymbol(const SymbolRef &Symbol) const;
  850. const coff_relocation *getCOFFRelocation(const RelocationRef &Reloc) const;
  851. unsigned getSectionID(SectionRef Sec) const;
  852. unsigned getSymbolSectionID(SymbolRef Sym) const;
  853. uint8_t getBytesInAddress() const override;
  854. StringRef getFileFormatName() const override;
  855. Triple::ArchType getArch() const override;
  856. Expected<uint64_t> getStartAddress() const override;
  857. Expected<SubtargetFeatures> getFeatures() const override {
  858. return SubtargetFeatures();
  859. }
  860. import_directory_iterator import_directory_begin() const;
  861. import_directory_iterator import_directory_end() const;
  862. delay_import_directory_iterator delay_import_directory_begin() const;
  863. delay_import_directory_iterator delay_import_directory_end() const;
  864. export_directory_iterator export_directory_begin() const;
  865. export_directory_iterator export_directory_end() const;
  866. base_reloc_iterator base_reloc_begin() const;
  867. base_reloc_iterator base_reloc_end() const;
  868. const debug_directory *debug_directory_begin() const {
  869. return DebugDirectoryBegin;
  870. }
  871. const debug_directory *debug_directory_end() const {
  872. return DebugDirectoryEnd;
  873. }
  874. iterator_range<import_directory_iterator> import_directories() const;
  875. iterator_range<delay_import_directory_iterator>
  876. delay_import_directories() const;
  877. iterator_range<export_directory_iterator> export_directories() const;
  878. iterator_range<base_reloc_iterator> base_relocs() const;
  879. iterator_range<const debug_directory *> debug_directories() const {
  880. return make_range(debug_directory_begin(), debug_directory_end());
  881. }
  882. const coff_tls_directory32 *getTLSDirectory32() const {
  883. return TLSDirectory32;
  884. }
  885. const coff_tls_directory64 *getTLSDirectory64() const {
  886. return TLSDirectory64;
  887. }
  888. const dos_header *getDOSHeader() const {
  889. if (!PE32Header && !PE32PlusHeader)
  890. return nullptr;
  891. return reinterpret_cast<const dos_header *>(base());
  892. }
  893. const coff_file_header *getCOFFHeader() const { return COFFHeader; }
  894. const coff_bigobj_file_header *getCOFFBigObjHeader() const {
  895. return COFFBigObjHeader;
  896. }
  897. const pe32_header *getPE32Header() const { return PE32Header; }
  898. const pe32plus_header *getPE32PlusHeader() const { return PE32PlusHeader; }
  899. const data_directory *getDataDirectory(uint32_t index) const;
  900. Expected<const coff_section *> getSection(int32_t index) const;
  901. Expected<COFFSymbolRef> getSymbol(uint32_t index) const {
  902. if (index >= getNumberOfSymbols())
  903. return errorCodeToError(object_error::parse_failed);
  904. if (SymbolTable16)
  905. return COFFSymbolRef(SymbolTable16 + index);
  906. if (SymbolTable32)
  907. return COFFSymbolRef(SymbolTable32 + index);
  908. return errorCodeToError(object_error::parse_failed);
  909. }
  910. template <typename T>
  911. Error getAuxSymbol(uint32_t index, const T *&Res) const {
  912. Expected<COFFSymbolRef> S = getSymbol(index);
  913. if (Error E = S.takeError())
  914. return E;
  915. Res = reinterpret_cast<const T *>(S->getRawPtr());
  916. return Error::success();
  917. }
  918. Expected<StringRef> getSymbolName(COFFSymbolRef Symbol) const;
  919. Expected<StringRef> getSymbolName(const coff_symbol_generic *Symbol) const;
  920. ArrayRef<uint8_t> getSymbolAuxData(COFFSymbolRef Symbol) const;
  921. uint32_t getSymbolIndex(COFFSymbolRef Symbol) const;
  922. size_t getSymbolTableEntrySize() const {
  923. if (COFFHeader)
  924. return sizeof(coff_symbol16);
  925. if (COFFBigObjHeader)
  926. return sizeof(coff_symbol32);
  927. llvm_unreachable("null symbol table pointer!");
  928. }
  929. ArrayRef<coff_relocation> getRelocations(const coff_section *Sec) const;
  930. Expected<StringRef> getSectionName(const coff_section *Sec) const;
  931. uint64_t getSectionSize(const coff_section *Sec) const;
  932. Error getSectionContents(const coff_section *Sec,
  933. ArrayRef<uint8_t> &Res) const;
  934. uint64_t getImageBase() const;
  935. Error getVaPtr(uint64_t VA, uintptr_t &Res) const;
  936. Error getRvaPtr(uint32_t Rva, uintptr_t &Res,
  937. const char *ErrorContext = nullptr) const;
  938. /// Given an RVA base and size, returns a valid array of bytes or an error
  939. /// code if the RVA and size is not contained completely within a valid
  940. /// section.
  941. Error getRvaAndSizeAsBytes(uint32_t RVA, uint32_t Size,
  942. ArrayRef<uint8_t> &Contents,
  943. const char *ErrorContext = nullptr) const;
  944. Error getHintName(uint32_t Rva, uint16_t &Hint,
  945. StringRef &Name) const;
  946. /// Get PDB information out of a codeview debug directory entry.
  947. Error getDebugPDBInfo(const debug_directory *DebugDir,
  948. const codeview::DebugInfo *&Info,
  949. StringRef &PDBFileName) const;
  950. /// Get PDB information from an executable. If the information is not present,
  951. /// Info will be set to nullptr and PDBFileName will be empty. An error is
  952. /// returned only on corrupt object files. Convenience accessor that can be
  953. /// used if the debug directory is not already handy.
  954. Error getDebugPDBInfo(const codeview::DebugInfo *&Info,
  955. StringRef &PDBFileName) const;
  956. bool isRelocatableObject() const override;
  957. bool is64() const { return PE32PlusHeader; }
  958. StringRef mapDebugSectionName(StringRef Name) const override;
  959. static bool classof(const Binary *v) { return v->isCOFF(); }
  960. };
  961. // The iterator for the import directory table.
  962. class ImportDirectoryEntryRef {
  963. public:
  964. ImportDirectoryEntryRef() = default;
  965. ImportDirectoryEntryRef(const coff_import_directory_table_entry *Table,
  966. uint32_t I, const COFFObjectFile *Owner)
  967. : ImportTable(Table), Index(I), OwningObject(Owner) {}
  968. bool operator==(const ImportDirectoryEntryRef &Other) const;
  969. void moveNext();
  970. imported_symbol_iterator imported_symbol_begin() const;
  971. imported_symbol_iterator imported_symbol_end() const;
  972. iterator_range<imported_symbol_iterator> imported_symbols() const;
  973. imported_symbol_iterator lookup_table_begin() const;
  974. imported_symbol_iterator lookup_table_end() const;
  975. iterator_range<imported_symbol_iterator> lookup_table_symbols() const;
  976. Error getName(StringRef &Result) const;
  977. Error getImportLookupTableRVA(uint32_t &Result) const;
  978. Error getImportAddressTableRVA(uint32_t &Result) const;
  979. Error
  980. getImportTableEntry(const coff_import_directory_table_entry *&Result) const;
  981. private:
  982. const coff_import_directory_table_entry *ImportTable;
  983. uint32_t Index;
  984. const COFFObjectFile *OwningObject = nullptr;
  985. };
  986. class DelayImportDirectoryEntryRef {
  987. public:
  988. DelayImportDirectoryEntryRef() = default;
  989. DelayImportDirectoryEntryRef(const delay_import_directory_table_entry *T,
  990. uint32_t I, const COFFObjectFile *Owner)
  991. : Table(T), Index(I), OwningObject(Owner) {}
  992. bool operator==(const DelayImportDirectoryEntryRef &Other) const;
  993. void moveNext();
  994. imported_symbol_iterator imported_symbol_begin() const;
  995. imported_symbol_iterator imported_symbol_end() const;
  996. iterator_range<imported_symbol_iterator> imported_symbols() const;
  997. Error getName(StringRef &Result) const;
  998. Error getDelayImportTable(
  999. const delay_import_directory_table_entry *&Result) const;
  1000. Error getImportAddress(int AddrIndex, uint64_t &Result) const;
  1001. private:
  1002. const delay_import_directory_table_entry *Table;
  1003. uint32_t Index;
  1004. const COFFObjectFile *OwningObject = nullptr;
  1005. };
  1006. // The iterator for the export directory table entry.
  1007. class ExportDirectoryEntryRef {
  1008. public:
  1009. ExportDirectoryEntryRef() = default;
  1010. ExportDirectoryEntryRef(const export_directory_table_entry *Table, uint32_t I,
  1011. const COFFObjectFile *Owner)
  1012. : ExportTable(Table), Index(I), OwningObject(Owner) {}
  1013. bool operator==(const ExportDirectoryEntryRef &Other) const;
  1014. void moveNext();
  1015. Error getDllName(StringRef &Result) const;
  1016. Error getOrdinalBase(uint32_t &Result) const;
  1017. Error getOrdinal(uint32_t &Result) const;
  1018. Error getExportRVA(uint32_t &Result) const;
  1019. Error getSymbolName(StringRef &Result) const;
  1020. Error isForwarder(bool &Result) const;
  1021. Error getForwardTo(StringRef &Result) const;
  1022. private:
  1023. const export_directory_table_entry *ExportTable;
  1024. uint32_t Index;
  1025. const COFFObjectFile *OwningObject = nullptr;
  1026. };
  1027. class ImportedSymbolRef {
  1028. public:
  1029. ImportedSymbolRef() = default;
  1030. ImportedSymbolRef(const import_lookup_table_entry32 *Entry, uint32_t I,
  1031. const COFFObjectFile *Owner)
  1032. : Entry32(Entry), Entry64(nullptr), Index(I), OwningObject(Owner) {}
  1033. ImportedSymbolRef(const import_lookup_table_entry64 *Entry, uint32_t I,
  1034. const COFFObjectFile *Owner)
  1035. : Entry32(nullptr), Entry64(Entry), Index(I), OwningObject(Owner) {}
  1036. bool operator==(const ImportedSymbolRef &Other) const;
  1037. void moveNext();
  1038. Error getSymbolName(StringRef &Result) const;
  1039. Error isOrdinal(bool &Result) const;
  1040. Error getOrdinal(uint16_t &Result) const;
  1041. Error getHintNameRVA(uint32_t &Result) const;
  1042. private:
  1043. const import_lookup_table_entry32 *Entry32;
  1044. const import_lookup_table_entry64 *Entry64;
  1045. uint32_t Index;
  1046. const COFFObjectFile *OwningObject = nullptr;
  1047. };
  1048. class BaseRelocRef {
  1049. public:
  1050. BaseRelocRef() = default;
  1051. BaseRelocRef(const coff_base_reloc_block_header *Header,
  1052. const COFFObjectFile *Owner)
  1053. : Header(Header), Index(0) {}
  1054. bool operator==(const BaseRelocRef &Other) const;
  1055. void moveNext();
  1056. Error getType(uint8_t &Type) const;
  1057. Error getRVA(uint32_t &Result) const;
  1058. private:
  1059. const coff_base_reloc_block_header *Header;
  1060. uint32_t Index;
  1061. };
  1062. class ResourceSectionRef {
  1063. public:
  1064. ResourceSectionRef() = default;
  1065. explicit ResourceSectionRef(StringRef Ref) : BBS(Ref, support::little) {}
  1066. Error load(const COFFObjectFile *O);
  1067. Error load(const COFFObjectFile *O, const SectionRef &S);
  1068. Expected<ArrayRef<UTF16>>
  1069. getEntryNameString(const coff_resource_dir_entry &Entry);
  1070. Expected<const coff_resource_dir_table &>
  1071. getEntrySubDir(const coff_resource_dir_entry &Entry);
  1072. Expected<const coff_resource_data_entry &>
  1073. getEntryData(const coff_resource_dir_entry &Entry);
  1074. Expected<const coff_resource_dir_table &> getBaseTable();
  1075. Expected<const coff_resource_dir_entry &>
  1076. getTableEntry(const coff_resource_dir_table &Table, uint32_t Index);
  1077. Expected<StringRef> getContents(const coff_resource_data_entry &Entry);
  1078. private:
  1079. BinaryByteStream BBS;
  1080. SectionRef Section;
  1081. const COFFObjectFile *Obj;
  1082. std::vector<const coff_relocation *> Relocs;
  1083. Expected<const coff_resource_dir_table &> getTableAtOffset(uint32_t Offset);
  1084. Expected<const coff_resource_dir_entry &>
  1085. getTableEntryAtOffset(uint32_t Offset);
  1086. Expected<const coff_resource_data_entry &>
  1087. getDataEntryAtOffset(uint32_t Offset);
  1088. Expected<ArrayRef<UTF16>> getDirStringAtOffset(uint32_t Offset);
  1089. };
  1090. // Corresponds to `_FPO_DATA` structure in the PE/COFF spec.
  1091. struct FpoData {
  1092. support::ulittle32_t Offset; // ulOffStart: Offset 1st byte of function code
  1093. support::ulittle32_t Size; // cbProcSize: # bytes in function
  1094. support::ulittle32_t NumLocals; // cdwLocals: # bytes in locals/4
  1095. support::ulittle16_t NumParams; // cdwParams: # bytes in params/4
  1096. support::ulittle16_t Attributes;
  1097. // cbProlog: # bytes in prolog
  1098. int getPrologSize() const { return Attributes & 0xF; }
  1099. // cbRegs: # regs saved
  1100. int getNumSavedRegs() const { return (Attributes >> 8) & 0x7; }
  1101. // fHasSEH: true if seh is func
  1102. bool hasSEH() const { return (Attributes >> 9) & 1; }
  1103. // fUseBP: true if EBP has been allocated
  1104. bool useBP() const { return (Attributes >> 10) & 1; }
  1105. // cbFrame: frame pointer
  1106. frame_type getFP() const { return static_cast<frame_type>(Attributes >> 14); }
  1107. };
  1108. class SectionStrippedError
  1109. : public ErrorInfo<SectionStrippedError, BinaryError> {
  1110. public:
  1111. SectionStrippedError() { setErrorCode(object_error::section_stripped); }
  1112. };
  1113. } // end namespace object
  1114. } // end namespace llvm
  1115. #endif // LLVM_OBJECT_COFF_H
  1116. #ifdef __GNUC__
  1117. #pragma GCC diagnostic pop
  1118. #endif