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          = 0,
  29
  30     // Module sub-block id's
  31     TYPE_BLOCK_ID            = 1,
  32     CONSTANTS_BLOCK_ID       = 2,
  33     FUNCTION_BLOCK_ID        = 3,
  34     TYPE_SYMTAB_BLOCK_ID     = 4,
  35     VALUE_SYMTAB_BLOCK_ID    = 5
  36   };
  37
  38
  39   /// MODULE blocks have a number of optional fields and subblocks.
  40   enum ModuleCodes {
  41     MODULE_CODE_VERSION     = 1,    // VERSION:     [version#]
  42     MODULE_CODE_TRIPLE      = 2,    // TRIPLE:      [strlen, strchr x N]
  43     MODULE_CODE_DATALAYOUT  = 3,    // DATALAYOUT:  [strlen, strchr x N]
  44     MODULE_CODE_ASM         = 4,    // ASM:         [strlen, strchr x N]
  45     MODULE_CODE_SECTIONNAME = 5,    // SECTIONNAME: [strlen, strchr x N]
  46     MODULE_CODE_DEPLIB      = 6,    // DEPLIB:      [strlen, strchr x N]
  47
  48     // GLOBALVAR: [type, isconst, initid,
  49     //             linkage, alignment, section, visibility, threadlocal]
  50     MODULE_CODE_GLOBALVAR   = 7,
  51
  52     // FUNCTION:  [type, callingconv, isproto, linkage, alignment, section,
  53     //             visibility]
  54     MODULE_CODE_FUNCTION    = 8,
  55
  56     // ALIAS: [alias type, aliasee val#, linkage]
  57     MODULE_CODE_ALIAS       = 9,
  58
  59     /// MODULE_CODE_PURGEVALS: [numvals]
  60     MODULE_CODE_PURGEVALS   = 10
  61   };
  62
  63   /// TYPE blocks have codes for each type primitive they use.
  64   enum TypeCodes {
  65     TYPE_CODE_NUMENTRY =  1,   // TYPE_CODE_NUMENTRY: [numentries]
  66     TYPE_CODE_META     =  2,   // TYPE_CODE_META: [metacode]... - Future use
  67
  68     // Type Codes
  69     TYPE_CODE_VOID     =  3,   // VOID
  70     TYPE_CODE_FLOAT    =  4,   // FLOAT
  71     TYPE_CODE_DOUBLE   =  5,   // DOUBLE
  72     TYPE_CODE_LABEL    =  6,   // LABEL
  73     TYPE_CODE_OPAQUE   =  7,   // OPAQUE
  74     TYPE_CODE_INTEGER  =  8,   // INTEGER: [width]
  75     TYPE_CODE_POINTER  =  9,   // POINTER: [pointee type]
  76     TYPE_CODE_FUNCTION = 10,   // FUNCTION: [vararg, retty, #pararms, paramty N]
  77     TYPE_CODE_STRUCT   = 11,   // STRUCT: [ispacked, #elts, eltty x N]
  78     TYPE_CODE_ARRAY    = 12,   // ARRAY: [numelts, eltty]
  79     TYPE_CODE_VECTOR   = 13    // VECTOR: [numelts, eltty]
  80     // Any other type code is assumed to be an unknown type.
  81   };
  82
  83   // The type symbol table only has one code (TST_ENTRY_CODE).
  84   enum TypeSymtabCodes {
  85     TST_CODE_ENTRY = 1     // TST_ENTRY: [typeid, namelen, namechar x N]
  86   };
  87
  88   // The value symbol table only has one code (VST_ENTRY_CODE).
  89   enum ValueSymtabCodes {
  90     VST_CODE_ENTRY = 1     // VST_ENTRY: [valid, namelen, namechar x N]
  91   };
  92
  93   // The constants block (CONSTANTS_BLOCK_ID) describes emission for each
  94   // constant and maintains an implicit current type value.
  95   enum ConstantsSymtabCodes {
  96     CST_CODE_SETTYPE       =  1,  // SETTYPE:       [typeid]
  97     CST_CODE_NULL          =  2,  // NULL
  98     CST_CODE_UNDEF         =  3,  // UNDEF
  99     CST_CODE_INTEGER       =  4,  // INTEGER:       [intval]
 100     CST_CODE_WIDE_INTEGER  =  5,  // WIDE_INTEGER:  [n, n x intval]
 101     CST_CODE_FLOAT         =  6,  // FLOAT:         [fpval]
 102     CST_CODE_AGGREGATE     =  7,  // AGGREGATE:     [n, n x value number]
 103     CST_CODE_CE_BINOP      =  8,  // CE_BINOP:      [opcode, opval, opval]
 104     CST_CODE_CE_CAST       =  9,  // CE_CAST:       [opcode, opty, opval]
 105     CST_CODE_CE_GEP        = 10,  // CE_GEP:        [n, n x operands]
 106     CST_CODE_CE_SELECT     = 11,  // CE_SELECT:     [opval, opval, opval]
 107     CST_CODE_CE_EXTRACTELT = 12,  // CE_EXTRACTELT: [opty, opval, opval]
 108     CST_CODE_CE_INSERTELT  = 13,  // CE_INSERTELT:  [opval, opval, opval]
 109     CST_CODE_CE_SHUFFLEVEC = 14,  // CE_SHUFFLEVEC: [opval, opval, opval]
 110     CST_CODE_CE_CMP        = 15   // CE_CMP:        [opty, opval, opval, pred]
 111   };
 112
 113   /// CastOpcodes - These are values used in the bitcode files to encode which
 114   /// cast a CST_CODE_CE_CAST or a XXX refers to.  The values of these enums
 115   /// have no fixed relation to the LLVM IR enum values.  Changing these will
 116   /// break compatibility with old files.
 117   enum CastOpcodes {
 118     CAST_TRUNC    =  0,
 119     CAST_ZEXT     =  1,
 120     CAST_SEXT     =  2,
 121     CAST_FPTOUI   =  3,
 122     CAST_FPTOSI   =  4,
 123     CAST_UITOFP   =  5,
 124     CAST_SITOFP   =  6,
 125     CAST_FPTRUNC  =  7,
 126     CAST_FPEXT    =  8,
 127     CAST_PTRTOINT =  9,
 128     CAST_INTTOPTR = 10,
 129     CAST_BITCAST  = 11
 130   };
 131
 132   /// BinaryOpcodes - These are values used in the bitcode files to encode which
 133   /// binop a CST_CODE_CE_BINOP or a XXX refers to.  The values of these enums
 134   /// have no fixed relation to the LLVM IR enum values.  Changing these will
 135   /// break compatibility with old files.
 136   enum BinaryOpcodes {
 137     BINOP_ADD  =  0,
 138     BINOP_SUB  =  1,
 139     BINOP_MUL  =  2,
 140     BINOP_UDIV =  3,
 141     BINOP_SDIV =  4,    // overloaded for FP
 142     BINOP_UREM =  5,
 143     BINOP_SREM =  6,    // overloaded for FP
 144     BINOP_SHL  =  7,
 145     BINOP_LSHR =  8,
 146     BINOP_ASHR =  9,
 147     BINOP_AND  = 10,
 148     BINOP_OR   = 11,
 149     BINOP_XOR  = 12
 150   };
 151
 152
 153   // The function body block (FUNCTION_BLOCK_ID) describes function bodies.  It
 154   // can contain a constant block (CONSTANTS_BLOCK_ID).
 155   enum FunctionCodes {
 156     FUNC_CODE_DECLAREBLOCKS    =  1, // DECLAREBLOCKS: [n]
 157
 158     FUNC_CODE_INST_BINOP       =  2, // BINOP:      [opcode, ty, opval, opval]
 159     FUNC_CODE_INST_CAST        =  3, // CAST:       [opcode, ty, opty, opval]
 160     FUNC_CODE_INST_GEP         =  4, // GEP:        [n, n x operands]
 161     FUNC_CODE_INST_SELECT      =  5, // SELECT:     [ty, opval, opval, opval]
 162     FUNC_CODE_INST_EXTRACTELT  =  6, // EXTRACTELT: [opty, opval, opval]
 163     FUNC_CODE_INST_INSERTELT   =  7, // INSERTELT:  [ty, opval, opval, opval]
 164     FUNC_CODE_INST_SHUFFLEVEC  =  8, // SHUFFLEVEC: [ty, opval, opval, opval]
 165     FUNC_CODE_INST_CMP         =  9, // CMP:        [opty, opval, opval, pred]
 166
 167     FUNC_CODE_INST_RET         = 10, // RET:        [opval<optional>]
 168     FUNC_CODE_INST_BR          = 11, // BR:         [opval, bb#, bb#] or [bb#]
 169     FUNC_CODE_INST_SWITCH      = 12, // SWITCH:     [opty, opval, n, n x ops]
 170     FUNC_CODE_INST_INVOKE      = 13, // INVOKE:
 171     FUNC_CODE_INST_UNWIND      = 14, // UNWIND
 172     FUNC_CODE_INST_UNREACHABLE = 15, // UNREACHABLE
 173
 174     FUNC_CODE_INST_MALLOC      = 16, // MALLOC: ..
 175     FUNC_CODE_INST_FREE        = 17, // FREE: ..
 176     FUNC_CODE_INST_ALLOCA      = 18, // ALLOCA: ..
 177     FUNC_CODE_INST_LOAD        = 19, // LOAD: ..
 178     FUNC_CODE_INST_STORE       = 20, // STORE: ..
 179     FUNC_CODE_INST_CALL        = 21, // CALL: ..
 180     FUNC_CODE_INST_VAARG       = 22  // VAARG: ..
 181   };
 182 } // End bitc namespace
 183 } // End llvm namespace
 184
 185 #endif