include/llvm/Support/COFF.h

   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 Microsofts 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
  29 namespace llvm {
  30 namespace 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 symbol_flags {
  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   enum symbol_storage_class {
  71     IMAGE_SYM_CLASS_END_OF_FUNCTION  = -1,
  72     IMAGE_SYM_CLASS_NULL             = 0,
  73     IMAGE_SYM_CLASS_AUTOMATIC        = 1,
  74     IMAGE_SYM_CLASS_EXTERNAL         = 2,
  75     IMAGE_SYM_CLASS_STATIC           = 3,
  76     IMAGE_SYM_CLASS_REGISTER         = 4,
  77     IMAGE_SYM_CLASS_EXTERNAL_DEF     = 5,
  78     IMAGE_SYM_CLASS_LABEL            = 6,
  79     IMAGE_SYM_CLASS_UNDEFINED_LABEL  = 7,
  80     IMAGE_SYM_CLASS_MEMBER_OF_STRUCT = 8,
  81     IMAGE_SYM_CLASS_ARGUMENT         = 9,
  82     IMAGE_SYM_CLASS_STRUCT_TAG       = 10,
  83     IMAGE_SYM_CLASS_MEMBER_OF_UNION  = 11,
  84     IMAGE_SYM_CLASS_UNION_TAG        = 12,
  85     IMAGE_SYM_CLASS_TYPE_DEFINITION  = 13,
  86     IMAGE_SYM_CLASS_UNDEFINED_STATIC = 14,
  87     IMAGE_SYM_CLASS_ENUM_TAG         = 15,
  88     IMAGE_SYM_CLASS_MEMBER_OF_ENUM   = 16,
  89     IMAGE_SYM_CLASS_REGISTER_PARAM   = 17,
  90     IMAGE_SYM_CLASS_BIT_FIELD        = 18,
  91     IMAGE_SYM_CLASS_BLOCK            = 100,
  92     IMAGE_SYM_CLASS_FUNCTION         = 101,
  93     IMAGE_SYM_CLASS_END_OF_STRUCT    = 102,
  94     IMAGE_SYM_CLASS_FILE             = 103,
  95     IMAGE_SYM_CLASS_SECTION          = 104,
  96     IMAGE_SYM_CLASS_WEAK_EXTERNAL    = 105,
  97     IMAGE_SYM_CLASS_CLR_TOKEN        = 107
  98   };
  99
 100   struct section {
 101     char     Name[NameSize];
 102     uint32_t VirtualSize;
 103     uint32_t VirtualAddress;
 104     uint32_t SizeOfRawData;
 105     uint32_t PointerToRawData;
 106     uint32_t PointerToRelocations;
 107     uint32_t PointerToLineNumbers;
 108     uint16_t NumberOfRelocations;
 109     uint16_t NumberOfLineNumbers;
 110     uint32_t Characteristics;
 111   };
 112
 113   enum section_characteristics {
 114     IMAGE_SCN_TYPE_NO_PAD            = 0x00000008,
 115     IMAGE_SCN_CNT_CODE               = 0x00000020,
 116     IMAGE_SCN_CNT_INITIALIZED_DATA   = 0x00000040,
 117     IMAGE_SCN_CNT_UNINITIALIZED_DATA = 0x00000080,
 118     IMAGE_SCN_LNK_OTHER              = 0x00000100,
 119     IMAGE_SCN_LNK_INFO               = 0x00000200,
 120     IMAGE_SCN_LNK_REMOVE             = 0x00000800,
 121     IMAGE_SCN_LNK_COMDAT             = 0x00001000,
 122     IMAGE_SCN_GPREL                  = 0x00008000,
 123     IMAGE_SCN_MEM_PURGEABLE          = 0x00020000,
 124     IMAGE_SCN_MEM_16BIT              = 0x00020000,
 125     IMAGE_SCN_MEM_LOCKED             = 0x00040000,
 126     IMAGE_SCN_MEM_PRELOAD            = 0x00080000,
 127     IMAGE_SCN_ALIGN_1BYTES           = 0x00100000,
 128     IMAGE_SCN_ALIGN_2BYTES           = 0x00200000,
 129     IMAGE_SCN_ALIGN_4BYTES           = 0x00300000,
 130     IMAGE_SCN_ALIGN_8BYTES           = 0x00400000,
 131     IMAGE_SCN_ALIGN_16BYTES          = 0x00500000,
 132     IMAGE_SCN_ALIGN_32BYTES          = 0x00600000,
 133     IMAGE_SCN_ALIGN_64BYTES          = 0x00700000,
 134     IMAGE_SCN_ALIGN_128BYTES         = 0x00800000,
 135     IMAGE_SCN_ALIGN_256BYTES         = 0x00900000,
 136     IMAGE_SCN_ALIGN_512BYTES         = 0x00A00000,
 137     IMAGE_SCN_ALIGN_1024BYTES        = 0x00B00000,
 138     IMAGE_SCN_ALIGN_2048BYTES        = 0x00C00000,
 139     IMAGE_SCN_ALIGN_4096BYTES        = 0x00D00000,
 140     IMAGE_SCN_ALIGN_8192BYTES        = 0x00E00000,
 141     IMAGE_SCN_LNK_NRELOC_OVFL        = 0x01000000,
 142     IMAGE_SCN_MEM_DISCARDABLE        = 0x02000000,
 143     IMAGE_SCN_MEM_NOT_CACHED         = 0x04000000,
 144     IMAGE_SCN_MEM_NOT_PAGED          = 0x08000000,
 145     IMAGE_SCN_MEM_SHARED             = 0x10000000,
 146     IMAGE_SCN_MEM_EXECUTE            = 0x20000000,
 147     IMAGE_SCN_MEM_READ               = 0x40000000,
 148     IMAGE_SCN_MEM_WRITE              = 0x80000000
 149   };
 150
 151   struct relocation {
 152     uint32_t VirtualAddress;
 153     uint32_t SymbolTableIndex;
 154     uint16_t Type;
 155   };
 156
 157   enum relocation_type_x86 {
 158     IMAGE_REL_I386_ABSOLUTE = 0x0000,
 159     IMAGE_REL_I386_DIR16    = 0x0001,
 160     IMAGE_REL_I386_REL16    = 0x0002,
 161     IMAGE_REL_I386_DIR32    = 0x0006,
 162     IMAGE_REL_I386_DIR32NB  = 0x0007,
 163     IMAGE_REL_I386_SEG12    = 0x0009,
 164     IMAGE_REL_I386_SECTION  = 0x000A,
 165     IMAGE_REL_I386_SECREL   = 0x000B,
 166     IMAGE_REL_I386_TOKEN    = 0x000C,
 167     IMAGE_REL_I386_SECREL7  = 0x000D,
 168     IMAGE_REL_I386_REL32    = 0x0014
 169   };
 170
 171   enum {
 172     IMAGE_COMDAT_SELECT_NODUPLICATES = 1,
 173     IMAGE_COMDAT_SELECT_ANY,
 174     IMAGE_COMDAT_SELECT_SAME_SIZE,
 175     IMAGE_COMDAT_SELECT_EXACT_MATCH,
 176     IMAGE_COMDAT_SELECT_ASSOCIATIVE,
 177     IMAGE_COMDAT_SELECT_LARGEST
 178   };
 179
 180 } // End namespace llvm.
 181 } // End namespace COFF.
 182
 183 #endif