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