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,
38 METADATA_ATTACHMENT_ID
42 /// MODULE blocks have a number of optional fields and subblocks.
44 MODULE_CODE_VERSION = 1, // VERSION: [version#]
45 MODULE_CODE_TRIPLE = 2, // TRIPLE: [strchr x N]
46 MODULE_CODE_DATALAYOUT = 3, // DATALAYOUT: [strchr x N]
47 MODULE_CODE_ASM = 4, // ASM: [strchr x N]
48 MODULE_CODE_SECTIONNAME = 5, // SECTIONNAME: [strchr x N]
49 MODULE_CODE_DEPLIB = 6, // DEPLIB: [strchr x N]
51 // GLOBALVAR: [pointer type, isconst, initid,
52 // linkage, alignment, section, visibility, threadlocal]
53 MODULE_CODE_GLOBALVAR = 7,
55 // FUNCTION: [type, callingconv, isproto, linkage, paramattrs, alignment,
56 // section, visibility]
57 MODULE_CODE_FUNCTION = 8,
59 // ALIAS: [alias type, aliasee val#, linkage]
60 MODULE_CODE_ALIAS = 9,
62 /// MODULE_CODE_PURGEVALS: [numvals]
63 MODULE_CODE_PURGEVALS = 10,
65 MODULE_CODE_GCNAME = 11 // GCNAME: [strchr x N]
68 /// PARAMATTR blocks have code for defining a parameter attribute set.
70 PARAMATTR_CODE_ENTRY = 1 // ENTRY: [paramidx0, attr0, paramidx1, attr1...]
73 /// TYPE blocks have codes for each type primitive they use.
75 TYPE_CODE_NUMENTRY = 1, // NUMENTRY: [numentries]
78 TYPE_CODE_VOID = 2, // VOID
79 TYPE_CODE_FLOAT = 3, // FLOAT
80 TYPE_CODE_DOUBLE = 4, // DOUBLE
81 TYPE_CODE_LABEL = 5, // LABEL
82 TYPE_CODE_OPAQUE = 6, // OPAQUE
83 TYPE_CODE_INTEGER = 7, // INTEGER: [width]
84 TYPE_CODE_POINTER = 8, // POINTER: [pointee type]
85 TYPE_CODE_FUNCTION = 9, // FUNCTION: [vararg, retty, paramty x N]
86 TYPE_CODE_STRUCT = 10, // STRUCT: [ispacked, eltty x N]
87 TYPE_CODE_ARRAY = 11, // ARRAY: [numelts, eltty]
88 TYPE_CODE_VECTOR = 12, // VECTOR: [numelts, eltty]
90 // These are not with the other floating point types because they're
91 // a late addition, and putting them in the right place breaks
92 // binary compatibility.
93 TYPE_CODE_X86_FP80 = 13, // X86 LONG DOUBLE
94 TYPE_CODE_FP128 = 14, // LONG DOUBLE (112 bit mantissa)
95 TYPE_CODE_PPC_FP128= 15, // PPC LONG DOUBLE (2 doubles)
97 TYPE_CODE_METADATA = 16, // METADATA
99 TYPE_CODE_X86_MMX = 17 // X86 MMX
102 // The type symbol table only has one code (TST_ENTRY_CODE).
103 enum TypeSymtabCodes {
104 TST_CODE_ENTRY = 1 // TST_ENTRY: [typeid, namechar x N]
107 // The value symbol table only has one code (VST_ENTRY_CODE).
108 enum ValueSymtabCodes {
109 VST_CODE_ENTRY = 1, // VST_ENTRY: [valid, namechar x N]
110 VST_CODE_BBENTRY = 2 // VST_BBENTRY: [bbid, namechar x N]
114 METADATA_STRING = 1, // MDSTRING: [values]
115 // FIXME: Remove NODE in favor of NODE2 in LLVM 3.0
116 METADATA_NODE = 2, // NODE with potentially invalid metadata
117 // FIXME: Remove FN_NODE in favor of FN_NODE2 in LLVM 3.0
118 METADATA_FN_NODE = 3, // FN_NODE with potentially invalid metadata
119 METADATA_NAME = 4, // STRING: [values]
120 // FIXME: Remove NAMED_NODE in favor of NAMED_NODE2 in LLVM 3.0
121 METADATA_NAMED_NODE = 5, // NAMED_NODE with potentially invalid metadata
122 METADATA_KIND = 6, // [n x [id, name]]
123 // FIXME: Remove ATTACHMENT in favor of ATTACHMENT2 in LLVM 3.0
124 METADATA_ATTACHMENT = 7, // ATTACHMENT with potentially invalid metadata
125 METADATA_NODE2 = 8, // NODE2: [n x (type num, value num)]
126 METADATA_FN_NODE2 = 9, // FN_NODE2: [n x (type num, value num)]
127 METADATA_NAMED_NODE2 = 10, // NAMED_NODE2: [n x mdnodes]
128 METADATA_ATTACHMENT2 = 11 // [m x [value, [n x [id, mdnode]]]
130 // The constants block (CONSTANTS_BLOCK_ID) describes emission for each
131 // constant and maintains an implicit current type value.
132 enum ConstantsCodes {
133 CST_CODE_SETTYPE = 1, // SETTYPE: [typeid]
134 CST_CODE_NULL = 2, // NULL
135 CST_CODE_UNDEF = 3, // UNDEF
136 CST_CODE_INTEGER = 4, // INTEGER: [intval]
137 CST_CODE_WIDE_INTEGER = 5, // WIDE_INTEGER: [n x intval]
138 CST_CODE_FLOAT = 6, // FLOAT: [fpval]
139 CST_CODE_AGGREGATE = 7, // AGGREGATE: [n x value number]
140 CST_CODE_STRING = 8, // STRING: [values]
141 CST_CODE_CSTRING = 9, // CSTRING: [values]
142 CST_CODE_CE_BINOP = 10, // CE_BINOP: [opcode, opval, opval]
143 CST_CODE_CE_CAST = 11, // CE_CAST: [opcode, opty, opval]
144 CST_CODE_CE_GEP = 12, // CE_GEP: [n x operands]
145 CST_CODE_CE_SELECT = 13, // CE_SELECT: [opval, opval, opval]
146 CST_CODE_CE_EXTRACTELT = 14, // CE_EXTRACTELT: [opty, opval, opval]
147 CST_CODE_CE_INSERTELT = 15, // CE_INSERTELT: [opval, opval, opval]
148 CST_CODE_CE_SHUFFLEVEC = 16, // CE_SHUFFLEVEC: [opval, opval, opval]
149 CST_CODE_CE_CMP = 17, // CE_CMP: [opty, opval, opval, pred]
150 CST_CODE_INLINEASM = 18, // INLINEASM: [sideeffect,asmstr,conststr]
151 CST_CODE_CE_SHUFVEC_EX = 19, // SHUFVEC_EX: [opty, opval, opval, opval]
152 CST_CODE_CE_INBOUNDS_GEP = 20,// INBOUNDS_GEP: [n x operands]
153 CST_CODE_BLOCKADDRESS = 21 // CST_CODE_BLOCKADDRESS [fnty, fnval, bb#]
156 /// CastOpcodes - These are values used in the bitcode files to encode which
157 /// cast a CST_CODE_CE_CAST or a XXX refers to. The values of these enums
158 /// have no fixed relation to the LLVM IR enum values. Changing these will
159 /// break compatibility with old files.
175 /// BinaryOpcodes - These are values used in the bitcode files to encode which
176 /// binop a CST_CODE_CE_BINOP or a XXX refers to. The values of these enums
177 /// have no fixed relation to the LLVM IR enum values. Changing these will
178 /// break compatibility with old files.
184 BINOP_SDIV = 4, // overloaded for FP
186 BINOP_SREM = 6, // overloaded for FP
195 /// OverflowingBinaryOperatorOptionalFlags - Flags for serializing
196 /// OverflowingBinaryOperator's SubclassOptionalData contents.
197 enum OverflowingBinaryOperatorOptionalFlags {
198 OBO_NO_UNSIGNED_WRAP = 0,
199 OBO_NO_SIGNED_WRAP = 1
202 /// PossiblyExactOperatorOptionalFlags - Flags for serializing
203 /// PossiblyExactOperator's SubclassOptionalData contents.
204 enum PossiblyExactOperatorOptionalFlags {
208 // The function body block (FUNCTION_BLOCK_ID) describes function bodies. It
209 // can contain a constant block (CONSTANTS_BLOCK_ID).
211 FUNC_CODE_DECLAREBLOCKS = 1, // DECLAREBLOCKS: [n]
213 FUNC_CODE_INST_BINOP = 2, // BINOP: [opcode, ty, opval, opval]
214 FUNC_CODE_INST_CAST = 3, // CAST: [opcode, ty, opty, opval]
215 FUNC_CODE_INST_GEP = 4, // GEP: [n x operands]
216 FUNC_CODE_INST_SELECT = 5, // SELECT: [ty, opval, opval, opval]
217 FUNC_CODE_INST_EXTRACTELT = 6, // EXTRACTELT: [opty, opval, opval]
218 FUNC_CODE_INST_INSERTELT = 7, // INSERTELT: [ty, opval, opval, opval]
219 FUNC_CODE_INST_SHUFFLEVEC = 8, // SHUFFLEVEC: [ty, opval, opval, opval]
220 FUNC_CODE_INST_CMP = 9, // CMP: [opty, opval, opval, pred]
222 FUNC_CODE_INST_RET = 10, // RET: [opty,opval<both optional>]
223 FUNC_CODE_INST_BR = 11, // BR: [bb#, bb#, cond] or [bb#]
224 FUNC_CODE_INST_SWITCH = 12, // SWITCH: [opty, op0, op1, ...]
225 FUNC_CODE_INST_INVOKE = 13, // INVOKE: [attr, fnty, op0,op1, ...]
226 FUNC_CODE_INST_UNWIND = 14, // UNWIND
227 FUNC_CODE_INST_UNREACHABLE = 15, // UNREACHABLE
229 FUNC_CODE_INST_PHI = 16, // PHI: [ty, val0,bb0, ...]
230 FUNC_CODE_INST_MALLOC = 17, // MALLOC: [instty, op, align]
231 FUNC_CODE_INST_FREE = 18, // FREE: [opty, op]
232 FUNC_CODE_INST_ALLOCA = 19, // ALLOCA: [instty, op, align]
233 FUNC_CODE_INST_LOAD = 20, // LOAD: [opty, op, align, vol]
234 // FIXME: Remove STORE in favor of STORE2 in LLVM 3.0
235 FUNC_CODE_INST_STORE = 21, // STORE: [valty,val,ptr, align, vol]
236 // FIXME: Remove CALL in favor of CALL2 in LLVM 3.0
237 FUNC_CODE_INST_CALL = 22, // CALL with potentially invalid metadata
238 FUNC_CODE_INST_VAARG = 23, // VAARG: [valistty, valist, instty]
239 // This store code encodes the pointer type, rather than the value type
240 // this is so information only available in the pointer type (e.g. address
241 // spaces) is retained.
242 FUNC_CODE_INST_STORE2 = 24, // STORE: [ptrty,ptr,val, align, vol]
243 // FIXME: Remove GETRESULT in favor of EXTRACTVAL in LLVM 3.0
244 FUNC_CODE_INST_GETRESULT = 25, // GETRESULT: [ty, opval, n]
245 FUNC_CODE_INST_EXTRACTVAL = 26, // EXTRACTVAL: [n x operands]
246 FUNC_CODE_INST_INSERTVAL = 27, // INSERTVAL: [n x operands]
247 // fcmp/icmp returning Int1TY or vector of Int1Ty. Same as CMP, exists to
248 // support legacy vicmp/vfcmp instructions.
249 FUNC_CODE_INST_CMP2 = 28, // CMP2: [opty, opval, opval, pred]
250 // new select on i1 or [N x i1]
251 FUNC_CODE_INST_VSELECT = 29, // VSELECT: [ty,opval,opval,predty,pred]
252 FUNC_CODE_INST_INBOUNDS_GEP= 30, // INBOUNDS_GEP: [n x operands]
253 FUNC_CODE_INST_INDIRECTBR = 31, // INDIRECTBR: [opty, op0, op1, ...]
255 // FIXME: Remove DEBUG_LOC in favor of DEBUG_LOC2 in LLVM 3.0
256 FUNC_CODE_DEBUG_LOC = 32, // DEBUG_LOC with potentially invalid metadata
257 FUNC_CODE_DEBUG_LOC_AGAIN = 33, // DEBUG_LOC_AGAIN
259 FUNC_CODE_INST_CALL2 = 34, // CALL2: [attr, fnty, fnid, args...]
261 FUNC_CODE_DEBUG_LOC2 = 35 // DEBUG_LOC2: [Line,Col,ScopeVal, IAVal]
263 } // End bitc namespace
264 } // End llvm namespace