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