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.
32 PARAMATTR_GROUP_BLOCK_ID,
39 VALUE_SYMTAB_BLOCK_ID,
41 METADATA_ATTACHMENT_ID,
49 /// MODULE blocks have a number of optional fields and subblocks.
51 MODULE_CODE_VERSION = 1, // VERSION: [version#]
52 MODULE_CODE_TRIPLE = 2, // TRIPLE: [strchr x N]
53 MODULE_CODE_DATALAYOUT = 3, // DATALAYOUT: [strchr x N]
54 MODULE_CODE_ASM = 4, // ASM: [strchr x N]
55 MODULE_CODE_SECTIONNAME = 5, // SECTIONNAME: [strchr x N]
57 // FIXME: Remove DEPLIB in 4.0.
58 MODULE_CODE_DEPLIB = 6, // DEPLIB: [strchr x N]
60 // GLOBALVAR: [pointer type, isconst, initid,
61 // linkage, alignment, section, visibility, threadlocal]
62 MODULE_CODE_GLOBALVAR = 7,
64 // FUNCTION: [type, callingconv, isproto, linkage, paramattrs, alignment,
65 // section, visibility, gc, unnamed_addr]
66 MODULE_CODE_FUNCTION = 8,
68 // ALIAS: [alias type, aliasee val#, linkage, visibility]
69 MODULE_CODE_ALIAS = 9,
71 // MODULE_CODE_PURGEVALS: [numvals]
72 MODULE_CODE_PURGEVALS = 10,
74 MODULE_CODE_GCNAME = 11, // GCNAME: [strchr x N]
75 MODULE_CODE_COMDAT = 12, // COMDAT: [selection_kind, name]
78 /// PARAMATTR blocks have code for defining a parameter attribute set.
80 // FIXME: Remove `PARAMATTR_CODE_ENTRY_OLD' in 4.0
81 PARAMATTR_CODE_ENTRY_OLD = 1, // ENTRY: [paramidx0, attr0,
82 // paramidx1, attr1...]
83 PARAMATTR_CODE_ENTRY = 2, // ENTRY: [paramidx0, attrgrp0,
84 // paramidx1, attrgrp1, ...]
85 PARAMATTR_GRP_CODE_ENTRY = 3 // ENTRY: [id, attr0, att1, ...]
88 /// TYPE blocks have codes for each type primitive they use.
90 TYPE_CODE_NUMENTRY = 1, // NUMENTRY: [numentries]
93 TYPE_CODE_VOID = 2, // VOID
94 TYPE_CODE_FLOAT = 3, // FLOAT
95 TYPE_CODE_DOUBLE = 4, // DOUBLE
96 TYPE_CODE_LABEL = 5, // LABEL
97 TYPE_CODE_OPAQUE = 6, // OPAQUE
98 TYPE_CODE_INTEGER = 7, // INTEGER: [width]
99 TYPE_CODE_POINTER = 8, // POINTER: [pointee type]
101 TYPE_CODE_FUNCTION_OLD = 9, // FUNCTION: [vararg, attrid, retty,
104 TYPE_CODE_HALF = 10, // HALF
106 TYPE_CODE_ARRAY = 11, // ARRAY: [numelts, eltty]
107 TYPE_CODE_VECTOR = 12, // VECTOR: [numelts, eltty]
109 // These are not with the other floating point types because they're
110 // a late addition, and putting them in the right place breaks
111 // binary compatibility.
112 TYPE_CODE_X86_FP80 = 13, // X86 LONG DOUBLE
113 TYPE_CODE_FP128 = 14, // LONG DOUBLE (112 bit mantissa)
114 TYPE_CODE_PPC_FP128= 15, // PPC LONG DOUBLE (2 doubles)
116 TYPE_CODE_METADATA = 16, // METADATA
118 TYPE_CODE_X86_MMX = 17, // X86 MMX
120 TYPE_CODE_STRUCT_ANON = 18, // STRUCT_ANON: [ispacked, eltty x N]
121 TYPE_CODE_STRUCT_NAME = 19, // STRUCT_NAME: [strchr x N]
122 TYPE_CODE_STRUCT_NAMED = 20,// STRUCT_NAMED: [ispacked, eltty x N]
124 TYPE_CODE_FUNCTION = 21, // FUNCTION: [vararg, retty, paramty x N]
126 TYPE_CODE_TOKEN = 22 // TOKEN
129 // The type symbol table only has one code (TST_ENTRY_CODE).
130 enum TypeSymtabCodes {
131 TST_CODE_ENTRY = 1 // TST_ENTRY: [typeid, namechar x N]
134 // The value symbol table only has one code (VST_ENTRY_CODE).
135 enum ValueSymtabCodes {
136 VST_CODE_ENTRY = 1, // VST_ENTRY: [valid, namechar x N]
137 VST_CODE_BBENTRY = 2 // VST_BBENTRY: [bbid, namechar x N]
141 METADATA_STRING = 1, // MDSTRING: [values]
142 METADATA_VALUE = 2, // VALUE: [type num, value num]
143 METADATA_NODE = 3, // NODE: [n x md num]
144 METADATA_NAME = 4, // STRING: [values]
145 METADATA_DISTINCT_NODE = 5, // DISTINCT_NODE: [n x md num]
146 METADATA_KIND = 6, // [n x [id, name]]
147 METADATA_LOCATION = 7, // [distinct, line, col, scope, inlined-at?]
148 METADATA_OLD_NODE = 8, // OLD_NODE: [n x (type num, value num)]
149 METADATA_OLD_FN_NODE = 9, // OLD_FN_NODE: [n x (type num, value num)]
150 METADATA_NAMED_NODE = 10, // NAMED_NODE: [n x mdnodes]
151 METADATA_ATTACHMENT = 11, // [m x [value, [n x [id, mdnode]]]
152 METADATA_GENERIC_DEBUG = 12, // [distinct, tag, vers, header, n x md num]
153 METADATA_SUBRANGE = 13, // [distinct, count, lo]
154 METADATA_ENUMERATOR = 14, // [distinct, value, name]
155 METADATA_BASIC_TYPE = 15, // [distinct, tag, name, size, align, enc]
156 METADATA_FILE = 16, // [distinct, filename, directory]
157 METADATA_DERIVED_TYPE = 17, // [distinct, ...]
158 METADATA_COMPOSITE_TYPE= 18, // [distinct, ...]
159 METADATA_SUBROUTINE_TYPE=19, // [distinct, flags, types]
160 METADATA_COMPILE_UNIT = 20, // [distinct, ...]
161 METADATA_SUBPROGRAM = 21, // [distinct, ...]
162 METADATA_LEXICAL_BLOCK = 22, // [distinct, scope, file, line, column]
163 METADATA_LEXICAL_BLOCK_FILE=23,//[distinct, scope, file, discriminator]
164 METADATA_NAMESPACE = 24, // [distinct, scope, file, name, line]
165 METADATA_TEMPLATE_TYPE = 25, // [distinct, scope, name, type, ...]
166 METADATA_TEMPLATE_VALUE= 26, // [distinct, scope, name, type, value, ...]
167 METADATA_GLOBAL_VAR = 27, // [distinct, ...]
168 METADATA_LOCAL_VAR = 28, // [distinct, ...]
169 METADATA_EXPRESSION = 29, // [distinct, n x element]
170 METADATA_OBJC_PROPERTY = 30, // [distinct, name, file, line, ...]
171 METADATA_IMPORTED_ENTITY=31, // [distinct, tag, scope, entity, line, name]
172 METADATA_MODULE=32, // [distinct, scope, name, ...]
175 // The constants block (CONSTANTS_BLOCK_ID) describes emission for each
176 // constant and maintains an implicit current type value.
177 enum ConstantsCodes {
178 CST_CODE_SETTYPE = 1, // SETTYPE: [typeid]
179 CST_CODE_NULL = 2, // NULL
180 CST_CODE_UNDEF = 3, // UNDEF
181 CST_CODE_INTEGER = 4, // INTEGER: [intval]
182 CST_CODE_WIDE_INTEGER = 5, // WIDE_INTEGER: [n x intval]
183 CST_CODE_FLOAT = 6, // FLOAT: [fpval]
184 CST_CODE_AGGREGATE = 7, // AGGREGATE: [n x value number]
185 CST_CODE_STRING = 8, // STRING: [values]
186 CST_CODE_CSTRING = 9, // CSTRING: [values]
187 CST_CODE_CE_BINOP = 10, // CE_BINOP: [opcode, opval, opval]
188 CST_CODE_CE_CAST = 11, // CE_CAST: [opcode, opty, opval]
189 CST_CODE_CE_GEP = 12, // CE_GEP: [n x operands]
190 CST_CODE_CE_SELECT = 13, // CE_SELECT: [opval, opval, opval]
191 CST_CODE_CE_EXTRACTELT = 14, // CE_EXTRACTELT: [opty, opval, opval]
192 CST_CODE_CE_INSERTELT = 15, // CE_INSERTELT: [opval, opval, opval]
193 CST_CODE_CE_SHUFFLEVEC = 16, // CE_SHUFFLEVEC: [opval, opval, opval]
194 CST_CODE_CE_CMP = 17, // CE_CMP: [opty, opval, opval, pred]
195 CST_CODE_INLINEASM_OLD = 18, // INLINEASM: [sideeffect|alignstack,
197 CST_CODE_CE_SHUFVEC_EX = 19, // SHUFVEC_EX: [opty, opval, opval, opval]
198 CST_CODE_CE_INBOUNDS_GEP = 20,// INBOUNDS_GEP: [n x operands]
199 CST_CODE_BLOCKADDRESS = 21, // CST_CODE_BLOCKADDRESS [fnty, fnval, bb#]
200 CST_CODE_DATA = 22, // DATA: [n x elements]
201 CST_CODE_INLINEASM = 23 // INLINEASM: [sideeffect|alignstack|
202 // asmdialect,asmstr,conststr]
205 /// CastOpcodes - These are values used in the bitcode files to encode which
206 /// cast a CST_CODE_CE_CAST or a XXX refers to. The values of these enums
207 /// have no fixed relation to the LLVM IR enum values. Changing these will
208 /// break compatibility with old files.
222 CAST_ADDRSPACECAST = 12
225 /// BinaryOpcodes - These are values used in the bitcode files to encode which
226 /// binop a CST_CODE_CE_BINOP or a XXX refers to. The values of these enums
227 /// have no fixed relation to the LLVM IR enum values. Changing these will
228 /// break compatibility with old files.
234 BINOP_SDIV = 4, // overloaded for FP
236 BINOP_SREM = 6, // overloaded for FP
245 /// These are values used in the bitcode files to encode AtomicRMW operations.
246 /// The values of these enums have no fixed relation to the LLVM IR enum
247 /// values. Changing these will break compatibility with old files.
262 /// OverflowingBinaryOperatorOptionalFlags - Flags for serializing
263 /// OverflowingBinaryOperator's SubclassOptionalData contents.
264 enum OverflowingBinaryOperatorOptionalFlags {
265 OBO_NO_UNSIGNED_WRAP = 0,
266 OBO_NO_SIGNED_WRAP = 1
269 /// PossiblyExactOperatorOptionalFlags - Flags for serializing
270 /// PossiblyExactOperator's SubclassOptionalData contents.
271 enum PossiblyExactOperatorOptionalFlags {
275 /// Encoded AtomicOrdering values.
276 enum AtomicOrderingCodes {
277 ORDERING_NOTATOMIC = 0,
278 ORDERING_UNORDERED = 1,
279 ORDERING_MONOTONIC = 2,
280 ORDERING_ACQUIRE = 3,
281 ORDERING_RELEASE = 4,
286 /// Encoded SynchronizationScope values.
287 enum AtomicSynchScopeCodes {
288 SYNCHSCOPE_SINGLETHREAD = 0,
289 SYNCHSCOPE_CROSSTHREAD = 1
292 // The function body block (FUNCTION_BLOCK_ID) describes function bodies. It
293 // can contain a constant block (CONSTANTS_BLOCK_ID).
295 FUNC_CODE_DECLAREBLOCKS = 1, // DECLAREBLOCKS: [n]
297 FUNC_CODE_INST_BINOP = 2, // BINOP: [opcode, ty, opval, opval]
298 FUNC_CODE_INST_CAST = 3, // CAST: [opcode, ty, opty, opval]
299 FUNC_CODE_INST_GEP_OLD = 4, // GEP: [n x operands]
300 FUNC_CODE_INST_SELECT = 5, // SELECT: [ty, opval, opval, opval]
301 FUNC_CODE_INST_EXTRACTELT = 6, // EXTRACTELT: [opty, opval, opval]
302 FUNC_CODE_INST_INSERTELT = 7, // INSERTELT: [ty, opval, opval, opval]
303 FUNC_CODE_INST_SHUFFLEVEC = 8, // SHUFFLEVEC: [ty, opval, opval, opval]
304 FUNC_CODE_INST_CMP = 9, // CMP: [opty, opval, opval, pred]
306 FUNC_CODE_INST_RET = 10, // RET: [opty,opval<both optional>]
307 FUNC_CODE_INST_BR = 11, // BR: [bb#, bb#, cond] or [bb#]
308 FUNC_CODE_INST_SWITCH = 12, // SWITCH: [opty, op0, op1, ...]
309 FUNC_CODE_INST_INVOKE = 13, // INVOKE: [attr, fnty, op0,op1, ...]
311 FUNC_CODE_INST_UNREACHABLE = 15, // UNREACHABLE
313 FUNC_CODE_INST_PHI = 16, // PHI: [ty, val0,bb0, ...]
316 FUNC_CODE_INST_ALLOCA = 19, // ALLOCA: [instty, opty, op, align]
317 FUNC_CODE_INST_LOAD = 20, // LOAD: [opty, op, align, vol]
320 FUNC_CODE_INST_VAARG = 23, // VAARG: [valistty, valist, instty]
321 // This store code encodes the pointer type, rather than the value type
322 // this is so information only available in the pointer type (e.g. address
323 // spaces) is retained.
324 FUNC_CODE_INST_STORE_OLD = 24, // STORE: [ptrty,ptr,val, align, vol]
326 FUNC_CODE_INST_EXTRACTVAL = 26, // EXTRACTVAL: [n x operands]
327 FUNC_CODE_INST_INSERTVAL = 27, // INSERTVAL: [n x operands]
328 // fcmp/icmp returning Int1TY or vector of Int1Ty. Same as CMP, exists to
329 // support legacy vicmp/vfcmp instructions.
330 FUNC_CODE_INST_CMP2 = 28, // CMP2: [opty, opval, opval, pred]
331 // new select on i1 or [N x i1]
332 FUNC_CODE_INST_VSELECT = 29, // VSELECT: [ty,opval,opval,predty,pred]
333 FUNC_CODE_INST_INBOUNDS_GEP_OLD = 30, // INBOUNDS_GEP: [n x operands]
334 FUNC_CODE_INST_INDIRECTBR = 31, // INDIRECTBR: [opty, op0, op1, ...]
336 FUNC_CODE_DEBUG_LOC_AGAIN = 33, // DEBUG_LOC_AGAIN
338 FUNC_CODE_INST_CALL = 34, // CALL: [attr, cc, fnty, fnid, args...]
340 FUNC_CODE_DEBUG_LOC = 35, // DEBUG_LOC: [Line,Col,ScopeVal, IAVal]
341 FUNC_CODE_INST_FENCE = 36, // FENCE: [ordering, synchscope]
342 FUNC_CODE_INST_CMPXCHG_OLD = 37, // CMPXCHG: [ptrty,ptr,cmp,new, align, vol,
343 // ordering, synchscope]
344 FUNC_CODE_INST_ATOMICRMW = 38, // ATOMICRMW: [ptrty,ptr,val, operation,
346 // ordering, synchscope]
347 FUNC_CODE_INST_RESUME = 39, // RESUME: [opval]
348 FUNC_CODE_INST_LANDINGPAD_OLD = 40, // LANDINGPAD: [ty,val,val,num,id0,val0...]
349 FUNC_CODE_INST_LOADATOMIC = 41, // LOAD: [opty, op, align, vol,
350 // ordering, synchscope]
351 FUNC_CODE_INST_STOREATOMIC_OLD = 42, // STORE: [ptrty,ptr,val, align, vol
352 // ordering, synchscope]
353 FUNC_CODE_INST_GEP = 43, // GEP: [inbounds, n x operands]
354 FUNC_CODE_INST_STORE = 44, // STORE: [ptrty,ptr,valty,val, align, vol]
355 FUNC_CODE_INST_STOREATOMIC = 45, // STORE: [ptrty,ptr,val, align, vol
356 FUNC_CODE_INST_CMPXCHG = 46, // CMPXCHG: [ptrty,ptr,valty,cmp,new, align,
357 // vol,ordering,synchscope]
358 FUNC_CODE_INST_LANDINGPAD = 47, // LANDINGPAD: [ty,val,num,id0,val0...]
359 FUNC_CODE_INST_CLEANUPRET = 48, // CLEANUPRET: [] or [val] or [bb#] or [val,bb#]
360 FUNC_CODE_INST_CATCHRET = 49, // CATCHRET: [bb#]
361 FUNC_CODE_INST_CATCHPAD = 50, // CATCHPAD: [ty,val,val,num,args...]
362 FUNC_CODE_INST_TERMINATEPAD = 51, // TERMINATEPAD: [bb#,num,args...]
363 FUNC_CODE_INST_CLEANUPPAD = 52, // CLEANUPPAD: [num,args...]
364 FUNC_CODE_INST_CATCHENDPAD = 53, // CATCHENDPAD: [] or [bb#]
368 USELIST_CODE_DEFAULT = 1, // DEFAULT: [index..., value-id]
369 USELIST_CODE_BB = 2 // BB: [index..., bb-id]
372 enum AttributeKindCodes {
374 ATTR_KIND_ALIGNMENT = 1,
375 ATTR_KIND_ALWAYS_INLINE = 2,
376 ATTR_KIND_BY_VAL = 3,
377 ATTR_KIND_INLINE_HINT = 4,
378 ATTR_KIND_IN_REG = 5,
379 ATTR_KIND_MIN_SIZE = 6,
382 ATTR_KIND_NO_ALIAS = 9,
383 ATTR_KIND_NO_BUILTIN = 10,
384 ATTR_KIND_NO_CAPTURE = 11,
385 ATTR_KIND_NO_DUPLICATE = 12,
386 ATTR_KIND_NO_IMPLICIT_FLOAT = 13,
387 ATTR_KIND_NO_INLINE = 14,
388 ATTR_KIND_NON_LAZY_BIND = 15,
389 ATTR_KIND_NO_RED_ZONE = 16,
390 ATTR_KIND_NO_RETURN = 17,
391 ATTR_KIND_NO_UNWIND = 18,
392 ATTR_KIND_OPTIMIZE_FOR_SIZE = 19,
393 ATTR_KIND_READ_NONE = 20,
394 ATTR_KIND_READ_ONLY = 21,
395 ATTR_KIND_RETURNED = 22,
396 ATTR_KIND_RETURNS_TWICE = 23,
397 ATTR_KIND_S_EXT = 24,
398 ATTR_KIND_STACK_ALIGNMENT = 25,
399 ATTR_KIND_STACK_PROTECT = 26,
400 ATTR_KIND_STACK_PROTECT_REQ = 27,
401 ATTR_KIND_STACK_PROTECT_STRONG = 28,
402 ATTR_KIND_STRUCT_RET = 29,
403 ATTR_KIND_SANITIZE_ADDRESS = 30,
404 ATTR_KIND_SANITIZE_THREAD = 31,
405 ATTR_KIND_SANITIZE_MEMORY = 32,
406 ATTR_KIND_UW_TABLE = 33,
407 ATTR_KIND_Z_EXT = 34,
408 ATTR_KIND_BUILTIN = 35,
410 ATTR_KIND_OPTIMIZE_NONE = 37,
411 ATTR_KIND_IN_ALLOCA = 38,
412 ATTR_KIND_NON_NULL = 39,
413 ATTR_KIND_JUMP_TABLE = 40,
414 ATTR_KIND_DEREFERENCEABLE = 41,
415 ATTR_KIND_DEREFERENCEABLE_OR_NULL = 42,
416 ATTR_KIND_CONVERGENT = 43,
417 ATTR_KIND_SAFESTACK = 44,
418 ATTR_KIND_ARGMEMONLY = 45,
419 ATTR_KIND_SWIFT_SELF = 46,
420 ATTR_KIND_SWIFT_ERROR = 47
423 enum ComdatSelectionKindCodes {
424 COMDAT_SELECTION_KIND_ANY = 1,
425 COMDAT_SELECTION_KIND_EXACT_MATCH = 2,
426 COMDAT_SELECTION_KIND_LARGEST = 3,
427 COMDAT_SELECTION_KIND_NO_DUPLICATES = 4,
428 COMDAT_SELECTION_KIND_SAME_SIZE = 5,
431 } // End bitc namespace
432 } // End llvm namespace