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]
127 // The type symbol table only has one code (TST_ENTRY_CODE).
128 enum TypeSymtabCodes {
129 TST_CODE_ENTRY = 1 // TST_ENTRY: [typeid, namechar x N]
132 // The value symbol table only has one code (VST_ENTRY_CODE).
133 enum ValueSymtabCodes {
134 VST_CODE_ENTRY = 1, // VST_ENTRY: [valid, namechar x N]
135 VST_CODE_BBENTRY = 2 // VST_BBENTRY: [bbid, namechar x N]
139 METADATA_STRING = 1, // MDSTRING: [values]
140 METADATA_VALUE = 2, // VALUE: [type num, value num]
141 METADATA_NODE = 3, // NODE: [n x md num]
142 METADATA_NAME = 4, // STRING: [values]
143 METADATA_DISTINCT_NODE = 5, // DISTINCT_NODE: [n x md num]
144 METADATA_KIND = 6, // [n x [id, name]]
145 METADATA_LOCATION = 7, // [distinct, line, col, scope, inlined-at?]
146 METADATA_OLD_NODE = 8, // OLD_NODE: [n x (type num, value num)]
147 METADATA_OLD_FN_NODE = 9, // OLD_FN_NODE: [n x (type num, value num)]
148 METADATA_NAMED_NODE = 10, // NAMED_NODE: [n x mdnodes]
149 METADATA_ATTACHMENT = 11, // [m x [value, [n x [id, mdnode]]]
150 METADATA_GENERIC_DEBUG = 12, // [distinct, tag, vers, header, n x md num]
151 METADATA_SUBRANGE = 13, // [distinct, count, lo]
152 METADATA_ENUMERATOR = 14, // [distinct, value, name?]
153 METADATA_BASIC_TYPE = 15, // [distinct, tag, name, size, align, enc]
154 METADATA_FILE = 16, // [distinct, filename, directory]
155 METADATA_DERIVED_TYPE = 17, // [distinct, ...]
156 METADATA_COMPOSITE_TYPE= 18, // [distinct, ...]
157 METADATA_SUBROUTINE_TYPE=19, // [distinct, flags, types]
158 METADATA_COMPILE_UNIT = 20, // [distinct, ...]
159 METADATA_SUBPROGRAM = 21, // [distinct, ...]
160 METADATA_LEXICAL_BLOCK = 22 // [distinct, scope, file, line, column]
163 // The constants block (CONSTANTS_BLOCK_ID) describes emission for each
164 // constant and maintains an implicit current type value.
165 enum ConstantsCodes {
166 CST_CODE_SETTYPE = 1, // SETTYPE: [typeid]
167 CST_CODE_NULL = 2, // NULL
168 CST_CODE_UNDEF = 3, // UNDEF
169 CST_CODE_INTEGER = 4, // INTEGER: [intval]
170 CST_CODE_WIDE_INTEGER = 5, // WIDE_INTEGER: [n x intval]
171 CST_CODE_FLOAT = 6, // FLOAT: [fpval]
172 CST_CODE_AGGREGATE = 7, // AGGREGATE: [n x value number]
173 CST_CODE_STRING = 8, // STRING: [values]
174 CST_CODE_CSTRING = 9, // CSTRING: [values]
175 CST_CODE_CE_BINOP = 10, // CE_BINOP: [opcode, opval, opval]
176 CST_CODE_CE_CAST = 11, // CE_CAST: [opcode, opty, opval]
177 CST_CODE_CE_GEP = 12, // CE_GEP: [n x operands]
178 CST_CODE_CE_SELECT = 13, // CE_SELECT: [opval, opval, opval]
179 CST_CODE_CE_EXTRACTELT = 14, // CE_EXTRACTELT: [opty, opval, opval]
180 CST_CODE_CE_INSERTELT = 15, // CE_INSERTELT: [opval, opval, opval]
181 CST_CODE_CE_SHUFFLEVEC = 16, // CE_SHUFFLEVEC: [opval, opval, opval]
182 CST_CODE_CE_CMP = 17, // CE_CMP: [opty, opval, opval, pred]
183 CST_CODE_INLINEASM_OLD = 18, // INLINEASM: [sideeffect|alignstack,
185 CST_CODE_CE_SHUFVEC_EX = 19, // SHUFVEC_EX: [opty, opval, opval, opval]
186 CST_CODE_CE_INBOUNDS_GEP = 20,// INBOUNDS_GEP: [n x operands]
187 CST_CODE_BLOCKADDRESS = 21, // CST_CODE_BLOCKADDRESS [fnty, fnval, bb#]
188 CST_CODE_DATA = 22, // DATA: [n x elements]
189 CST_CODE_INLINEASM = 23 // INLINEASM: [sideeffect|alignstack|
190 // asmdialect,asmstr,conststr]
193 /// CastOpcodes - These are values used in the bitcode files to encode which
194 /// cast a CST_CODE_CE_CAST or a XXX refers to. The values of these enums
195 /// have no fixed relation to the LLVM IR enum values. Changing these will
196 /// break compatibility with old files.
210 CAST_ADDRSPACECAST = 12
213 /// BinaryOpcodes - These are values used in the bitcode files to encode which
214 /// binop a CST_CODE_CE_BINOP or a XXX refers to. The values of these enums
215 /// have no fixed relation to the LLVM IR enum values. Changing these will
216 /// break compatibility with old files.
222 BINOP_SDIV = 4, // overloaded for FP
224 BINOP_SREM = 6, // overloaded for FP
233 /// These are values used in the bitcode files to encode AtomicRMW operations.
234 /// The values of these enums have no fixed relation to the LLVM IR enum
235 /// values. Changing these will break compatibility with old files.
250 /// OverflowingBinaryOperatorOptionalFlags - Flags for serializing
251 /// OverflowingBinaryOperator's SubclassOptionalData contents.
252 enum OverflowingBinaryOperatorOptionalFlags {
253 OBO_NO_UNSIGNED_WRAP = 0,
254 OBO_NO_SIGNED_WRAP = 1
257 /// PossiblyExactOperatorOptionalFlags - Flags for serializing
258 /// PossiblyExactOperator's SubclassOptionalData contents.
259 enum PossiblyExactOperatorOptionalFlags {
263 /// Encoded AtomicOrdering values.
264 enum AtomicOrderingCodes {
265 ORDERING_NOTATOMIC = 0,
266 ORDERING_UNORDERED = 1,
267 ORDERING_MONOTONIC = 2,
268 ORDERING_ACQUIRE = 3,
269 ORDERING_RELEASE = 4,
274 /// Encoded SynchronizationScope values.
275 enum AtomicSynchScopeCodes {
276 SYNCHSCOPE_SINGLETHREAD = 0,
277 SYNCHSCOPE_CROSSTHREAD = 1
280 // The function body block (FUNCTION_BLOCK_ID) describes function bodies. It
281 // can contain a constant block (CONSTANTS_BLOCK_ID).
283 FUNC_CODE_DECLAREBLOCKS = 1, // DECLAREBLOCKS: [n]
285 FUNC_CODE_INST_BINOP = 2, // BINOP: [opcode, ty, opval, opval]
286 FUNC_CODE_INST_CAST = 3, // CAST: [opcode, ty, opty, opval]
287 FUNC_CODE_INST_GEP = 4, // GEP: [n x operands]
288 FUNC_CODE_INST_SELECT = 5, // SELECT: [ty, opval, opval, opval]
289 FUNC_CODE_INST_EXTRACTELT = 6, // EXTRACTELT: [opty, opval, opval]
290 FUNC_CODE_INST_INSERTELT = 7, // INSERTELT: [ty, opval, opval, opval]
291 FUNC_CODE_INST_SHUFFLEVEC = 8, // SHUFFLEVEC: [ty, opval, opval, opval]
292 FUNC_CODE_INST_CMP = 9, // CMP: [opty, opval, opval, pred]
294 FUNC_CODE_INST_RET = 10, // RET: [opty,opval<both optional>]
295 FUNC_CODE_INST_BR = 11, // BR: [bb#, bb#, cond] or [bb#]
296 FUNC_CODE_INST_SWITCH = 12, // SWITCH: [opty, op0, op1, ...]
297 FUNC_CODE_INST_INVOKE = 13, // INVOKE: [attr, fnty, op0,op1, ...]
299 FUNC_CODE_INST_UNREACHABLE = 15, // UNREACHABLE
301 FUNC_CODE_INST_PHI = 16, // PHI: [ty, val0,bb0, ...]
304 FUNC_CODE_INST_ALLOCA = 19, // ALLOCA: [instty, opty, op, align]
305 FUNC_CODE_INST_LOAD = 20, // LOAD: [opty, op, align, vol]
308 FUNC_CODE_INST_VAARG = 23, // VAARG: [valistty, valist, instty]
309 // This store code encodes the pointer type, rather than the value type
310 // this is so information only available in the pointer type (e.g. address
311 // spaces) is retained.
312 FUNC_CODE_INST_STORE = 24, // STORE: [ptrty,ptr,val, align, vol]
314 FUNC_CODE_INST_EXTRACTVAL = 26, // EXTRACTVAL: [n x operands]
315 FUNC_CODE_INST_INSERTVAL = 27, // INSERTVAL: [n x operands]
316 // fcmp/icmp returning Int1TY or vector of Int1Ty. Same as CMP, exists to
317 // support legacy vicmp/vfcmp instructions.
318 FUNC_CODE_INST_CMP2 = 28, // CMP2: [opty, opval, opval, pred]
319 // new select on i1 or [N x i1]
320 FUNC_CODE_INST_VSELECT = 29, // VSELECT: [ty,opval,opval,predty,pred]
321 FUNC_CODE_INST_INBOUNDS_GEP= 30, // INBOUNDS_GEP: [n x operands]
322 FUNC_CODE_INST_INDIRECTBR = 31, // INDIRECTBR: [opty, op0, op1, ...]
324 FUNC_CODE_DEBUG_LOC_AGAIN = 33, // DEBUG_LOC_AGAIN
326 FUNC_CODE_INST_CALL = 34, // CALL: [attr, cc, fnty, fnid, args...]
328 FUNC_CODE_DEBUG_LOC = 35, // DEBUG_LOC: [Line,Col,ScopeVal, IAVal]
329 FUNC_CODE_INST_FENCE = 36, // FENCE: [ordering, synchscope]
330 FUNC_CODE_INST_CMPXCHG = 37, // CMPXCHG: [ptrty,ptr,cmp,new, align, vol,
331 // ordering, synchscope]
332 FUNC_CODE_INST_ATOMICRMW = 38, // ATOMICRMW: [ptrty,ptr,val, operation,
334 // ordering, synchscope]
335 FUNC_CODE_INST_RESUME = 39, // RESUME: [opval]
336 FUNC_CODE_INST_LANDINGPAD = 40, // LANDINGPAD: [ty,val,val,num,id0,val0...]
337 FUNC_CODE_INST_LOADATOMIC = 41, // LOAD: [opty, op, align, vol,
338 // ordering, synchscope]
339 FUNC_CODE_INST_STOREATOMIC = 42 // STORE: [ptrty,ptr,val, align, vol
340 // ordering, synchscope]
344 USELIST_CODE_DEFAULT = 1, // DEFAULT: [index..., value-id]
345 USELIST_CODE_BB = 2 // BB: [index..., bb-id]
348 enum AttributeKindCodes {
350 ATTR_KIND_ALIGNMENT = 1,
351 ATTR_KIND_ALWAYS_INLINE = 2,
352 ATTR_KIND_BY_VAL = 3,
353 ATTR_KIND_INLINE_HINT = 4,
354 ATTR_KIND_IN_REG = 5,
355 ATTR_KIND_MIN_SIZE = 6,
358 ATTR_KIND_NO_ALIAS = 9,
359 ATTR_KIND_NO_BUILTIN = 10,
360 ATTR_KIND_NO_CAPTURE = 11,
361 ATTR_KIND_NO_DUPLICATE = 12,
362 ATTR_KIND_NO_IMPLICIT_FLOAT = 13,
363 ATTR_KIND_NO_INLINE = 14,
364 ATTR_KIND_NON_LAZY_BIND = 15,
365 ATTR_KIND_NO_RED_ZONE = 16,
366 ATTR_KIND_NO_RETURN = 17,
367 ATTR_KIND_NO_UNWIND = 18,
368 ATTR_KIND_OPTIMIZE_FOR_SIZE = 19,
369 ATTR_KIND_READ_NONE = 20,
370 ATTR_KIND_READ_ONLY = 21,
371 ATTR_KIND_RETURNED = 22,
372 ATTR_KIND_RETURNS_TWICE = 23,
373 ATTR_KIND_S_EXT = 24,
374 ATTR_KIND_STACK_ALIGNMENT = 25,
375 ATTR_KIND_STACK_PROTECT = 26,
376 ATTR_KIND_STACK_PROTECT_REQ = 27,
377 ATTR_KIND_STACK_PROTECT_STRONG = 28,
378 ATTR_KIND_STRUCT_RET = 29,
379 ATTR_KIND_SANITIZE_ADDRESS = 30,
380 ATTR_KIND_SANITIZE_THREAD = 31,
381 ATTR_KIND_SANITIZE_MEMORY = 32,
382 ATTR_KIND_UW_TABLE = 33,
383 ATTR_KIND_Z_EXT = 34,
384 ATTR_KIND_BUILTIN = 35,
386 ATTR_KIND_OPTIMIZE_NONE = 37,
387 ATTR_KIND_IN_ALLOCA = 38,
388 ATTR_KIND_NON_NULL = 39,
389 ATTR_KIND_JUMP_TABLE = 40,
390 ATTR_KIND_DEREFERENCEABLE = 41
393 enum ComdatSelectionKindCodes {
394 COMDAT_SELECTION_KIND_ANY = 1,
395 COMDAT_SELECTION_KIND_EXACT_MATCH = 2,
396 COMDAT_SELECTION_KIND_LARGEST = 3,
397 COMDAT_SELECTION_KIND_NO_DUPLICATES = 4,
398 COMDAT_SELECTION_KIND_SAME_SIZE = 5,
401 } // End bitc namespace
402 } // End llvm namespace