1 //===-- llvm/Support/COFF.h -------------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains an definitions used in Windows COFF Files.
12 // Structures and enums defined within this file where created using
13 // information from Microsoft's publicly available PE/COFF format document:
15 // Microsoft Portable Executable and Common Object File Format Specification
16 // Revision 8.1 - February 15, 2008
18 // As of 5/2/2010, hosted by Microsoft at:
19 // http://www.microsoft.com/whdc/system/platform/firmware/pecoff.mspx
21 //===----------------------------------------------------------------------===//
23 #ifndef LLVM_SUPPORT_WIN_COFF_H
24 #define LLVM_SUPPORT_WIN_COFF_H
26 #include "llvm/System/DataTypes.h"
32 // Sizes in bytes of various things in the COFF format.
43 uint16_t NumberOfSections;
44 uint32_t TimeDateStamp;
45 uint32_t PointerToSymbolTable;
46 uint32_t NumberOfSymbols;
47 uint16_t SizeOfOptionalHeader;
48 uint16_t Characteristics;
52 IMAGE_FILE_MACHINE_I386 = 0x14C,
53 IMAGINE_FILE_MACHINE_AMD64 = 0x8664
61 uint16_t SectionNumber;
62 uint8_t NumberOfAuxSymbols;
66 SF_TypeMask = 0x0000FFFF,
69 SF_ClassMask = 0x00FF0000,
72 SF_WeakReference = 0x01000000
75 /// Storage class tells where and what the symbol represents
76 enum SymbolStorageClass {
77 IMAGE_SYM_CLASS_END_OF_FUNCTION = -1, ///< Physical end of function
78 IMAGE_SYM_CLASS_NULL = 0, ///< No symbol
79 IMAGE_SYM_CLASS_AUTOMATIC = 1, ///< Stack variable
80 IMAGE_SYM_CLASS_EXTERNAL = 2, ///< External symbol
81 IMAGE_SYM_CLASS_STATIC = 3, ///< Static
82 IMAGE_SYM_CLASS_REGISTER = 4, ///< Register variable
83 IMAGE_SYM_CLASS_EXTERNAL_DEF = 5, ///< External definition
84 IMAGE_SYM_CLASS_LABEL = 6, ///< Label
85 IMAGE_SYM_CLASS_UNDEFINED_LABEL = 7, ///< Undefined label
86 IMAGE_SYM_CLASS_MEMBER_OF_STRUCT = 8, ///< Member of structure
87 IMAGE_SYM_CLASS_ARGUMENT = 9, ///< Function argument
88 IMAGE_SYM_CLASS_STRUCT_TAG = 10, ///< Structure tag
89 IMAGE_SYM_CLASS_MEMBER_OF_UNION = 11, ///< Member of union
90 IMAGE_SYM_CLASS_UNION_TAG = 12, ///< Union tag
91 IMAGE_SYM_CLASS_TYPE_DEFINITION = 13, ///< Type definition
92 IMAGE_SYM_CLASS_UNDEFINED_STATIC = 14, ///< Undefined static
93 IMAGE_SYM_CLASS_ENUM_TAG = 15, ///< Enumeration tag
94 IMAGE_SYM_CLASS_MEMBER_OF_ENUM = 16, ///< Member of enumeration
95 IMAGE_SYM_CLASS_REGISTER_PARAM = 17, ///< Register parameter
96 IMAGE_SYM_CLASS_BIT_FIELD = 18, ///< Bit field
97 /// ".bb" or ".eb" - beginning or end of block
98 IMAGE_SYM_CLASS_BLOCK = 100,
99 /// ".bf" or ".ef" - beginning or end of function
100 IMAGE_SYM_CLASS_FUNCTION = 101,
101 IMAGE_SYM_CLASS_END_OF_STRUCT = 102, ///< End of structure
102 IMAGE_SYM_CLASS_FILE = 103, ///< File name
103 /// Line number, reformatted as symbol
104 IMAGE_SYM_CLASS_SECTION = 104,
105 IMAGE_SYM_CLASS_WEAK_EXTERNAL = 105, ///< Duplicate tag
106 /// External symbol in dmert public lib
107 IMAGE_SYM_CLASS_CLR_TOKEN = 107
110 enum SymbolBaseType {
111 IMAGE_SYM_TYPE_NULL = 0, ///< No type information or unknown base type.
112 IMAGE_SYM_TYPE_VOID = 1, ///< Used with void pointers and functions.
113 IMAGE_SYM_TYPE_CHAR = 2, ///< A character (signed byte).
114 IMAGE_SYM_TYPE_SHORT = 3, ///< A 2-byte signed integer.
115 IMAGE_SYM_TYPE_INT = 4, ///< A natural integer type on the target.
116 IMAGE_SYM_TYPE_LONG = 5, ///< A 4-byte signed integer.
117 IMAGE_SYM_TYPE_FLOAT = 6, ///< A 4-byte floating-point number.
118 IMAGE_SYM_TYPE_DOUBLE = 7, ///< An 8-byte floating-point number.
119 IMAGE_SYM_TYPE_STRUCT = 8, ///< A structure.
120 IMAGE_SYM_TYPE_UNION = 9, ///< An union.
121 IMAGE_SYM_TYPE_ENUM = 10, ///< An enumerated type.
122 IMAGE_SYM_TYPE_MOE = 11, ///< A member of enumeration (a specific value).
123 IMAGE_SYM_TYPE_BYTE = 12, ///< A byte; unsigned 1-byte integer.
124 IMAGE_SYM_TYPE_WORD = 13, ///< A word; unsigned 2-byte integer.
125 IMAGE_SYM_TYPE_UINT = 14, ///< An unsigned integer of natural size.
126 IMAGE_SYM_TYPE_DWORD = 15 ///< An unsigned 4-byte integer.
129 enum SymbolComplexType {
130 IMAGE_SYM_DTYPE_NULL = 0, ///< No complex type; simple scalar variable.
131 IMAGE_SYM_DTYPE_POINTER = 1, ///< A pointer to base type.
132 IMAGE_SYM_DTYPE_FUNCTION = 2, ///< A function that returns a base type.
133 IMAGE_SYM_DTYPE_ARRAY = 3, ///< An array of base type.
135 /// Type is formed as (base + (derived << SCT_COMPLEX_TYPE_SHIFT))
136 SCT_COMPLEX_TYPE_SHIFT = 4
141 uint32_t VirtualSize;
142 uint32_t VirtualAddress;
143 uint32_t SizeOfRawData;
144 uint32_t PointerToRawData;
145 uint32_t PointerToRelocations;
146 uint32_t PointerToLineNumbers;
147 uint16_t NumberOfRelocations;
148 uint16_t NumberOfLineNumbers;
149 uint32_t Characteristics;
152 enum SectionCharacteristics {
153 IMAGE_SCN_TYPE_NO_PAD = 0x00000008,
154 IMAGE_SCN_CNT_CODE = 0x00000020,
155 IMAGE_SCN_CNT_INITIALIZED_DATA = 0x00000040,
156 IMAGE_SCN_CNT_UNINITIALIZED_DATA = 0x00000080,
157 IMAGE_SCN_LNK_OTHER = 0x00000100,
158 IMAGE_SCN_LNK_INFO = 0x00000200,
159 IMAGE_SCN_LNK_REMOVE = 0x00000800,
160 IMAGE_SCN_LNK_COMDAT = 0x00001000,
161 IMAGE_SCN_GPREL = 0x00008000,
162 IMAGE_SCN_MEM_PURGEABLE = 0x00020000,
163 IMAGE_SCN_MEM_16BIT = 0x00020000,
164 IMAGE_SCN_MEM_LOCKED = 0x00040000,
165 IMAGE_SCN_MEM_PRELOAD = 0x00080000,
166 IMAGE_SCN_ALIGN_1BYTES = 0x00100000,
167 IMAGE_SCN_ALIGN_2BYTES = 0x00200000,
168 IMAGE_SCN_ALIGN_4BYTES = 0x00300000,
169 IMAGE_SCN_ALIGN_8BYTES = 0x00400000,
170 IMAGE_SCN_ALIGN_16BYTES = 0x00500000,
171 IMAGE_SCN_ALIGN_32BYTES = 0x00600000,
172 IMAGE_SCN_ALIGN_64BYTES = 0x00700000,
173 IMAGE_SCN_ALIGN_128BYTES = 0x00800000,
174 IMAGE_SCN_ALIGN_256BYTES = 0x00900000,
175 IMAGE_SCN_ALIGN_512BYTES = 0x00A00000,
176 IMAGE_SCN_ALIGN_1024BYTES = 0x00B00000,
177 IMAGE_SCN_ALIGN_2048BYTES = 0x00C00000,
178 IMAGE_SCN_ALIGN_4096BYTES = 0x00D00000,
179 IMAGE_SCN_ALIGN_8192BYTES = 0x00E00000,
180 IMAGE_SCN_LNK_NRELOC_OVFL = 0x01000000,
181 IMAGE_SCN_MEM_DISCARDABLE = 0x02000000,
182 IMAGE_SCN_MEM_NOT_CACHED = 0x04000000,
183 IMAGE_SCN_MEM_NOT_PAGED = 0x08000000,
184 IMAGE_SCN_MEM_SHARED = 0x10000000,
185 IMAGE_SCN_MEM_EXECUTE = 0x20000000,
186 IMAGE_SCN_MEM_READ = 0x40000000,
187 IMAGE_SCN_MEM_WRITE = 0x80000000
191 uint32_t VirtualAddress;
192 uint32_t SymbolTableIndex;
196 enum RelocationTypeX86 {
197 IMAGE_REL_I386_ABSOLUTE = 0x0000,
198 IMAGE_REL_I386_DIR16 = 0x0001,
199 IMAGE_REL_I386_REL16 = 0x0002,
200 IMAGE_REL_I386_DIR32 = 0x0006,
201 IMAGE_REL_I386_DIR32NB = 0x0007,
202 IMAGE_REL_I386_SEG12 = 0x0009,
203 IMAGE_REL_I386_SECTION = 0x000A,
204 IMAGE_REL_I386_SECREL = 0x000B,
205 IMAGE_REL_I386_TOKEN = 0x000C,
206 IMAGE_REL_I386_SECREL7 = 0x000D,
207 IMAGE_REL_I386_REL32 = 0x0014,
209 IMAGE_REL_AMD64_ABSOLUTE = 0x0000,
210 IMAGE_REL_AMD64_ADDR64 = 0x0001,
211 IMAGE_REL_AMD64_ADDR32 = 0x0002,
212 IMAGE_REL_AMD64_ADDR32NB = 0x0003,
213 IMAGE_REL_AMD64_REL32 = 0x0004,
214 IMAGE_REL_AMD64_REL32_1 = 0x0005,
215 IMAGE_REL_AMD64_REL32_2 = 0x0006,
216 IMAGE_REL_AMD64_REL32_3 = 0x0007,
217 IMAGE_REL_AMD64_REL32_4 = 0x0008,
218 IMAGE_REL_AMD64_REL32_5 = 0x0009,
219 IMAGE_REL_AMD64_SECTION = 0x000A,
220 IMAGE_REL_AMD64_SECREL = 0x000B,
221 IMAGE_REL_AMD64_SECREL7 = 0x000C,
222 IMAGE_REL_AMD64_TOKEN = 0x000D,
223 IMAGE_REL_AMD64_SREL32 = 0x000E,
224 IMAGE_REL_AMD64_PAIR = 0x000F,
225 IMAGE_REL_AMD64_SSPAN32 = 0x0010
229 IMAGE_COMDAT_SELECT_NODUPLICATES = 1,
230 IMAGE_COMDAT_SELECT_ANY,
231 IMAGE_COMDAT_SELECT_SAME_SIZE,
232 IMAGE_COMDAT_SELECT_EXACT_MATCH,
233 IMAGE_COMDAT_SELECT_ASSOCIATIVE,
234 IMAGE_COMDAT_SELECT_LARGEST
237 // Auxiliary Symbol Formats
238 struct AuxiliaryFunctionDefinition {
241 uint32_t PointerToLinenumber;
242 uint32_t PointerToNextFunction;
246 struct AuxiliarybfAndefSymbol {
250 uint32_t PointerToNextFunction;
254 struct AuxiliaryWeakExternal {
256 uint32_t Characteristics;
260 /// These are not documented in the spec, but are located in WinNT.h.
261 enum WeakExternalCharacteristics {
262 IMAGE_WEAK_EXTERN_SEARCH_NOLIBRARY = 1,
263 IMAGE_WEAK_EXTERN_SEARCH_LIBRARY = 2,
264 IMAGE_WEAK_EXTERN_SEARCH_ALIAS = 3
267 struct AuxiliaryFile {
268 uint8_t FileName[18];
271 struct AuxiliarySectionDefinition {
273 uint16_t NumberOfRelocations;
274 uint16_t NumberOfLinenumbers;
282 AuxiliaryFunctionDefinition FunctionDefinition;
283 AuxiliarybfAndefSymbol bfAndefSymbol;
284 AuxiliaryWeakExternal WeakExternal;
286 AuxiliarySectionDefinition SectionDefinition;
289 } // End namespace llvm.
290 } // End namespace COFF.