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,
37 // Block intended to contains information on the bitcode versioning.
38 // Can be used to provide better error messages when we fail to parse a
40 IDENTIFICATION_BLOCK_ID,
42 VALUE_SYMTAB_BLOCK_ID,
44 METADATA_ATTACHMENT_ID,
50 MODULE_STRTAB_BLOCK_ID,
51 FUNCTION_SUMMARY_BLOCK_ID,
53 OPERAND_BUNDLE_TAGS_BLOCK_ID
56 /// Identification block contains a string that describes the producer details,
57 /// and an epoch that defines the auto-upgrade capability.
58 enum IdentificationCodes {
59 IDENTIFICATION_CODE_STRING = 1, // IDENTIFICATION: [strchr x N]
60 IDENTIFICATION_CODE_EPOCH = 2, // EPOCH: [epoch#]
63 /// The epoch that defines the auto-upgrade compatibility for the bitcode.
65 /// LLVM guarantees in a major release that a minor release can read bitcode
66 /// generated by previous minor releases. We translate this by making the reader
67 /// accepting only bitcode with the same epoch, except for the X.0 release which
69 enum { BITCODE_CURRENT_EPOCH = 0 };
71 /// MODULE blocks have a number of optional fields and subblocks.
73 MODULE_CODE_VERSION = 1, // VERSION: [version#]
74 MODULE_CODE_TRIPLE = 2, // TRIPLE: [strchr x N]
75 MODULE_CODE_DATALAYOUT = 3, // DATALAYOUT: [strchr x N]
76 MODULE_CODE_ASM = 4, // ASM: [strchr x N]
77 MODULE_CODE_SECTIONNAME = 5, // SECTIONNAME: [strchr x N]
79 // FIXME: Remove DEPLIB in 4.0.
80 MODULE_CODE_DEPLIB = 6, // DEPLIB: [strchr x N]
82 // GLOBALVAR: [pointer type, isconst, initid,
83 // linkage, alignment, section, visibility, threadlocal]
84 MODULE_CODE_GLOBALVAR = 7,
86 // FUNCTION: [type, callingconv, isproto, linkage, paramattrs, alignment,
87 // section, visibility, gc, unnamed_addr]
88 MODULE_CODE_FUNCTION = 8,
90 // ALIAS: [alias type, aliasee val#, linkage, visibility]
91 MODULE_CODE_ALIAS_OLD = 9,
93 // MODULE_CODE_PURGEVALS: [numvals]
94 MODULE_CODE_PURGEVALS = 10,
96 MODULE_CODE_GCNAME = 11, // GCNAME: [strchr x N]
97 MODULE_CODE_COMDAT = 12, // COMDAT: [selection_kind, name]
99 MODULE_CODE_VSTOFFSET = 13, // VSTOFFSET: [offset]
101 // ALIAS: [alias value type, addrspace, aliasee val#, linkage, visibility]
102 MODULE_CODE_ALIAS = 14,
105 /// PARAMATTR blocks have code for defining a parameter attribute set.
106 enum AttributeCodes {
107 // FIXME: Remove `PARAMATTR_CODE_ENTRY_OLD' in 4.0
108 PARAMATTR_CODE_ENTRY_OLD = 1, // ENTRY: [paramidx0, attr0,
109 // paramidx1, attr1...]
110 PARAMATTR_CODE_ENTRY = 2, // ENTRY: [paramidx0, attrgrp0,
111 // paramidx1, attrgrp1, ...]
112 PARAMATTR_GRP_CODE_ENTRY = 3 // ENTRY: [id, attr0, att1, ...]
115 /// TYPE blocks have codes for each type primitive they use.
117 TYPE_CODE_NUMENTRY = 1, // NUMENTRY: [numentries]
120 TYPE_CODE_VOID = 2, // VOID
121 TYPE_CODE_FLOAT = 3, // FLOAT
122 TYPE_CODE_DOUBLE = 4, // DOUBLE
123 TYPE_CODE_LABEL = 5, // LABEL
124 TYPE_CODE_OPAQUE = 6, // OPAQUE
125 TYPE_CODE_INTEGER = 7, // INTEGER: [width]
126 TYPE_CODE_POINTER = 8, // POINTER: [pointee type]
128 TYPE_CODE_FUNCTION_OLD = 9, // FUNCTION: [vararg, attrid, retty,
131 TYPE_CODE_HALF = 10, // HALF
133 TYPE_CODE_ARRAY = 11, // ARRAY: [numelts, eltty]
134 TYPE_CODE_VECTOR = 12, // VECTOR: [numelts, eltty]
136 // These are not with the other floating point types because they're
137 // a late addition, and putting them in the right place breaks
138 // binary compatibility.
139 TYPE_CODE_X86_FP80 = 13, // X86 LONG DOUBLE
140 TYPE_CODE_FP128 = 14, // LONG DOUBLE (112 bit mantissa)
141 TYPE_CODE_PPC_FP128= 15, // PPC LONG DOUBLE (2 doubles)
143 TYPE_CODE_METADATA = 16, // METADATA
145 TYPE_CODE_X86_MMX = 17, // X86 MMX
147 TYPE_CODE_STRUCT_ANON = 18, // STRUCT_ANON: [ispacked, eltty x N]
148 TYPE_CODE_STRUCT_NAME = 19, // STRUCT_NAME: [strchr x N]
149 TYPE_CODE_STRUCT_NAMED = 20,// STRUCT_NAMED: [ispacked, eltty x N]
151 TYPE_CODE_FUNCTION = 21, // FUNCTION: [vararg, retty, paramty x N]
153 TYPE_CODE_TOKEN = 22 // TOKEN
156 enum OperandBundleTagCode {
157 OPERAND_BUNDLE_TAG = 1, // TAG: [strchr x N]
160 // The type symbol table only has one code (TST_ENTRY_CODE).
161 enum TypeSymtabCodes {
162 TST_CODE_ENTRY = 1 // TST_ENTRY: [typeid, namechar x N]
165 // Value symbol table codes.
166 enum ValueSymtabCodes {
167 VST_CODE_ENTRY = 1, // VST_ENTRY: [valueid, namechar x N]
168 VST_CODE_BBENTRY = 2, // VST_BBENTRY: [bbid, namechar x N]
169 VST_CODE_FNENTRY = 3, // VST_FNENTRY: [valueid, offset, namechar x N]
170 // VST_COMBINED_FNENTRY: [offset, namechar x N]
171 VST_CODE_COMBINED_FNENTRY = 4
174 // The module path symbol table only has one code (MST_CODE_ENTRY).
175 enum ModulePathSymtabCodes {
176 MST_CODE_ENTRY = 1, // MST_ENTRY: [modid, namechar x N]
179 // The function summary section uses different codes in the per-module
180 // and combined index cases.
181 enum FunctionSummarySymtabCodes {
182 FS_CODE_PERMODULE_ENTRY = 1, // FS_ENTRY: [valueid, islocal, instcount]
183 FS_CODE_COMBINED_ENTRY = 2, // FS_ENTRY: [modid, instcount]
187 METADATA_STRING = 1, // MDSTRING: [values]
188 METADATA_VALUE = 2, // VALUE: [type num, value num]
189 METADATA_NODE = 3, // NODE: [n x md num]
190 METADATA_NAME = 4, // STRING: [values]
191 METADATA_DISTINCT_NODE = 5, // DISTINCT_NODE: [n x md num]
192 METADATA_KIND = 6, // [n x [id, name]]
193 METADATA_LOCATION = 7, // [distinct, line, col, scope, inlined-at?]
194 METADATA_OLD_NODE = 8, // OLD_NODE: [n x (type num, value num)]
195 METADATA_OLD_FN_NODE = 9, // OLD_FN_NODE: [n x (type num, value num)]
196 METADATA_NAMED_NODE = 10, // NAMED_NODE: [n x mdnodes]
197 METADATA_ATTACHMENT = 11, // [m x [value, [n x [id, mdnode]]]
198 METADATA_GENERIC_DEBUG = 12, // [distinct, tag, vers, header, n x md num]
199 METADATA_SUBRANGE = 13, // [distinct, count, lo]
200 METADATA_ENUMERATOR = 14, // [distinct, value, name]
201 METADATA_BASIC_TYPE = 15, // [distinct, tag, name, size, align, enc]
202 METADATA_FILE = 16, // [distinct, filename, directory]
203 METADATA_DERIVED_TYPE = 17, // [distinct, ...]
204 METADATA_COMPOSITE_TYPE= 18, // [distinct, ...]
205 METADATA_SUBROUTINE_TYPE=19, // [distinct, flags, types]
206 METADATA_COMPILE_UNIT = 20, // [distinct, ...]
207 METADATA_SUBPROGRAM = 21, // [distinct, ...]
208 METADATA_LEXICAL_BLOCK = 22, // [distinct, scope, file, line, column]
209 METADATA_LEXICAL_BLOCK_FILE=23,//[distinct, scope, file, discriminator]
210 METADATA_NAMESPACE = 24, // [distinct, scope, file, name, line]
211 METADATA_TEMPLATE_TYPE = 25, // [distinct, scope, name, type, ...]
212 METADATA_TEMPLATE_VALUE= 26, // [distinct, scope, name, type, value, ...]
213 METADATA_GLOBAL_VAR = 27, // [distinct, ...]
214 METADATA_LOCAL_VAR = 28, // [distinct, ...]
215 METADATA_EXPRESSION = 29, // [distinct, n x element]
216 METADATA_OBJC_PROPERTY = 30, // [distinct, name, file, line, ...]
217 METADATA_IMPORTED_ENTITY=31, // [distinct, tag, scope, entity, line, name]
218 METADATA_MODULE=32, // [distinct, scope, name, ...]
221 // The constants block (CONSTANTS_BLOCK_ID) describes emission for each
222 // constant and maintains an implicit current type value.
223 enum ConstantsCodes {
224 CST_CODE_SETTYPE = 1, // SETTYPE: [typeid]
225 CST_CODE_NULL = 2, // NULL
226 CST_CODE_UNDEF = 3, // UNDEF
227 CST_CODE_INTEGER = 4, // INTEGER: [intval]
228 CST_CODE_WIDE_INTEGER = 5, // WIDE_INTEGER: [n x intval]
229 CST_CODE_FLOAT = 6, // FLOAT: [fpval]
230 CST_CODE_AGGREGATE = 7, // AGGREGATE: [n x value number]
231 CST_CODE_STRING = 8, // STRING: [values]
232 CST_CODE_CSTRING = 9, // CSTRING: [values]
233 CST_CODE_CE_BINOP = 10, // CE_BINOP: [opcode, opval, opval]
234 CST_CODE_CE_CAST = 11, // CE_CAST: [opcode, opty, opval]
235 CST_CODE_CE_GEP = 12, // CE_GEP: [n x operands]
236 CST_CODE_CE_SELECT = 13, // CE_SELECT: [opval, opval, opval]
237 CST_CODE_CE_EXTRACTELT = 14, // CE_EXTRACTELT: [opty, opval, opval]
238 CST_CODE_CE_INSERTELT = 15, // CE_INSERTELT: [opval, opval, opval]
239 CST_CODE_CE_SHUFFLEVEC = 16, // CE_SHUFFLEVEC: [opval, opval, opval]
240 CST_CODE_CE_CMP = 17, // CE_CMP: [opty, opval, opval, pred]
241 CST_CODE_INLINEASM_OLD = 18, // INLINEASM: [sideeffect|alignstack,
243 CST_CODE_CE_SHUFVEC_EX = 19, // SHUFVEC_EX: [opty, opval, opval, opval]
244 CST_CODE_CE_INBOUNDS_GEP = 20,// INBOUNDS_GEP: [n x operands]
245 CST_CODE_BLOCKADDRESS = 21, // CST_CODE_BLOCKADDRESS [fnty, fnval, bb#]
246 CST_CODE_DATA = 22, // DATA: [n x elements]
247 CST_CODE_INLINEASM = 23 // INLINEASM: [sideeffect|alignstack|
248 // asmdialect,asmstr,conststr]
251 /// CastOpcodes - These are values used in the bitcode files to encode which
252 /// cast a CST_CODE_CE_CAST or a XXX refers to. The values of these enums
253 /// have no fixed relation to the LLVM IR enum values. Changing these will
254 /// break compatibility with old files.
268 CAST_ADDRSPACECAST = 12
271 /// BinaryOpcodes - These are values used in the bitcode files to encode which
272 /// binop a CST_CODE_CE_BINOP or a XXX refers to. The values of these enums
273 /// have no fixed relation to the LLVM IR enum values. Changing these will
274 /// break compatibility with old files.
280 BINOP_SDIV = 4, // overloaded for FP
282 BINOP_SREM = 6, // overloaded for FP
291 /// These are values used in the bitcode files to encode AtomicRMW operations.
292 /// The values of these enums have no fixed relation to the LLVM IR enum
293 /// values. Changing these will break compatibility with old files.
308 /// OverflowingBinaryOperatorOptionalFlags - Flags for serializing
309 /// OverflowingBinaryOperator's SubclassOptionalData contents.
310 enum OverflowingBinaryOperatorOptionalFlags {
311 OBO_NO_UNSIGNED_WRAP = 0,
312 OBO_NO_SIGNED_WRAP = 1
315 /// PossiblyExactOperatorOptionalFlags - Flags for serializing
316 /// PossiblyExactOperator's SubclassOptionalData contents.
317 enum PossiblyExactOperatorOptionalFlags {
321 /// Encoded AtomicOrdering values.
322 enum AtomicOrderingCodes {
323 ORDERING_NOTATOMIC = 0,
324 ORDERING_UNORDERED = 1,
325 ORDERING_MONOTONIC = 2,
326 ORDERING_ACQUIRE = 3,
327 ORDERING_RELEASE = 4,
332 /// Encoded SynchronizationScope values.
333 enum AtomicSynchScopeCodes {
334 SYNCHSCOPE_SINGLETHREAD = 0,
335 SYNCHSCOPE_CROSSTHREAD = 1
338 /// Markers and flags for call instruction.
339 enum CallMarkersFlags {
343 CALL_EXPLICIT_TYPE = 15,
347 // The function body block (FUNCTION_BLOCK_ID) describes function bodies. It
348 // can contain a constant block (CONSTANTS_BLOCK_ID).
350 FUNC_CODE_DECLAREBLOCKS = 1, // DECLAREBLOCKS: [n]
352 FUNC_CODE_INST_BINOP = 2, // BINOP: [opcode, ty, opval, opval]
353 FUNC_CODE_INST_CAST = 3, // CAST: [opcode, ty, opty, opval]
354 FUNC_CODE_INST_GEP_OLD = 4, // GEP: [n x operands]
355 FUNC_CODE_INST_SELECT = 5, // SELECT: [ty, opval, opval, opval]
356 FUNC_CODE_INST_EXTRACTELT = 6, // EXTRACTELT: [opty, opval, opval]
357 FUNC_CODE_INST_INSERTELT = 7, // INSERTELT: [ty, opval, opval, opval]
358 FUNC_CODE_INST_SHUFFLEVEC = 8, // SHUFFLEVEC: [ty, opval, opval, opval]
359 FUNC_CODE_INST_CMP = 9, // CMP: [opty, opval, opval, pred]
361 FUNC_CODE_INST_RET = 10, // RET: [opty,opval<both optional>]
362 FUNC_CODE_INST_BR = 11, // BR: [bb#, bb#, cond] or [bb#]
363 FUNC_CODE_INST_SWITCH = 12, // SWITCH: [opty, op0, op1, ...]
364 FUNC_CODE_INST_INVOKE = 13, // INVOKE: [attr, fnty, op0,op1, ...]
366 FUNC_CODE_INST_UNREACHABLE = 15, // UNREACHABLE
368 FUNC_CODE_INST_PHI = 16, // PHI: [ty, val0,bb0, ...]
371 FUNC_CODE_INST_ALLOCA = 19, // ALLOCA: [instty, opty, op, align]
372 FUNC_CODE_INST_LOAD = 20, // LOAD: [opty, op, align, vol]
375 FUNC_CODE_INST_VAARG = 23, // VAARG: [valistty, valist, instty]
376 // This store code encodes the pointer type, rather than the value type
377 // this is so information only available in the pointer type (e.g. address
378 // spaces) is retained.
379 FUNC_CODE_INST_STORE_OLD = 24, // STORE: [ptrty,ptr,val, align, vol]
381 FUNC_CODE_INST_EXTRACTVAL = 26, // EXTRACTVAL: [n x operands]
382 FUNC_CODE_INST_INSERTVAL = 27, // INSERTVAL: [n x operands]
383 // fcmp/icmp returning Int1TY or vector of Int1Ty. Same as CMP, exists to
384 // support legacy vicmp/vfcmp instructions.
385 FUNC_CODE_INST_CMP2 = 28, // CMP2: [opty, opval, opval, pred]
386 // new select on i1 or [N x i1]
387 FUNC_CODE_INST_VSELECT = 29, // VSELECT: [ty,opval,opval,predty,pred]
388 FUNC_CODE_INST_INBOUNDS_GEP_OLD = 30, // INBOUNDS_GEP: [n x operands]
389 FUNC_CODE_INST_INDIRECTBR = 31, // INDIRECTBR: [opty, op0, op1, ...]
391 FUNC_CODE_DEBUG_LOC_AGAIN = 33, // DEBUG_LOC_AGAIN
393 FUNC_CODE_INST_CALL = 34, // CALL: [attr, cc, fnty, fnid, args...]
395 FUNC_CODE_DEBUG_LOC = 35, // DEBUG_LOC: [Line,Col,ScopeVal, IAVal]
396 FUNC_CODE_INST_FENCE = 36, // FENCE: [ordering, synchscope]
397 FUNC_CODE_INST_CMPXCHG_OLD = 37, // CMPXCHG: [ptrty,ptr,cmp,new, align, vol,
398 // ordering, synchscope]
399 FUNC_CODE_INST_ATOMICRMW = 38, // ATOMICRMW: [ptrty,ptr,val, operation,
401 // ordering, synchscope]
402 FUNC_CODE_INST_RESUME = 39, // RESUME: [opval]
403 FUNC_CODE_INST_LANDINGPAD_OLD = 40, // LANDINGPAD: [ty,val,val,num,id0,val0...]
404 FUNC_CODE_INST_LOADATOMIC = 41, // LOAD: [opty, op, align, vol,
405 // ordering, synchscope]
406 FUNC_CODE_INST_STOREATOMIC_OLD = 42, // STORE: [ptrty,ptr,val, align, vol
407 // ordering, synchscope]
408 FUNC_CODE_INST_GEP = 43, // GEP: [inbounds, n x operands]
409 FUNC_CODE_INST_STORE = 44, // STORE: [ptrty,ptr,valty,val, align, vol]
410 FUNC_CODE_INST_STOREATOMIC = 45, // STORE: [ptrty,ptr,val, align, vol
411 FUNC_CODE_INST_CMPXCHG = 46, // CMPXCHG: [ptrty,ptr,valty,cmp,new, align,
412 // vol,ordering,synchscope]
413 FUNC_CODE_INST_LANDINGPAD = 47, // LANDINGPAD: [ty,val,num,id0,val0...]
414 FUNC_CODE_INST_CLEANUPRET = 48, // CLEANUPRET: [val] or [val,bb#]
415 FUNC_CODE_INST_CATCHRET = 49, // CATCHRET: [val,bb#]
416 FUNC_CODE_INST_CATCHPAD = 50, // CATCHPAD: [bb#,bb#,num,args...]
417 FUNC_CODE_INST_TERMINATEPAD = 51, // TERMINATEPAD: [bb#,num,args...]
418 FUNC_CODE_INST_CLEANUPPAD = 52, // CLEANUPPAD: [num,args...]
419 FUNC_CODE_INST_CATCHENDPAD = 53, // CATCHENDPAD: [] or [bb#]
420 FUNC_CODE_INST_CLEANUPENDPAD = 54, // CLEANUPENDPAD: [val] or [val,bb#]
422 FUNC_CODE_OPERAND_BUNDLE = 55, // OPERAND_BUNDLE: [tag#, value...]
426 USELIST_CODE_DEFAULT = 1, // DEFAULT: [index..., value-id]
427 USELIST_CODE_BB = 2 // BB: [index..., bb-id]
430 enum AttributeKindCodes {
432 ATTR_KIND_ALIGNMENT = 1,
433 ATTR_KIND_ALWAYS_INLINE = 2,
434 ATTR_KIND_BY_VAL = 3,
435 ATTR_KIND_INLINE_HINT = 4,
436 ATTR_KIND_IN_REG = 5,
437 ATTR_KIND_MIN_SIZE = 6,
440 ATTR_KIND_NO_ALIAS = 9,
441 ATTR_KIND_NO_BUILTIN = 10,
442 ATTR_KIND_NO_CAPTURE = 11,
443 ATTR_KIND_NO_DUPLICATE = 12,
444 ATTR_KIND_NO_IMPLICIT_FLOAT = 13,
445 ATTR_KIND_NO_INLINE = 14,
446 ATTR_KIND_NON_LAZY_BIND = 15,
447 ATTR_KIND_NO_RED_ZONE = 16,
448 ATTR_KIND_NO_RETURN = 17,
449 ATTR_KIND_NO_UNWIND = 18,
450 ATTR_KIND_OPTIMIZE_FOR_SIZE = 19,
451 ATTR_KIND_READ_NONE = 20,
452 ATTR_KIND_READ_ONLY = 21,
453 ATTR_KIND_RETURNED = 22,
454 ATTR_KIND_RETURNS_TWICE = 23,
455 ATTR_KIND_S_EXT = 24,
456 ATTR_KIND_STACK_ALIGNMENT = 25,
457 ATTR_KIND_STACK_PROTECT = 26,
458 ATTR_KIND_STACK_PROTECT_REQ = 27,
459 ATTR_KIND_STACK_PROTECT_STRONG = 28,
460 ATTR_KIND_STRUCT_RET = 29,
461 ATTR_KIND_SANITIZE_ADDRESS = 30,
462 ATTR_KIND_SANITIZE_THREAD = 31,
463 ATTR_KIND_SANITIZE_MEMORY = 32,
464 ATTR_KIND_UW_TABLE = 33,
465 ATTR_KIND_Z_EXT = 34,
466 ATTR_KIND_BUILTIN = 35,
468 ATTR_KIND_OPTIMIZE_NONE = 37,
469 ATTR_KIND_IN_ALLOCA = 38,
470 ATTR_KIND_NON_NULL = 39,
471 ATTR_KIND_JUMP_TABLE = 40,
472 ATTR_KIND_DEREFERENCEABLE = 41,
473 ATTR_KIND_DEREFERENCEABLE_OR_NULL = 42,
474 ATTR_KIND_CONVERGENT = 43,
475 ATTR_KIND_SAFESTACK = 44,
476 ATTR_KIND_ARGMEMONLY = 45,
477 ATTR_KIND_SWIFT_SELF = 46,
478 ATTR_KIND_SWIFT_ERROR = 47,
479 ATTR_KIND_NO_RECURSE = 48
482 enum ComdatSelectionKindCodes {
483 COMDAT_SELECTION_KIND_ANY = 1,
484 COMDAT_SELECTION_KIND_EXACT_MATCH = 2,
485 COMDAT_SELECTION_KIND_LARGEST = 3,
486 COMDAT_SELECTION_KIND_NO_DUPLICATES = 4,
487 COMDAT_SELECTION_KIND_SAME_SIZE = 5,
490 } // End bitc namespace
491 } // End llvm namespace