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 33 /// TYPE_BLOCK_ID_OLD - This is the type descriptor block in LLVM 2.9 and 34 /// earlier, replaced with TYPE_BLOCK_ID2. FIXME: Remove in LLVM 3.1. 35 TYPE_BLOCK_ID_OLD, 36 37 CONSTANTS_BLOCK_ID, 38 FUNCTION_BLOCK_ID, 39 40 /// TYPE_SYMTAB_BLOCK_ID_OLD - This type descriptor is from LLVM 2.9 and 41 /// earlier bitcode files. FIXME: Remove in LLVM 3.1 42 TYPE_SYMTAB_BLOCK_ID_OLD, 43 44 VALUE_SYMTAB_BLOCK_ID, 45 METADATA_BLOCK_ID, 46 METADATA_ATTACHMENT_ID, 47 48 TYPE_BLOCK_ID_NEW 49 }; 50 51 52 /// MODULE blocks have a number of optional fields and subblocks. 53 enum ModuleCodes { 54 MODULE_CODE_VERSION = 1, // VERSION: [version#] 55 MODULE_CODE_TRIPLE = 2, // TRIPLE: [strchr x N] 56 MODULE_CODE_DATALAYOUT = 3, // DATALAYOUT: [strchr x N] 57 MODULE_CODE_ASM = 4, // ASM: [strchr x N] 58 MODULE_CODE_SECTIONNAME = 5, // SECTIONNAME: [strchr x N] 59 MODULE_CODE_DEPLIB = 6, // DEPLIB: [strchr x N] 60 61 // GLOBALVAR: [pointer type, isconst, initid, 62 // linkage, alignment, section, visibility, threadlocal] 63 MODULE_CODE_GLOBALVAR = 7, 64 65 // FUNCTION: [type, callingconv, isproto, linkage, paramattrs, alignment, 66 // section, visibility] 67 MODULE_CODE_FUNCTION = 8, 68 69 // ALIAS: [alias type, aliasee val#, linkage] 70 MODULE_CODE_ALIAS = 9, 71 72 /// MODULE_CODE_PURGEVALS: [numvals] 73 MODULE_CODE_PURGEVALS = 10, 74 75 MODULE_CODE_GCNAME = 11 // GCNAME: [strchr x N] 76 }; 77 78 /// PARAMATTR blocks have code for defining a parameter attribute set. 79 enum AttributeCodes { 80 PARAMATTR_CODE_ENTRY = 1 // ENTRY: [paramidx0, attr0, paramidx1, attr1...] 81 }; 82 83 /// TYPE blocks have codes for each type primitive they use. 84 enum TypeCodes { 85 TYPE_CODE_NUMENTRY = 1, // NUMENTRY: [numentries] 86 87 // Type Codes 88 TYPE_CODE_VOID = 2, // VOID 89 TYPE_CODE_FLOAT = 3, // FLOAT 90 TYPE_CODE_DOUBLE = 4, // DOUBLE 91 TYPE_CODE_LABEL = 5, // LABEL 92 TYPE_CODE_OPAQUE = 6, // OPAQUE 93 TYPE_CODE_INTEGER = 7, // INTEGER: [width] 94 TYPE_CODE_POINTER = 8, // POINTER: [pointee type] 95 TYPE_CODE_FUNCTION = 9, // FUNCTION: [vararg, retty, paramty x N] 96 97 // FIXME: This is the encoding used for structs in LLVM 2.9 and earlier. 98 // REMOVE this in LLVM 3.1 99 TYPE_CODE_STRUCT_OLD = 10, // STRUCT: [ispacked, eltty x N] 100 TYPE_CODE_ARRAY = 11, // ARRAY: [numelts, eltty] 101 TYPE_CODE_VECTOR = 12, // VECTOR: [numelts, eltty] 102 103 // These are not with the other floating point types because they're 104 // a late addition, and putting them in the right place breaks 105 // binary compatibility. 106 TYPE_CODE_X86_FP80 = 13, // X86 LONG DOUBLE 107 TYPE_CODE_FP128 = 14, // LONG DOUBLE (112 bit mantissa) 108 TYPE_CODE_PPC_FP128= 15, // PPC LONG DOUBLE (2 doubles) 109 110 TYPE_CODE_METADATA = 16, // METADATA 111 112 TYPE_CODE_X86_MMX = 17, // X86 MMX 113 114 TYPE_CODE_STRUCT_ANON = 18, // STRUCT_ANON: [ispacked, eltty x N] 115 TYPE_CODE_STRUCT_NAME = 19, // STRUCT_NAME: [strchr x N] 116 TYPE_CODE_STRUCT_NAMED = 20 // STRUCT_NAMED: [ispacked, eltty x N] 117 }; 118 119 // The type symbol table only has one code (TST_ENTRY_CODE). 120 enum TypeSymtabCodes { 121 TST_CODE_ENTRY = 1 // TST_ENTRY: [typeid, namechar x N] 122 }; 123 124 // The value symbol table only has one code (VST_ENTRY_CODE). 125 enum ValueSymtabCodes { 126 VST_CODE_ENTRY = 1, // VST_ENTRY: [valid, namechar x N] 127 VST_CODE_BBENTRY = 2 // VST_BBENTRY: [bbid, namechar x N] 128 }; 129 130 enum MetadataCodes { 131 METADATA_STRING = 1, // MDSTRING: [values] 132 // 2 is unused. 133 // 3 is unused. 134 METADATA_NAME = 4, // STRING: [values] 135 // 5 is unused. 136 METADATA_KIND = 6, // [n x [id, name]] 137 // 7 is unused. 138 METADATA_NODE = 8, // NODE: [n x (type num, value num)] 139 METADATA_FN_NODE = 9, // FN_NODE: [n x (type num, value num)] 140 METADATA_NAMED_NODE = 10, // NAMED_NODE: [n x mdnodes] 141 METADATA_ATTACHMENT = 11 // [m x [value, [n x [id, mdnode]]] 142 }; 143 // The constants block (CONSTANTS_BLOCK_ID) describes emission for each 144 // constant and maintains an implicit current type value. 145 enum ConstantsCodes { 146 CST_CODE_SETTYPE = 1, // SETTYPE: [typeid] 147 CST_CODE_NULL = 2, // NULL 148 CST_CODE_UNDEF = 3, // UNDEF 149 CST_CODE_INTEGER = 4, // INTEGER: [intval] 150 CST_CODE_WIDE_INTEGER = 5, // WIDE_INTEGER: [n x intval] 151 CST_CODE_FLOAT = 6, // FLOAT: [fpval] 152 CST_CODE_AGGREGATE = 7, // AGGREGATE: [n x value number] 153 CST_CODE_STRING = 8, // STRING: [values] 154 CST_CODE_CSTRING = 9, // CSTRING: [values] 155 CST_CODE_CE_BINOP = 10, // CE_BINOP: [opcode, opval, opval] 156 CST_CODE_CE_CAST = 11, // CE_CAST: [opcode, opty, opval] 157 CST_CODE_CE_GEP = 12, // CE_GEP: [n x operands] 158 CST_CODE_CE_SELECT = 13, // CE_SELECT: [opval, opval, opval] 159 CST_CODE_CE_EXTRACTELT = 14, // CE_EXTRACTELT: [opty, opval, opval] 160 CST_CODE_CE_INSERTELT = 15, // CE_INSERTELT: [opval, opval, opval] 161 CST_CODE_CE_SHUFFLEVEC = 16, // CE_SHUFFLEVEC: [opval, opval, opval] 162 CST_CODE_CE_CMP = 17, // CE_CMP: [opty, opval, opval, pred] 163 CST_CODE_INLINEASM = 18, // INLINEASM: [sideeffect,asmstr,conststr] 164 CST_CODE_CE_SHUFVEC_EX = 19, // SHUFVEC_EX: [opty, opval, opval, opval] 165 CST_CODE_CE_INBOUNDS_GEP = 20,// INBOUNDS_GEP: [n x operands] 166 CST_CODE_BLOCKADDRESS = 21 // CST_CODE_BLOCKADDRESS [fnty, fnval, bb#] 167 }; 168 169 /// CastOpcodes - These are values used in the bitcode files to encode which 170 /// cast a CST_CODE_CE_CAST or a XXX refers to. The values of these enums 171 /// have no fixed relation to the LLVM IR enum values. Changing these will 172 /// break compatibility with old files. 173 enum CastOpcodes { 174 CAST_TRUNC = 0, 175 CAST_ZEXT = 1, 176 CAST_SEXT = 2, 177 CAST_FPTOUI = 3, 178 CAST_FPTOSI = 4, 179 CAST_UITOFP = 5, 180 CAST_SITOFP = 6, 181 CAST_FPTRUNC = 7, 182 CAST_FPEXT = 8, 183 CAST_PTRTOINT = 9, 184 CAST_INTTOPTR = 10, 185 CAST_BITCAST = 11 186 }; 187 188 /// BinaryOpcodes - These are values used in the bitcode files to encode which 189 /// binop a CST_CODE_CE_BINOP or a XXX refers to. The values of these enums 190 /// have no fixed relation to the LLVM IR enum values. Changing these will 191 /// break compatibility with old files. 192 enum BinaryOpcodes { 193 BINOP_ADD = 0, 194 BINOP_SUB = 1, 195 BINOP_MUL = 2, 196 BINOP_UDIV = 3, 197 BINOP_SDIV = 4, // overloaded for FP 198 BINOP_UREM = 5, 199 BINOP_SREM = 6, // overloaded for FP 200 BINOP_SHL = 7, 201 BINOP_LSHR = 8, 202 BINOP_ASHR = 9, 203 BINOP_AND = 10, 204 BINOP_OR = 11, 205 BINOP_XOR = 12 206 }; 207 208 /// These are values used in the bitcode files to encode AtomicRMW operations. 209 /// The values of these enums have no fixed relation to the LLVM IR enum 210 /// values. Changing these will break compatibility with old files. 211 enum RMWOperations { 212 RMW_XCHG = 0, 213 RMW_ADD = 1, 214 RMW_SUB = 2, 215 RMW_AND = 3, 216 RMW_NAND = 4, 217 RMW_OR = 5, 218 RMW_XOR = 6, 219 RMW_MAX = 7, 220 RMW_MIN = 8, 221 RMW_UMAX = 9, 222 RMW_UMIN = 10 223 }; 224 225 /// OverflowingBinaryOperatorOptionalFlags - Flags for serializing 226 /// OverflowingBinaryOperator's SubclassOptionalData contents. 227 enum OverflowingBinaryOperatorOptionalFlags { 228 OBO_NO_UNSIGNED_WRAP = 0, 229 OBO_NO_SIGNED_WRAP = 1 230 }; 231 232 /// PossiblyExactOperatorOptionalFlags - Flags for serializing 233 /// PossiblyExactOperator's SubclassOptionalData contents. 234 enum PossiblyExactOperatorOptionalFlags { 235 PEO_EXACT = 0 236 }; 237 238 /// Encoded AtomicOrdering values. 239 enum AtomicOrderingCodes { 240 ORDERING_NOTATOMIC = 0, 241 ORDERING_UNORDERED = 1, 242 ORDERING_MONOTONIC = 2, 243 ORDERING_ACQUIRE = 3, 244 ORDERING_RELEASE = 4, 245 ORDERING_ACQREL = 5, 246 ORDERING_SEQCST = 6 247 }; 248 249 /// Encoded SynchronizationScope values. 250 enum AtomicSynchScopeCodes { 251 SYNCHSCOPE_SINGLETHREAD = 0, 252 SYNCHSCOPE_CROSSTHREAD = 1 253 }; 254 255 // The function body block (FUNCTION_BLOCK_ID) describes function bodies. It 256 // can contain a constant block (CONSTANTS_BLOCK_ID). 257 enum FunctionCodes { 258 FUNC_CODE_DECLAREBLOCKS = 1, // DECLAREBLOCKS: [n] 259 260 FUNC_CODE_INST_BINOP = 2, // BINOP: [opcode, ty, opval, opval] 261 FUNC_CODE_INST_CAST = 3, // CAST: [opcode, ty, opty, opval] 262 FUNC_CODE_INST_GEP = 4, // GEP: [n x operands] 263 FUNC_CODE_INST_SELECT = 5, // SELECT: [ty, opval, opval, opval] 264 FUNC_CODE_INST_EXTRACTELT = 6, // EXTRACTELT: [opty, opval, opval] 265 FUNC_CODE_INST_INSERTELT = 7, // INSERTELT: [ty, opval, opval, opval] 266 FUNC_CODE_INST_SHUFFLEVEC = 8, // SHUFFLEVEC: [ty, opval, opval, opval] 267 FUNC_CODE_INST_CMP = 9, // CMP: [opty, opval, opval, pred] 268 269 FUNC_CODE_INST_RET = 10, // RET: [opty,opval<both optional>] 270 FUNC_CODE_INST_BR = 11, // BR: [bb#, bb#, cond] or [bb#] 271 FUNC_CODE_INST_SWITCH = 12, // SWITCH: [opty, op0, op1, ...] 272 FUNC_CODE_INST_INVOKE = 13, // INVOKE: [attr, fnty, op0,op1, ...] 273 FUNC_CODE_INST_UNWIND = 14, // UNWIND 274 FUNC_CODE_INST_UNREACHABLE = 15, // UNREACHABLE 275 276 FUNC_CODE_INST_PHI = 16, // PHI: [ty, val0,bb0, ...] 277 // 17 is unused. 278 // 18 is unused. 279 FUNC_CODE_INST_ALLOCA = 19, // ALLOCA: [instty, op, align] 280 FUNC_CODE_INST_LOAD = 20, // LOAD: [opty, op, align, vol] 281 // 21 is unused. 282 // 22 is unused. 283 FUNC_CODE_INST_VAARG = 23, // VAARG: [valistty, valist, instty] 284 // This store code encodes the pointer type, rather than the value type 285 // this is so information only available in the pointer type (e.g. address 286 // spaces) is retained. 287 FUNC_CODE_INST_STORE = 24, // STORE: [ptrty,ptr,val, align, vol] 288 // 25 is unused. 289 FUNC_CODE_INST_EXTRACTVAL = 26, // EXTRACTVAL: [n x operands] 290 FUNC_CODE_INST_INSERTVAL = 27, // INSERTVAL: [n x operands] 291 // fcmp/icmp returning Int1TY or vector of Int1Ty. Same as CMP, exists to 292 // support legacy vicmp/vfcmp instructions. 293 FUNC_CODE_INST_CMP2 = 28, // CMP2: [opty, opval, opval, pred] 294 // new select on i1 or [N x i1] 295 FUNC_CODE_INST_VSELECT = 29, // VSELECT: [ty,opval,opval,predty,pred] 296 FUNC_CODE_INST_INBOUNDS_GEP= 30, // INBOUNDS_GEP: [n x operands] 297 FUNC_CODE_INST_INDIRECTBR = 31, // INDIRECTBR: [opty, op0, op1, ...] 298 // 32 is unused. 299 FUNC_CODE_DEBUG_LOC_AGAIN = 33, // DEBUG_LOC_AGAIN 300 301 FUNC_CODE_INST_CALL = 34, // CALL: [attr, fnty, fnid, args...] 302 303 FUNC_CODE_DEBUG_LOC = 35, // DEBUG_LOC: [Line,Col,ScopeVal, IAVal] 304 FUNC_CODE_INST_FENCE = 36, // FENCE: [ordering, synchscope] 305 FUNC_CODE_INST_CMPXCHG = 37, // CMPXCHG: [ptrty,ptr,cmp,new, align, vol, 306 // ordering, synchscope] 307 FUNC_CODE_INST_ATOMICRMW = 38, // ATOMICRMW: [ptrty,ptr,val, operation, 308 // align, vol, 309 // ordering, synchscope] 310 FUNC_CODE_INST_RESUME = 39, // RESUME: [opval] 311 FUNC_CODE_INST_LANDINGPAD = 40, // LANDINGPAD: [ty,val,val,num,id0,val0...] 312 FUNC_CODE_INST_LOADATOMIC = 41, // LOAD: [opty, op, align, vol, 313 // ordering, synchscope] 314 FUNC_CODE_INST_STOREATOMIC = 42 // STORE: [ptrty,ptr,val, align, vol 315 // ordering, synchscope] 316 }; 317 } // End bitc namespace 318 } // End llvm namespace 319 320 #endif 321
