COFF.h revision 210299 
1//===-- llvm/Support/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_SUPPORT_WIN_COFF_H
24#define LLVM_SUPPORT_WIN_COFF_H
25
26#include "llvm/System/DataTypes.h"
27#include <cstring>
28
29namespace llvm {
30namespace COFF {
31
32  // Sizes in bytes of various things in the COFF format.
33  enum {
34    HeaderSize     = 20,
35    NameSize       = 8,
36    SymbolSize     = 18,
37    SectionSize    = 40,
38    RelocationSize = 10
39  };
40
41  struct header {
42    uint16_t Machine;
43    uint16_t NumberOfSections;
44    uint32_t TimeDateStamp;
45    uint32_t PointerToSymbolTable;
46    uint32_t NumberOfSymbols;
47    uint16_t SizeOfOptionalHeader;
48    uint16_t Characteristics;
49  };
50
51  struct symbol {
52    char     Name[NameSize];
53    uint32_t Value;
54    uint16_t Type;
55    uint8_t  StorageClass;
56    uint16_t SectionNumber;
57    uint8_t  NumberOfAuxSymbols;
58  };
59
60  enum SymbolFlags {
61    SF_TypeMask = 0x0000FFFF,
62    SF_TypeShift = 0,
63
64    SF_ClassMask = 0x00FF0000,
65    SF_ClassShift = 16,
66
67    SF_WeakReference = 0x01000000
68  };
69
70  /// Storage class tells where and what the symbol represents
71  enum SymbolStorageClass {
72    IMAGE_SYM_CLASS_END_OF_FUNCTION  = -1,  ///< Physical end of function
73    IMAGE_SYM_CLASS_NULL             = 0,   ///< No symbol
74    IMAGE_SYM_CLASS_AUTOMATIC        = 1,   ///< Stack variable
75    IMAGE_SYM_CLASS_EXTERNAL         = 2,   ///< External symbol
76    IMAGE_SYM_CLASS_STATIC           = 3,   ///< Static
77    IMAGE_SYM_CLASS_REGISTER         = 4,   ///< Register variable
78    IMAGE_SYM_CLASS_EXTERNAL_DEF     = 5,   ///< External definition
79    IMAGE_SYM_CLASS_LABEL            = 6,   ///< Label
80    IMAGE_SYM_CLASS_UNDEFINED_LABEL  = 7,   ///< Undefined label
81    IMAGE_SYM_CLASS_MEMBER_OF_STRUCT = 8,   ///< Member of structure
82    IMAGE_SYM_CLASS_ARGUMENT         = 9,   ///< Function argument
83    IMAGE_SYM_CLASS_STRUCT_TAG       = 10,  ///< Structure tag
84    IMAGE_SYM_CLASS_MEMBER_OF_UNION  = 11,  ///< Member of union
85    IMAGE_SYM_CLASS_UNION_TAG        = 12,  ///< Union tag
86    IMAGE_SYM_CLASS_TYPE_DEFINITION  = 13,  ///< Type definition
87    IMAGE_SYM_CLASS_UNDEFINED_STATIC = 14,  ///< Undefined static
88    IMAGE_SYM_CLASS_ENUM_TAG         = 15,  ///< Enumeration tag
89    IMAGE_SYM_CLASS_MEMBER_OF_ENUM   = 16,  ///< Member of enumeration
90    IMAGE_SYM_CLASS_REGISTER_PARAM   = 17,  ///< Register parameter
91    IMAGE_SYM_CLASS_BIT_FIELD        = 18,  ///< Bit field
92    /// ".bb" or ".eb" - beginning or end of block
93    IMAGE_SYM_CLASS_BLOCK            = 100,
94    /// ".bf" or ".ef" - beginning or end of function
95    IMAGE_SYM_CLASS_FUNCTION         = 101,
96    IMAGE_SYM_CLASS_END_OF_STRUCT    = 102, ///< End of structure
97    IMAGE_SYM_CLASS_FILE             = 103, ///< File name
98    /// Line number, reformatted as symbol
99    IMAGE_SYM_CLASS_SECTION          = 104,
100    IMAGE_SYM_CLASS_WEAK_EXTERNAL    = 105, ///< Duplicate tag
101    /// External symbol in dmert public lib
102    IMAGE_SYM_CLASS_CLR_TOKEN        = 107
103  };
104
105  enum SymbolBaseType {
106    IMAGE_SYM_TYPE_NULL   = 0,  ///< No type information or unknown base type.
107    IMAGE_SYM_TYPE_VOID   = 1,  ///< Used with void pointers and functions.
108    IMAGE_SYM_TYPE_CHAR   = 2,  ///< A character (signed byte).
109    IMAGE_SYM_TYPE_SHORT  = 3,  ///< A 2-byte signed integer.
110    IMAGE_SYM_TYPE_INT    = 4,  ///< A natural integer type on the target.
111    IMAGE_SYM_TYPE_LONG   = 5,  ///< A 4-byte signed integer.
112    IMAGE_SYM_TYPE_FLOAT  = 6,  ///< A 4-byte floating-point number.
113    IMAGE_SYM_TYPE_DOUBLE = 7,  ///< An 8-byte floating-point number.
114    IMAGE_SYM_TYPE_STRUCT = 8,  ///< A structure.
115    IMAGE_SYM_TYPE_UNION  = 9,  ///< An union.
116    IMAGE_SYM_TYPE_ENUM   = 10, ///< An enumerated type.
117    IMAGE_SYM_TYPE_MOE    = 11, ///< A member of enumeration (a specific value).
118    IMAGE_SYM_TYPE_BYTE   = 12, ///< A byte; unsigned 1-byte integer.
119    IMAGE_SYM_TYPE_WORD   = 13, ///< A word; unsigned 2-byte integer.
120    IMAGE_SYM_TYPE_UINT   = 14, ///< An unsigned integer of natural size.
121    IMAGE_SYM_TYPE_DWORD  = 15  ///< An unsigned 4-byte integer.
122  };
123
124  enum SymbolComplexType {
125    IMAGE_SYM_DTYPE_NULL     = 0, ///< No complex type; simple scalar variable.
126    IMAGE_SYM_DTYPE_POINTER  = 1, ///< A pointer to base type.
127    IMAGE_SYM_DTYPE_FUNCTION = 2, ///< A function that returns a base type.
128    IMAGE_SYM_DTYPE_ARRAY    = 3, ///< An array of base type.
129
130    /// Type is formed as (base + (derived << SCT_COMPLEX_TYPE_SHIFT))
131    SCT_COMPLEX_TYPE_SHIFT   = 4
132  };
133
134  struct section {
135    char     Name[NameSize];
136    uint32_t VirtualSize;
137    uint32_t VirtualAddress;
138    uint32_t SizeOfRawData;
139    uint32_t PointerToRawData;
140    uint32_t PointerToRelocations;
141    uint32_t PointerToLineNumbers;
142    uint16_t NumberOfRelocations;
143    uint16_t NumberOfLineNumbers;
144    uint32_t Characteristics;
145  };
146
147  enum SectionCharacteristics {
148    IMAGE_SCN_TYPE_NO_PAD            = 0x00000008,
149    IMAGE_SCN_CNT_CODE               = 0x00000020,
150    IMAGE_SCN_CNT_INITIALIZED_DATA   = 0x00000040,
151    IMAGE_SCN_CNT_UNINITIALIZED_DATA = 0x00000080,
152    IMAGE_SCN_LNK_OTHER              = 0x00000100,
153    IMAGE_SCN_LNK_INFO               = 0x00000200,
154    IMAGE_SCN_LNK_REMOVE             = 0x00000800,
155    IMAGE_SCN_LNK_COMDAT             = 0x00001000,
156    IMAGE_SCN_GPREL                  = 0x00008000,
157    IMAGE_SCN_MEM_PURGEABLE          = 0x00020000,
158    IMAGE_SCN_MEM_16BIT              = 0x00020000,
159    IMAGE_SCN_MEM_LOCKED             = 0x00040000,
160    IMAGE_SCN_MEM_PRELOAD            = 0x00080000,
161    IMAGE_SCN_ALIGN_1BYTES           = 0x00100000,
162    IMAGE_SCN_ALIGN_2BYTES           = 0x00200000,
163    IMAGE_SCN_ALIGN_4BYTES           = 0x00300000,
164    IMAGE_SCN_ALIGN_8BYTES           = 0x00400000,
165    IMAGE_SCN_ALIGN_16BYTES          = 0x00500000,
166    IMAGE_SCN_ALIGN_32BYTES          = 0x00600000,
167    IMAGE_SCN_ALIGN_64BYTES          = 0x00700000,
168    IMAGE_SCN_ALIGN_128BYTES         = 0x00800000,
169    IMAGE_SCN_ALIGN_256BYTES         = 0x00900000,
170    IMAGE_SCN_ALIGN_512BYTES         = 0x00A00000,
171    IMAGE_SCN_ALIGN_1024BYTES        = 0x00B00000,
172    IMAGE_SCN_ALIGN_2048BYTES        = 0x00C00000,
173    IMAGE_SCN_ALIGN_4096BYTES        = 0x00D00000,
174    IMAGE_SCN_ALIGN_8192BYTES        = 0x00E00000,
175    IMAGE_SCN_LNK_NRELOC_OVFL        = 0x01000000,
176    IMAGE_SCN_MEM_DISCARDABLE        = 0x02000000,
177    IMAGE_SCN_MEM_NOT_CACHED         = 0x04000000,
178    IMAGE_SCN_MEM_NOT_PAGED          = 0x08000000,
179    IMAGE_SCN_MEM_SHARED             = 0x10000000,
180    IMAGE_SCN_MEM_EXECUTE            = 0x20000000,
181    IMAGE_SCN_MEM_READ               = 0x40000000,
182    IMAGE_SCN_MEM_WRITE              = 0x80000000
183  };
184
185  struct relocation {
186    uint32_t VirtualAddress;
187    uint32_t SymbolTableIndex;
188    uint16_t Type;
189  };
190
191  enum RelocationTypeX86 {
192    IMAGE_REL_I386_ABSOLUTE = 0x0000,
193    IMAGE_REL_I386_DIR16    = 0x0001,
194    IMAGE_REL_I386_REL16    = 0x0002,
195    IMAGE_REL_I386_DIR32    = 0x0006,
196    IMAGE_REL_I386_DIR32NB  = 0x0007,
197    IMAGE_REL_I386_SEG12    = 0x0009,
198    IMAGE_REL_I386_SECTION  = 0x000A,
199    IMAGE_REL_I386_SECREL   = 0x000B,
200    IMAGE_REL_I386_TOKEN    = 0x000C,
201    IMAGE_REL_I386_SECREL7  = 0x000D,
202    IMAGE_REL_I386_REL32    = 0x0014
203  };
204
205  enum {
206    IMAGE_COMDAT_SELECT_NODUPLICATES = 1,
207    IMAGE_COMDAT_SELECT_ANY,
208    IMAGE_COMDAT_SELECT_SAME_SIZE,
209    IMAGE_COMDAT_SELECT_EXACT_MATCH,
210    IMAGE_COMDAT_SELECT_ASSOCIATIVE,
211    IMAGE_COMDAT_SELECT_LARGEST
212  };
213
214} // End namespace llvm.
215} // End namespace COFF.
216
217#endif
218