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 is distributed under the University of Illinois Open Source
   6 // 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     METADATA_BLOCK_ID,
  38     METADATA_ATTACHMENT_ID
  39   };
  40
  41
  42   /// MODULE blocks have a number of optional fields and subblocks.
  43   enum ModuleCodes {
  44     MODULE_CODE_VERSION     = 1,    // VERSION:     [version#]
  45     MODULE_CODE_TRIPLE      = 2,    // TRIPLE:      [strchr x N]
  46     MODULE_CODE_DATALAYOUT  = 3,    // DATALAYOUT:  [strchr x N]
  47     MODULE_CODE_ASM         = 4,    // ASM:         [strchr x N]
  48     MODULE_CODE_SECTIONNAME = 5,    // SECTIONNAME: [strchr x N]
  49     MODULE_CODE_DEPLIB      = 6,    // DEPLIB:      [strchr x N]
  50
  51     // GLOBALVAR: [pointer type, isconst, initid,
  52     //             linkage, alignment, section, visibility, threadlocal]
  53     MODULE_CODE_GLOBALVAR   = 7,
  54
  55     // FUNCTION:  [type, callingconv, isproto, linkage, paramattrs, alignment,
  56     //             section, visibility]
  57     MODULE_CODE_FUNCTION    = 8,
  58
  59     // ALIAS: [alias type, aliasee val#, linkage]
  60     MODULE_CODE_ALIAS       = 9,
  61
  62     /// MODULE_CODE_PURGEVALS: [numvals]
  63     MODULE_CODE_PURGEVALS   = 10,
  64
  65     MODULE_CODE_GCNAME      = 11   // GCNAME: [strchr x N]
  66   };
  67
  68   /// PARAMATTR blocks have code for defining a parameter attribute set.
  69   enum AttributeCodes {
  70     PARAMATTR_CODE_ENTRY = 1   // ENTRY: [paramidx0, attr0, paramidx1, attr1...]
  71   };
  72
  73   /// TYPE blocks have codes for each type primitive they use.
  74   enum TypeCodes {
  75     TYPE_CODE_NUMENTRY =  1,   // NUMENTRY: [numentries]
  76
  77     // Type Codes
  78     TYPE_CODE_VOID     =  2,   // VOID
  79     TYPE_CODE_FLOAT    =  3,   // FLOAT
  80     TYPE_CODE_DOUBLE   =  4,   // DOUBLE
  81     TYPE_CODE_LABEL    =  5,   // LABEL
  82     TYPE_CODE_OPAQUE   =  6,   // OPAQUE
  83     TYPE_CODE_INTEGER  =  7,   // INTEGER: [width]
  84     TYPE_CODE_POINTER  =  8,   // POINTER: [pointee type]
  85     TYPE_CODE_FUNCTION =  9,   // FUNCTION: [vararg, retty, paramty x N]
  86     TYPE_CODE_STRUCT   = 10,   // STRUCT: [ispacked, eltty x N]
  87     TYPE_CODE_ARRAY    = 11,   // ARRAY: [numelts, eltty]
  88     TYPE_CODE_VECTOR   = 12,   // VECTOR: [numelts, eltty]
  89
  90     // These are not with the other floating point types because they're
  91     // a late addition, and putting them in the right place breaks
  92     // binary compatibility.
  93     TYPE_CODE_X86_FP80 = 13,   // X86 LONG DOUBLE
  94     TYPE_CODE_FP128    = 14,   // LONG DOUBLE (112 bit mantissa)
  95     TYPE_CODE_PPC_FP128= 15,   // PPC LONG DOUBLE (2 doubles)
  96
  97     TYPE_CODE_METADATA = 16,   // METADATA
  98     TYPE_CODE_UNION    = 17    // UNION: [eltty x N]
  99   };
 100
 101   // The type symbol table only has one code (TST_ENTRY_CODE).
 102   enum TypeSymtabCodes {
 103     TST_CODE_ENTRY = 1     // TST_ENTRY: [typeid, namechar x N]
 104   };
 105
 106   // The value symbol table only has one code (VST_ENTRY_CODE).
 107   enum ValueSymtabCodes {
 108     VST_CODE_ENTRY   = 1,  // VST_ENTRY: [valid, namechar x N]
 109     VST_CODE_BBENTRY = 2   // VST_BBENTRY: [bbid, namechar x N]
 110   };
 111
 112   enum MetadataCodes {
 113     METADATA_STRING        = 1,   // MDSTRING:      [values]
 114     METADATA_NODE          = 2,   // MDNODE:        [n x (type num, value num)]
 115     METADATA_FN_NODE       = 3,   // FN_MDNODE:     [n x (type num, value num)]
 116     METADATA_NAME          = 4,   // STRING:        [values]
 117     METADATA_NAMED_NODE    = 5,   // NAMEDMDNODE:   [n x mdnodes]
 118     METADATA_KIND          = 6,   // [n x [id, name]]
 119     METADATA_ATTACHMENT    = 7    // [m x [value, [n x [id, mdnode]]]
 120   };
 121   // The constants block (CONSTANTS_BLOCK_ID) describes emission for each
 122   // constant and maintains an implicit current type value.
 123   enum ConstantsCodes {
 124     CST_CODE_SETTYPE       =  1,  // SETTYPE:       [typeid]
 125     CST_CODE_NULL          =  2,  // NULL
 126     CST_CODE_UNDEF         =  3,  // UNDEF
 127     CST_CODE_INTEGER       =  4,  // INTEGER:       [intval]
 128     CST_CODE_WIDE_INTEGER  =  5,  // WIDE_INTEGER:  [n x intval]
 129     CST_CODE_FLOAT         =  6,  // FLOAT:         [fpval]
 130     CST_CODE_AGGREGATE     =  7,  // AGGREGATE:     [n x value number]
 131     CST_CODE_STRING        =  8,  // STRING:        [values]
 132     CST_CODE_CSTRING       =  9,  // CSTRING:       [values]
 133     CST_CODE_CE_BINOP      = 10,  // CE_BINOP:      [opcode, opval, opval]
 134     CST_CODE_CE_CAST       = 11,  // CE_CAST:       [opcode, opty, opval]
 135     CST_CODE_CE_GEP        = 12,  // CE_GEP:        [n x operands]
 136     CST_CODE_CE_SELECT     = 13,  // CE_SELECT:     [opval, opval, opval]
 137     CST_CODE_CE_EXTRACTELT = 14,  // CE_EXTRACTELT: [opty, opval, opval]
 138     CST_CODE_CE_INSERTELT  = 15,  // CE_INSERTELT:  [opval, opval, opval]
 139     CST_CODE_CE_SHUFFLEVEC = 16,  // CE_SHUFFLEVEC: [opval, opval, opval]
 140     CST_CODE_CE_CMP        = 17,  // CE_CMP:        [opty, opval, opval, pred]
 141     CST_CODE_INLINEASM     = 18,  // INLINEASM:     [sideeffect,asmstr,conststr]
 142     CST_CODE_CE_SHUFVEC_EX = 19,  // SHUFVEC_EX:    [opty, opval, opval, opval]
 143     CST_CODE_CE_INBOUNDS_GEP = 20,// INBOUNDS_GEP:  [n x operands]
 144     CST_CODE_BLOCKADDRESS  = 21   // CST_CODE_BLOCKADDRESS [fnty, fnval, bb#]
 145   };
 146
 147   /// CastOpcodes - These are values used in the bitcode files to encode which
 148   /// cast a CST_CODE_CE_CAST or a XXX refers to.  The values of these enums
 149   /// have no fixed relation to the LLVM IR enum values.  Changing these will
 150   /// break compatibility with old files.
 151   enum CastOpcodes {
 152     CAST_TRUNC    =  0,
 153     CAST_ZEXT     =  1,
 154     CAST_SEXT     =  2,
 155     CAST_FPTOUI   =  3,
 156     CAST_FPTOSI   =  4,
 157     CAST_UITOFP   =  5,
 158     CAST_SITOFP   =  6,
 159     CAST_FPTRUNC  =  7,
 160     CAST_FPEXT    =  8,
 161     CAST_PTRTOINT =  9,
 162     CAST_INTTOPTR = 10,
 163     CAST_BITCAST  = 11
 164   };
 165
 166   /// BinaryOpcodes - These are values used in the bitcode files to encode which
 167   /// binop a CST_CODE_CE_BINOP or a XXX refers to.  The values of these enums
 168   /// have no fixed relation to the LLVM IR enum values.  Changing these will
 169   /// break compatibility with old files.
 170   enum BinaryOpcodes {
 171     BINOP_ADD  =  0,
 172     BINOP_SUB  =  1,
 173     BINOP_MUL  =  2,
 174     BINOP_UDIV =  3,
 175     BINOP_SDIV =  4,    // overloaded for FP
 176     BINOP_UREM =  5,
 177     BINOP_SREM =  6,    // overloaded for FP
 178     BINOP_SHL  =  7,
 179     BINOP_LSHR =  8,
 180     BINOP_ASHR =  9,
 181     BINOP_AND  = 10,
 182     BINOP_OR   = 11,
 183     BINOP_XOR  = 12
 184   };
 185
 186   /// OverflowingBinaryOperatorOptionalFlags - Flags for serializing
 187   /// OverflowingBinaryOperator's SubclassOptionalData contents.
 188   enum OverflowingBinaryOperatorOptionalFlags {
 189     OBO_NO_UNSIGNED_WRAP = 0,
 190     OBO_NO_SIGNED_WRAP = 1
 191   };
 192
 193   /// SDivOperatorOptionalFlags - Flags for serializing SDivOperator's
 194   /// SubclassOptionalData contents.
 195   enum SDivOperatorOptionalFlags {
 196     SDIV_EXACT = 0
 197   };
 198
 199   // The function body block (FUNCTION_BLOCK_ID) describes function bodies.  It
 200   // can contain a constant block (CONSTANTS_BLOCK_ID).
 201   enum FunctionCodes {
 202     FUNC_CODE_DECLAREBLOCKS    =  1, // DECLAREBLOCKS: [n]
 203
 204     FUNC_CODE_INST_BINOP       =  2, // BINOP:      [opcode, ty, opval, opval]
 205     FUNC_CODE_INST_CAST        =  3, // CAST:       [opcode, ty, opty, opval]
 206     FUNC_CODE_INST_GEP         =  4, // GEP:        [n x operands]
 207     FUNC_CODE_INST_SELECT      =  5, // SELECT:     [ty, opval, opval, opval]
 208     FUNC_CODE_INST_EXTRACTELT  =  6, // EXTRACTELT: [opty, opval, opval]
 209     FUNC_CODE_INST_INSERTELT   =  7, // INSERTELT:  [ty, opval, opval, opval]
 210     FUNC_CODE_INST_SHUFFLEVEC  =  8, // SHUFFLEVEC: [ty, opval, opval, opval]
 211     FUNC_CODE_INST_CMP         =  9, // CMP:        [opty, opval, opval, pred]
 212
 213     FUNC_CODE_INST_RET         = 10, // RET:        [opty,opval<both optional>]
 214     FUNC_CODE_INST_BR          = 11, // BR:         [bb#, bb#, cond] or [bb#]
 215     FUNC_CODE_INST_SWITCH      = 12, // SWITCH:     [opty, op0, op1, ...]
 216     FUNC_CODE_INST_INVOKE      = 13, // INVOKE:     [attr, fnty, op0,op1, ...]
 217     FUNC_CODE_INST_UNWIND      = 14, // UNWIND
 218     FUNC_CODE_INST_UNREACHABLE = 15, // UNREACHABLE
 219
 220     FUNC_CODE_INST_PHI         = 16, // PHI:        [ty, val0,bb0, ...]
 221     FUNC_CODE_INST_MALLOC      = 17, // MALLOC:     [instty, op, align]
 222     FUNC_CODE_INST_FREE        = 18, // FREE:       [opty, op]
 223     FUNC_CODE_INST_ALLOCA      = 19, // ALLOCA:     [instty, op, align]
 224     FUNC_CODE_INST_LOAD        = 20, // LOAD:       [opty, op, align, vol]
 225     // FIXME: Remove STORE in favor of STORE2 in LLVM 3.0
 226     FUNC_CODE_INST_STORE       = 21, // STORE:      [valty,val,ptr, align, vol]
 227     FUNC_CODE_INST_CALL        = 22, // CALL:       [attr, fnty, fnid, args...]
 228     FUNC_CODE_INST_VAARG       = 23, // VAARG:      [valistty, valist, instty]
 229     // This store code encodes the pointer type, rather than the value type
 230     // this is so information only available in the pointer type (e.g. address
 231     // spaces) is retained.
 232     FUNC_CODE_INST_STORE2      = 24, // STORE:      [ptrty,ptr,val, align, vol]
 233     // FIXME: Remove GETRESULT in favor of EXTRACTVAL in LLVM 3.0
 234     FUNC_CODE_INST_GETRESULT   = 25, // GETRESULT:  [ty, opval, n]
 235     FUNC_CODE_INST_EXTRACTVAL  = 26, // EXTRACTVAL: [n x operands]
 236     FUNC_CODE_INST_INSERTVAL   = 27, // INSERTVAL:  [n x operands]
 237     // fcmp/icmp returning Int1TY or vector of Int1Ty. Same as CMP, exists to
 238     // support legacy vicmp/vfcmp instructions.
 239     FUNC_CODE_INST_CMP2        = 28, // CMP2:       [opty, opval, opval, pred]
 240     // new select on i1 or [N x i1]
 241     FUNC_CODE_INST_VSELECT     = 29, // VSELECT:    [ty,opval,opval,predty,pred]
 242     FUNC_CODE_INST_INBOUNDS_GEP= 30, // INBOUNDS_GEP: [n x operands]
 243     FUNC_CODE_INST_INDIRECTBR  = 31, // INDIRECTBR: [opty, op0, op1, ...]
 244
 245     FUNC_CODE_DEBUG_LOC        = 32, // DEBUG_LOC: [Line,Col,ScopeVal, IAVal]
 246     FUNC_CODE_DEBUG_LOC_AGAIN  = 33  // DEBUG_LOC_AGAIN
 247   };
 248 } // End bitc namespace
 249 } // End llvm namespace
 250
 251 #endif