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 TYPE_CODE_TARGET_TYPE = 26, // TARGET_TYPE 180 }; 181 182 enum OperandBundleTagCode { 183 OPERAND_BUNDLE_TAG = 1, // TAG: [strchr x N] 184 }; 185 186 enum SyncScopeNameCode { 187 SYNC_SCOPE_NAME = 1, 188 }; 189 190 // Value symbol table codes. 191 enum ValueSymtabCodes { 192 VST_CODE_ENTRY = 1, // VST_ENTRY: [valueid, namechar x N] 193 VST_CODE_BBENTRY = 2, // VST_BBENTRY: [bbid, namechar x N] 194 VST_CODE_FNENTRY = 3, // VST_FNENTRY: [valueid, offset, namechar x N] 195 // VST_COMBINED_ENTRY: [valueid, refguid] 196 VST_CODE_COMBINED_ENTRY = 5 197 }; 198 199 // The module path symbol table only has one code (MST_CODE_ENTRY). 200 enum ModulePathSymtabCodes { 201 MST_CODE_ENTRY = 1, // MST_ENTRY: [modid, namechar x N] 202 MST_CODE_HASH = 2, // MST_HASH: [5*i32] 203 }; 204 205 // The summary section uses different codes in the per-module 206 // and combined index cases. 207 enum GlobalValueSummarySymtabCodes { 208 // PERMODULE: [valueid, flags, instcount, numrefs, numrefs x valueid, 209 // n x (valueid)] 210 FS_PERMODULE = 1, 211 // PERMODULE_PROFILE: [valueid, flags, instcount, numrefs, 212 // numrefs x valueid, 213 // n x (valueid, hotness+tailcall)] 214 FS_PERMODULE_PROFILE = 2, 215 // PERMODULE_GLOBALVAR_INIT_REFS: [valueid, flags, n x valueid] 216 FS_PERMODULE_GLOBALVAR_INIT_REFS = 3, 217 // COMBINED: [valueid, modid, flags, instcount, numrefs, numrefs x valueid, 218 // n x (valueid)] 219 FS_COMBINED = 4, 220 // COMBINED_PROFILE: [valueid, modid, flags, instcount, numrefs, 221 // numrefs x valueid, 222 // n x (valueid, hotness+tailcall)] 223 FS_COMBINED_PROFILE = 5, 224 // COMBINED_GLOBALVAR_INIT_REFS: [valueid, modid, flags, n x valueid] 225 FS_COMBINED_GLOBALVAR_INIT_REFS = 6, 226 // ALIAS: [valueid, flags, valueid] 227 FS_ALIAS = 7, 228 // COMBINED_ALIAS: [valueid, modid, flags, valueid] 229 FS_COMBINED_ALIAS = 8, 230 // COMBINED_ORIGINAL_NAME: [original_name_hash] 231 FS_COMBINED_ORIGINAL_NAME = 9, 232 // VERSION of the summary, bumped when adding flags for instance. 233 FS_VERSION = 10, 234 // The list of llvm.type.test type identifiers used by the following function 235 // that are used other than by an llvm.assume. 236 // [n x typeid] 237 FS_TYPE_TESTS = 11, 238 // The list of virtual calls made by this function using 239 // llvm.assume(llvm.type.test) intrinsics that do not have all constant 240 // integer arguments. 241 // [n x (typeid, offset)] 242 FS_TYPE_TEST_ASSUME_VCALLS = 12, 243 // The list of virtual calls made by this function using 244 // llvm.type.checked.load intrinsics that do not have all constant integer 245 // arguments. 246 // [n x (typeid, offset)] 247 FS_TYPE_CHECKED_LOAD_VCALLS = 13, 248 // Identifies a virtual call made by this function using an 249 // llvm.assume(llvm.type.test) intrinsic with all constant integer arguments. 250 // [typeid, offset, n x arg] 251 FS_TYPE_TEST_ASSUME_CONST_VCALL = 14, 252 // Identifies a virtual call made by this function using an 253 // llvm.type.checked.load intrinsic with all constant integer arguments. 254 // [typeid, offset, n x arg] 255 FS_TYPE_CHECKED_LOAD_CONST_VCALL = 15, 256 // Assigns a GUID to a value ID. This normally appears only in combined 257 // summaries, but it can also appear in per-module summaries for PGO data. 258 // [valueid, guid] 259 FS_VALUE_GUID = 16, 260 // The list of local functions with CFI jump tables. Function names are 261 // strings in strtab. 262 // [n * name] 263 FS_CFI_FUNCTION_DEFS = 17, 264 // The list of external functions with CFI jump tables. Function names are 265 // strings in strtab. 266 // [n * name] 267 FS_CFI_FUNCTION_DECLS = 18, 268 // Per-module summary that also adds relative block frequency to callee info. 269 // PERMODULE_RELBF: [valueid, flags, instcount, numrefs, 270 // numrefs x valueid, 271 // n x (valueid, relblockfreq+tailcall)] 272 FS_PERMODULE_RELBF = 19, 273 // Index-wide flags 274 FS_FLAGS = 20, 275 // Maps type identifier to summary information for that type identifier. 276 // Produced by the thin link (only lives in combined index). 277 // TYPE_ID: [typeid, kind, bitwidth, align, size, bitmask, inlinebits, 278 // n x (typeid, kind, name, numrba, 279 // numrba x (numarg, numarg x arg, kind, info, byte, bit))] 280 FS_TYPE_ID = 21, 281 // For background see overview at https://llvm.org/docs/TypeMetadata.html. 282 // The type metadata includes both the type identifier and the offset of 283 // the address point of the type (the address held by objects of that type 284 // which may not be the beginning of the virtual table). Vtable definitions 285 // are decorated with type metadata for the types they are compatible with. 286 // 287 // Maps type identifier to summary information for that type identifier 288 // computed from type metadata: the valueid of each vtable definition 289 // decorated with a type metadata for that identifier, and the offset from 290 // the corresponding type metadata. 291 // Exists in the per-module summary to provide information to thin link 292 // for index-based whole program devirtualization. 293 // TYPE_ID_METADATA: [typeid, n x (valueid, offset)] 294 FS_TYPE_ID_METADATA = 22, 295 // Summarizes vtable definition for use in index-based whole program 296 // devirtualization during the thin link. 297 // PERMODULE_VTABLE_GLOBALVAR_INIT_REFS: [valueid, flags, varflags, 298 // numrefs, numrefs x valueid, 299 // n x (valueid, offset)] 300 FS_PERMODULE_VTABLE_GLOBALVAR_INIT_REFS = 23, 301 // The total number of basic blocks in the module. 302 FS_BLOCK_COUNT = 24, 303 // Range information for accessed offsets for every argument. 304 // [n x (paramno, range, numcalls, numcalls x (callee_guid, paramno, range))] 305 FS_PARAM_ACCESS = 25, 306 // Summary of per-module memprof callsite metadata. 307 // [valueid, n x stackidindex] 308 FS_PERMODULE_CALLSITE_INFO = 26, 309 // Summary of per-module allocation memprof metadata. 310 // [nummib, nummib x (alloc type, context radix tree index), 311 // [nummib x (numcontext x total size)]?] 312 FS_PERMODULE_ALLOC_INFO = 27, 313 // Summary of combined index memprof callsite metadata. 314 // [valueid, context radix tree index, numver, 315 // numver x version] 316 FS_COMBINED_CALLSITE_INFO = 28, 317 // Summary of combined index allocation memprof metadata. 318 // [nummib, numver, 319 // nummib x (alloc type, numstackids, numstackids x stackidindex), 320 // numver x version] 321 FS_COMBINED_ALLOC_INFO = 29, 322 // List of all stack ids referenced by index in the callsite and alloc infos. 323 // [n x stack id] 324 FS_STACK_IDS = 30, 325 // List of all full stack id pairs corresponding to the total sizes recorded 326 // at the end of the alloc info when reporting of hinted bytes is enabled. 327 // We use a fixed-width array, which is more efficient as these ids typically 328 // are close to 64 bits in size. The max fixed width value supported is 32 329 // bits so each 64-bit context id hash is recorded as a pair (upper 32 bits 330 // first). This record must immediately precede the associated alloc info, and 331 // the entries must be in the exact same order as the corresponding sizes. 332 // [nummib x (numcontext x full stack id)] 333 FS_ALLOC_CONTEXT_IDS = 31, 334 // Linearized radix tree of allocation contexts. See the description above the 335 // CallStackRadixTreeBuilder class in ProfileData/MemProf.h for format. 336 // [n x entry] 337 FS_CONTEXT_RADIX_TREE_ARRAY = 32, 338 }; 339 340 enum MetadataCodes { 341 METADATA_STRING_OLD = 1, // MDSTRING: [values] 342 METADATA_VALUE = 2, // VALUE: [type num, value num] 343 METADATA_NODE = 3, // NODE: [n x md num] 344 METADATA_NAME = 4, // STRING: [values] 345 METADATA_DISTINCT_NODE = 5, // DISTINCT_NODE: [n x md num] 346 METADATA_KIND = 6, // [n x [id, name]] 347 METADATA_LOCATION = 7, // [distinct, line, col, scope, inlined-at?] 348 METADATA_OLD_NODE = 8, // OLD_NODE: [n x (type num, value num)] 349 METADATA_OLD_FN_NODE = 9, // OLD_FN_NODE: [n x (type num, value num)] 350 METADATA_NAMED_NODE = 10, // NAMED_NODE: [n x mdnodes] 351 METADATA_ATTACHMENT = 11, // [m x [value, [n x [id, mdnode]]] 352 METADATA_GENERIC_DEBUG = 12, // [distinct, tag, vers, header, n x md num] 353 METADATA_SUBRANGE = 13, // [distinct, count, lo] 354 METADATA_ENUMERATOR = 14, // [isUnsigned|distinct, value, name] 355 METADATA_BASIC_TYPE = 15, // [distinct, tag, name, size, align, enc] 356 METADATA_FILE = 16, // [distinct, filename, directory, checksumkind, checksum] 357 METADATA_DERIVED_TYPE = 17, // [distinct, ...] 358 METADATA_COMPOSITE_TYPE = 18, // [distinct, ...] 359 METADATA_SUBROUTINE_TYPE = 19, // [distinct, flags, types, cc] 360 METADATA_COMPILE_UNIT = 20, // [distinct, ...] 361 METADATA_SUBPROGRAM = 21, // [distinct, ...] 362 METADATA_LEXICAL_BLOCK = 22, // [distinct, scope, file, line, column] 363 METADATA_LEXICAL_BLOCK_FILE = 23, //[distinct, scope, file, discriminator] 364 METADATA_NAMESPACE = 24, // [distinct, scope, file, name, line, exportSymbols] 365 METADATA_TEMPLATE_TYPE = 25, // [distinct, scope, name, type, ...] 366 METADATA_TEMPLATE_VALUE = 26, // [distinct, scope, name, type, value, ...] 367 METADATA_GLOBAL_VAR = 27, // [distinct, ...] 368 METADATA_LOCAL_VAR = 28, // [distinct, ...] 369 METADATA_EXPRESSION = 29, // [distinct, n x element] 370 METADATA_OBJC_PROPERTY = 30, // [distinct, name, file, line, ...] 371 METADATA_IMPORTED_ENTITY = 31, // [distinct, tag, scope, entity, line, name] 372 METADATA_MODULE = 32, // [distinct, scope, name, ...] 373 METADATA_MACRO = 33, // [distinct, macinfo, line, name, value] 374 METADATA_MACRO_FILE = 34, // [distinct, macinfo, line, file, ...] 375 METADATA_STRINGS = 35, // [count, offset] blob([lengths][chars]) 376 METADATA_GLOBAL_DECL_ATTACHMENT = 36, // [valueid, n x [id, mdnode]] 377 METADATA_GLOBAL_VAR_EXPR = 37, // [distinct, var, expr] 378 METADATA_INDEX_OFFSET = 38, // [offset] 379 METADATA_INDEX = 39, // [bitpos] 380 METADATA_LABEL = 40, // [distinct, scope, name, file, line] 381 METADATA_STRING_TYPE = 41, // [distinct, name, size, align,...] 382 // Codes 42 and 43 are reserved for support for Fortran array specific debug 383 // info. 384 METADATA_COMMON_BLOCK = 44, // [distinct, scope, name, variable,...] 385 METADATA_GENERIC_SUBRANGE = 45, // [distinct, count, lo, up, stride] 386 METADATA_ARG_LIST = 46, // [n x [type num, value num]] 387 METADATA_ASSIGN_ID = 47, // [distinct, ...] 388 }; 389 390 // The constants block (CONSTANTS_BLOCK_ID) describes emission for each 391 // constant and maintains an implicit current type value. 392 enum ConstantsCodes { 393 CST_CODE_SETTYPE = 1, // SETTYPE: [typeid] 394 CST_CODE_NULL = 2, // NULL 395 CST_CODE_UNDEF = 3, // UNDEF 396 CST_CODE_INTEGER = 4, // INTEGER: [intval] 397 CST_CODE_WIDE_INTEGER = 5, // WIDE_INTEGER: [n x intval] 398 CST_CODE_FLOAT = 6, // FLOAT: [fpval] 399 CST_CODE_AGGREGATE = 7, // AGGREGATE: [n x value number] 400 CST_CODE_STRING = 8, // STRING: [values] 401 CST_CODE_CSTRING = 9, // CSTRING: [values] 402 CST_CODE_CE_BINOP = 10, // CE_BINOP: [opcode, opval, opval] 403 CST_CODE_CE_CAST = 11, // CE_CAST: [opcode, opty, opval] 404 CST_CODE_CE_GEP_OLD = 12, // CE_GEP: [n x operands] 405 CST_CODE_CE_SELECT = 13, // CE_SELECT: [opval, opval, opval] 406 CST_CODE_CE_EXTRACTELT = 14, // CE_EXTRACTELT: [opty, opval, opval] 407 CST_CODE_CE_INSERTELT = 15, // CE_INSERTELT: [opval, opval, opval] 408 CST_CODE_CE_SHUFFLEVEC = 16, // CE_SHUFFLEVEC: [opval, opval, opval] 409 CST_CODE_CE_CMP = 17, // CE_CMP: [opty, opval, opval, pred] 410 CST_CODE_INLINEASM_OLD = 18, // INLINEASM: [sideeffect|alignstack, 411 // asmstr,conststr] 412 CST_CODE_CE_SHUFVEC_EX = 19, // SHUFVEC_EX: [opty, opval, opval, opval] 413 CST_CODE_CE_INBOUNDS_GEP = 20, // INBOUNDS_GEP: [n x operands] 414 CST_CODE_BLOCKADDRESS = 21, // CST_CODE_BLOCKADDRESS [fnty, fnval, bb#] 415 CST_CODE_DATA = 22, // DATA: [n x elements] 416 CST_CODE_INLINEASM_OLD2 = 23, // INLINEASM: [sideeffect|alignstack| 417 // asmdialect,asmstr,conststr] 418 CST_CODE_CE_GEP_WITH_INRANGE_INDEX_OLD = 24, // [opty, flags, n x operands] 419 CST_CODE_CE_UNOP = 25, // CE_UNOP: [opcode, opval] 420 CST_CODE_POISON = 26, // POISON 421 CST_CODE_DSO_LOCAL_EQUIVALENT = 27, // DSO_LOCAL_EQUIVALENT [gvty, gv] 422 CST_CODE_INLINEASM_OLD3 = 28, // INLINEASM: [sideeffect|alignstack| 423 // asmdialect|unwind, 424 // asmstr,conststr] 425 CST_CODE_NO_CFI_VALUE = 29, // NO_CFI [ fty, f ] 426 CST_CODE_INLINEASM = 30, // INLINEASM: [fnty, 427 // sideeffect|alignstack| 428 // asmdialect|unwind, 429 // asmstr,conststr] 430 CST_CODE_CE_GEP_WITH_INRANGE = 31, // [opty, flags, range, n x operands] 431 CST_CODE_CE_GEP = 32, // [opty, flags, n x operands] 432 CST_CODE_PTRAUTH = 33, // [ptr, key, disc, addrdisc] 433 }; 434 435 /// CastOpcodes - These are values used in the bitcode files to encode which 436 /// cast a CST_CODE_CE_CAST or a XXX refers to. The values of these enums 437 /// have no fixed relation to the LLVM IR enum values. Changing these will 438 /// break compatibility with old files. 439 enum CastOpcodes { 440 CAST_TRUNC = 0, 441 CAST_ZEXT = 1, 442 CAST_SEXT = 2, 443 CAST_FPTOUI = 3, 444 CAST_FPTOSI = 4, 445 CAST_UITOFP = 5, 446 CAST_SITOFP = 6, 447 CAST_FPTRUNC = 7, 448 CAST_FPEXT = 8, 449 CAST_PTRTOINT = 9, 450 CAST_INTTOPTR = 10, 451 CAST_BITCAST = 11, 452 CAST_ADDRSPACECAST = 12 453 }; 454 455 /// UnaryOpcodes - These are values used in the bitcode files to encode which 456 /// unop a CST_CODE_CE_UNOP or a XXX refers to. The values of these enums 457 /// have no fixed relation to the LLVM IR enum values. Changing these will 458 /// break compatibility with old files. 459 enum UnaryOpcodes { 460 UNOP_FNEG = 0 461 }; 462 463 /// BinaryOpcodes - These are values used in the bitcode files to encode which 464 /// binop a CST_CODE_CE_BINOP or a XXX refers to. The values of these enums 465 /// have no fixed relation to the LLVM IR enum values. Changing these will 466 /// break compatibility with old files. 467 enum BinaryOpcodes { 468 BINOP_ADD = 0, 469 BINOP_SUB = 1, 470 BINOP_MUL = 2, 471 BINOP_UDIV = 3, 472 BINOP_SDIV = 4, // overloaded for FP 473 BINOP_UREM = 5, 474 BINOP_SREM = 6, // overloaded for FP 475 BINOP_SHL = 7, 476 BINOP_LSHR = 8, 477 BINOP_ASHR = 9, 478 BINOP_AND = 10, 479 BINOP_OR = 11, 480 BINOP_XOR = 12 481 }; 482 483 /// These are values used in the bitcode files to encode AtomicRMW operations. 484 /// The values of these enums have no fixed relation to the LLVM IR enum 485 /// values. Changing these will break compatibility with old files. 486 enum RMWOperations { 487 RMW_XCHG = 0, 488 RMW_ADD = 1, 489 RMW_SUB = 2, 490 RMW_AND = 3, 491 RMW_NAND = 4, 492 RMW_OR = 5, 493 RMW_XOR = 6, 494 RMW_MAX = 7, 495 RMW_MIN = 8, 496 RMW_UMAX = 9, 497 RMW_UMIN = 10, 498 RMW_FADD = 11, 499 RMW_FSUB = 12, 500 RMW_FMAX = 13, 501 RMW_FMIN = 14, 502 RMW_UINC_WRAP = 15, 503 RMW_UDEC_WRAP = 16, 504 RMW_USUB_COND = 17, 505 RMW_USUB_SAT = 18 506 }; 507 508 /// OverflowingBinaryOperatorOptionalFlags - Flags for serializing 509 /// OverflowingBinaryOperator's SubclassOptionalData contents. 510 enum OverflowingBinaryOperatorOptionalFlags { 511 OBO_NO_UNSIGNED_WRAP = 0, 512 OBO_NO_SIGNED_WRAP = 1 513 }; 514 515 /// TruncInstOptionalFlags - Flags for serializing 516 /// TruncInstOptionalFlags's SubclassOptionalData contents. 517 enum TruncInstOptionalFlags { 518 TIO_NO_UNSIGNED_WRAP = 0, 519 TIO_NO_SIGNED_WRAP = 1 520 }; 521 522 /// FastMath Flags 523 /// This is a fixed layout derived from the bitcode emitted by LLVM 5.0 524 /// intended to decouple the in-memory representation from the serialization. 525 enum FastMathMap { 526 UnsafeAlgebra = (1 << 0), // Legacy 527 NoNaNs = (1 << 1), 528 NoInfs = (1 << 2), 529 NoSignedZeros = (1 << 3), 530 AllowReciprocal = (1 << 4), 531 AllowContract = (1 << 5), 532 ApproxFunc = (1 << 6), 533 AllowReassoc = (1 << 7) 534 }; 535 536 /// Flags for serializing PossiblyNonNegInst's SubclassOptionalData contents. 537 enum PossiblyNonNegInstOptionalFlags { PNNI_NON_NEG = 0 }; 538 539 /// PossiblyExactOperatorOptionalFlags - Flags for serializing 540 /// PossiblyExactOperator's SubclassOptionalData contents. 541 enum PossiblyExactOperatorOptionalFlags { PEO_EXACT = 0 }; 542 543 /// PossiblyDisjointInstOptionalFlags - Flags for serializing 544 /// PossiblyDisjointInst's SubclassOptionalData contents. 545 enum PossiblyDisjointInstOptionalFlags { PDI_DISJOINT = 0 }; 546 547 /// Mark to distinguish metadata from value in an operator bundle. 548 enum MetadataOperandBundleValueMarker { OB_METADATA = 0x80000000 }; 549 550 /// GetElementPtrOptionalFlags - Flags for serializing 551 /// GEPOperator's SubclassOptionalData contents. 552 enum GetElementPtrOptionalFlags { 553 GEP_INBOUNDS = 0, 554 GEP_NUSW = 1, 555 GEP_NUW = 2, 556 }; 557 558 /// ICmpOptionalFlags - Flags for serializing 559 /// ICmpOptionalFlags's SubclassOptionalData contents. 560 enum ICmpOptionalFlags { ICMP_SAME_SIGN = 0 }; 561 562 /// Encoded AtomicOrdering values. 563 enum AtomicOrderingCodes { 564 ORDERING_NOTATOMIC = 0, 565 ORDERING_UNORDERED = 1, 566 ORDERING_MONOTONIC = 2, 567 ORDERING_ACQUIRE = 3, 568 ORDERING_RELEASE = 4, 569 ORDERING_ACQREL = 5, 570 ORDERING_SEQCST = 6 571 }; 572 573 /// Markers and flags for call instruction. 574 enum CallMarkersFlags { 575 CALL_TAIL = 0, 576 CALL_CCONV = 1, 577 CALL_MUSTTAIL = 14, 578 CALL_EXPLICIT_TYPE = 15, 579 CALL_NOTAIL = 16, 580 CALL_FMF = 17 // Call has optional fast-math-flags. 581 }; 582 583 // The function body block (FUNCTION_BLOCK_ID) describes function bodies. It 584 // can contain a constant block (CONSTANTS_BLOCK_ID). 585 enum FunctionCodes { 586 FUNC_CODE_DECLAREBLOCKS = 1, // DECLAREBLOCKS: [n] 587 588 FUNC_CODE_INST_BINOP = 2, // BINOP: [opcode, ty, opval, opval] 589 FUNC_CODE_INST_CAST = 3, // CAST: [opcode, ty, opty, opval] 590 FUNC_CODE_INST_GEP_OLD = 4, // GEP: [n x operands] 591 FUNC_CODE_INST_SELECT = 5, // SELECT: [ty, opval, opval, opval] 592 FUNC_CODE_INST_EXTRACTELT = 6, // EXTRACTELT: [opty, opval, opval] 593 FUNC_CODE_INST_INSERTELT = 7, // INSERTELT: [ty, opval, opval, opval] 594 FUNC_CODE_INST_SHUFFLEVEC = 8, // SHUFFLEVEC: [ty, opval, opval, opval] 595 FUNC_CODE_INST_CMP = 9, // CMP: [opty, opval, opval, pred] 596 597 FUNC_CODE_INST_RET = 10, // RET: [opty,opval<both optional>] 598 FUNC_CODE_INST_BR = 11, // BR: [bb#, bb#, cond] or [bb#] 599 FUNC_CODE_INST_SWITCH = 12, // SWITCH: [opty, op0, op1, ...] 600 FUNC_CODE_INST_INVOKE = 13, // INVOKE: [attr, fnty, op0,op1, ...] 601 // 14 is unused. 602 FUNC_CODE_INST_UNREACHABLE = 15, // UNREACHABLE 603 604 FUNC_CODE_INST_PHI = 16, // PHI: [ty, val0,bb0, ...] 605 // 17 is unused. 606 // 18 is unused. 607 FUNC_CODE_INST_ALLOCA = 19, // ALLOCA: [instty, opty, op, align] 608 FUNC_CODE_INST_LOAD = 20, // LOAD: [opty, op, align, vol] 609 // 21 is unused. 610 // 22 is unused. 611 FUNC_CODE_INST_VAARG = 23, // VAARG: [valistty, valist, instty] 612 // This store code encodes the pointer type, rather than the value type 613 // this is so information only available in the pointer type (e.g. address 614 // spaces) is retained. 615 FUNC_CODE_INST_STORE_OLD = 24, // STORE: [ptrty,ptr,val, align, vol] 616 // 25 is unused. 617 FUNC_CODE_INST_EXTRACTVAL = 26, // EXTRACTVAL: [n x operands] 618 FUNC_CODE_INST_INSERTVAL = 27, // INSERTVAL: [n x operands] 619 // fcmp/icmp returning Int1TY or vector of Int1Ty. Same as CMP, exists to 620 // support legacy vicmp/vfcmp instructions. 621 FUNC_CODE_INST_CMP2 = 28, // CMP2: [opty, opval, opval, pred] 622 // new select on i1 or [N x i1] 623 FUNC_CODE_INST_VSELECT = 29, // VSELECT: [ty,opval,opval,predty,pred] 624 FUNC_CODE_INST_INBOUNDS_GEP_OLD = 30, // INBOUNDS_GEP: [n x operands] 625 FUNC_CODE_INST_INDIRECTBR = 31, // INDIRECTBR: [opty, op0, op1, ...] 626 // 32 is unused. 627 FUNC_CODE_DEBUG_LOC_AGAIN = 33, // DEBUG_LOC_AGAIN 628 629 FUNC_CODE_INST_CALL = 34, // CALL: [attr, cc, fnty, fnid, args...] 630 631 FUNC_CODE_DEBUG_LOC = 35, // DEBUG_LOC: [Line,Col,ScopeVal, IAVal] 632 FUNC_CODE_INST_FENCE = 36, // FENCE: [ordering, synchscope] 633 FUNC_CODE_INST_CMPXCHG_OLD = 37, // CMPXCHG: [ptrty, ptr, cmp, val, vol, 634 // ordering, synchscope, 635 // failure_ordering?, weak?] 636 FUNC_CODE_INST_ATOMICRMW_OLD = 38, // ATOMICRMW: [ptrty,ptr,val, operation, 637 // align, vol, 638 // ordering, synchscope] 639 FUNC_CODE_INST_RESUME = 39, // RESUME: [opval] 640 FUNC_CODE_INST_LANDINGPAD_OLD = 641 40, // LANDINGPAD: [ty,val,val,num,id0,val0...] 642 FUNC_CODE_INST_LOADATOMIC = 41, // LOAD: [opty, op, align, vol, 643 // ordering, synchscope] 644 FUNC_CODE_INST_STOREATOMIC_OLD = 42, // STORE: [ptrty,ptr,val, align, vol 645 // ordering, synchscope] 646 FUNC_CODE_INST_GEP = 43, // GEP: [inbounds, n x operands] 647 FUNC_CODE_INST_STORE = 44, // STORE: [ptrty,ptr,valty,val, align, vol] 648 FUNC_CODE_INST_STOREATOMIC = 45, // STORE: [ptrty,ptr,val, align, vol 649 FUNC_CODE_INST_CMPXCHG = 46, // CMPXCHG: [ptrty, ptr, cmp, val, vol, 650 // success_ordering, synchscope, 651 // failure_ordering, weak] 652 FUNC_CODE_INST_LANDINGPAD = 47, // LANDINGPAD: [ty,val,num,id0,val0...] 653 FUNC_CODE_INST_CLEANUPRET = 48, // CLEANUPRET: [val] or [val,bb#] 654 FUNC_CODE_INST_CATCHRET = 49, // CATCHRET: [val,bb#] 655 FUNC_CODE_INST_CATCHPAD = 50, // CATCHPAD: [bb#,bb#,num,args...] 656 FUNC_CODE_INST_CLEANUPPAD = 51, // CLEANUPPAD: [num,args...] 657 FUNC_CODE_INST_CATCHSWITCH = 658 52, // CATCHSWITCH: [num,args...] or [num,args...,bb] 659 // 53 is unused. 660 // 54 is unused. 661 FUNC_CODE_OPERAND_BUNDLE = 55, // OPERAND_BUNDLE: [tag#, value...] 662 FUNC_CODE_INST_UNOP = 56, // UNOP: [opcode, ty, opval] 663 FUNC_CODE_INST_CALLBR = 57, // CALLBR: [attr, cc, norm, transfs, 664 // fnty, fnid, args...] 665 FUNC_CODE_INST_FREEZE = 58, // FREEZE: [opty, opval] 666 FUNC_CODE_INST_ATOMICRMW = 59, // ATOMICRMW: [ptrty, ptr, valty, val, 667 // operation, align, vol, 668 // ordering, synchscope] 669 FUNC_CODE_BLOCKADDR_USERS = 60, // BLOCKADDR_USERS: [value...] 670 671 FUNC_CODE_DEBUG_RECORD_VALUE = 672 61, // [DILocation, DILocalVariable, DIExpression, ValueAsMetadata] 673 FUNC_CODE_DEBUG_RECORD_DECLARE = 674 62, // [DILocation, DILocalVariable, DIExpression, ValueAsMetadata] 675 FUNC_CODE_DEBUG_RECORD_ASSIGN = 676 63, // [DILocation, DILocalVariable, DIExpression, ValueAsMetadata, 677 // DIAssignID, DIExpression (addr), ValueAsMetadata (addr)] 678 FUNC_CODE_DEBUG_RECORD_VALUE_SIMPLE = 679 64, // [DILocation, DILocalVariable, DIExpression, Value] 680 FUNC_CODE_DEBUG_RECORD_LABEL = 65, // [DILocation, DILabel] 681 }; 682 683 enum UseListCodes { 684 USELIST_CODE_DEFAULT = 1, // DEFAULT: [index..., value-id] 685 USELIST_CODE_BB = 2 // BB: [index..., bb-id] 686 }; 687 688 enum AttributeKindCodes { 689 // = 0 is unused 690 ATTR_KIND_ALIGNMENT = 1, 691 ATTR_KIND_ALWAYS_INLINE = 2, 692 ATTR_KIND_BY_VAL = 3, 693 ATTR_KIND_INLINE_HINT = 4, 694 ATTR_KIND_IN_REG = 5, 695 ATTR_KIND_MIN_SIZE = 6, 696 ATTR_KIND_NAKED = 7, 697 ATTR_KIND_NEST = 8, 698 ATTR_KIND_NO_ALIAS = 9, 699 ATTR_KIND_NO_BUILTIN = 10, 700 ATTR_KIND_NO_CAPTURE = 11, 701 ATTR_KIND_NO_DUPLICATE = 12, 702 ATTR_KIND_NO_IMPLICIT_FLOAT = 13, 703 ATTR_KIND_NO_INLINE = 14, 704 ATTR_KIND_NON_LAZY_BIND = 15, 705 ATTR_KIND_NO_RED_ZONE = 16, 706 ATTR_KIND_NO_RETURN = 17, 707 ATTR_KIND_NO_UNWIND = 18, 708 ATTR_KIND_OPTIMIZE_FOR_SIZE = 19, 709 ATTR_KIND_READ_NONE = 20, 710 ATTR_KIND_READ_ONLY = 21, 711 ATTR_KIND_RETURNED = 22, 712 ATTR_KIND_RETURNS_TWICE = 23, 713 ATTR_KIND_S_EXT = 24, 714 ATTR_KIND_STACK_ALIGNMENT = 25, 715 ATTR_KIND_STACK_PROTECT = 26, 716 ATTR_KIND_STACK_PROTECT_REQ = 27, 717 ATTR_KIND_STACK_PROTECT_STRONG = 28, 718 ATTR_KIND_STRUCT_RET = 29, 719 ATTR_KIND_SANITIZE_ADDRESS = 30, 720 ATTR_KIND_SANITIZE_THREAD = 31, 721 ATTR_KIND_SANITIZE_MEMORY = 32, 722 ATTR_KIND_UW_TABLE = 33, 723 ATTR_KIND_Z_EXT = 34, 724 ATTR_KIND_BUILTIN = 35, 725 ATTR_KIND_COLD = 36, 726 ATTR_KIND_OPTIMIZE_NONE = 37, 727 ATTR_KIND_IN_ALLOCA = 38, 728 ATTR_KIND_NON_NULL = 39, 729 ATTR_KIND_JUMP_TABLE = 40, 730 ATTR_KIND_DEREFERENCEABLE = 41, 731 ATTR_KIND_DEREFERENCEABLE_OR_NULL = 42, 732 ATTR_KIND_CONVERGENT = 43, 733 ATTR_KIND_SAFESTACK = 44, 734 ATTR_KIND_ARGMEMONLY = 45, 735 ATTR_KIND_SWIFT_SELF = 46, 736 ATTR_KIND_SWIFT_ERROR = 47, 737 ATTR_KIND_NO_RECURSE = 48, 738 ATTR_KIND_INACCESSIBLEMEM_ONLY = 49, 739 ATTR_KIND_INACCESSIBLEMEM_OR_ARGMEMONLY = 50, 740 ATTR_KIND_ALLOC_SIZE = 51, 741 ATTR_KIND_WRITEONLY = 52, 742 ATTR_KIND_SPECULATABLE = 53, 743 ATTR_KIND_STRICT_FP = 54, 744 ATTR_KIND_SANITIZE_HWADDRESS = 55, 745 ATTR_KIND_NOCF_CHECK = 56, 746 ATTR_KIND_OPT_FOR_FUZZING = 57, 747 ATTR_KIND_SHADOWCALLSTACK = 58, 748 ATTR_KIND_SPECULATIVE_LOAD_HARDENING = 59, 749 ATTR_KIND_IMMARG = 60, 750 ATTR_KIND_WILLRETURN = 61, 751 ATTR_KIND_NOFREE = 62, 752 ATTR_KIND_NOSYNC = 63, 753 ATTR_KIND_SANITIZE_MEMTAG = 64, 754 ATTR_KIND_PREALLOCATED = 65, 755 ATTR_KIND_NO_MERGE = 66, 756 ATTR_KIND_NULL_POINTER_IS_VALID = 67, 757 ATTR_KIND_NOUNDEF = 68, 758 ATTR_KIND_BYREF = 69, 759 ATTR_KIND_MUSTPROGRESS = 70, 760 ATTR_KIND_NO_CALLBACK = 71, 761 ATTR_KIND_HOT = 72, 762 ATTR_KIND_NO_PROFILE = 73, 763 ATTR_KIND_VSCALE_RANGE = 74, 764 ATTR_KIND_SWIFT_ASYNC = 75, 765 ATTR_KIND_NO_SANITIZE_COVERAGE = 76, 766 ATTR_KIND_ELEMENTTYPE = 77, 767 ATTR_KIND_DISABLE_SANITIZER_INSTRUMENTATION = 78, 768 ATTR_KIND_NO_SANITIZE_BOUNDS = 79, 769 ATTR_KIND_ALLOC_ALIGN = 80, 770 ATTR_KIND_ALLOCATED_POINTER = 81, 771 ATTR_KIND_ALLOC_KIND = 82, 772 ATTR_KIND_PRESPLIT_COROUTINE = 83, 773 ATTR_KIND_FNRETTHUNK_EXTERN = 84, 774 ATTR_KIND_SKIP_PROFILE = 85, 775 ATTR_KIND_MEMORY = 86, 776 ATTR_KIND_NOFPCLASS = 87, 777 ATTR_KIND_OPTIMIZE_FOR_DEBUGGING = 88, 778 ATTR_KIND_WRITABLE = 89, 779 ATTR_KIND_CORO_ONLY_DESTROY_WHEN_COMPLETE = 90, 780 ATTR_KIND_DEAD_ON_UNWIND = 91, 781 ATTR_KIND_RANGE = 92, 782 ATTR_KIND_SANITIZE_NUMERICAL_STABILITY = 93, 783 ATTR_KIND_INITIALIZES = 94, 784 ATTR_KIND_HYBRID_PATCHABLE = 95, 785 ATTR_KIND_SANITIZE_REALTIME = 96, 786 ATTR_KIND_SANITIZE_REALTIME_BLOCKING = 97, 787 ATTR_KIND_CORO_ELIDE_SAFE = 98, 788 ATTR_KIND_NO_EXT = 99, 789 ATTR_KIND_NO_DIVERGENCE_SOURCE = 100, 790 ATTR_KIND_SANITIZE_TYPE = 101, 791 ATTR_KIND_CAPTURES = 102, 792 }; 793 794 enum ComdatSelectionKindCodes { 795 COMDAT_SELECTION_KIND_ANY = 1, 796 COMDAT_SELECTION_KIND_EXACT_MATCH = 2, 797 COMDAT_SELECTION_KIND_LARGEST = 3, 798 COMDAT_SELECTION_KIND_NO_DUPLICATES = 4, 799 COMDAT_SELECTION_KIND_SAME_SIZE = 5, 800 }; 801 802 enum StrtabCodes { 803 STRTAB_BLOB = 1, 804 }; 805 806 enum SymtabCodes { 807 SYMTAB_BLOB = 1, 808 }; 809 810 } // End bitc namespace 811 } // End llvm namespace 812 813 #endif 814