include/llvm/Bitcode/LLVMBitCodes.h

   1 //===- LLVMBitCodes.h - Enum values for the LLVM bitcode format -*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Chris Lattner and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This header defines Bitcode enum values for LLVM IR bitcode files.
  11 //
  12 // The enum values defined in this file should be considered permanent.  If
  13 // new features are added, they should have values added at the end of the
  14 // respective lists.
  15 //
  16 //===----------------------------------------------------------------------===//
  17
  18 #ifndef LLVM_BITCODE_LLVMBITCODES_H
  19 #define LLVM_BITCODE_LLVMBITCODES_H
  20
  21 #include "llvm/Bitcode/BitCodes.h"
  22
  23 namespace llvm {
  24 namespace bitc {
  25   // The only top-level block type defined is for a module.
  26   enum BlockIDs {
  27     // Blocks
  28     MODULE_BLOCK_ID          = FIRST_APPLICATION_BLOCKID,
  29
  30     // Module sub-block id's.
  31     PARAMATTR_BLOCK_ID,
  32     TYPE_BLOCK_ID,
  33     CONSTANTS_BLOCK_ID,
  34     FUNCTION_BLOCK_ID,
  35     TYPE_SYMTAB_BLOCK_ID,
  36     VALUE_SYMTAB_BLOCK_ID
  37   };
  38
  39
  40   /// MODULE blocks have a number of optional fields and subblocks.
  41   enum ModuleCodes {
  42     MODULE_CODE_VERSION     = 1,    // VERSION:     [version#]
  43     MODULE_CODE_TRIPLE      = 2,    // TRIPLE:      [strchr x N]
  44     MODULE_CODE_DATALAYOUT  = 3,    // DATALAYOUT:  [strchr x N]
  45     MODULE_CODE_ASM         = 4,    // ASM:         [strchr x N]
  46     MODULE_CODE_SECTIONNAME = 5,    // SECTIONNAME: [strchr x N]
  47     MODULE_CODE_DEPLIB      = 6,    // DEPLIB:      [strchr x N]
  48
  49     // GLOBALVAR: [pointer type, isconst, initid,
  50     //             linkage, alignment, section, visibility, threadlocal]
  51     MODULE_CODE_GLOBALVAR   = 7,
  52
  53     // FUNCTION:  [type, callingconv, isproto, linkage, paramattrs, alignment,
  54     //             section, visibility]
  55     MODULE_CODE_FUNCTION    = 8,
  56
  57     // ALIAS: [alias type, aliasee val#, linkage]
  58     MODULE_CODE_ALIAS       = 9,
  59
  60     /// MODULE_CODE_PURGEVALS: [numvals]
  61     MODULE_CODE_PURGEVALS   = 10,
  62
  63     MODULE_CODE_COLLECTORNAME = 11   // COLLECTORNAME: [strchr x N]
  64   };
  65
  66   /// PARAMATTR blocks have code for defining a parameter attribute set.
  67   enum ParamAttrCodes {
  68     PARAMATTR_CODE_ENTRY = 1   // ENTRY: [paramidx0, attr0, paramidx1, attr1...]
  69   };
  70
  71   /// TYPE blocks have codes for each type primitive they use.
  72   enum TypeCodes {
  73     TYPE_CODE_NUMENTRY =  1,   // NUMENTRY: [numentries]
  74
  75     // Type Codes
  76     TYPE_CODE_VOID     =  2,   // VOID
  77     TYPE_CODE_FLOAT    =  3,   // FLOAT
  78     TYPE_CODE_DOUBLE   =  4,   // DOUBLE
  79     TYPE_CODE_LABEL    =  5,   // LABEL
  80     TYPE_CODE_OPAQUE   =  6,   // OPAQUE
  81     TYPE_CODE_INTEGER  =  7,   // INTEGER: [width]
  82     TYPE_CODE_POINTER  =  8,   // POINTER: [pointee type]
  83     TYPE_CODE_FUNCTION =  9,   // FUNCTION: [vararg, retty, paramty x N]
  84     TYPE_CODE_STRUCT   = 10,   // STRUCT: [ispacked, eltty x N]
  85     TYPE_CODE_ARRAY    = 11,   // ARRAY: [numelts, eltty]
  86     TYPE_CODE_VECTOR   = 12,   // VECTOR: [numelts, eltty]
  87
  88     // These are not with the other floating point types because they're
  89     // a late addition, and putting them in the right place breaks
  90     // binary compatibility.
  91     TYPE_CODE_X86_FP80 = 13,   // X86 LONG DOUBLE
  92     TYPE_CODE_FP128    = 14,   // LONG DOUBLE (112 bit mantissa)
  93     TYPE_CODE_PPC_FP128= 15    // PPC LONG DOUBLE (2 doubles)
  94     // Any other type code is assumed to be an unknown type.
  95   };
  96
  97   // The type symbol table only has one code (TST_ENTRY_CODE).
  98   enum TypeSymtabCodes {
  99     TST_CODE_ENTRY = 1     // TST_ENTRY: [typeid, namechar x N]
 100   };
 101
 102   // The value symbol table only has one code (VST_ENTRY_CODE).
 103   enum ValueSymtabCodes {
 104     VST_CODE_ENTRY   = 1,  // VST_ENTRY: [valid, namechar x N]
 105     VST_CODE_BBENTRY = 2   // VST_BBENTRY: [bbid, namechar x N]
 106   };
 107
 108   // The constants block (CONSTANTS_BLOCK_ID) describes emission for each
 109   // constant and maintains an implicit current type value.
 110   enum ConstantsCodes {
 111     CST_CODE_SETTYPE       =  1,  // SETTYPE:       [typeid]
 112     CST_CODE_NULL          =  2,  // NULL
 113     CST_CODE_UNDEF         =  3,  // UNDEF
 114     CST_CODE_INTEGER       =  4,  // INTEGER:       [intval]
 115     CST_CODE_WIDE_INTEGER  =  5,  // WIDE_INTEGER:  [n x intval]
 116     CST_CODE_FLOAT         =  6,  // FLOAT:         [fpval]
 117     CST_CODE_AGGREGATE     =  7,  // AGGREGATE:     [n x value number]
 118     CST_CODE_STRING        =  8,  // STRING:        [values]
 119     CST_CODE_CSTRING       =  9,  // CSTRING:       [values]
 120     CST_CODE_CE_BINOP      = 10,  // CE_BINOP:      [opcode, opval, opval]
 121     CST_CODE_CE_CAST       = 11,  // CE_CAST:       [opcode, opty, opval]
 122     CST_CODE_CE_GEP        = 12,  // CE_GEP:        [n x operands]
 123     CST_CODE_CE_SELECT     = 13,  // CE_SELECT:     [opval, opval, opval]
 124     CST_CODE_CE_EXTRACTELT = 14,  // CE_EXTRACTELT: [opty, opval, opval]
 125     CST_CODE_CE_INSERTELT  = 15,  // CE_INSERTELT:  [opval, opval, opval]
 126     CST_CODE_CE_SHUFFLEVEC = 16,  // CE_SHUFFLEVEC: [opval, opval, opval]
 127     CST_CODE_CE_CMP        = 17,  // CE_CMP:        [opty, opval, opval, pred]
 128     CST_CODE_INLINEASM     = 18   // INLINEASM:     [sideeffect,asmstr,conststr]
 129   };
 130
 131   /// CastOpcodes - These are values used in the bitcode files to encode which
 132   /// cast a CST_CODE_CE_CAST or a XXX refers to.  The values of these enums
 133   /// have no fixed relation to the LLVM IR enum values.  Changing these will
 134   /// break compatibility with old files.
 135   enum CastOpcodes {
 136     CAST_TRUNC    =  0,
 137     CAST_ZEXT     =  1,
 138     CAST_SEXT     =  2,
 139     CAST_FPTOUI   =  3,
 140     CAST_FPTOSI   =  4,
 141     CAST_UITOFP   =  5,
 142     CAST_SITOFP   =  6,
 143     CAST_FPTRUNC  =  7,
 144     CAST_FPEXT    =  8,
 145     CAST_PTRTOINT =  9,
 146     CAST_INTTOPTR = 10,
 147     CAST_BITCAST  = 11
 148   };
 149
 150   /// BinaryOpcodes - These are values used in the bitcode files to encode which
 151   /// binop a CST_CODE_CE_BINOP or a XXX refers to.  The values of these enums
 152   /// have no fixed relation to the LLVM IR enum values.  Changing these will
 153   /// break compatibility with old files.
 154   enum BinaryOpcodes {
 155     BINOP_ADD  =  0,
 156     BINOP_SUB  =  1,
 157     BINOP_MUL  =  2,
 158     BINOP_UDIV =  3,
 159     BINOP_SDIV =  4,    // overloaded for FP
 160     BINOP_UREM =  5,
 161     BINOP_SREM =  6,    // overloaded for FP
 162     BINOP_SHL  =  7,
 163     BINOP_LSHR =  8,
 164     BINOP_ASHR =  9,
 165     BINOP_AND  = 10,
 166     BINOP_OR   = 11,
 167     BINOP_XOR  = 12
 168   };
 169
 170
 171   // The function body block (FUNCTION_BLOCK_ID) describes function bodies.  It
 172   // can contain a constant block (CONSTANTS_BLOCK_ID).
 173   enum FunctionCodes {
 174     FUNC_CODE_DECLAREBLOCKS    =  1, // DECLAREBLOCKS: [n]
 175
 176     FUNC_CODE_INST_BINOP       =  2, // BINOP:      [opcode, ty, opval, opval]
 177     FUNC_CODE_INST_CAST        =  3, // CAST:       [opcode, ty, opty, opval]
 178     FUNC_CODE_INST_GEP         =  4, // GEP:        [n x operands]
 179     FUNC_CODE_INST_SELECT      =  5, // SELECT:     [ty, opval, opval, opval]
 180     FUNC_CODE_INST_EXTRACTELT  =  6, // EXTRACTELT: [opty, opval, opval]
 181     FUNC_CODE_INST_INSERTELT   =  7, // INSERTELT:  [ty, opval, opval, opval]
 182     FUNC_CODE_INST_SHUFFLEVEC  =  8, // SHUFFLEVEC: [ty, opval, opval, opval]
 183     FUNC_CODE_INST_CMP         =  9, // CMP:        [opty, opval, opval, pred]
 184
 185     FUNC_CODE_INST_RET         = 10, // RET:        [opty,opval<both optional>]
 186     FUNC_CODE_INST_BR          = 11, // BR:         [bb#, bb#, cond] or [bb#]
 187     FUNC_CODE_INST_SWITCH      = 12, // SWITCH:     [opty, opval, n, n x ops]
 188     FUNC_CODE_INST_INVOKE      = 13, // INVOKE:     [attr, fnty, op0,op1, ...]
 189     FUNC_CODE_INST_UNWIND      = 14, // UNWIND
 190     FUNC_CODE_INST_UNREACHABLE = 15, // UNREACHABLE
 191
 192     FUNC_CODE_INST_PHI         = 16, // PHI:        [ty, val0,bb0, ...]
 193     FUNC_CODE_INST_MALLOC      = 17, // MALLOC:     [instty, op, align]
 194     FUNC_CODE_INST_FREE        = 18, // FREE:       [opty, op]
 195     FUNC_CODE_INST_ALLOCA      = 19, // ALLOCA:     [instty, op, align]
 196     FUNC_CODE_INST_LOAD        = 20, // LOAD:       [opty, op, align, vol]
 197     // FIXME: Remove STORE in favor of STORE2 in LLVM 3.0
 198     FUNC_CODE_INST_STORE       = 21, // STORE:      [valty,val,ptr, align, vol]
 199     FUNC_CODE_INST_CALL        = 22, // CALL:       [attr, fnty, fnid, args...]
 200     FUNC_CODE_INST_VAARG       = 23, // VAARG:      [valistty, valist, instty]
 201     // This store code encodes the pointer type, rather than the value type
 202     // this is so information only available in the pointer type (e.g. address
 203     // spaces) is retained.
 204     FUNC_CODE_INST_STORE2      = 24 // STORE:      [ptrty,ptr,val, align, vol]
 205   };
 206 } // End bitc namespace
 207 } // End llvm namespace
 208
 209 #endif