1 /*===-- llvm-c/Core.h - Core Library C Interface ------------------*- C -*-===*\ 2 |* *| 3 |* The LLVM Compiler Infrastructure *| 4 |* *| 5 |* This file is distributed under the University of Illinois Open Source *| 6 |* License. See LICENSE.TXT for details. *| 7 |* *| 8 |*===----------------------------------------------------------------------===*| 9 |* *| 10 |* This header declares the C interface to libLLVMCore.a, which implements *| 11 |* the LLVM intermediate representation. *| 12 |* *| 13 \*===----------------------------------------------------------------------===*/ 14 15 #ifndef LLVM_C_CORE_H 16 #define LLVM_C_CORE_H 17 18 #include "llvm-c/Support.h" 19 20 #ifdef __cplusplus 21 extern "C" { 22 #endif 23 24 /** 25 * @defgroup LLVMC LLVM-C: C interface to LLVM 26 * 27 * This module exposes parts of the LLVM library as a C API. 28 * 29 * @{ 30 */ 31 32 /** 33 * @defgroup LLVMCTransforms Transforms 34 */ 35 36 /** 37 * @defgroup LLVMCCore Core 38 * 39 * This modules provide an interface to libLLVMCore, which implements 40 * the LLVM intermediate representation as well as other related types 41 * and utilities. 42 * 43 * LLVM uses a polymorphic type hierarchy which C cannot represent, therefore 44 * parameters must be passed as base types. Despite the declared types, most 45 * of the functions provided operate only on branches of the type hierarchy. 46 * The declared parameter names are descriptive and specify which type is 47 * required. Additionally, each type hierarchy is documented along with the 48 * functions that operate upon it. For more detail, refer to LLVM's C++ code. 49 * If in doubt, refer to Core.cpp, which performs parameter downcasts in the 50 * form unwrap<RequiredType>(Param). 51 * 52 * Many exotic languages can interoperate with C code but have a harder time 53 * with C++ due to name mangling. So in addition to C, this interface enables 54 * tools written in such languages. 55 * 56 * @{ 57 */ 58 59 /** 60 * @defgroup LLVMCCoreTypes Types and Enumerations 61 * 62 * @{ 63 */ 64 65 /* Opaque types. */ 66 67 /** 68 * The top-level container for all LLVM global data. See the LLVMContext class. 69 */ 70 typedef struct LLVMOpaqueContext *LLVMContextRef; 71 72 /** 73 * The top-level container for all other LLVM Intermediate Representation (IR) 74 * objects. 75 * 76 * @see llvm::Module 77 */ 78 typedef struct LLVMOpaqueModule *LLVMModuleRef; 79 80 /** 81 * Each value in the LLVM IR has a type, an LLVMTypeRef. 82 * 83 * @see llvm::Type 84 */ 85 typedef struct LLVMOpaqueType *LLVMTypeRef; 86 87 /** 88 * Represents an individual value in LLVM IR. 89 * 90 * This models llvm::Value. 91 */ 92 typedef struct LLVMOpaqueValue *LLVMValueRef; 93 94 /** 95 * Represents a basic block of instructions in LLVM IR. 96 * 97 * This models llvm::BasicBlock. 98 */ 99 typedef struct LLVMOpaqueBasicBlock *LLVMBasicBlockRef; 100 101 /** 102 * Represents an LLVM basic block builder. 103 * 104 * This models llvm::IRBuilder. 105 */ 106 typedef struct LLVMOpaqueBuilder *LLVMBuilderRef; 107 108 /** 109 * Interface used to provide a module to JIT or interpreter. 110 * This is now just a synonym for llvm::Module, but we have to keep using the 111 * different type to keep binary compatibility. 112 */ 113 typedef struct LLVMOpaqueModuleProvider *LLVMModuleProviderRef; 114 115 /** @see llvm::PassManagerBase */ 116 typedef struct LLVMOpaquePassManager *LLVMPassManagerRef; 117 118 /** @see llvm::PassRegistry */ 119 typedef struct LLVMOpaquePassRegistry *LLVMPassRegistryRef; 120 121 /** 122 * Used to get the users and usees of a Value. 123 * 124 * @see llvm::Use */ 125 typedef struct LLVMOpaqueUse *LLVMUseRef; 126 127 128 /** 129 * @see llvm::DiagnosticInfo 130 */ 131 typedef struct LLVMOpaqueDiagnosticInfo *LLVMDiagnosticInfoRef; 132 133 typedef enum { 134 LLVMZExtAttribute = 1<<0, 135 LLVMSExtAttribute = 1<<1, 136 LLVMNoReturnAttribute = 1<<2, 137 LLVMInRegAttribute = 1<<3, 138 LLVMStructRetAttribute = 1<<4, 139 LLVMNoUnwindAttribute = 1<<5, 140 LLVMNoAliasAttribute = 1<<6, 141 LLVMByValAttribute = 1<<7, 142 LLVMNestAttribute = 1<<8, 143 LLVMReadNoneAttribute = 1<<9, 144 LLVMReadOnlyAttribute = 1<<10, 145 LLVMNoInlineAttribute = 1<<11, 146 LLVMAlwaysInlineAttribute = 1<<12, 147 LLVMOptimizeForSizeAttribute = 1<<13, 148 LLVMStackProtectAttribute = 1<<14, 149 LLVMStackProtectReqAttribute = 1<<15, 150 LLVMAlignment = 31<<16, 151 LLVMNoCaptureAttribute = 1<<21, 152 LLVMNoRedZoneAttribute = 1<<22, 153 LLVMNoImplicitFloatAttribute = 1<<23, 154 LLVMNakedAttribute = 1<<24, 155 LLVMInlineHintAttribute = 1<<25, 156 LLVMStackAlignment = 7<<26, 157 LLVMReturnsTwice = 1 << 29, 158 LLVMUWTable = 1 << 30, 159 LLVMNonLazyBind = 1 << 31 160 161 /* FIXME: These attributes are currently not included in the C API as 162 a temporary measure until the API/ABI impact to the C API is understood 163 and the path forward agreed upon. 164 LLVMAddressSafety = 1ULL << 32, 165 LLVMStackProtectStrongAttribute = 1ULL<<33, 166 LLVMCold = 1ULL << 34, 167 LLVMOptimizeNone = 1ULL << 35, 168 LLVMInAllocaAttribute = 1ULL << 36, 169 LLVMNonNullAttribute = 1ULL << 37, 170 LLVMJumpTableAttribute = 1ULL << 38, 171 LLVMDereferenceableAttribute = 1ULL << 39, 172 */ 173 } LLVMAttribute; 174 175 typedef enum { 176 /* Terminator Instructions */ 177 LLVMRet = 1, 178 LLVMBr = 2, 179 LLVMSwitch = 3, 180 LLVMIndirectBr = 4, 181 LLVMInvoke = 5, 182 /* removed 6 due to API changes */ 183 LLVMUnreachable = 7, 184 185 /* Standard Binary Operators */ 186 LLVMAdd = 8, 187 LLVMFAdd = 9, 188 LLVMSub = 10, 189 LLVMFSub = 11, 190 LLVMMul = 12, 191 LLVMFMul = 13, 192 LLVMUDiv = 14, 193 LLVMSDiv = 15, 194 LLVMFDiv = 16, 195 LLVMURem = 17, 196 LLVMSRem = 18, 197 LLVMFRem = 19, 198 199 /* Logical Operators */ 200 LLVMShl = 20, 201 LLVMLShr = 21, 202 LLVMAShr = 22, 203 LLVMAnd = 23, 204 LLVMOr = 24, 205 LLVMXor = 25, 206 207 /* Memory Operators */ 208 LLVMAlloca = 26, 209 LLVMLoad = 27, 210 LLVMStore = 28, 211 LLVMGetElementPtr = 29, 212 213 /* Cast Operators */ 214 LLVMTrunc = 30, 215 LLVMZExt = 31, 216 LLVMSExt = 32, 217 LLVMFPToUI = 33, 218 LLVMFPToSI = 34, 219 LLVMUIToFP = 35, 220 LLVMSIToFP = 36, 221 LLVMFPTrunc = 37, 222 LLVMFPExt = 38, 223 LLVMPtrToInt = 39, 224 LLVMIntToPtr = 40, 225 LLVMBitCast = 41, 226 LLVMAddrSpaceCast = 60, 227 228 /* Other Operators */ 229 LLVMICmp = 42, 230 LLVMFCmp = 43, 231 LLVMPHI = 44, 232 LLVMCall = 45, 233 LLVMSelect = 46, 234 LLVMUserOp1 = 47, 235 LLVMUserOp2 = 48, 236 LLVMVAArg = 49, 237 LLVMExtractElement = 50, 238 LLVMInsertElement = 51, 239 LLVMShuffleVector = 52, 240 LLVMExtractValue = 53, 241 LLVMInsertValue = 54, 242 243 /* Atomic operators */ 244 LLVMFence = 55, 245 LLVMAtomicCmpXchg = 56, 246 LLVMAtomicRMW = 57, 247 248 /* Exception Handling Operators */ 249 LLVMResume = 58, 250 LLVMLandingPad = 59 251 252 } LLVMOpcode; 253 254 typedef enum { 255 LLVMVoidTypeKind, /**< type with no size */ 256 LLVMHalfTypeKind, /**< 16 bit floating point type */ 257 LLVMFloatTypeKind, /**< 32 bit floating point type */ 258 LLVMDoubleTypeKind, /**< 64 bit floating point type */ 259 LLVMX86_FP80TypeKind, /**< 80 bit floating point type (X87) */ 260 LLVMFP128TypeKind, /**< 128 bit floating point type (112-bit mantissa)*/ 261 LLVMPPC_FP128TypeKind, /**< 128 bit floating point type (two 64-bits) */ 262 LLVMLabelTypeKind, /**< Labels */ 263 LLVMIntegerTypeKind, /**< Arbitrary bit width integers */ 264 LLVMFunctionTypeKind, /**< Functions */ 265 LLVMStructTypeKind, /**< Structures */ 266 LLVMArrayTypeKind, /**< Arrays */ 267 LLVMPointerTypeKind, /**< Pointers */ 268 LLVMVectorTypeKind, /**< SIMD 'packed' format, or other vector type */ 269 LLVMMetadataTypeKind, /**< Metadata */ 270 LLVMX86_MMXTypeKind /**< X86 MMX */ 271 } LLVMTypeKind; 272 273 typedef enum { 274 LLVMExternalLinkage, /**< Externally visible function */ 275 LLVMAvailableExternallyLinkage, 276 LLVMLinkOnceAnyLinkage, /**< Keep one copy of function when linking (inline)*/ 277 LLVMLinkOnceODRLinkage, /**< Same, but only replaced by something 278 equivalent. */ 279 LLVMLinkOnceODRAutoHideLinkage, /**< Obsolete */ 280 LLVMWeakAnyLinkage, /**< Keep one copy of function when linking (weak) */ 281 LLVMWeakODRLinkage, /**< Same, but only replaced by something 282 equivalent. */ 283 LLVMAppendingLinkage, /**< Special purpose, only applies to global arrays */ 284 LLVMInternalLinkage, /**< Rename collisions when linking (static 285 functions) */ 286 LLVMPrivateLinkage, /**< Like Internal, but omit from symbol table */ 287 LLVMDLLImportLinkage, /**< Obsolete */ 288 LLVMDLLExportLinkage, /**< Obsolete */ 289 LLVMExternalWeakLinkage,/**< ExternalWeak linkage description */ 290 LLVMGhostLinkage, /**< Obsolete */ 291 LLVMCommonLinkage, /**< Tentative definitions */ 292 LLVMLinkerPrivateLinkage, /**< Like Private, but linker removes. */ 293 LLVMLinkerPrivateWeakLinkage /**< Like LinkerPrivate, but is weak. */ 294 } LLVMLinkage; 295 296 typedef enum { 297 LLVMDefaultVisibility, /**< The GV is visible */ 298 LLVMHiddenVisibility, /**< The GV is hidden */ 299 LLVMProtectedVisibility /**< The GV is protected */ 300 } LLVMVisibility; 301 302 typedef enum { 303 LLVMDefaultStorageClass = 0, 304 LLVMDLLImportStorageClass = 1, /**< Function to be imported from DLL. */ 305 LLVMDLLExportStorageClass = 2 /**< Function to be accessible from DLL. */ 306 } LLVMDLLStorageClass; 307 308 typedef enum { 309 LLVMCCallConv = 0, 310 LLVMFastCallConv = 8, 311 LLVMColdCallConv = 9, 312 LLVMWebKitJSCallConv = 12, 313 LLVMAnyRegCallConv = 13, 314 LLVMX86StdcallCallConv = 64, 315 LLVMX86FastcallCallConv = 65 316 } LLVMCallConv; 317 318 typedef enum { 319 LLVMIntEQ = 32, /**< equal */ 320 LLVMIntNE, /**< not equal */ 321 LLVMIntUGT, /**< unsigned greater than */ 322 LLVMIntUGE, /**< unsigned greater or equal */ 323 LLVMIntULT, /**< unsigned less than */ 324 LLVMIntULE, /**< unsigned less or equal */ 325 LLVMIntSGT, /**< signed greater than */ 326 LLVMIntSGE, /**< signed greater or equal */ 327 LLVMIntSLT, /**< signed less than */ 328 LLVMIntSLE /**< signed less or equal */ 329 } LLVMIntPredicate; 330 331 typedef enum { 332 LLVMRealPredicateFalse, /**< Always false (always folded) */ 333 LLVMRealOEQ, /**< True if ordered and equal */ 334 LLVMRealOGT, /**< True if ordered and greater than */ 335 LLVMRealOGE, /**< True if ordered and greater than or equal */ 336 LLVMRealOLT, /**< True if ordered and less than */ 337 LLVMRealOLE, /**< True if ordered and less than or equal */ 338 LLVMRealONE, /**< True if ordered and operands are unequal */ 339 LLVMRealORD, /**< True if ordered (no nans) */ 340 LLVMRealUNO, /**< True if unordered: isnan(X) | isnan(Y) */ 341 LLVMRealUEQ, /**< True if unordered or equal */ 342 LLVMRealUGT, /**< True if unordered or greater than */ 343 LLVMRealUGE, /**< True if unordered, greater than, or equal */ 344 LLVMRealULT, /**< True if unordered or less than */ 345 LLVMRealULE, /**< True if unordered, less than, or equal */ 346 LLVMRealUNE, /**< True if unordered or not equal */ 347 LLVMRealPredicateTrue /**< Always true (always folded) */ 348 } LLVMRealPredicate; 349 350 typedef enum { 351 LLVMLandingPadCatch, /**< A catch clause */ 352 LLVMLandingPadFilter /**< A filter clause */ 353 } LLVMLandingPadClauseTy; 354 355 typedef enum { 356 LLVMNotThreadLocal = 0, 357 LLVMGeneralDynamicTLSModel, 358 LLVMLocalDynamicTLSModel, 359 LLVMInitialExecTLSModel, 360 LLVMLocalExecTLSModel 361 } LLVMThreadLocalMode; 362 363 typedef enum { 364 LLVMAtomicOrderingNotAtomic = 0, /**< A load or store which is not atomic */ 365 LLVMAtomicOrderingUnordered = 1, /**< Lowest level of atomicity, guarantees 366 somewhat sane results, lock free. */ 367 LLVMAtomicOrderingMonotonic = 2, /**< guarantees that if you take all the 368 operations affecting a specific address, 369 a consistent ordering exists */ 370 LLVMAtomicOrderingAcquire = 4, /**< Acquire provides a barrier of the sort 371 necessary to acquire a lock to access other 372 memory with normal loads and stores. */ 373 LLVMAtomicOrderingRelease = 5, /**< Release is similar to Acquire, but with 374 a barrier of the sort necessary to release 375 a lock. */ 376 LLVMAtomicOrderingAcquireRelease = 6, /**< provides both an Acquire and a 377 Release barrier (for fences and 378 operations which both read and write 379 memory). */ 380 LLVMAtomicOrderingSequentiallyConsistent = 7 /**< provides Acquire semantics 381 for loads and Release 382 semantics for stores. 383 Additionally, it guarantees 384 that a total ordering exists 385 between all 386 SequentiallyConsistent 387 operations. */ 388 } LLVMAtomicOrdering; 389 390 typedef enum { 391 LLVMAtomicRMWBinOpXchg, /**< Set the new value and return the one old */ 392 LLVMAtomicRMWBinOpAdd, /**< Add a value and return the old one */ 393 LLVMAtomicRMWBinOpSub, /**< Subtract a value and return the old one */ 394 LLVMAtomicRMWBinOpAnd, /**< And a value and return the old one */ 395 LLVMAtomicRMWBinOpNand, /**< Not-And a value and return the old one */ 396 LLVMAtomicRMWBinOpOr, /**< OR a value and return the old one */ 397 LLVMAtomicRMWBinOpXor, /**< Xor a value and return the old one */ 398 LLVMAtomicRMWBinOpMax, /**< Sets the value if it's greater than the 399 original using a signed comparison and return 400 the old one */ 401 LLVMAtomicRMWBinOpMin, /**< Sets the value if it's Smaller than the 402 original using a signed comparison and return 403 the old one */ 404 LLVMAtomicRMWBinOpUMax, /**< Sets the value if it's greater than the 405 original using an unsigned comparison and return 406 the old one */ 407 LLVMAtomicRMWBinOpUMin /**< Sets the value if it's greater than the 408 original using an unsigned comparison and return 409 the old one */ 410 } LLVMAtomicRMWBinOp; 411 412 typedef enum { 413 LLVMDSError, 414 LLVMDSWarning, 415 LLVMDSRemark, 416 LLVMDSNote 417 } LLVMDiagnosticSeverity; 418 419 /** 420 * @} 421 */ 422 423 void LLVMInitializeCore(LLVMPassRegistryRef R); 424 425 /** Deallocate and destroy all ManagedStatic variables. 426 @see llvm::llvm_shutdown 427 @see ManagedStatic */ 428 void LLVMShutdown(void); 429 430 431 /*===-- Error handling ----------------------------------------------------===*/ 432 433 char *LLVMCreateMessage(const char *Message); 434 void LLVMDisposeMessage(char *Message); 435 436 typedef void (*LLVMFatalErrorHandler)(const char *Reason); 437 438 /** 439 * Install a fatal error handler. By default, if LLVM detects a fatal error, it 440 * will call exit(1). This may not be appropriate in many contexts. For example, 441 * doing exit(1) will bypass many crash reporting/tracing system tools. This 442 * function allows you to install a callback that will be invoked prior to the 443 * call to exit(1). 444 */ 445 void LLVMInstallFatalErrorHandler(LLVMFatalErrorHandler Handler); 446 447 /** 448 * Reset the fatal error handler. This resets LLVM's fatal error handling 449 * behavior to the default. 450 */ 451 void LLVMResetFatalErrorHandler(void); 452 453 /** 454 * Enable LLVM's built-in stack trace code. This intercepts the OS's crash 455 * signals and prints which component of LLVM you were in at the time if the 456 * crash. 457 */ 458 void LLVMEnablePrettyStackTrace(void); 459 460 /** 461 * @defgroup LLVMCCoreContext Contexts 462 * 463 * Contexts are execution states for the core LLVM IR system. 464 * 465 * Most types are tied to a context instance. Multiple contexts can 466 * exist simultaneously. A single context is not thread safe. However, 467 * different contexts can execute on different threads simultaneously. 468 * 469 * @{ 470 */ 471 472 typedef void (*LLVMDiagnosticHandler)(LLVMDiagnosticInfoRef, void *); 473 typedef void (*LLVMYieldCallback)(LLVMContextRef, void *); 474 475 /** 476 * Create a new context. 477 * 478 * Every call to this function should be paired with a call to 479 * LLVMContextDispose() or the context will leak memory. 480 */ 481 LLVMContextRef LLVMContextCreate(void); 482 483 /** 484 * Obtain the global context instance. 485 */ 486 LLVMContextRef LLVMGetGlobalContext(void); 487 488 /** 489 * Set the diagnostic handler for this context. 490 */ 491 void LLVMContextSetDiagnosticHandler(LLVMContextRef C, 492 LLVMDiagnosticHandler Handler, 493 void *DiagnosticContext); 494 495 /** 496 * Set the yield callback function for this context. 497 * 498 * @see LLVMContext::setYieldCallback() 499 */ 500 void LLVMContextSetYieldCallback(LLVMContextRef C, LLVMYieldCallback Callback, 501 void *OpaqueHandle); 502 503 /** 504 * Destroy a context instance. 505 * 506 * This should be called for every call to LLVMContextCreate() or memory 507 * will be leaked. 508 */ 509 void LLVMContextDispose(LLVMContextRef C); 510 511 /** 512 * Return a string representation of the DiagnosticInfo. Use 513 * LLVMDisposeMessage to free the string. 514 * 515 * @see DiagnosticInfo::print() 516 */ 517 char *LLVMGetDiagInfoDescription(LLVMDiagnosticInfoRef DI); 518 519 /** 520 * Return an enum LLVMDiagnosticSeverity. 521 * 522 * @see DiagnosticInfo::getSeverity() 523 */ 524 LLVMDiagnosticSeverity LLVMGetDiagInfoSeverity(LLVMDiagnosticInfoRef DI); 525 526 unsigned LLVMGetMDKindIDInContext(LLVMContextRef C, const char* Name, 527 unsigned SLen); 528 unsigned LLVMGetMDKindID(const char* Name, unsigned SLen); 529 530 /** 531 * @} 532 */ 533 534 /** 535 * @defgroup LLVMCCoreModule Modules 536 * 537 * Modules represent the top-level structure in an LLVM program. An LLVM 538 * module is effectively a translation unit or a collection of 539 * translation units merged together. 540 * 541 * @{ 542 */ 543 544 /** 545 * Create a new, empty module in the global context. 546 * 547 * This is equivalent to calling LLVMModuleCreateWithNameInContext with 548 * LLVMGetGlobalContext() as the context parameter. 549 * 550 * Every invocation should be paired with LLVMDisposeModule() or memory 551 * will be leaked. 552 */ 553 LLVMModuleRef LLVMModuleCreateWithName(const char *ModuleID); 554 555 /** 556 * Create a new, empty module in a specific context. 557 * 558 * Every invocation should be paired with LLVMDisposeModule() or memory 559 * will be leaked. 560 */ 561 LLVMModuleRef LLVMModuleCreateWithNameInContext(const char *ModuleID, 562 LLVMContextRef C); 563 564 /** 565 * Destroy a module instance. 566 * 567 * This must be called for every created module or memory will be 568 * leaked. 569 */ 570 void LLVMDisposeModule(LLVMModuleRef M); 571 572 /** 573 * Obtain the data layout for a module. 574 * 575 * @see Module::getDataLayout() 576 */ 577 const char *LLVMGetDataLayout(LLVMModuleRef M); 578 579 /** 580 * Set the data layout for a module. 581 * 582 * @see Module::setDataLayout() 583 */ 584 void LLVMSetDataLayout(LLVMModuleRef M, const char *Triple); 585 586 /** 587 * Obtain the target triple for a module. 588 * 589 * @see Module::getTargetTriple() 590 */ 591 const char *LLVMGetTarget(LLVMModuleRef M); 592 593 /** 594 * Set the target triple for a module. 595 * 596 * @see Module::setTargetTriple() 597 */ 598 void LLVMSetTarget(LLVMModuleRef M, const char *Triple); 599 600 /** 601 * Dump a representation of a module to stderr. 602 * 603 * @see Module::dump() 604 */ 605 void LLVMDumpModule(LLVMModuleRef M); 606 607 /** 608 * Print a representation of a module to a file. The ErrorMessage needs to be 609 * disposed with LLVMDisposeMessage. Returns 0 on success, 1 otherwise. 610 * 611 * @see Module::print() 612 */ 613 LLVMBool LLVMPrintModuleToFile(LLVMModuleRef M, const char *Filename, 614 char **ErrorMessage); 615 616 /** 617 * Return a string representation of the module. Use 618 * LLVMDisposeMessage to free the string. 619 * 620 * @see Module::print() 621 */ 622 char *LLVMPrintModuleToString(LLVMModuleRef M); 623 624 /** 625 * Set inline assembly for a module. 626 * 627 * @see Module::setModuleInlineAsm() 628 */ 629 void LLVMSetModuleInlineAsm(LLVMModuleRef M, const char *Asm); 630 631 /** 632 * Obtain the context to which this module is associated. 633 * 634 * @see Module::getContext() 635 */ 636 LLVMContextRef LLVMGetModuleContext(LLVMModuleRef M); 637 638 /** 639 * Obtain a Type from a module by its registered name. 640 */ 641 LLVMTypeRef LLVMGetTypeByName(LLVMModuleRef M, const char *Name); 642 643 /** 644 * Obtain the number of operands for named metadata in a module. 645 * 646 * @see llvm::Module::getNamedMetadata() 647 */ 648 unsigned LLVMGetNamedMetadataNumOperands(LLVMModuleRef M, const char* name); 649 650 /** 651 * Obtain the named metadata operands for a module. 652 * 653 * The passed LLVMValueRef pointer should refer to an array of 654 * LLVMValueRef at least LLVMGetNamedMetadataNumOperands long. This 655 * array will be populated with the LLVMValueRef instances. Each 656 * instance corresponds to a llvm::MDNode. 657 * 658 * @see llvm::Module::getNamedMetadata() 659 * @see llvm::MDNode::getOperand() 660 */ 661 void LLVMGetNamedMetadataOperands(LLVMModuleRef M, const char* name, LLVMValueRef *Dest); 662 663 /** 664 * Add an operand to named metadata. 665 * 666 * @see llvm::Module::getNamedMetadata() 667 * @see llvm::MDNode::addOperand() 668 */ 669 void LLVMAddNamedMetadataOperand(LLVMModuleRef M, const char* name, 670 LLVMValueRef Val); 671 672 /** 673 * Add a function to a module under a specified name. 674 * 675 * @see llvm::Function::Create() 676 */ 677 LLVMValueRef LLVMAddFunction(LLVMModuleRef M, const char *Name, 678 LLVMTypeRef FunctionTy); 679 680 /** 681 * Obtain a Function value from a Module by its name. 682 * 683 * The returned value corresponds to a llvm::Function value. 684 * 685 * @see llvm::Module::getFunction() 686 */ 687 LLVMValueRef LLVMGetNamedFunction(LLVMModuleRef M, const char *Name); 688 689 /** 690 * Obtain an iterator to the first Function in a Module. 691 * 692 * @see llvm::Module::begin() 693 */ 694 LLVMValueRef LLVMGetFirstFunction(LLVMModuleRef M); 695 696 /** 697 * Obtain an iterator to the last Function in a Module. 698 * 699 * @see llvm::Module::end() 700 */ 701 LLVMValueRef LLVMGetLastFunction(LLVMModuleRef M); 702 703 /** 704 * Advance a Function iterator to the next Function. 705 * 706 * Returns NULL if the iterator was already at the end and there are no more 707 * functions. 708 */ 709 LLVMValueRef LLVMGetNextFunction(LLVMValueRef Fn); 710 711 /** 712 * Decrement a Function iterator to the previous Function. 713 * 714 * Returns NULL if the iterator was already at the beginning and there are 715 * no previous functions. 716 */ 717 LLVMValueRef LLVMGetPreviousFunction(LLVMValueRef Fn); 718 719 /** 720 * @} 721 */ 722 723 /** 724 * @defgroup LLVMCCoreType Types 725 * 726 * Types represent the type of a value. 727 * 728 * Types are associated with a context instance. The context internally 729 * deduplicates types so there is only 1 instance of a specific type 730 * alive at a time. In other words, a unique type is shared among all 731 * consumers within a context. 732 * 733 * A Type in the C API corresponds to llvm::Type. 734 * 735 * Types have the following hierarchy: 736 * 737 * types: 738 * integer type 739 * real type 740 * function type 741 * sequence types: 742 * array type 743 * pointer type 744 * vector type 745 * void type 746 * label type 747 * opaque type 748 * 749 * @{ 750 */ 751 752 /** 753 * Obtain the enumerated type of a Type instance. 754 * 755 * @see llvm::Type:getTypeID() 756 */ 757 LLVMTypeKind LLVMGetTypeKind(LLVMTypeRef Ty); 758 759 /** 760 * Whether the type has a known size. 761 * 762 * Things that don't have a size are abstract types, labels, and void.a 763 * 764 * @see llvm::Type::isSized() 765 */ 766 LLVMBool LLVMTypeIsSized(LLVMTypeRef Ty); 767 768 /** 769 * Obtain the context to which this type instance is associated. 770 * 771 * @see llvm::Type::getContext() 772 */ 773 LLVMContextRef LLVMGetTypeContext(LLVMTypeRef Ty); 774 775 /** 776 * Dump a representation of a type to stderr. 777 * 778 * @see llvm::Type::dump() 779 */ 780 void LLVMDumpType(LLVMTypeRef Val); 781 782 /** 783 * Return a string representation of the type. Use 784 * LLVMDisposeMessage to free the string. 785 * 786 * @see llvm::Type::print() 787 */ 788 char *LLVMPrintTypeToString(LLVMTypeRef Val); 789 790 /** 791 * @defgroup LLVMCCoreTypeInt Integer Types 792 * 793 * Functions in this section operate on integer types. 794 * 795 * @{ 796 */ 797 798 /** 799 * Obtain an integer type from a context with specified bit width. 800 */ 801 LLVMTypeRef LLVMInt1TypeInContext(LLVMContextRef C); 802 LLVMTypeRef LLVMInt8TypeInContext(LLVMContextRef C); 803 LLVMTypeRef LLVMInt16TypeInContext(LLVMContextRef C); 804 LLVMTypeRef LLVMInt32TypeInContext(LLVMContextRef C); 805 LLVMTypeRef LLVMInt64TypeInContext(LLVMContextRef C); 806 LLVMTypeRef LLVMIntTypeInContext(LLVMContextRef C, unsigned NumBits); 807 808 /** 809 * Obtain an integer type from the global context with a specified bit 810 * width. 811 */ 812 LLVMTypeRef LLVMInt1Type(void); 813 LLVMTypeRef LLVMInt8Type(void); 814 LLVMTypeRef LLVMInt16Type(void); 815 LLVMTypeRef LLVMInt32Type(void); 816 LLVMTypeRef LLVMInt64Type(void); 817 LLVMTypeRef LLVMIntType(unsigned NumBits); 818 unsigned LLVMGetIntTypeWidth(LLVMTypeRef IntegerTy); 819 820 /** 821 * @} 822 */ 823 824 /** 825 * @defgroup LLVMCCoreTypeFloat Floating Point Types 826 * 827 * @{ 828 */ 829 830 /** 831 * Obtain a 16-bit floating point type from a context. 832 */ 833 LLVMTypeRef LLVMHalfTypeInContext(LLVMContextRef C); 834 835 /** 836 * Obtain a 32-bit floating point type from a context. 837 */ 838 LLVMTypeRef LLVMFloatTypeInContext(LLVMContextRef C); 839 840 /** 841 * Obtain a 64-bit floating point type from a context. 842 */ 843 LLVMTypeRef LLVMDoubleTypeInContext(LLVMContextRef C); 844 845 /** 846 * Obtain a 80-bit floating point type (X87) from a context. 847 */ 848 LLVMTypeRef LLVMX86FP80TypeInContext(LLVMContextRef C); 849 850 /** 851 * Obtain a 128-bit floating point type (112-bit mantissa) from a 852 * context. 853 */ 854 LLVMTypeRef LLVMFP128TypeInContext(LLVMContextRef C); 855 856 /** 857 * Obtain a 128-bit floating point type (two 64-bits) from a context. 858 */ 859 LLVMTypeRef LLVMPPCFP128TypeInContext(LLVMContextRef C); 860 861 /** 862 * Obtain a floating point type from the global context. 863 * 864 * These map to the functions in this group of the same name. 865 */ 866 LLVMTypeRef LLVMHalfType(void); 867 LLVMTypeRef LLVMFloatType(void); 868 LLVMTypeRef LLVMDoubleType(void); 869 LLVMTypeRef LLVMX86FP80Type(void); 870 LLVMTypeRef LLVMFP128Type(void); 871 LLVMTypeRef LLVMPPCFP128Type(void); 872 873 /** 874 * @} 875 */ 876 877 /** 878 * @defgroup LLVMCCoreTypeFunction Function Types 879 * 880 * @{ 881 */ 882 883 /** 884 * Obtain a function type consisting of a specified signature. 885 * 886 * The function is defined as a tuple of a return Type, a list of 887 * parameter types, and whether the function is variadic. 888 */ 889 LLVMTypeRef LLVMFunctionType(LLVMTypeRef ReturnType, 890 LLVMTypeRef *ParamTypes, unsigned ParamCount, 891 LLVMBool IsVarArg); 892 893 /** 894 * Returns whether a function type is variadic. 895 */ 896 LLVMBool LLVMIsFunctionVarArg(LLVMTypeRef FunctionTy); 897 898 /** 899 * Obtain the Type this function Type returns. 900 */ 901 LLVMTypeRef LLVMGetReturnType(LLVMTypeRef FunctionTy); 902 903 /** 904 * Obtain the number of parameters this function accepts. 905 */ 906 unsigned LLVMCountParamTypes(LLVMTypeRef FunctionTy); 907 908 /** 909 * Obtain the types of a function's parameters. 910 * 911 * The Dest parameter should point to a pre-allocated array of 912 * LLVMTypeRef at least LLVMCountParamTypes() large. On return, the 913 * first LLVMCountParamTypes() entries in the array will be populated 914 * with LLVMTypeRef instances. 915 * 916 * @param FunctionTy The function type to operate on. 917 * @param Dest Memory address of an array to be filled with result. 918 */ 919 void LLVMGetParamTypes(LLVMTypeRef FunctionTy, LLVMTypeRef *Dest); 920 921 /** 922 * @} 923 */ 924 925 /** 926 * @defgroup LLVMCCoreTypeStruct Structure Types 927 * 928 * These functions relate to LLVMTypeRef instances. 929 * 930 * @see llvm::StructType 931 * 932 * @{ 933 */ 934 935 /** 936 * Create a new structure type in a context. 937 * 938 * A structure is specified by a list of inner elements/types and 939 * whether these can be packed together. 940 * 941 * @see llvm::StructType::create() 942 */ 943 LLVMTypeRef LLVMStructTypeInContext(LLVMContextRef C, LLVMTypeRef *ElementTypes, 944 unsigned ElementCount, LLVMBool Packed); 945 946 /** 947 * Create a new structure type in the global context. 948 * 949 * @see llvm::StructType::create() 950 */ 951 LLVMTypeRef LLVMStructType(LLVMTypeRef *ElementTypes, unsigned ElementCount, 952 LLVMBool Packed); 953 954 /** 955 * Create an empty structure in a context having a specified name. 956 * 957 * @see llvm::StructType::create() 958 */ 959 LLVMTypeRef LLVMStructCreateNamed(LLVMContextRef C, const char *Name); 960 961 /** 962 * Obtain the name of a structure. 963 * 964 * @see llvm::StructType::getName() 965 */ 966 const char *LLVMGetStructName(LLVMTypeRef Ty); 967 968 /** 969 * Set the contents of a structure type. 970 * 971 * @see llvm::StructType::setBody() 972 */ 973 void LLVMStructSetBody(LLVMTypeRef StructTy, LLVMTypeRef *ElementTypes, 974 unsigned ElementCount, LLVMBool Packed); 975 976 /** 977 * Get the number of elements defined inside the structure. 978 * 979 * @see llvm::StructType::getNumElements() 980 */ 981 unsigned LLVMCountStructElementTypes(LLVMTypeRef StructTy); 982 983 /** 984 * Get the elements within a structure. 985 * 986 * The function is passed the address of a pre-allocated array of 987 * LLVMTypeRef at least LLVMCountStructElementTypes() long. After 988 * invocation, this array will be populated with the structure's 989 * elements. The objects in the destination array will have a lifetime 990 * of the structure type itself, which is the lifetime of the context it 991 * is contained in. 992 */ 993 void LLVMGetStructElementTypes(LLVMTypeRef StructTy, LLVMTypeRef *Dest); 994 995 /** 996 * Determine whether a structure is packed. 997 * 998 * @see llvm::StructType::isPacked() 999 */ 1000 LLVMBool LLVMIsPackedStruct(LLVMTypeRef StructTy); 1001 1002 /** 1003 * Determine whether a structure is opaque. 1004 * 1005 * @see llvm::StructType::isOpaque() 1006 */ 1007 LLVMBool LLVMIsOpaqueStruct(LLVMTypeRef StructTy); 1008 1009 /** 1010 * @} 1011 */ 1012 1013 1014 /** 1015 * @defgroup LLVMCCoreTypeSequential Sequential Types 1016 * 1017 * Sequential types represents "arrays" of types. This is a super class 1018 * for array, vector, and pointer types. 1019 * 1020 * @{ 1021 */ 1022 1023 /** 1024 * Obtain the type of elements within a sequential type. 1025 * 1026 * This works on array, vector, and pointer types. 1027 * 1028 * @see llvm::SequentialType::getElementType() 1029 */ 1030 LLVMTypeRef LLVMGetElementType(LLVMTypeRef Ty); 1031 1032 /** 1033 * Create a fixed size array type that refers to a specific type. 1034 * 1035 * The created type will exist in the context that its element type 1036 * exists in. 1037 * 1038 * @see llvm::ArrayType::get() 1039 */ 1040 LLVMTypeRef LLVMArrayType(LLVMTypeRef ElementType, unsigned ElementCount); 1041 1042 /** 1043 * Obtain the length of an array type. 1044 * 1045 * This only works on types that represent arrays. 1046 * 1047 * @see llvm::ArrayType::getNumElements() 1048 */ 1049 unsigned LLVMGetArrayLength(LLVMTypeRef ArrayTy); 1050 1051 /** 1052 * Create a pointer type that points to a defined type. 1053 * 1054 * The created type will exist in the context that its pointee type 1055 * exists in. 1056 * 1057 * @see llvm::PointerType::get() 1058 */ 1059 LLVMTypeRef LLVMPointerType(LLVMTypeRef ElementType, unsigned AddressSpace); 1060 1061 /** 1062 * Obtain the address space of a pointer type. 1063 * 1064 * This only works on types that represent pointers. 1065 * 1066 * @see llvm::PointerType::getAddressSpace() 1067 */ 1068 unsigned LLVMGetPointerAddressSpace(LLVMTypeRef PointerTy); 1069 1070 /** 1071 * Create a vector type that contains a defined type and has a specific 1072 * number of elements. 1073 * 1074 * The created type will exist in the context thats its element type 1075 * exists in. 1076 * 1077 * @see llvm::VectorType::get() 1078 */ 1079 LLVMTypeRef LLVMVectorType(LLVMTypeRef ElementType, unsigned ElementCount); 1080 1081 /** 1082 * Obtain the number of elements in a vector type. 1083 * 1084 * This only works on types that represent vectors. 1085 * 1086 * @see llvm::VectorType::getNumElements() 1087 */ 1088 unsigned LLVMGetVectorSize(LLVMTypeRef VectorTy); 1089 1090 /** 1091 * @} 1092 */ 1093 1094 /** 1095 * @defgroup LLVMCCoreTypeOther Other Types 1096 * 1097 * @{ 1098 */ 1099 1100 /** 1101 * Create a void type in a context. 1102 */ 1103 LLVMTypeRef LLVMVoidTypeInContext(LLVMContextRef C); 1104 1105 /** 1106 * Create a label type in a context. 1107 */ 1108 LLVMTypeRef LLVMLabelTypeInContext(LLVMContextRef C); 1109 1110 /** 1111 * Create a X86 MMX type in a context. 1112 */ 1113 LLVMTypeRef LLVMX86MMXTypeInContext(LLVMContextRef C); 1114 1115 /** 1116 * These are similar to the above functions except they operate on the 1117 * global context. 1118 */ 1119 LLVMTypeRef LLVMVoidType(void); 1120 LLVMTypeRef LLVMLabelType(void); 1121 LLVMTypeRef LLVMX86MMXType(void); 1122 1123 /** 1124 * @} 1125 */ 1126 1127 /** 1128 * @} 1129 */ 1130 1131 /** 1132 * @defgroup LLVMCCoreValues Values 1133 * 1134 * The bulk of LLVM's object model consists of values, which comprise a very 1135 * rich type hierarchy. 1136 * 1137 * LLVMValueRef essentially represents llvm::Value. There is a rich 1138 * hierarchy of classes within this type. Depending on the instance 1139 * obtained, not all APIs are available. 1140 * 1141 * Callers can determine the type of an LLVMValueRef by calling the 1142 * LLVMIsA* family of functions (e.g. LLVMIsAArgument()). These 1143 * functions are defined by a macro, so it isn't obvious which are 1144 * available by looking at the Doxygen source code. Instead, look at the 1145 * source definition of LLVM_FOR_EACH_VALUE_SUBCLASS and note the list 1146 * of value names given. These value names also correspond to classes in 1147 * the llvm::Value hierarchy. 1148 * 1149 * @{ 1150 */ 1151 1152 #define LLVM_FOR_EACH_VALUE_SUBCLASS(macro) \ 1153 macro(Argument) \ 1154 macro(BasicBlock) \ 1155 macro(InlineAsm) \ 1156 macro(MDNode) \ 1157 macro(MDString) \ 1158 macro(User) \ 1159 macro(Constant) \ 1160 macro(BlockAddress) \ 1161 macro(ConstantAggregateZero) \ 1162 macro(ConstantArray) \ 1163 macro(ConstantDataSequential) \ 1164 macro(ConstantDataArray) \ 1165 macro(ConstantDataVector) \ 1166 macro(ConstantExpr) \ 1167 macro(ConstantFP) \ 1168 macro(ConstantInt) \ 1169 macro(ConstantPointerNull) \ 1170 macro(ConstantStruct) \ 1171 macro(ConstantVector) \ 1172 macro(GlobalValue) \ 1173 macro(GlobalAlias) \ 1174 macro(GlobalObject) \ 1175 macro(Function) \ 1176 macro(GlobalVariable) \ 1177 macro(UndefValue) \ 1178 macro(Instruction) \ 1179 macro(BinaryOperator) \ 1180 macro(CallInst) \ 1181 macro(IntrinsicInst) \ 1182 macro(DbgInfoIntrinsic) \ 1183 macro(DbgDeclareInst) \ 1184 macro(MemIntrinsic) \ 1185 macro(MemCpyInst) \ 1186 macro(MemMoveInst) \ 1187 macro(MemSetInst) \ 1188 macro(CmpInst) \ 1189 macro(FCmpInst) \ 1190 macro(ICmpInst) \ 1191 macro(ExtractElementInst) \ 1192 macro(GetElementPtrInst) \ 1193 macro(InsertElementInst) \ 1194 macro(InsertValueInst) \ 1195 macro(LandingPadInst) \ 1196 macro(PHINode) \ 1197 macro(SelectInst) \ 1198 macro(ShuffleVectorInst) \ 1199 macro(StoreInst) \ 1200 macro(TerminatorInst) \ 1201 macro(BranchInst) \ 1202 macro(IndirectBrInst) \ 1203 macro(InvokeInst) \ 1204 macro(ReturnInst) \ 1205 macro(SwitchInst) \ 1206 macro(UnreachableInst) \ 1207 macro(ResumeInst) \ 1208 macro(UnaryInstruction) \ 1209 macro(AllocaInst) \ 1210 macro(CastInst) \ 1211 macro(AddrSpaceCastInst) \ 1212 macro(BitCastInst) \ 1213 macro(FPExtInst) \ 1214 macro(FPToSIInst) \ 1215 macro(FPToUIInst) \ 1216 macro(FPTruncInst) \ 1217 macro(IntToPtrInst) \ 1218 macro(PtrToIntInst) \ 1219 macro(SExtInst) \ 1220 macro(SIToFPInst) \ 1221 macro(TruncInst) \ 1222 macro(UIToFPInst) \ 1223 macro(ZExtInst) \ 1224 macro(ExtractValueInst) \ 1225 macro(LoadInst) \ 1226 macro(VAArgInst) 1227 1228 /** 1229 * @defgroup LLVMCCoreValueGeneral General APIs 1230 * 1231 * Functions in this section work on all LLVMValueRef instances, 1232 * regardless of their sub-type. They correspond to functions available 1233 * on llvm::Value. 1234 * 1235 * @{ 1236 */ 1237 1238 /** 1239 * Obtain the type of a value. 1240 * 1241 * @see llvm::Value::getType() 1242 */ 1243 LLVMTypeRef LLVMTypeOf(LLVMValueRef Val); 1244 1245 /** 1246 * Obtain the string name of a value. 1247 * 1248 * @see llvm::Value::getName() 1249 */ 1250 const char *LLVMGetValueName(LLVMValueRef Val); 1251 1252 /** 1253 * Set the string name of a value. 1254 * 1255 * @see llvm::Value::setName() 1256 */ 1257 void LLVMSetValueName(LLVMValueRef Val, const char *Name); 1258 1259 /** 1260 * Dump a representation of a value to stderr. 1261 * 1262 * @see llvm::Value::dump() 1263 */ 1264 void LLVMDumpValue(LLVMValueRef Val); 1265 1266 /** 1267 * Return a string representation of the value. Use 1268 * LLVMDisposeMessage to free the string. 1269 * 1270 * @see llvm::Value::print() 1271 */ 1272 char *LLVMPrintValueToString(LLVMValueRef Val); 1273 1274 /** 1275 * Replace all uses of a value with another one. 1276 * 1277 * @see llvm::Value::replaceAllUsesWith() 1278 */ 1279 void LLVMReplaceAllUsesWith(LLVMValueRef OldVal, LLVMValueRef NewVal); 1280 1281 /** 1282 * Determine whether the specified constant instance is constant. 1283 */ 1284 LLVMBool LLVMIsConstant(LLVMValueRef Val); 1285 1286 /** 1287 * Determine whether a value instance is undefined. 1288 */ 1289 LLVMBool LLVMIsUndef(LLVMValueRef Val); 1290 1291 /** 1292 * Convert value instances between types. 1293 * 1294 * Internally, an LLVMValueRef is "pinned" to a specific type. This 1295 * series of functions allows you to cast an instance to a specific 1296 * type. 1297 * 1298 * If the cast is not valid for the specified type, NULL is returned. 1299 * 1300 * @see llvm::dyn_cast_or_null<> 1301 */ 1302 #define LLVM_DECLARE_VALUE_CAST(name) \ 1303 LLVMValueRef LLVMIsA##name(LLVMValueRef Val); 1304 LLVM_FOR_EACH_VALUE_SUBCLASS(LLVM_DECLARE_VALUE_CAST) 1305 1306 /** 1307 * @} 1308 */ 1309 1310 /** 1311 * @defgroup LLVMCCoreValueUses Usage 1312 * 1313 * This module defines functions that allow you to inspect the uses of a 1314 * LLVMValueRef. 1315 * 1316 * It is possible to obtain an LLVMUseRef for any LLVMValueRef instance. 1317 * Each LLVMUseRef (which corresponds to a llvm::Use instance) holds a 1318 * llvm::User and llvm::Value. 1319 * 1320 * @{ 1321 */ 1322 1323 /** 1324 * Obtain the first use of a value. 1325 * 1326 * Uses are obtained in an iterator fashion. First, call this function 1327 * to obtain a reference to the first use. Then, call LLVMGetNextUse() 1328 * on that instance and all subsequently obtained instances until 1329 * LLVMGetNextUse() returns NULL. 1330 * 1331 * @see llvm::Value::use_begin() 1332 */ 1333 LLVMUseRef LLVMGetFirstUse(LLVMValueRef Val); 1334 1335 /** 1336 * Obtain the next use of a value. 1337 * 1338 * This effectively advances the iterator. It returns NULL if you are on 1339 * the final use and no more are available. 1340 */ 1341 LLVMUseRef LLVMGetNextUse(LLVMUseRef U); 1342 1343 /** 1344 * Obtain the user value for a user. 1345 * 1346 * The returned value corresponds to a llvm::User type. 1347 * 1348 * @see llvm::Use::getUser() 1349 */ 1350 LLVMValueRef LLVMGetUser(LLVMUseRef U); 1351 1352 /** 1353 * Obtain the value this use corresponds to. 1354 * 1355 * @see llvm::Use::get(). 1356 */ 1357 LLVMValueRef LLVMGetUsedValue(LLVMUseRef U); 1358 1359 /** 1360 * @} 1361 */ 1362 1363 /** 1364 * @defgroup LLVMCCoreValueUser User value 1365 * 1366 * Function in this group pertain to LLVMValueRef instances that descent 1367 * from llvm::User. This includes constants, instructions, and 1368 * operators. 1369 * 1370 * @{ 1371 */ 1372 1373 /** 1374 * Obtain an operand at a specific index in a llvm::User value. 1375 * 1376 * @see llvm::User::getOperand() 1377 */ 1378 LLVMValueRef LLVMGetOperand(LLVMValueRef Val, unsigned Index); 1379 1380 /** 1381 * Set an operand at a specific index in a llvm::User value. 1382 * 1383 * @see llvm::User::setOperand() 1384 */ 1385 void LLVMSetOperand(LLVMValueRef User, unsigned Index, LLVMValueRef Val); 1386 1387 /** 1388 * Obtain the number of operands in a llvm::User value. 1389 * 1390 * @see llvm::User::getNumOperands() 1391 */ 1392 int LLVMGetNumOperands(LLVMValueRef Val); 1393 1394 /** 1395 * @} 1396 */ 1397 1398 /** 1399 * @defgroup LLVMCCoreValueConstant Constants 1400 * 1401 * This section contains APIs for interacting with LLVMValueRef that 1402 * correspond to llvm::Constant instances. 1403 * 1404 * These functions will work for any LLVMValueRef in the llvm::Constant 1405 * class hierarchy. 1406 * 1407 * @{ 1408 */ 1409 1410 /** 1411 * Obtain a constant value referring to the null instance of a type. 1412 * 1413 * @see llvm::Constant::getNullValue() 1414 */ 1415 LLVMValueRef LLVMConstNull(LLVMTypeRef Ty); /* all zeroes */ 1416 1417 /** 1418 * Obtain a constant value referring to the instance of a type 1419 * consisting of all ones. 1420 * 1421 * This is only valid for integer types. 1422 * 1423 * @see llvm::Constant::getAllOnesValue() 1424 */ 1425 LLVMValueRef LLVMConstAllOnes(LLVMTypeRef Ty); 1426 1427 /** 1428 * Obtain a constant value referring to an undefined value of a type. 1429 * 1430 * @see llvm::UndefValue::get() 1431 */ 1432 LLVMValueRef LLVMGetUndef(LLVMTypeRef Ty); 1433 1434 /** 1435 * Determine whether a value instance is null. 1436 * 1437 * @see llvm::Constant::isNullValue() 1438 */ 1439 LLVMBool LLVMIsNull(LLVMValueRef Val); 1440 1441 /** 1442 * Obtain a constant that is a constant pointer pointing to NULL for a 1443 * specified type. 1444 */ 1445 LLVMValueRef LLVMConstPointerNull(LLVMTypeRef Ty); 1446 1447 /** 1448 * @defgroup LLVMCCoreValueConstantScalar Scalar constants 1449 * 1450 * Functions in this group model LLVMValueRef instances that correspond 1451 * to constants referring to scalar types. 1452 * 1453 * For integer types, the LLVMTypeRef parameter should correspond to a 1454 * llvm::IntegerType instance and the returned LLVMValueRef will 1455 * correspond to a llvm::ConstantInt. 1456 * 1457 * For floating point types, the LLVMTypeRef returned corresponds to a 1458 * llvm::ConstantFP. 1459 * 1460 * @{ 1461 */ 1462 1463 /** 1464 * Obtain a constant value for an integer type. 1465 * 1466 * The returned value corresponds to a llvm::ConstantInt. 1467 * 1468 * @see llvm::ConstantInt::get() 1469 * 1470 * @param IntTy Integer type to obtain value of. 1471 * @param N The value the returned instance should refer to. 1472 * @param SignExtend Whether to sign extend the produced value. 1473 */ 1474 LLVMValueRef LLVMConstInt(LLVMTypeRef IntTy, unsigned long long N, 1475 LLVMBool SignExtend); 1476 1477 /** 1478 * Obtain a constant value for an integer of arbitrary precision. 1479 * 1480 * @see llvm::ConstantInt::get() 1481 */ 1482 LLVMValueRef LLVMConstIntOfArbitraryPrecision(LLVMTypeRef IntTy, 1483 unsigned NumWords, 1484 const uint64_t Words[]); 1485 1486 /** 1487 * Obtain a constant value for an integer parsed from a string. 1488 * 1489 * A similar API, LLVMConstIntOfStringAndSize is also available. If the 1490 * string's length is available, it is preferred to call that function 1491 * instead. 1492 * 1493 * @see llvm::ConstantInt::get() 1494 */ 1495 LLVMValueRef LLVMConstIntOfString(LLVMTypeRef IntTy, const char *Text, 1496 uint8_t Radix); 1497 1498 /** 1499 * Obtain a constant value for an integer parsed from a string with 1500 * specified length. 1501 * 1502 * @see llvm::ConstantInt::get() 1503 */ 1504 LLVMValueRef LLVMConstIntOfStringAndSize(LLVMTypeRef IntTy, const char *Text, 1505 unsigned SLen, uint8_t Radix); 1506 1507 /** 1508 * Obtain a constant value referring to a double floating point value. 1509 */ 1510 LLVMValueRef LLVMConstReal(LLVMTypeRef RealTy, double N); 1511 1512 /** 1513 * Obtain a constant for a floating point value parsed from a string. 1514 * 1515 * A similar API, LLVMConstRealOfStringAndSize is also available. It 1516 * should be used if the input string's length is known. 1517 */ 1518 LLVMValueRef LLVMConstRealOfString(LLVMTypeRef RealTy, const char *Text); 1519 1520 /** 1521 * Obtain a constant for a floating point value parsed from a string. 1522 */ 1523 LLVMValueRef LLVMConstRealOfStringAndSize(LLVMTypeRef RealTy, const char *Text, 1524 unsigned SLen); 1525 1526 /** 1527 * Obtain the zero extended value for an integer constant value. 1528 * 1529 * @see llvm::ConstantInt::getZExtValue() 1530 */ 1531 unsigned long long LLVMConstIntGetZExtValue(LLVMValueRef ConstantVal); 1532 1533 /** 1534 * Obtain the sign extended value for an integer constant value. 1535 * 1536 * @see llvm::ConstantInt::getSExtValue() 1537 */ 1538 long long LLVMConstIntGetSExtValue(LLVMValueRef ConstantVal); 1539 1540 /** 1541 * @} 1542 */ 1543 1544 /** 1545 * @defgroup LLVMCCoreValueConstantComposite Composite Constants 1546 * 1547 * Functions in this group operate on composite constants. 1548 * 1549 * @{ 1550 */ 1551 1552 /** 1553 * Create a ConstantDataSequential and initialize it with a string. 1554 * 1555 * @see llvm::ConstantDataArray::getString() 1556 */ 1557 LLVMValueRef LLVMConstStringInContext(LLVMContextRef C, const char *Str, 1558 unsigned Length, LLVMBool DontNullTerminate); 1559 1560 /** 1561 * Create a ConstantDataSequential with string content in the global context. 1562 * 1563 * This is the same as LLVMConstStringInContext except it operates on the 1564 * global context. 1565 * 1566 * @see LLVMConstStringInContext() 1567 * @see llvm::ConstantDataArray::getString() 1568 */ 1569 LLVMValueRef LLVMConstString(const char *Str, unsigned Length, 1570 LLVMBool DontNullTerminate); 1571 1572 /** 1573 * Create an anonymous ConstantStruct with the specified values. 1574 * 1575 * @see llvm::ConstantStruct::getAnon() 1576 */ 1577 LLVMValueRef LLVMConstStructInContext(LLVMContextRef C, 1578 LLVMValueRef *ConstantVals, 1579 unsigned Count, LLVMBool Packed); 1580 1581 /** 1582 * Create a ConstantStruct in the global Context. 1583 * 1584 * This is the same as LLVMConstStructInContext except it operates on the 1585 * global Context. 1586 * 1587 * @see LLVMConstStructInContext() 1588 */ 1589 LLVMValueRef LLVMConstStruct(LLVMValueRef *ConstantVals, unsigned Count, 1590 LLVMBool Packed); 1591 1592 /** 1593 * Create a ConstantArray from values. 1594 * 1595 * @see llvm::ConstantArray::get() 1596 */ 1597 LLVMValueRef LLVMConstArray(LLVMTypeRef ElementTy, 1598 LLVMValueRef *ConstantVals, unsigned Length); 1599 1600 /** 1601 * Create a non-anonymous ConstantStruct from values. 1602 * 1603 * @see llvm::ConstantStruct::get() 1604 */ 1605 LLVMValueRef LLVMConstNamedStruct(LLVMTypeRef StructTy, 1606 LLVMValueRef *ConstantVals, 1607 unsigned Count); 1608 1609 /** 1610 * Create a ConstantVector from values. 1611 * 1612 * @see llvm::ConstantVector::get() 1613 */ 1614 LLVMValueRef LLVMConstVector(LLVMValueRef *ScalarConstantVals, unsigned Size); 1615 1616 /** 1617 * @} 1618 */ 1619 1620 /** 1621 * @defgroup LLVMCCoreValueConstantExpressions Constant Expressions 1622 * 1623 * Functions in this group correspond to APIs on llvm::ConstantExpr. 1624 * 1625 * @see llvm::ConstantExpr. 1626 * 1627 * @{ 1628 */ 1629 LLVMOpcode LLVMGetConstOpcode(LLVMValueRef ConstantVal); 1630 LLVMValueRef LLVMAlignOf(LLVMTypeRef Ty); 1631 LLVMValueRef LLVMSizeOf(LLVMTypeRef Ty); 1632 LLVMValueRef LLVMConstNeg(LLVMValueRef ConstantVal); 1633 LLVMValueRef LLVMConstNSWNeg(LLVMValueRef ConstantVal); 1634 LLVMValueRef LLVMConstNUWNeg(LLVMValueRef ConstantVal); 1635 LLVMValueRef LLVMConstFNeg(LLVMValueRef ConstantVal); 1636 LLVMValueRef LLVMConstNot(LLVMValueRef ConstantVal); 1637 LLVMValueRef LLVMConstAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1638 LLVMValueRef LLVMConstNSWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1639 LLVMValueRef LLVMConstNUWAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1640 LLVMValueRef LLVMConstFAdd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1641 LLVMValueRef LLVMConstSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1642 LLVMValueRef LLVMConstNSWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1643 LLVMValueRef LLVMConstNUWSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1644 LLVMValueRef LLVMConstFSub(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1645 LLVMValueRef LLVMConstMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1646 LLVMValueRef LLVMConstNSWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1647 LLVMValueRef LLVMConstNUWMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1648 LLVMValueRef LLVMConstFMul(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1649 LLVMValueRef LLVMConstUDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1650 LLVMValueRef LLVMConstSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1651 LLVMValueRef LLVMConstExactSDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1652 LLVMValueRef LLVMConstFDiv(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1653 LLVMValueRef LLVMConstURem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1654 LLVMValueRef LLVMConstSRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1655 LLVMValueRef LLVMConstFRem(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1656 LLVMValueRef LLVMConstAnd(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1657 LLVMValueRef LLVMConstOr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1658 LLVMValueRef LLVMConstXor(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1659 LLVMValueRef LLVMConstICmp(LLVMIntPredicate Predicate, 1660 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1661 LLVMValueRef LLVMConstFCmp(LLVMRealPredicate Predicate, 1662 LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1663 LLVMValueRef LLVMConstShl(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1664 LLVMValueRef LLVMConstLShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1665 LLVMValueRef LLVMConstAShr(LLVMValueRef LHSConstant, LLVMValueRef RHSConstant); 1666 LLVMValueRef LLVMConstGEP(LLVMValueRef ConstantVal, 1667 LLVMValueRef *ConstantIndices, unsigned NumIndices); 1668 LLVMValueRef LLVMConstInBoundsGEP(LLVMValueRef ConstantVal, 1669 LLVMValueRef *ConstantIndices, 1670 unsigned NumIndices); 1671 LLVMValueRef LLVMConstTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1672 LLVMValueRef LLVMConstSExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1673 LLVMValueRef LLVMConstZExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1674 LLVMValueRef LLVMConstFPTrunc(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1675 LLVMValueRef LLVMConstFPExt(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1676 LLVMValueRef LLVMConstUIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1677 LLVMValueRef LLVMConstSIToFP(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1678 LLVMValueRef LLVMConstFPToUI(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1679 LLVMValueRef LLVMConstFPToSI(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1680 LLVMValueRef LLVMConstPtrToInt(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1681 LLVMValueRef LLVMConstIntToPtr(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1682 LLVMValueRef LLVMConstBitCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1683 LLVMValueRef LLVMConstAddrSpaceCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1684 LLVMValueRef LLVMConstZExtOrBitCast(LLVMValueRef ConstantVal, 1685 LLVMTypeRef ToType); 1686 LLVMValueRef LLVMConstSExtOrBitCast(LLVMValueRef ConstantVal, 1687 LLVMTypeRef ToType); 1688 LLVMValueRef LLVMConstTruncOrBitCast(LLVMValueRef ConstantVal, 1689 LLVMTypeRef ToType); 1690 LLVMValueRef LLVMConstPointerCast(LLVMValueRef ConstantVal, 1691 LLVMTypeRef ToType); 1692 LLVMValueRef LLVMConstIntCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType, 1693 LLVMBool isSigned); 1694 LLVMValueRef LLVMConstFPCast(LLVMValueRef ConstantVal, LLVMTypeRef ToType); 1695 LLVMValueRef LLVMConstSelect(LLVMValueRef ConstantCondition, 1696 LLVMValueRef ConstantIfTrue, 1697 LLVMValueRef ConstantIfFalse); 1698 LLVMValueRef LLVMConstExtractElement(LLVMValueRef VectorConstant, 1699 LLVMValueRef IndexConstant); 1700 LLVMValueRef LLVMConstInsertElement(LLVMValueRef VectorConstant, 1701 LLVMValueRef ElementValueConstant, 1702 LLVMValueRef IndexConstant); 1703 LLVMValueRef LLVMConstShuffleVector(LLVMValueRef VectorAConstant, 1704 LLVMValueRef VectorBConstant, 1705 LLVMValueRef MaskConstant); 1706 LLVMValueRef LLVMConstExtractValue(LLVMValueRef AggConstant, unsigned *IdxList, 1707 unsigned NumIdx); 1708 LLVMValueRef LLVMConstInsertValue(LLVMValueRef AggConstant, 1709 LLVMValueRef ElementValueConstant, 1710 unsigned *IdxList, unsigned NumIdx); 1711 LLVMValueRef LLVMConstInlineAsm(LLVMTypeRef Ty, 1712 const char *AsmString, const char *Constraints, 1713 LLVMBool HasSideEffects, LLVMBool IsAlignStack); 1714 LLVMValueRef LLVMBlockAddress(LLVMValueRef F, LLVMBasicBlockRef BB); 1715 1716 /** 1717 * @} 1718 */ 1719 1720 /** 1721 * @defgroup LLVMCCoreValueConstantGlobals Global Values 1722 * 1723 * This group contains functions that operate on global values. Functions in 1724 * this group relate to functions in the llvm::GlobalValue class tree. 1725 * 1726 * @see llvm::GlobalValue 1727 * 1728 * @{ 1729 */ 1730 1731 LLVMModuleRef LLVMGetGlobalParent(LLVMValueRef Global); 1732 LLVMBool LLVMIsDeclaration(LLVMValueRef Global); 1733 LLVMLinkage LLVMGetLinkage(LLVMValueRef Global); 1734 void LLVMSetLinkage(LLVMValueRef Global, LLVMLinkage Linkage); 1735 const char *LLVMGetSection(LLVMValueRef Global); 1736 void LLVMSetSection(LLVMValueRef Global, const char *Section); 1737 LLVMVisibility LLVMGetVisibility(LLVMValueRef Global); 1738 void LLVMSetVisibility(LLVMValueRef Global, LLVMVisibility Viz); 1739 LLVMDLLStorageClass LLVMGetDLLStorageClass(LLVMValueRef Global); 1740 void LLVMSetDLLStorageClass(LLVMValueRef Global, LLVMDLLStorageClass Class); 1741 LLVMBool LLVMHasUnnamedAddr(LLVMValueRef Global); 1742 void LLVMSetUnnamedAddr(LLVMValueRef Global, LLVMBool HasUnnamedAddr); 1743 1744 /** 1745 * @defgroup LLVMCCoreValueWithAlignment Values with alignment 1746 * 1747 * Functions in this group only apply to values with alignment, i.e. 1748 * global variables, load and store instructions. 1749 */ 1750 1751 /** 1752 * Obtain the preferred alignment of the value. 1753 * @see llvm::AllocaInst::getAlignment() 1754 * @see llvm::LoadInst::getAlignment() 1755 * @see llvm::StoreInst::getAlignment() 1756 * @see llvm::GlobalValue::getAlignment() 1757 */ 1758 unsigned LLVMGetAlignment(LLVMValueRef V); 1759 1760 /** 1761 * Set the preferred alignment of the value. 1762 * @see llvm::AllocaInst::setAlignment() 1763 * @see llvm::LoadInst::setAlignment() 1764 * @see llvm::StoreInst::setAlignment() 1765 * @see llvm::GlobalValue::setAlignment() 1766 */ 1767 void LLVMSetAlignment(LLVMValueRef V, unsigned Bytes); 1768 1769 /** 1770 * @} 1771 */ 1772 1773 /** 1774 * @defgroup LLVMCoreValueConstantGlobalVariable Global Variables 1775 * 1776 * This group contains functions that operate on global variable values. 1777 * 1778 * @see llvm::GlobalVariable 1779 * 1780 * @{ 1781 */ 1782 LLVMValueRef LLVMAddGlobal(LLVMModuleRef M, LLVMTypeRef Ty, const char *Name); 1783 LLVMValueRef LLVMAddGlobalInAddressSpace(LLVMModuleRef M, LLVMTypeRef Ty, 1784 const char *Name, 1785 unsigned AddressSpace); 1786 LLVMValueRef LLVMGetNamedGlobal(LLVMModuleRef M, const char *Name); 1787 LLVMValueRef LLVMGetFirstGlobal(LLVMModuleRef M); 1788 LLVMValueRef LLVMGetLastGlobal(LLVMModuleRef M); 1789 LLVMValueRef LLVMGetNextGlobal(LLVMValueRef GlobalVar); 1790 LLVMValueRef LLVMGetPreviousGlobal(LLVMValueRef GlobalVar); 1791 void LLVMDeleteGlobal(LLVMValueRef GlobalVar); 1792 LLVMValueRef LLVMGetInitializer(LLVMValueRef GlobalVar); 1793 void LLVMSetInitializer(LLVMValueRef GlobalVar, LLVMValueRef ConstantVal); 1794 LLVMBool LLVMIsThreadLocal(LLVMValueRef GlobalVar); 1795 void LLVMSetThreadLocal(LLVMValueRef GlobalVar, LLVMBool IsThreadLocal); 1796 LLVMBool LLVMIsGlobalConstant(LLVMValueRef GlobalVar); 1797 void LLVMSetGlobalConstant(LLVMValueRef GlobalVar, LLVMBool IsConstant); 1798 LLVMThreadLocalMode LLVMGetThreadLocalMode(LLVMValueRef GlobalVar); 1799 void LLVMSetThreadLocalMode(LLVMValueRef GlobalVar, LLVMThreadLocalMode Mode); 1800 LLVMBool LLVMIsExternallyInitialized(LLVMValueRef GlobalVar); 1801 void LLVMSetExternallyInitialized(LLVMValueRef GlobalVar, LLVMBool IsExtInit); 1802 1803 /** 1804 * @} 1805 */ 1806 1807 /** 1808 * @defgroup LLVMCoreValueConstantGlobalAlias Global Aliases 1809 * 1810 * This group contains function that operate on global alias values. 1811 * 1812 * @see llvm::GlobalAlias 1813 * 1814 * @{ 1815 */ 1816 LLVMValueRef LLVMAddAlias(LLVMModuleRef M, LLVMTypeRef Ty, LLVMValueRef Aliasee, 1817 const char *Name); 1818 1819 /** 1820 * @} 1821 */ 1822 1823 /** 1824 * @defgroup LLVMCCoreValueFunction Function values 1825 * 1826 * Functions in this group operate on LLVMValueRef instances that 1827 * correspond to llvm::Function instances. 1828 * 1829 * @see llvm::Function 1830 * 1831 * @{ 1832 */ 1833 1834 /** 1835 * Remove a function from its containing module and deletes it. 1836 * 1837 * @see llvm::Function::eraseFromParent() 1838 */ 1839 void LLVMDeleteFunction(LLVMValueRef Fn); 1840 1841 /** 1842 * Obtain the ID number from a function instance. 1843 * 1844 * @see llvm::Function::getIntrinsicID() 1845 */ 1846 unsigned LLVMGetIntrinsicID(LLVMValueRef Fn); 1847 1848 /** 1849 * Obtain the calling function of a function. 1850 * 1851 * The returned value corresponds to the LLVMCallConv enumeration. 1852 * 1853 * @see llvm::Function::getCallingConv() 1854 */ 1855 unsigned LLVMGetFunctionCallConv(LLVMValueRef Fn); 1856 1857 /** 1858 * Set the calling convention of a function. 1859 * 1860 * @see llvm::Function::setCallingConv() 1861 * 1862 * @param Fn Function to operate on 1863 * @param CC LLVMCallConv to set calling convention to 1864 */ 1865 void LLVMSetFunctionCallConv(LLVMValueRef Fn, unsigned CC); 1866 1867 /** 1868 * Obtain the name of the garbage collector to use during code 1869 * generation. 1870 * 1871 * @see llvm::Function::getGC() 1872 */ 1873 const char *LLVMGetGC(LLVMValueRef Fn); 1874 1875 /** 1876 * Define the garbage collector to use during code generation. 1877 * 1878 * @see llvm::Function::setGC() 1879 */ 1880 void LLVMSetGC(LLVMValueRef Fn, const char *Name); 1881 1882 /** 1883 * Add an attribute to a function. 1884 * 1885 * @see llvm::Function::addAttribute() 1886 */ 1887 void LLVMAddFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA); 1888 1889 /** 1890 * Add a target-dependent attribute to a fuction 1891 * @see llvm::AttrBuilder::addAttribute() 1892 */ 1893 void LLVMAddTargetDependentFunctionAttr(LLVMValueRef Fn, const char *A, 1894 const char *V); 1895 1896 /** 1897 * Obtain an attribute from a function. 1898 * 1899 * @see llvm::Function::getAttributes() 1900 */ 1901 LLVMAttribute LLVMGetFunctionAttr(LLVMValueRef Fn); 1902 1903 /** 1904 * Remove an attribute from a function. 1905 */ 1906 void LLVMRemoveFunctionAttr(LLVMValueRef Fn, LLVMAttribute PA); 1907 1908 /** 1909 * @defgroup LLVMCCoreValueFunctionParameters Function Parameters 1910 * 1911 * Functions in this group relate to arguments/parameters on functions. 1912 * 1913 * Functions in this group expect LLVMValueRef instances that correspond 1914 * to llvm::Function instances. 1915 * 1916 * @{ 1917 */ 1918 1919 /** 1920 * Obtain the number of parameters in a function. 1921 * 1922 * @see llvm::Function::arg_size() 1923 */ 1924 unsigned LLVMCountParams(LLVMValueRef Fn); 1925 1926 /** 1927 * Obtain the parameters in a function. 1928 * 1929 * The takes a pointer to a pre-allocated array of LLVMValueRef that is 1930 * at least LLVMCountParams() long. This array will be filled with 1931 * LLVMValueRef instances which correspond to the parameters the 1932 * function receives. Each LLVMValueRef corresponds to a llvm::Argument 1933 * instance. 1934 * 1935 * @see llvm::Function::arg_begin() 1936 */ 1937 void LLVMGetParams(LLVMValueRef Fn, LLVMValueRef *Params); 1938 1939 /** 1940 * Obtain the parameter at the specified index. 1941 * 1942 * Parameters are indexed from 0. 1943 * 1944 * @see llvm::Function::arg_begin() 1945 */ 1946 LLVMValueRef LLVMGetParam(LLVMValueRef Fn, unsigned Index); 1947 1948 /** 1949 * Obtain the function to which this argument belongs. 1950 * 1951 * Unlike other functions in this group, this one takes an LLVMValueRef 1952 * that corresponds to a llvm::Attribute. 1953 * 1954 * The returned LLVMValueRef is the llvm::Function to which this 1955 * argument belongs. 1956 */ 1957 LLVMValueRef LLVMGetParamParent(LLVMValueRef Inst); 1958 1959 /** 1960 * Obtain the first parameter to a function. 1961 * 1962 * @see llvm::Function::arg_begin() 1963 */ 1964 LLVMValueRef LLVMGetFirstParam(LLVMValueRef Fn); 1965 1966 /** 1967 * Obtain the last parameter to a function. 1968 * 1969 * @see llvm::Function::arg_end() 1970 */ 1971 LLVMValueRef LLVMGetLastParam(LLVMValueRef Fn); 1972 1973 /** 1974 * Obtain the next parameter to a function. 1975 * 1976 * This takes an LLVMValueRef obtained from LLVMGetFirstParam() (which is 1977 * actually a wrapped iterator) and obtains the next parameter from the 1978 * underlying iterator. 1979 */ 1980 LLVMValueRef LLVMGetNextParam(LLVMValueRef Arg); 1981 1982 /** 1983 * Obtain the previous parameter to a function. 1984 * 1985 * This is the opposite of LLVMGetNextParam(). 1986 */ 1987 LLVMValueRef LLVMGetPreviousParam(LLVMValueRef Arg); 1988 1989 /** 1990 * Add an attribute to a function argument. 1991 * 1992 * @see llvm::Argument::addAttr() 1993 */ 1994 void LLVMAddAttribute(LLVMValueRef Arg, LLVMAttribute PA); 1995 1996 /** 1997 * Remove an attribute from a function argument. 1998 * 1999 * @see llvm::Argument::removeAttr() 2000 */ 2001 void LLVMRemoveAttribute(LLVMValueRef Arg, LLVMAttribute PA); 2002 2003 /** 2004 * Get an attribute from a function argument. 2005 */ 2006 LLVMAttribute LLVMGetAttribute(LLVMValueRef Arg); 2007 2008 /** 2009 * Set the alignment for a function parameter. 2010 * 2011 * @see llvm::Argument::addAttr() 2012 * @see llvm::AttrBuilder::addAlignmentAttr() 2013 */ 2014 void LLVMSetParamAlignment(LLVMValueRef Arg, unsigned align); 2015 2016 /** 2017 * @} 2018 */ 2019 2020 /** 2021 * @} 2022 */ 2023 2024 /** 2025 * @} 2026 */ 2027 2028 /** 2029 * @} 2030 */ 2031 2032 /** 2033 * @defgroup LLVMCCoreValueMetadata Metadata 2034 * 2035 * @{ 2036 */ 2037 2038 /** 2039 * Obtain a MDString value from a context. 2040 * 2041 * The returned instance corresponds to the llvm::MDString class. 2042 * 2043 * The instance is specified by string data of a specified length. The 2044 * string content is copied, so the backing memory can be freed after 2045 * this function returns. 2046 */ 2047 LLVMValueRef LLVMMDStringInContext(LLVMContextRef C, const char *Str, 2048 unsigned SLen); 2049 2050 /** 2051 * Obtain a MDString value from the global context. 2052 */ 2053 LLVMValueRef LLVMMDString(const char *Str, unsigned SLen); 2054 2055 /** 2056 * Obtain a MDNode value from a context. 2057 * 2058 * The returned value corresponds to the llvm::MDNode class. 2059 */ 2060 LLVMValueRef LLVMMDNodeInContext(LLVMContextRef C, LLVMValueRef *Vals, 2061 unsigned Count); 2062 2063 /** 2064 * Obtain a MDNode value from the global context. 2065 */ 2066 LLVMValueRef LLVMMDNode(LLVMValueRef *Vals, unsigned Count); 2067 2068 /** 2069 * Obtain the underlying string from a MDString value. 2070 * 2071 * @param V Instance to obtain string from. 2072 * @param Len Memory address which will hold length of returned string. 2073 * @return String data in MDString. 2074 */ 2075 const char *LLVMGetMDString(LLVMValueRef V, unsigned* Len); 2076 2077 /** 2078 * Obtain the number of operands from an MDNode value. 2079 * 2080 * @param V MDNode to get number of operands from. 2081 * @return Number of operands of the MDNode. 2082 */ 2083 unsigned LLVMGetMDNodeNumOperands(LLVMValueRef V); 2084 2085 /** 2086 * Obtain the given MDNode's operands. 2087 * 2088 * The passed LLVMValueRef pointer should point to enough memory to hold all of 2089 * the operands of the given MDNode (see LLVMGetMDNodeNumOperands) as 2090 * LLVMValueRefs. This memory will be populated with the LLVMValueRefs of the 2091 * MDNode's operands. 2092 * 2093 * @param V MDNode to get the operands from. 2094 * @param Dest Destination array for operands. 2095 */ 2096 void LLVMGetMDNodeOperands(LLVMValueRef V, LLVMValueRef *Dest); 2097 2098 /** 2099 * @} 2100 */ 2101 2102 /** 2103 * @defgroup LLVMCCoreValueBasicBlock Basic Block 2104 * 2105 * A basic block represents a single entry single exit section of code. 2106 * Basic blocks contain a list of instructions which form the body of 2107 * the block. 2108 * 2109 * Basic blocks belong to functions. They have the type of label. 2110 * 2111 * Basic blocks are themselves values. However, the C API models them as 2112 * LLVMBasicBlockRef. 2113 * 2114 * @see llvm::BasicBlock 2115 * 2116 * @{ 2117 */ 2118 2119 /** 2120 * Convert a basic block instance to a value type. 2121 */ 2122 LLVMValueRef LLVMBasicBlockAsValue(LLVMBasicBlockRef BB); 2123 2124 /** 2125 * Determine whether an LLVMValueRef is itself a basic block. 2126 */ 2127 LLVMBool LLVMValueIsBasicBlock(LLVMValueRef Val); 2128 2129 /** 2130 * Convert an LLVMValueRef to an LLVMBasicBlockRef instance. 2131 */ 2132 LLVMBasicBlockRef LLVMValueAsBasicBlock(LLVMValueRef Val); 2133 2134 /** 2135 * Obtain the function to which a basic block belongs. 2136 * 2137 * @see llvm::BasicBlock::getParent() 2138 */ 2139 LLVMValueRef LLVMGetBasicBlockParent(LLVMBasicBlockRef BB); 2140 2141 /** 2142 * Obtain the terminator instruction for a basic block. 2143 * 2144 * If the basic block does not have a terminator (it is not well-formed 2145 * if it doesn't), then NULL is returned. 2146 * 2147 * The returned LLVMValueRef corresponds to a llvm::TerminatorInst. 2148 * 2149 * @see llvm::BasicBlock::getTerminator() 2150 */ 2151 LLVMValueRef LLVMGetBasicBlockTerminator(LLVMBasicBlockRef BB); 2152 2153 /** 2154 * Obtain the number of basic blocks in a function. 2155 * 2156 * @param Fn Function value to operate on. 2157 */ 2158 unsigned LLVMCountBasicBlocks(LLVMValueRef Fn); 2159 2160 /** 2161 * Obtain all of the basic blocks in a function. 2162 * 2163 * This operates on a function value. The BasicBlocks parameter is a 2164 * pointer to a pre-allocated array of LLVMBasicBlockRef of at least 2165 * LLVMCountBasicBlocks() in length. This array is populated with 2166 * LLVMBasicBlockRef instances. 2167 */ 2168 void LLVMGetBasicBlocks(LLVMValueRef Fn, LLVMBasicBlockRef *BasicBlocks); 2169 2170 /** 2171 * Obtain the first basic block in a function. 2172 * 2173 * The returned basic block can be used as an iterator. You will likely 2174 * eventually call into LLVMGetNextBasicBlock() with it. 2175 * 2176 * @see llvm::Function::begin() 2177 */ 2178 LLVMBasicBlockRef LLVMGetFirstBasicBlock(LLVMValueRef Fn); 2179 2180 /** 2181 * Obtain the last basic block in a function. 2182 * 2183 * @see llvm::Function::end() 2184 */ 2185 LLVMBasicBlockRef LLVMGetLastBasicBlock(LLVMValueRef Fn); 2186 2187 /** 2188 * Advance a basic block iterator. 2189 */ 2190 LLVMBasicBlockRef LLVMGetNextBasicBlock(LLVMBasicBlockRef BB); 2191 2192 /** 2193 * Go backwards in a basic block iterator. 2194 */ 2195 LLVMBasicBlockRef LLVMGetPreviousBasicBlock(LLVMBasicBlockRef BB); 2196 2197 /** 2198 * Obtain the basic block that corresponds to the entry point of a 2199 * function. 2200 * 2201 * @see llvm::Function::getEntryBlock() 2202 */ 2203 LLVMBasicBlockRef LLVMGetEntryBasicBlock(LLVMValueRef Fn); 2204 2205 /** 2206 * Append a basic block to the end of a function. 2207 * 2208 * @see llvm::BasicBlock::Create() 2209 */ 2210 LLVMBasicBlockRef LLVMAppendBasicBlockInContext(LLVMContextRef C, 2211 LLVMValueRef Fn, 2212 const char *Name); 2213 2214 /** 2215 * Append a basic block to the end of a function using the global 2216 * context. 2217 * 2218 * @see llvm::BasicBlock::Create() 2219 */ 2220 LLVMBasicBlockRef LLVMAppendBasicBlock(LLVMValueRef Fn, const char *Name); 2221 2222 /** 2223 * Insert a basic block in a function before another basic block. 2224 * 2225 * The function to add to is determined by the function of the 2226 * passed basic block. 2227 * 2228 * @see llvm::BasicBlock::Create() 2229 */ 2230 LLVMBasicBlockRef LLVMInsertBasicBlockInContext(LLVMContextRef C, 2231 LLVMBasicBlockRef BB, 2232 const char *Name); 2233 2234 /** 2235 * Insert a basic block in a function using the global context. 2236 * 2237 * @see llvm::BasicBlock::Create() 2238 */ 2239 LLVMBasicBlockRef LLVMInsertBasicBlock(LLVMBasicBlockRef InsertBeforeBB, 2240 const char *Name); 2241 2242 /** 2243 * Remove a basic block from a function and delete it. 2244 * 2245 * This deletes the basic block from its containing function and deletes 2246 * the basic block itself. 2247 * 2248 * @see llvm::BasicBlock::eraseFromParent() 2249 */ 2250 void LLVMDeleteBasicBlock(LLVMBasicBlockRef BB); 2251 2252 /** 2253 * Remove a basic block from a function. 2254 * 2255 * This deletes the basic block from its containing function but keep 2256 * the basic block alive. 2257 * 2258 * @see llvm::BasicBlock::removeFromParent() 2259 */ 2260 void LLVMRemoveBasicBlockFromParent(LLVMBasicBlockRef BB); 2261 2262 /** 2263 * Move a basic block to before another one. 2264 * 2265 * @see llvm::BasicBlock::moveBefore() 2266 */ 2267 void LLVMMoveBasicBlockBefore(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos); 2268 2269 /** 2270 * Move a basic block to after another one. 2271 * 2272 * @see llvm::BasicBlock::moveAfter() 2273 */ 2274 void LLVMMoveBasicBlockAfter(LLVMBasicBlockRef BB, LLVMBasicBlockRef MovePos); 2275 2276 /** 2277 * Obtain the first instruction in a basic block. 2278 * 2279 * The returned LLVMValueRef corresponds to a llvm::Instruction 2280 * instance. 2281 */ 2282 LLVMValueRef LLVMGetFirstInstruction(LLVMBasicBlockRef BB); 2283 2284 /** 2285 * Obtain the last instruction in a basic block. 2286 * 2287 * The returned LLVMValueRef corresponds to an LLVM:Instruction. 2288 */ 2289 LLVMValueRef LLVMGetLastInstruction(LLVMBasicBlockRef BB); 2290 2291 /** 2292 * @} 2293 */ 2294 2295 /** 2296 * @defgroup LLVMCCoreValueInstruction Instructions 2297 * 2298 * Functions in this group relate to the inspection and manipulation of 2299 * individual instructions. 2300 * 2301 * In the C++ API, an instruction is modeled by llvm::Instruction. This 2302 * class has a large number of descendents. llvm::Instruction is a 2303 * llvm::Value and in the C API, instructions are modeled by 2304 * LLVMValueRef. 2305 * 2306 * This group also contains sub-groups which operate on specific 2307 * llvm::Instruction types, e.g. llvm::CallInst. 2308 * 2309 * @{ 2310 */ 2311 2312 /** 2313 * Determine whether an instruction has any metadata attached. 2314 */ 2315 int LLVMHasMetadata(LLVMValueRef Val); 2316 2317 /** 2318 * Return metadata associated with an instruction value. 2319 */ 2320 LLVMValueRef LLVMGetMetadata(LLVMValueRef Val, unsigned KindID); 2321 2322 /** 2323 * Set metadata associated with an instruction value. 2324 */ 2325 void LLVMSetMetadata(LLVMValueRef Val, unsigned KindID, LLVMValueRef Node); 2326 2327 /** 2328 * Obtain the basic block to which an instruction belongs. 2329 * 2330 * @see llvm::Instruction::getParent() 2331 */ 2332 LLVMBasicBlockRef LLVMGetInstructionParent(LLVMValueRef Inst); 2333 2334 /** 2335 * Obtain the instruction that occurs after the one specified. 2336 * 2337 * The next instruction will be from the same basic block. 2338 * 2339 * If this is the last instruction in a basic block, NULL will be 2340 * returned. 2341 */ 2342 LLVMValueRef LLVMGetNextInstruction(LLVMValueRef Inst); 2343 2344 /** 2345 * Obtain the instruction that occurred before this one. 2346 * 2347 * If the instruction is the first instruction in a basic block, NULL 2348 * will be returned. 2349 */ 2350 LLVMValueRef LLVMGetPreviousInstruction(LLVMValueRef Inst); 2351 2352 /** 2353 * Remove and delete an instruction. 2354 * 2355 * The instruction specified is removed from its containing building 2356 * block and then deleted. 2357 * 2358 * @see llvm::Instruction::eraseFromParent() 2359 */ 2360 void LLVMInstructionEraseFromParent(LLVMValueRef Inst); 2361 2362 /** 2363 * Obtain the code opcode for an individual instruction. 2364 * 2365 * @see llvm::Instruction::getOpCode() 2366 */ 2367 LLVMOpcode LLVMGetInstructionOpcode(LLVMValueRef Inst); 2368 2369 /** 2370 * Obtain the predicate of an instruction. 2371 * 2372 * This is only valid for instructions that correspond to llvm::ICmpInst 2373 * or llvm::ConstantExpr whose opcode is llvm::Instruction::ICmp. 2374 * 2375 * @see llvm::ICmpInst::getPredicate() 2376 */ 2377 LLVMIntPredicate LLVMGetICmpPredicate(LLVMValueRef Inst); 2378 2379 /** 2380 * @defgroup LLVMCCoreValueInstructionCall Call Sites and Invocations 2381 * 2382 * Functions in this group apply to instructions that refer to call 2383 * sites and invocations. These correspond to C++ types in the 2384 * llvm::CallInst class tree. 2385 * 2386 * @{ 2387 */ 2388 2389 /** 2390 * Set the calling convention for a call instruction. 2391 * 2392 * This expects an LLVMValueRef that corresponds to a llvm::CallInst or 2393 * llvm::InvokeInst. 2394 * 2395 * @see llvm::CallInst::setCallingConv() 2396 * @see llvm::InvokeInst::setCallingConv() 2397 */ 2398 void LLVMSetInstructionCallConv(LLVMValueRef Instr, unsigned CC); 2399 2400 /** 2401 * Obtain the calling convention for a call instruction. 2402 * 2403 * This is the opposite of LLVMSetInstructionCallConv(). Reads its 2404 * usage. 2405 * 2406 * @see LLVMSetInstructionCallConv() 2407 */ 2408 unsigned LLVMGetInstructionCallConv(LLVMValueRef Instr); 2409 2410 2411 void LLVMAddInstrAttribute(LLVMValueRef Instr, unsigned index, LLVMAttribute); 2412 void LLVMRemoveInstrAttribute(LLVMValueRef Instr, unsigned index, 2413 LLVMAttribute); 2414 void LLVMSetInstrParamAlignment(LLVMValueRef Instr, unsigned index, 2415 unsigned align); 2416 2417 /** 2418 * Obtain whether a call instruction is a tail call. 2419 * 2420 * This only works on llvm::CallInst instructions. 2421 * 2422 * @see llvm::CallInst::isTailCall() 2423 */ 2424 LLVMBool LLVMIsTailCall(LLVMValueRef CallInst); 2425 2426 /** 2427 * Set whether a call instruction is a tail call. 2428 * 2429 * This only works on llvm::CallInst instructions. 2430 * 2431 * @see llvm::CallInst::setTailCall() 2432 */ 2433 void LLVMSetTailCall(LLVMValueRef CallInst, LLVMBool IsTailCall); 2434 2435 /** 2436 * @} 2437 */ 2438 2439 /** 2440 * Obtain the default destination basic block of a switch instruction. 2441 * 2442 * This only works on llvm::SwitchInst instructions. 2443 * 2444 * @see llvm::SwitchInst::getDefaultDest() 2445 */ 2446 LLVMBasicBlockRef LLVMGetSwitchDefaultDest(LLVMValueRef SwitchInstr); 2447 2448 /** 2449 * @defgroup LLVMCCoreValueInstructionPHINode PHI Nodes 2450 * 2451 * Functions in this group only apply to instructions that map to 2452 * llvm::PHINode instances. 2453 * 2454 * @{ 2455 */ 2456 2457 /** 2458 * Add an incoming value to the end of a PHI list. 2459 */ 2460 void LLVMAddIncoming(LLVMValueRef PhiNode, LLVMValueRef *IncomingValues, 2461 LLVMBasicBlockRef *IncomingBlocks, unsigned Count); 2462 2463 /** 2464 * Obtain the number of incoming basic blocks to a PHI node. 2465 */ 2466 unsigned LLVMCountIncoming(LLVMValueRef PhiNode); 2467 2468 /** 2469 * Obtain an incoming value to a PHI node as an LLVMValueRef. 2470 */ 2471 LLVMValueRef LLVMGetIncomingValue(LLVMValueRef PhiNode, unsigned Index); 2472 2473 /** 2474 * Obtain an incoming value to a PHI node as an LLVMBasicBlockRef. 2475 */ 2476 LLVMBasicBlockRef LLVMGetIncomingBlock(LLVMValueRef PhiNode, unsigned Index); 2477 2478 /** 2479 * @} 2480 */ 2481 2482 /** 2483 * @} 2484 */ 2485 2486 /** 2487 * @} 2488 */ 2489 2490 /** 2491 * @defgroup LLVMCCoreInstructionBuilder Instruction Builders 2492 * 2493 * An instruction builder represents a point within a basic block and is 2494 * the exclusive means of building instructions using the C interface. 2495 * 2496 * @{ 2497 */ 2498 2499 LLVMBuilderRef LLVMCreateBuilderInContext(LLVMContextRef C); 2500 LLVMBuilderRef LLVMCreateBuilder(void); 2501 void LLVMPositionBuilder(LLVMBuilderRef Builder, LLVMBasicBlockRef Block, 2502 LLVMValueRef Instr); 2503 void LLVMPositionBuilderBefore(LLVMBuilderRef Builder, LLVMValueRef Instr); 2504 void LLVMPositionBuilderAtEnd(LLVMBuilderRef Builder, LLVMBasicBlockRef Block); 2505 LLVMBasicBlockRef LLVMGetInsertBlock(LLVMBuilderRef Builder); 2506 void LLVMClearInsertionPosition(LLVMBuilderRef Builder); 2507 void LLVMInsertIntoBuilder(LLVMBuilderRef Builder, LLVMValueRef Instr); 2508 void LLVMInsertIntoBuilderWithName(LLVMBuilderRef Builder, LLVMValueRef Instr, 2509 const char *Name); 2510 void LLVMDisposeBuilder(LLVMBuilderRef Builder); 2511 2512 /* Metadata */ 2513 void LLVMSetCurrentDebugLocation(LLVMBuilderRef Builder, LLVMValueRef L); 2514 LLVMValueRef LLVMGetCurrentDebugLocation(LLVMBuilderRef Builder); 2515 void LLVMSetInstDebugLocation(LLVMBuilderRef Builder, LLVMValueRef Inst); 2516 2517 /* Terminators */ 2518 LLVMValueRef LLVMBuildRetVoid(LLVMBuilderRef); 2519 LLVMValueRef LLVMBuildRet(LLVMBuilderRef, LLVMValueRef V); 2520 LLVMValueRef LLVMBuildAggregateRet(LLVMBuilderRef, LLVMValueRef *RetVals, 2521 unsigned N); 2522 LLVMValueRef LLVMBuildBr(LLVMBuilderRef, LLVMBasicBlockRef Dest); 2523 LLVMValueRef LLVMBuildCondBr(LLVMBuilderRef, LLVMValueRef If, 2524 LLVMBasicBlockRef Then, LLVMBasicBlockRef Else); 2525 LLVMValueRef LLVMBuildSwitch(LLVMBuilderRef, LLVMValueRef V, 2526 LLVMBasicBlockRef Else, unsigned NumCases); 2527 LLVMValueRef LLVMBuildIndirectBr(LLVMBuilderRef B, LLVMValueRef Addr, 2528 unsigned NumDests); 2529 LLVMValueRef LLVMBuildInvoke(LLVMBuilderRef, LLVMValueRef Fn, 2530 LLVMValueRef *Args, unsigned NumArgs, 2531 LLVMBasicBlockRef Then, LLVMBasicBlockRef Catch, 2532 const char *Name); 2533 LLVMValueRef LLVMBuildLandingPad(LLVMBuilderRef B, LLVMTypeRef Ty, 2534 LLVMValueRef PersFn, unsigned NumClauses, 2535 const char *Name); 2536 LLVMValueRef LLVMBuildResume(LLVMBuilderRef B, LLVMValueRef Exn); 2537 LLVMValueRef LLVMBuildUnreachable(LLVMBuilderRef); 2538 2539 /* Add a case to the switch instruction */ 2540 void LLVMAddCase(LLVMValueRef Switch, LLVMValueRef OnVal, 2541 LLVMBasicBlockRef Dest); 2542 2543 /* Add a destination to the indirectbr instruction */ 2544 void LLVMAddDestination(LLVMValueRef IndirectBr, LLVMBasicBlockRef Dest); 2545 2546 /* Add a catch or filter clause to the landingpad instruction */ 2547 void LLVMAddClause(LLVMValueRef LandingPad, LLVMValueRef ClauseVal); 2548 2549 /* Set the 'cleanup' flag in the landingpad instruction */ 2550 void LLVMSetCleanup(LLVMValueRef LandingPad, LLVMBool Val); 2551 2552 /* Arithmetic */ 2553 LLVMValueRef LLVMBuildAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2554 const char *Name); 2555 LLVMValueRef LLVMBuildNSWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2556 const char *Name); 2557 LLVMValueRef LLVMBuildNUWAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2558 const char *Name); 2559 LLVMValueRef LLVMBuildFAdd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2560 const char *Name); 2561 LLVMValueRef LLVMBuildSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2562 const char *Name); 2563 LLVMValueRef LLVMBuildNSWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2564 const char *Name); 2565 LLVMValueRef LLVMBuildNUWSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2566 const char *Name); 2567 LLVMValueRef LLVMBuildFSub(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2568 const char *Name); 2569 LLVMValueRef LLVMBuildMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2570 const char *Name); 2571 LLVMValueRef LLVMBuildNSWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2572 const char *Name); 2573 LLVMValueRef LLVMBuildNUWMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2574 const char *Name); 2575 LLVMValueRef LLVMBuildFMul(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2576 const char *Name); 2577 LLVMValueRef LLVMBuildUDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2578 const char *Name); 2579 LLVMValueRef LLVMBuildSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2580 const char *Name); 2581 LLVMValueRef LLVMBuildExactSDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2582 const char *Name); 2583 LLVMValueRef LLVMBuildFDiv(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2584 const char *Name); 2585 LLVMValueRef LLVMBuildURem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2586 const char *Name); 2587 LLVMValueRef LLVMBuildSRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2588 const char *Name); 2589 LLVMValueRef LLVMBuildFRem(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2590 const char *Name); 2591 LLVMValueRef LLVMBuildShl(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2592 const char *Name); 2593 LLVMValueRef LLVMBuildLShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2594 const char *Name); 2595 LLVMValueRef LLVMBuildAShr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2596 const char *Name); 2597 LLVMValueRef LLVMBuildAnd(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2598 const char *Name); 2599 LLVMValueRef LLVMBuildOr(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2600 const char *Name); 2601 LLVMValueRef LLVMBuildXor(LLVMBuilderRef, LLVMValueRef LHS, LLVMValueRef RHS, 2602 const char *Name); 2603 LLVMValueRef LLVMBuildBinOp(LLVMBuilderRef B, LLVMOpcode Op, 2604 LLVMValueRef LHS, LLVMValueRef RHS, 2605 const char *Name); 2606 LLVMValueRef LLVMBuildNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name); 2607 LLVMValueRef LLVMBuildNSWNeg(LLVMBuilderRef B, LLVMValueRef V, 2608 const char *Name); 2609 LLVMValueRef LLVMBuildNUWNeg(LLVMBuilderRef B, LLVMValueRef V, 2610 const char *Name); 2611 LLVMValueRef LLVMBuildFNeg(LLVMBuilderRef, LLVMValueRef V, const char *Name); 2612 LLVMValueRef LLVMBuildNot(LLVMBuilderRef, LLVMValueRef V, const char *Name); 2613 2614 /* Memory */ 2615 LLVMValueRef LLVMBuildMalloc(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name); 2616 LLVMValueRef LLVMBuildArrayMalloc(LLVMBuilderRef, LLVMTypeRef Ty, 2617 LLVMValueRef Val, const char *Name); 2618 LLVMValueRef LLVMBuildAlloca(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name); 2619 LLVMValueRef LLVMBuildArrayAlloca(LLVMBuilderRef, LLVMTypeRef Ty, 2620 LLVMValueRef Val, const char *Name); 2621 LLVMValueRef LLVMBuildFree(LLVMBuilderRef, LLVMValueRef PointerVal); 2622 LLVMValueRef LLVMBuildLoad(LLVMBuilderRef, LLVMValueRef PointerVal, 2623 const char *Name); 2624 LLVMValueRef LLVMBuildStore(LLVMBuilderRef, LLVMValueRef Val, LLVMValueRef Ptr); 2625 LLVMValueRef LLVMBuildGEP(LLVMBuilderRef B, LLVMValueRef Pointer, 2626 LLVMValueRef *Indices, unsigned NumIndices, 2627 const char *Name); 2628 LLVMValueRef LLVMBuildInBoundsGEP(LLVMBuilderRef B, LLVMValueRef Pointer, 2629 LLVMValueRef *Indices, unsigned NumIndices, 2630 const char *Name); 2631 LLVMValueRef LLVMBuildStructGEP(LLVMBuilderRef B, LLVMValueRef Pointer, 2632 unsigned Idx, const char *Name); 2633 LLVMValueRef LLVMBuildGlobalString(LLVMBuilderRef B, const char *Str, 2634 const char *Name); 2635 LLVMValueRef LLVMBuildGlobalStringPtr(LLVMBuilderRef B, const char *Str, 2636 const char *Name); 2637 LLVMBool LLVMGetVolatile(LLVMValueRef MemoryAccessInst); 2638 void LLVMSetVolatile(LLVMValueRef MemoryAccessInst, LLVMBool IsVolatile); 2639 2640 /* Casts */ 2641 LLVMValueRef LLVMBuildTrunc(LLVMBuilderRef, LLVMValueRef Val, 2642 LLVMTypeRef DestTy, const char *Name); 2643 LLVMValueRef LLVMBuildZExt(LLVMBuilderRef, LLVMValueRef Val, 2644 LLVMTypeRef DestTy, const char *Name); 2645 LLVMValueRef LLVMBuildSExt(LLVMBuilderRef, LLVMValueRef Val, 2646 LLVMTypeRef DestTy, const char *Name); 2647 LLVMValueRef LLVMBuildFPToUI(LLVMBuilderRef, LLVMValueRef Val, 2648 LLVMTypeRef DestTy, const char *Name); 2649 LLVMValueRef LLVMBuildFPToSI(LLVMBuilderRef, LLVMValueRef Val, 2650 LLVMTypeRef DestTy, const char *Name); 2651 LLVMValueRef LLVMBuildUIToFP(LLVMBuilderRef, LLVMValueRef Val, 2652 LLVMTypeRef DestTy, const char *Name); 2653 LLVMValueRef LLVMBuildSIToFP(LLVMBuilderRef, LLVMValueRef Val, 2654 LLVMTypeRef DestTy, const char *Name); 2655 LLVMValueRef LLVMBuildFPTrunc(LLVMBuilderRef, LLVMValueRef Val, 2656 LLVMTypeRef DestTy, const char *Name); 2657 LLVMValueRef LLVMBuildFPExt(LLVMBuilderRef, LLVMValueRef Val, 2658 LLVMTypeRef DestTy, const char *Name); 2659 LLVMValueRef LLVMBuildPtrToInt(LLVMBuilderRef, LLVMValueRef Val, 2660 LLVMTypeRef DestTy, const char *Name); 2661 LLVMValueRef LLVMBuildIntToPtr(LLVMBuilderRef, LLVMValueRef Val, 2662 LLVMTypeRef DestTy, const char *Name); 2663 LLVMValueRef LLVMBuildBitCast(LLVMBuilderRef, LLVMValueRef Val, 2664 LLVMTypeRef DestTy, const char *Name); 2665 LLVMValueRef LLVMBuildAddrSpaceCast(LLVMBuilderRef, LLVMValueRef Val, 2666 LLVMTypeRef DestTy, const char *Name); 2667 LLVMValueRef LLVMBuildZExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val, 2668 LLVMTypeRef DestTy, const char *Name); 2669 LLVMValueRef LLVMBuildSExtOrBitCast(LLVMBuilderRef, LLVMValueRef Val, 2670 LLVMTypeRef DestTy, const char *Name); 2671 LLVMValueRef LLVMBuildTruncOrBitCast(LLVMBuilderRef, LLVMValueRef Val, 2672 LLVMTypeRef DestTy, const char *Name); 2673 LLVMValueRef LLVMBuildCast(LLVMBuilderRef B, LLVMOpcode Op, LLVMValueRef Val, 2674 LLVMTypeRef DestTy, const char *Name); 2675 LLVMValueRef LLVMBuildPointerCast(LLVMBuilderRef, LLVMValueRef Val, 2676 LLVMTypeRef DestTy, const char *Name); 2677 LLVMValueRef LLVMBuildIntCast(LLVMBuilderRef, LLVMValueRef Val, /*Signed cast!*/ 2678 LLVMTypeRef DestTy, const char *Name); 2679 LLVMValueRef LLVMBuildFPCast(LLVMBuilderRef, LLVMValueRef Val, 2680 LLVMTypeRef DestTy, const char *Name); 2681 2682 /* Comparisons */ 2683 LLVMValueRef LLVMBuildICmp(LLVMBuilderRef, LLVMIntPredicate Op, 2684 LLVMValueRef LHS, LLVMValueRef RHS, 2685 const char *Name); 2686 LLVMValueRef LLVMBuildFCmp(LLVMBuilderRef, LLVMRealPredicate Op, 2687 LLVMValueRef LHS, LLVMValueRef RHS, 2688 const char *Name); 2689 2690 /* Miscellaneous instructions */ 2691 LLVMValueRef LLVMBuildPhi(LLVMBuilderRef, LLVMTypeRef Ty, const char *Name); 2692 LLVMValueRef LLVMBuildCall(LLVMBuilderRef, LLVMValueRef Fn, 2693 LLVMValueRef *Args, unsigned NumArgs, 2694 const char *Name); 2695 LLVMValueRef LLVMBuildSelect(LLVMBuilderRef, LLVMValueRef If, 2696 LLVMValueRef Then, LLVMValueRef Else, 2697 const char *Name); 2698 LLVMValueRef LLVMBuildVAArg(LLVMBuilderRef, LLVMValueRef List, LLVMTypeRef Ty, 2699 const char *Name); 2700 LLVMValueRef LLVMBuildExtractElement(LLVMBuilderRef, LLVMValueRef VecVal, 2701 LLVMValueRef Index, const char *Name); 2702 LLVMValueRef LLVMBuildInsertElement(LLVMBuilderRef, LLVMValueRef VecVal, 2703 LLVMValueRef EltVal, LLVMValueRef Index, 2704 const char *Name); 2705 LLVMValueRef LLVMBuildShuffleVector(LLVMBuilderRef, LLVMValueRef V1, 2706 LLVMValueRef V2, LLVMValueRef Mask, 2707 const char *Name); 2708 LLVMValueRef LLVMBuildExtractValue(LLVMBuilderRef, LLVMValueRef AggVal, 2709 unsigned Index, const char *Name); 2710 LLVMValueRef LLVMBuildInsertValue(LLVMBuilderRef, LLVMValueRef AggVal, 2711 LLVMValueRef EltVal, unsigned Index, 2712 const char *Name); 2713 2714 LLVMValueRef LLVMBuildIsNull(LLVMBuilderRef, LLVMValueRef Val, 2715 const char *Name); 2716 LLVMValueRef LLVMBuildIsNotNull(LLVMBuilderRef, LLVMValueRef Val, 2717 const char *Name); 2718 LLVMValueRef LLVMBuildPtrDiff(LLVMBuilderRef, LLVMValueRef LHS, 2719 LLVMValueRef RHS, const char *Name); 2720 LLVMValueRef LLVMBuildFence(LLVMBuilderRef B, LLVMAtomicOrdering ordering, 2721 LLVMBool singleThread, const char *Name); 2722 LLVMValueRef LLVMBuildAtomicRMW(LLVMBuilderRef B, LLVMAtomicRMWBinOp op, 2723 LLVMValueRef PTR, LLVMValueRef Val, 2724 LLVMAtomicOrdering ordering, 2725 LLVMBool singleThread); 2726 2727 /** 2728 * @} 2729 */ 2730 2731 /** 2732 * @defgroup LLVMCCoreModuleProvider Module Providers 2733 * 2734 * @{ 2735 */ 2736 2737 /** 2738 * Changes the type of M so it can be passed to FunctionPassManagers and the 2739 * JIT. They take ModuleProviders for historical reasons. 2740 */ 2741 LLVMModuleProviderRef 2742 LLVMCreateModuleProviderForExistingModule(LLVMModuleRef M); 2743 2744 /** 2745 * Destroys the module M. 2746 */ 2747 void LLVMDisposeModuleProvider(LLVMModuleProviderRef M); 2748 2749 /** 2750 * @} 2751 */ 2752 2753 /** 2754 * @defgroup LLVMCCoreMemoryBuffers Memory Buffers 2755 * 2756 * @{ 2757 */ 2758 2759 LLVMBool LLVMCreateMemoryBufferWithContentsOfFile(const char *Path, 2760 LLVMMemoryBufferRef *OutMemBuf, 2761 char **OutMessage); 2762 LLVMBool LLVMCreateMemoryBufferWithSTDIN(LLVMMemoryBufferRef *OutMemBuf, 2763 char **OutMessage); 2764 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRange(const char *InputData, 2765 size_t InputDataLength, 2766 const char *BufferName, 2767 LLVMBool RequiresNullTerminator); 2768 LLVMMemoryBufferRef LLVMCreateMemoryBufferWithMemoryRangeCopy(const char *InputData, 2769 size_t InputDataLength, 2770 const char *BufferName); 2771 const char *LLVMGetBufferStart(LLVMMemoryBufferRef MemBuf); 2772 size_t LLVMGetBufferSize(LLVMMemoryBufferRef MemBuf); 2773 void LLVMDisposeMemoryBuffer(LLVMMemoryBufferRef MemBuf); 2774 2775 /** 2776 * @} 2777 */ 2778 2779 /** 2780 * @defgroup LLVMCCorePassRegistry Pass Registry 2781 * 2782 * @{ 2783 */ 2784 2785 /** Return the global pass registry, for use with initialization functions. 2786 @see llvm::PassRegistry::getPassRegistry */ 2787 LLVMPassRegistryRef LLVMGetGlobalPassRegistry(void); 2788 2789 /** 2790 * @} 2791 */ 2792 2793 /** 2794 * @defgroup LLVMCCorePassManagers Pass Managers 2795 * 2796 * @{ 2797 */ 2798 2799 /** Constructs a new whole-module pass pipeline. This type of pipeline is 2800 suitable for link-time optimization and whole-module transformations. 2801 @see llvm::PassManager::PassManager */ 2802 LLVMPassManagerRef LLVMCreatePassManager(void); 2803 2804 /** Constructs a new function-by-function pass pipeline over the module 2805 provider. It does not take ownership of the module provider. This type of 2806 pipeline is suitable for code generation and JIT compilation tasks. 2807 @see llvm::FunctionPassManager::FunctionPassManager */ 2808 LLVMPassManagerRef LLVMCreateFunctionPassManagerForModule(LLVMModuleRef M); 2809 2810 /** Deprecated: Use LLVMCreateFunctionPassManagerForModule instead. */ 2811 LLVMPassManagerRef LLVMCreateFunctionPassManager(LLVMModuleProviderRef MP); 2812 2813 /** Initializes, executes on the provided module, and finalizes all of the 2814 passes scheduled in the pass manager. Returns 1 if any of the passes 2815 modified the module, 0 otherwise. 2816 @see llvm::PassManager::run(Module&) */ 2817 LLVMBool LLVMRunPassManager(LLVMPassManagerRef PM, LLVMModuleRef M); 2818 2819 /** Initializes all of the function passes scheduled in the function pass 2820 manager. Returns 1 if any of the passes modified the module, 0 otherwise. 2821 @see llvm::FunctionPassManager::doInitialization */ 2822 LLVMBool LLVMInitializeFunctionPassManager(LLVMPassManagerRef FPM); 2823 2824 /** Executes all of the function passes scheduled in the function pass manager 2825 on the provided function. Returns 1 if any of the passes modified the 2826 function, false otherwise. 2827 @see llvm::FunctionPassManager::run(Function&) */ 2828 LLVMBool LLVMRunFunctionPassManager(LLVMPassManagerRef FPM, LLVMValueRef F); 2829 2830 /** Finalizes all of the function passes scheduled in in the function pass 2831 manager. Returns 1 if any of the passes modified the module, 0 otherwise. 2832 @see llvm::FunctionPassManager::doFinalization */ 2833 LLVMBool LLVMFinalizeFunctionPassManager(LLVMPassManagerRef FPM); 2834 2835 /** Frees the memory of a pass pipeline. For function pipelines, does not free 2836 the module provider. 2837 @see llvm::PassManagerBase::~PassManagerBase. */ 2838 void LLVMDisposePassManager(LLVMPassManagerRef PM); 2839 2840 /** 2841 * @} 2842 */ 2843 2844 /** 2845 * @defgroup LLVMCCoreThreading Threading 2846 * 2847 * Handle the structures needed to make LLVM safe for multithreading. 2848 * 2849 * @{ 2850 */ 2851 2852 /** Deprecated: Multi-threading can only be enabled/disabled with the compile 2853 time define LLVM_ENABLE_THREADS. This function always returns 2854 LLVMIsMultithreaded(). */ 2855 LLVMBool LLVMStartMultithreaded(void); 2856 2857 /** Deprecated: Multi-threading can only be enabled/disabled with the compile 2858 time define LLVM_ENABLE_THREADS. */ 2859 void LLVMStopMultithreaded(void); 2860 2861 /** Check whether LLVM is executing in thread-safe mode or not. 2862 @see llvm::llvm_is_multithreaded */ 2863 LLVMBool LLVMIsMultithreaded(void); 2864 2865 /** 2866 * @} 2867 */ 2868 2869 /** 2870 * @} 2871 */ 2872 2873 /** 2874 * @} 2875 */ 2876 2877 #ifdef __cplusplus 2878 } 2879 #endif /* !defined(__cplusplus) */ 2880 2881 #endif /* !defined(LLVM_C_CORE_H) */ 2882