LLVM API Documentation

LLVMBitCodes.h

Go to the documentation of this file.
00001 //===- LLVMBitCodes.h - Enum values for the LLVM bitcode format -*- C++ -*-===//
00002 //
00003 //                     The LLVM Compiler Infrastructure
00004 //
00005 // This file is distributed under the University of Illinois Open Source
00006 // License. See LICENSE.TXT for details.
00007 //
00008 //===----------------------------------------------------------------------===//
00009 //
00010 // This header defines Bitcode enum values for LLVM IR bitcode files.
00011 //
00012 // The enum values defined in this file should be considered permanent.  If
00013 // new features are added, they should have values added at the end of the
00014 // respective lists.
00015 //
00016 //===----------------------------------------------------------------------===//
00017 
00018 #ifndef LLVM_BITCODE_LLVMBITCODES_H
00019 #define LLVM_BITCODE_LLVMBITCODES_H
00020 
00021 #include "llvm/Bitcode/BitCodes.h"
00022 
00023 namespace llvm {
00024 namespace bitc {
00025   // The only top-level block type defined is for a module.
00026   enum BlockIDs {
00027     // Blocks
00028     MODULE_BLOCK_ID          = FIRST_APPLICATION_BLOCKID,
00029 
00030     // Module sub-block id's.
00031     PARAMATTR_BLOCK_ID,
00032     TYPE_BLOCK_ID,
00033     CONSTANTS_BLOCK_ID,
00034     FUNCTION_BLOCK_ID,
00035     TYPE_SYMTAB_BLOCK_ID,
00036     VALUE_SYMTAB_BLOCK_ID,
00037     METADATA_BLOCK_ID
00038   };
00039 
00040 
00041   /// MODULE blocks have a number of optional fields and subblocks.
00042   enum ModuleCodes {
00043     MODULE_CODE_VERSION     = 1,    // VERSION:     [version#]
00044     MODULE_CODE_TRIPLE      = 2,    // TRIPLE:      [strchr x N]
00045     MODULE_CODE_DATALAYOUT  = 3,    // DATALAYOUT:  [strchr x N]
00046     MODULE_CODE_ASM         = 4,    // ASM:         [strchr x N]
00047     MODULE_CODE_SECTIONNAME = 5,    // SECTIONNAME: [strchr x N]
00048     MODULE_CODE_DEPLIB      = 6,    // DEPLIB:      [strchr x N]
00049 
00050     // GLOBALVAR: [pointer type, isconst, initid,
00051     //             linkage, alignment, section, visibility, threadlocal]
00052     MODULE_CODE_GLOBALVAR   = 7,
00053 
00054     // FUNCTION:  [type, callingconv, isproto, linkage, paramattrs, alignment,
00055     //             section, visibility]
00056     MODULE_CODE_FUNCTION    = 8,
00057 
00058     // ALIAS: [alias type, aliasee val#, linkage]
00059     MODULE_CODE_ALIAS       = 9,
00060 
00061     /// MODULE_CODE_PURGEVALS: [numvals]
00062     MODULE_CODE_PURGEVALS   = 10,
00063 
00064     MODULE_CODE_GCNAME      = 11   // GCNAME: [strchr x N]
00065   };
00066 
00067   /// PARAMATTR blocks have code for defining a parameter attribute set.
00068   enum AttributeCodes {
00069     PARAMATTR_CODE_ENTRY = 1   // ENTRY: [paramidx0, attr0, paramidx1, attr1...]
00070   };
00071 
00072   /// TYPE blocks have codes for each type primitive they use.
00073   enum TypeCodes {
00074     TYPE_CODE_NUMENTRY =  1,   // NUMENTRY: [numentries]
00075 
00076     // Type Codes
00077     TYPE_CODE_VOID     =  2,   // VOID
00078     TYPE_CODE_FLOAT    =  3,   // FLOAT
00079     TYPE_CODE_DOUBLE   =  4,   // DOUBLE
00080     TYPE_CODE_LABEL    =  5,   // LABEL
00081     TYPE_CODE_OPAQUE   =  6,   // OPAQUE
00082     TYPE_CODE_INTEGER  =  7,   // INTEGER: [width]
00083     TYPE_CODE_POINTER  =  8,   // POINTER: [pointee type]
00084     TYPE_CODE_FUNCTION =  9,   // FUNCTION: [vararg, retty, paramty x N]
00085     TYPE_CODE_STRUCT   = 10,   // STRUCT: [ispacked, eltty x N]
00086     TYPE_CODE_ARRAY    = 11,   // ARRAY: [numelts, eltty]
00087     TYPE_CODE_VECTOR   = 12,   // VECTOR: [numelts, eltty]
00088 
00089     // These are not with the other floating point types because they're
00090     // a late addition, and putting them in the right place breaks
00091     // binary compatibility.
00092     TYPE_CODE_X86_FP80 = 13,   // X86 LONG DOUBLE
00093     TYPE_CODE_FP128    = 14,   // LONG DOUBLE (112 bit mantissa)
00094     TYPE_CODE_PPC_FP128= 15,   // PPC LONG DOUBLE (2 doubles)
00095 
00096     TYPE_CODE_METADATA = 16    // METADATA
00097   };
00098 
00099   // The type symbol table only has one code (TST_ENTRY_CODE).
00100   enum TypeSymtabCodes {
00101     TST_CODE_ENTRY = 1     // TST_ENTRY: [typeid, namechar x N]
00102   };
00103 
00104   // The value symbol table only has one code (VST_ENTRY_CODE).
00105   enum ValueSymtabCodes {
00106     VST_CODE_ENTRY   = 1,  // VST_ENTRY: [valid, namechar x N]
00107     VST_CODE_BBENTRY = 2   // VST_BBENTRY: [bbid, namechar x N]
00108   };
00109 
00110   enum MetadataCodes {
00111     METADATA_STRING        = 1,   // MDSTRING:      [values]
00112     METADATA_NODE          = 2,   // MDNODE:        [n x (type num, value num)]
00113     METADATA_NAME          = 3,   // STRING:        [values]
00114     METADATA_NAMED_NODE    = 4    // NAMEDMDNODE:   [n x mdnodes]
00115   };
00116   // The constants block (CONSTANTS_BLOCK_ID) describes emission for each
00117   // constant and maintains an implicit current type value.
00118   enum ConstantsCodes {
00119     CST_CODE_SETTYPE       =  1,  // SETTYPE:       [typeid]
00120     CST_CODE_NULL          =  2,  // NULL
00121     CST_CODE_UNDEF         =  3,  // UNDEF
00122     CST_CODE_INTEGER       =  4,  // INTEGER:       [intval]
00123     CST_CODE_WIDE_INTEGER  =  5,  // WIDE_INTEGER:  [n x intval]
00124     CST_CODE_FLOAT         =  6,  // FLOAT:         [fpval]
00125     CST_CODE_AGGREGATE     =  7,  // AGGREGATE:     [n x value number]
00126     CST_CODE_STRING        =  8,  // STRING:        [values]
00127     CST_CODE_CSTRING       =  9,  // CSTRING:       [values]
00128     CST_CODE_CE_BINOP      = 10,  // CE_BINOP:      [opcode, opval, opval]
00129     CST_CODE_CE_CAST       = 11,  // CE_CAST:       [opcode, opty, opval]
00130     CST_CODE_CE_GEP        = 12,  // CE_GEP:        [n x operands]
00131     CST_CODE_CE_SELECT     = 13,  // CE_SELECT:     [opval, opval, opval]
00132     CST_CODE_CE_EXTRACTELT = 14,  // CE_EXTRACTELT: [opty, opval, opval]
00133     CST_CODE_CE_INSERTELT  = 15,  // CE_INSERTELT:  [opval, opval, opval]
00134     CST_CODE_CE_SHUFFLEVEC = 16,  // CE_SHUFFLEVEC: [opval, opval, opval]
00135     CST_CODE_CE_CMP        = 17,  // CE_CMP:        [opty, opval, opval, pred]
00136     CST_CODE_INLINEASM     = 18,  // INLINEASM:     [sideeffect,asmstr,conststr]
00137     CST_CODE_CE_SHUFVEC_EX = 19,  // SHUFVEC_EX:    [opty, opval, opval, opval]
00138     CST_CODE_CE_INBOUNDS_GEP = 20 // INBOUNDS_GEP:  [n x operands]
00139   };
00140 
00141   /// CastOpcodes - These are values used in the bitcode files to encode which
00142   /// cast a CST_CODE_CE_CAST or a XXX refers to.  The values of these enums
00143   /// have no fixed relation to the LLVM IR enum values.  Changing these will
00144   /// break compatibility with old files.
00145   enum CastOpcodes {
00146     CAST_TRUNC    =  0,
00147     CAST_ZEXT     =  1,
00148     CAST_SEXT     =  2,
00149     CAST_FPTOUI   =  3,
00150     CAST_FPTOSI   =  4,
00151     CAST_UITOFP   =  5,
00152     CAST_SITOFP   =  6,
00153     CAST_FPTRUNC  =  7,
00154     CAST_FPEXT    =  8,
00155     CAST_PTRTOINT =  9,
00156     CAST_INTTOPTR = 10,
00157     CAST_BITCAST  = 11
00158   };
00159 
00160   /// BinaryOpcodes - These are values used in the bitcode files to encode which
00161   /// binop a CST_CODE_CE_BINOP or a XXX refers to.  The values of these enums
00162   /// have no fixed relation to the LLVM IR enum values.  Changing these will
00163   /// break compatibility with old files.
00164   enum BinaryOpcodes {
00165     BINOP_ADD  =  0,
00166     BINOP_SUB  =  1,
00167     BINOP_MUL  =  2,
00168     BINOP_UDIV =  3,
00169     BINOP_SDIV =  4,    // overloaded for FP
00170     BINOP_UREM =  5,
00171     BINOP_SREM =  6,    // overloaded for FP
00172     BINOP_SHL  =  7,
00173     BINOP_LSHR =  8,
00174     BINOP_ASHR =  9,
00175     BINOP_AND  = 10,
00176     BINOP_OR   = 11,
00177     BINOP_XOR  = 12
00178   };
00179 
00180   /// OverflowingBinaryOperatorOptionalFlags - Flags for serializing
00181   /// OverflowingBinaryOperator's SubclassOptionalData contents.
00182   enum OverflowingBinaryOperatorOptionalFlags {
00183     OBO_NO_UNSIGNED_WRAP = 0,
00184     OBO_NO_SIGNED_WRAP = 1
00185   };
00186 
00187   /// SDivOperatorOptionalFlags - Flags for serializing SDivOperator's
00188   /// SubclassOptionalData contents.
00189   enum SDivOperatorOptionalFlags {
00190     SDIV_EXACT = 0
00191   };
00192 
00193   // The function body block (FUNCTION_BLOCK_ID) describes function bodies.  It
00194   // can contain a constant block (CONSTANTS_BLOCK_ID).
00195   enum FunctionCodes {
00196     FUNC_CODE_DECLAREBLOCKS    =  1, // DECLAREBLOCKS: [n]
00197 
00198     FUNC_CODE_INST_BINOP       =  2, // BINOP:      [opcode, ty, opval, opval]
00199     FUNC_CODE_INST_CAST        =  3, // CAST:       [opcode, ty, opty, opval]
00200     FUNC_CODE_INST_GEP         =  4, // GEP:        [n x operands]
00201     FUNC_CODE_INST_SELECT      =  5, // SELECT:     [ty, opval, opval, opval]
00202     FUNC_CODE_INST_EXTRACTELT  =  6, // EXTRACTELT: [opty, opval, opval]
00203     FUNC_CODE_INST_INSERTELT   =  7, // INSERTELT:  [ty, opval, opval, opval]
00204     FUNC_CODE_INST_SHUFFLEVEC  =  8, // SHUFFLEVEC: [ty, opval, opval, opval]
00205     FUNC_CODE_INST_CMP         =  9, // CMP:        [opty, opval, opval, pred]
00206 
00207     FUNC_CODE_INST_RET         = 10, // RET:        [opty,opval<both optional>]
00208     FUNC_CODE_INST_BR          = 11, // BR:         [bb#, bb#, cond] or [bb#]
00209     FUNC_CODE_INST_SWITCH      = 12, // SWITCH:     [opty, opval, n, n x ops]
00210     FUNC_CODE_INST_INVOKE      = 13, // INVOKE:     [attr, fnty, op0,op1, ...]
00211     FUNC_CODE_INST_UNWIND      = 14, // UNWIND
00212     FUNC_CODE_INST_UNREACHABLE = 15, // UNREACHABLE
00213 
00214     FUNC_CODE_INST_PHI         = 16, // PHI:        [ty, val0,bb0, ...]
00215     FUNC_CODE_INST_MALLOC      = 17, // MALLOC:     [instty, op, align]
00216     FUNC_CODE_INST_FREE        = 18, // FREE:       [opty, op]
00217     FUNC_CODE_INST_ALLOCA      = 19, // ALLOCA:     [instty, op, align]
00218     FUNC_CODE_INST_LOAD        = 20, // LOAD:       [opty, op, align, vol]
00219     // FIXME: Remove STORE in favor of STORE2 in LLVM 3.0
00220     FUNC_CODE_INST_STORE       = 21, // STORE:      [valty,val,ptr, align, vol]
00221     FUNC_CODE_INST_CALL        = 22, // CALL:       [attr, fnty, fnid, args...]
00222     FUNC_CODE_INST_VAARG       = 23, // VAARG:      [valistty, valist, instty]
00223     // This store code encodes the pointer type, rather than the value type
00224     // this is so information only available in the pointer type (e.g. address
00225     // spaces) is retained.
00226     FUNC_CODE_INST_STORE2      = 24, // STORE:      [ptrty,ptr,val, align, vol]
00227     // FIXME: Remove GETRESULT in favor of EXTRACTVAL in LLVM 3.0
00228     FUNC_CODE_INST_GETRESULT   = 25, // GETRESULT:  [ty, opval, n]
00229     FUNC_CODE_INST_EXTRACTVAL  = 26, // EXTRACTVAL: [n x operands]
00230     FUNC_CODE_INST_INSERTVAL   = 27, // INSERTVAL:  [n x operands]
00231     // fcmp/icmp returning Int1TY or vector of Int1Ty. Same as CMP, exists to
00232     // support legacy vicmp/vfcmp instructions.
00233     FUNC_CODE_INST_CMP2        = 28, // CMP2:       [opty, opval, opval, pred]
00234     // new select on i1 or [N x i1]
00235     FUNC_CODE_INST_VSELECT     = 29, // VSELECT:    [ty,opval,opval,predty,pred]
00236     FUNC_CODE_INST_INBOUNDS_GEP = 30 // INBOUNDS_GEP: [n x operands]
00237   };
00238 } // End bitc namespace
00239 } // End llvm namespace
00240 
00241 #endif