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: [type, isconst, initid,
  50     //             linkage, alignment, section, visibility, threadlocal]
  51     MODULE_CODE_GLOBALVAR   = 7,
  52
  53     // FUNCTION:  [type, callingconv, isproto, linkage, alignment, section,
  54     //             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
  64   /// PARAMATTR blocks have code for defining a parameter attribute set.
  65   enum ParamAttrCodes {
  66     PARAMATTR_CODE_ENTRY = 1   // ENTRY: [paramidx0, attr0, paramidx1, attr1...]
  67   };
  68
  69   /// TYPE blocks have codes for each type primitive they use.
  70   enum TypeCodes {
  71     TYPE_CODE_NUMENTRY =  1,   // NUMENTRY: [numentries]
  72
  73     // Type Codes
  74     TYPE_CODE_VOID     =  2,   // VOID
  75     TYPE_CODE_FLOAT    =  3,   // FLOAT
  76     TYPE_CODE_DOUBLE   =  4,   // DOUBLE
  77     TYPE_CODE_LABEL    =  5,   // LABEL
  78     TYPE_CODE_OPAQUE   =  6,   // OPAQUE
  79     TYPE_CODE_INTEGER  =  7,   // INTEGER: [width]
  80     TYPE_CODE_POINTER  =  8,   // POINTER: [pointee type]
  81     TYPE_CODE_FUNCTION =  9,   // FUNCTION: [vararg, retty, paramty x N]
  82     TYPE_CODE_STRUCT   = 10,   // STRUCT: [ispacked, eltty x N]
  83     TYPE_CODE_ARRAY    = 11,   // ARRAY: [numelts, eltty]
  84     TYPE_CODE_VECTOR   = 12    // VECTOR: [numelts, eltty]
  85     // Any other type code is assumed to be an unknown type.
  86   };
  87
  88   // The type symbol table only has one code (TST_ENTRY_CODE).
  89   enum TypeSymtabCodes {
  90     TST_CODE_ENTRY = 1     // TST_ENTRY: [typeid, namechar x N]
  91   };
  92
  93   // The value symbol table only has one code (VST_ENTRY_CODE).
  94   enum ValueSymtabCodes {
  95     VST_CODE_ENTRY   = 1,  // VST_ENTRY: [valid, namechar x N]
  96     VST_CODE_BBENTRY = 2   // VST_BBENTRY: [bbid, namechar x N]
  97   };
  98
  99   // The constants block (CONSTANTS_BLOCK_ID) describes emission for each
 100   // constant and maintains an implicit current type value.
 101   enum ConstantsCodes {
 102     CST_CODE_SETTYPE       =  1,  // SETTYPE:       [typeid]
 103     CST_CODE_NULL          =  2,  // NULL
 104     CST_CODE_UNDEF         =  3,  // UNDEF
 105     CST_CODE_INTEGER       =  4,  // INTEGER:       [intval]
 106     CST_CODE_WIDE_INTEGER  =  5,  // WIDE_INTEGER:  [n x intval]
 107     CST_CODE_FLOAT         =  6,  // FLOAT:         [fpval]
 108     CST_CODE_AGGREGATE     =  7,  // AGGREGATE:     [n x value number]
 109     CST_CODE_STRING        =  8,  // STRING:        [values]
 110     CST_CODE_CE_BINOP      =  9,  // CE_BINOP:      [opcode, opval, opval]
 111     CST_CODE_CE_CAST       = 10,  // CE_CAST:       [opcode, opty, opval]
 112     CST_CODE_CE_GEP        = 11,  // CE_GEP:        [n x operands]
 113     CST_CODE_CE_SELECT     = 12,  // CE_SELECT:     [opval, opval, opval]
 114     CST_CODE_CE_EXTRACTELT = 13,  // CE_EXTRACTELT: [opty, opval, opval]
 115     CST_CODE_CE_INSERTELT  = 14,  // CE_INSERTELT:  [opval, opval, opval]
 116     CST_CODE_CE_SHUFFLEVEC = 15,  // CE_SHUFFLEVEC: [opval, opval, opval]
 117     CST_CODE_CE_CMP        = 16   // CE_CMP:        [opty, opval, opval, pred]
 118   };
 119
 120   /// CastOpcodes - These are values used in the bitcode files to encode which
 121   /// cast a CST_CODE_CE_CAST or a XXX refers to.  The values of these enums
 122   /// have no fixed relation to the LLVM IR enum values.  Changing these will
 123   /// break compatibility with old files.
 124   enum CastOpcodes {
 125     CAST_TRUNC    =  0,
 126     CAST_ZEXT     =  1,
 127     CAST_SEXT     =  2,
 128     CAST_FPTOUI   =  3,
 129     CAST_FPTOSI   =  4,
 130     CAST_UITOFP   =  5,
 131     CAST_SITOFP   =  6,
 132     CAST_FPTRUNC  =  7,
 133     CAST_FPEXT    =  8,
 134     CAST_PTRTOINT =  9,
 135     CAST_INTTOPTR = 10,
 136     CAST_BITCAST  = 11
 137   };
 138
 139   /// BinaryOpcodes - These are values used in the bitcode files to encode which
 140   /// binop a CST_CODE_CE_BINOP or a XXX refers to.  The values of these enums
 141   /// have no fixed relation to the LLVM IR enum values.  Changing these will
 142   /// break compatibility with old files.
 143   enum BinaryOpcodes {
 144     BINOP_ADD  =  0,
 145     BINOP_SUB  =  1,
 146     BINOP_MUL  =  2,
 147     BINOP_UDIV =  3,
 148     BINOP_SDIV =  4,    // overloaded for FP
 149     BINOP_UREM =  5,
 150     BINOP_SREM =  6,    // overloaded for FP
 151     BINOP_SHL  =  7,
 152     BINOP_LSHR =  8,
 153     BINOP_ASHR =  9,
 154     BINOP_AND  = 10,
 155     BINOP_OR   = 11,
 156     BINOP_XOR  = 12
 157   };
 158
 159
 160   // The function body block (FUNCTION_BLOCK_ID) describes function bodies.  It
 161   // can contain a constant block (CONSTANTS_BLOCK_ID).
 162   enum FunctionCodes {
 163     FUNC_CODE_DECLAREBLOCKS    =  1, // DECLAREBLOCKS: [n]
 164
 165     FUNC_CODE_INST_BINOP       =  2, // BINOP:      [opcode, ty, opval, opval]
 166     FUNC_CODE_INST_CAST        =  3, // CAST:       [opcode, ty, opty, opval]
 167     FUNC_CODE_INST_GEP         =  4, // GEP:        [n x operands]
 168     FUNC_CODE_INST_SELECT      =  5, // SELECT:     [ty, opval, opval, opval]
 169     FUNC_CODE_INST_EXTRACTELT  =  6, // EXTRACTELT: [opty, opval, opval]
 170     FUNC_CODE_INST_INSERTELT   =  7, // INSERTELT:  [ty, opval, opval, opval]
 171     FUNC_CODE_INST_SHUFFLEVEC  =  8, // SHUFFLEVEC: [ty, opval, opval, opval]
 172     FUNC_CODE_INST_CMP         =  9, // CMP:        [opty, opval, opval, pred]
 173
 174     FUNC_CODE_INST_RET         = 10, // RET:        [opty,opval<both optional>]
 175     FUNC_CODE_INST_BR          = 11, // BR:         [bb#, bb#, cond] or [bb#]
 176     FUNC_CODE_INST_SWITCH      = 12, // SWITCH:     [opty, opval, n, n x ops]
 177     FUNC_CODE_INST_INVOKE      = 13, // INVOKE:     [fnty, op0,op1,op2, ...]
 178     FUNC_CODE_INST_UNWIND      = 14, // UNWIND
 179     FUNC_CODE_INST_UNREACHABLE = 15, // UNREACHABLE
 180
 181     FUNC_CODE_INST_PHI         = 16, // PHI:        [ty, val0,bb0, ...]
 182     FUNC_CODE_INST_MALLOC      = 17, // MALLOC:     [instty, op, align]
 183     FUNC_CODE_INST_FREE        = 18, // FREE:       [opty, op]
 184     FUNC_CODE_INST_ALLOCA      = 19, // ALLOCA:     [instty, op, align]
 185     FUNC_CODE_INST_LOAD        = 20, // LOAD:       [opty, op, align, vol]
 186     FUNC_CODE_INST_STORE       = 21, // STORE:      [ptrty,val,ptr, align, vol]
 187     FUNC_CODE_INST_CALL        = 22, // CALL:       [fnty, fnid, arg0, arg1...]
 188     FUNC_CODE_INST_VAARG       = 23  // VAARG:      [valistty, valist, instty]
 189   };
 190 } // End bitc namespace
 191 } // End llvm namespace
 192
 193 #endif