1 //===- LLVMBitCodes.h - Enum values for the LLVM bitcode format -*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This header defines Bitcode enum values for LLVM IR bitcode files.
10 //
11 // The enum values defined in this file should be considered permanent.  If
12 // new features are added, they should have values added at the end of the
13 // respective lists.
14 //
15 //===----------------------------------------------------------------------===//
16 
17 #ifndef LLVM_BITCODE_LLVMBITCODES_H
18 #define LLVM_BITCODE_LLVMBITCODES_H
19 
20 // This is the only file included, and it, in turn, is a leaf header.
21 // This allows external tools to dump the AST of this file and analyze it for
22 // changes without needing to fully or partially build LLVM itself.
23 #include "llvm/Bitstream/BitCodeEnums.h"
24 
25 namespace llvm {
26 namespace bitc {
27 // The only top-level block types are MODULE, IDENTIFICATION, STRTAB and SYMTAB.
28 enum BlockIDs {
29   // Blocks
30   MODULE_BLOCK_ID = FIRST_APPLICATION_BLOCKID,
31 
32   // Module sub-block id's.
33   PARAMATTR_BLOCK_ID,
34   PARAMATTR_GROUP_BLOCK_ID,
35 
36   CONSTANTS_BLOCK_ID,
37   FUNCTION_BLOCK_ID,
38 
39   // Block intended to contains information on the bitcode versioning.
40   // Can be used to provide better error messages when we fail to parse a
41   // bitcode file.
42   IDENTIFICATION_BLOCK_ID,
43 
44   VALUE_SYMTAB_BLOCK_ID,
45   METADATA_BLOCK_ID,
46   METADATA_ATTACHMENT_ID,
47 
48   TYPE_BLOCK_ID_NEW,
49 
50   USELIST_BLOCK_ID,
51 
52   MODULE_STRTAB_BLOCK_ID,
53   GLOBALVAL_SUMMARY_BLOCK_ID,
54 
55   OPERAND_BUNDLE_TAGS_BLOCK_ID,
56 
57   METADATA_KIND_BLOCK_ID,
58 
59   STRTAB_BLOCK_ID,
60 
61   FULL_LTO_GLOBALVAL_SUMMARY_BLOCK_ID,
62 
63   SYMTAB_BLOCK_ID,
64 
65   SYNC_SCOPE_NAMES_BLOCK_ID,
66 };
67 
68 /// Identification block contains a string that describes the producer details,
69 /// and an epoch that defines the auto-upgrade capability.
70 enum IdentificationCodes {
71   IDENTIFICATION_CODE_STRING = 1, // IDENTIFICATION:      [strchr x N]
72   IDENTIFICATION_CODE_EPOCH = 2,  // EPOCH:               [epoch#]
73 };
74 
75 /// The epoch that defines the auto-upgrade compatibility for the bitcode.
76 ///
77 /// LLVM guarantees in a major release that a minor release can read bitcode
78 /// generated by previous minor releases. We translate this by making the reader
79 /// accepting only bitcode with the same epoch, except for the X.0 release which
80 /// also accepts N-1.
81 enum { BITCODE_CURRENT_EPOCH = 0 };
82 
83 /// MODULE blocks have a number of optional fields and subblocks.
84 enum ModuleCodes {
85   MODULE_CODE_VERSION = 1,     // VERSION:     [version#]
86   MODULE_CODE_TRIPLE = 2,      // TRIPLE:      [strchr x N]
87   MODULE_CODE_DATALAYOUT = 3,  // DATALAYOUT:  [strchr x N]
88   MODULE_CODE_ASM = 4,         // ASM:         [strchr x N]
89   MODULE_CODE_SECTIONNAME = 5, // SECTIONNAME: [strchr x N]
90 
91   // Deprecated, but still needed to read old bitcode files.
92   MODULE_CODE_DEPLIB = 6, // DEPLIB:      [strchr x N]
93 
94   // GLOBALVAR: [pointer type, isconst, initid,
95   //             linkage, alignment, section, visibility, threadlocal]
96   MODULE_CODE_GLOBALVAR = 7,
97 
98   // FUNCTION:  [type, callingconv, isproto, linkage, paramattrs, alignment,
99   //             section, visibility, gc, unnamed_addr]
100   MODULE_CODE_FUNCTION = 8,
101 
102   // ALIAS: [alias type, aliasee val#, linkage, visibility]
103   MODULE_CODE_ALIAS_OLD = 9,
104 
105   MODULE_CODE_GCNAME = 11, // GCNAME: [strchr x N]
106   MODULE_CODE_COMDAT = 12, // COMDAT: [selection_kind, name]
107 
108   MODULE_CODE_VSTOFFSET = 13, // VSTOFFSET: [offset]
109 
110   // ALIAS: [alias value type, addrspace, aliasee val#, linkage, visibility]
111   MODULE_CODE_ALIAS = 14,
112 
113   MODULE_CODE_METADATA_VALUES_UNUSED = 15,
114 
115   // SOURCE_FILENAME: [namechar x N]
116   MODULE_CODE_SOURCE_FILENAME = 16,
117 
118   // HASH: [5*i32]
119   MODULE_CODE_HASH = 17,
120 
121   // IFUNC: [ifunc value type, addrspace, resolver val#, linkage, visibility]
122   MODULE_CODE_IFUNC = 18,
123 };
124 
125 /// PARAMATTR blocks have code for defining a parameter attribute set.
126 enum AttributeCodes {
127   // Deprecated, but still needed to read old bitcode files.
128   PARAMATTR_CODE_ENTRY_OLD = 1, // ENTRY: [paramidx0, attr0,
129                                 //         paramidx1, attr1...]
130   PARAMATTR_CODE_ENTRY = 2,     // ENTRY: [attrgrp0, attrgrp1, ...]
131   PARAMATTR_GRP_CODE_ENTRY = 3  // ENTRY: [grpid, idx, attr0, attr1, ...]
132 };
133 
134 /// TYPE blocks have codes for each type primitive they use.
135 enum TypeCodes {
136   TYPE_CODE_NUMENTRY = 1, // NUMENTRY: [numentries]
137 
138   // Type Codes
139   TYPE_CODE_VOID = 2,    // VOID
140   TYPE_CODE_FLOAT = 3,   // FLOAT
141   TYPE_CODE_DOUBLE = 4,  // DOUBLE
142   TYPE_CODE_LABEL = 5,   // LABEL
143   TYPE_CODE_OPAQUE = 6,  // OPAQUE
144   TYPE_CODE_INTEGER = 7, // INTEGER: [width]
145   TYPE_CODE_POINTER = 8, // POINTER: [pointee type]
146 
147   TYPE_CODE_FUNCTION_OLD = 9, // FUNCTION: [vararg, attrid, retty,
148                               //            paramty x N]
149 
150   TYPE_CODE_HALF = 10, // HALF
151 
152   TYPE_CODE_ARRAY = 11,  // ARRAY: [numelts, eltty]
153   TYPE_CODE_VECTOR = 12, // VECTOR: [numelts, eltty]
154 
155   // These are not with the other floating point types because they're
156   // a late addition, and putting them in the right place breaks
157   // binary compatibility.
158   TYPE_CODE_X86_FP80 = 13,  // X86 LONG DOUBLE
159   TYPE_CODE_FP128 = 14,     // LONG DOUBLE (112 bit mantissa)
160   TYPE_CODE_PPC_FP128 = 15, // PPC LONG DOUBLE (2 doubles)
161 
162   TYPE_CODE_METADATA = 16, // METADATA
163 
164   TYPE_CODE_X86_MMX = 17, // X86 MMX
165 
166   TYPE_CODE_STRUCT_ANON = 18,  // STRUCT_ANON: [ispacked, eltty x N]
167   TYPE_CODE_STRUCT_NAME = 19,  // STRUCT_NAME: [strchr x N]
168   TYPE_CODE_STRUCT_NAMED = 20, // STRUCT_NAMED: [ispacked, eltty x N]
169 
170   TYPE_CODE_FUNCTION = 21, // FUNCTION: [vararg, retty, paramty x N]
171 
172   TYPE_CODE_TOKEN = 22, // TOKEN
173 
174   TYPE_CODE_BFLOAT = 23,  // BRAIN FLOATING POINT
175   TYPE_CODE_X86_AMX = 24, // X86 AMX
176 
177   TYPE_CODE_OPAQUE_POINTER = 25, // OPAQUE_POINTER: [addrspace]
178 };
179 
180 enum OperandBundleTagCode {
181   OPERAND_BUNDLE_TAG = 1, // TAG: [strchr x N]
182 };
183 
184 enum SyncScopeNameCode {
185   SYNC_SCOPE_NAME = 1,
186 };
187 
188 // Value symbol table codes.
189 enum ValueSymtabCodes {
190   VST_CODE_ENTRY = 1,   // VST_ENTRY: [valueid, namechar x N]
191   VST_CODE_BBENTRY = 2, // VST_BBENTRY: [bbid, namechar x N]
192   VST_CODE_FNENTRY = 3, // VST_FNENTRY: [valueid, offset, namechar x N]
193   // VST_COMBINED_ENTRY: [valueid, refguid]
194   VST_CODE_COMBINED_ENTRY = 5
195 };
196 
197 // The module path symbol table only has one code (MST_CODE_ENTRY).
198 enum ModulePathSymtabCodes {
199   MST_CODE_ENTRY = 1, // MST_ENTRY: [modid, namechar x N]
200   MST_CODE_HASH = 2,  // MST_HASH:  [5*i32]
201 };
202 
203 // The summary section uses different codes in the per-module
204 // and combined index cases.
205 enum GlobalValueSummarySymtabCodes {
206   // PERMODULE: [valueid, flags, instcount, numrefs, numrefs x valueid,
207   //             n x (valueid)]
208   FS_PERMODULE = 1,
209   // PERMODULE_PROFILE: [valueid, flags, instcount, numrefs,
210   //                     numrefs x valueid,
211   //                     n x (valueid, hotness)]
212   FS_PERMODULE_PROFILE = 2,
213   // PERMODULE_GLOBALVAR_INIT_REFS: [valueid, flags, n x valueid]
214   FS_PERMODULE_GLOBALVAR_INIT_REFS = 3,
215   // COMBINED: [valueid, modid, flags, instcount, numrefs, numrefs x valueid,
216   //            n x (valueid)]
217   FS_COMBINED = 4,
218   // COMBINED_PROFILE: [valueid, modid, flags, instcount, numrefs,
219   //                    numrefs x valueid,
220   //                    n x (valueid, hotness)]
221   FS_COMBINED_PROFILE = 5,
222   // COMBINED_GLOBALVAR_INIT_REFS: [valueid, modid, flags, n x valueid]
223   FS_COMBINED_GLOBALVAR_INIT_REFS = 6,
224   // ALIAS: [valueid, flags, valueid]
225   FS_ALIAS = 7,
226   // COMBINED_ALIAS: [valueid, modid, flags, valueid]
227   FS_COMBINED_ALIAS = 8,
228   // COMBINED_ORIGINAL_NAME: [original_name_hash]
229   FS_COMBINED_ORIGINAL_NAME = 9,
230   // VERSION of the summary, bumped when adding flags for instance.
231   FS_VERSION = 10,
232   // The list of llvm.type.test type identifiers used by the following function
233   // that are used other than by an llvm.assume.
234   // [n x typeid]
235   FS_TYPE_TESTS = 11,
236   // The list of virtual calls made by this function using
237   // llvm.assume(llvm.type.test) intrinsics that do not have all constant
238   // integer arguments.
239   // [n x (typeid, offset)]
240   FS_TYPE_TEST_ASSUME_VCALLS = 12,
241   // The list of virtual calls made by this function using
242   // llvm.type.checked.load intrinsics that do not have all constant integer
243   // arguments.
244   // [n x (typeid, offset)]
245   FS_TYPE_CHECKED_LOAD_VCALLS = 13,
246   // Identifies a virtual call made by this function using an
247   // llvm.assume(llvm.type.test) intrinsic with all constant integer arguments.
248   // [typeid, offset, n x arg]
249   FS_TYPE_TEST_ASSUME_CONST_VCALL = 14,
250   // Identifies a virtual call made by this function using an
251   // llvm.type.checked.load intrinsic with all constant integer arguments.
252   // [typeid, offset, n x arg]
253   FS_TYPE_CHECKED_LOAD_CONST_VCALL = 15,
254   // Assigns a GUID to a value ID. This normally appears only in combined
255   // summaries, but it can also appear in per-module summaries for PGO data.
256   // [valueid, guid]
257   FS_VALUE_GUID = 16,
258   // The list of local functions with CFI jump tables. Function names are
259   // strings in strtab.
260   // [n * name]
261   FS_CFI_FUNCTION_DEFS = 17,
262   // The list of external functions with CFI jump tables. Function names are
263   // strings in strtab.
264   // [n * name]
265   FS_CFI_FUNCTION_DECLS = 18,
266   // Per-module summary that also adds relative block frequency to callee info.
267   // PERMODULE_RELBF: [valueid, flags, instcount, numrefs,
268   //                   numrefs x valueid,
269   //                   n x (valueid, relblockfreq)]
270   FS_PERMODULE_RELBF = 19,
271   // Index-wide flags
272   FS_FLAGS = 20,
273   // Maps type identifier to summary information for that type identifier.
274   // Produced by the thin link (only lives in combined index).
275   // TYPE_ID: [typeid, kind, bitwidth, align, size, bitmask, inlinebits,
276   //           n x (typeid, kind, name, numrba,
277   //                numrba x (numarg, numarg x arg, kind, info, byte, bit))]
278   FS_TYPE_ID = 21,
279   // For background see overview at https://llvm.org/docs/TypeMetadata.html.
280   // The type metadata includes both the type identifier and the offset of
281   // the address point of the type (the address held by objects of that type
282   // which may not be the beginning of the virtual table). Vtable definitions
283   // are decorated with type metadata for the types they are compatible with.
284   //
285   // Maps type identifier to summary information for that type identifier
286   // computed from type metadata: the valueid of each vtable definition
287   // decorated with a type metadata for that identifier, and the offset from
288   // the corresponding type metadata.
289   // Exists in the per-module summary to provide information to thin link
290   // for index-based whole program devirtualization.
291   // TYPE_ID_METADATA: [typeid, n x (valueid, offset)]
292   FS_TYPE_ID_METADATA = 22,
293   // Summarizes vtable definition for use in index-based whole program
294   // devirtualization during the thin link.
295   // PERMODULE_VTABLE_GLOBALVAR_INIT_REFS: [valueid, flags, varflags,
296   //                                        numrefs, numrefs x valueid,
297   //                                        n x (valueid, offset)]
298   FS_PERMODULE_VTABLE_GLOBALVAR_INIT_REFS = 23,
299   // The total number of basic blocks in the module.
300   FS_BLOCK_COUNT = 24,
301   // Range information for accessed offsets for every argument.
302   // [n x (paramno, range, numcalls, numcalls x (callee_guid, paramno, range))]
303   FS_PARAM_ACCESS = 25,
304 };
305 
306 enum MetadataCodes {
307   METADATA_STRING_OLD = 1,     // MDSTRING:      [values]
308   METADATA_VALUE = 2,          // VALUE:         [type num, value num]
309   METADATA_NODE = 3,           // NODE:          [n x md num]
310   METADATA_NAME = 4,           // STRING:        [values]
311   METADATA_DISTINCT_NODE = 5,  // DISTINCT_NODE: [n x md num]
312   METADATA_KIND = 6,           // [n x [id, name]]
313   METADATA_LOCATION = 7,       // [distinct, line, col, scope, inlined-at?]
314   METADATA_OLD_NODE = 8,       // OLD_NODE:      [n x (type num, value num)]
315   METADATA_OLD_FN_NODE = 9,    // OLD_FN_NODE:   [n x (type num, value num)]
316   METADATA_NAMED_NODE = 10,    // NAMED_NODE:    [n x mdnodes]
317   METADATA_ATTACHMENT = 11,    // [m x [value, [n x [id, mdnode]]]
318   METADATA_GENERIC_DEBUG = 12, // [distinct, tag, vers, header, n x md num]
319   METADATA_SUBRANGE = 13,      // [distinct, count, lo]
320   METADATA_ENUMERATOR = 14,    // [isUnsigned|distinct, value, name]
321   METADATA_BASIC_TYPE = 15,    // [distinct, tag, name, size, align, enc]
322   METADATA_FILE = 16, // [distinct, filename, directory, checksumkind, checksum]
323   METADATA_DERIVED_TYPE = 17,       // [distinct, ...]
324   METADATA_COMPOSITE_TYPE = 18,     // [distinct, ...]
325   METADATA_SUBROUTINE_TYPE = 19,    // [distinct, flags, types, cc]
326   METADATA_COMPILE_UNIT = 20,       // [distinct, ...]
327   METADATA_SUBPROGRAM = 21,         // [distinct, ...]
328   METADATA_LEXICAL_BLOCK = 22,      // [distinct, scope, file, line, column]
329   METADATA_LEXICAL_BLOCK_FILE = 23, //[distinct, scope, file, discriminator]
330   METADATA_NAMESPACE = 24, // [distinct, scope, file, name, line, exportSymbols]
331   METADATA_TEMPLATE_TYPE = 25,   // [distinct, scope, name, type, ...]
332   METADATA_TEMPLATE_VALUE = 26,  // [distinct, scope, name, type, value, ...]
333   METADATA_GLOBAL_VAR = 27,      // [distinct, ...]
334   METADATA_LOCAL_VAR = 28,       // [distinct, ...]
335   METADATA_EXPRESSION = 29,      // [distinct, n x element]
336   METADATA_OBJC_PROPERTY = 30,   // [distinct, name, file, line, ...]
337   METADATA_IMPORTED_ENTITY = 31, // [distinct, tag, scope, entity, line, name]
338   METADATA_MODULE = 32,          // [distinct, scope, name, ...]
339   METADATA_MACRO = 33,           // [distinct, macinfo, line, name, value]
340   METADATA_MACRO_FILE = 34,      // [distinct, macinfo, line, file, ...]
341   METADATA_STRINGS = 35,         // [count, offset] blob([lengths][chars])
342   METADATA_GLOBAL_DECL_ATTACHMENT = 36, // [valueid, n x [id, mdnode]]
343   METADATA_GLOBAL_VAR_EXPR = 37,        // [distinct, var, expr]
344   METADATA_INDEX_OFFSET = 38,           // [offset]
345   METADATA_INDEX = 39,                  // [bitpos]
346   METADATA_LABEL = 40,                  // [distinct, scope, name, file, line]
347   METADATA_STRING_TYPE = 41,            // [distinct, name, size, align,...]
348   // Codes 42 and 43 are reserved for support for Fortran array specific debug
349   // info.
350   METADATA_COMMON_BLOCK = 44,     // [distinct, scope, name, variable,...]
351   METADATA_GENERIC_SUBRANGE = 45, // [distinct, count, lo, up, stride]
352   METADATA_ARG_LIST = 46          // [n x [type num, value num]]
353 };
354 
355 // The constants block (CONSTANTS_BLOCK_ID) describes emission for each
356 // constant and maintains an implicit current type value.
357 enum ConstantsCodes {
358   CST_CODE_SETTYPE = 1,          // SETTYPE:       [typeid]
359   CST_CODE_NULL = 2,             // NULL
360   CST_CODE_UNDEF = 3,            // UNDEF
361   CST_CODE_INTEGER = 4,          // INTEGER:       [intval]
362   CST_CODE_WIDE_INTEGER = 5,     // WIDE_INTEGER:  [n x intval]
363   CST_CODE_FLOAT = 6,            // FLOAT:         [fpval]
364   CST_CODE_AGGREGATE = 7,        // AGGREGATE:     [n x value number]
365   CST_CODE_STRING = 8,           // STRING:        [values]
366   CST_CODE_CSTRING = 9,          // CSTRING:       [values]
367   CST_CODE_CE_BINOP = 10,        // CE_BINOP:      [opcode, opval, opval]
368   CST_CODE_CE_CAST = 11,         // CE_CAST:       [opcode, opty, opval]
369   CST_CODE_CE_GEP = 12,          // CE_GEP:        [n x operands]
370   CST_CODE_CE_SELECT = 13,       // CE_SELECT:     [opval, opval, opval]
371   CST_CODE_CE_EXTRACTELT = 14,   // CE_EXTRACTELT: [opty, opval, opval]
372   CST_CODE_CE_INSERTELT = 15,    // CE_INSERTELT:  [opval, opval, opval]
373   CST_CODE_CE_SHUFFLEVEC = 16,   // CE_SHUFFLEVEC: [opval, opval, opval]
374   CST_CODE_CE_CMP = 17,          // CE_CMP:        [opty, opval, opval, pred]
375   CST_CODE_INLINEASM_OLD = 18,   // INLINEASM:     [sideeffect|alignstack,
376                                  //                 asmstr,conststr]
377   CST_CODE_CE_SHUFVEC_EX = 19,   // SHUFVEC_EX:    [opty, opval, opval, opval]
378   CST_CODE_CE_INBOUNDS_GEP = 20, // INBOUNDS_GEP:  [n x operands]
379   CST_CODE_BLOCKADDRESS = 21,    // CST_CODE_BLOCKADDRESS [fnty, fnval, bb#]
380   CST_CODE_DATA = 22,            // DATA:          [n x elements]
381   CST_CODE_INLINEASM_OLD2 = 23,  // INLINEASM:     [sideeffect|alignstack|
382                                  //                 asmdialect,asmstr,conststr]
383   CST_CODE_CE_GEP_WITH_INRANGE_INDEX = 24, //      [opty, flags, n x operands]
384   CST_CODE_CE_UNOP = 25,                   // CE_UNOP:      [opcode, opval]
385   CST_CODE_POISON = 26,                    // POISON
386   CST_CODE_DSO_LOCAL_EQUIVALENT = 27,      // DSO_LOCAL_EQUIVALENT [gvty, gv]
387   CST_CODE_INLINEASM_OLD3 = 28,    // INLINEASM:     [sideeffect|alignstack|
388                                    //                 asmdialect|unwind,
389                                    //                 asmstr,conststr]
390   CST_CODE_NO_CFI_VALUE = 29, // NO_CFI [ fty, f ]
391   CST_CODE_INLINEASM = 30,    // INLINEASM:     [fnty,
392                               //                 sideeffect|alignstack|
393                               //                 asmdialect|unwind,
394                               //                 asmstr,conststr]
395 };
396 
397 /// CastOpcodes - These are values used in the bitcode files to encode which
398 /// cast a CST_CODE_CE_CAST or a XXX refers to.  The values of these enums
399 /// have no fixed relation to the LLVM IR enum values.  Changing these will
400 /// break compatibility with old files.
401 enum CastOpcodes {
402   CAST_TRUNC = 0,
403   CAST_ZEXT = 1,
404   CAST_SEXT = 2,
405   CAST_FPTOUI = 3,
406   CAST_FPTOSI = 4,
407   CAST_UITOFP = 5,
408   CAST_SITOFP = 6,
409   CAST_FPTRUNC = 7,
410   CAST_FPEXT = 8,
411   CAST_PTRTOINT = 9,
412   CAST_INTTOPTR = 10,
413   CAST_BITCAST = 11,
414   CAST_ADDRSPACECAST = 12
415 };
416 
417 /// UnaryOpcodes - These are values used in the bitcode files to encode which
418 /// unop a CST_CODE_CE_UNOP or a XXX refers to.  The values of these enums
419 /// have no fixed relation to the LLVM IR enum values.  Changing these will
420 /// break compatibility with old files.
421 enum UnaryOpcodes {
422   UNOP_FNEG = 0
423 };
424 
425 /// BinaryOpcodes - These are values used in the bitcode files to encode which
426 /// binop a CST_CODE_CE_BINOP or a XXX refers to.  The values of these enums
427 /// have no fixed relation to the LLVM IR enum values.  Changing these will
428 /// break compatibility with old files.
429 enum BinaryOpcodes {
430   BINOP_ADD = 0,
431   BINOP_SUB = 1,
432   BINOP_MUL = 2,
433   BINOP_UDIV = 3,
434   BINOP_SDIV = 4, // overloaded for FP
435   BINOP_UREM = 5,
436   BINOP_SREM = 6, // overloaded for FP
437   BINOP_SHL = 7,
438   BINOP_LSHR = 8,
439   BINOP_ASHR = 9,
440   BINOP_AND = 10,
441   BINOP_OR = 11,
442   BINOP_XOR = 12
443 };
444 
445 /// These are values used in the bitcode files to encode AtomicRMW operations.
446 /// The values of these enums have no fixed relation to the LLVM IR enum
447 /// values.  Changing these will break compatibility with old files.
448 enum RMWOperations {
449   RMW_XCHG = 0,
450   RMW_ADD = 1,
451   RMW_SUB = 2,
452   RMW_AND = 3,
453   RMW_NAND = 4,
454   RMW_OR = 5,
455   RMW_XOR = 6,
456   RMW_MAX = 7,
457   RMW_MIN = 8,
458   RMW_UMAX = 9,
459   RMW_UMIN = 10,
460   RMW_FADD = 11,
461   RMW_FSUB = 12,
462   RMW_FMAX = 13,
463   RMW_FMIN = 14
464 };
465 
466 /// OverflowingBinaryOperatorOptionalFlags - Flags for serializing
467 /// OverflowingBinaryOperator's SubclassOptionalData contents.
468 enum OverflowingBinaryOperatorOptionalFlags {
469   OBO_NO_UNSIGNED_WRAP = 0,
470   OBO_NO_SIGNED_WRAP = 1
471 };
472 
473 /// FastMath Flags
474 /// This is a fixed layout derived from the bitcode emitted by LLVM 5.0
475 /// intended to decouple the in-memory representation from the serialization.
476 enum FastMathMap {
477   UnsafeAlgebra   = (1 << 0), // Legacy
478   NoNaNs          = (1 << 1),
479   NoInfs          = (1 << 2),
480   NoSignedZeros   = (1 << 3),
481   AllowReciprocal = (1 << 4),
482   AllowContract   = (1 << 5),
483   ApproxFunc      = (1 << 6),
484   AllowReassoc    = (1 << 7)
485 };
486 
487 /// PossiblyExactOperatorOptionalFlags - Flags for serializing
488 /// PossiblyExactOperator's SubclassOptionalData contents.
489 enum PossiblyExactOperatorOptionalFlags { PEO_EXACT = 0 };
490 
491 /// Encoded AtomicOrdering values.
492 enum AtomicOrderingCodes {
493   ORDERING_NOTATOMIC = 0,
494   ORDERING_UNORDERED = 1,
495   ORDERING_MONOTONIC = 2,
496   ORDERING_ACQUIRE = 3,
497   ORDERING_RELEASE = 4,
498   ORDERING_ACQREL = 5,
499   ORDERING_SEQCST = 6
500 };
501 
502 /// Markers and flags for call instruction.
503 enum CallMarkersFlags {
504   CALL_TAIL = 0,
505   CALL_CCONV = 1,
506   CALL_MUSTTAIL = 14,
507   CALL_EXPLICIT_TYPE = 15,
508   CALL_NOTAIL = 16,
509   CALL_FMF = 17 // Call has optional fast-math-flags.
510 };
511 
512 // The function body block (FUNCTION_BLOCK_ID) describes function bodies.  It
513 // can contain a constant block (CONSTANTS_BLOCK_ID).
514 enum FunctionCodes {
515   FUNC_CODE_DECLAREBLOCKS = 1, // DECLAREBLOCKS: [n]
516 
517   FUNC_CODE_INST_BINOP = 2,      // BINOP:      [opcode, ty, opval, opval]
518   FUNC_CODE_INST_CAST = 3,       // CAST:       [opcode, ty, opty, opval]
519   FUNC_CODE_INST_GEP_OLD = 4,    // GEP:        [n x operands]
520   FUNC_CODE_INST_SELECT = 5,     // SELECT:     [ty, opval, opval, opval]
521   FUNC_CODE_INST_EXTRACTELT = 6, // EXTRACTELT: [opty, opval, opval]
522   FUNC_CODE_INST_INSERTELT = 7,  // INSERTELT:  [ty, opval, opval, opval]
523   FUNC_CODE_INST_SHUFFLEVEC = 8, // SHUFFLEVEC: [ty, opval, opval, opval]
524   FUNC_CODE_INST_CMP = 9,        // CMP:        [opty, opval, opval, pred]
525 
526   FUNC_CODE_INST_RET = 10,    // RET:        [opty,opval<both optional>]
527   FUNC_CODE_INST_BR = 11,     // BR:         [bb#, bb#, cond] or [bb#]
528   FUNC_CODE_INST_SWITCH = 12, // SWITCH:     [opty, op0, op1, ...]
529   FUNC_CODE_INST_INVOKE = 13, // INVOKE:     [attr, fnty, op0,op1, ...]
530   // 14 is unused.
531   FUNC_CODE_INST_UNREACHABLE = 15, // UNREACHABLE
532 
533   FUNC_CODE_INST_PHI = 16, // PHI:        [ty, val0,bb0, ...]
534   // 17 is unused.
535   // 18 is unused.
536   FUNC_CODE_INST_ALLOCA = 19, // ALLOCA:     [instty, opty, op, align]
537   FUNC_CODE_INST_LOAD = 20,   // LOAD:       [opty, op, align, vol]
538   // 21 is unused.
539   // 22 is unused.
540   FUNC_CODE_INST_VAARG = 23, // VAARG:      [valistty, valist, instty]
541   // This store code encodes the pointer type, rather than the value type
542   // this is so information only available in the pointer type (e.g. address
543   // spaces) is retained.
544   FUNC_CODE_INST_STORE_OLD = 24, // STORE:      [ptrty,ptr,val, align, vol]
545   // 25 is unused.
546   FUNC_CODE_INST_EXTRACTVAL = 26, // EXTRACTVAL: [n x operands]
547   FUNC_CODE_INST_INSERTVAL = 27,  // INSERTVAL:  [n x operands]
548   // fcmp/icmp returning Int1TY or vector of Int1Ty. Same as CMP, exists to
549   // support legacy vicmp/vfcmp instructions.
550   FUNC_CODE_INST_CMP2 = 28, // CMP2:       [opty, opval, opval, pred]
551   // new select on i1 or [N x i1]
552   FUNC_CODE_INST_VSELECT = 29, // VSELECT:    [ty,opval,opval,predty,pred]
553   FUNC_CODE_INST_INBOUNDS_GEP_OLD = 30, // INBOUNDS_GEP: [n x operands]
554   FUNC_CODE_INST_INDIRECTBR = 31,       // INDIRECTBR: [opty, op0, op1, ...]
555   // 32 is unused.
556   FUNC_CODE_DEBUG_LOC_AGAIN = 33, // DEBUG_LOC_AGAIN
557 
558   FUNC_CODE_INST_CALL = 34, // CALL:    [attr, cc, fnty, fnid, args...]
559 
560   FUNC_CODE_DEBUG_LOC = 35,          // DEBUG_LOC:  [Line,Col,ScopeVal, IAVal]
561   FUNC_CODE_INST_FENCE = 36,         // FENCE: [ordering, synchscope]
562   FUNC_CODE_INST_CMPXCHG_OLD = 37,   // CMPXCHG: [ptrty, ptr, cmp, val, vol,
563                                      //            ordering, synchscope,
564                                      //            failure_ordering?, weak?]
565   FUNC_CODE_INST_ATOMICRMW_OLD = 38, // ATOMICRMW: [ptrty,ptr,val, operation,
566                                      //             align, vol,
567                                      //             ordering, synchscope]
568   FUNC_CODE_INST_RESUME = 39,        // RESUME:     [opval]
569   FUNC_CODE_INST_LANDINGPAD_OLD =
570       40,                         // LANDINGPAD: [ty,val,val,num,id0,val0...]
571   FUNC_CODE_INST_LOADATOMIC = 41, // LOAD: [opty, op, align, vol,
572                                   //        ordering, synchscope]
573   FUNC_CODE_INST_STOREATOMIC_OLD = 42, // STORE: [ptrty,ptr,val, align, vol
574                                        //         ordering, synchscope]
575   FUNC_CODE_INST_GEP = 43,             // GEP:  [inbounds, n x operands]
576   FUNC_CODE_INST_STORE = 44,       // STORE: [ptrty,ptr,valty,val, align, vol]
577   FUNC_CODE_INST_STOREATOMIC = 45, // STORE: [ptrty,ptr,val, align, vol
578   FUNC_CODE_INST_CMPXCHG = 46,     // CMPXCHG: [ptrty, ptr, cmp, val, vol,
579                                    //           success_ordering, synchscope,
580                                    //           failure_ordering, weak]
581   FUNC_CODE_INST_LANDINGPAD = 47,  // LANDINGPAD: [ty,val,num,id0,val0...]
582   FUNC_CODE_INST_CLEANUPRET = 48,  // CLEANUPRET: [val] or [val,bb#]
583   FUNC_CODE_INST_CATCHRET = 49,    // CATCHRET: [val,bb#]
584   FUNC_CODE_INST_CATCHPAD = 50,    // CATCHPAD: [bb#,bb#,num,args...]
585   FUNC_CODE_INST_CLEANUPPAD = 51,  // CLEANUPPAD: [num,args...]
586   FUNC_CODE_INST_CATCHSWITCH =
587       52, // CATCHSWITCH: [num,args...] or [num,args...,bb]
588   // 53 is unused.
589   // 54 is unused.
590   FUNC_CODE_OPERAND_BUNDLE = 55,  // OPERAND_BUNDLE: [tag#, value...]
591   FUNC_CODE_INST_UNOP = 56,       // UNOP:       [opcode, ty, opval]
592   FUNC_CODE_INST_CALLBR = 57,     // CALLBR:     [attr, cc, norm, transfs,
593                                   //              fnty, fnid, args...]
594   FUNC_CODE_INST_FREEZE = 58,     // FREEZE: [opty, opval]
595   FUNC_CODE_INST_ATOMICRMW = 59,  // ATOMICRMW: [ptrty, ptr, valty, val,
596                                   //             operation, align, vol,
597                                   //             ordering, synchscope]
598   FUNC_CODE_BLOCKADDR_USERS = 60, // BLOCKADDR_USERS: [value...]
599 };
600 
601 enum UseListCodes {
602   USELIST_CODE_DEFAULT = 1, // DEFAULT: [index..., value-id]
603   USELIST_CODE_BB = 2       // BB: [index..., bb-id]
604 };
605 
606 enum AttributeKindCodes {
607   // = 0 is unused
608   ATTR_KIND_ALIGNMENT = 1,
609   ATTR_KIND_ALWAYS_INLINE = 2,
610   ATTR_KIND_BY_VAL = 3,
611   ATTR_KIND_INLINE_HINT = 4,
612   ATTR_KIND_IN_REG = 5,
613   ATTR_KIND_MIN_SIZE = 6,
614   ATTR_KIND_NAKED = 7,
615   ATTR_KIND_NEST = 8,
616   ATTR_KIND_NO_ALIAS = 9,
617   ATTR_KIND_NO_BUILTIN = 10,
618   ATTR_KIND_NO_CAPTURE = 11,
619   ATTR_KIND_NO_DUPLICATE = 12,
620   ATTR_KIND_NO_IMPLICIT_FLOAT = 13,
621   ATTR_KIND_NO_INLINE = 14,
622   ATTR_KIND_NON_LAZY_BIND = 15,
623   ATTR_KIND_NO_RED_ZONE = 16,
624   ATTR_KIND_NO_RETURN = 17,
625   ATTR_KIND_NO_UNWIND = 18,
626   ATTR_KIND_OPTIMIZE_FOR_SIZE = 19,
627   ATTR_KIND_READ_NONE = 20,
628   ATTR_KIND_READ_ONLY = 21,
629   ATTR_KIND_RETURNED = 22,
630   ATTR_KIND_RETURNS_TWICE = 23,
631   ATTR_KIND_S_EXT = 24,
632   ATTR_KIND_STACK_ALIGNMENT = 25,
633   ATTR_KIND_STACK_PROTECT = 26,
634   ATTR_KIND_STACK_PROTECT_REQ = 27,
635   ATTR_KIND_STACK_PROTECT_STRONG = 28,
636   ATTR_KIND_STRUCT_RET = 29,
637   ATTR_KIND_SANITIZE_ADDRESS = 30,
638   ATTR_KIND_SANITIZE_THREAD = 31,
639   ATTR_KIND_SANITIZE_MEMORY = 32,
640   ATTR_KIND_UW_TABLE = 33,
641   ATTR_KIND_Z_EXT = 34,
642   ATTR_KIND_BUILTIN = 35,
643   ATTR_KIND_COLD = 36,
644   ATTR_KIND_OPTIMIZE_NONE = 37,
645   ATTR_KIND_IN_ALLOCA = 38,
646   ATTR_KIND_NON_NULL = 39,
647   ATTR_KIND_JUMP_TABLE = 40,
648   ATTR_KIND_DEREFERENCEABLE = 41,
649   ATTR_KIND_DEREFERENCEABLE_OR_NULL = 42,
650   ATTR_KIND_CONVERGENT = 43,
651   ATTR_KIND_SAFESTACK = 44,
652   ATTR_KIND_ARGMEMONLY = 45,
653   ATTR_KIND_SWIFT_SELF = 46,
654   ATTR_KIND_SWIFT_ERROR = 47,
655   ATTR_KIND_NO_RECURSE = 48,
656   ATTR_KIND_INACCESSIBLEMEM_ONLY = 49,
657   ATTR_KIND_INACCESSIBLEMEM_OR_ARGMEMONLY = 50,
658   ATTR_KIND_ALLOC_SIZE = 51,
659   ATTR_KIND_WRITEONLY = 52,
660   ATTR_KIND_SPECULATABLE = 53,
661   ATTR_KIND_STRICT_FP = 54,
662   ATTR_KIND_SANITIZE_HWADDRESS = 55,
663   ATTR_KIND_NOCF_CHECK = 56,
664   ATTR_KIND_OPT_FOR_FUZZING = 57,
665   ATTR_KIND_SHADOWCALLSTACK = 58,
666   ATTR_KIND_SPECULATIVE_LOAD_HARDENING = 59,
667   ATTR_KIND_IMMARG = 60,
668   ATTR_KIND_WILLRETURN = 61,
669   ATTR_KIND_NOFREE = 62,
670   ATTR_KIND_NOSYNC = 63,
671   ATTR_KIND_SANITIZE_MEMTAG = 64,
672   ATTR_KIND_PREALLOCATED = 65,
673   ATTR_KIND_NO_MERGE = 66,
674   ATTR_KIND_NULL_POINTER_IS_VALID = 67,
675   ATTR_KIND_NOUNDEF = 68,
676   ATTR_KIND_BYREF = 69,
677   ATTR_KIND_MUSTPROGRESS = 70,
678   ATTR_KIND_NO_CALLBACK = 71,
679   ATTR_KIND_HOT = 72,
680   ATTR_KIND_NO_PROFILE = 73,
681   ATTR_KIND_VSCALE_RANGE = 74,
682   ATTR_KIND_SWIFT_ASYNC = 75,
683   ATTR_KIND_NO_SANITIZE_COVERAGE = 76,
684   ATTR_KIND_ELEMENTTYPE = 77,
685   ATTR_KIND_DISABLE_SANITIZER_INSTRUMENTATION = 78,
686   ATTR_KIND_NO_SANITIZE_BOUNDS = 79,
687   ATTR_KIND_ALLOC_ALIGN = 80,
688   ATTR_KIND_ALLOCATED_POINTER = 81,
689   ATTR_KIND_ALLOC_KIND = 82,
690   ATTR_KIND_PRESPLIT_COROUTINE = 83,
691   ATTR_KIND_FNRETTHUNK_EXTERN = 84,
692 };
693 
694 enum ComdatSelectionKindCodes {
695   COMDAT_SELECTION_KIND_ANY = 1,
696   COMDAT_SELECTION_KIND_EXACT_MATCH = 2,
697   COMDAT_SELECTION_KIND_LARGEST = 3,
698   COMDAT_SELECTION_KIND_NO_DUPLICATES = 4,
699   COMDAT_SELECTION_KIND_SAME_SIZE = 5,
700 };
701 
702 enum StrtabCodes {
703   STRTAB_BLOB = 1,
704 };
705 
706 enum SymtabCodes {
707   SYMTAB_BLOB = 1,
708 };
709 
710 } // End bitc namespace
711 } // End llvm namespace
712 
713 #endif
714