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.
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.
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,
44 VALUE_SYMTAB_BLOCK_ID,
46 METADATA_ATTACHMENT_ID,
52 /// MODULE blocks have a number of optional fields and subblocks.
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]
61 // GLOBALVAR: [pointer type, isconst, initid,
62 // linkage, alignment, section, visibility, threadlocal]
63 MODULE_CODE_GLOBALVAR = 7,
65 // FUNCTION: [type, callingconv, isproto, linkage, paramattrs, alignment,
66 // section, visibility]
67 MODULE_CODE_FUNCTION = 8,
69 // ALIAS: [alias type, aliasee val#, linkage]
70 MODULE_CODE_ALIAS = 9,
72 /// MODULE_CODE_PURGEVALS: [numvals]
73 MODULE_CODE_PURGEVALS = 10,
75 MODULE_CODE_GCNAME = 11 // GCNAME: [strchr x N]
78 /// PARAMATTR blocks have code for defining a parameter attribute set.
80 PARAMATTR_CODE_ENTRY = 1 // ENTRY: [paramidx0, attr0, paramidx1, attr1...]
83 /// TYPE blocks have codes for each type primitive they use.
85 TYPE_CODE_NUMENTRY = 1, // NUMENTRY: [numentries]
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]
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]
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)
110 TYPE_CODE_METADATA = 16, // METADATA
112 TYPE_CODE_X86_MMX = 17, // X86 MMX
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]
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]
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]
131 METADATA_STRING = 1, // MDSTRING: [values]
134 METADATA_NAME = 4, // STRING: [values]
136 METADATA_KIND = 6, // [n x [id, name]]
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]]]
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#]
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.
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.
197 BINOP_SDIV = 4, // overloaded for FP
199 BINOP_SREM = 6, // overloaded for FP
208 /// OverflowingBinaryOperatorOptionalFlags - Flags for serializing
209 /// OverflowingBinaryOperator's SubclassOptionalData contents.
210 enum OverflowingBinaryOperatorOptionalFlags {
211 OBO_NO_UNSIGNED_WRAP = 0,
212 OBO_NO_SIGNED_WRAP = 1
215 /// PossiblyExactOperatorOptionalFlags - Flags for serializing
216 /// PossiblyExactOperator's SubclassOptionalData contents.
217 enum PossiblyExactOperatorOptionalFlags {
221 // The function body block (FUNCTION_BLOCK_ID) describes function bodies. It
222 // can contain a constant block (CONSTANTS_BLOCK_ID).
224 FUNC_CODE_DECLAREBLOCKS = 1, // DECLAREBLOCKS: [n]
226 FUNC_CODE_INST_BINOP = 2, // BINOP: [opcode, ty, opval, opval]
227 FUNC_CODE_INST_CAST = 3, // CAST: [opcode, ty, opty, opval]
228 FUNC_CODE_INST_GEP = 4, // GEP: [n x operands]
229 FUNC_CODE_INST_SELECT = 5, // SELECT: [ty, opval, opval, opval]
230 FUNC_CODE_INST_EXTRACTELT = 6, // EXTRACTELT: [opty, opval, opval]
231 FUNC_CODE_INST_INSERTELT = 7, // INSERTELT: [ty, opval, opval, opval]
232 FUNC_CODE_INST_SHUFFLEVEC = 8, // SHUFFLEVEC: [ty, opval, opval, opval]
233 FUNC_CODE_INST_CMP = 9, // CMP: [opty, opval, opval, pred]
235 FUNC_CODE_INST_RET = 10, // RET: [opty,opval<both optional>]
236 FUNC_CODE_INST_BR = 11, // BR: [bb#, bb#, cond] or [bb#]
237 FUNC_CODE_INST_SWITCH = 12, // SWITCH: [opty, op0, op1, ...]
238 FUNC_CODE_INST_INVOKE = 13, // INVOKE: [attr, fnty, op0,op1, ...]
239 FUNC_CODE_INST_UNWIND = 14, // UNWIND
240 FUNC_CODE_INST_UNREACHABLE = 15, // UNREACHABLE
242 FUNC_CODE_INST_PHI = 16, // PHI: [ty, val0,bb0, ...]
245 FUNC_CODE_INST_ALLOCA = 19, // ALLOCA: [instty, op, align]
246 FUNC_CODE_INST_LOAD = 20, // LOAD: [opty, op, align, vol]
249 FUNC_CODE_INST_VAARG = 23, // VAARG: [valistty, valist, instty]
250 // This store code encodes the pointer type, rather than the value type
251 // this is so information only available in the pointer type (e.g. address
252 // spaces) is retained.
253 FUNC_CODE_INST_STORE = 24, // STORE: [ptrty,ptr,val, align, vol]
255 FUNC_CODE_INST_EXTRACTVAL = 26, // EXTRACTVAL: [n x operands]
256 FUNC_CODE_INST_INSERTVAL = 27, // INSERTVAL: [n x operands]
257 // fcmp/icmp returning Int1TY or vector of Int1Ty. Same as CMP, exists to
258 // support legacy vicmp/vfcmp instructions.
259 FUNC_CODE_INST_CMP2 = 28, // CMP2: [opty, opval, opval, pred]
260 // new select on i1 or [N x i1]
261 FUNC_CODE_INST_VSELECT = 29, // VSELECT: [ty,opval,opval,predty,pred]
262 FUNC_CODE_INST_INBOUNDS_GEP= 30, // INBOUNDS_GEP: [n x operands]
263 FUNC_CODE_INST_INDIRECTBR = 31, // INDIRECTBR: [opty, op0, op1, ...]
265 FUNC_CODE_DEBUG_LOC_AGAIN = 33, // DEBUG_LOC_AGAIN
267 FUNC_CODE_INST_CALL = 34, // CALL: [attr, fnty, fnid, args...]
269 FUNC_CODE_DEBUG_LOC = 35 // DEBUG_LOC: [Line,Col,ScopeVal, IAVal]
271 } // End bitc namespace
272 } // End llvm namespace