Coverage Report

Created: 2018-11-16 02:38

/Users/buildslave/jenkins/workspace/clang-stage2-coverage-R/llvm/include/llvm/BinaryFormat/COFF.h
Line
Count
Source
1
//===-- llvm/BinaryFormat/COFF.h --------------------------------*- 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
// This file contains an definitions used in Windows COFF Files.
11
//
12
// Structures and enums defined within this file where created using
13
// information from Microsoft's publicly available PE/COFF format document:
14
//
15
// Microsoft Portable Executable and Common Object File Format Specification
16
// Revision 8.1 - February 15, 2008
17
//
18
// As of 5/2/2010, hosted by Microsoft at:
19
// http://www.microsoft.com/whdc/system/platform/firmware/pecoff.mspx
20
//
21
//===----------------------------------------------------------------------===//
22
23
#ifndef LLVM_BINARYFORMAT_COFF_H
24
#define LLVM_BINARYFORMAT_COFF_H
25
26
#include "llvm/Support/DataTypes.h"
27
#include <cassert>
28
#include <cstring>
29
30
namespace llvm {
31
namespace COFF {
32
33
// The maximum number of sections that a COFF object can have (inclusive).
34
const int32_t MaxNumberOfSections16 = 65279;
35
36
// The PE signature bytes that follows the DOS stub header.
37
static const char PEMagic[] = {'P', 'E', '\0', '\0'};
38
39
static const char BigObjMagic[] = {
40
    '\xc7', '\xa1', '\xba', '\xd1', '\xee', '\xba', '\xa9', '\x4b',
41
    '\xaf', '\x20', '\xfa', '\xf6', '\x6a', '\xa4', '\xdc', '\xb8',
42
};
43
44
static const char ClGlObjMagic[] = {
45
    '\x38', '\xfe', '\xb3', '\x0c', '\xa5', '\xd9', '\xab', '\x4d',
46
    '\xac', '\x9b', '\xd6', '\xb6', '\x22', '\x26', '\x53', '\xc2',
47
};
48
49
// The signature bytes that start a .res file.
50
static const char WinResMagic[] = {
51
    '\x00', '\x00', '\x00', '\x00', '\x20', '\x00', '\x00', '\x00',
52
    '\xff', '\xff', '\x00', '\x00', '\xff', '\xff', '\x00', '\x00',
53
};
54
55
// Sizes in bytes of various things in the COFF format.
56
enum {
57
  Header16Size = 20,
58
  Header32Size = 56,
59
  NameSize = 8,
60
  Symbol16Size = 18,
61
  Symbol32Size = 20,
62
  SectionSize = 40,
63
  RelocationSize = 10
64
};
65
66
struct header {
67
  uint16_t Machine;
68
  int32_t NumberOfSections;
69
  uint32_t TimeDateStamp;
70
  uint32_t PointerToSymbolTable;
71
  uint32_t NumberOfSymbols;
72
  uint16_t SizeOfOptionalHeader;
73
  uint16_t Characteristics;
74
};
75
76
struct BigObjHeader {
77
  enum : uint16_t { MinBigObjectVersion = 2 };
78
79
  uint16_t Sig1; ///< Must be IMAGE_FILE_MACHINE_UNKNOWN (0).
80
  uint16_t Sig2; ///< Must be 0xFFFF.
81
  uint16_t Version;
82
  uint16_t Machine;
83
  uint32_t TimeDateStamp;
84
  uint8_t UUID[16];
85
  uint32_t unused1;
86
  uint32_t unused2;
87
  uint32_t unused3;
88
  uint32_t unused4;
89
  uint32_t NumberOfSections;
90
  uint32_t PointerToSymbolTable;
91
  uint32_t NumberOfSymbols;
92
};
93
94
enum MachineTypes : unsigned {
95
  MT_Invalid = 0xffff,
96
97
  IMAGE_FILE_MACHINE_UNKNOWN = 0x0,
98
  IMAGE_FILE_MACHINE_AM33 = 0x1D3,
99
  IMAGE_FILE_MACHINE_AMD64 = 0x8664,
100
  IMAGE_FILE_MACHINE_ARM = 0x1C0,
101
  IMAGE_FILE_MACHINE_ARMNT = 0x1C4,
102
  IMAGE_FILE_MACHINE_ARM64 = 0xAA64,
103
  IMAGE_FILE_MACHINE_EBC = 0xEBC,
104
  IMAGE_FILE_MACHINE_I386 = 0x14C,
105
  IMAGE_FILE_MACHINE_IA64 = 0x200,
106
  IMAGE_FILE_MACHINE_M32R = 0x9041,
107
  IMAGE_FILE_MACHINE_MIPS16 = 0x266,
108
  IMAGE_FILE_MACHINE_MIPSFPU = 0x366,
109
  IMAGE_FILE_MACHINE_MIPSFPU16 = 0x466,
110
  IMAGE_FILE_MACHINE_POWERPC = 0x1F0,
111
  IMAGE_FILE_MACHINE_POWERPCFP = 0x1F1,
112
  IMAGE_FILE_MACHINE_R4000 = 0x166,
113
  IMAGE_FILE_MACHINE_RISCV32 = 0x5032,
114
  IMAGE_FILE_MACHINE_RISCV64 = 0x5064,
115
  IMAGE_FILE_MACHINE_RISCV128 = 0x5128,
116
  IMAGE_FILE_MACHINE_SH3 = 0x1A2,
117
  IMAGE_FILE_MACHINE_SH3DSP = 0x1A3,
118
  IMAGE_FILE_MACHINE_SH4 = 0x1A6,
119
  IMAGE_FILE_MACHINE_SH5 = 0x1A8,
120
  IMAGE_FILE_MACHINE_THUMB = 0x1C2,
121
  IMAGE_FILE_MACHINE_WCEMIPSV2 = 0x169
122
};
123
124
enum Characteristics : unsigned {
125
  C_Invalid = 0,
126
127
  /// The file does not contain base relocations and must be loaded at its
128
  /// preferred base. If this cannot be done, the loader will error.
129
  IMAGE_FILE_RELOCS_STRIPPED = 0x0001,
130
  /// The file is valid and can be run.
131
  IMAGE_FILE_EXECUTABLE_IMAGE = 0x0002,
132
  /// COFF line numbers have been stripped. This is deprecated and should be
133
  /// 0.
134
  IMAGE_FILE_LINE_NUMS_STRIPPED = 0x0004,
135
  /// COFF symbol table entries for local symbols have been removed. This is
136
  /// deprecated and should be 0.
137
  IMAGE_FILE_LOCAL_SYMS_STRIPPED = 0x0008,
138
  /// Aggressively trim working set. This is deprecated and must be 0.
139
  IMAGE_FILE_AGGRESSIVE_WS_TRIM = 0x0010,
140
  /// Image can handle > 2GiB addresses.
141
  IMAGE_FILE_LARGE_ADDRESS_AWARE = 0x0020,
142
  /// Little endian: the LSB precedes the MSB in memory. This is deprecated
143
  /// and should be 0.
144
  IMAGE_FILE_BYTES_REVERSED_LO = 0x0080,
145
  /// Machine is based on a 32bit word architecture.
146
  IMAGE_FILE_32BIT_MACHINE = 0x0100,
147
  /// Debugging info has been removed.
148
  IMAGE_FILE_DEBUG_STRIPPED = 0x0200,
149
  /// If the image is on removable media, fully load it and copy it to swap.
150
  IMAGE_FILE_REMOVABLE_RUN_FROM_SWAP = 0x0400,
151
  /// If the image is on network media, fully load it and copy it to swap.
152
  IMAGE_FILE_NET_RUN_FROM_SWAP = 0x0800,
153
  /// The image file is a system file, not a user program.
154
  IMAGE_FILE_SYSTEM = 0x1000,
155
  /// The image file is a DLL.
156
  IMAGE_FILE_DLL = 0x2000,
157
  /// This file should only be run on a uniprocessor machine.
158
  IMAGE_FILE_UP_SYSTEM_ONLY = 0x4000,
159
  /// Big endian: the MSB precedes the LSB in memory. This is deprecated
160
  /// and should be 0.
161
  IMAGE_FILE_BYTES_REVERSED_HI = 0x8000
162
};
163
164
enum ResourceTypeID : unsigned {
165
  RID_Cursor = 1,
166
  RID_Bitmap = 2,
167
  RID_Icon = 3,
168
  RID_Menu = 4,
169
  RID_Dialog = 5,
170
  RID_String = 6,
171
  RID_FontDir = 7,
172
  RID_Font = 8,
173
  RID_Accelerator = 9,
174
  RID_RCData = 10,
175
  RID_MessageTable = 11,
176
  RID_Group_Cursor = 12,
177
  RID_Group_Icon = 14,
178
  RID_Version = 16,
179
  RID_DLGInclude = 17,
180
  RID_PlugPlay = 19,
181
  RID_VXD = 20,
182
  RID_AniCursor = 21,
183
  RID_AniIcon = 22,
184
  RID_HTML = 23,
185
  RID_Manifest = 24,
186
};
187
188
struct symbol {
189
  char Name[NameSize];
190
  uint32_t Value;
191
  int32_t SectionNumber;
192
  uint16_t Type;
193
  uint8_t StorageClass;
194
  uint8_t NumberOfAuxSymbols;
195
};
196
197
enum SymbolSectionNumber : int32_t {
198
  IMAGE_SYM_DEBUG = -2,
199
  IMAGE_SYM_ABSOLUTE = -1,
200
  IMAGE_SYM_UNDEFINED = 0
201
};
202
203
/// Storage class tells where and what the symbol represents
204
enum SymbolStorageClass {
205
  SSC_Invalid = 0xff,
206
207
  IMAGE_SYM_CLASS_END_OF_FUNCTION = -1,  ///< Physical end of function
208
  IMAGE_SYM_CLASS_NULL = 0,              ///< No symbol
209
  IMAGE_SYM_CLASS_AUTOMATIC = 1,         ///< Stack variable
210
  IMAGE_SYM_CLASS_EXTERNAL = 2,          ///< External symbol
211
  IMAGE_SYM_CLASS_STATIC = 3,            ///< Static
212
  IMAGE_SYM_CLASS_REGISTER = 4,          ///< Register variable
213
  IMAGE_SYM_CLASS_EXTERNAL_DEF = 5,      ///< External definition
214
  IMAGE_SYM_CLASS_LABEL = 6,             ///< Label
215
  IMAGE_SYM_CLASS_UNDEFINED_LABEL = 7,   ///< Undefined label
216
  IMAGE_SYM_CLASS_MEMBER_OF_STRUCT = 8,  ///< Member of structure
217
  IMAGE_SYM_CLASS_ARGUMENT = 9,          ///< Function argument
218
  IMAGE_SYM_CLASS_STRUCT_TAG = 10,       ///< Structure tag
219
  IMAGE_SYM_CLASS_MEMBER_OF_UNION = 11,  ///< Member of union
220
  IMAGE_SYM_CLASS_UNION_TAG = 12,        ///< Union tag
221
  IMAGE_SYM_CLASS_TYPE_DEFINITION = 13,  ///< Type definition
222
  IMAGE_SYM_CLASS_UNDEFINED_STATIC = 14, ///< Undefined static
223
  IMAGE_SYM_CLASS_ENUM_TAG = 15,         ///< Enumeration tag
224
  IMAGE_SYM_CLASS_MEMBER_OF_ENUM = 16,   ///< Member of enumeration
225
  IMAGE_SYM_CLASS_REGISTER_PARAM = 17,   ///< Register parameter
226
  IMAGE_SYM_CLASS_BIT_FIELD = 18,        ///< Bit field
227
  /// ".bb" or ".eb" - beginning or end of block
228
  IMAGE_SYM_CLASS_BLOCK = 100,
229
  /// ".bf" or ".ef" - beginning or end of function
230
  IMAGE_SYM_CLASS_FUNCTION = 101,
231
  IMAGE_SYM_CLASS_END_OF_STRUCT = 102, ///< End of structure
232
  IMAGE_SYM_CLASS_FILE = 103,          ///< File name
233
  /// Line number, reformatted as symbol
234
  IMAGE_SYM_CLASS_SECTION = 104,
235
  IMAGE_SYM_CLASS_WEAK_EXTERNAL = 105, ///< Duplicate tag
236
  /// External symbol in dmert public lib
237
  IMAGE_SYM_CLASS_CLR_TOKEN = 107
238
};
239
240
enum SymbolBaseType : unsigned {
241
  IMAGE_SYM_TYPE_NULL = 0,   ///< No type information or unknown base type.
242
  IMAGE_SYM_TYPE_VOID = 1,   ///< Used with void pointers and functions.
243
  IMAGE_SYM_TYPE_CHAR = 2,   ///< A character (signed byte).
244
  IMAGE_SYM_TYPE_SHORT = 3,  ///< A 2-byte signed integer.
245
  IMAGE_SYM_TYPE_INT = 4,    ///< A natural integer type on the target.
246
  IMAGE_SYM_TYPE_LONG = 5,   ///< A 4-byte signed integer.
247
  IMAGE_SYM_TYPE_FLOAT = 6,  ///< A 4-byte floating-point number.
248
  IMAGE_SYM_TYPE_DOUBLE = 7, ///< An 8-byte floating-point number.
249
  IMAGE_SYM_TYPE_STRUCT = 8, ///< A structure.
250
  IMAGE_SYM_TYPE_UNION = 9,  ///< An union.
251
  IMAGE_SYM_TYPE_ENUM = 10,  ///< An enumerated type.
252
  IMAGE_SYM_TYPE_MOE = 11,   ///< A member of enumeration (a specific value).
253
  IMAGE_SYM_TYPE_BYTE = 12,  ///< A byte; unsigned 1-byte integer.
254
  IMAGE_SYM_TYPE_WORD = 13,  ///< A word; unsigned 2-byte integer.
255
  IMAGE_SYM_TYPE_UINT = 14,  ///< An unsigned integer of natural size.
256
  IMAGE_SYM_TYPE_DWORD = 15  ///< An unsigned 4-byte integer.
257
};
258
259
enum SymbolComplexType : unsigned {
260
  IMAGE_SYM_DTYPE_NULL = 0,     ///< No complex type; simple scalar variable.
261
  IMAGE_SYM_DTYPE_POINTER = 1,  ///< A pointer to base type.
262
  IMAGE_SYM_DTYPE_FUNCTION = 2, ///< A function that returns a base type.
263
  IMAGE_SYM_DTYPE_ARRAY = 3,    ///< An array of base type.
264
265
  /// Type is formed as (base + (derived << SCT_COMPLEX_TYPE_SHIFT))
266
  SCT_COMPLEX_TYPE_SHIFT = 4
267
};
268
269
enum AuxSymbolType { IMAGE_AUX_SYMBOL_TYPE_TOKEN_DEF = 1 };
270
271
struct section {
272
  char Name[NameSize];
273
  uint32_t VirtualSize;
274
  uint32_t VirtualAddress;
275
  uint32_t SizeOfRawData;
276
  uint32_t PointerToRawData;
277
  uint32_t PointerToRelocations;
278
  uint32_t PointerToLineNumbers;
279
  uint16_t NumberOfRelocations;
280
  uint16_t NumberOfLineNumbers;
281
  uint32_t Characteristics;
282
};
283
284
enum SectionCharacteristics : uint32_t {
285
  SC_Invalid = 0xffffffff,
286
287
  IMAGE_SCN_TYPE_NOLOAD = 0x00000002,
288
  IMAGE_SCN_TYPE_NO_PAD = 0x00000008,
289
  IMAGE_SCN_CNT_CODE = 0x00000020,
290
  IMAGE_SCN_CNT_INITIALIZED_DATA = 0x00000040,
291
  IMAGE_SCN_CNT_UNINITIALIZED_DATA = 0x00000080,
292
  IMAGE_SCN_LNK_OTHER = 0x00000100,
293
  IMAGE_SCN_LNK_INFO = 0x00000200,
294
  IMAGE_SCN_LNK_REMOVE = 0x00000800,
295
  IMAGE_SCN_LNK_COMDAT = 0x00001000,
296
  IMAGE_SCN_GPREL = 0x00008000,
297
  IMAGE_SCN_MEM_PURGEABLE = 0x00020000,
298
  IMAGE_SCN_MEM_16BIT = 0x00020000,
299
  IMAGE_SCN_MEM_LOCKED = 0x00040000,
300
  IMAGE_SCN_MEM_PRELOAD = 0x00080000,
301
  IMAGE_SCN_ALIGN_1BYTES = 0x00100000,
302
  IMAGE_SCN_ALIGN_2BYTES = 0x00200000,
303
  IMAGE_SCN_ALIGN_4BYTES = 0x00300000,
304
  IMAGE_SCN_ALIGN_8BYTES = 0x00400000,
305
  IMAGE_SCN_ALIGN_16BYTES = 0x00500000,
306
  IMAGE_SCN_ALIGN_32BYTES = 0x00600000,
307
  IMAGE_SCN_ALIGN_64BYTES = 0x00700000,
308
  IMAGE_SCN_ALIGN_128BYTES = 0x00800000,
309
  IMAGE_SCN_ALIGN_256BYTES = 0x00900000,
310
  IMAGE_SCN_ALIGN_512BYTES = 0x00A00000,
311
  IMAGE_SCN_ALIGN_1024BYTES = 0x00B00000,
312
  IMAGE_SCN_ALIGN_2048BYTES = 0x00C00000,
313
  IMAGE_SCN_ALIGN_4096BYTES = 0x00D00000,
314
  IMAGE_SCN_ALIGN_8192BYTES = 0x00E00000,
315
  IMAGE_SCN_LNK_NRELOC_OVFL = 0x01000000,
316
  IMAGE_SCN_MEM_DISCARDABLE = 0x02000000,
317
  IMAGE_SCN_MEM_NOT_CACHED = 0x04000000,
318
  IMAGE_SCN_MEM_NOT_PAGED = 0x08000000,
319
  IMAGE_SCN_MEM_SHARED = 0x10000000,
320
  IMAGE_SCN_MEM_EXECUTE = 0x20000000,
321
  IMAGE_SCN_MEM_READ = 0x40000000,
322
  IMAGE_SCN_MEM_WRITE = 0x80000000
323
};
324
325
struct relocation {
326
  uint32_t VirtualAddress;
327
  uint32_t SymbolTableIndex;
328
  uint16_t Type;
329
};
330
331
enum RelocationTypeI386 : unsigned {
332
  IMAGE_REL_I386_ABSOLUTE = 0x0000,
333
  IMAGE_REL_I386_DIR16 = 0x0001,
334
  IMAGE_REL_I386_REL16 = 0x0002,
335
  IMAGE_REL_I386_DIR32 = 0x0006,
336
  IMAGE_REL_I386_DIR32NB = 0x0007,
337
  IMAGE_REL_I386_SEG12 = 0x0009,
338
  IMAGE_REL_I386_SECTION = 0x000A,
339
  IMAGE_REL_I386_SECREL = 0x000B,
340
  IMAGE_REL_I386_TOKEN = 0x000C,
341
  IMAGE_REL_I386_SECREL7 = 0x000D,
342
  IMAGE_REL_I386_REL32 = 0x0014
343
};
344
345
enum RelocationTypeAMD64 : unsigned {
346
  IMAGE_REL_AMD64_ABSOLUTE = 0x0000,
347
  IMAGE_REL_AMD64_ADDR64 = 0x0001,
348
  IMAGE_REL_AMD64_ADDR32 = 0x0002,
349
  IMAGE_REL_AMD64_ADDR32NB = 0x0003,
350
  IMAGE_REL_AMD64_REL32 = 0x0004,
351
  IMAGE_REL_AMD64_REL32_1 = 0x0005,
352
  IMAGE_REL_AMD64_REL32_2 = 0x0006,
353
  IMAGE_REL_AMD64_REL32_3 = 0x0007,
354
  IMAGE_REL_AMD64_REL32_4 = 0x0008,
355
  IMAGE_REL_AMD64_REL32_5 = 0x0009,
356
  IMAGE_REL_AMD64_SECTION = 0x000A,
357
  IMAGE_REL_AMD64_SECREL = 0x000B,
358
  IMAGE_REL_AMD64_SECREL7 = 0x000C,
359
  IMAGE_REL_AMD64_TOKEN = 0x000D,
360
  IMAGE_REL_AMD64_SREL32 = 0x000E,
361
  IMAGE_REL_AMD64_PAIR = 0x000F,
362
  IMAGE_REL_AMD64_SSPAN32 = 0x0010
363
};
364
365
enum RelocationTypesARM : unsigned {
366
  IMAGE_REL_ARM_ABSOLUTE = 0x0000,
367
  IMAGE_REL_ARM_ADDR32 = 0x0001,
368
  IMAGE_REL_ARM_ADDR32NB = 0x0002,
369
  IMAGE_REL_ARM_BRANCH24 = 0x0003,
370
  IMAGE_REL_ARM_BRANCH11 = 0x0004,
371
  IMAGE_REL_ARM_TOKEN = 0x0005,
372
  IMAGE_REL_ARM_BLX24 = 0x0008,
373
  IMAGE_REL_ARM_BLX11 = 0x0009,
374
  IMAGE_REL_ARM_SECTION = 0x000E,
375
  IMAGE_REL_ARM_SECREL = 0x000F,
376
  IMAGE_REL_ARM_MOV32A = 0x0010,
377
  IMAGE_REL_ARM_MOV32T = 0x0011,
378
  IMAGE_REL_ARM_BRANCH20T = 0x0012,
379
  IMAGE_REL_ARM_BRANCH24T = 0x0014,
380
  IMAGE_REL_ARM_BLX23T = 0x0015
381
};
382
383
enum RelocationTypesARM64 : unsigned {
384
  IMAGE_REL_ARM64_ABSOLUTE = 0x0000,
385
  IMAGE_REL_ARM64_ADDR32 = 0x0001,
386
  IMAGE_REL_ARM64_ADDR32NB = 0x0002,
387
  IMAGE_REL_ARM64_BRANCH26 = 0x0003,
388
  IMAGE_REL_ARM64_PAGEBASE_REL21 = 0x0004,
389
  IMAGE_REL_ARM64_REL21 = 0x0005,
390
  IMAGE_REL_ARM64_PAGEOFFSET_12A = 0x0006,
391
  IMAGE_REL_ARM64_PAGEOFFSET_12L = 0x0007,
392
  IMAGE_REL_ARM64_SECREL = 0x0008,
393
  IMAGE_REL_ARM64_SECREL_LOW12A = 0x0009,
394
  IMAGE_REL_ARM64_SECREL_HIGH12A = 0x000A,
395
  IMAGE_REL_ARM64_SECREL_LOW12L = 0x000B,
396
  IMAGE_REL_ARM64_TOKEN = 0x000C,
397
  IMAGE_REL_ARM64_SECTION = 0x000D,
398
  IMAGE_REL_ARM64_ADDR64 = 0x000E,
399
  IMAGE_REL_ARM64_BRANCH19 = 0x000F,
400
  IMAGE_REL_ARM64_BRANCH14 = 0x0010,
401
};
402
403
enum COMDATType : unsigned {
404
  IMAGE_COMDAT_SELECT_NODUPLICATES = 1,
405
  IMAGE_COMDAT_SELECT_ANY,
406
  IMAGE_COMDAT_SELECT_SAME_SIZE,
407
  IMAGE_COMDAT_SELECT_EXACT_MATCH,
408
  IMAGE_COMDAT_SELECT_ASSOCIATIVE,
409
  IMAGE_COMDAT_SELECT_LARGEST,
410
  IMAGE_COMDAT_SELECT_NEWEST
411
};
412
413
// Auxiliary Symbol Formats
414
struct AuxiliaryFunctionDefinition {
415
  uint32_t TagIndex;
416
  uint32_t TotalSize;
417
  uint32_t PointerToLinenumber;
418
  uint32_t PointerToNextFunction;
419
  char unused[2];
420
};
421
422
struct AuxiliarybfAndefSymbol {
423
  uint8_t unused1[4];
424
  uint16_t Linenumber;
425
  uint8_t unused2[6];
426
  uint32_t PointerToNextFunction;
427
  uint8_t unused3[2];
428
};
429
430
struct AuxiliaryWeakExternal {
431
  uint32_t TagIndex;
432
  uint32_t Characteristics;
433
  uint8_t unused[10];
434
};
435
436
enum WeakExternalCharacteristics : unsigned {
437
  IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY = 1,
438
  IMAGE_WEAK_EXTERN_SEARCH_LIBRARY = 2,
439
  IMAGE_WEAK_EXTERN_SEARCH_ALIAS = 3
440
};
441
442
struct AuxiliarySectionDefinition {
443
  uint32_t Length;
444
  uint16_t NumberOfRelocations;
445
  uint16_t NumberOfLinenumbers;
446
  uint32_t CheckSum;
447
  uint32_t Number;
448
  uint8_t Selection;
449
  char unused;
450
};
451
452
struct AuxiliaryCLRToken {
453
  uint8_t AuxType;
454
  uint8_t unused1;
455
  uint32_t SymbolTableIndex;
456
  char unused2[12];
457
};
458
459
union Auxiliary {
460
  AuxiliaryFunctionDefinition FunctionDefinition;
461
  AuxiliarybfAndefSymbol bfAndefSymbol;
462
  AuxiliaryWeakExternal WeakExternal;
463
  AuxiliarySectionDefinition SectionDefinition;
464
};
465
466
/// The Import Directory Table.
467
///
468
/// There is a single array of these and one entry per imported DLL.
469
struct ImportDirectoryTableEntry {
470
  uint32_t ImportLookupTableRVA;
471
  uint32_t TimeDateStamp;
472
  uint32_t ForwarderChain;
473
  uint32_t NameRVA;
474
  uint32_t ImportAddressTableRVA;
475
};
476
477
/// The PE32 Import Lookup Table.
478
///
479
/// There is an array of these for each imported DLL. It represents either
480
/// the ordinal to import from the target DLL, or a name to lookup and import
481
/// from the target DLL.
482
///
483
/// This also happens to be the same format used by the Import Address Table
484
/// when it is initially written out to the image.
485
struct ImportLookupTableEntry32 {
486
  uint32_t data;
487
488
  /// Is this entry specified by ordinal, or name?
489
  bool isOrdinal() const { return data & 0x80000000; }
490
491
  /// Get the ordinal value of this entry. isOrdinal must be true.
492
  uint16_t getOrdinal() const {
493
    assert(isOrdinal() && "ILT entry is not an ordinal!");
494
    return data & 0xFFFF;
495
  }
496
497
  /// Set the ordinal value and set isOrdinal to true.
498
  void setOrdinal(uint16_t o) {
499
    data = o;
500
    data |= 0x80000000;
501
  }
502
503
  /// Get the Hint/Name entry RVA. isOrdinal must be false.
504
  uint32_t getHintNameRVA() const {
505
    assert(!isOrdinal() && "ILT entry is not a Hint/Name RVA!");
506
    return data;
507
  }
508
509
  /// Set the Hint/Name entry RVA and set isOrdinal to false.
510
  void setHintNameRVA(uint32_t rva) { data = rva; }
511
};
512
513
/// The DOS compatible header at the front of all PEs.
514
struct DOSHeader {
515
  uint16_t Magic;
516
  uint16_t UsedBytesInTheLastPage;
517
  uint16_t FileSizeInPages;
518
  uint16_t NumberOfRelocationItems;
519
  uint16_t HeaderSizeInParagraphs;
520
  uint16_t MinimumExtraParagraphs;
521
  uint16_t MaximumExtraParagraphs;
522
  uint16_t InitialRelativeSS;
523
  uint16_t InitialSP;
524
  uint16_t Checksum;
525
  uint16_t InitialIP;
526
  uint16_t InitialRelativeCS;
527
  uint16_t AddressOfRelocationTable;
528
  uint16_t OverlayNumber;
529
  uint16_t Reserved[4];
530
  uint16_t OEMid;
531
  uint16_t OEMinfo;
532
  uint16_t Reserved2[10];
533
  uint32_t AddressOfNewExeHeader;
534
};
535
536
struct PE32Header {
537
  enum { PE32 = 0x10b, PE32_PLUS = 0x20b };
538
539
  uint16_t Magic;
540
  uint8_t MajorLinkerVersion;
541
  uint8_t MinorLinkerVersion;
542
  uint32_t SizeOfCode;
543
  uint32_t SizeOfInitializedData;
544
  uint32_t SizeOfUninitializedData;
545
  uint32_t AddressOfEntryPoint; // RVA
546
  uint32_t BaseOfCode;          // RVA
547
  uint32_t BaseOfData;          // RVA
548
  uint32_t ImageBase;
549
  uint32_t SectionAlignment;
550
  uint32_t FileAlignment;
551
  uint16_t MajorOperatingSystemVersion;
552
  uint16_t MinorOperatingSystemVersion;
553
  uint16_t MajorImageVersion;
554
  uint16_t MinorImageVersion;
555
  uint16_t MajorSubsystemVersion;
556
  uint16_t MinorSubsystemVersion;
557
  uint32_t Win32VersionValue;
558
  uint32_t SizeOfImage;
559
  uint32_t SizeOfHeaders;
560
  uint32_t CheckSum;
561
  uint16_t Subsystem;
562
  // FIXME: This should be DllCharacteristics to match the COFF spec.
563
  uint16_t DLLCharacteristics;
564
  uint32_t SizeOfStackReserve;
565
  uint32_t SizeOfStackCommit;
566
  uint32_t SizeOfHeapReserve;
567
  uint32_t SizeOfHeapCommit;
568
  uint32_t LoaderFlags;
569
  // FIXME: This should be NumberOfRvaAndSizes to match the COFF spec.
570
  uint32_t NumberOfRvaAndSize;
571
};
572
573
struct DataDirectory {
574
  uint32_t RelativeVirtualAddress;
575
  uint32_t Size;
576
};
577
578
enum DataDirectoryIndex : unsigned {
579
  EXPORT_TABLE = 0,
580
  IMPORT_TABLE,
581
  RESOURCE_TABLE,
582
  EXCEPTION_TABLE,
583
  CERTIFICATE_TABLE,
584
  BASE_RELOCATION_TABLE,
585
  DEBUG_DIRECTORY,
586
  ARCHITECTURE,
587
  GLOBAL_PTR,
588
  TLS_TABLE,
589
  LOAD_CONFIG_TABLE,
590
  BOUND_IMPORT,
591
  IAT,
592
  DELAY_IMPORT_DESCRIPTOR,
593
  CLR_RUNTIME_HEADER,
594
595
  NUM_DATA_DIRECTORIES
596
};
597
598
enum WindowsSubsystem : unsigned {
599
  IMAGE_SUBSYSTEM_UNKNOWN = 0, ///< An unknown subsystem.
600
  IMAGE_SUBSYSTEM_NATIVE = 1,  ///< Device drivers and native Windows processes
601
  IMAGE_SUBSYSTEM_WINDOWS_GUI = 2,      ///< The Windows GUI subsystem.
602
  IMAGE_SUBSYSTEM_WINDOWS_CUI = 3,      ///< The Windows character subsystem.
603
  IMAGE_SUBSYSTEM_OS2_CUI = 5,          ///< The OS/2 character subsytem.
604
  IMAGE_SUBSYSTEM_POSIX_CUI = 7,        ///< The POSIX character subsystem.
605
  IMAGE_SUBSYSTEM_NATIVE_WINDOWS = 8,   ///< Native Windows 9x driver.
606
  IMAGE_SUBSYSTEM_WINDOWS_CE_GUI = 9,   ///< Windows CE.
607
  IMAGE_SUBSYSTEM_EFI_APPLICATION = 10, ///< An EFI application.
608
  IMAGE_SUBSYSTEM_EFI_BOOT_SERVICE_DRIVER = 11, ///< An EFI driver with boot
609
                                                ///  services.
610
  IMAGE_SUBSYSTEM_EFI_RUNTIME_DRIVER = 12,      ///< An EFI driver with run-time
611
                                                ///  services.
612
  IMAGE_SUBSYSTEM_EFI_ROM = 13,                 ///< An EFI ROM image.
613
  IMAGE_SUBSYSTEM_XBOX = 14,                    ///< XBOX.
614
  IMAGE_SUBSYSTEM_WINDOWS_BOOT_APPLICATION = 16 ///< A BCD application.
615
};
616
617
enum DLLCharacteristics : unsigned {
618
  /// ASLR with 64 bit address space.
619
  IMAGE_DLL_CHARACTERISTICS_HIGH_ENTROPY_VA = 0x0020,
620
  /// DLL can be relocated at load time.
621
  IMAGE_DLL_CHARACTERISTICS_DYNAMIC_BASE = 0x0040,
622
  /// Code integrity checks are enforced.
623
  IMAGE_DLL_CHARACTERISTICS_FORCE_INTEGRITY = 0x0080,
624
  ///< Image is NX compatible.
625
  IMAGE_DLL_CHARACTERISTICS_NX_COMPAT = 0x0100,
626
  /// Isolation aware, but do not isolate the image.
627
  IMAGE_DLL_CHARACTERISTICS_NO_ISOLATION = 0x0200,
628
  /// Does not use structured exception handling (SEH). No SEH handler may be
629
  /// called in this image.
630
  IMAGE_DLL_CHARACTERISTICS_NO_SEH = 0x0400,
631
  /// Do not bind the image.
632
  IMAGE_DLL_CHARACTERISTICS_NO_BIND = 0x0800,
633
  ///< Image should execute in an AppContainer.
634
  IMAGE_DLL_CHARACTERISTICS_APPCONTAINER = 0x1000,
635
  ///< A WDM driver.
636
  IMAGE_DLL_CHARACTERISTICS_WDM_DRIVER = 0x2000,
637
  ///< Image supports Control Flow Guard.
638
  IMAGE_DLL_CHARACTERISTICS_GUARD_CF = 0x4000,
639
  /// Terminal Server aware.
640
  IMAGE_DLL_CHARACTERISTICS_TERMINAL_SERVER_AWARE = 0x8000
641
};
642
643
enum DebugType : unsigned {
644
  IMAGE_DEBUG_TYPE_UNKNOWN = 0,
645
  IMAGE_DEBUG_TYPE_COFF = 1,
646
  IMAGE_DEBUG_TYPE_CODEVIEW = 2,
647
  IMAGE_DEBUG_TYPE_FPO = 3,
648
  IMAGE_DEBUG_TYPE_MISC = 4,
649
  IMAGE_DEBUG_TYPE_EXCEPTION = 5,
650
  IMAGE_DEBUG_TYPE_FIXUP = 6,
651
  IMAGE_DEBUG_TYPE_OMAP_TO_SRC = 7,
652
  IMAGE_DEBUG_TYPE_OMAP_FROM_SRC = 8,
653
  IMAGE_DEBUG_TYPE_BORLAND = 9,
654
  IMAGE_DEBUG_TYPE_RESERVED10 = 10,
655
  IMAGE_DEBUG_TYPE_CLSID = 11,
656
  IMAGE_DEBUG_TYPE_VC_FEATURE = 12,
657
  IMAGE_DEBUG_TYPE_POGO = 13,
658
  IMAGE_DEBUG_TYPE_ILTCG = 14,
659
  IMAGE_DEBUG_TYPE_MPX = 15,
660
  IMAGE_DEBUG_TYPE_REPRO = 16,
661
};
662
663
enum BaseRelocationType : unsigned {
664
  IMAGE_REL_BASED_ABSOLUTE = 0,
665
  IMAGE_REL_BASED_HIGH = 1,
666
  IMAGE_REL_BASED_LOW = 2,
667
  IMAGE_REL_BASED_HIGHLOW = 3,
668
  IMAGE_REL_BASED_HIGHADJ = 4,
669
  IMAGE_REL_BASED_MIPS_JMPADDR = 5,
670
  IMAGE_REL_BASED_ARM_MOV32A = 5,
671
  IMAGE_REL_BASED_ARM_MOV32T = 7,
672
  IMAGE_REL_BASED_MIPS_JMPADDR16 = 9,
673
  IMAGE_REL_BASED_DIR64 = 10
674
};
675
676
enum ImportType : unsigned {
677
  IMPORT_CODE = 0,
678
  IMPORT_DATA = 1,
679
  IMPORT_CONST = 2
680
};
681
682
enum ImportNameType : unsigned {
683
  /// Import is by ordinal. This indicates that the value in the Ordinal/Hint
684
  /// field of the import header is the import's ordinal. If this constant is
685
  /// not specified, then the Ordinal/Hint field should always be interpreted
686
  /// as the import's hint.
687
  IMPORT_ORDINAL = 0,
688
  /// The import name is identical to the public symbol name
689
  IMPORT_NAME = 1,
690
  /// The import name is the public symbol name, but skipping the leading ?,
691
  /// @, or optionally _.
692
  IMPORT_NAME_NOPREFIX = 2,
693
  /// The import name is the public symbol name, but skipping the leading ?,
694
  /// @, or optionally _, and truncating at the first @.
695
  IMPORT_NAME_UNDECORATE = 3
696
};
697
698
struct ImportHeader {
699
  uint16_t Sig1; ///< Must be IMAGE_FILE_MACHINE_UNKNOWN (0).
700
  uint16_t Sig2; ///< Must be 0xFFFF.
701
  uint16_t Version;
702
  uint16_t Machine;
703
  uint32_t TimeDateStamp;
704
  uint32_t SizeOfData;
705
  uint16_t OrdinalHint;
706
  uint16_t TypeInfo;
707
708
  ImportType getType() const { return static_cast<ImportType>(TypeInfo & 0x3); }
709
710
  ImportNameType getNameType() const {
711
    return static_cast<ImportNameType>((TypeInfo & 0x1C) >> 2);
712
  }
713
};
714
715
enum CodeViewIdentifiers {
716
  DEBUG_SECTION_MAGIC = 0x4,
717
  DEBUG_HASHES_SECTION_MAGIC = 0x133C9C5
718
};
719
720
14.5k
inline bool isReservedSectionNumber(int32_t SectionNumber) {
721
14.5k
  return SectionNumber <= 0;
722
14.5k
}
723
724
} // End namespace COFF.
725
} // End namespace llvm.
726
727
#endif