1 //===- LLVMBitCodes.h - Enum values for the LLVM bitcode format -*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This header defines Bitcode enum values for LLVM IR bitcode files.
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
16 //===----------------------------------------------------------------------===//
18 #ifndef LLVM_BITCODE_LLVMBITCODES_H
19 #define LLVM_BITCODE_LLVMBITCODES_H
21 #include "llvm/Bitcode/BitCodes.h"
25 // The only top-level block type defined is for a module.
28 MODULE_BLOCK_ID = FIRST_APPLICATION_BLOCKID,
30 // Module sub-block id's.
36 VALUE_SYMTAB_BLOCK_ID,
41 /// MODULE blocks have a number of optional fields and subblocks.
43 MODULE_CODE_VERSION = 1, // VERSION: [version#]
44 MODULE_CODE_TRIPLE = 2, // TRIPLE: [strchr x N]
45 MODULE_CODE_DATALAYOUT = 3, // DATALAYOUT: [strchr x N]
46 MODULE_CODE_ASM = 4, // ASM: [strchr x N]
47 MODULE_CODE_SECTIONNAME = 5, // SECTIONNAME: [strchr x N]
48 MODULE_CODE_DEPLIB = 6, // DEPLIB: [strchr x N]
50 // GLOBALVAR: [pointer type, isconst, initid,
51 // linkage, alignment, section, visibility, threadlocal]
52 MODULE_CODE_GLOBALVAR = 7,
54 // FUNCTION: [type, callingconv, isproto, linkage, paramattrs, alignment,
55 // section, visibility]
56 MODULE_CODE_FUNCTION = 8,
58 // ALIAS: [alias type, aliasee val#, linkage]
59 MODULE_CODE_ALIAS = 9,
61 /// MODULE_CODE_PURGEVALS: [numvals]
62 MODULE_CODE_PURGEVALS = 10,
64 MODULE_CODE_GCNAME = 11 // GCNAME: [strchr x N]
67 /// PARAMATTR blocks have code for defining a parameter attribute set.
69 PARAMATTR_CODE_ENTRY = 1 // ENTRY: [paramidx0, attr0, paramidx1, attr1...]
72 /// TYPE blocks have codes for each type primitive they use.
74 TYPE_CODE_NUMENTRY = 1, // NUMENTRY: [numentries]
77 TYPE_CODE_VOID = 2, // VOID
78 TYPE_CODE_FLOAT = 3, // FLOAT
79 TYPE_CODE_DOUBLE = 4, // DOUBLE
80 TYPE_CODE_LABEL = 5, // LABEL
81 TYPE_CODE_OPAQUE = 6, // OPAQUE
82 TYPE_CODE_INTEGER = 7, // INTEGER: [width]
83 TYPE_CODE_POINTER = 8, // POINTER: [pointee type]
84 TYPE_CODE_FUNCTION = 9, // FUNCTION: [vararg, retty, paramty x N]
85 TYPE_CODE_STRUCT = 10, // STRUCT: [ispacked, eltty x N]
86 TYPE_CODE_ARRAY = 11, // ARRAY: [numelts, eltty]
87 TYPE_CODE_VECTOR = 12, // VECTOR: [numelts, eltty]
89 // These are not with the other floating point types because they're
90 // a late addition, and putting them in the right place breaks
91 // binary compatibility.
92 TYPE_CODE_X86_FP80 = 13, // X86 LONG DOUBLE
93 TYPE_CODE_FP128 = 14, // LONG DOUBLE (112 bit mantissa)
94 TYPE_CODE_PPC_FP128= 15, // PPC LONG DOUBLE (2 doubles)
96 TYPE_CODE_METADATA = 16 // METADATA
99 // The type symbol table only has one code (TST_ENTRY_CODE).
100 enum TypeSymtabCodes {
101 TST_CODE_ENTRY = 1 // TST_ENTRY: [typeid, namechar x N]
104 // The value symbol table only has one code (VST_ENTRY_CODE).
105 enum ValueSymtabCodes {
106 VST_CODE_ENTRY = 1, // VST_ENTRY: [valid, namechar x N]
107 VST_CODE_BBENTRY = 2 // VST_BBENTRY: [bbid, namechar x N]
111 METADATA_STRING = 1, // MDString: [values]
112 METADATA_NODE = 2 // MDNODE: [n x (type num, value num)]
114 // The constants block (CONSTANTS_BLOCK_ID) describes emission for each
115 // constant and maintains an implicit current type value.
116 enum ConstantsCodes {
117 CST_CODE_SETTYPE = 1, // SETTYPE: [typeid]
118 CST_CODE_NULL = 2, // NULL
119 CST_CODE_UNDEF = 3, // UNDEF
120 CST_CODE_INTEGER = 4, // INTEGER: [intval]
121 CST_CODE_WIDE_INTEGER = 5, // WIDE_INTEGER: [n x intval]
122 CST_CODE_FLOAT = 6, // FLOAT: [fpval]
123 CST_CODE_AGGREGATE = 7, // AGGREGATE: [n x value number]
124 CST_CODE_STRING = 8, // STRING: [values]
125 CST_CODE_CSTRING = 9, // CSTRING: [values]
126 CST_CODE_CE_BINOP = 10, // CE_BINOP: [opcode, opval, opval]
127 CST_CODE_CE_CAST = 11, // CE_CAST: [opcode, opty, opval]
128 CST_CODE_CE_GEP = 12, // CE_GEP: [n x operands]
129 CST_CODE_CE_SELECT = 13, // CE_SELECT: [opval, opval, opval]
130 CST_CODE_CE_EXTRACTELT = 14, // CE_EXTRACTELT: [opty, opval, opval]
131 CST_CODE_CE_INSERTELT = 15, // CE_INSERTELT: [opval, opval, opval]
132 CST_CODE_CE_SHUFFLEVEC = 16, // CE_SHUFFLEVEC: [opval, opval, opval]
133 CST_CODE_CE_CMP = 17, // CE_CMP: [opty, opval, opval, pred]
134 CST_CODE_INLINEASM = 18, // INLINEASM: [sideeffect,asmstr,conststr]
135 CST_CODE_CE_SHUFVEC_EX = 19, // SHUFVEC_EX: [opty, opval, opval, opval]
136 CST_CODE_CE_INBOUNDS_GEP = 20 // INBOUNDS_GEP: [n x operands]
139 /// CastOpcodes - These are values used in the bitcode files to encode which
140 /// cast a CST_CODE_CE_CAST 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.
158 /// BinaryOpcodes - These are values used in the bitcode files to encode which
159 /// binop a CST_CODE_CE_BINOP or a XXX refers to. The values of these enums
160 /// have no fixed relation to the LLVM IR enum values. Changing these will
161 /// break compatibility with old files.
167 BINOP_SDIV = 4, // overloaded for FP
169 BINOP_SREM = 6, // overloaded for FP
178 /// OverflowingBinaryOperatorOptionalFlags - Flags for serializing
179 /// OverflowingBinaryOperator's SubclassOptionalData contents.
180 enum OverflowingBinaryOperatorOptionalFlags {
181 OBO_NO_UNSIGNED_OVERFLOW = 0,
182 OBO_NO_SIGNED_OVERFLOW = 1
185 /// SDivOperatorOptionalFlags - Flags for serializing SDivOperator's
186 /// SubclassOptionalData contents.
187 enum SDivOperatorOptionalFlags {
191 // The function body block (FUNCTION_BLOCK_ID) describes function bodies. It
192 // can contain a constant block (CONSTANTS_BLOCK_ID).
194 FUNC_CODE_DECLAREBLOCKS = 1, // DECLAREBLOCKS: [n]
196 FUNC_CODE_INST_BINOP = 2, // BINOP: [opcode, ty, opval, opval]
197 FUNC_CODE_INST_CAST = 3, // CAST: [opcode, ty, opty, opval]
198 FUNC_CODE_INST_GEP = 4, // GEP: [n x operands]
199 FUNC_CODE_INST_SELECT = 5, // SELECT: [ty, opval, opval, opval]
200 FUNC_CODE_INST_EXTRACTELT = 6, // EXTRACTELT: [opty, opval, opval]
201 FUNC_CODE_INST_INSERTELT = 7, // INSERTELT: [ty, opval, opval, opval]
202 FUNC_CODE_INST_SHUFFLEVEC = 8, // SHUFFLEVEC: [ty, opval, opval, opval]
203 FUNC_CODE_INST_CMP = 9, // CMP: [opty, opval, opval, pred]
205 FUNC_CODE_INST_RET = 10, // RET: [opty,opval<both optional>]
206 FUNC_CODE_INST_BR = 11, // BR: [bb#, bb#, cond] or [bb#]
207 FUNC_CODE_INST_SWITCH = 12, // SWITCH: [opty, opval, n, n x ops]
208 FUNC_CODE_INST_INVOKE = 13, // INVOKE: [attr, fnty, op0,op1, ...]
209 FUNC_CODE_INST_UNWIND = 14, // UNWIND
210 FUNC_CODE_INST_UNREACHABLE = 15, // UNREACHABLE
212 FUNC_CODE_INST_PHI = 16, // PHI: [ty, val0,bb0, ...]
213 FUNC_CODE_INST_MALLOC = 17, // MALLOC: [instty, op, align]
214 FUNC_CODE_INST_FREE = 18, // FREE: [opty, op]
215 FUNC_CODE_INST_ALLOCA = 19, // ALLOCA: [instty, op, align]
216 FUNC_CODE_INST_LOAD = 20, // LOAD: [opty, op, align, vol]
217 // FIXME: Remove STORE in favor of STORE2 in LLVM 3.0
218 FUNC_CODE_INST_STORE = 21, // STORE: [valty,val,ptr, align, vol]
219 FUNC_CODE_INST_CALL = 22, // CALL: [attr, fnty, fnid, args...]
220 FUNC_CODE_INST_VAARG = 23, // VAARG: [valistty, valist, instty]
221 // This store code encodes the pointer type, rather than the value type
222 // this is so information only available in the pointer type (e.g. address
223 // spaces) is retained.
224 FUNC_CODE_INST_STORE2 = 24, // STORE: [ptrty,ptr,val, align, vol]
225 // FIXME: Remove GETRESULT in favor of EXTRACTVAL in LLVM 3.0
226 FUNC_CODE_INST_GETRESULT = 25, // GETRESULT: [ty, opval, n]
227 FUNC_CODE_INST_EXTRACTVAL = 26, // EXTRACTVAL: [n x operands]
228 FUNC_CODE_INST_INSERTVAL = 27, // INSERTVAL: [n x operands]
229 // fcmp/icmp returning Int1TY or vector of Int1Ty. Same as CMP, exists to
230 // support legacy vicmp/vfcmp instructions.
231 FUNC_CODE_INST_CMP2 = 28, // CMP2: [opty, opval, opval, pred]
232 // new select on i1 or [N x i1]
233 FUNC_CODE_INST_VSELECT = 29, // VSELECT: [ty,opval,opval,predty,pred]
234 FUNC_CODE_INST_INBOUNDS_GEP = 30 // INBOUNDS_GEP: [n x operands]
236 } // End bitc namespace
237 } // End llvm namespace