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